深入研究Clang（四） Clang編譯器的簡單分析

作者：史寧寧（snsn1984）

首先我們確定下Clang編譯器的具體內容和涵蓋范圍。之前在《LLVM每日談之二十 Everything && Clang driver 》中曾經提到過，Clang driver（命令行表示是clang）和Clang前端（按照具體實現來說就是Clang的那些庫所實現的前端）是不同的，同時還存在一個Clang編譯器（命令行表示是clang -cc1）。Clang編譯器不僅僅包含了Clang前端，還包括使用LLVM的哭實現的編譯器的中間階段以及后端，同時也集成了assembler。

Clang driver有一系列的frontend action，這些frontend action定義于clang/include/clang/Frontend/FrontendOptions.h中的ActionKind枚舉中。其中一些frontend action就會觸發Clang編譯器（clang -cc1），比如：ASTView, EmitBC, EmitObj等。一旦觸發了Clang編譯器（clang -cc1），就會執行函數cc1_main()（clang/tools/driver/cc1_main.cpp），從名字上就可以看出來，這個函數是Clang編譯器（clang -cc1）的入口主函數。

舉個具體的例子來看一下：

min.c

int min(int a, int b) {if (a < b) {return a;}return b;
}

運行命令： clang -### min.c -o min

clang version 3.5.0 (tags/RELEASE_350/final)
Target: x86_64-unknown-linux-gnu
Thread model: posix"/home/shining/llvm-3.5/build/bin/clang-3.5" "-cc1" "-triple" "x86_64-unknown-linux-gnu" "-emit-obj" "-mrelax-all" "-disable-free" "-main-file-name" "min.c" "-mrelocation-model" "static" "-mdisable-fp-elim" "-fmath-errno" "-masm-verbose" "-mconstructor-aliases" "-munwind-tables" "-fuse-init-array" "-target-cpu" "x86-64" "-dwarf-column-info" "-resource-dir" "/home/shining/llvm-3.5/build/bin/../lib/clang/3.5.0" "-internal-isystem" "/usr/local/include" "-internal-isystem" "/home/shining/llvm-3.5/build/bin/../lib/clang/3.5.0/include" "-internal-externc-isystem" "/usr/include/x86_64-linux-gnu" "-internal-externc-isystem" "/include" "-internal-externc-isystem" "/usr/include" "-fdebug-compilation-dir" "/home/shining/llvm-3.5/build/bin" "-ferror-limit" "19" "-fmessage-length" "80" "-mstackrealign" "-fobjc-runtime=gcc" "-fdiagnostics-show-option" "-o" "/tmp/min-75c13b.o" "-x" "c" "min.c""/usr/bin/ld" "-z" "relro" "--hash-style=gnu" "--build-id" "--eh-frame-hdr" "-m" "elf_x86_64" "-dynamic-linker" "/lib64/ld-linux-x86-64.so.2" "-o" "min" "/usr/lib/gcc/x86_64-linux-gnu/4.8/../../../x86_64-linux-gnu/crt1.o" "/usr/lib/gcc/x86_64-linux-gnu/4.8/../../../x86_64-linux-gnu/crti.o" "/usr/lib/gcc/x86_64-linux-gnu/4.8/crtbegin.o" "-L/usr/lib/gcc/x86_64-linux-gnu/4.8" "-L/usr/lib/gcc/x86_64-linux-gnu/4.8/../../../x86_64-linux-gnu" "-L/lib/x86_64-linux-gnu" "-L/lib/../lib64" "-L/usr/lib/x86_64-linux-gnu" "-L/usr/lib/gcc/x86_64-linux-gnu/4.8/../../.." "-L/home/shining/llvm-3.5/build/bin/../lib" "-L/lib" "-L/usr/lib" "/tmp/min-75c13b.o" "-lgcc" "--as-needed" "-lgcc_s" "--no-as-needed" "-lc" "-lgcc" "--as-needed" "-lgcc_s" "--no-as-needed" "/usr/lib/gcc/x86_64-linux-gnu/4.8/crtend.o" "/usr/lib/gcc/x86_64-linux-gnu/4.8/../../../x86_64-linux-gnu/crtn.o"

