初识LLVM

LLVM：编译器中的王者 - 视频观看笔记

笔记目录：

理论篇
代码篇
工具准备
插件开发（内容涉及C++，可作为拓展）

一、理论篇

1.1、什么是LLVM？

官网描述
The LLVM Project is a collection of modular and reusable compiler and toolchain technologies. Despite its name, LLVM has little to do with traditional virtual machines. The name "LLVM" itself is not an acronym; it is the full name of the project.
--
LLVM项目是模块化和可重用的编译器和工具链技术的集合。尽管名称如此，LLVM与传统虚拟机几乎没有关系。名称“LLVM”本身不是首字母缩略词; 它是项目的全名

1.2、传统编译器架构 VS LLVM架构

传统编译器架构

传统编译器架构.jpg

Frontend：前端
词法分析、语法分析、语义分析、生成中间代码
Optimizer：优化器
中间代码优化
Backend：后端
生成机器码

LLVM架构

LLVM架构.jpg

LLVM架构优点

不同的前端后端使用统一的中间代码LLVM Intermediate Representation ( LLVM IR)
如果需要支持一种新的编程语言，只需要实现一个新的前端
如果需要支持一种新的硬件设备，只需要实现一个新的后端
优化阶段是一个通用的阶段，它针对的是统一的LLVM IR，不论是支持新的编程语言，还是支持新的硬件设备，都不需要对优化阶段做修改
相比之下，GCC的前端和后端没分得太开，前端后端耦合在了一起，所以GCC为了支持一门新的语言，或者为了支持一个新的设备的话，就变得特别困难
LLVM现在被作为实现各种静态和运行时编译语言的通用基础结构（GCC家族、Java、.NET、 Python、Ruby 、Scheme Haskell、D）

1.4、关于Clang

Clang是一个“LLVM原生”C / C ++ / Objective-C编译器，旨在提供惊人的快速编译,非常有用的错误和警告消息，并且提供构建优秀源代码工具的平台。

相对于GCC，Clang具有如下优点

编译速度快：在调试配置中编译Objective-C代码时比GCC快3倍
占用内存小：Clang生成的AST所占用的内存是GCC的五分之一左右
模块化设计：Clang采用基于库的模块化设计，易与IDE集成及其他用途重用
诊断信息可读性强：在编译过程中，Clang创建并保留了大量详细的元数据（metadata），有利于调试
设计清晰简单，容易理解，易于扩展增强

Clang与LLVM的关系

Clang与LLVM.jpg

广义的LLVM：整个LLVM架构
狭义上的LLVM：LLVM后端（代码优化，目标代码生成）

---.jpg

二、代码篇

2.1、OC源文件的编译过程

clang -ccc-print-phases main.m    // main.m是对应文件名

打印：

0: input, "main.m", objective-c    // 找到原代码 main.m文件
1: preprocessor, {0}, objective-c-cpp-output // 预处理器，将#import、#include的内容直接拷贝到相应位置，将宏替换到相应位置
2: compiler, {1}, ir。             // 编译成IR中间代码
3: backend, {2}, assembler         // 后端生成目标代码
4: assembler, {3}, object          // 目标代码
5: linker, {4}, image              // 链接（动态库、静态库等）
6: bind-arch, "x86_64", {5}, image // 处理成适合某个架构的代码

查看preprocessor（预处理）的结果：

clang -E main.m  // main.m是对应文件名

代码：

#include 
#define AGE 40

int main(int argc, char * argv[]) {
    @autoreleasepool {
        int a = 10;
        int b = 20;
        int c = a + b + AGE;
        return UIApplicationMain(argc, argv, nil, NSStringFromClass([AppDelegate class]));
    }
}

预处理结果：

......
extern int __vsnprintf_chk (char * restrict, size_t, int, size_t,
       const char * restrict, va_list);
# 412 "/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.14.sdk/usr/include/stdio.h" 2 3 4
# 9 "test.m" 2

int main(int argc, char * argv[]) {
    @autoreleasepool {
        int a = 10;
        int b = 20;
        int c = a + b + 40;
        return UIApplicationMain(argc, argv, nil, NSStringFromClass([AppDelegate class]));
    }
}

