LLVM IRBuilder and pass：1/2.通过llvm提供的api和IRBuilder生成LLVM-IR

已于 2023-03-24 16:43:22 修改
阅读量340 收藏 1
点赞数 2
分类专栏： LLVM 文章标签： c++ java 开发语言
于 2023-03-22 10:46:47 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_43566431/article/details/129516909
版权

本章及下一章介绍了如何通过C++、LLVM API将源代码转换为LLVM IR

文章目录

1.模块Module

在LLVM IR的基本概念（构建中），模块是一个组合，它包含了其他更小的基本构件。比如，它可以包含的基本构件有全局变量、函数、数据结构等。

用LLVM创建模块之前，需要首先初始化LLVMContext，然后才能调用LLVM API，代码如下所示（实例）：

//HelloModule.app

#include "llvm/IR/Module.h"
#include "llvm/IR/LLVMContext.h"

using namespace llvm;

int main(int argc, char* argv[])
{
	LLVMContext context;
	Module* module = new Module("HelloModule", context);
	
	module->print(outs(), nullptr);

	return 0;
}

1.1编译

clang++ -O3 HelloModule.cpp -o HelloModule `llvm-config --cflags --ldflags` `llvm-config --libs` `llvm-config --system-libs`

此时在当前路径下生成了一个HelloModule的可执行程序

1.2运行
运行HelloModule（示例）:

./HelloModule

输出结果如下（示例）：

; ModuleID = 'HelloModule'
source_filename = "HelloModule"

2.函数Function

要创建一个函数，我们需要用到其他的工具，比如llvm::Function、llvm::FunctionType等。我们知道，函数也是有类型的，而llvm::FunctionType就是用来创建函数类型的。创建函数之前，需要先创建函数类型，然后才能用llvm::Function来创建函数。

为了简单起见，我们假设这个函数没有返回值，即返回值为void，代码如下（示例）：

//HelloFunction.cpp

#include "llvm/IR/Function.h"
#include "llvm/IR/LLVMContext.h"
#include "llvm/IR/Module.h"
#include "llvm/IR/Verifier.h"

using namespace llvm;

int main(int argc, char* argv[])
{
	LLVMContext context;

	//Create a module
	Module* module = new Module("helloModule", context);

	//Add a function
	Type* voidType = Type::getVoidTy(context);
	FunctionType* FunctionType = FunctionType::get(voidType, false);
	Function* function = Function::Create(functionType, GlobalValue::ExternalLinkage, "HelloFunction", module);
	//Print the IR 
	verifyFunction(*function);
	module->print(outs(), nullptr);
	
	return 0;
	
}

2.1编译

clang++ -O3 HelloFunction.cpp -o HelloFunction `llvm-config --cflags --ldflags` `llvm-config --libs` `llvm-config --system-libs`

此时在当前路径下生成了一个HelloFunction的可执行程序

2.2运行
运行HelloFunction（示例）:

./HelloFunction

输出结果如下（示例）：

; ModuleID = 'HelloModule'
source_filename = "HelloModule"

declare void @HelloFunction()

3.逻辑代码块Block

函数（Function）是由基本逻辑代码块（BasicBlock）——简称“代码块”组成。一个代码块有且只有一个起点和一个终点。代码块的起点是一个标签，它是整个代码块的标签（“entry:”），最后一条IR指令就是结束指令。

LLVM中的BasicBlock类，就是用来创建、使用、处理代码块的。当然，我们还可以使用LLVM提供的IR代码创建工具（类）IRBuilder，它能让我们更方便快捷的创建出代码块。

我们来来创建一个最简单的代码块（BasicBlock），示例代码如下：

//HelloBlock.cpp

#include "llvm/IR/BasicBlock.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/IRBuilder.h"
#include "llvm/IR/LLVMContext.h"
#include "llvm/IR/Module.h"
#include "llvm/IR/Verifier.h"

using namespace llvm;

int main(int argc, char* argv[])
{
	LLVMContext context;
	IRBuilder<> builder(context);

	//Create a module
	Module* module = new Module("HelloModule", context);

	//Add a function
	Type* voidType = Type::getVoidTy(context);
	FunctionType* functionType = FunctionType::get(voidType, false);
	Function* function = Function::Create(functionType, GlobalValue::ExternalLinkage, "HelloFunction", module);
	
	//Create a block
	BasicBlock* block = BasicBlock::Create(context, "entry", function);
	builder.SetInsertPoint(block);
	
	//Print the IR
	verifyFunction(*function);
	module->print(outs(), nullptr);
	
	return 0;
}