-###參數是為了查看，clang driver到底調用了哪些命令，并且不會執行這些命令。從這里可以實際看到，實際上調用的是 clang-3.5 -cc1，其中3.5是版本號，所以其實調用的就是clang編譯器。之后又調用了系統的ld loader,因為LLVM架構的loader還在開發之中。

所以，對于那些我們已經明確需要clang編譯器去作的工作，我們可以不通過clang driver去隱式調用（比如上面的例子），而是直接在命令行調用clang -cc1去執行，并且在clang -cc1之后跟clang編譯器接受的參數。也可以通過clang -Xclang就可以直接將參數傳遞給clang編譯器（clang -cc1）。下面的具體實現，將同時給出這兩種的命令行形式，其實運行結果幾乎是完全相同的。不同的是，使用clang -Xclang的時候，如果不加強制的參數，這里雖然-Xclang將參數傳遞給了clang -cc1，但是這里的clang driver依然會繼續工作的。在下面的例子中會進行分別的展示

編譯器首先進行的是詞法分析，我們可以通過命令行去查看進行詞法分析之后的token序列到底是怎么樣的，仍然以上面的min.c為例，運行命令：

clang -cc1 -dump-tokens min.c

運行之后得到如下輸出：

int 'int'	 [StartOfLine]	Loc=<min.c:1:1>
identifier 'min'	 [LeadingSpace]	Loc=<min.c:1:5>
l_paren '('		Loc=<min.c:1:8>
int 'int'		Loc=<min.c:1:9>
identifier 'a'	 [LeadingSpace]	Loc=<min.c:1:13>
comma ','		Loc=<min.c:1:14>
int 'int'	 [LeadingSpace]	Loc=<min.c:1:16>
identifier 'b'	 [LeadingSpace]	Loc=<min.c:1:20>
r_paren ')'		Loc=<min.c:1:21>
l_brace '{'	 [LeadingSpace]	Loc=<min.c:1:23>
if 'if'	 [StartOfLine] [LeadingSpace]	Loc=<min.c:2:5>
l_paren '('	 [LeadingSpace]	Loc=<min.c:2:8>
identifier 'a'		Loc=<min.c:2:9>
less '<'	 [LeadingSpace]	Loc=<min.c:2:11>
identifier 'b'	 [LeadingSpace]	Loc=<min.c:2:13>
r_paren ')'		Loc=<min.c:2:14>
l_brace '{'	 [LeadingSpace]	Loc=<min.c:2:16>
return 'return'	 [StartOfLine] [LeadingSpace]	Loc=<min.c:3:9>
identifier 'a'	 [LeadingSpace]	Loc=<min.c:3:16>
semi ';'		Loc=<min.c:3:17>
r_brace '}'	 [StartOfLine] [LeadingSpace]	Loc=<min.c:4:5>
return 'return'	 [StartOfLine] [LeadingSpace]	Loc=<min.c:5:5>
identifier 'b'	 [LeadingSpace]	Loc=<min.c:5:12>
semi ';'		Loc=<min.c:5:13>
r_brace '}'	 [StartOfLine]	Loc=<min.c:6:1>
eof ''		Loc=<min.c:6:2>

或者選用： clang -Xclang -dump-tokens min.c

輸出信息如下：

