unittests/ExecutionEngine/JIT/JITTest.cpp

   1 //===- JITTest.cpp - Unit tests for the JIT -------------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #include "llvm/ExecutionEngine/JIT.h"
  11 #include "llvm/ADT/SmallPtrSet.h"
  12 #include "llvm/AsmParser/Parser.h"
  13 #include "llvm/Bitcode/ReaderWriter.h"
  14 #include "llvm/ExecutionEngine/JITMemoryManager.h"
  15 #include "llvm/IR/BasicBlock.h"
  16 #include "llvm/IR/Constant.h"
  17 #include "llvm/IR/Constants.h"
  18 #include "llvm/IR/DerivedTypes.h"
  19 #include "llvm/IR/Function.h"
  20 #include "llvm/IR/GlobalValue.h"
  21 #include "llvm/IR/GlobalVariable.h"
  22 #include "llvm/IR/IRBuilder.h"
  23 #include "llvm/IR/LLVMContext.h"
  24 #include "llvm/IR/Module.h"
  25 #include "llvm/IR/Type.h"
  26 #include "llvm/IR/TypeBuilder.h"
  27 #include "llvm/Support/MemoryBuffer.h"
  28 #include "llvm/Support/SourceMgr.h"
  29 #include "llvm/Support/TargetSelect.h"
  30 #include "gtest/gtest.h"
  31 #include <vector>
  32
  33 using namespace llvm;
  34
  35 // This variable is intentionally defined differently in the statically-compiled
  36 // program from the IR input to the JIT to assert that the JIT doesn't use its
  37 // definition.  Note that this variable must be defined even on platforms where
  38 // JIT tests are disabled as it is referenced from the .def file.
  39 extern "C" int32_t JITTest_AvailableExternallyGlobal;
  40 int32_t JITTest_AvailableExternallyGlobal LLVM_ATTRIBUTE_USED = 42;
  41
  42 // This function is intentionally defined differently in the statically-compiled
  43 // program from the IR input to the JIT to assert that the JIT doesn't use its
  44 // definition.  Note that this function must be defined even on platforms where
  45 // JIT tests are disabled as it is referenced from the .def file.
  46 extern "C" int32_t JITTest_AvailableExternallyFunction() LLVM_ATTRIBUTE_USED;
  47 extern "C" int32_t JITTest_AvailableExternallyFunction() {
  48   return 42;
  49 }
  50
  51 namespace {
  52
  53 // Tests on ARM, PowerPC and SystemZ disabled as we're running the old jit
  54 #if !defined(__arm__) && !defined(__powerpc__) && !defined(__s390__) \
  55                       && !defined(__aarch64__)
  56
  57 Function *makeReturnGlobal(std::string Name, GlobalVariable *G, Module *M) {
  58   std::vector<Type*> params;
  59   FunctionType *FTy = FunctionType::get(G->getType()->getElementType(),
  60                                               params, false);
  61   Function *F = Function::Create(FTy, GlobalValue::ExternalLinkage, Name, M);
  62   BasicBlock *Entry = BasicBlock::Create(M->getContext(), "entry", F);
  63   IRBuilder<> builder(Entry);
  64   Value *Load = builder.CreateLoad(G);
  65   Type *GTy = G->getType()->getElementType();
  66   Value *Add = builder.CreateAdd(Load, ConstantInt::get(GTy, 1LL));
  67   builder.CreateStore(Add, G);
  68   builder.CreateRet(Add);
  69   return F;
  70 }
  71
  72 std::string DumpFunction(const Function *F) {
  73   string_ostream Result;
  74   Result << "" << *F;
  75   return Result.str();
  76 }
  77
  78 class RecordingJITMemoryManager : public JITMemoryManager {
  79   const std::unique_ptr<JITMemoryManager> Base;
  80
  81 public:
  82   RecordingJITMemoryManager()
  83     : Base(JITMemoryManager::CreateDefaultMemManager()) {
  84     stubsAllocated = 0;
  85   }
  86   virtual void *getPointerToNamedFunction(const std::string &Name,
  87                                           bool AbortOnFailure = true) {
  88     return Base->getPointerToNamedFunction(Name, AbortOnFailure);
  89   }
  90
  91   virtual void setMemoryWritable() { Base->setMemoryWritable(); }
  92   virtual void setMemoryExecutable() { Base->setMemoryExecutable(); }
  93   virtual void setPoisonMemory(bool poison) { Base->setPoisonMemory(poison); }
  94   virtual void AllocateGOT() { Base->AllocateGOT(); }
  95   virtual uint8_t *getGOTBase() const { return Base->getGOTBase(); }
  96   struct StartFunctionBodyCall {
  97     StartFunctionBodyCall(uint8_t *Result, const Function *F,
  98                           uintptr_t ActualSize, uintptr_t ActualSizeResult)
  99       : Result(Result), F(F), F_dump(DumpFunction(F)),
 100         ActualSize(ActualSize), ActualSizeResult(ActualSizeResult) {}
 101     uint8_t *Result;
 102     const Function *F;
 103     std::string F_dump;
 104     uintptr_t ActualSize;
 105     uintptr_t ActualSizeResult;
 106   };
 107   std::vector<StartFunctionBodyCall> startFunctionBodyCalls;
 108   virtual uint8_t *startFunctionBody(const Function *F,
 109                                      uintptr_t &ActualSize) {
 110     uintptr_t InitialActualSize = ActualSize;
 111     uint8_t *Result = Base->startFunctionBody(F, ActualSize);
 112     startFunctionBodyCalls.push_back(
 113       StartFunctionBodyCall(Result, F, InitialActualSize, ActualSize));
 114     return Result;
 115   }
 116   int stubsAllocated;
 117   uint8_t *allocateStub(const GlobalValue *F, unsigned StubSize,
 118                         unsigned Alignment) override {
 119     stubsAllocated++;
 120     return Base->allocateStub(F, StubSize, Alignment);
 121   }
 122   struct EndFunctionBodyCall {
 123     EndFunctionBodyCall(const Function *F, uint8_t *FunctionStart,
 124                         uint8_t *FunctionEnd)
 125       : F(F), F_dump(DumpFunction(F)),
 126         FunctionStart(FunctionStart), FunctionEnd(FunctionEnd) {}
 127     const Function *F;
 128     std::string F_dump;
 129     uint8_t *FunctionStart;
 130     uint8_t *FunctionEnd;
 131   };
 132   std::vector<EndFunctionBodyCall> endFunctionBodyCalls;
 133   virtual void endFunctionBody(const Function *F, uint8_t *FunctionStart,
 134                                uint8_t *FunctionEnd) {
 135     endFunctionBodyCalls.push_back(
 136       EndFunctionBodyCall(F, FunctionStart, FunctionEnd));
 137     Base->endFunctionBody(F, FunctionStart, FunctionEnd);
 138   }
 139   virtual uint8_t *allocateDataSection(
 140     uintptr_t Size, unsigned Alignment, unsigned SectionID,
 141     StringRef SectionName, bool IsReadOnly) {
 142     return Base->allocateDataSection(
 143       Size, Alignment, SectionID, SectionName, IsReadOnly);
 144   }
 145   virtual uint8_t *allocateCodeSection(
 146     uintptr_t Size, unsigned Alignment, unsigned SectionID,
 147     StringRef SectionName) {
 148     return Base->allocateCodeSection(
 149       Size, Alignment, SectionID, SectionName);
 150   }
 151   virtual bool finalizeMemory(std::string *ErrMsg) { return false; }
 152   virtual uint8_t *allocateSpace(intptr_t Size, unsigned Alignment) {
 153     return Base->allocateSpace(Size, Alignment);
 154   }
 155   virtual uint8_t *allocateGlobal(uintptr_t Size, unsigned Alignment) {
 156     return Base->allocateGlobal(Size, Alignment);
 157   }
 158   struct DeallocateFunctionBodyCall {
 159     DeallocateFunctionBodyCall(const void *Body) : Body(Body) {}
 160     const void *Body;
 161   };
 162   std::vector<DeallocateFunctionBodyCall> deallocateFunctionBodyCalls;
 163   virtual void deallocateFunctionBody(void *Body) {
 164     deallocateFunctionBodyCalls.push_back(DeallocateFunctionBodyCall(Body));
 165     Base->deallocateFunctionBody(Body);
 166   }
 167 };
 168
 169 bool LoadAssemblyInto(Module *M, const char *assembly) {
 170   SMDiagnostic Error;
 171   bool success =
 172     nullptr != ParseAssemblyString(assembly, M, Error, M->getContext());
 173   string_ostream errMsg;
 174   Error.print("", errMsg);
 175   EXPECT_TRUE(success) << errMsg.str();
 176   return success;
 177 }
 178
 179 class JITTest : public testing::Test {
 180  protected:
 181   virtual RecordingJITMemoryManager *createMemoryManager() {
 182     return new RecordingJITMemoryManager;
 183   }
 184
 185   virtual void SetUp() {
 186     M = new Module("<main>", Context);
 187     RJMM = createMemoryManager();
 188     RJMM->setPoisonMemory(true);
 189     std::string Error;
 190     TargetOptions Options;
 191     TheJIT.reset(EngineBuilder(M).setEngineKind(EngineKind::JIT)
 192                  .setJITMemoryManager(RJMM)
 193                  .setErrorStr(&Error)
 194                  .setTargetOptions(Options).create());
 195     ASSERT_TRUE(TheJIT.get() != nullptr) << Error;
 196   }
 197
 198   void LoadAssembly(const char *assembly) {
 199     LoadAssemblyInto(M, assembly);
 200   }
 201
 202   LLVMContext Context;
 203   Module *M;  // Owned by ExecutionEngine.
 204   RecordingJITMemoryManager *RJMM;
 205   std::unique_ptr<ExecutionEngine> TheJIT;
 206 };
 207
 208 // Regression test for a bug.  The JIT used to allocate globals inside the same
 209 // memory block used for the function, and when the function code was freed,
 210 // the global was left in the same place.  This test allocates a function
 211 // that uses and global, deallocates it, and then makes sure that the global
 212 // stays alive after that.
 213 TEST(JIT, GlobalInFunction) {
 214   LLVMContext context;
 215   Module *M = new Module("<main>", context);
 216
 217   JITMemoryManager *MemMgr = JITMemoryManager::CreateDefaultMemManager();
 218   // Tell the memory manager to poison freed memory so that accessing freed
 219   // memory is more easily tested.
 220   MemMgr->setPoisonMemory(true);
 221   std::string Error;
 222   std::unique_ptr<ExecutionEngine> JIT(EngineBuilder(M)
 223                                            .setEngineKind(EngineKind::JIT)
 224                                            .setErrorStr(&Error)
 225                                            .setJITMemoryManager(MemMgr)
 226                                            // The next line enables the fix:
 227                                            .setAllocateGVsWithCode(false)
 228                                            .create());
 229   ASSERT_EQ(Error, "");
 230
 231   // Create a global variable.
 232   Type *GTy = Type::getInt32Ty(context);
 233   GlobalVariable *G = new GlobalVariable(
 234       *M,
 235       GTy,
 236       false,  // Not constant.
 237       GlobalValue::InternalLinkage,
 238       Constant::getNullValue(GTy),
 239       "myglobal");
 240
 241   // Make a function that points to a global.
 242   Function *F1 = makeReturnGlobal("F1", G, M);
 243
 244   // Get the pointer to the native code to force it to JIT the function and
 245   // allocate space for the global.
 246   void (*F1Ptr)() =
 247       reinterpret_cast<void(*)()>((intptr_t)JIT->getPointerToFunction(F1));
 248
 249   // Since F1 was codegen'd, a pointer to G should be available.
 250   int32_t *GPtr = (int32_t*)JIT->getPointerToGlobalIfAvailable(G);
 251   ASSERT_NE((int32_t*)nullptr, GPtr);
 252   EXPECT_EQ(0, *GPtr);
 253
 254   // F1() should increment G.
 255   F1Ptr();
 256   EXPECT_EQ(1, *GPtr);
 257
 258   // Make a second function identical to the first, referring to the same
 259   // global.
 260   Function *F2 = makeReturnGlobal("F2", G, M);
 261   void (*F2Ptr)() =
 262       reinterpret_cast<void(*)()>((intptr_t)JIT->getPointerToFunction(F2));
 263
 264   // F2() should increment G.
 265   F2Ptr();
 266   EXPECT_EQ(2, *GPtr);
 267
 268   // Deallocate F1.
 269   JIT->freeMachineCodeForFunction(F1);
 270
 271   // F2() should *still* increment G.
 272   F2Ptr();
 273   EXPECT_EQ(3, *GPtr);
 274 }
 275
 276 int PlusOne(int arg) {
 277   return arg + 1;
 278 }
 279
 280 TEST_F(JITTest, FarCallToKnownFunction) {
 281   // x86-64 can only make direct calls to functions within 32 bits of
 282   // the current PC.  To call anything farther away, we have to load
 283   // the address into a register and call through the register.  The
 284   // current JIT does this by allocating a stub for any far call.
 285   // There was a bug in which the JIT tried to emit a direct call when
 286   // the target was already in the JIT's global mappings and lazy
 287   // compilation was disabled.
 288
 289   Function *KnownFunction = Function::Create(
 290       TypeBuilder<int(int), false>::get(Context),
 291       GlobalValue::ExternalLinkage, "known", M);
 292   TheJIT->addGlobalMapping(KnownFunction, (void*)(intptr_t)PlusOne);
 293
 294   // int test() { return known(7); }
 295   Function *TestFunction = Function::Create(
 296       TypeBuilder<int(), false>::get(Context),
 297       GlobalValue::ExternalLinkage, "test", M);
 298   BasicBlock *Entry = BasicBlock::Create(Context, "entry", TestFunction);
 299   IRBuilder<> Builder(Entry);
 300   Value *result = Builder.CreateCall(
 301       KnownFunction,
 302       ConstantInt::get(TypeBuilder<int, false>::get(Context), 7));
 303   Builder.CreateRet(result);
 304
 305   TheJIT->DisableLazyCompilation(true);
 306   int (*TestFunctionPtr)() = reinterpret_cast<int(*)()>(
 307       (intptr_t)TheJIT->getPointerToFunction(TestFunction));
 308   // This used to crash in trying to call PlusOne().
 309   EXPECT_EQ(8, TestFunctionPtr());
 310 }
 311
 312 // Test a function C which calls A and B which call each other.
 313 TEST_F(JITTest, NonLazyCompilationStillNeedsStubs) {
 314   TheJIT->DisableLazyCompilation(true);
 315
 316   FunctionType *Func1Ty =
 317       cast<FunctionType>(TypeBuilder<void(void), false>::get(Context));
 318   std::vector<Type*> arg_types;
 319   arg_types.push_back(Type::getInt1Ty(Context));
 320   FunctionType *FuncTy = FunctionType::get(
 321       Type::getVoidTy(Context), arg_types, false);
 322   Function *Func1 = Function::Create(Func1Ty, Function::ExternalLinkage,
 323                                      "func1", M);
 324   Function *Func2 = Function::Create(FuncTy, Function::InternalLinkage,
 325                                      "func2", M);
 326   Function *Func3 = Function::Create(FuncTy, Function::InternalLinkage,
 327                                      "func3", M);
 328   BasicBlock *Block1 = BasicBlock::Create(Context, "block1", Func1);
 329   BasicBlock *Block2 = BasicBlock::Create(Context, "block2", Func2);
 330   BasicBlock *True2 = BasicBlock::Create(Context, "cond_true", Func2);
 331   BasicBlock *False2 = BasicBlock::Create(Context, "cond_false", Func2);
 332   BasicBlock *Block3 = BasicBlock::Create(Context, "block3", Func3);
 333   BasicBlock *True3 = BasicBlock::Create(Context, "cond_true", Func3);
 334   BasicBlock *False3 = BasicBlock::Create(Context, "cond_false", Func3);
 335
 336   // Make Func1 call Func2(0) and Func3(0).
 337   IRBuilder<> Builder(Block1);
 338   Builder.CreateCall(Func2, ConstantInt::getTrue(Context));
 339   Builder.CreateCall(Func3, ConstantInt::getTrue(Context));
 340   Builder.CreateRetVoid();
 341
 342   // void Func2(bool b) { if (b) { Func3(false); return; } return; }
 343   Builder.SetInsertPoint(Block2);
 344   Builder.CreateCondBr(Func2->arg_begin(), True2, False2);
 345   Builder.SetInsertPoint(True2);
 346   Builder.CreateCall(Func3, ConstantInt::getFalse(Context));
 347   Builder.CreateRetVoid();
 348   Builder.SetInsertPoint(False2);
 349   Builder.CreateRetVoid();
 350
 351   // void Func3(bool b) { if (b) { Func2(false); return; } return; }
 352   Builder.SetInsertPoint(Block3);
 353   Builder.CreateCondBr(Func3->arg_begin(), True3, False3);
 354   Builder.SetInsertPoint(True3);
 355   Builder.CreateCall(Func2, ConstantInt::getFalse(Context));
 356   Builder.CreateRetVoid();
 357   Builder.SetInsertPoint(False3);
 358   Builder.CreateRetVoid();
 359
 360   // Compile the function to native code
 361   void (*F1Ptr)() =
 362      reinterpret_cast<void(*)()>((intptr_t)TheJIT->getPointerToFunction(Func1));
 363
 364   F1Ptr();
 365 }
 366
 367 // Regression test for PR5162.  This used to trigger an AssertingVH inside the
 368 // JIT's Function to stub mapping.
 369 TEST_F(JITTest, NonLazyLeaksNoStubs) {
 370   TheJIT->DisableLazyCompilation(true);
 371
 372   // Create two functions with a single basic block each.
 373   FunctionType *FuncTy =
 374       cast<FunctionType>(TypeBuilder<int(), false>::get(Context));
 375   Function *Func1 = Function::Create(FuncTy, Function::ExternalLinkage,
 376                                      "func1", M);
 377   Function *Func2 = Function::Create(FuncTy, Function::InternalLinkage,
 378                                      "func2", M);
 379   BasicBlock *Block1 = BasicBlock::Create(Context, "block1", Func1);
 380   BasicBlock *Block2 = BasicBlock::Create(Context, "block2", Func2);
 381
 382   // The first function calls the second and returns the result
 383   IRBuilder<> Builder(Block1);
 384   Value *Result = Builder.CreateCall(Func2);
 385   Builder.CreateRet(Result);
 386
 387   // The second function just returns a constant
 388   Builder.SetInsertPoint(Block2);
 389   Builder.CreateRet(ConstantInt::get(TypeBuilder<int, false>::get(Context),42));
 390
 391   // Compile the function to native code
 392   (void)TheJIT->getPointerToFunction(Func1);
 393
 394   // Free the JIT state for the functions
 395   TheJIT->freeMachineCodeForFunction(Func1);
 396   TheJIT->freeMachineCodeForFunction(Func2);
 397
 398   // Delete the first function (and show that is has no users)
 399   EXPECT_EQ(Func1->getNumUses(), 0u);
 400   Func1->eraseFromParent();
 401
 402   // Delete the second function (and show that it has no users - it had one,
 403   // func1 but that's gone now)
 404   EXPECT_EQ(Func2->getNumUses(), 0u);
 405   Func2->eraseFromParent();
 406 }
 407
 408 TEST_F(JITTest, ModuleDeletion) {
 409   TheJIT->DisableLazyCompilation(false);
 410   LoadAssembly("define void @main() { "
 411                "  call i32 @computeVal() "
 412                "  ret void "
 413                "} "
 414                " "
 415                "define internal i32 @computeVal()  { "
 416                "  ret i32 0 "
 417                "} ");
 418   Function *func = M->getFunction("main");
 419   TheJIT->getPointerToFunction(func);
 420   TheJIT->removeModule(M);
 421   delete M;
 422
 423   SmallPtrSet<const void*, 2> FunctionsDeallocated;
 424   for (unsigned i = 0, e = RJMM->deallocateFunctionBodyCalls.size();
 425        i != e; ++i) {
 426     FunctionsDeallocated.insert(RJMM->deallocateFunctionBodyCalls[i].Body);
 427   }
 428   for (unsigned i = 0, e = RJMM->startFunctionBodyCalls.size(); i != e; ++i) {
 429     EXPECT_TRUE(FunctionsDeallocated.count(
 430                   RJMM->startFunctionBodyCalls[i].Result))
 431       << "Function leaked: \n" << RJMM->startFunctionBodyCalls[i].F_dump;
 432   }
 433   EXPECT_EQ(RJMM->startFunctionBodyCalls.size(),
 434             RJMM->deallocateFunctionBodyCalls.size());
 435 }
 436
 437 // ARM, MIPS and PPC still emit stubs for calls since the target may be
 438 // too far away to call directly.  This #if can probably be removed when
 439 // http://llvm.org/PR5201 is fixed.
 440 #if !defined(__arm__) && !defined(__mips__) && \
 441     !defined(__powerpc__) && !defined(__ppc__) && !defined(__aarch64__)
 442 typedef int (*FooPtr) ();
 443
 444 TEST_F(JITTest, NoStubs) {
 445   LoadAssembly("define void @bar() {"
 446                "entry: "
 447                "ret void"
 448                "}"
 449                " "
 450                "define i32 @foo() {"
 451                "entry:"
 452                "call void @bar()"
 453                "ret i32 undef"
 454                "}"
 455                " "
 456                "define i32 @main() {"
 457                "entry:"
 458                "%0 = call i32 @foo()"
 459                "call void @bar()"
 460                "ret i32 undef"
 461                "}");
 462   Function *foo = M->getFunction("foo");
 463   uintptr_t tmp = (uintptr_t)(TheJIT->getPointerToFunction(foo));
 464   FooPtr ptr = (FooPtr)(tmp);
 465
 466   (ptr)();
 467
 468   // We should now allocate no more stubs, we have the code to foo
 469   // and the existing stub for bar.
 470   int stubsBefore = RJMM->stubsAllocated;
 471   Function *func = M->getFunction("main");
 472   TheJIT->getPointerToFunction(func);
 473
 474   Function *bar = M->getFunction("bar");
 475   TheJIT->getPointerToFunction(bar);
 476
 477   ASSERT_EQ(stubsBefore, RJMM->stubsAllocated);
 478 }
 479 #endif  // !ARM && !PPC
 480
 481 TEST_F(JITTest, FunctionPointersOutliveTheirCreator) {
 482   TheJIT->DisableLazyCompilation(true);
 483   LoadAssembly("define i8()* @get_foo_addr() { "
 484                "  ret i8()* @foo "
 485                "} "
 486                " "
 487                "define i8 @foo() { "
 488                "  ret i8 42 "
 489                "} ");
 490   Function *F_get_foo_addr = M->getFunction("get_foo_addr");
 491
 492   typedef char(*fooT)();
 493   fooT (*get_foo_addr)() = reinterpret_cast<fooT(*)()>(
 494       (intptr_t)TheJIT->getPointerToFunction(F_get_foo_addr));
 495   fooT foo_addr = get_foo_addr();
 496
 497   // Now free get_foo_addr.  This should not free the machine code for foo or
 498   // any call stub returned as foo's canonical address.
 499   TheJIT->freeMachineCodeForFunction(F_get_foo_addr);
 500
 501   // Check by calling the reported address of foo.
 502   EXPECT_EQ(42, foo_addr());
 503
 504   // The reported address should also be the same as the result of a subsequent
 505   // getPointerToFunction(foo).
 506 #if 0
 507   // Fails until PR5126 is fixed:
 508   Function *F_foo = M->getFunction("foo");
 509   fooT foo = reinterpret_cast<fooT>(
 510       (intptr_t)TheJIT->getPointerToFunction(F_foo));
 511   EXPECT_EQ((intptr_t)foo, (intptr_t)foo_addr);
 512 #endif
 513 }
 514
 515 // ARM does not have an implementation of replaceMachineCodeForFunction(),
 516 // so recompileAndRelinkFunction doesn't work.
 517 #if !defined(__arm__) && !defined(__aarch64__)
 518 TEST_F(JITTest, FunctionIsRecompiledAndRelinked) {
 519   Function *F = Function::Create(TypeBuilder<int(void), false>::get(Context),
 520                                  GlobalValue::ExternalLinkage, "test", M);
 521   BasicBlock *Entry = BasicBlock::Create(Context, "entry", F);
 522   IRBuilder<> Builder(Entry);
 523   Value *Val = ConstantInt::get(TypeBuilder<int, false>::get(Context), 1);
 524   Builder.CreateRet(Val);
 525
 526   TheJIT->DisableLazyCompilation(true);
 527   // Compile the function once, and make sure it works.
 528   int (*OrigFPtr)() = reinterpret_cast<int(*)()>(
 529     (intptr_t)TheJIT->recompileAndRelinkFunction(F));
 530   EXPECT_EQ(1, OrigFPtr());
 531
 532   // Now change the function to return a different value.
 533   Entry->eraseFromParent();
 534   BasicBlock *NewEntry = BasicBlock::Create(Context, "new_entry", F);
 535   Builder.SetInsertPoint(NewEntry);
 536   Val = ConstantInt::get(TypeBuilder<int, false>::get(Context), 2);
 537   Builder.CreateRet(Val);
 538   // Recompile it, which should produce a new function pointer _and_ update the
 539   // old one.
 540   int (*NewFPtr)() = reinterpret_cast<int(*)()>(
 541     (intptr_t)TheJIT->recompileAndRelinkFunction(F));
 542
 543   EXPECT_EQ(2, NewFPtr())
 544     << "The new pointer should call the new version of the function";
 545   EXPECT_EQ(2, OrigFPtr())
 546     << "The old pointer's target should now jump to the new version";
 547 }
 548 #endif  // !defined(__arm__)
 549
 550 TEST_F(JITTest, AvailableExternallyGlobalIsntEmitted) {
 551   TheJIT->DisableLazyCompilation(true);
 552   LoadAssembly("@JITTest_AvailableExternallyGlobal = "
 553                "  available_externally global i32 7 "
 554                " "
 555                "define i32 @loader() { "
 556                "  %result = load i32* @JITTest_AvailableExternallyGlobal "
 557                "  ret i32 %result "
 558                "} ");
 559   Function *loaderIR = M->getFunction("loader");
 560
 561   int32_t (*loader)() = reinterpret_cast<int32_t(*)()>(
 562     (intptr_t)TheJIT->getPointerToFunction(loaderIR));
 563   EXPECT_EQ(42, loader()) << "func should return 42 from the external global,"
 564                           << " not 7 from the IR version.";
 565 }
 566
 567 TEST_F(JITTest, AvailableExternallyFunctionIsntCompiled) {
 568   TheJIT->DisableLazyCompilation(true);
 569   LoadAssembly("define available_externally i32 "
 570                "    @JITTest_AvailableExternallyFunction() { "
 571                "  ret i32 7 "
 572                "} "
 573                " "
 574                "define i32 @func() { "
 575                "  %result = tail call i32 "
 576                "    @JITTest_AvailableExternallyFunction() "
 577                "  ret i32 %result "
 578                "} ");
 579   Function *funcIR = M->getFunction("func");
 580
 581   int32_t (*func)() = reinterpret_cast<int32_t(*)()>(
 582     (intptr_t)TheJIT->getPointerToFunction(funcIR));
 583   EXPECT_EQ(42, func()) << "func should return 42 from the static version,"
 584                         << " not 7 from the IR version.";
 585 }
 586
 587 TEST_F(JITTest, EscapedLazyStubStillCallable) {
 588   TheJIT->DisableLazyCompilation(false);
 589   LoadAssembly("define internal i32 @stubbed() { "
 590                "  ret i32 42 "
 591                "} "
 592                " "
 593                "define i32()* @get_stub() { "
 594                "  ret i32()* @stubbed "
 595                "} ");
 596   typedef int32_t(*StubTy)();
 597
 598   // Call get_stub() to get the address of @stubbed without actually JITting it.
 599   Function *get_stubIR = M->getFunction("get_stub");
 600   StubTy (*get_stub)() = reinterpret_cast<StubTy(*)()>(
 601     (intptr_t)TheJIT->getPointerToFunction(get_stubIR));
 602   StubTy stubbed = get_stub();
 603   // Now get_stubIR is the only reference to stubbed's stub.
 604   get_stubIR->eraseFromParent();
 605   // Now there are no references inside the JIT, but we've got a pointer outside
 606   // it.  The stub should be callable and return the right value.
 607   EXPECT_EQ(42, stubbed());
 608 }
 609
 610 // Converts the LLVM assembly to bitcode and returns it in a std::string.  An
 611 // empty string indicates an error.
 612 std::string AssembleToBitcode(LLVMContext &Context, const char *Assembly) {
 613   Module TempModule("TempModule", Context);
 614   if (!LoadAssemblyInto(&TempModule, Assembly)) {
 615     return "";
 616   }
 617
 618   std::string Result;
 619   raw_string_ostream OS(Result);
 620   WriteBitcodeToFile(&TempModule, OS);
 621   OS.flush();
 622   return Result;
 623 }
 624
 625 // Returns a newly-created ExecutionEngine that reads the bitcode in 'Bitcode'
 626 // lazily.  The associated Module (owned by the ExecutionEngine) is returned in
 627 // M.  Both will be NULL on an error.  Bitcode must live at least as long as the
 628 // ExecutionEngine.
 629 ExecutionEngine *getJITFromBitcode(
 630   LLVMContext &Context, const std::string &Bitcode, Module *&M) {
 631   // c_str() is null-terminated like MemoryBuffer::getMemBuffer requires.
 632   MemoryBuffer *BitcodeBuffer =
 633     MemoryBuffer::getMemBuffer(Bitcode, "Bitcode for test");
 634   ErrorOr<Module*> ModuleOrErr = getLazyBitcodeModule(BitcodeBuffer, Context);
 635   if (std::error_code EC = ModuleOrErr.getError()) {
 636     ADD_FAILURE() << EC.message();
 637     delete BitcodeBuffer;
 638     return nullptr;
 639   }
 640   M = ModuleOrErr.get();
 641   std::string errMsg;
 642   ExecutionEngine *TheJIT = EngineBuilder(M)
 643     .setEngineKind(EngineKind::JIT)
 644     .setErrorStr(&errMsg)
 645     .create();
 646   if (TheJIT == nullptr) {
 647     ADD_FAILURE() << errMsg;
 648     delete M;
 649     M = nullptr;
 650     return nullptr;
 651   }
 652   return TheJIT;
 653 }
 654
 655 TEST(LazyLoadedJITTest, MaterializableAvailableExternallyFunctionIsntCompiled) {
 656   LLVMContext Context;
 657   const std::string Bitcode =
 658     AssembleToBitcode(Context,
 659                       "define available_externally i32 "
 660                       "    @JITTest_AvailableExternallyFunction() { "
 661                       "  ret i32 7 "
 662                       "} "
 663                       " "
 664                       "define i32 @func() { "
 665                       "  %result = tail call i32 "
 666                       "    @JITTest_AvailableExternallyFunction() "
 667                       "  ret i32 %result "
 668                       "} ");
 669   ASSERT_FALSE(Bitcode.empty()) << "Assembling failed";
 670   Module *M;
 671   std::unique_ptr<ExecutionEngine> TheJIT(
 672       getJITFromBitcode(Context, Bitcode, M));
 673   ASSERT_TRUE(TheJIT.get()) << "Failed to create JIT.";
 674   TheJIT->DisableLazyCompilation(true);
 675
 676   Function *funcIR = M->getFunction("func");
 677   Function *availableFunctionIR =
 678     M->getFunction("JITTest_AvailableExternallyFunction");
 679
 680   // Double-check that the available_externally function is still unmaterialized
 681   // when getPointerToFunction needs to find out if it's available_externally.
 682   EXPECT_TRUE(availableFunctionIR->isMaterializable());
 683
 684   int32_t (*func)() = reinterpret_cast<int32_t(*)()>(
 685     (intptr_t)TheJIT->getPointerToFunction(funcIR));
 686   EXPECT_EQ(42, func()) << "func should return 42 from the static version,"
 687                         << " not 7 from the IR version.";
 688 }
 689
 690 TEST(LazyLoadedJITTest, EagerCompiledRecursionThroughGhost) {
 691   LLVMContext Context;
 692   const std::string Bitcode =
 693     AssembleToBitcode(Context,
 694                       "define i32 @recur1(i32 %a) { "
 695                       "  %zero = icmp eq i32 %a, 0 "
 696                       "  br i1 %zero, label %done, label %notdone "
 697                       "done: "
 698                       "  ret i32 3 "
 699                       "notdone: "
 700                       "  %am1 = sub i32 %a, 1 "
 701                       "  %result = call i32 @recur2(i32 %am1) "
 702                       "  ret i32 %result "
 703                       "} "
 704                       " "
 705                       "define i32 @recur2(i32 %b) { "
 706                       "  %result = call i32 @recur1(i32 %b) "
 707                       "  ret i32 %result "
 708                       "} ");
 709   ASSERT_FALSE(Bitcode.empty()) << "Assembling failed";
 710   Module *M;
 711   std::unique_ptr<ExecutionEngine> TheJIT(
 712       getJITFromBitcode(Context, Bitcode, M));
 713   ASSERT_TRUE(TheJIT.get()) << "Failed to create JIT.";
 714   TheJIT->DisableLazyCompilation(true);
 715
 716   Function *recur1IR = M->getFunction("recur1");
 717   Function *recur2IR = M->getFunction("recur2");
 718   EXPECT_TRUE(recur1IR->isMaterializable());
 719   EXPECT_TRUE(recur2IR->isMaterializable());
 720
 721   int32_t (*recur1)(int32_t) = reinterpret_cast<int32_t(*)(int32_t)>(
 722     (intptr_t)TheJIT->getPointerToFunction(recur1IR));
 723   EXPECT_EQ(3, recur1(4));
 724 }
 725 #endif // !defined(__arm__) && !defined(__powerpc__) && !defined(__s390__)
 726
 727 }