3.1编译

clang++ -O3 HelloBlock.cpp -o HelloBlock`llvm-config --cflags --ldflags` `llvm-config --libs` `llvm-config --system-libs`

此时在当前路径下生成了一个HelloBlock的可执行程序

3.2运行
运行HelloBlock（示例）:

./HelloBlock

输出结果如下（示例）：

; ModuleID = 'HelloModule'
source_filename = "HelloModule"

define void @HelloFunction() {
entry:
}

4.全局变量Global Variable

全局变量（Global Variable）是在一个模块（Module）之内全局可见的变量，也就是说模块内所有的函数都能用它。

LLVM提供了Module::getOrInsertGlobal()函数来创建全局变量，以及Module::getNamedGlobal()函数来找到一个全局变量。创建全局变量之后，我们可以配置它的属性，如链接类型、内存对齐模型等。

全局变量在链接的时候，到底是指向同一个全局变量，还是多个不同的全局变量，是由链接类型决定的。这里说的“多个不同的全局变量”，意思是其名称相同，但是有多个“分身”（可以简单的理解为copy、instance、实例等等），“分身之间互不影响”。

Column 1Column 2
ExternalLinkage模块外部可见的函数
AvailableExternallyLinkage只在查询而非代码生成的时候外部可见
LinkOnceAnyLinkage函数在链接（或内连inline）的时候仅保存一份实现
LinkOnceODRLinkage同上，但有些链接属性可以用类似的属性替换
WeakAnyLinkage函数在链接的时候仅保存一份实现（弱链接）
WeakODRLinkage同上，但有些链接属性可以用类似的属性替换
AppendingLinkage这是特殊的链接类型，只适用于全局数组
InternalLinkage链接时若发现有重命名的静态函数，则进行重命名
PrivateLinkage只做内部链接，但不会添加到符号表中
ExternalWeakLinkage外部弱链接
CommonLinkage由编译器（链接器）自动选择链接类型

有关于更详细的说明请参考LLVM官方文档Linkage Types

用llvm创建全局变量的示例代码如下：

#include "llvm/IR/BasicBlock.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/GlobalVariable.h"
#include "llvm/IR/IRBuilder.h"
#include "llvm/IR/LLVMContext.h"
#include "llvm/IR/Module.h"
#include "llvm/IR/Verifier.h"

using namespace llvm;

int main(int argc, char* argv[])
{
	LLVMContext context;
	IRBuilder<> builder(context);

	//Create a module
	Module* module = new Module("HelloModule", context);

    // Add a global variable
    module->getOrInsertGlobal("helloGlobalVariable", Type::getInt32Ty(context));
    GlobalVariable* globalVariable = module->getNamedGlobal("helloGlobalVariable");
    globalVariable->setLinkage(GlobalValue::CommonLinkage);
    globalVariable->setAlignment(MaybeAlign(4));

	//Add a function
	Type* voidType = Type::getVoidTy(context);
	FunctionType* functionType = FunctionType::get(voidType, false);
	Function* function = Function::Create(functionType, GlobalValue::ExternalLinkage, "HelloFunction", module);
	
	//Create a block
	BasicBlock* block = BasicBlock::Create(context, "entry", function);
	builder.SetInsertPoint(block);
	
	//Print the IR
	verifyFunction(*function);
	module->print(outs(), nullptr);
	
	return 0;
}

4.1编译

clang++ -O3 HelloGlobalVariable.cpp -o HelloGlobalVariable`llvm-config --cflags --ldflags` `llvm-config --libs` `llvm-config --system-libs`

此时在当前路径下生成了一个HelloGlobalVariable的可执行程序

4.2运行
运行HelloGlobalVariable（示例）:

./HelloGlobalVariable

输出结果如下（示例）：

; ModuleID = 'HelloModule'
source_filename = "HelloModule"

@helloGlobalVariable = common global i32, align 4

define void @HelloFunction() {
entry:
}

5.函数返回值return

我们来实现一个函数，并让它返回一个整数。比如0。在代码中，整数值0是一个常量，所以我们需要用到LLVM提供的Constant类。

// HelloReturn.cpp

#include "llvm/IR/BasicBlock.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/GlobalVariable.h"
#include "llvm/IR/IRBuilder.h"
#include "llvm/IR/LLVMContext.h"
#include "llvm/IR/Module.h"
#include "llvm/IR/Verifier.h"

