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), JMM(jmm),
 273     AllocateGVsWithCode(GVsWithCode), isAlreadyCodeGenerating(false) {
 274   setTargetData(TM.getTargetData());
 275
 276   jitstate = new JITState(M);
 277
 278   // Initialize JCE
 279   JCE = createEmitter(*this, JMM, TM);
 280
 281   // Register in global list of all JITs.
 282   AllJits->Add(this);
 283
 284   // Add target data
 285   MutexGuard locked(lock);
 286   FunctionPassManager &PM = jitstate->getPM(locked);
 287   PM.add(new TargetData(*TM.getTargetData()));
 288
 289   // Turn the machine code intermediate representation into bytes in memory that
 290   // may be executed.
 291   if (TM.addPassesToEmitMachineCode(PM, *JCE)) {
 292     report_fatal_error("Target does not support machine code emission!");
 293   }
 294
 295   // Register routine for informing unwinding runtime about new EH frames
 296 #if HAVE_EHTABLE_SUPPORT
 297 #if USE_KEYMGR
 298   struct LibgccObjectInfo* LOI = (struct LibgccObjectInfo*)
 299     _keymgr_get_and_lock_processwide_ptr(KEYMGR_GCC3_DW2_OBJ_LIST);
 300
 301   // The key is created on demand, and libgcc creates it the first time an
 302   // exception occurs. Since we need the key to register frames, we create
 303   // it now.
 304   if (!LOI)
 305     LOI = (LibgccObjectInfo*)calloc(sizeof(struct LibgccObjectInfo), 1);
 306   _keymgr_set_and_unlock_processwide_ptr(KEYMGR_GCC3_DW2_OBJ_LIST, LOI);
 307   InstallExceptionTableRegister(DarwinRegisterFrame);
 308   // Not sure about how to deregister on Darwin.
 309 #else
 310   InstallExceptionTableRegister(__register_frame);
 311   InstallExceptionTableDeregister(__deregister_frame);
 312 #endif // __APPLE__
 313 #endif // HAVE_EHTABLE_SUPPORT
 314
 315   // Initialize passes.
 316   PM.doInitialization();
 317 }
 318
 319 JIT::~JIT() {
 320   // Unregister all exception tables registered by this JIT.
 321   DeregisterAllTables();
 322   // Cleanup.
 323   AllJits->Remove(this);
 324   delete jitstate;
 325   delete JCE;
 326   delete &TM;
 327 }
 328
 329 /// addModule - Add a new Module to the JIT.  If we previously removed the last
 330 /// Module, we need re-initialize jitstate with a valid Module.
 331 void JIT::addModule(Module *M) {
 332   MutexGuard locked(lock);
 333
 334   if (Modules.empty()) {
 335     assert(!jitstate && "jitstate should be NULL if Modules vector is empty!");
 336
 337     jitstate = new JITState(M);
 338
 339     FunctionPassManager &PM = jitstate->getPM(locked);
 340     PM.add(new TargetData(*TM.getTargetData()));
 341
 342     // Turn the machine code intermediate representation into bytes in memory
 343     // that may be executed.
 344     if (TM.addPassesToEmitMachineCode(PM, *JCE)) {
 345       report_fatal_error("Target does not support machine code emission!");
 346     }
 347
 348     // Initialize passes.
 349     PM.doInitialization();
 350   }
 351
 352   ExecutionEngine::addModule(M);
 353 }
 354
 355 /// removeModule - If we are removing the last Module, invalidate the jitstate
 356 /// since the PassManager it contains references a released Module.
 357 bool JIT::removeModule(Module *M) {
 358   bool result = ExecutionEngine::removeModule(M);
 359
 360   MutexGuard locked(lock);
 361
 362   if (jitstate->getModule() == M) {
 363     delete jitstate;
 364     jitstate = 0;
 365   }
 366
 367   if (!jitstate && !Modules.empty()) {
 368     jitstate = new JITState(Modules[0]);
 369
 370     FunctionPassManager &PM = jitstate->getPM(locked);
 371     PM.add(new TargetData(*TM.getTargetData()));
 372
 373     // Turn the machine code intermediate representation into bytes in memory
 374     // that may be executed.
 375     if (TM.addPassesToEmitMachineCode(PM, *JCE)) {
 376       report_fatal_error("Target does not support machine code emission!");
 377     }
 378
 379     // Initialize passes.
 380     PM.doInitialization();
 381   }
 382   return result;
 383 }
 384
 385 /// run - Start execution with the specified function and arguments.
 386 ///
 387 GenericValue JIT::runFunction(Function *F,
 388                               const std::vector<GenericValue> &ArgValues) {
 389   assert(F && "Function *F was null at entry to run()");
 390
 391   void *FPtr = getPointerToFunction(F);
 392   assert(FPtr && "Pointer to fn's code was null after getPointerToFunction");
 393   FunctionType *FTy = F->getFunctionType();
 394   Type *RetTy = FTy->getReturnType();
 395
 396   assert((FTy->getNumParams() == ArgValues.size() ||
 397           (FTy->isVarArg() && FTy->getNumParams() <= ArgValues.size())) &&
 398          "Wrong number of arguments passed into function!");
 399   assert(FTy->getNumParams() == ArgValues.size() &&
 400          "This doesn't support passing arguments through varargs (yet)!");
 401
 402   // Handle some common cases first.  These cases correspond to common `main'
 403   // prototypes.
 404   if (RetTy->isIntegerTy(32) || RetTy->isVoidTy()) {
 405     switch (ArgValues.size()) {
 406     case 3:
 407       if (FTy->getParamType(0)->isIntegerTy(32) &&
 408           FTy->getParamType(1)->isPointerTy() &&
 409           FTy->getParamType(2)->isPointerTy()) {
 410         int (*PF)(int, char **, const char **) =
 411           (int(*)(int, char **, const char **))(intptr_t)FPtr;
 412
 413         // Call the function.
 414         GenericValue rv;
 415         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
 416                                  (char **)GVTOP(ArgValues[1]),
 417                                  (const char **)GVTOP(ArgValues[2])));
 418         return rv;
 419       }
 420       break;
 421     case 2:
 422       if (FTy->getParamType(0)->isIntegerTy(32) &&
 423           FTy->getParamType(1)->isPointerTy()) {
 424         int (*PF)(int, char **) = (int(*)(int, char **))(intptr_t)FPtr;
 425
 426         // Call the function.
 427         GenericValue rv;
 428         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
 429                                  (char **)GVTOP(ArgValues[1])));
 430         return rv;
 431       }
 432       break;
 433     case 1:
 434       if (FTy->getNumParams() == 1 &&
 435           FTy->getParamType(0)->isIntegerTy(32)) {
 436         GenericValue rv;
 437         int (*PF)(int) = (int(*)(int))(intptr_t)FPtr;
 438         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue()));
 439         return rv;
 440       }
 441       break;
 442     }
 443   }
 444
 445   // Handle cases where no arguments are passed first.
 446   if (ArgValues.empty()) {
 447     GenericValue rv;
 448     switch (RetTy->getTypeID()) {
 449     default: llvm_unreachable("Unknown return type for function call!");
 450     case Type::IntegerTyID: {
 451       unsigned BitWidth = cast<IntegerType>(RetTy)->getBitWidth();
 452       if (BitWidth == 1)
 453         rv.IntVal = APInt(BitWidth, ((bool(*)())(intptr_t)FPtr)());
 454       else if (BitWidth <= 8)
 455         rv.IntVal = APInt(BitWidth, ((char(*)())(intptr_t)FPtr)());
 456       else if (BitWidth <= 16)
 457         rv.IntVal = APInt(BitWidth, ((short(*)())(intptr_t)FPtr)());
 458       else if (BitWidth <= 32)
 459         rv.IntVal = APInt(BitWidth, ((int(*)())(intptr_t)FPtr)());
 460       else if (BitWidth <= 64)
 461         rv.IntVal = APInt(BitWidth, ((int64_t(*)())(intptr_t)FPtr)());
 462       else
 463         llvm_unreachable("Integer types > 64 bits not supported");
 464       return rv;
 465     }
 466     case Type::VoidTyID:
 467       rv.IntVal = APInt(32, ((int(*)())(intptr_t)FPtr)());
 468       return rv;
 469     case Type::FloatTyID:
 470       rv.FloatVal = ((float(*)())(intptr_t)FPtr)();
 471       return rv;
 472     case Type::DoubleTyID:
 473       rv.DoubleVal = ((double(*)())(intptr_t)FPtr)();
 474       return rv;
 475     case Type::X86_FP80TyID:
 476     case Type::FP128TyID:
 477     case Type::PPC_FP128TyID:
 478       llvm_unreachable("long double not supported yet");
 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     llvm_unreachable("JIT does not have BB address for address-of-label, was"
 711                      " it eliminated by optimizer?");
 712   }
 713 }
 714
 715 void *JIT::getPointerToNamedFunction(const std::string &Name,
 716                                      bool AbortOnFailure){
 717   if (!isSymbolSearchingDisabled()) {
 718     void *ptr = JMM->getPointerToNamedFunction(Name, false);
 719     if (ptr)
 720       return ptr;
 721   }
 722
 723   /// If a LazyFunctionCreator is installed, use it to get/create the function.
 724   if (LazyFunctionCreator)
 725     if (void *RP = LazyFunctionCreator(Name))
 726       return RP;
 727
 728   if (AbortOnFailure) {
 729     report_fatal_error("Program used external function '"+Name+
 730                       "' which could not be resolved!");
 731   }
 732   return 0;
 733 }
 734
 735
 736 /// getOrEmitGlobalVariable - Return the address of the specified global
 737 /// variable, possibly emitting it to memory if needed.  This is used by the
 738 /// Emitter.
 739 void *JIT::getOrEmitGlobalVariable(const GlobalVariable *GV) {
 740   MutexGuard locked(lock);
 741
 742   void *Ptr = getPointerToGlobalIfAvailable(GV);
 743   if (Ptr) return Ptr;
 744
 745   // If the global is external, just remember the address.
 746   if (GV->isDeclaration() || GV->hasAvailableExternallyLinkage()) {
 747 #if HAVE___DSO_HANDLE
 748     if (GV->getName() == "__dso_handle")
 749       return (void*)&__dso_handle;
 750 #endif
 751     Ptr = sys::DynamicLibrary::SearchForAddressOfSymbol(GV->getName());
 752     if (Ptr == 0) {
 753       report_fatal_error("Could not resolve external global address: "
 754                         +GV->getName());
 755     }
 756     addGlobalMapping(GV, Ptr);
 757   } else {
 758     // If the global hasn't been emitted to memory yet, allocate space and
 759     // emit it into memory.
 760     Ptr = getMemoryForGV(GV);
 761     addGlobalMapping(GV, Ptr);
 762     EmitGlobalVariable(GV);  // Initialize the variable.
 763   }
 764   return Ptr;
 765 }
 766
 767 /// recompileAndRelinkFunction - This method is used to force a function
 768 /// which has already been compiled, to be compiled again, possibly
 769 /// after it has been modified. Then the entry to the old copy is overwritten
 770 /// with a branch to the new copy. If there was no old copy, this acts
 771 /// just like JIT::getPointerToFunction().
 772 ///
 773 void *JIT::recompileAndRelinkFunction(Function *F) {
 774   void *OldAddr = getPointerToGlobalIfAvailable(F);
 775
 776   // If it's not already compiled there is no reason to patch it up.
 777   if (OldAddr == 0) { return getPointerToFunction(F); }
 778
 779   // Delete the old function mapping.
 780   addGlobalMapping(F, 0);
 781
 782   // Recodegen the function
 783   runJITOnFunction(F);
 784
 785   // Update state, forward the old function to the new function.
 786   void *Addr = getPointerToGlobalIfAvailable(F);
 787   assert(Addr && "Code generation didn't add function to GlobalAddress table!");
 788   TJI.replaceMachineCodeForFunction(OldAddr, Addr);
 789   return Addr;
 790 }
 791
 792 /// getMemoryForGV - This method abstracts memory allocation of global
 793 /// variable so that the JIT can allocate thread local variables depending
 794 /// on the target.
 795 ///
 796 char* JIT::getMemoryForGV(const GlobalVariable* GV) {
 797   char *Ptr;
 798
 799   // GlobalVariable's which are not "constant" will cause trouble in a server
 800   // situation. It's returned in the same block of memory as code which may
 801   // not be writable.
 802   if (isGVCompilationDisabled() && !GV->isConstant()) {
 803     report_fatal_error("Compilation of non-internal GlobalValue is disabled!");
 804   }
 805
 806   // Some applications require globals and code to live together, so they may
 807   // be allocated into the same buffer, but in general globals are allocated
 808   // through the memory manager which puts them near the code but not in the
 809   // same buffer.
 810   Type *GlobalType = GV->getType()->getElementType();
 811   size_t S = getTargetData()->getTypeAllocSize(GlobalType);
 812   size_t A = getTargetData()->getPreferredAlignment(GV);
 813   if (GV->isThreadLocal()) {
 814     MutexGuard locked(lock);
 815     Ptr = TJI.allocateThreadLocalMemory(S);
 816   } else if (TJI.allocateSeparateGVMemory()) {
 817     if (A <= 8) {
 818       Ptr = (char*)malloc(S);
 819     } else {
 820       // Allocate S+A bytes of memory, then use an aligned pointer within that
 821       // space.
 822       Ptr = (char*)malloc(S+A);
 823       unsigned MisAligned = ((intptr_t)Ptr & (A-1));
 824       Ptr = Ptr + (MisAligned ? (A-MisAligned) : 0);
 825     }
 826   } else if (AllocateGVsWithCode) {
 827     Ptr = (char*)JCE->allocateSpace(S, A);
 828   } else {
 829     Ptr = (char*)JCE->allocateGlobal(S, A);
 830   }
 831   return Ptr;
 832 }
 833
 834 void JIT::addPendingFunction(Function *F) {
 835   MutexGuard locked(lock);
 836   jitstate->getPendingFunctions(locked).push_back(F);
 837 }
 838
 839
 840 JITEventListener::~JITEventListener() {}