LLVM

传统编译器

LLVM区别于传统的编译器，它前端和后端分开了

LLVM流程
1.所有的代码会经过[词法分析，语法分析，语义分析]生成抽象语法数
2.将抽象语法树编译成IR
3.将IR输送给Optimizer(优化器)，进行优化IR代码
4.优化之后的IR输送给后端，根据架构(x86 & arm)生成不同的指令集代码(机器语言)

clang & swift都隶属于LLVM,它们分别是LLVM针对前端语言编译的一种格式，之后都会生成IR

clang

iOS里面 c,c++,oc 使用的是clang这个前端

swift

iOS里面 swift ，使用的是swift这个前端

• 查看前端clang流程

clang -ccc-print-phases main.m

• 查看预处理流程

// 生成main1.m文件，展开`头`文件，展开`宏`

clang -E main.m >> mian1.m

• typedef不是预处理指令(只是定义了一个别名)

• #define才是预处理指令
  

  typedef不是预处理指令

• ???通过词法分析，将代码加切成一段一段的token

clang -fmodules -fsyntax-only -Xclang -dump-tokens mian.m

• 生成抽象语法树(包含 语法分析)

// 地址是当前文件中的偏移地址，并非真实地址
clang -fmodules -fsyntax-only -Xclang -ast-dump mian.m

• 生成IR

clang -S -fobjc-arc -emit-llvm main.m

ls

// main.ll 即是生成的IR

IR语法解读

• llvm的优化级别 O0/O1/O2/O3/Os(注意字母O是大写)
• 生成优化之后的IR

clang -Os -S -fobjc-arc -emit-llvm main.m -o main.ll

• bitcode一般不开启，优化后的IR再次优化生成.bc的中间代码

clang -emit-llvm -c main.ll -o main.bc

优化后的IR语法解读

• 生成汇编代码([通过最终的.bc或.ll代码生成汇编代码] -> IR ->汇编)

clang -S -fobjc-arc main.bc -o main.s
或
clang -S -fobjc-arc main.ll -o main.s

• 优化汇编

clang -Os -S -fobjc-arc mian.m -o main.s
或
clang -Os -S -fobjc-arc mian.ll -o main.s
或
clang -Os -S -fobjc-arc mian.bc -o main.s

当选择了优化等级，不同的节点上还能进行优化

• 生成目标文件（汇编器以汇编代码作为输入，将汇编代码转换成机器代码,形成目标文件）

// .o文件是不能执行的
clang -fmoduls -c main.s -o main.o

• 查看目标文件main.o

xcrun nm -nm main.o

• 找不到外部的_printf,这时候就需要链接image(镜像文件，所依赖的库)

// linker
clang main.o -o main

_printf找不到

• 查看main 可执行文件

xcrun nm -nm main

// 链接是在编译期，绑定是在执行期(dyld_stub_binder(from libsystem) 负责绑定操作)
// 外部函数都会生成符号表(符号表的地址在没有运行之前为NULL，然后执行dyld_stub_binder找到对应库的符号绑定地址)

查看main可执行文件

符号绑定地址细节图解

• 执行 main可执行文件

./main

// 打印结果:6%

写一个clang插件

• 1.下载llvm工程

由于国内网络限制，需要借助镜像下载llvm的源码
llvm源码

• 下载llvm项目

git clone 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，libcxxabi

cd ../projects

git clone https://mirrors.tuna.tsinghua.edu.cn/git/llvm/compiler-rt.g it
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-e xtra.git

llvm编译

由于最新的llvm只支持cmake来编译了，so还需要安装cmake

安装cmake

• 查看brew是否安装cmake如果有调过下面步骤

brew list

// 如果没有找到cmake才去安装

• 通过brew安装cmake

brew install cmake

通过xcode编译llvm

• cmake编译成xcode项目

mkdir build_xcode
cd build_xcode
cmake -G Xcode ../llvm

• 使用xcode编译clang
  • 选择自动创建Schemes

• 编译选择ALL_BUILD Secheme进行编译，预计1+小时

编译时间胡比较长

创建插件

• 在/llvm/tools/clang/tools目录下新建插件HKPlugin

• 修改/llvm/tools/clang/tools目录下的CMakeLists.txt文件，新增add_clang_subdirectory(HKPlugin)

• 在HKPlugin目录下新建一个名为HKPlugi.cpp文件和CMakeLists.txt文件，在CMakeLists.txt中写上

add_llvm_library( HKPlugin MODULE BUILDTREE_ONLY
  HKPlugin.cpp
)

• 接下来利用cmake重新生成一下Xcode项目,在build_xcode中

cmake -G Xcode ../llvm

• 最后可以在LLVM的Xcode项目中可以看到Loadable modules目录下有自己的Plugin目录，可以在里面编写插件代码

编写插件代码

#include <iostream>
#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"

using namespace clang;
using namespace std;
using namespace llvm;
using namespace clang::ast_matchers;

//命名空间，和插件同名
namespace HKPlugin {

//第三步：扫描完毕的回调函数
//4、自定义回调类，继承自MatchCallback
class HKMatchCallback: public MatchFinder::MatchCallback {
    
private:
    //CI传递路径：HKASTAction类中的CreateASTConsumer方法参数 - HKConsumer的构造函数 - HKMatchCallback的私有属性，通过构造函数从HKASTConsumer构造函数中获取

    CompilerInstance &CI;
    
    //判断是否是用户源文件
    bool isUserSourceCode(const string filename) {
        //文件名不为空
        if (filename.empty()) return  false;
        //非xcode中的源码都认为是用户的
        if (filename.find("/Applications/Xcode.app/") == 0) return false;
        return  true;
    }