using namespace llvm;

int main(int argc, char* argv[])
{
    LLVMContext context;
    IRBuilder<> builder(context);

    // Create a module
    Module* module = new Module("HelloModule", context);

    // Add a global variable
    module->getOrInsertGlobal("helloGlobalVariable", builder.getInt32Ty());
    GlobalVariable* globalVariable = module->getNamedGlobal("helloGlobalVariable");
    globalVariable->setLinkage(GlobalValue::CommonLinkage);
    globalVariable->setAlignment(MaybeAlign(4));

    // Add a function
    FunctionType* functionType = FunctionType::get(builder.getInt32Ty(), false);
    Function* function = Function::Create(functionType, GlobalValue::ExternalLinkage, "HelloFunction", module);

    // Create a block
    // 定义一个block，用于存储函数体的内容，但是函数体的内容构建是通过IRBuilder来实现的。
    BasicBlock* block = BasicBlock::Create(context, "entry", function);
    builder.SetInsertPoint(block);

    // Add a return
    ConstantInt* zero = builder.getInt32(0);
    builder.CreateRet(zero);

    // Print the IR
    verifyFunction(*function);
    module->print(outs(), nullptr);

    return 0;
}

5.1编译

clang++ -O3 HelloReturn.cpp -o HelloReturn`llvm-config --cflags --ldflags` `llvm-config --libs` `llvm-config --system-libs`

此时在当前路径下生成了一个HelloGlobalVariable的可执行程序

5.2运行
运行HelloReturn（示例）:

./HelloReturn

输出结果如下（示例）：

; ModuleID = 'HelloModule'
source_filename = "HelloModule"

@helloGlobalVariable = common global i32, align 4

define i32 @HelloFunction() {
entry:
  ret i32 0
}

6.函数参数Function Arguments

我们来创建一个带有参数的函数

假定这个函数带有两个参数，它们的名称分别为a和b，类型均为32位整数型。代码如下（示例）：

// HelloFunctionArguments.cpp

#include "llvm/IR/BasicBlock.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/GlobalVariable.h"
#include "llvm/IR/IRBuilder.h"
#include "llvm/IR/LLVMContext.h"
#include "llvm/IR/Module.h"
#include "llvm/IR/Verifier.h"

#include <vector>

using namespace llvm;

int main(int argc, char* argv[])
{
    LLVMContext context;
    IRBuilder<> builder(context);

    // Create a module
    Module* module = new Module("HelloModule", context);

    // Add a global variable
    module->getOrInsertGlobal("helloGlobalVariable", builder.getInt32Ty());
    GlobalVariable* globalVariable = module->getNamedGlobal("helloGlobalVariable");
    globalVariable->setLinkage(GlobalValue::CommonLinkage);
    globalVariable->setAlignment(MaybeAlign(4));

    // Add a function with parameters
    std::vector<Type*> parameters(2, builder.getInt32Ty());
    FunctionType* functionType = FunctionType::get(builder.getInt32Ty(), parameters, false);
    Function* function = Function::Create(functionType, GlobalValue::ExternalLinkage, "HelloFunction", module);

    // Set arguments for the function
    function->getArg(0)->setName("a");
    function->getArg(1)->setName("b");

    // Create a block
    BasicBlock* block = BasicBlock::Create(context, "entry", function);
    builder.SetInsertPoint(block);

    // Add a return
    ConstantInt* zero = builder.getInt32(0);
    builder.CreateRet(zero);

    // Print the IR
    verifyFunction(*function);
    module->print(outs(), nullptr);

    return 0;
}

6.1编译

clang++ -O3 HelloFunctionArguments.cpp -o HelloFunctionArguments`llvm-config --cflags --ldflags` `llvm-config --libs` `llvm-config --system-libs`

此时在当前路径下生成了一个HelloFunctionArguments的可执行程序

6.2运行
运行HelloFunctionArguments（示例）:

./HelloFunctionArguments

输出结果如下（示例）：

; ModuleID = 'HelloModule'
source_filename = "HelloModule"

@helloGlobalVariable = common global i32, align 4

define i32 @HelloFunction(i32 %a, i32 %b) {
entry:
  ret i32 0
}

总结

这里表明几个关系：

  • Module：包含一个至多个Function，全局变量等
    可以遍历Module得到Function
