lib/ExecutionEngine/JIT/JITEmitter.cpp

   1 //===-- JITEmitter.cpp - Write machine code to executable memory ----------===//
   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 file defines a MachineCodeEmitter object that is used by the JIT to
  11 // write machine code to memory and remember where relocatable values are.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #define DEBUG_TYPE "jit"
  16 #include "JIT.h"
  17 #include "JITDebugRegisterer.h"
  18 #include "JITDwarfEmitter.h"
  19 #include "llvm/ADT/OwningPtr.h"
  20 #include "llvm/Constants.h"
  21 #include "llvm/Module.h"
  22 #include "llvm/DerivedTypes.h"
  23 #include "llvm/CodeGen/JITCodeEmitter.h"
  24 #include "llvm/CodeGen/MachineFunction.h"
  25 #include "llvm/CodeGen/MachineConstantPool.h"
  26 #include "llvm/CodeGen/MachineJumpTableInfo.h"
  27 #include "llvm/CodeGen/MachineModuleInfo.h"
  28 #include "llvm/CodeGen/MachineRelocation.h"
  29 #include "llvm/ExecutionEngine/GenericValue.h"
  30 #include "llvm/ExecutionEngine/JITEventListener.h"
  31 #include "llvm/ExecutionEngine/JITMemoryManager.h"
  32 #include "llvm/CodeGen/MachineCodeInfo.h"
  33 #include "llvm/Target/TargetData.h"
  34 #include "llvm/Target/TargetJITInfo.h"
  35 #include "llvm/Target/TargetMachine.h"
  36 #include "llvm/Target/TargetOptions.h"
  37 #include "llvm/Support/Debug.h"
  38 #include "llvm/Support/ErrorHandling.h"
  39 #include "llvm/Support/MutexGuard.h"
  40 #include "llvm/Support/ValueHandle.h"
  41 #include "llvm/Support/raw_ostream.h"
  42 #include "llvm/System/Disassembler.h"
  43 #include "llvm/System/Memory.h"
  44 #include "llvm/Target/TargetInstrInfo.h"
  45 #include "llvm/ADT/DenseMap.h"
  46 #include "llvm/ADT/SmallPtrSet.h"
  47 #include "llvm/ADT/SmallVector.h"
  48 #include "llvm/ADT/Statistic.h"
  49 #include "llvm/ADT/ValueMap.h"
  50 #include <algorithm>
  51 #ifndef NDEBUG
  52 #include <iomanip>
  53 #endif
  54 using namespace llvm;
  55
  56 STATISTIC(NumBytes, "Number of bytes of machine code compiled");
  57 STATISTIC(NumRelos, "Number of relocations applied");
  58 STATISTIC(NumRetries, "Number of retries with more memory");
  59 static JIT *TheJIT = 0;
  60
  61
  62 //===----------------------------------------------------------------------===//
  63 // JIT lazy compilation code.
  64 //
  65 namespace {
  66   class JITEmitter;
  67   class JITResolverState;
  68
  69   template<typename ValueTy>
  70   struct NoRAUWValueMapConfig : public ValueMapConfig<ValueTy> {
  71     typedef JITResolverState *ExtraData;
  72     static void onRAUW(JITResolverState *, Value *Old, Value *New) {
  73       assert(false && "The JIT doesn't know how to handle a"
  74              " RAUW on a value it has emitted.");
  75     }
  76   };
  77
  78   struct CallSiteValueMapConfig : public NoRAUWValueMapConfig<Function*> {
  79     typedef JITResolverState *ExtraData;
  80     static void onDelete(JITResolverState *JRS, Function *F);
  81   };
  82
  83   class JITResolverState {
  84   public:
  85     typedef ValueMap<Function*, void*, NoRAUWValueMapConfig<Function*> >
  86       FunctionToStubMapTy;
  87     typedef std::map<void*, AssertingVH<Function> > CallSiteToFunctionMapTy;
  88     typedef ValueMap<Function *, SmallPtrSet<void*, 1>,
  89                      CallSiteValueMapConfig> FunctionToCallSitesMapTy;
  90     typedef std::map<AssertingVH<GlobalValue>, void*> GlobalToIndirectSymMapTy;
  91   private:
  92     /// FunctionToStubMap - Keep track of the stub created for a particular
  93     /// function so that we can reuse them if necessary.
  94     FunctionToStubMapTy FunctionToStubMap;
  95
  96     /// CallSiteToFunctionMap - Keep track of the function that each lazy call
  97     /// site corresponds to, and vice versa.
  98     CallSiteToFunctionMapTy CallSiteToFunctionMap;
  99     FunctionToCallSitesMapTy FunctionToCallSitesMap;
 100
 101     /// GlobalToIndirectSymMap - Keep track of the indirect symbol created for a
 102     /// particular GlobalVariable so that we can reuse them if necessary.
 103     GlobalToIndirectSymMapTy GlobalToIndirectSymMap;
 104
 105   public:
 106     JITResolverState() : FunctionToStubMap(this),
 107                          FunctionToCallSitesMap(this) {}
 108
 109     FunctionToStubMapTy& getFunctionToStubMap(const MutexGuard& locked) {
 110       assert(locked.holds(TheJIT->lock));
 111       return FunctionToStubMap;
 112     }
 113
 114     GlobalToIndirectSymMapTy& getGlobalToIndirectSymMap(const MutexGuard& locked) {
 115       assert(locked.holds(TheJIT->lock));
 116       return GlobalToIndirectSymMap;
 117     }
 118
 119     pair<void *, Function *> LookupFunctionFromCallSite(
 120         const MutexGuard &locked, void *CallSite) const {
 121       assert(locked.holds(TheJIT->lock));
 122
 123       // The address given to us for the stub may not be exactly right, it might be
 124       // a little bit after the stub.  As such, use upper_bound to find it.
 125       CallSiteToFunctionMapTy::const_iterator I =
 126         CallSiteToFunctionMap.upper_bound(CallSite);
 127       assert(I != CallSiteToFunctionMap.begin() &&
 128              "This is not a known call site!");
 129       --I;
 130       return *I;
 131     }
 132
 133     void AddCallSite(const MutexGuard &locked, void *CallSite, Function *F) {
 134       assert(locked.holds(TheJIT->lock));
 135
 136       bool Inserted = CallSiteToFunctionMap.insert(
 137           std::make_pair(CallSite, F)).second;
 138       (void)Inserted;
 139       assert(Inserted && "Pair was already in CallSiteToFunctionMap");
 140       FunctionToCallSitesMap[F].insert(CallSite);
 141     }
 142
 143     // Returns the Function of the stub if a stub was erased, or NULL if there
 144     // was no stub.  This function uses the call-site->function map to find a
 145     // relevant function, but asserts that only stubs and not other call sites
 146     // will be passed in.
 147     Function *EraseStub(const MutexGuard &locked, void *Stub) {
 148       CallSiteToFunctionMapTy::iterator C2F_I =
 149         CallSiteToFunctionMap.find(Stub);
 150       if (C2F_I == CallSiteToFunctionMap.end()) {
 151         // Not a stub.
 152         return NULL;
 153       }
 154
 155       Function *const F = C2F_I->second;
 156 #ifndef NDEBUG
 157       void *RealStub = FunctionToStubMap.lookup(F);
 158       assert(RealStub == Stub &&
 159              "Call-site that wasn't a stub pass in to EraseStub");
 160 #endif
 161       FunctionToStubMap.erase(F);
 162       CallSiteToFunctionMap.erase(C2F_I);
 163
 164       // Remove the stub from the function->call-sites map, and remove the whole
 165       // entry from the map if that was the last call site.
 166       FunctionToCallSitesMapTy::iterator F2C_I = FunctionToCallSitesMap.find(F);
 167       assert(F2C_I != FunctionToCallSitesMap.end() &&
 168              "FunctionToCallSitesMap broken");
 169       bool Erased = F2C_I->second.erase(Stub);
 170       (void)Erased;
 171       assert(Erased && "FunctionToCallSitesMap broken");
 172       if (F2C_I->second.empty())
 173         FunctionToCallSitesMap.erase(F2C_I);
 174
 175       return F;
 176     }
 177
 178     void EraseAllCallSites(const MutexGuard &locked, Function *F) {
 179       assert(locked.holds(TheJIT->lock));
 180       EraseAllCallSitesPrelocked(F);
 181     }
 182     void EraseAllCallSitesPrelocked(Function *F) {
 183       FunctionToCallSitesMapTy::iterator F2C = FunctionToCallSitesMap.find(F);
 184       if (F2C == FunctionToCallSitesMap.end())
 185         return;
 186       for (SmallPtrSet<void*, 1>::const_iterator I = F2C->second.begin(),
 187              E = F2C->second.end(); I != E; ++I) {
 188         bool Erased = CallSiteToFunctionMap.erase(*I);
 189         (void)Erased;
 190         assert(Erased && "Missing call site->function mapping");
 191       }
 192       FunctionToCallSitesMap.erase(F2C);
 193     }
 194   };
 195
 196   /// JITResolver - Keep track of, and resolve, call sites for functions that
 197   /// have not yet been compiled.
 198   class JITResolver {
 199     typedef JITResolverState::FunctionToStubMapTy FunctionToStubMapTy;
 200     typedef JITResolverState::CallSiteToFunctionMapTy CallSiteToFunctionMapTy;
 201     typedef JITResolverState::GlobalToIndirectSymMapTy GlobalToIndirectSymMapTy;
 202
 203     /// LazyResolverFn - The target lazy resolver function that we actually
 204     /// rewrite instructions to use.
 205     TargetJITInfo::LazyResolverFn LazyResolverFn;
 206
 207     JITResolverState state;
 208
 209     /// ExternalFnToStubMap - This is the equivalent of FunctionToStubMap for
 210     /// external functions.
 211     std::map<void*, void*> ExternalFnToStubMap;
 212
 213     /// revGOTMap - map addresses to indexes in the GOT
 214     std::map<void*, unsigned> revGOTMap;
 215     unsigned nextGOTIndex;
 216
 217     JITEmitter &JE;
 218
 219     static JITResolver *TheJITResolver;
 220   public:
 221     explicit JITResolver(JIT &jit, JITEmitter &je) : nextGOTIndex(0), JE(je) {
 222       TheJIT = &jit;
 223
 224       LazyResolverFn = jit.getJITInfo().getLazyResolverFunction(JITCompilerFn);
 225       assert(TheJITResolver == 0 && "Multiple JIT resolvers?");
 226       TheJITResolver = this;
 227     }
 228
 229     ~JITResolver() {
 230       TheJITResolver = 0;
 231     }
 232
 233     /// getFunctionStubIfAvailable - This returns a pointer to a function stub
 234     /// if it has already been created.
 235     void *getFunctionStubIfAvailable(Function *F);
 236
 237     /// getFunctionStub - This returns a pointer to a function stub, creating
 238     /// one on demand as needed.  If empty is true, create a function stub
 239     /// pointing at address 0, to be filled in later.
 240     void *getFunctionStub(Function *F);
 241
 242     /// getExternalFunctionStub - Return a stub for the function at the
 243     /// specified address, created lazily on demand.
 244     void *getExternalFunctionStub(void *FnAddr);
 245
 246     /// getGlobalValueIndirectSym - Return an indirect symbol containing the
 247     /// specified GV address.
 248     void *getGlobalValueIndirectSym(GlobalValue *V, void *GVAddress);
 249
 250     void getRelocatableGVs(SmallVectorImpl<GlobalValue*> &GVs,
 251                            SmallVectorImpl<void*> &Ptrs);
 252
 253     GlobalValue *invalidateStub(void *Stub);
 254
 255     /// getGOTIndexForAddress - Return a new or existing index in the GOT for
 256     /// an address.  This function only manages slots, it does not manage the
 257     /// contents of the slots or the memory associated with the GOT.
 258     unsigned getGOTIndexForAddr(void *addr);
 259
 260     /// JITCompilerFn - This function is called to resolve a stub to a compiled
 261     /// address.  If the LLVM Function corresponding to the stub has not yet
 262     /// been compiled, this function compiles it first.
 263     static void *JITCompilerFn(void *Stub);
 264   };
 265
 266   /// JITEmitter - The JIT implementation of the MachineCodeEmitter, which is
 267   /// used to output functions to memory for execution.
 268   class JITEmitter : public JITCodeEmitter {
 269     JITMemoryManager *MemMgr;
 270
 271     // When outputting a function stub in the context of some other function, we
 272     // save BufferBegin/BufferEnd/CurBufferPtr here.
 273     uint8_t *SavedBufferBegin, *SavedBufferEnd, *SavedCurBufferPtr;
 274
 275     // When reattempting to JIT a function after running out of space, we store
 276     // the estimated size of the function we're trying to JIT here, so we can
 277     // ask the memory manager for at least this much space.  When we
 278     // successfully emit the function, we reset this back to zero.
 279     uintptr_t SizeEstimate;
 280
 281     /// Relocations - These are the relocations that the function needs, as
 282     /// emitted.
 283     std::vector<MachineRelocation> Relocations;
 284
 285     /// MBBLocations - This vector is a mapping from MBB ID's to their address.
 286     /// It is filled in by the StartMachineBasicBlock callback and queried by
 287     /// the getMachineBasicBlockAddress callback.
 288     std::vector<uintptr_t> MBBLocations;
 289
 290     /// ConstantPool - The constant pool for the current function.
 291     ///
 292     MachineConstantPool *ConstantPool;
 293
 294     /// ConstantPoolBase - A pointer to the first entry in the constant pool.
 295     ///
 296     void *ConstantPoolBase;
 297
 298     /// ConstPoolAddresses - Addresses of individual constant pool entries.
 299     ///
 300     SmallVector<uintptr_t, 8> ConstPoolAddresses;
 301
 302     /// JumpTable - The jump tables for the current function.
 303     ///
 304     MachineJumpTableInfo *JumpTable;
 305
 306     /// JumpTableBase - A pointer to the first entry in the jump table.
 307     ///
 308     void *JumpTableBase;
 309
 310     /// Resolver - This contains info about the currently resolved functions.
 311     JITResolver Resolver;
 312
 313     /// DE - The dwarf emitter for the jit.
 314     OwningPtr<JITDwarfEmitter> DE;
 315
 316     /// DR - The debug registerer for the jit.
 317     OwningPtr<JITDebugRegisterer> DR;
 318
 319     /// LabelLocations - This vector is a mapping from Label ID's to their
 320     /// address.
 321     std::vector<uintptr_t> LabelLocations;
 322
 323     /// MMI - Machine module info for exception informations
 324     MachineModuleInfo* MMI;
 325
 326     // GVSet - a set to keep track of which globals have been seen
 327     SmallPtrSet<const GlobalVariable*, 8> GVSet;
 328
 329     // CurFn - The llvm function being emitted.  Only valid during
 330     // finishFunction().
 331     const Function *CurFn;
 332
 333     /// Information about emitted code, which is passed to the
 334     /// JITEventListeners.  This is reset in startFunction and used in
 335     /// finishFunction.
 336     JITEvent_EmittedFunctionDetails EmissionDetails;
 337
 338     struct EmittedCode {
 339       void *FunctionBody;  // Beginning of the function's allocation.
 340       void *Code;  // The address the function's code actually starts at.
 341       void *ExceptionTable;
 342       EmittedCode() : FunctionBody(0), Code(0), ExceptionTable(0) {}
 343     };
 344     struct EmittedFunctionConfig : public ValueMapConfig<const Function*> {
 345       typedef JITEmitter *ExtraData;
 346       static void onDelete(JITEmitter *, const Function*);
 347       static void onRAUW(JITEmitter *, const Function*, const Function*);
 348     };
 349     ValueMap<const Function *, EmittedCode,
 350              EmittedFunctionConfig> EmittedFunctions;
 351
 352     // CurFnStubUses - For a given Function, a vector of stubs that it
 353     // references.  This facilitates the JIT detecting that a stub is no
 354     // longer used, so that it may be deallocated.
 355     DenseMap<AssertingVH<const Function>, SmallVector<void*, 1> > CurFnStubUses;
 356
 357     // StubFnRefs - For a given pointer to a stub, a set of Functions which
 358     // reference the stub.  When the count of a stub's references drops to zero,
 359     // the stub is unused.
 360     DenseMap<void *, SmallPtrSet<const Function*, 1> > StubFnRefs;
 361
 362     DebugLocTuple PrevDLT;
 363
 364   public:
 365     JITEmitter(JIT &jit, JITMemoryManager *JMM, TargetMachine &TM)
 366       : SizeEstimate(0), Resolver(jit, *this), MMI(0), CurFn(0),
 367           EmittedFunctions(this) {
 368       MemMgr = JMM ? JMM : JITMemoryManager::CreateDefaultMemManager();
 369       if (jit.getJITInfo().needsGOT()) {
 370         MemMgr->AllocateGOT();
 371         DEBUG(errs() << "JIT is managing a GOT\n");
 372       }
 373
 374       if (DwarfExceptionHandling || JITEmitDebugInfo) {
 375         DE.reset(new JITDwarfEmitter(jit));
 376       }
 377       if (JITEmitDebugInfo) {
 378         DR.reset(new JITDebugRegisterer(TM));
 379       }
 380     }
 381     ~JITEmitter() {
 382       delete MemMgr;
 383     }
 384
 385     /// classof - Methods for support type inquiry through isa, cast, and
 386     /// dyn_cast:
 387     ///
 388     static inline bool classof(const JITEmitter*) { return true; }
 389     static inline bool classof(const MachineCodeEmitter*) { return true; }
 390
 391     JITResolver &getJITResolver() { return Resolver; }
 392
 393     virtual void startFunction(MachineFunction &F);
 394     virtual bool finishFunction(MachineFunction &F);
 395
 396     void emitConstantPool(MachineConstantPool *MCP);
 397     void initJumpTableInfo(MachineJumpTableInfo *MJTI);
 398     void emitJumpTableInfo(MachineJumpTableInfo *MJTI);
 399
 400     virtual void startGVStub(const GlobalValue* GV, unsigned StubSize,
 401                                    unsigned Alignment = 1);
 402     virtual void startGVStub(const GlobalValue* GV, void *Buffer,
 403                              unsigned StubSize);
 404     virtual void* finishGVStub(const GlobalValue *GV);
 405
 406     /// allocateSpace - Reserves space in the current block if any, or
 407     /// allocate a new one of the given size.
 408     virtual void *allocateSpace(uintptr_t Size, unsigned Alignment);
 409
 410     /// allocateGlobal - Allocate memory for a global.  Unlike allocateSpace,
 411     /// this method does not allocate memory in the current output buffer,
 412     /// because a global may live longer than the current function.
 413     virtual void *allocateGlobal(uintptr_t Size, unsigned Alignment);
 414
 415     virtual void addRelocation(const MachineRelocation &MR) {
 416       Relocations.push_back(MR);
 417     }
 418
 419     virtual void StartMachineBasicBlock(MachineBasicBlock *MBB) {
 420       if (MBBLocations.size() <= (unsigned)MBB->getNumber())
 421         MBBLocations.resize((MBB->getNumber()+1)*2);
 422       MBBLocations[MBB->getNumber()] = getCurrentPCValue();
 423       DEBUG(errs() << "JIT: Emitting BB" << MBB->getNumber() << " at ["
 424                    << (void*) getCurrentPCValue() << "]\n");
 425     }
 426
 427     virtual uintptr_t getConstantPoolEntryAddress(unsigned Entry) const;
 428     virtual uintptr_t getJumpTableEntryAddress(unsigned Entry) const;
 429
 430     virtual uintptr_t getMachineBasicBlockAddress(MachineBasicBlock *MBB) const {
 431       assert(MBBLocations.size() > (unsigned)MBB->getNumber() &&
 432              MBBLocations[MBB->getNumber()] && "MBB not emitted!");
 433       return MBBLocations[MBB->getNumber()];
 434     }
 435
 436     /// retryWithMoreMemory - Log a retry and deallocate all memory for the
 437     /// given function.  Increase the minimum allocation size so that we get
 438     /// more memory next time.
 439     void retryWithMoreMemory(MachineFunction &F);
 440
 441     /// deallocateMemForFunction - Deallocate all memory for the specified
 442     /// function body.
 443     void deallocateMemForFunction(const Function *F);
 444
 445     /// AddStubToCurrentFunction - Mark the current function being JIT'd as
 446     /// using the stub at the specified address. Allows
 447     /// deallocateMemForFunction to also remove stubs no longer referenced.
 448     void AddStubToCurrentFunction(void *Stub);
 449
 450     virtual void processDebugLoc(DebugLoc DL, bool BeforePrintingInsn);
 451
 452     virtual void emitLabel(uint64_t LabelID) {
 453       if (LabelLocations.size() <= LabelID)
 454         LabelLocations.resize((LabelID+1)*2);
 455       LabelLocations[LabelID] = getCurrentPCValue();
 456     }
 457
 458     virtual uintptr_t getLabelAddress(uint64_t LabelID) const {
 459       assert(LabelLocations.size() > (unsigned)LabelID &&
 460              LabelLocations[LabelID] && "Label not emitted!");
 461       return LabelLocations[LabelID];
 462     }
 463
 464     virtual void setModuleInfo(MachineModuleInfo* Info) {
 465       MMI = Info;
 466       if (DE.get()) DE->setModuleInfo(Info);
 467     }
 468
 469     void setMemoryExecutable() {
 470       MemMgr->setMemoryExecutable();
 471     }
 472
 473     JITMemoryManager *getMemMgr() const { return MemMgr; }
 474
 475   private:
 476     void *getPointerToGlobal(GlobalValue *GV, void *Reference,
 477                              bool MayNeedFarStub);
 478     void *getPointerToGVIndirectSym(GlobalValue *V, void *Reference);
 479     unsigned addSizeOfGlobal(const GlobalVariable *GV, unsigned Size);
 480     unsigned addSizeOfGlobalsInConstantVal(const Constant *C, unsigned Size);
 481     unsigned addSizeOfGlobalsInInitializer(const Constant *Init, unsigned Size);
 482     unsigned GetSizeOfGlobalsInBytes(MachineFunction &MF);
 483   };
 484 }
 485
 486 JITResolver *JITResolver::TheJITResolver = 0;
 487
 488 void CallSiteValueMapConfig::onDelete(JITResolverState *JRS, Function *F) {
 489   JRS->EraseAllCallSitesPrelocked(F);
 490 }
 491
 492 /// getFunctionStubIfAvailable - This returns a pointer to a function stub
 493 /// if it has already been created.
 494 void *JITResolver::getFunctionStubIfAvailable(Function *F) {
 495   MutexGuard locked(TheJIT->lock);
 496
 497   // If we already have a stub for this function, recycle it.
 498   return state.getFunctionToStubMap(locked).lookup(F);
 499 }
 500
 501 /// getFunctionStub - This returns a pointer to a function stub, creating
 502 /// one on demand as needed.
 503 void *JITResolver::getFunctionStub(Function *F) {
 504   MutexGuard locked(TheJIT->lock);
 505
 506   // If we already have a stub for this function, recycle it.
 507   void *&Stub = state.getFunctionToStubMap(locked)[F];
 508   if (Stub) return Stub;
 509
 510   // Call the lazy resolver function if we are JIT'ing lazily.  Otherwise we
 511   // must resolve the symbol now.
 512   void *Actual = TheJIT->isCompilingLazily()
 513     ? (void *)(intptr_t)LazyResolverFn : (void *)0;
 514
 515   // If this is an external declaration, attempt to resolve the address now
 516   // to place in the stub.
 517   if (F->isDeclaration() && !F->hasNotBeenReadFromBitcode()) {
 518     Actual = TheJIT->getPointerToFunction(F);
 519
 520     // If we resolved the symbol to a null address (eg. a weak external)
 521     // don't emit a stub. Return a null pointer to the application.
 522     if (!Actual) return 0;
 523   }
 524
 525   // Codegen a new stub, calling the lazy resolver or the actual address of the
 526   // external function, if it was resolved.
 527   Stub = TheJIT->getJITInfo().emitFunctionStub(F, Actual, JE);
 528
 529   if (Actual != (void*)(intptr_t)LazyResolverFn) {
 530     // If we are getting the stub for an external function, we really want the
 531     // address of the stub in the GlobalAddressMap for the JIT, not the address
 532     // of the external function.
 533     TheJIT->updateGlobalMapping(F, Stub);
 534   }
 535
 536   DEBUG(errs() << "JIT: Stub emitted at [" << Stub << "] for function '"
 537         << F->getName() << "'\n");
 538
 539   // Finally, keep track of the stub-to-Function mapping so that the
 540   // JITCompilerFn knows which function to compile!
 541   state.AddCallSite(locked, Stub, F);
 542
 543   // If we are JIT'ing non-lazily but need to call a function that does not
 544   // exist yet, add it to the JIT's work list so that we can fill in the stub
 545   // address later.
 546   if (!Actual && !TheJIT->isCompilingLazily())
 547     if (!F->isDeclaration() || F->hasNotBeenReadFromBitcode())
 548       TheJIT->addPendingFunction(F);
 549
 550   return Stub;
 551 }
 552
 553 /// getGlobalValueIndirectSym - Return a lazy pointer containing the specified
 554 /// GV address.
 555 void *JITResolver::getGlobalValueIndirectSym(GlobalValue *GV, void *GVAddress) {
 556   MutexGuard locked(TheJIT->lock);
 557
 558   // If we already have a stub for this global variable, recycle it.
 559   void *&IndirectSym = state.getGlobalToIndirectSymMap(locked)[GV];
 560   if (IndirectSym) return IndirectSym;
 561
 562   // Otherwise, codegen a new indirect symbol.
 563   IndirectSym = TheJIT->getJITInfo().emitGlobalValueIndirectSym(GV, GVAddress,
 564                                                                 JE);
 565
 566   DEBUG(errs() << "JIT: Indirect symbol emitted at [" << IndirectSym
 567         << "] for GV '" << GV->getName() << "'\n");
 568
 569   return IndirectSym;
 570 }
 571
 572 /// getExternalFunctionStub - Return a stub for the function at the
 573 /// specified address, created lazily on demand.
 574 void *JITResolver::getExternalFunctionStub(void *FnAddr) {
 575   // If we already have a stub for this function, recycle it.
 576   void *&Stub = ExternalFnToStubMap[FnAddr];
 577   if (Stub) return Stub;
 578
 579   Stub = TheJIT->getJITInfo().emitFunctionStub(0, FnAddr, JE);
 580
 581   DEBUG(errs() << "JIT: Stub emitted at [" << Stub
 582                << "] for external function at '" << FnAddr << "'\n");
 583   return Stub;
 584 }
 585
 586 unsigned JITResolver::getGOTIndexForAddr(void* addr) {
 587   unsigned idx = revGOTMap[addr];
 588   if (!idx) {
 589     idx = ++nextGOTIndex;
 590     revGOTMap[addr] = idx;
 591     DEBUG(errs() << "JIT: Adding GOT entry " << idx << " for addr ["
 592                  << addr << "]\n");
 593   }
 594   return idx;
 595 }
 596
 597 void JITResolver::getRelocatableGVs(SmallVectorImpl<GlobalValue*> &GVs,
 598                                     SmallVectorImpl<void*> &Ptrs) {
 599   MutexGuard locked(TheJIT->lock);
 600
 601   const FunctionToStubMapTy &FM = state.getFunctionToStubMap(locked);
 602   GlobalToIndirectSymMapTy &GM = state.getGlobalToIndirectSymMap(locked);
 603
 604   for (FunctionToStubMapTy::const_iterator i = FM.begin(), e = FM.end();
 605        i != e; ++i){
 606     Function *F = i->first;
 607     if (F->isDeclaration() && F->hasExternalLinkage()) {
 608       GVs.push_back(i->first);
 609       Ptrs.push_back(i->second);
 610     }
 611   }
 612   for (GlobalToIndirectSymMapTy::iterator i = GM.begin(), e = GM.end();
 613        i != e; ++i) {
 614     GVs.push_back(i->first);
 615     Ptrs.push_back(i->second);
 616   }
 617 }
 618
 619 GlobalValue *JITResolver::invalidateStub(void *Stub) {
 620   MutexGuard locked(TheJIT->lock);
 621
 622   GlobalToIndirectSymMapTy &GM = state.getGlobalToIndirectSymMap(locked);
 623
 624   // Look up the cheap way first, to see if it's a function stub we are
 625   // invalidating.  If so, remove it from both the forward and reverse maps.
 626   if (Function *F = state.EraseStub(locked, Stub)) {
 627     return F;
 628   }
 629
 630   // Otherwise, it might be an indirect symbol stub.  Find it and remove it.
 631   for (GlobalToIndirectSymMapTy::iterator i = GM.begin(), e = GM.end();
 632        i != e; ++i) {
 633     if (i->second != Stub)
 634       continue;
 635     GlobalValue *GV = i->first;
 636     GM.erase(i);
 637     return GV;
 638   }
 639
 640   // Lastly, check to see if it's in the ExternalFnToStubMap.
 641   for (std::map<void *, void *>::iterator i = ExternalFnToStubMap.begin(),
 642        e = ExternalFnToStubMap.end(); i != e; ++i) {
 643     if (i->second != Stub)
 644       continue;
 645     ExternalFnToStubMap.erase(i);
 646     break;
 647   }
 648
 649   return 0;
 650 }
 651
 652 /// JITCompilerFn - This function is called when a lazy compilation stub has
 653 /// been entered.  It looks up which function this stub corresponds to, compiles
 654 /// it if necessary, then returns the resultant function pointer.
 655 void *JITResolver::JITCompilerFn(void *Stub) {
 656   JITResolver &JR = *TheJITResolver;
 657
 658   Function* F = 0;
 659   void* ActualPtr = 0;
 660
 661   {
 662     // Only lock for getting the Function. The call getPointerToFunction made
 663     // in this function might trigger function materializing, which requires
 664     // JIT lock to be unlocked.
 665     MutexGuard locked(TheJIT->lock);
 666
 667     // The address given to us for the stub may not be exactly right, it might
 668     // be a little bit after the stub.  As such, use upper_bound to find it.
 669     pair<void*, Function*> I =
 670       JR.state.LookupFunctionFromCallSite(locked, Stub);
 671     F = I.second;
 672     ActualPtr = I.first;
 673   }
 674
 675   // If we have already code generated the function, just return the address.
 676   void *Result = TheJIT->getPointerToGlobalIfAvailable(F);
 677
 678   if (!Result) {
 679     // Otherwise we don't have it, do lazy compilation now.
 680
 681     // If lazy compilation is disabled, emit a useful error message and abort.
 682     if (!TheJIT->isCompilingLazily()) {
 683       llvm_report_error("LLVM JIT requested to do lazy compilation of function '"
 684                         + F->getName() + "' when lazy compiles are disabled!");
 685     }
 686
 687     DEBUG(errs() << "JIT: Lazily resolving function '" << F->getName()
 688           << "' In stub ptr = " << Stub << " actual ptr = "
 689           << ActualPtr << "\n");
 690
 691     Result = TheJIT->getPointerToFunction(F);
 692   }
 693
 694   // Reacquire the lock to update the GOT map.
 695   MutexGuard locked(TheJIT->lock);
 696
 697   // We might like to remove the call site from the CallSiteToFunction map, but
 698   // we can't do that! Multiple threads could be stuck, waiting to acquire the
 699   // lock above. As soon as the 1st function finishes compiling the function,
 700   // the next one will be released, and needs to be able to find the function it
 701   // needs to call.
 702
 703   // FIXME: We could rewrite all references to this stub if we knew them.
 704
 705   // What we will do is set the compiled function address to map to the
 706   // same GOT entry as the stub so that later clients may update the GOT
 707   // if they see it still using the stub address.
 708   // Note: this is done so the Resolver doesn't have to manage GOT memory
 709   // Do this without allocating map space if the target isn't using a GOT
 710   if(JR.revGOTMap.find(Stub) != JR.revGOTMap.end())
 711     JR.revGOTMap[Result] = JR.revGOTMap[Stub];
 712
 713   return Result;
 714 }
 715
 716 //===----------------------------------------------------------------------===//
 717 // JITEmitter code.
 718 //
 719 void *JITEmitter::getPointerToGlobal(GlobalValue *V, void *Reference,
 720                                      bool MayNeedFarStub) {
 721   if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
 722     return TheJIT->getOrEmitGlobalVariable(GV);
 723
 724   if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
 725     return TheJIT->getPointerToGlobal(GA->resolveAliasedGlobal(false));
 726
 727   // If we have already compiled the function, return a pointer to its body.
 728   Function *F = cast<Function>(V);
 729
 730   void *FnStub = Resolver.getFunctionStubIfAvailable(F);
 731   if (FnStub) {
 732     // Return the function stub if it's already created.  We do this first
 733     // so that we're returning the same address for the function as any
 734     // previous call.
 735     AddStubToCurrentFunction(FnStub);
 736     return FnStub;
 737   }
 738
 739   // Otherwise if we have code, go ahead and return that.
 740   void *ResultPtr = TheJIT->getPointerToGlobalIfAvailable(F);
 741   if (ResultPtr) return ResultPtr;
 742
 743   // If this is an external function pointer, we can force the JIT to
 744   // 'compile' it, which really just adds it to the map.
 745   if (F->isDeclaration() && !F->hasNotBeenReadFromBitcode() &&
 746       !MayNeedFarStub)
 747     return TheJIT->getPointerToFunction(F);
 748
 749   // Otherwise, we have to emit a stub.
 750   void *StubAddr = Resolver.getFunctionStub(F);
 751
 752   // Add the stub to the current function's list of referenced stubs, so we can
 753   // deallocate them if the current function is ever freed.  It's possible to
 754   // return null from getFunctionStub in the case of a weak extern that fails
 755   // to resolve.
 756   if (StubAddr)
 757     AddStubToCurrentFunction(StubAddr);
 758
 759   return StubAddr;
 760 }
 761
 762 void *JITEmitter::getPointerToGVIndirectSym(GlobalValue *V, void *Reference) {
 763   // Make sure GV is emitted first, and create a stub containing the fully
 764   // resolved address.
 765   void *GVAddress = getPointerToGlobal(V, Reference, false);
 766   void *StubAddr = Resolver.getGlobalValueIndirectSym(V, GVAddress);
 767
 768   // Add the stub to the current function's list of referenced stubs, so we can
 769   // deallocate them if the current function is ever freed.
 770   AddStubToCurrentFunction(StubAddr);
 771
 772   return StubAddr;
 773 }
 774
 775 void JITEmitter::AddStubToCurrentFunction(void *StubAddr) {
 776   assert(CurFn && "Stub added to current function, but current function is 0!");
 777
 778   SmallVectorImpl<void*> &StubsUsed = CurFnStubUses[CurFn];
 779   StubsUsed.push_back(StubAddr);
 780
 781   SmallPtrSet<const Function *, 1> &FnRefs = StubFnRefs[StubAddr];
 782   FnRefs.insert(CurFn);
 783 }
 784
 785 void JITEmitter::processDebugLoc(DebugLoc DL, bool BeforePrintingInsn) {
 786   if (!DL.isUnknown()) {
 787     DebugLocTuple CurDLT = EmissionDetails.MF->getDebugLocTuple(DL);
 788
 789     if (BeforePrintingInsn) {
 790       if (CurDLT.Scope != 0 && PrevDLT != CurDLT) {
 791         JITEvent_EmittedFunctionDetails::LineStart NextLine;
 792         NextLine.Address = getCurrentPCValue();
 793         NextLine.Loc = DL;
 794         EmissionDetails.LineStarts.push_back(NextLine);
 795       }
 796
 797       PrevDLT = CurDLT;
 798     }
 799   }
 800 }
 801
 802 static unsigned GetConstantPoolSizeInBytes(MachineConstantPool *MCP,
 803                                            const TargetData *TD) {
 804   const std::vector<MachineConstantPoolEntry> &Constants = MCP->getConstants();
 805   if (Constants.empty()) return 0;
 806
 807   unsigned Size = 0;
 808   for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
 809     MachineConstantPoolEntry CPE = Constants[i];
 810     unsigned AlignMask = CPE.getAlignment() - 1;
 811     Size = (Size + AlignMask) & ~AlignMask;
 812     const Type *Ty = CPE.getType();
 813     Size += TD->getTypeAllocSize(Ty);
 814   }
 815   return Size;
 816 }
 817
 818 static unsigned GetJumpTableSizeInBytes(MachineJumpTableInfo *MJTI) {
 819   const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
 820   if (JT.empty()) return 0;
 821
 822   unsigned NumEntries = 0;
 823   for (unsigned i = 0, e = JT.size(); i != e; ++i)
 824     NumEntries += JT[i].MBBs.size();
 825
 826   unsigned EntrySize = MJTI->getEntrySize();
 827
 828   return NumEntries * EntrySize;
 829 }
 830
 831 static uintptr_t RoundUpToAlign(uintptr_t Size, unsigned Alignment) {
 832   if (Alignment == 0) Alignment = 1;
 833   // Since we do not know where the buffer will be allocated, be pessimistic.
 834   return Size + Alignment;
 835 }
 836
 837 /// addSizeOfGlobal - add the size of the global (plus any alignment padding)
 838 /// into the running total Size.
 839
 840 unsigned JITEmitter::addSizeOfGlobal(const GlobalVariable *GV, unsigned Size) {
 841   const Type *ElTy = GV->getType()->getElementType();
 842   size_t GVSize = (size_t)TheJIT->getTargetData()->getTypeAllocSize(ElTy);
 843   size_t GVAlign =
 844       (size_t)TheJIT->getTargetData()->getPreferredAlignment(GV);
 845   DEBUG(errs() << "JIT: Adding in size " << GVSize << " alignment " << GVAlign);
 846   DEBUG(GV->dump());
 847   // Assume code section ends with worst possible alignment, so first
 848   // variable needs maximal padding.
 849   if (Size==0)
 850     Size = 1;
 851   Size = ((Size+GVAlign-1)/GVAlign)*GVAlign;
 852   Size += GVSize;
 853   return Size;
 854 }
 855
 856 /// addSizeOfGlobalsInConstantVal - find any globals that we haven't seen yet
 857 /// but are referenced from the constant; put them in GVSet and add their
 858 /// size into the running total Size.
 859
 860 unsigned JITEmitter::addSizeOfGlobalsInConstantVal(const Constant *C,
 861                                               unsigned Size) {
 862   // If its undefined, return the garbage.
 863   if (isa<UndefValue>(C))
 864     return Size;
 865
 866   // If the value is a ConstantExpr
 867   if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
 868     Constant *Op0 = CE->getOperand(0);
 869     switch (CE->getOpcode()) {
 870     case Instruction::GetElementPtr:
 871     case Instruction::Trunc:
 872     case Instruction::ZExt:
 873     case Instruction::SExt:
 874     case Instruction::FPTrunc:
 875     case Instruction::FPExt:
 876     case Instruction::UIToFP:
 877     case Instruction::SIToFP:
 878     case Instruction::FPToUI:
 879     case Instruction::FPToSI:
 880     case Instruction::PtrToInt:
 881     case Instruction::IntToPtr:
 882     case Instruction::BitCast: {
 883       Size = addSizeOfGlobalsInConstantVal(Op0, Size);
 884       break;
 885     }
 886     case Instruction::Add:
 887     case Instruction::FAdd:
 888     case Instruction::Sub:
 889     case Instruction::FSub:
 890     case Instruction::Mul:
 891     case Instruction::FMul:
 892     case Instruction::UDiv:
 893     case Instruction::SDiv:
 894     case Instruction::URem:
 895     case Instruction::SRem:
 896     case Instruction::And:
 897     case Instruction::Or:
 898     case Instruction::Xor: {
 899       Size = addSizeOfGlobalsInConstantVal(Op0, Size);
 900       Size = addSizeOfGlobalsInConstantVal(CE->getOperand(1), Size);
 901       break;
 902     }
 903     default: {
 904        std::string msg;
 905        raw_string_ostream Msg(msg);
 906        Msg << "ConstantExpr not handled: " << *CE;
 907        llvm_report_error(Msg.str());
 908     }
 909     }
 910   }
 911
 912   if (C->getType()->getTypeID() == Type::PointerTyID)
 913     if (const GlobalVariable* GV = dyn_cast<GlobalVariable>(C))
 914       if (GVSet.insert(GV))
 915         Size = addSizeOfGlobal(GV, Size);
 916
 917   return Size;
 918 }
 919
 920 /// addSizeOfGLobalsInInitializer - handle any globals that we haven't seen yet
 921 /// but are referenced from the given initializer.
 922
 923 unsigned JITEmitter::addSizeOfGlobalsInInitializer(const Constant *Init,
 924                                               unsigned Size) {
 925   if (!isa<UndefValue>(Init) &&
 926       !isa<ConstantVector>(Init) &&
 927       !isa<ConstantAggregateZero>(Init) &&
 928       !isa<ConstantArray>(Init) &&
 929       !isa<ConstantStruct>(Init) &&
 930       Init->getType()->isFirstClassType())
 931     Size = addSizeOfGlobalsInConstantVal(Init, Size);
 932   return Size;
 933 }
 934
 935 /// GetSizeOfGlobalsInBytes - walk the code for the function, looking for
 936 /// globals; then walk the initializers of those globals looking for more.
 937 /// If their size has not been considered yet, add it into the running total
 938 /// Size.
 939
 940 unsigned JITEmitter::GetSizeOfGlobalsInBytes(MachineFunction &MF) {
 941   unsigned Size = 0;
 942   GVSet.clear();
 943
 944   for (MachineFunction::iterator MBB = MF.begin(), E = MF.end();
 945        MBB != E; ++MBB) {
 946     for (MachineBasicBlock::const_iterator I = MBB->begin(), E = MBB->end();
 947          I != E; ++I) {
 948       const TargetInstrDesc &Desc = I->getDesc();
 949       const MachineInstr &MI = *I;
 950       unsigned NumOps = Desc.getNumOperands();
 951       for (unsigned CurOp = 0; CurOp < NumOps; CurOp++) {
 952         const MachineOperand &MO = MI.getOperand(CurOp);
 953         if (MO.isGlobal()) {
 954           GlobalValue* V = MO.getGlobal();
 955           const GlobalVariable *GV = dyn_cast<const GlobalVariable>(V);
 956           if (!GV)
 957             continue;
 958           // If seen in previous function, it will have an entry here.
 959           if (TheJIT->getPointerToGlobalIfAvailable(GV))
 960             continue;
 961           // If seen earlier in this function, it will have an entry here.
 962           // FIXME: it should be possible to combine these tables, by
 963           // assuming the addresses of the new globals in this module
 964           // start at 0 (or something) and adjusting them after codegen
 965           // complete.  Another possibility is to grab a marker bit in GV.
 966           if (GVSet.insert(GV))
 967             // A variable as yet unseen.  Add in its size.
 968             Size = addSizeOfGlobal(GV, Size);
 969         }
 970       }
 971     }
 972   }
 973   DEBUG(errs() << "JIT: About to look through initializers\n");
 974   // Look for more globals that are referenced only from initializers.
 975   // GVSet.end is computed each time because the set can grow as we go.
 976   for (SmallPtrSet<const GlobalVariable *, 8>::iterator I = GVSet.begin();
 977        I != GVSet.end(); I++) {
 978     const GlobalVariable* GV = *I;
 979     if (GV->hasInitializer())
 980       Size = addSizeOfGlobalsInInitializer(GV->getInitializer(), Size);
 981   }
 982
 983   return Size;
 984 }
 985
 986 void JITEmitter::startFunction(MachineFunction &F) {
 987   DEBUG(errs() << "JIT: Starting CodeGen of Function "
 988         << F.getFunction()->getName() << "\n");
 989
 990   uintptr_t ActualSize = 0;
 991   // Set the memory writable, if it's not already
 992   MemMgr->setMemoryWritable();
 993   if (MemMgr->NeedsExactSize()) {
 994     DEBUG(errs() << "JIT: ExactSize\n");
 995     const TargetInstrInfo* TII = F.getTarget().getInstrInfo();
 996     MachineJumpTableInfo *MJTI = F.getJumpTableInfo();
 997     MachineConstantPool *MCP = F.getConstantPool();
 998
 999     // Ensure the constant pool/jump table info is at least 4-byte aligned.
1000     ActualSize = RoundUpToAlign(ActualSize, 16);
1001
1002     // Add the alignment of the constant pool
1003     ActualSize = RoundUpToAlign(ActualSize, MCP->getConstantPoolAlignment());
1004
1005     // Add the constant pool size
1006     ActualSize += GetConstantPoolSizeInBytes(MCP, TheJIT->getTargetData());
1007
1008     // Add the aligment of the jump table info
1009     ActualSize = RoundUpToAlign(ActualSize, MJTI->getAlignment());
1010
1011     // Add the jump table size
1012     ActualSize += GetJumpTableSizeInBytes(MJTI);
1013
1014     // Add the alignment for the function
1015     ActualSize = RoundUpToAlign(ActualSize,
1016                                 std::max(F.getFunction()->getAlignment(), 8U));
1017
1018     // Add the function size
1019     ActualSize += TII->GetFunctionSizeInBytes(F);
1020
1021     DEBUG(errs() << "JIT: ActualSize before globals " << ActualSize << "\n");
1022     // Add the size of the globals that will be allocated after this function.
1023     // These are all the ones referenced from this function that were not
1024     // previously allocated.
1025     ActualSize += GetSizeOfGlobalsInBytes(F);
1026     DEBUG(errs() << "JIT: ActualSize after globals " << ActualSize << "\n");
1027   } else if (SizeEstimate > 0) {
1028     // SizeEstimate will be non-zero on reallocation attempts.
1029     ActualSize = SizeEstimate;
1030   }
1031
1032   BufferBegin = CurBufferPtr = MemMgr->startFunctionBody(F.getFunction(),
1033                                                          ActualSize);
1034   BufferEnd = BufferBegin+ActualSize;
1035   EmittedFunctions[F.getFunction()].FunctionBody = BufferBegin;
1036
1037   // Ensure the constant pool/jump table info is at least 4-byte aligned.
1038   emitAlignment(16);
1039
1040   emitConstantPool(F.getConstantPool());
1041   initJumpTableInfo(F.getJumpTableInfo());
1042
1043   // About to start emitting the machine code for the function.
1044   emitAlignment(std::max(F.getFunction()->getAlignment(), 8U));
1045   TheJIT->updateGlobalMapping(F.getFunction(), CurBufferPtr);
1046   EmittedFunctions[F.getFunction()].Code = CurBufferPtr;
1047
1048   MBBLocations.clear();
1049
1050   EmissionDetails.MF = &F;
1051   EmissionDetails.LineStarts.clear();
1052 }
1053
1054 bool JITEmitter::finishFunction(MachineFunction &F) {
1055   if (CurBufferPtr == BufferEnd) {
1056     // We must call endFunctionBody before retrying, because
1057     // deallocateMemForFunction requires it.
1058     MemMgr->endFunctionBody(F.getFunction(), BufferBegin, CurBufferPtr);
1059     retryWithMoreMemory(F);
1060     return true;
1061   }
1062
1063   emitJumpTableInfo(F.getJumpTableInfo());
1064
1065   // FnStart is the start of the text, not the start of the constant pool and
1066   // other per-function data.
1067   uint8_t *FnStart =
1068     (uint8_t *)TheJIT->getPointerToGlobalIfAvailable(F.getFunction());
1069
1070   // FnEnd is the end of the function's machine code.
1071   uint8_t *FnEnd = CurBufferPtr;
1072
1073   if (!Relocations.empty()) {
1074     CurFn = F.getFunction();
1075     NumRelos += Relocations.size();
1076
1077     // Resolve the relocations to concrete pointers.
1078     for (unsigned i = 0, e = Relocations.size(); i != e; ++i) {
1079       MachineRelocation &MR = Relocations[i];
1080       void *ResultPtr = 0;
1081       if (!MR.letTargetResolve()) {
1082         if (MR.isExternalSymbol()) {
1083           ResultPtr = TheJIT->getPointerToNamedFunction(MR.getExternalSymbol(),
1084                                                         false);
1085           DEBUG(errs() << "JIT: Map \'" << MR.getExternalSymbol() << "\' to ["
1086                        << ResultPtr << "]\n");
1087
1088           // If the target REALLY wants a stub for this function, emit it now.
1089           if (MR.mayNeedFarStub()) {
1090             ResultPtr = Resolver.getExternalFunctionStub(ResultPtr);
1091           }
1092         } else if (MR.isGlobalValue()) {
1093           ResultPtr = getPointerToGlobal(MR.getGlobalValue(),
1094                                          BufferBegin+MR.getMachineCodeOffset(),
1095                                          MR.mayNeedFarStub());
1096         } else if (MR.isIndirectSymbol()) {
1097           ResultPtr = getPointerToGVIndirectSym(
1098               MR.getGlobalValue(), BufferBegin+MR.getMachineCodeOffset());
1099         } else if (MR.isBasicBlock()) {
1100           ResultPtr = (void*)getMachineBasicBlockAddress(MR.getBasicBlock());
1101         } else if (MR.isConstantPoolIndex()) {
1102           ResultPtr = (void*)getConstantPoolEntryAddress(MR.getConstantPoolIndex());
1103         } else {
1104           assert(MR.isJumpTableIndex());
1105           ResultPtr=(void*)getJumpTableEntryAddress(MR.getJumpTableIndex());
1106         }
1107
1108         MR.setResultPointer(ResultPtr);
1109       }
1110
1111       // if we are managing the GOT and the relocation wants an index,
1112       // give it one
1113       if (MR.isGOTRelative() && MemMgr->isManagingGOT()) {
1114         unsigned idx = Resolver.getGOTIndexForAddr(ResultPtr);
1115         MR.setGOTIndex(idx);
1116         if (((void**)MemMgr->getGOTBase())[idx] != ResultPtr) {
1117           DEBUG(errs() << "JIT: GOT was out of date for " << ResultPtr
1118                        << " pointing at " << ((void**)MemMgr->getGOTBase())[idx]
1119                        << "\n");
1120           ((void**)MemMgr->getGOTBase())[idx] = ResultPtr;
1121         }
1122       }
1123     }
1124
1125     CurFn = 0;
1126     TheJIT->getJITInfo().relocate(BufferBegin, &Relocations[0],
1127                                   Relocations.size(), MemMgr->getGOTBase());
1128   }
1129
1130   // Update the GOT entry for F to point to the new code.
1131   if (MemMgr->isManagingGOT()) {
1132     unsigned idx = Resolver.getGOTIndexForAddr((void*)BufferBegin);
1133     if (((void**)MemMgr->getGOTBase())[idx] != (void*)BufferBegin) {
1134       DEBUG(errs() << "JIT: GOT was out of date for " << (void*)BufferBegin
1135                    << " pointing at " << ((void**)MemMgr->getGOTBase())[idx]
1136                    << "\n");
1137       ((void**)MemMgr->getGOTBase())[idx] = (void*)BufferBegin;
1138     }
1139   }
1140
1141   // CurBufferPtr may have moved beyond FnEnd, due to memory allocation for
1142   // global variables that were referenced in the relocations.
1143   MemMgr->endFunctionBody(F.getFunction(), BufferBegin, CurBufferPtr);
1144
1145   if (CurBufferPtr == BufferEnd) {
1146     retryWithMoreMemory(F);
1147     return true;
1148   } else {
1149     // Now that we've succeeded in emitting the function, reset the
1150     // SizeEstimate back down to zero.
1151     SizeEstimate = 0;
1152   }
1153
1154   BufferBegin = CurBufferPtr = 0;
1155   NumBytes += FnEnd-FnStart;
1156
1157   // Invalidate the icache if necessary.
1158   sys::Memory::InvalidateInstructionCache(FnStart, FnEnd-FnStart);
1159
1160   TheJIT->NotifyFunctionEmitted(*F.getFunction(), FnStart, FnEnd-FnStart,
1161                                 EmissionDetails);
1162
1163   DEBUG(errs() << "JIT: Finished CodeGen of [" << (void*)FnStart
1164         << "] Function: " << F.getFunction()->getName()
1165         << ": " << (FnEnd-FnStart) << " bytes of text, "
1166         << Relocations.size() << " relocations\n");
1167
1168   Relocations.clear();
1169   ConstPoolAddresses.clear();
1170
1171   // Mark code region readable and executable if it's not so already.
1172   MemMgr->setMemoryExecutable();
1173
1174   DEBUG(
1175     if (sys::hasDisassembler()) {
1176       errs() << "JIT: Disassembled code:\n";
1177       errs() << sys::disassembleBuffer(FnStart, FnEnd-FnStart,
1178                                        (uintptr_t)FnStart);
1179     } else {
1180       errs() << "JIT: Binary code:\n";
1181       uint8_t* q = FnStart;
1182       for (int i = 0; q < FnEnd; q += 4, ++i) {
1183         if (i == 4)
1184           i = 0;
1185         if (i == 0)
1186           errs() << "JIT: " << (long)(q - FnStart) << ": ";
1187         bool Done = false;
1188         for (int j = 3; j >= 0; --j) {
1189           if (q + j >= FnEnd)
1190             Done = true;
1191           else
1192             errs() << (unsigned short)q[j];
1193         }
1194         if (Done)
1195           break;
1196         errs() << ' ';
1197         if (i == 3)
1198           errs() << '\n';
1199       }
1200       errs()<< '\n';
1201     }
1202         );
1203
1204   if (DwarfExceptionHandling || JITEmitDebugInfo) {
1205     uintptr_t ActualSize = 0;
1206     SavedBufferBegin = BufferBegin;
1207     SavedBufferEnd = BufferEnd;
1208     SavedCurBufferPtr = CurBufferPtr;
1209
1210     if (MemMgr->NeedsExactSize()) {
1211       ActualSize = DE->GetDwarfTableSizeInBytes(F, *this, FnStart, FnEnd);
1212     }
1213
1214     BufferBegin = CurBufferPtr = MemMgr->startExceptionTable(F.getFunction(),
1215                                                              ActualSize);
1216     BufferEnd = BufferBegin+ActualSize;
1217     EmittedFunctions[F.getFunction()].ExceptionTable = BufferBegin;
1218     uint8_t *EhStart;
1219     uint8_t *FrameRegister = DE->EmitDwarfTable(F, *this, FnStart, FnEnd,
1220                                                 EhStart);
1221     MemMgr->endExceptionTable(F.getFunction(), BufferBegin, CurBufferPtr,
1222                               FrameRegister);
1223     uint8_t *EhEnd = CurBufferPtr;
1224     BufferBegin = SavedBufferBegin;
1225     BufferEnd = SavedBufferEnd;
1226     CurBufferPtr = SavedCurBufferPtr;
1227
1228     if (DwarfExceptionHandling) {
1229       TheJIT->RegisterTable(FrameRegister);
1230     }
1231
1232     if (JITEmitDebugInfo) {
1233       DebugInfo I;
1234       I.FnStart = FnStart;
1235       I.FnEnd = FnEnd;
1236       I.EhStart = EhStart;
1237       I.EhEnd = EhEnd;
1238       DR->RegisterFunction(F.getFunction(), I);
1239     }
1240   }
1241
1242   if (MMI)
1243     MMI->EndFunction();
1244
1245   return false;
1246 }
1247
1248 void JITEmitter::retryWithMoreMemory(MachineFunction &F) {
1249   DEBUG(errs() << "JIT: Ran out of space for native code.  Reattempting.\n");
1250   Relocations.clear();  // Clear the old relocations or we'll reapply them.
1251   ConstPoolAddresses.clear();
1252   ++NumRetries;
1253   deallocateMemForFunction(F.getFunction());
1254   // Try again with at least twice as much free space.
1255   SizeEstimate = (uintptr_t)(2 * (BufferEnd - BufferBegin));
1256 }
1257
1258 /// deallocateMemForFunction - Deallocate all memory for the specified
1259 /// function body.  Also drop any references the function has to stubs.
1260 /// May be called while the Function is being destroyed inside ~Value().
1261 void JITEmitter::deallocateMemForFunction(const Function *F) {
1262   ValueMap<const Function *, EmittedCode, EmittedFunctionConfig>::iterator
1263     Emitted = EmittedFunctions.find(F);
1264   if (Emitted != EmittedFunctions.end()) {
1265     MemMgr->deallocateFunctionBody(Emitted->second.FunctionBody);
1266     MemMgr->deallocateExceptionTable(Emitted->second.ExceptionTable);
1267     TheJIT->NotifyFreeingMachineCode(Emitted->second.Code);
1268
1269     EmittedFunctions.erase(Emitted);
1270   }
1271
1272   // TODO: Do we need to unregister exception handling information from libgcc
1273   // here?
1274
1275   if (JITEmitDebugInfo) {
1276     DR->UnregisterFunction(F);
1277   }
1278
1279   // If the function did not reference any stubs, return.
1280   if (CurFnStubUses.find(F) == CurFnStubUses.end())
1281     return;
1282
1283   // For each referenced stub, erase the reference to this function, and then
1284   // erase the list of referenced stubs.
1285   SmallVectorImpl<void *> &StubList = CurFnStubUses[F];
1286   for (unsigned i = 0, e = StubList.size(); i != e; ++i) {
1287     void *Stub = StubList[i];
1288
1289     // If we already invalidated this stub for this function, continue.
1290     if (StubFnRefs.count(Stub) == 0)
1291       continue;
1292
1293     SmallPtrSet<const Function *, 1> &FnRefs = StubFnRefs[Stub];
1294     FnRefs.erase(F);
1295
1296     // If this function was the last reference to the stub, invalidate the stub
1297     // in the JITResolver.  Were there a memory manager deallocateStub routine,
1298     // we could call that at this point too.
1299     if (FnRefs.empty()) {
1300       DEBUG(errs() << "\nJIT: Invalidated Stub at [" << Stub << "]\n");
1301       StubFnRefs.erase(Stub);
1302
1303       // Invalidate the stub.  If it is a GV stub, update the JIT's global
1304       // mapping for that GV to zero.
1305       GlobalValue *GV = Resolver.invalidateStub(Stub);
1306       if (GV) {
1307         TheJIT->updateGlobalMapping(GV, 0);
1308       }
1309     }
1310   }
1311   CurFnStubUses.erase(F);
1312 }
1313
1314
1315 void* JITEmitter::allocateSpace(uintptr_t Size, unsigned Alignment) {
1316   if (BufferBegin)
1317     return JITCodeEmitter::allocateSpace(Size, Alignment);
1318
1319   // create a new memory block if there is no active one.
1320   // care must be taken so that BufferBegin is invalidated when a
1321   // block is trimmed
1322   BufferBegin = CurBufferPtr = MemMgr->allocateSpace(Size, Alignment);
1323   BufferEnd = BufferBegin+Size;
1324   return CurBufferPtr;
1325 }
1326
1327 void* JITEmitter::allocateGlobal(uintptr_t Size, unsigned Alignment) {
1328   // Delegate this call through the memory manager.
1329   return MemMgr->allocateGlobal(Size, Alignment);
1330 }
1331
1332 void JITEmitter::emitConstantPool(MachineConstantPool *MCP) {
1333   if (TheJIT->getJITInfo().hasCustomConstantPool())
1334     return;
1335
1336   const std::vector<MachineConstantPoolEntry> &Constants = MCP->getConstants();
1337   if (Constants.empty()) return;
1338
1339   unsigned Size = GetConstantPoolSizeInBytes(MCP, TheJIT->getTargetData());
1340   unsigned Align = MCP->getConstantPoolAlignment();
1341   ConstantPoolBase = allocateSpace(Size, Align);
1342   ConstantPool = MCP;
1343
1344   if (ConstantPoolBase == 0) return;  // Buffer overflow.
1345
1346   DEBUG(errs() << "JIT: Emitted constant pool at [" << ConstantPoolBase
1347                << "] (size: " << Size << ", alignment: " << Align << ")\n");
1348
1349   // Initialize the memory for all of the constant pool entries.
1350   unsigned Offset = 0;
1351   for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
1352     MachineConstantPoolEntry CPE = Constants[i];
1353     unsigned AlignMask = CPE.getAlignment() - 1;
1354     Offset = (Offset + AlignMask) & ~AlignMask;
1355
1356     uintptr_t CAddr = (uintptr_t)ConstantPoolBase + Offset;
1357     ConstPoolAddresses.push_back(CAddr);
1358     if (CPE.isMachineConstantPoolEntry()) {
1359       // FIXME: add support to lower machine constant pool values into bytes!
1360       llvm_report_error("Initialize memory with machine specific constant pool"
1361                         "entry has not been implemented!");
1362     }
1363     TheJIT->InitializeMemory(CPE.Val.ConstVal, (void*)CAddr);
1364     DEBUG(errs() << "JIT:   CP" << i << " at [0x";
1365           errs().write_hex(CAddr) << "]\n");
1366
1367     const Type *Ty = CPE.Val.ConstVal->getType();
1368     Offset += TheJIT->getTargetData()->getTypeAllocSize(Ty);
1369   }
1370 }
1371
1372 void JITEmitter::initJumpTableInfo(MachineJumpTableInfo *MJTI) {
1373   if (TheJIT->getJITInfo().hasCustomJumpTables())
1374     return;
1375
1376   const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
1377   if (JT.empty()) return;
1378
1379   unsigned NumEntries = 0;
1380   for (unsigned i = 0, e = JT.size(); i != e; ++i)
1381     NumEntries += JT[i].MBBs.size();
1382
1383   unsigned EntrySize = MJTI->getEntrySize();
1384
1385   // Just allocate space for all the jump tables now.  We will fix up the actual
1386   // MBB entries in the tables after we emit the code for each block, since then
1387   // we will know the final locations of the MBBs in memory.
1388   JumpTable = MJTI;
1389   JumpTableBase = allocateSpace(NumEntries * EntrySize, MJTI->getAlignment());
1390 }
1391
1392 void JITEmitter::emitJumpTableInfo(MachineJumpTableInfo *MJTI) {
1393   if (TheJIT->getJITInfo().hasCustomJumpTables())
1394     return;
1395
1396   const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
1397   if (JT.empty() || JumpTableBase == 0) return;
1398
1399   if (TargetMachine::getRelocationModel() == Reloc::PIC_) {
1400     assert(MJTI->getEntrySize() == 4 && "Cross JIT'ing?");
1401     // For each jump table, place the offset from the beginning of the table
1402     // to the target address.
1403     int *SlotPtr = (int*)JumpTableBase;
1404
1405     for (unsigned i = 0, e = JT.size(); i != e; ++i) {
1406       const std::vector<MachineBasicBlock*> &MBBs = JT[i].MBBs;
1407       // Store the offset of the basic block for this jump table slot in the
1408       // memory we allocated for the jump table in 'initJumpTableInfo'
1409       uintptr_t Base = (uintptr_t)SlotPtr;
1410       for (unsigned mi = 0, me = MBBs.size(); mi != me; ++mi) {
1411         uintptr_t MBBAddr = getMachineBasicBlockAddress(MBBs[mi]);
1412         *SlotPtr++ = TheJIT->getJITInfo().getPICJumpTableEntry(MBBAddr, Base);
1413       }
1414     }
1415   } else {
1416     assert(MJTI->getEntrySize() == sizeof(void*) && "Cross JIT'ing?");
1417
1418     // For each jump table, map each target in the jump table to the address of
1419     // an emitted MachineBasicBlock.
1420     intptr_t *SlotPtr = (intptr_t*)JumpTableBase;
1421
1422     for (unsigned i = 0, e = JT.size(); i != e; ++i) {
1423       const std::vector<MachineBasicBlock*> &MBBs = JT[i].MBBs;
1424       // Store the address of the basic block for this jump table slot in the
1425       // memory we allocated for the jump table in 'initJumpTableInfo'
1426       for (unsigned mi = 0, me = MBBs.size(); mi != me; ++mi)
1427         *SlotPtr++ = getMachineBasicBlockAddress(MBBs[mi]);
1428     }
1429   }
1430 }
1431
1432 void JITEmitter::startGVStub(const GlobalValue* GV, unsigned StubSize,
1433                              unsigned Alignment) {
1434   SavedBufferBegin = BufferBegin;
1435   SavedBufferEnd = BufferEnd;
1436   SavedCurBufferPtr = CurBufferPtr;
1437
1438   BufferBegin = CurBufferPtr = MemMgr->allocateStub(GV, StubSize, Alignment);
1439   BufferEnd = BufferBegin+StubSize+1;
1440 }
1441
1442 void JITEmitter::startGVStub(const GlobalValue* GV, void *Buffer,
1443                              unsigned StubSize) {
1444   SavedBufferBegin = BufferBegin;
1445   SavedBufferEnd = BufferEnd;
1446   SavedCurBufferPtr = CurBufferPtr;
1447
1448   BufferBegin = CurBufferPtr = (uint8_t *)Buffer;
1449   BufferEnd = BufferBegin+StubSize+1;
1450 }
1451
1452 void *JITEmitter::finishGVStub(const GlobalValue* GV) {
1453   NumBytes += getCurrentPCOffset();
1454   std::swap(SavedBufferBegin, BufferBegin);
1455   BufferEnd = SavedBufferEnd;
1456   CurBufferPtr = SavedCurBufferPtr;
1457   return SavedBufferBegin;
1458 }
1459
1460 // getConstantPoolEntryAddress - Return the address of the 'ConstantNum' entry
1461 // in the constant pool that was last emitted with the 'emitConstantPool'
1462 // method.
1463 //
1464 uintptr_t JITEmitter::getConstantPoolEntryAddress(unsigned ConstantNum) const {
1465   assert(ConstantNum < ConstantPool->getConstants().size() &&
1466          "Invalid ConstantPoolIndex!");
1467   return ConstPoolAddresses[ConstantNum];
1468 }
1469
1470 // getJumpTableEntryAddress - Return the address of the JumpTable with index
1471 // 'Index' in the jumpp table that was last initialized with 'initJumpTableInfo'
1472 //
1473 uintptr_t JITEmitter::getJumpTableEntryAddress(unsigned Index) const {
1474   const std::vector<MachineJumpTableEntry> &JT = JumpTable->getJumpTables();
1475   assert(Index < JT.size() && "Invalid jump table index!");
1476
1477   unsigned Offset = 0;
1478   unsigned EntrySize = JumpTable->getEntrySize();
1479
1480   for (unsigned i = 0; i < Index; ++i)
1481     Offset += JT[i].MBBs.size();
1482
1483    Offset *= EntrySize;
1484
1485   return (uintptr_t)((char *)JumpTableBase + Offset);
1486 }
1487
1488 void JITEmitter::EmittedFunctionConfig::onDelete(
1489   JITEmitter *Emitter, const Function *F) {
1490   Emitter->deallocateMemForFunction(F);
1491 }
1492 void JITEmitter::EmittedFunctionConfig::onRAUW(
1493   JITEmitter *, const Function*, const Function*) {
1494   llvm_unreachable("The JIT doesn't know how to handle a"
1495                    " RAUW on a value it has emitted.");
1496 }
1497
1498
1499 //===----------------------------------------------------------------------===//
1500 //  Public interface to this file
1501 //===----------------------------------------------------------------------===//
1502
1503 JITCodeEmitter *JIT::createEmitter(JIT &jit, JITMemoryManager *JMM,
1504                                    TargetMachine &tm) {
1505   return new JITEmitter(jit, JMM, tm);
1506 }
1507
1508 // getPointerToNamedFunction - This function is used as a global wrapper to
1509 // JIT::getPointerToNamedFunction for the purpose of resolving symbols when
1510 // bugpoint is debugging the JIT. In that scenario, we are loading an .so and
1511 // need to resolve function(s) that are being mis-codegenerated, so we need to
1512 // resolve their addresses at runtime, and this is the way to do it.
1513 extern "C" {
1514   void *getPointerToNamedFunction(const char *Name) {
1515     if (Function *F = TheJIT->FindFunctionNamed(Name))
1516       return TheJIT->getPointerToFunction(F);
1517     return TheJIT->getPointerToNamedFunction(Name);
1518   }
1519 }
1520
1521 // getPointerToFunctionOrStub - If the specified function has been
1522 // code-gen'd, return a pointer to the function.  If not, compile it, or use
1523 // a stub to implement lazy compilation if available.
1524 //
1525 void *JIT::getPointerToFunctionOrStub(Function *F) {
1526   // If we have already code generated the function, just return the address.
1527   if (void *Addr = getPointerToGlobalIfAvailable(F))
1528     return Addr;
1529
1530   // Get a stub if the target supports it.
1531   assert(isa<JITEmitter>(JCE) && "Unexpected MCE?");
1532   JITEmitter *JE = cast<JITEmitter>(getCodeEmitter());
1533   return JE->getJITResolver().getFunctionStub(F);
1534 }
1535
1536 void JIT::updateFunctionStub(Function *F) {
1537   // Get the empty stub we generated earlier.
1538   assert(isa<JITEmitter>(JCE) && "Unexpected MCE?");
1539   JITEmitter *JE = cast<JITEmitter>(getCodeEmitter());
1540   void *Stub = JE->getJITResolver().getFunctionStub(F);
1541
1542   // Tell the target jit info to rewrite the stub at the specified address,
1543   // rather than creating a new one.
1544   void *Addr = getPointerToGlobalIfAvailable(F);
1545   getJITInfo().emitFunctionStubAtAddr(F, Addr, Stub, *getCodeEmitter());
1546 }
1547
1548 /// freeMachineCodeForFunction - release machine code memory for given Function.
1549 ///
1550 void JIT::freeMachineCodeForFunction(Function *F) {
1551   // Delete translation for this from the ExecutionEngine, so it will get
1552   // retranslated next time it is used.
1553   updateGlobalMapping(F, 0);
1554
1555   // Free the actual memory for the function body and related stuff.
1556   assert(isa<JITEmitter>(JCE) && "Unexpected MCE?");
1557   cast<JITEmitter>(JCE)->deallocateMemForFunction(F);
1558 }