    //判断是否应该用copy修饰
    bool isShouldUseCopy(const string typeStr) {
        //判断类型是否是NSString | NSArray | NSDictionary
        if (typeStr.find("NSString") != string::npos ||
            typeStr.find("NSArray") != string::npos ||
            typeStr.find("NSDictionary") != string::npos/*...*/)
        {
            return true;
        }
        
        return false;
    }
    
public:
    HKMatchCallback(CompilerInstance &CI) :CI(CI) {}
    
    //重写run方法
    void run(const MatchFinder::MatchResult &Result) {
        //通过result获取到相关节点 -- 根据节点标记获取（标记需要与HKASTConsumer构造方法中一致）
        const ObjCPropertyDecl *propertyDecl = Result.Nodes.getNodeAs<ObjCPropertyDecl>("objcPropertyDecl");
        //判断节点有值，并且是用户文件
        if (propertyDecl && isUserSourceCode(CI.getSourceManager().getFilename(propertyDecl->getSourceRange().getBegin()).str()) ) {
            //15、获取节点的描述信息
            ObjCPropertyDecl::PropertyAttributeKind attrKind = propertyDecl->getPropertyAttributes();
            //获取节点的类型，并转成字符串
            string typeStr = propertyDecl->getType().getAsString();
//            cout<<"---------拿到了："<<typeStr<<"---------"<<endl;
            
            //判断应该使用copy，但是没有使用copy
            if (propertyDecl->getTypeSourceInfo() && isShouldUseCopy(typeStr) && !(attrKind & ObjCPropertyDecl::OBJC_PR_copy)) {

                //使用CI发警告信息
                //通过CI获取诊断引擎
                DiagnosticsEngine &diag = CI.getDiagnostics();

                //通过诊断引擎 report报告 错误，即抛出异常
                /*
                错误位置：getBeginLoc 节点开始位置
                错误：getCustomDiagID（等级，提示）
                 */
                diag.Report(propertyDecl->getBeginLoc(), diag.getCustomDiagID(DiagnosticsEngine::Warning, "%0 - 这个地方推荐使用copy!!"))<< typeStr;
            }
        }
    }
};


//第二步：扫描配置完毕
//3、自定义HKASTConsumer，继承自ASTConsumer，用于监听AST节点的信息 -- 过滤器
class HKASTConsumer: public ASTConsumer {
private:
    //AST节点的查找过滤器
    MatchFinder matcher;
    //定义回调类对象
    HKMatchCallback callback;
    
public:
    //构造方法中创建matcherFinder对象
    HKASTConsumer(CompilerInstance &CI) : callback(CI) {
        //添加一个MatchFinder，每个objcPropertyDecl节点绑定一个objcPropertyDecl标识（去匹配objcPropertyDecl节点）
        //回调callback，其实是在HKMatchCallback里面重写run方法（真正回调的是回调run方法）
        matcher.addMatcher(objcPropertyDecl().bind("objcPropertyDecl"), &callback);
    }
    
    //实现两个回调方法 HandleTopLevelDecl 和 HandleTranslationUnit
    //解析完一个顶级的声明，就回调一次(顶级节点，相当于一个全局变量、函数声明)
    bool HandleTopLevelDecl(DeclGroupRef D){
//        cout<<"正在解析..."<<endl;
        return  true;
    }
    
    //整个文件都解析完成的回调
    void HandleTranslationUnit(ASTContext &context) {
//        cout<<"文件解析完毕!"<<endl;
        //将文件解析完毕后的上下文context（即AST语法树） 给 matcher
        matcher.matchAST(context);
    }
};

//2、继承PluginASTAction，实现我们自定义的Action，即自定义AST语法树行为
class HKASTAction: public PluginASTAction {
    
public:
    //重载ParseArgs 和 CreateASTConsumer方法
    bool ParseArgs(const CompilerInstance &ci, const std::vector<std::string> &args) {
        return true;
    }
    
    //返回ASTConsumer类型对象，其中ASTConsumer是一个抽象类，即基类
    /*
     解析给定的插件命令行参数。
     - param CI 编译器实例，用于报告诊断。
     - return 如果解析成功，则为true；否则，插件将被销毁，并且不执行任何操作。该插件负责使用CompilerInstance的Diagnostic对象报告错误。
     */
    unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI, StringRef iFile) {
        //返回自定义的CJLASTConsumer,即ASTConsumer的子类对象
        /*
         CI用于：
         - 判断文件是否使用户的
         - 抛出警告
         */
        return unique_ptr<HKASTConsumer> (new HKASTConsumer(CI));
    }
    
};

}

//第一步：注册插件，并自定义AST语法树Action类
//1、注册插件
static FrontendPluginRegistry::Add<HKPlugin::HKASTAction> HK("HKPlugin", "This is HKPlugin");

测试插件

自己编译的clang文件路径 -isysroot /Applications/Xcode.app/Contents/Deve loper/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulat or12.2.sdk/ -Xclang -load -Xclang 插件(.dylib)路径 -Xclang -add-plugin
-Xclang 插件名 -c 源码路径

测试结果：

测试插件

Xcode集成插件

加载插件

• 打开测试项目，在Build Settings -> Other C Flags添加上如下内容

 -Xclang -load -Xclang (.dylib)动态库路径 -Xclang -add-plugin -Xclang H KPlugin

设置编译器

• 由于Clang插件需要使用对应的版本去加载，如果版本不一致就会导致编译错误，会出现如下图所示：

  
  

• 在Build Settings栏中新增亮相用户定义的设置

• 分别是 CC & CXX
  • CC对应的是自己编译的clang的绝对路径
  • CXX对应的是自己编译的clang++的绝对路径

• 接下来在Build Settings栏中搜索index，将Enable Index-Wihle-Building Functionality的Default改为NO

• 拓展 c 语法

chanr *argv[] == chanr **argv