LLVM 初步了解

LLVM标志

什么是LLVM

• 官网：https://llvm.org/

• LLVM项目是模块化、可重用的编译器以及工具链技术的集合。美国计算机协会 (ACM) 将其2012 年软件系统奖项颁给了LLVM，之前曾经获得此奖项的软件和技术包括:Java、Apache、 Mosaic、the World Wide Web、Smalltalk、UNIX、Eclipse等等

• 创始人：Chris Lattner，亦是Swift之父

传统的编译器架构

传统的编译器架构

LLVM编译器架构

LLVM编译器架构

 从上面的2张图就可以看出来LLVM编译器的优点
 1.不同的前端后端使用统一的中间代码LLVM Intermediate Representation (LLVM IR)
 2.如果需要支持一种新的编程语言，那么只需要实现一个新的前端
 3.如果需要支持一种新的硬件设备，那么只需要实现一个新的后端
 4.优化阶段是一个通用的阶段，它针对的是统一的LLVM IR，不论是支持新的编程语言，还是支持新的硬件设备，都不需要对优化阶段做修改
 5.相比之下，GCC的前端和后端没分得太开，前端后端耦合在了一起。所以GCC为了支持一门新的语言，或者为了支持一个新的目标平台，就 变得特别困难
 6LLVM现在被作为实现各种静态和运行时编译语言的通用基础结构(GCC家族、Java、.NET、Python、Ruby、Scheme、Haskell、D等)

下面主要介绍下Clang

• Clang是LLVM项目的一个子项目

• 基于LLVM架构的C/C++/Objective-C编译器前端

• 官网:http://clang.llvm.org/
  相比于GCC ，Clang具有的优点

  1.编译速度快:在某些平台上，Clang的编译速度显著的快过GCC(Debug模式下编译OC速度比GGC快3倍)
  2.占用内存小:Clang生成的AST所占用的内存是GCC的五分之一左右
  3.模块化设计:Clang采用基于库的模块化设计，易于 IDE 集成及其他用途的重用
  4.诊断信息可读性强:在编译过程中，Clang 创建并保留了大量详细的元数据 (metadata)，有利于调试和错误报告
  5.设计清晰简单，容易理解，易于扩展增强
  

Clang 与LLVM 的关系

Clang 与 LLVM 的关系

• 可以看的出Clang可以对语法进行分析，所以我们接下来做个类名规范的插件

具体操作开始

下载LLVM

• git clone https://git.llvm.org/git/llvm.git/ 大小大约700M左右

下载Clang

• 下载完llvm后然后进入cd llvm/tools 这个目录下 再去下载clang
• git clone https://git.llvm.org/git/clang.git/

编译源码

• 首先安装brew(https://brew.sh/)
• curl -LsSf http://github.com/mxcl/homebrew/tarball/master | sudo tar xvz -C/usr/local --strip 1(安装过的可以忽略)
  当brew安装成功后，就可以随意安装自己想要的软件了

安装cmake和ninja

• brew install cmake
• brew install ninja
  （ninja如果安装失败，可以直接从github获取release版放入【/usr/local/bin】中 下载地址 ：https://github.com/ninja-build/ninja/releases）
• 在LLVM源码同级目录下新建一个【llvm_build】目录(最终会在【llvm_build】目录下生成【build.ninja】
• cd llvm_build
• cmake -G Ninja ../llvm -DCMAKE_INSTALL_PREFIX=../llvm_release
  (cmake -G Ninja ../llvm -DCMAKE_INSTALL_PREFIX=LLVM的安装路径)
• 然后依次执行命令
• ninja （备注：编译完毕后，编译时间大概半个小时 【llvm_build】目录大概 21.05 G(仅供参考) ）
• ninja install （ 备注： 安装完毕后，安装时间大概20分钟，安装目录大概 11.92 G(仅供参考)）
• 在llvm同级目录下新建一个【llvm_xcode】目录
• cd llvm_xcode
• cmake -G Xcode ../llvm

• 完成之后 双击 LLVM.xcodeproj 打开项目

  
  
  

  点击这个
• 然后command+B 编译一下

libclang、libTooling

• 官方参考:https://clang.llvm.org/docs/Tooling.html
• 应用:语法树分析、语言转换等

Clang插件开发

• 官方参考:
• https://clang.llvm.org/docs/ClangPlugins.html
• https://clang.llvm.org/docs/ExternalClangExamples.html
• https://clang.llvm.org/docs/RAVFrontendAction.html
• 应用:代码检查(命名规范、代码规范)等

---

clang插件开发

• 在【clang/tools】源码目录下新建一个插件目录，假设叫做【zw-plugin】

• /llvm/tools/clang/tools 在这个目录下创建一个zw-plugin 文件夹

  
  
  

  创建zw-plugin文件夹

• 在/llvm/tools/clang/tools/CMakeLists.txt 最后加入内容: add_clang_subdirectory(zw-plugin)，小括号里是插件目录名

  
  
  

  添加
• 然后在/llvm/tools/clang/tools/zw-plugin 的目录下新建一个CMakeLists.txt 。
• 文件添加内容是:add_llvm_loadable_module(ZWPlugin ZWPlugin.cpp)

• 然后在/llvm/tools/clang/tools/zw-plugin 文件里 创建名字为ZWPlugin.cpp 的文件

  
  
  

  最终的效果图
• ZWPlugin.cpp 里面的源码，我上传到github

写完插件代码后需要重新来到我们创建llvm_xcode 文件下

• cd llvm_xcode
• cmake -G Xcode ../llvm
  (利用cmake生成的Xcode项目来编译插件(第一次编写完插件，需要利用cmake重新生成一下Xcode项目))
• 选择MJPlugin这个target进行编译，编译完会生成一个动态库文件

运行效果

• ZWPlugin 就是最后做成插件的动态库

测试插件效果

• 自己新创建一个xcode 工程 在创建一个zw_class 带下划线的类名

• 在新建的工程中找到下图

  
  
  

  BuildSettings > OTHER_CFLAGS
• -Xclang -load -Xclang 动态库路径 -Xclang -add-plugin -Xclang 插件名称

clang插件开发6 – Hack Xcode

• 首先要对Xcode进行Hack，才能修改默认的编译器
• 下载【XcodeHacking.zip】，解压，修改【HackedClang.xcplugin/Contents/Resources/HackedClang.xcspec】的内容，设置一下自己编译好的clang的路径
• 然后在XcodeHacking目录下进行命令行，将XcodeHacking的内容剪切到Xcode内部
• sudo mv HackedClang.xcplugin xcode-select-print- path/../PlugIns/Xcode3Core.ideplugin/Contents/SharedSupport/Developer/Library/Xcode/Plug-ins
• sudo mv HackedBuildSystem.xcspec xcode-select-print- path/Developer/Platforms/iPhoneSimulator.platform/Developer/Library/Xcode/Specifications
• 如果上面的命令报错的话，就根据上面的路径找到对应的文件，然后把解压的文件放在里面