JITed LLVM 代码如何回调到 Go 函数中？答案

【问题标题】：How can JITed LLVM code call back into a Go function?JITed LLVM 代码如何回调到 Go 函数中？
【发布时间】：2016-08-20 14:08:37
【问题描述】：

我正在编写代码以使用 LLVM Go bindings 从自定义 VM 字节码生成 LLVM 字节码；然后代码被 JITed 并在进程中执行。

自定义 VM 字节码有几个无法在 LLVM 中直接实现的操作，因为它们需要更改外部状态；这些操作码的功能被实现为 Go 函数。

有 excellent guides 开始从 Go 生成 LLVM 字节码，但没有一个解决回调或导出函数的问题。是否可以生成 LLVM 指令来回调 Go 函数？如果有，怎么做？

我尝试了@arrowd 下面描述的方法，但它似乎不起作用。源代码，改编自 Felix Angell 的博文：

package main

import (
    "C"
    "fmt"
    "llvm.org/llvm/final/bindings/go/llvm"
)

// export AddInts
func AddInts(arg1, arg2 int) int {
    return arg1 + arg2;
}

func main() {
    // setup our builder and module
    builder := llvm.NewBuilder()
    mod := llvm.NewModule("my_module")

    // create our function prologue
    main := llvm.FunctionType(llvm.Int32Type(), []llvm.Type{}, false)
    llvm.AddFunction(mod, "main", main)
    block := llvm.AddBasicBlock(mod.NamedFunction("main"), "entry")
    builder.SetInsertPoint(block, block.FirstInstruction())

    // int a = 32
    a := builder.CreateAlloca(llvm.Int32Type(), "a")
    builder.CreateStore(llvm.ConstInt(llvm.Int32Type(), 32, false), a)

    // int b = 16
    b := builder.CreateAlloca(llvm.Int32Type(), "b")
    builder.CreateStore(llvm.ConstInt(llvm.Int32Type(), 16, false), b)

    // return a + b
    bVal := builder.CreateLoad(b, "b_val")
    aVal := builder.CreateLoad(a, "a_val")
    addIntsType := llvm.FunctionType(llvm.Int32Type(), []llvm.Type{llvm.Int32Type(), llvm.Int32Type()}, false)
    addInts := llvm.AddFunction(mod, "AddInts", addIntsType)
    call := builder.CreateCall(addInts, []llvm.Value{aVal, bVal}, "AddInts")
    builder.CreateRet(call)

    // verify it's all good
    if ok := llvm.VerifyModule(mod, llvm.ReturnStatusAction); ok != nil {
        fmt.Println(ok.Error())
    }
    mod.Dump()

    // create our exe engine
    engine, err := llvm.NewExecutionEngine(mod)
    if err != nil {
        fmt.Println(err.Error())
    }

    // run the function!
    funcResult := engine.RunFunction(mod.NamedFunction("main"), []llvm.GenericValue{})
    fmt.Printf("%d\n", funcResult.Int(false))
}

; ModuleID = 'my_module'

define i32 @main() {
entry:
  %a = alloca i32
  store i32 32, i32* %a
  %b = alloca i32
  store i32 16, i32* %b
  %b_val = load i32* %b
  %a_val = load i32* %a
  %AddInts = call i32 @AddInts(i32 %a_val, i32 %b_val)
  ret i32 %AddInts
}

declare i32 @AddInts(i32, i32)
LLVM ERROR: Tried to execute an unknown external function: AddInts
exit status 1

【问题讨论】：

Haskell 提供了一种将代码导出为 C 函数的方法，因此可以从任何东西（包括 LLVM）中调用 Haskell。 Go 有这样的功能吗？
@arrowd 我的理解是 CGo 提供了这个（而原生 Go 实现没有，因为它使用自己的调用约定）。这是朝着正确方向迈出的一步，但我仍然不确定如何从 LLVM 中实际调用该函数。

标签： go llvm jit

【解决方案1】：

根据this answer，您可以通过添加“导出”注释将 Go 函数导出为 C 函数。如果为函数执行此操作，LLVM JIT 应该能够在运行时链接期间解析此符号。答案没有提供调用该导出函数的 C 代码，但假设它只是 goProgressCB(args);，那么您可以为该函数创建一个 CallInst 并对其进行 JIT。

已更新。

看看this answer。最近的 Go 似乎可以生成 C 标头供您调用 Go 回去。有了这个，您可以使用 clang -S -emit-llvm 或 clang -march=cpp 编译它们，并获得对构成调用指令的 LLVM API 的文本 IR 或 C++ 调用。

【讨论】：

谢谢！不过，我仍然希望有人能提出一个简单的端到端 LLVM 示例（部分原因是我确信我不会是最后一个提出这个问题的人）。
顺便说一下，go 的 LLVM 绑定没有 CallInst；有没有与我应该寻找的东西等效的东西？
所以，不幸的是，这似乎不起作用 - 请参阅我对帖子的更新。

【解决方案2】：

主要问题是您实际上并没有在这里使用 JIT，而是使用了解释器。 llvm.NewExecutionEngine 将构建一个 JIT 编译器（如果可用），否则回退到解释器。

您应该使用llvm.NewMCJITCompiler。如果不进行其他更改，这将失败，这与 NewExecutionEngine 一开始没有产生 JIT 的原因相同。您需要将以下内容添加到“func main()”中：

llvm.LinkInMCJIT()               
llvm.InitializeNativeTarget()    
llvm.InitializeNativeAsmPrinter()

您的代码的另一个较小的问题是（缺少）空格在“//export”魔法中很重要。

【讨论】：