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/Bitcode/ReaderWriter.h"
16 #include "llvm/Constant.h"
17 #include "llvm/Constants.h"
18 #include "llvm/DerivedTypes.h"
19 #include "llvm/ExecutionEngine/JIT.h"
20 #include "llvm/ExecutionEngine/JITMemoryManager.h"
21 #include "llvm/Function.h"
22 #include "llvm/GlobalValue.h"
23 #include "llvm/GlobalVariable.h"
24 #include "llvm/LLVMContext.h"
25 #include "llvm/Module.h"
26 #include "llvm/ModuleProvider.h"
27 #include "llvm/Support/IRBuilder.h"
28 #include "llvm/Support/MemoryBuffer.h"
29 #include "llvm/Support/SourceMgr.h"
30 #include "llvm/Support/TypeBuilder.h"
31 #include "llvm/Target/TargetSelect.h"
32 #include "llvm/Type.h"
40 Function *makeReturnGlobal(std::string Name, GlobalVariable *G, Module *M) {
41 std::vector<const Type*> params;
42 const FunctionType *FTy = FunctionType::get(G->getType()->getElementType(),
44 Function *F = Function::Create(FTy, GlobalValue::ExternalLinkage, Name, M);
45 BasicBlock *Entry = BasicBlock::Create(M->getContext(), "entry", F);
46 IRBuilder<> builder(Entry);
47 Value *Load = builder.CreateLoad(G);
48 const Type *GTy = G->getType()->getElementType();
49 Value *Add = builder.CreateAdd(Load, ConstantInt::get(GTy, 1LL));
50 builder.CreateStore(Add, G);
51 builder.CreateRet(Add);
55 std::string DumpFunction(const Function *F) {
57 raw_string_ostream(Result) << "" << *F;
61 class RecordingJITMemoryManager : public JITMemoryManager {
62 const OwningPtr<JITMemoryManager> Base;
64 RecordingJITMemoryManager()
65 : Base(JITMemoryManager::CreateDefaultMemManager()) {
69 virtual void setMemoryWritable() { Base->setMemoryWritable(); }
70 virtual void setMemoryExecutable() { Base->setMemoryExecutable(); }
71 virtual void setPoisonMemory(bool poison) { Base->setPoisonMemory(poison); }
72 virtual void AllocateGOT() { Base->AllocateGOT(); }
73 virtual uint8_t *getGOTBase() const { return Base->getGOTBase(); }
74 struct StartFunctionBodyCall {
75 StartFunctionBodyCall(uint8_t *Result, const Function *F,
76 uintptr_t ActualSize, uintptr_t ActualSizeResult)
77 : Result(Result), F(F), F_dump(DumpFunction(F)),
78 ActualSize(ActualSize), ActualSizeResult(ActualSizeResult) {}
83 uintptr_t ActualSizeResult;
85 std::vector<StartFunctionBodyCall> startFunctionBodyCalls;
86 virtual uint8_t *startFunctionBody(const Function *F,
87 uintptr_t &ActualSize) {
88 uintptr_t InitialActualSize = ActualSize;
89 uint8_t *Result = Base->startFunctionBody(F, ActualSize);
90 startFunctionBodyCalls.push_back(
91 StartFunctionBodyCall(Result, F, InitialActualSize, ActualSize));
95 virtual uint8_t *allocateStub(const GlobalValue* F, unsigned StubSize,
98 return Base->allocateStub(F, StubSize, Alignment);
100 struct EndFunctionBodyCall {
101 EndFunctionBodyCall(const Function *F, uint8_t *FunctionStart,
102 uint8_t *FunctionEnd)
103 : F(F), F_dump(DumpFunction(F)),
104 FunctionStart(FunctionStart), FunctionEnd(FunctionEnd) {}
107 uint8_t *FunctionStart;
108 uint8_t *FunctionEnd;
110 std::vector<EndFunctionBodyCall> endFunctionBodyCalls;
111 virtual void endFunctionBody(const Function *F, uint8_t *FunctionStart,
112 uint8_t *FunctionEnd) {
113 endFunctionBodyCalls.push_back(
114 EndFunctionBodyCall(F, FunctionStart, FunctionEnd));
115 Base->endFunctionBody(F, FunctionStart, FunctionEnd);
117 virtual uint8_t *allocateSpace(intptr_t Size, unsigned Alignment) {
118 return Base->allocateSpace(Size, Alignment);
120 virtual uint8_t *allocateGlobal(uintptr_t Size, unsigned Alignment) {
121 return Base->allocateGlobal(Size, Alignment);
123 struct DeallocateFunctionBodyCall {
124 DeallocateFunctionBodyCall(const void *Body) : Body(Body) {}
127 std::vector<DeallocateFunctionBodyCall> deallocateFunctionBodyCalls;
128 virtual void deallocateFunctionBody(void *Body) {
129 deallocateFunctionBodyCalls.push_back(DeallocateFunctionBodyCall(Body));
130 Base->deallocateFunctionBody(Body);
132 struct DeallocateExceptionTableCall {
133 DeallocateExceptionTableCall(const void *ET) : ET(ET) {}
136 std::vector<DeallocateExceptionTableCall> deallocateExceptionTableCalls;
137 virtual void deallocateExceptionTable(void *ET) {
138 deallocateExceptionTableCalls.push_back(DeallocateExceptionTableCall(ET));
139 Base->deallocateExceptionTable(ET);
141 struct StartExceptionTableCall {
142 StartExceptionTableCall(uint8_t *Result, const Function *F,
143 uintptr_t ActualSize, uintptr_t ActualSizeResult)
144 : Result(Result), F(F), F_dump(DumpFunction(F)),
145 ActualSize(ActualSize), ActualSizeResult(ActualSizeResult) {}
149 uintptr_t ActualSize;
150 uintptr_t ActualSizeResult;
152 std::vector<StartExceptionTableCall> startExceptionTableCalls;
153 virtual uint8_t* startExceptionTable(const Function* F,
154 uintptr_t &ActualSize) {
155 uintptr_t InitialActualSize = ActualSize;
156 uint8_t *Result = Base->startExceptionTable(F, ActualSize);
157 startExceptionTableCalls.push_back(
158 StartExceptionTableCall(Result, F, InitialActualSize, ActualSize));
161 struct EndExceptionTableCall {
162 EndExceptionTableCall(const Function *F, uint8_t *TableStart,
163 uint8_t *TableEnd, uint8_t* FrameRegister)
164 : F(F), F_dump(DumpFunction(F)),
165 TableStart(TableStart), TableEnd(TableEnd),
166 FrameRegister(FrameRegister) {}
171 uint8_t *FrameRegister;
173 std::vector<EndExceptionTableCall> endExceptionTableCalls;
174 virtual void endExceptionTable(const Function *F, uint8_t *TableStart,
175 uint8_t *TableEnd, uint8_t* FrameRegister) {
176 endExceptionTableCalls.push_back(
177 EndExceptionTableCall(F, TableStart, TableEnd, FrameRegister));
178 return Base->endExceptionTable(F, TableStart, TableEnd, FrameRegister);
182 bool LoadAssemblyInto(Module *M, const char *assembly) {
185 NULL != ParseAssemblyString(assembly, M, Error, M->getContext());
187 raw_string_ostream os(errMsg);
189 EXPECT_TRUE(success) << os.str();
193 class JITTest : public testing::Test {
195 virtual void SetUp() {
196 M = new Module("<main>", Context);
197 MP = new ExistingModuleProvider(M);
198 RJMM = new RecordingJITMemoryManager;
199 RJMM->setPoisonMemory(true);
201 TheJIT.reset(EngineBuilder(MP).setEngineKind(EngineKind::JIT)
202 .setJITMemoryManager(RJMM)
203 .setErrorStr(&Error).create());
204 ASSERT_TRUE(TheJIT.get() != NULL) << Error;
207 void LoadAssembly(const char *assembly) {
208 LoadAssemblyInto(M, assembly);
212 Module *M; // Owned by MP.
213 ModuleProvider *MP; // Owned by ExecutionEngine.
214 RecordingJITMemoryManager *RJMM;
215 OwningPtr<ExecutionEngine> TheJIT;
218 // Regression test for a bug. The JIT used to allocate globals inside the same
219 // memory block used for the function, and when the function code was freed,
220 // the global was left in the same place. This test allocates a function
221 // that uses and global, deallocates it, and then makes sure that the global
222 // stays alive after that.
223 TEST(JIT, GlobalInFunction) {
225 Module *M = new Module("<main>", context);
226 ExistingModuleProvider *MP = new ExistingModuleProvider(M);
228 JITMemoryManager *MemMgr = JITMemoryManager::CreateDefaultMemManager();
229 // Tell the memory manager to poison freed memory so that accessing freed
230 // memory is more easily tested.
231 MemMgr->setPoisonMemory(true);
233 OwningPtr<ExecutionEngine> JIT(EngineBuilder(MP)
234 .setEngineKind(EngineKind::JIT)
236 .setJITMemoryManager(MemMgr)
237 // The next line enables the fix:
238 .setAllocateGVsWithCode(false)
240 ASSERT_EQ(Error, "");
242 // Create a global variable.
243 const Type *GTy = Type::getInt32Ty(context);
244 GlobalVariable *G = new GlobalVariable(
247 false, // Not constant.
248 GlobalValue::InternalLinkage,
249 Constant::getNullValue(GTy),
252 // Make a function that points to a global.
253 Function *F1 = makeReturnGlobal("F1", G, M);
255 // Get the pointer to the native code to force it to JIT the function and
256 // allocate space for the global.
258 reinterpret_cast<void(*)()>((intptr_t)JIT->getPointerToFunction(F1));
260 // Since F1 was codegen'd, a pointer to G should be available.
261 int32_t *GPtr = (int32_t*)JIT->getPointerToGlobalIfAvailable(G);
262 ASSERT_NE((int32_t*)NULL, GPtr);
265 // F1() should increment G.
269 // Make a second function identical to the first, referring to the same
271 Function *F2 = makeReturnGlobal("F2", G, M);
273 reinterpret_cast<void(*)()>((intptr_t)JIT->getPointerToFunction(F2));
275 // F2() should increment G.
280 JIT->freeMachineCodeForFunction(F1);
282 // F2() should *still* increment G.
287 int PlusOne(int arg) {
291 TEST_F(JITTest, FarCallToKnownFunction) {
292 // x86-64 can only make direct calls to functions within 32 bits of
293 // the current PC. To call anything farther away, we have to load
294 // the address into a register and call through the register. The
295 // current JIT does this by allocating a stub for any far call.
296 // There was a bug in which the JIT tried to emit a direct call when
297 // the target was already in the JIT's global mappings and lazy
298 // compilation was disabled.
300 Function *KnownFunction = Function::Create(
301 TypeBuilder<int(int), false>::get(Context),
302 GlobalValue::ExternalLinkage, "known", M);
303 TheJIT->addGlobalMapping(KnownFunction, (void*)(intptr_t)PlusOne);
305 // int test() { return known(7); }
306 Function *TestFunction = Function::Create(
307 TypeBuilder<int(), false>::get(Context),
308 GlobalValue::ExternalLinkage, "test", M);
309 BasicBlock *Entry = BasicBlock::Create(Context, "entry", TestFunction);
310 IRBuilder<> Builder(Entry);
311 Value *result = Builder.CreateCall(
313 ConstantInt::get(TypeBuilder<int, false>::get(Context), 7));
314 Builder.CreateRet(result);
316 TheJIT->DisableLazyCompilation(true);
317 int (*TestFunctionPtr)() = reinterpret_cast<int(*)()>(
318 (intptr_t)TheJIT->getPointerToFunction(TestFunction));
319 // This used to crash in trying to call PlusOne().
320 EXPECT_EQ(8, TestFunctionPtr());
323 // Test a function C which calls A and B which call each other.
324 TEST_F(JITTest, NonLazyCompilationStillNeedsStubs) {
325 TheJIT->DisableLazyCompilation(true);
327 const FunctionType *Func1Ty =
328 cast<FunctionType>(TypeBuilder<void(void), false>::get(Context));
329 std::vector<const Type*> arg_types;
330 arg_types.push_back(Type::getInt1Ty(Context));
331 const FunctionType *FuncTy = FunctionType::get(
332 Type::getVoidTy(Context), arg_types, false);
333 Function *Func1 = Function::Create(Func1Ty, Function::ExternalLinkage,
335 Function *Func2 = Function::Create(FuncTy, Function::InternalLinkage,
337 Function *Func3 = Function::Create(FuncTy, Function::InternalLinkage,
339 BasicBlock *Block1 = BasicBlock::Create(Context, "block1", Func1);
340 BasicBlock *Block2 = BasicBlock::Create(Context, "block2", Func2);
341 BasicBlock *True2 = BasicBlock::Create(Context, "cond_true", Func2);
342 BasicBlock *False2 = BasicBlock::Create(Context, "cond_false", Func2);
343 BasicBlock *Block3 = BasicBlock::Create(Context, "block3", Func3);
344 BasicBlock *True3 = BasicBlock::Create(Context, "cond_true", Func3);
345 BasicBlock *False3 = BasicBlock::Create(Context, "cond_false", Func3);
347 // Make Func1 call Func2(0) and Func3(0).
348 IRBuilder<> Builder(Block1);
349 Builder.CreateCall(Func2, ConstantInt::getTrue(Context));
350 Builder.CreateCall(Func3, ConstantInt::getTrue(Context));
351 Builder.CreateRetVoid();
353 // void Func2(bool b) { if (b) { Func3(false); return; } return; }
354 Builder.SetInsertPoint(Block2);
355 Builder.CreateCondBr(Func2->arg_begin(), True2, False2);
356 Builder.SetInsertPoint(True2);
357 Builder.CreateCall(Func3, ConstantInt::getFalse(Context));
358 Builder.CreateRetVoid();
359 Builder.SetInsertPoint(False2);
360 Builder.CreateRetVoid();
362 // void Func3(bool b) { if (b) { Func2(false); return; } return; }
363 Builder.SetInsertPoint(Block3);
364 Builder.CreateCondBr(Func3->arg_begin(), True3, False3);
365 Builder.SetInsertPoint(True3);
366 Builder.CreateCall(Func2, ConstantInt::getFalse(Context));
367 Builder.CreateRetVoid();
368 Builder.SetInsertPoint(False3);
369 Builder.CreateRetVoid();
371 // Compile the function to native code
373 reinterpret_cast<void(*)()>((intptr_t)TheJIT->getPointerToFunction(Func1));
378 // Regression test for PR5162. This used to trigger an AssertingVH inside the
379 // JIT's Function to stub mapping.
380 TEST_F(JITTest, NonLazyLeaksNoStubs) {
381 TheJIT->DisableLazyCompilation(true);
383 // Create two functions with a single basic block each.
384 const FunctionType *FuncTy =
385 cast<FunctionType>(TypeBuilder<int(), false>::get(Context));
386 Function *Func1 = Function::Create(FuncTy, Function::ExternalLinkage,
388 Function *Func2 = Function::Create(FuncTy, Function::InternalLinkage,
390 BasicBlock *Block1 = BasicBlock::Create(Context, "block1", Func1);
391 BasicBlock *Block2 = BasicBlock::Create(Context, "block2", Func2);
393 // The first function calls the second and returns the result
394 IRBuilder<> Builder(Block1);
395 Value *Result = Builder.CreateCall(Func2);
396 Builder.CreateRet(Result);
398 // The second function just returns a constant
399 Builder.SetInsertPoint(Block2);
400 Builder.CreateRet(ConstantInt::get(TypeBuilder<int, false>::get(Context),42));
402 // Compile the function to native code
403 (void)TheJIT->getPointerToFunction(Func1);
405 // Free the JIT state for the functions
406 TheJIT->freeMachineCodeForFunction(Func1);
407 TheJIT->freeMachineCodeForFunction(Func2);
409 // Delete the first function (and show that is has no users)
410 EXPECT_EQ(Func1->getNumUses(), 0u);
411 Func1->eraseFromParent();
413 // Delete the second function (and show that it has no users - it had one,
414 // func1 but that's gone now)
415 EXPECT_EQ(Func2->getNumUses(), 0u);
416 Func2->eraseFromParent();
419 TEST_F(JITTest, ModuleDeletion) {
420 TheJIT->DisableLazyCompilation(false);
421 LoadAssembly("define void @main() { "
422 " call i32 @computeVal() "
426 "define internal i32 @computeVal() { "
429 Function *func = M->getFunction("main");
430 TheJIT->getPointerToFunction(func);
431 TheJIT->deleteModuleProvider(MP);
433 SmallPtrSet<const void*, 2> FunctionsDeallocated;
434 for (unsigned i = 0, e = RJMM->deallocateFunctionBodyCalls.size();
436 FunctionsDeallocated.insert(RJMM->deallocateFunctionBodyCalls[i].Body);
438 for (unsigned i = 0, e = RJMM->startFunctionBodyCalls.size(); i != e; ++i) {
439 EXPECT_TRUE(FunctionsDeallocated.count(
440 RJMM->startFunctionBodyCalls[i].Result))
441 << "Function leaked: \n" << RJMM->startFunctionBodyCalls[i].F_dump;
443 EXPECT_EQ(RJMM->startFunctionBodyCalls.size(),
444 RJMM->deallocateFunctionBodyCalls.size());
446 SmallPtrSet<const void*, 2> ExceptionTablesDeallocated;
447 unsigned NumTablesDeallocated = 0;
448 for (unsigned i = 0, e = RJMM->deallocateExceptionTableCalls.size();
450 ExceptionTablesDeallocated.insert(
451 RJMM->deallocateExceptionTableCalls[i].ET);
452 if (RJMM->deallocateExceptionTableCalls[i].ET != NULL) {
453 // If JITEmitDebugInfo is off, we'll "deallocate" NULL, which doesn't
454 // appear in startExceptionTableCalls.
455 NumTablesDeallocated++;
458 for (unsigned i = 0, e = RJMM->startExceptionTableCalls.size(); i != e; ++i) {
459 EXPECT_TRUE(ExceptionTablesDeallocated.count(
460 RJMM->startExceptionTableCalls[i].Result))
461 << "Function's exception table leaked: \n"
462 << RJMM->startExceptionTableCalls[i].F_dump;
464 EXPECT_EQ(RJMM->startExceptionTableCalls.size(),
465 NumTablesDeallocated);
468 // ARM and PPC still emit stubs for calls since the target may be too far away
469 // to call directly. This #if can probably be removed when
470 // http://llvm.org/PR5201 is fixed.
471 #if !defined(__arm__) && !defined(__powerpc__) && !defined(__ppc__)
472 typedef int (*FooPtr) ();
474 TEST_F(JITTest, NoStubs) {
475 LoadAssembly("define void @bar() {"
480 "define i32 @foo() {"
486 "define i32 @main() {"
488 "%0 = call i32 @foo()"
492 Function *foo = M->getFunction("foo");
493 uintptr_t tmp = (uintptr_t)(TheJIT->getPointerToFunction(foo));
494 FooPtr ptr = (FooPtr)(tmp);
498 // We should now allocate no more stubs, we have the code to foo
499 // and the existing stub for bar.
500 int stubsBefore = RJMM->stubsAllocated;
501 Function *func = M->getFunction("main");
502 TheJIT->getPointerToFunction(func);
504 Function *bar = M->getFunction("bar");
505 TheJIT->getPointerToFunction(bar);
507 ASSERT_EQ(stubsBefore, RJMM->stubsAllocated);
509 #endif // !ARM && !PPC
511 TEST_F(JITTest, FunctionPointersOutliveTheirCreator) {
512 TheJIT->DisableLazyCompilation(true);
513 LoadAssembly("define i8()* @get_foo_addr() { "
517 "define i8 @foo() { "
520 Function *F_get_foo_addr = M->getFunction("get_foo_addr");
522 typedef char(*fooT)();
523 fooT (*get_foo_addr)() = reinterpret_cast<fooT(*)()>(
524 (intptr_t)TheJIT->getPointerToFunction(F_get_foo_addr));
525 fooT foo_addr = get_foo_addr();
527 // Now free get_foo_addr. This should not free the machine code for foo or
528 // any call stub returned as foo's canonical address.
529 TheJIT->freeMachineCodeForFunction(F_get_foo_addr);
531 // Check by calling the reported address of foo.
532 EXPECT_EQ(42, foo_addr());
534 // The reported address should also be the same as the result of a subsequent
535 // getPointerToFunction(foo).
537 // Fails until PR5126 is fixed:
538 Function *F_foo = M->getFunction("foo");
539 fooT foo = reinterpret_cast<fooT>(
540 (intptr_t)TheJIT->getPointerToFunction(F_foo));
541 EXPECT_EQ((intptr_t)foo, (intptr_t)foo_addr);
545 // ARM doesn't have an implementation of replaceMachineCodeForFunction(), so
546 // recompileAndRelinkFunction doesn't work.
547 #if !defined(__arm__)
548 TEST_F(JITTest, FunctionIsRecompiledAndRelinked) {
549 Function *F = Function::Create(TypeBuilder<int(void), false>::get(Context),
550 GlobalValue::ExternalLinkage, "test", M);
551 BasicBlock *Entry = BasicBlock::Create(Context, "entry", F);
552 IRBuilder<> Builder(Entry);
553 Value *Val = ConstantInt::get(TypeBuilder<int, false>::get(Context), 1);
554 Builder.CreateRet(Val);
556 TheJIT->DisableLazyCompilation(true);
557 // Compile the function once, and make sure it works.
558 int (*OrigFPtr)() = reinterpret_cast<int(*)()>(
559 (intptr_t)TheJIT->recompileAndRelinkFunction(F));
560 EXPECT_EQ(1, OrigFPtr());
562 // Now change the function to return a different value.
563 Entry->eraseFromParent();
564 BasicBlock *NewEntry = BasicBlock::Create(Context, "new_entry", F);
565 Builder.SetInsertPoint(NewEntry);
566 Val = ConstantInt::get(TypeBuilder<int, false>::get(Context), 2);
567 Builder.CreateRet(Val);
568 // Recompile it, which should produce a new function pointer _and_ update the
570 int (*NewFPtr)() = reinterpret_cast<int(*)()>(
571 (intptr_t)TheJIT->recompileAndRelinkFunction(F));
573 EXPECT_EQ(2, NewFPtr())
574 << "The new pointer should call the new version of the function";
575 EXPECT_EQ(2, OrigFPtr())
576 << "The old pointer's target should now jump to the new version";
578 #endif // !defined(__arm__)
580 } // anonymous namespace
581 // This variable is intentionally defined differently in the statically-compiled
582 // program from the IR input to the JIT to assert that the JIT doesn't use its
584 extern "C" int32_t JITTest_AvailableExternallyGlobal;
585 int32_t JITTest_AvailableExternallyGlobal = 42;
588 TEST_F(JITTest, AvailableExternallyGlobalIsntEmitted) {
589 TheJIT->DisableLazyCompilation(true);
590 LoadAssembly("@JITTest_AvailableExternallyGlobal = "
591 " available_externally global i32 7 "
593 "define i32 @loader() { "
594 " %result = load i32* @JITTest_AvailableExternallyGlobal "
597 Function *loaderIR = M->getFunction("loader");
599 int32_t (*loader)() = reinterpret_cast<int32_t(*)()>(
600 (intptr_t)TheJIT->getPointerToFunction(loaderIR));
601 EXPECT_EQ(42, loader()) << "func should return 42 from the external global,"
602 << " not 7 from the IR version.";
605 } // anonymous namespace
606 // This function 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_AvailableExternallyFunction() {
614 TEST_F(JITTest, AvailableExternallyFunctionIsntCompiled) {
615 TheJIT->DisableLazyCompilation(true);
616 LoadAssembly("define available_externally i32 "
617 " @JITTest_AvailableExternallyFunction() { "
621 "define i32 @func() { "
622 " %result = tail call i32 "
623 " @JITTest_AvailableExternallyFunction() "
626 Function *funcIR = M->getFunction("func");
628 int32_t (*func)() = reinterpret_cast<int32_t(*)()>(
629 (intptr_t)TheJIT->getPointerToFunction(funcIR));
630 EXPECT_EQ(42, func()) << "func should return 42 from the static version,"
631 << " not 7 from the IR version.";
634 // Converts the LLVM assembly to bitcode and returns it in a std::string. An
635 // empty string indicates an error.
636 std::string AssembleToBitcode(LLVMContext &Context, const char *Assembly) {
637 Module TempModule("TempModule", Context);
638 if (!LoadAssemblyInto(&TempModule, Assembly)) {
643 raw_string_ostream OS(Result);
644 WriteBitcodeToFile(&TempModule, OS);
649 // Returns a newly-created ExecutionEngine that reads the bitcode in 'Bitcode'
650 // lazily. The associated ModuleProvider (owned by the ExecutionEngine) is
651 // returned in MP. Both will be NULL on an error. Bitcode must live at least
652 // as long as the ExecutionEngine.
653 ExecutionEngine *getJITFromBitcode(
654 LLVMContext &Context, const std::string &Bitcode, ModuleProvider *&MP) {
655 // c_str() is null-terminated like MemoryBuffer::getMemBuffer requires.
656 MemoryBuffer *BitcodeBuffer =
657 MemoryBuffer::getMemBuffer(Bitcode.c_str(),
658 Bitcode.c_str() + Bitcode.size(),
661 MP = getBitcodeModuleProvider(BitcodeBuffer, Context, &errMsg);
663 ADD_FAILURE() << errMsg;
664 delete BitcodeBuffer;
667 ExecutionEngine *TheJIT = EngineBuilder(MP)
668 .setEngineKind(EngineKind::JIT)
669 .setErrorStr(&errMsg)
671 if (TheJIT == NULL) {
672 ADD_FAILURE() << errMsg;
680 TEST(LazyLoadedJITTest, EagerCompiledRecursionThroughGhost) {
682 const std::string Bitcode =
683 AssembleToBitcode(Context,
684 "define i32 @recur1(i32 %a) { "
685 " %zero = icmp eq i32 %a, 0 "
686 " br i1 %zero, label %done, label %notdone "
690 " %am1 = sub i32 %a, 1 "
691 " %result = call i32 @recur2(i32 %am1) "
695 "define i32 @recur2(i32 %b) { "
696 " %result = call i32 @recur1(i32 %b) "
699 ASSERT_FALSE(Bitcode.empty()) << "Assembling failed";
701 OwningPtr<ExecutionEngine> TheJIT(getJITFromBitcode(Context, Bitcode, MP));
702 ASSERT_TRUE(TheJIT.get()) << "Failed to create JIT.";
703 TheJIT->DisableLazyCompilation(true);
705 Module *M = MP->getModule();
706 Function *recur1IR = M->getFunction("recur1");
707 Function *recur2IR = M->getFunction("recur2");
708 EXPECT_TRUE(recur1IR->hasNotBeenReadFromBitcode());
709 EXPECT_TRUE(recur2IR->hasNotBeenReadFromBitcode());
711 int32_t (*recur1)(int32_t) = reinterpret_cast<int32_t(*)(int32_t)>(
712 (intptr_t)TheJIT->getPointerToFunction(recur1IR));
713 EXPECT_EQ(3, recur1(4));
716 // This code is copied from JITEventListenerTest, but it only runs once for all
717 // the tests in this directory. Everything seems fine, but that's strange
719 class JITEnvironment : public testing::Environment {
720 virtual void SetUp() {
721 // Required to create a JIT.
722 InitializeNativeTarget();
725 testing::Environment* const jit_env =
726 testing::AddGlobalTestEnvironment(new JITEnvironment);