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 "gtest/gtest.h"
  11 #include "llvm/ADT/OwningPtr.h"
  12 #include "llvm/ADT/SmallPtrSet.h"
  13 #include "llvm/Assembly/Parser.h"
  14 #include "llvm/BasicBlock.h"
  15 #include "llvm/Constant.h"
  16 #include "llvm/Constants.h"
  17 #include "llvm/DerivedTypes.h"
  18 #include "llvm/ExecutionEngine/JIT.h"
  19 #include "llvm/ExecutionEngine/JITMemoryManager.h"
  20 #include "llvm/Function.h"
  21 #include "llvm/GlobalValue.h"
  22 #include "llvm/GlobalVariable.h"
  23 #include "llvm/LLVMContext.h"
  24 #include "llvm/Module.h"
  25 #include "llvm/ModuleProvider.h"
  26 #include "llvm/Support/IRBuilder.h"
  27 #include "llvm/Support/SourceMgr.h"
  28 #include "llvm/Support/TypeBuilder.h"
  29 #include "llvm/Target/TargetSelect.h"
  30 #include "llvm/Type.h"
  31
  32 #include <vector>
  33
  34 using namespace llvm;
  35
  36 namespace {
  37
  38 Function *makeReturnGlobal(std::string Name, GlobalVariable *G, Module *M) {
  39   std::vector<const Type*> params;
  40   const FunctionType *FTy = FunctionType::get(G->getType()->getElementType(),
  41                                               params, false);
  42   Function *F = Function::Create(FTy, GlobalValue::ExternalLinkage, Name, M);
  43   BasicBlock *Entry = BasicBlock::Create(M->getContext(), "entry", F);
  44   IRBuilder<> builder(Entry);
  45   Value *Load = builder.CreateLoad(G);
  46   const Type *GTy = G->getType()->getElementType();
  47   Value *Add = builder.CreateAdd(Load, ConstantInt::get(GTy, 1LL));
  48   builder.CreateStore(Add, G);
  49   builder.CreateRet(Add);
  50   return F;
  51 }
  52
  53 std::string DumpFunction(const Function *F) {
  54   std::string Result;
  55   raw_string_ostream(Result) << "" << *F;
  56   return Result;
  57 }
  58
  59 class RecordingJITMemoryManager : public JITMemoryManager {
  60   const OwningPtr<JITMemoryManager> Base;
  61 public:
  62   RecordingJITMemoryManager()
  63     : Base(JITMemoryManager::CreateDefaultMemManager()) {
  64     stubsAllocated = 0;
  65   }
  66
  67   virtual void setMemoryWritable() { Base->setMemoryWritable(); }
  68   virtual void setMemoryExecutable() { Base->setMemoryExecutable(); }
  69   virtual void setPoisonMemory(bool poison) { Base->setPoisonMemory(poison); }
  70   virtual void AllocateGOT() { Base->AllocateGOT(); }
  71   virtual uint8_t *getGOTBase() const { return Base->getGOTBase(); }
  72   struct StartFunctionBodyCall {
  73     StartFunctionBodyCall(uint8_t *Result, const Function *F,
  74                           uintptr_t ActualSize, uintptr_t ActualSizeResult)
  75       : Result(Result), F(F), F_dump(DumpFunction(F)),
  76         ActualSize(ActualSize), ActualSizeResult(ActualSizeResult) {}
  77     uint8_t *Result;
  78     const Function *F;
  79     std::string F_dump;
  80     uintptr_t ActualSize;
  81     uintptr_t ActualSizeResult;
  82   };
  83   std::vector<StartFunctionBodyCall> startFunctionBodyCalls;
  84   virtual uint8_t *startFunctionBody(const Function *F,
  85                                      uintptr_t &ActualSize) {
  86     uintptr_t InitialActualSize = ActualSize;
  87     uint8_t *Result = Base->startFunctionBody(F, ActualSize);
  88     startFunctionBodyCalls.push_back(
  89       StartFunctionBodyCall(Result, F, InitialActualSize, ActualSize));
  90     return Result;
  91   }
  92   int stubsAllocated;
  93   virtual uint8_t *allocateStub(const GlobalValue* F, unsigned StubSize,
  94                                 unsigned Alignment) {
  95     stubsAllocated++;
  96     return Base->allocateStub(F, StubSize, Alignment);
  97   }
  98   struct EndFunctionBodyCall {
  99     EndFunctionBodyCall(const Function *F, uint8_t *FunctionStart,
 100                         uint8_t *FunctionEnd)
 101       : F(F), F_dump(DumpFunction(F)),
 102         FunctionStart(FunctionStart), FunctionEnd(FunctionEnd) {}
 103     const Function *F;
 104     std::string F_dump;
 105     uint8_t *FunctionStart;
 106     uint8_t *FunctionEnd;
 107   };
 108   std::vector<EndFunctionBodyCall> endFunctionBodyCalls;
 109   virtual void endFunctionBody(const Function *F, uint8_t *FunctionStart,
 110                                uint8_t *FunctionEnd) {
 111     endFunctionBodyCalls.push_back(
 112       EndFunctionBodyCall(F, FunctionStart, FunctionEnd));
 113     Base->endFunctionBody(F, FunctionStart, FunctionEnd);
 114   }
 115   virtual uint8_t *allocateSpace(intptr_t Size, unsigned Alignment) {
 116     return Base->allocateSpace(Size, Alignment);
 117   }
 118   virtual uint8_t *allocateGlobal(uintptr_t Size, unsigned Alignment) {
 119     return Base->allocateGlobal(Size, Alignment);
 120   }
 121   struct DeallocateFunctionBodyCall {
 122     DeallocateFunctionBodyCall(const void *Body) : Body(Body) {}
 123     const void *Body;
 124   };
 125   std::vector<DeallocateFunctionBodyCall> deallocateFunctionBodyCalls;
 126   virtual void deallocateFunctionBody(void *Body) {
 127     deallocateFunctionBodyCalls.push_back(DeallocateFunctionBodyCall(Body));
 128     Base->deallocateFunctionBody(Body);
 129   }
 130   struct DeallocateExceptionTableCall {
 131     DeallocateExceptionTableCall(const void *ET) : ET(ET) {}
 132     const void *ET;
 133   };
 134   std::vector<DeallocateExceptionTableCall> deallocateExceptionTableCalls;
 135   virtual void deallocateExceptionTable(void *ET) {
 136     deallocateExceptionTableCalls.push_back(DeallocateExceptionTableCall(ET));
 137     Base->deallocateExceptionTable(ET);
 138   }
 139   struct StartExceptionTableCall {
 140     StartExceptionTableCall(uint8_t *Result, const Function *F,
 141                             uintptr_t ActualSize, uintptr_t ActualSizeResult)
 142       : Result(Result), F(F), F_dump(DumpFunction(F)),
 143         ActualSize(ActualSize), ActualSizeResult(ActualSizeResult) {}
 144     uint8_t *Result;
 145     const Function *F;
 146     std::string F_dump;
 147     uintptr_t ActualSize;
 148     uintptr_t ActualSizeResult;
 149   };
 150   std::vector<StartExceptionTableCall> startExceptionTableCalls;
 151   virtual uint8_t* startExceptionTable(const Function* F,
 152                                        uintptr_t &ActualSize) {
 153     uintptr_t InitialActualSize = ActualSize;
 154     uint8_t *Result = Base->startExceptionTable(F, ActualSize);
 155     startExceptionTableCalls.push_back(
 156       StartExceptionTableCall(Result, F, InitialActualSize, ActualSize));
 157     return Result;
 158   }
 159   struct EndExceptionTableCall {
 160     EndExceptionTableCall(const Function *F, uint8_t *TableStart,
 161                           uint8_t *TableEnd, uint8_t* FrameRegister)
 162       : F(F), F_dump(DumpFunction(F)),
 163         TableStart(TableStart), TableEnd(TableEnd),
 164         FrameRegister(FrameRegister) {}
 165     const Function *F;
 166     std::string F_dump;
 167     uint8_t *TableStart;
 168     uint8_t *TableEnd;
 169     uint8_t *FrameRegister;
 170   };
 171   std::vector<EndExceptionTableCall> endExceptionTableCalls;
 172   virtual void endExceptionTable(const Function *F, uint8_t *TableStart,
 173                                  uint8_t *TableEnd, uint8_t* FrameRegister) {
 174       endExceptionTableCalls.push_back(
 175           EndExceptionTableCall(F, TableStart, TableEnd, FrameRegister));
 176     return Base->endExceptionTable(F, TableStart, TableEnd, FrameRegister);
 177   }
 178 };
 179
 180 class JITTest : public testing::Test {
 181  protected:
 182   virtual void SetUp() {
 183     M = new Module("<main>", Context);
 184     MP = new ExistingModuleProvider(M);
 185     RJMM = new RecordingJITMemoryManager;
 186     std::string Error;
 187     TheJIT.reset(EngineBuilder(MP).setEngineKind(EngineKind::JIT)
 188                  .setJITMemoryManager(RJMM)
 189                  .setErrorStr(&Error).create());
 190     ASSERT_TRUE(TheJIT.get() != NULL) << Error;
 191   }
 192
 193   void LoadAssembly(const char *assembly) {
 194     SMDiagnostic Error;
 195     bool success = NULL != ParseAssemblyString(assembly, M, Error, Context);
 196     std::string errMsg;
 197     raw_string_ostream os(errMsg);
 198     Error.Print("", os);
 199     ASSERT_TRUE(success) << os.str();
 200   }
 201
 202   LLVMContext Context;
 203   Module *M;  // Owned by MP.
 204   ModuleProvider *MP;  // Owned by ExecutionEngine.
 205   RecordingJITMemoryManager *RJMM;
 206   OwningPtr<ExecutionEngine> TheJIT;
 207 };
 208
 209 // Regression test for a bug.  The JIT used to allocate globals inside the same
 210 // memory block used for the function, and when the function code was freed,
 211 // the global was left in the same place.  This test allocates a function
 212 // that uses and global, deallocates it, and then makes sure that the global
 213 // stays alive after that.
 214 TEST(JIT, GlobalInFunction) {
 215   LLVMContext context;
 216   Module *M = new Module("<main>", context);
 217   ExistingModuleProvider *MP = new ExistingModuleProvider(M);
 218
 219   JITMemoryManager *MemMgr = JITMemoryManager::CreateDefaultMemManager();
 220   // Tell the memory manager to poison freed memory so that accessing freed
 221   // memory is more easily tested.
 222   MemMgr->setPoisonMemory(true);
 223   std::string Error;
 224   OwningPtr<ExecutionEngine> JIT(EngineBuilder(MP)
 225                                  .setEngineKind(EngineKind::JIT)
 226                                  .setErrorStr(&Error)
 227                                  .setJITMemoryManager(MemMgr)
 228                                  // The next line enables the fix:
 229                                  .setAllocateGVsWithCode(false)
 230                                  .create());
 231   ASSERT_EQ(Error, "");
 232
 233   // Create a global variable.
 234   const Type *GTy = Type::getInt32Ty(context);
 235   GlobalVariable *G = new GlobalVariable(
 236       *M,
 237       GTy,
 238       false,  // Not constant.
 239       GlobalValue::InternalLinkage,
 240       Constant::getNullValue(GTy),
 241       "myglobal");
 242
 243   // Make a function that points to a global.
 244   Function *F1 = makeReturnGlobal("F1", G, M);
 245
 246   // Get the pointer to the native code to force it to JIT the function and
 247   // allocate space for the global.
 248   void (*F1Ptr)() =
 249       reinterpret_cast<void(*)()>((intptr_t)JIT->getPointerToFunction(F1));
 250
 251   // Since F1 was codegen'd, a pointer to G should be available.
 252   int32_t *GPtr = (int32_t*)JIT->getPointerToGlobalIfAvailable(G);
 253   ASSERT_NE((int32_t*)NULL, GPtr);
 254   EXPECT_EQ(0, *GPtr);
 255
 256   // F1() should increment G.
 257   F1Ptr();
 258   EXPECT_EQ(1, *GPtr);
 259
 260   // Make a second function identical to the first, referring to the same
 261   // global.
 262   Function *F2 = makeReturnGlobal("F2", G, M);
 263   void (*F2Ptr)() =
 264       reinterpret_cast<void(*)()>((intptr_t)JIT->getPointerToFunction(F2));
 265
 266   // F2() should increment G.
 267   F2Ptr();
 268   EXPECT_EQ(2, *GPtr);
 269
 270   // Deallocate F1.
 271   JIT->freeMachineCodeForFunction(F1);
 272
 273   // F2() should *still* increment G.
 274   F2Ptr();
 275   EXPECT_EQ(3, *GPtr);
 276 }
 277
 278 int PlusOne(int arg) {
 279   return arg + 1;
 280 }
 281
 282 TEST_F(JITTest, FarCallToKnownFunction) {
 283   // x86-64 can only make direct calls to functions within 32 bits of
 284   // the current PC.  To call anything farther away, we have to load
 285   // the address into a register and call through the register.  The
 286   // current JIT does this by allocating a stub for any far call.
 287   // There was a bug in which the JIT tried to emit a direct call when
 288   // the target was already in the JIT's global mappings and lazy
 289   // compilation was disabled.
 290
 291   Function *KnownFunction = Function::Create(
 292       TypeBuilder<int(int), false>::get(Context),
 293       GlobalValue::ExternalLinkage, "known", M);
 294   TheJIT->addGlobalMapping(KnownFunction, (void*)(intptr_t)PlusOne);
 295
 296   // int test() { return known(7); }
 297   Function *TestFunction = Function::Create(
 298       TypeBuilder<int(), false>::get(Context),
 299       GlobalValue::ExternalLinkage, "test", M);
 300   BasicBlock *Entry = BasicBlock::Create(Context, "entry", TestFunction);
 301   IRBuilder<> Builder(Entry);
 302   Value *result = Builder.CreateCall(
 303       KnownFunction,
 304       ConstantInt::get(TypeBuilder<int, false>::get(Context), 7));
 305   Builder.CreateRet(result);
 306
 307   TheJIT->DisableLazyCompilation(true);
 308   int (*TestFunctionPtr)() = reinterpret_cast<int(*)()>(
 309       (intptr_t)TheJIT->getPointerToFunction(TestFunction));
 310   // This used to crash in trying to call PlusOne().
 311   EXPECT_EQ(8, TestFunctionPtr());
 312 }
 313
 314 #if !defined(__arm__) && !defined(__powerpc__) && !defined(__ppc__)
 315 // Test a function C which calls A and B which call each other.
 316 TEST_F(JITTest, NonLazyCompilationStillNeedsStubs) {
 317   TheJIT->DisableLazyCompilation(true);
 318
 319   const FunctionType *Func1Ty =
 320       cast<FunctionType>(TypeBuilder<void(void), false>::get(Context));
 321   std::vector<const Type*> arg_types;
 322   arg_types.push_back(Type::getInt1Ty(Context));
 323   const FunctionType *FuncTy = FunctionType::get(
 324       Type::getVoidTy(Context), arg_types, false);
 325   Function *Func1 = Function::Create(Func1Ty, Function::ExternalLinkage,
 326                                      "func1", M);
 327   Function *Func2 = Function::Create(FuncTy, Function::InternalLinkage,
 328                                      "func2", M);
 329   Function *Func3 = Function::Create(FuncTy, Function::InternalLinkage,
 330                                      "func3", M);
 331   BasicBlock *Block1 = BasicBlock::Create(Context, "block1", Func1);
 332   BasicBlock *Block2 = BasicBlock::Create(Context, "block2", Func2);
 333   BasicBlock *True2 = BasicBlock::Create(Context, "cond_true", Func2);
 334   BasicBlock *False2 = BasicBlock::Create(Context, "cond_false", Func2);
 335   BasicBlock *Block3 = BasicBlock::Create(Context, "block3", Func3);
 336   BasicBlock *True3 = BasicBlock::Create(Context, "cond_true", Func3);
 337   BasicBlock *False3 = BasicBlock::Create(Context, "cond_false", Func3);
 338
 339   // Make Func1 call Func2(0) and Func3(0).
 340   IRBuilder<> Builder(Block1);
 341   Builder.CreateCall(Func2, ConstantInt::getTrue(Context));
 342   Builder.CreateCall(Func3, ConstantInt::getTrue(Context));
 343   Builder.CreateRetVoid();
 344
 345   // void Func2(bool b) { if (b) { Func3(false); return; } return; }
 346   Builder.SetInsertPoint(Block2);
 347   Builder.CreateCondBr(Func2->arg_begin(), True2, False2);
 348   Builder.SetInsertPoint(True2);
 349   Builder.CreateCall(Func3, ConstantInt::getFalse(Context));
 350   Builder.CreateRetVoid();
 351   Builder.SetInsertPoint(False2);
 352   Builder.CreateRetVoid();
 353
 354   // void Func3(bool b) { if (b) { Func2(false); return; } return; }
 355   Builder.SetInsertPoint(Block3);
 356   Builder.CreateCondBr(Func3->arg_begin(), True3, False3);
 357   Builder.SetInsertPoint(True3);
 358   Builder.CreateCall(Func2, ConstantInt::getFalse(Context));
 359   Builder.CreateRetVoid();
 360   Builder.SetInsertPoint(False3);
 361   Builder.CreateRetVoid();
 362
 363   // Compile the function to native code
 364   void (*F1Ptr)() =
 365      reinterpret_cast<void(*)()>((intptr_t)TheJIT->getPointerToFunction(Func1));
 366
 367   F1Ptr();
 368 }
 369
 370 // Regression test for PR5162.  This used to trigger an AssertingVH inside the
 371 // JIT's Function to stub mapping.
 372 TEST_F(JITTest, NonLazyLeaksNoStubs) {
 373   TheJIT->DisableLazyCompilation(true);
 374
 375   // Create two functions with a single basic block each.
 376   const FunctionType *FuncTy =
 377       cast<FunctionType>(TypeBuilder<int(), false>::get(Context));
 378   Function *Func1 = Function::Create(FuncTy, Function::ExternalLinkage,
 379                                      "func1", M);
 380   Function *Func2 = Function::Create(FuncTy, Function::InternalLinkage,
 381                                      "func2", M);
 382   BasicBlock *Block1 = BasicBlock::Create(Context, "block1", Func1);
 383   BasicBlock *Block2 = BasicBlock::Create(Context, "block2", Func2);
 384
 385   // The first function calls the second and returns the result
 386   IRBuilder<> Builder(Block1);
 387   Value *Result = Builder.CreateCall(Func2);
 388   Builder.CreateRet(Result);
 389
 390   // The second function just returns a constant
 391   Builder.SetInsertPoint(Block2);
 392   Builder.CreateRet(ConstantInt::get(TypeBuilder<int, false>::get(Context),42));
 393
 394   // Compile the function to native code
 395   (void)TheJIT->getPointerToFunction(Func1);
 396
 397   // Free the JIT state for the functions
 398   TheJIT->freeMachineCodeForFunction(Func1);
 399   TheJIT->freeMachineCodeForFunction(Func2);
 400
 401   // Delete the first function (and show that is has no users)
 402   EXPECT_EQ(Func1->getNumUses(), 0u);
 403   Func1->eraseFromParent();
 404
 405   // Delete the second function (and show that it has no users - it had one,
 406   // func1 but that's gone now)
 407   EXPECT_EQ(Func2->getNumUses(), 0u);
 408   Func2->eraseFromParent();
 409 }
 410 #endif
 411
 412 TEST_F(JITTest, ModuleDeletion) {
 413   TheJIT->DisableLazyCompilation(false);
 414   LoadAssembly("define void @main() { "
 415                "  call i32 @computeVal() "
 416                "  ret void "
 417                "} "
 418                " "
 419                "define internal i32 @computeVal()  { "
 420                "  ret i32 0 "
 421                "} ");
 422   Function *func = M->getFunction("main");
 423   TheJIT->getPointerToFunction(func);
 424   TheJIT->deleteModuleProvider(MP);
 425
 426   SmallPtrSet<const void*, 2> FunctionsDeallocated;
 427   for (unsigned i = 0, e = RJMM->deallocateFunctionBodyCalls.size();
 428        i != e; ++i) {
 429     FunctionsDeallocated.insert(RJMM->deallocateFunctionBodyCalls[i].Body);
 430   }
 431   for (unsigned i = 0, e = RJMM->startFunctionBodyCalls.size(); i != e; ++i) {
 432     EXPECT_TRUE(FunctionsDeallocated.count(
 433                   RJMM->startFunctionBodyCalls[i].Result))
 434       << "Function leaked: \n" << RJMM->startFunctionBodyCalls[i].F_dump;
 435   }
 436   EXPECT_EQ(RJMM->startFunctionBodyCalls.size(),
 437             RJMM->deallocateFunctionBodyCalls.size());
 438
 439   SmallPtrSet<const void*, 2> ExceptionTablesDeallocated;
 440   unsigned NumTablesDeallocated = 0;
 441   for (unsigned i = 0, e = RJMM->deallocateExceptionTableCalls.size();
 442        i != e; ++i) {
 443     ExceptionTablesDeallocated.insert(
 444         RJMM->deallocateExceptionTableCalls[i].ET);
 445     if (RJMM->deallocateExceptionTableCalls[i].ET != NULL) {
 446         // If JITEmitDebugInfo is off, we'll "deallocate" NULL, which doesn't
 447         // appear in startExceptionTableCalls.
 448         NumTablesDeallocated++;
 449     }
 450   }
 451   for (unsigned i = 0, e = RJMM->startExceptionTableCalls.size(); i != e; ++i) {
 452     EXPECT_TRUE(ExceptionTablesDeallocated.count(
 453                   RJMM->startExceptionTableCalls[i].Result))
 454       << "Function's exception table leaked: \n"
 455       << RJMM->startExceptionTableCalls[i].F_dump;
 456   }
 457   EXPECT_EQ(RJMM->startExceptionTableCalls.size(),
 458             NumTablesDeallocated);
 459 }
 460
 461 #if !defined(__arm__) && !defined(__powerpc__) && !defined(__ppc__)
 462 typedef int (*FooPtr) ();
 463
 464 TEST_F(JITTest, NoStubs) {
 465   LoadAssembly("define void @bar() {"
 466                "entry: "
 467                "ret void"
 468                "}"
 469                " "
 470                "define i32 @foo() {"
 471                "entry:"
 472                "call void @bar()"
 473                "ret i32 undef"
 474                "}"
 475                " "
 476                "define i32 @main() {"
 477                "entry:"
 478                "%0 = call i32 @foo()"
 479                "call void @bar()"
 480                "ret i32 undef"
 481                "}");
 482   Function *foo = M->getFunction("foo");
 483   uintptr_t tmp = (uintptr_t)(TheJIT->getPointerToFunction(foo));
 484   FooPtr ptr = (FooPtr)(tmp);
 485
 486   (ptr)();
 487
 488   // We should now allocate no more stubs, we have the code to foo
 489   // and the existing stub for bar.
 490   int stubsBefore = RJMM->stubsAllocated;
 491   Function *func = M->getFunction("main");
 492   TheJIT->getPointerToFunction(func);
 493
 494   Function *bar = M->getFunction("bar");
 495   TheJIT->getPointerToFunction(bar);
 496
 497   ASSERT_EQ(stubsBefore, RJMM->stubsAllocated);
 498 }
 499 #endif
 500
 501 // This code is copied from JITEventListenerTest, but it only runs once for all
 502 // the tests in this directory.  Everything seems fine, but that's strange
 503 // behavior.
 504 class JITEnvironment : public testing::Environment {
 505   virtual void SetUp() {
 506     // Required to create a JIT.
 507     InitializeNativeTarget();
 508   }
 509 };
 510 testing::Environment* const jit_env =
 511   testing::AddGlobalTestEnvironment(new JITEnvironment);
 512
 513 }