前言

在此记录下基于LLVM提供的ORC JIT引擎写一个简单的Hello World的过程，以备查阅。

开发环境的配置请参考第一章《LLVM系列第一章：编译LLVM源码》。

ORC(On Request Compilation)是LLVM提供的新一代JIT引擎。JIT(Just In Time)也是一个程序，它在运行时，创建并执行了一些新的代码，而这些新代码并不是属于JIT程序本身的。以下是原英文解释：

Whenever a program, while running, creates and runs some new executable code which was not part of the program when it was stored on disk, it’s a JIT.

LLVM提供了三种JIT的实现：

Legacy JIT (LLVM 1.0 - 3.5)，引入了ExecutionEngine、延迟编译(lazy compilation)，在当前进程中运行(in-process only)，在 LLVM 3.5之后被移除了
MCJIT (LLVM 2.9 - 现在)，实现了ExecutionEngine，可编译链接多个目标(cross-target)，不支持延迟编译
ORC JIT (LLVM 3.7 - 现在)，提供预先查询(forward looking) API，没有实现ExecutionEngine

本章我们就来写一个简单的Hello World，初步感受一下LLVM的ORC JIT引擎是什么样子的。

一、Hello JIT

为了简单起见，我们就用以下IR代码为例子，试着调用ORC JIT来编译并执行它：

; ModuleID = 'Add.c'
source_filename = "Add.c"

define i32 @Add(i32 %a, i32 %b) {
entry:
  %result = add i32 %a, %b
  ret i32 %result
}

其对应的C代码如下（示例）：

// Add.c

int Add(int a, int b)
{
    return a + b;
}

以下我们就来调用LLVM API生成IR代码，并调用ORC JIT对其进行编译执行（示例）：

// HelloJIT.cpp

#include "llvm/ExecutionEngine/Orc/LLJIT.h"
#include "llvm/ExecutionEngine/Orc/ThreadSafeModule.h"
#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"
#include "llvm/Support/InitLLVM.h"
#include "llvm/Support/TargetSelect.h"
#include "llvm/Support/raw_ostream.h"

#include <iostream>
#include <utility>
#include <vector>

using namespace llvm;
using namespace llvm::orc;

typedef int (*AddFunctionType)(int, int);

// Create a module to represent the following C function
//   int Add(int a, int b)
//   {
//       return a + b;
//   }
ThreadSafeModule CreateModule()
{
    auto context = std::make_unique<LLVMContext>();
    IRBuilder<> builder(*context);

    // Create a module
    auto module = std::make_unique<Module>("Add.c", *context);

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

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

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

    // Create an instruction to add a and b:
    //   return a + b;
    Value* a = function->getArg(0);
    Value* b = function->getArg(1);
    Value* result = builder.CreateAdd(a, b, "result");
    builder.CreateRet(result);

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

    return ThreadSafeModule(std::move(module), std::move(context));
}

// Compile and run the "Add()" function
int main(int argc, char* argv[])
{
    // Do initialization for JIT
    InitializeNativeTarget();
    InitializeNativeTargetAsmPrinter();

    // Create the JIT
    ExitOnError ExitOnErr;
    auto jit = ExitOnErr(LLJITBuilder().create());
    auto module = CreateModule();
    ExitOnErr(jit->addIRModule(std::move(module)));

    // Find the "Add()" function
    auto functionSymbol = ExitOnErr(jit->lookup("Add"));
    AddFunctionType add = (AddFunctionType)functionSymbol.getAddress();

    // Use the "Add()" function
    int result = add(12, 34);
    std::cout << "\n-----------------\n";
    std::cout << "Add(12, 34) = " << result << std::endl;

    return 0;
}

二、编译

用clang++进行编译（示例）：

# Set up C++ standard library and header path
export SDKROOT=$(xcrun --sdk macosx --show-sdk-path)

# Compile
clang++ -w -o HelloJIT `llvm-config --cxxflags --ldflags --system-libs --libs all` HelloJIT.cpp

以上命令会生成一个名为HelloJIT的可执行程序。

三、运行

运行HelloJIT（示例）：

./HelloJIT

输出结果如下（示例）：

; ModuleID = 'Add.c'
source_filename = "Add.c"

define i32 @Add(i32 %a, i32 %b) {
entry:
  %add.result = add i32 %a, %b
  ret i32 %add.result
}

-----------------
Add(12, 34) = 46