iOS-LLVM的编译以及Clang的插件编写

开篇

深入了解LLVM编译器架构我们介绍了编译器原理，LLVM编译器架构，编译流程，今天我们带大家编译LLVM的源码，写Clang的简单插件。

1 LLVM下载

由于国内网络限制，我们可以借助镜像下载LLVM源码
https://mirror.tuna.tsinghua.edu.cn/help/llvm/

• 下载llvm项目
  https://mirrors.tuna.tsinghua.edu.cn/git/llvm/llvm.git
• 在LLVM的tools目录下下载Clang
  cd llvm/tools
  git clone https://mirrors.tuna.tsinghua.edu.cn/git/llvm/clang.git
• 在LLVM的projects目录下载compiler-rt,libcxx,libxxabi
  cd ../projects
  git clone https://mirrors.tuna.tsinghua.edu.cn/git/llvm/compiler-rt.git
  git clone https://mirrors.tuna.tsinghua.edu.cn/git/llvm/libcxx.git
  git clone https://mirrors.tuna.tsinghua.edu.cn/git/llvm/libcxxabi.git
• 在Clang的tools下安装extra工具
  cd ../tools/clang/tools
  git clone https://mirrors.tuna.tsinghua.edu.cn/git/llvm/clang-tools-extra.git

2 LLVM编译

通过xcode编译LLVM

• cmake编译成xcode项目
  mkdir build_xcode
  cd build_xcode
  cmake -G Xcode ../

• 使用xcode编译Clang
  选择手动创建

  
  
  1

3 创建插件

• 在/llvm/tools/clang/tools目录下新建插件RoPlugin
• 修改/llvm/tools/clang/tools目录下的CmakeLists.txt文件，新增
  add_clang_subdirectory(RoPlugin)。
• 在RoPlugin目录下新建一个名为RoPlugin.cpp的文件和CMakeLists.txt的文件。在CMakeLists.txt中写上
  add_llvm_library(HKPlugin MODULE BUILDTREE_ONLY
  RoPlugin.cpp
  )
• 接下来利用cmake重新生成一个xcode项目，在build_xcode中，cmake -G Xcode ../
• 最后可以在LLVM的xcode项目中可以看到Loadable modules目录下有自己的Plugin目录了。我们可以在里面编写插件代码。

4 编写插件代码

RoPlugin.cpp源码

#include 
#include "clang/AST/AST.h"
#include "clang/AST/DeclObjC.h"
#include "clang/AST/ASTConsumer.h"
#include "clang/ASTMatchers/ASTMatchers.h"
#include "clang/Frontend/CompilerInstance.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
#include "clang/Frontend/FrontendPluginRegistry.h"

//enum PropertyAttributeKind {
//  OBJC_PR_noattr    = 0x00,
//  OBJC_PR_readonly  = 0x01,
//  OBJC_PR_getter    = 0x02,
//  OBJC_PR_assign    = 0x04,
//  OBJC_PR_readwrite = 0x08,
//  OBJC_PR_retain    = 0x10,
//  OBJC_PR_copy      = 0x20,
//  OBJC_PR_nonatomic = 0x40,
//  OBJC_PR_setter    = 0x80,
//  OBJC_PR_atomic    = 0x100,
//  OBJC_PR_weak      = 0x200,
//  OBJC_PR_strong    = 0x400,
//  OBJC_PR_unsafe_unretained = 0x800,
//  /// Indicates that the nullability of the type was spelled with a
//  /// property attribute rather than a type qualifier.
//  OBJC_PR_nullability = 0x1000,
//  OBJC_PR_null_resettable = 0x2000,
//  OBJC_PR_class = 0x4000
//  // Adding a property should change NumPropertyAttrsBits
//};

//使用命名空间！
using namespace clang;
using namespace std;
using namespace llvm;
using namespace ast_matchers;

// 基于clang的API二次开发
namespace RoPlugin {
    
    class RoMatchCallback: public MatchFinder::MatchCallback {
    private:
        CompilerInstance &CI;
        // 判断是否是自己的文件
        bool isUserSourceCode(const string fileName) {
            if(fileName.empty()) return false;
            if (fileName.find("/Applications/Xcode.app/") == 0) return false;
            return  true;
        }
        // 判断是否应该用copy修饰
        bool isShouldUseCopy(const string typeStr){
            if(typeStr.find("NSString") != string::npos ||
               typeStr.find("NSArray") != string::npos ||
               typeStr.find("NSDictionary") != string::npos){
                return true;
            }
            return false;
        }
    public:
        RoMatchCallback( CompilerInstance &CI):CI(CI){}
        
        void run(const MatchFinder::MatchResult &Result){
            //通过结果获取到节点对象
            const ObjCPropertyDecl *propertyDecl= Result.Nodes.getNodeAs("objcPropertyDecl");
            // 获取文件路径(包含路径)
            string fileName = CI.getSourceManager().getFilename(propertyDecl->getSourceRange().getBegin()).str();
            //拿到属性节点并且不是系统文件
            if(propertyDecl && isUserSourceCode(fileName)) {
                string typeStr = propertyDecl->getType().getAsString();
                // 拿到节点的描述信息
                ObjCPropertyDecl::PropertyAttributeKind attrKind = propertyDecl->getPropertyAttributes();
                if (attrKind)
                // 判断应该使用copy,但是没有copy修饰
                if (isShouldUseCopy(typeStr) && !(attrKind & ObjCPropertyDecl::OBJC_PR_copy)) {
                    // 发出警告信息,使用诊断引擎
                    DiagnosticsEngine &diag = CI.getDiagnostics();
                    diag.Report(propertyDecl->getLocation(),diag.getCustomDiagID(DiagnosticsEngine::Warning, "这个地方应该用Copy"));
//                    cout << "应该使用未使用" << typeStr < &arg) {
             
             return true;
         }
        
        //创建RoConsumer
        std::unique_ptr CreateASTConsumer(CompilerInstance &CI,
                                                       StringRef InFile) {
            return unique_ptr(new RoConsumer(CI));
        }
        
    };

}

// 注册插件
static FrontendPluginRegistry::Add X("RoPlugin","this is the description");

5 xcode集成插件

5.1 加载插件

打开测试项目，在Build Settings -> Other C Flags添加上如下内容：
-Xclang -load -Xclang (.dylib)动态库路径 -Xclang -add-plugin-Xclang H KPlugin*

2

5.2 设置编译器

• 由于Clang插件需要使用对应的版本去加载，如果版本不一致则会导致编译错误Expected in: flat namespace

• 在Build Settings栏目中新增两项用户定义的设置

  
  
  3
• 分别是CC和CXX
  CC对应的是自己编译的clang的绝对路径
  CXX对应的是自己编译的clang++的绝对路径
• 接下来在Build Settings栏目中搜索index，将Enable Index-Wihle-BuildingFunctionality的Default改为NO
  
  4

总结

通过这篇文章，我们了解如何编译LLVM工程，怎样写一个简单的Clang的插件，有兴趣的可以相互关注学习。