iOS LLVM编译流程

1. LLVM概念

1.1 编译器

LLVM与编译器息息相关，究竟什么是编译器呢？带着疑问往下看吧。
编译器就是将一种语言（通常为高级语言）翻译为另一种语言（通常为低级语言的程序。一个现代编译器的主要工作流程：源代码(source code) → 预处理器(preprocessor) → 编译器(compiler) → 目标代码(object code) → 链接器(Linker) → 可执行程序(executables)

源代码一般为高级语言(High-level language)， 如C、C++、Java、Objective-C等或汇编语言，而目标则是机器语言的目标代码(Object copy)，有时也称作机器代码(Machine code)。

• 解释型语言
  引入一个Python代码，见下图：
  

  创建Python案例
  创建一个FirstDemo.py文件，里面只有一行代码，print('Hello world for first time')。通过解释器指令python，解释这段代码：
  解析Python案例
  通过上面的流程可以发现解释型语言的运行流程：
  解释型语言编译流程
  解释型语言特点：边解释，边执行，运行速度慢，部分改动无需整体重新编译，不可脱离解释器环境运行。

• 编译型语言
  引入一个C代码，见下图：
  

  创建C语言案例
  创建一个firstDemoForC.c文件，里面添加了一个main函数。首先通过clang去读取这个代码:
  读取C代码
  读取之后发现代码并没有立刻执行，而是生成了一个a.out文件。这个文件就是可执行文件。通过./a.out执行这段代码：
  a.out执行
  通过上面的流程可以发现编译型语言的运行流程：
  编译型语言运行流程
  编译型语言特点：先整体编译，再执行，运行速度快，任意改动需重新编译，可脱离编译环境运行。

注意：编译型语言编译是先将代码编译成cpu可读的懂的二进制才能执行

1.2 LLVM概述

LLVM是构架编译器(compiler)的框架系统，以C++编写而成，用于优化以任意程序语言编写的程序的编译时间(compile-time)、链接时间(link-time)、运行时间(run-time)以及空闲时间(idle-time)，对开发者保持开放，并兼容已有脚本。

目前LLVM已经被Apple、Microsoft、Google、Facebook等各大公司采用。

1.2.1 传统编译器的设计

传统编译器的设计

• 编译器前端(Frontend)
  编译器前端的任务是解析源代码。它会进行：词法分析、语法分析、语义分析，检查源代码是否存在错误，然后构建抽象语法树，LLVM的前端会生成中间代码IR。

• 优化器(Optimizer)
  优化器负责进行各种优化。改善运行时间，例如消除冗余计算等。

• 后端(Backend)
  也可以叫代码生成器(CodeGenerator)，将代码映射到目标指令集。生成机器语言，并且进行机器相关的代码优化。

补充：随着高级语言越来越多，终端类型种类的增加，所使用的的CPU架构等也不尽相同，所以为了适配多种环境，不得不设计不同的编译器，而这些编译器前端和后端往往是捆绑在一起的。

1.2.2 LLVM的设计思路

LLVM的设计之初，即将编译器前端(Frontend)和后端(Backend)进行了分离。将前端和后端针对不同的架构，按照独立的项目进行研发，而它们均采用通用的代码形式IR。

前后端分离独立适配架构
当编译器决定支持多种语言或多种硬件架构时，LLVM最重要的地方就体现出来了，使用通用的代码表示形式(IR)，它是用来在编译器中表示代码的形式。所以LLVM可以为任何编程语言独立编写前端，并且可以为任意硬件架构独立编写后端。

1.2.3 iOS编译架构

Objective C/C/C++使用的编译器前端是Clang，Swift是Swift，后端都是LLVM。

iOS编译架构

1.3 Clang

Clang是LLVM项目中的一个子项目。它是基于LLVM架构的轻量级编译器，诞生之初是为了替代GCC，提供更快的编译速度。它是负责编译C、C++、Objective-C语言的编译器，它属于整个LLVM架构中，编译器前端。对于开发者来说，研究Clang可以给我们带来很多好处。

2. 编译流程详解

通过命令可以打印源码的编译阶段。引入下面一个案例，main.m中添加代码：

int main(int argc, const char * argv[]) {
    return 0;
}

通过指令clang -ccc-print-phases main.m，查看编译流程：

通过指令查看编译流程
流程说明：
0.输入文件：找到源文件
1.预处理阶段：这个过程处理包括宏的替换，头文件的导入
2.编译阶段：进行词法分析、语法分析、检测语法是否正确，最终生成IR
3.后端：这里LLVM会通过一个一个的Pass（节点）去优化，每个Pass做一些事情，最终生成汇编代码
4.生成目标文件
5.链接：链接需要的动态库和静态库，生成可执行文件
6.通过不同的架构，生成对应的可行文件

2.1 预处理

执行如下指令：clang -E main.m，对源代码进行预处理。见下面流程:

执行指令进行预处理
在预处理之后，输出mainE.m文件，查看mainE.m文件：
mainE.m文件查看
打开mainE.m源文件会发现，其进行了宏的替换，如上面案例中宏c直接替换成了30；进行头文件的导入。

