代码生成Code generation to LLVM IR

代码生成的准备工作

在开始生成LLVM IR之前，还有一些准备工作要做。首先，给每个AST类添加一个虚函数Codegen（code generation），用于实现代码生成：

/// ExprAST - Base class for all expression nodes.

class ExprAST {

public:

virtual ~ExprAST() {}

virtual Value *Codegen() = 0;

};

/// NumberExprAST - Expression class for numeric literals like "1.0".

class NumberExprAST : public ExprAST {

double Val;

public:

NumberExprAST(double val) : Val(val) {}

virtual Value *Codegen();

};

...

每种AST节点的Codegen()方法负责生成该类型AST节点的IR代码及其他必要信息，生成的内容以LLVM Value对象的形式返回。LLVM用“Value”类表示“静态一次性赋值（SSA，Static Single Assignment）寄存器”或“SSA值”。SSA值最为突出的特点就在于“固定不变”：SSA值经由对应指令运算得出后便固定下来，直到该指令再次执行之前都不可修改。详情请参考Static Single Assignment——这个概念并不难，习惯了就好。

除了在ExprAST类体系中添加虚方法以外，还可以利用visitor模式等其他方法来实现代码生成。再次强调，本教程不拘泥于软件工程实践层面的优劣：就当前需求而言，添加虚函数是最简单的方案。

其次，我们还需要一个“Error”方法，该方法与语法解析器里用到的报错函数类似，用于报告代码生成过程中发生的错误（例如引用了未经声明的参数）：

Value *ErrorV(const char *Str) { Error(Str); return 0; }

static Module *TheModule;

static IRBuilder<> Builder(getGlobalContext());

static std::map<std::string, Value*> NamedValues;

上述几个静态变量都是用于完成代码生成的。其中TheModule是LLVM中用于存放代码段中所有函数和全局变量的结构。从某种意义上讲，可以把它当作LLVM IR代码的顶层容器。

Builder是用于简化LLVM指令生成的辅助对象。IRBuilder类模板的实例可用于跟踪当前插入指令的位置，同时还带有用于生成新指令的方法。

NamedValues映射表用于记录定义于当前作用域内的变量及与之相对应的LLVM表示（换言之，也就是代码的符号表）。在这一版的Kaleidoscope中，可引用的变量只有函数的参数。因此，在生成函数体的代码时，函数的参数就存放在这张表中。

有了这些，就可以开始进行表达式的代码生成工作了。注意，在生成代码之前必须先设置好Builder对象，指明写入代码的位置。现在，我们姑且假设已经万事俱备，专心生成代码即可。

表达式代码生成

为表达式节点生成LLVM代码的过程十分简单明了：连带注释只需区区45行代码便足以搞定全部四种表达式节点。首先是数值常量：

Value *NumberExprAST::Codegen() {

return ConstantFP::get(getGlobalContext(), APFloat(Val));

}

LLVM IR中的数值常量是由ConstantFP类表示的。在其内部，具体数值由APFloat（Arbitrary Precision Float，可用于存储任意精度的浮点数常量）表示。这段代码说白了就是新建并返回了一个ConstantFP对象。值得注意的是，在LLVM IR内部，常量都只有一份，并且是共享的。因此，API往往会采用”foo:get(...)“的形式而不是“new foo(...)”或“foo::Create(...)”。

Value *VariableExprAST::Codegen() {

// Look this variable up in the function.

Value *V = NamedValues[Name];

return V ? V : ErrorV("Unknown variable name");

}

在LLVM中引用变量也很简单。在简化版的Kaleidoscope中，我们大可假设被引用的变量已经在某处被定义并赋值。实际上，位于NamedValues映射表中的变量只可能是函数的调用参数。这段代码首先确认给定的变量名是否存在于映射表中（如果不存在，就说明引用了未定义的变量）然后返回该变量的值。在后续章节中，我们还会对语言做进一步的扩展，让符号表支持“循环归纳变量”和局部变量。

