Convert getSymbolSection to return an ErrorOr.
[oota-llvm.git] / lib / ExecutionEngine / RuntimeDyld / RuntimeDyldELF.cpp
1 //===-- RuntimeDyldELF.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 ELF support for the MC-JIT runtime dynamic linker.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "RuntimeDyldELF.h"
15 #include "RuntimeDyldCheckerImpl.h"
16 #include "llvm/ADT/IntervalMap.h"
17 #include "llvm/ADT/STLExtras.h"
18 #include "llvm/ADT/StringRef.h"
19 #include "llvm/ADT/Triple.h"
20 #include "llvm/MC/MCStreamer.h"
21 #include "llvm/Object/ELFObjectFile.h"
22 #include "llvm/Object/ObjectFile.h"
23 #include "llvm/Support/ELF.h"
24 #include "llvm/Support/Endian.h"
25 #include "llvm/Support/MemoryBuffer.h"
26 #include "llvm/Support/TargetRegistry.h"
27
28 using namespace llvm;
29 using namespace llvm::object;
30
31 #define DEBUG_TYPE "dyld"
32
33 static inline std::error_code check(std::error_code Err) {
34   if (Err) {
35     report_fatal_error(Err.message());
36   }
37   return Err;
38 }
39
40 namespace {
41
42 template <class ELFT> class DyldELFObject : public ELFObjectFile<ELFT> {
43   LLVM_ELF_IMPORT_TYPES_ELFT(ELFT)
44
45   typedef Elf_Shdr_Impl<ELFT> Elf_Shdr;
46   typedef Elf_Sym_Impl<ELFT> Elf_Sym;
47   typedef Elf_Rel_Impl<ELFT, false> Elf_Rel;
48   typedef Elf_Rel_Impl<ELFT, true> Elf_Rela;
49
50   typedef Elf_Ehdr_Impl<ELFT> Elf_Ehdr;
51
52   typedef typename ELFDataTypeTypedefHelper<ELFT>::value_type addr_type;
53
54 public:
55   DyldELFObject(MemoryBufferRef Wrapper, std::error_code &ec);
56
57   void updateSectionAddress(const SectionRef &Sec, uint64_t Addr);
58
59   void updateSymbolAddress(const SymbolRef &SymRef, uint64_t Addr);
60
61   // Methods for type inquiry through isa, cast and dyn_cast
62   static inline bool classof(const Binary *v) {
63     return (isa<ELFObjectFile<ELFT>>(v) &&
64             classof(cast<ELFObjectFile<ELFT>>(v)));
65   }
66   static inline bool classof(const ELFObjectFile<ELFT> *v) {
67     return v->isDyldType();
68   }
69
70 };
71
72
73
74 // The MemoryBuffer passed into this constructor is just a wrapper around the
75 // actual memory.  Ultimately, the Binary parent class will take ownership of
76 // this MemoryBuffer object but not the underlying memory.
77 template <class ELFT>
78 DyldELFObject<ELFT>::DyldELFObject(MemoryBufferRef Wrapper, std::error_code &EC)
79     : ELFObjectFile<ELFT>(Wrapper, EC) {
80   this->isDyldELFObject = true;
81 }
82
83 template <class ELFT>
84 void DyldELFObject<ELFT>::updateSectionAddress(const SectionRef &Sec,
85                                                uint64_t Addr) {
86   DataRefImpl ShdrRef = Sec.getRawDataRefImpl();
87   Elf_Shdr *shdr =
88       const_cast<Elf_Shdr *>(reinterpret_cast<const Elf_Shdr *>(ShdrRef.p));
89
90   // This assumes the address passed in matches the target address bitness
91   // The template-based type cast handles everything else.
92   shdr->sh_addr = static_cast<addr_type>(Addr);
93 }
94
95 template <class ELFT>
96 void DyldELFObject<ELFT>::updateSymbolAddress(const SymbolRef &SymRef,
97                                               uint64_t Addr) {
98
99   Elf_Sym *sym = const_cast<Elf_Sym *>(
100       ELFObjectFile<ELFT>::getSymbol(SymRef.getRawDataRefImpl()));
101
102   // This assumes the address passed in matches the target address bitness
103   // The template-based type cast handles everything else.
104   sym->st_value = static_cast<addr_type>(Addr);
105 }
106
107 class LoadedELFObjectInfo final
108     : public RuntimeDyld::LoadedObjectInfoHelper<LoadedELFObjectInfo> {
109 public:
110   LoadedELFObjectInfo(RuntimeDyldImpl &RTDyld, ObjSectionToIDMap ObjSecToIDMap)
111       : LoadedObjectInfoHelper(RTDyld, std::move(ObjSecToIDMap)) {}
112
113   OwningBinary<ObjectFile>
114   getObjectForDebug(const ObjectFile &Obj) const override;
115 };
116
117 template <typename ELFT>
118 std::unique_ptr<DyldELFObject<ELFT>>
119 createRTDyldELFObject(MemoryBufferRef Buffer,
120                       const ObjectFile &SourceObject,
121                       const LoadedELFObjectInfo &L,
122                       std::error_code &ec) {
123   typedef typename ELFFile<ELFT>::Elf_Shdr Elf_Shdr;
124   typedef typename ELFDataTypeTypedefHelper<ELFT>::value_type addr_type;
125
126   std::unique_ptr<DyldELFObject<ELFT>> Obj =
127     llvm::make_unique<DyldELFObject<ELFT>>(Buffer, ec);
128
129   // Iterate over all sections in the object.
130   auto SI = SourceObject.section_begin();
131   for (const auto &Sec : Obj->sections()) {
132     StringRef SectionName;
133     Sec.getName(SectionName);
134     if (SectionName != "") {
135       DataRefImpl ShdrRef = Sec.getRawDataRefImpl();
136       Elf_Shdr *shdr = const_cast<Elf_Shdr *>(
137           reinterpret_cast<const Elf_Shdr *>(ShdrRef.p));
138
139       if (uint64_t SecLoadAddr = L.getSectionLoadAddress(*SI)) {
140         // This assumes that the address passed in matches the target address
141         // bitness. The template-based type cast handles everything else.
142         shdr->sh_addr = static_cast<addr_type>(SecLoadAddr);
143       }
144     }
145     ++SI;
146   }
147
148   return Obj;
149 }
150
151 OwningBinary<ObjectFile> createELFDebugObject(const ObjectFile &Obj,
152                                               const LoadedELFObjectInfo &L) {
153   assert(Obj.isELF() && "Not an ELF object file.");
154
155   std::unique_ptr<MemoryBuffer> Buffer =
156     MemoryBuffer::getMemBufferCopy(Obj.getData(), Obj.getFileName());
157
158   std::error_code ec;
159
160   std::unique_ptr<ObjectFile> DebugObj;
161   if (Obj.getBytesInAddress() == 4 && Obj.isLittleEndian()) {
162     typedef ELFType<support::little, false> ELF32LE;
163     DebugObj = createRTDyldELFObject<ELF32LE>(Buffer->getMemBufferRef(), Obj, L,
164                                               ec);
165   } else if (Obj.getBytesInAddress() == 4 && !Obj.isLittleEndian()) {
166     typedef ELFType<support::big, false> ELF32BE;
167     DebugObj = createRTDyldELFObject<ELF32BE>(Buffer->getMemBufferRef(), Obj, L,
168                                               ec);
169   } else if (Obj.getBytesInAddress() == 8 && !Obj.isLittleEndian()) {
170     typedef ELFType<support::big, true> ELF64BE;
171     DebugObj = createRTDyldELFObject<ELF64BE>(Buffer->getMemBufferRef(), Obj, L,
172                                               ec);
173   } else if (Obj.getBytesInAddress() == 8 && Obj.isLittleEndian()) {
174     typedef ELFType<support::little, true> ELF64LE;
175     DebugObj = createRTDyldELFObject<ELF64LE>(Buffer->getMemBufferRef(), Obj, L,
176                                               ec);
177   } else
178     llvm_unreachable("Unexpected ELF format");
179
180   assert(!ec && "Could not construct copy ELF object file");
181
182   return OwningBinary<ObjectFile>(std::move(DebugObj), std::move(Buffer));
183 }
184
185 OwningBinary<ObjectFile>
186 LoadedELFObjectInfo::getObjectForDebug(const ObjectFile &Obj) const {
187   return createELFDebugObject(Obj, *this);
188 }
189
190 } // namespace
191
192 namespace llvm {
193
194 RuntimeDyldELF::RuntimeDyldELF(RuntimeDyld::MemoryManager &MemMgr,
195                                RuntimeDyld::SymbolResolver &Resolver)
196     : RuntimeDyldImpl(MemMgr, Resolver), GOTSectionID(0), CurrentGOTIndex(0) {}
197 RuntimeDyldELF::~RuntimeDyldELF() {}
198
199 void RuntimeDyldELF::registerEHFrames() {
200   for (int i = 0, e = UnregisteredEHFrameSections.size(); i != e; ++i) {
201     SID EHFrameSID = UnregisteredEHFrameSections[i];
202     uint8_t *EHFrameAddr = Sections[EHFrameSID].Address;
203     uint64_t EHFrameLoadAddr = Sections[EHFrameSID].LoadAddress;
204     size_t EHFrameSize = Sections[EHFrameSID].Size;
205     MemMgr.registerEHFrames(EHFrameAddr, EHFrameLoadAddr, EHFrameSize);
206     RegisteredEHFrameSections.push_back(EHFrameSID);
207   }
208   UnregisteredEHFrameSections.clear();
209 }
210
211 void RuntimeDyldELF::deregisterEHFrames() {
212   for (int i = 0, e = RegisteredEHFrameSections.size(); i != e; ++i) {
213     SID EHFrameSID = RegisteredEHFrameSections[i];
214     uint8_t *EHFrameAddr = Sections[EHFrameSID].Address;
215     uint64_t EHFrameLoadAddr = Sections[EHFrameSID].LoadAddress;
216     size_t EHFrameSize = Sections[EHFrameSID].Size;
217     MemMgr.deregisterEHFrames(EHFrameAddr, EHFrameLoadAddr, EHFrameSize);
218   }
219   RegisteredEHFrameSections.clear();
220 }
221
222 std::unique_ptr<RuntimeDyld::LoadedObjectInfo>
223 RuntimeDyldELF::loadObject(const object::ObjectFile &O) {
224   return llvm::make_unique<LoadedELFObjectInfo>(*this, loadObjectImpl(O));
225 }
226
227 void RuntimeDyldELF::resolveX86_64Relocation(const SectionEntry &Section,
228                                              uint64_t Offset, uint64_t Value,
229                                              uint32_t Type, int64_t Addend,
230                                              uint64_t SymOffset) {
231   switch (Type) {
232   default:
233     llvm_unreachable("Relocation type not implemented yet!");
234     break;
235   case ELF::R_X86_64_64: {
236     support::ulittle64_t::ref(Section.Address + Offset) = Value + Addend;
237     DEBUG(dbgs() << "Writing " << format("%p", (Value + Addend)) << " at "
238                  << format("%p\n", Section.Address + Offset));
239     break;
240   }
241   case ELF::R_X86_64_32:
242   case ELF::R_X86_64_32S: {
243     Value += Addend;
244     assert((Type == ELF::R_X86_64_32 && (Value <= UINT32_MAX)) ||
245            (Type == ELF::R_X86_64_32S &&
246             ((int64_t)Value <= INT32_MAX && (int64_t)Value >= INT32_MIN)));
247     uint32_t TruncatedAddr = (Value & 0xFFFFFFFF);
248     support::ulittle32_t::ref(Section.Address + Offset) = TruncatedAddr;
249     DEBUG(dbgs() << "Writing " << format("%p", TruncatedAddr) << " at "
250                  << format("%p\n", Section.Address + Offset));
251     break;
252   }
253   case ELF::R_X86_64_PC32: {
254     uint64_t FinalAddress = Section.LoadAddress + Offset;
255     int64_t RealOffset = Value + Addend - FinalAddress;
256     assert(isInt<32>(RealOffset));
257     int32_t TruncOffset = (RealOffset & 0xFFFFFFFF);
258     support::ulittle32_t::ref(Section.Address + Offset) = TruncOffset;
259     break;
260   }
261   case ELF::R_X86_64_PC64: {
262     uint64_t FinalAddress = Section.LoadAddress + Offset;
263     int64_t RealOffset = Value + Addend - FinalAddress;
264     support::ulittle64_t::ref(Section.Address + Offset) = RealOffset;
265     break;
266   }
267   }
268 }
269
270 void RuntimeDyldELF::resolveX86Relocation(const SectionEntry &Section,
271                                           uint64_t Offset, uint32_t Value,
272                                           uint32_t Type, int32_t Addend) {
273   switch (Type) {
274   case ELF::R_386_32: {
275     support::ulittle32_t::ref(Section.Address + Offset) = Value + Addend;
276     break;
277   }
278   case ELF::R_386_PC32: {
279     uint32_t FinalAddress = ((Section.LoadAddress + Offset) & 0xFFFFFFFF);
280     uint32_t RealOffset = Value + Addend - FinalAddress;
281     support::ulittle32_t::ref(Section.Address + Offset) = RealOffset;
282     break;
283   }
284   default:
285     // There are other relocation types, but it appears these are the
286     // only ones currently used by the LLVM ELF object writer
287     llvm_unreachable("Relocation type not implemented yet!");
288     break;
289   }
290 }
291
292 void RuntimeDyldELF::resolveAArch64Relocation(const SectionEntry &Section,
293                                               uint64_t Offset, uint64_t Value,
294                                               uint32_t Type, int64_t Addend) {
295   uint32_t *TargetPtr = reinterpret_cast<uint32_t *>(Section.Address + Offset);
296   uint64_t FinalAddress = Section.LoadAddress + Offset;
297
298   DEBUG(dbgs() << "resolveAArch64Relocation, LocalAddress: 0x"
299                << format("%llx", Section.Address + Offset)
300                << " FinalAddress: 0x" << format("%llx", FinalAddress)
301                << " Value: 0x" << format("%llx", Value) << " Type: 0x"
302                << format("%x", Type) << " Addend: 0x" << format("%llx", Addend)
303                << "\n");
304
305   switch (Type) {
306   default:
307     llvm_unreachable("Relocation type not implemented yet!");
308     break;
309   case ELF::R_AARCH64_ABS64: {
310     uint64_t *TargetPtr =
311         reinterpret_cast<uint64_t *>(Section.Address + Offset);
312     *TargetPtr = Value + Addend;
313     break;
314   }
315   case ELF::R_AARCH64_PREL32: {
316     uint64_t Result = Value + Addend - FinalAddress;
317     assert(static_cast<int64_t>(Result) >= INT32_MIN &&
318            static_cast<int64_t>(Result) <= UINT32_MAX);
319     *TargetPtr = static_cast<uint32_t>(Result & 0xffffffffU);
320     break;
321   }
322   case ELF::R_AARCH64_CALL26: // fallthrough
323   case ELF::R_AARCH64_JUMP26: {
324     // Operation: S+A-P. Set Call or B immediate value to bits fff_fffc of the
325     // calculation.
326     uint64_t BranchImm = Value + Addend - FinalAddress;
327
328     // "Check that -2^27 <= result < 2^27".
329     assert(isInt<28>(BranchImm));
330
331     // AArch64 code is emitted with .rela relocations. The data already in any
332     // bits affected by the relocation on entry is garbage.
333     *TargetPtr &= 0xfc000000U;
334     // Immediate goes in bits 25:0 of B and BL.
335     *TargetPtr |= static_cast<uint32_t>(BranchImm & 0xffffffcU) >> 2;
336     break;
337   }
338   case ELF::R_AARCH64_MOVW_UABS_G3: {
339     uint64_t Result = Value + Addend;
340
341     // AArch64 code is emitted with .rela relocations. The data already in any
342     // bits affected by the relocation on entry is garbage.
343     *TargetPtr &= 0xffe0001fU;
344     // Immediate goes in bits 20:5 of MOVZ/MOVK instruction
345     *TargetPtr |= Result >> (48 - 5);
346     // Shift must be "lsl #48", in bits 22:21
347     assert((*TargetPtr >> 21 & 0x3) == 3 && "invalid shift for relocation");
348     break;
349   }
350   case ELF::R_AARCH64_MOVW_UABS_G2_NC: {
351     uint64_t Result = Value + Addend;
352
353     // AArch64 code is emitted with .rela relocations. The data already in any
354     // bits affected by the relocation on entry is garbage.
355     *TargetPtr &= 0xffe0001fU;
356     // Immediate goes in bits 20:5 of MOVZ/MOVK instruction
357     *TargetPtr |= ((Result & 0xffff00000000ULL) >> (32 - 5));
358     // Shift must be "lsl #32", in bits 22:21
359     assert((*TargetPtr >> 21 & 0x3) == 2 && "invalid shift for relocation");
360     break;
361   }
362   case ELF::R_AARCH64_MOVW_UABS_G1_NC: {
363     uint64_t Result = Value + Addend;
364
365     // AArch64 code is emitted with .rela relocations. The data already in any
366     // bits affected by the relocation on entry is garbage.
367     *TargetPtr &= 0xffe0001fU;
368     // Immediate goes in bits 20:5 of MOVZ/MOVK instruction
369     *TargetPtr |= ((Result & 0xffff0000U) >> (16 - 5));
370     // Shift must be "lsl #16", in bits 22:2
371     assert((*TargetPtr >> 21 & 0x3) == 1 && "invalid shift for relocation");
372     break;
373   }
374   case ELF::R_AARCH64_MOVW_UABS_G0_NC: {
375     uint64_t Result = Value + Addend;
376
377     // AArch64 code is emitted with .rela relocations. The data already in any
378     // bits affected by the relocation on entry is garbage.
379     *TargetPtr &= 0xffe0001fU;
380     // Immediate goes in bits 20:5 of MOVZ/MOVK instruction
381     *TargetPtr |= ((Result & 0xffffU) << 5);
382     // Shift must be "lsl #0", in bits 22:21.
383     assert((*TargetPtr >> 21 & 0x3) == 0 && "invalid shift for relocation");
384     break;
385   }
386   case ELF::R_AARCH64_ADR_PREL_PG_HI21: {
387     // Operation: Page(S+A) - Page(P)
388     uint64_t Result =
389         ((Value + Addend) & ~0xfffULL) - (FinalAddress & ~0xfffULL);
390
391     // Check that -2^32 <= X < 2^32
392     assert(isInt<33>(Result) && "overflow check failed for relocation");
393
394     // AArch64 code is emitted with .rela relocations. The data already in any
395     // bits affected by the relocation on entry is garbage.
396     *TargetPtr &= 0x9f00001fU;
397     // Immediate goes in bits 30:29 + 5:23 of ADRP instruction, taken
398     // from bits 32:12 of X.
399     *TargetPtr |= ((Result & 0x3000U) << (29 - 12));
400     *TargetPtr |= ((Result & 0x1ffffc000ULL) >> (14 - 5));
401     break;
402   }
403   case ELF::R_AARCH64_LDST32_ABS_LO12_NC: {
404     // Operation: S + A
405     uint64_t Result = Value + Addend;
406
407     // AArch64 code is emitted with .rela relocations. The data already in any
408     // bits affected by the relocation on entry is garbage.
409     *TargetPtr &= 0xffc003ffU;
410     // Immediate goes in bits 21:10 of LD/ST instruction, taken
411     // from bits 11:2 of X
412     *TargetPtr |= ((Result & 0xffc) << (10 - 2));
413     break;
414   }
415   case ELF::R_AARCH64_LDST64_ABS_LO12_NC: {
416     // Operation: S + A
417     uint64_t Result = Value + Addend;
418
419     // AArch64 code is emitted with .rela relocations. The data already in any
420     // bits affected by the relocation on entry is garbage.
421     *TargetPtr &= 0xffc003ffU;
422     // Immediate goes in bits 21:10 of LD/ST instruction, taken
423     // from bits 11:3 of X
424     *TargetPtr |= ((Result & 0xff8) << (10 - 3));
425     break;
426   }
427   }
428 }
429
430 void RuntimeDyldELF::resolveARMRelocation(const SectionEntry &Section,
431                                           uint64_t Offset, uint32_t Value,
432                                           uint32_t Type, int32_t Addend) {
433   // TODO: Add Thumb relocations.
434   uint32_t *TargetPtr = (uint32_t *)(Section.Address + Offset);
435   uint32_t FinalAddress = ((Section.LoadAddress + Offset) & 0xFFFFFFFF);
436   Value += Addend;
437
438   DEBUG(dbgs() << "resolveARMRelocation, LocalAddress: "
439                << Section.Address + Offset
440                << " FinalAddress: " << format("%p", FinalAddress) << " Value: "
441                << format("%x", Value) << " Type: " << format("%x", Type)
442                << " Addend: " << format("%x", Addend) << "\n");
443
444   switch (Type) {
445   default:
446     llvm_unreachable("Not implemented relocation type!");
447
448   case ELF::R_ARM_NONE:
449     break;
450   case ELF::R_ARM_PREL31:
451   case ELF::R_ARM_TARGET1:
452   case ELF::R_ARM_ABS32:
453     *TargetPtr = Value;
454     break;
455     // Write first 16 bit of 32 bit value to the mov instruction.
456     // Last 4 bit should be shifted.
457   case ELF::R_ARM_MOVW_ABS_NC:
458   case ELF::R_ARM_MOVT_ABS:
459     if (Type == ELF::R_ARM_MOVW_ABS_NC)
460       Value = Value & 0xFFFF;
461     else if (Type == ELF::R_ARM_MOVT_ABS)
462       Value = (Value >> 16) & 0xFFFF;
463     *TargetPtr &= ~0x000F0FFF;
464     *TargetPtr |= Value & 0xFFF;
465     *TargetPtr |= ((Value >> 12) & 0xF) << 16;
466     break;
467     // Write 24 bit relative value to the branch instruction.
468   case ELF::R_ARM_PC24: // Fall through.
469   case ELF::R_ARM_CALL: // Fall through.
470   case ELF::R_ARM_JUMP24:
471     int32_t RelValue = static_cast<int32_t>(Value - FinalAddress - 8);
472     RelValue = (RelValue & 0x03FFFFFC) >> 2;
473     assert((*TargetPtr & 0xFFFFFF) == 0xFFFFFE);
474     *TargetPtr &= 0xFF000000;
475     *TargetPtr |= RelValue;
476     break;
477   }
478 }
479
480 void RuntimeDyldELF::resolveMIPSRelocation(const SectionEntry &Section,
481                                            uint64_t Offset, uint32_t Value,
482                                            uint32_t Type, int32_t Addend) {
483   uint8_t *TargetPtr = Section.Address + Offset;
484   Value += Addend;
485
486   DEBUG(dbgs() << "resolveMIPSRelocation, LocalAddress: "
487                << Section.Address + Offset << " FinalAddress: "
488                << format("%p", Section.LoadAddress + Offset) << " Value: "
489                << format("%x", Value) << " Type: " << format("%x", Type)
490                << " Addend: " << format("%x", Addend) << "\n");
491
492   uint32_t Insn = readBytesUnaligned(TargetPtr, 4);
493
494   switch (Type) {
495   default:
496     llvm_unreachable("Not implemented relocation type!");
497     break;
498   case ELF::R_MIPS_32:
499     writeBytesUnaligned(Value, TargetPtr, 4);
500     break;
501   case ELF::R_MIPS_26:
502     Insn &= 0xfc000000;
503     Insn |= (Value & 0x0fffffff) >> 2;
504     writeBytesUnaligned(Insn, TargetPtr, 4);
505     break;
506   case ELF::R_MIPS_HI16:
507     // Get the higher 16-bits. Also add 1 if bit 15 is 1.
508     Insn &= 0xffff0000;
509     Insn |= ((Value + 0x8000) >> 16) & 0xffff;
510     writeBytesUnaligned(Insn, TargetPtr, 4);
511     break;
512   case ELF::R_MIPS_LO16:
513     Insn &= 0xffff0000;
514     Insn |= Value & 0xffff;
515     writeBytesUnaligned(Insn, TargetPtr, 4);
516     break;
517   case ELF::R_MIPS_PC32: {
518     uint32_t FinalAddress = (Section.LoadAddress + Offset);
519     writeBytesUnaligned(Value - FinalAddress, (uint8_t *)TargetPtr, 4);
520     break;
521   }
522   case ELF::R_MIPS_PC16: {
523     uint32_t FinalAddress = (Section.LoadAddress + Offset);
524     Insn &= 0xffff0000;
525     Insn |= ((Value - FinalAddress) >> 2) & 0xffff;
526     writeBytesUnaligned(Insn, TargetPtr, 4);
527     break;
528   }
529   case ELF::R_MIPS_PC19_S2: {
530     uint32_t FinalAddress = (Section.LoadAddress + Offset);
531     Insn &= 0xfff80000;
532     Insn |= ((Value - (FinalAddress & ~0x3)) >> 2) & 0x7ffff;
533     writeBytesUnaligned(Insn, TargetPtr, 4);
534     break;
535   }
536   case ELF::R_MIPS_PC21_S2: {
537     uint32_t FinalAddress = (Section.LoadAddress + Offset);
538     Insn &= 0xffe00000;
539     Insn |= ((Value - FinalAddress) >> 2) & 0x1fffff;
540     writeBytesUnaligned(Insn, TargetPtr, 4);
541     break;
542   }
543   case ELF::R_MIPS_PC26_S2: {
544     uint32_t FinalAddress = (Section.LoadAddress + Offset);
545     Insn &= 0xfc000000;
546     Insn |= ((Value - FinalAddress) >> 2) & 0x3ffffff;
547     writeBytesUnaligned(Insn, TargetPtr, 4);
548     break;
549   }
550   case ELF::R_MIPS_PCHI16: {
551     uint32_t FinalAddress = (Section.LoadAddress + Offset);
552     Insn &= 0xffff0000;
553     Insn |= ((Value - FinalAddress + 0x8000) >> 16) & 0xffff;
554     writeBytesUnaligned(Insn, TargetPtr, 4);
555     break;
556   }
557   case ELF::R_MIPS_PCLO16: {
558     uint32_t FinalAddress = (Section.LoadAddress + Offset);
559     Insn &= 0xffff0000;
560     Insn |= (Value - FinalAddress) & 0xffff;
561     writeBytesUnaligned(Insn, TargetPtr, 4);
562     break;
563   }
564   }
565 }
566
567 void RuntimeDyldELF::setMipsABI(const ObjectFile &Obj) {
568   if (Arch == Triple::UnknownArch ||
569       !StringRef(Triple::getArchTypePrefix(Arch)).equals("mips")) {
570     IsMipsO32ABI = false;
571     IsMipsN64ABI = false;
572     return;
573   }
574   unsigned AbiVariant;
575   Obj.getPlatformFlags(AbiVariant);
576   IsMipsO32ABI = AbiVariant & ELF::EF_MIPS_ABI_O32;
577   IsMipsN64ABI = Obj.getFileFormatName().equals("ELF64-mips");
578   if (AbiVariant & ELF::EF_MIPS_ABI2)
579     llvm_unreachable("Mips N32 ABI is not supported yet");
580 }
581
582 void RuntimeDyldELF::resolveMIPS64Relocation(const SectionEntry &Section,
583                                              uint64_t Offset, uint64_t Value,
584                                              uint32_t Type, int64_t Addend,
585                                              uint64_t SymOffset,
586                                              SID SectionID) {
587   uint32_t r_type = Type & 0xff;
588   uint32_t r_type2 = (Type >> 8) & 0xff;
589   uint32_t r_type3 = (Type >> 16) & 0xff;
590
591   // RelType is used to keep information for which relocation type we are
592   // applying relocation.
593   uint32_t RelType = r_type;
594   int64_t CalculatedValue = evaluateMIPS64Relocation(Section, Offset, Value,
595                                                      RelType, Addend,
596                                                      SymOffset, SectionID);
597   if (r_type2 != ELF::R_MIPS_NONE) {
598     RelType = r_type2;
599     CalculatedValue = evaluateMIPS64Relocation(Section, Offset, 0, RelType,
600                                                CalculatedValue, SymOffset,
601                                                SectionID);
602   }
603   if (r_type3 != ELF::R_MIPS_NONE) {
604     RelType = r_type3;
605     CalculatedValue = evaluateMIPS64Relocation(Section, Offset, 0, RelType,
606                                                CalculatedValue, SymOffset,
607                                                SectionID);
608   }
609   applyMIPS64Relocation(Section.Address + Offset, CalculatedValue, RelType);
610 }
611
612 int64_t
613 RuntimeDyldELF::evaluateMIPS64Relocation(const SectionEntry &Section,
614                                          uint64_t Offset, uint64_t Value,
615                                          uint32_t Type, int64_t Addend,
616                                          uint64_t SymOffset, SID SectionID) {
617
618   DEBUG(dbgs() << "evaluateMIPS64Relocation, LocalAddress: 0x"
619                << format("%llx", Section.Address + Offset)
620                << " FinalAddress: 0x"
621                << format("%llx", Section.LoadAddress + Offset)
622                << " Value: 0x" << format("%llx", Value) << " Type: 0x"
623                << format("%x", Type) << " Addend: 0x" << format("%llx", Addend)
624                << " SymOffset: " << format("%x", SymOffset)
625                << "\n");
626
627   switch (Type) {
628   default:
629     llvm_unreachable("Not implemented relocation type!");
630     break;
631   case ELF::R_MIPS_JALR:
632   case ELF::R_MIPS_NONE:
633     break;
634   case ELF::R_MIPS_32:
635   case ELF::R_MIPS_64:
636     return Value + Addend;
637   case ELF::R_MIPS_26:
638     return ((Value + Addend) >> 2) & 0x3ffffff;
639   case ELF::R_MIPS_GPREL16: {
640     uint64_t GOTAddr = getSectionLoadAddress(SectionToGOTMap[SectionID]);
641     return Value + Addend - (GOTAddr + 0x7ff0);
642   }
643   case ELF::R_MIPS_SUB:
644     return Value - Addend;
645   case ELF::R_MIPS_HI16:
646     // Get the higher 16-bits. Also add 1 if bit 15 is 1.
647     return ((Value + Addend + 0x8000) >> 16) & 0xffff;
648   case ELF::R_MIPS_LO16:
649     return (Value + Addend) & 0xffff;
650   case ELF::R_MIPS_CALL16:
651   case ELF::R_MIPS_GOT_DISP:
652   case ELF::R_MIPS_GOT_PAGE: {
653     uint8_t *LocalGOTAddr =
654         getSectionAddress(SectionToGOTMap[SectionID]) + SymOffset;
655     uint64_t GOTEntry = readBytesUnaligned(LocalGOTAddr, 8);
656
657     Value += Addend;
658     if (Type == ELF::R_MIPS_GOT_PAGE)
659       Value = (Value + 0x8000) & ~0xffff;
660
661     if (GOTEntry)
662       assert(GOTEntry == Value &&
663                    "GOT entry has two different addresses.");
664     else
665       writeBytesUnaligned(Value, LocalGOTAddr, 8);
666
667     return (SymOffset - 0x7ff0) & 0xffff;
668   }
669   case ELF::R_MIPS_GOT_OFST: {
670     int64_t page = (Value + Addend + 0x8000) & ~0xffff;
671     return (Value + Addend - page) & 0xffff;
672   }
673   case ELF::R_MIPS_GPREL32: {
674     uint64_t GOTAddr = getSectionLoadAddress(SectionToGOTMap[SectionID]);
675     return Value + Addend - (GOTAddr + 0x7ff0);
676   }
677   case ELF::R_MIPS_PC16: {
678     uint64_t FinalAddress = (Section.LoadAddress + Offset);
679     return ((Value + Addend - FinalAddress) >> 2) & 0xffff;
680   }
681   case ELF::R_MIPS_PC32: {
682     uint64_t FinalAddress = (Section.LoadAddress + Offset);
683     return Value + Addend - FinalAddress;
684   }
685   case ELF::R_MIPS_PC18_S3: {
686     uint64_t FinalAddress = (Section.LoadAddress + Offset);
687     return ((Value + Addend - ((FinalAddress | 7) ^ 7)) >> 3) & 0x3ffff;
688   }
689   case ELF::R_MIPS_PC19_S2: {
690     uint64_t FinalAddress = (Section.LoadAddress + Offset);
691     return ((Value + Addend - FinalAddress) >> 2) & 0x7ffff;
692   }
693   case ELF::R_MIPS_PC21_S2: {
694     uint64_t FinalAddress = (Section.LoadAddress + Offset);
695     return ((Value + Addend - FinalAddress) >> 2) & 0x1fffff;
696   }
697   case ELF::R_MIPS_PC26_S2: {
698     uint64_t FinalAddress = (Section.LoadAddress + Offset);
699     return ((Value + Addend - FinalAddress) >> 2) & 0x3ffffff;
700   }
701   case ELF::R_MIPS_PCHI16: {
702     uint64_t FinalAddress = (Section.LoadAddress + Offset);
703     return ((Value + Addend - FinalAddress + 0x8000) >> 16) & 0xffff;
704   }
705   case ELF::R_MIPS_PCLO16: {
706     uint64_t FinalAddress = (Section.LoadAddress + Offset);
707     return (Value + Addend - FinalAddress) & 0xffff;
708   }
709   }
710   return 0;
711 }
712
713 void RuntimeDyldELF::applyMIPS64Relocation(uint8_t *TargetPtr,
714                                            int64_t CalculatedValue,
715                                            uint32_t Type) {
716   uint32_t Insn = readBytesUnaligned(TargetPtr, 4);
717
718   switch (Type) {
719     default:
720       break;
721     case ELF::R_MIPS_32:
722     case ELF::R_MIPS_GPREL32:
723     case ELF::R_MIPS_PC32:
724       writeBytesUnaligned(CalculatedValue & 0xffffffff, TargetPtr, 4);
725       break;
726     case ELF::R_MIPS_64:
727     case ELF::R_MIPS_SUB:
728       writeBytesUnaligned(CalculatedValue, TargetPtr, 8);
729       break;
730     case ELF::R_MIPS_26:
731     case ELF::R_MIPS_PC26_S2:
732       Insn = (Insn & 0xfc000000) | CalculatedValue;
733       writeBytesUnaligned(Insn, TargetPtr, 4);
734       break;
735     case ELF::R_MIPS_GPREL16:
736       Insn = (Insn & 0xffff0000) | (CalculatedValue & 0xffff);
737       writeBytesUnaligned(Insn, TargetPtr, 4);
738       break;
739     case ELF::R_MIPS_HI16:
740     case ELF::R_MIPS_LO16:
741     case ELF::R_MIPS_PCHI16:
742     case ELF::R_MIPS_PCLO16:
743     case ELF::R_MIPS_PC16:
744     case ELF::R_MIPS_CALL16:
745     case ELF::R_MIPS_GOT_DISP:
746     case ELF::R_MIPS_GOT_PAGE:
747     case ELF::R_MIPS_GOT_OFST:
748       Insn = (Insn & 0xffff0000) | CalculatedValue;
749       writeBytesUnaligned(Insn, TargetPtr, 4);
750       break;
751     case ELF::R_MIPS_PC18_S3:
752       Insn = (Insn & 0xfffc0000) | CalculatedValue;
753       writeBytesUnaligned(Insn, TargetPtr, 4);
754       break;
755     case ELF::R_MIPS_PC19_S2:
756       Insn = (Insn & 0xfff80000) | CalculatedValue;
757       writeBytesUnaligned(Insn, TargetPtr, 4);
758       break;
759     case ELF::R_MIPS_PC21_S2:
760       Insn = (Insn & 0xffe00000) | CalculatedValue;
761       writeBytesUnaligned(Insn, TargetPtr, 4);
762       break;
763     }
764 }
765
766 // Return the .TOC. section and offset.
767 void RuntimeDyldELF::findPPC64TOCSection(const ELFObjectFileBase &Obj,
768                                          ObjSectionToIDMap &LocalSections,
769                                          RelocationValueRef &Rel) {
770   // Set a default SectionID in case we do not find a TOC section below.
771   // This may happen for references to TOC base base (sym@toc, .odp
772   // relocation) without a .toc directive.  In this case just use the
773   // first section (which is usually the .odp) since the code won't
774   // reference the .toc base directly.
775   Rel.SymbolName = NULL;
776   Rel.SectionID = 0;
777
778   // The TOC consists of sections .got, .toc, .tocbss, .plt in that
779   // order. The TOC starts where the first of these sections starts.
780   for (auto &Section: Obj.sections()) {
781     StringRef SectionName;
782     check(Section.getName(SectionName));
783
784     if (SectionName == ".got"
785         || SectionName == ".toc"
786         || SectionName == ".tocbss"
787         || SectionName == ".plt") {
788       Rel.SectionID = findOrEmitSection(Obj, Section, false, LocalSections);
789       break;
790     }
791   }
792
793   // Per the ppc64-elf-linux ABI, The TOC base is TOC value plus 0x8000
794   // thus permitting a full 64 Kbytes segment.
795   Rel.Addend = 0x8000;
796 }
797
798 // Returns the sections and offset associated with the ODP entry referenced
799 // by Symbol.
800 void RuntimeDyldELF::findOPDEntrySection(const ELFObjectFileBase &Obj,
801                                          ObjSectionToIDMap &LocalSections,
802                                          RelocationValueRef &Rel) {
803   // Get the ELF symbol value (st_value) to compare with Relocation offset in
804   // .opd entries
805   for (section_iterator si = Obj.section_begin(), se = Obj.section_end();
806        si != se; ++si) {
807     section_iterator RelSecI = si->getRelocatedSection();
808     if (RelSecI == Obj.section_end())
809       continue;
810
811     StringRef RelSectionName;
812     check(RelSecI->getName(RelSectionName));
813     if (RelSectionName != ".opd")
814       continue;
815
816     for (elf_relocation_iterator i = si->relocation_begin(),
817                                  e = si->relocation_end();
818          i != e;) {
819       // The R_PPC64_ADDR64 relocation indicates the first field
820       // of a .opd entry
821       uint64_t TypeFunc = i->getType();
822       if (TypeFunc != ELF::R_PPC64_ADDR64) {
823         ++i;
824         continue;
825       }
826
827       uint64_t TargetSymbolOffset = i->getOffset();
828       symbol_iterator TargetSymbol = i->getSymbol();
829       ErrorOr<int64_t> AddendOrErr = i->getAddend();
830       Check(AddendOrErr.getError());
831       int64_t Addend = *AddendOrErr;
832
833       ++i;
834       if (i == e)
835         break;
836
837       // Just check if following relocation is a R_PPC64_TOC
838       uint64_t TypeTOC = i->getType();
839       if (TypeTOC != ELF::R_PPC64_TOC)
840         continue;
841
842       // Finally compares the Symbol value and the target symbol offset
843       // to check if this .opd entry refers to the symbol the relocation
844       // points to.
845       if (Rel.Addend != (int64_t)TargetSymbolOffset)
846         continue;
847
848       ErrorOr<section_iterator> TSIOrErr = TargetSymbol->getSection();
849       check(TSIOrErr.getError());
850       section_iterator tsi = *TSIOrErr;
851       bool IsCode = tsi->isText();
852       Rel.SectionID = findOrEmitSection(Obj, (*tsi), IsCode, LocalSections);
853       Rel.Addend = (intptr_t)Addend;
854       return;
855     }
856   }
857   llvm_unreachable("Attempting to get address of ODP entry!");
858 }
859
860 // Relocation masks following the #lo(value), #hi(value), #ha(value),
861 // #higher(value), #highera(value), #highest(value), and #highesta(value)
862 // macros defined in section 4.5.1. Relocation Types of the PPC-elf64abi
863 // document.
864
865 static inline uint16_t applyPPClo(uint64_t value) { return value & 0xffff; }
866
867 static inline uint16_t applyPPChi(uint64_t value) {
868   return (value >> 16) & 0xffff;
869 }
870
871 static inline uint16_t applyPPCha (uint64_t value) {
872   return ((value + 0x8000) >> 16) & 0xffff;
873 }
874
875 static inline uint16_t applyPPChigher(uint64_t value) {
876   return (value >> 32) & 0xffff;
877 }
878
879 static inline uint16_t applyPPChighera (uint64_t value) {
880   return ((value + 0x8000) >> 32) & 0xffff;
881 }
882
883 static inline uint16_t applyPPChighest(uint64_t value) {
884   return (value >> 48) & 0xffff;
885 }
886
887 static inline uint16_t applyPPChighesta (uint64_t value) {
888   return ((value + 0x8000) >> 48) & 0xffff;
889 }
890
891 void RuntimeDyldELF::resolvePPC32Relocation(const SectionEntry &Section,
892                                             uint64_t Offset, uint64_t Value,
893                                             uint32_t Type, int64_t Addend) {
894   uint8_t *LocalAddress = Section.Address + Offset;
895   switch (Type) {
896   default:
897     llvm_unreachable("Relocation type not implemented yet!");
898     break;
899   case ELF::R_PPC_ADDR16_LO:
900     writeInt16BE(LocalAddress, applyPPClo(Value + Addend));
901     break;
902   case ELF::R_PPC_ADDR16_HI:
903     writeInt16BE(LocalAddress, applyPPChi(Value + Addend));
904     break;
905   case ELF::R_PPC_ADDR16_HA:
906     writeInt16BE(LocalAddress, applyPPCha(Value + Addend));
907     break;
908   }
909 }
910
911 void RuntimeDyldELF::resolvePPC64Relocation(const SectionEntry &Section,
912                                             uint64_t Offset, uint64_t Value,
913                                             uint32_t Type, int64_t Addend) {
914   uint8_t *LocalAddress = Section.Address + Offset;
915   switch (Type) {
916   default:
917     llvm_unreachable("Relocation type not implemented yet!");
918     break;
919   case ELF::R_PPC64_ADDR16:
920     writeInt16BE(LocalAddress, applyPPClo(Value + Addend));
921     break;
922   case ELF::R_PPC64_ADDR16_DS:
923     writeInt16BE(LocalAddress, applyPPClo(Value + Addend) & ~3);
924     break;
925   case ELF::R_PPC64_ADDR16_LO:
926     writeInt16BE(LocalAddress, applyPPClo(Value + Addend));
927     break;
928   case ELF::R_PPC64_ADDR16_LO_DS:
929     writeInt16BE(LocalAddress, applyPPClo(Value + Addend) & ~3);
930     break;
931   case ELF::R_PPC64_ADDR16_HI:
932     writeInt16BE(LocalAddress, applyPPChi(Value + Addend));
933     break;
934   case ELF::R_PPC64_ADDR16_HA:
935     writeInt16BE(LocalAddress, applyPPCha(Value + Addend));
936     break;
937   case ELF::R_PPC64_ADDR16_HIGHER:
938     writeInt16BE(LocalAddress, applyPPChigher(Value + Addend));
939     break;
940   case ELF::R_PPC64_ADDR16_HIGHERA:
941     writeInt16BE(LocalAddress, applyPPChighera(Value + Addend));
942     break;
943   case ELF::R_PPC64_ADDR16_HIGHEST:
944     writeInt16BE(LocalAddress, applyPPChighest(Value + Addend));
945     break;
946   case ELF::R_PPC64_ADDR16_HIGHESTA:
947     writeInt16BE(LocalAddress, applyPPChighesta(Value + Addend));
948     break;
949   case ELF::R_PPC64_ADDR14: {
950     assert(((Value + Addend) & 3) == 0);
951     // Preserve the AA/LK bits in the branch instruction
952     uint8_t aalk = *(LocalAddress + 3);
953     writeInt16BE(LocalAddress + 2, (aalk & 3) | ((Value + Addend) & 0xfffc));
954   } break;
955   case ELF::R_PPC64_REL16_LO: {
956     uint64_t FinalAddress = (Section.LoadAddress + Offset);
957     uint64_t Delta = Value - FinalAddress + Addend;
958     writeInt16BE(LocalAddress, applyPPClo(Delta));
959   } break;
960   case ELF::R_PPC64_REL16_HI: {
961     uint64_t FinalAddress = (Section.LoadAddress + Offset);
962     uint64_t Delta = Value - FinalAddress + Addend;
963     writeInt16BE(LocalAddress, applyPPChi(Delta));
964   } break;
965   case ELF::R_PPC64_REL16_HA: {
966     uint64_t FinalAddress = (Section.LoadAddress + Offset);
967     uint64_t Delta = Value - FinalAddress + Addend;
968     writeInt16BE(LocalAddress, applyPPCha(Delta));
969   } break;
970   case ELF::R_PPC64_ADDR32: {
971     int32_t Result = static_cast<int32_t>(Value + Addend);
972     if (SignExtend32<32>(Result) != Result)
973       llvm_unreachable("Relocation R_PPC64_ADDR32 overflow");
974     writeInt32BE(LocalAddress, Result);
975   } break;
976   case ELF::R_PPC64_REL24: {
977     uint64_t FinalAddress = (Section.LoadAddress + Offset);
978     int32_t delta = static_cast<int32_t>(Value - FinalAddress + Addend);
979     if (SignExtend32<24>(delta) != delta)
980       llvm_unreachable("Relocation R_PPC64_REL24 overflow");
981     // Generates a 'bl <address>' instruction
982     writeInt32BE(LocalAddress, 0x48000001 | (delta & 0x03FFFFFC));
983   } break;
984   case ELF::R_PPC64_REL32: {
985     uint64_t FinalAddress = (Section.LoadAddress + Offset);
986     int32_t delta = static_cast<int32_t>(Value - FinalAddress + Addend);
987     if (SignExtend32<32>(delta) != delta)
988       llvm_unreachable("Relocation R_PPC64_REL32 overflow");
989     writeInt32BE(LocalAddress, delta);
990   } break;
991   case ELF::R_PPC64_REL64: {
992     uint64_t FinalAddress = (Section.LoadAddress + Offset);
993     uint64_t Delta = Value - FinalAddress + Addend;
994     writeInt64BE(LocalAddress, Delta);
995   } break;
996   case ELF::R_PPC64_ADDR64:
997     writeInt64BE(LocalAddress, Value + Addend);
998     break;
999   }
1000 }
1001
1002 void RuntimeDyldELF::resolveSystemZRelocation(const SectionEntry &Section,
1003                                               uint64_t Offset, uint64_t Value,
1004                                               uint32_t Type, int64_t Addend) {
1005   uint8_t *LocalAddress = Section.Address + Offset;
1006   switch (Type) {
1007   default:
1008     llvm_unreachable("Relocation type not implemented yet!");
1009     break;
1010   case ELF::R_390_PC16DBL:
1011   case ELF::R_390_PLT16DBL: {
1012     int64_t Delta = (Value + Addend) - (Section.LoadAddress + Offset);
1013     assert(int16_t(Delta / 2) * 2 == Delta && "R_390_PC16DBL overflow");
1014     writeInt16BE(LocalAddress, Delta / 2);
1015     break;
1016   }
1017   case ELF::R_390_PC32DBL:
1018   case ELF::R_390_PLT32DBL: {
1019     int64_t Delta = (Value + Addend) - (Section.LoadAddress + Offset);
1020     assert(int32_t(Delta / 2) * 2 == Delta && "R_390_PC32DBL overflow");
1021     writeInt32BE(LocalAddress, Delta / 2);
1022     break;
1023   }
1024   case ELF::R_390_PC32: {
1025     int64_t Delta = (Value + Addend) - (Section.LoadAddress + Offset);
1026     assert(int32_t(Delta) == Delta && "R_390_PC32 overflow");
1027     writeInt32BE(LocalAddress, Delta);
1028     break;
1029   }
1030   case ELF::R_390_64:
1031     writeInt64BE(LocalAddress, Value + Addend);
1032     break;
1033   }
1034 }
1035
1036 // The target location for the relocation is described by RE.SectionID and
1037 // RE.Offset.  RE.SectionID can be used to find the SectionEntry.  Each
1038 // SectionEntry has three members describing its location.
1039 // SectionEntry::Address is the address at which the section has been loaded
1040 // into memory in the current (host) process.  SectionEntry::LoadAddress is the
1041 // address that the section will have in the target process.
1042 // SectionEntry::ObjAddress is the address of the bits for this section in the
1043 // original emitted object image (also in the current address space).
1044 //
1045 // Relocations will be applied as if the section were loaded at
1046 // SectionEntry::LoadAddress, but they will be applied at an address based
1047 // on SectionEntry::Address.  SectionEntry::ObjAddress will be used to refer to
1048 // Target memory contents if they are required for value calculations.
1049 //
1050 // The Value parameter here is the load address of the symbol for the
1051 // relocation to be applied.  For relocations which refer to symbols in the
1052 // current object Value will be the LoadAddress of the section in which
1053 // the symbol resides (RE.Addend provides additional information about the
1054 // symbol location).  For external symbols, Value will be the address of the
1055 // symbol in the target address space.
1056 void RuntimeDyldELF::resolveRelocation(const RelocationEntry &RE,
1057                                        uint64_t Value) {
1058   const SectionEntry &Section = Sections[RE.SectionID];
1059   return resolveRelocation(Section, RE.Offset, Value, RE.RelType, RE.Addend,
1060                            RE.SymOffset, RE.SectionID);
1061 }
1062
1063 void RuntimeDyldELF::resolveRelocation(const SectionEntry &Section,
1064                                        uint64_t Offset, uint64_t Value,
1065                                        uint32_t Type, int64_t Addend,
1066                                        uint64_t SymOffset, SID SectionID) {
1067   switch (Arch) {
1068   case Triple::x86_64:
1069     resolveX86_64Relocation(Section, Offset, Value, Type, Addend, SymOffset);
1070     break;
1071   case Triple::x86:
1072     resolveX86Relocation(Section, Offset, (uint32_t)(Value & 0xffffffffL), Type,
1073                          (uint32_t)(Addend & 0xffffffffL));
1074     break;
1075   case Triple::aarch64:
1076   case Triple::aarch64_be:
1077     resolveAArch64Relocation(Section, Offset, Value, Type, Addend);
1078     break;
1079   case Triple::arm: // Fall through.
1080   case Triple::armeb:
1081   case Triple::thumb:
1082   case Triple::thumbeb:
1083     resolveARMRelocation(Section, Offset, (uint32_t)(Value & 0xffffffffL), Type,
1084                          (uint32_t)(Addend & 0xffffffffL));
1085     break;
1086   case Triple::mips: // Fall through.
1087   case Triple::mipsel:
1088   case Triple::mips64:
1089   case Triple::mips64el:
1090     if (IsMipsO32ABI)
1091       resolveMIPSRelocation(Section, Offset, (uint32_t)(Value & 0xffffffffL),
1092                             Type, (uint32_t)(Addend & 0xffffffffL));
1093     else if (IsMipsN64ABI)
1094       resolveMIPS64Relocation(Section, Offset, Value, Type, Addend, SymOffset,
1095                               SectionID);
1096     else
1097       llvm_unreachable("Mips ABI not handled");
1098     break;
1099   case Triple::ppc:
1100     resolvePPC32Relocation(Section, Offset, Value, Type, Addend);
1101     break;
1102   case Triple::ppc64: // Fall through.
1103   case Triple::ppc64le:
1104     resolvePPC64Relocation(Section, Offset, Value, Type, Addend);
1105     break;
1106   case Triple::systemz:
1107     resolveSystemZRelocation(Section, Offset, Value, Type, Addend);
1108     break;
1109   default:
1110     llvm_unreachable("Unsupported CPU type!");
1111   }
1112 }
1113
1114 void *RuntimeDyldELF::computePlaceholderAddress(unsigned SectionID, uint64_t Offset) const {
1115   return (void*)(Sections[SectionID].ObjAddress + Offset);
1116 }
1117
1118 void RuntimeDyldELF::processSimpleRelocation(unsigned SectionID, uint64_t Offset, unsigned RelType, RelocationValueRef Value) {
1119   RelocationEntry RE(SectionID, Offset, RelType, Value.Addend, Value.Offset);
1120   if (Value.SymbolName)
1121     addRelocationForSymbol(RE, Value.SymbolName);
1122   else
1123     addRelocationForSection(RE, Value.SectionID);
1124 }
1125
1126 relocation_iterator RuntimeDyldELF::processRelocationRef(
1127     unsigned SectionID, relocation_iterator RelI, const ObjectFile &O,
1128     ObjSectionToIDMap &ObjSectionToID, StubMap &Stubs) {
1129   const auto &Obj = cast<ELFObjectFileBase>(O);
1130   uint64_t RelType = RelI->getType();
1131   ErrorOr<int64_t> AddendOrErr = ELFRelocationRef(*RelI).getAddend();
1132   int64_t Addend = AddendOrErr ? *AddendOrErr : 0;
1133   elf_symbol_iterator Symbol = RelI->getSymbol();
1134
1135   // Obtain the symbol name which is referenced in the relocation
1136   StringRef TargetName;
1137   if (Symbol != Obj.symbol_end()) {
1138     ErrorOr<StringRef> TargetNameOrErr = Symbol->getName();
1139     if (std::error_code EC = TargetNameOrErr.getError())
1140       report_fatal_error(EC.message());
1141     TargetName = *TargetNameOrErr;
1142   }
1143   DEBUG(dbgs() << "\t\tRelType: " << RelType << " Addend: " << Addend
1144                << " TargetName: " << TargetName << "\n");
1145   RelocationValueRef Value;
1146   // First search for the symbol in the local symbol table
1147   SymbolRef::Type SymType = SymbolRef::ST_Unknown;
1148
1149   // Search for the symbol in the global symbol table
1150   RTDyldSymbolTable::const_iterator gsi = GlobalSymbolTable.end();
1151   if (Symbol != Obj.symbol_end()) {
1152     gsi = GlobalSymbolTable.find(TargetName.data());
1153     SymType = Symbol->getType();
1154   }
1155   if (gsi != GlobalSymbolTable.end()) {
1156     const auto &SymInfo = gsi->second;
1157     Value.SectionID = SymInfo.getSectionID();
1158     Value.Offset = SymInfo.getOffset();
1159     Value.Addend = SymInfo.getOffset() + Addend;
1160   } else {
1161     switch (SymType) {
1162     case SymbolRef::ST_Debug: {
1163       // TODO: Now ELF SymbolRef::ST_Debug = STT_SECTION, it's not obviously
1164       // and can be changed by another developers. Maybe best way is add
1165       // a new symbol type ST_Section to SymbolRef and use it.
1166       section_iterator si = *Symbol->getSection();
1167       if (si == Obj.section_end())
1168         llvm_unreachable("Symbol section not found, bad object file format!");
1169       DEBUG(dbgs() << "\t\tThis is section symbol\n");
1170       bool isCode = si->isText();
1171       Value.SectionID = findOrEmitSection(Obj, (*si), isCode, ObjSectionToID);
1172       Value.Addend = Addend;
1173       break;
1174     }
1175     case SymbolRef::ST_Data:
1176     case SymbolRef::ST_Unknown: {
1177       Value.SymbolName = TargetName.data();
1178       Value.Addend = Addend;
1179
1180       // Absolute relocations will have a zero symbol ID (STN_UNDEF), which
1181       // will manifest here as a NULL symbol name.
1182       // We can set this as a valid (but empty) symbol name, and rely
1183       // on addRelocationForSymbol to handle this.
1184       if (!Value.SymbolName)
1185         Value.SymbolName = "";
1186       break;
1187     }
1188     default:
1189       llvm_unreachable("Unresolved symbol type!");
1190       break;
1191     }
1192   }
1193
1194   uint64_t Offset = RelI->getOffset();
1195
1196   DEBUG(dbgs() << "\t\tSectionID: " << SectionID << " Offset: " << Offset
1197                << "\n");
1198   if ((Arch == Triple::aarch64 || Arch == Triple::aarch64_be) &&
1199       (RelType == ELF::R_AARCH64_CALL26 || RelType == ELF::R_AARCH64_JUMP26)) {
1200     // This is an AArch64 branch relocation, need to use a stub function.
1201     DEBUG(dbgs() << "\t\tThis is an AArch64 branch relocation.");
1202     SectionEntry &Section = Sections[SectionID];
1203
1204     // Look for an existing stub.
1205     StubMap::const_iterator i = Stubs.find(Value);
1206     if (i != Stubs.end()) {
1207       resolveRelocation(Section, Offset, (uint64_t)Section.Address + i->second,
1208                         RelType, 0);
1209       DEBUG(dbgs() << " Stub function found\n");
1210     } else {
1211       // Create a new stub function.
1212       DEBUG(dbgs() << " Create a new stub function\n");
1213       Stubs[Value] = Section.StubOffset;
1214       uint8_t *StubTargetAddr =
1215           createStubFunction(Section.Address + Section.StubOffset);
1216
1217       RelocationEntry REmovz_g3(SectionID, StubTargetAddr - Section.Address,
1218                                 ELF::R_AARCH64_MOVW_UABS_G3, Value.Addend);
1219       RelocationEntry REmovk_g2(SectionID, StubTargetAddr - Section.Address + 4,
1220                                 ELF::R_AARCH64_MOVW_UABS_G2_NC, Value.Addend);
1221       RelocationEntry REmovk_g1(SectionID, StubTargetAddr - Section.Address + 8,
1222                                 ELF::R_AARCH64_MOVW_UABS_G1_NC, Value.Addend);
1223       RelocationEntry REmovk_g0(SectionID,
1224                                 StubTargetAddr - Section.Address + 12,
1225                                 ELF::R_AARCH64_MOVW_UABS_G0_NC, Value.Addend);
1226
1227       if (Value.SymbolName) {
1228         addRelocationForSymbol(REmovz_g3, Value.SymbolName);
1229         addRelocationForSymbol(REmovk_g2, Value.SymbolName);
1230         addRelocationForSymbol(REmovk_g1, Value.SymbolName);
1231         addRelocationForSymbol(REmovk_g0, Value.SymbolName);
1232       } else {
1233         addRelocationForSection(REmovz_g3, Value.SectionID);
1234         addRelocationForSection(REmovk_g2, Value.SectionID);
1235         addRelocationForSection(REmovk_g1, Value.SectionID);
1236         addRelocationForSection(REmovk_g0, Value.SectionID);
1237       }
1238       resolveRelocation(Section, Offset,
1239                         (uint64_t)Section.Address + Section.StubOffset, RelType,
1240                         0);
1241       Section.StubOffset += getMaxStubSize();
1242     }
1243   } else if (Arch == Triple::arm) {
1244     if (RelType == ELF::R_ARM_PC24 || RelType == ELF::R_ARM_CALL ||
1245       RelType == ELF::R_ARM_JUMP24) {
1246       // This is an ARM branch relocation, need to use a stub function.
1247       DEBUG(dbgs() << "\t\tThis is an ARM branch relocation.");
1248       SectionEntry &Section = Sections[SectionID];
1249
1250       // Look for an existing stub.
1251       StubMap::const_iterator i = Stubs.find(Value);
1252       if (i != Stubs.end()) {
1253         resolveRelocation(Section, Offset, (uint64_t)Section.Address + i->second,
1254           RelType, 0);
1255         DEBUG(dbgs() << " Stub function found\n");
1256       } else {
1257         // Create a new stub function.
1258         DEBUG(dbgs() << " Create a new stub function\n");
1259         Stubs[Value] = Section.StubOffset;
1260         uint8_t *StubTargetAddr =
1261           createStubFunction(Section.Address + Section.StubOffset);
1262         RelocationEntry RE(SectionID, StubTargetAddr - Section.Address,
1263           ELF::R_ARM_ABS32, Value.Addend);
1264         if (Value.SymbolName)
1265           addRelocationForSymbol(RE, Value.SymbolName);
1266         else
1267           addRelocationForSection(RE, Value.SectionID);
1268
1269         resolveRelocation(Section, Offset,
1270           (uint64_t)Section.Address + Section.StubOffset, RelType,
1271           0);
1272         Section.StubOffset += getMaxStubSize();
1273       }
1274     } else {
1275       uint32_t *Placeholder =
1276         reinterpret_cast<uint32_t*>(computePlaceholderAddress(SectionID, Offset));
1277       if (RelType == ELF::R_ARM_PREL31 || RelType == ELF::R_ARM_TARGET1 ||
1278           RelType == ELF::R_ARM_ABS32) {
1279         Value.Addend += *Placeholder;
1280       } else if (RelType == ELF::R_ARM_MOVW_ABS_NC || RelType == ELF::R_ARM_MOVT_ABS) {
1281         // See ELF for ARM documentation
1282         Value.Addend += (int16_t)((*Placeholder & 0xFFF) | (((*Placeholder >> 16) & 0xF) << 12));
1283       }
1284       processSimpleRelocation(SectionID, Offset, RelType, Value);
1285     }
1286   } else if (IsMipsO32ABI) {
1287     uint8_t *Placeholder = reinterpret_cast<uint8_t *>(
1288         computePlaceholderAddress(SectionID, Offset));
1289     uint32_t Opcode = readBytesUnaligned(Placeholder, 4);
1290     if (RelType == ELF::R_MIPS_26) {
1291       // This is an Mips branch relocation, need to use a stub function.
1292       DEBUG(dbgs() << "\t\tThis is a Mips branch relocation.");
1293       SectionEntry &Section = Sections[SectionID];
1294
1295       // Extract the addend from the instruction.
1296       // We shift up by two since the Value will be down shifted again
1297       // when applying the relocation.
1298       uint32_t Addend = (Opcode & 0x03ffffff) << 2;
1299
1300       Value.Addend += Addend;
1301
1302       //  Look up for existing stub.
1303       StubMap::const_iterator i = Stubs.find(Value);
1304       if (i != Stubs.end()) {
1305         RelocationEntry RE(SectionID, Offset, RelType, i->second);
1306         addRelocationForSection(RE, SectionID);
1307         DEBUG(dbgs() << " Stub function found\n");
1308       } else {
1309         // Create a new stub function.
1310         DEBUG(dbgs() << " Create a new stub function\n");
1311         Stubs[Value] = Section.StubOffset;
1312         uint8_t *StubTargetAddr =
1313           createStubFunction(Section.Address + Section.StubOffset);
1314
1315         // Creating Hi and Lo relocations for the filled stub instructions.
1316         RelocationEntry REHi(SectionID, StubTargetAddr - Section.Address,
1317           ELF::R_MIPS_HI16, Value.Addend);
1318         RelocationEntry RELo(SectionID, StubTargetAddr - Section.Address + 4,
1319           ELF::R_MIPS_LO16, Value.Addend);
1320
1321         if (Value.SymbolName) {
1322           addRelocationForSymbol(REHi, Value.SymbolName);
1323           addRelocationForSymbol(RELo, Value.SymbolName);
1324         }
1325         else {
1326           addRelocationForSection(REHi, Value.SectionID);
1327           addRelocationForSection(RELo, Value.SectionID);
1328         }
1329
1330         RelocationEntry RE(SectionID, Offset, RelType, Section.StubOffset);
1331         addRelocationForSection(RE, SectionID);
1332         Section.StubOffset += getMaxStubSize();
1333       }
1334     } else {
1335       // FIXME: Calculate correct addends for R_MIPS_HI16, R_MIPS_LO16,
1336       // R_MIPS_PCHI16 and R_MIPS_PCLO16 relocations.
1337       if (RelType == ELF::R_MIPS_HI16 || RelType == ELF::R_MIPS_PCHI16)
1338         Value.Addend += (Opcode & 0x0000ffff) << 16;
1339       else if (RelType == ELF::R_MIPS_LO16)
1340         Value.Addend += (Opcode & 0x0000ffff);
1341       else if (RelType == ELF::R_MIPS_32)
1342         Value.Addend += Opcode;
1343       else if (RelType == ELF::R_MIPS_PCLO16)
1344         Value.Addend += SignExtend32<16>((Opcode & 0x0000ffff));
1345       else if (RelType == ELF::R_MIPS_PC16)
1346         Value.Addend += SignExtend32<18>((Opcode & 0x0000ffff) << 2);
1347       else if (RelType == ELF::R_MIPS_PC19_S2)
1348         Value.Addend += SignExtend32<21>((Opcode & 0x0007ffff) << 2);
1349       else if (RelType == ELF::R_MIPS_PC21_S2)
1350         Value.Addend += SignExtend32<23>((Opcode & 0x001fffff) << 2);
1351       else if (RelType == ELF::R_MIPS_PC26_S2)
1352         Value.Addend += SignExtend32<28>((Opcode & 0x03ffffff) << 2);
1353       processSimpleRelocation(SectionID, Offset, RelType, Value);
1354     }
1355   } else if (IsMipsN64ABI) {
1356     uint32_t r_type = RelType & 0xff;
1357     RelocationEntry RE(SectionID, Offset, RelType, Value.Addend);
1358     if (r_type == ELF::R_MIPS_CALL16 || r_type == ELF::R_MIPS_GOT_PAGE
1359         || r_type == ELF::R_MIPS_GOT_DISP) {
1360       StringMap<uint64_t>::iterator i = GOTSymbolOffsets.find(TargetName);
1361       if (i != GOTSymbolOffsets.end())
1362         RE.SymOffset = i->second;
1363       else {
1364         RE.SymOffset = allocateGOTEntries(SectionID, 1);
1365         GOTSymbolOffsets[TargetName] = RE.SymOffset;
1366       }
1367     }
1368     if (Value.SymbolName)
1369       addRelocationForSymbol(RE, Value.SymbolName);
1370     else
1371       addRelocationForSection(RE, Value.SectionID);
1372   } else if (Arch == Triple::ppc64 || Arch == Triple::ppc64le) {
1373     if (RelType == ELF::R_PPC64_REL24) {
1374       // Determine ABI variant in use for this object.
1375       unsigned AbiVariant;
1376       Obj.getPlatformFlags(AbiVariant);
1377       AbiVariant &= ELF::EF_PPC64_ABI;
1378       // A PPC branch relocation will need a stub function if the target is
1379       // an external symbol (Symbol::ST_Unknown) or if the target address
1380       // is not within the signed 24-bits branch address.
1381       SectionEntry &Section = Sections[SectionID];
1382       uint8_t *Target = Section.Address + Offset;
1383       bool RangeOverflow = false;
1384       if (SymType != SymbolRef::ST_Unknown) {
1385         if (AbiVariant != 2) {
1386           // In the ELFv1 ABI, a function call may point to the .opd entry,
1387           // so the final symbol value is calculated based on the relocation
1388           // values in the .opd section.
1389           findOPDEntrySection(Obj, ObjSectionToID, Value);
1390         } else {
1391           // In the ELFv2 ABI, a function symbol may provide a local entry
1392           // point, which must be used for direct calls.
1393           uint8_t SymOther = Symbol->getOther();
1394           Value.Addend += ELF::decodePPC64LocalEntryOffset(SymOther);
1395         }
1396         uint8_t *RelocTarget = Sections[Value.SectionID].Address + Value.Addend;
1397         int32_t delta = static_cast<int32_t>(Target - RelocTarget);
1398         // If it is within 24-bits branch range, just set the branch target
1399         if (SignExtend32<24>(delta) == delta) {
1400           RelocationEntry RE(SectionID, Offset, RelType, Value.Addend);
1401           if (Value.SymbolName)
1402             addRelocationForSymbol(RE, Value.SymbolName);
1403           else
1404             addRelocationForSection(RE, Value.SectionID);
1405         } else {
1406           RangeOverflow = true;
1407         }
1408       }
1409       if (SymType == SymbolRef::ST_Unknown || RangeOverflow) {
1410         // It is an external symbol (SymbolRef::ST_Unknown) or within a range
1411         // larger than 24-bits.
1412         StubMap::const_iterator i = Stubs.find(Value);
1413         if (i != Stubs.end()) {
1414           // Symbol function stub already created, just relocate to it
1415           resolveRelocation(Section, Offset,
1416                             (uint64_t)Section.Address + i->second, RelType, 0);
1417           DEBUG(dbgs() << " Stub function found\n");
1418         } else {
1419           // Create a new stub function.
1420           DEBUG(dbgs() << " Create a new stub function\n");
1421           Stubs[Value] = Section.StubOffset;
1422           uint8_t *StubTargetAddr =
1423               createStubFunction(Section.Address + Section.StubOffset,
1424                                  AbiVariant);
1425           RelocationEntry RE(SectionID, StubTargetAddr - Section.Address,
1426                              ELF::R_PPC64_ADDR64, Value.Addend);
1427
1428           // Generates the 64-bits address loads as exemplified in section
1429           // 4.5.1 in PPC64 ELF ABI.  Note that the relocations need to
1430           // apply to the low part of the instructions, so we have to update
1431           // the offset according to the target endianness.
1432           uint64_t StubRelocOffset = StubTargetAddr - Section.Address;
1433           if (!IsTargetLittleEndian)
1434             StubRelocOffset += 2;
1435
1436           RelocationEntry REhst(SectionID, StubRelocOffset + 0,
1437                                 ELF::R_PPC64_ADDR16_HIGHEST, Value.Addend);
1438           RelocationEntry REhr(SectionID, StubRelocOffset + 4,
1439                                ELF::R_PPC64_ADDR16_HIGHER, Value.Addend);
1440           RelocationEntry REh(SectionID, StubRelocOffset + 12,
1441                               ELF::R_PPC64_ADDR16_HI, Value.Addend);
1442           RelocationEntry REl(SectionID, StubRelocOffset + 16,
1443                               ELF::R_PPC64_ADDR16_LO, Value.Addend);
1444
1445           if (Value.SymbolName) {
1446             addRelocationForSymbol(REhst, Value.SymbolName);
1447             addRelocationForSymbol(REhr, Value.SymbolName);
1448             addRelocationForSymbol(REh, Value.SymbolName);
1449             addRelocationForSymbol(REl, Value.SymbolName);
1450           } else {
1451             addRelocationForSection(REhst, Value.SectionID);
1452             addRelocationForSection(REhr, Value.SectionID);
1453             addRelocationForSection(REh, Value.SectionID);
1454             addRelocationForSection(REl, Value.SectionID);
1455           }
1456
1457           resolveRelocation(Section, Offset,
1458                             (uint64_t)Section.Address + Section.StubOffset,
1459                             RelType, 0);
1460           Section.StubOffset += getMaxStubSize();
1461         }
1462         if (SymType == SymbolRef::ST_Unknown) {
1463           // Restore the TOC for external calls
1464           if (AbiVariant == 2)
1465             writeInt32BE(Target + 4, 0xE8410018); // ld r2,28(r1)
1466           else
1467             writeInt32BE(Target + 4, 0xE8410028); // ld r2,40(r1)
1468         }
1469       }
1470     } else if (RelType == ELF::R_PPC64_TOC16 ||
1471                RelType == ELF::R_PPC64_TOC16_DS ||
1472                RelType == ELF::R_PPC64_TOC16_LO ||
1473                RelType == ELF::R_PPC64_TOC16_LO_DS ||
1474                RelType == ELF::R_PPC64_TOC16_HI ||
1475                RelType == ELF::R_PPC64_TOC16_HA) {
1476       // These relocations are supposed to subtract the TOC address from
1477       // the final value.  This does not fit cleanly into the RuntimeDyld
1478       // scheme, since there may be *two* sections involved in determining
1479       // the relocation value (the section of the symbol refered to by the
1480       // relocation, and the TOC section associated with the current module).
1481       //
1482       // Fortunately, these relocations are currently only ever generated
1483       // refering to symbols that themselves reside in the TOC, which means
1484       // that the two sections are actually the same.  Thus they cancel out
1485       // and we can immediately resolve the relocation right now.
1486       switch (RelType) {
1487       case ELF::R_PPC64_TOC16: RelType = ELF::R_PPC64_ADDR16; break;
1488       case ELF::R_PPC64_TOC16_DS: RelType = ELF::R_PPC64_ADDR16_DS; break;
1489       case ELF::R_PPC64_TOC16_LO: RelType = ELF::R_PPC64_ADDR16_LO; break;
1490       case ELF::R_PPC64_TOC16_LO_DS: RelType = ELF::R_PPC64_ADDR16_LO_DS; break;
1491       case ELF::R_PPC64_TOC16_HI: RelType = ELF::R_PPC64_ADDR16_HI; break;
1492       case ELF::R_PPC64_TOC16_HA: RelType = ELF::R_PPC64_ADDR16_HA; break;
1493       default: llvm_unreachable("Wrong relocation type.");
1494       }
1495
1496       RelocationValueRef TOCValue;
1497       findPPC64TOCSection(Obj, ObjSectionToID, TOCValue);
1498       if (Value.SymbolName || Value.SectionID != TOCValue.SectionID)
1499         llvm_unreachable("Unsupported TOC relocation.");
1500       Value.Addend -= TOCValue.Addend;
1501       resolveRelocation(Sections[SectionID], Offset, Value.Addend, RelType, 0);
1502     } else {
1503       // There are two ways to refer to the TOC address directly: either
1504       // via a ELF::R_PPC64_TOC relocation (where both symbol and addend are
1505       // ignored), or via any relocation that refers to the magic ".TOC."
1506       // symbols (in which case the addend is respected).
1507       if (RelType == ELF::R_PPC64_TOC) {
1508         RelType = ELF::R_PPC64_ADDR64;
1509         findPPC64TOCSection(Obj, ObjSectionToID, Value);
1510       } else if (TargetName == ".TOC.") {
1511         findPPC64TOCSection(Obj, ObjSectionToID, Value);
1512         Value.Addend += Addend;
1513       }
1514
1515       RelocationEntry RE(SectionID, Offset, RelType, Value.Addend);
1516
1517       if (Value.SymbolName)
1518         addRelocationForSymbol(RE, Value.SymbolName);
1519       else
1520         addRelocationForSection(RE, Value.SectionID);
1521     }
1522   } else if (Arch == Triple::systemz &&
1523              (RelType == ELF::R_390_PLT32DBL || RelType == ELF::R_390_GOTENT)) {
1524     // Create function stubs for both PLT and GOT references, regardless of
1525     // whether the GOT reference is to data or code.  The stub contains the
1526     // full address of the symbol, as needed by GOT references, and the
1527     // executable part only adds an overhead of 8 bytes.
1528     //
1529     // We could try to conserve space by allocating the code and data
1530     // parts of the stub separately.  However, as things stand, we allocate
1531     // a stub for every relocation, so using a GOT in JIT code should be
1532     // no less space efficient than using an explicit constant pool.
1533     DEBUG(dbgs() << "\t\tThis is a SystemZ indirect relocation.");
1534     SectionEntry &Section = Sections[SectionID];
1535
1536     // Look for an existing stub.
1537     StubMap::const_iterator i = Stubs.find(Value);
1538     uintptr_t StubAddress;
1539     if (i != Stubs.end()) {
1540       StubAddress = uintptr_t(Section.Address) + i->second;
1541       DEBUG(dbgs() << " Stub function found\n");
1542     } else {
1543       // Create a new stub function.
1544       DEBUG(dbgs() << " Create a new stub function\n");
1545
1546       uintptr_t BaseAddress = uintptr_t(Section.Address);
1547       uintptr_t StubAlignment = getStubAlignment();
1548       StubAddress = (BaseAddress + Section.StubOffset + StubAlignment - 1) &
1549                     -StubAlignment;
1550       unsigned StubOffset = StubAddress - BaseAddress;
1551
1552       Stubs[Value] = StubOffset;
1553       createStubFunction((uint8_t *)StubAddress);
1554       RelocationEntry RE(SectionID, StubOffset + 8, ELF::R_390_64,
1555                          Value.Offset);
1556       if (Value.SymbolName)
1557         addRelocationForSymbol(RE, Value.SymbolName);
1558       else
1559         addRelocationForSection(RE, Value.SectionID);
1560       Section.StubOffset = StubOffset + getMaxStubSize();
1561     }
1562
1563     if (RelType == ELF::R_390_GOTENT)
1564       resolveRelocation(Section, Offset, StubAddress + 8, ELF::R_390_PC32DBL,
1565                         Addend);
1566     else
1567       resolveRelocation(Section, Offset, StubAddress, RelType, Addend);
1568   } else if (Arch == Triple::x86_64) {
1569     if (RelType == ELF::R_X86_64_PLT32) {
1570       // The way the PLT relocations normally work is that the linker allocates
1571       // the
1572       // PLT and this relocation makes a PC-relative call into the PLT.  The PLT
1573       // entry will then jump to an address provided by the GOT.  On first call,
1574       // the
1575       // GOT address will point back into PLT code that resolves the symbol. After
1576       // the first call, the GOT entry points to the actual function.
1577       //
1578       // For local functions we're ignoring all of that here and just replacing
1579       // the PLT32 relocation type with PC32, which will translate the relocation
1580       // into a PC-relative call directly to the function. For external symbols we
1581       // can't be sure the function will be within 2^32 bytes of the call site, so
1582       // we need to create a stub, which calls into the GOT.  This case is
1583       // equivalent to the usual PLT implementation except that we use the stub
1584       // mechanism in RuntimeDyld (which puts stubs at the end of the section)
1585       // rather than allocating a PLT section.
1586       if (Value.SymbolName) {
1587         // This is a call to an external function.
1588         // Look for an existing stub.
1589         SectionEntry &Section = Sections[SectionID];
1590         StubMap::const_iterator i = Stubs.find(Value);
1591         uintptr_t StubAddress;
1592         if (i != Stubs.end()) {
1593         StubAddress = uintptr_t(Section.Address) + i->second;
1594         DEBUG(dbgs() << " Stub function found\n");
1595         } else {
1596         // Create a new stub function (equivalent to a PLT entry).
1597         DEBUG(dbgs() << " Create a new stub function\n");
1598
1599         uintptr_t BaseAddress = uintptr_t(Section.Address);
1600         uintptr_t StubAlignment = getStubAlignment();
1601         StubAddress = (BaseAddress + Section.StubOffset + StubAlignment - 1) &
1602                 -StubAlignment;
1603         unsigned StubOffset = StubAddress - BaseAddress;
1604         Stubs[Value] = StubOffset;
1605         createStubFunction((uint8_t *)StubAddress);
1606
1607         // Bump our stub offset counter
1608         Section.StubOffset = StubOffset + getMaxStubSize();
1609
1610         // Allocate a GOT Entry
1611         uint64_t GOTOffset = allocateGOTEntries(SectionID, 1);
1612
1613         // The load of the GOT address has an addend of -4
1614         resolveGOTOffsetRelocation(SectionID, StubOffset + 2, GOTOffset - 4);
1615
1616         // Fill in the value of the symbol we're targeting into the GOT
1617         addRelocationForSymbol(computeGOTOffsetRE(SectionID,GOTOffset,0,ELF::R_X86_64_64),
1618           Value.SymbolName);
1619         }
1620
1621         // Make the target call a call into the stub table.
1622         resolveRelocation(Section, Offset, StubAddress, ELF::R_X86_64_PC32,
1623                 Addend);
1624       } else {
1625         RelocationEntry RE(SectionID, Offset, ELF::R_X86_64_PC32, Value.Addend,
1626                   Value.Offset);
1627         addRelocationForSection(RE, Value.SectionID);
1628       }
1629     } else if (RelType == ELF::R_X86_64_GOTPCREL) {
1630       uint64_t GOTOffset = allocateGOTEntries(SectionID, 1);
1631       resolveGOTOffsetRelocation(SectionID, Offset, GOTOffset + Addend);
1632
1633       // Fill in the value of the symbol we're targeting into the GOT
1634       RelocationEntry RE = computeGOTOffsetRE(SectionID, GOTOffset, Value.Offset, ELF::R_X86_64_64);
1635       if (Value.SymbolName)
1636         addRelocationForSymbol(RE, Value.SymbolName);
1637       else
1638         addRelocationForSection(RE, Value.SectionID);
1639     } else if (RelType == ELF::R_X86_64_PC32) {
1640       Value.Addend += support::ulittle32_t::ref(computePlaceholderAddress(SectionID, Offset));
1641       processSimpleRelocation(SectionID, Offset, RelType, Value);
1642     } else if (RelType == ELF::R_X86_64_PC64) {
1643       Value.Addend += support::ulittle64_t::ref(computePlaceholderAddress(SectionID, Offset));
1644       processSimpleRelocation(SectionID, Offset, RelType, Value);
1645     } else {
1646       processSimpleRelocation(SectionID, Offset, RelType, Value);
1647     }
1648   } else {
1649     if (Arch == Triple::x86) {
1650       Value.Addend += support::ulittle32_t::ref(computePlaceholderAddress(SectionID, Offset));
1651     }
1652     processSimpleRelocation(SectionID, Offset, RelType, Value);
1653   }
1654   return ++RelI;
1655 }
1656
1657 size_t RuntimeDyldELF::getGOTEntrySize() {
1658   // We don't use the GOT in all of these cases, but it's essentially free
1659   // to put them all here.
1660   size_t Result = 0;
1661   switch (Arch) {
1662   case Triple::x86_64:
1663   case Triple::aarch64:
1664   case Triple::aarch64_be:
1665   case Triple::ppc64:
1666   case Triple::ppc64le:
1667   case Triple::systemz:
1668     Result = sizeof(uint64_t);
1669     break;
1670   case Triple::x86:
1671   case Triple::arm:
1672   case Triple::thumb:
1673     Result = sizeof(uint32_t);
1674     break;
1675   case Triple::mips:
1676   case Triple::mipsel:
1677   case Triple::mips64:
1678   case Triple::mips64el:
1679     if (IsMipsO32ABI)
1680       Result = sizeof(uint32_t);
1681     else if (IsMipsN64ABI)
1682       Result = sizeof(uint64_t);
1683     else
1684       llvm_unreachable("Mips ABI not handled");
1685     break;
1686   default:
1687     llvm_unreachable("Unsupported CPU type!");
1688   }
1689   return Result;
1690 }
1691
1692 uint64_t RuntimeDyldELF::allocateGOTEntries(unsigned SectionID, unsigned no)
1693 {
1694   (void)SectionID; // The GOT Section is the same for all section in the object file
1695   if (GOTSectionID == 0) {
1696     GOTSectionID = Sections.size();
1697     // Reserve a section id. We'll allocate the section later
1698     // once we know the total size
1699     Sections.push_back(SectionEntry(".got", 0, 0, 0));
1700   }
1701   uint64_t StartOffset = CurrentGOTIndex * getGOTEntrySize();
1702   CurrentGOTIndex += no;
1703   return StartOffset;
1704 }
1705
1706 void RuntimeDyldELF::resolveGOTOffsetRelocation(unsigned SectionID, uint64_t Offset, uint64_t GOTOffset)
1707 {
1708   // Fill in the relative address of the GOT Entry into the stub
1709   RelocationEntry GOTRE(SectionID, Offset, ELF::R_X86_64_PC32, GOTOffset);
1710   addRelocationForSection(GOTRE, GOTSectionID);
1711 }
1712
1713 RelocationEntry RuntimeDyldELF::computeGOTOffsetRE(unsigned SectionID, uint64_t GOTOffset, uint64_t SymbolOffset,
1714                                                    uint32_t Type)
1715 {
1716   (void)SectionID; // The GOT Section is the same for all section in the object file
1717   return RelocationEntry(GOTSectionID, GOTOffset, Type, SymbolOffset);
1718 }
1719
1720 void RuntimeDyldELF::finalizeLoad(const ObjectFile &Obj,
1721                                   ObjSectionToIDMap &SectionMap) {
1722   // If necessary, allocate the global offset table
1723   if (GOTSectionID != 0) {
1724     // Allocate memory for the section
1725     size_t TotalSize = CurrentGOTIndex * getGOTEntrySize();
1726     uint8_t *Addr = MemMgr.allocateDataSection(TotalSize, getGOTEntrySize(),
1727                                                 GOTSectionID, ".got", false);
1728     if (!Addr)
1729       report_fatal_error("Unable to allocate memory for GOT!");
1730
1731     Sections[GOTSectionID] = SectionEntry(".got", Addr, TotalSize, 0);
1732
1733     if (Checker)
1734       Checker->registerSection(Obj.getFileName(), GOTSectionID);
1735
1736     // For now, initialize all GOT entries to zero.  We'll fill them in as
1737     // needed when GOT-based relocations are applied.
1738     memset(Addr, 0, TotalSize);
1739     if (IsMipsN64ABI) {
1740       // To correctly resolve Mips GOT relocations, we need a mapping from
1741       // object's sections to GOTs.
1742       for (section_iterator SI = Obj.section_begin(), SE = Obj.section_end();
1743            SI != SE; ++SI) {
1744         if (SI->relocation_begin() != SI->relocation_end()) {
1745           section_iterator RelocatedSection = SI->getRelocatedSection();
1746           ObjSectionToIDMap::iterator i = SectionMap.find(*RelocatedSection);
1747           assert (i != SectionMap.end());
1748           SectionToGOTMap[i->second] = GOTSectionID;
1749         }
1750       }
1751       GOTSymbolOffsets.clear();
1752     }
1753   }
1754
1755   // Look for and record the EH frame section.
1756   ObjSectionToIDMap::iterator i, e;
1757   for (i = SectionMap.begin(), e = SectionMap.end(); i != e; ++i) {
1758     const SectionRef &Section = i->first;
1759     StringRef Name;
1760     Section.getName(Name);
1761     if (Name == ".eh_frame") {
1762       UnregisteredEHFrameSections.push_back(i->second);
1763       break;
1764     }
1765   }
1766
1767   GOTSectionID = 0;
1768   CurrentGOTIndex = 0;
1769 }
1770
1771 bool RuntimeDyldELF::isCompatibleFile(const object::ObjectFile &Obj) const {
1772   return Obj.isELF();
1773 }
1774
1775 } // namespace llvm