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 LLVM_UNITTESTS_EXECUTIONENGINE_MCJIT_MCJITTESTBASE_H
18 #define LLVM_UNITTESTS_EXECUTIONENGINE_MCJIT_MCJITTESTBASE_H
20 #include "MCJITTestAPICommon.h"
21 #include "llvm/Config/config.h"
22 #include "llvm/ExecutionEngine/ExecutionEngine.h"
23 #include "llvm/ExecutionEngine/SectionMemoryManager.h"
24 #include "llvm/IR/Function.h"
25 #include "llvm/IR/IRBuilder.h"
26 #include "llvm/IR/LLVMContext.h"
27 #include "llvm/IR/Module.h"
28 #include "llvm/IR/TypeBuilder.h"
29 #include "llvm/Support/CodeGen.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 a declaration to a function defined elsewhere
111 template <typename FuncType>
112 Function *insertExternalReferenceToFunction(Module *M, StringRef Name) {
113 Function *Result = Function::Create(
114 TypeBuilder<FuncType, false>::get(Context),
115 GlobalValue::ExternalLinkage, Name, M);
119 // Inserts an declaration to a function defined elsewhere
120 Function *insertExternalReferenceToFunction(Module *M, StringRef Name,
121 FunctionType *FuncTy) {
122 Function *Result = Function::Create(FuncTy,
123 GlobalValue::ExternalLinkage,
128 // Inserts an declaration to a function defined elsewhere
129 Function *insertExternalReferenceToFunction(Module *M, Function *Func) {
130 Function *Result = Function::Create(Func->getFunctionType(),
131 GlobalValue::ExternalLinkage,
136 // Inserts a global variable of type int32
137 // FIXME: make this a template function to support any type
138 GlobalVariable *insertGlobalInt32(Module *M,
140 int32_t InitialValue) {
141 Type *GlobalTy = TypeBuilder<types::i<32>, true>::get(Context);
142 Constant *IV = ConstantInt::get(Context, APInt(32, InitialValue));
143 GlobalVariable *Global = new GlobalVariable(*M,
146 GlobalValue::ExternalLinkage,
152 // Inserts a function
153 // int32_t recursive_add(int32_t num) {
157 // int32_t recursive_param = num - 1;
158 // return num + Helper(recursive_param);
161 // NOTE: if Helper is left as the default parameter, Helper == recursive_add.
162 Function *insertAccumulateFunction(Module *M,
163 Function *Helper = 0,
164 StringRef Name = "accumulate") {
165 Function *Result = startFunction<int32_t(int32_t)>(M, Name);
169 BasicBlock *BaseCase = BasicBlock::Create(Context, "", Result);
170 BasicBlock *RecursiveCase = BasicBlock::Create(Context, "", Result);
173 Value *Param = Result->arg_begin();
174 Value *Zero = ConstantInt::get(Context, APInt(32, 0));
175 Builder.CreateCondBr(Builder.CreateICmpEQ(Param, Zero),
176 BaseCase, RecursiveCase);
179 Builder.SetInsertPoint(BaseCase);
180 Builder.CreateRet(Param);
182 // int32_t recursive_param = num - 1;
183 // return Helper(recursive_param);
184 Builder.SetInsertPoint(RecursiveCase);
185 Value *One = ConstantInt::get(Context, APInt(32, 1));
186 Value *RecursiveParam = Builder.CreateSub(Param, One);
187 Value *RecursiveReturn = Builder.CreateCall(Helper, RecursiveParam);
188 Value *Accumulator = Builder.CreateAdd(Param, RecursiveReturn);
189 Builder.CreateRet(Accumulator);
194 // Populates Modules A and B:
195 // Module A { Extern FB1, Function FA which calls FB1 },
196 // Module B { Extern FA, Function FB1, Function FB2 which calls FA },
197 void createCrossModuleRecursiveCase(std::unique_ptr<Module> &A, Function *&FA,
198 std::unique_ptr<Module> &B,
199 Function *&FB1, Function *&FB2) {
201 B.reset(createEmptyModule("B"));
202 FB1 = insertAccumulateFunction(B.get(), 0, "FB1");
204 // Declare FB1 in A (as an external).
205 A.reset(createEmptyModule("A"));
206 Function *FB1Extern = insertExternalReferenceToFunction(A.get(), FB1);
208 // Define FA in A (with a call to FB1).
209 FA = insertAccumulateFunction(A.get(), FB1Extern, "FA");
211 // Declare FA in B (as an external)
212 Function *FAExtern = insertExternalReferenceToFunction(B.get(), FA);
214 // Define FB2 in B (with a call to FA)
215 FB2 = insertAccumulateFunction(B.get(), FAExtern, "FB2");
218 // Module A { Function FA },
219 // Module B { Extern FA, Function FB which calls FA },
220 // Module C { Extern FB, Function FC which calls FB },
222 createThreeModuleChainedCallsCase(std::unique_ptr<Module> &A, Function *&FA,
223 std::unique_ptr<Module> &B, Function *&FB,
224 std::unique_ptr<Module> &C, Function *&FC) {
225 A.reset(createEmptyModule("A"));
226 FA = insertAddFunction(A.get());
228 B.reset(createEmptyModule("B"));
229 Function *FAExtern_in_B = insertExternalReferenceToFunction(B.get(), FA);
230 FB = insertSimpleCallFunction<int32_t(int32_t, int32_t)>(B.get(), FAExtern_in_B);
232 C.reset(createEmptyModule("C"));
233 Function *FBExtern_in_C = insertExternalReferenceToFunction(C.get(), FB);
234 FC = insertSimpleCallFunction<int32_t(int32_t, int32_t)>(C.get(), FBExtern_in_C);
238 // Module A { Function FA },
239 // Populates Modules A and B:
240 // Module B { Function FB }
241 void createTwoModuleCase(std::unique_ptr<Module> &A, Function *&FA,
242 std::unique_ptr<Module> &B, Function *&FB) {
243 A.reset(createEmptyModule("A"));
244 FA = insertAddFunction(A.get());
246 B.reset(createEmptyModule("B"));
247 FB = insertAddFunction(B.get());
250 // Module A { Function FA },
251 // Module B { Extern FA, Function FB which calls FA }
252 void createTwoModuleExternCase(std::unique_ptr<Module> &A, Function *&FA,
253 std::unique_ptr<Module> &B, Function *&FB) {
254 A.reset(createEmptyModule("A"));
255 FA = insertAddFunction(A.get());
257 B.reset(createEmptyModule("B"));
258 Function *FAExtern_in_B = insertExternalReferenceToFunction(B.get(), FA);
259 FB = insertSimpleCallFunction<int32_t(int32_t, int32_t)>(B.get(),
263 // Module A { Function FA },
264 // Module B { Extern FA, Function FB which calls FA },
265 // Module C { Extern FB, Function FC which calls FA },
266 void createThreeModuleCase(std::unique_ptr<Module> &A, Function *&FA,
267 std::unique_ptr<Module> &B, Function *&FB,
268 std::unique_ptr<Module> &C, Function *&FC) {
269 A.reset(createEmptyModule("A"));
270 FA = insertAddFunction(A.get());
272 B.reset(createEmptyModule("B"));
273 Function *FAExtern_in_B = insertExternalReferenceToFunction(B.get(), FA);
274 FB = insertSimpleCallFunction<int32_t(int32_t, int32_t)>(B.get(), FAExtern_in_B);
276 C.reset(createEmptyModule("C"));
277 Function *FAExtern_in_C = insertExternalReferenceToFunction(C.get(), FA);
278 FC = insertSimpleCallFunction<int32_t(int32_t, int32_t)>(C.get(), FAExtern_in_C);
283 class MCJITTestBase : public MCJITTestAPICommon, public TrivialModuleBuilder {
287 : TrivialModuleBuilder(HostTriple)
288 , OptLevel(CodeGenOpt::None)
289 , RelocModel(Reloc::Default)
290 , CodeModel(CodeModel::Default)
292 , MM(new SectionMemoryManager)
294 // The architectures below are known to be compatible with MCJIT as they
295 // are copied from test/ExecutionEngine/MCJIT/lit.local.cfg and should be
297 SupportedArchs.push_back(Triple::aarch64);
298 SupportedArchs.push_back(Triple::arm);
299 SupportedArchs.push_back(Triple::mips);
300 SupportedArchs.push_back(Triple::mipsel);
301 SupportedArchs.push_back(Triple::x86);
302 SupportedArchs.push_back(Triple::x86_64);
304 // Some architectures have sub-architectures in which tests will fail, like
305 // ARM. These two vectors will define if they do have sub-archs (to avoid
306 // extra work for those who don't), and if so, if they are listed to work
307 HasSubArchs.push_back(Triple::arm);
308 SupportedSubArchs.push_back("armv6");
309 SupportedSubArchs.push_back("armv7");
311 UnsupportedEnvironments.push_back(Triple::Cygnus);
314 void createJIT(std::unique_ptr<Module> M) {
316 // Due to the EngineBuilder constructor, it is required to have a Module
317 // in order to construct an ExecutionEngine (i.e. MCJIT)
318 assert(M != 0 && "a non-null Module must be provided to create MCJIT");
320 EngineBuilder EB(std::move(M));
322 TheJIT.reset(EB.setEngineKind(EngineKind::JIT)
323 .setMCJITMemoryManager(std::move(MM))
325 .setOptLevel(CodeGenOpt::None)
326 .setCodeModel(CodeModel::JITDefault)
327 .setRelocationModel(Reloc::Default)
329 .setMCPU(sys::getHostCPUName())
332 // At this point, we cannot modify the module any more.
333 assert(TheJIT.get() != NULL && "error creating MCJIT with EngineBuilder");
336 CodeGenOpt::Level OptLevel;
337 Reloc::Model RelocModel;
338 CodeModel::Model CodeModel;
340 SmallVector<std::string, 1> MAttrs;
341 std::unique_ptr<ExecutionEngine> TheJIT;
342 std::unique_ptr<RTDyldMemoryManager> MM;
344 std::unique_ptr<Module> M;