1 //===-- JITEmitter.cpp - Write machine code to executable memory ----------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
13 //===----------------------------------------------------------------------===//
15 #define DEBUG_TYPE "jit"
17 #include "JITDwarfEmitter.h"
18 #include "llvm/Constant.h"
19 #include "llvm/Module.h"
20 #include "llvm/Type.h"
21 #include "llvm/CodeGen/MachineCodeEmitter.h"
22 #include "llvm/CodeGen/MachineFunction.h"
23 #include "llvm/CodeGen/MachineConstantPool.h"
24 #include "llvm/CodeGen/MachineJumpTableInfo.h"
25 #include "llvm/CodeGen/MachineModuleInfo.h"
26 #include "llvm/CodeGen/MachineRelocation.h"
27 #include "llvm/ExecutionEngine/JITMemoryManager.h"
28 #include "llvm/Target/TargetData.h"
29 #include "llvm/Target/TargetJITInfo.h"
30 #include "llvm/Target/TargetMachine.h"
31 #include "llvm/Target/TargetOptions.h"
32 #include "llvm/Support/Debug.h"
33 #include "llvm/Support/MutexGuard.h"
34 #include "llvm/System/Disassembler.h"
35 #include "llvm/ADT/Statistic.h"
39 STATISTIC(NumBytes, "Number of bytes of machine code compiled");
40 STATISTIC(NumRelos, "Number of relocations applied");
41 static JIT *TheJIT = 0;
44 //===----------------------------------------------------------------------===//
45 // JIT lazy compilation code.
48 class JITResolverState {
50 /// FunctionToStubMap - Keep track of the stub created for a particular
51 /// function so that we can reuse them if necessary.
52 std::map<Function*, void*> FunctionToStubMap;
54 /// StubToFunctionMap - Keep track of the function that each stub
56 std::map<void*, Function*> StubToFunctionMap;
58 /// GlobalToLazyPtrMap - Keep track of the lazy pointer created for a
59 /// particular GlobalVariable so that we can reuse them if necessary.
60 std::map<GlobalValue*, void*> GlobalToLazyPtrMap;
63 std::map<Function*, void*>& getFunctionToStubMap(const MutexGuard& locked) {
64 assert(locked.holds(TheJIT->lock));
65 return FunctionToStubMap;
68 std::map<void*, Function*>& getStubToFunctionMap(const MutexGuard& locked) {
69 assert(locked.holds(TheJIT->lock));
70 return StubToFunctionMap;
73 std::map<GlobalValue*, void*>&
74 getGlobalToLazyPtrMap(const MutexGuard& locked) {
75 assert(locked.holds(TheJIT->lock));
76 return GlobalToLazyPtrMap;
80 /// JITResolver - Keep track of, and resolve, call sites for functions that
81 /// have not yet been compiled.
83 /// LazyResolverFn - The target lazy resolver function that we actually
84 /// rewrite instructions to use.
85 TargetJITInfo::LazyResolverFn LazyResolverFn;
87 JITResolverState state;
89 /// ExternalFnToStubMap - This is the equivalent of FunctionToStubMap for
90 /// external functions.
91 std::map<void*, void*> ExternalFnToStubMap;
93 //map addresses to indexes in the GOT
94 std::map<void*, unsigned> revGOTMap;
95 unsigned nextGOTIndex;
97 static JITResolver *TheJITResolver;
99 explicit JITResolver(JIT &jit) : nextGOTIndex(0) {
102 LazyResolverFn = jit.getJITInfo().getLazyResolverFunction(JITCompilerFn);
103 assert(TheJITResolver == 0 && "Multiple JIT resolvers?");
104 TheJITResolver = this;
111 /// getFunctionStub - This returns a pointer to a function stub, creating
112 /// one on demand as needed.
113 void *getFunctionStub(Function *F);
115 /// getExternalFunctionStub - Return a stub for the function at the
116 /// specified address, created lazily on demand.
117 void *getExternalFunctionStub(void *FnAddr);
119 /// getGlobalValueLazyPtr - Return a lazy pointer containing the specified
121 void *getGlobalValueLazyPtr(GlobalValue *V, void *GVAddress);
123 /// AddCallbackAtLocation - If the target is capable of rewriting an
124 /// instruction without the use of a stub, record the location of the use so
125 /// we know which function is being used at the location.
126 void *AddCallbackAtLocation(Function *F, void *Location) {
127 MutexGuard locked(TheJIT->lock);
128 /// Get the target-specific JIT resolver function.
129 state.getStubToFunctionMap(locked)[Location] = F;
130 return (void*)(intptr_t)LazyResolverFn;
133 /// getGOTIndexForAddress - Return a new or existing index in the GOT for
134 /// an address. This function only manages slots, it does not manage the
135 /// contents of the slots or the memory associated with the GOT.
136 unsigned getGOTIndexForAddr(void *addr);
138 /// JITCompilerFn - This function is called to resolve a stub to a compiled
139 /// address. If the LLVM Function corresponding to the stub has not yet
140 /// been compiled, this function compiles it first.
141 static void *JITCompilerFn(void *Stub);
145 JITResolver *JITResolver::TheJITResolver = 0;
147 #if (defined(__POWERPC__) || defined (__ppc__) || defined(_POWER)) && \
149 extern "C" void sys_icache_invalidate(const void *Addr, size_t len);
152 /// synchronizeICache - On some targets, the JIT emitted code must be
153 /// explicitly refetched to ensure correct execution.
154 static void synchronizeICache(const void *Addr, size_t len) {
155 #if (defined(__POWERPC__) || defined (__ppc__) || defined(_POWER)) && \
157 sys_icache_invalidate(Addr, len);
161 /// getFunctionStub - This returns a pointer to a function stub, creating
162 /// one on demand as needed.
163 void *JITResolver::getFunctionStub(Function *F) {
164 MutexGuard locked(TheJIT->lock);
166 // If we already have a stub for this function, recycle it.
167 void *&Stub = state.getFunctionToStubMap(locked)[F];
168 if (Stub) return Stub;
170 // Call the lazy resolver function unless we already KNOW it is an external
171 // function, in which case we just skip the lazy resolution step.
172 void *Actual = (void*)(intptr_t)LazyResolverFn;
173 if (F->isDeclaration() && !F->hasNotBeenReadFromBitcode())
174 Actual = TheJIT->getPointerToFunction(F);
176 // Otherwise, codegen a new stub. For now, the stub will call the lazy
177 // resolver function.
178 Stub = TheJIT->getJITInfo().emitFunctionStub(F, Actual,
179 *TheJIT->getCodeEmitter());
181 if (Actual != (void*)(intptr_t)LazyResolverFn) {
182 // If we are getting the stub for an external function, we really want the
183 // address of the stub in the GlobalAddressMap for the JIT, not the address
184 // of the external function.
185 TheJIT->updateGlobalMapping(F, Stub);
188 DOUT << "JIT: Stub emitted at [" << Stub << "] for function '"
189 << F->getName() << "'\n";
191 // Finally, keep track of the stub-to-Function mapping so that the
192 // JITCompilerFn knows which function to compile!
193 state.getStubToFunctionMap(locked)[Stub] = F;
197 /// getGlobalValueLazyPtr - Return a lazy pointer containing the specified
199 void *JITResolver::getGlobalValueLazyPtr(GlobalValue *GV, void *GVAddress) {
200 MutexGuard locked(TheJIT->lock);
202 // If we already have a stub for this global variable, recycle it.
203 void *&LazyPtr = state.getGlobalToLazyPtrMap(locked)[GV];
204 if (LazyPtr) return LazyPtr;
206 // Otherwise, codegen a new lazy pointer.
207 LazyPtr = TheJIT->getJITInfo().emitGlobalValueLazyPtr(GV, GVAddress,
208 *TheJIT->getCodeEmitter());
210 DOUT << "JIT: Stub emitted at [" << LazyPtr << "] for GV '"
211 << GV->getName() << "'\n";
216 /// getExternalFunctionStub - Return a stub for the function at the
217 /// specified address, created lazily on demand.
218 void *JITResolver::getExternalFunctionStub(void *FnAddr) {
219 // If we already have a stub for this function, recycle it.
220 void *&Stub = ExternalFnToStubMap[FnAddr];
221 if (Stub) return Stub;
223 Stub = TheJIT->getJITInfo().emitFunctionStub(0, FnAddr,
224 *TheJIT->getCodeEmitter());
226 DOUT << "JIT: Stub emitted at [" << Stub
227 << "] for external function at '" << FnAddr << "'\n";
231 unsigned JITResolver::getGOTIndexForAddr(void* addr) {
232 unsigned idx = revGOTMap[addr];
234 idx = ++nextGOTIndex;
235 revGOTMap[addr] = idx;
236 DOUT << "Adding GOT entry " << idx << " for addr " << addr << "\n";
241 /// JITCompilerFn - This function is called when a lazy compilation stub has
242 /// been entered. It looks up which function this stub corresponds to, compiles
243 /// it if necessary, then returns the resultant function pointer.
244 void *JITResolver::JITCompilerFn(void *Stub) {
245 JITResolver &JR = *TheJITResolver;
247 MutexGuard locked(TheJIT->lock);
249 // The address given to us for the stub may not be exactly right, it might be
250 // a little bit after the stub. As such, use upper_bound to find it.
251 std::map<void*, Function*>::iterator I =
252 JR.state.getStubToFunctionMap(locked).upper_bound(Stub);
253 assert(I != JR.state.getStubToFunctionMap(locked).begin() &&
254 "This is not a known stub!");
255 Function *F = (--I)->second;
257 // If we have already code generated the function, just return the address.
258 void *Result = TheJIT->getPointerToGlobalIfAvailable(F);
261 // Otherwise we don't have it, do lazy compilation now.
263 // If lazy compilation is disabled, emit a useful error message and abort.
264 if (TheJIT->isLazyCompilationDisabled()) {
265 cerr << "LLVM JIT requested to do lazy compilation of function '"
266 << F->getName() << "' when lazy compiles are disabled!\n";
270 // We might like to remove the stub from the StubToFunction map.
271 // We can't do that! Multiple threads could be stuck, waiting to acquire the
272 // lock above. As soon as the 1st function finishes compiling the function,
273 // the next one will be released, and needs to be able to find the function
275 //JR.state.getStubToFunctionMap(locked).erase(I);
277 DOUT << "JIT: Lazily resolving function '" << F->getName()
278 << "' In stub ptr = " << Stub << " actual ptr = "
281 Result = TheJIT->getPointerToFunction(F);
284 // We don't need to reuse this stub in the future, as F is now compiled.
285 JR.state.getFunctionToStubMap(locked).erase(F);
287 // FIXME: We could rewrite all references to this stub if we knew them.
289 // What we will do is set the compiled function address to map to the
290 // same GOT entry as the stub so that later clients may update the GOT
291 // if they see it still using the stub address.
292 // Note: this is done so the Resolver doesn't have to manage GOT memory
293 // Do this without allocating map space if the target isn't using a GOT
294 if(JR.revGOTMap.find(Stub) != JR.revGOTMap.end())
295 JR.revGOTMap[Result] = JR.revGOTMap[Stub];
300 //===----------------------------------------------------------------------===//
301 // Function Index Support
303 // On MacOS we generate an index of currently JIT'd functions so that
304 // performance tools can determine a symbol name and accurate code range for a
305 // PC value. Because performance tools are generally asynchronous, the code
306 // below is written with the hope that it could be interrupted at any time and
307 // have useful answers. However, we don't go crazy with atomic operations, we
308 // just do a "reasonable effort".
310 #define ENABLE_JIT_SYMBOL_TABLE 1
313 /// JitSymbolEntry - Each function that is JIT compiled results in one of these
314 /// being added to an array of symbols. This indicates the name of the function
315 /// as well as the address range it occupies. This allows the client to map
316 /// from a PC value to the name of the function.
317 struct JitSymbolEntry {
318 const char *FnName; // FnName - a strdup'd string.
324 struct JitSymbolTable {
325 /// NextPtr - This forms a linked list of JitSymbolTable entries. This
326 /// pointer is not used right now, but might be used in the future. Consider
327 /// it reserved for future use.
328 JitSymbolTable *NextPtr;
330 /// Symbols - This is an array of JitSymbolEntry entries. Only the first
331 /// 'NumSymbols' symbols are valid.
332 JitSymbolEntry *Symbols;
334 /// NumSymbols - This indicates the number entries in the Symbols array that
338 /// NumAllocated - This indicates the amount of space we have in the Symbols
339 /// array. This is a private field that should not be read by external tools.
340 unsigned NumAllocated;
343 #if ENABLE_JIT_SYMBOL_TABLE
344 JitSymbolTable *__jitSymbolTable;
347 static void AddFunctionToSymbolTable(const char *FnName,
348 void *FnStart, intptr_t FnSize) {
349 assert(FnName != 0 && FnStart != 0 && "Bad symbol to add");
350 JitSymbolTable **SymTabPtrPtr = 0;
351 #if !ENABLE_JIT_SYMBOL_TABLE
354 SymTabPtrPtr = &__jitSymbolTable;
357 // If this is the first entry in the symbol table, add the JitSymbolTable
359 if (*SymTabPtrPtr == 0) {
360 JitSymbolTable *New = new JitSymbolTable();
364 New->NumAllocated = 0;
368 JitSymbolTable *SymTabPtr = *SymTabPtrPtr;
370 // If we have space in the table, reallocate the table.
371 if (SymTabPtr->NumSymbols >= SymTabPtr->NumAllocated) {
372 // If we don't have space, reallocate the table.
373 unsigned NewSize = std::max(64U, SymTabPtr->NumAllocated*2);
374 JitSymbolEntry *NewSymbols = new JitSymbolEntry[NewSize];
375 JitSymbolEntry *OldSymbols = SymTabPtr->Symbols;
377 // Copy the old entries over.
378 memcpy(NewSymbols, OldSymbols,
379 SymTabPtr->NumSymbols*sizeof(OldSymbols[0]));
381 // Swap the new symbols in, delete the old ones.
382 SymTabPtr->Symbols = NewSymbols;
383 SymTabPtr->NumAllocated = NewSize;
384 delete [] OldSymbols;
387 // Otherwise, we have enough space, just tack it onto the end of the array.
388 JitSymbolEntry &Entry = SymTabPtr->Symbols[SymTabPtr->NumSymbols];
389 Entry.FnName = strdup(FnName);
390 Entry.FnStart = FnStart;
391 Entry.FnSize = FnSize;
392 ++SymTabPtr->NumSymbols;
395 static void RemoveFunctionFromSymbolTable(void *FnStart) {
396 assert(FnStart && "Invalid function pointer");
397 JitSymbolTable **SymTabPtrPtr = 0;
398 #if !ENABLE_JIT_SYMBOL_TABLE
401 SymTabPtrPtr = &__jitSymbolTable;
404 JitSymbolTable *SymTabPtr = *SymTabPtrPtr;
405 JitSymbolEntry *Symbols = SymTabPtr->Symbols;
407 // Scan the table to find its index. The table is not sorted, so do a linear
410 for (Index = 0; Symbols[Index].FnStart != FnStart; ++Index)
411 assert(Index != SymTabPtr->NumSymbols && "Didn't find function!");
413 // Once we have an index, we know to nuke this entry, overwrite it with the
414 // entry at the end of the array, making the last entry redundant.
415 const char *OldName = Symbols[Index].FnName;
416 Symbols[Index] = Symbols[SymTabPtr->NumSymbols-1];
417 free((void*)OldName);
419 // Drop the number of symbols in the table.
420 --SymTabPtr->NumSymbols;
422 // Finally, if we deleted the final symbol, deallocate the table itself.
423 if (SymTabPtr->NumSymbols == 0)
431 //===----------------------------------------------------------------------===//
435 /// JITEmitter - The JIT implementation of the MachineCodeEmitter, which is
436 /// used to output functions to memory for execution.
437 class JITEmitter : public MachineCodeEmitter {
438 JITMemoryManager *MemMgr;
440 // When outputting a function stub in the context of some other function, we
441 // save BufferBegin/BufferEnd/CurBufferPtr here.
442 unsigned char *SavedBufferBegin, *SavedBufferEnd, *SavedCurBufferPtr;
444 /// Relocations - These are the relocations that the function needs, as
446 std::vector<MachineRelocation> Relocations;
448 /// MBBLocations - This vector is a mapping from MBB ID's to their address.
449 /// It is filled in by the StartMachineBasicBlock callback and queried by
450 /// the getMachineBasicBlockAddress callback.
451 std::vector<intptr_t> MBBLocations;
453 /// ConstantPool - The constant pool for the current function.
455 MachineConstantPool *ConstantPool;
457 /// ConstantPoolBase - A pointer to the first entry in the constant pool.
459 void *ConstantPoolBase;
461 /// JumpTable - The jump tables for the current function.
463 MachineJumpTableInfo *JumpTable;
465 /// JumpTableBase - A pointer to the first entry in the jump table.
469 /// Resolver - This contains info about the currently resolved functions.
470 JITResolver Resolver;
472 /// DE - The dwarf emitter for the jit.
475 /// LabelLocations - This vector is a mapping from Label ID's to their
477 std::vector<intptr_t> LabelLocations;
479 /// MMI - Machine module info for exception informations
480 MachineModuleInfo* MMI;
483 JITEmitter(JIT &jit, JITMemoryManager *JMM) : Resolver(jit) {
484 MemMgr = JMM ? JMM : JITMemoryManager::CreateDefaultMemManager();
485 if (jit.getJITInfo().needsGOT()) {
486 MemMgr->AllocateGOT();
487 DOUT << "JIT is managing a GOT\n";
490 if (ExceptionHandling) DE = new JITDwarfEmitter(jit);
494 if (ExceptionHandling) delete DE;
497 JITResolver &getJITResolver() { return Resolver; }
499 virtual void startFunction(MachineFunction &F);
500 virtual bool finishFunction(MachineFunction &F);
502 void emitConstantPool(MachineConstantPool *MCP);
503 void initJumpTableInfo(MachineJumpTableInfo *MJTI);
504 void emitJumpTableInfo(MachineJumpTableInfo *MJTI);
506 virtual void startFunctionStub(const GlobalValue* F, unsigned StubSize,
507 unsigned Alignment = 1);
508 virtual void* finishFunctionStub(const GlobalValue *F);
510 virtual void addRelocation(const MachineRelocation &MR) {
511 Relocations.push_back(MR);
514 virtual void StartMachineBasicBlock(MachineBasicBlock *MBB) {
515 if (MBBLocations.size() <= (unsigned)MBB->getNumber())
516 MBBLocations.resize((MBB->getNumber()+1)*2);
517 MBBLocations[MBB->getNumber()] = getCurrentPCValue();
520 virtual intptr_t getConstantPoolEntryAddress(unsigned Entry) const;
521 virtual intptr_t getJumpTableEntryAddress(unsigned Entry) const;
523 virtual intptr_t getMachineBasicBlockAddress(MachineBasicBlock *MBB) const {
524 assert(MBBLocations.size() > (unsigned)MBB->getNumber() &&
525 MBBLocations[MBB->getNumber()] && "MBB not emitted!");
526 return MBBLocations[MBB->getNumber()];
529 /// deallocateMemForFunction - Deallocate all memory for the specified
531 void deallocateMemForFunction(Function *F) {
532 MemMgr->deallocateMemForFunction(F);
535 virtual void emitLabel(uint64_t LabelID) {
536 if (LabelLocations.size() <= LabelID)
537 LabelLocations.resize((LabelID+1)*2);
538 LabelLocations[LabelID] = getCurrentPCValue();
541 virtual intptr_t getLabelAddress(uint64_t LabelID) const {
542 assert(LabelLocations.size() > (unsigned)LabelID &&
543 LabelLocations[LabelID] && "Label not emitted!");
544 return LabelLocations[LabelID];
547 virtual void setModuleInfo(MachineModuleInfo* Info) {
549 if (ExceptionHandling) DE->setModuleInfo(Info);
553 void *getPointerToGlobal(GlobalValue *GV, void *Reference, bool NoNeedStub);
554 void *getPointerToGVLazyPtr(GlobalValue *V, void *Reference,
559 void *JITEmitter::getPointerToGlobal(GlobalValue *V, void *Reference,
560 bool DoesntNeedStub) {
561 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
562 /// FIXME: If we straightened things out, this could actually emit the
563 /// global immediately instead of queuing it for codegen later!
564 return TheJIT->getOrEmitGlobalVariable(GV);
567 // If we have already compiled the function, return a pointer to its body.
568 Function *F = cast<Function>(V);
569 void *ResultPtr = TheJIT->getPointerToGlobalIfAvailable(F);
570 if (ResultPtr) return ResultPtr;
572 if (F->isDeclaration() && !F->hasNotBeenReadFromBitcode()) {
573 // If this is an external function pointer, we can force the JIT to
574 // 'compile' it, which really just adds it to the map.
576 return TheJIT->getPointerToFunction(F);
578 return Resolver.getFunctionStub(F);
581 // Okay, the function has not been compiled yet, if the target callback
582 // mechanism is capable of rewriting the instruction directly, prefer to do
583 // that instead of emitting a stub.
585 return Resolver.AddCallbackAtLocation(F, Reference);
587 // Otherwise, we have to emit a lazy resolving stub.
588 return Resolver.getFunctionStub(F);
591 void *JITEmitter::getPointerToGVLazyPtr(GlobalValue *V, void *Reference,
592 bool DoesntNeedStub) {
593 // Make sure GV is emitted first.
594 // FIXME: For now, if the GV is an external function we force the JIT to
595 // compile it so the lazy pointer will contain the fully resolved address.
596 void *GVAddress = getPointerToGlobal(V, Reference, true);
597 return Resolver.getGlobalValueLazyPtr(V, GVAddress);
601 void JITEmitter::startFunction(MachineFunction &F) {
602 uintptr_t ActualSize;
603 BufferBegin = CurBufferPtr = MemMgr->startFunctionBody(F.getFunction(),
605 BufferEnd = BufferBegin+ActualSize;
607 // Ensure the constant pool/jump table info is at least 4-byte aligned.
610 emitConstantPool(F.getConstantPool());
611 initJumpTableInfo(F.getJumpTableInfo());
613 // About to start emitting the machine code for the function.
614 emitAlignment(std::max(F.getFunction()->getAlignment(), 8U));
615 TheJIT->updateGlobalMapping(F.getFunction(), CurBufferPtr);
617 MBBLocations.clear();
620 bool JITEmitter::finishFunction(MachineFunction &F) {
621 if (CurBufferPtr == BufferEnd) {
622 // FIXME: Allocate more space, then try again.
623 cerr << "JIT: Ran out of space for generated machine code!\n";
627 emitJumpTableInfo(F.getJumpTableInfo());
629 // FnStart is the start of the text, not the start of the constant pool and
630 // other per-function data.
631 unsigned char *FnStart =
632 (unsigned char *)TheJIT->getPointerToGlobalIfAvailable(F.getFunction());
633 unsigned char *FnEnd = CurBufferPtr;
635 MemMgr->endFunctionBody(F.getFunction(), BufferBegin, FnEnd);
636 NumBytes += FnEnd-FnStart;
638 if (!Relocations.empty()) {
639 NumRelos += Relocations.size();
641 // Resolve the relocations to concrete pointers.
642 for (unsigned i = 0, e = Relocations.size(); i != e; ++i) {
643 MachineRelocation &MR = Relocations[i];
646 ResultPtr = TheJIT->getPointerToNamedFunction(MR.getString());
648 // If the target REALLY wants a stub for this function, emit it now.
649 if (!MR.doesntNeedStub())
650 ResultPtr = Resolver.getExternalFunctionStub(ResultPtr);
651 } else if (MR.isGlobalValue()) {
652 ResultPtr = getPointerToGlobal(MR.getGlobalValue(),
653 BufferBegin+MR.getMachineCodeOffset(),
654 MR.doesntNeedStub());
655 } else if (MR.isGlobalValueLazyPtr()) {
656 ResultPtr = getPointerToGVLazyPtr(MR.getGlobalValue(),
657 BufferBegin+MR.getMachineCodeOffset(),
658 MR.doesntNeedStub());
659 } else if (MR.isBasicBlock()) {
660 ResultPtr = (void*)getMachineBasicBlockAddress(MR.getBasicBlock());
661 } else if (MR.isConstantPoolIndex()) {
662 ResultPtr=(void*)getConstantPoolEntryAddress(MR.getConstantPoolIndex());
664 assert(MR.isJumpTableIndex());
665 ResultPtr=(void*)getJumpTableEntryAddress(MR.getJumpTableIndex());
668 MR.setResultPointer(ResultPtr);
670 // if we are managing the GOT and the relocation wants an index,
672 if (MR.isGOTRelative() && MemMgr->isManagingGOT()) {
673 unsigned idx = Resolver.getGOTIndexForAddr(ResultPtr);
675 if (((void**)MemMgr->getGOTBase())[idx] != ResultPtr) {
676 DOUT << "GOT was out of date for " << ResultPtr
677 << " pointing at " << ((void**)MemMgr->getGOTBase())[idx]
679 ((void**)MemMgr->getGOTBase())[idx] = ResultPtr;
684 TheJIT->getJITInfo().relocate(BufferBegin, &Relocations[0],
685 Relocations.size(), MemMgr->getGOTBase());
688 // Update the GOT entry for F to point to the new code.
689 if (MemMgr->isManagingGOT()) {
690 unsigned idx = Resolver.getGOTIndexForAddr((void*)BufferBegin);
691 if (((void**)MemMgr->getGOTBase())[idx] != (void*)BufferBegin) {
692 DOUT << "GOT was out of date for " << (void*)BufferBegin
693 << " pointing at " << ((void**)MemMgr->getGOTBase())[idx] << "\n";
694 ((void**)MemMgr->getGOTBase())[idx] = (void*)BufferBegin;
698 // Invalidate the icache if necessary.
699 synchronizeICache(FnStart, FnEnd-FnStart);
701 // Add it to the JIT symbol table if the host wants it.
702 AddFunctionToSymbolTable(F.getFunction()->getNameStart(),
703 FnStart, FnEnd-FnStart);
705 DOUT << "JIT: Finished CodeGen of [" << (void*)FnStart
706 << "] Function: " << F.getFunction()->getName()
707 << ": " << (FnEnd-FnStart) << " bytes of text, "
708 << Relocations.size() << " relocations\n";
712 if (sys::hasDisassembler())
713 DOUT << "Disassembled code:\n"
714 << sys::disassembleBuffer(FnStart, FnEnd-FnStart, (uintptr_t)FnStart);
716 if (ExceptionHandling) {
717 uintptr_t ActualSize;
718 SavedBufferBegin = BufferBegin;
719 SavedBufferEnd = BufferEnd;
720 SavedCurBufferPtr = CurBufferPtr;
722 BufferBegin = CurBufferPtr = MemMgr->startExceptionTable(F.getFunction(),
724 BufferEnd = BufferBegin+ActualSize;
725 unsigned char* FrameRegister = DE->EmitDwarfTable(F, *this, FnStart, FnEnd);
726 MemMgr->endExceptionTable(F.getFunction(), BufferBegin, CurBufferPtr,
728 BufferBegin = SavedBufferBegin;
729 BufferEnd = SavedBufferEnd;
730 CurBufferPtr = SavedCurBufferPtr;
732 TheJIT->RegisterTable(FrameRegister);
739 void JITEmitter::emitConstantPool(MachineConstantPool *MCP) {
740 const std::vector<MachineConstantPoolEntry> &Constants = MCP->getConstants();
741 if (Constants.empty()) return;
743 MachineConstantPoolEntry CPE = Constants.back();
744 unsigned Size = CPE.Offset;
745 const Type *Ty = CPE.isMachineConstantPoolEntry()
746 ? CPE.Val.MachineCPVal->getType() : CPE.Val.ConstVal->getType();
747 Size += TheJIT->getTargetData()->getABITypeSize(Ty);
749 unsigned Align = 1 << MCP->getConstantPoolAlignment();
750 ConstantPoolBase = allocateSpace(Size, Align);
753 if (ConstantPoolBase == 0) return; // Buffer overflow.
755 DOUT << "JIT: Emitted constant pool at [" << ConstantPoolBase
756 << "] (size: " << Size << ", alignment: " << Align << ")\n";
758 // Initialize the memory for all of the constant pool entries.
759 for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
760 void *CAddr = (char*)ConstantPoolBase+Constants[i].Offset;
761 if (Constants[i].isMachineConstantPoolEntry()) {
762 // FIXME: add support to lower machine constant pool values into bytes!
763 cerr << "Initialize memory with machine specific constant pool entry"
764 << " has not been implemented!\n";
767 TheJIT->InitializeMemory(Constants[i].Val.ConstVal, CAddr);
768 DOUT << "JIT: CP" << i << " at [" << CAddr << "]\n";
772 void JITEmitter::initJumpTableInfo(MachineJumpTableInfo *MJTI) {
773 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
774 if (JT.empty()) return;
776 unsigned NumEntries = 0;
777 for (unsigned i = 0, e = JT.size(); i != e; ++i)
778 NumEntries += JT[i].MBBs.size();
780 unsigned EntrySize = MJTI->getEntrySize();
782 // Just allocate space for all the jump tables now. We will fix up the actual
783 // MBB entries in the tables after we emit the code for each block, since then
784 // we will know the final locations of the MBBs in memory.
786 JumpTableBase = allocateSpace(NumEntries * EntrySize, MJTI->getAlignment());
789 void JITEmitter::emitJumpTableInfo(MachineJumpTableInfo *MJTI) {
790 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
791 if (JT.empty() || JumpTableBase == 0) return;
793 if (TargetMachine::getRelocationModel() == Reloc::PIC_) {
794 assert(MJTI->getEntrySize() == 4 && "Cross JIT'ing?");
795 // For each jump table, place the offset from the beginning of the table
796 // to the target address.
797 int *SlotPtr = (int*)JumpTableBase;
799 for (unsigned i = 0, e = JT.size(); i != e; ++i) {
800 const std::vector<MachineBasicBlock*> &MBBs = JT[i].MBBs;
801 // Store the offset of the basic block for this jump table slot in the
802 // memory we allocated for the jump table in 'initJumpTableInfo'
803 intptr_t Base = (intptr_t)SlotPtr;
804 for (unsigned mi = 0, me = MBBs.size(); mi != me; ++mi) {
805 intptr_t MBBAddr = getMachineBasicBlockAddress(MBBs[mi]);
806 *SlotPtr++ = TheJIT->getJITInfo().getPICJumpTableEntry(MBBAddr, Base);
810 assert(MJTI->getEntrySize() == sizeof(void*) && "Cross JIT'ing?");
812 // For each jump table, map each target in the jump table to the address of
813 // an emitted MachineBasicBlock.
814 intptr_t *SlotPtr = (intptr_t*)JumpTableBase;
816 for (unsigned i = 0, e = JT.size(); i != e; ++i) {
817 const std::vector<MachineBasicBlock*> &MBBs = JT[i].MBBs;
818 // Store the address of the basic block for this jump table slot in the
819 // memory we allocated for the jump table in 'initJumpTableInfo'
820 for (unsigned mi = 0, me = MBBs.size(); mi != me; ++mi)
821 *SlotPtr++ = getMachineBasicBlockAddress(MBBs[mi]);
826 void JITEmitter::startFunctionStub(const GlobalValue* F, unsigned StubSize,
827 unsigned Alignment) {
828 SavedBufferBegin = BufferBegin;
829 SavedBufferEnd = BufferEnd;
830 SavedCurBufferPtr = CurBufferPtr;
832 BufferBegin = CurBufferPtr = MemMgr->allocateStub(F, StubSize, Alignment);
833 BufferEnd = BufferBegin+StubSize+1;
836 void *JITEmitter::finishFunctionStub(const GlobalValue* F) {
837 NumBytes += getCurrentPCOffset();
838 std::swap(SavedBufferBegin, BufferBegin);
839 BufferEnd = SavedBufferEnd;
840 CurBufferPtr = SavedCurBufferPtr;
841 return SavedBufferBegin;
844 // getConstantPoolEntryAddress - Return the address of the 'ConstantNum' entry
845 // in the constant pool that was last emitted with the 'emitConstantPool'
848 intptr_t JITEmitter::getConstantPoolEntryAddress(unsigned ConstantNum) const {
849 assert(ConstantNum < ConstantPool->getConstants().size() &&
850 "Invalid ConstantPoolIndex!");
851 return (intptr_t)ConstantPoolBase +
852 ConstantPool->getConstants()[ConstantNum].Offset;
855 // getJumpTableEntryAddress - Return the address of the JumpTable with index
856 // 'Index' in the jumpp table that was last initialized with 'initJumpTableInfo'
858 intptr_t JITEmitter::getJumpTableEntryAddress(unsigned Index) const {
859 const std::vector<MachineJumpTableEntry> &JT = JumpTable->getJumpTables();
860 assert(Index < JT.size() && "Invalid jump table index!");
863 unsigned EntrySize = JumpTable->getEntrySize();
865 for (unsigned i = 0; i < Index; ++i)
866 Offset += JT[i].MBBs.size();
870 return (intptr_t)((char *)JumpTableBase + Offset);
873 //===----------------------------------------------------------------------===//
874 // Public interface to this file
875 //===----------------------------------------------------------------------===//
877 MachineCodeEmitter *JIT::createEmitter(JIT &jit, JITMemoryManager *JMM) {
878 return new JITEmitter(jit, JMM);
881 // getPointerToNamedFunction - This function is used as a global wrapper to
882 // JIT::getPointerToNamedFunction for the purpose of resolving symbols when
883 // bugpoint is debugging the JIT. In that scenario, we are loading an .so and
884 // need to resolve function(s) that are being mis-codegenerated, so we need to
885 // resolve their addresses at runtime, and this is the way to do it.
887 void *getPointerToNamedFunction(const char *Name) {
888 if (Function *F = TheJIT->FindFunctionNamed(Name))
889 return TheJIT->getPointerToFunction(F);
890 return TheJIT->getPointerToNamedFunction(Name);
894 // getPointerToFunctionOrStub - If the specified function has been
895 // code-gen'd, return a pointer to the function. If not, compile it, or use
896 // a stub to implement lazy compilation if available.
898 void *JIT::getPointerToFunctionOrStub(Function *F) {
899 // If we have already code generated the function, just return the address.
900 if (void *Addr = getPointerToGlobalIfAvailable(F))
903 // Get a stub if the target supports it.
904 assert(dynamic_cast<JITEmitter*>(MCE) && "Unexpected MCE?");
905 JITEmitter *JE = static_cast<JITEmitter*>(getCodeEmitter());
906 return JE->getJITResolver().getFunctionStub(F);
909 /// freeMachineCodeForFunction - release machine code memory for given Function.
911 void JIT::freeMachineCodeForFunction(Function *F) {
913 // Delete translation for this from the ExecutionEngine, so it will get
914 // retranslated next time it is used.
915 void *OldPtr = updateGlobalMapping(F, 0);
918 RemoveFunctionFromSymbolTable(OldPtr);
920 // Free the actual memory for the function body and related stuff.
921 assert(dynamic_cast<JITEmitter*>(MCE) && "Unexpected MCE?");
922 static_cast<JITEmitter*>(MCE)->deallocateMemForFunction(F);