1 //===- JITTest.cpp - Unit tests for the JIT -------------------------------===//
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 #include "gtest/gtest.h"
11 #include "llvm/ADT/OwningPtr.h"
12 #include "llvm/ADT/SmallPtrSet.h"
13 #include "llvm/Assembly/Parser.h"
14 #include "llvm/BasicBlock.h"
15 #include "llvm/Constant.h"
16 #include "llvm/Constants.h"
17 #include "llvm/DerivedTypes.h"
18 #include "llvm/ExecutionEngine/JIT.h"
19 #include "llvm/ExecutionEngine/JITMemoryManager.h"
20 #include "llvm/Function.h"
21 #include "llvm/GlobalValue.h"
22 #include "llvm/GlobalVariable.h"
23 #include "llvm/LLVMContext.h"
24 #include "llvm/Module.h"
25 #include "llvm/ModuleProvider.h"
26 #include "llvm/Support/IRBuilder.h"
27 #include "llvm/Support/SourceMgr.h"
28 #include "llvm/Support/TypeBuilder.h"
29 #include "llvm/Target/TargetSelect.h"
30 #include "llvm/Type.h"
38 Function *makeReturnGlobal(std::string Name, GlobalVariable *G, Module *M) {
39 std::vector<const Type*> params;
40 const FunctionType *FTy = FunctionType::get(G->getType()->getElementType(),
42 Function *F = Function::Create(FTy, GlobalValue::ExternalLinkage, Name, M);
43 BasicBlock *Entry = BasicBlock::Create(M->getContext(), "entry", F);
44 IRBuilder<> builder(Entry);
45 Value *Load = builder.CreateLoad(G);
46 const Type *GTy = G->getType()->getElementType();
47 Value *Add = builder.CreateAdd(Load, ConstantInt::get(GTy, 1LL));
48 builder.CreateStore(Add, G);
49 builder.CreateRet(Add);
53 std::string DumpFunction(const Function *F) {
55 raw_string_ostream(Result) << "" << *F;
59 class RecordingJITMemoryManager : public JITMemoryManager {
60 const OwningPtr<JITMemoryManager> Base;
62 RecordingJITMemoryManager()
63 : Base(JITMemoryManager::CreateDefaultMemManager()) {
67 virtual void setMemoryWritable() { Base->setMemoryWritable(); }
68 virtual void setMemoryExecutable() { Base->setMemoryExecutable(); }
69 virtual void setPoisonMemory(bool poison) { Base->setPoisonMemory(poison); }
70 virtual void AllocateGOT() { Base->AllocateGOT(); }
71 virtual uint8_t *getGOTBase() const { return Base->getGOTBase(); }
72 struct StartFunctionBodyCall {
73 StartFunctionBodyCall(uint8_t *Result, const Function *F,
74 uintptr_t ActualSize, uintptr_t ActualSizeResult)
75 : Result(Result), F(F), F_dump(DumpFunction(F)),
76 ActualSize(ActualSize), ActualSizeResult(ActualSizeResult) {}
81 uintptr_t ActualSizeResult;
83 std::vector<StartFunctionBodyCall> startFunctionBodyCalls;
84 virtual uint8_t *startFunctionBody(const Function *F,
85 uintptr_t &ActualSize) {
86 uintptr_t InitialActualSize = ActualSize;
87 uint8_t *Result = Base->startFunctionBody(F, ActualSize);
88 startFunctionBodyCalls.push_back(
89 StartFunctionBodyCall(Result, F, InitialActualSize, ActualSize));
93 virtual uint8_t *allocateStub(const GlobalValue* F, unsigned StubSize,
96 return Base->allocateStub(F, StubSize, Alignment);
98 struct EndFunctionBodyCall {
99 EndFunctionBodyCall(const Function *F, uint8_t *FunctionStart,
100 uint8_t *FunctionEnd)
101 : F(F), F_dump(DumpFunction(F)),
102 FunctionStart(FunctionStart), FunctionEnd(FunctionEnd) {}
105 uint8_t *FunctionStart;
106 uint8_t *FunctionEnd;
108 std::vector<EndFunctionBodyCall> endFunctionBodyCalls;
109 virtual void endFunctionBody(const Function *F, uint8_t *FunctionStart,
110 uint8_t *FunctionEnd) {
111 endFunctionBodyCalls.push_back(
112 EndFunctionBodyCall(F, FunctionStart, FunctionEnd));
113 Base->endFunctionBody(F, FunctionStart, FunctionEnd);
115 virtual uint8_t *allocateSpace(intptr_t Size, unsigned Alignment) {
116 return Base->allocateSpace(Size, Alignment);
118 virtual uint8_t *allocateGlobal(uintptr_t Size, unsigned Alignment) {
119 return Base->allocateGlobal(Size, Alignment);
121 struct DeallocateFunctionBodyCall {
122 DeallocateFunctionBodyCall(const void *Body) : Body(Body) {}
125 std::vector<DeallocateFunctionBodyCall> deallocateFunctionBodyCalls;
126 virtual void deallocateFunctionBody(void *Body) {
127 deallocateFunctionBodyCalls.push_back(DeallocateFunctionBodyCall(Body));
128 Base->deallocateFunctionBody(Body);
130 struct DeallocateExceptionTableCall {
131 DeallocateExceptionTableCall(const void *ET) : ET(ET) {}
134 std::vector<DeallocateExceptionTableCall> deallocateExceptionTableCalls;
135 virtual void deallocateExceptionTable(void *ET) {
136 deallocateExceptionTableCalls.push_back(DeallocateExceptionTableCall(ET));
137 Base->deallocateExceptionTable(ET);
139 struct StartExceptionTableCall {
140 StartExceptionTableCall(uint8_t *Result, const Function *F,
141 uintptr_t ActualSize, uintptr_t ActualSizeResult)
142 : Result(Result), F(F), F_dump(DumpFunction(F)),
143 ActualSize(ActualSize), ActualSizeResult(ActualSizeResult) {}
147 uintptr_t ActualSize;
148 uintptr_t ActualSizeResult;
150 std::vector<StartExceptionTableCall> startExceptionTableCalls;
151 virtual uint8_t* startExceptionTable(const Function* F,
152 uintptr_t &ActualSize) {
153 uintptr_t InitialActualSize = ActualSize;
154 uint8_t *Result = Base->startExceptionTable(F, ActualSize);
155 startExceptionTableCalls.push_back(
156 StartExceptionTableCall(Result, F, InitialActualSize, ActualSize));
159 struct EndExceptionTableCall {
160 EndExceptionTableCall(const Function *F, uint8_t *TableStart,
161 uint8_t *TableEnd, uint8_t* FrameRegister)
162 : F(F), F_dump(DumpFunction(F)),
163 TableStart(TableStart), TableEnd(TableEnd),
164 FrameRegister(FrameRegister) {}
169 uint8_t *FrameRegister;
171 std::vector<EndExceptionTableCall> endExceptionTableCalls;
172 virtual void endExceptionTable(const Function *F, uint8_t *TableStart,
173 uint8_t *TableEnd, uint8_t* FrameRegister) {
174 endExceptionTableCalls.push_back(
175 EndExceptionTableCall(F, TableStart, TableEnd, FrameRegister));
176 return Base->endExceptionTable(F, TableStart, TableEnd, FrameRegister);
180 class JITTest : public testing::Test {
182 virtual void SetUp() {
183 M = new Module("<main>", Context);
184 MP = new ExistingModuleProvider(M);
185 RJMM = new RecordingJITMemoryManager;
186 RJMM->setPoisonMemory(true);
188 TheJIT.reset(EngineBuilder(MP).setEngineKind(EngineKind::JIT)
189 .setJITMemoryManager(RJMM)
190 .setErrorStr(&Error).create());
191 ASSERT_TRUE(TheJIT.get() != NULL) << Error;
194 void LoadAssembly(const char *assembly) {
196 bool success = NULL != ParseAssemblyString(assembly, M, Error, Context);
198 raw_string_ostream os(errMsg);
200 ASSERT_TRUE(success) << os.str();
204 Module *M; // Owned by MP.
205 ModuleProvider *MP; // Owned by ExecutionEngine.
206 RecordingJITMemoryManager *RJMM;
207 OwningPtr<ExecutionEngine> TheJIT;
210 // Regression test for a bug. The JIT used to allocate globals inside the same
211 // memory block used for the function, and when the function code was freed,
212 // the global was left in the same place. This test allocates a function
213 // that uses and global, deallocates it, and then makes sure that the global
214 // stays alive after that.
215 TEST(JIT, GlobalInFunction) {
217 Module *M = new Module("<main>", context);
218 ExistingModuleProvider *MP = new ExistingModuleProvider(M);
220 JITMemoryManager *MemMgr = JITMemoryManager::CreateDefaultMemManager();
221 // Tell the memory manager to poison freed memory so that accessing freed
222 // memory is more easily tested.
223 MemMgr->setPoisonMemory(true);
225 OwningPtr<ExecutionEngine> JIT(EngineBuilder(MP)
226 .setEngineKind(EngineKind::JIT)
228 .setJITMemoryManager(MemMgr)
229 // The next line enables the fix:
230 .setAllocateGVsWithCode(false)
232 ASSERT_EQ(Error, "");
234 // Create a global variable.
235 const Type *GTy = Type::getInt32Ty(context);
236 GlobalVariable *G = new GlobalVariable(
239 false, // Not constant.
240 GlobalValue::InternalLinkage,
241 Constant::getNullValue(GTy),
244 // Make a function that points to a global.
245 Function *F1 = makeReturnGlobal("F1", G, M);
247 // Get the pointer to the native code to force it to JIT the function and
248 // allocate space for the global.
250 reinterpret_cast<void(*)()>((intptr_t)JIT->getPointerToFunction(F1));
252 // Since F1 was codegen'd, a pointer to G should be available.
253 int32_t *GPtr = (int32_t*)JIT->getPointerToGlobalIfAvailable(G);
254 ASSERT_NE((int32_t*)NULL, GPtr);
257 // F1() should increment G.
261 // Make a second function identical to the first, referring to the same
263 Function *F2 = makeReturnGlobal("F2", G, M);
265 reinterpret_cast<void(*)()>((intptr_t)JIT->getPointerToFunction(F2));
267 // F2() should increment G.
272 JIT->freeMachineCodeForFunction(F1);
274 // F2() should *still* increment G.
279 int PlusOne(int arg) {
283 TEST_F(JITTest, FarCallToKnownFunction) {
284 // x86-64 can only make direct calls to functions within 32 bits of
285 // the current PC. To call anything farther away, we have to load
286 // the address into a register and call through the register. The
287 // current JIT does this by allocating a stub for any far call.
288 // There was a bug in which the JIT tried to emit a direct call when
289 // the target was already in the JIT's global mappings and lazy
290 // compilation was disabled.
292 Function *KnownFunction = Function::Create(
293 TypeBuilder<int(int), false>::get(Context),
294 GlobalValue::ExternalLinkage, "known", M);
295 TheJIT->addGlobalMapping(KnownFunction, (void*)(intptr_t)PlusOne);
297 // int test() { return known(7); }
298 Function *TestFunction = Function::Create(
299 TypeBuilder<int(), false>::get(Context),
300 GlobalValue::ExternalLinkage, "test", M);
301 BasicBlock *Entry = BasicBlock::Create(Context, "entry", TestFunction);
302 IRBuilder<> Builder(Entry);
303 Value *result = Builder.CreateCall(
305 ConstantInt::get(TypeBuilder<int, false>::get(Context), 7));
306 Builder.CreateRet(result);
308 TheJIT->DisableLazyCompilation(true);
309 int (*TestFunctionPtr)() = reinterpret_cast<int(*)()>(
310 (intptr_t)TheJIT->getPointerToFunction(TestFunction));
311 // This used to crash in trying to call PlusOne().
312 EXPECT_EQ(8, TestFunctionPtr());
315 // Test a function C which calls A and B which call each other.
316 TEST_F(JITTest, NonLazyCompilationStillNeedsStubs) {
317 TheJIT->DisableLazyCompilation(true);
319 const FunctionType *Func1Ty =
320 cast<FunctionType>(TypeBuilder<void(void), false>::get(Context));
321 std::vector<const Type*> arg_types;
322 arg_types.push_back(Type::getInt1Ty(Context));
323 const FunctionType *FuncTy = FunctionType::get(
324 Type::getVoidTy(Context), arg_types, false);
325 Function *Func1 = Function::Create(Func1Ty, Function::ExternalLinkage,
327 Function *Func2 = Function::Create(FuncTy, Function::InternalLinkage,
329 Function *Func3 = Function::Create(FuncTy, Function::InternalLinkage,
331 BasicBlock *Block1 = BasicBlock::Create(Context, "block1", Func1);
332 BasicBlock *Block2 = BasicBlock::Create(Context, "block2", Func2);
333 BasicBlock *True2 = BasicBlock::Create(Context, "cond_true", Func2);
334 BasicBlock *False2 = BasicBlock::Create(Context, "cond_false", Func2);
335 BasicBlock *Block3 = BasicBlock::Create(Context, "block3", Func3);
336 BasicBlock *True3 = BasicBlock::Create(Context, "cond_true", Func3);
337 BasicBlock *False3 = BasicBlock::Create(Context, "cond_false", Func3);
339 // Make Func1 call Func2(0) and Func3(0).
340 IRBuilder<> Builder(Block1);
341 Builder.CreateCall(Func2, ConstantInt::getTrue(Context));
342 Builder.CreateCall(Func3, ConstantInt::getTrue(Context));
343 Builder.CreateRetVoid();
345 // void Func2(bool b) { if (b) { Func3(false); return; } return; }
346 Builder.SetInsertPoint(Block2);
347 Builder.CreateCondBr(Func2->arg_begin(), True2, False2);
348 Builder.SetInsertPoint(True2);
349 Builder.CreateCall(Func3, ConstantInt::getFalse(Context));
350 Builder.CreateRetVoid();
351 Builder.SetInsertPoint(False2);
352 Builder.CreateRetVoid();
354 // void Func3(bool b) { if (b) { Func2(false); return; } return; }
355 Builder.SetInsertPoint(Block3);
356 Builder.CreateCondBr(Func3->arg_begin(), True3, False3);
357 Builder.SetInsertPoint(True3);
358 Builder.CreateCall(Func2, ConstantInt::getFalse(Context));
359 Builder.CreateRetVoid();
360 Builder.SetInsertPoint(False3);
361 Builder.CreateRetVoid();
363 // Compile the function to native code
365 reinterpret_cast<void(*)()>((intptr_t)TheJIT->getPointerToFunction(Func1));
370 // Regression test for PR5162. This used to trigger an AssertingVH inside the
371 // JIT's Function to stub mapping.
372 TEST_F(JITTest, NonLazyLeaksNoStubs) {
373 TheJIT->DisableLazyCompilation(true);
375 // Create two functions with a single basic block each.
376 const FunctionType *FuncTy =
377 cast<FunctionType>(TypeBuilder<int(), false>::get(Context));
378 Function *Func1 = Function::Create(FuncTy, Function::ExternalLinkage,
380 Function *Func2 = Function::Create(FuncTy, Function::InternalLinkage,
382 BasicBlock *Block1 = BasicBlock::Create(Context, "block1", Func1);
383 BasicBlock *Block2 = BasicBlock::Create(Context, "block2", Func2);
385 // The first function calls the second and returns the result
386 IRBuilder<> Builder(Block1);
387 Value *Result = Builder.CreateCall(Func2);
388 Builder.CreateRet(Result);
390 // The second function just returns a constant
391 Builder.SetInsertPoint(Block2);
392 Builder.CreateRet(ConstantInt::get(TypeBuilder<int, false>::get(Context),42));
394 // Compile the function to native code
395 (void)TheJIT->getPointerToFunction(Func1);
397 // Free the JIT state for the functions
398 TheJIT->freeMachineCodeForFunction(Func1);
399 TheJIT->freeMachineCodeForFunction(Func2);
401 // Delete the first function (and show that is has no users)
402 EXPECT_EQ(Func1->getNumUses(), 0u);
403 Func1->eraseFromParent();
405 // Delete the second function (and show that it has no users - it had one,
406 // func1 but that's gone now)
407 EXPECT_EQ(Func2->getNumUses(), 0u);
408 Func2->eraseFromParent();
411 TEST_F(JITTest, ModuleDeletion) {
412 TheJIT->DisableLazyCompilation(false);
413 LoadAssembly("define void @main() { "
414 " call i32 @computeVal() "
418 "define internal i32 @computeVal() { "
421 Function *func = M->getFunction("main");
422 TheJIT->getPointerToFunction(func);
423 TheJIT->deleteModuleProvider(MP);
425 SmallPtrSet<const void*, 2> FunctionsDeallocated;
426 for (unsigned i = 0, e = RJMM->deallocateFunctionBodyCalls.size();
428 FunctionsDeallocated.insert(RJMM->deallocateFunctionBodyCalls[i].Body);
430 for (unsigned i = 0, e = RJMM->startFunctionBodyCalls.size(); i != e; ++i) {
431 EXPECT_TRUE(FunctionsDeallocated.count(
432 RJMM->startFunctionBodyCalls[i].Result))
433 << "Function leaked: \n" << RJMM->startFunctionBodyCalls[i].F_dump;
435 EXPECT_EQ(RJMM->startFunctionBodyCalls.size(),
436 RJMM->deallocateFunctionBodyCalls.size());
438 SmallPtrSet<const void*, 2> ExceptionTablesDeallocated;
439 unsigned NumTablesDeallocated = 0;
440 for (unsigned i = 0, e = RJMM->deallocateExceptionTableCalls.size();
442 ExceptionTablesDeallocated.insert(
443 RJMM->deallocateExceptionTableCalls[i].ET);
444 if (RJMM->deallocateExceptionTableCalls[i].ET != NULL) {
445 // If JITEmitDebugInfo is off, we'll "deallocate" NULL, which doesn't
446 // appear in startExceptionTableCalls.
447 NumTablesDeallocated++;
450 for (unsigned i = 0, e = RJMM->startExceptionTableCalls.size(); i != e; ++i) {
451 EXPECT_TRUE(ExceptionTablesDeallocated.count(
452 RJMM->startExceptionTableCalls[i].Result))
453 << "Function's exception table leaked: \n"
454 << RJMM->startExceptionTableCalls[i].F_dump;
456 EXPECT_EQ(RJMM->startExceptionTableCalls.size(),
457 NumTablesDeallocated);
460 // ARM and PPC still emit stubs for calls since the target may be too far away
461 // to call directly. This #if can probably be removed when
462 // http://llvm.org/PR5201 is fixed.
463 #if !defined(__arm__) && !defined(__powerpc__) && !defined(__ppc__)
464 typedef int (*FooPtr) ();
466 TEST_F(JITTest, NoStubs) {
467 LoadAssembly("define void @bar() {"
472 "define i32 @foo() {"
478 "define i32 @main() {"
480 "%0 = call i32 @foo()"
484 Function *foo = M->getFunction("foo");
485 uintptr_t tmp = (uintptr_t)(TheJIT->getPointerToFunction(foo));
486 FooPtr ptr = (FooPtr)(tmp);
490 // We should now allocate no more stubs, we have the code to foo
491 // and the existing stub for bar.
492 int stubsBefore = RJMM->stubsAllocated;
493 Function *func = M->getFunction("main");
494 TheJIT->getPointerToFunction(func);
496 Function *bar = M->getFunction("bar");
497 TheJIT->getPointerToFunction(bar);
499 ASSERT_EQ(stubsBefore, RJMM->stubsAllocated);
501 #endif // !ARM && !PPC
503 TEST_F(JITTest, FunctionPointersOutliveTheirCreator) {
504 TheJIT->DisableLazyCompilation(true);
505 LoadAssembly("define i8()* @get_foo_addr() { "
509 "define i8 @foo() { "
512 Function *F_get_foo_addr = M->getFunction("get_foo_addr");
514 typedef char(*fooT)();
515 fooT (*get_foo_addr)() = reinterpret_cast<fooT(*)()>(
516 (intptr_t)TheJIT->getPointerToFunction(F_get_foo_addr));
517 fooT foo_addr = get_foo_addr();
519 // Now free get_foo_addr. This should not free the machine code for foo or
520 // any call stub returned as foo's canonical address.
521 TheJIT->freeMachineCodeForFunction(F_get_foo_addr);
523 // Check by calling the reported address of foo.
524 EXPECT_EQ(42, foo_addr());
526 // The reported address should also be the same as the result of a subsequent
527 // getPointerToFunction(foo).
529 // Fails until PR5126 is fixed:
530 Function *F_foo = M->getFunction("foo");
531 fooT foo = reinterpret_cast<fooT>(
532 (intptr_t)TheJIT->getPointerToFunction(F_foo));
533 EXPECT_EQ((intptr_t)foo, (intptr_t)foo_addr);
537 // This code is copied from JITEventListenerTest, but it only runs once for all
538 // the tests in this directory. Everything seems fine, but that's strange
540 class JITEnvironment : public testing::Environment {
541 virtual void SetUp() {
542 // Required to create a JIT.
543 InitializeNativeTarget();
546 testing::Environment* const jit_env =
547 testing::AddGlobalTestEnvironment(new JITEnvironment);