llvmllvmを使い始める


備考

このセクションでは、llvmの概要と、開発者がなぜそれを使いたいのかを概説します。

また、llvm内の大きなテーマについても言及し、関連するトピックにリンクする必要があります。 llvmのドキュメンテーションは新しいものなので、それらの関連トピックの初期バージョンを作成する必要があります。

llvm 4.0の単純な関数のコンパイル

だから私たちがやろうとしているのは、次の関数をコンパイルすることです

int sum(int a, int b) {
    return a + b + 2;
}
 

急いで。 .cpp 例全体がここにあります:

#include <iostream>

#include "llvm/IR/LLVMContext.h"
#include "llvm/IR/Module.h"
#include "llvm/IR/IRBuilder.h"
#include "llvm/IR/Verifier.h"
#include "llvm/ExecutionEngine/ExecutionEngine.h"
#include "llvm/ExecutionEngine/SectionMemoryManager.h"
#include "llvm/ExecutionEngine/Orc/CompileUtils.h"
#include "llvm/Support/TargetSelect.h"

// Optimizations
#include "llvm/Transforms/Scalar.h"
#include "llvm/Analysis/BasicAliasAnalysis.h"

using namespace llvm;


llvm::Function* createSumFunction(Module* module) {
    /* Builds the following function:
    
    int sum(int a, int b) {
        int sum1 = 1 + 1;
        int sum2 = sum1 + a;
        int result = sum2 + b;
        return result;
    }
    */

    LLVMContext &context = module->getContext();
    IRBuilder<> builder(context);

    // Define function's signature
    std::vector<Type*> Integers(2, builder.getInt32Ty());
    auto *funcType = FunctionType::get(builder.getInt32Ty(), Integers, false);

    // create the function "sum" and bind it to the module with ExternalLinkage,
    // so we can retrieve it later
    auto *fooFunc = Function::Create(
        funcType, Function::ExternalLinkage, "sum", module
    );

    // Define the entry block and fill it with an appropriate code
    auto *entry = BasicBlock::Create(context, "entry", fooFunc);
    builder.SetInsertPoint(entry);

    // Add constant to itself, to visualize constant folding
    Value *constant = ConstantInt::get(builder.getInt32Ty(), 0x1);
    auto *sum1 = builder.CreateAdd(constant, constant, "sum1");

    // Retrieve arguments and proceed with further adding...
    auto args = fooFunc->arg_begin();
    Value *arg1 = &(*args);
    args = std::next(args);
    Value *arg2 = &(*args);
    auto *sum2 = builder.CreateAdd(sum1, arg1, "sum2");
    auto *result = builder.CreateAdd(sum2, arg2, "result");  
    
    // ...and return
    builder.CreateRet(result);

    // Verify at the end
    verifyFunction(*fooFunc);
    return fooFunc;
};

int main(int argc, char* argv[]) {
    // Initilaze native target
    llvm::TargetOptions Opts;
    InitializeNativeTarget();
    InitializeNativeTargetAsmPrinter();

    LLVMContext context;
    auto myModule = make_unique<Module>("My First JIT", context);
    auto* module = myModule.get();

    std::unique_ptr<llvm::RTDyldMemoryManager> MemMgr(new llvm::SectionMemoryManager());

    // Create JIT engine
    llvm::EngineBuilder factory(std::move(myModule));
    factory.setEngineKind(llvm::EngineKind::JIT);
    factory.setTargetOptions(Opts);
    factory.setMCJITMemoryManager(std::move(MemMgr));
    auto executionEngine = std::unique_ptr<llvm::ExecutionEngine>(factory.create());
    module->setDataLayout(executionEngine->getDataLayout());

    // Create optimizations, not necessary, whole block can be ommited.
    // auto fpm = llvm::make_unique<legacy::FunctionPassManager>(module);
    // fpm->add(llvm::createBasicAAWrapperPass());
    // fpm->add(llvm::createPromoteMemoryToRegisterPass());
    // fpm->add(llvm::createInstructionCombiningPass());
    // fpm->add(llvm::createReassociatePass());
    // fpm->add(llvm::createNewGVNPass());
    // fpm->add(llvm::createCFGSimplificationPass());
    // fpm->doInitialization();

    auto* func = createSumFunction(module);  // create function
    executionEngine->finalizeObject();       // compile the module
    module->dump();                          // print the compiled code

    // Get raw pointer
    auto* raw_ptr = executionEngine->getPointerToFunction(func);
    auto* func_ptr = (int(*)(int, int))raw_ptr;

    // Execute
    int arg1 = 5;
    int arg2 = 7;
    int result = func_ptr(arg1, arg2);
    std::cout << arg1 << " + " << arg2 << " + 1 + 1 = " << result << std::endl;

    return 0;
}
 

