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/BasicBlock.h"
  11 #include "llvm/Constant.h"
  12 #include "llvm/Constants.h"
  13 #include "llvm/DerivedTypes.h"
  14 #include "llvm/Function.h"
  15 #include "llvm/GlobalValue.h"
  16 #include "llvm/GlobalVariable.h"
  17 #include "llvm/IRBuilder.h"
  18 #include "llvm/LLVMContext.h"
  19 #include "llvm/Module.h"
  20 #include "llvm/Type.h"
  21 #include "llvm/TypeBuilder.h"
  22 #include "llvm/ADT/OwningPtr.h"
  23 #include "llvm/ADT/SmallPtrSet.h"
  24 #include "llvm/Assembly/Parser.h"
  25 #include "llvm/Bitcode/ReaderWriter.h"
  26 #include "llvm/ExecutionEngine/JIT.h"
  27 #include "llvm/ExecutionEngine/JITMemoryManager.h"
  28 #include "llvm/Support/MemoryBuffer.h"
  29 #include "llvm/Support/SourceMgr.h"
  30 #include "llvm/Support/TargetSelect.h"
  31
  32 #include "gtest/gtest.h"
  33 #include <vector>
  34
  35 using namespace llvm;
  36
  37 namespace {
  38
  39 Function *makeReturnGlobal(std::string Name, GlobalVariable *G, Module *M) {
  40   std::vector<Type*> params;
  41   FunctionType *FTy = FunctionType::get(G->getType()->getElementType(),
  42                                               params, false);
  43   Function *F = Function::Create(FTy, GlobalValue::ExternalLinkage, Name, M);
  44   BasicBlock *Entry = BasicBlock::Create(M->getContext(), "entry", F);
  45   IRBuilder<> builder(Entry);
  46   Value *Load = builder.CreateLoad(G);
  47   Type *GTy = G->getType()->getElementType();
  48   Value *Add = builder.CreateAdd(Load, ConstantInt::get(GTy, 1LL));
  49   builder.CreateStore(Add, G);
  50   builder.CreateRet(Add);
  51   return F;
  52 }
  53
  54 std::string DumpFunction(const Function *F) {
  55   std::string Result;
  56   raw_string_ostream(Result) << "" << *F;
  57   return Result;
  58 }
  59
  60 class RecordingJITMemoryManager : public JITMemoryManager {
  61   const OwningPtr<JITMemoryManager> Base;
  62 public:
  63   RecordingJITMemoryManager()
  64     : Base(JITMemoryManager::CreateDefaultMemManager()) {
  65     stubsAllocated = 0;
  66   }
  67   virtual void *getPointerToNamedFunction(const std::string &Name,
  68                                           bool AbortOnFailure = true) {
  69     return Base->getPointerToNamedFunction(Name, AbortOnFailure);
  70   }
  71
  72   virtual void setMemoryWritable() { Base->setMemoryWritable(); }
  73   virtual void setMemoryExecutable() { Base->setMemoryExecutable(); }
  74   virtual void setPoisonMemory(bool poison) { Base->setPoisonMemory(poison); }
  75   virtual void AllocateGOT() { Base->AllocateGOT(); }
  76   virtual uint8_t *getGOTBase() const { return Base->getGOTBase(); }
  77   struct StartFunctionBodyCall {
  78     StartFunctionBodyCall(uint8_t *Result, const Function *F,
  79                           uintptr_t ActualSize, uintptr_t ActualSizeResult)
  80       : Result(Result), F(F), F_dump(DumpFunction(F)),
  81         ActualSize(ActualSize), ActualSizeResult(ActualSizeResult) {}
  82     uint8_t *Result;
  83     const Function *F;
  84     std::string F_dump;
  85     uintptr_t ActualSize;
  86     uintptr_t ActualSizeResult;
  87   };
  88   std::vector<StartFunctionBodyCall> startFunctionBodyCalls;
  89   virtual uint8_t *startFunctionBody(const Function *F,
  90                                      uintptr_t &ActualSize) {
  91     uintptr_t InitialActualSize = ActualSize;
  92     uint8_t *Result = Base->startFunctionBody(F, ActualSize);
  93     startFunctionBodyCalls.push_back(
  94       StartFunctionBodyCall(Result, F, InitialActualSize, ActualSize));
  95     return Result;
  96   }
  97   int stubsAllocated;
  98   virtual uint8_t *allocateStub(const GlobalValue* F, unsigned StubSize,
  99                                 unsigned Alignment) {
 100     stubsAllocated++;
 101     return Base->allocateStub(F, StubSize, Alignment);
 102   }
 103   struct EndFunctionBodyCall {
 104     EndFunctionBodyCall(const Function *F, uint8_t *FunctionStart,
 105                         uint8_t *FunctionEnd)
 106       : F(F), F_dump(DumpFunction(F)),
 107         FunctionStart(FunctionStart), FunctionEnd(FunctionEnd) {}
 108     const Function *F;
 109     std::string F_dump;
 110     uint8_t *FunctionStart;
 111     uint8_t *FunctionEnd;
 112   };
 113   std::vector<EndFunctionBodyCall> endFunctionBodyCalls;
 114   virtual void endFunctionBody(const Function *F, uint8_t *FunctionStart,
 115                                uint8_t *FunctionEnd) {
 116     endFunctionBodyCalls.push_back(
 117       EndFunctionBodyCall(F, FunctionStart, FunctionEnd));
 118     Base->endFunctionBody(F, FunctionStart, FunctionEnd);
 119   }
 120   virtual uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
 121                                        unsigned SectionID) {
 122     return Base->allocateDataSection(Size, Alignment, SectionID);
 123   }
 124   virtual uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
 125                                        unsigned SectionID) {
 126     return Base->allocateCodeSection(Size, Alignment, SectionID);
 127   }
 128   virtual uint8_t *allocateSpace(intptr_t Size, unsigned Alignment) {
 129     return Base->allocateSpace(Size, Alignment);
 130   }
 131   virtual uint8_t *allocateGlobal(uintptr_t Size, unsigned Alignment) {
 132     return Base->allocateGlobal(Size, Alignment);
 133   }
 134   struct DeallocateFunctionBodyCall {
 135     DeallocateFunctionBodyCall(const void *Body) : Body(Body) {}
 136     const void *Body;
 137   };
 138   std::vector<DeallocateFunctionBodyCall> deallocateFunctionBodyCalls;
 139   virtual void deallocateFunctionBody(void *Body) {
 140     deallocateFunctionBodyCalls.push_back(DeallocateFunctionBodyCall(Body));
 141     Base->deallocateFunctionBody(Body);
 142   }
 143   struct DeallocateExceptionTableCall {
 144     DeallocateExceptionTableCall(const void *ET) : ET(ET) {}
 145     const void *ET;
 146   };
 147   std::vector<DeallocateExceptionTableCall> deallocateExceptionTableCalls;
 148   virtual void deallocateExceptionTable(void *ET) {
 149     deallocateExceptionTableCalls.push_back(DeallocateExceptionTableCall(ET));
 150     Base->deallocateExceptionTable(ET);
 151   }
 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) {}
 157     uint8_t *Result;
 158     const Function *F;
 159     std::string F_dump;
 160     uintptr_t ActualSize;
 161     uintptr_t ActualSizeResult;
 162   };
 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));
 170     return Result;
 171   }
 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) {}
 178     const Function *F;
 179     std::string F_dump;
 180     uint8_t *TableStart;
 181     uint8_t *TableEnd;
 182     uint8_t *FrameRegister;
 183   };
 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);
 190   }
 191 };
 192
 193 bool LoadAssemblyInto(Module *M, const char *assembly) {
 194   SMDiagnostic Error;
 195   bool success =
 196     NULL != ParseAssemblyString(assembly, M, Error, M->getContext());
 197   std::string errMsg;
 198   raw_string_ostream os(errMsg);
 199   Error.print("", os);
 200   EXPECT_TRUE(success) << os.str();
 201   return success;
 202 }
 203
 204 class JITTest : public testing::Test {
 205  protected:
 206   virtual void SetUp() {
 207     M = new Module("<main>", Context);
 208     RJMM = new RecordingJITMemoryManager;
 209     RJMM->setPoisonMemory(true);
 210     std::string Error;
 211     TheJIT.reset(EngineBuilder(M).setEngineKind(EngineKind::JIT)
 212                  .setJITMemoryManager(RJMM)
 213                  .setErrorStr(&Error).create());
 214     ASSERT_TRUE(TheJIT.get() != NULL) << Error;
 215   }
 216
 217   void LoadAssembly(const char *assembly) {
 218     LoadAssemblyInto(M, assembly);
 219   }
 220
 221   LLVMContext Context;
 222   Module *M;  // Owned by ExecutionEngine.
 223   RecordingJITMemoryManager *RJMM;
 224   OwningPtr<ExecutionEngine> TheJIT;
 225 };
 226
 227 // Tests on ARM disabled as we're running the old jit
 228 #if !defined(__arm__)
 229
 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) {
 236   LLVMContext context;
 237   Module *M = new Module("<main>", context);
 238
 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);
 243   std::string Error;
 244   OwningPtr<ExecutionEngine> JIT(EngineBuilder(M)
 245                                  .setEngineKind(EngineKind::JIT)
 246                                  .setErrorStr(&Error)
 247                                  .setJITMemoryManager(MemMgr)
 248                                  // The next line enables the fix:
 249                                  .setAllocateGVsWithCode(false)
 250                                  .create());
 251   ASSERT_EQ(Error, "");
 252
 253   // Create a global variable.
 254   Type *GTy = Type::getInt32Ty(context);
 255   GlobalVariable *G = new GlobalVariable(
 256       *M,
 257       GTy,
 258       false,  // Not constant.
 259       GlobalValue::InternalLinkage,
 260       Constant::getNullValue(GTy),
 261       "myglobal");
 262
 263   // Make a function that points to a global.
 264   Function *F1 = makeReturnGlobal("F1", G, M);
 265
 266   // Get the pointer to the native code to force it to JIT the function and
 267   // allocate space for the global.
 268   void (*F1Ptr)() =
 269       reinterpret_cast<void(*)()>((intptr_t)JIT->getPointerToFunction(F1));
 270
 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);
 274   EXPECT_EQ(0, *GPtr);
 275
 276   // F1() should increment G.
 277   F1Ptr();
 278   EXPECT_EQ(1, *GPtr);
 279
 280   // Make a second function identical to the first, referring to the same
 281   // global.
 282   Function *F2 = makeReturnGlobal("F2", G, M);
 283   void (*F2Ptr)() =
 284       reinterpret_cast<void(*)()>((intptr_t)JIT->getPointerToFunction(F2));
 285
 286   // F2() should increment G.
 287   F2Ptr();
 288   EXPECT_EQ(2, *GPtr);
 289
 290   // Deallocate F1.
 291   JIT->freeMachineCodeForFunction(F1);
 292
 293   // F2() should *still* increment G.
 294   F2Ptr();
 295   EXPECT_EQ(3, *GPtr);
 296 }
 297
 298 #endif // !defined(__arm__)
 299
 300 int PlusOne(int arg) {
 301   return arg + 1;
 302 }
 303
 304 // ARM tests disabled pending fix for PR10783.
 305 #if !defined(__arm__)
 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.
 314
 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);
 319
 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(
 327       KnownFunction,
 328       ConstantInt::get(TypeBuilder<int, false>::get(Context), 7));
 329   Builder.CreateRet(result);
 330
 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());
 336 }
 337
 338 // Test a function C which calls A and B which call each other.
 339 TEST_F(JITTest, NonLazyCompilationStillNeedsStubs) {
 340   TheJIT->DisableLazyCompilation(true);
 341
 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,
 349                                      "func1", M);
 350   Function *Func2 = Function::Create(FuncTy, Function::InternalLinkage,
 351                                      "func2", M);
 352   Function *Func3 = Function::Create(FuncTy, Function::InternalLinkage,
 353                                      "func3", M);
 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);
 361
 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();
 367
 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();
 376
 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();
 385
 386   // Compile the function to native code
 387   void (*F1Ptr)() =
 388      reinterpret_cast<void(*)()>((intptr_t)TheJIT->getPointerToFunction(Func1));
 389
 390   F1Ptr();
 391 }
 392
 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);
 397
 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,
 402                                      "func1", M);
 403   Function *Func2 = Function::Create(FuncTy, Function::InternalLinkage,
 404                                      "func2", M);
 405   BasicBlock *Block1 = BasicBlock::Create(Context, "block1", Func1);
 406   BasicBlock *Block2 = BasicBlock::Create(Context, "block2", Func2);
 407
 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);
 412
 413   // The second function just returns a constant
 414   Builder.SetInsertPoint(Block2);
 415   Builder.CreateRet(ConstantInt::get(TypeBuilder<int, false>::get(Context),42));
 416
 417   // Compile the function to native code
 418   (void)TheJIT->getPointerToFunction(Func1);
 419
 420   // Free the JIT state for the functions
 421   TheJIT->freeMachineCodeForFunction(Func1);
 422   TheJIT->freeMachineCodeForFunction(Func2);
 423
 424   // Delete the first function (and show that is has no users)
 425   EXPECT_EQ(Func1->getNumUses(), 0u);
 426   Func1->eraseFromParent();
 427
 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();
 432 }
 433
 434 TEST_F(JITTest, ModuleDeletion) {
 435   TheJIT->DisableLazyCompilation(false);
 436   LoadAssembly("define void @main() { "
 437                "  call i32 @computeVal() "
 438                "  ret void "
 439                "} "
 440                " "
 441                "define internal i32 @computeVal()  { "
 442                "  ret i32 0 "
 443                "} ");
 444   Function *func = M->getFunction("main");
 445   TheJIT->getPointerToFunction(func);
 446   TheJIT->removeModule(M);
 447   delete M;
 448
 449   SmallPtrSet<const void*, 2> FunctionsDeallocated;
 450   for (unsigned i = 0, e = RJMM->deallocateFunctionBodyCalls.size();
 451        i != e; ++i) {
 452     FunctionsDeallocated.insert(RJMM->deallocateFunctionBodyCalls[i].Body);
 453   }
 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;
 458   }
 459   EXPECT_EQ(RJMM->startFunctionBodyCalls.size(),
 460             RJMM->deallocateFunctionBodyCalls.size());
 461
 462   SmallPtrSet<const void*, 2> ExceptionTablesDeallocated;
 463   unsigned NumTablesDeallocated = 0;
 464   for (unsigned i = 0, e = RJMM->deallocateExceptionTableCalls.size();
 465        i != e; ++i) {
 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++;
 472     }
 473   }
 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;
 479   }
 480   EXPECT_EQ(RJMM->startExceptionTableCalls.size(),
 481             NumTablesDeallocated);
 482 }
 483 #endif // !defined(__arm__)
 484
 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) ();
 491
 492 TEST_F(JITTest, NoStubs) {
 493   LoadAssembly("define void @bar() {"
 494                "entry: "
 495                "ret void"
 496                "}"
 497                " "
 498                "define i32 @foo() {"
 499                "entry:"
 500                "call void @bar()"
 501                "ret i32 undef"
 502                "}"
 503                " "
 504                "define i32 @main() {"
 505                "entry:"
 506                "%0 = call i32 @foo()"
 507                "call void @bar()"
 508                "ret i32 undef"
 509                "}");
 510   Function *foo = M->getFunction("foo");
 511   uintptr_t tmp = (uintptr_t)(TheJIT->getPointerToFunction(foo));
 512   FooPtr ptr = (FooPtr)(tmp);
 513
 514   (ptr)();
 515
 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);
 521
 522   Function *bar = M->getFunction("bar");
 523   TheJIT->getPointerToFunction(bar);
 524
 525   ASSERT_EQ(stubsBefore, RJMM->stubsAllocated);
 526 }
 527 #endif  // !ARM && !PPC
 528
 529 // Tests on ARM disabled as we're running the old jit
 530 #if !defined(__arm__)
 531
 532 TEST_F(JITTest, FunctionPointersOutliveTheirCreator) {
 533   TheJIT->DisableLazyCompilation(true);
 534   LoadAssembly("define i8()* @get_foo_addr() { "
 535                "  ret i8()* @foo "
 536                "} "
 537                " "
 538                "define i8 @foo() { "
 539                "  ret i8 42 "
 540                "} ");
 541   Function *F_get_foo_addr = M->getFunction("get_foo_addr");
 542
 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();
 547
 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);
 551
 552   // Check by calling the reported address of foo.
 553   EXPECT_EQ(42, foo_addr());
 554
 555   // The reported address should also be the same as the result of a subsequent
 556   // getPointerToFunction(foo).
 557 #if 0
 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);
 563 #endif
 564 }
 565
 566 #endif //!defined(__arm__)
 567
 568 // ARM does not have an implementation
 569 // of replaceMachineCodeForFunction(), so recompileAndRelinkFunction
 570 // doesn't work.
 571 #if !defined(__arm__)
 572 TEST_F(JITTest, FunctionIsRecompiledAndRelinked) {
 573   Function *F = Function::Create(TypeBuilder<int(void), false>::get(Context),
 574                                  GlobalValue::ExternalLinkage, "test", M);
 575   BasicBlock *Entry = BasicBlock::Create(Context, "entry", F);
 576   IRBuilder<> Builder(Entry);
 577   Value *Val = ConstantInt::get(TypeBuilder<int, false>::get(Context), 1);
 578   Builder.CreateRet(Val);
 579
 580   TheJIT->DisableLazyCompilation(true);
 581   // Compile the function once, and make sure it works.
 582   int (*OrigFPtr)() = reinterpret_cast<int(*)()>(
 583     (intptr_t)TheJIT->recompileAndRelinkFunction(F));
 584   EXPECT_EQ(1, OrigFPtr());
 585
 586   // Now change the function to return a different value.
 587   Entry->eraseFromParent();
 588   BasicBlock *NewEntry = BasicBlock::Create(Context, "new_entry", F);
 589   Builder.SetInsertPoint(NewEntry);
 590   Val = ConstantInt::get(TypeBuilder<int, false>::get(Context), 2);
 591   Builder.CreateRet(Val);
 592   // Recompile it, which should produce a new function pointer _and_ update the
 593   // old one.
 594   int (*NewFPtr)() = reinterpret_cast<int(*)()>(
 595     (intptr_t)TheJIT->recompileAndRelinkFunction(F));
 596
 597   EXPECT_EQ(2, NewFPtr())
 598     << "The new pointer should call the new version of the function";
 599   EXPECT_EQ(2, OrigFPtr())
 600     << "The old pointer's target should now jump to the new version";
 601 }
 602 #endif  // !defined(__arm__)
 603
 604 }  // anonymous namespace
 605 // This variable is intentionally defined differently in the statically-compiled
 606 // program from the IR input to the JIT to assert that the JIT doesn't use its
 607 // definition.
 608 extern "C" int32_t JITTest_AvailableExternallyGlobal;
 609 int32_t JITTest_AvailableExternallyGlobal = 42;
 610 namespace {
 611
 612 // Tests on ARM disabled as we're running the old jit
 613 #if !defined(__arm__)
 614
 615 TEST_F(JITTest, AvailableExternallyGlobalIsntEmitted) {
 616   TheJIT->DisableLazyCompilation(true);
 617   LoadAssembly("@JITTest_AvailableExternallyGlobal = "
 618                "  available_externally global i32 7 "
 619                " "
 620                "define i32 @loader() { "
 621                "  %result = load i32* @JITTest_AvailableExternallyGlobal "
 622                "  ret i32 %result "
 623                "} ");
 624   Function *loaderIR = M->getFunction("loader");
 625
 626   int32_t (*loader)() = reinterpret_cast<int32_t(*)()>(
 627     (intptr_t)TheJIT->getPointerToFunction(loaderIR));
 628   EXPECT_EQ(42, loader()) << "func should return 42 from the external global,"
 629                           << " not 7 from the IR version.";
 630 }
 631 #endif //!defined(__arm__)
 632 }  // anonymous namespace
 633 // This function is intentionally defined differently in the statically-compiled
 634 // program from the IR input to the JIT to assert that the JIT doesn't use its
 635 // definition.
 636 extern "C" int32_t JITTest_AvailableExternallyFunction() __attribute__((used)) {
 637   return 42;
 638 }
 639 namespace {
 640
 641 // ARM tests disabled pending fix for PR10783.
 642 #if !defined(__arm__)
 643 TEST_F(JITTest, AvailableExternallyFunctionIsntCompiled) {
 644   TheJIT->DisableLazyCompilation(true);
 645   LoadAssembly("define available_externally i32 "
 646                "    @JITTest_AvailableExternallyFunction() { "
 647                "  ret i32 7 "
 648                "} "
 649                " "
 650                "define i32 @func() { "
 651                "  %result = tail call i32 "
 652                "    @JITTest_AvailableExternallyFunction() "
 653                "  ret i32 %result "
 654                "} ");
 655   Function *funcIR = M->getFunction("func");
 656
 657   int32_t (*func)() = reinterpret_cast<int32_t(*)()>(
 658     (intptr_t)TheJIT->getPointerToFunction(funcIR));
 659   EXPECT_EQ(42, func()) << "func should return 42 from the static version,"
 660                         << " not 7 from the IR version.";
 661 }
 662
 663 TEST_F(JITTest, EscapedLazyStubStillCallable) {
 664   TheJIT->DisableLazyCompilation(false);
 665   LoadAssembly("define internal i32 @stubbed() { "
 666                "  ret i32 42 "
 667                "} "
 668                " "
 669                "define i32()* @get_stub() { "
 670                "  ret i32()* @stubbed "
 671                "} ");
 672   typedef int32_t(*StubTy)();
 673
 674   // Call get_stub() to get the address of @stubbed without actually JITting it.
 675   Function *get_stubIR = M->getFunction("get_stub");
 676   StubTy (*get_stub)() = reinterpret_cast<StubTy(*)()>(
 677     (intptr_t)TheJIT->getPointerToFunction(get_stubIR));
 678   StubTy stubbed = get_stub();
 679   // Now get_stubIR is the only reference to stubbed's stub.
 680   get_stubIR->eraseFromParent();
 681   // Now there are no references inside the JIT, but we've got a pointer outside
 682   // it.  The stub should be callable and return the right value.
 683   EXPECT_EQ(42, stubbed());
 684 }
 685
 686 // Converts the LLVM assembly to bitcode and returns it in a std::string.  An
 687 // empty string indicates an error.
 688 std::string AssembleToBitcode(LLVMContext &Context, const char *Assembly) {
 689   Module TempModule("TempModule", Context);
 690   if (!LoadAssemblyInto(&TempModule, Assembly)) {
 691     return "";
 692   }
 693
 694   std::string Result;
 695   raw_string_ostream OS(Result);
 696   WriteBitcodeToFile(&TempModule, OS);
 697   OS.flush();
 698   return Result;
 699 }
 700
 701 // Returns a newly-created ExecutionEngine that reads the bitcode in 'Bitcode'
 702 // lazily.  The associated Module (owned by the ExecutionEngine) is returned in
 703 // M.  Both will be NULL on an error.  Bitcode must live at least as long as the
 704 // ExecutionEngine.
 705 ExecutionEngine *getJITFromBitcode(
 706   LLVMContext &Context, const std::string &Bitcode, Module *&M) {
 707   // c_str() is null-terminated like MemoryBuffer::getMemBuffer requires.
 708   MemoryBuffer *BitcodeBuffer =
 709     MemoryBuffer::getMemBuffer(Bitcode, "Bitcode for test");
 710   std::string errMsg;
 711   M = getLazyBitcodeModule(BitcodeBuffer, Context, &errMsg);
 712   if (M == NULL) {
 713     ADD_FAILURE() << errMsg;
 714     delete BitcodeBuffer;
 715     return NULL;
 716   }
 717   ExecutionEngine *TheJIT = EngineBuilder(M)
 718     .setEngineKind(EngineKind::JIT)
 719     .setErrorStr(&errMsg)
 720     .create();
 721   if (TheJIT == NULL) {
 722     ADD_FAILURE() << errMsg;
 723     delete M;
 724     M = NULL;
 725     return NULL;
 726   }
 727   return TheJIT;
 728 }
 729
 730 TEST(LazyLoadedJITTest, MaterializableAvailableExternallyFunctionIsntCompiled) {
 731   LLVMContext Context;
 732   const std::string Bitcode =
 733     AssembleToBitcode(Context,
 734                       "define available_externally i32 "
 735                       "    @JITTest_AvailableExternallyFunction() { "
 736                       "  ret i32 7 "
 737                       "} "
 738                       " "
 739                       "define i32 @func() { "
 740                       "  %result = tail call i32 "
 741                       "    @JITTest_AvailableExternallyFunction() "
 742                       "  ret i32 %result "
 743                       "} ");
 744   ASSERT_FALSE(Bitcode.empty()) << "Assembling failed";
 745   Module *M;
 746   OwningPtr<ExecutionEngine> TheJIT(getJITFromBitcode(Context, Bitcode, M));
 747   ASSERT_TRUE(TheJIT.get()) << "Failed to create JIT.";
 748   TheJIT->DisableLazyCompilation(true);
 749
 750   Function *funcIR = M->getFunction("func");
 751   Function *availableFunctionIR =
 752     M->getFunction("JITTest_AvailableExternallyFunction");
 753
 754   // Double-check that the available_externally function is still unmaterialized
 755   // when getPointerToFunction needs to find out if it's available_externally.
 756   EXPECT_TRUE(availableFunctionIR->isMaterializable());
 757
 758   int32_t (*func)() = reinterpret_cast<int32_t(*)()>(
 759     (intptr_t)TheJIT->getPointerToFunction(funcIR));
 760   EXPECT_EQ(42, func()) << "func should return 42 from the static version,"
 761                         << " not 7 from the IR version.";
 762 }
 763
 764 TEST(LazyLoadedJITTest, EagerCompiledRecursionThroughGhost) {
 765   LLVMContext Context;
 766   const std::string Bitcode =
 767     AssembleToBitcode(Context,
 768                       "define i32 @recur1(i32 %a) { "
 769                       "  %zero = icmp eq i32 %a, 0 "
 770                       "  br i1 %zero, label %done, label %notdone "
 771                       "done: "
 772                       "  ret i32 3 "
 773                       "notdone: "
 774                       "  %am1 = sub i32 %a, 1 "
 775                       "  %result = call i32 @recur2(i32 %am1) "
 776                       "  ret i32 %result "
 777                       "} "
 778                       " "
 779                       "define i32 @recur2(i32 %b) { "
 780                       "  %result = call i32 @recur1(i32 %b) "
 781                       "  ret i32 %result "
 782                       "} ");
 783   ASSERT_FALSE(Bitcode.empty()) << "Assembling failed";
 784   Module *M;
 785   OwningPtr<ExecutionEngine> TheJIT(getJITFromBitcode(Context, Bitcode, M));
 786   ASSERT_TRUE(TheJIT.get()) << "Failed to create JIT.";
 787   TheJIT->DisableLazyCompilation(true);
 788
 789   Function *recur1IR = M->getFunction("recur1");
 790   Function *recur2IR = M->getFunction("recur2");
 791   EXPECT_TRUE(recur1IR->isMaterializable());
 792   EXPECT_TRUE(recur2IR->isMaterializable());
 793
 794   int32_t (*recur1)(int32_t) = reinterpret_cast<int32_t(*)(int32_t)>(
 795     (intptr_t)TheJIT->getPointerToFunction(recur1IR));
 796   EXPECT_EQ(3, recur1(4));
 797 }
 798 #endif // !defined(__arm__)
 799
 800 // This code is copied from JITEventListenerTest, but it only runs once for all
 801 // the tests in this directory.  Everything seems fine, but that's strange
 802 // behavior.
 803 class JITEnvironment : public testing::Environment {
 804   virtual void SetUp() {
 805     // Required to create a JIT.
 806     InitializeNativeTarget();
 807   }
 808 };
 809 testing::Environment* const jit_env =
 810   testing::AddGlobalTestEnvironment(new JITEnvironment);
 811
 812 }