1 //===- MCJITTestBase.h - Common base class for MCJIT Unit tests ----------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This class implements common functionality required by the MCJIT unit tests,
11 // as well as logic to skip tests on unsupported architectures and operating
14 //===----------------------------------------------------------------------===//
17 #ifndef MCJIT_TEST_BASE_H
18 #define MCJIT_TEST_BASE_H
20 #include "llvm/Config/config.h"
21 #include "llvm/ExecutionEngine/ExecutionEngine.h"
22 #include "llvm/ExecutionEngine/SectionMemoryManager.h"
23 #include "llvm/IR/Function.h"
24 #include "llvm/IR/IRBuilder.h"
25 #include "llvm/IR/LLVMContext.h"
26 #include "llvm/IR/Module.h"
27 #include "llvm/IR/TypeBuilder.h"
28 #include "llvm/Support/CodeGen.h"
29 #include "MCJITTestAPICommon.h"
33 /// Helper class that can build very simple Modules
34 class TrivialModuleBuilder {
38 std::string BuilderTriple;
40 TrivialModuleBuilder(const std::string &Triple)
41 : Builder(Context), BuilderTriple(Triple) {}
43 Module *createEmptyModule(StringRef Name = StringRef()) {
44 Module * M = new Module(Name, Context);
45 M->setTargetTriple(Triple::normalize(BuilderTriple));
49 template<typename FuncType>
50 Function *startFunction(Module *M, StringRef Name) {
51 Function *Result = Function::Create(
52 TypeBuilder<FuncType, false>::get(Context),
53 GlobalValue::ExternalLinkage, Name, M);
55 BasicBlock *BB = BasicBlock::Create(Context, Name, Result);
56 Builder.SetInsertPoint(BB);
61 void endFunctionWithRet(Function *Func, Value *RetValue) {
62 Builder.CreateRet(RetValue);
65 // Inserts a simple function that invokes Callee and takes the same arguments:
66 // int Caller(...) { return Callee(...); }
67 template<typename Signature>
68 Function *insertSimpleCallFunction(Module *M, Function *Callee) {
69 Function *Result = startFunction<Signature>(M, "caller");
71 SmallVector<Value*, 1> CallArgs;
73 Function::arg_iterator arg_iter = Result->arg_begin();
74 for(;arg_iter != Result->arg_end(); ++arg_iter)
75 CallArgs.push_back(arg_iter);
77 Value *ReturnCode = Builder.CreateCall(Callee, CallArgs);
78 Builder.CreateRet(ReturnCode);
82 // Inserts a function named 'main' that returns a uint32_t:
83 // int32_t main() { return X; }
84 // where X is given by returnCode
85 Function *insertMainFunction(Module *M, uint32_t returnCode) {
86 Function *Result = startFunction<int32_t(void)>(M, "main");
88 Value *ReturnVal = ConstantInt::get(Context, APInt(32, returnCode));
89 endFunctionWithRet(Result, ReturnVal);
95 // int32_t add(int32_t a, int32_t b) { return a + b; }
96 // in the current module and returns a pointer to it.
97 Function *insertAddFunction(Module *M, StringRef Name = "add") {
98 Function *Result = startFunction<int32_t(int32_t, int32_t)>(M, Name);
100 Function::arg_iterator args = Result->arg_begin();
102 Value *Arg2 = ++args;
103 Value *AddResult = Builder.CreateAdd(Arg1, Arg2);
105 endFunctionWithRet(Result, AddResult);
110 // Inserts an declaration to a function defined elsewhere
111 Function *insertExternalReferenceToFunction(Module *M, StringRef Name,
112 FunctionType *FuncTy) {
113 Function *Result = Function::Create(FuncTy,
114 GlobalValue::ExternalLinkage,
119 // Inserts an declaration to a function defined elsewhere
120 Function *insertExternalReferenceToFunction(Module *M, Function *Func) {
121 Function *Result = Function::Create(Func->getFunctionType(),
122 GlobalValue::AvailableExternallyLinkage,
127 // Inserts a global variable of type int32
128 GlobalVariable *insertGlobalInt32(Module *M,
130 int32_t InitialValue) {
131 Type *GlobalTy = TypeBuilder<types::i<32>, true>::get(Context);
132 Constant *IV = ConstantInt::get(Context, APInt(32, InitialValue));
133 GlobalVariable *Global = new GlobalVariable(*M,
136 GlobalValue::ExternalLinkage,
143 class MCJITTestBase : public MCJITTestAPICommon, public TrivialModuleBuilder {
147 : TrivialModuleBuilder(HostTriple)
148 , OptLevel(CodeGenOpt::None)
149 , RelocModel(Reloc::Default)
150 , CodeModel(CodeModel::Default)
152 , MM(new SectionMemoryManager)
154 // The architectures below are known to be compatible with MCJIT as they
155 // are copied from test/ExecutionEngine/MCJIT/lit.local.cfg and should be
157 SupportedArchs.push_back(Triple::aarch64);
158 SupportedArchs.push_back(Triple::arm);
159 SupportedArchs.push_back(Triple::mips);
160 SupportedArchs.push_back(Triple::mipsel);
161 SupportedArchs.push_back(Triple::x86);
162 SupportedArchs.push_back(Triple::x86_64);
164 // Some architectures have sub-architectures in which tests will fail, like
165 // ARM. These two vectors will define if they do have sub-archs (to avoid
166 // extra work for those who don't), and if so, if they are listed to work
167 HasSubArchs.push_back(Triple::arm);
168 SupportedSubArchs.push_back("armv6");
169 SupportedSubArchs.push_back("armv7");
171 // The operating systems below are known to be incompatible with MCJIT as
172 // they are copied from the test/ExecutionEngine/MCJIT/lit.local.cfg and
173 // should be kept in sync.
174 UnsupportedOSs.push_back(Triple::Cygwin);
175 UnsupportedOSs.push_back(Triple::Darwin);
178 void createJIT(Module *M) {
180 // Due to the EngineBuilder constructor, it is required to have a Module
181 // in order to construct an ExecutionEngine (i.e. MCJIT)
182 assert(M != 0 && "a non-null Module must be provided to create MCJIT");
186 TheJIT.reset(EB.setEngineKind(EngineKind::JIT)
187 .setUseMCJIT(true) /* can this be folded into the EngineKind enum? */
188 .setMCJITMemoryManager(MM)
190 .setOptLevel(CodeGenOpt::None)
191 .setAllocateGVsWithCode(false) /*does this do anything?*/
192 .setCodeModel(CodeModel::JITDefault)
193 .setRelocationModel(Reloc::Default)
195 .setMCPU(sys::getHostCPUName())
198 // At this point, we cannot modify the module any more.
199 assert(TheJIT.get() != NULL && "error creating MCJIT with EngineBuilder");
202 CodeGenOpt::Level OptLevel;
203 Reloc::Model RelocModel;
204 CodeModel::Model CodeModel;
206 SmallVector<std::string, 1> MAttrs;
207 OwningPtr<ExecutionEngine> TheJIT;
208 RTDyldMemoryManager *MM;
215 #endif // MCJIT_TEST_H