clang ++ - 4.0で以下のフラグを付けてコンパイルするとうまく動作するはずです:

$ llvm-config-4.0 --cxxflags --libs core
 

インストールまたはセットアップ

お使いのOSに応じて、LLVMの公式Webサイトにアクセスし、インストールガイドに従うことをお勧めします。

posixで作業している場合は、正式なLLVMパッケージリポジトリの 1つを追加する必要があります 。たとえば、Ubuntu Xenial(16.04)で作業している場合は、 debdeb-src エントリを/etc/apt/sources.list ファイルに追加します:

$ sudo su
$ echo deb http://apt.llvm.org/xenial/ llvm-toolchain-xenial-4.0 main \ >> /etc/apt/sources.list
$ echo deb-src http://apt.llvm.org/xenial/ llvm-toolchain-xenial-4.0 main \ >> /etc/apt/sources.list
 

一度インストールすればインストールは簡単です

$ sudo apt update
$ sudo apt install clang-X
 

X はあなたが探しているバージョンです(4.0はこの記事を書いている時点で最新です)。

clangはLLVM上で書かれたC / C ++コンパイラであり(実際には現在は自己ホストされています)、すべてのLLVMライブラリとともに使用されます。いったんこれを行うと、任意のトーナリーに行き、コーディングを開始することができます。

必要に応じて、LLVMライブラリを手動でインストールできます。そのためには、 apt install llvm-Y 必要があります。ここで、 Y はあなたが探しているライブラリです。しかし、clangを使ってプロジェクトを使ってLLVMをコンパイルすることをお勧めします。

一度これを行うと、 llvm-config ツールが必要になります。正しいLLVMプロジェクトのコンパイルに必要なコンパイラフラグを取得するのは非常に便利です。それで、最初にテストしたのは、

$ llvm-config-4.0 --cxxflags --libs engine
-I/usr/lib/llvm-4.0/include -std=c++0x -gsplit-dwarf -Wl,-fuse-ld=gold -fPIC -fvisibility-inlines-hidden -Wall -W -Wno-unused-parameter -Wwrite-strings -Wcast-qual -Wno-missing-field-initializers -pedantic -Wno-long-long -Wno-maybe-uninitialized -Wdelete-non-virtual-dtor -Wno-comment -Werror=date-time -std=c++11 -ffunction-sections -fdata-sections -O2 -g -DNDEBUG  -fno-exceptions -D_GNU_SOURCE -D__STDC_CONSTANT_MACROS -D__STDC_FORMAT_MACROS -D__STDC_LIMIT_MACROS
-lLLVM-4.0
 

別のフラグセットを取得しても構いませんが、心配しないでください。 command not found ないと失敗しない限り、あなたはうまくいくはずです。

次のステップは、実際のLLVMライブラリ自体をテストすることです。だから、単純なllvmtest.cpp ファイルを作成することができます:

#include <iostream>
#include "llvm/IR/LLVMContext.h"

int main() {
    llvm::LLVMContext context;
    std::cout << &context << std::endl;
    return 0;
};
 

私はstd::cout を使って実際にcontext 変数を使うようにしているので(コンパイル時にはコンパイル時にそれを取り除かないので)今度はファイルをコンパイルしてください

$ clang++-4.0 -o llvmtest `llvm-config-4.0 --cxxflags --libs engine` llvmtest.cpp
 

それをテストする

$ ./llvmtest
0x7ffd85500970
 

おめでとう! LLVMを使用する準備ができました。