blob: 4d5857414b924ebb19ade83dc3b3c7e15b899b17 [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"
Chris Lattner1cc08382003-01-13 01:00:12 +000026#include "llvm/CodeGen/MachineConstantPool.h"
Nate Begeman37efe672006-04-22 18:53:45 +000027#include "llvm/CodeGen/MachineJumpTableInfo.h"
Nicolas Geoffrayafe6c2b2008-02-13 18:39:37 +000028#include "llvm/CodeGen/MachineModuleInfo.h"
Chris Lattner5be478f2004-11-20 03:46:14 +000029#include "llvm/CodeGen/MachineRelocation.h"
Dale Johannesendd947ea2008-08-07 01:30:15 +000030#include "llvm/ExecutionEngine/GenericValue.h"
Jeffrey Yasskindf5a7da2009-06-25 02:04:04 +000031#include "llvm/ExecutionEngine/JITEventListener.h"
32#include "llvm/ExecutionEngine/JITMemoryManager.h"
Argyrios Kyrtzidisb3a847d2009-05-18 21:06:40 +000033#include "llvm/CodeGen/MachineCodeInfo.h"
Chris Lattner1cc08382003-01-13 01:00:12 +000034#include "llvm/Target/TargetData.h"
Chris Lattner5be478f2004-11-20 03:46:14 +000035#include "llvm/Target/TargetJITInfo.h"
Jim Laskeyacd80ac2006-12-14 19:17:33 +000036#include "llvm/Target/TargetMachine.h"
Nicolas Geoffrayafe6c2b2008-02-13 18:39:37 +000037#include "llvm/Target/TargetOptions.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000038#include "llvm/Support/Debug.h"
Torok Edwin7d696d82009-07-11 13:10:19 +000039#include "llvm/Support/ErrorHandling.h"
Chris Lattnere7fd5532006-05-08 22:00:52 +000040#include "llvm/Support/MutexGuard.h"
Nick Lewycky848b3142009-04-19 18:32:03 +000041#include "llvm/Support/ValueHandle.h"
Torok Edwin7d696d82009-07-11 13:10:19 +000042#include "llvm/Support/raw_ostream.h"
Anton Korobeynikovfd58e6e2007-01-23 10:26:08 +000043#include "llvm/System/Disassembler.h"
Chris Lattnerbc52cad2008-06-25 17:18:44 +000044#include "llvm/System/Memory.h"
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +000045#include "llvm/Target/TargetInstrInfo.h"
Jeffrey Yasskin1e861322009-10-20 18:13:21 +000046#include "llvm/ADT/DenseMap.h"
Evan Cheng47c01a02008-11-07 09:02:17 +000047#include "llvm/ADT/SmallPtrSet.h"
Nate Begemand6b7a242009-02-18 08:31:02 +000048#include "llvm/ADT/SmallVector.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000049#include "llvm/ADT/Statistic.h"
Jeffrey Yasskin23e5fcf2009-10-23 22:37:43 +000050#include "llvm/ADT/ValueMap.h"
Andrew Lenhartha00269b2005-07-29 23:40:16 +000051#include <algorithm>
Evan Chenga7916f52008-11-05 23:44:08 +000052#ifndef NDEBUG
53#include <iomanip>
54#endif
Chris Lattnerc19aade2003-12-08 08:06:28 +000055using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000056
Chris Lattner36343732006-12-19 22:43:32 +000057STATISTIC(NumBytes, "Number of bytes of machine code compiled");
58STATISTIC(NumRelos, "Number of relocations applied");
Reid Kleckner10b4fc52009-07-23 21:46:56 +000059STATISTIC(NumRetries, "Number of retries with more memory");
Chris Lattner36343732006-12-19 22:43:32 +000060static JIT *TheJIT = 0;
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) {
66 return F->isDeclaration() && !F->hasNotBeenReadFromBitcode();
67}
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
Reid Spenceree448632005-07-12 15:51:55 +0000112 public:
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000113 JITResolverState() : FunctionToLazyStubMap(this),
Jeffrey Yasskin23e5fcf2009-10-23 22:37:43 +0000114 FunctionToCallSitesMap(this) {}
115
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000116 FunctionToLazyStubMapTy& getFunctionToLazyStubMap(
117 const MutexGuard& locked) {
Reid Spenceree448632005-07-12 15:51:55 +0000118 assert(locked.holds(TheJIT->lock));
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000119 return FunctionToLazyStubMap;
Reid Spenceree448632005-07-12 15:51:55 +0000120 }
Jeff Cohen00b168892005-07-27 06:12:32 +0000121
Nick Lewyckye2bcf132009-04-27 05:09:44 +0000122 GlobalToIndirectSymMapTy& getGlobalToIndirectSymMap(const MutexGuard& locked) {
Evan Chengbe8c03f2008-01-04 10:46:51 +0000123 assert(locked.holds(TheJIT->lock));
Evan Cheng5594f122008-11-10 01:52:24 +0000124 return GlobalToIndirectSymMap;
Evan Chengbe8c03f2008-01-04 10:46:51 +0000125 }
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000126
127 pair<void *, Function *> LookupFunctionFromCallSite(
128 const MutexGuard &locked, void *CallSite) const {
129 assert(locked.holds(TheJIT->lock));
130
131 // The address given to us for the stub may not be exactly right, it might be
132 // a little bit after the stub. As such, use upper_bound to find it.
133 CallSiteToFunctionMapTy::const_iterator I =
134 CallSiteToFunctionMap.upper_bound(CallSite);
135 assert(I != CallSiteToFunctionMap.begin() &&
136 "This is not a known call site!");
137 --I;
138 return *I;
139 }
140
141 void AddCallSite(const MutexGuard &locked, void *CallSite, Function *F) {
142 assert(locked.holds(TheJIT->lock));
143
Jeffrey Yasskin23e5fcf2009-10-23 22:37:43 +0000144 bool Inserted = CallSiteToFunctionMap.insert(
145 std::make_pair(CallSite, F)).second;
146 (void)Inserted;
147 assert(Inserted && "Pair was already in CallSiteToFunctionMap");
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000148 FunctionToCallSitesMap[F].insert(CallSite);
149 }
150
151 // Returns the Function of the stub if a stub was erased, or NULL if there
152 // was no stub. This function uses the call-site->function map to find a
153 // relevant function, but asserts that only stubs and not other call sites
154 // will be passed in.
155 Function *EraseStub(const MutexGuard &locked, void *Stub) {
156 CallSiteToFunctionMapTy::iterator C2F_I =
157 CallSiteToFunctionMap.find(Stub);
158 if (C2F_I == CallSiteToFunctionMap.end()) {
159 // Not a stub.
160 return NULL;
161 }
162
163 Function *const F = C2F_I->second;
164#ifndef NDEBUG
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000165 void *RealStub = FunctionToLazyStubMap.lookup(F);
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000166 assert(RealStub == Stub &&
167 "Call-site that wasn't a stub pass in to EraseStub");
168#endif
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000169 FunctionToLazyStubMap.erase(F);
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000170 CallSiteToFunctionMap.erase(C2F_I);
171
172 // Remove the stub from the function->call-sites map, and remove the whole
173 // entry from the map if that was the last call site.
174 FunctionToCallSitesMapTy::iterator F2C_I = FunctionToCallSitesMap.find(F);
175 assert(F2C_I != FunctionToCallSitesMap.end() &&
176 "FunctionToCallSitesMap broken");
Jeffrey Yasskin23e5fcf2009-10-23 22:37:43 +0000177 bool Erased = F2C_I->second.erase(Stub);
178 (void)Erased;
179 assert(Erased && "FunctionToCallSitesMap broken");
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000180 if (F2C_I->second.empty())
181 FunctionToCallSitesMap.erase(F2C_I);
182
183 return F;
184 }
185
186 void EraseAllCallSites(const MutexGuard &locked, Function *F) {
187 assert(locked.holds(TheJIT->lock));
Jeffrey Yasskin23e5fcf2009-10-23 22:37:43 +0000188 EraseAllCallSitesPrelocked(F);
189 }
190 void EraseAllCallSitesPrelocked(Function *F) {
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000191 FunctionToCallSitesMapTy::iterator F2C = FunctionToCallSitesMap.find(F);
192 if (F2C == FunctionToCallSitesMap.end())
193 return;
194 for (SmallPtrSet<void*, 1>::const_iterator I = F2C->second.begin(),
195 E = F2C->second.end(); I != E; ++I) {
Jeffrey Yasskin23e5fcf2009-10-23 22:37:43 +0000196 bool Erased = CallSiteToFunctionMap.erase(*I);
197 (void)Erased;
198 assert(Erased && "Missing call site->function mapping");
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000199 }
200 FunctionToCallSitesMap.erase(F2C);
201 }
Reid Spenceree448632005-07-12 15:51:55 +0000202 };
Jeff Cohen00b168892005-07-27 06:12:32 +0000203
Chris Lattner54266522004-11-20 23:57:07 +0000204 /// JITResolver - Keep track of, and resolve, call sites for functions that
205 /// have not yet been compiled.
206 class JITResolver {
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000207 typedef JITResolverState::FunctionToLazyStubMapTy FunctionToLazyStubMapTy;
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000208 typedef JITResolverState::CallSiteToFunctionMapTy CallSiteToFunctionMapTy;
Nick Lewyckye2bcf132009-04-27 05:09:44 +0000209 typedef JITResolverState::GlobalToIndirectSymMapTy GlobalToIndirectSymMapTy;
210
Chris Lattner5e225582004-11-21 03:37:42 +0000211 /// LazyResolverFn - The target lazy resolver function that we actually
212 /// rewrite instructions to use.
213 TargetJITInfo::LazyResolverFn LazyResolverFn;
214
Reid Spenceree448632005-07-12 15:51:55 +0000215 JITResolverState state;
Chris Lattner54266522004-11-20 23:57:07 +0000216
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000217 /// ExternalFnToStubMap - This is the equivalent of FunctionToLazyStubMap
218 /// for external functions. TODO: Of course, external functions don't need
219 /// a lazy stub. It's actually here to make it more likely that far calls
220 /// succeed, but no single stub can guarantee that. I'll remove this in a
221 /// subsequent checkin when I actually fix far calls.
Chris Lattnerd91ff7c2005-04-18 01:44:27 +0000222 std::map<void*, void*> ExternalFnToStubMap;
Andrew Lenharth6a974612005-07-28 12:44:13 +0000223
Evan Cheng1606e8e2009-03-13 07:51:59 +0000224 /// revGOTMap - map addresses to indexes in the GOT
Andrew Lenharth6a974612005-07-28 12:44:13 +0000225 std::map<void*, unsigned> revGOTMap;
226 unsigned nextGOTIndex;
227
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000228 JITEmitter &JE;
229
Chris Lattnere7484012007-02-24 02:57:03 +0000230 static JITResolver *TheJITResolver;
Chris Lattner54266522004-11-20 23:57:07 +0000231 public:
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000232 explicit JITResolver(JIT &jit, JITEmitter &je) : nextGOTIndex(0), JE(je) {
Chris Lattnere7484012007-02-24 02:57:03 +0000233 TheJIT = &jit;
234
235 LazyResolverFn = jit.getJITInfo().getLazyResolverFunction(JITCompilerFn);
236 assert(TheJITResolver == 0 && "Multiple JIT resolvers?");
237 TheJITResolver = this;
238 }
Eric Christopher116664a2009-11-12 03:12:18 +0000239
Chris Lattnere7484012007-02-24 02:57:03 +0000240 ~JITResolver() {
241 TheJITResolver = 0;
Chris Lattner5e225582004-11-21 03:37:42 +0000242 }
Chris Lattner54266522004-11-20 23:57:07 +0000243
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000244 /// getLazyFunctionStubIfAvailable - This returns a pointer to a function's
245 /// lazy-compilation stub if it has already been created.
246 void *getLazyFunctionStubIfAvailable(Function *F);
Evan Cheng704bff92008-11-13 21:50:50 +0000247
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000248 /// getLazyFunctionStub - This returns a pointer to a function's
249 /// lazy-compilation stub, creating one on demand as needed.
250 void *getLazyFunctionStub(Function *F);
Chris Lattner54266522004-11-20 23:57:07 +0000251
Chris Lattnerd91ff7c2005-04-18 01:44:27 +0000252 /// getExternalFunctionStub - Return a stub for the function at the
253 /// specified address, created lazily on demand.
254 void *getExternalFunctionStub(void *FnAddr);
255
Evan Cheng5594f122008-11-10 01:52:24 +0000256 /// getGlobalValueIndirectSym - Return an indirect symbol containing the
Evan Chengc96a8e72008-11-05 01:50:32 +0000257 /// specified GV address.
Evan Cheng5594f122008-11-10 01:52:24 +0000258 void *getGlobalValueIndirectSym(GlobalValue *V, void *GVAddress);
Evan Chengbe8c03f2008-01-04 10:46:51 +0000259
Nate Begemand6b7a242009-02-18 08:31:02 +0000260 void getRelocatableGVs(SmallVectorImpl<GlobalValue*> &GVs,
Nate Begeman50cd6fd2009-03-05 06:34:37 +0000261 SmallVectorImpl<void*> &Ptrs);
Eric Christopher116664a2009-11-12 03:12:18 +0000262
Nate Begeman50cd6fd2009-03-05 06:34:37 +0000263 GlobalValue *invalidateStub(void *Stub);
Chris Lattner5e225582004-11-21 03:37:42 +0000264
Andrew Lenharth6a974612005-07-28 12:44:13 +0000265 /// getGOTIndexForAddress - Return a new or existing index in the GOT for
Chris Lattner8907b4b2007-12-05 23:39:57 +0000266 /// an address. This function only manages slots, it does not manage the
Andrew Lenharth6a974612005-07-28 12:44:13 +0000267 /// contents of the slots or the memory associated with the GOT.
Chris Lattner8907b4b2007-12-05 23:39:57 +0000268 unsigned getGOTIndexForAddr(void *addr);
Andrew Lenharth6a974612005-07-28 12:44:13 +0000269
Chris Lattner54266522004-11-20 23:57:07 +0000270 /// JITCompilerFn - This function is called to resolve a stub to a compiled
271 /// address. If the LLVM Function corresponding to the stub has not yet
272 /// been compiled, this function compiles it first.
273 static void *JITCompilerFn(void *Stub);
274 };
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000275
276 /// 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.
331 std::vector<uintptr_t> LabelLocations;
332
333 /// MMI - Machine module info for exception informations
334 MachineModuleInfo* MMI;
335
336 // GVSet - a set to keep track of which globals have been seen
337 SmallPtrSet<const GlobalVariable*, 8> GVSet;
338
Eric Christopher116664a2009-11-12 03:12:18 +0000339 // CurFn - The llvm function being emitted. Only valid during
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000340 // finishFunction().
341 const Function *CurFn;
342
343 /// Information about emitted code, which is passed to the
344 /// JITEventListeners. This is reset in startFunction and used in
345 /// finishFunction.
346 JITEvent_EmittedFunctionDetails EmissionDetails;
347
348 struct EmittedCode {
349 void *FunctionBody; // Beginning of the function's allocation.
350 void *Code; // The address the function's code actually starts at.
351 void *ExceptionTable;
352 EmittedCode() : FunctionBody(0), Code(0), ExceptionTable(0) {}
353 };
354 struct EmittedFunctionConfig : public ValueMapConfig<const Function*> {
355 typedef JITEmitter *ExtraData;
356 static void onDelete(JITEmitter *, const Function*);
357 static void onRAUW(JITEmitter *, const Function*, const Function*);
358 };
359 ValueMap<const Function *, EmittedCode,
360 EmittedFunctionConfig> EmittedFunctions;
361
362 // CurFnStubUses - For a given Function, a vector of stubs that it
363 // references. This facilitates the JIT detecting that a stub is no
364 // longer used, so that it may be deallocated.
365 DenseMap<AssertingVH<const Function>, SmallVector<void*, 1> > CurFnStubUses;
366
367 // StubFnRefs - For a given pointer to a stub, a set of Functions which
368 // reference the stub. When the count of a stub's references drops to zero,
369 // the stub is unused.
370 DenseMap<void *, SmallPtrSet<const Function*, 1> > StubFnRefs;
Eric Christopher116664a2009-11-12 03:12:18 +0000371
Devang Patel6b61f582010-01-16 06:09:35 +0000372 DILocation PrevDLT;
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000373
374 public:
375 JITEmitter(JIT &jit, JITMemoryManager *JMM, TargetMachine &TM)
376 : SizeEstimate(0), Resolver(jit, *this), MMI(0), CurFn(0),
Devang Patel6b61f582010-01-16 06:09:35 +0000377 EmittedFunctions(this), PrevDLT(NULL) {
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000378 MemMgr = JMM ? JMM : JITMemoryManager::CreateDefaultMemManager();
379 if (jit.getJITInfo().needsGOT()) {
380 MemMgr->AllocateGOT();
David Greenec9ec9932010-01-05 01:23:36 +0000381 DEBUG(dbgs() << "JIT is managing a GOT\n");
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000382 }
383
384 if (DwarfExceptionHandling || JITEmitDebugInfo) {
385 DE.reset(new JITDwarfEmitter(jit));
386 }
387 if (JITEmitDebugInfo) {
388 DR.reset(new JITDebugRegisterer(TM));
389 }
390 }
Eric Christopher116664a2009-11-12 03:12:18 +0000391 ~JITEmitter() {
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000392 delete MemMgr;
393 }
394
395 /// classof - Methods for support type inquiry through isa, cast, and
396 /// dyn_cast:
397 ///
398 static inline bool classof(const JITEmitter*) { return true; }
399 static inline bool classof(const MachineCodeEmitter*) { return true; }
Eric Christopher116664a2009-11-12 03:12:18 +0000400
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000401 JITResolver &getJITResolver() { return Resolver; }
402
403 virtual void startFunction(MachineFunction &F);
404 virtual bool finishFunction(MachineFunction &F);
Eric Christopher116664a2009-11-12 03:12:18 +0000405
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000406 void emitConstantPool(MachineConstantPool *MCP);
407 void initJumpTableInfo(MachineJumpTableInfo *MJTI);
408 void emitJumpTableInfo(MachineJumpTableInfo *MJTI);
Eric Christopher116664a2009-11-12 03:12:18 +0000409
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +0000410 void startGVStub(const GlobalValue* GV,
411 unsigned StubSize, unsigned Alignment = 1);
412 void startGVStub(void *Buffer, unsigned StubSize);
413 void finishGVStub();
414 virtual void *allocIndirectGV(const GlobalValue *GV,
415 const uint8_t *Buffer, size_t Size,
416 unsigned Alignment);
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000417
418 /// allocateSpace - Reserves space in the current block if any, or
419 /// allocate a new one of the given size.
420 virtual void *allocateSpace(uintptr_t Size, unsigned Alignment);
421
422 /// allocateGlobal - Allocate memory for a global. Unlike allocateSpace,
423 /// this method does not allocate memory in the current output buffer,
424 /// because a global may live longer than the current function.
425 virtual void *allocateGlobal(uintptr_t Size, unsigned Alignment);
426
427 virtual void addRelocation(const MachineRelocation &MR) {
428 Relocations.push_back(MR);
429 }
Eric Christopher116664a2009-11-12 03:12:18 +0000430
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000431 virtual void StartMachineBasicBlock(MachineBasicBlock *MBB) {
432 if (MBBLocations.size() <= (unsigned)MBB->getNumber())
433 MBBLocations.resize((MBB->getNumber()+1)*2);
434 MBBLocations[MBB->getNumber()] = getCurrentPCValue();
David Greenec9ec9932010-01-05 01:23:36 +0000435 DEBUG(dbgs() << "JIT: Emitting BB" << MBB->getNumber() << " at ["
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000436 << (void*) getCurrentPCValue() << "]\n");
437 }
438
439 virtual uintptr_t getConstantPoolEntryAddress(unsigned Entry) const;
440 virtual uintptr_t getJumpTableEntryAddress(unsigned Entry) const;
441
442 virtual uintptr_t getMachineBasicBlockAddress(MachineBasicBlock *MBB) const {
Eric Christopher116664a2009-11-12 03:12:18 +0000443 assert(MBBLocations.size() > (unsigned)MBB->getNumber() &&
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000444 MBBLocations[MBB->getNumber()] && "MBB not emitted!");
445 return MBBLocations[MBB->getNumber()];
446 }
447
448 /// retryWithMoreMemory - Log a retry and deallocate all memory for the
449 /// given function. Increase the minimum allocation size so that we get
450 /// more memory next time.
451 void retryWithMoreMemory(MachineFunction &F);
452
453 /// deallocateMemForFunction - Deallocate all memory for the specified
454 /// function body.
455 void deallocateMemForFunction(const Function *F);
456
457 /// AddStubToCurrentFunction - Mark the current function being JIT'd as
458 /// using the stub at the specified address. Allows
459 /// deallocateMemForFunction to also remove stubs no longer referenced.
460 void AddStubToCurrentFunction(void *Stub);
Eric Christopher116664a2009-11-12 03:12:18 +0000461
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000462 virtual void processDebugLoc(DebugLoc DL, bool BeforePrintingInsn);
463
464 virtual void emitLabel(uint64_t LabelID) {
465 if (LabelLocations.size() <= LabelID)
466 LabelLocations.resize((LabelID+1)*2);
467 LabelLocations[LabelID] = getCurrentPCValue();
468 }
469
470 virtual uintptr_t getLabelAddress(uint64_t LabelID) const {
Eric Christopher116664a2009-11-12 03:12:18 +0000471 assert(LabelLocations.size() > (unsigned)LabelID &&
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000472 LabelLocations[LabelID] && "Label not emitted!");
473 return LabelLocations[LabelID];
474 }
Eric Christopher116664a2009-11-12 03:12:18 +0000475
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000476 virtual void setModuleInfo(MachineModuleInfo* Info) {
477 MMI = Info;
478 if (DE.get()) DE->setModuleInfo(Info);
479 }
480
481 void setMemoryExecutable() {
482 MemMgr->setMemoryExecutable();
483 }
Eric Christopher116664a2009-11-12 03:12:18 +0000484
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000485 JITMemoryManager *getMemMgr() const { return MemMgr; }
486
487 private:
Jeffrey Yasskin2d274412009-11-07 08:51:52 +0000488 void *getPointerToGlobal(GlobalValue *GV, void *Reference,
489 bool MayNeedFarStub);
490 void *getPointerToGVIndirectSym(GlobalValue *V, void *Reference);
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000491 unsigned addSizeOfGlobal(const GlobalVariable *GV, unsigned Size);
492 unsigned addSizeOfGlobalsInConstantVal(const Constant *C, unsigned Size);
493 unsigned addSizeOfGlobalsInInitializer(const Constant *Init, unsigned Size);
494 unsigned GetSizeOfGlobalsInBytes(MachineFunction &MF);
495 };
Chris Lattner54266522004-11-20 23:57:07 +0000496}
497
Chris Lattnere7484012007-02-24 02:57:03 +0000498JITResolver *JITResolver::TheJITResolver = 0;
Chris Lattner54266522004-11-20 23:57:07 +0000499
Jeffrey Yasskin23e5fcf2009-10-23 22:37:43 +0000500void CallSiteValueMapConfig::onDelete(JITResolverState *JRS, Function *F) {
501 JRS->EraseAllCallSitesPrelocked(F);
502}
503
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000504/// getLazyFunctionStubIfAvailable - This returns a pointer to a function stub
Evan Cheng704bff92008-11-13 21:50:50 +0000505/// if it has already been created.
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000506void *JITResolver::getLazyFunctionStubIfAvailable(Function *F) {
Evan Cheng704bff92008-11-13 21:50:50 +0000507 MutexGuard locked(TheJIT->lock);
508
509 // If we already have a stub for this function, recycle it.
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000510 return state.getFunctionToLazyStubMap(locked).lookup(F);
Evan Cheng704bff92008-11-13 21:50:50 +0000511}
512
Chris Lattner54266522004-11-20 23:57:07 +0000513/// getFunctionStub - This returns a pointer to a function stub, creating
514/// one on demand as needed.
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000515void *JITResolver::getLazyFunctionStub(Function *F) {
Reid Spenceree448632005-07-12 15:51:55 +0000516 MutexGuard locked(TheJIT->lock);
517
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000518 // If we already have a lazy stub for this function, recycle it.
519 void *&Stub = state.getFunctionToLazyStubMap(locked)[F];
Chris Lattner54266522004-11-20 23:57:07 +0000520 if (Stub) return Stub;
521
Jeffrey Yasskindc857242009-10-27 20:30:28 +0000522 // Call the lazy resolver function if we are JIT'ing lazily. Otherwise we
523 // must resolve the symbol now.
524 void *Actual = TheJIT->isCompilingLazily()
525 ? (void *)(intptr_t)LazyResolverFn : (void *)0;
526
Nate Begemanb9c6c9b2009-03-07 06:41:19 +0000527 // If this is an external declaration, attempt to resolve the address now
528 // to place in the stub.
Jeffrey Yasskinc5818fb2009-12-22 23:47:23 +0000529 if (isNonGhostDeclaration(F) || F->hasAvailableExternallyLinkage()) {
Chris Lattnerb43dbdc2004-11-22 07:24:43 +0000530 Actual = TheJIT->getPointerToFunction(F);
Misha Brukmanf976c852005-04-21 22:55:34 +0000531
Dan Gohman69f93782009-01-05 05:32:42 +0000532 // If we resolved the symbol to a null address (eg. a weak external)
Jeffrey Yasskin6f348e42009-11-09 22:34:19 +0000533 // don't emit a stub. Return a null pointer to the application.
534 if (!Actual) return 0;
Dan Gohman69f93782009-01-05 05:32:42 +0000535 }
536
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000537 TargetJITInfo::StubLayout SL = TheJIT->getJITInfo().getStubLayout();
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +0000538 JE.startGVStub(F, SL.Size, SL.Alignment);
Nate Begemanb9c6c9b2009-03-07 06:41:19 +0000539 // Codegen a new stub, calling the lazy resolver or the actual address of the
540 // external function, if it was resolved.
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000541 Stub = TheJIT->getJITInfo().emitFunctionStub(F, Actual, JE);
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +0000542 JE.finishGVStub();
Chris Lattnerb43dbdc2004-11-22 07:24:43 +0000543
Chris Lattner870286a2006-06-01 17:29:22 +0000544 if (Actual != (void*)(intptr_t)LazyResolverFn) {
Chris Lattnerb43dbdc2004-11-22 07:24:43 +0000545 // If we are getting the stub for an external function, we really want the
546 // address of the stub in the GlobalAddressMap for the JIT, not the address
547 // of the external function.
548 TheJIT->updateGlobalMapping(F, Stub);
549 }
Chris Lattner54266522004-11-20 23:57:07 +0000550
David Greenec9ec9932010-01-05 01:23:36 +0000551 DEBUG(dbgs() << "JIT: Lazy stub emitted at [" << Stub << "] for function '"
Daniel Dunbarce63ffb2009-07-25 00:23:56 +0000552 << F->getName() << "'\n");
Chris Lattnercb479412004-11-21 03:44:32 +0000553
Chris Lattner54266522004-11-20 23:57:07 +0000554 // Finally, keep track of the stub-to-Function mapping so that the
555 // JITCompilerFn knows which function to compile!
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000556 state.AddCallSite(locked, Stub, F);
Jeffrey Yasskine5f87982009-10-13 21:32:57 +0000557
Nate Begemanb9c6c9b2009-03-07 06:41:19 +0000558 // If we are JIT'ing non-lazily but need to call a function that does not
559 // exist yet, add it to the JIT's work list so that we can fill in the stub
560 // address later.
Jeffrey Yasskindc857242009-10-27 20:30:28 +0000561 if (!Actual && !TheJIT->isCompilingLazily())
Jeffrey Yasskinc5818fb2009-12-22 23:47:23 +0000562 if (!isNonGhostDeclaration(F) && !F->hasAvailableExternallyLinkage())
Nate Begemanb9c6c9b2009-03-07 06:41:19 +0000563 TheJIT->addPendingFunction(F);
Jeffrey Yasskine5f87982009-10-13 21:32:57 +0000564
Chris Lattner54266522004-11-20 23:57:07 +0000565 return Stub;
566}
567
Evan Cheng5594f122008-11-10 01:52:24 +0000568/// getGlobalValueIndirectSym - Return a lazy pointer containing the specified
Evan Chengbe8c03f2008-01-04 10:46:51 +0000569/// GV address.
Evan Cheng5594f122008-11-10 01:52:24 +0000570void *JITResolver::getGlobalValueIndirectSym(GlobalValue *GV, void *GVAddress) {
Evan Chengbe8c03f2008-01-04 10:46:51 +0000571 MutexGuard locked(TheJIT->lock);
572
573 // If we already have a stub for this global variable, recycle it.
Evan Cheng5594f122008-11-10 01:52:24 +0000574 void *&IndirectSym = state.getGlobalToIndirectSymMap(locked)[GV];
575 if (IndirectSym) return IndirectSym;
Evan Chengbe8c03f2008-01-04 10:46:51 +0000576
Evan Chenge4d783d2008-11-10 23:26:16 +0000577 // Otherwise, codegen a new indirect symbol.
Evan Cheng5594f122008-11-10 01:52:24 +0000578 IndirectSym = TheJIT->getJITInfo().emitGlobalValueIndirectSym(GV, GVAddress,
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000579 JE);
Evan Chengbe8c03f2008-01-04 10:46:51 +0000580
David Greenec9ec9932010-01-05 01:23:36 +0000581 DEBUG(dbgs() << "JIT: Indirect symbol emitted at [" << IndirectSym
Daniel Dunbarce63ffb2009-07-25 00:23:56 +0000582 << "] for GV '" << GV->getName() << "'\n");
Evan Chengbe8c03f2008-01-04 10:46:51 +0000583
Evan Cheng5594f122008-11-10 01:52:24 +0000584 return IndirectSym;
Evan Chengbe8c03f2008-01-04 10:46:51 +0000585}
586
Chris Lattnerd91ff7c2005-04-18 01:44:27 +0000587/// getExternalFunctionStub - Return a stub for the function at the
588/// specified address, created lazily on demand.
589void *JITResolver::getExternalFunctionStub(void *FnAddr) {
590 // If we already have a stub for this function, recycle it.
591 void *&Stub = ExternalFnToStubMap[FnAddr];
592 if (Stub) return Stub;
593
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000594 TargetJITInfo::StubLayout SL = TheJIT->getJITInfo().getStubLayout();
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +0000595 JE.startGVStub(0, SL.Size, SL.Alignment);
Jeffrey Yasskine637c192009-11-07 00:00:10 +0000596 Stub = TheJIT->getJITInfo().emitFunctionStub(0, FnAddr, JE);
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +0000597 JE.finishGVStub();
Evan Cheng55fc2802006-07-25 20:40:54 +0000598
David Greenec9ec9932010-01-05 01:23:36 +0000599 DEBUG(dbgs() << "JIT: Stub emitted at [" << Stub
Chris Lattnerbbbfa992009-08-23 06:35:02 +0000600 << "] for external function at '" << FnAddr << "'\n");
Chris Lattnerd91ff7c2005-04-18 01:44:27 +0000601 return Stub;
602}
603
Andrew Lenharth6a974612005-07-28 12:44:13 +0000604unsigned JITResolver::getGOTIndexForAddr(void* addr) {
605 unsigned idx = revGOTMap[addr];
606 if (!idx) {
607 idx = ++nextGOTIndex;
608 revGOTMap[addr] = idx;
David Greenec9ec9932010-01-05 01:23:36 +0000609 DEBUG(dbgs() << "JIT: Adding GOT entry " << idx << " for addr ["
Chris Lattnerbbbfa992009-08-23 06:35:02 +0000610 << addr << "]\n");
Andrew Lenharth6a974612005-07-28 12:44:13 +0000611 }
612 return idx;
613}
Chris Lattnerd91ff7c2005-04-18 01:44:27 +0000614
Nate Begemand6b7a242009-02-18 08:31:02 +0000615void JITResolver::getRelocatableGVs(SmallVectorImpl<GlobalValue*> &GVs,
616 SmallVectorImpl<void*> &Ptrs) {
617 MutexGuard locked(TheJIT->lock);
Eric Christopher116664a2009-11-12 03:12:18 +0000618
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000619 const FunctionToLazyStubMapTy &FM = state.getFunctionToLazyStubMap(locked);
Nick Lewyckye2bcf132009-04-27 05:09:44 +0000620 GlobalToIndirectSymMapTy &GM = state.getGlobalToIndirectSymMap(locked);
Eric Christopher116664a2009-11-12 03:12:18 +0000621
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000622 for (FunctionToLazyStubMapTy::const_iterator i = FM.begin(), e = FM.end();
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000623 i != e; ++i){
Nate Begemand6b7a242009-02-18 08:31:02 +0000624 Function *F = i->first;
625 if (F->isDeclaration() && F->hasExternalLinkage()) {
626 GVs.push_back(i->first);
627 Ptrs.push_back(i->second);
628 }
629 }
Nick Lewyckye2bcf132009-04-27 05:09:44 +0000630 for (GlobalToIndirectSymMapTy::iterator i = GM.begin(), e = GM.end();
Nate Begemand6b7a242009-02-18 08:31:02 +0000631 i != e; ++i) {
632 GVs.push_back(i->first);
633 Ptrs.push_back(i->second);
634 }
635}
636
Nate Begeman50cd6fd2009-03-05 06:34:37 +0000637GlobalValue *JITResolver::invalidateStub(void *Stub) {
638 MutexGuard locked(TheJIT->lock);
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000639
Nick Lewyckye2bcf132009-04-27 05:09:44 +0000640 GlobalToIndirectSymMapTy &GM = state.getGlobalToIndirectSymMap(locked);
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000641
Nate Begeman50cd6fd2009-03-05 06:34:37 +0000642 // Look up the cheap way first, to see if it's a function stub we are
643 // invalidating. If so, remove it from both the forward and reverse maps.
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000644 if (Function *F = state.EraseStub(locked, Stub)) {
Nate Begeman50cd6fd2009-03-05 06:34:37 +0000645 return F;
646 }
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000647
Nate Begeman841c6a42009-03-11 07:03:43 +0000648 // Otherwise, it might be an indirect symbol stub. Find it and remove it.
Nick Lewyckye2bcf132009-04-27 05:09:44 +0000649 for (GlobalToIndirectSymMapTy::iterator i = GM.begin(), e = GM.end();
Nate Begeman50cd6fd2009-03-05 06:34:37 +0000650 i != e; ++i) {
651 if (i->second != Stub)
652 continue;
653 GlobalValue *GV = i->first;
654 GM.erase(i);
655 return GV;
656 }
Eric Christopher116664a2009-11-12 03:12:18 +0000657
Nate Begeman841c6a42009-03-11 07:03:43 +0000658 // Lastly, check to see if it's in the ExternalFnToStubMap.
659 for (std::map<void *, void *>::iterator i = ExternalFnToStubMap.begin(),
660 e = ExternalFnToStubMap.end(); i != e; ++i) {
661 if (i->second != Stub)
662 continue;
663 ExternalFnToStubMap.erase(i);
664 break;
665 }
Eric Christopher116664a2009-11-12 03:12:18 +0000666
Nate Begeman50cd6fd2009-03-05 06:34:37 +0000667 return 0;
668}
669
Chris Lattner54266522004-11-20 23:57:07 +0000670/// JITCompilerFn - This function is called when a lazy compilation stub has
671/// been entered. It looks up which function this stub corresponds to, compiles
672/// it if necessary, then returns the resultant function pointer.
673void *JITResolver::JITCompilerFn(void *Stub) {
Chris Lattnere7484012007-02-24 02:57:03 +0000674 JITResolver &JR = *TheJITResolver;
Eric Christopher116664a2009-11-12 03:12:18 +0000675
Nicolas Geoffraydcb31e12008-10-03 07:27:08 +0000676 Function* F = 0;
677 void* ActualPtr = 0;
Misha Brukmanf976c852005-04-21 22:55:34 +0000678
Nicolas Geoffraydcb31e12008-10-03 07:27:08 +0000679 {
680 // Only lock for getting the Function. The call getPointerToFunction made
681 // in this function might trigger function materializing, which requires
682 // JIT lock to be unlocked.
683 MutexGuard locked(TheJIT->lock);
Reid Spenceree448632005-07-12 15:51:55 +0000684
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000685 // The address given to us for the stub may not be exactly right, it might
686 // be a little bit after the stub. As such, use upper_bound to find it.
687 pair<void*, Function*> I =
688 JR.state.LookupFunctionFromCallSite(locked, Stub);
689 F = I.second;
690 ActualPtr = I.first;
Nicolas Geoffraydcb31e12008-10-03 07:27:08 +0000691 }
Chris Lattner54266522004-11-20 23:57:07 +0000692
Evan Cheng9da60f92007-06-30 00:10:37 +0000693 // If we have already code generated the function, just return the address.
694 void *Result = TheJIT->getPointerToGlobalIfAvailable(F);
Eric Christopher116664a2009-11-12 03:12:18 +0000695
Evan Cheng9da60f92007-06-30 00:10:37 +0000696 if (!Result) {
697 // Otherwise we don't have it, do lazy compilation now.
Eric Christopher116664a2009-11-12 03:12:18 +0000698
Evan Cheng9da60f92007-06-30 00:10:37 +0000699 // If lazy compilation is disabled, emit a useful error message and abort.
Jeffrey Yasskindc857242009-10-27 20:30:28 +0000700 if (!TheJIT->isCompilingLazily()) {
Torok Edwin7d696d82009-07-11 13:10:19 +0000701 llvm_report_error("LLVM JIT requested to do lazy compilation of function '"
702 + F->getName() + "' when lazy compiles are disabled!");
Evan Cheng9da60f92007-06-30 00:10:37 +0000703 }
Eric Christopher116664a2009-11-12 03:12:18 +0000704
David Greenec9ec9932010-01-05 01:23:36 +0000705 DEBUG(dbgs() << "JIT: Lazily resolving function '" << F->getName()
Daniel Dunbarce63ffb2009-07-25 00:23:56 +0000706 << "' In stub ptr = " << Stub << " actual ptr = "
707 << ActualPtr << "\n");
Chris Lattner54266522004-11-20 23:57:07 +0000708
Evan Cheng9da60f92007-06-30 00:10:37 +0000709 Result = TheJIT->getPointerToFunction(F);
710 }
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000711
712 // Reacquire the lock to update the GOT map.
Nicolas Geoffraydcb31e12008-10-03 07:27:08 +0000713 MutexGuard locked(TheJIT->lock);
Chris Lattner54266522004-11-20 23:57:07 +0000714
Jeffrey Yasskinebbcef92009-10-19 18:49:59 +0000715 // We might like to remove the call site from the CallSiteToFunction map, but
716 // we can't do that! Multiple threads could be stuck, waiting to acquire the
717 // lock above. As soon as the 1st function finishes compiling the function,
718 // the next one will be released, and needs to be able to find the function it
719 // needs to call.
Chris Lattner54266522004-11-20 23:57:07 +0000720
721 // FIXME: We could rewrite all references to this stub if we knew them.
Andrew Lenharth6a974612005-07-28 12:44:13 +0000722
Jeff Cohend29b6aa2005-07-30 18:33:25 +0000723 // What we will do is set the compiled function address to map to the
724 // same GOT entry as the stub so that later clients may update the GOT
Andrew Lenharth6a974612005-07-28 12:44:13 +0000725 // if they see it still using the stub address.
726 // Note: this is done so the Resolver doesn't have to manage GOT memory
727 // Do this without allocating map space if the target isn't using a GOT
728 if(JR.revGOTMap.find(Stub) != JR.revGOTMap.end())
729 JR.revGOTMap[Result] = JR.revGOTMap[Stub];
730
Chris Lattner54266522004-11-20 23:57:07 +0000731 return Result;
732}
Chris Lattner688506d2003-08-14 18:35:27 +0000733
Chris Lattner8ac66c12008-04-04 05:51:42 +0000734//===----------------------------------------------------------------------===//
Chris Lattner166f2262004-11-22 22:00:25 +0000735// JITEmitter code.
Chris Lattner54266522004-11-20 23:57:07 +0000736//
Chris Lattner166f2262004-11-22 22:00:25 +0000737void *JITEmitter::getPointerToGlobal(GlobalValue *V, void *Reference,
Jeffrey Yasskin2d274412009-11-07 08:51:52 +0000738 bool MayNeedFarStub) {
Nate Begemand6b7a242009-02-18 08:31:02 +0000739 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
Chris Lattner54266522004-11-20 23:57:07 +0000740 return TheJIT->getOrEmitGlobalVariable(GV);
Nate Begemand6b7a242009-02-18 08:31:02 +0000741
Chris Lattner18e04592008-06-25 20:21:35 +0000742 if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
Anton Korobeynikov19e861a2008-09-09 20:05:04 +0000743 return TheJIT->getPointerToGlobal(GA->resolveAliasedGlobal(false));
Chris Lattner54266522004-11-20 23:57:07 +0000744
745 // If we have already compiled the function, return a pointer to its body.
746 Function *F = cast<Function>(V);
Eric Christopher116664a2009-11-12 03:12:18 +0000747
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000748 void *FnStub = Resolver.getLazyFunctionStubIfAvailable(F);
Eric Christopher116664a2009-11-12 03:12:18 +0000749 if (FnStub) {
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000750 // Return the function stub if it's already created. We do this first so
751 // that we're returning the same address for the function as any previous
752 // call. TODO: Yes, this is wrong. The lazy stub isn't guaranteed to be
753 // close enough to call.
Eric Christopher116664a2009-11-12 03:12:18 +0000754 AddStubToCurrentFunction(FnStub);
755 return FnStub;
Nate Begeman50cd6fd2009-03-05 06:34:37 +0000756 }
Eric Christopher116664a2009-11-12 03:12:18 +0000757
Jeffrey Yasskine03a39b2009-11-19 23:42:58 +0000758 // If we know the target can handle arbitrary-distance calls, try to
759 // return a direct pointer.
760 if (!MayNeedFarStub) {
761 // If we have code, go ahead and return that.
762 void *ResultPtr = TheJIT->getPointerToGlobalIfAvailable(F);
763 if (ResultPtr) return ResultPtr;
Chris Lattner54266522004-11-20 23:57:07 +0000764
Jeffrey Yasskine03a39b2009-11-19 23:42:58 +0000765 // If this is an external function pointer, we can force the JIT to
766 // 'compile' it, which really just adds it to the map.
Jeffrey Yasskinc5818fb2009-12-22 23:47:23 +0000767 if (isNonGhostDeclaration(F) || F->hasAvailableExternallyLinkage())
Jeffrey Yasskine03a39b2009-11-19 23:42:58 +0000768 return TheJIT->getPointerToFunction(F);
769 }
Chris Lattnerb43dbdc2004-11-22 07:24:43 +0000770
Jeffrey Yasskine03a39b2009-11-19 23:42:58 +0000771 // Otherwise, we may need a to emit a stub, and, conservatively, we
772 // always do so.
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000773 void *StubAddr = Resolver.getLazyFunctionStub(F);
Nate Begeman50cd6fd2009-03-05 06:34:37 +0000774
775 // Add the stub to the current function's list of referenced stubs, so we can
Nate Begemanb9c6c9b2009-03-07 06:41:19 +0000776 // deallocate them if the current function is ever freed. It's possible to
Jeffrey Yasskin108c8382009-11-23 23:35:19 +0000777 // return null from getLazyFunctionStub in the case of a weak extern that
778 // fails to resolve.
Nate Begemanb9c6c9b2009-03-07 06:41:19 +0000779 if (StubAddr)
780 AddStubToCurrentFunction(StubAddr);
781
Nate Begeman50cd6fd2009-03-05 06:34:37 +0000782 return StubAddr;
Chris Lattner54266522004-11-20 23:57:07 +0000783}
784
Jeffrey Yasskin2d274412009-11-07 08:51:52 +0000785void *JITEmitter::getPointerToGVIndirectSym(GlobalValue *V, void *Reference) {
Nate Begeman50cd6fd2009-03-05 06:34:37 +0000786 // Make sure GV is emitted first, and create a stub containing the fully
787 // resolved address.
Jeffrey Yasskin2d274412009-11-07 08:51:52 +0000788 void *GVAddress = getPointerToGlobal(V, Reference, false);
Nate Begeman50cd6fd2009-03-05 06:34:37 +0000789 void *StubAddr = Resolver.getGlobalValueIndirectSym(V, GVAddress);
Eric Christopher116664a2009-11-12 03:12:18 +0000790
Nate Begeman50cd6fd2009-03-05 06:34:37 +0000791 // Add the stub to the current function's list of referenced stubs, so we can
792 // deallocate them if the current function is ever freed.
793 AddStubToCurrentFunction(StubAddr);
Eric Christopher116664a2009-11-12 03:12:18 +0000794
Nate Begeman50cd6fd2009-03-05 06:34:37 +0000795 return StubAddr;
796}
797
798void JITEmitter::AddStubToCurrentFunction(void *StubAddr) {
Nate Begeman50cd6fd2009-03-05 06:34:37 +0000799 assert(CurFn && "Stub added to current function, but current function is 0!");
Jeffrey Yasskine5f87982009-10-13 21:32:57 +0000800
Nate Begeman50cd6fd2009-03-05 06:34:37 +0000801 SmallVectorImpl<void*> &StubsUsed = CurFnStubUses[CurFn];
802 StubsUsed.push_back(StubAddr);
803
804 SmallPtrSet<const Function *, 1> &FnRefs = StubFnRefs[StubAddr];
805 FnRefs.insert(CurFn);
Evan Chengbe8c03f2008-01-04 10:46:51 +0000806}
807
Devang Patel02c04232009-10-06 03:04:58 +0000808void JITEmitter::processDebugLoc(DebugLoc DL, bool BeforePrintingInsn) {
Jeffrey Yasskin32360a72009-07-16 21:07:26 +0000809 if (!DL.isUnknown()) {
Devang Patel6b61f582010-01-16 06:09:35 +0000810 DILocation CurDLT = EmissionDetails.MF->getDILocation(DL);
Jeffrey Yasskin32360a72009-07-16 21:07:26 +0000811
Devang Patel02c04232009-10-06 03:04:58 +0000812 if (BeforePrintingInsn) {
Devang Patel6b61f582010-01-16 06:09:35 +0000813 if (CurDLT.getScope().getNode() != 0
814 && PrevDLT.getNode() != CurDLT.getNode()) {
Devang Patel02c04232009-10-06 03:04:58 +0000815 JITEvent_EmittedFunctionDetails::LineStart NextLine;
816 NextLine.Address = getCurrentPCValue();
817 NextLine.Loc = DL;
818 EmissionDetails.LineStarts.push_back(NextLine);
819 }
Eric Christopher116664a2009-11-12 03:12:18 +0000820
Devang Patel02c04232009-10-06 03:04:58 +0000821 PrevDLT = CurDLT;
Jeffrey Yasskin32360a72009-07-16 21:07:26 +0000822 }
Jeffrey Yasskin32360a72009-07-16 21:07:26 +0000823 }
824}
825
Evan Cheng1606e8e2009-03-13 07:51:59 +0000826static unsigned GetConstantPoolSizeInBytes(MachineConstantPool *MCP,
827 const TargetData *TD) {
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +0000828 const std::vector<MachineConstantPoolEntry> &Constants = MCP->getConstants();
829 if (Constants.empty()) return 0;
830
Evan Cheng1606e8e2009-03-13 07:51:59 +0000831 unsigned Size = 0;
832 for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
833 MachineConstantPoolEntry CPE = Constants[i];
834 unsigned AlignMask = CPE.getAlignment() - 1;
835 Size = (Size + AlignMask) & ~AlignMask;
836 const Type *Ty = CPE.getType();
Duncan Sands777d2302009-05-09 07:06:46 +0000837 Size += TD->getTypeAllocSize(Ty);
Evan Cheng1606e8e2009-03-13 07:51:59 +0000838 }
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +0000839 return Size;
840}
841
842static unsigned GetJumpTableSizeInBytes(MachineJumpTableInfo *MJTI) {
843 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
844 if (JT.empty()) return 0;
Eric Christopher116664a2009-11-12 03:12:18 +0000845
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +0000846 unsigned NumEntries = 0;
847 for (unsigned i = 0, e = JT.size(); i != e; ++i)
848 NumEntries += JT[i].MBBs.size();
849
Chris Lattner071c62f2010-01-25 23:26:13 +0000850 return NumEntries * MJTI->getEntrySize(*TheJIT->getTargetData());
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +0000851}
852
Nicolas Geoffray580631a2008-04-20 23:39:44 +0000853static uintptr_t RoundUpToAlign(uintptr_t Size, unsigned Alignment) {
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +0000854 if (Alignment == 0) Alignment = 1;
Eric Christopher116664a2009-11-12 03:12:18 +0000855 // Since we do not know where the buffer will be allocated, be pessimistic.
Nicolas Geoffray580631a2008-04-20 23:39:44 +0000856 return Size + Alignment;
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +0000857}
Evan Chengbe8c03f2008-01-04 10:46:51 +0000858
Dale Johannesendd947ea2008-08-07 01:30:15 +0000859/// addSizeOfGlobal - add the size of the global (plus any alignment padding)
860/// into the running total Size.
861
862unsigned JITEmitter::addSizeOfGlobal(const GlobalVariable *GV, unsigned Size) {
863 const Type *ElTy = GV->getType()->getElementType();
Duncan Sands777d2302009-05-09 07:06:46 +0000864 size_t GVSize = (size_t)TheJIT->getTargetData()->getTypeAllocSize(ElTy);
Eric Christopher116664a2009-11-12 03:12:18 +0000865 size_t GVAlign =
Dale Johannesendd947ea2008-08-07 01:30:15 +0000866 (size_t)TheJIT->getTargetData()->getPreferredAlignment(GV);
David Greenec9ec9932010-01-05 01:23:36 +0000867 DEBUG(dbgs() << "JIT: Adding in size " << GVSize << " alignment " << GVAlign);
Dale Johannesendd947ea2008-08-07 01:30:15 +0000868 DEBUG(GV->dump());
869 // Assume code section ends with worst possible alignment, so first
870 // variable needs maximal padding.
871 if (Size==0)
872 Size = 1;
873 Size = ((Size+GVAlign-1)/GVAlign)*GVAlign;
874 Size += GVSize;
875 return Size;
876}
877
878/// addSizeOfGlobalsInConstantVal - find any globals that we haven't seen yet
879/// but are referenced from the constant; put them in GVSet and add their
880/// size into the running total Size.
881
Eric Christopher116664a2009-11-12 03:12:18 +0000882unsigned JITEmitter::addSizeOfGlobalsInConstantVal(const Constant *C,
Dale Johannesendd947ea2008-08-07 01:30:15 +0000883 unsigned Size) {
884 // If its undefined, return the garbage.
885 if (isa<UndefValue>(C))
886 return Size;
887
888 // If the value is a ConstantExpr
889 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
890 Constant *Op0 = CE->getOperand(0);
891 switch (CE->getOpcode()) {
892 case Instruction::GetElementPtr:
893 case Instruction::Trunc:
894 case Instruction::ZExt:
895 case Instruction::SExt:
896 case Instruction::FPTrunc:
897 case Instruction::FPExt:
898 case Instruction::UIToFP:
899 case Instruction::SIToFP:
900 case Instruction::FPToUI:
901 case Instruction::FPToSI:
902 case Instruction::PtrToInt:
903 case Instruction::IntToPtr:
904 case Instruction::BitCast: {
905 Size = addSizeOfGlobalsInConstantVal(Op0, Size);
906 break;
907 }
908 case Instruction::Add:
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000909 case Instruction::FAdd:
Dale Johannesendd947ea2008-08-07 01:30:15 +0000910 case Instruction::Sub:
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000911 case Instruction::FSub:
Dale Johannesendd947ea2008-08-07 01:30:15 +0000912 case Instruction::Mul:
Dan Gohmanae3a0be2009-06-04 22:49:04 +0000913 case Instruction::FMul:
Dale Johannesendd947ea2008-08-07 01:30:15 +0000914 case Instruction::UDiv:
915 case Instruction::SDiv:
916 case Instruction::URem:
917 case Instruction::SRem:
918 case Instruction::And:
919 case Instruction::Or:
920 case Instruction::Xor: {
921 Size = addSizeOfGlobalsInConstantVal(Op0, Size);
922 Size = addSizeOfGlobalsInConstantVal(CE->getOperand(1), Size);
923 break;
924 }
925 default: {
Torok Edwin7d696d82009-07-11 13:10:19 +0000926 std::string msg;
927 raw_string_ostream Msg(msg);
928 Msg << "ConstantExpr not handled: " << *CE;
929 llvm_report_error(Msg.str());
Dale Johannesendd947ea2008-08-07 01:30:15 +0000930 }
931 }
932 }
933
934 if (C->getType()->getTypeID() == Type::PointerTyID)
935 if (const GlobalVariable* GV = dyn_cast<GlobalVariable>(C))
Evan Cheng47c01a02008-11-07 09:02:17 +0000936 if (GVSet.insert(GV))
Dale Johannesendd947ea2008-08-07 01:30:15 +0000937 Size = addSizeOfGlobal(GV, Size);
938
939 return Size;
940}
941
942/// addSizeOfGLobalsInInitializer - handle any globals that we haven't seen yet
943/// but are referenced from the given initializer.
944
Eric Christopher116664a2009-11-12 03:12:18 +0000945unsigned JITEmitter::addSizeOfGlobalsInInitializer(const Constant *Init,
Dale Johannesendd947ea2008-08-07 01:30:15 +0000946 unsigned Size) {
947 if (!isa<UndefValue>(Init) &&
948 !isa<ConstantVector>(Init) &&
949 !isa<ConstantAggregateZero>(Init) &&
950 !isa<ConstantArray>(Init) &&
951 !isa<ConstantStruct>(Init) &&
952 Init->getType()->isFirstClassType())
953 Size = addSizeOfGlobalsInConstantVal(Init, Size);
954 return Size;
955}
956
957/// GetSizeOfGlobalsInBytes - walk the code for the function, looking for
958/// globals; then walk the initializers of those globals looking for more.
959/// If their size has not been considered yet, add it into the running total
960/// Size.
961
962unsigned JITEmitter::GetSizeOfGlobalsInBytes(MachineFunction &MF) {
963 unsigned Size = 0;
964 GVSet.clear();
965
Eric Christopher116664a2009-11-12 03:12:18 +0000966 for (MachineFunction::iterator MBB = MF.begin(), E = MF.end();
Dale Johannesendd947ea2008-08-07 01:30:15 +0000967 MBB != E; ++MBB) {
968 for (MachineBasicBlock::const_iterator I = MBB->begin(), E = MBB->end();
969 I != E; ++I) {
970 const TargetInstrDesc &Desc = I->getDesc();
971 const MachineInstr &MI = *I;
972 unsigned NumOps = Desc.getNumOperands();
973 for (unsigned CurOp = 0; CurOp < NumOps; CurOp++) {
974 const MachineOperand &MO = MI.getOperand(CurOp);
Dan Gohmand735b802008-10-03 15:45:36 +0000975 if (MO.isGlobal()) {
Dale Johannesendd947ea2008-08-07 01:30:15 +0000976 GlobalValue* V = MO.getGlobal();
977 const GlobalVariable *GV = dyn_cast<const GlobalVariable>(V);
978 if (!GV)
979 continue;
980 // If seen in previous function, it will have an entry here.
981 if (TheJIT->getPointerToGlobalIfAvailable(GV))
982 continue;
983 // If seen earlier in this function, it will have an entry here.
984 // FIXME: it should be possible to combine these tables, by
985 // assuming the addresses of the new globals in this module
986 // start at 0 (or something) and adjusting them after codegen
987 // complete. Another possibility is to grab a marker bit in GV.
Evan Cheng47c01a02008-11-07 09:02:17 +0000988 if (GVSet.insert(GV))
Dale Johannesendd947ea2008-08-07 01:30:15 +0000989 // A variable as yet unseen. Add in its size.
990 Size = addSizeOfGlobal(GV, Size);
991 }
992 }
993 }
994 }
David Greenec9ec9932010-01-05 01:23:36 +0000995 DEBUG(dbgs() << "JIT: About to look through initializers\n");
Dale Johannesendd947ea2008-08-07 01:30:15 +0000996 // Look for more globals that are referenced only from initializers.
997 // GVSet.end is computed each time because the set can grow as we go.
Eric Christopher116664a2009-11-12 03:12:18 +0000998 for (SmallPtrSet<const GlobalVariable *, 8>::iterator I = GVSet.begin();
Dale Johannesendd947ea2008-08-07 01:30:15 +0000999 I != GVSet.end(); I++) {
1000 const GlobalVariable* GV = *I;
1001 if (GV->hasInitializer())
1002 Size = addSizeOfGlobalsInInitializer(GV->getInitializer(), Size);
1003 }
1004
1005 return Size;
1006}
1007
Chris Lattner166f2262004-11-22 22:00:25 +00001008void JITEmitter::startFunction(MachineFunction &F) {
David Greenec9ec9932010-01-05 01:23:36 +00001009 DEBUG(dbgs() << "JIT: Starting CodeGen of Function "
Daniel Dunbarce63ffb2009-07-25 00:23:56 +00001010 << F.getFunction()->getName() << "\n");
Evan Chengeb5d95a2008-11-06 17:46:04 +00001011
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +00001012 uintptr_t ActualSize = 0;
Jim Grosbachcce6c292008-10-03 16:17:20 +00001013 // Set the memory writable, if it's not already
1014 MemMgr->setMemoryWritable();
Nicolas Geoffray5913e6c2008-04-20 17:44:19 +00001015 if (MemMgr->NeedsExactSize()) {
David Greenec9ec9932010-01-05 01:23:36 +00001016 DEBUG(dbgs() << "JIT: ExactSize\n");
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +00001017 const TargetInstrInfo* TII = F.getTarget().getInstrInfo();
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +00001018 MachineConstantPool *MCP = F.getConstantPool();
Eric Christopher116664a2009-11-12 03:12:18 +00001019
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +00001020 // Ensure the constant pool/jump table info is at least 4-byte aligned.
Nicolas Geoffray580631a2008-04-20 23:39:44 +00001021 ActualSize = RoundUpToAlign(ActualSize, 16);
Eric Christopher116664a2009-11-12 03:12:18 +00001022
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +00001023 // Add the alignment of the constant pool
Evan Cheng1606e8e2009-03-13 07:51:59 +00001024 ActualSize = RoundUpToAlign(ActualSize, MCP->getConstantPoolAlignment());
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +00001025
1026 // Add the constant pool size
Evan Cheng1606e8e2009-03-13 07:51:59 +00001027 ActualSize += GetConstantPoolSizeInBytes(MCP, TheJIT->getTargetData());
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +00001028
Chris Lattner071c62f2010-01-25 23:26:13 +00001029 if (MachineJumpTableInfo *MJTI = F.getJumpTableInfo()) {
1030 // Add the aligment of the jump table info
1031 ActualSize = RoundUpToAlign(ActualSize,
1032 MJTI->getEntryAlignment(*TheJIT->getTargetData()));
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +00001033
Chris Lattner071c62f2010-01-25 23:26:13 +00001034 // Add the jump table size
1035 ActualSize += GetJumpTableSizeInBytes(MJTI);
1036 }
Eric Christopher116664a2009-11-12 03:12:18 +00001037
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +00001038 // Add the alignment for the function
Nicolas Geoffray580631a2008-04-20 23:39:44 +00001039 ActualSize = RoundUpToAlign(ActualSize,
1040 std::max(F.getFunction()->getAlignment(), 8U));
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +00001041
1042 // Add the function size
1043 ActualSize += TII->GetFunctionSizeInBytes(F);
Dale Johannesendd947ea2008-08-07 01:30:15 +00001044
David Greenec9ec9932010-01-05 01:23:36 +00001045 DEBUG(dbgs() << "JIT: ActualSize before globals " << ActualSize << "\n");
Dale Johannesendd947ea2008-08-07 01:30:15 +00001046 // Add the size of the globals that will be allocated after this function.
1047 // These are all the ones referenced from this function that were not
1048 // previously allocated.
1049 ActualSize += GetSizeOfGlobalsInBytes(F);
David Greenec9ec9932010-01-05 01:23:36 +00001050 DEBUG(dbgs() << "JIT: ActualSize after globals " << ActualSize << "\n");
Reid Kleckner10b4fc52009-07-23 21:46:56 +00001051 } else if (SizeEstimate > 0) {
1052 // SizeEstimate will be non-zero on reallocation attempts.
1053 ActualSize = SizeEstimate;
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +00001054 }
1055
Chris Lattner8907b4b2007-12-05 23:39:57 +00001056 BufferBegin = CurBufferPtr = MemMgr->startFunctionBody(F.getFunction(),
1057 ActualSize);
Chris Lattnere993cc22006-05-11 23:08:08 +00001058 BufferEnd = BufferBegin+ActualSize;
Jeffrey Yasskin1e861322009-10-20 18:13:21 +00001059 EmittedFunctions[F.getFunction()].FunctionBody = BufferBegin;
1060
Evan Cheng9a1e9b92006-11-16 20:04:54 +00001061 // Ensure the constant pool/jump table info is at least 4-byte aligned.
1062 emitAlignment(16);
1063
Chris Lattnerf75f9be2006-05-02 23:22:24 +00001064 emitConstantPool(F.getConstantPool());
Chris Lattner071c62f2010-01-25 23:26:13 +00001065 if (MachineJumpTableInfo *MJTI = F.getJumpTableInfo())
1066 initJumpTableInfo(MJTI);
Chris Lattnerf75f9be2006-05-02 23:22:24 +00001067
1068 // About to start emitting the machine code for the function.
Chris Lattner0eb4d6b2006-05-03 01:03:20 +00001069 emitAlignment(std::max(F.getFunction()->getAlignment(), 8U));
Chris Lattnerf75f9be2006-05-02 23:22:24 +00001070 TheJIT->updateGlobalMapping(F.getFunction(), CurBufferPtr);
Jeffrey Yasskin7a9034c2009-10-27 00:03:05 +00001071 EmittedFunctions[F.getFunction()].Code = CurBufferPtr;
Evan Cheng55fc2802006-07-25 20:40:54 +00001072
Chris Lattnerb4432f32006-05-03 17:10:41 +00001073 MBBLocations.clear();
Jeffrey Yasskin32360a72009-07-16 21:07:26 +00001074
1075 EmissionDetails.MF = &F;
1076 EmissionDetails.LineStarts.clear();
Chris Lattnerbd199fb2002-12-24 00:01:05 +00001077}
1078
Chris Lattner43b429b2006-05-02 18:27:26 +00001079bool JITEmitter::finishFunction(MachineFunction &F) {
Chris Lattnere993cc22006-05-11 23:08:08 +00001080 if (CurBufferPtr == BufferEnd) {
Reid Kleckner10b4fc52009-07-23 21:46:56 +00001081 // We must call endFunctionBody before retrying, because
1082 // deallocateMemForFunction requires it.
1083 MemMgr->endFunctionBody(F.getFunction(), BufferBegin, CurBufferPtr);
1084 retryWithMoreMemory(F);
1085 return true;
Chris Lattnere993cc22006-05-11 23:08:08 +00001086 }
Reid Kleckner10b4fc52009-07-23 21:46:56 +00001087
Chris Lattner071c62f2010-01-25 23:26:13 +00001088 if (MachineJumpTableInfo *MJTI = F.getJumpTableInfo())
1089 emitJumpTableInfo(MJTI);
Reid Kleckner10b4fc52009-07-23 21:46:56 +00001090
Chris Lattnera8279532006-06-16 18:09:26 +00001091 // FnStart is the start of the text, not the start of the constant pool and
1092 // other per-function data.
Bruno Cardoso Lopes186c6702009-06-04 00:15:51 +00001093 uint8_t *FnStart =
1094 (uint8_t *)TheJIT->getPointerToGlobalIfAvailable(F.getFunction());
Chris Lattnerbd199fb2002-12-24 00:01:05 +00001095
Argyrios Kyrtzidis19fee412009-04-30 23:01:58 +00001096 // FnEnd is the end of the function's machine code.
Bruno Cardoso Lopes186c6702009-06-04 00:15:51 +00001097 uint8_t *FnEnd = CurBufferPtr;
Argyrios Kyrtzidis19fee412009-04-30 23:01:58 +00001098
Chris Lattner5be478f2004-11-20 03:46:14 +00001099 if (!Relocations.empty()) {
Nate Begeman50cd6fd2009-03-05 06:34:37 +00001100 CurFn = F.getFunction();
Chris Lattnere884dc22005-07-20 16:29:20 +00001101 NumRelos += Relocations.size();
1102
Chris Lattner5be478f2004-11-20 03:46:14 +00001103 // Resolve the relocations to concrete pointers.
1104 for (unsigned i = 0, e = Relocations.size(); i != e; ++i) {
1105 MachineRelocation &MR = Relocations[i];
Evan Cheng92006052008-11-03 07:14:02 +00001106 void *ResultPtr = 0;
Evan Chengef5784e2008-10-29 23:54:46 +00001107 if (!MR.letTargetResolve()) {
Evan Chengd7398c92008-11-08 07:37:34 +00001108 if (MR.isExternalSymbol()) {
Dan Gohman69f93782009-01-05 05:32:42 +00001109 ResultPtr = TheJIT->getPointerToNamedFunction(MR.getExternalSymbol(),
1110 false);
David Greenec9ec9932010-01-05 01:23:36 +00001111 DEBUG(dbgs() << "JIT: Map \'" << MR.getExternalSymbol() << "\' to ["
Eric Christopher116664a2009-11-12 03:12:18 +00001112 << ResultPtr << "]\n");
Misha Brukmanf976c852005-04-21 22:55:34 +00001113
Evan Chengef5784e2008-10-29 23:54:46 +00001114 // If the target REALLY wants a stub for this function, emit it now.
Jeffrey Yasskin2d274412009-11-07 08:51:52 +00001115 if (MR.mayNeedFarStub()) {
Jeffrey Yasskin6f348e42009-11-09 22:34:19 +00001116 ResultPtr = Resolver.getExternalFunctionStub(ResultPtr);
Nate Begeman841c6a42009-03-11 07:03:43 +00001117 }
Evan Chengef5784e2008-10-29 23:54:46 +00001118 } else if (MR.isGlobalValue()) {
1119 ResultPtr = getPointerToGlobal(MR.getGlobalValue(),
1120 BufferBegin+MR.getMachineCodeOffset(),
Jeffrey Yasskin2d274412009-11-07 08:51:52 +00001121 MR.mayNeedFarStub());
Evan Cheng5594f122008-11-10 01:52:24 +00001122 } else if (MR.isIndirectSymbol()) {
Jeffrey Yasskin2d274412009-11-07 08:51:52 +00001123 ResultPtr = getPointerToGVIndirectSym(
1124 MR.getGlobalValue(), BufferBegin+MR.getMachineCodeOffset());
Evan Chengef5784e2008-10-29 23:54:46 +00001125 } else if (MR.isBasicBlock()) {
1126 ResultPtr = (void*)getMachineBasicBlockAddress(MR.getBasicBlock());
1127 } else if (MR.isConstantPoolIndex()) {
1128 ResultPtr = (void*)getConstantPoolEntryAddress(MR.getConstantPoolIndex());
1129 } else {
1130 assert(MR.isJumpTableIndex());
1131 ResultPtr=(void*)getJumpTableEntryAddress(MR.getJumpTableIndex());
1132 }
Jeff Cohen00b168892005-07-27 06:12:32 +00001133
Evan Chengef5784e2008-10-29 23:54:46 +00001134 MR.setResultPointer(ResultPtr);
1135 }
Andrew Lenharth16ec33c2005-07-22 20:48:12 +00001136
Andrew Lenharth6a974612005-07-28 12:44:13 +00001137 // if we are managing the GOT and the relocation wants an index,
1138 // give it one
Chris Lattner8907b4b2007-12-05 23:39:57 +00001139 if (MR.isGOTRelative() && MemMgr->isManagingGOT()) {
Chris Lattnere7484012007-02-24 02:57:03 +00001140 unsigned idx = Resolver.getGOTIndexForAddr(ResultPtr);
Andrew Lenharth6a974612005-07-28 12:44:13 +00001141 MR.setGOTIndex(idx);
Chris Lattner8907b4b2007-12-05 23:39:57 +00001142 if (((void**)MemMgr->getGOTBase())[idx] != ResultPtr) {
David Greenec9ec9932010-01-05 01:23:36 +00001143 DEBUG(dbgs() << "JIT: GOT was out of date for " << ResultPtr
Chris Lattnerbbbfa992009-08-23 06:35:02 +00001144 << " pointing at " << ((void**)MemMgr->getGOTBase())[idx]
1145 << "\n");
Chris Lattner8907b4b2007-12-05 23:39:57 +00001146 ((void**)MemMgr->getGOTBase())[idx] = ResultPtr;
Andrew Lenharth6a974612005-07-28 12:44:13 +00001147 }
Andrew Lenharth16ec33c2005-07-22 20:48:12 +00001148 }
Chris Lattner5be478f2004-11-20 03:46:14 +00001149 }
1150
Nate Begeman50cd6fd2009-03-05 06:34:37 +00001151 CurFn = 0;
Chris Lattner43b429b2006-05-02 18:27:26 +00001152 TheJIT->getJITInfo().relocate(BufferBegin, &Relocations[0],
Chris Lattner8907b4b2007-12-05 23:39:57 +00001153 Relocations.size(), MemMgr->getGOTBase());
Chris Lattner5be478f2004-11-20 03:46:14 +00001154 }
1155
Chris Lattnerd2d5c762006-05-03 18:55:56 +00001156 // Update the GOT entry for F to point to the new code.
Chris Lattner8907b4b2007-12-05 23:39:57 +00001157 if (MemMgr->isManagingGOT()) {
Chris Lattnere7484012007-02-24 02:57:03 +00001158 unsigned idx = Resolver.getGOTIndexForAddr((void*)BufferBegin);
Chris Lattner8907b4b2007-12-05 23:39:57 +00001159 if (((void**)MemMgr->getGOTBase())[idx] != (void*)BufferBegin) {
David Greenec9ec9932010-01-05 01:23:36 +00001160 DEBUG(dbgs() << "JIT: GOT was out of date for " << (void*)BufferBegin
Chris Lattnerbbbfa992009-08-23 06:35:02 +00001161 << " pointing at " << ((void**)MemMgr->getGOTBase())[idx]
1162 << "\n");
Chris Lattner8907b4b2007-12-05 23:39:57 +00001163 ((void**)MemMgr->getGOTBase())[idx] = (void*)BufferBegin;
Andrew Lenharth6a974612005-07-28 12:44:13 +00001164 }
1165 }
1166
Argyrios Kyrtzidis19fee412009-04-30 23:01:58 +00001167 // CurBufferPtr may have moved beyond FnEnd, due to memory allocation for
1168 // global variables that were referenced in the relocations.
1169 MemMgr->endFunctionBody(F.getFunction(), BufferBegin, CurBufferPtr);
Evan Cheng5788d1a2008-12-10 02:32:19 +00001170
1171 if (CurBufferPtr == BufferEnd) {
Reid Kleckner10b4fc52009-07-23 21:46:56 +00001172 retryWithMoreMemory(F);
1173 return true;
1174 } else {
1175 // Now that we've succeeded in emitting the function, reset the
1176 // SizeEstimate back down to zero.
1177 SizeEstimate = 0;
Evan Cheng5788d1a2008-12-10 02:32:19 +00001178 }
1179
Nuno Lopescef75272008-10-21 11:42:16 +00001180 BufferBegin = CurBufferPtr = 0;
1181 NumBytes += FnEnd-FnStart;
1182
Evan Cheng55fc2802006-07-25 20:40:54 +00001183 // Invalidate the icache if necessary.
Chris Lattnerbc52cad2008-06-25 17:18:44 +00001184 sys::Memory::InvalidateInstructionCache(FnStart, FnEnd-FnStart);
Jeffrey Yasskindf5a7da2009-06-25 02:04:04 +00001185
Jeffrey Yasskindf5a7da2009-06-25 02:04:04 +00001186 TheJIT->NotifyFunctionEmitted(*F.getFunction(), FnStart, FnEnd-FnStart,
Jeffrey Yasskin32360a72009-07-16 21:07:26 +00001187 EmissionDetails);
Evan Cheng55fc2802006-07-25 20:40:54 +00001188
David Greenec9ec9932010-01-05 01:23:36 +00001189 DEBUG(dbgs() << "JIT: Finished CodeGen of [" << (void*)FnStart
Daniel Dunbarce63ffb2009-07-25 00:23:56 +00001190 << "] Function: " << F.getFunction()->getName()
1191 << ": " << (FnEnd-FnStart) << " bytes of text, "
1192 << Relocations.size() << " relocations\n");
Argyrios Kyrtzidisb3a847d2009-05-18 21:06:40 +00001193
Chris Lattner5be478f2004-11-20 03:46:14 +00001194 Relocations.clear();
Evan Cheng1606e8e2009-03-13 07:51:59 +00001195 ConstPoolAddresses.clear();
Anton Korobeynikov8cd4c3e2007-01-19 17:25:17 +00001196
Evan Chengbc4707a2008-09-18 07:54:21 +00001197 // Mark code region readable and executable if it's not so already.
Jim Grosbachcce6c292008-10-03 16:17:20 +00001198 MemMgr->setMemoryExecutable();
Evan Chengbc4707a2008-09-18 07:54:21 +00001199
Chris Lattnerbbbfa992009-08-23 06:35:02 +00001200 DEBUG(
Evan Chenge7c35512008-11-12 08:22:43 +00001201 if (sys::hasDisassembler()) {
David Greenec9ec9932010-01-05 01:23:36 +00001202 dbgs() << "JIT: Disassembled code:\n";
1203 dbgs() << sys::disassembleBuffer(FnStart, FnEnd-FnStart,
Chris Lattnerbbbfa992009-08-23 06:35:02 +00001204 (uintptr_t)FnStart);
Evan Chenge7c35512008-11-12 08:22:43 +00001205 } else {
David Greenec9ec9932010-01-05 01:23:36 +00001206 dbgs() << "JIT: Binary code:\n";
Bruno Cardoso Lopes186c6702009-06-04 00:15:51 +00001207 uint8_t* q = FnStart;
Evan Chenge7c35512008-11-12 08:22:43 +00001208 for (int i = 0; q < FnEnd; q += 4, ++i) {
1209 if (i == 4)
1210 i = 0;
1211 if (i == 0)
David Greenec9ec9932010-01-05 01:23:36 +00001212 dbgs() << "JIT: " << (long)(q - FnStart) << ": ";
Evan Chenge7c35512008-11-12 08:22:43 +00001213 bool Done = false;
1214 for (int j = 3; j >= 0; --j) {
1215 if (q + j >= FnEnd)
1216 Done = true;
1217 else
David Greenec9ec9932010-01-05 01:23:36 +00001218 dbgs() << (unsigned short)q[j];
Evan Chenge7c35512008-11-12 08:22:43 +00001219 }
1220 if (Done)
1221 break;
David Greenec9ec9932010-01-05 01:23:36 +00001222 dbgs() << ' ';
Evan Chenge7c35512008-11-12 08:22:43 +00001223 if (i == 3)
David Greenec9ec9932010-01-05 01:23:36 +00001224 dbgs() << '\n';
Evan Chenga7916f52008-11-05 23:44:08 +00001225 }
David Greenec9ec9932010-01-05 01:23:36 +00001226 dbgs()<< '\n';
Evan Chenga7916f52008-11-05 23:44:08 +00001227 }
Chris Lattnerbbbfa992009-08-23 06:35:02 +00001228 );
1229
Reid Kleckner27632172009-09-20 23:52:43 +00001230 if (DwarfExceptionHandling || JITEmitDebugInfo) {
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +00001231 uintptr_t ActualSize = 0;
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +00001232 SavedBufferBegin = BufferBegin;
1233 SavedBufferEnd = BufferEnd;
1234 SavedCurBufferPtr = CurBufferPtr;
Reid Kleckner27632172009-09-20 23:52:43 +00001235
Nicolas Geoffray5913e6c2008-04-20 17:44:19 +00001236 if (MemMgr->NeedsExactSize()) {
1237 ActualSize = DE->GetDwarfTableSizeInBytes(F, *this, FnStart, FnEnd);
Nicolas Geoffraydc17ab22008-04-18 20:59:31 +00001238 }
Nicolas Geoffrayafe6c2b2008-02-13 18:39:37 +00001239
1240 BufferBegin = CurBufferPtr = MemMgr->startExceptionTable(F.getFunction(),
1241 ActualSize);
1242 BufferEnd = BufferBegin+ActualSize;
Jeffrey Yasskin1e861322009-10-20 18:13:21 +00001243 EmittedFunctions[F.getFunction()].ExceptionTable = BufferBegin;
Reid Kleckner27632172009-09-20 23:52:43 +00001244 uint8_t *EhStart;
1245 uint8_t *FrameRegister = DE->EmitDwarfTable(F, *this, FnStart, FnEnd,
1246 EhStart);
Chris Lattner0fdaa0b2008-03-07 20:05:43 +00001247 MemMgr->endExceptionTable(F.getFunction(), BufferBegin, CurBufferPtr,
1248 FrameRegister);
Reid Kleckner27632172009-09-20 23:52:43 +00001249 uint8_t *EhEnd = CurBufferPtr;
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +00001250 BufferBegin = SavedBufferBegin;
1251 BufferEnd = SavedBufferEnd;
1252 CurBufferPtr = SavedCurBufferPtr;
Nicolas Geoffrayafe6c2b2008-02-13 18:39:37 +00001253
Reid Kleckner27632172009-09-20 23:52:43 +00001254 if (DwarfExceptionHandling) {
1255 TheJIT->RegisterTable(FrameRegister);
1256 }
1257
1258 if (JITEmitDebugInfo) {
1259 DebugInfo I;
1260 I.FnStart = FnStart;
1261 I.FnEnd = FnEnd;
1262 I.EhStart = EhStart;
1263 I.EhEnd = EhEnd;
1264 DR->RegisterFunction(F.getFunction(), I);
1265 }
Nicolas Geoffrayafe6c2b2008-02-13 18:39:37 +00001266 }
Evan Cheng252ddfb2008-09-02 08:14:01 +00001267
1268 if (MMI)
1269 MMI->EndFunction();
Eric Christopher116664a2009-11-12 03:12:18 +00001270
Chris Lattner43b429b2006-05-02 18:27:26 +00001271 return false;
Chris Lattnerbd199fb2002-12-24 00:01:05 +00001272}
1273
Reid Kleckner10b4fc52009-07-23 21:46:56 +00001274void JITEmitter::retryWithMoreMemory(MachineFunction &F) {
David Greenec9ec9932010-01-05 01:23:36 +00001275 DEBUG(dbgs() << "JIT: Ran out of space for native code. Reattempting.\n");
Reid Kleckner10b4fc52009-07-23 21:46:56 +00001276 Relocations.clear(); // Clear the old relocations or we'll reapply them.
1277 ConstPoolAddresses.clear();
1278 ++NumRetries;
1279 deallocateMemForFunction(F.getFunction());
1280 // Try again with at least twice as much free space.
1281 SizeEstimate = (uintptr_t)(2 * (BufferEnd - BufferBegin));
1282}
1283
Nate Begeman50cd6fd2009-03-05 06:34:37 +00001284/// deallocateMemForFunction - Deallocate all memory for the specified
1285/// function body. Also drop any references the function has to stubs.
Jeffrey Yasskin7a9034c2009-10-27 00:03:05 +00001286/// May be called while the Function is being destroyed inside ~Value().
Reid Kleckner10b4fc52009-07-23 21:46:56 +00001287void JITEmitter::deallocateMemForFunction(const Function *F) {
Jeffrey Yasskin7a9034c2009-10-27 00:03:05 +00001288 ValueMap<const Function *, EmittedCode, EmittedFunctionConfig>::iterator
1289 Emitted = EmittedFunctions.find(F);
Jeffrey Yasskin1e861322009-10-20 18:13:21 +00001290 if (Emitted != EmittedFunctions.end()) {
1291 MemMgr->deallocateFunctionBody(Emitted->second.FunctionBody);
1292 MemMgr->deallocateExceptionTable(Emitted->second.ExceptionTable);
Jeffrey Yasskin7a9034c2009-10-27 00:03:05 +00001293 TheJIT->NotifyFreeingMachineCode(Emitted->second.Code);
1294
Jeffrey Yasskin1e861322009-10-20 18:13:21 +00001295 EmittedFunctions.erase(Emitted);
1296 }
Nate Begeman50cd6fd2009-03-05 06:34:37 +00001297
Reid Kleckner27632172009-09-20 23:52:43 +00001298 // TODO: Do we need to unregister exception handling information from libgcc
1299 // here?
1300
1301 if (JITEmitDebugInfo) {
1302 DR->UnregisterFunction(F);
1303 }
1304
Nate Begeman50cd6fd2009-03-05 06:34:37 +00001305 // If the function did not reference any stubs, return.
1306 if (CurFnStubUses.find(F) == CurFnStubUses.end())
1307 return;
Eric Christopher116664a2009-11-12 03:12:18 +00001308
Nate Begeman50cd6fd2009-03-05 06:34:37 +00001309 // For each referenced stub, erase the reference to this function, and then
1310 // erase the list of referenced stubs.
1311 SmallVectorImpl<void *> &StubList = CurFnStubUses[F];
1312 for (unsigned i = 0, e = StubList.size(); i != e; ++i) {
1313 void *Stub = StubList[i];
Eric Christopher116664a2009-11-12 03:12:18 +00001314
Nate Begeman841c6a42009-03-11 07:03:43 +00001315 // If we already invalidated this stub for this function, continue.
1316 if (StubFnRefs.count(Stub) == 0)
1317 continue;
Eric Christopher116664a2009-11-12 03:12:18 +00001318
Nate Begeman50cd6fd2009-03-05 06:34:37 +00001319 SmallPtrSet<const Function *, 1> &FnRefs = StubFnRefs[Stub];
1320 FnRefs.erase(F);
Eric Christopher116664a2009-11-12 03:12:18 +00001321
Nate Begeman50cd6fd2009-03-05 06:34:37 +00001322 // If this function was the last reference to the stub, invalidate the stub
1323 // in the JITResolver. Were there a memory manager deallocateStub routine,
1324 // we could call that at this point too.
1325 if (FnRefs.empty()) {
David Greenec9ec9932010-01-05 01:23:36 +00001326 DEBUG(dbgs() << "\nJIT: Invalidated Stub at [" << Stub << "]\n");
Nate Begeman841c6a42009-03-11 07:03:43 +00001327 StubFnRefs.erase(Stub);
1328
1329 // Invalidate the stub. If it is a GV stub, update the JIT's global
Jeffrey Yasskin6f348e42009-11-09 22:34:19 +00001330 // mapping for that GV to zero.
Nate Begemanb9c6c9b2009-03-07 06:41:19 +00001331 GlobalValue *GV = Resolver.invalidateStub(Stub);
Nate Begeman841c6a42009-03-11 07:03:43 +00001332 if (GV) {
1333 TheJIT->updateGlobalMapping(GV, 0);
Nate Begeman841c6a42009-03-11 07:03:43 +00001334 }
Nate Begeman50cd6fd2009-03-05 06:34:37 +00001335 }
1336 }
1337 CurFnStubUses.erase(F);
1338}
1339
1340
Evan Cheng5788d1a2008-12-10 02:32:19 +00001341void* JITEmitter::allocateSpace(uintptr_t Size, unsigned Alignment) {
Nuno Lopescef75272008-10-21 11:42:16 +00001342 if (BufferBegin)
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +00001343 return JITCodeEmitter::allocateSpace(Size, Alignment);
Nuno Lopescef75272008-10-21 11:42:16 +00001344
1345 // create a new memory block if there is no active one.
1346 // care must be taken so that BufferBegin is invalidated when a
1347 // block is trimmed
1348 BufferBegin = CurBufferPtr = MemMgr->allocateSpace(Size, Alignment);
1349 BufferEnd = BufferBegin+Size;
1350 return CurBufferPtr;
1351}
1352
Jeffrey Yasskin489393d2009-07-08 21:59:57 +00001353void* JITEmitter::allocateGlobal(uintptr_t Size, unsigned Alignment) {
1354 // Delegate this call through the memory manager.
1355 return MemMgr->allocateGlobal(Size, Alignment);
1356}
1357
Chris Lattner166f2262004-11-22 22:00:25 +00001358void JITEmitter::emitConstantPool(MachineConstantPool *MCP) {
Evan Cheng47c01a02008-11-07 09:02:17 +00001359 if (TheJIT->getJITInfo().hasCustomConstantPool())
Jim Grosbach8fe95352008-10-30 23:44:39 +00001360 return;
Evan Cheng47c01a02008-11-07 09:02:17 +00001361
Chris Lattnerfa77d432006-02-09 04:22:52 +00001362 const std::vector<MachineConstantPoolEntry> &Constants = MCP->getConstants();
Chris Lattner2c0a6a12003-11-30 04:23:21 +00001363 if (Constants.empty()) return;
1364
Evan Cheng1606e8e2009-03-13 07:51:59 +00001365 unsigned Size = GetConstantPoolSizeInBytes(MCP, TheJIT->getTargetData());
1366 unsigned Align = MCP->getConstantPoolAlignment();
Evan Cheng97b8c402008-04-12 00:22:01 +00001367 ConstantPoolBase = allocateSpace(Size, Align);
Chris Lattner239862c2006-02-09 04:49:59 +00001368 ConstantPool = MCP;
Chris Lattnerf75f9be2006-05-02 23:22:24 +00001369
1370 if (ConstantPoolBase == 0) return; // Buffer overflow.
1371
David Greenec9ec9932010-01-05 01:23:36 +00001372 DEBUG(dbgs() << "JIT: Emitted constant pool at [" << ConstantPoolBase
Chris Lattnerbbbfa992009-08-23 06:35:02 +00001373 << "] (size: " << Size << ", alignment: " << Align << ")\n");
Evan Cheng97b8c402008-04-12 00:22:01 +00001374
Chris Lattner239862c2006-02-09 04:49:59 +00001375 // Initialize the memory for all of the constant pool entries.
Evan Cheng1606e8e2009-03-13 07:51:59 +00001376 unsigned Offset = 0;
Chris Lattner3029f922006-02-09 04:46:04 +00001377 for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
Evan Cheng1606e8e2009-03-13 07:51:59 +00001378 MachineConstantPoolEntry CPE = Constants[i];
1379 unsigned AlignMask = CPE.getAlignment() - 1;
1380 Offset = (Offset + AlignMask) & ~AlignMask;
1381
1382 uintptr_t CAddr = (uintptr_t)ConstantPoolBase + Offset;
1383 ConstPoolAddresses.push_back(CAddr);
1384 if (CPE.isMachineConstantPoolEntry()) {
Evan Chengcd5731d2006-09-12 20:59:59 +00001385 // FIXME: add support to lower machine constant pool values into bytes!
Torok Edwin7d696d82009-07-11 13:10:19 +00001386 llvm_report_error("Initialize memory with machine specific constant pool"
1387 "entry has not been implemented!");
Evan Chengcd5731d2006-09-12 20:59:59 +00001388 }
Evan Cheng1606e8e2009-03-13 07:51:59 +00001389 TheJIT->InitializeMemory(CPE.Val.ConstVal, (void*)CAddr);
David Greenec9ec9932010-01-05 01:23:36 +00001390 DEBUG(dbgs() << "JIT: CP" << i << " at [0x";
1391 dbgs().write_hex(CAddr) << "]\n");
Evan Cheng1606e8e2009-03-13 07:51:59 +00001392
1393 const Type *Ty = CPE.Val.ConstVal->getType();
Duncan Sands777d2302009-05-09 07:06:46 +00001394 Offset += TheJIT->getTargetData()->getTypeAllocSize(Ty);
Chris Lattner1cc08382003-01-13 01:00:12 +00001395 }
1396}
1397
Nate Begeman37efe672006-04-22 18:53:45 +00001398void JITEmitter::initJumpTableInfo(MachineJumpTableInfo *MJTI) {
Evan Cheng47c01a02008-11-07 09:02:17 +00001399 if (TheJIT->getJITInfo().hasCustomJumpTables())
1400 return;
1401
Nate Begeman37efe672006-04-22 18:53:45 +00001402 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
1403 if (JT.empty()) return;
Eric Christopher116664a2009-11-12 03:12:18 +00001404
Chris Lattnerf75f9be2006-05-02 23:22:24 +00001405 unsigned NumEntries = 0;
Nate Begeman37efe672006-04-22 18:53:45 +00001406 for (unsigned i = 0, e = JT.size(); i != e; ++i)
Chris Lattnerf75f9be2006-05-02 23:22:24 +00001407 NumEntries += JT[i].MBBs.size();
1408
Chris Lattner071c62f2010-01-25 23:26:13 +00001409 unsigned EntrySize = MJTI->getEntrySize(*TheJIT->getTargetData());
Chris Lattnerf75f9be2006-05-02 23:22:24 +00001410
Nate Begeman37efe672006-04-22 18:53:45 +00001411 // Just allocate space for all the jump tables now. We will fix up the actual
1412 // MBB entries in the tables after we emit the code for each block, since then
1413 // we will know the final locations of the MBBs in memory.
1414 JumpTable = MJTI;
Chris Lattner071c62f2010-01-25 23:26:13 +00001415 JumpTableBase = allocateSpace(NumEntries * EntrySize,
1416 MJTI->getEntryAlignment(*TheJIT->getTargetData()));
Nate Begeman37efe672006-04-22 18:53:45 +00001417}
1418
Jim Laskeyb92767a2006-12-14 22:53:42 +00001419void JITEmitter::emitJumpTableInfo(MachineJumpTableInfo *MJTI) {
Evan Cheng47c01a02008-11-07 09:02:17 +00001420 if (TheJIT->getJITInfo().hasCustomJumpTables())
1421 return;
1422
Nate Begeman37efe672006-04-22 18:53:45 +00001423 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
Chris Lattnerf75f9be2006-05-02 23:22:24 +00001424 if (JT.empty() || JumpTableBase == 0) return;
Eric Christopher116664a2009-11-12 03:12:18 +00001425
Chris Lattner13af11a2010-01-26 03:47:15 +00001426
1427 switch (MJTI->getEntryKind()) {
1428 case MachineJumpTableInfo::EK_BlockAddress: {
1429 // EK_BlockAddress - Each entry is a plain address of block, e.g.:
1430 // .word LBB123
1431 assert(MJTI->getEntrySize(*TheJIT->getTargetData()) == sizeof(void*) &&
1432 "Cross JIT'ing?");
1433
1434 // For each jump table, map each target in the jump table to the address of
1435 // an emitted MachineBasicBlock.
1436 intptr_t *SlotPtr = (intptr_t*)JumpTableBase;
1437
1438 for (unsigned i = 0, e = JT.size(); i != e; ++i) {
1439 const std::vector<MachineBasicBlock*> &MBBs = JT[i].MBBs;
1440 // Store the address of the basic block for this jump table slot in the
1441 // memory we allocated for the jump table in 'initJumpTableInfo'
1442 for (unsigned mi = 0, me = MBBs.size(); mi != me; ++mi)
1443 *SlotPtr++ = getMachineBasicBlockAddress(MBBs[mi]);
1444 }
1445 break;
1446 }
1447
Chris Lattner85fe0782010-01-26 04:05:28 +00001448 case MachineJumpTableInfo::EK_Custom32:
Chris Lattner13af11a2010-01-26 03:47:15 +00001449 case MachineJumpTableInfo::EK_GPRel32BlockAddress:
1450 case MachineJumpTableInfo::EK_LabelDifference32: {
Chris Lattner071c62f2010-01-25 23:26:13 +00001451 assert(MJTI->getEntrySize(*TheJIT->getTargetData()) == 4&&"Cross JIT'ing?");
Jim Laskeyacd80ac2006-12-14 19:17:33 +00001452 // For each jump table, place the offset from the beginning of the table
1453 // to the target address.
1454 int *SlotPtr = (int*)JumpTableBase;
Chris Lattner32ca55f2006-05-03 00:13:06 +00001455
Jim Laskeyacd80ac2006-12-14 19:17:33 +00001456 for (unsigned i = 0, e = JT.size(); i != e; ++i) {
1457 const std::vector<MachineBasicBlock*> &MBBs = JT[i].MBBs;
1458 // Store the offset of the basic block for this jump table slot in the
1459 // memory we allocated for the jump table in 'initJumpTableInfo'
Evan Cheng5788d1a2008-12-10 02:32:19 +00001460 uintptr_t Base = (uintptr_t)SlotPtr;
Evan Cheng2a3e08b2008-01-05 02:26:58 +00001461 for (unsigned mi = 0, me = MBBs.size(); mi != me; ++mi) {
Evan Cheng5788d1a2008-12-10 02:32:19 +00001462 uintptr_t MBBAddr = getMachineBasicBlockAddress(MBBs[mi]);
Chris Lattner13af11a2010-01-26 03:47:15 +00001463 /// FIXME: USe EntryKind instead of magic "getPICJumpTableEntry" hook.
Evan Cheng2a3e08b2008-01-05 02:26:58 +00001464 *SlotPtr++ = TheJIT->getJITInfo().getPICJumpTableEntry(MBBAddr, Base);
1465 }
Jim Laskeyacd80ac2006-12-14 19:17:33 +00001466 }
Chris Lattner13af11a2010-01-26 03:47:15 +00001467 break;
1468 }
Nate Begeman37efe672006-04-22 18:53:45 +00001469 }
1470}
1471
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +00001472void JITEmitter::startGVStub(const GlobalValue* GV,
Jeffrey Yasskin0261d792009-11-23 22:49:00 +00001473 unsigned StubSize, unsigned Alignment) {
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +00001474 SavedBufferBegin = BufferBegin;
1475 SavedBufferEnd = BufferEnd;
1476 SavedCurBufferPtr = CurBufferPtr;
Eric Christopher116664a2009-11-12 03:12:18 +00001477
Evan Chengce4a70b2008-11-08 08:02:53 +00001478 BufferBegin = CurBufferPtr = MemMgr->allocateStub(GV, StubSize, Alignment);
Chris Lattner43b429b2006-05-02 18:27:26 +00001479 BufferEnd = BufferBegin+StubSize+1;
Chris Lattner6125fdd2003-05-09 03:30:07 +00001480}
1481
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +00001482void JITEmitter::startGVStub(void *Buffer, unsigned StubSize) {
1483 SavedBufferBegin = BufferBegin;
1484 SavedBufferEnd = BufferEnd;
1485 SavedCurBufferPtr = CurBufferPtr;
Eric Christopher116664a2009-11-12 03:12:18 +00001486
Bruno Cardoso Lopes186c6702009-06-04 00:15:51 +00001487 BufferBegin = CurBufferPtr = (uint8_t *)Buffer;
Nate Begemand6b7a242009-02-18 08:31:02 +00001488 BufferEnd = BufferBegin+StubSize+1;
1489}
1490
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +00001491void JITEmitter::finishGVStub() {
Jeffrey Yasskin108c8382009-11-23 23:35:19 +00001492 assert(CurBufferPtr != BufferEnd && "Stub overflowed allocated space.");
Chris Lattner43b429b2006-05-02 18:27:26 +00001493 NumBytes += getCurrentPCOffset();
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +00001494 BufferBegin = SavedBufferBegin;
1495 BufferEnd = SavedBufferEnd;
1496 CurBufferPtr = SavedCurBufferPtr;
1497}
1498
1499void *JITEmitter::allocIndirectGV(const GlobalValue *GV,
1500 const uint8_t *Buffer, size_t Size,
1501 unsigned Alignment) {
1502 uint8_t *IndGV = MemMgr->allocateStub(GV, Size, Alignment);
1503 memcpy(IndGV, Buffer, Size);
1504 return IndGV;
Chris Lattnerbba1b6d2003-06-01 23:24:36 +00001505}
1506
Chris Lattnerbba1b6d2003-06-01 23:24:36 +00001507// getConstantPoolEntryAddress - Return the address of the 'ConstantNum' entry
1508// in the constant pool that was last emitted with the 'emitConstantPool'
1509// method.
1510//
Evan Cheng5788d1a2008-12-10 02:32:19 +00001511uintptr_t JITEmitter::getConstantPoolEntryAddress(unsigned ConstantNum) const {
Chris Lattner239862c2006-02-09 04:49:59 +00001512 assert(ConstantNum < ConstantPool->getConstants().size() &&
Misha Brukman3c944972005-04-22 04:08:30 +00001513 "Invalid ConstantPoolIndex!");
Evan Cheng1606e8e2009-03-13 07:51:59 +00001514 return ConstPoolAddresses[ConstantNum];
Chris Lattnerbba1b6d2003-06-01 23:24:36 +00001515}
1516
Nate Begeman37efe672006-04-22 18:53:45 +00001517// getJumpTableEntryAddress - Return the address of the JumpTable with index
1518// 'Index' in the jumpp table that was last initialized with 'initJumpTableInfo'
1519//
Evan Cheng5788d1a2008-12-10 02:32:19 +00001520uintptr_t JITEmitter::getJumpTableEntryAddress(unsigned Index) const {
Nate Begeman37efe672006-04-22 18:53:45 +00001521 const std::vector<MachineJumpTableEntry> &JT = JumpTable->getJumpTables();
1522 assert(Index < JT.size() && "Invalid jump table index!");
Eric Christopher116664a2009-11-12 03:12:18 +00001523
Chris Lattner071c62f2010-01-25 23:26:13 +00001524 unsigned EntrySize = JumpTable->getEntrySize(*TheJIT->getTargetData());
Eric Christopher116664a2009-11-12 03:12:18 +00001525
Chris Lattner071c62f2010-01-25 23:26:13 +00001526 unsigned Offset = 0;
Nate Begeman37efe672006-04-22 18:53:45 +00001527 for (unsigned i = 0; i < Index; ++i)
Jim Laskeyacd80ac2006-12-14 19:17:33 +00001528 Offset += JT[i].MBBs.size();
Eric Christopher116664a2009-11-12 03:12:18 +00001529
Jim Laskeyacd80ac2006-12-14 19:17:33 +00001530 Offset *= EntrySize;
Eric Christopher116664a2009-11-12 03:12:18 +00001531
Evan Cheng5788d1a2008-12-10 02:32:19 +00001532 return (uintptr_t)((char *)JumpTableBase + Offset);
Nate Begeman37efe672006-04-22 18:53:45 +00001533}
1534
Jeffrey Yasskin7a9034c2009-10-27 00:03:05 +00001535void JITEmitter::EmittedFunctionConfig::onDelete(
1536 JITEmitter *Emitter, const Function *F) {
1537 Emitter->deallocateMemForFunction(F);
1538}
1539void JITEmitter::EmittedFunctionConfig::onRAUW(
1540 JITEmitter *, const Function*, const Function*) {
1541 llvm_unreachable("The JIT doesn't know how to handle a"
1542 " RAUW on a value it has emitted.");
1543}
1544
1545
Chris Lattnere993cc22006-05-11 23:08:08 +00001546//===----------------------------------------------------------------------===//
1547// Public interface to this file
1548//===----------------------------------------------------------------------===//
1549
Reid Kleckner27632172009-09-20 23:52:43 +00001550JITCodeEmitter *JIT::createEmitter(JIT &jit, JITMemoryManager *JMM,
1551 TargetMachine &tm) {
1552 return new JITEmitter(jit, JMM, tm);
Chris Lattnere993cc22006-05-11 23:08:08 +00001553}
1554
Misha Brukmand69c1e62003-07-28 19:09:06 +00001555// getPointerToNamedFunction - This function is used as a global wrapper to
Chris Lattner4d326fa2003-12-20 01:46:27 +00001556// JIT::getPointerToNamedFunction for the purpose of resolving symbols when
Misha Brukmand69c1e62003-07-28 19:09:06 +00001557// bugpoint is debugging the JIT. In that scenario, we are loading an .so and
1558// need to resolve function(s) that are being mis-codegenerated, so we need to
1559// resolve their addresses at runtime, and this is the way to do it.
1560extern "C" {
1561 void *getPointerToNamedFunction(const char *Name) {
Chris Lattnerfe854032006-08-16 01:24:12 +00001562 if (Function *F = TheJIT->FindFunctionNamed(Name))
Chris Lattner4d326fa2003-12-20 01:46:27 +00001563 return TheJIT->getPointerToFunction(F);
1564 return TheJIT->getPointerToNamedFunction(Name);
Misha Brukmand69c1e62003-07-28 19:09:06 +00001565 }
1566}
Chris Lattnere993cc22006-05-11 23:08:08 +00001567
1568// getPointerToFunctionOrStub - If the specified function has been
1569// code-gen'd, return a pointer to the function. If not, compile it, or use
1570// a stub to implement lazy compilation if available.
1571//
1572void *JIT::getPointerToFunctionOrStub(Function *F) {
1573 // If we have already code generated the function, just return the address.
1574 if (void *Addr = getPointerToGlobalIfAvailable(F))
1575 return Addr;
Eric Christopher116664a2009-11-12 03:12:18 +00001576
Chris Lattnere7484012007-02-24 02:57:03 +00001577 // Get a stub if the target supports it.
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +00001578 assert(isa<JITEmitter>(JCE) && "Unexpected MCE?");
Evan Chenga044dfc2008-08-20 00:28:12 +00001579 JITEmitter *JE = cast<JITEmitter>(getCodeEmitter());
Jeffrey Yasskin108c8382009-11-23 23:35:19 +00001580 return JE->getJITResolver().getLazyFunctionStub(F);
Chris Lattnere993cc22006-05-11 23:08:08 +00001581}
1582
Nate Begemand6b7a242009-02-18 08:31:02 +00001583void JIT::updateFunctionStub(Function *F) {
1584 // Get the empty stub we generated earlier.
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +00001585 assert(isa<JITEmitter>(JCE) && "Unexpected MCE?");
Nate Begemand6b7a242009-02-18 08:31:02 +00001586 JITEmitter *JE = cast<JITEmitter>(getCodeEmitter());
Jeffrey Yasskin108c8382009-11-23 23:35:19 +00001587 void *Stub = JE->getJITResolver().getLazyFunctionStub(F);
1588 void *Addr = getPointerToGlobalIfAvailable(F);
Jeffrey Yasskinaad0d522009-12-17 21:35:29 +00001589 assert(Addr != Stub && "Function must have non-stub address to be updated.");
Nate Begemand6b7a242009-02-18 08:31:02 +00001590
1591 // Tell the target jit info to rewrite the stub at the specified address,
1592 // rather than creating a new one.
Jeffrey Yasskin108c8382009-11-23 23:35:19 +00001593 TargetJITInfo::StubLayout layout = getJITInfo().getStubLayout();
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +00001594 JE->startGVStub(Stub, layout.Size);
Jeffrey Yasskin108c8382009-11-23 23:35:19 +00001595 getJITInfo().emitFunctionStub(F, Addr, *getCodeEmitter());
Jeffrey Yasskin32d7e6e2009-12-15 22:42:46 +00001596 JE->finishGVStub();
Nate Begemand6b7a242009-02-18 08:31:02 +00001597}
1598
Chris Lattnere993cc22006-05-11 23:08:08 +00001599/// freeMachineCodeForFunction - release machine code memory for given Function.
1600///
1601void JIT::freeMachineCodeForFunction(Function *F) {
1602 // Delete translation for this from the ExecutionEngine, so it will get
1603 // retranslated next time it is used.
Jeffrey Yasskin7a9034c2009-10-27 00:03:05 +00001604 updateGlobalMapping(F, 0);
Chris Lattnere993cc22006-05-11 23:08:08 +00001605
1606 // Free the actual memory for the function body and related stuff.
Bruno Cardoso Lopesa3f99f92009-05-30 20:51:52 +00001607 assert(isa<JITEmitter>(JCE) && "Unexpected MCE?");
1608 cast<JITEmitter>(JCE)->deallocateMemForFunction(F);
Chris Lattnere993cc22006-05-11 23:08:08 +00001609}