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