[MCJIT] Remove the local symbol table from RuntimeDlyd - it's not needed.
[oota-llvm.git] / lib / ExecutionEngine / RuntimeDyld / RuntimeDyld.cpp
1 //===-- RuntimeDyld.cpp - Run-time dynamic linker for MC-JIT ----*- C++ -*-===//
2 //
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
14 #include "llvm/ExecutionEngine/RuntimeDyld.h"
15 #include "RuntimeDyldCheckerImpl.h"
16 #include "RuntimeDyldELF.h"
17 #include "RuntimeDyldImpl.h"
18 #include "RuntimeDyldMachO.h"
19 #include "llvm/Object/ELF.h"
20 #include "llvm/Support/MathExtras.h"
21 #include "llvm/Support/MutexGuard.h"
22
23 using namespace llvm;
24 using namespace llvm::object;
25
26 #define DEBUG_TYPE "dyld"
27
28 // Empty out-of-line virtual destructor as the key function.
29 RuntimeDyldImpl::~RuntimeDyldImpl() {}
30
31 // Pin LoadedObjectInfo's vtables to this file.
32 void RuntimeDyld::LoadedObjectInfo::anchor() {}
33
34 namespace llvm {
35
36 void RuntimeDyldImpl::registerEHFrames() {}
37
38 void RuntimeDyldImpl::deregisterEHFrames() {}
39
40 #ifndef NDEBUG
41 static void dumpSectionMemory(const SectionEntry &S, StringRef State) {
42   dbgs() << "----- Contents of section " << S.Name << " " << State << " -----";
43
44   if (S.Address == nullptr) {
45     dbgs() << "\n          <section not emitted>\n";
46     return;
47   }
48
49   const unsigned ColsPerRow = 16;
50
51   uint8_t *DataAddr = S.Address;
52   uint64_t LoadAddr = S.LoadAddress;
53
54   unsigned StartPadding = LoadAddr & (ColsPerRow - 1);
55   unsigned BytesRemaining = S.Size;
56
57   if (StartPadding) {
58     dbgs() << "\n" << format("0x%016" PRIx64, LoadAddr & ~(ColsPerRow - 1)) << ":";
59     while (StartPadding--)
60       dbgs() << "   ";
61   }
62
63   while (BytesRemaining > 0) {
64     if ((LoadAddr & (ColsPerRow - 1)) == 0)
65       dbgs() << "\n" << format("0x%016" PRIx64, LoadAddr) << ":";
66
67     dbgs() << " " << format("%02x", *DataAddr);
68
69     ++DataAddr;
70     ++LoadAddr;
71     --BytesRemaining;
72   }
73
74   dbgs() << "\n";
75 }
76 #endif
77
78 // Resolve the relocations for all symbols we currently know about.
79 void RuntimeDyldImpl::resolveRelocations() {
80   MutexGuard locked(lock);
81
82   // First, resolve relocations associated with external symbols.
83   resolveExternalSymbols();
84
85   // Just iterate over the sections we have and resolve all the relocations
86   // in them. Gross overkill, but it gets the job done.
87   for (int i = 0, e = Sections.size(); i != e; ++i) {
88     // The Section here (Sections[i]) refers to the section in which the
89     // symbol for the relocation is located.  The SectionID in the relocation
90     // entry provides the section to which the relocation will be applied.
91     uint64_t Addr = Sections[i].LoadAddress;
92     DEBUG(dbgs() << "Resolving relocations Section #" << i << "\t"
93                  << format("0x%x", Addr) << "\n");
94     DEBUG(dumpSectionMemory(Sections[i], "before relocations"));
95     resolveRelocationList(Relocations[i], Addr);
96     DEBUG(dumpSectionMemory(Sections[i], "after relocations"));
97     Relocations.erase(i);
98   }
99 }
100
101 void RuntimeDyldImpl::mapSectionAddress(const void *LocalAddress,
102                                         uint64_t TargetAddress) {
103   MutexGuard locked(lock);
104   for (unsigned i = 0, e = Sections.size(); i != e; ++i) {
105     if (Sections[i].Address == LocalAddress) {
106       reassignSectionAddress(i, TargetAddress);
107       return;
108     }
109   }
110   llvm_unreachable("Attempting to remap address of unknown section!");
111 }
112
113 static std::error_code getOffset(const SymbolRef &Sym, uint64_t &Result) {
114   uint64_t Address;
115   if (std::error_code EC = Sym.getAddress(Address))
116     return EC;
117
118   if (Address == UnknownAddressOrSize) {
119     Result = UnknownAddressOrSize;
120     return object_error::success;
121   }
122
123   const ObjectFile *Obj = Sym.getObject();
124   section_iterator SecI(Obj->section_begin());
125   if (std::error_code EC = Sym.getSection(SecI))
126     return EC;
127
128   if (SecI == Obj->section_end()) {
129     Result = UnknownAddressOrSize;
130     return object_error::success;
131   }
132
133   uint64_t SectionAddress = SecI->getAddress();
134   Result = Address - SectionAddress;
135   return object_error::success;
136 }
137
138 std::pair<unsigned, unsigned>
139 RuntimeDyldImpl::loadObjectImpl(const object::ObjectFile &Obj) {
140   MutexGuard locked(lock);
141
142   // Grab the first Section ID. We'll use this later to construct the underlying
143   // range for the returned LoadedObjectInfo.
144   unsigned SectionsAddedBeginIdx = Sections.size();
145
146   // Save information about our target
147   Arch = (Triple::ArchType)Obj.getArch();
148   IsTargetLittleEndian = Obj.isLittleEndian();
149
150   // Compute the memory size required to load all sections to be loaded
151   // and pass this information to the memory manager
152   if (MemMgr->needsToReserveAllocationSpace()) {
153     uint64_t CodeSize = 0, DataSizeRO = 0, DataSizeRW = 0;
154     computeTotalAllocSize(Obj, CodeSize, DataSizeRO, DataSizeRW);
155     MemMgr->reserveAllocationSpace(CodeSize, DataSizeRO, DataSizeRW);
156   }
157
158   // Used sections from the object file
159   ObjSectionToIDMap LocalSections;
160
161   // Common symbols requiring allocation, with their sizes and alignments
162   CommonSymbolMap CommonSymbols;
163   // Maximum required total memory to allocate all common symbols
164   uint64_t CommonSize = 0;
165
166   // Parse symbols
167   DEBUG(dbgs() << "Parse symbols:\n");
168   for (symbol_iterator I = Obj.symbol_begin(), E = Obj.symbol_end(); I != E;
169        ++I) {
170     object::SymbolRef::Type SymType;
171     StringRef Name;
172     Check(I->getType(SymType));
173     Check(I->getName(Name));
174
175     uint32_t Flags = I->getFlags();
176
177     bool IsCommon = Flags & SymbolRef::SF_Common;
178     if (IsCommon) {
179       // Add the common symbols to a list.  We'll allocate them all below.
180       if (!GlobalSymbolTable.count(Name)) {
181         uint32_t Align;
182         Check(I->getAlignment(Align));
183         uint64_t Size = 0;
184         Check(I->getSize(Size));
185         CommonSize += Size + Align;
186         CommonSymbols[*I] = CommonSymbolInfo(Size, Align);
187       }
188     } else {
189       if (SymType == object::SymbolRef::ST_Function ||
190           SymType == object::SymbolRef::ST_Data ||
191           SymType == object::SymbolRef::ST_Unknown) {
192         uint64_t SectOffset;
193         StringRef SectionData;
194         section_iterator SI = Obj.section_end();
195         Check(getOffset(*I, SectOffset));
196         Check(I->getSection(SI));
197         if (SI == Obj.section_end())
198           continue;
199         Check(SI->getContents(SectionData));
200         bool IsCode = SI->isText();
201         unsigned SectionID =
202             findOrEmitSection(Obj, *SI, IsCode, LocalSections);
203         DEBUG(dbgs() << "\tOffset: " << format("%p", (uintptr_t)SectOffset)
204                      << " flags: " << Flags << " SID: " << SectionID);
205         GlobalSymbolTable[Name] = SymbolLoc(SectionID, SectOffset);
206       }
207     }
208     DEBUG(dbgs() << "\tType: " << SymType << " Name: " << Name << "\n");
209   }
210
211   // Allocate common symbols
212   if (CommonSize != 0)
213     emitCommonSymbols(Obj, CommonSymbols, CommonSize, GlobalSymbolTable);
214
215   // Parse and process relocations
216   DEBUG(dbgs() << "Parse relocations:\n");
217   for (section_iterator SI = Obj.section_begin(), SE = Obj.section_end();
218        SI != SE; ++SI) {
219     unsigned SectionID = 0;
220     StubMap Stubs;
221     section_iterator RelocatedSection = SI->getRelocatedSection();
222
223     relocation_iterator I = SI->relocation_begin();
224     relocation_iterator E = SI->relocation_end();
225
226     if (I == E && !ProcessAllSections)
227       continue;
228
229     bool IsCode = RelocatedSection->isText();
230     SectionID =
231         findOrEmitSection(Obj, *RelocatedSection, IsCode, LocalSections);
232     DEBUG(dbgs() << "\tSectionID: " << SectionID << "\n");
233
234     for (; I != E;)
235       I = processRelocationRef(SectionID, I, Obj, LocalSections, Stubs);
236
237     // If there is an attached checker, notify it about the stubs for this
238     // section so that they can be verified.
239     if (Checker)
240       Checker->registerStubMap(Obj.getFileName(), SectionID, Stubs);
241   }
242
243   // Give the subclasses a chance to tie-up any loose ends.
244   finalizeLoad(Obj, LocalSections);
245
246   unsigned SectionsAddedEndIdx = Sections.size();
247
248   return std::make_pair(SectionsAddedBeginIdx, SectionsAddedEndIdx);
249 }
250
251 // A helper method for computeTotalAllocSize.
252 // Computes the memory size required to allocate sections with the given sizes,
253 // assuming that all sections are allocated with the given alignment
254 static uint64_t
255 computeAllocationSizeForSections(std::vector<uint64_t> &SectionSizes,
256                                  uint64_t Alignment) {
257   uint64_t TotalSize = 0;
258   for (size_t Idx = 0, Cnt = SectionSizes.size(); Idx < Cnt; Idx++) {
259     uint64_t AlignedSize =
260         (SectionSizes[Idx] + Alignment - 1) / Alignment * Alignment;
261     TotalSize += AlignedSize;
262   }
263   return TotalSize;
264 }
265
266 // Compute an upper bound of the memory size that is required to load all
267 // sections
268 void RuntimeDyldImpl::computeTotalAllocSize(const ObjectFile &Obj,
269                                             uint64_t &CodeSize,
270                                             uint64_t &DataSizeRO,
271                                             uint64_t &DataSizeRW) {
272   // Compute the size of all sections required for execution
273   std::vector<uint64_t> CodeSectionSizes;
274   std::vector<uint64_t> ROSectionSizes;
275   std::vector<uint64_t> RWSectionSizes;
276   uint64_t MaxAlignment = sizeof(void *);
277
278   // Collect sizes of all sections to be loaded;
279   // also determine the max alignment of all sections
280   for (section_iterator SI = Obj.section_begin(), SE = Obj.section_end();
281        SI != SE; ++SI) {
282     const SectionRef &Section = *SI;
283
284     bool IsRequired = Section.isRequiredForExecution();
285
286     // Consider only the sections that are required to be loaded for execution
287     if (IsRequired) {
288       StringRef Name;
289       uint64_t DataSize = Section.getSize();
290       uint64_t Alignment64 = Section.getAlignment();
291       bool IsCode = Section.isText();
292       bool IsReadOnly = Section.isReadOnlyData();
293       Check(Section.getName(Name));
294       unsigned Alignment = (unsigned)Alignment64 & 0xffffffffL;
295
296       uint64_t StubBufSize = computeSectionStubBufSize(Obj, Section);
297       uint64_t SectionSize = DataSize + StubBufSize;
298
299       // The .eh_frame section (at least on Linux) needs an extra four bytes
300       // padded
301       // with zeroes added at the end.  For MachO objects, this section has a
302       // slightly different name, so this won't have any effect for MachO
303       // objects.
304       if (Name == ".eh_frame")
305         SectionSize += 4;
306
307       if (SectionSize > 0) {
308         // save the total size of the section
309         if (IsCode) {
310           CodeSectionSizes.push_back(SectionSize);
311         } else if (IsReadOnly) {
312           ROSectionSizes.push_back(SectionSize);
313         } else {
314           RWSectionSizes.push_back(SectionSize);
315         }
316         // update the max alignment
317         if (Alignment > MaxAlignment) {
318           MaxAlignment = Alignment;
319         }
320       }
321     }
322   }
323
324   // Compute the size of all common symbols
325   uint64_t CommonSize = 0;
326   for (symbol_iterator I = Obj.symbol_begin(), E = Obj.symbol_end(); I != E;
327        ++I) {
328     uint32_t Flags = I->getFlags();
329     if (Flags & SymbolRef::SF_Common) {
330       // Add the common symbols to a list.  We'll allocate them all below.
331       uint64_t Size = 0;
332       Check(I->getSize(Size));
333       CommonSize += Size;
334     }
335   }
336   if (CommonSize != 0) {
337     RWSectionSizes.push_back(CommonSize);
338   }
339
340   // Compute the required allocation space for each different type of sections
341   // (code, read-only data, read-write data) assuming that all sections are
342   // allocated with the max alignment. Note that we cannot compute with the
343   // individual alignments of the sections, because then the required size
344   // depends on the order, in which the sections are allocated.
345   CodeSize = computeAllocationSizeForSections(CodeSectionSizes, MaxAlignment);
346   DataSizeRO = computeAllocationSizeForSections(ROSectionSizes, MaxAlignment);
347   DataSizeRW = computeAllocationSizeForSections(RWSectionSizes, MaxAlignment);
348 }
349
350 // compute stub buffer size for the given section
351 unsigned RuntimeDyldImpl::computeSectionStubBufSize(const ObjectFile &Obj,
352                                                     const SectionRef &Section) {
353   unsigned StubSize = getMaxStubSize();
354   if (StubSize == 0) {
355     return 0;
356   }
357   // FIXME: this is an inefficient way to handle this. We should computed the
358   // necessary section allocation size in loadObject by walking all the sections
359   // once.
360   unsigned StubBufSize = 0;
361   for (section_iterator SI = Obj.section_begin(), SE = Obj.section_end();
362        SI != SE; ++SI) {
363     section_iterator RelSecI = SI->getRelocatedSection();
364     if (!(RelSecI == Section))
365       continue;
366
367     for (const RelocationRef &Reloc : SI->relocations()) {
368       (void)Reloc;
369       StubBufSize += StubSize;
370     }
371   }
372
373   // Get section data size and alignment
374   uint64_t DataSize = Section.getSize();
375   uint64_t Alignment64 = Section.getAlignment();
376
377   // Add stubbuf size alignment
378   unsigned Alignment = (unsigned)Alignment64 & 0xffffffffL;
379   unsigned StubAlignment = getStubAlignment();
380   unsigned EndAlignment = (DataSize | Alignment) & -(DataSize | Alignment);
381   if (StubAlignment > EndAlignment)
382     StubBufSize += StubAlignment - EndAlignment;
383   return StubBufSize;
384 }
385
386 uint64_t RuntimeDyldImpl::readBytesUnaligned(uint8_t *Src,
387                                              unsigned Size) const {
388   uint64_t Result = 0;
389   if (IsTargetLittleEndian) {
390     Src += Size - 1;
391     while (Size--)
392       Result = (Result << 8) | *Src--;
393   } else
394     while (Size--)
395       Result = (Result << 8) | *Src++;
396
397   return Result;
398 }
399
400 void RuntimeDyldImpl::writeBytesUnaligned(uint64_t Value, uint8_t *Dst,
401                                           unsigned Size) const {
402   if (IsTargetLittleEndian) {
403     while (Size--) {
404       *Dst++ = Value & 0xFF;
405       Value >>= 8;
406     }
407   } else {
408     Dst += Size - 1;
409     while (Size--) {
410       *Dst-- = Value & 0xFF;
411       Value >>= 8;
412     }
413   }
414 }
415
416 void RuntimeDyldImpl::emitCommonSymbols(const ObjectFile &Obj,
417                                         const CommonSymbolMap &CommonSymbols,
418                                         uint64_t TotalSize,
419                                         SymbolTableMap &SymbolTable) {
420   // Allocate memory for the section
421   unsigned SectionID = Sections.size();
422   uint8_t *Addr = MemMgr->allocateDataSection(TotalSize, sizeof(void *),
423                                               SectionID, StringRef(), false);
424   if (!Addr)
425     report_fatal_error("Unable to allocate memory for common symbols!");
426   uint64_t Offset = 0;
427   Sections.push_back(SectionEntry("<common symbols>", Addr, TotalSize, 0));
428   memset(Addr, 0, TotalSize);
429
430   DEBUG(dbgs() << "emitCommonSection SectionID: " << SectionID << " new addr: "
431                << format("%p", Addr) << " DataSize: " << TotalSize << "\n");
432
433   // Assign the address of each symbol
434   for (CommonSymbolMap::const_iterator it = CommonSymbols.begin(),
435        itEnd = CommonSymbols.end(); it != itEnd; ++it) {
436     uint64_t Size = it->second.first;
437     uint64_t Align = it->second.second;
438     StringRef Name;
439     it->first.getName(Name);
440     if (Align) {
441       // This symbol has an alignment requirement.
442       uint64_t AlignOffset = OffsetToAlignment((uint64_t)Addr, Align);
443       Addr += AlignOffset;
444       Offset += AlignOffset;
445       DEBUG(dbgs() << "Allocating common symbol " << Name << " address "
446                    << format("%p\n", Addr));
447     }
448     SymbolTable[Name.data()] = SymbolLoc(SectionID, Offset);
449     Offset += Size;
450     Addr += Size;
451   }
452 }
453
454 unsigned RuntimeDyldImpl::emitSection(const ObjectFile &Obj,
455                                       const SectionRef &Section, bool IsCode) {
456
457   StringRef data;
458   Check(Section.getContents(data));
459   uint64_t Alignment64 = Section.getAlignment();
460
461   unsigned Alignment = (unsigned)Alignment64 & 0xffffffffL;
462   unsigned PaddingSize = 0;
463   unsigned StubBufSize = 0;
464   StringRef Name;
465   bool IsRequired = Section.isRequiredForExecution();
466   bool IsVirtual = Section.isVirtual();
467   bool IsZeroInit = Section.isZeroInit();
468   bool IsReadOnly = Section.isReadOnlyData();
469   uint64_t DataSize = Section.getSize();
470   Check(Section.getName(Name));
471
472   StubBufSize = computeSectionStubBufSize(Obj, Section);
473
474   // The .eh_frame section (at least on Linux) needs an extra four bytes padded
475   // with zeroes added at the end.  For MachO objects, this section has a
476   // slightly different name, so this won't have any effect for MachO objects.
477   if (Name == ".eh_frame")
478     PaddingSize = 4;
479
480   uintptr_t Allocate;
481   unsigned SectionID = Sections.size();
482   uint8_t *Addr;
483   const char *pData = nullptr;
484
485   // Some sections, such as debug info, don't need to be loaded for execution.
486   // Leave those where they are.
487   if (IsRequired) {
488     Allocate = DataSize + PaddingSize + StubBufSize;
489     Addr = IsCode ? MemMgr->allocateCodeSection(Allocate, Alignment, SectionID,
490                                                 Name)
491                   : MemMgr->allocateDataSection(Allocate, Alignment, SectionID,
492                                                 Name, IsReadOnly);
493     if (!Addr)
494       report_fatal_error("Unable to allocate section memory!");
495
496     // Virtual sections have no data in the object image, so leave pData = 0
497     if (!IsVirtual)
498       pData = data.data();
499
500     // Zero-initialize or copy the data from the image
501     if (IsZeroInit || IsVirtual)
502       memset(Addr, 0, DataSize);
503     else
504       memcpy(Addr, pData, DataSize);
505
506     // Fill in any extra bytes we allocated for padding
507     if (PaddingSize != 0) {
508       memset(Addr + DataSize, 0, PaddingSize);
509       // Update the DataSize variable so that the stub offset is set correctly.
510       DataSize += PaddingSize;
511     }
512
513     DEBUG(dbgs() << "emitSection SectionID: " << SectionID << " Name: " << Name
514                  << " obj addr: " << format("%p", pData)
515                  << " new addr: " << format("%p", Addr)
516                  << " DataSize: " << DataSize << " StubBufSize: " << StubBufSize
517                  << " Allocate: " << Allocate << "\n");
518   } else {
519     // Even if we didn't load the section, we need to record an entry for it
520     // to handle later processing (and by 'handle' I mean don't do anything
521     // with these sections).
522     Allocate = 0;
523     Addr = nullptr;
524     DEBUG(dbgs() << "emitSection SectionID: " << SectionID << " Name: " << Name
525                  << " obj addr: " << format("%p", data.data()) << " new addr: 0"
526                  << " DataSize: " << DataSize << " StubBufSize: " << StubBufSize
527                  << " Allocate: " << Allocate << "\n");
528   }
529
530   Sections.push_back(SectionEntry(Name, Addr, DataSize, (uintptr_t)pData));
531
532   if (Checker)
533     Checker->registerSection(Obj.getFileName(), SectionID);
534
535   return SectionID;
536 }
537
538 unsigned RuntimeDyldImpl::findOrEmitSection(const ObjectFile &Obj,
539                                             const SectionRef &Section,
540                                             bool IsCode,
541                                             ObjSectionToIDMap &LocalSections) {
542
543   unsigned SectionID = 0;
544   ObjSectionToIDMap::iterator i = LocalSections.find(Section);
545   if (i != LocalSections.end())
546     SectionID = i->second;
547   else {
548     SectionID = emitSection(Obj, Section, IsCode);
549     LocalSections[Section] = SectionID;
550   }
551   return SectionID;
552 }
553
554 void RuntimeDyldImpl::addRelocationForSection(const RelocationEntry &RE,
555                                               unsigned SectionID) {
556   Relocations[SectionID].push_back(RE);
557 }
558
559 void RuntimeDyldImpl::addRelocationForSymbol(const RelocationEntry &RE,
560                                              StringRef SymbolName) {
561   // Relocation by symbol.  If the symbol is found in the global symbol table,
562   // create an appropriate section relocation.  Otherwise, add it to
563   // ExternalSymbolRelocations.
564   SymbolTableMap::const_iterator Loc = GlobalSymbolTable.find(SymbolName);
565   if (Loc == GlobalSymbolTable.end()) {
566     ExternalSymbolRelocations[SymbolName].push_back(RE);
567   } else {
568     // Copy the RE since we want to modify its addend.
569     RelocationEntry RECopy = RE;
570     RECopy.Addend += Loc->second.second;
571     Relocations[Loc->second.first].push_back(RECopy);
572   }
573 }
574
575 uint8_t *RuntimeDyldImpl::createStubFunction(uint8_t *Addr,
576                                              unsigned AbiVariant) {
577   if (Arch == Triple::aarch64 || Arch == Triple::aarch64_be) {
578     // This stub has to be able to access the full address space,
579     // since symbol lookup won't necessarily find a handy, in-range,
580     // PLT stub for functions which could be anywhere.
581     // Stub can use ip0 (== x16) to calculate address
582     writeBytesUnaligned(0xd2e00010, Addr,    4); // movz ip0, #:abs_g3:<addr>
583     writeBytesUnaligned(0xf2c00010, Addr+4,  4); // movk ip0, #:abs_g2_nc:<addr>
584     writeBytesUnaligned(0xf2a00010, Addr+8,  4); // movk ip0, #:abs_g1_nc:<addr>
585     writeBytesUnaligned(0xf2800010, Addr+12, 4); // movk ip0, #:abs_g0_nc:<addr>
586     writeBytesUnaligned(0xd61f0200, Addr+16, 4); // br ip0
587
588     return Addr;
589   } else if (Arch == Triple::arm || Arch == Triple::armeb) {
590     // TODO: There is only ARM far stub now. We should add the Thumb stub,
591     // and stubs for branches Thumb - ARM and ARM - Thumb.
592     writeBytesUnaligned(0xe51ff004, Addr, 4); // ldr pc,<label>
593     return Addr + 4;
594   } else if (Arch == Triple::mipsel || Arch == Triple::mips) {
595     // 0:   3c190000        lui     t9,%hi(addr).
596     // 4:   27390000        addiu   t9,t9,%lo(addr).
597     // 8:   03200008        jr      t9.
598     // c:   00000000        nop.
599     const unsigned LuiT9Instr = 0x3c190000, AdduiT9Instr = 0x27390000;
600     const unsigned JrT9Instr = 0x03200008, NopInstr = 0x0;
601
602     writeBytesUnaligned(LuiT9Instr, Addr, 4);
603     writeBytesUnaligned(AdduiT9Instr, Addr+4, 4);
604     writeBytesUnaligned(JrT9Instr, Addr+8, 4);
605     writeBytesUnaligned(NopInstr, Addr+12, 4);
606     return Addr;
607   } else if (Arch == Triple::ppc64 || Arch == Triple::ppc64le) {
608     // Depending on which version of the ELF ABI is in use, we need to
609     // generate one of two variants of the stub.  They both start with
610     // the same sequence to load the target address into r12.
611     writeInt32BE(Addr,    0x3D800000); // lis   r12, highest(addr)
612     writeInt32BE(Addr+4,  0x618C0000); // ori   r12, higher(addr)
613     writeInt32BE(Addr+8,  0x798C07C6); // sldi  r12, r12, 32
614     writeInt32BE(Addr+12, 0x658C0000); // oris  r12, r12, h(addr)
615     writeInt32BE(Addr+16, 0x618C0000); // ori   r12, r12, l(addr)
616     if (AbiVariant == 2) {
617       // PowerPC64 stub ELFv2 ABI: The address points to the function itself.
618       // The address is already in r12 as required by the ABI.  Branch to it.
619       writeInt32BE(Addr+20, 0xF8410018); // std   r2,  24(r1)
620       writeInt32BE(Addr+24, 0x7D8903A6); // mtctr r12
621       writeInt32BE(Addr+28, 0x4E800420); // bctr
622     } else {
623       // PowerPC64 stub ELFv1 ABI: The address points to a function descriptor.
624       // Load the function address on r11 and sets it to control register. Also
625       // loads the function TOC in r2 and environment pointer to r11.
626       writeInt32BE(Addr+20, 0xF8410028); // std   r2,  40(r1)
627       writeInt32BE(Addr+24, 0xE96C0000); // ld    r11, 0(r12)
628       writeInt32BE(Addr+28, 0xE84C0008); // ld    r2,  0(r12)
629       writeInt32BE(Addr+32, 0x7D6903A6); // mtctr r11
630       writeInt32BE(Addr+36, 0xE96C0010); // ld    r11, 16(r2)
631       writeInt32BE(Addr+40, 0x4E800420); // bctr
632     }
633     return Addr;
634   } else if (Arch == Triple::systemz) {
635     writeInt16BE(Addr,    0xC418);     // lgrl %r1,.+8
636     writeInt16BE(Addr+2,  0x0000);
637     writeInt16BE(Addr+4,  0x0004);
638     writeInt16BE(Addr+6,  0x07F1);     // brc 15,%r1
639     // 8-byte address stored at Addr + 8
640     return Addr;
641   } else if (Arch == Triple::x86_64) {
642     *Addr      = 0xFF; // jmp
643     *(Addr+1)  = 0x25; // rip
644     // 32-bit PC-relative address of the GOT entry will be stored at Addr+2
645   } else if (Arch == Triple::x86) {
646     *Addr      = 0xE9; // 32-bit pc-relative jump.
647   }
648   return Addr;
649 }
650
651 // Assign an address to a symbol name and resolve all the relocations
652 // associated with it.
653 void RuntimeDyldImpl::reassignSectionAddress(unsigned SectionID,
654                                              uint64_t Addr) {
655   // The address to use for relocation resolution is not
656   // the address of the local section buffer. We must be doing
657   // a remote execution environment of some sort. Relocations can't
658   // be applied until all the sections have been moved.  The client must
659   // trigger this with a call to MCJIT::finalize() or
660   // RuntimeDyld::resolveRelocations().
661   //
662   // Addr is a uint64_t because we can't assume the pointer width
663   // of the target is the same as that of the host. Just use a generic
664   // "big enough" type.
665   DEBUG(dbgs() << "Reassigning address for section "
666                << SectionID << " (" << Sections[SectionID].Name << "): "
667                << format("0x%016" PRIx64, Sections[SectionID].LoadAddress) << " -> "
668                << format("0x%016" PRIx64, Addr) << "\n");
669   Sections[SectionID].LoadAddress = Addr;
670 }
671
672 void RuntimeDyldImpl::resolveRelocationList(const RelocationList &Relocs,
673                                             uint64_t Value) {
674   for (unsigned i = 0, e = Relocs.size(); i != e; ++i) {
675     const RelocationEntry &RE = Relocs[i];
676     // Ignore relocations for sections that were not loaded
677     if (Sections[RE.SectionID].Address == nullptr)
678       continue;
679     resolveRelocation(RE, Value);
680   }
681 }
682
683 void RuntimeDyldImpl::resolveExternalSymbols() {
684   while (!ExternalSymbolRelocations.empty()) {
685     StringMap<RelocationList>::iterator i = ExternalSymbolRelocations.begin();
686
687     StringRef Name = i->first();
688     if (Name.size() == 0) {
689       // This is an absolute symbol, use an address of zero.
690       DEBUG(dbgs() << "Resolving absolute relocations."
691                    << "\n");
692       RelocationList &Relocs = i->second;
693       resolveRelocationList(Relocs, 0);
694     } else {
695       uint64_t Addr = 0;
696       SymbolTableMap::const_iterator Loc = GlobalSymbolTable.find(Name);
697       if (Loc == GlobalSymbolTable.end()) {
698         // This is an external symbol, try to get its address from
699         // MemoryManager.
700         Addr = MemMgr->getSymbolAddress(Name.data());
701         // The call to getSymbolAddress may have caused additional modules to
702         // be loaded, which may have added new entries to the
703         // ExternalSymbolRelocations map.  Consquently, we need to update our
704         // iterator.  This is also why retrieval of the relocation list
705         // associated with this symbol is deferred until below this point.
706         // New entries may have been added to the relocation list.
707         i = ExternalSymbolRelocations.find(Name);
708       } else {
709         // We found the symbol in our global table.  It was probably in a
710         // Module that we loaded previously.
711         SymbolLoc SymLoc = Loc->second;
712         Addr = getSectionLoadAddress(SymLoc.first) + SymLoc.second;
713       }
714
715       // FIXME: Implement error handling that doesn't kill the host program!
716       if (!Addr)
717         report_fatal_error("Program used external function '" + Name +
718                            "' which could not be resolved!");
719
720       updateGOTEntries(Name, Addr);
721       DEBUG(dbgs() << "Resolving relocations Name: " << Name << "\t"
722                    << format("0x%lx", Addr) << "\n");
723       // This list may have been updated when we called getSymbolAddress, so
724       // don't change this code to get the list earlier.
725       RelocationList &Relocs = i->second;
726       resolveRelocationList(Relocs, Addr);
727     }
728
729     ExternalSymbolRelocations.erase(i);
730   }
731 }
732
733 //===----------------------------------------------------------------------===//
734 // RuntimeDyld class implementation
735
736 uint64_t RuntimeDyld::LoadedObjectInfo::getSectionLoadAddress(
737                                                   StringRef SectionName) const {
738   for (unsigned I = BeginIdx; I != EndIdx; ++I)
739     if (RTDyld.Sections[I].Name == SectionName)
740       return RTDyld.Sections[I].LoadAddress;
741
742   return 0;
743 }
744
745 RuntimeDyld::RuntimeDyld(RTDyldMemoryManager *mm) {
746   // FIXME: There's a potential issue lurking here if a single instance of
747   // RuntimeDyld is used to load multiple objects.  The current implementation
748   // associates a single memory manager with a RuntimeDyld instance.  Even
749   // though the public class spawns a new 'impl' instance for each load,
750   // they share a single memory manager.  This can become a problem when page
751   // permissions are applied.
752   Dyld = nullptr;
753   MM = mm;
754   ProcessAllSections = false;
755   Checker = nullptr;
756 }
757
758 RuntimeDyld::~RuntimeDyld() {}
759
760 static std::unique_ptr<RuntimeDyldELF>
761 createRuntimeDyldELF(RTDyldMemoryManager *MM, bool ProcessAllSections,
762                      RuntimeDyldCheckerImpl *Checker) {
763   std::unique_ptr<RuntimeDyldELF> Dyld(new RuntimeDyldELF(MM));
764   Dyld->setProcessAllSections(ProcessAllSections);
765   Dyld->setRuntimeDyldChecker(Checker);
766   return Dyld;
767 }
768
769 static std::unique_ptr<RuntimeDyldMachO>
770 createRuntimeDyldMachO(Triple::ArchType Arch, RTDyldMemoryManager *MM,
771                        bool ProcessAllSections, RuntimeDyldCheckerImpl *Checker) {
772   std::unique_ptr<RuntimeDyldMachO> Dyld(RuntimeDyldMachO::create(Arch, MM));
773   Dyld->setProcessAllSections(ProcessAllSections);
774   Dyld->setRuntimeDyldChecker(Checker);
775   return Dyld;
776 }
777
778 std::unique_ptr<RuntimeDyld::LoadedObjectInfo>
779 RuntimeDyld::loadObject(const ObjectFile &Obj) {
780   if (!Dyld) {
781     if (Obj.isELF())
782       Dyld = createRuntimeDyldELF(MM, ProcessAllSections, Checker);
783     else if (Obj.isMachO())
784       Dyld = createRuntimeDyldMachO(
785                static_cast<Triple::ArchType>(Obj.getArch()), MM,
786                ProcessAllSections, Checker);
787     else
788       report_fatal_error("Incompatible object format!");
789   }
790
791   if (!Dyld->isCompatibleFile(Obj))
792     report_fatal_error("Incompatible object format!");
793
794   return Dyld->loadObject(Obj);
795 }
796
797 void *RuntimeDyld::getSymbolAddress(StringRef Name) const {
798   if (!Dyld)
799     return nullptr;
800   return Dyld->getSymbolAddress(Name);
801 }
802
803 uint64_t RuntimeDyld::getSymbolLoadAddress(StringRef Name) const {
804   if (!Dyld)
805     return 0;
806   return Dyld->getSymbolLoadAddress(Name);
807 }
808
809 void RuntimeDyld::resolveRelocations() { Dyld->resolveRelocations(); }
810
811 void RuntimeDyld::reassignSectionAddress(unsigned SectionID, uint64_t Addr) {
812   Dyld->reassignSectionAddress(SectionID, Addr);
813 }
814
815 void RuntimeDyld::mapSectionAddress(const void *LocalAddress,
816                                     uint64_t TargetAddress) {
817   Dyld->mapSectionAddress(LocalAddress, TargetAddress);
818 }
819
820 bool RuntimeDyld::hasError() { return Dyld->hasError(); }
821
822 StringRef RuntimeDyld::getErrorString() { return Dyld->getErrorString(); }
823
824 void RuntimeDyld::registerEHFrames() {
825   if (Dyld)
826     Dyld->registerEHFrames();
827 }
828
829 void RuntimeDyld::deregisterEHFrames() {
830   if (Dyld)
831     Dyld->deregisterEHFrames();
832 }
833
834 } // end namespace llvm