examples/HowToUseJIT/HowToUseJIT.cpp

   1 //===-- examples/HowToUseJIT/HowToUseJIT.cpp - An example use of the JIT --===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Valery A. Khamenya and is distributed under the
   6 // University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 //  This small program provides an example of how to quickly build a small
  11 //  module with two functions and execute it with the JIT.
  12 //
  13 // Goal:
  14 //  The goal of this snippet is to create in the memory
  15 //  the LLVM module consisting of two functions as follow:
  16 //
  17 // int add1(int x) {
  18 //   return x+1;
  19 // }
  20 //
  21 // int foo() {
  22 //   return add1(10);
  23 // }
  24 //
  25 // then compile the module via JIT, then execute the `foo'
  26 // function and return result to a driver, i.e. to a "host program".
  27 //
  28 // Some remarks and questions:
  29 //
  30 // - could we invoke some code using noname functions too?
  31 //   e.g. evaluate "foo()+foo()" without fears to introduce
  32 //   conflict of temporary function name with some real
  33 //   existing function name?
  34 //
  35 //===----------------------------------------------------------------------===//
  36
  37 #include "llvm/Module.h"
  38 #include "llvm/Constants.h"
  39 #include "llvm/DerivedTypes.h"
  40 #include "llvm/Instructions.h"
  41 #include "llvm/ModuleProvider.h"
  42 #include "llvm/ExecutionEngine/JIT.h"
  43 #include "llvm/ExecutionEngine/Interpreter.h"
  44 #include "llvm/ExecutionEngine/GenericValue.h"
  45 #include <iostream>
  46 using namespace llvm;
  47
  48 int main() {
  49   // Create some module to put our function into it.
  50   Module *M = new Module("test");
  51
  52   // Create the add1 function entry and insert this entry into module M.  The
  53   // function will have a return type of "int" and take an argument of "int".
  54   // The '0' terminates the list of argument types.
  55   Function *Add1F =
  56     cast<Function>(M->getOrInsertFunction("add1", Type::Int32Ty, Type::Int32Ty,
  57                                           (Type *)0));
  58
  59   // Add a basic block to the function. As before, it automatically inserts
  60   // because of the last argument.
  61   BasicBlock *BB = new BasicBlock("EntryBlock", Add1F);
  62
  63   // Get pointers to the constant `1'.
  64   Value *One = ConstantInt::get(Type::Int32Ty, 1);
  65
  66   // Get pointers to the integer argument of the add1 function...
  67   assert(Add1F->arg_begin() != Add1F->arg_end()); // Make sure there's an arg
  68   Argument *ArgX = Add1F->arg_begin();  // Get the arg
  69   ArgX->setName("AnArg");            // Give it a nice symbolic name for fun.
  70
  71   // Create the add instruction, inserting it into the end of BB.
  72   Instruction *Add = BinaryOperator::createAdd(One, ArgX, "addresult", BB);
  73
  74   // Create the return instruction and add it to the basic block
  75   new ReturnInst(Add, BB);
  76
  77   // Now, function add1 is ready.
  78
  79
  80   // Now we going to create function `foo', which returns an int and takes no
  81   // arguments.
  82   Function *FooF =
  83     cast<Function>(M->getOrInsertFunction("foo", Type::Int32Ty, (Type *)0));
  84
  85   // Add a basic block to the FooF function.
  86   BB = new BasicBlock("EntryBlock", FooF);
  87
  88   // Get pointers to the constant `10'.
  89   Value *Ten = ConstantInt::get(Type::Int32Ty, 10);
  90
  91   // Pass Ten to the call call:
  92   std::vector<Value*> Params;
  93   Params.push_back(Ten);
  94   CallInst *Add1CallRes = new CallInst(Add1F, Params, "add1", BB);
  95   Add1CallRes->setTailCall(true);
  96
  97   // Create the return instruction and add it to the basic block.
  98   new ReturnInst(Add1CallRes, BB);
  99
 100   // Now we create the JIT.
 101   ExistingModuleProvider* MP = new ExistingModuleProvider(M);
 102   ExecutionEngine* EE = ExecutionEngine::create(MP, false);
 103
 104   std::cout << "We just constructed this LLVM module:\n\n" << *M;
 105   std::cout << "\n\nRunning foo: " << std::flush;
 106
 107   // Call the `foo' function with no arguments:
 108   std::vector<GenericValue> noargs;
 109   GenericValue gv = EE->runFunction(FooF, noargs);
 110
 111   // Import result of execution:
 112   std::cout << "Result: " << gv.Int32Val << "\n";
 113   return 0;
 114 }