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