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 "llvm/ExecutionEngine/JIT.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/Bitcode/ReaderWriter.h"
16 #include "llvm/Constant.h"
17 #include "llvm/Constants.h"
18 #include "llvm/DerivedTypes.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/IRBuilder.h"
24 #include "llvm/LLVMContext.h"
25 #include "llvm/Module.h"
26 #include "llvm/Support/MemoryBuffer.h"
27 #include "llvm/Support/SourceMgr.h"
28 #include "llvm/Support/TargetSelect.h"
29 #include "llvm/Type.h"
30 #include "llvm/TypeBuilder.h"
31 #include "gtest/gtest.h"
38 Function *makeReturnGlobal(std::string Name, GlobalVariable *G, Module *M) {
39 std::vector<Type*> params;
40 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 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()) {
66 virtual void *getPointerToNamedFunction(const std::string &Name,
67 bool AbortOnFailure = true) {
68 return Base->getPointerToNamedFunction(Name, AbortOnFailure);
71 virtual void setMemoryWritable() { Base->setMemoryWritable(); }
72 virtual void setMemoryExecutable() { Base->setMemoryExecutable(); }
73 virtual void setPoisonMemory(bool poison) { Base->setPoisonMemory(poison); }
74 virtual void AllocateGOT() { Base->AllocateGOT(); }
75 virtual uint8_t *getGOTBase() const { return Base->getGOTBase(); }
76 struct StartFunctionBodyCall {
77 StartFunctionBodyCall(uint8_t *Result, const Function *F,
78 uintptr_t ActualSize, uintptr_t ActualSizeResult)
79 : Result(Result), F(F), F_dump(DumpFunction(F)),
80 ActualSize(ActualSize), ActualSizeResult(ActualSizeResult) {}
85 uintptr_t ActualSizeResult;
87 std::vector<StartFunctionBodyCall> startFunctionBodyCalls;
88 virtual uint8_t *startFunctionBody(const Function *F,
89 uintptr_t &ActualSize) {
90 uintptr_t InitialActualSize = ActualSize;
91 uint8_t *Result = Base->startFunctionBody(F, ActualSize);
92 startFunctionBodyCalls.push_back(
93 StartFunctionBodyCall(Result, F, InitialActualSize, ActualSize));
97 virtual uint8_t *allocateStub(const GlobalValue* F, unsigned StubSize,
100 return Base->allocateStub(F, StubSize, Alignment);
102 struct EndFunctionBodyCall {
103 EndFunctionBodyCall(const Function *F, uint8_t *FunctionStart,
104 uint8_t *FunctionEnd)
105 : F(F), F_dump(DumpFunction(F)),
106 FunctionStart(FunctionStart), FunctionEnd(FunctionEnd) {}
109 uint8_t *FunctionStart;
110 uint8_t *FunctionEnd;
112 std::vector<EndFunctionBodyCall> endFunctionBodyCalls;
113 virtual void endFunctionBody(const Function *F, uint8_t *FunctionStart,
114 uint8_t *FunctionEnd) {
115 endFunctionBodyCalls.push_back(
116 EndFunctionBodyCall(F, FunctionStart, FunctionEnd));
117 Base->endFunctionBody(F, FunctionStart, FunctionEnd);
119 virtual uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
120 unsigned SectionID, bool IsReadOnly) {
121 return Base->allocateDataSection(Size, Alignment, SectionID, IsReadOnly);
123 virtual uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
124 unsigned SectionID) {
125 return Base->allocateCodeSection(Size, Alignment, SectionID);
127 virtual bool applyPermissions(std::string *ErrMsg) { return false; }
128 virtual uint8_t *allocateSpace(intptr_t Size, unsigned Alignment) {
129 return Base->allocateSpace(Size, Alignment);
131 virtual uint8_t *allocateGlobal(uintptr_t Size, unsigned Alignment) {
132 return Base->allocateGlobal(Size, Alignment);
134 struct DeallocateFunctionBodyCall {
135 DeallocateFunctionBodyCall(const void *Body) : Body(Body) {}
138 std::vector<DeallocateFunctionBodyCall> deallocateFunctionBodyCalls;
139 virtual void deallocateFunctionBody(void *Body) {
140 deallocateFunctionBodyCalls.push_back(DeallocateFunctionBodyCall(Body));
141 Base->deallocateFunctionBody(Body);
143 struct DeallocateExceptionTableCall {
144 DeallocateExceptionTableCall(const void *ET) : ET(ET) {}
147 std::vector<DeallocateExceptionTableCall> deallocateExceptionTableCalls;
148 virtual void deallocateExceptionTable(void *ET) {
149 deallocateExceptionTableCalls.push_back(DeallocateExceptionTableCall(ET));
150 Base->deallocateExceptionTable(ET);
152 struct StartExceptionTableCall {
153 StartExceptionTableCall(uint8_t *Result, const Function *F,
154 uintptr_t ActualSize, uintptr_t ActualSizeResult)
155 : Result(Result), F(F), F_dump(DumpFunction(F)),
156 ActualSize(ActualSize), ActualSizeResult(ActualSizeResult) {}
160 uintptr_t ActualSize;
161 uintptr_t ActualSizeResult;
163 std::vector<StartExceptionTableCall> startExceptionTableCalls;
164 virtual uint8_t* startExceptionTable(const Function* F,
165 uintptr_t &ActualSize) {
166 uintptr_t InitialActualSize = ActualSize;
167 uint8_t *Result = Base->startExceptionTable(F, ActualSize);
168 startExceptionTableCalls.push_back(
169 StartExceptionTableCall(Result, F, InitialActualSize, ActualSize));
172 struct EndExceptionTableCall {
173 EndExceptionTableCall(const Function *F, uint8_t *TableStart,
174 uint8_t *TableEnd, uint8_t* FrameRegister)
175 : F(F), F_dump(DumpFunction(F)),
176 TableStart(TableStart), TableEnd(TableEnd),
177 FrameRegister(FrameRegister) {}
182 uint8_t *FrameRegister;
184 std::vector<EndExceptionTableCall> endExceptionTableCalls;
185 virtual void endExceptionTable(const Function *F, uint8_t *TableStart,
186 uint8_t *TableEnd, uint8_t* FrameRegister) {
187 endExceptionTableCalls.push_back(
188 EndExceptionTableCall(F, TableStart, TableEnd, FrameRegister));
189 return Base->endExceptionTable(F, TableStart, TableEnd, FrameRegister);
193 bool LoadAssemblyInto(Module *M, const char *assembly) {
196 NULL != ParseAssemblyString(assembly, M, Error, M->getContext());
198 raw_string_ostream os(errMsg);
200 EXPECT_TRUE(success) << os.str();
204 class JITTest : public testing::Test {
206 virtual void SetUp() {
207 M = new Module("<main>", Context);
208 RJMM = new RecordingJITMemoryManager;
209 RJMM->setPoisonMemory(true);
211 TheJIT.reset(EngineBuilder(M).setEngineKind(EngineKind::JIT)
212 .setJITMemoryManager(RJMM)
213 .setErrorStr(&Error).create());
214 ASSERT_TRUE(TheJIT.get() != NULL) << Error;
217 void LoadAssembly(const char *assembly) {
218 LoadAssemblyInto(M, assembly);
222 Module *M; // Owned by ExecutionEngine.
223 RecordingJITMemoryManager *RJMM;
224 OwningPtr<ExecutionEngine> TheJIT;
227 // Tests on ARM and PowerPC disabled as we're running the old jit
228 #if !defined(__arm__) && !defined(__powerpc__)
230 // Regression test for a bug. The JIT used to allocate globals inside the same
231 // memory block used for the function, and when the function code was freed,
232 // the global was left in the same place. This test allocates a function
233 // that uses and global, deallocates it, and then makes sure that the global
234 // stays alive after that.
235 TEST(JIT, GlobalInFunction) {
237 Module *M = new Module("<main>", context);
239 JITMemoryManager *MemMgr = JITMemoryManager::CreateDefaultMemManager();
240 // Tell the memory manager to poison freed memory so that accessing freed
241 // memory is more easily tested.
242 MemMgr->setPoisonMemory(true);
244 OwningPtr<ExecutionEngine> JIT(EngineBuilder(M)
245 .setEngineKind(EngineKind::JIT)
247 .setJITMemoryManager(MemMgr)
248 // The next line enables the fix:
249 .setAllocateGVsWithCode(false)
251 ASSERT_EQ(Error, "");
253 // Create a global variable.
254 Type *GTy = Type::getInt32Ty(context);
255 GlobalVariable *G = new GlobalVariable(
258 false, // Not constant.
259 GlobalValue::InternalLinkage,
260 Constant::getNullValue(GTy),
263 // Make a function that points to a global.
264 Function *F1 = makeReturnGlobal("F1", G, M);
266 // Get the pointer to the native code to force it to JIT the function and
267 // allocate space for the global.
269 reinterpret_cast<void(*)()>((intptr_t)JIT->getPointerToFunction(F1));
271 // Since F1 was codegen'd, a pointer to G should be available.
272 int32_t *GPtr = (int32_t*)JIT->getPointerToGlobalIfAvailable(G);
273 ASSERT_NE((int32_t*)NULL, GPtr);
276 // F1() should increment G.
280 // Make a second function identical to the first, referring to the same
282 Function *F2 = makeReturnGlobal("F2", G, M);
284 reinterpret_cast<void(*)()>((intptr_t)JIT->getPointerToFunction(F2));
286 // F2() should increment G.
291 JIT->freeMachineCodeForFunction(F1);
293 // F2() should *still* increment G.
298 #endif // !defined(__arm__) && !defined(__powerpc__)
300 int PlusOne(int arg) {
304 // ARM and PowerPC tests disabled pending fix for PR10783.
305 #if !defined(__arm__) && !defined(__powerpc__)
306 TEST_F(JITTest, FarCallToKnownFunction) {
307 // x86-64 can only make direct calls to functions within 32 bits of
308 // the current PC. To call anything farther away, we have to load
309 // the address into a register and call through the register. The
310 // current JIT does this by allocating a stub for any far call.
311 // There was a bug in which the JIT tried to emit a direct call when
312 // the target was already in the JIT's global mappings and lazy
313 // compilation was disabled.
315 Function *KnownFunction = Function::Create(
316 TypeBuilder<int(int), false>::get(Context),
317 GlobalValue::ExternalLinkage, "known", M);
318 TheJIT->addGlobalMapping(KnownFunction, (void*)(intptr_t)PlusOne);
320 // int test() { return known(7); }
321 Function *TestFunction = Function::Create(
322 TypeBuilder<int(), false>::get(Context),
323 GlobalValue::ExternalLinkage, "test", M);
324 BasicBlock *Entry = BasicBlock::Create(Context, "entry", TestFunction);
325 IRBuilder<> Builder(Entry);
326 Value *result = Builder.CreateCall(
328 ConstantInt::get(TypeBuilder<int, false>::get(Context), 7));
329 Builder.CreateRet(result);
331 TheJIT->DisableLazyCompilation(true);
332 int (*TestFunctionPtr)() = reinterpret_cast<int(*)()>(
333 (intptr_t)TheJIT->getPointerToFunction(TestFunction));
334 // This used to crash in trying to call PlusOne().
335 EXPECT_EQ(8, TestFunctionPtr());
338 // Test a function C which calls A and B which call each other.
339 TEST_F(JITTest, NonLazyCompilationStillNeedsStubs) {
340 TheJIT->DisableLazyCompilation(true);
342 FunctionType *Func1Ty =
343 cast<FunctionType>(TypeBuilder<void(void), false>::get(Context));
344 std::vector<Type*> arg_types;
345 arg_types.push_back(Type::getInt1Ty(Context));
346 FunctionType *FuncTy = FunctionType::get(
347 Type::getVoidTy(Context), arg_types, false);
348 Function *Func1 = Function::Create(Func1Ty, Function::ExternalLinkage,
350 Function *Func2 = Function::Create(FuncTy, Function::InternalLinkage,
352 Function *Func3 = Function::Create(FuncTy, Function::InternalLinkage,
354 BasicBlock *Block1 = BasicBlock::Create(Context, "block1", Func1);
355 BasicBlock *Block2 = BasicBlock::Create(Context, "block2", Func2);
356 BasicBlock *True2 = BasicBlock::Create(Context, "cond_true", Func2);
357 BasicBlock *False2 = BasicBlock::Create(Context, "cond_false", Func2);
358 BasicBlock *Block3 = BasicBlock::Create(Context, "block3", Func3);
359 BasicBlock *True3 = BasicBlock::Create(Context, "cond_true", Func3);
360 BasicBlock *False3 = BasicBlock::Create(Context, "cond_false", Func3);
362 // Make Func1 call Func2(0) and Func3(0).
363 IRBuilder<> Builder(Block1);
364 Builder.CreateCall(Func2, ConstantInt::getTrue(Context));
365 Builder.CreateCall(Func3, ConstantInt::getTrue(Context));
366 Builder.CreateRetVoid();
368 // void Func2(bool b) { if (b) { Func3(false); return; } return; }
369 Builder.SetInsertPoint(Block2);
370 Builder.CreateCondBr(Func2->arg_begin(), True2, False2);
371 Builder.SetInsertPoint(True2);
372 Builder.CreateCall(Func3, ConstantInt::getFalse(Context));
373 Builder.CreateRetVoid();
374 Builder.SetInsertPoint(False2);
375 Builder.CreateRetVoid();
377 // void Func3(bool b) { if (b) { Func2(false); return; } return; }
378 Builder.SetInsertPoint(Block3);
379 Builder.CreateCondBr(Func3->arg_begin(), True3, False3);
380 Builder.SetInsertPoint(True3);
381 Builder.CreateCall(Func2, ConstantInt::getFalse(Context));
382 Builder.CreateRetVoid();
383 Builder.SetInsertPoint(False3);
384 Builder.CreateRetVoid();
386 // Compile the function to native code
388 reinterpret_cast<void(*)()>((intptr_t)TheJIT->getPointerToFunction(Func1));
393 // Regression test for PR5162. This used to trigger an AssertingVH inside the
394 // JIT's Function to stub mapping.
395 TEST_F(JITTest, NonLazyLeaksNoStubs) {
396 TheJIT->DisableLazyCompilation(true);
398 // Create two functions with a single basic block each.
399 FunctionType *FuncTy =
400 cast<FunctionType>(TypeBuilder<int(), false>::get(Context));
401 Function *Func1 = Function::Create(FuncTy, Function::ExternalLinkage,
403 Function *Func2 = Function::Create(FuncTy, Function::InternalLinkage,
405 BasicBlock *Block1 = BasicBlock::Create(Context, "block1", Func1);
406 BasicBlock *Block2 = BasicBlock::Create(Context, "block2", Func2);
408 // The first function calls the second and returns the result
409 IRBuilder<> Builder(Block1);
410 Value *Result = Builder.CreateCall(Func2);
411 Builder.CreateRet(Result);
413 // The second function just returns a constant
414 Builder.SetInsertPoint(Block2);
415 Builder.CreateRet(ConstantInt::get(TypeBuilder<int, false>::get(Context),42));
417 // Compile the function to native code
418 (void)TheJIT->getPointerToFunction(Func1);
420 // Free the JIT state for the functions
421 TheJIT->freeMachineCodeForFunction(Func1);
422 TheJIT->freeMachineCodeForFunction(Func2);
424 // Delete the first function (and show that is has no users)
425 EXPECT_EQ(Func1->getNumUses(), 0u);
426 Func1->eraseFromParent();
428 // Delete the second function (and show that it has no users - it had one,
429 // func1 but that's gone now)
430 EXPECT_EQ(Func2->getNumUses(), 0u);
431 Func2->eraseFromParent();
434 TEST_F(JITTest, ModuleDeletion) {
435 TheJIT->DisableLazyCompilation(false);
436 LoadAssembly("define void @main() { "
437 " call i32 @computeVal() "
441 "define internal i32 @computeVal() { "
444 Function *func = M->getFunction("main");
445 TheJIT->getPointerToFunction(func);
446 TheJIT->removeModule(M);
449 SmallPtrSet<const void*, 2> FunctionsDeallocated;
450 for (unsigned i = 0, e = RJMM->deallocateFunctionBodyCalls.size();
452 FunctionsDeallocated.insert(RJMM->deallocateFunctionBodyCalls[i].Body);
454 for (unsigned i = 0, e = RJMM->startFunctionBodyCalls.size(); i != e; ++i) {
455 EXPECT_TRUE(FunctionsDeallocated.count(
456 RJMM->startFunctionBodyCalls[i].Result))
457 << "Function leaked: \n" << RJMM->startFunctionBodyCalls[i].F_dump;
459 EXPECT_EQ(RJMM->startFunctionBodyCalls.size(),
460 RJMM->deallocateFunctionBodyCalls.size());
462 SmallPtrSet<const void*, 2> ExceptionTablesDeallocated;
463 unsigned NumTablesDeallocated = 0;
464 for (unsigned i = 0, e = RJMM->deallocateExceptionTableCalls.size();
466 ExceptionTablesDeallocated.insert(
467 RJMM->deallocateExceptionTableCalls[i].ET);
468 if (RJMM->deallocateExceptionTableCalls[i].ET != NULL) {
469 // If JITEmitDebugInfo is off, we'll "deallocate" NULL, which doesn't
470 // appear in startExceptionTableCalls.
471 NumTablesDeallocated++;
474 for (unsigned i = 0, e = RJMM->startExceptionTableCalls.size(); i != e; ++i) {
475 EXPECT_TRUE(ExceptionTablesDeallocated.count(
476 RJMM->startExceptionTableCalls[i].Result))
477 << "Function's exception table leaked: \n"
478 << RJMM->startExceptionTableCalls[i].F_dump;
480 EXPECT_EQ(RJMM->startExceptionTableCalls.size(),
481 NumTablesDeallocated);
483 #endif // !defined(__arm__) && !defined(__powerpc__)
485 // ARM, MIPS and PPC still emit stubs for calls since the target may be
486 // too far away to call directly. This #if can probably be removed when
487 // http://llvm.org/PR5201 is fixed.
488 #if !defined(__arm__) && !defined(__mips__) && \
489 !defined(__powerpc__) && !defined(__ppc__)
490 typedef int (*FooPtr) ();
492 TEST_F(JITTest, NoStubs) {
493 LoadAssembly("define void @bar() {"
498 "define i32 @foo() {"
504 "define i32 @main() {"
506 "%0 = call i32 @foo()"
510 Function *foo = M->getFunction("foo");
511 uintptr_t tmp = (uintptr_t)(TheJIT->getPointerToFunction(foo));
512 FooPtr ptr = (FooPtr)(tmp);
516 // We should now allocate no more stubs, we have the code to foo
517 // and the existing stub for bar.
518 int stubsBefore = RJMM->stubsAllocated;
519 Function *func = M->getFunction("main");
520 TheJIT->getPointerToFunction(func);
522 Function *bar = M->getFunction("bar");
523 TheJIT->getPointerToFunction(bar);
525 ASSERT_EQ(stubsBefore, RJMM->stubsAllocated);
527 #endif // !ARM && !PPC
529 // Tests on ARM and PowerPC disabled as we're running the old jit
530 #if !defined(__arm__) && !defined(__powerpc__)
532 TEST_F(JITTest, FunctionPointersOutliveTheirCreator) {
533 TheJIT->DisableLazyCompilation(true);
534 LoadAssembly("define i8()* @get_foo_addr() { "
538 "define i8 @foo() { "
541 Function *F_get_foo_addr = M->getFunction("get_foo_addr");
543 typedef char(*fooT)();
544 fooT (*get_foo_addr)() = reinterpret_cast<fooT(*)()>(
545 (intptr_t)TheJIT->getPointerToFunction(F_get_foo_addr));
546 fooT foo_addr = get_foo_addr();
548 // Now free get_foo_addr. This should not free the machine code for foo or
549 // any call stub returned as foo's canonical address.
550 TheJIT->freeMachineCodeForFunction(F_get_foo_addr);
552 // Check by calling the reported address of foo.
553 EXPECT_EQ(42, foo_addr());
555 // The reported address should also be the same as the result of a subsequent
556 // getPointerToFunction(foo).
558 // Fails until PR5126 is fixed:
559 Function *F_foo = M->getFunction("foo");
560 fooT foo = reinterpret_cast<fooT>(
561 (intptr_t)TheJIT->getPointerToFunction(F_foo));
562 EXPECT_EQ((intptr_t)foo, (intptr_t)foo_addr);
566 #endif //!defined(__arm__) && !defined(__powerpc__)
568 // Tests on ARM and PowerPC disabled as we're running the old jit
569 // In addition, ARM does not have an implementation
570 // of replaceMachineCodeForFunction(), so recompileAndRelinkFunction
572 #if !defined(__arm__) && !defined(__powerpc__)
573 TEST_F(JITTest, FunctionIsRecompiledAndRelinked) {
574 Function *F = Function::Create(TypeBuilder<int(void), false>::get(Context),
575 GlobalValue::ExternalLinkage, "test", M);
576 BasicBlock *Entry = BasicBlock::Create(Context, "entry", F);
577 IRBuilder<> Builder(Entry);
578 Value *Val = ConstantInt::get(TypeBuilder<int, false>::get(Context), 1);
579 Builder.CreateRet(Val);
581 TheJIT->DisableLazyCompilation(true);
582 // Compile the function once, and make sure it works.
583 int (*OrigFPtr)() = reinterpret_cast<int(*)()>(
584 (intptr_t)TheJIT->recompileAndRelinkFunction(F));
585 EXPECT_EQ(1, OrigFPtr());
587 // Now change the function to return a different value.
588 Entry->eraseFromParent();
589 BasicBlock *NewEntry = BasicBlock::Create(Context, "new_entry", F);
590 Builder.SetInsertPoint(NewEntry);
591 Val = ConstantInt::get(TypeBuilder<int, false>::get(Context), 2);
592 Builder.CreateRet(Val);
593 // Recompile it, which should produce a new function pointer _and_ update the
595 int (*NewFPtr)() = reinterpret_cast<int(*)()>(
596 (intptr_t)TheJIT->recompileAndRelinkFunction(F));
598 EXPECT_EQ(2, NewFPtr())
599 << "The new pointer should call the new version of the function";
600 EXPECT_EQ(2, OrigFPtr())
601 << "The old pointer's target should now jump to the new version";
603 #endif // !defined(__arm__) && !defined(__powerpc__)
605 } // anonymous namespace
606 // This variable is intentionally defined differently in the statically-compiled
607 // program from the IR input to the JIT to assert that the JIT doesn't use its
609 extern "C" int32_t JITTest_AvailableExternallyGlobal;
610 int32_t JITTest_AvailableExternallyGlobal LLVM_ATTRIBUTE_USED = 42;
613 // Tests on ARM and PowerPC disabled as we're running the old jit
614 #if !defined(__arm__) && !defined(__powerpc__)
616 TEST_F(JITTest, AvailableExternallyGlobalIsntEmitted) {
617 TheJIT->DisableLazyCompilation(true);
618 LoadAssembly("@JITTest_AvailableExternallyGlobal = "
619 " available_externally global i32 7 "
621 "define i32 @loader() { "
622 " %result = load i32* @JITTest_AvailableExternallyGlobal "
625 Function *loaderIR = M->getFunction("loader");
627 int32_t (*loader)() = reinterpret_cast<int32_t(*)()>(
628 (intptr_t)TheJIT->getPointerToFunction(loaderIR));
629 EXPECT_EQ(42, loader()) << "func should return 42 from the external global,"
630 << " not 7 from the IR version.";
632 #endif //!defined(__arm__) && !defined(__powerpc__)
633 } // anonymous namespace
634 // This function is intentionally defined differently in the statically-compiled
635 // program from the IR input to the JIT to assert that the JIT doesn't use its
637 extern "C" int32_t JITTest_AvailableExternallyFunction() LLVM_ATTRIBUTE_USED;
638 extern "C" int32_t JITTest_AvailableExternallyFunction() {
643 // ARM and PowerPC tests disabled pending fix for PR10783.
644 #if !defined(__arm__) && !defined(__powerpc__)
645 TEST_F(JITTest, AvailableExternallyFunctionIsntCompiled) {
646 TheJIT->DisableLazyCompilation(true);
647 LoadAssembly("define available_externally i32 "
648 " @JITTest_AvailableExternallyFunction() { "
652 "define i32 @func() { "
653 " %result = tail call i32 "
654 " @JITTest_AvailableExternallyFunction() "
657 Function *funcIR = M->getFunction("func");
659 int32_t (*func)() = reinterpret_cast<int32_t(*)()>(
660 (intptr_t)TheJIT->getPointerToFunction(funcIR));
661 EXPECT_EQ(42, func()) << "func should return 42 from the static version,"
662 << " not 7 from the IR version.";
665 TEST_F(JITTest, EscapedLazyStubStillCallable) {
666 TheJIT->DisableLazyCompilation(false);
667 LoadAssembly("define internal i32 @stubbed() { "
671 "define i32()* @get_stub() { "
672 " ret i32()* @stubbed "
674 typedef int32_t(*StubTy)();
676 // Call get_stub() to get the address of @stubbed without actually JITting it.
677 Function *get_stubIR = M->getFunction("get_stub");
678 StubTy (*get_stub)() = reinterpret_cast<StubTy(*)()>(
679 (intptr_t)TheJIT->getPointerToFunction(get_stubIR));
680 StubTy stubbed = get_stub();
681 // Now get_stubIR is the only reference to stubbed's stub.
682 get_stubIR->eraseFromParent();
683 // Now there are no references inside the JIT, but we've got a pointer outside
684 // it. The stub should be callable and return the right value.
685 EXPECT_EQ(42, stubbed());
688 // Converts the LLVM assembly to bitcode and returns it in a std::string. An
689 // empty string indicates an error.
690 std::string AssembleToBitcode(LLVMContext &Context, const char *Assembly) {
691 Module TempModule("TempModule", Context);
692 if (!LoadAssemblyInto(&TempModule, Assembly)) {
697 raw_string_ostream OS(Result);
698 WriteBitcodeToFile(&TempModule, OS);
703 // Returns a newly-created ExecutionEngine that reads the bitcode in 'Bitcode'
704 // lazily. The associated Module (owned by the ExecutionEngine) is returned in
705 // M. Both will be NULL on an error. Bitcode must live at least as long as the
707 ExecutionEngine *getJITFromBitcode(
708 LLVMContext &Context, const std::string &Bitcode, Module *&M) {
709 // c_str() is null-terminated like MemoryBuffer::getMemBuffer requires.
710 MemoryBuffer *BitcodeBuffer =
711 MemoryBuffer::getMemBuffer(Bitcode, "Bitcode for test");
713 M = getLazyBitcodeModule(BitcodeBuffer, Context, &errMsg);
715 ADD_FAILURE() << errMsg;
716 delete BitcodeBuffer;
719 ExecutionEngine *TheJIT = EngineBuilder(M)
720 .setEngineKind(EngineKind::JIT)
721 .setErrorStr(&errMsg)
723 if (TheJIT == NULL) {
724 ADD_FAILURE() << errMsg;
732 TEST(LazyLoadedJITTest, MaterializableAvailableExternallyFunctionIsntCompiled) {
734 const std::string Bitcode =
735 AssembleToBitcode(Context,
736 "define available_externally i32 "
737 " @JITTest_AvailableExternallyFunction() { "
741 "define i32 @func() { "
742 " %result = tail call i32 "
743 " @JITTest_AvailableExternallyFunction() "
746 ASSERT_FALSE(Bitcode.empty()) << "Assembling failed";
748 OwningPtr<ExecutionEngine> TheJIT(getJITFromBitcode(Context, Bitcode, M));
749 ASSERT_TRUE(TheJIT.get()) << "Failed to create JIT.";
750 TheJIT->DisableLazyCompilation(true);
752 Function *funcIR = M->getFunction("func");
753 Function *availableFunctionIR =
754 M->getFunction("JITTest_AvailableExternallyFunction");
756 // Double-check that the available_externally function is still unmaterialized
757 // when getPointerToFunction needs to find out if it's available_externally.
758 EXPECT_TRUE(availableFunctionIR->isMaterializable());
760 int32_t (*func)() = reinterpret_cast<int32_t(*)()>(
761 (intptr_t)TheJIT->getPointerToFunction(funcIR));
762 EXPECT_EQ(42, func()) << "func should return 42 from the static version,"
763 << " not 7 from the IR version.";
766 TEST(LazyLoadedJITTest, EagerCompiledRecursionThroughGhost) {
768 const std::string Bitcode =
769 AssembleToBitcode(Context,
770 "define i32 @recur1(i32 %a) { "
771 " %zero = icmp eq i32 %a, 0 "
772 " br i1 %zero, label %done, label %notdone "
776 " %am1 = sub i32 %a, 1 "
777 " %result = call i32 @recur2(i32 %am1) "
781 "define i32 @recur2(i32 %b) { "
782 " %result = call i32 @recur1(i32 %b) "
785 ASSERT_FALSE(Bitcode.empty()) << "Assembling failed";
787 OwningPtr<ExecutionEngine> TheJIT(getJITFromBitcode(Context, Bitcode, M));
788 ASSERT_TRUE(TheJIT.get()) << "Failed to create JIT.";
789 TheJIT->DisableLazyCompilation(true);
791 Function *recur1IR = M->getFunction("recur1");
792 Function *recur2IR = M->getFunction("recur2");
793 EXPECT_TRUE(recur1IR->isMaterializable());
794 EXPECT_TRUE(recur2IR->isMaterializable());
796 int32_t (*recur1)(int32_t) = reinterpret_cast<int32_t(*)(int32_t)>(
797 (intptr_t)TheJIT->getPointerToFunction(recur1IR));
798 EXPECT_EQ(3, recur1(4));
800 #endif // !defined(__arm__) && !defined(__powerpc__)
802 // This code is copied from JITEventListenerTest, but it only runs once for all
803 // the tests in this directory. Everything seems fine, but that's strange
805 class JITEnvironment : public testing::Environment {
806 virtual void SetUp() {
807 // Required to create a JIT.
808 InitializeNativeTarget();
811 testing::Environment* const jit_env =
812 testing::AddGlobalTestEnvironment(new JITEnvironment);