lib/ExecutionEngine/JIT/JIT.cpp

   1 //===-- JIT.cpp - LLVM Just in Time Compiler ------------------------------===//
   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 // This tool implements a just-in-time compiler for LLVM, allowing direct
  11 // execution of LLVM bitcode in an efficient manner.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "JIT.h"
  16 #include "llvm/Constants.h"
  17 #include "llvm/DerivedTypes.h"
  18 #include "llvm/Function.h"
  19 #include "llvm/GlobalVariable.h"
  20 #include "llvm/Instructions.h"
  21 #include "llvm/ADT/SmallPtrSet.h"
  22 #include "llvm/CodeGen/JITCodeEmitter.h"
  23 #include "llvm/CodeGen/MachineCodeInfo.h"
  24 #include "llvm/ExecutionEngine/GenericValue.h"
  25 #include "llvm/ExecutionEngine/JITEventListener.h"
  26 #include "llvm/Target/TargetData.h"
  27 #include "llvm/Target/TargetMachine.h"
  28 #include "llvm/Target/TargetJITInfo.h"
  29 #include "llvm/Support/Dwarf.h"
  30 #include "llvm/Support/ErrorHandling.h"
  31 #include "llvm/Support/ManagedStatic.h"
  32 #include "llvm/Support/MutexGuard.h"
  33 #include "llvm/Support/DynamicLibrary.h"
  34 #include "llvm/Config/config.h"
  35
  36 using namespace llvm;
  37
  38 #ifdef __APPLE__
  39 // Apple gcc defaults to -fuse-cxa-atexit (i.e. calls __cxa_atexit instead
  40 // of atexit). It passes the address of linker generated symbol __dso_handle
  41 // to the function.
  42 // This configuration change happened at version 5330.
  43 # include <AvailabilityMacros.h>
  44 # if defined(MAC_OS_X_VERSION_10_4) && \
  45      ((MAC_OS_X_VERSION_MIN_REQUIRED > MAC_OS_X_VERSION_10_4) || \
  46       (MAC_OS_X_VERSION_MIN_REQUIRED == MAC_OS_X_VERSION_10_4 && \
  47        __APPLE_CC__ >= 5330))
  48 #  ifndef HAVE___DSO_HANDLE
  49 #   define HAVE___DSO_HANDLE 1
  50 #  endif
  51 # endif
  52 #endif
  53
  54 #if HAVE___DSO_HANDLE
  55 extern void *__dso_handle __attribute__ ((__visibility__ ("hidden")));
  56 #endif
  57
  58 namespace {
  59
  60 static struct RegisterJIT {
  61   RegisterJIT() { JIT::Register(); }
  62 } JITRegistrator;
  63
  64 }
  65
  66 extern "C" void LLVMLinkInJIT() {
  67 }
  68
  69 // Determine whether we can register EH tables.
  70 #if (defined(__GNUC__) && !defined(__ARM_EABI__) && \
  71      !defined(__USING_SJLJ_EXCEPTIONS__))
  72 #define HAVE_EHTABLE_SUPPORT 1
  73 #else
  74 #define HAVE_EHTABLE_SUPPORT 0
  75 #endif
  76
  77 #if HAVE_EHTABLE_SUPPORT
  78
  79 // libgcc defines the __register_frame function to dynamically register new
  80 // dwarf frames for exception handling. This functionality is not portable
  81 // across compilers and is only provided by GCC. We use the __register_frame
  82 // function here so that code generated by the JIT cooperates with the unwinding
  83 // runtime of libgcc. When JITting with exception handling enable, LLVM
  84 // generates dwarf frames and registers it to libgcc with __register_frame.
  85 //
  86 // The __register_frame function works with Linux.
  87 //
  88 // Unfortunately, this functionality seems to be in libgcc after the unwinding
  89 // library of libgcc for darwin was written. The code for darwin overwrites the
  90 // value updated by __register_frame with a value fetched with "keymgr".
  91 // "keymgr" is an obsolete functionality, which should be rewritten some day.
  92 // In the meantime, since "keymgr" is on all libgccs shipped with apple-gcc, we
  93 // need a workaround in LLVM which uses the "keymgr" to dynamically modify the
  94 // values of an opaque key, used by libgcc to find dwarf tables.
  95
  96 extern "C" void __register_frame(void*);
  97 extern "C" void __deregister_frame(void*);
  98
  99 #if defined(__APPLE__) && MAC_OS_X_VERSION_MAX_ALLOWED <= 1050
 100 # define USE_KEYMGR 1
 101 #else
 102 # define USE_KEYMGR 0
 103 #endif
 104
 105 #if USE_KEYMGR
 106
 107 namespace {
 108
 109 // LibgccObject - This is the structure defined in libgcc. There is no #include
 110 // provided for this structure, so we also define it here. libgcc calls it
 111 // "struct object". The structure is undocumented in libgcc.
 112 struct LibgccObject {
 113   void *unused1;
 114   void *unused2;
 115   void *unused3;
 116
 117   /// frame - Pointer to the exception table.
 118   void *frame;
 119
 120   /// encoding -  The encoding of the object?
 121   union {
 122     struct {
 123       unsigned long sorted : 1;
 124       unsigned long from_array : 1;
 125       unsigned long mixed_encoding : 1;
 126       unsigned long encoding : 8;
 127       unsigned long count : 21;
 128     } b;
 129     size_t i;
 130   } encoding;
 131
 132   /// fde_end - libgcc defines this field only if some macro is defined. We
 133   /// include this field even if it may not there, to make libgcc happy.
 134   char *fde_end;
 135
 136   /// next - At least we know it's a chained list!
 137   struct LibgccObject *next;
 138 };
 139
 140 // "kemgr" stuff. Apparently, all frame tables are stored there.
 141 extern "C" void _keymgr_set_and_unlock_processwide_ptr(int, void *);
 142 extern "C" void *_keymgr_get_and_lock_processwide_ptr(int);
 143 #define KEYMGR_GCC3_DW2_OBJ_LIST        302     /* Dwarf2 object list  */
 144
 145 /// LibgccObjectInfo - libgcc defines this struct as km_object_info. It
 146 /// probably contains all dwarf tables that are loaded.
 147 struct LibgccObjectInfo {
 148
 149   /// seenObjects - LibgccObjects already parsed by the unwinding runtime.
 150   ///
 151   struct LibgccObject* seenObjects;
 152
 153   /// unseenObjects - LibgccObjects not parsed yet by the unwinding runtime.
 154   ///
 155   struct LibgccObject* unseenObjects;
 156
 157   unsigned unused[2];
 158 };
 159
 160 /// darwin_register_frame - Since __register_frame does not work with darwin's
 161 /// libgcc,we provide our own function, which "tricks" libgcc by modifying the
 162 /// "Dwarf2 object list" key.
 163 void DarwinRegisterFrame(void* FrameBegin) {
 164   // Get the key.
 165   LibgccObjectInfo* LOI = (struct LibgccObjectInfo*)
 166     _keymgr_get_and_lock_processwide_ptr(KEYMGR_GCC3_DW2_OBJ_LIST);
 167   assert(LOI && "This should be preallocated by the runtime");
 168
 169   // Allocate a new LibgccObject to represent this frame. Deallocation of this
 170   // object may be impossible: since darwin code in libgcc was written after
 171   // the ability to dynamically register frames, things may crash if we
 172   // deallocate it.
 173   struct LibgccObject* ob = (struct LibgccObject*)
 174     malloc(sizeof(struct LibgccObject));
 175
 176   // Do like libgcc for the values of the field.
 177   ob->unused1 = (void *)-1;
 178   ob->unused2 = 0;
 179   ob->unused3 = 0;
 180   ob->frame = FrameBegin;
 181   ob->encoding.i = 0;
 182   ob->encoding.b.encoding = llvm::dwarf::DW_EH_PE_omit;
 183
 184   // Put the info on both places, as libgcc uses the first or the second
 185   // field. Note that we rely on having two pointers here. If fde_end was a
 186   // char, things would get complicated.
 187   ob->fde_end = (char*)LOI->unseenObjects;
 188   ob->next = LOI->unseenObjects;
 189
 190   // Update the key's unseenObjects list.
 191   LOI->unseenObjects = ob;
 192
 193   // Finally update the "key". Apparently, libgcc requires it.
 194   _keymgr_set_and_unlock_processwide_ptr(KEYMGR_GCC3_DW2_OBJ_LIST,
 195                                          LOI);
 196
 197 }
 198
 199 }
 200 #endif // __APPLE__
 201 #endif // HAVE_EHTABLE_SUPPORT
 202
 203 /// createJIT - This is the factory method for creating a JIT for the current
 204 /// machine, it does not fall back to the interpreter.  This takes ownership
 205 /// of the module.
 206 ExecutionEngine *JIT::createJIT(Module *M,
 207                                 std::string *ErrorStr,
 208                                 JITMemoryManager *JMM,
 209                                 bool GVsWithCode,
 210                                 TargetMachine *TM) {
 211   // Try to register the program as a source of symbols to resolve against.
 212   //
 213   // FIXME: Don't do this here.
 214   sys::DynamicLibrary::LoadLibraryPermanently(0, NULL);
 215
 216   // If the target supports JIT code generation, create the JIT.
 217   if (TargetJITInfo *TJ = TM->getJITInfo()) {
 218     return new JIT(M, *TM, *TJ, JMM, GVsWithCode);
 219   } else {
 220     if (ErrorStr)
 221       *ErrorStr = "target does not support JIT code generation";
 222     return 0;
 223   }
 224 }
 225
 226 namespace {
 227 /// This class supports the global getPointerToNamedFunction(), which allows
 228 /// bugpoint or gdb users to search for a function by name without any context.
 229 class JitPool {
 230   SmallPtrSet<JIT*, 1> JITs;  // Optimize for process containing just 1 JIT.
 231   mutable sys::Mutex Lock;
 232 public:
 233   void Add(JIT *jit) {
 234     MutexGuard guard(Lock);
 235     JITs.insert(jit);
 236   }
 237   void Remove(JIT *jit) {
 238     MutexGuard guard(Lock);
 239     JITs.erase(jit);
 240   }
 241   void *getPointerToNamedFunction(const char *Name) const {
 242     MutexGuard guard(Lock);
 243     assert(JITs.size() != 0 && "No Jit registered");
 244     //search function in every instance of JIT
 245     for (SmallPtrSet<JIT*, 1>::const_iterator Jit = JITs.begin(),
 246            end = JITs.end();
 247          Jit != end; ++Jit) {
 248       if (Function *F = (*Jit)->FindFunctionNamed(Name))
 249         return (*Jit)->getPointerToFunction(F);
 250     }
 251     // The function is not available : fallback on the first created (will
 252     // search in symbol of the current program/library)
 253     return (*JITs.begin())->getPointerToNamedFunction(Name);
 254   }
 255 };
 256 ManagedStatic<JitPool> AllJits;
 257 }
 258 extern "C" {
 259   // getPointerToNamedFunction - This function is used as a global wrapper to
 260   // JIT::getPointerToNamedFunction for the purpose of resolving symbols when
 261   // bugpoint is debugging the JIT. In that scenario, we are loading an .so and
 262   // need to resolve function(s) that are being mis-codegenerated, so we need to
 263   // resolve their addresses at runtime, and this is the way to do it.
 264   void *getPointerToNamedFunction(const char *Name) {
 265     return AllJits->getPointerToNamedFunction(Name);
 266   }
 267 }
 268
 269 JIT::JIT(Module *M, TargetMachine &tm, TargetJITInfo &tji,
 270          JITMemoryManager *JMM, bool GVsWithCode)
 271   : ExecutionEngine(M), TM(tm), TJI(tji), AllocateGVsWithCode(GVsWithCode),
 272     isAlreadyCodeGenerating(false) {
 273   setTargetData(TM.getTargetData());
 274
 275   jitstate = new JITState(M);
 276
 277   // Initialize JCE
 278   JCE = createEmitter(*this, JMM, TM);
 279
 280   // Register in global list of all JITs.
 281   AllJits->Add(this);
 282
 283   // Add target data
 284   MutexGuard locked(lock);
 285   FunctionPassManager &PM = jitstate->getPM(locked);
 286   PM.add(new TargetData(*TM.getTargetData()));
 287
 288   // Turn the machine code intermediate representation into bytes in memory that
 289   // may be executed.
 290   if (TM.addPassesToEmitMachineCode(PM, *JCE)) {
 291     report_fatal_error("Target does not support machine code emission!");
 292   }
 293
 294   // Register routine for informing unwinding runtime about new EH frames
 295 #if HAVE_EHTABLE_SUPPORT
 296 #if USE_KEYMGR
 297   struct LibgccObjectInfo* LOI = (struct LibgccObjectInfo*)
 298     _keymgr_get_and_lock_processwide_ptr(KEYMGR_GCC3_DW2_OBJ_LIST);
 299
 300   // The key is created on demand, and libgcc creates it the first time an
 301   // exception occurs. Since we need the key to register frames, we create
 302   // it now.
 303   if (!LOI)
 304     LOI = (LibgccObjectInfo*)calloc(sizeof(struct LibgccObjectInfo), 1);
 305   _keymgr_set_and_unlock_processwide_ptr(KEYMGR_GCC3_DW2_OBJ_LIST, LOI);
 306   InstallExceptionTableRegister(DarwinRegisterFrame);
 307   // Not sure about how to deregister on Darwin.
 308 #else
 309   InstallExceptionTableRegister(__register_frame);
 310   InstallExceptionTableDeregister(__deregister_frame);
 311 #endif // __APPLE__
 312 #endif // HAVE_EHTABLE_SUPPORT
 313
 314   // Initialize passes.
 315   PM.doInitialization();
 316 }
 317
 318 JIT::~JIT() {
 319   // Unregister all exception tables registered by this JIT.
 320   DeregisterAllTables();
 321   // Cleanup.
 322   AllJits->Remove(this);
 323   delete jitstate;
 324   delete JCE;
 325   delete &TM;
 326 }
 327
 328 /// addModule - Add a new Module to the JIT.  If we previously removed the last
 329 /// Module, we need re-initialize jitstate with a valid Module.
 330 void JIT::addModule(Module *M) {
 331   MutexGuard locked(lock);
 332
 333   if (Modules.empty()) {
 334     assert(!jitstate && "jitstate should be NULL if Modules vector is empty!");
 335
 336     jitstate = new JITState(M);
 337
 338     FunctionPassManager &PM = jitstate->getPM(locked);
 339     PM.add(new TargetData(*TM.getTargetData()));
 340
 341     // Turn the machine code intermediate representation into bytes in memory
 342     // that may be executed.
 343     if (TM.addPassesToEmitMachineCode(PM, *JCE)) {
 344       report_fatal_error("Target does not support machine code emission!");
 345     }
 346
 347     // Initialize passes.
 348     PM.doInitialization();
 349   }
 350
 351   ExecutionEngine::addModule(M);
 352 }
 353
 354 /// removeModule - If we are removing the last Module, invalidate the jitstate
 355 /// since the PassManager it contains references a released Module.
 356 bool JIT::removeModule(Module *M) {
 357   bool result = ExecutionEngine::removeModule(M);
 358
 359   MutexGuard locked(lock);
 360
 361   if (jitstate->getModule() == M) {
 362     delete jitstate;
 363     jitstate = 0;
 364   }
 365
 366   if (!jitstate && !Modules.empty()) {
 367     jitstate = new JITState(Modules[0]);
 368
 369     FunctionPassManager &PM = jitstate->getPM(locked);
 370     PM.add(new TargetData(*TM.getTargetData()));
 371
 372     // Turn the machine code intermediate representation into bytes in memory
 373     // that may be executed.
 374     if (TM.addPassesToEmitMachineCode(PM, *JCE)) {
 375       report_fatal_error("Target does not support machine code emission!");
 376     }
 377
 378     // Initialize passes.
 379     PM.doInitialization();
 380   }
 381   return result;
 382 }
 383
 384 /// run - Start execution with the specified function and arguments.
 385 ///
 386 GenericValue JIT::runFunction(Function *F,
 387                               const std::vector<GenericValue> &ArgValues) {
 388   assert(F && "Function *F was null at entry to run()");
 389
 390   void *FPtr = getPointerToFunction(F);
 391   assert(FPtr && "Pointer to fn's code was null after getPointerToFunction");
 392   FunctionType *FTy = F->getFunctionType();
 393   Type *RetTy = FTy->getReturnType();
 394
 395   assert((FTy->getNumParams() == ArgValues.size() ||
 396           (FTy->isVarArg() && FTy->getNumParams() <= ArgValues.size())) &&
 397          "Wrong number of arguments passed into function!");
 398   assert(FTy->getNumParams() == ArgValues.size() &&
 399          "This doesn't support passing arguments through varargs (yet)!");
 400
 401   // Handle some common cases first.  These cases correspond to common `main'
 402   // prototypes.
 403   if (RetTy->isIntegerTy(32) || RetTy->isVoidTy()) {
 404     switch (ArgValues.size()) {
 405     case 3:
 406       if (FTy->getParamType(0)->isIntegerTy(32) &&
 407           FTy->getParamType(1)->isPointerTy() &&
 408           FTy->getParamType(2)->isPointerTy()) {
 409         int (*PF)(int, char **, const char **) =
 410           (int(*)(int, char **, const char **))(intptr_t)FPtr;
 411
 412         // Call the function.
 413         GenericValue rv;
 414         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
 415                                  (char **)GVTOP(ArgValues[1]),
 416                                  (const char **)GVTOP(ArgValues[2])));
 417         return rv;
 418       }
 419       break;
 420     case 2:
 421       if (FTy->getParamType(0)->isIntegerTy(32) &&
 422           FTy->getParamType(1)->isPointerTy()) {
 423         int (*PF)(int, char **) = (int(*)(int, char **))(intptr_t)FPtr;
 424
 425         // Call the function.
 426         GenericValue rv;
 427         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
 428                                  (char **)GVTOP(ArgValues[1])));
 429         return rv;
 430       }
 431       break;
 432     case 1:
 433       if (FTy->getNumParams() == 1 &&
 434           FTy->getParamType(0)->isIntegerTy(32)) {
 435         GenericValue rv;
 436         int (*PF)(int) = (int(*)(int))(intptr_t)FPtr;
 437         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue()));
 438         return rv;
 439       }
 440       break;
 441     }
 442   }
 443
 444   // Handle cases where no arguments are passed first.
 445   if (ArgValues.empty()) {
 446     GenericValue rv;
 447     switch (RetTy->getTypeID()) {
 448     default: llvm_unreachable("Unknown return type for function call!");
 449     case Type::IntegerTyID: {
 450       unsigned BitWidth = cast<IntegerType>(RetTy)->getBitWidth();
 451       if (BitWidth == 1)
 452         rv.IntVal = APInt(BitWidth, ((bool(*)())(intptr_t)FPtr)());
 453       else if (BitWidth <= 8)
 454         rv.IntVal = APInt(BitWidth, ((char(*)())(intptr_t)FPtr)());
 455       else if (BitWidth <= 16)
 456         rv.IntVal = APInt(BitWidth, ((short(*)())(intptr_t)FPtr)());
 457       else if (BitWidth <= 32)
 458         rv.IntVal = APInt(BitWidth, ((int(*)())(intptr_t)FPtr)());
 459       else if (BitWidth <= 64)
 460         rv.IntVal = APInt(BitWidth, ((int64_t(*)())(intptr_t)FPtr)());
 461       else
 462         llvm_unreachable("Integer types > 64 bits not supported");
 463       return rv;
 464     }
 465     case Type::VoidTyID:
 466       rv.IntVal = APInt(32, ((int(*)())(intptr_t)FPtr)());
 467       return rv;
 468     case Type::FloatTyID:
 469       rv.FloatVal = ((float(*)())(intptr_t)FPtr)();
 470       return rv;
 471     case Type::DoubleTyID:
 472       rv.DoubleVal = ((double(*)())(intptr_t)FPtr)();
 473       return rv;
 474     case Type::X86_FP80TyID:
 475     case Type::FP128TyID:
 476     case Type::PPC_FP128TyID:
 477       llvm_unreachable("long double not supported yet");
 478       return rv;
 479     case Type::PointerTyID:
 480       return PTOGV(((void*(*)())(intptr_t)FPtr)());
 481     }
 482   }
 483
 484   // Okay, this is not one of our quick and easy cases.  Because we don't have a
 485   // full FFI, we have to codegen a nullary stub function that just calls the
 486   // function we are interested in, passing in constants for all of the
 487   // arguments.  Make this function and return.
 488
 489   // First, create the function.
 490   FunctionType *STy=FunctionType::get(RetTy, false);
 491   Function *Stub = Function::Create(STy, Function::InternalLinkage, "",
 492                                     F->getParent());
 493
 494   // Insert a basic block.
 495   BasicBlock *StubBB = BasicBlock::Create(F->getContext(), "", Stub);
 496
 497   // Convert all of the GenericValue arguments over to constants.  Note that we
 498   // currently don't support varargs.
 499   SmallVector<Value*, 8> Args;
 500   for (unsigned i = 0, e = ArgValues.size(); i != e; ++i) {
 501     Constant *C = 0;
 502     Type *ArgTy = FTy->getParamType(i);
 503     const GenericValue &AV = ArgValues[i];
 504     switch (ArgTy->getTypeID()) {
 505     default: llvm_unreachable("Unknown argument type for function call!");
 506     case Type::IntegerTyID:
 507         C = ConstantInt::get(F->getContext(), AV.IntVal);
 508         break;
 509     case Type::FloatTyID:
 510         C = ConstantFP::get(F->getContext(), APFloat(AV.FloatVal));
 511         break;
 512     case Type::DoubleTyID:
 513         C = ConstantFP::get(F->getContext(), APFloat(AV.DoubleVal));
 514         break;
 515     case Type::PPC_FP128TyID:
 516     case Type::X86_FP80TyID:
 517     case Type::FP128TyID:
 518         C = ConstantFP::get(F->getContext(), APFloat(AV.IntVal));
 519         break;
 520     case Type::PointerTyID:
 521       void *ArgPtr = GVTOP(AV);
 522       if (sizeof(void*) == 4)
 523         C = ConstantInt::get(Type::getInt32Ty(F->getContext()),
 524                              (int)(intptr_t)ArgPtr);
 525       else
 526         C = ConstantInt::get(Type::getInt64Ty(F->getContext()),
 527                              (intptr_t)ArgPtr);
 528       // Cast the integer to pointer
 529       C = ConstantExpr::getIntToPtr(C, ArgTy);
 530       break;
 531     }
 532     Args.push_back(C);
 533   }
 534
 535   CallInst *TheCall = CallInst::Create(F, Args, "", StubBB);
 536   TheCall->setCallingConv(F->getCallingConv());
 537   TheCall->setTailCall();
 538   if (!TheCall->getType()->isVoidTy())
 539     // Return result of the call.
 540     ReturnInst::Create(F->getContext(), TheCall, StubBB);
 541   else
 542     ReturnInst::Create(F->getContext(), StubBB);           // Just return void.
 543
 544   // Finally, call our nullary stub function.
 545   GenericValue Result = runFunction(Stub, std::vector<GenericValue>());
 546   // Erase it, since no other function can have a reference to it.
 547   Stub->eraseFromParent();
 548   // And return the result.
 549   return Result;
 550 }
 551
 552 void JIT::RegisterJITEventListener(JITEventListener *L) {
 553   if (L == NULL)
 554     return;
 555   MutexGuard locked(lock);
 556   EventListeners.push_back(L);
 557 }
 558 void JIT::UnregisterJITEventListener(JITEventListener *L) {
 559   if (L == NULL)
 560     return;
 561   MutexGuard locked(lock);
 562   std::vector<JITEventListener*>::reverse_iterator I=
 563       std::find(EventListeners.rbegin(), EventListeners.rend(), L);
 564   if (I != EventListeners.rend()) {
 565     std::swap(*I, EventListeners.back());
 566     EventListeners.pop_back();
 567   }
 568 }
 569 void JIT::NotifyFunctionEmitted(
 570     const Function &F,
 571     void *Code, size_t Size,
 572     const JITEvent_EmittedFunctionDetails &Details) {
 573   MutexGuard locked(lock);
 574   for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
 575     EventListeners[I]->NotifyFunctionEmitted(F, Code, Size, Details);
 576   }
 577 }
 578
 579 void JIT::NotifyFreeingMachineCode(void *OldPtr) {
 580   MutexGuard locked(lock);
 581   for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
 582     EventListeners[I]->NotifyFreeingMachineCode(OldPtr);
 583   }
 584 }
 585
 586 /// runJITOnFunction - Run the FunctionPassManager full of
 587 /// just-in-time compilation passes on F, hopefully filling in
 588 /// GlobalAddress[F] with the address of F's machine code.
 589 ///
 590 void JIT::runJITOnFunction(Function *F, MachineCodeInfo *MCI) {
 591   MutexGuard locked(lock);
 592
 593   class MCIListener : public JITEventListener {
 594     MachineCodeInfo *const MCI;
 595    public:
 596     MCIListener(MachineCodeInfo *mci) : MCI(mci) {}
 597     virtual void NotifyFunctionEmitted(const Function &,
 598                                        void *Code, size_t Size,
 599                                        const EmittedFunctionDetails &) {
 600       MCI->setAddress(Code);
 601       MCI->setSize(Size);
 602     }
 603   };
 604   MCIListener MCIL(MCI);
 605   if (MCI)
 606     RegisterJITEventListener(&MCIL);
 607
 608   runJITOnFunctionUnlocked(F, locked);
 609
 610   if (MCI)
 611     UnregisterJITEventListener(&MCIL);
 612 }
 613
 614 void JIT::runJITOnFunctionUnlocked(Function *F, const MutexGuard &locked) {
 615   assert(!isAlreadyCodeGenerating && "Error: Recursive compilation detected!");
 616
 617   jitTheFunction(F, locked);
 618
 619   // If the function referred to another function that had not yet been
 620   // read from bitcode, and we are jitting non-lazily, emit it now.
 621   while (!jitstate->getPendingFunctions(locked).empty()) {
 622     Function *PF = jitstate->getPendingFunctions(locked).back();
 623     jitstate->getPendingFunctions(locked).pop_back();
 624
 625     assert(!PF->hasAvailableExternallyLinkage() &&
 626            "Externally-defined function should not be in pending list.");
 627
 628     jitTheFunction(PF, locked);
 629
 630     // Now that the function has been jitted, ask the JITEmitter to rewrite
 631     // the stub with real address of the function.
 632     updateFunctionStub(PF);
 633   }
 634 }
 635
 636 void JIT::jitTheFunction(Function *F, const MutexGuard &locked) {
 637   isAlreadyCodeGenerating = true;
 638   jitstate->getPM(locked).run(*F);
 639   isAlreadyCodeGenerating = false;
 640
 641   // clear basic block addresses after this function is done
 642   getBasicBlockAddressMap(locked).clear();
 643 }
 644
 645 /// getPointerToFunction - This method is used to get the address of the
 646 /// specified function, compiling it if necessary.
 647 ///
 648 void *JIT::getPointerToFunction(Function *F) {
 649
 650   if (void *Addr = getPointerToGlobalIfAvailable(F))
 651     return Addr;   // Check if function already code gen'd
 652
 653   MutexGuard locked(lock);
 654
 655   // Now that this thread owns the lock, make sure we read in the function if it
 656   // exists in this Module.
 657   std::string ErrorMsg;
 658   if (F->Materialize(&ErrorMsg)) {
 659     report_fatal_error("Error reading function '" + F->getName()+
 660                       "' from bitcode file: " + ErrorMsg);
 661   }
 662
 663   // ... and check if another thread has already code gen'd the function.
 664   if (void *Addr = getPointerToGlobalIfAvailable(F))
 665     return Addr;
 666
 667   if (F->isDeclaration() || F->hasAvailableExternallyLinkage()) {
 668     bool AbortOnFailure = !F->hasExternalWeakLinkage();
 669     void *Addr = getPointerToNamedFunction(F->getName(), AbortOnFailure);
 670     addGlobalMapping(F, Addr);
 671     return Addr;
 672   }
 673
 674   runJITOnFunctionUnlocked(F, locked);
 675
 676   void *Addr = getPointerToGlobalIfAvailable(F);
 677   assert(Addr && "Code generation didn't add function to GlobalAddress table!");
 678   return Addr;
 679 }
 680
 681 void JIT::addPointerToBasicBlock(const BasicBlock *BB, void *Addr) {
 682   MutexGuard locked(lock);
 683
 684   BasicBlockAddressMapTy::iterator I =
 685     getBasicBlockAddressMap(locked).find(BB);
 686   if (I == getBasicBlockAddressMap(locked).end()) {
 687     getBasicBlockAddressMap(locked)[BB] = Addr;
 688   } else {
 689     // ignore repeats: some BBs can be split into few MBBs?
 690   }
 691 }
 692
 693 void JIT::clearPointerToBasicBlock(const BasicBlock *BB) {
 694   MutexGuard locked(lock);
 695   getBasicBlockAddressMap(locked).erase(BB);
 696 }
 697
 698 void *JIT::getPointerToBasicBlock(BasicBlock *BB) {
 699   // make sure it's function is compiled by JIT
 700   (void)getPointerToFunction(BB->getParent());
 701
 702   // resolve basic block address
 703   MutexGuard locked(lock);
 704
 705   BasicBlockAddressMapTy::iterator I =
 706     getBasicBlockAddressMap(locked).find(BB);
 707   if (I != getBasicBlockAddressMap(locked).end()) {
 708     return I->second;
 709   } else {
 710     assert(0 && "JIT does not have BB address for address-of-label, was"
 711            " it eliminated by optimizer?");
 712     return 0;
 713   }
 714 }
 715
 716 /// getOrEmitGlobalVariable - Return the address of the specified global
 717 /// variable, possibly emitting it to memory if needed.  This is used by the
 718 /// Emitter.
 719 void *JIT::getOrEmitGlobalVariable(const GlobalVariable *GV) {
 720   MutexGuard locked(lock);
 721
 722   void *Ptr = getPointerToGlobalIfAvailable(GV);
 723   if (Ptr) return Ptr;
 724
 725   // If the global is external, just remember the address.
 726   if (GV->isDeclaration() || GV->hasAvailableExternallyLinkage()) {
 727 #if HAVE___DSO_HANDLE
 728     if (GV->getName() == "__dso_handle")
 729       return (void*)&__dso_handle;
 730 #endif
 731     Ptr = sys::DynamicLibrary::SearchForAddressOfSymbol(GV->getName());
 732     if (Ptr == 0) {
 733       report_fatal_error("Could not resolve external global address: "
 734                         +GV->getName());
 735     }
 736     addGlobalMapping(GV, Ptr);
 737   } else {
 738     // If the global hasn't been emitted to memory yet, allocate space and
 739     // emit it into memory.
 740     Ptr = getMemoryForGV(GV);
 741     addGlobalMapping(GV, Ptr);
 742     EmitGlobalVariable(GV);  // Initialize the variable.
 743   }
 744   return Ptr;
 745 }
 746
 747 /// recompileAndRelinkFunction - This method is used to force a function
 748 /// which has already been compiled, to be compiled again, possibly
 749 /// after it has been modified. Then the entry to the old copy is overwritten
 750 /// with a branch to the new copy. If there was no old copy, this acts
 751 /// just like JIT::getPointerToFunction().
 752 ///
 753 void *JIT::recompileAndRelinkFunction(Function *F) {
 754   void *OldAddr = getPointerToGlobalIfAvailable(F);
 755
 756   // If it's not already compiled there is no reason to patch it up.
 757   if (OldAddr == 0) { return getPointerToFunction(F); }
 758
 759   // Delete the old function mapping.
 760   addGlobalMapping(F, 0);
 761
 762   // Recodegen the function
 763   runJITOnFunction(F);
 764
 765   // Update state, forward the old function to the new function.
 766   void *Addr = getPointerToGlobalIfAvailable(F);
 767   assert(Addr && "Code generation didn't add function to GlobalAddress table!");
 768   TJI.replaceMachineCodeForFunction(OldAddr, Addr);
 769   return Addr;
 770 }
 771
 772 /// getMemoryForGV - This method abstracts memory allocation of global
 773 /// variable so that the JIT can allocate thread local variables depending
 774 /// on the target.
 775 ///
 776 char* JIT::getMemoryForGV(const GlobalVariable* GV) {
 777   char *Ptr;
 778
 779   // GlobalVariable's which are not "constant" will cause trouble in a server
 780   // situation. It's returned in the same block of memory as code which may
 781   // not be writable.
 782   if (isGVCompilationDisabled() && !GV->isConstant()) {
 783     report_fatal_error("Compilation of non-internal GlobalValue is disabled!");
 784   }
 785
 786   // Some applications require globals and code to live together, so they may
 787   // be allocated into the same buffer, but in general globals are allocated
 788   // through the memory manager which puts them near the code but not in the
 789   // same buffer.
 790   Type *GlobalType = GV->getType()->getElementType();
 791   size_t S = getTargetData()->getTypeAllocSize(GlobalType);
 792   size_t A = getTargetData()->getPreferredAlignment(GV);
 793   if (GV->isThreadLocal()) {
 794     MutexGuard locked(lock);
 795     Ptr = TJI.allocateThreadLocalMemory(S);
 796   } else if (TJI.allocateSeparateGVMemory()) {
 797     if (A <= 8) {
 798       Ptr = (char*)malloc(S);
 799     } else {
 800       // Allocate S+A bytes of memory, then use an aligned pointer within that
 801       // space.
 802       Ptr = (char*)malloc(S+A);
 803       unsigned MisAligned = ((intptr_t)Ptr & (A-1));
 804       Ptr = Ptr + (MisAligned ? (A-MisAligned) : 0);
 805     }
 806   } else if (AllocateGVsWithCode) {
 807     Ptr = (char*)JCE->allocateSpace(S, A);
 808   } else {
 809     Ptr = (char*)JCE->allocateGlobal(S, A);
 810   }
 811   return Ptr;
 812 }
 813
 814 void JIT::addPendingFunction(Function *F) {
 815   MutexGuard locked(lock);
 816   jitstate->getPendingFunctions(locked).push_back(F);
 817 }
 818
 819
 820 JITEventListener::~JITEventListener() {}