blob: b858965b5c2c182c0bce87f8837f83bac4c59546 [file] [log] [blame]
Jim Grosbach06594e12012-01-16 23:50:58 +00001//===-- RuntimeDyld.cpp - Run-time dynamic linker for MC-JIT ----*- C++ -*-===//
Jim Grosbachf016b0a2011-03-21 22:15:52 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// Implementation of the MC-JIT runtime dynamic linker.
11//
12//===----------------------------------------------------------------------===//
13
Jim Grosbach6a85a052011-03-23 19:52:00 +000014#define DEBUG_TYPE "dyld"
Chandler Carruthed0881b2012-12-03 16:50:05 +000015#include "llvm/ExecutionEngine/RuntimeDyld.h"
Juergen Ributzkad12ccbd2013-11-19 00:57:56 +000016#include "JITRegistrar.h"
Andrew Kayloradc70562012-10-02 21:18:39 +000017#include "ObjectImageCommon.h"
Eli Bendersky058d6472012-01-22 07:05:02 +000018#include "RuntimeDyldELF.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000019#include "RuntimeDyldImpl.h"
Eli Bendersky058d6472012-01-22 07:05:02 +000020#include "RuntimeDyldMachO.h"
Chandler Carruth8a8cd2b2014-01-07 11:48:04 +000021#include "llvm/Object/ELF.h"
Rafael Espindola8de86072013-06-11 18:01:14 +000022#include "llvm/Support/FileSystem.h"
Tim Northover94bc73d2012-10-29 10:47:04 +000023#include "llvm/Support/MathExtras.h"
Andrew Kaylor4fba0492013-10-21 17:42:06 +000024#include "llvm/Support/MutexGuard.h"
Eli Bendersky058d6472012-01-22 07:05:02 +000025
Jim Grosbachf016b0a2011-03-21 22:15:52 +000026using namespace llvm;
27using namespace llvm::object;
28
Chandler Carruth086f7082011-04-05 23:54:31 +000029// Empty out-of-line virtual destructor as the key function.
Danil Malyshev72510f22011-07-13 07:57:58 +000030RuntimeDyldImpl::~RuntimeDyldImpl() {}
Chandler Carruth086f7082011-04-05 23:54:31 +000031
Juergen Ributzkad12ccbd2013-11-19 00:57:56 +000032// Pin the JITRegistrar's and ObjectImage*'s vtables to this file.
33void JITRegistrar::anchor() {}
34void ObjectImage::anchor() {}
35void ObjectImageCommon::anchor() {}
36
Jim Grosbachf016b0a2011-03-21 22:15:52 +000037namespace llvm {
Jim Grosbachf016b0a2011-03-21 22:15:52 +000038
Andrew Kaylor7bb13442013-10-11 21:25:48 +000039void RuntimeDyldImpl::registerEHFrames() {
Rafael Espindolafa5942b2013-05-05 20:43:10 +000040}
41
Andrew Kaylorc442a762013-10-16 00:14:21 +000042void RuntimeDyldImpl::deregisterEHFrames() {
43}
44
Jim Grosbach733d3052011-04-12 21:20:41 +000045// Resolve the relocations for all symbols we currently know about.
46void RuntimeDyldImpl::resolveRelocations() {
Andrew Kaylor4fba0492013-10-21 17:42:06 +000047 MutexGuard locked(lock);
48
Preston Gurd2138ef62012-04-12 20:13:57 +000049 // First, resolve relocations associated with external symbols.
Eli Benderskyb92e1cf2012-04-30 12:15:58 +000050 resolveExternalSymbols();
Danil Malyshev70d22cc2012-03-30 16:45:19 +000051
Jim Grosbacheff0a402012-01-16 22:26:39 +000052 // Just iterate over the sections we have and resolve all the relocations
53 // in them. Gross overkill, but it gets the job done.
54 for (int i = 0, e = Sections.size(); i != e; ++i) {
Andrew Kaylor5f3a9982013-08-19 19:38:06 +000055 // The Section here (Sections[i]) refers to the section in which the
56 // symbol for the relocation is located. The SectionID in the relocation
57 // entry provides the section to which the relocation will be applied.
Andrew Kaylora714efc2012-11-05 20:57:16 +000058 uint64_t Addr = Sections[i].LoadAddress;
59 DEBUG(dbgs() << "Resolving relocations Section #" << i
60 << "\t" << format("%p", (uint8_t *)Addr)
61 << "\n");
62 resolveRelocationList(Relocations[i], Addr);
Andrew Kaylorea395922013-10-01 01:47:35 +000063 Relocations.erase(i);
Jim Grosbacheff0a402012-01-16 22:26:39 +000064 }
Jim Grosbach733d3052011-04-12 21:20:41 +000065}
66
Jim Grosbach6d613972012-09-13 21:50:06 +000067void RuntimeDyldImpl::mapSectionAddress(const void *LocalAddress,
Jim Grosbach0ddb3a42012-01-16 23:50:55 +000068 uint64_t TargetAddress) {
Andrew Kaylor4fba0492013-10-21 17:42:06 +000069 MutexGuard locked(lock);
Danil Malyshev70d22cc2012-03-30 16:45:19 +000070 for (unsigned i = 0, e = Sections.size(); i != e; ++i) {
71 if (Sections[i].Address == LocalAddress) {
72 reassignSectionAddress(i, TargetAddress);
73 return;
74 }
75 }
76 llvm_unreachable("Attempting to remap address of unknown section!");
Jim Grosbach0ddb3a42012-01-16 23:50:55 +000077}
78
Eli Bendersky0e2ac5b2012-04-29 12:40:47 +000079// Subclasses can implement this method to create specialized image instances.
Sylvestre Ledru35521e22012-07-23 08:51:15 +000080// The caller owns the pointer that is returned.
Andrew Kayloradc70562012-10-02 21:18:39 +000081ObjectImage *RuntimeDyldImpl::createObjectImage(ObjectBuffer *InputBuffer) {
82 return new ObjectImageCommon(InputBuffer);
Preston Gurdcc31af92012-04-16 22:12:58 +000083}
84
Lang Hames173c69f2014-01-08 04:09:09 +000085ObjectImage *RuntimeDyldImpl::createObjectImageFromFile(ObjectFile *InputObject) {
86 return new ObjectImageCommon(InputObject);
87}
88
89ObjectImage *RuntimeDyldImpl::loadObject(ObjectFile *InputObject) {
90 return loadObject(createObjectImageFromFile(InputObject));
91}
92
Andrew Kayloradc70562012-10-02 21:18:39 +000093ObjectImage *RuntimeDyldImpl::loadObject(ObjectBuffer *InputBuffer) {
Lang Hames173c69f2014-01-08 04:09:09 +000094 return loadObject(createObjectImage(InputBuffer));
95}
96
97ObjectImage *RuntimeDyldImpl::loadObject(ObjectImage *InputObject) {
Andrew Kaylor4fba0492013-10-21 17:42:06 +000098 MutexGuard locked(lock);
99
Lang Hames173c69f2014-01-08 04:09:09 +0000100 OwningPtr<ObjectImage> obj(InputObject);
Preston Gurd2138ef62012-04-12 20:13:57 +0000101 if (!obj)
Lang Hames173c69f2014-01-08 04:09:09 +0000102 return NULL;
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000103
Andrew Kaylor33c5b1b2013-10-15 20:44:55 +0000104 // Save information about our target
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000105 Arch = (Triple::ArchType)obj->getArch();
Andrew Kaylor33c5b1b2013-10-15 20:44:55 +0000106 IsTargetLittleEndian = obj->getObjectFile()->isLittleEndian();
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000107
Eli Benderskyfc079082012-05-01 06:58:59 +0000108 // Symbols found in this object
109 StringMap<SymbolLoc> LocalSymbols;
110 // Used sections from the object file
111 ObjSectionToIDMap LocalSections;
112
Tim Northover94bc73d2012-10-29 10:47:04 +0000113 // Common symbols requiring allocation, with their sizes and alignments
Eli Benderskyfc079082012-05-01 06:58:59 +0000114 CommonSymbolMap CommonSymbols;
Tim Northover94bc73d2012-10-29 10:47:04 +0000115 // Maximum required total memory to allocate all common symbols
Eli Benderskyfc079082012-05-01 06:58:59 +0000116 uint64_t CommonSize = 0;
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000117
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000118 // Parse symbols
119 DEBUG(dbgs() << "Parse symbols:\n");
Rafael Espindola5e812af2014-01-30 02:49:50 +0000120 for (symbol_iterator i = obj->begin_symbols(), e = obj->end_symbols(); i != e;
121 ++i) {
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000122 object::SymbolRef::Type SymType;
123 StringRef Name;
124 Check(i->getType(SymType));
125 Check(i->getName(Name));
126
Rafael Espindola20122a42014-01-31 20:57:12 +0000127 uint32_t flags = i->getFlags();
Preston Gurd2138ef62012-04-12 20:13:57 +0000128
129 bool isCommon = flags & SymbolRef::SF_Common;
130 if (isCommon) {
131 // Add the common symbols to a list. We'll allocate them all below.
Rafael Espindolae4dd2e02013-04-29 22:24:22 +0000132 uint32_t Align;
133 Check(i->getAlignment(Align));
Preston Gurd2138ef62012-04-12 20:13:57 +0000134 uint64_t Size = 0;
135 Check(i->getSize(Size));
Tim Northover94bc73d2012-10-29 10:47:04 +0000136 CommonSize += Size + Align;
137 CommonSymbols[*i] = CommonSymbolInfo(Size, Align);
Preston Gurd2138ef62012-04-12 20:13:57 +0000138 } else {
139 if (SymType == object::SymbolRef::ST_Function ||
Akira Hatanaka111174b2012-08-17 21:28:04 +0000140 SymType == object::SymbolRef::ST_Data ||
141 SymType == object::SymbolRef::ST_Unknown) {
Preston Gurd2138ef62012-04-12 20:13:57 +0000142 uint64_t FileOffset;
Eli Bendersky0e2ac5b2012-04-29 12:40:47 +0000143 StringRef SectionData;
Tim Northoverd05e6b52012-12-17 17:59:35 +0000144 bool IsCode;
Preston Gurd2138ef62012-04-12 20:13:57 +0000145 section_iterator si = obj->end_sections();
146 Check(i->getFileOffset(FileOffset));
147 Check(i->getSection(si));
148 if (si == obj->end_sections()) continue;
Eli Bendersky0e2ac5b2012-04-29 12:40:47 +0000149 Check(si->getContents(SectionData));
Tim Northoverd05e6b52012-12-17 17:59:35 +0000150 Check(si->isText(IsCode));
Lang Hames173c69f2014-01-08 04:09:09 +0000151 const uint8_t* SymPtr = (const uint8_t*)InputObject->getData().data() +
Preston Gurd2138ef62012-04-12 20:13:57 +0000152 (uintptr_t)FileOffset;
Eli Bendersky0e2ac5b2012-04-29 12:40:47 +0000153 uintptr_t SectOffset = (uintptr_t)(SymPtr -
154 (const uint8_t*)SectionData.begin());
Tim Northoverd05e6b52012-12-17 17:59:35 +0000155 unsigned SectionID = findOrEmitSection(*obj, *si, IsCode, LocalSections);
Preston Gurd2138ef62012-04-12 20:13:57 +0000156 LocalSymbols[Name.data()] = SymbolLoc(SectionID, SectOffset);
157 DEBUG(dbgs() << "\tFileOffset: " << format("%p", (uintptr_t)FileOffset)
158 << " flags: " << flags
159 << " SID: " << SectionID
160 << " Offset: " << format("%p", SectOffset));
Amara Emersonc958bf32012-11-16 11:11:59 +0000161 GlobalSymbolTable[Name] = SymbolLoc(SectionID, SectOffset);
Preston Gurd2138ef62012-04-12 20:13:57 +0000162 }
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000163 }
164 DEBUG(dbgs() << "\tType: " << SymType << " Name: " << Name << "\n");
165 }
166
Preston Gurd2138ef62012-04-12 20:13:57 +0000167 // Allocate common symbols
168 if (CommonSize != 0)
Preston Gurdcc31af92012-04-16 22:12:58 +0000169 emitCommonSymbols(*obj, CommonSymbols, CommonSize, LocalSymbols);
Preston Gurd2138ef62012-04-12 20:13:57 +0000170
Eli Bendersky0e2ac5b2012-04-29 12:40:47 +0000171 // Parse and process relocations
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000172 DEBUG(dbgs() << "Parse relocations:\n");
Rafael Espindola5e812af2014-01-30 02:49:50 +0000173 for (section_iterator si = obj->begin_sections(), se = obj->end_sections();
174 si != se; ++si) {
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000175 bool isFirstRelocation = true;
176 unsigned SectionID = 0;
177 StubMap Stubs;
Rafael Espindola4f60a382013-05-30 03:05:14 +0000178 section_iterator RelocatedSection = si->getRelocatedSection();
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000179
Rafael Espindolab5155a52014-02-10 20:24:04 +0000180 for (relocation_iterator i = si->relocation_begin(),
181 e = si->relocation_end();
Rafael Espindola5e812af2014-01-30 02:49:50 +0000182 i != e; ++i) {
Eli Bendersky0e2ac5b2012-04-29 12:40:47 +0000183 // If it's the first relocation in this section, find its SectionID
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000184 if (isFirstRelocation) {
Rafael Espindola4f60a382013-05-30 03:05:14 +0000185 SectionID =
186 findOrEmitSection(*obj, *RelocatedSection, true, LocalSections);
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000187 DEBUG(dbgs() << "\tSectionID: " << SectionID << "\n");
188 isFirstRelocation = false;
189 }
190
Rafael Espindola37008942013-04-29 19:03:21 +0000191 processRelocationRef(SectionID, *i, *obj, LocalSections, LocalSymbols,
NAKAMURA Takumi87e08802013-12-07 11:21:42 +0000192 Stubs);
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000193 }
194 }
Preston Gurdcc31af92012-04-16 22:12:58 +0000195
Andrew Kaylor4612fed2013-08-19 23:27:43 +0000196 // Give the subclasses a chance to tie-up any loose ends.
Andrew Kaylor7bb13442013-10-11 21:25:48 +0000197 finalizeLoad(LocalSections);
Andrew Kaylor4612fed2013-08-19 23:27:43 +0000198
Andrew Kayloradc70562012-10-02 21:18:39 +0000199 return obj.take();
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000200}
201
Eli Bendersky667b8792012-05-01 10:41:12 +0000202void RuntimeDyldImpl::emitCommonSymbols(ObjectImage &Obj,
203 const CommonSymbolMap &CommonSymbols,
204 uint64_t TotalSize,
205 SymbolTableMap &SymbolTable) {
Preston Gurd2138ef62012-04-12 20:13:57 +0000206 // Allocate memory for the section
207 unsigned SectionID = Sections.size();
Filip Pizlo7aa695e02013-10-02 00:59:25 +0000208 uint8_t *Addr = MemMgr->allocateDataSection(
209 TotalSize, sizeof(void*), SectionID, StringRef(), false);
Preston Gurd2138ef62012-04-12 20:13:57 +0000210 if (!Addr)
211 report_fatal_error("Unable to allocate memory for common symbols!");
212 uint64_t Offset = 0;
Rafael Espindolafa5942b2013-05-05 20:43:10 +0000213 Sections.push_back(SectionEntry(StringRef(), Addr, TotalSize, 0));
Preston Gurd2138ef62012-04-12 20:13:57 +0000214 memset(Addr, 0, TotalSize);
215
216 DEBUG(dbgs() << "emitCommonSection SectionID: " << SectionID
217 << " new addr: " << format("%p", Addr)
218 << " DataSize: " << TotalSize
219 << "\n");
220
221 // Assign the address of each symbol
Eli Bendersky667b8792012-05-01 10:41:12 +0000222 for (CommonSymbolMap::const_iterator it = CommonSymbols.begin(),
223 itEnd = CommonSymbols.end(); it != itEnd; it++) {
Tim Northover94bc73d2012-10-29 10:47:04 +0000224 uint64_t Size = it->second.first;
225 uint64_t Align = it->second.second;
Preston Gurd2138ef62012-04-12 20:13:57 +0000226 StringRef Name;
227 it->first.getName(Name);
Tim Northover94bc73d2012-10-29 10:47:04 +0000228 if (Align) {
229 // This symbol has an alignment requirement.
230 uint64_t AlignOffset = OffsetToAlignment((uint64_t)Addr, Align);
231 Addr += AlignOffset;
232 Offset += AlignOffset;
233 DEBUG(dbgs() << "Allocating common symbol " << Name << " address " <<
Andrew Kaylor0eece8d2012-11-01 19:49:21 +0000234 format("%p\n", Addr));
Tim Northover94bc73d2012-10-29 10:47:04 +0000235 }
Preston Gurdcc31af92012-04-16 22:12:58 +0000236 Obj.updateSymbolAddress(it->first, (uint64_t)Addr);
Eli Bendersky667b8792012-05-01 10:41:12 +0000237 SymbolTable[Name.data()] = SymbolLoc(SectionID, Offset);
Preston Gurd2138ef62012-04-12 20:13:57 +0000238 Offset += Size;
239 Addr += Size;
240 }
Preston Gurd2138ef62012-04-12 20:13:57 +0000241}
242
Preston Gurdcc31af92012-04-16 22:12:58 +0000243unsigned RuntimeDyldImpl::emitSection(ObjectImage &Obj,
244 const SectionRef &Section,
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000245 bool IsCode) {
246
247 unsigned StubBufSize = 0,
248 StubSize = getMaxStubSize();
Rafael Espindola4f60a382013-05-30 03:05:14 +0000249 const ObjectFile *ObjFile = Obj.getObjectFile();
250 // FIXME: this is an inefficient way to handle this. We should computed the
251 // necessary section allocation size in loadObject by walking all the sections
252 // once.
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000253 if (StubSize > 0) {
Rafael Espindolab5155a52014-02-10 20:24:04 +0000254 for (section_iterator SI = ObjFile->section_begin(),
255 SE = ObjFile->section_end();
Rafael Espindola5e812af2014-01-30 02:49:50 +0000256 SI != SE; ++SI) {
Rafael Espindola4f60a382013-05-30 03:05:14 +0000257 section_iterator RelSecI = SI->getRelocatedSection();
258 if (!(RelSecI == Section))
259 continue;
260
Rafael Espindolab5155a52014-02-10 20:24:04 +0000261 for (relocation_iterator I = SI->relocation_begin(),
262 E = SI->relocation_end();
Rafael Espindola5e812af2014-01-30 02:49:50 +0000263 I != E; ++I) {
Rafael Espindola4f60a382013-05-30 03:05:14 +0000264 StubBufSize += StubSize;
265 }
266 }
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000267 }
Rafael Espindola4f60a382013-05-30 03:05:14 +0000268
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000269 StringRef data;
270 uint64_t Alignment64;
271 Check(Section.getContents(data));
272 Check(Section.getAlignment(Alignment64));
273
274 unsigned Alignment = (unsigned)Alignment64 & 0xffffffffL;
Preston Gurd2138ef62012-04-12 20:13:57 +0000275 bool IsRequired;
276 bool IsVirtual;
277 bool IsZeroInit;
Andrew Kaylora342cb92012-11-15 23:50:01 +0000278 bool IsReadOnly;
Preston Gurd2138ef62012-04-12 20:13:57 +0000279 uint64_t DataSize;
Andrew Kaylor877b9312013-10-16 00:32:24 +0000280 unsigned PaddingSize = 0;
Adhemerval Zanella5fc11b32012-10-25 13:13:48 +0000281 StringRef Name;
Preston Gurd2138ef62012-04-12 20:13:57 +0000282 Check(Section.isRequiredForExecution(IsRequired));
283 Check(Section.isVirtual(IsVirtual));
284 Check(Section.isZeroInit(IsZeroInit));
Andrew Kaylora342cb92012-11-15 23:50:01 +0000285 Check(Section.isReadOnlyData(IsReadOnly));
Preston Gurd2138ef62012-04-12 20:13:57 +0000286 Check(Section.getSize(DataSize));
Adhemerval Zanella5fc11b32012-10-25 13:13:48 +0000287 Check(Section.getName(Name));
Richard Sandifordca044082013-05-03 14:15:35 +0000288 if (StubSize > 0) {
289 unsigned StubAlignment = getStubAlignment();
290 unsigned EndAlignment = (DataSize | Alignment) & -(DataSize | Alignment);
291 if (StubAlignment > EndAlignment)
292 StubBufSize += StubAlignment - EndAlignment;
293 }
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000294
Andrew Kaylor877b9312013-10-16 00:32:24 +0000295 // The .eh_frame section (at least on Linux) needs an extra four bytes padded
296 // with zeroes added at the end. For MachO objects, this section has a
297 // slightly different name, so this won't have any effect for MachO objects.
298 if (Name == ".eh_frame")
299 PaddingSize = 4;
300
Preston Gurd2138ef62012-04-12 20:13:57 +0000301 unsigned Allocate;
302 unsigned SectionID = Sections.size();
303 uint8_t *Addr;
304 const char *pData = 0;
305
306 // Some sections, such as debug info, don't need to be loaded for execution.
307 // Leave those where they are.
308 if (IsRequired) {
Andrew Kaylor877b9312013-10-16 00:32:24 +0000309 Allocate = DataSize + PaddingSize + StubBufSize;
Preston Gurd2138ef62012-04-12 20:13:57 +0000310 Addr = IsCode
Filip Pizlo7aa695e02013-10-02 00:59:25 +0000311 ? MemMgr->allocateCodeSection(Allocate, Alignment, SectionID, Name)
312 : MemMgr->allocateDataSection(Allocate, Alignment, SectionID, Name,
313 IsReadOnly);
Preston Gurd2138ef62012-04-12 20:13:57 +0000314 if (!Addr)
315 report_fatal_error("Unable to allocate section memory!");
316
317 // Virtual sections have no data in the object image, so leave pData = 0
318 if (!IsVirtual)
319 pData = data.data();
320
321 // Zero-initialize or copy the data from the image
322 if (IsZeroInit || IsVirtual)
323 memset(Addr, 0, DataSize);
324 else
325 memcpy(Addr, pData, DataSize);
326
Andrew Kaylor877b9312013-10-16 00:32:24 +0000327 // Fill in any extra bytes we allocated for padding
328 if (PaddingSize != 0) {
329 memset(Addr + DataSize, 0, PaddingSize);
330 // Update the DataSize variable so that the stub offset is set correctly.
331 DataSize += PaddingSize;
332 }
333
Preston Gurd2138ef62012-04-12 20:13:57 +0000334 DEBUG(dbgs() << "emitSection SectionID: " << SectionID
Adhemerval Zanella5fc11b32012-10-25 13:13:48 +0000335 << " Name: " << Name
Preston Gurd2138ef62012-04-12 20:13:57 +0000336 << " obj addr: " << format("%p", pData)
337 << " new addr: " << format("%p", Addr)
338 << " DataSize: " << DataSize
339 << " StubBufSize: " << StubBufSize
340 << " Allocate: " << Allocate
341 << "\n");
Preston Gurdcc31af92012-04-16 22:12:58 +0000342 Obj.updateSectionAddress(Section, (uint64_t)Addr);
Preston Gurd2138ef62012-04-12 20:13:57 +0000343 }
344 else {
345 // Even if we didn't load the section, we need to record an entry for it
Eli Bendersky0e2ac5b2012-04-29 12:40:47 +0000346 // to handle later processing (and by 'handle' I mean don't do anything
347 // with these sections).
Preston Gurd2138ef62012-04-12 20:13:57 +0000348 Allocate = 0;
349 Addr = 0;
350 DEBUG(dbgs() << "emitSection SectionID: " << SectionID
Adhemerval Zanella5fc11b32012-10-25 13:13:48 +0000351 << " Name: " << Name
Preston Gurd2138ef62012-04-12 20:13:57 +0000352 << " obj addr: " << format("%p", data.data())
353 << " new addr: 0"
354 << " DataSize: " << DataSize
355 << " StubBufSize: " << StubBufSize
356 << " Allocate: " << Allocate
357 << "\n");
358 }
359
Rafael Espindolafa5942b2013-05-05 20:43:10 +0000360 Sections.push_back(SectionEntry(Name, Addr, DataSize, (uintptr_t)pData));
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000361 return SectionID;
362}
363
Preston Gurdcc31af92012-04-16 22:12:58 +0000364unsigned RuntimeDyldImpl::findOrEmitSection(ObjectImage &Obj,
365 const SectionRef &Section,
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000366 bool IsCode,
367 ObjSectionToIDMap &LocalSections) {
368
369 unsigned SectionID = 0;
370 ObjSectionToIDMap::iterator i = LocalSections.find(Section);
371 if (i != LocalSections.end())
372 SectionID = i->second;
373 else {
Preston Gurdcc31af92012-04-16 22:12:58 +0000374 SectionID = emitSection(Obj, Section, IsCode);
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000375 LocalSections[Section] = SectionID;
376 }
377 return SectionID;
378}
379
Eli Bendersky667b8792012-05-01 10:41:12 +0000380void RuntimeDyldImpl::addRelocationForSection(const RelocationEntry &RE,
381 unsigned SectionID) {
382 Relocations[SectionID].push_back(RE);
383}
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000384
Eli Bendersky667b8792012-05-01 10:41:12 +0000385void RuntimeDyldImpl::addRelocationForSymbol(const RelocationEntry &RE,
386 StringRef SymbolName) {
387 // Relocation by symbol. If the symbol is found in the global symbol table,
388 // create an appropriate section relocation. Otherwise, add it to
389 // ExternalSymbolRelocations.
390 SymbolTableMap::const_iterator Loc =
391 GlobalSymbolTable.find(SymbolName);
392 if (Loc == GlobalSymbolTable.end()) {
393 ExternalSymbolRelocations[SymbolName].push_back(RE);
Eli Benderskyb92e1cf2012-04-30 12:15:58 +0000394 } else {
Eli Bendersky667b8792012-05-01 10:41:12 +0000395 // Copy the RE since we want to modify its addend.
396 RelocationEntry RECopy = RE;
397 RECopy.Addend += Loc->second.second;
398 Relocations[Loc->second.first].push_back(RECopy);
Eli Benderskyb92e1cf2012-04-30 12:15:58 +0000399 }
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000400}
401
402uint8_t *RuntimeDyldImpl::createStubFunction(uint8_t *Addr) {
Tim Northover37cde972013-05-04 20:14:09 +0000403 if (Arch == Triple::aarch64) {
404 // This stub has to be able to access the full address space,
405 // since symbol lookup won't necessarily find a handy, in-range,
406 // PLT stub for functions which could be anywhere.
407 uint32_t *StubAddr = (uint32_t*)Addr;
408
409 // Stub can use ip0 (== x16) to calculate address
410 *StubAddr = 0xd2e00010; // movz ip0, #:abs_g3:<addr>
411 StubAddr++;
412 *StubAddr = 0xf2c00010; // movk ip0, #:abs_g2_nc:<addr>
413 StubAddr++;
414 *StubAddr = 0xf2a00010; // movk ip0, #:abs_g1_nc:<addr>
415 StubAddr++;
416 *StubAddr = 0xf2800010; // movk ip0, #:abs_g0_nc:<addr>
417 StubAddr++;
418 *StubAddr = 0xd61f0200; // br ip0
419
420 return Addr;
421 } else if (Arch == Triple::arm) {
Akira Hatanaka111174b2012-08-17 21:28:04 +0000422 // TODO: There is only ARM far stub now. We should add the Thumb stub,
423 // and stubs for branches Thumb - ARM and ARM - Thumb.
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000424 uint32_t *StubAddr = (uint32_t*)Addr;
425 *StubAddr = 0xe51ff004; // ldr pc,<label>
426 return (uint8_t*)++StubAddr;
NAKAMURA Takumif97efd92012-12-04 00:08:14 +0000427 } else if (Arch == Triple::mipsel || Arch == Triple::mips) {
Akira Hatanaka111174b2012-08-17 21:28:04 +0000428 uint32_t *StubAddr = (uint32_t*)Addr;
429 // 0: 3c190000 lui t9,%hi(addr).
430 // 4: 27390000 addiu t9,t9,%lo(addr).
431 // 8: 03200008 jr t9.
432 // c: 00000000 nop.
433 const unsigned LuiT9Instr = 0x3c190000, AdduiT9Instr = 0x27390000;
434 const unsigned JrT9Instr = 0x03200008, NopInstr = 0x0;
435
436 *StubAddr = LuiT9Instr;
437 StubAddr++;
438 *StubAddr = AdduiT9Instr;
439 StubAddr++;
440 *StubAddr = JrT9Instr;
441 StubAddr++;
442 *StubAddr = NopInstr;
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000443 return Addr;
Bill Schmidt0a9170d2013-07-26 01:35:43 +0000444 } else if (Arch == Triple::ppc64 || Arch == Triple::ppc64le) {
Adhemerval Zanella5fc11b32012-10-25 13:13:48 +0000445 // PowerPC64 stub: the address points to a function descriptor
446 // instead of the function itself. Load the function address
447 // on r11 and sets it to control register. Also loads the function
448 // TOC in r2 and environment pointer to r11.
449 writeInt32BE(Addr, 0x3D800000); // lis r12, highest(addr)
450 writeInt32BE(Addr+4, 0x618C0000); // ori r12, higher(addr)
451 writeInt32BE(Addr+8, 0x798C07C6); // sldi r12, r12, 32
452 writeInt32BE(Addr+12, 0x658C0000); // oris r12, r12, h(addr)
453 writeInt32BE(Addr+16, 0x618C0000); // ori r12, r12, l(addr)
454 writeInt32BE(Addr+20, 0xF8410028); // std r2, 40(r1)
455 writeInt32BE(Addr+24, 0xE96C0000); // ld r11, 0(r12)
456 writeInt32BE(Addr+28, 0xE84C0008); // ld r2, 0(r12)
457 writeInt32BE(Addr+32, 0x7D6903A6); // mtctr r11
458 writeInt32BE(Addr+36, 0xE96C0010); // ld r11, 16(r2)
459 writeInt32BE(Addr+40, 0x4E800420); // bctr
Andrew Kaylor0eece8d2012-11-01 19:49:21 +0000460
Adhemerval Zanella5fc11b32012-10-25 13:13:48 +0000461 return Addr;
Richard Sandifordca044082013-05-03 14:15:35 +0000462 } else if (Arch == Triple::systemz) {
463 writeInt16BE(Addr, 0xC418); // lgrl %r1,.+8
464 writeInt16BE(Addr+2, 0x0000);
465 writeInt16BE(Addr+4, 0x0004);
466 writeInt16BE(Addr+6, 0x07F1); // brc 15,%r1
467 // 8-byte address stored at Addr + 8
468 return Addr;
Andrew Kaylor4612fed2013-08-19 23:27:43 +0000469 } else if (Arch == Triple::x86_64) {
470 *Addr = 0xFF; // jmp
471 *(Addr+1) = 0x25; // rip
472 // 32-bit PC-relative address of the GOT entry will be stored at Addr+2
Akira Hatanaka111174b2012-08-17 21:28:04 +0000473 }
474 return Addr;
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000475}
476
477// Assign an address to a symbol name and resolve all the relocations
478// associated with it.
479void RuntimeDyldImpl::reassignSectionAddress(unsigned SectionID,
480 uint64_t Addr) {
481 // The address to use for relocation resolution is not
482 // the address of the local section buffer. We must be doing
Andrew Kaylora714efc2012-11-05 20:57:16 +0000483 // a remote execution environment of some sort. Relocations can't
484 // be applied until all the sections have been moved. The client must
485 // trigger this with a call to MCJIT::finalize() or
486 // RuntimeDyld::resolveRelocations().
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000487 //
488 // Addr is a uint64_t because we can't assume the pointer width
489 // of the target is the same as that of the host. Just use a generic
490 // "big enough" type.
491 Sections[SectionID].LoadAddress = Addr;
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000492}
493
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000494void RuntimeDyldImpl::resolveRelocationList(const RelocationList &Relocs,
495 uint64_t Value) {
496 for (unsigned i = 0, e = Relocs.size(); i != e; ++i) {
Rafael Espindolaf1f1c622013-04-29 17:24:34 +0000497 const RelocationEntry &RE = Relocs[i];
498 // Ignore relocations for sections that were not loaded
499 if (Sections[RE.SectionID].Address == 0)
500 continue;
501 resolveRelocation(RE, Value);
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000502 }
503}
504
Eli Benderskyb92e1cf2012-04-30 12:15:58 +0000505void RuntimeDyldImpl::resolveExternalSymbols() {
Andrew Kaylorea395922013-10-01 01:47:35 +0000506 while(!ExternalSymbolRelocations.empty()) {
507 StringMap<RelocationList>::iterator i = ExternalSymbolRelocations.begin();
508
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000509 StringRef Name = i->first();
Andrew Kaylorea395922013-10-01 01:47:35 +0000510 if (Name.size() == 0) {
511 // This is an absolute symbol, use an address of zero.
512 DEBUG(dbgs() << "Resolving absolute relocations." << "\n");
Andrew Kaylorcfb4a992013-11-11 19:55:10 +0000513 RelocationList &Relocs = i->second;
Andrew Kaylorea395922013-10-01 01:47:35 +0000514 resolveRelocationList(Relocs, 0);
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000515 } else {
Andrew Kaylorea395922013-10-01 01:47:35 +0000516 uint64_t Addr = 0;
517 SymbolTableMap::const_iterator Loc = GlobalSymbolTable.find(Name);
518 if (Loc == GlobalSymbolTable.end()) {
519 // This is an external symbol, try to get its address from
520 // MemoryManager.
521 Addr = MemMgr->getSymbolAddress(Name.data());
Andrew Kaylorcfb4a992013-11-11 19:55:10 +0000522 // The call to getSymbolAddress may have caused additional modules to
523 // be loaded, which may have added new entries to the
524 // ExternalSymbolRelocations map. Consquently, we need to update our
525 // iterator. This is also why retrieval of the relocation list
526 // associated with this symbol is deferred until below this point.
527 // New entries may have been added to the relocation list.
528 i = ExternalSymbolRelocations.find(Name);
Andrew Kaylorea395922013-10-01 01:47:35 +0000529 } else {
530 // We found the symbol in our global table. It was probably in a
531 // Module that we loaded previously.
Yaron Kerenc9802882013-10-19 09:04:26 +0000532 SymbolLoc SymLoc = Loc->second;
Andrew Kaylorea395922013-10-01 01:47:35 +0000533 Addr = getSectionLoadAddress(SymLoc.first) + SymLoc.second;
534 }
535
536 // FIXME: Implement error handling that doesn't kill the host program!
537 if (!Addr)
538 report_fatal_error("Program used external function '" + Name +
539 "' which could not be resolved!");
540
541 updateGOTEntries(Name, Addr);
542 DEBUG(dbgs() << "Resolving relocations Name: " << Name
543 << "\t" << format("0x%lx", Addr)
544 << "\n");
Andrew Kaylorcfb4a992013-11-11 19:55:10 +0000545 // This list may have been updated when we called getSymbolAddress, so
546 // don't change this code to get the list earlier.
547 RelocationList &Relocs = i->second;
Andrew Kaylorea395922013-10-01 01:47:35 +0000548 resolveRelocationList(Relocs, Addr);
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000549 }
Andrew Kaylorea395922013-10-01 01:47:35 +0000550
Andrew Kaylorcfb4a992013-11-11 19:55:10 +0000551 ExternalSymbolRelocations.erase(i);
Danil Malyshev70d22cc2012-03-30 16:45:19 +0000552 }
553}
554
555
Jim Grosbachf016b0a2011-03-21 22:15:52 +0000556//===----------------------------------------------------------------------===//
557// RuntimeDyld class implementation
Danil Malyshev72510f22011-07-13 07:57:58 +0000558RuntimeDyld::RuntimeDyld(RTDyldMemoryManager *mm) {
Andrew Kaylora342cb92012-11-15 23:50:01 +0000559 // FIXME: There's a potential issue lurking here if a single instance of
560 // RuntimeDyld is used to load multiple objects. The current implementation
561 // associates a single memory manager with a RuntimeDyld instance. Even
562 // though the public class spawns a new 'impl' instance for each load,
563 // they share a single memory manager. This can become a problem when page
564 // permissions are applied.
Danil Malyshev72510f22011-07-13 07:57:58 +0000565 Dyld = 0;
566 MM = mm;
Jim Grosbachf016b0a2011-03-21 22:15:52 +0000567}
568
569RuntimeDyld::~RuntimeDyld() {
570 delete Dyld;
571}
572
Lang Hames173c69f2014-01-08 04:09:09 +0000573ObjectImage *RuntimeDyld::loadObject(ObjectFile *InputObject) {
574 if (!Dyld) {
575 if (InputObject->isELF())
576 Dyld = new RuntimeDyldELF(MM);
577 else if (InputObject->isMachO())
578 Dyld = new RuntimeDyldMachO(MM);
579 else
580 report_fatal_error("Incompatible object format!");
581 } else {
582 if (!Dyld->isCompatibleFile(InputObject))
583 report_fatal_error("Incompatible object format!");
584 }
585
586 return Dyld->loadObject(InputObject);
587}
588
Andrew Kayloradc70562012-10-02 21:18:39 +0000589ObjectImage *RuntimeDyld::loadObject(ObjectBuffer *InputBuffer) {
Danil Malyshev72510f22011-07-13 07:57:58 +0000590 if (!Dyld) {
Rafael Espindola8de86072013-06-11 18:01:14 +0000591 sys::fs::file_magic Type =
592 sys::fs::identify_magic(InputBuffer->getBuffer());
593 switch (Type) {
594 case sys::fs::file_magic::elf_relocatable:
595 case sys::fs::file_magic::elf_executable:
596 case sys::fs::file_magic::elf_shared_object:
597 case sys::fs::file_magic::elf_core:
598 Dyld = new RuntimeDyldELF(MM);
599 break;
600 case sys::fs::file_magic::macho_object:
601 case sys::fs::file_magic::macho_executable:
602 case sys::fs::file_magic::macho_fixed_virtual_memory_shared_lib:
603 case sys::fs::file_magic::macho_core:
604 case sys::fs::file_magic::macho_preload_executable:
605 case sys::fs::file_magic::macho_dynamically_linked_shared_lib:
606 case sys::fs::file_magic::macho_dynamic_linker:
607 case sys::fs::file_magic::macho_bundle:
608 case sys::fs::file_magic::macho_dynamically_linked_shared_lib_stub:
609 case sys::fs::file_magic::macho_dsym_companion:
610 Dyld = new RuntimeDyldMachO(MM);
611 break;
612 case sys::fs::file_magic::unknown:
613 case sys::fs::file_magic::bitcode:
614 case sys::fs::file_magic::archive:
615 case sys::fs::file_magic::coff_object:
Rui Ueyamae448f9e2013-11-15 21:22:02 +0000616 case sys::fs::file_magic::coff_import_library:
Rafael Espindola8de86072013-06-11 18:01:14 +0000617 case sys::fs::file_magic::pecoff_executable:
Alexey Samsonove6388e62013-06-18 15:03:28 +0000618 case sys::fs::file_magic::macho_universal_binary:
Rui Ueyamafc149a62013-10-15 22:45:38 +0000619 case sys::fs::file_magic::windows_resource:
Rafael Espindola8de86072013-06-11 18:01:14 +0000620 report_fatal_error("Incompatible object format!");
Eli Bendersky4c647582012-01-16 08:56:09 +0000621 }
Danil Malyshev72510f22011-07-13 07:57:58 +0000622 } else {
Eli Bendersky4c647582012-01-16 08:56:09 +0000623 if (!Dyld->isCompatibleFormat(InputBuffer))
Danil Malyshev72510f22011-07-13 07:57:58 +0000624 report_fatal_error("Incompatible object format!");
625 }
626
Jim Grosbachf016b0a2011-03-21 22:15:52 +0000627 return Dyld->loadObject(InputBuffer);
628}
629
Jim Grosbach18b81c52011-04-08 17:31:24 +0000630void *RuntimeDyld::getSymbolAddress(StringRef Name) {
Andrew Kaylorea395922013-10-01 01:47:35 +0000631 if (!Dyld)
632 return NULL;
Jim Grosbachf016b0a2011-03-21 22:15:52 +0000633 return Dyld->getSymbolAddress(Name);
634}
635
Jim Grosbachdc1123f2012-09-05 16:50:40 +0000636uint64_t RuntimeDyld::getSymbolLoadAddress(StringRef Name) {
Andrew Kaylorea395922013-10-01 01:47:35 +0000637 if (!Dyld)
638 return 0;
Jim Grosbachdc1123f2012-09-05 16:50:40 +0000639 return Dyld->getSymbolLoadAddress(Name);
640}
641
Jim Grosbach733d3052011-04-12 21:20:41 +0000642void RuntimeDyld::resolveRelocations() {
643 Dyld->resolveRelocations();
644}
645
Jim Grosbacheff0a402012-01-16 22:26:39 +0000646void RuntimeDyld::reassignSectionAddress(unsigned SectionID,
647 uint64_t Addr) {
648 Dyld->reassignSectionAddress(SectionID, Addr);
Jim Grosbach733d3052011-04-12 21:20:41 +0000649}
650
Jim Grosbach6d613972012-09-13 21:50:06 +0000651void RuntimeDyld::mapSectionAddress(const void *LocalAddress,
Jim Grosbach0ddb3a42012-01-16 23:50:55 +0000652 uint64_t TargetAddress) {
653 Dyld->mapSectionAddress(LocalAddress, TargetAddress);
654}
655
Jim Grosbach5cc5eef2011-03-22 18:22:27 +0000656StringRef RuntimeDyld::getErrorString() {
Jim Grosbach40411cc2011-03-22 18:19:42 +0000657 return Dyld->getErrorString();
658}
659
Andrew Kaylor7bb13442013-10-11 21:25:48 +0000660void RuntimeDyld::registerEHFrames() {
Andrew Kaylorc442a762013-10-16 00:14:21 +0000661 if (Dyld)
662 Dyld->registerEHFrames();
663}
664
665void RuntimeDyld::deregisterEHFrames() {
666 if (Dyld)
667 Dyld->deregisterEHFrames();
Rafael Espindolafa5942b2013-05-05 20:43:10 +0000668}
669
Jim Grosbachf016b0a2011-03-21 22:15:52 +0000670} // end namespace llvm