llvmIniziare con llvm


Osservazioni

Questa sezione fornisce una panoramica di cosa è llvm e perché uno sviluppatore potrebbe volerlo utilizzare.

Dovrebbe anche menzionare qualsiasi argomento di grandi dimensioni all'interno di llvm e collegarsi agli argomenti correlati. Poiché la documentazione di llvm è nuova, potrebbe essere necessario creare versioni iniziali di tali argomenti correlati.

Compilazione di una semplice funzione in llvm 4.0

Quindi, quello che cercheremo di fare è compilare una funzione seguente

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

al volo. Ed ecco l'intero esempio di .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;
}
 

Dovrebbe funzionare bene quando compilato con clang ++ - 4.0 con i seguenti flag:

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

Installazione o configurazione

È sempre consigliabile visitare il sito Web ufficiale di LLVM e seguire le guide di installazione in base al proprio sistema operativo.

Se stai lavorando su posix, in breve devi aggiungere uno dei repository ufficiali del pacchetto LLVM . Ad esempio se lavori su Ubuntu Xenial (16.04) aggiungi una voce deb e deb-src al tuo file /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
 

e una volta fatto l'installazione è semplice come chiamare

$ sudo apt update
$ sudo apt install clang-X
 

dove X è la versione che stai cercando (4.0 è attuale al momento della stesura di questo post).

Si noti che clang è un compilatore C / C ++ scritto su LLVM (e attualmente è auto-ospitato ora) e viene fornito insieme a tutte le librerie LLVM. Una volta fatto, puoi andare su qualsiasi turorial e iniziare a programmare.

Se lo desideri, puoi installare manualmente le librerie LLVM. Per questo devi semplicemente apt install llvm-Y dove Y è una libreria che stai cercando. Comunque raccomando di compilare LLVM usando progetti con clang.

Una volta fatto ciò dovresti avere llvm-config strumento llvm-config . È molto utile ottenere i flag del compilatore necessari per la corretta compilazione del progetto LLVM. Quindi il primo test che ha funzionato sarebbe chiamando

$ 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
 

Potresti ottenere un diverso set di bandiere, non preoccuparti. Finché non fallisce con il command not found si dovrebbe andare bene.

Il passo successivo è testare la libreria LLVM vera e propria. Quindi, creiamo un semplice file llvmtest.cpp :

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

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

Nota che uso std::cout modo tale da utilizzare effettivamente la variabile di context (quindi il compilatore non lo rimuoverà durante la fase di compilazione). Ora compila il file con

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

e testarlo

$ ./llvmtest
0x7ffd85500970
 

Congratulazioni! Sei pronto per usare LLVM.