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