llvm IR指令与llvm开发中对应的类与API

SetInsertPoint系列API的作用是设置要插入指令的位置，比如在基本块的后面或某指令的前面等，包括3个重载函数，这3个重载函数的详细定义可参看官网http://llvm.org/doxygen/classllvm_1_1IRBuilderBase.html#ace45cae6925c65e9d6916e09dd5b17cc，以参数为基本块的API为例：

void llvm::IRBuilderBase::SetInsertPoint(BasicBlock * TheBB)

TheBB形参表示要将创建的指令追加到哪个基本块的末尾，也就是插入的指令属于哪个基本块，换而言之，调用该语句之后，所有的创建指令的语句创建的指令都将依次添加至该基本块末尾，举个简单例子：

BasicBlock* for_body = BasicBlock::Create(module->getContext(), "for.body", fun);
BasicBlock* for_inc = BasicBlock::Create(module->getContext(), "for.inc", fun);
...省略若干代码...
//////////////////////for_body///////////////////////////////
builder.SetInsertPoint(for_body);
builder.CreateBr(for_inc);//该br指令位于for_body基本块内
//////////////////////for_inc///////////////////////////////
builder.SetInsertPoint(for_inc);//如下的所有指令都位于for_inc基本块内
Value*tmp = builder.CreateLoad(i);
Value*inc = builder.CreateAdd(tmp, builder.getInt32(1), "inc", false, true);
builder.CreateStore(inc, i);
builder.CreateBr(for_cond);
...省略若干代码...

如上一些代码则创建的指令所属的基本块如上面的分割线所示

整形常量在llvm中用ConstantInt表示，创建一个整形常量可以使用get函数，其定义如下：

static ConstantInt *get(IntegerType *Ty, uint64_t V,bool isSigned = false);

第一个参数Ty表示整形的类型，如int8,int32等，第二个参数是要创建的常量的值，第三个参数isSigned表示是否是有符号数，默认为false。比如在c/c++代码中有如下一段语句

int i=0;

即创建一个整数（32位）值为0，那么对应的llvm代码如下所示：

Value * i = ConstantInt::get(Type::getInt32Ty(M.getContext()), 0);

Value是ConstantInt的间接基类，可以看到在llvm中几乎所有的操作都是通过指针进行的，get函数返回的是指向了值为0的那块内存的地址。

如前面所述，如果使用IRBuilder那么代码可以简化为：

Value *i= builder.getInt32(0);//builder是创建的IRBuilder对象的实例

浮点型常量在llvm中用ConstantFP表示，创建一个浮点形常量也使用get函数，其定义如下：

 static Constant *get(Type* Ty, double V);

第一个参数Ty表示浮点数类型，第二个参数表示要创建的浮点型常量的值。如下是一个简单示例代码：

Value * i = ConstantFP::get(Type::getFloatTy(M.getContext()), 1.0);

CDS有一些重要的API接口

• getElementAsXX系列，获取第i处索引的值按照XX类型，比如uint64_t getElementAsInteger(unsigned i) float getElementAsFloat(unsigned i)
• getNumElements()返回该CDS的元素个数
• getElementByteSize()返回CDS每个元素的大小按照byte计算
• isString()/isCString()该CDS是否是字符串/C风格字符串
• StringRef getAsString()/StringRef getAsCString() 如果该CDS是字符串类型，则返回其对应的字符串的StringRef表示（返回值StringRef是llvm中的字符串类）
• StringRef getRawDataValues()返回该CDS的原始的底层字节（Return the raw, underlying, bytes of this data）

CDS提供的API接口不止上面这些，但是上面这些是相对而言非常重要的，在实际开发中可能会经常使用到的一些API接口，比如如果我们想要修改IR当中的某些全局字符串变量（在llvm中用GlobalVariable类表示）的值，可以先将全局变量（假设叫做gv）转为CDS，然后使用getRawDataValues()方法得到该CDS的StringRef表示，然后取其data字段即可得到该字符串变量的起始地址的指针。然后就可以通过指针操作修改其值。如下代码是个简单示例：

ConstantDataSequential *cds = dyn_cast<ConstantDataSequential>(gv->getInitializer());
if (cds) {
        const char *strValue = cdata->getRawDataValues().data();//全局字符串常量对应的起始地址
	unsigned len = cds->getNumElements()*cds->getElementByteSize();//该字符串的长度,该长度是包括字符串的结尾字符\0的
        char *str = const_cast<char *>(strValue);//将const指针强制转为非const，接下来就可以通过该指针修改字符串的值
}

常量数组中有一个重要API接口getString，因为该API接口很重要，所以看下其定义与注释：

