1 //===-- examples/HowToUseJIT/HowToUseJIT.cpp - An example use of the JIT --===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
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.
14 // The goal of this snippet is to create in the memory
15 // the LLVM module consisting of two functions as follow:
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".
28 // Some remarks and questions:
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?
35 //===----------------------------------------------------------------------===//
37 #include "llvm/Module.h"
38 #include "llvm/Constants.h"
39 #include "llvm/Type.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"
49 // Create some module to put our function into it.
50 Module *M = new Module("test");
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 = M->getOrInsertFunction("add1", Type::IntTy, Type::IntTy,
58 // Add a basic block to the function. As before, it automatically inserts
59 // because of the last argument.
60 BasicBlock *BB = new BasicBlock("EntryBlock", Add1F);
62 // Get pointers to the constant `1'.
63 Value *One = ConstantInt::get(Type::IntTy, 1);
65 // Get pointers to the integer argument of the add1 function...
66 assert(Add1F->arg_begin() != Add1F->arg_end()); // Make sure there's an arg
67 Argument *ArgX = Add1F->arg_begin(); // Get the arg
68 ArgX->setName("AnArg"); // Give it a nice symbolic name for fun.
70 // Create the add instruction, inserting it into the end of BB.
71 Instruction *Add = BinaryOperator::createAdd(One, ArgX, "addresult", BB);
73 // Create the return instruction and add it to the basic block
74 new ReturnInst(Add, BB);
76 // Now, function add1 is ready.
79 // Now we going to create function `foo', which returns an int and takes no
81 Function *FooF = M->getOrInsertFunction("foo", Type::IntTy, (Type *)0);
83 // Add a basic block to the FooF function.
84 BB = new BasicBlock("EntryBlock", FooF);
86 // Get pointers to the constant `10'.
87 Value *Ten = ConstantInt::get(Type::IntTy, 10);
89 // Pass Ten to the call call:
90 std::vector<Value*> Params;
91 Params.push_back(Ten);
92 CallInst *Add1CallRes = new CallInst(Add1F, Params, "add1", BB);
93 Add1CallRes->setTailCall(true);
95 // Create the return instruction and add it to the basic block.
96 new ReturnInst(Add1CallRes, BB);
98 // Now we create the JIT.
99 ExistingModuleProvider* MP = new ExistingModuleProvider(M);
100 ExecutionEngine* EE = ExecutionEngine::create(MP, false);
102 std::cout << "We just constructed this LLVM module:\n\n" << *M;
103 std::cout << "\n\nRunning foo: " << std::flush;
105 // Call the `foo' function with no arguments:
106 std::vector<GenericValue> noargs;
107 GenericValue gv = EE->runFunction(FooF, noargs);
109 // Import result of execution:
110 std::cout << "Result: " << gv.IntVal << "\n";