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