从注释可以看到该函数可以构造一个CDS通过传入的字符串StringRef。也正是因为这个特性，在llvm中创建一个字符串可以使用常量数组ConstantDataArray这个类,然后将其传递给一个全局变量GlobalVariable进行初始化（原因在llvm中间语言IR介绍中讲过c/c++源码中定义的所有的字符串在IR的Module中是以全局变量存在的,以@开头），如下是一个示例代码：

Constant* const_array = ConstantDataArray::getString(mod->getContext(), str, true);//创建一个字符串常量
ArrayType *ArrayTy = ArrayType::get(IntegerType::get(mod->getContext(), 8), str.length()+1);
GlobalVariable *global_str = new GlobalVariable(*mod, ArrayTy, true,GlobalValue::PrivateLinkage, 0, "gv_name");
global_str ->setAlignment(1);
global_str ->setInitializer(const_array);//将字符串常量传递给全局变量进行初始化

全局变量GlobalVariable，前面说过GlobalVariable实际上也是常量Constant，那为何叫做全局变量呢？我的理解是这里的全局是从生命周期角度来说的，而不是作用域，变量是相对原c/c++代码来说的，而常量是相对于IR而言的。比如在c/c++代码的函数中创建的一个局部的字符串变量，最终在IR中会以GlobalVariable的形式存在。该类的构造函数主要包括如下2中形式：

一般而言创建一个全局变量使用第2中重载形式，即包括Module参数，如下是一个简单的创建全局变量的示例代码：

GlobalVariable *global_str = new GlobalVariable(*mod, ArrayTy, true,GlobalValue::PrivateLinkage, 0, "gv_name");
global_str ->setAlignment(1);
global_str ->setInitializer(const_array);

其各个参数的含义如下：

• Module：该GV所在的Module
• Ty：该GV的类型，比如上面那个示例代码表示是数组类型
• isConstant:是否是常量，如果传递true，则表示该GV在程序中不可变，此时就对应c/c++中的常量概念了
• Linkage：链接属性
• Initializer：初始化常量，也就是该GV指针指向的内存。
• Name：该GV的名称，会体现在中间语言IR中

对于全局变量GlobalVariable而言，必须进行初始化，也就是说必须调用setInitializer()函数或者在创建时在构造函数中通过Initializer参数设置该GV所指向的内存，否则在后端进行编译处理时会抛出异常。如果该值等于NULL则会将原GV指向的地址取消，重新指向NULL。这和c语言中的指针使用是很像的，举个例子就很容易明白了。

int i;
int * p_i = &i;//创建p_i指针同时让其指向i变量
p_i = NULL;//取消原先的指向

Function是llvm层次结构中较复杂的类，通常包括基本块，形参列表，形参和指令的符号表。

/// Function ctor - If the (optional) Module argument is specified, the
/// function is automatically inserted into the end of the function list for
/// the module.
Function(FunctionType *Ty, LinkageTypes Linkage,const Twine &N = "", Module *M = nullptr);

其中FunctonType参数用来指定该函数的返回值类型，参数类型等，其定义如下：

FunctionType(Type *Result, ArrayRef<Type*> Params, bool IsVarArgs);

如下是一个简单的创建函数的示例代码：

std::vector<Type*>FuncTy_args;
FunctionType* FuncTy = FunctionType::get(
/*Result=*/Type::getVoidTy(module->getContext()), // returning void
/*Params=*/FuncTy_args, // taking no args
/*isVarArg=*/false);
Function* fun = Function::Create(FuncTy, GlobalValue::ExternalLinkage, "test_fun", module);
fun->setCallingConv(CallingConv::C);

该函数无基本块，所以相当于c/c++中的函数声明而不是定义，如果要定义一个函数需要在该函数中插入基本块，如下是个简单示例

BasicBlock* entry = BasicBlock::Create(module->getContext(), "entry", fun);//在函数fun中创建一个名为entry的基本块

所以一个简单的完整的创建函数的示例代码如下：

IRBuilder<> builder(module->getContext());
//定义函数 
std::vector<Type*>FuncTy_args;
FunctionType* FuncTy = FunctionType::get(
/*Result=*/Type::getVoidTy(module->getContext()), // returning void
/*Params=*/FuncTy_args, // taking no args
/*isVarArg=*/false);
Function* fun = Function::Create(FuncTy, GlobalValue::ExternalLinkage, "test_fun", module);
fun->setCallingConv(CallingConv::C);
//创建基本块，该基本块无内容，直接返回
BasicBlock* entry = BasicBlock::Create(module->getContext(), "entry", fun);
builder.SetInsertPoint(entry);
builder.CreateRetVoid();