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