llvmНачало работы с llvm


замечания

В этом разделе представлен обзор того, что такое llvm, и почему разработчик может захотеть его использовать.

Следует также упомянуть о любых крупных предметах в пределах llvm и ссылаться на связанные темы. Поскольку Documentation for 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
 

Установка или настройка

Всегда рекомендуется перейти на официальный сайт LLVM и следовать инструкциям по установке в зависимости от вашей ОС.

Если вы работаете над posix, то вкратце вы должны добавить один из официальных репозиториев пакетов LLVM . Например, если вы работаете с Ubuntu Xenial (16.04), вы добавляете запись deb и deb-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 - это компилятор C / C ++, написанный над LLVM (и фактически сам размещен сейчас), и поставляется вместе со всеми библиотеками LLVM. Как только вы это сделаете, вы можете пойти в любой магазин и начать кодирование.

Если вы хотите, вы можете установить библиотеки LLVM вручную. Для этого вам просто нужно apt install llvm-Y где Y - это библиотека, которую вы ищете. Однако я рекомендую компилировать LLVM, используя проекты с clang.

После этого вы должны иметь инструмент 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.