Value *BinaryExprAST::Codegen() {

Value *L = LHS->Codegen();

Value *R = RHS->Codegen();

if (L == 0 || R == 0) return 0;

switch (Op) {

case '+': return Builder.CreateFAdd(L, R, "addtmp");

case '-': return Builder.CreateFSub(L, R, "subtmp");

case '*': return Builder.CreateFMul(L, R, "multmp");

case '<':

L = Builder.CreateFCmpULT(L, R, "cmptmp");

// Convert bool 0/1 to double 0.0 or 1.0

return Builder.CreateUIToFP(L, Type::getDoubleTy(getGlobalContext()),

"booltmp");

default: return ErrorV("invalid binary operator");

}

二元运算符的处理就比较有意思了。其基本思想是递归地生成代码，先处理表达式的左侧，再处理表达式的右侧，最后计算整个二元表达式的值。上述代码就opcode的取值用了一个简单的switch语句，从而为各种二元运算符创建出相应的LLVM指令。

在上面的例子中，LLVM的Builder类逐渐开始凸显出自身的价值。你只需想清楚该用哪些操作数（即此处的L和R）生成哪条指令（通过调用CreateFAdd等方法）即可，至于新指令该插入到什么位置，交给IRBuilder就可以了。此外，如果需要，你还可以给生成的指令指定一个名字。

LLVM的优点之一在于此处的指令名只是一个提示。举个例子，假设上述代码生成了多条“addtmp”指令，LLVM会自动给每条指令的名字追加一个自增的唯一数字后缀。指令的local value name完全是可选的，但它能大大提升dump出来的IR代码的可读性。

LLVM指令遵循严格的约束：例如，add指令的Left、Right操作数必须同属一个类型，结果的类型则必须与操作数的类型相容。由于Kaleidoscope中的值都是双精度浮点数，add、sub和mul指令的代码得以大大简化。

然而，LLVM要求fcmp指令的返回值类型必须是‘i1’（单比特整数）。问题在于Kaleidoscope只能接受0.0或1.0。为了弥合语义上的差异，我们给fcmp指令配上一条uitofp指令。这条指令会将输入的整数视作无符号数，并将之转换成浮点数。相应地，如果用的是sitofp指令，Kaleidoscope的‘<’运算符将视输入的不同而返回0.0或-1.0。

Value *CallExprAST::Codegen() {

// Look up the name in the global module table.

Function *CalleeF = TheModule->getFunction(Callee);

if (CalleeF == 0)

return ErrorV("Unknown function referenced");

// If argument mismatch error.

if (CalleeF->arg_size() != Args.size())

return ErrorV("Incorrect # arguments passed");

std::vector<Value*> ArgsV;

for (unsigned i = 0, e = Args.size(); i != e; ++i) {

ArgsV.push_back(Args[i]->Codegen());

if (ArgsV.back() == 0) return 0;

}

return Builder.CreateCall(CalleeF, ArgsV, "calltmp");

}

函数调用的代码生成非常直截了当。上述代码开头的几行是在LLVM Module的符号表中查找函数名。如前文所述，LLVM Module是个容器，待处理的函数全都在里面。只要保证各函数的名字与用户指定的函数名一致，我们就可以利用LLVM的符号表替我们完成函数名的解析。

拿到待调用的函数之后，就递归地生成传入的各个参数的代码，并创建一条LLVM call指令。注意，LLVM默认采用本地的C调用规范，这样以来，就可以毫不费力地调用标准库中的“sin”、“cos”等函数了。

Kaleidoscope中的四种基本表达式的代码生成就介绍完了。尽情地添枝加叶去吧。去试试LLVM语言参考上的各种千奇百怪的指令，以当前的基本框架为基础，支持这些指令易如反掌。

函数的代码生成

函数原型和函数的代码生成比较繁琐，相关代码不及表达式的代码生成来得优雅，不过却刚好可以用于演示一些重要概念。首先，我们来看看函数原型的代码生成过程：函数定义和外部函数声明都依赖于它。这部分代码一开始是这样的：

Function *PrototypeAST::Codegen() {

// Make the function type: double(double,double) etc.

std::vector<Type*> Doubles(Args.size(),

Type::getDoubleTy(getGlobalContext()));

FunctionType *FT = FunctionType::get(Type::getDoubleTy(getGlobalContext()),

Doubles, false);

Function *F = Function::Create(FT, Function::ExternalLinkage, Name, TheModule);

短短几行暗藏玄机。首先需要注意的是该函数的返回值类型是“Function*”而不是“Value*”。“函数原型”描述的是函数的对外接口（而不是某表达式计算出的值），返回代码生成过程中与之相对应的LLVM Function自然也合情合理。

FunctionType::get调用用于为给定的函数原型创建对应的FunctionType对象。在Kaleidoscope中，函数的参数全部都是double，因此第一行创建了一个包含“N”个LLVM double的vector。随后，FunctionType::get方法以这“N”个double为参数类型、以单个double为返回值类型，创建出一个参数个数不可变（最后一个参数false就是这个意思）的函数类型。注意，和常数一样，LLVM中的类型对象也是单例，应该用“get”而不是“new”来获取。

最后一行实际上创建的是与该函数原型相对应的函数。其中包含了类型、链接方式和函数名等信息，还指定了该函数待插入的模块。“ExternalLinkage”表示该函数可能定义于当前模块之外，且/或可以被当前模块之外的函数调用。Name是用户指定的函数名：如上述代码中的调用所示，既然将函数定义在“TheModule”内，函数名自然也注册在“TheModule”的符号表内。

// If F conflicted, there was already something named 'Name'. If it has a

// body, don't allow redefinition or reextern.

if (F->getName() != Name) {

// Delete the one we just made and get the existing one.

F->eraseFromParent();

F = TheModule->getFunction(Name);

在处理名称冲突时，Module的符号表与Function的符号表类似：在模块中添加新函数时，如果发现函数名与符号表中现有的名称重复，新函数会被默默地重命名。上述代码用于检测函数有否被定义过。

对于Kaleidoscope，在两种情况下允许重定义函数：第一，允许对同一个函数进行多次extern声明，前提是所有声明中的函数原型保持一致（由于只有一种参数类型，我们只需要检查参数的个数是否匹配即可）。第二，允许先对函数进行extern声明，再定义函数体。这样一来，才能定义出相互递归调用的函数。

为了实现这些功能，上述代码首先检查是否存在函数名冲突。如果存在，（调用eraseFunctionParent）将刚刚创建的函数对象删除，然后调用getFunction获取与函数名相对应的函数对象。请注意，LLVM中有很多erase形式和remove形式的API。remove形式的API只会将对象从父对象处摘除并返回。erase形式的API不仅会摘除对象，还会将之删除。

// If F already has a body, reject this.

if (!F->empty()) {

ErrorF("redefinition of function");

return 0;

}

// If F took a different number of args, reject.

if (F->arg_size() != Args.size()) {

ErrorF("redefinition of function with different # args");

return 0;

}

为了在上述代码的基础上进一步进行校验，我们来看看之前定义的函数对象是否为“空”。换言之，也就是看看该函数有没有定义基本块。没有基本块就意味着该函数尚未定义函数体，只是一个前导声明。如果已经定义了函数体，就不能继续下去了，抛出错误予以拒绝。如果之前的函数对象只是个“extern”声明，则检查该函数的参数个数是否与当前的参数个数相符。如果不符，抛出错误。

// Set names for all arguments.

unsigned Idx = 0;

for (Function::arg_iterator AI = F->arg_begin(); Idx != Args.size();

++AI, ++Idx) {

AI->setName(Args[Idx]);

// Add arguments to variable symbol table.

NamedValues[Args[Idx]] = AI;

}

最后，遍历函数原型的所有参数，为这些LLVM Argument对象逐一设置参数名，并将这些参数注册倒NamedValues映射表内，以备AST节点类VariableExprAST稍后使用。完事之后，将Function对象返回。注意，此处并不检查参数名冲突与否（说的是“extern foo(a b a”这样的情况）。按照之前的讲解，要加上这一重检查易如反掌。

Function *FunctionAST::Codegen() {

NamedValues.clear();

Function *TheFunction = Proto->Codegen();

if (TheFunction == 0)

return 0;

下面是函数定义的代码生成过程，开场白很简单：生成函数原型（Proto）的代码并进行校验。与此同时，需要清空NamedValues映射表，确保其中不会残留之前代码生成过程中的产生的内容。函数原型的代码生成完毕后，一个现成的LLVM Function对象就到手了。

// Create a new basic block to start insertion into.

BasicBlock *BB = BasicBlock::Create(getGlobalContext(), "entry", TheFunction);

Builder.SetInsertPoint(BB);

if (Value *RetVal = Body->Codegen()) {

现在该开始设置Builder对象了。第一行新建了一个名为“entry”的基本块对象，稍后该对象将被插入TheFunction。第二行告诉Builder，后续的新指令应该插至刚刚新建的基本块的末尾处。LLVM基本块是用于定义控制流图（Control Flow Graph）的重要部件。当前我们还不涉及到控制流，所以所有的函数都只有一个基本块。这个问题我们留到第五章再改 :-)

if (Value *RetVal = Body->Codegen()) {

// Finish off the function.

Builder.CreateRet(RetVal);

// Validate the generated code, checking for consistency.

verifyFunction(*TheFunction);

return TheFunction;

}

选好插入点后，调用函数主表达式的CodeGen()方法。不出意外的话，

完整代码

// To build this:

// See example below.

#include "llvm/DerivedTypes.h"

#include "llvm/IRBuilder.h"

#include "llvm/LLVMContext.h"

#include "llvm/Module.h"

#include "llvm/Analysis/Verifier.h"

#include <cstdio>

#include <string>

#include <map>

#include <vector>

using namespace llvm;

//===----------------------------------------------------------------------===//

// Lexer

//===----------------------------------------------------------------------===//

// The lexer returns tokens [0-255] if it is an unknown character, otherwise one

// of these for known things.

enum Token {

tok_eof = -1,

// commands

tok_def = -2, tok_extern = -3,

// primary

tok_identifier = -4, tok_number = -5

};

static std::string IdentifierStr; // Filled in if tok_identifier

static double NumVal; // Filled in if tok_number

/// gettok - Return the next token from standard input.

static int gettok() {

static int LastChar = ' ';

// Skip any whitespace.

while (isspace(LastChar))

LastChar = getchar();

if (isalpha(LastChar)) { // identifier: [a-zA-Z][a-zA-Z0-9]*

IdentifierStr = LastChar;

while (isalnum((LastChar = getchar())))

IdentifierStr += LastChar;

if (IdentifierStr == "def") return tok_def;

if (IdentifierStr == "extern") return tok_extern;

return tok_identifier;

}

if (isdigit(LastChar) || LastChar == '.') { // Number: [0-9.]+

std::string NumStr;

do {

NumStr += LastChar;

LastChar = getchar();

} while (isdigit(LastChar) || LastChar == '.');

NumVal = strtod(NumStr.c_str(), 0);

return tok_number;

}

if (LastChar == '#') {

// Comment until end of line.

do LastChar = getchar();

while (LastChar != EOF && LastChar != '\n' && LastChar != '\r');

if (LastChar != EOF)

return gettok();

}

// Check for end of file. Don't eat the EOF.

if (LastChar == EOF)

return tok_eof;

// Otherwise, just return the character as its ascii value.

int ThisChar = LastChar;

LastChar = getchar();

return ThisChar;

}

//===----------------------------------------------------------------------===//

// Abstract Syntax Tree (aka Parse Tree)

//===----------------------------------------------------------------------===//

/// ExprAST - Base class for all expression nodes.

class ExprAST {

public:

virtual ~ExprAST() {}

virtual Value *Codegen() = 0;

};

/// NumberExprAST - Expression class for numeric literals like "1.0".

class NumberExprAST : public ExprAST {

double Val;

public:

NumberExprAST(double val) : Val(val) {}

virtual Value *Codegen();

};

/// VariableExprAST - Expression class for referencing a variable, like "a".

class VariableExprAST : public ExprAST {

std::string Name;

public:

VariableExprAST(const std::string &name) : Name(name) {}

virtual Value *Codegen();

};

/// BinaryExprAST - Expression class for a binary operator.

class BinaryExprAST : public ExprAST {

char Op;

ExprAST *LHS, *RHS;

public:

BinaryExprAST(char op, ExprAST *lhs, ExprAST *rhs)

: Op(op), LHS(lhs), RHS(rhs) {}

virtual Value *Codegen();

};

/// CallExprAST - Expression class for function calls.

class CallExprAST : public ExprAST {

std::string Callee;

std::vector<ExprAST*> Args;

public:

CallExprAST(const std::string &callee, std::vector<ExprAST*> &args)

: Callee(callee), Args(args) {}

virtual Value *Codegen();

};

/// PrototypeAST - This class represents the "prototype" for a function,

/// which captures its name, and its argument names (thus implicitly the number

/// of arguments the function takes).

class PrototypeAST {

std::string Name;

std::vector<std::string> Args;

public:

PrototypeAST(const std::string &name, const std::vector<std::string> &args)

: Name(name), Args(args) {}

Function *Codegen();

};

/// FunctionAST - This class represents a function definition itself.

class FunctionAST {

PrototypeAST *Proto;

ExprAST *Body;

public:

FunctionAST(PrototypeAST *proto, ExprAST *body)

: Proto(proto), Body(body) {}

Function *Codegen();

};

//===----------------------------------------------------------------------===//

// Parser

//===----------------------------------------------------------------------===//

/// CurTok/getNextToken - Provide a simple token buffer. CurTok is the current

/// token the parser is looking at. getNextToken reads another token from the

/// lexer and updates CurTok with its results.

static int CurTok;

static int getNextToken() {

return CurTok = gettok();

}

/// BinopPrecedence - This holds the precedence for each binary operator that is

/// defined.

static std::map<char, int> BinopPrecedence;

/// GetTokPrecedence - Get the precedence of the pending binary operator token.

static int GetTokPrecedence() {

if (!isascii(CurTok))

return -1;

// Make sure it's a declared binop.

int TokPrec = BinopPrecedence[CurTok];

if (TokPrec <= 0) return -1;

return TokPrec;

}

/// Error* - These are little helper functions for error handling.

ExprAST *Error(const char *Str) { fprintf(stderr, "Error: %s\n", Str);return 0;}

PrototypeAST *ErrorP(const char *Str) { Error(Str); return 0; }

FunctionAST *ErrorF(const char *Str) { Error(Str); return 0; }

static ExprAST *ParseExpression();

/// identifierexpr

/// ::= identifier

/// ::= identifier '(' expression* ')'

static ExprAST *ParseIdentifierExpr() {

std::string IdName = IdentifierStr;

getNextToken(); // eat identifier.

if (CurTok != '(') // Simple variable ref.

return new VariableExprAST(IdName);

// Call.

getNextToken(); // eat (

std::vector<ExprAST*> Args;

if (CurTok != ')') {

while (1) {

ExprAST *Arg = ParseExpression();

if (!Arg) return 0;

Args.push_back(Arg);

if (CurTok == ')') break;

if (CurTok != ',')

return Error("Expected ')' or ',' in argument list");

getNextToken();

}

// Eat the ')'.

getNextToken();

return new CallExprAST(IdName, Args);

}

/// numberexpr ::= number

static ExprAST *ParseNumberExpr() {

ExprAST *Result = new NumberExprAST(NumVal);

getNextToken(); // consume the number

return Result;

}

/// parenexpr ::= '(' expression ')'

static ExprAST *ParseParenExpr() {

getNextToken(); // eat (.

ExprAST *V = ParseExpression();

if (!V) return 0;

if (CurTok != ')')

return Error("expected ')'");

getNextToken(); // eat ).

return V;

}

/// primary

/// ::= identifierexpr

/// ::= numberexpr

/// ::= parenexpr

static ExprAST *ParsePrimary() {

switch (CurTok) {

default: return Error("unknown token when expecting an expression");

case tok_identifier: return ParseIdentifierExpr();

case tok_number: return ParseNumberExpr();

case '(': return ParseParenExpr();

}

/// binoprhs

/// ::= ('+' primary)*

static ExprAST *ParseBinOpRHS(int ExprPrec, ExprAST *LHS) {

// If this is a binop, find its precedence.

while (1) {

int TokPrec = GetTokPrecedence();

// If this is a binop that binds at least as tightly as the current binop,

// consume it, otherwise we are done.

if (TokPrec < ExprPrec)

return LHS;

// Okay, we know this is a binop.

int BinOp = CurTok;

getNextToken(); // eat binop

// Parse the primary expression after the binary operator.

ExprAST *RHS = ParsePrimary();

if (!RHS) return 0;

// If BinOp binds less tightly with RHS than the operator after RHS, let

// the pending operator take RHS as its LHS.

int NextPrec = GetTokPrecedence();

if (TokPrec < NextPrec) {

RHS = ParseBinOpRHS(TokPrec+1, RHS);

if (RHS == 0) return 0;

}

// Merge LHS/RHS.

LHS = new BinaryExprAST(BinOp, LHS, RHS);

}

/// expression

/// ::= primary binoprhs

///

static ExprAST *ParseExpression() {

ExprAST *LHS = ParsePrimary();

if (!LHS) return 0;

return ParseBinOpRHS(0, LHS);

}

/// prototype

/// ::= id '(' id* ')'

static PrototypeAST *ParsePrototype() {

if (CurTok != tok_identifier)

return ErrorP("Expected function name in prototype");

std::string FnName = IdentifierStr;

getNextToken();

if (CurTok != '(')

return ErrorP("Expected '(' in prototype");

std::vector<std::string> ArgNames;

while (getNextToken() == tok_identifier)

ArgNames.push_back(IdentifierStr);

if (CurTok != ')')

return ErrorP("Expected ')' in prototype");

// success.

getNextToken(); // eat ')'.

return new PrototypeAST(FnName, ArgNames);

}

/// definition ::= 'def' prototype expression

static FunctionAST *ParseDefinition() {

getNextToken(); // eat def.

PrototypeAST *Proto = ParsePrototype();

if (Proto == 0) return 0;

if (ExprAST *E = ParseExpression())

return new FunctionAST(Proto, E);

return 0;

}

/// toplevelexpr ::= expression

static FunctionAST *ParseTopLevelExpr() {

if (ExprAST *E = ParseExpression()) {

// Make an anonymous proto.

PrototypeAST *Proto = new PrototypeAST("", std::vector<std::string>());

return new FunctionAST(Proto, E);

}

return 0;

}

/// external ::= 'extern' prototype

static PrototypeAST *ParseExtern() {

getNextToken(); // eat extern.

return ParsePrototype();

}

//===----------------------------------------------------------------------===//

// Code Generation

//===----------------------------------------------------------------------===//

static Module *TheModule;

static IRBuilder<> Builder(getGlobalContext());

static std::map<std::string, Value*> NamedValues;

Value *ErrorV(const char *Str) { Error(Str); return 0; }

Value *NumberExprAST::Codegen() {

return ConstantFP::get(getGlobalContext(), APFloat(Val));

}

Value *VariableExprAST::Codegen() {

// Look this variable up in the function.

Value *V = NamedValues[Name];

return V ? V : ErrorV("Unknown variable name");

}

Value *BinaryExprAST::Codegen() {

Value *L = LHS->Codegen();

Value *R = RHS->Codegen();

if (L == 0 || R == 0) return 0;

switch (Op) {

case '+': return Builder.CreateFAdd(L, R, "addtmp");

case '-': return Builder.CreateFSub(L, R, "subtmp");

case '*': return Builder.CreateFMul(L, R, "multmp");

case '<':

L = Builder.CreateFCmpULT(L, R, "cmptmp");

// Convert bool 0/1 to double 0.0 or 1.0

return Builder.CreateUIToFP(L, Type::getDoubleTy(getGlobalContext()),

"booltmp");

default: return ErrorV("invalid binary operator");

}

Value *CallExprAST::Codegen() {

// Look up the name in the global module table.

Function *CalleeF = TheModule->getFunction(Callee);

if (CalleeF == 0)

return ErrorV("Unknown function referenced");

// If argument mismatch error.

if (CalleeF->arg_size() != Args.size())

return ErrorV("Incorrect # arguments passed");

std::vector<Value*> ArgsV;

for (unsigned i = 0, e = Args.size(); i != e; ++i) {

ArgsV.push_back(Args[i]->Codegen());

if (ArgsV.back() == 0) return 0;

}

return Builder.CreateCall(CalleeF, ArgsV, "calltmp");

}

Function *PrototypeAST::Codegen() {

// Make the function type: double(double,double) etc.

std::vector<Type*> Doubles(Args.size(),

Type::getDoubleTy(getGlobalContext()));

FunctionType *FT = FunctionType::get(Type::getDoubleTy(getGlobalContext()),

Doubles, false);

Function *F = Function::Create(FT, Function::ExternalLinkage, Name, TheModule);

// If F conflicted, there was already something named 'Name'. If it has a

// body, don't allow redefinition or reextern.

if (F->getName() != Name) {

// Delete the one we just made and get the existing one.

F->eraseFromParent();

F = TheModule->getFunction(Name);

// If F already has a body, reject this.

if (!F->empty()) {

ErrorF("redefinition of function");

return 0;

}

// If F took a different number of args, reject.

if (F->arg_size() != Args.size()) {

ErrorF("redefinition of function with different # args");

return 0;

}

// Set names for all arguments.

unsigned Idx = 0;

for (Function::arg_iterator AI = F->arg_begin(); Idx != Args.size();

++AI, ++Idx) {

AI->setName(Args[Idx]);

// Add arguments to variable symbol table.

NamedValues[Args[Idx]] = AI;

}

return F;

}

Function *FunctionAST::Codegen() {

NamedValues.clear();

Function *TheFunction = Proto->Codegen();

if (TheFunction == 0)

return 0;

// Create a new basic block to start insertion into.

BasicBlock *BB = BasicBlock::Create(getGlobalContext(), "entry", TheFunction);

Builder.SetInsertPoint(BB);

if (Value *RetVal = Body->Codegen()) {

// Finish off the function.

Builder.CreateRet(RetVal);

// Validate the generated code, checking for consistency.

verifyFunction(*TheFunction);

return TheFunction;

}

// Error reading body, remove function.

TheFunction->eraseFromParent();

return 0;

}

//===----------------------------------------------------------------------===//

// Top-Level parsing and JIT Driver

//===----------------------------------------------------------------------===//

static void HandleDefinition() {

if (FunctionAST *F = ParseDefinition()) {

if (Function *LF = F->Codegen()) {

fprintf(stderr, "Read function definition:");

LF->dump();

}

} else {

// Skip token for error recovery.

getNextToken();

}

static void HandleExtern() {

if (PrototypeAST *P = ParseExtern()) {

if (Function *F = P->Codegen()) {

fprintf(stderr, "Read extern: ");

F->dump();

}

} else {

// Skip token for error recovery.

getNextToken();

}

static void HandleTopLevelExpression() {

// Evaluate a top-level expression into an anonymous function.

if (FunctionAST *F = ParseTopLevelExpr()) {

if (Function *LF = F->Codegen()) {

fprintf(stderr, "Read top-level expression:");

LF->dump();

}

} else {

// Skip token for error recovery.

getNextToken();

}

/// top ::= definition | external | expression | ';'

static void MainLoop() {

while (1) {

fprintf(stderr, "ready> ");

switch (CurTok) {

case tok_eof: return;

case ';': getNextToken(); break; // ignore top-level semicolons.

case tok_def: HandleDefinition(); break;

case tok_extern: HandleExtern(); break;

default: HandleTopLevelExpression(); break;

}

//===----------------------------------------------------------------------===//

// "Library" functions that can be "extern'd" from user code.

//===----------------------------------------------------------------------===//

/// putchard - putchar that takes a double and returns 0.

extern "C"

double putchard(double X) {

putchar((char)X);

return 0;

}

//===----------------------------------------------------------------------===//

// Main driver code.

//===----------------------------------------------------------------------===//

int main() {

LLVMContext &Context = getGlobalContext();

// Install standard binary operators.

// 1 is lowest precedence.

BinopPrecedence['<'] = 10;

BinopPrecedence['+'] = 20;

BinopPrecedence['-'] = 20;

BinopPrecedence['*'] = 40; // highest.

// Prime the first token.

fprintf(stderr, "ready> ");

getNextToken();

// Make the module, which holds all the code.

TheModule = new Module("my cool jit", Context);

// Run the main "interpreter loop" now.

MainLoop();

// Print out all of the generated code.

TheModule->dump();

return 0;

}

生成中间的IR代码

完成了语法分析之后，代码生成器（Code Generation）会将语法树自顶而下进行遍历并逐步翻译成LLVM IR。通过下面的命令可以生成.ll文本文件，.ll文本文件里面就是IR代码

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

执行之后就会在相同路径下看到，多了一个main.ll文件：

IR的基本语法如下：

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

接下来我们就来分析一下。

首先将源代码稍微修改一下：

然后调用指令生成一份IR文件，查看该IR文件如下：

2.4 优化

接下来重点分析一下test函数：

经过分析，我们可以知道，这里面做的事情是：

将test函数的参数a0和a1传递给临时变量a3和a4，再将a3和a4传递给临时变量a5和a6，然后计算a5和a6的和并传给a7，然后计算a7和3的和传给a8，最后返回a8。

函数test的功能无非就是计算传入的两参数的和，再加上一个常数3，用得着像上面那样搞那么多中间变量吗？我要是在业务开发中写出这样冗余的代码，恐怕早被打死了。

其实，这样冗余的代码实际上是通过语法树遍历逐步生成的IR代码，这是无可厚非的。那么这样的冗余代码可以被优化吗？答案是可以的。

在Build Settings的code generation里面，有一个优化级别的选项：

可以看到，Debug模式下默认是不优化的，Release模式下才会优化。

再来看一下优化级别的选项：

可以看到，最小的是O0，即不进行任何优化。

接下来我们在llvm指令中修改一下优化级别：

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

执行之后再来看一下IR代码：

再比较一下优化之前的IR代码，可以很明显的地感觉到，冗余代码少了！

这就是LLVM的优化！

接下来聊一聊LLVM优化过程中的节点——pass。pass是很重要的一个概念，他不属于Clang前端，而是属于LLVM后端。

pass是LLVM优化过程中的一个节点，LLVM在优化代码的时候是一个节点一个节点去优化的，每一个节点去做一些优化的事情，最后加起来构成优化的转化，所以说LLVM的优化是由多个pass节点组成的。

我们可以通过自己写pass来改变LLVM的优化，比如可以通过自定义pass节点来使代码的逻辑变得更加复杂（增加一些中间变量、增加一些中间函数的调用），这样做的目的是什么呢？目的就是为了代码混淆。

2.5 bitCode优化

Xcode7之后，如果开启BitCode，那么苹果会在IR代码的基础上做更进一步的优化，最后生成.bc中间代码。

命令如下：

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

3，生成汇编代码

上一阶段最终生成的.bc或者.ll代码，在这里会生成汇编代码，命令如下：

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

前面我们提到，在编译阶段，可以通过调整优化级别参数以及bitcode优化，这里的优化是优化器负责的各种优化。需要注意的是，由IR代码或者bc代码转成汇编的过程中，也可以进行优化，这里的优化是由后端Backend负责的机器相关的代码优化，如下：

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

当然，我们也可以不通过前面的步骤，直接通过main.m来生成汇编代码：

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

其中，-Os是优化级别参数，加上了就会优化，不加就不会优化。

生成目标文件

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

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

生成可执行文件（Mach-O）

链接器是把编译产生的一堆.o文件和.dylib/.a文件的集合进行链接，最后生成一个mach-o可执行文件。

clang main.o -o main

我们先使用nm命令来查看一下链接之前的main.o文件中的符号：

$xcrun nm -nm main.o

然后对main.o进行链接生成main，之后使用nm命令来查看链接之后的可执行文件main文件中的符号：

可以看到，在_printf函数后面会多出一个(from libSystem)来显示其来源，这就是链接的作用。

当可执行文件main要被执行的时候，main.o内部有一个来自外部的符号，如果要调用该函数，那么就需要dyld在加载的时候进行绑定，那么绑定什么呢？(from libSystem)就告诉dyld需要绑定libSystem库。

我们要执行可执行文件可以使用如下命令：

./main

要查看可执行文件的详情呢，可以使用如下命令：

file main

输出结果如下：

main: Mach-O 64-bit executable x86_64

参考文献链接

https://mp.weixin.qq.com/s/OpMvRKrW95pbP8YSHLErdg

https://mp.weixin.qq.com/s/W7pmD9GtN3jtiyujH9bBvw

posted @ 2023-02-10 04:38 吴建明wujianming 阅读(158) 评论(0) 编辑收藏举报

刷新页面返回顶部

吴建明

代码生成Code generation to LLVM IR

公告