如何通过LLVM API将预编写的LLVM IR直接插入模块？

问题描述 #

我正在开发一款编译器，需要为语言实现一些预定义函数。比如实现软件栈时，会用到这样的LLVM IR代码：

@.stack = common global [1024 x i64]
@.sp = common global i64 0

define void @push(i64 %val) {
    %sp = load i64, i64* @.sp
    %addr = getelementptr [1024 x i64], [1024 x i64]* @.stack, i64 0, i64 %sp

    ; store the value
    store i64 %val, i64* %addr

    ; update the stack pointer
    %sp2 = add i64 %sp, 1
    store i64 %sp2, i64* @.sp

    ret void
}
[... other stack operations]

目前我只找到通过创建llvm::Function*的方式实现，但代码过于繁琐。想问下怎么通过LLVM API把std::string或const char*形式的上述代码直接插入到模块开头？

解决方案 #

你可以利用LLVM的IR解析API直接处理字符串形式的IR代码，将其合并到目标模块中，步骤如下：

核心思路 #

使用llvm::parseAssemblyString函数解析IR字符串，生成临时模块后，将临时模块中的全局变量、函数等实体移动到目标模块的开头位置。

示例代码 #

#include "llvm/IR/LLVMContext.h"
#include "llvm/IR/Module.h"
#include "llvm/IR/Verifier.h"
#include "llvm/AsmParser/Parser.h"
#include "llvm/Support/SourceMgr.h"
#include "llvm/Support/raw_ostream.h"

// 假设这是你正在构建的目标模块
llvm::Module* targetModule;
llvm::LLVMContext& context = targetModule->getContext();

// 预定义的栈操作IR代码字符串
const char* stackIR = R"(
@.stack = common global [1024 x i64]
@.sp = common global i64 0

define void @push(i64 %val) {
    %sp = load i64, i64* @.sp
    %addr = getelementptr [1024 x i64], [1024 x i64]* @.stack, i64 0, i64 %sp
    store i64 %val, i64* %addr
    %sp2 = add i64 %sp, 1
    store i64 %sp2, i64* @.sp
    ret void
}
)";

// 解析IR字符串并合并到目标模块
llvm::SMDiagnostic err;
std::unique_ptr<llvm::Module> irModule = llvm::parseAssemblyString(stackIR, err, context);

if (!irModule) {
    // 输出解析错误信息
    err.print("Compiler", llvm::errs());
} else {
    // 将临时模块的全局变量移到目标模块开头
    targetModule->getGlobalList().splice(
        targetModule->getGlobalList().begin(),
        irModule->getGlobalList()
    );
    // 将临时模块的函数移到目标模块开头
    targetModule->getFunctionList().splice(
        targetModule->getFunctionList().begin(),
        irModule->getFunctionList()
    );

    // 可选：验证模块是否合法
    if (llvm::verifyModule(*targetModule, &llvm::errs())) {
        llvm::errs() << "模块验证失败！\n";
    }
}

注意事项 #

• 确保IR代码语法完全正确，否则解析过程会失败，可通过SMDiagnostic对象获取具体错误信息。
• 若需要插入到模块开头，必须使用splice方法将实体移到目标模块列表的起始位置，而非直接追加。
• LLVM版本差异可能导致API名称变化，比如旧版本可能使用ParseAssembly而非parseAssemblyString，需根据使用的LLVM版本调整。

内容的提问来源于stack exchange，提问作者Rajesh