2.2 编译阶段

2.2.1 词法分析

预处理完成后就会进行词法分析，这里会把代码切成一个个Token，比如大小括号，等于号以及字符串等。词法分析指令为：

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

参考下面的案例：

词法分析案例
通过指令的输出可以看到，语法分析会将源码进行切割并检测。比如分号，逗号，int等。

2.2.2 语法分析

词法分析完成之后就是语法分析，它的任务是验证语法是否正确。在词法分析的基础上将单词序列组合成各类语法短语，如:程序，语句，表达式等等，然后将所有节点组成抽象语法树（Abstract Syntax Tree，AST）。语法分析程序判断源程序在结构上是否正确。语法分析指令：

clang -fmodules -fsyntax-only -Xclang -ast-dump main.m

参考下面的案例：

语法分析案例
通过上面的输出可以发现，其是一个树结构，比如下面的FunctionDecl，表示一个方法，在源码的第五行，名称为main，返回值为int，传入两个参数一个是int，一个是const char **。见下图：

注意：一旦生成抽象语法树，如果源码中存在语法错误，就会报错，而上面的预处理和词法分析不会报错。

如在源码中设置一个语法错误，通过语法分析指令进行进行编译，就会报错，见下面案例：

语法错误案例

2.2.3 生成中间代码IR(intermediate representation)

完成以上步骤后，就开始生成中间代码IR了，代码生成器（Code Generation）会将语法树自顶向下遍历逐步翻译成LLVM IR。通过下面指令可以生成.ll的文本文件，查看IR代码。

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

通过上面的指令获取main.ll文件，其结构见下图：

IR代码查看

• IR的基本语法

  • @ 全局标识
  • % 局部标识
  • alloca 开辟空间
  • align 内存对齐
  • i32 32个bit，4个字节
  • store 写入内存
  • load 读取数据
  • call 调用函数
  • ret返回

• IR优化
  上面生成的IR代码是没有经过优化的，其实我们在平时阅读代码时，经常会看下面的一些定义：

#define fastpath(x) (__builtin_expect(bool(x), 1))
#define slowpath(x) (__builtin_expect(bool(x), 0))

• fastpath：可以理解为快速流程，对更有可能执行的流程进行优化，提高运行速度；
  slowpath：基本流程，不被优化的。

在XCode中也有相应的优化设置入口：

优化入口
LLVM的优化级别分别是-O0 -O1 -O2 -O3 -Os(第一个是大写英文字母O)。可以通过下面的指令获取优化后的IR代码，也就是.ll文件：

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

通过以上指令生成优化后IR代码如下：

生成优化后IR代码
好明显，相较于优化前，代码精简了很多。

这里需要注意的是，通常debug模式下，优化模式选择None -O0，也就是不优化，避免一些保留代码被屏蔽，从而影响调试。而release模式设置为Fastest,Smallest -Os。

• bitCode
Xcode7以后开启bitCode苹果会做进一步的优化，生成.bc的中间代码。我们通过优化后的IR代码生成.bc代码。对应指令为：

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

2.3 后端生成汇编代码

我们通过最终的.bc或者.ll代码生成汇编代码：

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

生成汇编代码也可以进行优化：

    clang -Os -S -fobjc-arc main.m -o main.s

采用相同的案例，分别三种方式生成汇编代码，可以看到其优化效果。在进行IR优化后生成的.ll文件，依然可以进行优化生成回应的汇编代码。在不同的节点上都可以进行优化。见下图：

汇编代码的生成

2.4 生成目标文件(汇编器)

目标文件的生成，是汇编器以汇编代码作为输入，将汇编代码转换为机器代码，最后输出目标文件（object file）。指令为：

clang -fmodules -c main.s -o main.o

生成目标文件，见下图：

生成目标文件
其中main.o文件即为目标文件，但是此时生成的目标文件是不可执行的。通过nm命令，查看下main.o中的符号：

    $xcrun nm -nm main.o
            (undefined) external _printf
    0000000000000000 (__TEXT,__text) external _test
    000000000000000a (__TEXT,__text) external _main

• _printf是一个undefifined external的
• undefifined表示在当前文件暂时找不到符号_printf
• external表示这个符号是外部可以访问的

此时就需要链接，链接器把编译生成的.o文件和（.dylib .a）文件链接生成一个mach-o文件。

    clang main.o -o main

生成对应的可执行文件，见下图：

生成可执行文件

查看链接之后的符号：

$xcrun nm -nm main
        (undefined) external _printf (from libSystem)
        (undefined) external dyld_stub_binder (from libSystem)
0000000100000000 (__TEXT,__text) [referenced dynamically] external __mh_execute_header
000000100000f6d (__TEXT,__text) external _test
000000100000f77 (__TEXT,__text) external _main

可以发现此时的外部函数有2个，_printf和dyld_stub_binder，它们都来自libSystem库。dyld_stub_binder这个函数的作用是进行运行时绑定流程。

链接是在编译时，用来确定外部函数来自哪个动态库；绑定是在运行时，将对应方法的实现地址与符号进行绑定。

可执行文件运行结果：

可执行文件运行结果