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