for (Module::iterator iter = M.begin(); iter != M.end(); iter++) {Function *F = &(*iter);
  • Function：包含若干个BasicBlock
  • BasicBlock：包含若干个instruction
  • instruction：指令，包含若干操作，value
  • value：大部分对象都可以看做是Value，如常量、参数、指令、函数等。

续下一章

参考1
参考2

动弹动弹
关注
专栏目录
利用llvm 源码提供的API，获取IR中函数调用实际参数的名字并打印
shijiu2012的博客
05-21 2690
在LLVM Pass开发中，由于需要我们可能需要获取IR中函数调用的的实际参数名字,在C语言中函数调用是这样的func1("hello",3),如果在编译器的前端clang中我们想要获取第一个参数"hello"，还是比较容易的，但是在当程序被转成IR就类似这样了： @.str = private unnamed_addr constant [6 x i8] c"hello\00", align...
LLVM IR 构建 分析 转换 优化 IRBuilder Pass AI编译器后端代码生成
万有文的博客
08-07 1132
LLVM IR 构建 分析 转换 优化 LLVM汇编语言是一种 静态单赋值（SSA） 的中间表示，提供了类型安全检查，低层次的操作符，灵活和清晰表达‘几乎所有’高级语言的能力。同时，它也是LLVM编译算法中各个阶段的一种通用代码表达形式。 ...
llvm-13.0.1-1.5.7-API文档-中文版.zip
07-06
赠送jar包：llvm-13.0.1-1.5.7.jar； 赠送原API文档：llvm-13.0.1-1.5.7-javadoc.jar； 赠送源代码：llvm-13.0.1-1.5.7-sources.jar； 赠送Maven依赖信息文件：llvm-13.0.1-1.5.7.pom； 包含翻译后的API文档：llvm-13.0.1-1.5.7-javadoc-API文档-中文(简体)版.zip； Maven坐标：org.bytedeco:llvm:13.0.1-1.5.7； 标签：bytedeco、llvm、中文文档、jar包、java； 使用方法：解压翻译后的API文档，用浏览器打开“index.html”文件，即可纵览文档内容。 人性化翻译，文档中的代码和结构保持不变，注释和说明精准翻译，请放心使用。
IR API(五)——使用LLVM提供的C接口和IRBuilder来生成LLVM IR常用方法总结
yelvens的博客
08-17 8769
一、类型定义： //基本类型 Type::getInt32Ty(context); //int IntegerType::get(context, 32); //int,使用IntegerType的get方法和Type的getInt32Ty方法是一样的，我一般用第一种，感觉方便 Type::getInt64Ty(context); //long Type::getFloatTy(context); //float Type::getDoubleTy(context); //double Type::getI
LLVM 新一代 JIT API：ORC
fcsfcsfcs的博客
10-07 1780
最近看到 ORC(On Request Compilation) 在增加 MachO 平台的 OC 和 Swift 语言支持，这是 MachO JIT(Just In Time) 相关的进展。本文将探索这个 LLVM 新一代的 JIT APIs，即 ORC，其 ORC JIT Weekly 现在还一直处于更新状态。 1、JIT 解释 以防语境不一致，解释下 JIT(Just In Time) 这个术语。 Whenever a program, while running, creates and ru
LLVM系列第二十七章：理解IRBuilder
Zhanglin_Wu的专栏, C++, Scrum, LLVM, 编译器
07-25 3570
简单地分析一下LLVM API中的IRBuilder的作用和用法
LLVM-pass.zip
08-13
1. **编写Pass**：使用LLVM的C++ API创建一个新的类，继承自`llvm::Pass`接口，并实现必要的方法，如`runOnFunction`或`runOnModule`。 2. **注册Pass**：将新创建的Pass添加到LLVM的pass管理系统中，使其可以在...
llvm-tutor：用于教学的树外LLVM通行证的集合
01-31
LLVM通过示例-基于LLVM 11 llvm-tutor是自包含的参考LLVM通过的集合。 这是一个针对新手和有抱负的LLVM开发人员的教程。 主要特点： 树外-基于二进制LLVM安装构建（无需从源构建LLVM） 完整-包括CMake构建脚本，...
LLVM系列：1.设计思想和LLVM IR简介
最新发布
你的深度学习小站
09-02 1954
本文简单介绍了LLVM项目的背景，并针对LLVM中优化器和代码生成器的模块化设计思想进行了介绍，也简单介绍了LLVM IR的特点，包括结构、变量类型、指令格式等。
LLVM9.0编写Hello pass
zhugl的博客
10-30 722
最近动手尝试了一下，在安装完成LLVM9.0之后，新建一个FunctionPass。以下是参考他人文档和自己实现的过程。 1. 新建或修改Hello.cpp 在/home/zgl/llvm-project-9.0.0/llvm/lib/Transforms/Hello目录下新建或修改Hello.cpp，代码如下： #include "llvm/ADT/Statistic.h" #include "llvm/IR/Function.h" #include "llvm/Pass.h" #include "llv
HelloDataflow-LLVM：开始在LLVM中编写数据流分析。 （没有标准模板）
02-19
HelloDataflow-LLVM 开始在LLVM中编写数据流分析。 （没有标准模板） LLVM API的代码准则 请参阅从访问功能的基本步骤，基本块和说明。 以下LLVM API可能有助于实现数据流分析。 假设您有一个基本块，并且想找出其后继者，请使用以下代码片段迭代其后继者。 // #include "llvm/IR/CFG.h" for (BasicBlock *Succ : successors(&basic_block)) { ... } 接下来，使用以下API查找前身。 // #include "llvm/IR/CFG.h" for (BasicBlock *Pred : predecessors(&basic_block)) { ... } 使用标准的C ++ API执行基本的集合操作，例如两个集合或向量的并集。 // #include <set> std
LLVM学习日志6——另一个简单例子ModuleMaker，浅读调用LLVM的API及函数
tristan_tian的博客
08-18 2147
发现LLVM的调用还是看不太懂，先来学个小例子。 对了，刚发现，在llvm的examples中有各种例子的源码可以看，包括之前那个Kaleidoscope 这个ModuleMaker 照例读源码 第一句是定义context，到现在我还不知道具体有什么用，看文档说LLVMContext提供隔离，LLVM IR内存中的每个实体都属于一个context。只是看后面的定义，我猜测，就是画了个框，同...
（转载）（总纲）llvm IR指令与llvm开发中对应的类与API
春江花月夜
05-31 1660
llvm IR指令与llvm开发中对应的类与API 环境相关部分，如Contexts，Modules 类型Types 值Values 元数据Metadata 基本块Basic Block 指令Instructions 其中比较重要的是值Values，基本块BasicBlock和指令Instructions,llvm开发基本上使用最多的就是和这几个类相关的API接口，其中Values中使用最多就...
基于llvm自制编译器（3）：LLVM IR 代码生成
小杨的博客
03-08 1398
在上一章中，我们介绍了如何构建抽象语法树AST。这一章，我们进一步将抽象语法树转换成LLVM IR。此外，我们会简单介绍LLVM的工作原理和使用方法。注意：本章源码要求LLVM版本大于等于3.7如下所示，为函数定义的代码生成方法定义。if(!if(!对于函数定义，我们首先在模块的符号表中查找该函数已有的版本。如果返回null则表示不存在，因此我们将通过来生成。然后，我们对Builder通过函数创建一个基本块（Basic Block），基本块随后被插入到中。通过。
数据库浅谈之 LLVM
优质后端技术知识记录
02-24 2045
LLVM
一起学习LLVM（三）
雪一梦的博客
03-25 1162
学习LLVM常用的API操作 常用的结构： ---关于函数和指令以及block和指令的操作； 引用的各自类型： ---Dynamic casts ---Instanceof-of casts 修改CFG的几种方式 ---修改基本块或者指令 一、Runtime type inference(RTTI)...
LLVM学习入门(3):生成 LLVM 中间代码 IR
TSWorld
09-16 3778
主要实现 AST 转化为 LLVM IR 的功能。
LLVM系列第十六章：写一个简单的编译器
Zhanglin_Wu的专栏, C++, Scrum, LLVM, 编译器
06-10 3456
基于LLVM提供的API，用C++写一个很简单的编译器，并用它编译出了我们自己的计算器程序
编译器架构的王者LLVM——（2）开发LLVM项目
西风世界
11-06 7190
LLVM作为一款非常方便的编译器开发平台，我们能用LLVM做一款自己的编程语言么？答案是，有点难度，但不是不可能，今天，就从配置项目工程开始，了解LLVM项目开发的一点一滴。
使用LLVM Pass实现MC/DC测试覆盖率分析
编写一个LLVM Pass需要对LLVM框架有深入的了解，包括IR的数据结构、遍历和变换的API等。通常情况下，一个Pass可以被分为几种类型：分析型Pass、变换型Pass和工具型Pass。分析型Pass用于收集信息而不改变代码，变换型...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值