blob: 4a6cd715a5800111cbee35d841ab6d9abd1bb575 [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>
Chris Lattnerc19aade2003-12-08 08:06:28 +000033using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000034
Chris Lattnerbd199fb2002-12-24 00:01:05 +000035namespace {
Chris Lattnere7386562003-10-20 05:45:49 +000036 Statistic<> NumBytes("jit", "Number of bytes of machine code compiled");
Chris Lattnere884dc22005-07-20 16:29:20 +000037 Statistic<> NumRelos("jit", "Number of relocations applied");
Chris Lattner4d326fa2003-12-20 01:46:27 +000038 JIT *TheJIT = 0;
Chris Lattner54266522004-11-20 23:57:07 +000039}
Chris Lattnerbd199fb2002-12-24 00:01:05 +000040
Chris Lattner54266522004-11-20 23:57:07 +000041
42//===----------------------------------------------------------------------===//
43// JITMemoryManager code.
44//
45namespace {
Chris Lattner688506d2003-08-14 18:35:27 +000046 /// JITMemoryManager - Manage memory for the JIT code generation in a logical,
47 /// sane way. This splits a large block of MAP_NORESERVE'd memory into two
48 /// sections, one for function stubs, one for the functions themselves. We
49 /// have to do this because we may need to emit a function stub while in the
50 /// middle of emitting a function, and we don't know how large the function we
51 /// are emitting is. This never bothers to release the memory, because when
52 /// we are ready to destroy the JIT, the program exits.
53 class JITMemoryManager {
Chris Lattnere6fdcbf2006-05-03 00:54:49 +000054 std::vector<sys::MemoryBlock> Blocks; // Memory blocks allocated by the JIT
Chris Lattner688506d2003-08-14 18:35:27 +000055 unsigned char *FunctionBase; // Start of the function body area
Chris Lattnerf75f9be2006-05-02 23:22:24 +000056 unsigned char *CurStubPtr, *CurFunctionPtr;
Chris Lattnera726c7f2006-05-02 21:44:14 +000057 unsigned char *GOTBase; // Target Specific reserved memory
Andrew Lenhartha00269b2005-07-29 23:40:16 +000058
59 // centralize memory block allocation
60 sys::MemoryBlock getNewMemoryBlock(unsigned size);
Chris Lattner688506d2003-08-14 18:35:27 +000061 public:
Andrew Lenharth16ec33c2005-07-22 20:48:12 +000062 JITMemoryManager(bool useGOT);
Reid Spencer4af3da62004-12-13 16:04:04 +000063 ~JITMemoryManager();
Misha Brukmanf976c852005-04-21 22:55:34 +000064
Chris Lattner688506d2003-08-14 18:35:27 +000065 inline unsigned char *allocateStub(unsigned StubSize);
66 inline unsigned char *startFunctionBody();
Chris Lattner281a6012005-01-10 18:23:22 +000067 inline void endFunctionBody(unsigned char *FunctionEnd);
Chris Lattnera726c7f2006-05-02 21:44:14 +000068
69 unsigned char *getGOTBase() const {
70 return GOTBase;
71 }
72 bool isManagingGOT() const {
73 return GOTBase != NULL;
74 }
Chris Lattner688506d2003-08-14 18:35:27 +000075 };
76}
77
Andrew Lenharth16ec33c2005-07-22 20:48:12 +000078JITMemoryManager::JITMemoryManager(bool useGOT) {
Andrew Lenhartha00269b2005-07-29 23:40:16 +000079 // Allocate a 16M block of memory for functions
80 sys::MemoryBlock FunBlock = getNewMemoryBlock(16 << 20);
Andrew Lenharth16ec33c2005-07-22 20:48:12 +000081
Andrew Lenhartha00269b2005-07-29 23:40:16 +000082 FunctionBase = reinterpret_cast<unsigned char*>(FunBlock.base());
Chris Lattner281a6012005-01-10 18:23:22 +000083
Andrew Lenhartha00269b2005-07-29 23:40:16 +000084 // Allocate stubs backwards from the base, allocate functions forward
85 // from the base.
86 CurStubPtr = CurFunctionPtr = FunctionBase + 512*1024;// Use 512k for stubs
87
Chris Lattnerf5d438c2006-05-02 21:57:51 +000088 // Allocate the GOT.
Andrew Lenharth2b3b89c2005-08-01 17:35:40 +000089 GOTBase = NULL;
Chris Lattnerf5d438c2006-05-02 21:57:51 +000090 if (useGOT) GOTBase = (unsigned char*)malloc(sizeof(void*) * 8192);
Chris Lattner688506d2003-08-14 18:35:27 +000091}
92
Reid Spencer4af3da62004-12-13 16:04:04 +000093JITMemoryManager::~JITMemoryManager() {
Chris Lattnere6fdcbf2006-05-03 00:54:49 +000094 for (unsigned i = 0, e = Blocks.size(); i != e; ++i)
95 sys::Memory::ReleaseRWX(Blocks[i]);
Andrew Lenhartha00269b2005-07-29 23:40:16 +000096 Blocks.clear();
Reid Spencer4af3da62004-12-13 16:04:04 +000097}
98
Chris Lattner688506d2003-08-14 18:35:27 +000099unsigned char *JITMemoryManager::allocateStub(unsigned StubSize) {
100 CurStubPtr -= StubSize;
Andrew Lenhartha00269b2005-07-29 23:40:16 +0000101 if (CurStubPtr < FunctionBase) {
Chris Lattnera726c7f2006-05-02 21:44:14 +0000102 // FIXME: allocate a new block
Chris Lattner688506d2003-08-14 18:35:27 +0000103 std::cerr << "JIT ran out of memory for function stubs!\n";
104 abort();
105 }
106 return CurStubPtr;
107}
108
109unsigned char *JITMemoryManager::startFunctionBody() {
Chris Lattner0eb4d6b2006-05-03 01:03:20 +0000110 return CurFunctionPtr;
Chris Lattner688506d2003-08-14 18:35:27 +0000111}
112
113void JITMemoryManager::endFunctionBody(unsigned char *FunctionEnd) {
114 assert(FunctionEnd > CurFunctionPtr);
115 CurFunctionPtr = FunctionEnd;
116}
117
Andrew Lenhartha00269b2005-07-29 23:40:16 +0000118sys::MemoryBlock JITMemoryManager::getNewMemoryBlock(unsigned size) {
Andrew Lenhartha00269b2005-07-29 23:40:16 +0000119 try {
Chris Lattnere6fdcbf2006-05-03 00:54:49 +0000120 const sys::MemoryBlock *BOld = Blocks.empty() ? 0 : &Blocks.front();
121 sys::MemoryBlock B = sys::Memory::AllocateRWX(size, BOld);
122 Blocks.push_back(B);
123 return B;
124 } catch (std::string &err) {
Andrew Lenhartha00269b2005-07-29 23:40:16 +0000125 std::cerr << "Allocation failed when allocating new memory in the JIT\n";
126 std::cerr << err << "\n";
127 abort();
128 }
Andrew Lenhartha00269b2005-07-29 23:40:16 +0000129}
130
Chris Lattner54266522004-11-20 23:57:07 +0000131//===----------------------------------------------------------------------===//
132// JIT lazy compilation code.
133//
134namespace {
Reid Spenceree448632005-07-12 15:51:55 +0000135 class JITResolverState {
136 private:
137 /// FunctionToStubMap - Keep track of the stub created for a particular
138 /// function so that we can reuse them if necessary.
139 std::map<Function*, void*> FunctionToStubMap;
140
141 /// StubToFunctionMap - Keep track of the function that each stub
142 /// corresponds to.
143 std::map<void*, Function*> StubToFunctionMap;
Jeff Cohen00b168892005-07-27 06:12:32 +0000144
Reid Spenceree448632005-07-12 15:51:55 +0000145 public:
146 std::map<Function*, void*>& getFunctionToStubMap(const MutexGuard& locked) {
147 assert(locked.holds(TheJIT->lock));
148 return FunctionToStubMap;
149 }
Jeff Cohen00b168892005-07-27 06:12:32 +0000150
Reid Spenceree448632005-07-12 15:51:55 +0000151 std::map<void*, Function*>& getStubToFunctionMap(const MutexGuard& locked) {
152 assert(locked.holds(TheJIT->lock));
153 return StubToFunctionMap;
154 }
155 };
Jeff Cohen00b168892005-07-27 06:12:32 +0000156
Chris Lattner54266522004-11-20 23:57:07 +0000157 /// JITResolver - Keep track of, and resolve, call sites for functions that
158 /// have not yet been compiled.
159 class JITResolver {
Chris Lattner5e225582004-11-21 03:37:42 +0000160 /// MCE - The MachineCodeEmitter to use to emit stubs with.
Chris Lattner54266522004-11-20 23:57:07 +0000161 MachineCodeEmitter &MCE;
162
Chris Lattner5e225582004-11-21 03:37:42 +0000163 /// LazyResolverFn - The target lazy resolver function that we actually
164 /// rewrite instructions to use.
165 TargetJITInfo::LazyResolverFn LazyResolverFn;
166
Reid Spenceree448632005-07-12 15:51:55 +0000167 JITResolverState state;
Chris Lattner54266522004-11-20 23:57:07 +0000168
Chris Lattnerd91ff7c2005-04-18 01:44:27 +0000169 /// ExternalFnToStubMap - This is the equivalent of FunctionToStubMap for
170 /// external functions.
171 std::map<void*, void*> ExternalFnToStubMap;
Andrew Lenharth6a974612005-07-28 12:44:13 +0000172
173 //map addresses to indexes in the GOT
174 std::map<void*, unsigned> revGOTMap;
175 unsigned nextGOTIndex;
176
Chris Lattner54266522004-11-20 23:57:07 +0000177 public:
Andrew Lenharth6a974612005-07-28 12:44:13 +0000178 JITResolver(MachineCodeEmitter &mce) : MCE(mce), nextGOTIndex(0) {
Chris Lattner5e225582004-11-21 03:37:42 +0000179 LazyResolverFn =
180 TheJIT->getJITInfo().getLazyResolverFunction(JITCompilerFn);
181 }
Chris Lattner54266522004-11-20 23:57:07 +0000182
183 /// getFunctionStub - This returns a pointer to a function stub, creating
184 /// one on demand as needed.
185 void *getFunctionStub(Function *F);
186
Chris Lattnerd91ff7c2005-04-18 01:44:27 +0000187 /// getExternalFunctionStub - Return a stub for the function at the
188 /// specified address, created lazily on demand.
189 void *getExternalFunctionStub(void *FnAddr);
190
Chris Lattner5e225582004-11-21 03:37:42 +0000191 /// AddCallbackAtLocation - If the target is capable of rewriting an
192 /// instruction without the use of a stub, record the location of the use so
193 /// we know which function is being used at the location.
194 void *AddCallbackAtLocation(Function *F, void *Location) {
Reid Spenceree448632005-07-12 15:51:55 +0000195 MutexGuard locked(TheJIT->lock);
Chris Lattner5e225582004-11-21 03:37:42 +0000196 /// Get the target-specific JIT resolver function.
Reid Spenceree448632005-07-12 15:51:55 +0000197 state.getStubToFunctionMap(locked)[Location] = F;
Chris Lattner5e225582004-11-21 03:37:42 +0000198 return (void*)LazyResolverFn;
199 }
200
Andrew Lenharth6a974612005-07-28 12:44:13 +0000201 /// getGOTIndexForAddress - Return a new or existing index in the GOT for
202 /// and address. This function only manages slots, it does not manage the
203 /// contents of the slots or the memory associated with the GOT.
204 unsigned getGOTIndexForAddr(void* addr);
205
Chris Lattner54266522004-11-20 23:57:07 +0000206 /// JITCompilerFn - This function is called to resolve a stub to a compiled
207 /// address. If the LLVM Function corresponding to the stub has not yet
208 /// been compiled, this function compiles it first.
209 static void *JITCompilerFn(void *Stub);
210 };
211}
212
213/// getJITResolver - This function returns the one instance of the JIT resolver.
214///
215static JITResolver &getJITResolver(MachineCodeEmitter *MCE = 0) {
216 static JITResolver TheJITResolver(*MCE);
217 return TheJITResolver;
218}
219
220/// getFunctionStub - This returns a pointer to a function stub, creating
221/// one on demand as needed.
222void *JITResolver::getFunctionStub(Function *F) {
Reid Spenceree448632005-07-12 15:51:55 +0000223 MutexGuard locked(TheJIT->lock);
224
Chris Lattner54266522004-11-20 23:57:07 +0000225 // If we already have a stub for this function, recycle it.
Reid Spenceree448632005-07-12 15:51:55 +0000226 void *&Stub = state.getFunctionToStubMap(locked)[F];
Chris Lattner54266522004-11-20 23:57:07 +0000227 if (Stub) return Stub;
228
Chris Lattnerb43dbdc2004-11-22 07:24:43 +0000229 // Call the lazy resolver function unless we already KNOW it is an external
230 // function, in which case we just skip the lazy resolution step.
231 void *Actual = (void*)LazyResolverFn;
Chris Lattner69435702005-02-20 18:43:35 +0000232 if (F->isExternal() && F->hasExternalLinkage())
Chris Lattnerb43dbdc2004-11-22 07:24:43 +0000233 Actual = TheJIT->getPointerToFunction(F);
Misha Brukmanf976c852005-04-21 22:55:34 +0000234
Chris Lattner54266522004-11-20 23:57:07 +0000235 // Otherwise, codegen a new stub. For now, the stub will call the lazy
236 // resolver function.
Chris Lattnerb43dbdc2004-11-22 07:24:43 +0000237 Stub = TheJIT->getJITInfo().emitFunctionStub(Actual, MCE);
238
Chris Lattner69435702005-02-20 18:43:35 +0000239 if (Actual != (void*)LazyResolverFn) {
Chris Lattnerb43dbdc2004-11-22 07:24:43 +0000240 // If we are getting the stub for an external function, we really want the
241 // address of the stub in the GlobalAddressMap for the JIT, not the address
242 // of the external function.
243 TheJIT->updateGlobalMapping(F, Stub);
244 }
Chris Lattner54266522004-11-20 23:57:07 +0000245
Chris Lattnercb479412004-11-21 03:44:32 +0000246 DEBUG(std::cerr << "JIT: Stub emitted at [" << Stub << "] for function '"
Chris Lattner6f717202004-11-22 21:48:33 +0000247 << F->getName() << "'\n");
Chris Lattnercb479412004-11-21 03:44:32 +0000248
Chris Lattner54266522004-11-20 23:57:07 +0000249 // Finally, keep track of the stub-to-Function mapping so that the
250 // JITCompilerFn knows which function to compile!
Reid Spenceree448632005-07-12 15:51:55 +0000251 state.getStubToFunctionMap(locked)[Stub] = F;
Chris Lattner54266522004-11-20 23:57:07 +0000252 return Stub;
253}
254
Chris Lattnerd91ff7c2005-04-18 01:44:27 +0000255/// getExternalFunctionStub - Return a stub for the function at the
256/// specified address, created lazily on demand.
257void *JITResolver::getExternalFunctionStub(void *FnAddr) {
258 // If we already have a stub for this function, recycle it.
259 void *&Stub = ExternalFnToStubMap[FnAddr];
260 if (Stub) return Stub;
261
262 Stub = TheJIT->getJITInfo().emitFunctionStub(FnAddr, MCE);
263 DEBUG(std::cerr << "JIT: Stub emitted at [" << Stub
264 << "] for external function at '" << FnAddr << "'\n");
265 return Stub;
266}
267
Andrew Lenharth6a974612005-07-28 12:44:13 +0000268unsigned JITResolver::getGOTIndexForAddr(void* addr) {
269 unsigned idx = revGOTMap[addr];
270 if (!idx) {
271 idx = ++nextGOTIndex;
272 revGOTMap[addr] = idx;
273 DEBUG(std::cerr << "Adding GOT entry " << idx
274 << " for addr " << addr << "\n");
275 // ((void**)MemMgr.getGOTBase())[idx] = addr;
276 }
277 return idx;
278}
Chris Lattnerd91ff7c2005-04-18 01:44:27 +0000279
Chris Lattner54266522004-11-20 23:57:07 +0000280/// JITCompilerFn - This function is called when a lazy compilation stub has
281/// been entered. It looks up which function this stub corresponds to, compiles
282/// it if necessary, then returns the resultant function pointer.
283void *JITResolver::JITCompilerFn(void *Stub) {
284 JITResolver &JR = getJITResolver();
Misha Brukmanf976c852005-04-21 22:55:34 +0000285
Reid Spenceree448632005-07-12 15:51:55 +0000286 MutexGuard locked(TheJIT->lock);
287
Chris Lattner54266522004-11-20 23:57:07 +0000288 // The address given to us for the stub may not be exactly right, it might be
289 // a little bit after the stub. As such, use upper_bound to find it.
290 std::map<void*, Function*>::iterator I =
Reid Spenceree448632005-07-12 15:51:55 +0000291 JR.state.getStubToFunctionMap(locked).upper_bound(Stub);
Chris Lattner21998772006-01-07 06:20:51 +0000292 assert(I != JR.state.getStubToFunctionMap(locked).begin() &&
293 "This is not a known stub!");
Chris Lattner54266522004-11-20 23:57:07 +0000294 Function *F = (--I)->second;
295
Reid Spenceree448632005-07-12 15:51:55 +0000296 // We might like to remove the stub from the StubToFunction map.
297 // We can't do that! Multiple threads could be stuck, waiting to acquire the
298 // lock above. As soon as the 1st function finishes compiling the function,
Chris Lattner21998772006-01-07 06:20:51 +0000299 // the next one will be released, and needs to be able to find the function it
300 // needs to call.
Reid Spenceree448632005-07-12 15:51:55 +0000301 //JR.state.getStubToFunctionMap(locked).erase(I);
Chris Lattner54266522004-11-20 23:57:07 +0000302
Chris Lattnercb479412004-11-21 03:44:32 +0000303 DEBUG(std::cerr << "JIT: Lazily resolving function '" << F->getName()
Chris Lattner54266522004-11-20 23:57:07 +0000304 << "' In stub ptr = " << Stub << " actual ptr = "
305 << I->first << "\n");
306
307 void *Result = TheJIT->getPointerToFunction(F);
308
309 // We don't need to reuse this stub in the future, as F is now compiled.
Reid Spenceree448632005-07-12 15:51:55 +0000310 JR.state.getFunctionToStubMap(locked).erase(F);
Chris Lattner54266522004-11-20 23:57:07 +0000311
312 // FIXME: We could rewrite all references to this stub if we knew them.
Andrew Lenharth6a974612005-07-28 12:44:13 +0000313
Jeff Cohend29b6aa2005-07-30 18:33:25 +0000314 // What we will do is set the compiled function address to map to the
315 // same GOT entry as the stub so that later clients may update the GOT
Andrew Lenharth6a974612005-07-28 12:44:13 +0000316 // if they see it still using the stub address.
317 // Note: this is done so the Resolver doesn't have to manage GOT memory
318 // Do this without allocating map space if the target isn't using a GOT
319 if(JR.revGOTMap.find(Stub) != JR.revGOTMap.end())
320 JR.revGOTMap[Result] = JR.revGOTMap[Stub];
321
Chris Lattner54266522004-11-20 23:57:07 +0000322 return Result;
323}
Chris Lattner688506d2003-08-14 18:35:27 +0000324
325
Chris Lattnere518b712004-12-05 07:19:16 +0000326// getPointerToFunctionOrStub - If the specified function has been
327// code-gen'd, return a pointer to the function. If not, compile it, or use
328// a stub to implement lazy compilation if available.
329//
330void *JIT::getPointerToFunctionOrStub(Function *F) {
331 // If we have already code generated the function, just return the address.
332 if (void *Addr = getPointerToGlobalIfAvailable(F))
333 return Addr;
334
335 // Get a stub if the target supports it
336 return getJITResolver(MCE).getFunctionStub(F);
337}
338
339
340
Chris Lattner54266522004-11-20 23:57:07 +0000341//===----------------------------------------------------------------------===//
Chris Lattner166f2262004-11-22 22:00:25 +0000342// JITEmitter code.
Chris Lattner54266522004-11-20 23:57:07 +0000343//
Chris Lattner688506d2003-08-14 18:35:27 +0000344namespace {
Chris Lattner166f2262004-11-22 22:00:25 +0000345 /// JITEmitter - The JIT implementation of the MachineCodeEmitter, which is
346 /// used to output functions to memory for execution.
347 class JITEmitter : public MachineCodeEmitter {
Chris Lattner688506d2003-08-14 18:35:27 +0000348 JITMemoryManager MemMgr;
349
Chris Lattner6125fdd2003-05-09 03:30:07 +0000350 // When outputting a function stub in the context of some other function, we
Chris Lattner43b429b2006-05-02 18:27:26 +0000351 // save BufferBegin/BufferEnd/CurBufferPtr here.
352 unsigned char *SavedBufferBegin, *SavedBufferEnd, *SavedCurBufferPtr;
Chris Lattnerbba1b6d2003-06-01 23:24:36 +0000353
Chris Lattner5be478f2004-11-20 03:46:14 +0000354 /// Relocations - These are the relocations that the function needs, as
355 /// emitted.
356 std::vector<MachineRelocation> Relocations;
Chris Lattnerb4432f32006-05-03 17:10:41 +0000357
358 /// MBBLocations - This vector is a mapping from MBB ID's to their address.
359 /// It is filled in by the StartMachineBasicBlock callback and queried by
360 /// the getMachineBasicBlockAddress callback.
361 std::vector<intptr_t> MBBLocations;
Andrew Lenharth16ec33c2005-07-22 20:48:12 +0000362
Chris Lattner239862c2006-02-09 04:49:59 +0000363 /// ConstantPool - The constant pool for the current function.
364 ///
365 MachineConstantPool *ConstantPool;
366
367 /// ConstantPoolBase - A pointer to the first entry in the constant pool.
368 ///
369 void *ConstantPoolBase;
Nate Begeman37efe672006-04-22 18:53:45 +0000370
371 /// ConstantPool - The constant pool for the current function.
372 ///
373 MachineJumpTableInfo *JumpTable;
374
375 /// JumpTableBase - A pointer to the first entry in the jump table.
376 ///
377 void *JumpTableBase;
378public:
Chris Lattner239862c2006-02-09 04:49:59 +0000379 JITEmitter(JIT &jit) : MemMgr(jit.getJITInfo().needsGOT()) {
Jeff Cohen00b168892005-07-27 06:12:32 +0000380 TheJIT = &jit;
Chris Lattnera726c7f2006-05-02 21:44:14 +0000381 DEBUG(if (MemMgr.isManagingGOT()) std::cerr << "JIT is managing a GOT\n");
Andrew Lenharth16ec33c2005-07-22 20:48:12 +0000382 }
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000383
384 virtual void startFunction(MachineFunction &F);
Chris Lattner43b429b2006-05-02 18:27:26 +0000385 virtual bool finishFunction(MachineFunction &F);
Chris Lattnerf75f9be2006-05-02 23:22:24 +0000386
387 void emitConstantPool(MachineConstantPool *MCP);
388 void initJumpTableInfo(MachineJumpTableInfo *MJTI);
Chris Lattnerb4432f32006-05-03 17:10:41 +0000389 void emitJumpTableInfo(MachineJumpTableInfo *MJTI);
Chris Lattnerf75f9be2006-05-02 23:22:24 +0000390
Chris Lattner54266522004-11-20 23:57:07 +0000391 virtual void startFunctionStub(unsigned StubSize);
392 virtual void* finishFunctionStub(const Function *F);
Chris Lattnerbba1b6d2003-06-01 23:24:36 +0000393
Chris Lattner5be478f2004-11-20 03:46:14 +0000394 virtual void addRelocation(const MachineRelocation &MR) {
395 Relocations.push_back(MR);
396 }
Chris Lattnerb4432f32006-05-03 17:10:41 +0000397
398 virtual void StartMachineBasicBlock(MachineBasicBlock *MBB) {
399 if (MBBLocations.size() <= (unsigned)MBB->getNumber())
400 MBBLocations.resize((MBB->getNumber()+1)*2);
401 MBBLocations[MBB->getNumber()] = getCurrentPCValue();
402 }
Chris Lattner5be478f2004-11-20 03:46:14 +0000403
Chris Lattnerb4432f32006-05-03 17:10:41 +0000404 virtual intptr_t getConstantPoolEntryAddress(unsigned Entry) const;
405 virtual intptr_t getJumpTableEntryAddress(unsigned Entry) const;
406
407 virtual intptr_t getMachineBasicBlockAddress(MachineBasicBlock *MBB) const {
408 assert(MBBLocations.size() > (unsigned)MBB->getNumber() &&
409 MBBLocations[MBB->getNumber()] && "MBB not emitted!");
410 return MBBLocations[MBB->getNumber()];
411 }
412
Chris Lattnerbba1b6d2003-06-01 23:24:36 +0000413
Chris Lattner54266522004-11-20 23:57:07 +0000414 private:
Chris Lattner5e225582004-11-21 03:37:42 +0000415 void *getPointerToGlobal(GlobalValue *GV, void *Reference, bool NoNeedStub);
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000416 };
417}
418
Chris Lattner4d326fa2003-12-20 01:46:27 +0000419MachineCodeEmitter *JIT::createEmitter(JIT &jit) {
Chris Lattner166f2262004-11-22 22:00:25 +0000420 return new JITEmitter(jit);
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000421}
422
Chris Lattner166f2262004-11-22 22:00:25 +0000423void *JITEmitter::getPointerToGlobal(GlobalValue *V, void *Reference,
424 bool DoesntNeedStub) {
Chris Lattner54266522004-11-20 23:57:07 +0000425 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
426 /// FIXME: If we straightened things out, this could actually emit the
427 /// global immediately instead of queuing it for codegen later!
Chris Lattner54266522004-11-20 23:57:07 +0000428 return TheJIT->getOrEmitGlobalVariable(GV);
429 }
430
431 // If we have already compiled the function, return a pointer to its body.
432 Function *F = cast<Function>(V);
433 void *ResultPtr = TheJIT->getPointerToGlobalIfAvailable(F);
434 if (ResultPtr) return ResultPtr;
435
Chris Lattner532343b2004-11-30 17:41:49 +0000436 if (F->hasExternalLinkage() && F->isExternal()) {
Chris Lattner54266522004-11-20 23:57:07 +0000437 // If this is an external function pointer, we can force the JIT to
438 // 'compile' it, which really just adds it to the map.
Chris Lattnerb43dbdc2004-11-22 07:24:43 +0000439 if (DoesntNeedStub)
440 return TheJIT->getPointerToFunction(F);
441
442 return getJITResolver(this).getFunctionStub(F);
Chris Lattner54266522004-11-20 23:57:07 +0000443 }
444
Chris Lattner5e225582004-11-21 03:37:42 +0000445 // Okay, the function has not been compiled yet, if the target callback
446 // mechanism is capable of rewriting the instruction directly, prefer to do
447 // that instead of emitting a stub.
448 if (DoesntNeedStub)
449 return getJITResolver(this).AddCallbackAtLocation(F, Reference);
450
Chris Lattner54266522004-11-20 23:57:07 +0000451 // Otherwise, we have to emit a lazy resolving stub.
452 return getJITResolver(this).getFunctionStub(F);
453}
454
Chris Lattner166f2262004-11-22 22:00:25 +0000455void JITEmitter::startFunction(MachineFunction &F) {
Chris Lattner43b429b2006-05-02 18:27:26 +0000456 BufferBegin = CurBufferPtr = MemMgr.startFunctionBody();
Chris Lattner43b429b2006-05-02 18:27:26 +0000457
458 /// FIXME: implement out of space handling correctly!
459 BufferEnd = (unsigned char*)(intptr_t)~0ULL;
Chris Lattnerf75f9be2006-05-02 23:22:24 +0000460
461 emitConstantPool(F.getConstantPool());
462 initJumpTableInfo(F.getJumpTableInfo());
463
464 // About to start emitting the machine code for the function.
Chris Lattner0eb4d6b2006-05-03 01:03:20 +0000465 emitAlignment(std::max(F.getFunction()->getAlignment(), 8U));
Chris Lattnerf75f9be2006-05-02 23:22:24 +0000466 TheJIT->updateGlobalMapping(F.getFunction(), CurBufferPtr);
Chris Lattnerb4432f32006-05-03 17:10:41 +0000467
468 MBBLocations.clear();
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000469}
470
Chris Lattner43b429b2006-05-02 18:27:26 +0000471bool JITEmitter::finishFunction(MachineFunction &F) {
Chris Lattnerb4432f32006-05-03 17:10:41 +0000472 emitJumpTableInfo(F.getJumpTableInfo());
473
Chris Lattner43b429b2006-05-02 18:27:26 +0000474 MemMgr.endFunctionBody(CurBufferPtr);
475 NumBytes += getCurrentPCOffset();
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000476
Chris Lattner5be478f2004-11-20 03:46:14 +0000477 if (!Relocations.empty()) {
Chris Lattnere884dc22005-07-20 16:29:20 +0000478 NumRelos += Relocations.size();
479
Chris Lattner5be478f2004-11-20 03:46:14 +0000480 // Resolve the relocations to concrete pointers.
481 for (unsigned i = 0, e = Relocations.size(); i != e; ++i) {
482 MachineRelocation &MR = Relocations[i];
483 void *ResultPtr;
Chris Lattnerd91ff7c2005-04-18 01:44:27 +0000484 if (MR.isString()) {
Chris Lattner5be478f2004-11-20 03:46:14 +0000485 ResultPtr = TheJIT->getPointerToNamedFunction(MR.getString());
Misha Brukmanf976c852005-04-21 22:55:34 +0000486
Chris Lattnerd91ff7c2005-04-18 01:44:27 +0000487 // If the target REALLY wants a stub for this function, emit it now.
488 if (!MR.doesntNeedFunctionStub())
489 ResultPtr = getJITResolver(this).getExternalFunctionStub(ResultPtr);
Jeff Cohen00b168892005-07-27 06:12:32 +0000490 } else if (MR.isGlobalValue())
Chris Lattner5e225582004-11-21 03:37:42 +0000491 ResultPtr = getPointerToGlobal(MR.getGlobalValue(),
Chris Lattner43b429b2006-05-02 18:27:26 +0000492 BufferBegin+MR.getMachineCodeOffset(),
Chris Lattner5e225582004-11-21 03:37:42 +0000493 MR.doesntNeedFunctionStub());
Andrew Lenharth16ec33c2005-07-22 20:48:12 +0000494 else //ConstantPoolIndex
Jeff Cohen00b168892005-07-27 06:12:32 +0000495 ResultPtr =
Chris Lattnerd6bbac52005-07-25 23:42:58 +0000496 (void*)(intptr_t)getConstantPoolEntryAddress(MR.getConstantPoolIndex());
Jeff Cohen00b168892005-07-27 06:12:32 +0000497
Chris Lattner5be478f2004-11-20 03:46:14 +0000498 MR.setResultPointer(ResultPtr);
Andrew Lenharth16ec33c2005-07-22 20:48:12 +0000499
Andrew Lenharth6a974612005-07-28 12:44:13 +0000500 // if we are managing the GOT and the relocation wants an index,
501 // give it one
502 if (MemMgr.isManagingGOT() && !MR.isConstantPoolIndex() &&
503 MR.isGOTRelative()) {
504 unsigned idx = getJITResolver(this).getGOTIndexForAddr(ResultPtr);
505 MR.setGOTIndex(idx);
506 if (((void**)MemMgr.getGOTBase())[idx] != ResultPtr) {
507 DEBUG(std::cerr << "GOT was out of date for " << ResultPtr
Chris Lattner21998772006-01-07 06:20:51 +0000508 << " pointing at " << ((void**)MemMgr.getGOTBase())[idx]
509 << "\n");
Andrew Lenharth6a974612005-07-28 12:44:13 +0000510 ((void**)MemMgr.getGOTBase())[idx] = ResultPtr;
511 }
Andrew Lenharth16ec33c2005-07-22 20:48:12 +0000512 }
Chris Lattner5be478f2004-11-20 03:46:14 +0000513 }
514
Chris Lattner43b429b2006-05-02 18:27:26 +0000515 TheJIT->getJITInfo().relocate(BufferBegin, &Relocations[0],
Andrew Lenharth16ec33c2005-07-22 20:48:12 +0000516 Relocations.size(), MemMgr.getGOTBase());
Chris Lattner5be478f2004-11-20 03:46:14 +0000517 }
518
Andrew Lenharth6a974612005-07-28 12:44:13 +0000519 //Update the GOT entry for F to point to the new code.
520 if(MemMgr.isManagingGOT()) {
Chris Lattner43b429b2006-05-02 18:27:26 +0000521 unsigned idx = getJITResolver(this).getGOTIndexForAddr((void*)BufferBegin);
522 if (((void**)MemMgr.getGOTBase())[idx] != (void*)BufferBegin) {
523 DEBUG(std::cerr << "GOT was out of date for " << (void*)BufferBegin
Andrew Lenharth6a974612005-07-28 12:44:13 +0000524 << " pointing at " << ((void**)MemMgr.getGOTBase())[idx] << "\n");
Chris Lattner43b429b2006-05-02 18:27:26 +0000525 ((void**)MemMgr.getGOTBase())[idx] = (void*)BufferBegin;
Andrew Lenharth6a974612005-07-28 12:44:13 +0000526 }
527 }
528
Chris Lattner43b429b2006-05-02 18:27:26 +0000529 DEBUG(std::cerr << "JIT: Finished CodeGen of [" << (void*)BufferBegin
Misha Brukman1d440852003-06-06 06:52:35 +0000530 << "] Function: " << F.getFunction()->getName()
Chris Lattner43b429b2006-05-02 18:27:26 +0000531 << ": " << getCurrentPCOffset() << " bytes of text, "
Chris Lattner5be478f2004-11-20 03:46:14 +0000532 << Relocations.size() << " relocations\n");
533 Relocations.clear();
Chris Lattner43b429b2006-05-02 18:27:26 +0000534 return false;
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000535}
536
Chris Lattner166f2262004-11-22 22:00:25 +0000537void JITEmitter::emitConstantPool(MachineConstantPool *MCP) {
Chris Lattnerfa77d432006-02-09 04:22:52 +0000538 const std::vector<MachineConstantPoolEntry> &Constants = MCP->getConstants();
Chris Lattner2c0a6a12003-11-30 04:23:21 +0000539 if (Constants.empty()) return;
540
Chris Lattner3029f922006-02-09 04:46:04 +0000541 unsigned Size = Constants.back().Offset;
Owen Andersona69571c2006-05-03 01:29:57 +0000542 Size += TheJIT->getTargetData()->getTypeSize(Constants.back().Val->getType());
Chris Lattner2c0a6a12003-11-30 04:23:21 +0000543
Chris Lattnerf75f9be2006-05-02 23:22:24 +0000544 ConstantPoolBase = allocateSpace(Size, 1 << MCP->getConstantPoolAlignment());
Chris Lattner239862c2006-02-09 04:49:59 +0000545 ConstantPool = MCP;
Chris Lattnerf75f9be2006-05-02 23:22:24 +0000546
547 if (ConstantPoolBase == 0) return; // Buffer overflow.
548
Chris Lattner239862c2006-02-09 04:49:59 +0000549 // Initialize the memory for all of the constant pool entries.
Chris Lattner3029f922006-02-09 04:46:04 +0000550 for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
Chris Lattner239862c2006-02-09 04:49:59 +0000551 void *CAddr = (char*)ConstantPoolBase+Constants[i].Offset;
Chris Lattner3029f922006-02-09 04:46:04 +0000552 TheJIT->InitializeMemory(Constants[i].Val, CAddr);
Chris Lattner1cc08382003-01-13 01:00:12 +0000553 }
554}
555
Nate Begeman37efe672006-04-22 18:53:45 +0000556void JITEmitter::initJumpTableInfo(MachineJumpTableInfo *MJTI) {
557 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
558 if (JT.empty()) return;
559
Chris Lattnerf75f9be2006-05-02 23:22:24 +0000560 unsigned NumEntries = 0;
Nate Begeman37efe672006-04-22 18:53:45 +0000561 for (unsigned i = 0, e = JT.size(); i != e; ++i)
Chris Lattnerf75f9be2006-05-02 23:22:24 +0000562 NumEntries += JT[i].MBBs.size();
563
564 unsigned EntrySize = MJTI->getEntrySize();
565
Nate Begeman37efe672006-04-22 18:53:45 +0000566 // Just allocate space for all the jump tables now. We will fix up the actual
567 // MBB entries in the tables after we emit the code for each block, since then
568 // we will know the final locations of the MBBs in memory.
569 JumpTable = MJTI;
Chris Lattnerf75f9be2006-05-02 23:22:24 +0000570 JumpTableBase = allocateSpace(NumEntries * EntrySize, MJTI->getAlignment());
Nate Begeman37efe672006-04-22 18:53:45 +0000571}
572
Chris Lattnerb4432f32006-05-03 17:10:41 +0000573void JITEmitter::emitJumpTableInfo(MachineJumpTableInfo *MJTI) {
Nate Begeman37efe672006-04-22 18:53:45 +0000574 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
Chris Lattnerf75f9be2006-05-02 23:22:24 +0000575 if (JT.empty() || JumpTableBase == 0) return;
Nate Begeman37efe672006-04-22 18:53:45 +0000576
577 unsigned Offset = 0;
Chris Lattner32ca55f2006-05-03 00:13:06 +0000578 assert(MJTI->getEntrySize() == sizeof(void*) && "Cross JIT'ing?");
Nate Begeman37efe672006-04-22 18:53:45 +0000579
580 // For each jump table, map each target in the jump table to the address of
581 // an emitted MachineBasicBlock.
Chris Lattner32ca55f2006-05-03 00:13:06 +0000582 intptr_t *SlotPtr = (intptr_t*)JumpTableBase;
583
Nate Begeman37efe672006-04-22 18:53:45 +0000584 for (unsigned i = 0, e = JT.size(); i != e; ++i) {
585 const std::vector<MachineBasicBlock*> &MBBs = JT[i].MBBs;
Chris Lattner32ca55f2006-05-03 00:13:06 +0000586 // Store the address of the basic block for this jump table slot in the
587 // memory we allocated for the jump table in 'initJumpTableInfo'
588 for (unsigned mi = 0, me = MBBs.size(); mi != me; ++mi)
Chris Lattnerb4432f32006-05-03 17:10:41 +0000589 *SlotPtr++ = getMachineBasicBlockAddress(MBBs[mi]);
Nate Begeman37efe672006-04-22 18:53:45 +0000590 }
591}
592
Chris Lattner166f2262004-11-22 22:00:25 +0000593void JITEmitter::startFunctionStub(unsigned StubSize) {
Chris Lattner43b429b2006-05-02 18:27:26 +0000594 SavedBufferBegin = BufferBegin;
595 SavedBufferEnd = BufferEnd;
596 SavedCurBufferPtr = CurBufferPtr;
597
598 BufferBegin = CurBufferPtr = MemMgr.allocateStub(StubSize);
599 BufferEnd = BufferBegin+StubSize+1;
Chris Lattner6125fdd2003-05-09 03:30:07 +0000600}
601
Chris Lattner166f2262004-11-22 22:00:25 +0000602void *JITEmitter::finishFunctionStub(const Function *F) {
Chris Lattner43b429b2006-05-02 18:27:26 +0000603 NumBytes += getCurrentPCOffset();
604 std::swap(SavedBufferBegin, BufferBegin);
605 BufferEnd = SavedBufferEnd;
606 CurBufferPtr = SavedCurBufferPtr;
607 return SavedBufferBegin;
Chris Lattnerbba1b6d2003-06-01 23:24:36 +0000608}
609
Chris Lattnerbba1b6d2003-06-01 23:24:36 +0000610// getConstantPoolEntryAddress - Return the address of the 'ConstantNum' entry
611// in the constant pool that was last emitted with the 'emitConstantPool'
612// method.
613//
Chris Lattnerb4432f32006-05-03 17:10:41 +0000614intptr_t JITEmitter::getConstantPoolEntryAddress(unsigned ConstantNum) const {
Chris Lattner239862c2006-02-09 04:49:59 +0000615 assert(ConstantNum < ConstantPool->getConstants().size() &&
Misha Brukman3c944972005-04-22 04:08:30 +0000616 "Invalid ConstantPoolIndex!");
Chris Lattner239862c2006-02-09 04:49:59 +0000617 return (intptr_t)ConstantPoolBase +
618 ConstantPool->getConstants()[ConstantNum].Offset;
Chris Lattnerbba1b6d2003-06-01 23:24:36 +0000619}
620
Nate Begeman37efe672006-04-22 18:53:45 +0000621// getJumpTableEntryAddress - Return the address of the JumpTable with index
622// 'Index' in the jumpp table that was last initialized with 'initJumpTableInfo'
623//
Chris Lattnerb4432f32006-05-03 17:10:41 +0000624intptr_t JITEmitter::getJumpTableEntryAddress(unsigned Index) const {
Nate Begeman37efe672006-04-22 18:53:45 +0000625 const std::vector<MachineJumpTableEntry> &JT = JumpTable->getJumpTables();
626 assert(Index < JT.size() && "Invalid jump table index!");
627
628 unsigned Offset = 0;
629 unsigned EntrySize = JumpTable->getEntrySize();
630
631 for (unsigned i = 0; i < Index; ++i)
632 Offset += JT[i].MBBs.size() * EntrySize;
633
Nate Begemanc34b2272006-04-25 17:46:32 +0000634 return (intptr_t)((char *)JumpTableBase + Offset);
Nate Begeman37efe672006-04-22 18:53:45 +0000635}
636
Misha Brukmand69c1e62003-07-28 19:09:06 +0000637// getPointerToNamedFunction - This function is used as a global wrapper to
Chris Lattner4d326fa2003-12-20 01:46:27 +0000638// JIT::getPointerToNamedFunction for the purpose of resolving symbols when
Misha Brukmand69c1e62003-07-28 19:09:06 +0000639// bugpoint is debugging the JIT. In that scenario, we are loading an .so and
640// need to resolve function(s) that are being mis-codegenerated, so we need to
641// resolve their addresses at runtime, and this is the way to do it.
642extern "C" {
643 void *getPointerToNamedFunction(const char *Name) {
Chris Lattner4d326fa2003-12-20 01:46:27 +0000644 Module &M = TheJIT->getModule();
Misha Brukmand69c1e62003-07-28 19:09:06 +0000645 if (Function *F = M.getNamedFunction(Name))
Chris Lattner4d326fa2003-12-20 01:46:27 +0000646 return TheJIT->getPointerToFunction(F);
647 return TheJIT->getPointerToNamedFunction(Name);
Misha Brukmand69c1e62003-07-28 19:09:06 +0000648 }
649}