lib/ExecutionEngine/JIT/JITEmitter.cpp

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