blob: 4cd8757ad0b87412da396366237bc7cd37a3aeff [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//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// 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"
Reid Kleckner27632172009-09-20 23:52:43 +000017#include "JITDebugRegisterer.h"
Nicolas Geoffrayafe6c2b2008-02-13 18:39:37 +000018#include "JITDwarfEmitter.h"
Reid Kleckner27632172009-09-20 23:52:43 +000019#include "llvm/ADT/OwningPtr.h"
Dale Johannesendd947ea2008-08-07 01:30:15 +000020#include "llvm/Constants.h"
Chris Lattner2c0a6a12003-11-30 04:23:21 +000021#include "llvm/Module.h"
Dale Johannesendd947ea2008-08-07 01:30:15 +000022#include "llvm/DerivedTypes.h"
Devang Patelc99fd872010-01-19 06:09:04 +000023#include "llvm/Analysis/DebugInfo.h"
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +000024#include "llvm/CodeGen/JITCodeEmitter.h"
Chris Lattnerbd199fb2002-12-24 00:01:05 +000025#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling47639fc2010-04-16 08:46:10 +000026#include "llvm/CodeGen/MachineCodeInfo.h"
Chris Lattner1cc08382003-01-13 01:00:12 +000027#include "llvm/CodeGen/MachineConstantPool.h"
Nate Begeman37efe672006-04-22 18:53:45 +000028#include "llvm/CodeGen/MachineJumpTableInfo.h"
Nicolas Geoffrayafe6c2b2008-02-13 18:39:37 +000029#include "llvm/CodeGen/MachineModuleInfo.h"
Chris Lattner5be478f2004-11-20 03:46:14 +000030#include "llvm/CodeGen/MachineRelocation.h"
Dale Johannesendd947ea2008-08-07 01:30:15 +000031#include "llvm/ExecutionEngine/GenericValue.h"
Jeffrey Yasskindf5a7da2009-06-25 02:04:04 +000032#include "llvm/ExecutionEngine/JITEventListener.h"
33#include "llvm/ExecutionEngine/JITMemoryManager.h"
Chris Lattner1cc08382003-01-13 01:00:12 +000034#include "llvm/Target/TargetData.h"
Bill Wendling47639fc2010-04-16 08:46:10 +000035#include "llvm/Target/TargetInstrInfo.h"
Chris Lattner5be478f2004-11-20 03:46:14 +000036#include "llvm/Target/TargetJITInfo.h"
Jim Laskeyacd80ac2006-12-14 19:17:33 +000037#include "llvm/Target/TargetMachine.h"
Nicolas Geoffrayafe6c2b2008-02-13 18:39:37 +000038#include "llvm/Target/TargetOptions.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000039#include "llvm/Support/Debug.h"
Torok Edwin7d696d82009-07-11 13:10:19 +000040#include "llvm/Support/ErrorHandling.h"
Jeffrey Yasskin40966a72010-02-11 01:07:39 +000041#include "llvm/Support/ManagedStatic.h"
Chris Lattnere7fd5532006-05-08 22:00:52 +000042#include "llvm/Support/MutexGuard.h"
Nick Lewycky848b3142009-04-19 18:32:03 +000043#include "llvm/Support/ValueHandle.h"
Torok Edwin7d696d82009-07-11 13:10:19 +000044#include "llvm/Support/raw_ostream.h"
Michael J. Spencer1f6efa32010-11-29 18:16:10 +000045#include "llvm/Support/Disassembler.h"
46#include "llvm/Support/Memory.h"
Jeffrey Yasskin1e861322009-10-20 18:13:21 +000047#include "llvm/ADT/DenseMap.h"
Evan Cheng47c01a02008-11-07 09:02:17 +000048#include "llvm/ADT/SmallPtrSet.h"
Nate Begemand6b7a242009-02-18 08:31:02 +000049#include "llvm/ADT/SmallVector.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000050#include "llvm/ADT/Statistic.h"
Jeffrey Yasskin23e5fcf2009-10-23 22:37:43 +000051#include "llvm/ADT/ValueMap.h"
Andrew Lenhartha00269b2005-07-29 23:40:16 +000052#include <algorithm>
Evan Chenga7916f52008-11-05 23:44:08 +000053#ifndef NDEBUG
54#include <iomanip>
55#endif
Chris Lattnerc19aade2003-12-08 08:06:28 +000056using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000057
Chris Lattner36343732006-12-19 22:43:32 +000058STATISTIC(NumBytes, "Number of bytes of machine code compiled");
59STATISTIC(NumRelos, "Number of relocations applied");
Reid Kleckner10b4fc52009-07-23 21:46:56 +000060STATISTIC(NumRetries, "Number of retries with more memory");
Chris Lattner54266522004-11-20 23:57:07 +000061
Andrew Lenhartha00269b2005-07-29 23:40:16 +000062
Jeffrey Yasskinc5818fb2009-12-22 23:47:23 +000063// A declaration may stop being a declaration once it's fully read from bitcode.
64// This function returns true if F is fully read and is still a declaration.
65static bool isNonGhostDeclaration(const Function *F) {
Jeffrey Yasskinf0356fe2010-01-27 20:34:15 +000066 return F->isDeclaration() && !F->isMaterializable();
Jeffrey Yasskinc5818fb2009-12-22 23:47:23 +000067}
68
Chris Lattner54266522004-11-20 23:57:07 +000069//===----------------------------------------------------------------------===//
70// JIT lazy compilation code.
71//
72namespace {
Jeffrey Yasskine637c192009-11-07 00:00:10 +000073 class JITEmitter;
Jeffrey Yasskin23e5fcf2009-10-23 22:37:43 +000074 class JITResolverState;
75
76 template<typename ValueTy>
77 struct NoRAUWValueMapConfig : public ValueMapConfig<ValueTy> {
78 typedef JITResolverState *ExtraData;
79 static void onRAUW(JITResolverState *, Value *Old, Value *New) {
80 assert(false && "The JIT doesn't know how to handle a"
81 " RAUW on a value it has emitted.");
82 }
83 };
84
85 struct CallSiteValueMapConfig : public NoRAUWValueMapConfig<Function*> {
86 typedef JITResolverState *ExtraData;
87 static void onDelete(JITResolverState *JRS, Function *F);
88 };
89
Reid Spenceree448632005-07-12 15:51:55 +000090 class JITResolverState {
Nick Lewyckye2bcf132009-04-27 05:09:44 +000091 public:
Jeffrey Yasskin23e5fcf2009-10-23 22:37:43 +000092 typedef ValueMap<Function*, void*, NoRAUWValueMapConfig<Function*> >
Jeffrey Yasskin108c8382009-11-23 23:35:19 +000093 FunctionToLazyStubMapTy;
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +000094 typedef std::map<void*, AssertingVH<Function> > CallSiteToFunctionMapTy;
Jeffrey Yasskin23e5fcf2009-10-23 22:37:43 +000095 typedef ValueMap<Function *, SmallPtrSet<void*, 1>,
96 CallSiteValueMapConfig> FunctionToCallSitesMapTy;
Nick Lewyckye2bcf132009-04-27 05:09:44 +000097 typedef std::map<AssertingVH<GlobalValue>, void*> GlobalToIndirectSymMapTy;
Reid Spenceree448632005-07-12 15:51:55 +000098 private:
Jeffrey Yasskin108c8382009-11-23 23:35:19 +000099 /// FunctionToLazyStubMap - Keep track of the lazy stub created for a
100 /// particular function so that we can reuse them if necessary.
101 FunctionToLazyStubMapTy FunctionToLazyStubMap;
Reid Spenceree448632005-07-12 15:51:55 +0000102
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000103 /// CallSiteToFunctionMap - Keep track of the function that each lazy call
104 /// site corresponds to, and vice versa.
105 CallSiteToFunctionMapTy CallSiteToFunctionMap;
106 FunctionToCallSitesMapTy FunctionToCallSitesMap;
Jeff Cohen00b168892005-07-27 06:12:32 +0000107
Evan Cheng5594f122008-11-10 01:52:24 +0000108 /// GlobalToIndirectSymMap - Keep track of the indirect symbol created for a
Evan Chengbe8c03f2008-01-04 10:46:51 +0000109 /// particular GlobalVariable so that we can reuse them if necessary.
Nick Lewyckye2bcf132009-04-27 05:09:44 +0000110 GlobalToIndirectSymMapTy GlobalToIndirectSymMap;
Evan Chengbe8c03f2008-01-04 10:46:51 +0000111
Jeffrey Yasskin40966a72010-02-11 01:07:39 +0000112 /// Instance of the JIT this ResolverState serves.
113 JIT *TheJIT;
114
Reid Spenceree448632005-07-12 15:51:55 +0000115 public:
Jeffrey Yasskin40966a72010-02-11 01:07:39 +0000116 JITResolverState(JIT *jit) : FunctionToLazyStubMap(this),
117 FunctionToCallSitesMap(this),
118 TheJIT(jit) {}
Jeffrey Yasskin23e5fcf2009-10-23 22:37:43 +0000119
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000120 FunctionToLazyStubMapTy& getFunctionToLazyStubMap(
121 const MutexGuard& locked) {
Reid Spenceree448632005-07-12 15:51:55 +0000122 assert(locked.holds(TheJIT->lock));
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000123 return FunctionToLazyStubMap;
Reid Spenceree448632005-07-12 15:51:55 +0000124 }
Jeff Cohen00b168892005-07-27 06:12:32 +0000125
Nick Lewyckye2bcf132009-04-27 05:09:44 +0000126 GlobalToIndirectSymMapTy& getGlobalToIndirectSymMap(const MutexGuard& locked) {
Evan Chengbe8c03f2008-01-04 10:46:51 +0000127 assert(locked.holds(TheJIT->lock));
Evan Cheng5594f122008-11-10 01:52:24 +0000128 return GlobalToIndirectSymMap;
Evan Chengbe8c03f2008-01-04 10:46:51 +0000129 }
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000130
131 pair<void *, Function *> LookupFunctionFromCallSite(
132 const MutexGuard &locked, void *CallSite) const {
133 assert(locked.holds(TheJIT->lock));
134
135 // The address given to us for the stub may not be exactly right, it might be
136 // a little bit after the stub. As such, use upper_bound to find it.
137 CallSiteToFunctionMapTy::const_iterator I =
138 CallSiteToFunctionMap.upper_bound(CallSite);
139 assert(I != CallSiteToFunctionMap.begin() &&
140 "This is not a known call site!");
141 --I;
142 return *I;
143 }
144
145 void AddCallSite(const MutexGuard &locked, void *CallSite, Function *F) {
146 assert(locked.holds(TheJIT->lock));
147
Jeffrey Yasskin23e5fcf2009-10-23 22:37:43 +0000148 bool Inserted = CallSiteToFunctionMap.insert(
149 std::make_pair(CallSite, F)).second;
150 (void)Inserted;
151 assert(Inserted && "Pair was already in CallSiteToFunctionMap");
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000152 FunctionToCallSitesMap[F].insert(CallSite);
153 }
154
Jeffrey Yasskin8e98d122010-03-04 00:32:33 +0000155 void EraseAllCallSitesForPrelocked(Function *F);
156
157 // Erases _all_ call sites regardless of their function. This is used to
158 // unregister the stub addresses from the StubToResolverMap in
159 // ~JITResolver().
160 void EraseAllCallSitesPrelocked();
Reid Spenceree448632005-07-12 15:51:55 +0000161 };
Jeff Cohen00b168892005-07-27 06:12:32 +0000162
Chris Lattner54266522004-11-20 23:57:07 +0000163 /// JITResolver - Keep track of, and resolve, call sites for functions that
164 /// have not yet been compiled.
165 class JITResolver {
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000166 typedef JITResolverState::FunctionToLazyStubMapTy FunctionToLazyStubMapTy;
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000167 typedef JITResolverState::CallSiteToFunctionMapTy CallSiteToFunctionMapTy;
Nick Lewyckye2bcf132009-04-27 05:09:44 +0000168 typedef JITResolverState::GlobalToIndirectSymMapTy GlobalToIndirectSymMapTy;
169
Chris Lattner5e225582004-11-21 03:37:42 +0000170 /// LazyResolverFn - The target lazy resolver function that we actually
171 /// rewrite instructions to use.
172 TargetJITInfo::LazyResolverFn LazyResolverFn;
173
Reid Spenceree448632005-07-12 15:51:55 +0000174 JITResolverState state;
Chris Lattner54266522004-11-20 23:57:07 +0000175
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000176 /// ExternalFnToStubMap - This is the equivalent of FunctionToLazyStubMap
177 /// for external functions. TODO: Of course, external functions don't need
178 /// a lazy stub. It's actually here to make it more likely that far calls
179 /// succeed, but no single stub can guarantee that. I'll remove this in a
180 /// subsequent checkin when I actually fix far calls.
Chris Lattnerd91ff7c2005-04-18 01:44:27 +0000181 std::map<void*, void*> ExternalFnToStubMap;
Andrew Lenharth6a974612005-07-28 12:44:13 +0000182
Evan Cheng1606e8e2009-03-13 07:51:59 +0000183 /// revGOTMap - map addresses to indexes in the GOT
Andrew Lenharth6a974612005-07-28 12:44:13 +0000184 std::map<void*, unsigned> revGOTMap;
185 unsigned nextGOTIndex;
186
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000187 JITEmitter &JE;
188
Jeffrey Yasskin40966a72010-02-11 01:07:39 +0000189 /// Instance of JIT corresponding to this Resolver.
190 JIT *TheJIT;
191
Chris Lattner54266522004-11-20 23:57:07 +0000192 public:
Jeffrey Yasskin40966a72010-02-11 01:07:39 +0000193 explicit JITResolver(JIT &jit, JITEmitter &je)
194 : state(&jit), nextGOTIndex(0), JE(je), TheJIT(&jit) {
Chris Lattnere7484012007-02-24 02:57:03 +0000195 LazyResolverFn = jit.getJITInfo().getLazyResolverFunction(JITCompilerFn);
Chris Lattner5e225582004-11-21 03:37:42 +0000196 }
Chris Lattner54266522004-11-20 23:57:07 +0000197
Jeffrey Yasskin8e98d122010-03-04 00:32:33 +0000198 ~JITResolver();
199
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000200 /// getLazyFunctionStubIfAvailable - This returns a pointer to a function's
201 /// lazy-compilation stub if it has already been created.
202 void *getLazyFunctionStubIfAvailable(Function *F);
Evan Cheng704bff92008-11-13 21:50:50 +0000203
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000204 /// getLazyFunctionStub - This returns a pointer to a function's
205 /// lazy-compilation stub, creating one on demand as needed.
206 void *getLazyFunctionStub(Function *F);
Chris Lattner54266522004-11-20 23:57:07 +0000207
Chris Lattnerd91ff7c2005-04-18 01:44:27 +0000208 /// getExternalFunctionStub - Return a stub for the function at the
209 /// specified address, created lazily on demand.
210 void *getExternalFunctionStub(void *FnAddr);
211
Evan Cheng5594f122008-11-10 01:52:24 +0000212 /// getGlobalValueIndirectSym - Return an indirect symbol containing the
Evan Chengc96a8e72008-11-05 01:50:32 +0000213 /// specified GV address.
Evan Cheng5594f122008-11-10 01:52:24 +0000214 void *getGlobalValueIndirectSym(GlobalValue *V, void *GVAddress);
Evan Chengbe8c03f2008-01-04 10:46:51 +0000215
Andrew Lenharth6a974612005-07-28 12:44:13 +0000216 /// getGOTIndexForAddress - Return a new or existing index in the GOT for
Chris Lattner8907b4b2007-12-05 23:39:57 +0000217 /// an address. This function only manages slots, it does not manage the
Andrew Lenharth6a974612005-07-28 12:44:13 +0000218 /// contents of the slots or the memory associated with the GOT.
Chris Lattner8907b4b2007-12-05 23:39:57 +0000219 unsigned getGOTIndexForAddr(void *addr);
Andrew Lenharth6a974612005-07-28 12:44:13 +0000220
Chris Lattner54266522004-11-20 23:57:07 +0000221 /// JITCompilerFn - This function is called to resolve a stub to a compiled
222 /// address. If the LLVM Function corresponding to the stub has not yet
223 /// been compiled, this function compiles it first.
224 static void *JITCompilerFn(void *Stub);
225 };
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000226
Jeffrey Yasskin40966a72010-02-11 01:07:39 +0000227 class StubToResolverMapTy {
228 /// Map a stub address to a specific instance of a JITResolver so that
229 /// lazily-compiled functions can find the right resolver to use.
230 ///
231 /// Guarded by Lock.
232 std::map<void*, JITResolver*> Map;
233
234 /// Guards Map from concurrent accesses.
235 mutable sys::Mutex Lock;
236
237 public:
238 /// Registers a Stub to be resolved by Resolver.
239 void RegisterStubResolver(void *Stub, JITResolver *Resolver) {
240 MutexGuard guard(Lock);
241 Map.insert(std::make_pair(Stub, Resolver));
242 }
243 /// Unregisters the Stub when it's invalidated.
244 void UnregisterStubResolver(void *Stub) {
245 MutexGuard guard(Lock);
246 Map.erase(Stub);
247 }
248 /// Returns the JITResolver instance that owns the Stub.
249 JITResolver *getResolverFromStub(void *Stub) const {
250 MutexGuard guard(Lock);
251 // The address given to us for the stub may not be exactly right, it might
252 // be a little bit after the stub. As such, use upper_bound to find it.
253 // This is the same trick as in LookupFunctionFromCallSite from
254 // JITResolverState.
255 std::map<void*, JITResolver*>::const_iterator I = Map.upper_bound(Stub);
256 assert(I != Map.begin() && "This is not a known stub!");
257 --I;
258 return I->second;
259 }
Jeffrey Yasskin8e98d122010-03-04 00:32:33 +0000260 /// True if any stubs refer to the given resolver. Only used in an assert().
261 /// O(N)
262 bool ResolverHasStubs(JITResolver* Resolver) const {
263 MutexGuard guard(Lock);
264 for (std::map<void*, JITResolver*>::const_iterator I = Map.begin(),
265 E = Map.end(); I != E; ++I) {
266 if (I->second == Resolver)
267 return true;
268 }
269 return false;
270 }
Jeffrey Yasskin40966a72010-02-11 01:07:39 +0000271 };
272 /// This needs to be static so that a lazy call stub can access it with no
273 /// context except the address of the stub.
274 ManagedStatic<StubToResolverMapTy> StubToResolverMap;
275
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000276 /// JITEmitter - The JIT implementation of the MachineCodeEmitter, which is
277 /// used to output functions to memory for execution.
278 class JITEmitter : public JITCodeEmitter {
279 JITMemoryManager *MemMgr;
280
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +0000281 // When outputting a function stub in the context of some other function, we
282 // save BufferBegin/BufferEnd/CurBufferPtr here.
283 uint8_t *SavedBufferBegin, *SavedBufferEnd, *SavedCurBufferPtr;
284
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000285 // When reattempting to JIT a function after running out of space, we store
286 // the estimated size of the function we're trying to JIT here, so we can
287 // ask the memory manager for at least this much space. When we
288 // successfully emit the function, we reset this back to zero.
289 uintptr_t SizeEstimate;
290
291 /// Relocations - These are the relocations that the function needs, as
292 /// emitted.
293 std::vector<MachineRelocation> Relocations;
Eric Christopher116664a2009-11-12 03:12:18 +0000294
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000295 /// MBBLocations - This vector is a mapping from MBB ID's to their address.
296 /// It is filled in by the StartMachineBasicBlock callback and queried by
297 /// the getMachineBasicBlockAddress callback.
298 std::vector<uintptr_t> MBBLocations;
299
300 /// ConstantPool - The constant pool for the current function.
301 ///
302 MachineConstantPool *ConstantPool;
303
304 /// ConstantPoolBase - A pointer to the first entry in the constant pool.
305 ///
306 void *ConstantPoolBase;
307
308 /// ConstPoolAddresses - Addresses of individual constant pool entries.
309 ///
310 SmallVector<uintptr_t, 8> ConstPoolAddresses;
311
312 /// JumpTable - The jump tables for the current function.
313 ///
314 MachineJumpTableInfo *JumpTable;
Eric Christopher116664a2009-11-12 03:12:18 +0000315
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000316 /// JumpTableBase - A pointer to the first entry in the jump table.
317 ///
318 void *JumpTableBase;
319
320 /// Resolver - This contains info about the currently resolved functions.
321 JITResolver Resolver;
322
323 /// DE - The dwarf emitter for the jit.
324 OwningPtr<JITDwarfEmitter> DE;
325
326 /// DR - The debug registerer for the jit.
327 OwningPtr<JITDebugRegisterer> DR;
328
Eric Christopher116664a2009-11-12 03:12:18 +0000329 /// LabelLocations - This vector is a mapping from Label ID's to their
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000330 /// address.
Chris Lattner16112732010-03-14 01:41:15 +0000331 DenseMap<MCSymbol*, uintptr_t> LabelLocations;
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000332
333 /// MMI - Machine module info for exception informations
334 MachineModuleInfo* MMI;
335
Eric Christopher116664a2009-11-12 03:12:18 +0000336 // CurFn - The llvm function being emitted. Only valid during
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000337 // finishFunction().
338 const Function *CurFn;
339
340 /// Information about emitted code, which is passed to the
341 /// JITEventListeners. This is reset in startFunction and used in
342 /// finishFunction.
343 JITEvent_EmittedFunctionDetails EmissionDetails;
344
345 struct EmittedCode {
346 void *FunctionBody; // Beginning of the function's allocation.
347 void *Code; // The address the function's code actually starts at.
348 void *ExceptionTable;
349 EmittedCode() : FunctionBody(0), Code(0), ExceptionTable(0) {}
350 };
351 struct EmittedFunctionConfig : public ValueMapConfig<const Function*> {
352 typedef JITEmitter *ExtraData;
353 static void onDelete(JITEmitter *, const Function*);
354 static void onRAUW(JITEmitter *, const Function*, const Function*);
355 };
356 ValueMap<const Function *, EmittedCode,
357 EmittedFunctionConfig> EmittedFunctions;
358
Nicolas Geoffray4eb37392010-04-14 22:06:37 +0000359 DebugLoc PrevDL;
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000360
Jeffrey Yasskin40966a72010-02-11 01:07:39 +0000361 /// Instance of the JIT
362 JIT *TheJIT;
363
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000364 public:
365 JITEmitter(JIT &jit, JITMemoryManager *JMM, TargetMachine &TM)
366 : SizeEstimate(0), Resolver(jit, *this), MMI(0), CurFn(0),
Nicolas Geoffray4eb37392010-04-14 22:06:37 +0000367 EmittedFunctions(this), TheJIT(&jit) {
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000368 MemMgr = JMM ? JMM : JITMemoryManager::CreateDefaultMemManager();
369 if (jit.getJITInfo().needsGOT()) {
370 MemMgr->AllocateGOT();
David Greenec9ec9932010-01-05 01:23:36 +0000371 DEBUG(dbgs() << "JIT is managing a GOT\n");
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000372 }
373
Duncan Sands57b6e9e2010-05-02 15:36:26 +0000374 if (JITExceptionHandling || JITEmitDebugInfo) {
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000375 DE.reset(new JITDwarfEmitter(jit));
376 }
377 if (JITEmitDebugInfo) {
378 DR.reset(new JITDebugRegisterer(TM));
379 }
380 }
Eric Christopher116664a2009-11-12 03:12:18 +0000381 ~JITEmitter() {
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000382 delete MemMgr;
383 }
384
385 /// classof - Methods for support type inquiry through isa, cast, and
386 /// dyn_cast:
387 ///
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000388 static inline bool classof(const MachineCodeEmitter*) { return true; }
Eric Christopher116664a2009-11-12 03:12:18 +0000389
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000390 JITResolver &getJITResolver() { return Resolver; }
391
392 virtual void startFunction(MachineFunction &F);
393 virtual bool finishFunction(MachineFunction &F);
Eric Christopher116664a2009-11-12 03:12:18 +0000394
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000395 void emitConstantPool(MachineConstantPool *MCP);
396 void initJumpTableInfo(MachineJumpTableInfo *MJTI);
397 void emitJumpTableInfo(MachineJumpTableInfo *MJTI);
Eric Christopher116664a2009-11-12 03:12:18 +0000398
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +0000399 void startGVStub(const GlobalValue* GV,
400 unsigned StubSize, unsigned Alignment = 1);
401 void startGVStub(void *Buffer, unsigned StubSize);
402 void finishGVStub();
403 virtual void *allocIndirectGV(const GlobalValue *GV,
404 const uint8_t *Buffer, size_t Size,
405 unsigned Alignment);
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000406
407 /// allocateSpace - Reserves space in the current block if any, or
408 /// allocate a new one of the given size.
409 virtual void *allocateSpace(uintptr_t Size, unsigned Alignment);
410
411 /// allocateGlobal - Allocate memory for a global. Unlike allocateSpace,
412 /// this method does not allocate memory in the current output buffer,
413 /// because a global may live longer than the current function.
414 virtual void *allocateGlobal(uintptr_t Size, unsigned Alignment);
415
416 virtual void addRelocation(const MachineRelocation &MR) {
417 Relocations.push_back(MR);
418 }
Eric Christopher116664a2009-11-12 03:12:18 +0000419
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000420 virtual void StartMachineBasicBlock(MachineBasicBlock *MBB) {
421 if (MBBLocations.size() <= (unsigned)MBB->getNumber())
422 MBBLocations.resize((MBB->getNumber()+1)*2);
423 MBBLocations[MBB->getNumber()] = getCurrentPCValue();
Chris Lattner68feb222010-07-11 23:07:28 +0000424 if (MBB->hasAddressTaken())
425 TheJIT->addPointerToBasicBlock(MBB->getBasicBlock(),
426 (void*)getCurrentPCValue());
David Greenec9ec9932010-01-05 01:23:36 +0000427 DEBUG(dbgs() << "JIT: Emitting BB" << MBB->getNumber() << " at ["
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000428 << (void*) getCurrentPCValue() << "]\n");
429 }
430
431 virtual uintptr_t getConstantPoolEntryAddress(unsigned Entry) const;
432 virtual uintptr_t getJumpTableEntryAddress(unsigned Entry) const;
433
Chris Lattner68feb222010-07-11 23:07:28 +0000434 virtual uintptr_t getMachineBasicBlockAddress(MachineBasicBlock *MBB) const{
Eric Christopher116664a2009-11-12 03:12:18 +0000435 assert(MBBLocations.size() > (unsigned)MBB->getNumber() &&
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000436 MBBLocations[MBB->getNumber()] && "MBB not emitted!");
437 return MBBLocations[MBB->getNumber()];
438 }
439
440 /// retryWithMoreMemory - Log a retry and deallocate all memory for the
441 /// given function. Increase the minimum allocation size so that we get
442 /// more memory next time.
443 void retryWithMoreMemory(MachineFunction &F);
444
445 /// deallocateMemForFunction - Deallocate all memory for the specified
446 /// function body.
447 void deallocateMemForFunction(const Function *F);
448
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000449 virtual void processDebugLoc(DebugLoc DL, bool BeforePrintingInsn);
450
Chris Lattner16112732010-03-14 01:41:15 +0000451 virtual void emitLabel(MCSymbol *Label) {
452 LabelLocations[Label] = getCurrentPCValue();
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000453 }
454
Bill Wendling47639fc2010-04-16 08:46:10 +0000455 virtual DenseMap<MCSymbol*, uintptr_t> *getLabelLocations() {
456 return &LabelLocations;
457 }
458
Chris Lattner16112732010-03-14 01:41:15 +0000459 virtual uintptr_t getLabelAddress(MCSymbol *Label) const {
460 assert(LabelLocations.count(Label) && "Label not emitted!");
461 return LabelLocations.find(Label)->second;
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000462 }
Eric Christopher116664a2009-11-12 03:12:18 +0000463
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000464 virtual void setModuleInfo(MachineModuleInfo* Info) {
465 MMI = Info;
466 if (DE.get()) DE->setModuleInfo(Info);
467 }
468
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000469 private:
Jeffrey Yasskin2d274412009-11-07 08:51:52 +0000470 void *getPointerToGlobal(GlobalValue *GV, void *Reference,
471 bool MayNeedFarStub);
472 void *getPointerToGVIndirectSym(GlobalValue *V, void *Reference);
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000473 };
Chris Lattner54266522004-11-20 23:57:07 +0000474}
475
Jeffrey Yasskin23e5fcf2009-10-23 22:37:43 +0000476void CallSiteValueMapConfig::onDelete(JITResolverState *JRS, Function *F) {
Jeffrey Yasskin8e98d122010-03-04 00:32:33 +0000477 JRS->EraseAllCallSitesForPrelocked(F);
478}
479
Jeffrey Yasskin8e98d122010-03-04 00:32:33 +0000480void JITResolverState::EraseAllCallSitesForPrelocked(Function *F) {
481 FunctionToCallSitesMapTy::iterator F2C = FunctionToCallSitesMap.find(F);
482 if (F2C == FunctionToCallSitesMap.end())
483 return;
484 StubToResolverMapTy &S2RMap = *StubToResolverMap;
485 for (SmallPtrSet<void*, 1>::const_iterator I = F2C->second.begin(),
486 E = F2C->second.end(); I != E; ++I) {
487 S2RMap.UnregisterStubResolver(*I);
488 bool Erased = CallSiteToFunctionMap.erase(*I);
489 (void)Erased;
490 assert(Erased && "Missing call site->function mapping");
491 }
492 FunctionToCallSitesMap.erase(F2C);
493}
494
495void JITResolverState::EraseAllCallSitesPrelocked() {
496 StubToResolverMapTy &S2RMap = *StubToResolverMap;
497 for (CallSiteToFunctionMapTy::const_iterator
498 I = CallSiteToFunctionMap.begin(),
499 E = CallSiteToFunctionMap.end(); I != E; ++I) {
500 S2RMap.UnregisterStubResolver(I->first);
501 }
502 CallSiteToFunctionMap.clear();
503 FunctionToCallSitesMap.clear();
504}
505
506JITResolver::~JITResolver() {
507 // No need to lock because we're in the destructor, and state isn't shared.
508 state.EraseAllCallSitesPrelocked();
509 assert(!StubToResolverMap->ResolverHasStubs(this) &&
510 "Resolver destroyed with stubs still alive.");
Jeffrey Yasskin23e5fcf2009-10-23 22:37:43 +0000511}
512
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000513/// getLazyFunctionStubIfAvailable - This returns a pointer to a function stub
Evan Cheng704bff92008-11-13 21:50:50 +0000514/// if it has already been created.
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000515void *JITResolver::getLazyFunctionStubIfAvailable(Function *F) {
Evan Cheng704bff92008-11-13 21:50:50 +0000516 MutexGuard locked(TheJIT->lock);
517
518 // If we already have a stub for this function, recycle it.
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000519 return state.getFunctionToLazyStubMap(locked).lookup(F);
Evan Cheng704bff92008-11-13 21:50:50 +0000520}
521
Chris Lattner54266522004-11-20 23:57:07 +0000522/// getFunctionStub - This returns a pointer to a function stub, creating
523/// one on demand as needed.
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000524void *JITResolver::getLazyFunctionStub(Function *F) {
Reid Spenceree448632005-07-12 15:51:55 +0000525 MutexGuard locked(TheJIT->lock);
526
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000527 // If we already have a lazy stub for this function, recycle it.
528 void *&Stub = state.getFunctionToLazyStubMap(locked)[F];
Chris Lattner54266522004-11-20 23:57:07 +0000529 if (Stub) return Stub;
530
Jeffrey Yasskindc857242009-10-27 20:30:28 +0000531 // Call the lazy resolver function if we are JIT'ing lazily. Otherwise we
532 // must resolve the symbol now.
533 void *Actual = TheJIT->isCompilingLazily()
534 ? (void *)(intptr_t)LazyResolverFn : (void *)0;
535
Nate Begemanb9c6c9b2009-03-07 06:41:19 +0000536 // If this is an external declaration, attempt to resolve the address now
537 // to place in the stub.
Jeffrey Yasskinc5818fb2009-12-22 23:47:23 +0000538 if (isNonGhostDeclaration(F) || F->hasAvailableExternallyLinkage()) {
Chris Lattnerb43dbdc2004-11-22 07:24:43 +0000539 Actual = TheJIT->getPointerToFunction(F);
Misha Brukmanf976c852005-04-21 22:55:34 +0000540
Dan Gohman69f93782009-01-05 05:32:42 +0000541 // If we resolved the symbol to a null address (eg. a weak external)
Jeffrey Yasskin6f348e42009-11-09 22:34:19 +0000542 // don't emit a stub. Return a null pointer to the application.
543 if (!Actual) return 0;
Dan Gohman69f93782009-01-05 05:32:42 +0000544 }
545
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000546 TargetJITInfo::StubLayout SL = TheJIT->getJITInfo().getStubLayout();
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +0000547 JE.startGVStub(F, SL.Size, SL.Alignment);
Nate Begemanb9c6c9b2009-03-07 06:41:19 +0000548 // Codegen a new stub, calling the lazy resolver or the actual address of the
549 // external function, if it was resolved.
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000550 Stub = TheJIT->getJITInfo().emitFunctionStub(F, Actual, JE);
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +0000551 JE.finishGVStub();
Chris Lattnerb43dbdc2004-11-22 07:24:43 +0000552
Chris Lattner870286a2006-06-01 17:29:22 +0000553 if (Actual != (void*)(intptr_t)LazyResolverFn) {
Chris Lattnerb43dbdc2004-11-22 07:24:43 +0000554 // If we are getting the stub for an external function, we really want the
555 // address of the stub in the GlobalAddressMap for the JIT, not the address
556 // of the external function.
557 TheJIT->updateGlobalMapping(F, Stub);
558 }
Chris Lattner54266522004-11-20 23:57:07 +0000559
David Greenec9ec9932010-01-05 01:23:36 +0000560 DEBUG(dbgs() << "JIT: Lazy stub emitted at [" << Stub << "] for function '"
Daniel Dunbarce63ffb2009-07-25 00:23:56 +0000561 << F->getName() << "'\n");
Chris Lattnercb479412004-11-21 03:44:32 +0000562
Jeffrey Yasskin8e98d122010-03-04 00:32:33 +0000563 if (TheJIT->isCompilingLazily()) {
564 // Register this JITResolver as the one corresponding to this call site so
565 // JITCompilerFn will be able to find it.
566 StubToResolverMap->RegisterStubResolver(Stub, this);
Jeffrey Yasskin40966a72010-02-11 01:07:39 +0000567
Jeffrey Yasskin8e98d122010-03-04 00:32:33 +0000568 // Finally, keep track of the stub-to-Function mapping so that the
569 // JITCompilerFn knows which function to compile!
570 state.AddCallSite(locked, Stub, F);
571 } else if (!Actual) {
572 // If we are JIT'ing non-lazily but need to call a function that does not
573 // exist yet, add it to the JIT's work list so that we can fill in the
574 // stub address later.
575 assert(!isNonGhostDeclaration(F) && !F->hasAvailableExternallyLinkage() &&
576 "'Actual' should have been set above.");
577 TheJIT->addPendingFunction(F);
578 }
Jeffrey Yasskine5f87982009-10-13 21:32:57 +0000579
Chris Lattner54266522004-11-20 23:57:07 +0000580 return Stub;
581}
582
Evan Cheng5594f122008-11-10 01:52:24 +0000583/// getGlobalValueIndirectSym - Return a lazy pointer containing the specified
Evan Chengbe8c03f2008-01-04 10:46:51 +0000584/// GV address.
Evan Cheng5594f122008-11-10 01:52:24 +0000585void *JITResolver::getGlobalValueIndirectSym(GlobalValue *GV, void *GVAddress) {
Evan Chengbe8c03f2008-01-04 10:46:51 +0000586 MutexGuard locked(TheJIT->lock);
587
588 // If we already have a stub for this global variable, recycle it.
Evan Cheng5594f122008-11-10 01:52:24 +0000589 void *&IndirectSym = state.getGlobalToIndirectSymMap(locked)[GV];
590 if (IndirectSym) return IndirectSym;
Evan Chengbe8c03f2008-01-04 10:46:51 +0000591
Evan Chenge4d783d2008-11-10 23:26:16 +0000592 // Otherwise, codegen a new indirect symbol.
Evan Cheng5594f122008-11-10 01:52:24 +0000593 IndirectSym = TheJIT->getJITInfo().emitGlobalValueIndirectSym(GV, GVAddress,
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000594 JE);
Evan Chengbe8c03f2008-01-04 10:46:51 +0000595
David Greenec9ec9932010-01-05 01:23:36 +0000596 DEBUG(dbgs() << "JIT: Indirect symbol emitted at [" << IndirectSym
Daniel Dunbarce63ffb2009-07-25 00:23:56 +0000597 << "] for GV '" << GV->getName() << "'\n");
Evan Chengbe8c03f2008-01-04 10:46:51 +0000598
Evan Cheng5594f122008-11-10 01:52:24 +0000599 return IndirectSym;
Evan Chengbe8c03f2008-01-04 10:46:51 +0000600}
601
Chris Lattnerd91ff7c2005-04-18 01:44:27 +0000602/// getExternalFunctionStub - Return a stub for the function at the
603/// specified address, created lazily on demand.
604void *JITResolver::getExternalFunctionStub(void *FnAddr) {
605 // If we already have a stub for this function, recycle it.
606 void *&Stub = ExternalFnToStubMap[FnAddr];
607 if (Stub) return Stub;
608
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000609 TargetJITInfo::StubLayout SL = TheJIT->getJITInfo().getStubLayout();
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +0000610 JE.startGVStub(0, SL.Size, SL.Alignment);
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000611 Stub = TheJIT->getJITInfo().emitFunctionStub(0, FnAddr, JE);
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +0000612 JE.finishGVStub();
Evan Cheng55fc2802006-07-25 20:40:54 +0000613
David Greenec9ec9932010-01-05 01:23:36 +0000614 DEBUG(dbgs() << "JIT: Stub emitted at [" << Stub
Chris Lattnerbbbfa992009-08-23 06:35:02 +0000615 << "] for external function at '" << FnAddr << "'\n");
Chris Lattnerd91ff7c2005-04-18 01:44:27 +0000616 return Stub;
617}
618
Andrew Lenharth6a974612005-07-28 12:44:13 +0000619unsigned JITResolver::getGOTIndexForAddr(void* addr) {
620 unsigned idx = revGOTMap[addr];
621 if (!idx) {
622 idx = ++nextGOTIndex;
623 revGOTMap[addr] = idx;
David Greenec9ec9932010-01-05 01:23:36 +0000624 DEBUG(dbgs() << "JIT: Adding GOT entry " << idx << " for addr ["
Chris Lattnerbbbfa992009-08-23 06:35:02 +0000625 << addr << "]\n");
Andrew Lenharth6a974612005-07-28 12:44:13 +0000626 }
627 return idx;
628}
Chris Lattnerd91ff7c2005-04-18 01:44:27 +0000629
Chris Lattner54266522004-11-20 23:57:07 +0000630/// JITCompilerFn - This function is called when a lazy compilation stub has
631/// been entered. It looks up which function this stub corresponds to, compiles
632/// it if necessary, then returns the resultant function pointer.
633void *JITResolver::JITCompilerFn(void *Stub) {
Jeffrey Yasskin40966a72010-02-11 01:07:39 +0000634 JITResolver *JR = StubToResolverMap->getResolverFromStub(Stub);
635 assert(JR && "Unable to find the corresponding JITResolver to the call site");
Eric Christopher116664a2009-11-12 03:12:18 +0000636
Nicolas Geoffraydcb31e12008-10-03 07:27:08 +0000637 Function* F = 0;
638 void* ActualPtr = 0;
Misha Brukmanf976c852005-04-21 22:55:34 +0000639
Nicolas Geoffraydcb31e12008-10-03 07:27:08 +0000640 {
641 // Only lock for getting the Function. The call getPointerToFunction made
642 // in this function might trigger function materializing, which requires
643 // JIT lock to be unlocked.
Jeffrey Yasskin40966a72010-02-11 01:07:39 +0000644 MutexGuard locked(JR->TheJIT->lock);
Reid Spenceree448632005-07-12 15:51:55 +0000645
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000646 // The address given to us for the stub may not be exactly right, it might
647 // be a little bit after the stub. As such, use upper_bound to find it.
648 pair<void*, Function*> I =
Jeffrey Yasskin40966a72010-02-11 01:07:39 +0000649 JR->state.LookupFunctionFromCallSite(locked, Stub);
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000650 F = I.second;
651 ActualPtr = I.first;
Nicolas Geoffraydcb31e12008-10-03 07:27:08 +0000652 }
Chris Lattner54266522004-11-20 23:57:07 +0000653
Evan Cheng9da60f92007-06-30 00:10:37 +0000654 // If we have already code generated the function, just return the address.
Jeffrey Yasskin40966a72010-02-11 01:07:39 +0000655 void *Result = JR->TheJIT->getPointerToGlobalIfAvailable(F);
Eric Christopher116664a2009-11-12 03:12:18 +0000656
Evan Cheng9da60f92007-06-30 00:10:37 +0000657 if (!Result) {
658 // Otherwise we don't have it, do lazy compilation now.
Eric Christopher116664a2009-11-12 03:12:18 +0000659
Evan Cheng9da60f92007-06-30 00:10:37 +0000660 // If lazy compilation is disabled, emit a useful error message and abort.
Jeffrey Yasskin40966a72010-02-11 01:07:39 +0000661 if (!JR->TheJIT->isCompilingLazily()) {
Chris Lattner75361b62010-04-07 22:58:41 +0000662 report_fatal_error("LLVM JIT requested to do lazy compilation of function '"
Torok Edwin7d696d82009-07-11 13:10:19 +0000663 + F->getName() + "' when lazy compiles are disabled!");
Evan Cheng9da60f92007-06-30 00:10:37 +0000664 }
Eric Christopher116664a2009-11-12 03:12:18 +0000665
David Greenec9ec9932010-01-05 01:23:36 +0000666 DEBUG(dbgs() << "JIT: Lazily resolving function '" << F->getName()
Daniel Dunbarce63ffb2009-07-25 00:23:56 +0000667 << "' In stub ptr = " << Stub << " actual ptr = "
668 << ActualPtr << "\n");
Chris Lattner54266522004-11-20 23:57:07 +0000669
Jeffrey Yasskin40966a72010-02-11 01:07:39 +0000670 Result = JR->TheJIT->getPointerToFunction(F);
Evan Cheng9da60f92007-06-30 00:10:37 +0000671 }
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000672
673 // Reacquire the lock to update the GOT map.
Jeffrey Yasskin40966a72010-02-11 01:07:39 +0000674 MutexGuard locked(JR->TheJIT->lock);
Chris Lattner54266522004-11-20 23:57:07 +0000675
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000676 // We might like to remove the call site from the CallSiteToFunction map, but
677 // we can't do that! Multiple threads could be stuck, waiting to acquire the
678 // lock above. As soon as the 1st function finishes compiling the function,
679 // the next one will be released, and needs to be able to find the function it
680 // needs to call.
Chris Lattner54266522004-11-20 23:57:07 +0000681
682 // FIXME: We could rewrite all references to this stub if we knew them.
Andrew Lenharth6a974612005-07-28 12:44:13 +0000683
Jeff Cohend29b6aa2005-07-30 18:33:25 +0000684 // What we will do is set the compiled function address to map to the
685 // same GOT entry as the stub so that later clients may update the GOT
Andrew Lenharth6a974612005-07-28 12:44:13 +0000686 // if they see it still using the stub address.
687 // Note: this is done so the Resolver doesn't have to manage GOT memory
688 // Do this without allocating map space if the target isn't using a GOT
Jeffrey Yasskin40966a72010-02-11 01:07:39 +0000689 if(JR->revGOTMap.find(Stub) != JR->revGOTMap.end())
690 JR->revGOTMap[Result] = JR->revGOTMap[Stub];
Andrew Lenharth6a974612005-07-28 12:44:13 +0000691
Chris Lattner54266522004-11-20 23:57:07 +0000692 return Result;
693}
Chris Lattner688506d2003-08-14 18:35:27 +0000694
Chris Lattner8ac66c12008-04-04 05:51:42 +0000695//===----------------------------------------------------------------------===//
Chris Lattner166f2262004-11-22 22:00:25 +0000696// JITEmitter code.
Chris Lattner54266522004-11-20 23:57:07 +0000697//
Chris Lattner166f2262004-11-22 22:00:25 +0000698void *JITEmitter::getPointerToGlobal(GlobalValue *V, void *Reference,
Jeffrey Yasskin2d274412009-11-07 08:51:52 +0000699 bool MayNeedFarStub) {
Nate Begemand6b7a242009-02-18 08:31:02 +0000700 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
Chris Lattner54266522004-11-20 23:57:07 +0000701 return TheJIT->getOrEmitGlobalVariable(GV);
Nate Begemand6b7a242009-02-18 08:31:02 +0000702
Chris Lattner18e04592008-06-25 20:21:35 +0000703 if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
Anton Korobeynikov19e861a2008-09-09 20:05:04 +0000704 return TheJIT->getPointerToGlobal(GA->resolveAliasedGlobal(false));
Chris Lattner54266522004-11-20 23:57:07 +0000705
706 // If we have already compiled the function, return a pointer to its body.
707 Function *F = cast<Function>(V);
Eric Christopher116664a2009-11-12 03:12:18 +0000708
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000709 void *FnStub = Resolver.getLazyFunctionStubIfAvailable(F);
Eric Christopher116664a2009-11-12 03:12:18 +0000710 if (FnStub) {
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000711 // Return the function stub if it's already created. We do this first so
712 // that we're returning the same address for the function as any previous
713 // call. TODO: Yes, this is wrong. The lazy stub isn't guaranteed to be
714 // close enough to call.
Eric Christopher116664a2009-11-12 03:12:18 +0000715 return FnStub;
Nate Begeman50cd6fd2009-03-05 06:34:37 +0000716 }
Eric Christopher116664a2009-11-12 03:12:18 +0000717
Jeffrey Yasskine03a39b2009-11-19 23:42:58 +0000718 // If we know the target can handle arbitrary-distance calls, try to
719 // return a direct pointer.
720 if (!MayNeedFarStub) {
721 // If we have code, go ahead and return that.
722 void *ResultPtr = TheJIT->getPointerToGlobalIfAvailable(F);
723 if (ResultPtr) return ResultPtr;
Chris Lattner54266522004-11-20 23:57:07 +0000724
Jeffrey Yasskine03a39b2009-11-19 23:42:58 +0000725 // If this is an external function pointer, we can force the JIT to
726 // 'compile' it, which really just adds it to the map.
Jeffrey Yasskinc5818fb2009-12-22 23:47:23 +0000727 if (isNonGhostDeclaration(F) || F->hasAvailableExternallyLinkage())
Jeffrey Yasskine03a39b2009-11-19 23:42:58 +0000728 return TheJIT->getPointerToFunction(F);
729 }
Chris Lattnerb43dbdc2004-11-22 07:24:43 +0000730
Jeffrey Yasskin39c75f22010-03-04 19:45:09 +0000731 // Otherwise, we may need a to emit a stub, and, conservatively, we always do
732 // so. Note that it's possible to return null from getLazyFunctionStub in the
733 // case of a weak extern that fails to resolve.
734 return Resolver.getLazyFunctionStub(F);
Chris Lattner54266522004-11-20 23:57:07 +0000735}
736
Jeffrey Yasskin2d274412009-11-07 08:51:52 +0000737void *JITEmitter::getPointerToGVIndirectSym(GlobalValue *V, void *Reference) {
Nate Begeman50cd6fd2009-03-05 06:34:37 +0000738 // Make sure GV is emitted first, and create a stub containing the fully
739 // resolved address.
Jeffrey Yasskin2d274412009-11-07 08:51:52 +0000740 void *GVAddress = getPointerToGlobal(V, Reference, false);
Nate Begeman50cd6fd2009-03-05 06:34:37 +0000741 void *StubAddr = Resolver.getGlobalValueIndirectSym(V, GVAddress);
Nate Begeman50cd6fd2009-03-05 06:34:37 +0000742 return StubAddr;
743}
744
Devang Patel02c04232009-10-06 03:04:58 +0000745void JITEmitter::processDebugLoc(DebugLoc DL, bool BeforePrintingInsn) {
Chris Lattnerde4845c2010-04-02 19:42:39 +0000746 if (DL.isUnknown()) return;
747 if (!BeforePrintingInsn) return;
Chris Lattnerde4845c2010-04-02 19:42:39 +0000748
Chris Lattner134d8ee2010-07-22 21:17:55 +0000749 const LLVMContext &Context = EmissionDetails.MF->getFunction()->getContext();
Nicolas Geoffray4eb37392010-04-14 22:06:37 +0000750
751 if (DL.getScope(Context) != 0 && PrevDL != DL) {
Chris Lattnerde4845c2010-04-02 19:42:39 +0000752 JITEvent_EmittedFunctionDetails::LineStart NextLine;
753 NextLine.Address = getCurrentPCValue();
754 NextLine.Loc = DL;
755 EmissionDetails.LineStarts.push_back(NextLine);
Jeffrey Yasskin32360a72009-07-16 21:07:26 +0000756 }
Chris Lattnerde4845c2010-04-02 19:42:39 +0000757
Nicolas Geoffray4eb37392010-04-14 22:06:37 +0000758 PrevDL = DL;
Jeffrey Yasskin32360a72009-07-16 21:07:26 +0000759}
760
Evan Cheng1606e8e2009-03-13 07:51:59 +0000761static unsigned GetConstantPoolSizeInBytes(MachineConstantPool *MCP,
762 const TargetData *TD) {
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +0000763 const std::vector<MachineConstantPoolEntry> &Constants = MCP->getConstants();
764 if (Constants.empty()) return 0;
765
Evan Cheng1606e8e2009-03-13 07:51:59 +0000766 unsigned Size = 0;
767 for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
768 MachineConstantPoolEntry CPE = Constants[i];
769 unsigned AlignMask = CPE.getAlignment() - 1;
770 Size = (Size + AlignMask) & ~AlignMask;
771 const Type *Ty = CPE.getType();
Duncan Sands777d2302009-05-09 07:06:46 +0000772 Size += TD->getTypeAllocSize(Ty);
Evan Cheng1606e8e2009-03-13 07:51:59 +0000773 }
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +0000774 return Size;
775}
776
Chris Lattner166f2262004-11-22 22:00:25 +0000777void JITEmitter::startFunction(MachineFunction &F) {
David Greenec9ec9932010-01-05 01:23:36 +0000778 DEBUG(dbgs() << "JIT: Starting CodeGen of Function "
Daniel Dunbarce63ffb2009-07-25 00:23:56 +0000779 << F.getFunction()->getName() << "\n");
Evan Chengeb5d95a2008-11-06 17:46:04 +0000780
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +0000781 uintptr_t ActualSize = 0;
Jim Grosbachcce6c292008-10-03 16:17:20 +0000782 // Set the memory writable, if it's not already
783 MemMgr->setMemoryWritable();
Chris Lattner134d8ee2010-07-22 21:17:55 +0000784
785 if (SizeEstimate > 0) {
Reid Kleckner10b4fc52009-07-23 21:46:56 +0000786 // SizeEstimate will be non-zero on reallocation attempts.
787 ActualSize = SizeEstimate;
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +0000788 }
789
Chris Lattner8907b4b2007-12-05 23:39:57 +0000790 BufferBegin = CurBufferPtr = MemMgr->startFunctionBody(F.getFunction(),
791 ActualSize);
Chris Lattnere993cc22006-05-11 23:08:08 +0000792 BufferEnd = BufferBegin+ActualSize;
Jeffrey Yasskin1e861322009-10-20 18:13:21 +0000793 EmittedFunctions[F.getFunction()].FunctionBody = BufferBegin;
794
Evan Cheng9a1e9b92006-11-16 20:04:54 +0000795 // Ensure the constant pool/jump table info is at least 4-byte aligned.
796 emitAlignment(16);
797
Chris Lattnerf75f9be2006-05-02 23:22:24 +0000798 emitConstantPool(F.getConstantPool());
Chris Lattner071c62f2010-01-25 23:26:13 +0000799 if (MachineJumpTableInfo *MJTI = F.getJumpTableInfo())
800 initJumpTableInfo(MJTI);
Chris Lattnerf75f9be2006-05-02 23:22:24 +0000801
802 // About to start emitting the machine code for the function.
Chris Lattner0eb4d6b2006-05-03 01:03:20 +0000803 emitAlignment(std::max(F.getFunction()->getAlignment(), 8U));
Chris Lattnerf75f9be2006-05-02 23:22:24 +0000804 TheJIT->updateGlobalMapping(F.getFunction(), CurBufferPtr);
Jeffrey Yasskin7a9034c2009-10-27 00:03:05 +0000805 EmittedFunctions[F.getFunction()].Code = CurBufferPtr;
Evan Cheng55fc2802006-07-25 20:40:54 +0000806
Chris Lattnerb4432f32006-05-03 17:10:41 +0000807 MBBLocations.clear();
Jeffrey Yasskin32360a72009-07-16 21:07:26 +0000808
809 EmissionDetails.MF = &F;
810 EmissionDetails.LineStarts.clear();
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000811}
812
Chris Lattner43b429b2006-05-02 18:27:26 +0000813bool JITEmitter::finishFunction(MachineFunction &F) {
Chris Lattnere993cc22006-05-11 23:08:08 +0000814 if (CurBufferPtr == BufferEnd) {
Reid Kleckner10b4fc52009-07-23 21:46:56 +0000815 // We must call endFunctionBody before retrying, because
816 // deallocateMemForFunction requires it.
817 MemMgr->endFunctionBody(F.getFunction(), BufferBegin, CurBufferPtr);
818 retryWithMoreMemory(F);
819 return true;
Chris Lattnere993cc22006-05-11 23:08:08 +0000820 }
Reid Kleckner10b4fc52009-07-23 21:46:56 +0000821
Chris Lattner071c62f2010-01-25 23:26:13 +0000822 if (MachineJumpTableInfo *MJTI = F.getJumpTableInfo())
823 emitJumpTableInfo(MJTI);
Reid Kleckner10b4fc52009-07-23 21:46:56 +0000824
Chris Lattnera8279532006-06-16 18:09:26 +0000825 // FnStart is the start of the text, not the start of the constant pool and
826 // other per-function data.
Bruno Cardoso Lopes186c6702009-06-04 00:15:51 +0000827 uint8_t *FnStart =
828 (uint8_t *)TheJIT->getPointerToGlobalIfAvailable(F.getFunction());
Chris Lattnerbd199fb2002-12-24 00:01:05 +0000829
Argyrios Kyrtzidis19fee412009-04-30 23:01:58 +0000830 // FnEnd is the end of the function's machine code.
Bruno Cardoso Lopes186c6702009-06-04 00:15:51 +0000831 uint8_t *FnEnd = CurBufferPtr;
Argyrios Kyrtzidis19fee412009-04-30 23:01:58 +0000832
Chris Lattner5be478f2004-11-20 03:46:14 +0000833 if (!Relocations.empty()) {
Nate Begeman50cd6fd2009-03-05 06:34:37 +0000834 CurFn = F.getFunction();
Chris Lattnere884dc22005-07-20 16:29:20 +0000835 NumRelos += Relocations.size();
836
Chris Lattner5be478f2004-11-20 03:46:14 +0000837 // Resolve the relocations to concrete pointers.
838 for (unsigned i = 0, e = Relocations.size(); i != e; ++i) {
839 MachineRelocation &MR = Relocations[i];
Evan Cheng92006052008-11-03 07:14:02 +0000840 void *ResultPtr = 0;
Evan Chengef5784e2008-10-29 23:54:46 +0000841 if (!MR.letTargetResolve()) {
Evan Chengd7398c92008-11-08 07:37:34 +0000842 if (MR.isExternalSymbol()) {
Dan Gohman69f93782009-01-05 05:32:42 +0000843 ResultPtr = TheJIT->getPointerToNamedFunction(MR.getExternalSymbol(),
844 false);
David Greenec9ec9932010-01-05 01:23:36 +0000845 DEBUG(dbgs() << "JIT: Map \'" << MR.getExternalSymbol() << "\' to ["
Eric Christopher116664a2009-11-12 03:12:18 +0000846 << ResultPtr << "]\n");
Misha Brukmanf976c852005-04-21 22:55:34 +0000847
Evan Chengef5784e2008-10-29 23:54:46 +0000848 // If the target REALLY wants a stub for this function, emit it now.
Jeffrey Yasskin2d274412009-11-07 08:51:52 +0000849 if (MR.mayNeedFarStub()) {
Jeffrey Yasskin6f348e42009-11-09 22:34:19 +0000850 ResultPtr = Resolver.getExternalFunctionStub(ResultPtr);
Nate Begeman841c6a42009-03-11 07:03:43 +0000851 }
Evan Chengef5784e2008-10-29 23:54:46 +0000852 } else if (MR.isGlobalValue()) {
853 ResultPtr = getPointerToGlobal(MR.getGlobalValue(),
854 BufferBegin+MR.getMachineCodeOffset(),
Jeffrey Yasskin2d274412009-11-07 08:51:52 +0000855 MR.mayNeedFarStub());
Evan Cheng5594f122008-11-10 01:52:24 +0000856 } else if (MR.isIndirectSymbol()) {
Jeffrey Yasskin2d274412009-11-07 08:51:52 +0000857 ResultPtr = getPointerToGVIndirectSym(
858 MR.getGlobalValue(), BufferBegin+MR.getMachineCodeOffset());
Evan Chengef5784e2008-10-29 23:54:46 +0000859 } else if (MR.isBasicBlock()) {
860 ResultPtr = (void*)getMachineBasicBlockAddress(MR.getBasicBlock());
861 } else if (MR.isConstantPoolIndex()) {
862 ResultPtr = (void*)getConstantPoolEntryAddress(MR.getConstantPoolIndex());
863 } else {
864 assert(MR.isJumpTableIndex());
865 ResultPtr=(void*)getJumpTableEntryAddress(MR.getJumpTableIndex());
866 }
Jeff Cohen00b168892005-07-27 06:12:32 +0000867
Evan Chengef5784e2008-10-29 23:54:46 +0000868 MR.setResultPointer(ResultPtr);
869 }
Andrew Lenharth16ec33c2005-07-22 20:48:12 +0000870
Andrew Lenharth6a974612005-07-28 12:44:13 +0000871 // if we are managing the GOT and the relocation wants an index,
872 // give it one
Chris Lattner8907b4b2007-12-05 23:39:57 +0000873 if (MR.isGOTRelative() && MemMgr->isManagingGOT()) {
Chris Lattnere7484012007-02-24 02:57:03 +0000874 unsigned idx = Resolver.getGOTIndexForAddr(ResultPtr);
Andrew Lenharth6a974612005-07-28 12:44:13 +0000875 MR.setGOTIndex(idx);
Chris Lattner8907b4b2007-12-05 23:39:57 +0000876 if (((void**)MemMgr->getGOTBase())[idx] != ResultPtr) {
David Greenec9ec9932010-01-05 01:23:36 +0000877 DEBUG(dbgs() << "JIT: GOT was out of date for " << ResultPtr
Chris Lattnerbbbfa992009-08-23 06:35:02 +0000878 << " pointing at " << ((void**)MemMgr->getGOTBase())[idx]
879 << "\n");
Chris Lattner8907b4b2007-12-05 23:39:57 +0000880 ((void**)MemMgr->getGOTBase())[idx] = ResultPtr;
Andrew Lenharth6a974612005-07-28 12:44:13 +0000881 }
Andrew Lenharth16ec33c2005-07-22 20:48:12 +0000882 }
Chris Lattner5be478f2004-11-20 03:46:14 +0000883 }
884
Nate Begeman50cd6fd2009-03-05 06:34:37 +0000885 CurFn = 0;
Chris Lattner43b429b2006-05-02 18:27:26 +0000886 TheJIT->getJITInfo().relocate(BufferBegin, &Relocations[0],
Chris Lattner8907b4b2007-12-05 23:39:57 +0000887 Relocations.size(), MemMgr->getGOTBase());
Chris Lattner5be478f2004-11-20 03:46:14 +0000888 }
889
Chris Lattnerd2d5c762006-05-03 18:55:56 +0000890 // Update the GOT entry for F to point to the new code.
Chris Lattner8907b4b2007-12-05 23:39:57 +0000891 if (MemMgr->isManagingGOT()) {
Chris Lattnere7484012007-02-24 02:57:03 +0000892 unsigned idx = Resolver.getGOTIndexForAddr((void*)BufferBegin);
Chris Lattner8907b4b2007-12-05 23:39:57 +0000893 if (((void**)MemMgr->getGOTBase())[idx] != (void*)BufferBegin) {
David Greenec9ec9932010-01-05 01:23:36 +0000894 DEBUG(dbgs() << "JIT: GOT was out of date for " << (void*)BufferBegin
Chris Lattnerbbbfa992009-08-23 06:35:02 +0000895 << " pointing at " << ((void**)MemMgr->getGOTBase())[idx]
896 << "\n");
Chris Lattner8907b4b2007-12-05 23:39:57 +0000897 ((void**)MemMgr->getGOTBase())[idx] = (void*)BufferBegin;
Andrew Lenharth6a974612005-07-28 12:44:13 +0000898 }
899 }
900
Argyrios Kyrtzidis19fee412009-04-30 23:01:58 +0000901 // CurBufferPtr may have moved beyond FnEnd, due to memory allocation for
902 // global variables that were referenced in the relocations.
903 MemMgr->endFunctionBody(F.getFunction(), BufferBegin, CurBufferPtr);
Evan Cheng5788d1a2008-12-10 02:32:19 +0000904
905 if (CurBufferPtr == BufferEnd) {
Reid Kleckner10b4fc52009-07-23 21:46:56 +0000906 retryWithMoreMemory(F);
907 return true;
908 } else {
909 // Now that we've succeeded in emitting the function, reset the
910 // SizeEstimate back down to zero.
911 SizeEstimate = 0;
Evan Cheng5788d1a2008-12-10 02:32:19 +0000912 }
913
Nuno Lopescef75272008-10-21 11:42:16 +0000914 BufferBegin = CurBufferPtr = 0;
915 NumBytes += FnEnd-FnStart;
916
Evan Cheng55fc2802006-07-25 20:40:54 +0000917 // Invalidate the icache if necessary.
Chris Lattnerbc52cad2008-06-25 17:18:44 +0000918 sys::Memory::InvalidateInstructionCache(FnStart, FnEnd-FnStart);
Jeffrey Yasskindf5a7da2009-06-25 02:04:04 +0000919
Jeffrey Yasskindf5a7da2009-06-25 02:04:04 +0000920 TheJIT->NotifyFunctionEmitted(*F.getFunction(), FnStart, FnEnd-FnStart,
Jeffrey Yasskin32360a72009-07-16 21:07:26 +0000921 EmissionDetails);
Evan Cheng55fc2802006-07-25 20:40:54 +0000922
Nicolas Geoffray4eb37392010-04-14 22:06:37 +0000923 // Reset the previous debug location.
924 PrevDL = DebugLoc();
925
David Greenec9ec9932010-01-05 01:23:36 +0000926 DEBUG(dbgs() << "JIT: Finished CodeGen of [" << (void*)FnStart
Daniel Dunbarce63ffb2009-07-25 00:23:56 +0000927 << "] Function: " << F.getFunction()->getName()
928 << ": " << (FnEnd-FnStart) << " bytes of text, "
929 << Relocations.size() << " relocations\n");
Argyrios Kyrtzidisb3a847d2009-05-18 21:06:40 +0000930
Chris Lattner5be478f2004-11-20 03:46:14 +0000931 Relocations.clear();
Evan Cheng1606e8e2009-03-13 07:51:59 +0000932 ConstPoolAddresses.clear();
Anton Korobeynikov8cd4c3e2007-01-19 17:25:17 +0000933
Evan Chengbc4707a2008-09-18 07:54:21 +0000934 // Mark code region readable and executable if it's not so already.
Jim Grosbachcce6c292008-10-03 16:17:20 +0000935 MemMgr->setMemoryExecutable();
Evan Chengbc4707a2008-09-18 07:54:21 +0000936
Bill Wendling69c128f2010-04-18 00:52:08 +0000937 DEBUG({
938 if (sys::hasDisassembler()) {
939 dbgs() << "JIT: Disassembled code:\n";
940 dbgs() << sys::disassembleBuffer(FnStart, FnEnd-FnStart,
941 (uintptr_t)FnStart);
942 } else {
943 dbgs() << "JIT: Binary code:\n";
944 uint8_t* q = FnStart;
945 for (int i = 0; q < FnEnd; q += 4, ++i) {
946 if (i == 4)
947 i = 0;
948 if (i == 0)
949 dbgs() << "JIT: " << (long)(q - FnStart) << ": ";
950 bool Done = false;
951 for (int j = 3; j >= 0; --j) {
952 if (q + j >= FnEnd)
953 Done = true;
954 else
955 dbgs() << (unsigned short)q[j];
956 }
957 if (Done)
958 break;
959 dbgs() << ' ';
960 if (i == 3)
961 dbgs() << '\n';
Evan Chenge7c35512008-11-12 08:22:43 +0000962 }
Bill Wendling69c128f2010-04-18 00:52:08 +0000963 dbgs()<< '\n';
Evan Chenga7916f52008-11-05 23:44:08 +0000964 }
Bill Wendling69c128f2010-04-18 00:52:08 +0000965 });
Chris Lattnerbbbfa992009-08-23 06:35:02 +0000966
Duncan Sands57b6e9e2010-05-02 15:36:26 +0000967 if (JITExceptionHandling || JITEmitDebugInfo) {
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +0000968 uintptr_t ActualSize = 0;
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +0000969 SavedBufferBegin = BufferBegin;
970 SavedBufferEnd = BufferEnd;
971 SavedCurBufferPtr = CurBufferPtr;
Reid Kleckner27632172009-09-20 23:52:43 +0000972
Nicolas Geoffrayafe6c2b2008-02-13 18:39:37 +0000973 BufferBegin = CurBufferPtr = MemMgr->startExceptionTable(F.getFunction(),
974 ActualSize);
975 BufferEnd = BufferBegin+ActualSize;
Jeffrey Yasskin1e861322009-10-20 18:13:21 +0000976 EmittedFunctions[F.getFunction()].ExceptionTable = BufferBegin;
Reid Kleckner27632172009-09-20 23:52:43 +0000977 uint8_t *EhStart;
978 uint8_t *FrameRegister = DE->EmitDwarfTable(F, *this, FnStart, FnEnd,
979 EhStart);
Chris Lattner0fdaa0b2008-03-07 20:05:43 +0000980 MemMgr->endExceptionTable(F.getFunction(), BufferBegin, CurBufferPtr,
981 FrameRegister);
Reid Kleckner27632172009-09-20 23:52:43 +0000982 uint8_t *EhEnd = CurBufferPtr;
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +0000983 BufferBegin = SavedBufferBegin;
984 BufferEnd = SavedBufferEnd;
985 CurBufferPtr = SavedCurBufferPtr;
Nicolas Geoffrayafe6c2b2008-02-13 18:39:37 +0000986
Duncan Sands57b6e9e2010-05-02 15:36:26 +0000987 if (JITExceptionHandling) {
Reid Kleckner27632172009-09-20 23:52:43 +0000988 TheJIT->RegisterTable(FrameRegister);
989 }
990
991 if (JITEmitDebugInfo) {
992 DebugInfo I;
993 I.FnStart = FnStart;
994 I.FnEnd = FnEnd;
995 I.EhStart = EhStart;
996 I.EhEnd = EhEnd;
997 DR->RegisterFunction(F.getFunction(), I);
998 }
Nicolas Geoffrayafe6c2b2008-02-13 18:39:37 +0000999 }
Evan Cheng252ddfb2008-09-02 08:14:01 +00001000
1001 if (MMI)
1002 MMI->EndFunction();
Eric Christopher116664a2009-11-12 03:12:18 +00001003
Chris Lattner43b429b2006-05-02 18:27:26 +00001004 return false;
Chris Lattnerbd199fb2002-12-24 00:01:05 +00001005}
1006
Reid Kleckner10b4fc52009-07-23 21:46:56 +00001007void JITEmitter::retryWithMoreMemory(MachineFunction &F) {
David Greenec9ec9932010-01-05 01:23:36 +00001008 DEBUG(dbgs() << "JIT: Ran out of space for native code. Reattempting.\n");
Reid Kleckner10b4fc52009-07-23 21:46:56 +00001009 Relocations.clear(); // Clear the old relocations or we'll reapply them.
1010 ConstPoolAddresses.clear();
1011 ++NumRetries;
1012 deallocateMemForFunction(F.getFunction());
1013 // Try again with at least twice as much free space.
1014 SizeEstimate = (uintptr_t)(2 * (BufferEnd - BufferBegin));
Chris Lattner68feb222010-07-11 23:07:28 +00001015
1016 for (MachineFunction::iterator MBB = F.begin(), E = F.end(); MBB != E; ++MBB){
1017 if (MBB->hasAddressTaken())
1018 TheJIT->clearPointerToBasicBlock(MBB->getBasicBlock());
1019 }
Reid Kleckner10b4fc52009-07-23 21:46:56 +00001020}
1021
Nate Begeman50cd6fd2009-03-05 06:34:37 +00001022/// deallocateMemForFunction - Deallocate all memory for the specified
1023/// function body. Also drop any references the function has to stubs.
Jeffrey Yasskin7a9034c2009-10-27 00:03:05 +00001024/// May be called while the Function is being destroyed inside ~Value().
Reid Kleckner10b4fc52009-07-23 21:46:56 +00001025void JITEmitter::deallocateMemForFunction(const Function *F) {
Jeffrey Yasskin7a9034c2009-10-27 00:03:05 +00001026 ValueMap<const Function *, EmittedCode, EmittedFunctionConfig>::iterator
1027 Emitted = EmittedFunctions.find(F);
Jeffrey Yasskin1e861322009-10-20 18:13:21 +00001028 if (Emitted != EmittedFunctions.end()) {
1029 MemMgr->deallocateFunctionBody(Emitted->second.FunctionBody);
1030 MemMgr->deallocateExceptionTable(Emitted->second.ExceptionTable);
Jeffrey Yasskin7a9034c2009-10-27 00:03:05 +00001031 TheJIT->NotifyFreeingMachineCode(Emitted->second.Code);
1032
Jeffrey Yasskin1e861322009-10-20 18:13:21 +00001033 EmittedFunctions.erase(Emitted);
1034 }
Nate Begeman50cd6fd2009-03-05 06:34:37 +00001035
Reid Kleckner27632172009-09-20 23:52:43 +00001036 // TODO: Do we need to unregister exception handling information from libgcc
1037 // here?
1038
1039 if (JITEmitDebugInfo) {
1040 DR->UnregisterFunction(F);
1041 }
Nate Begeman50cd6fd2009-03-05 06:34:37 +00001042}
1043
1044
Evan Cheng5788d1a2008-12-10 02:32:19 +00001045void* JITEmitter::allocateSpace(uintptr_t Size, unsigned Alignment) {
Nuno Lopescef75272008-10-21 11:42:16 +00001046 if (BufferBegin)
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +00001047 return JITCodeEmitter::allocateSpace(Size, Alignment);
Nuno Lopescef75272008-10-21 11:42:16 +00001048
1049 // create a new memory block if there is no active one.
1050 // care must be taken so that BufferBegin is invalidated when a
1051 // block is trimmed
1052 BufferBegin = CurBufferPtr = MemMgr->allocateSpace(Size, Alignment);
1053 BufferEnd = BufferBegin+Size;
1054 return CurBufferPtr;
1055}
1056
Jeffrey Yasskin489393d2009-07-08 21:59:57 +00001057void* JITEmitter::allocateGlobal(uintptr_t Size, unsigned Alignment) {
1058 // Delegate this call through the memory manager.
1059 return MemMgr->allocateGlobal(Size, Alignment);
1060}
1061
Chris Lattner166f2262004-11-22 22:00:25 +00001062void JITEmitter::emitConstantPool(MachineConstantPool *MCP) {
Evan Cheng47c01a02008-11-07 09:02:17 +00001063 if (TheJIT->getJITInfo().hasCustomConstantPool())
Jim Grosbach8fe95352008-10-30 23:44:39 +00001064 return;
Evan Cheng47c01a02008-11-07 09:02:17 +00001065
Chris Lattnerfa77d432006-02-09 04:22:52 +00001066 const std::vector<MachineConstantPoolEntry> &Constants = MCP->getConstants();
Chris Lattner2c0a6a12003-11-30 04:23:21 +00001067 if (Constants.empty()) return;
1068
Evan Cheng1606e8e2009-03-13 07:51:59 +00001069 unsigned Size = GetConstantPoolSizeInBytes(MCP, TheJIT->getTargetData());
1070 unsigned Align = MCP->getConstantPoolAlignment();
Evan Cheng97b8c402008-04-12 00:22:01 +00001071 ConstantPoolBase = allocateSpace(Size, Align);
Chris Lattner239862c2006-02-09 04:49:59 +00001072 ConstantPool = MCP;
Chris Lattnerf75f9be2006-05-02 23:22:24 +00001073
1074 if (ConstantPoolBase == 0) return; // Buffer overflow.
1075
David Greenec9ec9932010-01-05 01:23:36 +00001076 DEBUG(dbgs() << "JIT: Emitted constant pool at [" << ConstantPoolBase
Chris Lattnerbbbfa992009-08-23 06:35:02 +00001077 << "] (size: " << Size << ", alignment: " << Align << ")\n");
Evan Cheng97b8c402008-04-12 00:22:01 +00001078
Chris Lattner239862c2006-02-09 04:49:59 +00001079 // Initialize the memory for all of the constant pool entries.
Evan Cheng1606e8e2009-03-13 07:51:59 +00001080 unsigned Offset = 0;
Chris Lattner3029f922006-02-09 04:46:04 +00001081 for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
Evan Cheng1606e8e2009-03-13 07:51:59 +00001082 MachineConstantPoolEntry CPE = Constants[i];
1083 unsigned AlignMask = CPE.getAlignment() - 1;
1084 Offset = (Offset + AlignMask) & ~AlignMask;
1085
1086 uintptr_t CAddr = (uintptr_t)ConstantPoolBase + Offset;
1087 ConstPoolAddresses.push_back(CAddr);
1088 if (CPE.isMachineConstantPoolEntry()) {
Evan Chengcd5731d2006-09-12 20:59:59 +00001089 // FIXME: add support to lower machine constant pool values into bytes!
Chris Lattner75361b62010-04-07 22:58:41 +00001090 report_fatal_error("Initialize memory with machine specific constant pool"
Torok Edwin7d696d82009-07-11 13:10:19 +00001091 "entry has not been implemented!");
Evan Chengcd5731d2006-09-12 20:59:59 +00001092 }
Evan Cheng1606e8e2009-03-13 07:51:59 +00001093 TheJIT->InitializeMemory(CPE.Val.ConstVal, (void*)CAddr);
David Greenec9ec9932010-01-05 01:23:36 +00001094 DEBUG(dbgs() << "JIT: CP" << i << " at [0x";
1095 dbgs().write_hex(CAddr) << "]\n");
Evan Cheng1606e8e2009-03-13 07:51:59 +00001096
1097 const Type *Ty = CPE.Val.ConstVal->getType();
Duncan Sands777d2302009-05-09 07:06:46 +00001098 Offset += TheJIT->getTargetData()->getTypeAllocSize(Ty);
Chris Lattner1cc08382003-01-13 01:00:12 +00001099 }
1100}
1101
Nate Begeman37efe672006-04-22 18:53:45 +00001102void JITEmitter::initJumpTableInfo(MachineJumpTableInfo *MJTI) {
Evan Cheng47c01a02008-11-07 09:02:17 +00001103 if (TheJIT->getJITInfo().hasCustomJumpTables())
1104 return;
Richard Osborne95da6052010-03-11 14:58:16 +00001105 if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_Inline)
1106 return;
Evan Cheng47c01a02008-11-07 09:02:17 +00001107
Nate Begeman37efe672006-04-22 18:53:45 +00001108 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
1109 if (JT.empty()) return;
Eric Christopher116664a2009-11-12 03:12:18 +00001110
Chris Lattnerf75f9be2006-05-02 23:22:24 +00001111 unsigned NumEntries = 0;
Nate Begeman37efe672006-04-22 18:53:45 +00001112 for (unsigned i = 0, e = JT.size(); i != e; ++i)
Chris Lattnerf75f9be2006-05-02 23:22:24 +00001113 NumEntries += JT[i].MBBs.size();
1114
Chris Lattner071c62f2010-01-25 23:26:13 +00001115 unsigned EntrySize = MJTI->getEntrySize(*TheJIT->getTargetData());
Chris Lattnerf75f9be2006-05-02 23:22:24 +00001116
Nate Begeman37efe672006-04-22 18:53:45 +00001117 // Just allocate space for all the jump tables now. We will fix up the actual
1118 // MBB entries in the tables after we emit the code for each block, since then
1119 // we will know the final locations of the MBBs in memory.
1120 JumpTable = MJTI;
Chris Lattner071c62f2010-01-25 23:26:13 +00001121 JumpTableBase = allocateSpace(NumEntries * EntrySize,
1122 MJTI->getEntryAlignment(*TheJIT->getTargetData()));
Nate Begeman37efe672006-04-22 18:53:45 +00001123}
1124
Jim Laskeyb92767a2006-12-14 22:53:42 +00001125void JITEmitter::emitJumpTableInfo(MachineJumpTableInfo *MJTI) {
Evan Cheng47c01a02008-11-07 09:02:17 +00001126 if (TheJIT->getJITInfo().hasCustomJumpTables())
1127 return;
1128
Nate Begeman37efe672006-04-22 18:53:45 +00001129 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
Chris Lattnerf75f9be2006-05-02 23:22:24 +00001130 if (JT.empty() || JumpTableBase == 0) return;
Eric Christopher116664a2009-11-12 03:12:18 +00001131
Chris Lattner13af11a2010-01-26 03:47:15 +00001132
1133 switch (MJTI->getEntryKind()) {
Richard Osborne95da6052010-03-11 14:58:16 +00001134 case MachineJumpTableInfo::EK_Inline:
1135 return;
Chris Lattner13af11a2010-01-26 03:47:15 +00001136 case MachineJumpTableInfo::EK_BlockAddress: {
1137 // EK_BlockAddress - Each entry is a plain address of block, e.g.:
1138 // .word LBB123
1139 assert(MJTI->getEntrySize(*TheJIT->getTargetData()) == sizeof(void*) &&
1140 "Cross JIT'ing?");
1141
1142 // For each jump table, map each target in the jump table to the address of
1143 // an emitted MachineBasicBlock.
1144 intptr_t *SlotPtr = (intptr_t*)JumpTableBase;
1145
1146 for (unsigned i = 0, e = JT.size(); i != e; ++i) {
1147 const std::vector<MachineBasicBlock*> &MBBs = JT[i].MBBs;
1148 // Store the address of the basic block for this jump table slot in the
1149 // memory we allocated for the jump table in 'initJumpTableInfo'
1150 for (unsigned mi = 0, me = MBBs.size(); mi != me; ++mi)
1151 *SlotPtr++ = getMachineBasicBlockAddress(MBBs[mi]);
1152 }
1153 break;
1154 }
1155
Chris Lattner85fe0782010-01-26 04:05:28 +00001156 case MachineJumpTableInfo::EK_Custom32:
Chris Lattner13af11a2010-01-26 03:47:15 +00001157 case MachineJumpTableInfo::EK_GPRel32BlockAddress:
1158 case MachineJumpTableInfo::EK_LabelDifference32: {
Chris Lattner071c62f2010-01-25 23:26:13 +00001159 assert(MJTI->getEntrySize(*TheJIT->getTargetData()) == 4&&"Cross JIT'ing?");
Jim Laskeyacd80ac2006-12-14 19:17:33 +00001160 // For each jump table, place the offset from the beginning of the table
1161 // to the target address.
1162 int *SlotPtr = (int*)JumpTableBase;
Chris Lattner32ca55f2006-05-03 00:13:06 +00001163
Jim Laskeyacd80ac2006-12-14 19:17:33 +00001164 for (unsigned i = 0, e = JT.size(); i != e; ++i) {
1165 const std::vector<MachineBasicBlock*> &MBBs = JT[i].MBBs;
1166 // Store the offset of the basic block for this jump table slot in the
1167 // memory we allocated for the jump table in 'initJumpTableInfo'
Evan Cheng5788d1a2008-12-10 02:32:19 +00001168 uintptr_t Base = (uintptr_t)SlotPtr;
Evan Cheng2a3e08b2008-01-05 02:26:58 +00001169 for (unsigned mi = 0, me = MBBs.size(); mi != me; ++mi) {
Evan Cheng5788d1a2008-12-10 02:32:19 +00001170 uintptr_t MBBAddr = getMachineBasicBlockAddress(MBBs[mi]);
Chris Lattner13af11a2010-01-26 03:47:15 +00001171 /// FIXME: USe EntryKind instead of magic "getPICJumpTableEntry" hook.
Evan Cheng2a3e08b2008-01-05 02:26:58 +00001172 *SlotPtr++ = TheJIT->getJITInfo().getPICJumpTableEntry(MBBAddr, Base);
1173 }
Jim Laskeyacd80ac2006-12-14 19:17:33 +00001174 }
Chris Lattner13af11a2010-01-26 03:47:15 +00001175 break;
1176 }
Nate Begeman37efe672006-04-22 18:53:45 +00001177 }
1178}
1179
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +00001180void JITEmitter::startGVStub(const GlobalValue* GV,
Jeffrey Yasskin0261d792009-11-23 22:49:00 +00001181 unsigned StubSize, unsigned Alignment) {
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +00001182 SavedBufferBegin = BufferBegin;
1183 SavedBufferEnd = BufferEnd;
1184 SavedCurBufferPtr = CurBufferPtr;
Eric Christopher116664a2009-11-12 03:12:18 +00001185
Evan Chengce4a70b2008-11-08 08:02:53 +00001186 BufferBegin = CurBufferPtr = MemMgr->allocateStub(GV, StubSize, Alignment);
Chris Lattner43b429b2006-05-02 18:27:26 +00001187 BufferEnd = BufferBegin+StubSize+1;
Chris Lattner6125fdd2003-05-09 03:30:07 +00001188}
1189
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +00001190void JITEmitter::startGVStub(void *Buffer, unsigned StubSize) {
1191 SavedBufferBegin = BufferBegin;
1192 SavedBufferEnd = BufferEnd;
1193 SavedCurBufferPtr = CurBufferPtr;
Eric Christopher116664a2009-11-12 03:12:18 +00001194
Bruno Cardoso Lopes186c6702009-06-04 00:15:51 +00001195 BufferBegin = CurBufferPtr = (uint8_t *)Buffer;
Nate Begemand6b7a242009-02-18 08:31:02 +00001196 BufferEnd = BufferBegin+StubSize+1;
1197}
1198
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +00001199void JITEmitter::finishGVStub() {
Jeffrey Yasskin108c8382009-11-23 23:35:19 +00001200 assert(CurBufferPtr != BufferEnd && "Stub overflowed allocated space.");
Chris Lattner43b429b2006-05-02 18:27:26 +00001201 NumBytes += getCurrentPCOffset();
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +00001202 BufferBegin = SavedBufferBegin;
1203 BufferEnd = SavedBufferEnd;
1204 CurBufferPtr = SavedCurBufferPtr;
1205}
1206
1207void *JITEmitter::allocIndirectGV(const GlobalValue *GV,
1208 const uint8_t *Buffer, size_t Size,
1209 unsigned Alignment) {
1210 uint8_t *IndGV = MemMgr->allocateStub(GV, Size, Alignment);
1211 memcpy(IndGV, Buffer, Size);
1212 return IndGV;
Chris Lattnerbba1b6d2003-06-01 23:24:36 +00001213}
1214
Chris Lattnerbba1b6d2003-06-01 23:24:36 +00001215// getConstantPoolEntryAddress - Return the address of the 'ConstantNum' entry
1216// in the constant pool that was last emitted with the 'emitConstantPool'
1217// method.
1218//
Evan Cheng5788d1a2008-12-10 02:32:19 +00001219uintptr_t JITEmitter::getConstantPoolEntryAddress(unsigned ConstantNum) const {
Chris Lattner239862c2006-02-09 04:49:59 +00001220 assert(ConstantNum < ConstantPool->getConstants().size() &&
Misha Brukman3c944972005-04-22 04:08:30 +00001221 "Invalid ConstantPoolIndex!");
Evan Cheng1606e8e2009-03-13 07:51:59 +00001222 return ConstPoolAddresses[ConstantNum];
Chris Lattnerbba1b6d2003-06-01 23:24:36 +00001223}
1224
Nate Begeman37efe672006-04-22 18:53:45 +00001225// getJumpTableEntryAddress - Return the address of the JumpTable with index
1226// 'Index' in the jumpp table that was last initialized with 'initJumpTableInfo'
1227//
Evan Cheng5788d1a2008-12-10 02:32:19 +00001228uintptr_t JITEmitter::getJumpTableEntryAddress(unsigned Index) const {
Nate Begeman37efe672006-04-22 18:53:45 +00001229 const std::vector<MachineJumpTableEntry> &JT = JumpTable->getJumpTables();
1230 assert(Index < JT.size() && "Invalid jump table index!");
Eric Christopher116664a2009-11-12 03:12:18 +00001231
Chris Lattner071c62f2010-01-25 23:26:13 +00001232 unsigned EntrySize = JumpTable->getEntrySize(*TheJIT->getTargetData());
Eric Christopher116664a2009-11-12 03:12:18 +00001233
Chris Lattner071c62f2010-01-25 23:26:13 +00001234 unsigned Offset = 0;
Nate Begeman37efe672006-04-22 18:53:45 +00001235 for (unsigned i = 0; i < Index; ++i)
Jim Laskeyacd80ac2006-12-14 19:17:33 +00001236 Offset += JT[i].MBBs.size();
Eric Christopher116664a2009-11-12 03:12:18 +00001237
Jim Laskeyacd80ac2006-12-14 19:17:33 +00001238 Offset *= EntrySize;
Eric Christopher116664a2009-11-12 03:12:18 +00001239
Evan Cheng5788d1a2008-12-10 02:32:19 +00001240 return (uintptr_t)((char *)JumpTableBase + Offset);
Nate Begeman37efe672006-04-22 18:53:45 +00001241}
1242
Jeffrey Yasskin7a9034c2009-10-27 00:03:05 +00001243void JITEmitter::EmittedFunctionConfig::onDelete(
1244 JITEmitter *Emitter, const Function *F) {
1245 Emitter->deallocateMemForFunction(F);
1246}
1247void JITEmitter::EmittedFunctionConfig::onRAUW(
1248 JITEmitter *, const Function*, const Function*) {
1249 llvm_unreachable("The JIT doesn't know how to handle a"
1250 " RAUW on a value it has emitted.");
1251}
1252
1253
Chris Lattnere993cc22006-05-11 23:08:08 +00001254//===----------------------------------------------------------------------===//
1255// Public interface to this file
1256//===----------------------------------------------------------------------===//
1257
Reid Kleckner27632172009-09-20 23:52:43 +00001258JITCodeEmitter *JIT::createEmitter(JIT &jit, JITMemoryManager *JMM,
1259 TargetMachine &tm) {
1260 return new JITEmitter(jit, JMM, tm);
Chris Lattnere993cc22006-05-11 23:08:08 +00001261}
1262
Chris Lattnere993cc22006-05-11 23:08:08 +00001263// getPointerToFunctionOrStub - If the specified function has been
1264// code-gen'd, return a pointer to the function. If not, compile it, or use
1265// a stub to implement lazy compilation if available.
1266//
1267void *JIT::getPointerToFunctionOrStub(Function *F) {
1268 // If we have already code generated the function, just return the address.
1269 if (void *Addr = getPointerToGlobalIfAvailable(F))
1270 return Addr;
Eric Christopher116664a2009-11-12 03:12:18 +00001271
Chris Lattnere7484012007-02-24 02:57:03 +00001272 // Get a stub if the target supports it.
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +00001273 assert(isa<JITEmitter>(JCE) && "Unexpected MCE?");
Evan Chenga044dfc2008-08-20 00:28:12 +00001274 JITEmitter *JE = cast<JITEmitter>(getCodeEmitter());
Jeffrey Yasskin108c8382009-11-23 23:35:19 +00001275 return JE->getJITResolver().getLazyFunctionStub(F);
Chris Lattnere993cc22006-05-11 23:08:08 +00001276}
1277
Nate Begemand6b7a242009-02-18 08:31:02 +00001278void JIT::updateFunctionStub(Function *F) {
1279 // Get the empty stub we generated earlier.
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +00001280 assert(isa<JITEmitter>(JCE) && "Unexpected MCE?");
Nate Begemand6b7a242009-02-18 08:31:02 +00001281 JITEmitter *JE = cast<JITEmitter>(getCodeEmitter());
Jeffrey Yasskin108c8382009-11-23 23:35:19 +00001282 void *Stub = JE->getJITResolver().getLazyFunctionStub(F);
1283 void *Addr = getPointerToGlobalIfAvailable(F);
Jeffrey Yasskinaad0d522009-12-17 21:35:29 +00001284 assert(Addr != Stub && "Function must have non-stub address to be updated.");
Nate Begemand6b7a242009-02-18 08:31:02 +00001285
1286 // Tell the target jit info to rewrite the stub at the specified address,
1287 // rather than creating a new one.
Jeffrey Yasskin108c8382009-11-23 23:35:19 +00001288 TargetJITInfo::StubLayout layout = getJITInfo().getStubLayout();
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +00001289 JE->startGVStub(Stub, layout.Size);
Jeffrey Yasskin108c8382009-11-23 23:35:19 +00001290 getJITInfo().emitFunctionStub(F, Addr, *getCodeEmitter());
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +00001291 JE->finishGVStub();
Nate Begemand6b7a242009-02-18 08:31:02 +00001292}
1293
Chris Lattnere993cc22006-05-11 23:08:08 +00001294/// freeMachineCodeForFunction - release machine code memory for given Function.
1295///
1296void JIT::freeMachineCodeForFunction(Function *F) {
1297 // Delete translation for this from the ExecutionEngine, so it will get
1298 // retranslated next time it is used.
Jeffrey Yasskin7a9034c2009-10-27 00:03:05 +00001299 updateGlobalMapping(F, 0);
Chris Lattnere993cc22006-05-11 23:08:08 +00001300
1301 // Free the actual memory for the function body and related stuff.
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +00001302 assert(isa<JITEmitter>(JCE) && "Unexpected MCE?");
1303 cast<JITEmitter>(JCE)->deallocateMemForFunction(F);
Chris Lattnere993cc22006-05-11 23:08:08 +00001304}