blob: 7d8848e069819658294fd3f959e53681f3c366f3 [file] [log] [blame]
Chris Lattner166f2262004-11-22 22:00:25 +00001//===-- JITEmitter.cpp - Write machine code to executable memory ----------===//
Misha Brukmanf976c852005-04-21 22:55:34 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
5// This file was developed by the LLVM research group and is distributed under
6// the University of Illinois Open Source License. See LICENSE.TXT for details.
Misha Brukmanf976c852005-04-21 22:55:34 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattnerbd199fb2002-12-24 00:01:05 +00009//
Chris Lattner5be478f2004-11-20 03:46:14 +000010// 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.
Chris Lattnerbd199fb2002-12-24 00:01:05 +000012//
13//===----------------------------------------------------------------------===//
14
Chris Lattner3785fad2003-08-05 17:00:32 +000015#define DEBUG_TYPE "jit"
Chris Lattner4d326fa2003-12-20 01:46:27 +000016#include "JIT.h"
Chris Lattner2c0a6a12003-11-30 04:23:21 +000017#include "llvm/Constant.h"
18#include "llvm/Module.h"
Chris Lattner5b3a4552005-03-17 15:38:16 +000019#include "llvm/Type.h"
Chris Lattnerbd199fb2002-12-24 00:01:05 +000020#include "llvm/CodeGen/MachineCodeEmitter.h"
21#include "llvm/CodeGen/MachineFunction.h"
Chris Lattner1cc08382003-01-13 01:00:12 +000022#include "llvm/CodeGen/MachineConstantPool.h"
Nate Begeman37efe672006-04-22 18:53:45 +000023#include "llvm/CodeGen/MachineJumpTableInfo.h"
Chris Lattner5be478f2004-11-20 03:46:14 +000024#include "llvm/CodeGen/MachineRelocation.h"
Nate Begeman37efe672006-04-22 18:53:45 +000025#include "llvm/ExecutionEngine/GenericValue.h"
Chris Lattner1cc08382003-01-13 01:00:12 +000026#include "llvm/Target/TargetData.h"
Chris Lattner5be478f2004-11-20 03:46:14 +000027#include "llvm/Target/TargetJITInfo.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000028#include "llvm/Support/Debug.h"
29#include "llvm/ADT/Statistic.h"
Reid Spencer52b0ba62004-09-11 04:31:03 +000030#include "llvm/System/Memory.h"
Andrew Lenhartha00269b2005-07-29 23:40:16 +000031#include <algorithm>
Chris Lattnerca261802006-01-22 23:41:42 +000032#include <iostream>
33#include <list>
Chris Lattnerc19aade2003-12-08 08:06:28 +000034using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000035
Chris Lattnerbd199fb2002-12-24 00:01:05 +000036namespace {
Chris Lattnere7386562003-10-20 05:45:49 +000037 Statistic<> NumBytes("jit", "Number of bytes of machine code compiled");
Chris Lattnere884dc22005-07-20 16:29:20 +000038 Statistic<> NumRelos("jit", "Number of relocations applied");
Chris Lattner4d326fa2003-12-20 01:46:27 +000039 JIT *TheJIT = 0;
Chris Lattner54266522004-11-20 23:57:07 +000040}
Chris Lattnerbd199fb2002-12-24 00:01:05 +000041
Chris Lattner54266522004-11-20 23:57:07 +000042
43//===----------------------------------------------------------------------===//
44// JITMemoryManager code.
45//
46namespace {
Chris Lattner688506d2003-08-14 18:35:27 +000047 /// JITMemoryManager - Manage memory for the JIT code generation in a logical,
48 /// sane way. This splits a large block of MAP_NORESERVE'd memory into two
49 /// sections, one for function stubs, one for the functions themselves. We
50 /// have to do this because we may need to emit a function stub while in the
51 /// middle of emitting a function, and we don't know how large the function we
52 /// are emitting is. This never bothers to release the memory, because when
53 /// we are ready to destroy the JIT, the program exits.
54 class JITMemoryManager {
Andrew Lenhartha00269b2005-07-29 23:40:16 +000055 std::list<sys::MemoryBlock> Blocks; // List of blocks allocated by the JIT
Chris Lattner688506d2003-08-14 18:35:27 +000056 unsigned char *FunctionBase; // Start of the function body area
Chris Lattnerf75f9be2006-05-02 23:22:24 +000057 unsigned char *CurStubPtr, *CurFunctionPtr;
Chris Lattnera726c7f2006-05-02 21:44:14 +000058 unsigned char *GOTBase; // Target Specific reserved memory
Andrew Lenhartha00269b2005-07-29 23:40:16 +000059
60 // centralize memory block allocation
61 sys::MemoryBlock getNewMemoryBlock(unsigned size);
Chris Lattner688506d2003-08-14 18:35:27 +000062 public:
Andrew Lenharth16ec33c2005-07-22 20:48:12 +000063 JITMemoryManager(bool useGOT);
Reid Spencer4af3da62004-12-13 16:04:04 +000064 ~JITMemoryManager();
Misha Brukmanf976c852005-04-21 22:55:34 +000065
Chris Lattner688506d2003-08-14 18:35:27 +000066 inline unsigned char *allocateStub(unsigned StubSize);
67 inline unsigned char *startFunctionBody();
Chris Lattner281a6012005-01-10 18:23:22 +000068 inline void endFunctionBody(unsigned char *FunctionEnd);
Chris Lattnera726c7f2006-05-02 21:44:14 +000069
70 unsigned char *getGOTBase() const {
71 return GOTBase;
72 }
73 bool isManagingGOT() const {
74 return GOTBase != NULL;
75 }
Chris Lattner688506d2003-08-14 18:35:27 +000076 };
77}
78
Andrew Lenharth16ec33c2005-07-22 20:48:12 +000079JITMemoryManager::JITMemoryManager(bool useGOT) {
Andrew Lenhartha00269b2005-07-29 23:40:16 +000080 // Allocate a 16M block of memory for functions
81 sys::MemoryBlock FunBlock = getNewMemoryBlock(16 << 20);
Andrew Lenharth16ec33c2005-07-22 20:48:12 +000082
Andrew Lenhartha00269b2005-07-29 23:40:16 +000083 Blocks.push_front(FunBlock);
Chris Lattner688506d2003-08-14 18:35:27 +000084
Andrew Lenhartha00269b2005-07-29 23:40:16 +000085 FunctionBase = reinterpret_cast<unsigned char*>(FunBlock.base());
Chris Lattner281a6012005-01-10 18:23:22 +000086
Andrew Lenhartha00269b2005-07-29 23:40:16 +000087 // Allocate stubs backwards from the base, allocate functions forward
88 // from the base.
89 CurStubPtr = CurFunctionPtr = FunctionBase + 512*1024;// Use 512k for stubs
90
Chris Lattnerf5d438c2006-05-02 21:57:51 +000091 // Allocate the GOT.
Andrew Lenharth2b3b89c2005-08-01 17:35:40 +000092 GOTBase = NULL;
Chris Lattnerf5d438c2006-05-02 21:57:51 +000093 if (useGOT) GOTBase = (unsigned char*)malloc(sizeof(void*) * 8192);
Chris Lattner688506d2003-08-14 18:35:27 +000094}
95
Reid Spencer4af3da62004-12-13 16:04:04 +000096JITMemoryManager::~JITMemoryManager() {
Chris Lattner21998772006-01-07 06:20:51 +000097 for (std::list<sys::MemoryBlock>::iterator ib = Blocks.begin(),
98 ie = Blocks.end(); ib != ie; ++ib)
Andrew Lenhartha00269b2005-07-29 23:40:16 +000099 sys::Memory::ReleaseRWX(*ib);
100 Blocks.clear();
Reid Spencer4af3da62004-12-13 16:04:04 +0000101}
102
Chris Lattner688506d2003-08-14 18:35:27 +0000103unsigned char *JITMemoryManager::allocateStub(unsigned StubSize) {
104 CurStubPtr -= StubSize;
Andrew Lenhartha00269b2005-07-29 23:40:16 +0000105 if (CurStubPtr < FunctionBase) {
Chris Lattnera726c7f2006-05-02 21:44:14 +0000106 // FIXME: allocate a new block
Chris Lattner688506d2003-08-14 18:35:27 +0000107 std::cerr << "JIT ran out of memory for function stubs!\n";
108 abort();
109 }
110 return CurStubPtr;
111}
112
113unsigned char *JITMemoryManager::startFunctionBody() {
Chris Lattner5be478f2004-11-20 03:46:14 +0000114 // Round up to an even multiple of 8 bytes, this should eventually be target
Chris Lattner688506d2003-08-14 18:35:27 +0000115 // specific.
Chris Lattner5be478f2004-11-20 03:46:14 +0000116 return (unsigned char*)(((intptr_t)CurFunctionPtr + 7) & ~7);
Chris Lattner688506d2003-08-14 18:35:27 +0000117}
118
119void JITMemoryManager::endFunctionBody(unsigned char *FunctionEnd) {
120 assert(FunctionEnd > CurFunctionPtr);
121 CurFunctionPtr = FunctionEnd;
122}
123
Andrew Lenhartha00269b2005-07-29 23:40:16 +0000124sys::MemoryBlock JITMemoryManager::getNewMemoryBlock(unsigned size) {
125 const sys::MemoryBlock* BOld = 0;
126 if (Blocks.size())
127 BOld = &Blocks.front();
128 //never allocate less than 1 MB
129 sys::MemoryBlock B;
130 try {
131 B = sys::Memory::AllocateRWX(std::max(((unsigned)1 << 20), size), BOld);
132 } catch (std::string& err) {
133 std::cerr << "Allocation failed when allocating new memory in the JIT\n";
134 std::cerr << err << "\n";
135 abort();
136 }
137 Blocks.push_front(B);
138 return B;
139}
140
Chris Lattner54266522004-11-20 23:57:07 +0000141//===----------------------------------------------------------------------===//
142// JIT lazy compilation code.
143//
144namespace {
Reid Spenceree448632005-07-12 15:51:55 +0000145 class JITResolverState {
146 private:
147 /// FunctionToStubMap - Keep track of the stub created for a particular
148 /// function so that we can reuse them if necessary.
149 std::map<Function*, void*> FunctionToStubMap;
150
151 /// StubToFunctionMap - Keep track of the function that each stub
152 /// corresponds to.
153 std::map<void*, Function*> StubToFunctionMap;
Jeff Cohen00b168892005-07-27 06:12:32 +0000154
Reid Spenceree448632005-07-12 15:51:55 +0000155 public:
156 std::map<Function*, void*>& getFunctionToStubMap(const MutexGuard& locked) {
157 assert(locked.holds(TheJIT->lock));
158 return FunctionToStubMap;
159 }
Jeff Cohen00b168892005-07-27 06:12:32 +0000160
Reid Spenceree448632005-07-12 15:51:55 +0000161 std::map<void*, Function*>& getStubToFunctionMap(const MutexGuard& locked) {
162 assert(locked.holds(TheJIT->lock));
163 return StubToFunctionMap;
164 }
165 };
Jeff Cohen00b168892005-07-27 06:12:32 +0000166
Chris Lattner54266522004-11-20 23:57:07 +0000167 /// JITResolver - Keep track of, and resolve, call sites for functions that
168 /// have not yet been compiled.
169 class JITResolver {
Chris Lattner5e225582004-11-21 03:37:42 +0000170 /// MCE - The MachineCodeEmitter to use to emit stubs with.
Chris Lattner54266522004-11-20 23:57:07 +0000171 MachineCodeEmitter &MCE;
172
Chris Lattner5e225582004-11-21 03:37:42 +0000173 /// LazyResolverFn - The target lazy resolver function that we actually
174 /// rewrite instructions to use.
175 TargetJITInfo::LazyResolverFn LazyResolverFn;
176
Reid Spenceree448632005-07-12 15:51:55 +0000177 JITResolverState state;
Chris Lattner54266522004-11-20 23:57:07 +0000178
Chris Lattnerd91ff7c2005-04-18 01:44:27 +0000179 /// ExternalFnToStubMap - This is the equivalent of FunctionToStubMap for
180 /// external functions.
181 std::map<void*, void*> ExternalFnToStubMap;
Andrew Lenharth6a974612005-07-28 12:44:13 +0000182
183 //map addresses to indexes in the GOT
184 std::map<void*, unsigned> revGOTMap;
185 unsigned nextGOTIndex;
186
Chris Lattner54266522004-11-20 23:57:07 +0000187 public:
Andrew Lenharth6a974612005-07-28 12:44:13 +0000188 JITResolver(MachineCodeEmitter &mce) : MCE(mce), nextGOTIndex(0) {
Chris Lattner5e225582004-11-21 03:37:42 +0000189 LazyResolverFn =
190 TheJIT->getJITInfo().getLazyResolverFunction(JITCompilerFn);
191 }
Chris Lattner54266522004-11-20 23:57:07 +0000192
193 /// getFunctionStub - This returns a pointer to a function stub, creating
194 /// one on demand as needed.
195 void *getFunctionStub(Function *F);
196
Chris Lattnerd91ff7c2005-04-18 01:44:27 +0000197 /// getExternalFunctionStub - Return a stub for the function at the
198 /// specified address, created lazily on demand.
199 void *getExternalFunctionStub(void *FnAddr);
200
Chris Lattner5e225582004-11-21 03:37:42 +0000201 /// AddCallbackAtLocation - If the target is capable of rewriting an
202 /// instruction without the use of a stub, record the location of the use so
203 /// we know which function is being used at the location.
204 void *AddCallbackAtLocation(Function *F, void *Location) {
Reid Spenceree448632005-07-12 15:51:55 +0000205 MutexGuard locked(TheJIT->lock);
Chris Lattner5e225582004-11-21 03:37:42 +0000206 /// Get the target-specific JIT resolver function.
Reid Spenceree448632005-07-12 15:51:55 +0000207 state.getStubToFunctionMap(locked)[Location] = F;
Chris Lattner5e225582004-11-21 03:37:42 +0000208 return (void*)LazyResolverFn;
209 }
210
Andrew Lenharth6a974612005-07-28 12:44:13 +0000211 /// getGOTIndexForAddress - Return a new or existing index in the GOT for
212 /// and address. This function only manages slots, it does not manage the
213 /// contents of the slots or the memory associated with the GOT.
214 unsigned getGOTIndexForAddr(void* addr);
215
Chris Lattner54266522004-11-20 23:57:07 +0000216 /// JITCompilerFn - This function is called to resolve a stub to a compiled
217 /// address. If the LLVM Function corresponding to the stub has not yet
218 /// been compiled, this function compiles it first.
219 static void *JITCompilerFn(void *Stub);
220 };
221}
222
223/// getJITResolver - This function returns the one instance of the JIT resolver.
224///
225static JITResolver &getJITResolver(MachineCodeEmitter *MCE = 0) {
226 static JITResolver TheJITResolver(*MCE);
227 return TheJITResolver;
228}
229
230/// getFunctionStub - This returns a pointer to a function stub, creating
231/// one on demand as needed.
232void *JITResolver::getFunctionStub(Function *F) {
Reid Spenceree448632005-07-12 15:51:55 +0000233 MutexGuard locked(TheJIT->lock);
234
Chris Lattner54266522004-11-20 23:57:07 +0000235 // If we already have a stub for this function, recycle it.
Reid Spenceree448632005-07-12 15:51:55 +0000236 void *&Stub = state.getFunctionToStubMap(locked)[F];
Chris Lattner54266522004-11-20 23:57:07 +0000237 if (Stub) return Stub;
238
Chris Lattnerb43dbdc2004-11-22 07:24:43 +0000239 // Call the lazy resolver function unless we already KNOW it is an external
240 // function, in which case we just skip the lazy resolution step.
241 void *Actual = (void*)LazyResolverFn;
Chris Lattner69435702005-02-20 18:43:35 +0000242 if (F->isExternal() && F->hasExternalLinkage())
Chris Lattnerb43dbdc2004-11-22 07:24:43 +0000243 Actual = TheJIT->getPointerToFunction(F);
Misha Brukmanf976c852005-04-21 22:55:34 +0000244
Chris Lattner54266522004-11-20 23:57:07 +0000245 // Otherwise, codegen a new stub. For now, the stub will call the lazy
246 // resolver function.
Chris Lattnerb43dbdc2004-11-22 07:24:43 +0000247 Stub = TheJIT->getJITInfo().emitFunctionStub(Actual, MCE);
248
Chris Lattner69435702005-02-20 18:43:35 +0000249 if (Actual != (void*)LazyResolverFn) {
Chris Lattnerb43dbdc2004-11-22 07:24:43 +0000250 // If we are getting the stub for an external function, we really want the
251 // address of the stub in the GlobalAddressMap for the JIT, not the address
252 // of the external function.
253 TheJIT->updateGlobalMapping(F, Stub);
254 }
Chris Lattner54266522004-11-20 23:57:07 +0000255
Chris Lattnercb479412004-11-21 03:44:32 +0000256 DEBUG(std::cerr << "JIT: Stub emitted at [" << Stub << "] for function '"
Chris Lattner6f717202004-11-22 21:48:33 +0000257 << F->getName() << "'\n");
Chris Lattnercb479412004-11-21 03:44:32 +0000258
Chris Lattner54266522004-11-20 23:57:07 +0000259 // Finally, keep track of the stub-to-Function mapping so that the
260 // JITCompilerFn knows which function to compile!
Reid Spenceree448632005-07-12 15:51:55 +0000261 state.getStubToFunctionMap(locked)[Stub] = F;
Chris Lattner54266522004-11-20 23:57:07 +0000262 return Stub;
263}
264
Chris Lattnerd91ff7c2005-04-18 01:44:27 +0000265/// getExternalFunctionStub - Return a stub for the function at the
266/// specified address, created lazily on demand.
267void *JITResolver::getExternalFunctionStub(void *FnAddr) {
268 // If we already have a stub for this function, recycle it.
269 void *&Stub = ExternalFnToStubMap[FnAddr];
270 if (Stub) return Stub;
271
272 Stub = TheJIT->getJITInfo().emitFunctionStub(FnAddr, MCE);
273 DEBUG(std::cerr << "JIT: Stub emitted at [" << Stub
274 << "] for external function at '" << FnAddr << "'\n");
275 return Stub;
276}
277
Andrew Lenharth6a974612005-07-28 12:44:13 +0000278unsigned JITResolver::getGOTIndexForAddr(void* addr) {
279 unsigned idx = revGOTMap[addr];
280 if (!idx) {
281 idx = ++nextGOTIndex;
282 revGOTMap[addr] = idx;
283 DEBUG(std::cerr << "Adding GOT entry " << idx
284 << " for addr " << addr << "\n");
285 // ((void**)MemMgr.getGOTBase())[idx] = addr;
286 }
287 return idx;
288}
Chris Lattnerd91ff7c2005-04-18 01:44:27 +0000289
Chris Lattner54266522004-11-20 23:57:07 +0000290/// JITCompilerFn - This function is called when a lazy compilation stub has
291/// been entered. It looks up which function this stub corresponds to, compiles
292/// it if necessary, then returns the resultant function pointer.
293void *JITResolver::JITCompilerFn(void *Stub) {
294 JITResolver &JR = getJITResolver();
Misha Brukmanf976c852005-04-21 22:55:34 +0000295
Reid Spenceree448632005-07-12 15:51:55 +0000296 MutexGuard locked(TheJIT->lock);
297
Chris Lattner54266522004-11-20 23:57:07 +0000298 // The address given to us for the stub may not be exactly right, it might be
299 // a little bit after the stub. As such, use upper_bound to find it.
300 std::map<void*, Function*>::iterator I =
Reid Spenceree448632005-07-12 15:51:55 +0000301 JR.state.getStubToFunctionMap(locked).upper_bound(Stub);
Chris Lattner21998772006-01-07 06:20:51 +0000302 assert(I != JR.state.getStubToFunctionMap(locked).begin() &&
303 "This is not a known stub!");
Chris Lattner54266522004-11-20 23:57:07 +0000304 Function *F = (--I)->second;
305
Reid Spenceree448632005-07-12 15:51:55 +0000306 // We might like to remove the stub from the StubToFunction map.
307 // We can't do that! Multiple threads could be stuck, waiting to acquire the
308 // lock above. As soon as the 1st function finishes compiling the function,
Chris Lattner21998772006-01-07 06:20:51 +0000309 // the next one will be released, and needs to be able to find the function it
310 // needs to call.
Reid Spenceree448632005-07-12 15:51:55 +0000311 //JR.state.getStubToFunctionMap(locked).erase(I);
Chris Lattner54266522004-11-20 23:57:07 +0000312
Chris Lattnercb479412004-11-21 03:44:32 +0000313 DEBUG(std::cerr << "JIT: Lazily resolving function '" << F->getName()
Chris Lattner54266522004-11-20 23:57:07 +0000314 << "' In stub ptr = " << Stub << " actual ptr = "
315 << I->first << "\n");
316
317 void *Result = TheJIT->getPointerToFunction(F);
318
319 // We don't need to reuse this stub in the future, as F is now compiled.
Reid Spenceree448632005-07-12 15:51:55 +0000320 JR.state.getFunctionToStubMap(locked).erase(F);
Chris Lattner54266522004-11-20 23:57:07 +0000321
322 // FIXME: We could rewrite all references to this stub if we knew them.
Andrew Lenharth6a974612005-07-28 12:44:13 +0000323
Jeff Cohend29b6aa2005-07-30 18:33:25 +0000324 // What we will do is set the compiled function address to map to the
325 // same GOT entry as the stub so that later clients may update the GOT
Andrew Lenharth6a974612005-07-28 12:44:13 +0000326 // if they see it still using the stub address.
327 // Note: this is done so the Resolver doesn't have to manage GOT memory
328 // Do this without allocating map space if the target isn't using a GOT
329 if(JR.revGOTMap.find(Stub) != JR.revGOTMap.end())
330 JR.revGOTMap[Result] = JR.revGOTMap[Stub];
331
Chris Lattner54266522004-11-20 23:57:07 +0000332 return Result;
333}
Chris Lattner688506d2003-08-14 18:35:27 +0000334
335
Chris Lattnere518b712004-12-05 07:19:16 +0000336// getPointerToFunctionOrStub - If the specified function has been
337// code-gen'd, return a pointer to the function. If not, compile it, or use
338// a stub to implement lazy compilation if available.
339//
340void *JIT::getPointerToFunctionOrStub(Function *F) {
341 // If we have already code generated the function, just return the address.
342 if (void *Addr = getPointerToGlobalIfAvailable(F))
343 return Addr;
344
345 // Get a stub if the target supports it
346 return getJITResolver(MCE).getFunctionStub(F);
347}
348
349
350
Chris Lattner54266522004-11-20 23:57:07 +0000351//===----------------------------------------------------------------------===//
Chris Lattner166f2262004-11-22 22:00:25 +0000352// JITEmitter code.
Chris Lattner54266522004-11-20 23:57:07 +0000353//
Chris Lattner688506d2003-08-14 18:35:27 +0000354namespace {
Chris Lattner166f2262004-11-22 22:00:25 +0000355 /// JITEmitter - The JIT implementation of the MachineCodeEmitter, which is
356 /// used to output functions to memory for execution.
357 class JITEmitter : public MachineCodeEmitter {
Chris Lattner688506d2003-08-14 18:35:27 +0000358 JITMemoryManager MemMgr;
359
Chris Lattner6125fdd2003-05-09 03:30:07 +0000360 // When outputting a function stub in the context of some other function, we
Chris Lattner43b429b2006-05-02 18:27:26 +0000361 // save BufferBegin/BufferEnd/CurBufferPtr here.
362 unsigned char *SavedBufferBegin, *SavedBufferEnd, *SavedCurBufferPtr;
Chris Lattnerbba1b6d2003-06-01 23:24:36 +0000363
Chris Lattner5be478f2004-11-20 03:46:14 +0000364 /// Relocations - These are the relocations that the function needs, as
365 /// emitted.
366 std::vector<MachineRelocation> Relocations;
Andrew Lenharth16ec33c2005-07-22 20:48:12 +0000367
Chris Lattner239862c2006-02-09 04:49:59 +0000368 /// ConstantPool - The constant pool for the current function.
369 ///
370 MachineConstantPool *ConstantPool;
371
372 /// ConstantPoolBase - A pointer to the first entry in the constant pool.
373 ///
374 void *ConstantPoolBase;
Nate Begeman37efe672006-04-22 18:53:45 +0000375
376 /// ConstantPool - The constant pool for the current function.
377 ///
378 MachineJumpTableInfo *JumpTable;
379
380 /// JumpTableBase - A pointer to the first entry in the jump table.
381 ///
382 void *JumpTableBase;
383public:
Chris Lattner239862c2006-02-09 04:49:59 +0000384 JITEmitter(JIT &jit) : MemMgr(jit.getJITInfo().needsGOT()) {
Jeff Cohen00b168892005-07-27 06:12:32 +0000385 TheJIT = &jit;
Chris Lattnera726c7f2006-05-02 21:44:14 +0000386 DEBUG(if (MemMgr.isManagingGOT()) std::cerr << "JIT is managing a GOT\n");
Andrew Lenharth16ec33c2005-07-22 20:48:12 +0000387 }
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000388
389 virtual void startFunction(MachineFunction &F);
Chris Lattner43b429b2006-05-02 18:27:26 +0000390 virtual bool finishFunction(MachineFunction &F);
Chris Lattnerf75f9be2006-05-02 23:22:24 +0000391
392 void emitConstantPool(MachineConstantPool *MCP);
393 void initJumpTableInfo(MachineJumpTableInfo *MJTI);
Nate Begeman37efe672006-04-22 18:53:45 +0000394 virtual void emitJumpTableInfo(MachineJumpTableInfo *MJTI,
395 std::map<MachineBasicBlock*,uint64_t> &MBBM);
Chris Lattnerf75f9be2006-05-02 23:22:24 +0000396
Chris Lattner54266522004-11-20 23:57:07 +0000397 virtual void startFunctionStub(unsigned StubSize);
398 virtual void* finishFunctionStub(const Function *F);
Chris Lattnerbba1b6d2003-06-01 23:24:36 +0000399
Chris Lattner5be478f2004-11-20 03:46:14 +0000400 virtual void addRelocation(const MachineRelocation &MR) {
401 Relocations.push_back(MR);
402 }
403
Chris Lattnerbba1b6d2003-06-01 23:24:36 +0000404 virtual uint64_t getConstantPoolEntryAddress(unsigned Entry);
Nate Begeman37efe672006-04-22 18:53:45 +0000405 virtual uint64_t getJumpTableEntryAddress(unsigned Entry);
Chris Lattnerbba1b6d2003-06-01 23:24:36 +0000406
Chris Lattner54266522004-11-20 23:57:07 +0000407 private:
Chris Lattner5e225582004-11-21 03:37:42 +0000408 void *getPointerToGlobal(GlobalValue *GV, void *Reference, bool NoNeedStub);
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000409 };
410}
411
Chris Lattner4d326fa2003-12-20 01:46:27 +0000412MachineCodeEmitter *JIT::createEmitter(JIT &jit) {
Chris Lattner166f2262004-11-22 22:00:25 +0000413 return new JITEmitter(jit);
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000414}
415
Chris Lattner166f2262004-11-22 22:00:25 +0000416void *JITEmitter::getPointerToGlobal(GlobalValue *V, void *Reference,
417 bool DoesntNeedStub) {
Chris Lattner54266522004-11-20 23:57:07 +0000418 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
419 /// FIXME: If we straightened things out, this could actually emit the
420 /// global immediately instead of queuing it for codegen later!
Chris Lattner54266522004-11-20 23:57:07 +0000421 return TheJIT->getOrEmitGlobalVariable(GV);
422 }
423
424 // If we have already compiled the function, return a pointer to its body.
425 Function *F = cast<Function>(V);
426 void *ResultPtr = TheJIT->getPointerToGlobalIfAvailable(F);
427 if (ResultPtr) return ResultPtr;
428
Chris Lattner532343b2004-11-30 17:41:49 +0000429 if (F->hasExternalLinkage() && F->isExternal()) {
Chris Lattner54266522004-11-20 23:57:07 +0000430 // If this is an external function pointer, we can force the JIT to
431 // 'compile' it, which really just adds it to the map.
Chris Lattnerb43dbdc2004-11-22 07:24:43 +0000432 if (DoesntNeedStub)
433 return TheJIT->getPointerToFunction(F);
434
435 return getJITResolver(this).getFunctionStub(F);
Chris Lattner54266522004-11-20 23:57:07 +0000436 }
437
Chris Lattner5e225582004-11-21 03:37:42 +0000438 // Okay, the function has not been compiled yet, if the target callback
439 // mechanism is capable of rewriting the instruction directly, prefer to do
440 // that instead of emitting a stub.
441 if (DoesntNeedStub)
442 return getJITResolver(this).AddCallbackAtLocation(F, Reference);
443
Chris Lattner54266522004-11-20 23:57:07 +0000444 // Otherwise, we have to emit a lazy resolving stub.
445 return getJITResolver(this).getFunctionStub(F);
446}
447
Chris Lattner166f2262004-11-22 22:00:25 +0000448void JITEmitter::startFunction(MachineFunction &F) {
Chris Lattner43b429b2006-05-02 18:27:26 +0000449 BufferBegin = CurBufferPtr = MemMgr.startFunctionBody();
Chris Lattner43b429b2006-05-02 18:27:26 +0000450
451 /// FIXME: implement out of space handling correctly!
452 BufferEnd = (unsigned char*)(intptr_t)~0ULL;
Chris Lattnerf75f9be2006-05-02 23:22:24 +0000453
454 emitConstantPool(F.getConstantPool());
455 initJumpTableInfo(F.getJumpTableInfo());
456
457 // About to start emitting the machine code for the function.
458 // FIXME: align it?
459 TheJIT->updateGlobalMapping(F.getFunction(), CurBufferPtr);
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000460}
461
Chris Lattner43b429b2006-05-02 18:27:26 +0000462bool JITEmitter::finishFunction(MachineFunction &F) {
463 MemMgr.endFunctionBody(CurBufferPtr);
464 NumBytes += getCurrentPCOffset();
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000465
Chris Lattner5be478f2004-11-20 03:46:14 +0000466 if (!Relocations.empty()) {
Chris Lattnere884dc22005-07-20 16:29:20 +0000467 NumRelos += Relocations.size();
468
Chris Lattner5be478f2004-11-20 03:46:14 +0000469 // Resolve the relocations to concrete pointers.
470 for (unsigned i = 0, e = Relocations.size(); i != e; ++i) {
471 MachineRelocation &MR = Relocations[i];
472 void *ResultPtr;
Chris Lattnerd91ff7c2005-04-18 01:44:27 +0000473 if (MR.isString()) {
Chris Lattner5be478f2004-11-20 03:46:14 +0000474 ResultPtr = TheJIT->getPointerToNamedFunction(MR.getString());
Misha Brukmanf976c852005-04-21 22:55:34 +0000475
Chris Lattnerd91ff7c2005-04-18 01:44:27 +0000476 // If the target REALLY wants a stub for this function, emit it now.
477 if (!MR.doesntNeedFunctionStub())
478 ResultPtr = getJITResolver(this).getExternalFunctionStub(ResultPtr);
Jeff Cohen00b168892005-07-27 06:12:32 +0000479 } else if (MR.isGlobalValue())
Chris Lattner5e225582004-11-21 03:37:42 +0000480 ResultPtr = getPointerToGlobal(MR.getGlobalValue(),
Chris Lattner43b429b2006-05-02 18:27:26 +0000481 BufferBegin+MR.getMachineCodeOffset(),
Chris Lattner5e225582004-11-21 03:37:42 +0000482 MR.doesntNeedFunctionStub());
Andrew Lenharth16ec33c2005-07-22 20:48:12 +0000483 else //ConstantPoolIndex
Jeff Cohen00b168892005-07-27 06:12:32 +0000484 ResultPtr =
Chris Lattnerd6bbac52005-07-25 23:42:58 +0000485 (void*)(intptr_t)getConstantPoolEntryAddress(MR.getConstantPoolIndex());
Jeff Cohen00b168892005-07-27 06:12:32 +0000486
Chris Lattner5be478f2004-11-20 03:46:14 +0000487 MR.setResultPointer(ResultPtr);
Andrew Lenharth16ec33c2005-07-22 20:48:12 +0000488
Andrew Lenharth6a974612005-07-28 12:44:13 +0000489 // if we are managing the GOT and the relocation wants an index,
490 // give it one
491 if (MemMgr.isManagingGOT() && !MR.isConstantPoolIndex() &&
492 MR.isGOTRelative()) {
493 unsigned idx = getJITResolver(this).getGOTIndexForAddr(ResultPtr);
494 MR.setGOTIndex(idx);
495 if (((void**)MemMgr.getGOTBase())[idx] != ResultPtr) {
496 DEBUG(std::cerr << "GOT was out of date for " << ResultPtr
Chris Lattner21998772006-01-07 06:20:51 +0000497 << " pointing at " << ((void**)MemMgr.getGOTBase())[idx]
498 << "\n");
Andrew Lenharth6a974612005-07-28 12:44:13 +0000499 ((void**)MemMgr.getGOTBase())[idx] = ResultPtr;
500 }
Andrew Lenharth16ec33c2005-07-22 20:48:12 +0000501 }
Chris Lattner5be478f2004-11-20 03:46:14 +0000502 }
503
Chris Lattner43b429b2006-05-02 18:27:26 +0000504 TheJIT->getJITInfo().relocate(BufferBegin, &Relocations[0],
Andrew Lenharth16ec33c2005-07-22 20:48:12 +0000505 Relocations.size(), MemMgr.getGOTBase());
Chris Lattner5be478f2004-11-20 03:46:14 +0000506 }
507
Andrew Lenharth6a974612005-07-28 12:44:13 +0000508 //Update the GOT entry for F to point to the new code.
509 if(MemMgr.isManagingGOT()) {
Chris Lattner43b429b2006-05-02 18:27:26 +0000510 unsigned idx = getJITResolver(this).getGOTIndexForAddr((void*)BufferBegin);
511 if (((void**)MemMgr.getGOTBase())[idx] != (void*)BufferBegin) {
512 DEBUG(std::cerr << "GOT was out of date for " << (void*)BufferBegin
Andrew Lenharth6a974612005-07-28 12:44:13 +0000513 << " pointing at " << ((void**)MemMgr.getGOTBase())[idx] << "\n");
Chris Lattner43b429b2006-05-02 18:27:26 +0000514 ((void**)MemMgr.getGOTBase())[idx] = (void*)BufferBegin;
Andrew Lenharth6a974612005-07-28 12:44:13 +0000515 }
516 }
517
Chris Lattner43b429b2006-05-02 18:27:26 +0000518 DEBUG(std::cerr << "JIT: Finished CodeGen of [" << (void*)BufferBegin
Misha Brukman1d440852003-06-06 06:52:35 +0000519 << "] Function: " << F.getFunction()->getName()
Chris Lattner43b429b2006-05-02 18:27:26 +0000520 << ": " << getCurrentPCOffset() << " bytes of text, "
Chris Lattner5be478f2004-11-20 03:46:14 +0000521 << Relocations.size() << " relocations\n");
522 Relocations.clear();
Chris Lattner43b429b2006-05-02 18:27:26 +0000523 return false;
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000524}
525
Chris Lattner166f2262004-11-22 22:00:25 +0000526void JITEmitter::emitConstantPool(MachineConstantPool *MCP) {
Chris Lattnerfa77d432006-02-09 04:22:52 +0000527 const std::vector<MachineConstantPoolEntry> &Constants = MCP->getConstants();
Chris Lattner2c0a6a12003-11-30 04:23:21 +0000528 if (Constants.empty()) return;
529
Chris Lattner3029f922006-02-09 04:46:04 +0000530 unsigned Size = Constants.back().Offset;
531 Size += TheJIT->getTargetData().getTypeSize(Constants.back().Val->getType());
Chris Lattner2c0a6a12003-11-30 04:23:21 +0000532
Chris Lattnerf75f9be2006-05-02 23:22:24 +0000533 ConstantPoolBase = allocateSpace(Size, 1 << MCP->getConstantPoolAlignment());
Chris Lattner239862c2006-02-09 04:49:59 +0000534 ConstantPool = MCP;
Chris Lattnerf75f9be2006-05-02 23:22:24 +0000535
536 if (ConstantPoolBase == 0) return; // Buffer overflow.
537
Chris Lattner239862c2006-02-09 04:49:59 +0000538 // Initialize the memory for all of the constant pool entries.
Chris Lattner3029f922006-02-09 04:46:04 +0000539 for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
Chris Lattner239862c2006-02-09 04:49:59 +0000540 void *CAddr = (char*)ConstantPoolBase+Constants[i].Offset;
Chris Lattner3029f922006-02-09 04:46:04 +0000541 TheJIT->InitializeMemory(Constants[i].Val, CAddr);
Chris Lattner1cc08382003-01-13 01:00:12 +0000542 }
543}
544
Nate Begeman37efe672006-04-22 18:53:45 +0000545void JITEmitter::initJumpTableInfo(MachineJumpTableInfo *MJTI) {
546 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
547 if (JT.empty()) return;
548
Chris Lattnerf75f9be2006-05-02 23:22:24 +0000549 unsigned NumEntries = 0;
Nate Begeman37efe672006-04-22 18:53:45 +0000550 for (unsigned i = 0, e = JT.size(); i != e; ++i)
Chris Lattnerf75f9be2006-05-02 23:22:24 +0000551 NumEntries += JT[i].MBBs.size();
552
553 unsigned EntrySize = MJTI->getEntrySize();
554
Nate Begeman37efe672006-04-22 18:53:45 +0000555 // Just allocate space for all the jump tables now. We will fix up the actual
556 // MBB entries in the tables after we emit the code for each block, since then
557 // we will know the final locations of the MBBs in memory.
558 JumpTable = MJTI;
Chris Lattnerf75f9be2006-05-02 23:22:24 +0000559 JumpTableBase = allocateSpace(NumEntries * EntrySize, MJTI->getAlignment());
Nate Begeman37efe672006-04-22 18:53:45 +0000560}
561
562void JITEmitter::emitJumpTableInfo(MachineJumpTableInfo *MJTI,
563 std::map<MachineBasicBlock*,uint64_t> &MBBM){
564 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
Chris Lattnerf75f9be2006-05-02 23:22:24 +0000565 if (JT.empty() || JumpTableBase == 0) return;
Nate Begeman37efe672006-04-22 18:53:45 +0000566
567 unsigned Offset = 0;
568 unsigned EntrySize = MJTI->getEntrySize();
569
570 // For each jump table, map each target in the jump table to the address of
571 // an emitted MachineBasicBlock.
572 for (unsigned i = 0, e = JT.size(); i != e; ++i) {
573 const std::vector<MachineBasicBlock*> &MBBs = JT[i].MBBs;
574 for (unsigned mi = 0, me = MBBs.size(); mi != me; ++mi) {
575 uint64_t addr = MBBM[MBBs[mi]];
576 GenericValue addrgv;
577 const Type *Ty;
578 if (EntrySize == 4) {
579 addrgv.UIntVal = addr;
580 Ty = Type::UIntTy;
581 } else if (EntrySize == 8) {
582 addrgv.ULongVal = addr;
583 Ty = Type::ULongTy;
584 } else {
585 assert(0 && "Unhandled jump table entry size!");
586 abort();
587 }
588 // Store the address of the basic block for this jump table slot in the
589 // memory we allocated for the jump table in 'initJumpTableInfo'
590 void *ptr = (void *)((char *)JumpTableBase + Offset);
591 TheJIT->StoreValueToMemory(addrgv, (GenericValue *)ptr, Ty);
592 Offset += EntrySize;
593 }
594 }
595}
596
Chris Lattner166f2262004-11-22 22:00:25 +0000597void JITEmitter::startFunctionStub(unsigned StubSize) {
Chris Lattner43b429b2006-05-02 18:27:26 +0000598 SavedBufferBegin = BufferBegin;
599 SavedBufferEnd = BufferEnd;
600 SavedCurBufferPtr = CurBufferPtr;
601
602 BufferBegin = CurBufferPtr = MemMgr.allocateStub(StubSize);
603 BufferEnd = BufferBegin+StubSize+1;
Chris Lattner6125fdd2003-05-09 03:30:07 +0000604}
605
Chris Lattner166f2262004-11-22 22:00:25 +0000606void *JITEmitter::finishFunctionStub(const Function *F) {
Chris Lattner43b429b2006-05-02 18:27:26 +0000607 NumBytes += getCurrentPCOffset();
608 std::swap(SavedBufferBegin, BufferBegin);
609 BufferEnd = SavedBufferEnd;
610 CurBufferPtr = SavedCurBufferPtr;
611 return SavedBufferBegin;
Chris Lattnerbba1b6d2003-06-01 23:24:36 +0000612}
613
Chris Lattnerbba1b6d2003-06-01 23:24:36 +0000614// getConstantPoolEntryAddress - Return the address of the 'ConstantNum' entry
615// in the constant pool that was last emitted with the 'emitConstantPool'
616// method.
617//
Chris Lattner166f2262004-11-22 22:00:25 +0000618uint64_t JITEmitter::getConstantPoolEntryAddress(unsigned ConstantNum) {
Chris Lattner239862c2006-02-09 04:49:59 +0000619 assert(ConstantNum < ConstantPool->getConstants().size() &&
Misha Brukman3c944972005-04-22 04:08:30 +0000620 "Invalid ConstantPoolIndex!");
Chris Lattner239862c2006-02-09 04:49:59 +0000621 return (intptr_t)ConstantPoolBase +
622 ConstantPool->getConstants()[ConstantNum].Offset;
Chris Lattnerbba1b6d2003-06-01 23:24:36 +0000623}
624
Nate Begeman37efe672006-04-22 18:53:45 +0000625// getJumpTableEntryAddress - Return the address of the JumpTable with index
626// 'Index' in the jumpp table that was last initialized with 'initJumpTableInfo'
627//
628uint64_t JITEmitter::getJumpTableEntryAddress(unsigned Index) {
629 const std::vector<MachineJumpTableEntry> &JT = JumpTable->getJumpTables();
630 assert(Index < JT.size() && "Invalid jump table index!");
631
632 unsigned Offset = 0;
633 unsigned EntrySize = JumpTable->getEntrySize();
634
635 for (unsigned i = 0; i < Index; ++i)
636 Offset += JT[i].MBBs.size() * EntrySize;
637
Nate Begemanc34b2272006-04-25 17:46:32 +0000638 return (intptr_t)((char *)JumpTableBase + Offset);
Nate Begeman37efe672006-04-22 18:53:45 +0000639}
640
Misha Brukmand69c1e62003-07-28 19:09:06 +0000641// getPointerToNamedFunction - This function is used as a global wrapper to
Chris Lattner4d326fa2003-12-20 01:46:27 +0000642// JIT::getPointerToNamedFunction for the purpose of resolving symbols when
Misha Brukmand69c1e62003-07-28 19:09:06 +0000643// bugpoint is debugging the JIT. In that scenario, we are loading an .so and
644// need to resolve function(s) that are being mis-codegenerated, so we need to
645// resolve their addresses at runtime, and this is the way to do it.
646extern "C" {
647 void *getPointerToNamedFunction(const char *Name) {
Chris Lattner4d326fa2003-12-20 01:46:27 +0000648 Module &M = TheJIT->getModule();
Misha Brukmand69c1e62003-07-28 19:09:06 +0000649 if (Function *F = M.getNamedFunction(Name))
Chris Lattner4d326fa2003-12-20 01:46:27 +0000650 return TheJIT->getPointerToFunction(F);
651 return TheJIT->getPointerToNamedFunction(Name);
Misha Brukmand69c1e62003-07-28 19:09:06 +0000652 }
653}