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 *ExecutionEngine::createJIT(Module *M,
 207                                             std::string *ErrorStr,
 208                                             JITMemoryManager *JMM,
 209                                             CodeGenOpt::Level OptLevel,
 210                                             bool GVsWithCode,
 211                                             CodeModel::Model CMM) {
 212   // Use the defaults for extra parameters.  Users can use EngineBuilder to
 213   // set them.
 214   StringRef MArch = "";
 215   StringRef MCPU = "";
 216   SmallVector<std::string, 1> MAttrs;
 217   TargetMachine *TM =
 218           EngineBuilder::selectTarget(M, MArch, MCPU, MAttrs, ErrorStr);
 219   if (!TM || (ErrorStr && ErrorStr->length() > 0)) return 0;
 220   TM->setCodeModel(CMM);
 221
 222   return JIT::createJIT(M, ErrorStr, JMM, OptLevel, GVsWithCode, TM);
 223 }
 224
 225 ExecutionEngine *JIT::createJIT(Module *M,
 226                                 std::string *ErrorStr,
 227                                 JITMemoryManager *JMM,
 228                                 CodeGenOpt::Level OptLevel,
 229                                 bool GVsWithCode,
 230                                 TargetMachine *TM) {
 231   // Try to register the program as a source of symbols to resolve against.
 232   //
 233   // FIXME: Don't do this here.
 234   sys::DynamicLibrary::LoadLibraryPermanently(0, NULL);
 235
 236   // If the target supports JIT code generation, create the JIT.
 237   if (TargetJITInfo *TJ = TM->getJITInfo()) {
 238     return new JIT(M, *TM, *TJ, JMM, OptLevel, GVsWithCode);
 239   } else {
 240     if (ErrorStr)
 241       *ErrorStr = "target does not support JIT code generation";
 242     return 0;
 243   }
 244 }
 245
 246 namespace {
 247 /// This class supports the global getPointerToNamedFunction(), which allows
 248 /// bugpoint or gdb users to search for a function by name without any context.
 249 class JitPool {
 250   SmallPtrSet<JIT*, 1> JITs;  // Optimize for process containing just 1 JIT.
 251   mutable sys::Mutex Lock;
 252 public:
 253   void Add(JIT *jit) {
 254     MutexGuard guard(Lock);
 255     JITs.insert(jit);
 256   }
 257   void Remove(JIT *jit) {
 258     MutexGuard guard(Lock);
 259     JITs.erase(jit);
 260   }
 261   void *getPointerToNamedFunction(const char *Name) const {
 262     MutexGuard guard(Lock);
 263     assert(JITs.size() != 0 && "No Jit registered");
 264     //search function in every instance of JIT
 265     for (SmallPtrSet<JIT*, 1>::const_iterator Jit = JITs.begin(),
 266            end = JITs.end();
 267          Jit != end; ++Jit) {
 268       if (Function *F = (*Jit)->FindFunctionNamed(Name))
 269         return (*Jit)->getPointerToFunction(F);
 270     }
 271     // The function is not available : fallback on the first created (will
 272     // search in symbol of the current program/library)
 273     return (*JITs.begin())->getPointerToNamedFunction(Name);
 274   }
 275 };
 276 ManagedStatic<JitPool> AllJits;
 277 }
 278 extern "C" {
 279   // getPointerToNamedFunction - This function is used as a global wrapper to
 280   // JIT::getPointerToNamedFunction for the purpose of resolving symbols when
 281   // bugpoint is debugging the JIT. In that scenario, we are loading an .so and
 282   // need to resolve function(s) that are being mis-codegenerated, so we need to
 283   // resolve their addresses at runtime, and this is the way to do it.
 284   void *getPointerToNamedFunction(const char *Name) {
 285     return AllJits->getPointerToNamedFunction(Name);
 286   }
 287 }
 288
 289 JIT::JIT(Module *M, TargetMachine &tm, TargetJITInfo &tji,
 290          JITMemoryManager *JMM, CodeGenOpt::Level OptLevel, bool GVsWithCode)
 291   : ExecutionEngine(M), TM(tm), TJI(tji), AllocateGVsWithCode(GVsWithCode),
 292     isAlreadyCodeGenerating(false) {
 293   setTargetData(TM.getTargetData());
 294
 295   jitstate = new JITState(M);
 296
 297   // Initialize JCE
 298   JCE = createEmitter(*this, JMM, TM);
 299
 300   // Register in global list of all JITs.
 301   AllJits->Add(this);
 302
 303   // Add target data
 304   MutexGuard locked(lock);
 305   FunctionPassManager &PM = jitstate->getPM(locked);
 306   PM.add(new TargetData(*TM.getTargetData()));
 307
 308   // Turn the machine code intermediate representation into bytes in memory that
 309   // may be executed.
 310   if (TM.addPassesToEmitMachineCode(PM, *JCE, OptLevel)) {
 311     report_fatal_error("Target does not support machine code emission!");
 312   }
 313
 314   // Register routine for informing unwinding runtime about new EH frames
 315 #if HAVE_EHTABLE_SUPPORT
 316 #if USE_KEYMGR
 317   struct LibgccObjectInfo* LOI = (struct LibgccObjectInfo*)
 318     _keymgr_get_and_lock_processwide_ptr(KEYMGR_GCC3_DW2_OBJ_LIST);
 319
 320   // The key is created on demand, and libgcc creates it the first time an
 321   // exception occurs. Since we need the key to register frames, we create
 322   // it now.
 323   if (!LOI)
 324     LOI = (LibgccObjectInfo*)calloc(sizeof(struct LibgccObjectInfo), 1);
 325   _keymgr_set_and_unlock_processwide_ptr(KEYMGR_GCC3_DW2_OBJ_LIST, LOI);
 326   InstallExceptionTableRegister(DarwinRegisterFrame);
 327   // Not sure about how to deregister on Darwin.
 328 #else
 329   InstallExceptionTableRegister(__register_frame);
 330   InstallExceptionTableDeregister(__deregister_frame);
 331 #endif // __APPLE__
 332 #endif // HAVE_EHTABLE_SUPPORT
 333
 334   // Initialize passes.
 335   PM.doInitialization();
 336 }
 337
 338 JIT::~JIT() {
 339   // Unregister all exception tables registered by this JIT.
 340   DeregisterAllTables();
 341   // Cleanup.
 342   AllJits->Remove(this);
 343   delete jitstate;
 344   delete JCE;
 345   delete &TM;
 346 }
 347
 348 /// addModule - Add a new Module to the JIT.  If we previously removed the last
 349 /// Module, we need re-initialize jitstate with a valid Module.
 350 void JIT::addModule(Module *M) {
 351   MutexGuard locked(lock);
 352
 353   if (Modules.empty()) {
 354     assert(!jitstate && "jitstate should be NULL if Modules vector is empty!");
 355
 356     jitstate = new JITState(M);
 357
 358     FunctionPassManager &PM = jitstate->getPM(locked);
 359     PM.add(new TargetData(*TM.getTargetData()));
 360
 361     // Turn the machine code intermediate representation into bytes in memory
 362     // that may be executed.
 363     if (TM.addPassesToEmitMachineCode(PM, *JCE, CodeGenOpt::Default)) {
 364       report_fatal_error("Target does not support machine code emission!");
 365     }
 366
 367     // Initialize passes.
 368     PM.doInitialization();
 369   }
 370
 371   ExecutionEngine::addModule(M);
 372 }
 373
 374 /// removeModule - If we are removing the last Module, invalidate the jitstate
 375 /// since the PassManager it contains references a released Module.
 376 bool JIT::removeModule(Module *M) {
 377   bool result = ExecutionEngine::removeModule(M);
 378
 379   MutexGuard locked(lock);
 380
 381   if (jitstate->getModule() == M) {
 382     delete jitstate;
 383     jitstate = 0;
 384   }
 385
 386   if (!jitstate && !Modules.empty()) {
 387     jitstate = new JITState(Modules[0]);
 388
 389     FunctionPassManager &PM = jitstate->getPM(locked);
 390     PM.add(new TargetData(*TM.getTargetData()));
 391
 392     // Turn the machine code intermediate representation into bytes in memory
 393     // that may be executed.
 394     if (TM.addPassesToEmitMachineCode(PM, *JCE, CodeGenOpt::Default)) {
 395       report_fatal_error("Target does not support machine code emission!");
 396     }
 397
 398     // Initialize passes.
 399     PM.doInitialization();
 400   }
 401   return result;
 402 }
 403
 404 /// run - Start execution with the specified function and arguments.
 405 ///
 406 GenericValue JIT::runFunction(Function *F,
 407                               const std::vector<GenericValue> &ArgValues) {
 408   assert(F && "Function *F was null at entry to run()");
 409
 410   void *FPtr = getPointerToFunction(F);
 411   assert(FPtr && "Pointer to fn's code was null after getPointerToFunction");
 412   const FunctionType *FTy = F->getFunctionType();
 413   const Type *RetTy = FTy->getReturnType();
 414
 415   assert((FTy->getNumParams() == ArgValues.size() ||
 416           (FTy->isVarArg() && FTy->getNumParams() <= ArgValues.size())) &&
 417          "Wrong number of arguments passed into function!");
 418   assert(FTy->getNumParams() == ArgValues.size() &&
 419          "This doesn't support passing arguments through varargs (yet)!");
 420
 421   // Handle some common cases first.  These cases correspond to common `main'
 422   // prototypes.
 423   if (RetTy->isIntegerTy(32) || RetTy->isVoidTy()) {
 424     switch (ArgValues.size()) {
 425     case 3:
 426       if (FTy->getParamType(0)->isIntegerTy(32) &&
 427           FTy->getParamType(1)->isPointerTy() &&
 428           FTy->getParamType(2)->isPointerTy()) {
 429         int (*PF)(int, char **, const char **) =
 430           (int(*)(int, char **, const char **))(intptr_t)FPtr;
 431
 432         // Call the function.
 433         GenericValue rv;
 434         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
 435                                  (char **)GVTOP(ArgValues[1]),
 436                                  (const char **)GVTOP(ArgValues[2])));
 437         return rv;
 438       }
 439       break;
 440     case 2:
 441       if (FTy->getParamType(0)->isIntegerTy(32) &&
 442           FTy->getParamType(1)->isPointerTy()) {
 443         int (*PF)(int, char **) = (int(*)(int, char **))(intptr_t)FPtr;
 444
 445         // Call the function.
 446         GenericValue rv;
 447         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
 448                                  (char **)GVTOP(ArgValues[1])));
 449         return rv;
 450       }
 451       break;
 452     case 1:
 453       if (FTy->getNumParams() == 1 &&
 454           FTy->getParamType(0)->isIntegerTy(32)) {
 455         GenericValue rv;
 456         int (*PF)(int) = (int(*)(int))(intptr_t)FPtr;
 457         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue()));
 458         return rv;
 459       }
 460       break;
 461     }
 462   }
 463
 464   // Handle cases where no arguments are passed first.
 465   if (ArgValues.empty()) {
 466     GenericValue rv;
 467     switch (RetTy->getTypeID()) {
 468     default: llvm_unreachable("Unknown return type for function call!");
 469     case Type::IntegerTyID: {
 470       unsigned BitWidth = cast<IntegerType>(RetTy)->getBitWidth();
 471       if (BitWidth == 1)
 472         rv.IntVal = APInt(BitWidth, ((bool(*)())(intptr_t)FPtr)());
 473       else if (BitWidth <= 8)
 474         rv.IntVal = APInt(BitWidth, ((char(*)())(intptr_t)FPtr)());
 475       else if (BitWidth <= 16)
 476         rv.IntVal = APInt(BitWidth, ((short(*)())(intptr_t)FPtr)());
 477       else if (BitWidth <= 32)
 478         rv.IntVal = APInt(BitWidth, ((int(*)())(intptr_t)FPtr)());
 479       else if (BitWidth <= 64)
 480         rv.IntVal = APInt(BitWidth, ((int64_t(*)())(intptr_t)FPtr)());
 481       else
 482         llvm_unreachable("Integer types > 64 bits not supported");
 483       return rv;
 484     }
 485     case Type::VoidTyID:
 486       rv.IntVal = APInt(32, ((int(*)())(intptr_t)FPtr)());
 487       return rv;
 488     case Type::FloatTyID:
 489       rv.FloatVal = ((float(*)())(intptr_t)FPtr)();
 490       return rv;
 491     case Type::DoubleTyID:
 492       rv.DoubleVal = ((double(*)())(intptr_t)FPtr)();
 493       return rv;
 494     case Type::X86_FP80TyID:
 495     case Type::FP128TyID:
 496     case Type::PPC_FP128TyID:
 497       llvm_unreachable("long double not supported yet");
 498       return rv;
 499     case Type::PointerTyID:
 500       return PTOGV(((void*(*)())(intptr_t)FPtr)());
 501     }
 502   }
 503
 504   // Okay, this is not one of our quick and easy cases.  Because we don't have a
 505   // full FFI, we have to codegen a nullary stub function that just calls the
 506   // function we are interested in, passing in constants for all of the
 507   // arguments.  Make this function and return.
 508
 509   // First, create the function.
 510   FunctionType *STy=FunctionType::get(RetTy, false);
 511   Function *Stub = Function::Create(STy, Function::InternalLinkage, "",
 512                                     F->getParent());
 513
 514   // Insert a basic block.
 515   BasicBlock *StubBB = BasicBlock::Create(F->getContext(), "", Stub);
 516
 517   // Convert all of the GenericValue arguments over to constants.  Note that we
 518   // currently don't support varargs.
 519   SmallVector<Value*, 8> Args;
 520   for (unsigned i = 0, e = ArgValues.size(); i != e; ++i) {
 521     Constant *C = 0;
 522     const Type *ArgTy = FTy->getParamType(i);
 523     const GenericValue &AV = ArgValues[i];
 524     switch (ArgTy->getTypeID()) {
 525     default: llvm_unreachable("Unknown argument type for function call!");
 526     case Type::IntegerTyID:
 527         C = ConstantInt::get(F->getContext(), AV.IntVal);
 528         break;
 529     case Type::FloatTyID:
 530         C = ConstantFP::get(F->getContext(), APFloat(AV.FloatVal));
 531         break;
 532     case Type::DoubleTyID:
 533         C = ConstantFP::get(F->getContext(), APFloat(AV.DoubleVal));
 534         break;
 535     case Type::PPC_FP128TyID:
 536     case Type::X86_FP80TyID:
 537     case Type::FP128TyID:
 538         C = ConstantFP::get(F->getContext(), APFloat(AV.IntVal));
 539         break;
 540     case Type::PointerTyID:
 541       void *ArgPtr = GVTOP(AV);
 542       if (sizeof(void*) == 4)
 543         C = ConstantInt::get(Type::getInt32Ty(F->getContext()),
 544                              (int)(intptr_t)ArgPtr);
 545       else
 546         C = ConstantInt::get(Type::getInt64Ty(F->getContext()),
 547                              (intptr_t)ArgPtr);
 548       // Cast the integer to pointer
 549       C = ConstantExpr::getIntToPtr(C, ArgTy);
 550       break;
 551     }
 552     Args.push_back(C);
 553   }
 554
 555   CallInst *TheCall = CallInst::Create(F, Args.begin(), Args.end(),
 556                                        "", StubBB);
 557   TheCall->setCallingConv(F->getCallingConv());
 558   TheCall->setTailCall();
 559   if (!TheCall->getType()->isVoidTy())
 560     // Return result of the call.
 561     ReturnInst::Create(F->getContext(), TheCall, StubBB);
 562   else
 563     ReturnInst::Create(F->getContext(), StubBB);           // Just return void.
 564
 565   // Finally, call our nullary stub function.
 566   GenericValue Result = runFunction(Stub, std::vector<GenericValue>());
 567   // Erase it, since no other function can have a reference to it.
 568   Stub->eraseFromParent();
 569   // And return the result.
 570   return Result;
 571 }
 572
 573 void JIT::RegisterJITEventListener(JITEventListener *L) {
 574   if (L == NULL)
 575     return;
 576   MutexGuard locked(lock);
 577   EventListeners.push_back(L);
 578 }
 579 void JIT::UnregisterJITEventListener(JITEventListener *L) {
 580   if (L == NULL)
 581     return;
 582   MutexGuard locked(lock);
 583   std::vector<JITEventListener*>::reverse_iterator I=
 584       std::find(EventListeners.rbegin(), EventListeners.rend(), L);
 585   if (I != EventListeners.rend()) {
 586     std::swap(*I, EventListeners.back());
 587     EventListeners.pop_back();
 588   }
 589 }
 590 void JIT::NotifyFunctionEmitted(
 591     const Function &F,
 592     void *Code, size_t Size,
 593     const JITEvent_EmittedFunctionDetails &Details) {
 594   MutexGuard locked(lock);
 595   for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
 596     EventListeners[I]->NotifyFunctionEmitted(F, Code, Size, Details);
 597   }
 598 }
 599
 600 void JIT::NotifyFreeingMachineCode(void *OldPtr) {
 601   MutexGuard locked(lock);
 602   for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
 603     EventListeners[I]->NotifyFreeingMachineCode(OldPtr);
 604   }
 605 }
 606
 607 /// runJITOnFunction - Run the FunctionPassManager full of
 608 /// just-in-time compilation passes on F, hopefully filling in
 609 /// GlobalAddress[F] with the address of F's machine code.
 610 ///
 611 void JIT::runJITOnFunction(Function *F, MachineCodeInfo *MCI) {
 612   MutexGuard locked(lock);
 613
 614   class MCIListener : public JITEventListener {
 615     MachineCodeInfo *const MCI;
 616    public:
 617     MCIListener(MachineCodeInfo *mci) : MCI(mci) {}
 618     virtual void NotifyFunctionEmitted(const Function &,
 619                                        void *Code, size_t Size,
 620                                        const EmittedFunctionDetails &) {
 621       MCI->setAddress(Code);
 622       MCI->setSize(Size);
 623     }
 624   };
 625   MCIListener MCIL(MCI);
 626   if (MCI)
 627     RegisterJITEventListener(&MCIL);
 628
 629   runJITOnFunctionUnlocked(F, locked);
 630
 631   if (MCI)
 632     UnregisterJITEventListener(&MCIL);
 633 }
 634
 635 void JIT::runJITOnFunctionUnlocked(Function *F, const MutexGuard &locked) {
 636   assert(!isAlreadyCodeGenerating && "Error: Recursive compilation detected!");
 637
 638   jitTheFunction(F, locked);
 639
 640   // If the function referred to another function that had not yet been
 641   // read from bitcode, and we are jitting non-lazily, emit it now.
 642   while (!jitstate->getPendingFunctions(locked).empty()) {
 643     Function *PF = jitstate->getPendingFunctions(locked).back();
 644     jitstate->getPendingFunctions(locked).pop_back();
 645
 646     assert(!PF->hasAvailableExternallyLinkage() &&
 647            "Externally-defined function should not be in pending list.");
 648
 649     jitTheFunction(PF, locked);
 650
 651     // Now that the function has been jitted, ask the JITEmitter to rewrite
 652     // the stub with real address of the function.
 653     updateFunctionStub(PF);
 654   }
 655 }
 656
 657 void JIT::jitTheFunction(Function *F, const MutexGuard &locked) {
 658   isAlreadyCodeGenerating = true;
 659   jitstate->getPM(locked).run(*F);
 660   isAlreadyCodeGenerating = false;
 661
 662   // clear basic block addresses after this function is done
 663   getBasicBlockAddressMap(locked).clear();
 664 }
 665
 666 /// getPointerToFunction - This method is used to get the address of the
 667 /// specified function, compiling it if necessary.
 668 ///
 669 void *JIT::getPointerToFunction(Function *F) {
 670
 671   if (void *Addr = getPointerToGlobalIfAvailable(F))
 672     return Addr;   // Check if function already code gen'd
 673
 674   MutexGuard locked(lock);
 675
 676   // Now that this thread owns the lock, make sure we read in the function if it
 677   // exists in this Module.
 678   std::string ErrorMsg;
 679   if (F->Materialize(&ErrorMsg)) {
 680     report_fatal_error("Error reading function '" + F->getName()+
 681                       "' from bitcode file: " + ErrorMsg);
 682   }
 683
 684   // ... and check if another thread has already code gen'd the function.
 685   if (void *Addr = getPointerToGlobalIfAvailable(F))
 686     return Addr;
 687
 688   if (F->isDeclaration() || F->hasAvailableExternallyLinkage()) {
 689     bool AbortOnFailure = !F->hasExternalWeakLinkage();
 690     void *Addr = getPointerToNamedFunction(F->getName(), AbortOnFailure);
 691     addGlobalMapping(F, Addr);
 692     return Addr;
 693   }
 694
 695   runJITOnFunctionUnlocked(F, locked);
 696
 697   void *Addr = getPointerToGlobalIfAvailable(F);
 698   assert(Addr && "Code generation didn't add function to GlobalAddress table!");
 699   return Addr;
 700 }
 701
 702 void JIT::addPointerToBasicBlock(const BasicBlock *BB, void *Addr) {
 703   MutexGuard locked(lock);
 704
 705   BasicBlockAddressMapTy::iterator I =
 706     getBasicBlockAddressMap(locked).find(BB);
 707   if (I == getBasicBlockAddressMap(locked).end()) {
 708     getBasicBlockAddressMap(locked)[BB] = Addr;
 709   } else {
 710     // ignore repeats: some BBs can be split into few MBBs?
 711   }
 712 }
 713
 714 void JIT::clearPointerToBasicBlock(const BasicBlock *BB) {
 715   MutexGuard locked(lock);
 716   getBasicBlockAddressMap(locked).erase(BB);
 717 }
 718
 719 void *JIT::getPointerToBasicBlock(BasicBlock *BB) {
 720   // make sure it's function is compiled by JIT
 721   (void)getPointerToFunction(BB->getParent());
 722
 723   // resolve basic block address
 724   MutexGuard locked(lock);
 725
 726   BasicBlockAddressMapTy::iterator I =
 727     getBasicBlockAddressMap(locked).find(BB);
 728   if (I != getBasicBlockAddressMap(locked).end()) {
 729     return I->second;
 730   } else {
 731     assert(0 && "JIT does not have BB address for address-of-label, was"
 732            " it eliminated by optimizer?");
 733     return 0;
 734   }
 735 }
 736
 737 /// getOrEmitGlobalVariable - Return the address of the specified global
 738 /// variable, possibly emitting it to memory if needed.  This is used by the
 739 /// Emitter.
 740 void *JIT::getOrEmitGlobalVariable(const GlobalVariable *GV) {
 741   MutexGuard locked(lock);
 742
 743   void *Ptr = getPointerToGlobalIfAvailable(GV);
 744   if (Ptr) return Ptr;
 745
 746   // If the global is external, just remember the address.
 747   if (GV->isDeclaration() || GV->hasAvailableExternallyLinkage()) {
 748 #if HAVE___DSO_HANDLE
 749     if (GV->getName() == "__dso_handle")
 750       return (void*)&__dso_handle;
 751 #endif
 752     Ptr = sys::DynamicLibrary::SearchForAddressOfSymbol(GV->getName());
 753     if (Ptr == 0) {
 754       report_fatal_error("Could not resolve external global address: "
 755                         +GV->getName());
 756     }
 757     addGlobalMapping(GV, Ptr);
 758   } else {
 759     // If the global hasn't been emitted to memory yet, allocate space and
 760     // emit it into memory.
 761     Ptr = getMemoryForGV(GV);
 762     addGlobalMapping(GV, Ptr);
 763     EmitGlobalVariable(GV);  // Initialize the variable.
 764   }
 765   return Ptr;
 766 }
 767
 768 /// recompileAndRelinkFunction - This method is used to force a function
 769 /// which has already been compiled, to be compiled again, possibly
 770 /// after it has been modified. Then the entry to the old copy is overwritten
 771 /// with a branch to the new copy. If there was no old copy, this acts
 772 /// just like JIT::getPointerToFunction().
 773 ///
 774 void *JIT::recompileAndRelinkFunction(Function *F) {
 775   void *OldAddr = getPointerToGlobalIfAvailable(F);
 776
 777   // If it's not already compiled there is no reason to patch it up.
 778   if (OldAddr == 0) { return getPointerToFunction(F); }
 779
 780   // Delete the old function mapping.
 781   addGlobalMapping(F, 0);
 782
 783   // Recodegen the function
 784   runJITOnFunction(F);
 785
 786   // Update state, forward the old function to the new function.
 787   void *Addr = getPointerToGlobalIfAvailable(F);
 788   assert(Addr && "Code generation didn't add function to GlobalAddress table!");
 789   TJI.replaceMachineCodeForFunction(OldAddr, Addr);
 790   return Addr;
 791 }
 792
 793 /// getMemoryForGV - This method abstracts memory allocation of global
 794 /// variable so that the JIT can allocate thread local variables depending
 795 /// on the target.
 796 ///
 797 char* JIT::getMemoryForGV(const GlobalVariable* GV) {
 798   char *Ptr;
 799
 800   // GlobalVariable's which are not "constant" will cause trouble in a server
 801   // situation. It's returned in the same block of memory as code which may
 802   // not be writable.
 803   if (isGVCompilationDisabled() && !GV->isConstant()) {
 804     report_fatal_error("Compilation of non-internal GlobalValue is disabled!");
 805   }
 806
 807   // Some applications require globals and code to live together, so they may
 808   // be allocated into the same buffer, but in general globals are allocated
 809   // through the memory manager which puts them near the code but not in the
 810   // same buffer.
 811   const Type *GlobalType = GV->getType()->getElementType();
 812   size_t S = getTargetData()->getTypeAllocSize(GlobalType);
 813   size_t A = getTargetData()->getPreferredAlignment(GV);
 814   if (GV->isThreadLocal()) {
 815     MutexGuard locked(lock);
 816     Ptr = TJI.allocateThreadLocalMemory(S);
 817   } else if (TJI.allocateSeparateGVMemory()) {
 818     if (A <= 8) {
 819       Ptr = (char*)malloc(S);
 820     } else {
 821       // Allocate S+A bytes of memory, then use an aligned pointer within that
 822       // space.
 823       Ptr = (char*)malloc(S+A);
 824       unsigned MisAligned = ((intptr_t)Ptr & (A-1));
 825       Ptr = Ptr + (MisAligned ? (A-MisAligned) : 0);
 826     }
 827   } else if (AllocateGVsWithCode) {
 828     Ptr = (char*)JCE->allocateSpace(S, A);
 829   } else {
 830     Ptr = (char*)JCE->allocateGlobal(S, A);
 831   }
 832   return Ptr;
 833 }
 834
 835 void JIT::addPendingFunction(Function *F) {
 836   MutexGuard locked(lock);
 837   jitstate->getPendingFunctions(locked).push_back(F);
 838 }
 839
 840
 841 JITEventListener::~JITEventListener() {}