int 'int'	 [StartOfLine]	Loc=<min.c:1:1>
identifier 'min'	 [LeadingSpace]	Loc=<min.c:1:5>
l_paren '('		Loc=<min.c:1:8>
int 'int'		Loc=<min.c:1:9>
identifier 'a'	 [LeadingSpace]	Loc=<min.c:1:13>
comma ','		Loc=<min.c:1:14>
int 'int'	 [LeadingSpace]	Loc=<min.c:1:16>
identifier 'b'	 [LeadingSpace]	Loc=<min.c:1:20>
r_paren ')'		Loc=<min.c:1:21>
l_brace '{'	 [LeadingSpace]	Loc=<min.c:1:23>
if 'if'	 [StartOfLine] [LeadingSpace]	Loc=<min.c:2:5>
l_paren '('	 [LeadingSpace]	Loc=<min.c:2:8>
identifier 'a'		Loc=<min.c:2:9>
less '<'	 [LeadingSpace]	Loc=<min.c:2:11>
identifier 'b'	 [LeadingSpace]	Loc=<min.c:2:13>
r_paren ')'		Loc=<min.c:2:14>
l_brace '{'	 [LeadingSpace]	Loc=<min.c:2:16>
return 'return'	 [StartOfLine] [LeadingSpace]	Loc=<min.c:3:9>
identifier 'a'	 [LeadingSpace]	Loc=<min.c:3:16>
semi ';'		Loc=<min.c:3:17>
r_brace '}'	 [StartOfLine] [LeadingSpace]	Loc=<min.c:4:5>
return 'return'	 [StartOfLine] [LeadingSpace]	Loc=<min.c:5:5>
identifier 'b'	 [LeadingSpace]	Loc=<min.c:5:12>
semi ';'		Loc=<min.c:5:13>
r_brace '}'	 [StartOfLine]	Loc=<min.c:6:1>
eof ''		Loc=<min.c:6:2>
/usr/bin/ld: cannot find /tmp/min-3cce9d.o: No such file or directory
clang-3.5: error: linker command failed with exit code 1 (use -v to see invocation)

明顯可以看到，使用-Xclang的時候，把-dump-tokens參數傳遞給了clang -cc1，但是clang driver依然工作，并且調用了ld.

可以使用clang -### -Xclang -dump-tokens min.c命令進行驗證。

看過了詞法分析階段，我們再看下clang編譯器語法分析來的AST nodes。

使用命令：clang -cc1 -fsyntax-only -ast-dump min.c

或者：clang -fsyntax-only -Xclang -ast-dump min.c

輸出結果一樣：

TranslationUnitDecl 0x6bc3a40 <<invalid sloc>> <invalid sloc>
|-TypedefDecl 0x6bc3f40 <<invalid sloc>> <invalid sloc> implicit __int128_t '__int128'
|-TypedefDecl 0x6bc3fa0 <<invalid sloc>> <invalid sloc> implicit __uint128_t 'unsigned __int128'
|-TypedefDecl 0x6bc42f0 <<invalid sloc>> <invalid sloc> implicit __builtin_va_list '__va_list_tag [1]'
`-FunctionDecl 0x6bc4490 <min.c:1:1, line:6:1> line:1:5 min 'int (int, int)'|-ParmVarDecl 0x6bc4350 <col:9, col:13> col:13 used a 'int'|-ParmVarDecl 0x6bc43c0 <col:16, col:20> col:20 used b 'int'`-CompoundStmt 0x6bc46f8 <col:23, line:6:1>|-IfStmt 0x6bc4668 <line:2:5, line:4:5>| |-<<<NULL>>>| |-BinaryOperator 0x6bc45c0 <line:2:9, col:13> 'int' '<'| | |-ImplicitCastExpr 0x6bc4590 <col:9> 'int' <LValueToRValue>| | | `-DeclRefExpr 0x6bc4540 <col:9> 'int' lvalue ParmVar 0x6bc4350 'a' 'int'| | `-ImplicitCastExpr 0x6bc45a8 <col:13> 'int' <LValueToRValue>| |   `-DeclRefExpr 0x6bc4568 <col:13> 'int' lvalue ParmVar 0x6bc43c0 'b' 'int'| |-CompoundStmt 0x6bc4648 <col:16, line:4:5>| | `-ReturnStmt 0x6bc4628 <line:3:9, col:16>| |   `-ImplicitCastExpr 0x6bc4610 <col:16> 'int' <LValueToRValue>| |     `-DeclRefExpr 0x6bc45e8 <col:16> 'int' lvalue ParmVar 0x6bc4350 'a' 'int'| `-<<<NULL>>>`-ReturnStmt 0x6bc46d8 <line:5:5, col:12>`-ImplicitCastExpr 0x6bc46c0 <col:12> 'int' <LValueToRValue>`-DeclRefExpr 0x6bc4698 <col:12> 'int' lvalue ParmVar 0x6bc43c0 'b' 'int'

通過clang -### -fsyntax-only -Xclang -ast-dump min.c查看實際執行命令，其實跟使用clang -cc1是相同的。

參考資料：

1. 《Getting Started with LLVM Core Libraries》

2.? Code of clang