1 //===--- examples/Fibonacci/fibonacci.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 build quickly a small module
11 // with function Fibonacci and execute it with the JIT.
13 // The goal of this snippet is to create in the memory the LLVM module
14 // consisting of one function as follow:
18 // return fib(x-1)+fib(x-2);
21 // Once we have this, we compile the module via JIT, then execute the `fib'
22 // function and return result to a driver, i.e. to a "host program".
24 //===----------------------------------------------------------------------===//
26 #include "llvm/Module.h"
27 #include "llvm/DerivedTypes.h"
28 #include "llvm/Constants.h"
29 #include "llvm/Instructions.h"
30 #include "llvm/ModuleProvider.h"
31 #include "llvm/Analysis/Verifier.h"
32 #include "llvm/ExecutionEngine/ExecutionEngine.h"
33 #include "llvm/ExecutionEngine/GenericValue.h"
37 static Function *CreateFibFunction(Module *M) {
38 // Create the fib function and insert it into module M. This function is said
39 // to return an int and take an int parameter.
40 Function *FibF = M->getOrInsertFunction("fib", Type::IntTy, Type::IntTy,
43 // Add a basic block to the function.
44 BasicBlock *BB = new BasicBlock("EntryBlock", FibF);
46 // Get pointers to the constants.
47 Value *One = ConstantSInt::get(Type::IntTy, 1);
48 Value *Two = ConstantSInt::get(Type::IntTy, 2);
50 // Get pointer to the integer argument of the add1 function...
51 Argument *ArgX = FibF->arg_begin(); // Get the arg.
52 ArgX->setName("AnArg"); // Give it a nice symbolic name for fun.
54 // Create the true_block.
55 BasicBlock *RetBB = new BasicBlock("return", FibF);
56 // Create an exit block.
57 BasicBlock* RecurseBB = new BasicBlock("recurse", FibF);
59 // Create the "if (arg < 2) goto exitbb"
60 Value *CondInst = BinaryOperator::createSetLE(ArgX, Two, "cond", BB);
61 new BranchInst(RetBB, RecurseBB, CondInst, BB);
64 new ReturnInst(One, RetBB);
67 Value *Sub = BinaryOperator::createSub(ArgX, One, "arg", RecurseBB);
68 CallInst *CallFibX1 = new CallInst(FibF, Sub, "fibx1", RecurseBB);
69 CallFibX1->setTailCall();
72 Sub = BinaryOperator::createSub(ArgX, Two, "arg", RecurseBB);
73 CallInst *CallFibX2 = new CallInst(FibF, Sub, "fibx2", RecurseBB);
74 CallFibX2->setTailCall();
78 Value *Sum = BinaryOperator::createAdd(CallFibX1, CallFibX2,
79 "addresult", RecurseBB);
81 // Create the return instruction and add it to the basic block
82 new ReturnInst(Sum, RecurseBB);
88 int main(int argc, char **argv) {
89 int n = argc > 1 ? atol(argv[1]) : 24;
91 // Create some module to put our function into it.
92 Module *M = new Module("test");
94 // We are about to create the "fib" function:
95 Function *FibF = CreateFibFunction(M);
97 // Now we going to create JIT
98 ExistingModuleProvider *MP = new ExistingModuleProvider(M);
99 ExecutionEngine *EE = ExecutionEngine::create(MP, false);
101 std::cerr << "verifying... ";
102 if (verifyModule(*M)) {
103 std::cerr << argv[0] << ": Error constructing function!\n";
108 std::cerr << "We just constructed this LLVM module:\n\n---------\n" << *M;
109 std::cerr << "---------\nstarting fibonacci(" << n << ") with JIT...\n";
111 // Call the Fibonacci function with argument n:
112 std::vector<GenericValue> Args(1);
114 GenericValue GV = EE->runFunction(FibF, Args);
116 // import result of execution
117 std::cout << "Result: " << GV.IntVal << "\n";