2.2、词法分析

将代码拆分成Token

clang -fmodules -E -Xclang -dump-tokens main.m

代码

#include 
#define AGE 40

int main(int argc, char * argv[]) {
    @autoreleasepool {
        int a = 10;
        int b = 20;
        int c = a + b + AGE;
        return 0;
    }
}

分析

int main(int argc, char * argv[]) {
    @autoreleasepool {
        int a = 10;
        int b = 20;
    '       Loc=
int 'int'    [StartOfLine]  Loc=
identifier 'main'    [LeadingSpace] Loc=
l_paren '('     Loc=            /// 第11行第9个字节
int 'int'       Loc=           /// 第11行第10个字节
identifier 'argc'    [LeadingSpace] Loc=
comma ','       Loc=
char 'char'  [LeadingSpace] Loc=
star '*'     [LeadingSpace] Loc=
identifier 'argv'    [LeadingSpace] Loc=
l_square '['        Loc=
r_square ']'        Loc=
r_paren ')'     Loc=

......

2.3、语法分析

将Token拼起来，生成语法树（AST，Abstract Syntax Tree）

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

代码

void test(int a, int b) {
    int c = a + b - 4;
}

分析

一颗语法树分析.jpg

分析.jpg

2.4、LLVM IR（中间代码）

LLVM IR 3种表示形式（本质等价）

test，便于阅读的文本格式，类似于汇编语言（拓展名.II）
memory，内存格式
bitcode，二进制格式，（拓展名.bc）

生成方式

test
clang -S -emit-llvm main.m

bitcode
clang -c -emit-llvm main.m

由于内存格式和二进制格式不易阅读，所以这里我们生成test形式的文件作为展示

二号文件.jpg

打开生成的文件（这里的.II文件，我用的是PhpStorm程序打开的）

 ; Function Attrs: noinline nounwind optnone ssp uwtable
define void @test(i32, i32) #0 {   // （int a, int b）
  %3 = alloca i32, align 4         //  int c
  %4 = alloca i32, align 4         //  int d
  %5 = alloca i32, align 4         //  int e
  store i32 %0, i32* %3, align 4   // c = a 将%0里面的内容送给%3
  store i32 %1, i32* %4, align 4   // d = b 将%1里面的内容送给%4（%0和%1是参数的两个变量）
  %6 = load i32, i32* %3, align 4  // a (将%3赋值给了%6)
  %7 = load i32, i32* %4, align 4  // b (将%4赋值给了%7)
  %8 = add nsw i32 %6, %7          // a + b
  %9 = sub nsw i32 %8, 4           // a + b - 3
  store i32 %9, i32* %5, align 4   //将 %5 赋值给 %9 
  ret void
}

IR基本语法：官方语法参考

IR基本语法：

1、注释以分号";"开头
2、全局标识符以"@"开头，局部标识符以"%"开头
3、"alloca"，在当前函数栈帧中分配内存
4、i32, 32bit，4个字节的意思
5、align, 内存对齐
6、store，写入数据
7、load，读取数据

时间定位：41.30

三、工具准备

Homebrew
LLVM
Clang
cmake和ninja（能提高编译效率）

3.1、Homebrew

安装
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

卸载
$ cd `brew --prefix`
$ rm -rf Cellar
$ brew prune
$ rm `git ls-files`
$ rm -r Library/Homebrew Library/Aliases Library/Formula Library/Contributions
$ rm -rf .git
$ rm -rf ~/Library/Caches/Homebrew

查看版本
$ brew -v

更新
$ brew update

安装任意包
$ brew install 

卸载任意包
$ brew uninstall 

查看可用包
$ brew search 

查看已安装包列表
$ brew list

查看任意包信息
$ brew info

3.2、LLVM

新创建一个名字为"llvm"的文件，用户开发插件，路径均用这个

下载llvm
git clone https://git.llvm.org/git/llvm.git/

3.3、Clang (目标路径放在下载的llvm子目录的tools中)

cd /llvm/tools
git clone https://git.llvm.org/git/clang.git/

3.4、安装cmake和ninja

brew install cmake
brew install ninja

四、插件开发

涉及C++代码，未完成