为什么 LLVM Module 的最终 IR 输出缺少顶层函数调用?
HandleTopLevelExpression() 打印顶层表达式的 IR 后,会立即调用 FnIR->eraseFromParent(),删除包装该表达式的函数。因此,程序退出时打印 TheModule,这些函数和其中的指令都已不存在。
这是所贴代码的执行结果,无须先排查 macOS、Apple Silicon 或 Clang 版本。要让最终输出保留所有顶层表达式,需要保留包装函数,并为每个函数分配不同的名称。
为什么即时输出有代码,最终输出却没有?
ParseTopLevelExpr() 将每个顶层表达式包装成名为 __anon_expr 的函数。这个函数没有参数,返回 double。例如:
cos(1.234);
生成的 IR 是:
define double @__anon_expr() {
entry:
%calltmp = call double @cos(double 1.234000e+00)
ret double %calltmp
}
随后,HandleTopLevelExpression() 执行:
FnIR->print(errs());
fprintf(stderr, "\n");
// Remove the anonymous expression.
FnIR->eraseFromParent();
执行 FnIR->print(errs()) 时,函数还在 Module 中,所以能够打印出来。接着,eraseFromParent() 将函数从所属 Module 中移除并销毁,函数体中的 call、ret 等指令也随之删除。
退出时,下面的语句只打印 Module 当前保留的内容,不会保存或重放此前生成过的 IR:
TheModule->print(errs(), nullptr);
foo 和 bar 由 HandleDefinition() 处理。该路径在成功生成函数后没有删除它们,所以最终输出中仍有这两个函数。最终的 bar 函数体内也有对 foo 和 bar 的 call 指令,说明 Module 的打印功能能够正常输出函数调用。
如何保留所有顶层表达式?
需要修改两个位置:取消顶层表达式处理成功后的删除操作,并在创建包装函数前生成唯一名称。
为每个表达式生成不同的函数名
将 ParseTopLevelExpr() 替换为:
static std::unique_ptr<FunctionAST> ParseTopLevelExpr() {
static unsigned long long ExprCount = 0;
if (auto E = ParseExpression()) {
std::string Name = "__anon_expr." + std::to_string(ExprCount++);
auto Proto = std::make_unique<PrototypeAST>(
Name, std::vector<std::string>());
return std::make_unique<FunctionAST>(std::move(Proto),
std::move(E));
}
return nullptr;
}
程序在一次运行中会依次使用 __anon_expr.0、__anon_expr.1 等名称。所需的 <string> 已包含在原始代码中。
保留生成成功的函数
将 HandleTopLevelExpression() 替换为:
static void HandleTopLevelExpression() {
if (auto FnAST = ParseTopLevelExpr()) {
if (auto *FnIR = FnAST->codegen()) {
fprintf(stderr, "Read top-level expression:");
FnIR->print(errs());
fprintf(stderr, "\n");
}
} else {
// Skip token for error recovery.
getNextToken();
}
}
这里取消的是成功路径中的 FnIR->eraseFromParent()。FunctionAST::codegen() 中的 TheFunction->eraseFromParent() 用于清理生成失败的函数,应继续保留,以免不完整的函数留在 Module 中。
为什么不能只删除 eraseFromParent()?
原始代码给所有顶层表达式使用相同的名称 __anon_expr,而 FunctionAST::codegen() 会先按名称查找已有函数:
Function *TheFunction = TheModule->getFunction(Proto->getName());
如果保留了第一个包装函数,第二个表达式就会找到这个已有函数。由于它已经有函数体,代码会触发以下错误:
if (!TheFunction->empty())
return (Function *)LogErrorV("Function cannot be redefined.");
因此,只取消删除操作会使后续顶层表达式报 Function cannot be redefined.。唯一名称必须在查找之前确定。这个执行路径在调用 Function::Create() 之前就已返回错误,所以不能依靠它自动添加后缀。
如何检查修改效果?
重新编译后,可以从一个新会话输入:
4+5;
extern cos(x);
cos(1.234);
发送 EOF 结束输入,然后检查最终的 Module 输出。按照上述修改,预期会保留以下内容,具体排版可能略有差异:
define double @__anon_expr.0() {
entry:
ret double 9.000000e+00
}
declare double @cos(double)
define double @__anon_expr.1() {
entry:
%calltmp = call double @cos(double 1.234000e+00)
ret double %calltmp
}
这是根据代码推导的预期结果,并非在所述版本环境中的实测记录。
还有哪些需要注意?
4+5 对应的 IR 直接返回 9.000000e+00,因为默认的 IRBuilder<> 对常量运算进行了 constant folding。即使保留了包装函数,也不一定会看到单独的 fadd 指令。这与整个包装函数被删除是两件事。
编译命令中的 -O3 用于优化这个 C++ 前端程序,不能据此认定生成的 LLVM IR 经过了某套优化 pass。所贴代码中导致顶层表达式消失的操作已经明确,无须通过调整该参数解决。
LLVM IR 中的 call 等可执行指令需要放在函数的 basic block 内。Kaleidoscope 源语言允许顶层表达式,这份代码便通过包装函数来承载它们。保留这些函数会让 IR 出现在最终输出中,但不会自动执行表达式:当前代码既没有执行这些包装函数的 JIT 调用,也没有生成按输入顺序调用它们的入口函数。
如果只想查看删除前的 Module 状态,可以在 FnIR->eraseFromParent() 之前调用 TheModule->print(errs(), nullptr)。先前已经删除的表达式仍不会出现;要在退出时一次性输出全部表达式,仍需保留函数并生成唯一名称。
备注:内容仅供参考。
