Handle relocations that don't point to symbols.
[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 #define DEBUG_TYPE "dyld"
15 #include "RuntimeDyldELF.h"
16 #include "JITRegistrar.h"
17 #include "ObjectImageCommon.h"
18 #include "llvm/ADT/IntervalMap.h"
19 #include "llvm/ADT/OwningPtr.h"
20 #include "llvm/ADT/STLExtras.h"
21 #include "llvm/ADT/StringRef.h"
22 #include "llvm/ADT/Triple.h"
23 #include "llvm/ExecutionEngine/ObjectBuffer.h"
24 #include "llvm/ExecutionEngine/ObjectImage.h"
25 #include "llvm/Object/ELF.h"
26 #include "llvm/Object/ObjectFile.h"
27 #include "llvm/Support/ELF.h"
28 using namespace llvm;
29 using namespace llvm::object;
30
31 namespace {
32
33 static inline
34 error_code check(error_code Err) {
35   if (Err) {
36     report_fatal_error(Err.message());
37   }
38   return Err;
39 }
40
41 template<class ELFT>
42 class DyldELFObject
43   : public ELFObjectFile<ELFT> {
44   LLVM_ELF_IMPORT_TYPES_ELFT(ELFT)
45
46   typedef Elf_Shdr_Impl<ELFT> Elf_Shdr;
47   typedef Elf_Sym_Impl<ELFT> Elf_Sym;
48   typedef
49     Elf_Rel_Impl<ELFT, false> Elf_Rel;
50   typedef
51     Elf_Rel_Impl<ELFT, true> Elf_Rela;
52
53   typedef Elf_Ehdr_Impl<ELFT> Elf_Ehdr;
54
55   typedef typename ELFDataTypeTypedefHelper<
56           ELFT>::value_type addr_type;
57
58 public:
59   DyldELFObject(MemoryBuffer *Wrapper, error_code &ec);
60
61   void updateSectionAddress(const SectionRef &Sec, uint64_t Addr);
62   void updateSymbolAddress(const SymbolRef &Sym, uint64_t Addr);
63
64   // Methods for type inquiry through isa, cast and dyn_cast
65   static inline bool classof(const Binary *v) {
66     return (isa<ELFObjectFile<ELFT> >(v)
67             && classof(cast<ELFObjectFile
68                 <ELFT> >(v)));
69   }
70   static inline bool classof(
71       const ELFObjectFile<ELFT> *v) {
72     return v->isDyldType();
73   }
74 };
75
76 template<class ELFT>
77 class ELFObjectImage : public ObjectImageCommon {
78   protected:
79     DyldELFObject<ELFT> *DyldObj;
80     bool Registered;
81
82   public:
83     ELFObjectImage(ObjectBuffer *Input,
84                  DyldELFObject<ELFT> *Obj)
85     : ObjectImageCommon(Input, Obj),
86       DyldObj(Obj),
87       Registered(false) {}
88
89     virtual ~ELFObjectImage() {
90       if (Registered)
91         deregisterWithDebugger();
92     }
93
94     // Subclasses can override these methods to update the image with loaded
95     // addresses for sections and common symbols
96     virtual void updateSectionAddress(const SectionRef &Sec, uint64_t Addr)
97     {
98       DyldObj->updateSectionAddress(Sec, Addr);
99     }
100
101     virtual void updateSymbolAddress(const SymbolRef &Sym, uint64_t Addr)
102     {
103       DyldObj->updateSymbolAddress(Sym, Addr);
104     }
105
106     virtual void registerWithDebugger()
107     {
108       JITRegistrar::getGDBRegistrar().registerObject(*Buffer);
109       Registered = true;
110     }
111     virtual void deregisterWithDebugger()
112     {
113       JITRegistrar::getGDBRegistrar().deregisterObject(*Buffer);
114     }
115 };
116
117 // The MemoryBuffer passed into this constructor is just a wrapper around the
118 // actual memory.  Ultimately, the Binary parent class will take ownership of
119 // this MemoryBuffer object but not the underlying memory.
120 template<class ELFT>
121 DyldELFObject<ELFT>::DyldELFObject(MemoryBuffer *Wrapper, error_code &ec)
122   : ELFObjectFile<ELFT>(Wrapper, ec) {
123   this->isDyldELFObject = true;
124 }
125
126 template<class ELFT>
127 void DyldELFObject<ELFT>::updateSectionAddress(const SectionRef &Sec,
128                                                uint64_t Addr) {
129   DataRefImpl ShdrRef = Sec.getRawDataRefImpl();
130   Elf_Shdr *shdr = const_cast<Elf_Shdr*>(
131                           reinterpret_cast<const Elf_Shdr *>(ShdrRef.p));
132
133   // This assumes the address passed in matches the target address bitness
134   // The template-based type cast handles everything else.
135   shdr->sh_addr = static_cast<addr_type>(Addr);
136 }
137
138 template<class ELFT>
139 void DyldELFObject<ELFT>::updateSymbolAddress(const SymbolRef &SymRef,
140                                               uint64_t Addr) {
141
142   Elf_Sym *sym = const_cast<Elf_Sym*>(
143     ELFObjectFile<ELFT>::getSymbol(SymRef.getRawDataRefImpl()));
144
145   // This assumes the address passed in matches the target address bitness
146   // The template-based type cast handles everything else.
147   sym->st_value = static_cast<addr_type>(Addr);
148 }
149
150 } // namespace
151
152 namespace llvm {
153
154 StringRef RuntimeDyldELF::getEHFrameSection() {
155   for (int i = 0, e = Sections.size(); i != e; ++i) {
156     if (Sections[i].Name == ".eh_frame")
157       return StringRef((const char*)Sections[i].Address, Sections[i].Size);
158   }
159   return StringRef();
160 }
161
162 ObjectImage *RuntimeDyldELF::createObjectImage(ObjectBuffer *Buffer) {
163   if (Buffer->getBufferSize() < ELF::EI_NIDENT)
164     llvm_unreachable("Unexpected ELF object size");
165   std::pair<unsigned char, unsigned char> Ident = std::make_pair(
166                          (uint8_t)Buffer->getBufferStart()[ELF::EI_CLASS],
167                          (uint8_t)Buffer->getBufferStart()[ELF::EI_DATA]);
168   error_code ec;
169
170   if (Ident.first == ELF::ELFCLASS32 && Ident.second == ELF::ELFDATA2LSB) {
171     DyldELFObject<ELFType<support::little, 4, false> > *Obj =
172       new DyldELFObject<ELFType<support::little, 4, false> >(
173         Buffer->getMemBuffer(), ec);
174     return new ELFObjectImage<ELFType<support::little, 4, false> >(Buffer, Obj);
175   }
176   else if (Ident.first == ELF::ELFCLASS32 && Ident.second == ELF::ELFDATA2MSB) {
177     DyldELFObject<ELFType<support::big, 4, false> > *Obj =
178       new DyldELFObject<ELFType<support::big, 4, false> >(
179         Buffer->getMemBuffer(), ec);
180     return new ELFObjectImage<ELFType<support::big, 4, false> >(Buffer, Obj);
181   }
182   else if (Ident.first == ELF::ELFCLASS64 && Ident.second == ELF::ELFDATA2MSB) {
183     DyldELFObject<ELFType<support::big, 8, true> > *Obj =
184       new DyldELFObject<ELFType<support::big, 8, true> >(
185         Buffer->getMemBuffer(), ec);
186     return new ELFObjectImage<ELFType<support::big, 8, true> >(Buffer, Obj);
187   }
188   else if (Ident.first == ELF::ELFCLASS64 && Ident.second == ELF::ELFDATA2LSB) {
189     DyldELFObject<ELFType<support::little, 8, true> > *Obj =
190       new DyldELFObject<ELFType<support::little, 8, true> >(
191         Buffer->getMemBuffer(), ec);
192     return new ELFObjectImage<ELFType<support::little, 8, true> >(Buffer, Obj);
193   }
194   else
195     llvm_unreachable("Unexpected ELF format");
196 }
197
198 RuntimeDyldELF::~RuntimeDyldELF() {
199 }
200
201 void RuntimeDyldELF::resolveX86_64Relocation(const SectionEntry &Section,
202                                              uint64_t Offset,
203                                              uint64_t Value,
204                                              uint32_t Type,
205                                              int64_t Addend) {
206   switch (Type) {
207   default:
208     llvm_unreachable("Relocation type not implemented yet!");
209   break;
210   case ELF::R_X86_64_64: {
211     uint64_t *Target = reinterpret_cast<uint64_t*>(Section.Address + Offset);
212     *Target = Value + Addend;
213     DEBUG(dbgs() << "Writing " << format("%p", (Value + Addend))
214                  << " at " << format("%p\n",Target));
215     break;
216   }
217   case ELF::R_X86_64_32:
218   case ELF::R_X86_64_32S: {
219     Value += Addend;
220     assert((Type == ELF::R_X86_64_32 && (Value <= UINT32_MAX)) ||
221            (Type == ELF::R_X86_64_32S &&
222              ((int64_t)Value <= INT32_MAX && (int64_t)Value >= INT32_MIN)));
223     uint32_t TruncatedAddr = (Value & 0xFFFFFFFF);
224     uint32_t *Target = reinterpret_cast<uint32_t*>(Section.Address + Offset);
225     *Target = TruncatedAddr;
226     DEBUG(dbgs() << "Writing " << format("%p", TruncatedAddr)
227                  << " at " << format("%p\n",Target));
228     break;
229   }
230   case ELF::R_X86_64_PC32: {
231     // Get the placeholder value from the generated object since
232     // a previous relocation attempt may have overwritten the loaded version
233     uint32_t *Placeholder = reinterpret_cast<uint32_t*>(Section.ObjAddress
234                                                                    + Offset);
235     uint32_t *Target = reinterpret_cast<uint32_t*>(Section.Address + Offset);
236     uint64_t  FinalAddress = Section.LoadAddress + Offset;
237     int64_t RealOffset = *Placeholder + Value + Addend - FinalAddress;
238     assert(RealOffset <= INT32_MAX && RealOffset >= INT32_MIN);
239     int32_t TruncOffset = (RealOffset & 0xFFFFFFFF);
240     *Target = TruncOffset;
241     break;
242   }
243   }
244 }
245
246 void RuntimeDyldELF::resolveX86Relocation(const SectionEntry &Section,
247                                           uint64_t Offset,
248                                           uint32_t Value,
249                                           uint32_t Type,
250                                           int32_t Addend) {
251   switch (Type) {
252   case ELF::R_386_32: {
253     // Get the placeholder value from the generated object since
254     // a previous relocation attempt may have overwritten the loaded version
255     uint32_t *Placeholder = reinterpret_cast<uint32_t*>(Section.ObjAddress
256                                                                    + Offset);
257     uint32_t *Target = reinterpret_cast<uint32_t*>(Section.Address + Offset);
258     *Target = *Placeholder + Value + Addend;
259     break;
260   }
261   case ELF::R_386_PC32: {
262     // Get the placeholder value from the generated object since
263     // a previous relocation attempt may have overwritten the loaded version
264     uint32_t *Placeholder = reinterpret_cast<uint32_t*>(Section.ObjAddress
265                                                                    + Offset);
266     uint32_t *Target = reinterpret_cast<uint32_t*>(Section.Address + Offset);
267     uint32_t  FinalAddress = ((Section.LoadAddress + Offset) & 0xFFFFFFFF);
268     uint32_t RealOffset = *Placeholder + Value + Addend - FinalAddress;
269     *Target = RealOffset;
270     break;
271     }
272     default:
273       // There are other relocation types, but it appears these are the
274       // only ones currently used by the LLVM ELF object writer
275       llvm_unreachable("Relocation type not implemented yet!");
276       break;
277   }
278 }
279
280 void RuntimeDyldELF::resolveAArch64Relocation(const SectionEntry &Section,
281                                               uint64_t Offset,
282                                               uint64_t Value,
283                                               uint32_t Type,
284                                               int64_t Addend) {
285   uint32_t *TargetPtr = reinterpret_cast<uint32_t*>(Section.Address + Offset);
286   uint64_t FinalAddress = Section.LoadAddress + Offset;
287
288   DEBUG(dbgs() << "resolveAArch64Relocation, LocalAddress: 0x"
289                << format("%llx", Section.Address + Offset)
290                << " FinalAddress: 0x" << format("%llx",FinalAddress)
291                << " Value: 0x" << format("%llx",Value)
292                << " Type: 0x" << format("%x",Type)
293                << " Addend: 0x" << format("%llx",Addend)
294                << "\n");
295
296   switch (Type) {
297   default:
298     llvm_unreachable("Relocation type not implemented yet!");
299     break;
300   case ELF::R_AARCH64_ABS64: {
301     uint64_t *TargetPtr = reinterpret_cast<uint64_t*>(Section.Address + Offset);
302     *TargetPtr = Value + Addend;
303     break;
304   }
305   case ELF::R_AARCH64_PREL32: {
306     uint64_t Result = Value + Addend - FinalAddress;
307     assert(static_cast<int64_t>(Result) >= INT32_MIN && 
308            static_cast<int64_t>(Result) <= UINT32_MAX);
309     *TargetPtr = static_cast<uint32_t>(Result & 0xffffffffU);
310     break;
311   }
312   case ELF::R_AARCH64_CALL26: // fallthrough
313   case ELF::R_AARCH64_JUMP26: {
314     // Operation: S+A-P. Set Call or B immediate value to bits fff_fffc of the
315     // calculation.
316     uint64_t BranchImm = Value + Addend - FinalAddress;
317
318     // "Check that -2^27 <= result < 2^27".
319     assert(-(1LL << 27) <= static_cast<int64_t>(BranchImm) && 
320            static_cast<int64_t>(BranchImm) < (1LL << 27));
321
322     // AArch64 code is emitted with .rela relocations. The data already in any
323     // bits affected by the relocation on entry is garbage.
324     *TargetPtr &= 0xfc000000U;
325     // Immediate goes in bits 25:0 of B and BL.
326     *TargetPtr |= static_cast<uint32_t>(BranchImm & 0xffffffcU) >> 2;
327     break;
328   }
329   case ELF::R_AARCH64_MOVW_UABS_G3: {
330     uint64_t Result = Value + Addend;
331
332     // AArch64 code is emitted with .rela relocations. The data already in any
333     // bits affected by the relocation on entry is garbage.
334     *TargetPtr &= 0xff80001fU;
335     // Immediate goes in bits 20:5 of MOVZ/MOVK instruction
336     *TargetPtr |= Result >> (48 - 5);
337     // Shift is "lsl #48", in bits 22:21
338     *TargetPtr |= 3 << 21;
339     break;
340   }
341   case ELF::R_AARCH64_MOVW_UABS_G2_NC: {
342     uint64_t Result = Value + Addend;
343
344
345     // AArch64 code is emitted with .rela relocations. The data already in any
346     // bits affected by the relocation on entry is garbage.
347     *TargetPtr &= 0xff80001fU;
348     // Immediate goes in bits 20:5 of MOVZ/MOVK instruction
349     *TargetPtr |= ((Result & 0xffff00000000ULL) >> (32 - 5));
350     // Shift is "lsl #32", in bits 22:21
351     *TargetPtr |= 2 << 21;
352     break;
353   }
354   case ELF::R_AARCH64_MOVW_UABS_G1_NC: {
355     uint64_t Result = Value + Addend;
356
357     // AArch64 code is emitted with .rela relocations. The data already in any
358     // bits affected by the relocation on entry is garbage.
359     *TargetPtr &= 0xff80001fU;
360     // Immediate goes in bits 20:5 of MOVZ/MOVK instruction
361     *TargetPtr |= ((Result & 0xffff0000U) >> (16 - 5));
362     // Shift is "lsl #16", in bits 22:21
363     *TargetPtr |= 1 << 21;
364     break;
365   }
366   case ELF::R_AARCH64_MOVW_UABS_G0_NC: {
367     uint64_t Result = Value + Addend;
368
369     // AArch64 code is emitted with .rela relocations. The data already in any
370     // bits affected by the relocation on entry is garbage.
371     *TargetPtr &= 0xff80001fU;
372     // Immediate goes in bits 20:5 of MOVZ/MOVK instruction
373     *TargetPtr |= ((Result & 0xffffU) << 5);
374     // Shift is "lsl #0", in bits 22:21. No action needed.
375     break;
376   }
377   }
378 }
379
380 void RuntimeDyldELF::resolveARMRelocation(const SectionEntry &Section,
381                                           uint64_t Offset,
382                                           uint32_t Value,
383                                           uint32_t Type,
384                                           int32_t Addend) {
385   // TODO: Add Thumb relocations.
386   uint32_t *Placeholder = reinterpret_cast<uint32_t*>(Section.ObjAddress +
387                                                       Offset);
388   uint32_t* TargetPtr = (uint32_t*)(Section.Address + Offset);
389   uint32_t FinalAddress = ((Section.LoadAddress + Offset) & 0xFFFFFFFF);
390   Value += Addend;
391
392   DEBUG(dbgs() << "resolveARMRelocation, LocalAddress: "
393                << Section.Address + Offset
394                << " FinalAddress: " << format("%p",FinalAddress)
395                << " Value: " << format("%x",Value)
396                << " Type: " << format("%x",Type)
397                << " Addend: " << format("%x",Addend)
398                << "\n");
399
400   switch(Type) {
401   default:
402     llvm_unreachable("Not implemented relocation type!");
403
404   // Write a 32bit value to relocation address, taking into account the
405   // implicit addend encoded in the target.
406   case ELF::R_ARM_TARGET1:
407   case ELF::R_ARM_ABS32:
408     *TargetPtr = *Placeholder + Value;
409     break;
410   // Write first 16 bit of 32 bit value to the mov instruction.
411   // Last 4 bit should be shifted.
412   case ELF::R_ARM_MOVW_ABS_NC:
413     // We are not expecting any other addend in the relocation address.
414     // Using 0x000F0FFF because MOVW has its 16 bit immediate split into 2
415     // non-contiguous fields.
416     assert((*Placeholder & 0x000F0FFF) == 0);
417     Value = Value & 0xFFFF;
418     *TargetPtr = *Placeholder | (Value & 0xFFF);
419     *TargetPtr |= ((Value >> 12) & 0xF) << 16;
420     break;
421   // Write last 16 bit of 32 bit value to the mov instruction.
422   // Last 4 bit should be shifted.
423   case ELF::R_ARM_MOVT_ABS:
424     // We are not expecting any other addend in the relocation address.
425     // Use 0x000F0FFF for the same reason as R_ARM_MOVW_ABS_NC.
426     assert((*Placeholder & 0x000F0FFF) == 0);
427
428     Value = (Value >> 16) & 0xFFFF;
429     *TargetPtr = *Placeholder | (Value & 0xFFF);
430     *TargetPtr |= ((Value >> 12) & 0xF) << 16;
431     break;
432   // Write 24 bit relative value to the branch instruction.
433   case ELF::R_ARM_PC24 :    // Fall through.
434   case ELF::R_ARM_CALL :    // Fall through.
435   case ELF::R_ARM_JUMP24: {
436     int32_t RelValue = static_cast<int32_t>(Value - FinalAddress - 8);
437     RelValue = (RelValue & 0x03FFFFFC) >> 2;
438     assert((*TargetPtr & 0xFFFFFF) == 0xFFFFFE);
439     *TargetPtr &= 0xFF000000;
440     *TargetPtr |= RelValue;
441     break;
442   }
443   case ELF::R_ARM_PRIVATE_0:
444     // This relocation is reserved by the ARM ELF ABI for internal use. We
445     // appropriate it here to act as an R_ARM_ABS32 without any addend for use
446     // in the stubs created during JIT (which can't put an addend into the
447     // original object file).
448     *TargetPtr = Value;
449     break;
450   }
451 }
452
453 void RuntimeDyldELF::resolveMIPSRelocation(const SectionEntry &Section,
454                                            uint64_t Offset,
455                                            uint32_t Value,
456                                            uint32_t Type,
457                                            int32_t Addend) {
458   uint32_t* TargetPtr = (uint32_t*)(Section.Address + Offset);
459   Value += Addend;
460
461   DEBUG(dbgs() << "resolveMipselocation, LocalAddress: "
462                << Section.Address + Offset
463                << " FinalAddress: "
464                << format("%p",Section.LoadAddress + Offset)
465                << " Value: " << format("%x",Value)
466                << " Type: " << format("%x",Type)
467                << " Addend: " << format("%x",Addend)
468                << "\n");
469
470   switch(Type) {
471   default:
472     llvm_unreachable("Not implemented relocation type!");
473     break;
474   case ELF::R_MIPS_32:
475     *TargetPtr = Value + (*TargetPtr);
476     break;
477   case ELF::R_MIPS_26:
478     *TargetPtr = ((*TargetPtr) & 0xfc000000) | (( Value & 0x0fffffff) >> 2);
479     break;
480   case ELF::R_MIPS_HI16:
481     // Get the higher 16-bits. Also add 1 if bit 15 is 1.
482     Value += ((*TargetPtr) & 0x0000ffff) << 16;
483     *TargetPtr = ((*TargetPtr) & 0xffff0000) |
484                  (((Value + 0x8000) >> 16) & 0xffff);
485     break;
486    case ELF::R_MIPS_LO16:
487     Value += ((*TargetPtr) & 0x0000ffff);
488     *TargetPtr = ((*TargetPtr) & 0xffff0000) | (Value & 0xffff);
489     break;
490    }
491 }
492
493 // Return the .TOC. section address to R_PPC64_TOC relocations.
494 uint64_t RuntimeDyldELF::findPPC64TOC() const {
495   // The TOC consists of sections .got, .toc, .tocbss, .plt in that
496   // order. The TOC starts where the first of these sections starts.
497   SectionList::const_iterator it = Sections.begin();
498   SectionList::const_iterator ite = Sections.end();
499   for (; it != ite; ++it) {
500     if (it->Name == ".got" ||
501         it->Name == ".toc" ||
502         it->Name == ".tocbss" ||
503         it->Name == ".plt")
504       break;
505   }
506   if (it == ite) {
507     // This may happen for
508     // * references to TOC base base (sym@toc, .odp relocation) without
509     // a .toc directive.
510     // In this case just use the first section (which is usually
511     // the .odp) since the code won't reference the .toc base
512     // directly.
513     it = Sections.begin();
514   }
515   assert (it != ite);
516   // Per the ppc64-elf-linux ABI, The TOC base is TOC value plus 0x8000
517   // thus permitting a full 64 Kbytes segment.
518   return it->LoadAddress + 0x8000;
519 }
520
521 // Returns the sections and offset associated with the ODP entry referenced
522 // by Symbol.
523 void RuntimeDyldELF::findOPDEntrySection(ObjectImage &Obj,
524                                          ObjSectionToIDMap &LocalSections,
525                                          RelocationValueRef &Rel) {
526   // Get the ELF symbol value (st_value) to compare with Relocation offset in
527   // .opd entries
528
529   error_code err;
530   for (section_iterator si = Obj.begin_sections(),
531      se = Obj.end_sections(); si != se; si.increment(err)) {
532     section_iterator RelSecI = si->getRelocatedSection();
533     if (RelSecI == Obj.end_sections())
534       continue;
535
536     StringRef RelSectionName;
537     check(RelSecI->getName(RelSectionName));
538     if (RelSectionName != ".opd")
539       continue;
540
541     for (relocation_iterator i = si->begin_relocations(),
542          e = si->end_relocations(); i != e;) {
543       check(err);
544
545       // The R_PPC64_ADDR64 relocation indicates the first field
546       // of a .opd entry
547       uint64_t TypeFunc;
548       check(i->getType(TypeFunc));
549       if (TypeFunc != ELF::R_PPC64_ADDR64) {
550         i.increment(err);
551         continue;
552       }
553
554       uint64_t TargetSymbolOffset;
555       symbol_iterator TargetSymbol = i->getSymbol();
556       check(i->getOffset(TargetSymbolOffset));
557       int64_t Addend;
558       check(getELFRelocationAddend(*i, Addend));
559
560       i = i.increment(err);
561       if (i == e)
562         break;
563       check(err);
564
565       // Just check if following relocation is a R_PPC64_TOC
566       uint64_t TypeTOC;
567       check(i->getType(TypeTOC));
568       if (TypeTOC != ELF::R_PPC64_TOC)
569         continue;
570
571       // Finally compares the Symbol value and the target symbol offset
572       // to check if this .opd entry refers to the symbol the relocation
573       // points to.
574       if (Rel.Addend != (intptr_t)TargetSymbolOffset)
575         continue;
576
577       section_iterator tsi(Obj.end_sections());
578       check(TargetSymbol->getSection(tsi));
579       Rel.SectionID = findOrEmitSection(Obj, (*tsi), true, LocalSections);
580       Rel.Addend = (intptr_t)Addend;
581       return;
582     }
583   }
584   llvm_unreachable("Attempting to get address of ODP entry!");
585 }
586
587 // Relocation masks following the #lo(value), #hi(value), #higher(value),
588 // and #highest(value) macros defined in section 4.5.1. Relocation Types
589 // in PPC-elf64abi document.
590 //
591 static inline
592 uint16_t applyPPClo (uint64_t value)
593 {
594   return value & 0xffff;
595 }
596
597 static inline
598 uint16_t applyPPChi (uint64_t value)
599 {
600   return (value >> 16) & 0xffff;
601 }
602
603 static inline
604 uint16_t applyPPChigher (uint64_t value)
605 {
606   return (value >> 32) & 0xffff;
607 }
608
609 static inline
610 uint16_t applyPPChighest (uint64_t value)
611 {
612   return (value >> 48) & 0xffff;
613 }
614
615 void RuntimeDyldELF::resolvePPC64Relocation(const SectionEntry &Section,
616                                             uint64_t Offset,
617                                             uint64_t Value,
618                                             uint32_t Type,
619                                             int64_t Addend) {
620   uint8_t* LocalAddress = Section.Address + Offset;
621   switch (Type) {
622   default:
623     llvm_unreachable("Relocation type not implemented yet!");
624   break;
625   case ELF::R_PPC64_ADDR16_LO :
626     writeInt16BE(LocalAddress, applyPPClo (Value + Addend));
627     break;
628   case ELF::R_PPC64_ADDR16_HI :
629     writeInt16BE(LocalAddress, applyPPChi (Value + Addend));
630     break;
631   case ELF::R_PPC64_ADDR16_HIGHER :
632     writeInt16BE(LocalAddress, applyPPChigher (Value + Addend));
633     break;
634   case ELF::R_PPC64_ADDR16_HIGHEST :
635     writeInt16BE(LocalAddress, applyPPChighest (Value + Addend));
636     break;
637   case ELF::R_PPC64_ADDR14 : {
638     assert(((Value + Addend) & 3) == 0);
639     // Preserve the AA/LK bits in the branch instruction
640     uint8_t aalk = *(LocalAddress+3);
641     writeInt16BE(LocalAddress + 2, (aalk & 3) | ((Value + Addend) & 0xfffc));
642   } break;
643   case ELF::R_PPC64_ADDR32 : {
644     int32_t Result = static_cast<int32_t>(Value + Addend);
645     if (SignExtend32<32>(Result) != Result)
646       llvm_unreachable("Relocation R_PPC64_ADDR32 overflow");
647     writeInt32BE(LocalAddress, Result);
648   } break;
649   case ELF::R_PPC64_REL24 : {
650     uint64_t FinalAddress = (Section.LoadAddress + Offset);
651     int32_t delta = static_cast<int32_t>(Value - FinalAddress + Addend);
652     if (SignExtend32<24>(delta) != delta)
653       llvm_unreachable("Relocation R_PPC64_REL24 overflow");
654     // Generates a 'bl <address>' instruction
655     writeInt32BE(LocalAddress, 0x48000001 | (delta & 0x03FFFFFC));
656   } break;
657   case ELF::R_PPC64_REL32 : {
658     uint64_t FinalAddress = (Section.LoadAddress + Offset);
659     int32_t delta = static_cast<int32_t>(Value - FinalAddress + Addend);
660     if (SignExtend32<32>(delta) != delta)
661       llvm_unreachable("Relocation R_PPC64_REL32 overflow");
662     writeInt32BE(LocalAddress, delta);
663   } break;
664   case ELF::R_PPC64_REL64: {
665     uint64_t FinalAddress = (Section.LoadAddress + Offset);
666     uint64_t Delta = Value - FinalAddress + Addend;
667     writeInt64BE(LocalAddress, Delta);
668   } break;
669   case ELF::R_PPC64_ADDR64 :
670     writeInt64BE(LocalAddress, Value + Addend);
671     break;
672   case ELF::R_PPC64_TOC :
673     writeInt64BE(LocalAddress, findPPC64TOC());
674     break;
675   case ELF::R_PPC64_TOC16 : {
676     uint64_t TOCStart = findPPC64TOC();
677     Value = applyPPClo((Value + Addend) - TOCStart);
678     writeInt16BE(LocalAddress, applyPPClo(Value));
679   } break;
680   case ELF::R_PPC64_TOC16_DS : {
681     uint64_t TOCStart = findPPC64TOC();
682     Value = ((Value + Addend) - TOCStart);
683     writeInt16BE(LocalAddress, applyPPClo(Value));
684   } break;
685   }
686 }
687
688 void RuntimeDyldELF::resolveSystemZRelocation(const SectionEntry &Section,
689                                               uint64_t Offset,
690                                               uint64_t Value,
691                                               uint32_t Type,
692                                               int64_t Addend) {
693   uint8_t *LocalAddress = Section.Address + Offset;
694   switch (Type) {
695   default:
696     llvm_unreachable("Relocation type not implemented yet!");
697     break;
698   case ELF::R_390_PC16DBL:
699   case ELF::R_390_PLT16DBL: {
700     int64_t Delta = (Value + Addend) - (Section.LoadAddress + Offset);
701     assert(int16_t(Delta / 2) * 2 == Delta && "R_390_PC16DBL overflow");
702     writeInt16BE(LocalAddress, Delta / 2);
703     break;
704   }
705   case ELF::R_390_PC32DBL:
706   case ELF::R_390_PLT32DBL: {
707     int64_t Delta = (Value + Addend) - (Section.LoadAddress + Offset);
708     assert(int32_t(Delta / 2) * 2 == Delta && "R_390_PC32DBL overflow");
709     writeInt32BE(LocalAddress, Delta / 2);
710     break;
711   }
712   case ELF::R_390_PC32: {
713     int64_t Delta = (Value + Addend) - (Section.LoadAddress + Offset);
714     assert(int32_t(Delta) == Delta && "R_390_PC32 overflow");
715     writeInt32BE(LocalAddress, Delta);
716     break;
717   }
718   case ELF::R_390_64:
719     writeInt64BE(LocalAddress, Value + Addend);
720     break;
721   }
722 }
723
724 void RuntimeDyldELF::resolveRelocation(const RelocationEntry &RE,
725                                        uint64_t Value) {
726   const SectionEntry &Section = Sections[RE.SectionID];
727   return resolveRelocation(Section, RE.Offset, Value, RE.RelType, RE.Addend);
728 }
729
730 void RuntimeDyldELF::resolveRelocation(const SectionEntry &Section,
731                                        uint64_t Offset,
732                                        uint64_t Value,
733                                        uint32_t Type,
734                                        int64_t Addend) {
735   switch (Arch) {
736   case Triple::x86_64:
737     resolveX86_64Relocation(Section, Offset, Value, Type, Addend);
738     break;
739   case Triple::x86:
740     resolveX86Relocation(Section, Offset,
741                          (uint32_t)(Value & 0xffffffffL), Type,
742                          (uint32_t)(Addend & 0xffffffffL));
743     break;
744   case Triple::aarch64:
745     resolveAArch64Relocation(Section, Offset, Value, Type, Addend);
746     break;
747   case Triple::arm:    // Fall through.
748   case Triple::thumb:
749     resolveARMRelocation(Section, Offset,
750                          (uint32_t)(Value & 0xffffffffL), Type,
751                          (uint32_t)(Addend & 0xffffffffL));
752     break;
753   case Triple::mips:    // Fall through.
754   case Triple::mipsel:
755     resolveMIPSRelocation(Section, Offset,
756                           (uint32_t)(Value & 0xffffffffL), Type,
757                           (uint32_t)(Addend & 0xffffffffL));
758     break;
759   case Triple::ppc64:
760     resolvePPC64Relocation(Section, Offset, Value, Type, Addend);
761     break;
762   case Triple::systemz:
763     resolveSystemZRelocation(Section, Offset, Value, Type, Addend);
764     break;
765   default: llvm_unreachable("Unsupported CPU type!");
766   }
767 }
768
769 void RuntimeDyldELF::processRelocationRef(unsigned SectionID,
770                                           RelocationRef RelI,
771                                           ObjectImage &Obj,
772                                           ObjSectionToIDMap &ObjSectionToID,
773                                           const SymbolTableMap &Symbols,
774                                           StubMap &Stubs) {
775   uint64_t RelType;
776   Check(RelI.getType(RelType));
777   int64_t Addend;
778   Check(getELFRelocationAddend(RelI, Addend));
779   symbol_iterator Symbol = RelI.getSymbol();
780
781   // Obtain the symbol name which is referenced in the relocation
782   StringRef TargetName;
783   Symbol->getName(TargetName);
784   DEBUG(dbgs() << "\t\tRelType: " << RelType
785                << " Addend: " << Addend
786                << " TargetName: " << TargetName
787                << "\n");
788   RelocationValueRef Value;
789   // First search for the symbol in the local symbol table
790   SymbolTableMap::const_iterator lsi = Symbols.find(TargetName.data());
791   SymbolRef::Type SymType;
792   Symbol->getType(SymType);
793   if (lsi != Symbols.end()) {
794     Value.SectionID = lsi->second.first;
795     Value.Addend = lsi->second.second + Addend;
796   } else {
797     // Search for the symbol in the global symbol table
798     SymbolTableMap::const_iterator gsi =
799         GlobalSymbolTable.find(TargetName.data());
800     if (gsi != GlobalSymbolTable.end()) {
801       Value.SectionID = gsi->second.first;
802       Value.Addend = gsi->second.second + Addend;
803     } else {
804       switch (SymType) {
805         case SymbolRef::ST_Debug: {
806           // TODO: Now ELF SymbolRef::ST_Debug = STT_SECTION, it's not obviously
807           // and can be changed by another developers. Maybe best way is add
808           // a new symbol type ST_Section to SymbolRef and use it.
809           section_iterator si(Obj.end_sections());
810           Symbol->getSection(si);
811           if (si == Obj.end_sections())
812             llvm_unreachable("Symbol section not found, bad object file format!");
813           DEBUG(dbgs() << "\t\tThis is section symbol\n");
814           // Default to 'true' in case isText fails (though it never does).
815           bool isCode = true;
816           si->isText(isCode);
817           Value.SectionID = findOrEmitSection(Obj,
818                                               (*si),
819                                               isCode,
820                                               ObjSectionToID);
821           Value.Addend = Addend;
822           break;
823         }
824         case SymbolRef::ST_Unknown: {
825           Value.SymbolName = TargetName.data();
826           Value.Addend = Addend;
827           break;
828         }
829         default:
830           llvm_unreachable("Unresolved symbol type!");
831           break;
832       }
833     }
834   }
835   uint64_t Offset;
836   Check(RelI.getOffset(Offset));
837
838   DEBUG(dbgs() << "\t\tSectionID: " << SectionID
839                << " Offset: " << Offset
840                << "\n");
841   if (Arch == Triple::aarch64 &&
842       (RelType == ELF::R_AARCH64_CALL26 ||
843        RelType == ELF::R_AARCH64_JUMP26)) {
844     // This is an AArch64 branch relocation, need to use a stub function.
845     DEBUG(dbgs() << "\t\tThis is an AArch64 branch relocation.");
846     SectionEntry &Section = Sections[SectionID];
847
848     // Look for an existing stub.
849     StubMap::const_iterator i = Stubs.find(Value);
850     if (i != Stubs.end()) {
851         resolveRelocation(Section, Offset,
852                           (uint64_t)Section.Address + i->second, RelType, 0);
853       DEBUG(dbgs() << " Stub function found\n");
854     } else {
855       // Create a new stub function.
856       DEBUG(dbgs() << " Create a new stub function\n");
857       Stubs[Value] = Section.StubOffset;
858       uint8_t *StubTargetAddr = createStubFunction(Section.Address +
859                                                    Section.StubOffset);
860
861       RelocationEntry REmovz_g3(SectionID,
862                                 StubTargetAddr - Section.Address,
863                                 ELF::R_AARCH64_MOVW_UABS_G3, Value.Addend);
864       RelocationEntry REmovk_g2(SectionID,
865                                 StubTargetAddr - Section.Address + 4,
866                                 ELF::R_AARCH64_MOVW_UABS_G2_NC, Value.Addend);
867       RelocationEntry REmovk_g1(SectionID,
868                                 StubTargetAddr - Section.Address + 8,
869                                 ELF::R_AARCH64_MOVW_UABS_G1_NC, Value.Addend);
870       RelocationEntry REmovk_g0(SectionID,
871                                 StubTargetAddr - Section.Address + 12,
872                                 ELF::R_AARCH64_MOVW_UABS_G0_NC, Value.Addend);
873
874       if (Value.SymbolName) {
875         addRelocationForSymbol(REmovz_g3, Value.SymbolName);
876         addRelocationForSymbol(REmovk_g2, Value.SymbolName);
877         addRelocationForSymbol(REmovk_g1, Value.SymbolName);
878         addRelocationForSymbol(REmovk_g0, Value.SymbolName);
879       } else {
880         addRelocationForSection(REmovz_g3, Value.SectionID);
881         addRelocationForSection(REmovk_g2, Value.SectionID);
882         addRelocationForSection(REmovk_g1, Value.SectionID);
883         addRelocationForSection(REmovk_g0, Value.SectionID);
884       }
885       resolveRelocation(Section, Offset,
886                         (uint64_t)Section.Address + Section.StubOffset,
887                         RelType, 0);
888       Section.StubOffset += getMaxStubSize();
889     }
890   } else if (Arch == Triple::arm &&
891       (RelType == ELF::R_ARM_PC24 ||
892        RelType == ELF::R_ARM_CALL ||
893        RelType == ELF::R_ARM_JUMP24)) {
894     // This is an ARM branch relocation, need to use a stub function.
895     DEBUG(dbgs() << "\t\tThis is an ARM branch relocation.");
896     SectionEntry &Section = Sections[SectionID];
897
898     // Look for an existing stub.
899     StubMap::const_iterator i = Stubs.find(Value);
900     if (i != Stubs.end()) {
901         resolveRelocation(Section, Offset,
902                           (uint64_t)Section.Address + i->second, RelType, 0);
903       DEBUG(dbgs() << " Stub function found\n");
904     } else {
905       // Create a new stub function.
906       DEBUG(dbgs() << " Create a new stub function\n");
907       Stubs[Value] = Section.StubOffset;
908       uint8_t *StubTargetAddr = createStubFunction(Section.Address +
909                                                    Section.StubOffset);
910       RelocationEntry RE(SectionID, StubTargetAddr - Section.Address,
911                          ELF::R_ARM_PRIVATE_0, Value.Addend);
912       if (Value.SymbolName)
913         addRelocationForSymbol(RE, Value.SymbolName);
914       else
915         addRelocationForSection(RE, Value.SectionID);
916
917       resolveRelocation(Section, Offset,
918                         (uint64_t)Section.Address + Section.StubOffset,
919                         RelType, 0);
920       Section.StubOffset += getMaxStubSize();
921     }
922   } else if ((Arch == Triple::mipsel || Arch == Triple::mips) &&
923              RelType == ELF::R_MIPS_26) {
924     // This is an Mips branch relocation, need to use a stub function.
925     DEBUG(dbgs() << "\t\tThis is a Mips branch relocation.");
926     SectionEntry &Section = Sections[SectionID];
927     uint8_t *Target = Section.Address + Offset;
928     uint32_t *TargetAddress = (uint32_t *)Target;
929
930     // Extract the addend from the instruction.
931     uint32_t Addend = ((*TargetAddress) & 0x03ffffff) << 2;
932
933     Value.Addend += Addend;
934
935     //  Look up for existing stub.
936     StubMap::const_iterator i = Stubs.find(Value);
937     if (i != Stubs.end()) {
938       resolveRelocation(Section, Offset,
939                         (uint64_t)Section.Address + i->second, RelType, 0);
940       DEBUG(dbgs() << " Stub function found\n");
941     } else {
942       // Create a new stub function.
943       DEBUG(dbgs() << " Create a new stub function\n");
944       Stubs[Value] = Section.StubOffset;
945       uint8_t *StubTargetAddr = createStubFunction(Section.Address +
946                                                    Section.StubOffset);
947
948       // Creating Hi and Lo relocations for the filled stub instructions.
949       RelocationEntry REHi(SectionID,
950                            StubTargetAddr - Section.Address,
951                            ELF::R_MIPS_HI16, Value.Addend);
952       RelocationEntry RELo(SectionID,
953                            StubTargetAddr - Section.Address + 4,
954                            ELF::R_MIPS_LO16, Value.Addend);
955
956       if (Value.SymbolName) {
957         addRelocationForSymbol(REHi, Value.SymbolName);
958         addRelocationForSymbol(RELo, Value.SymbolName);
959       } else {
960         addRelocationForSection(REHi, Value.SectionID);
961         addRelocationForSection(RELo, Value.SectionID);
962       }
963
964       resolveRelocation(Section, Offset,
965                         (uint64_t)Section.Address + Section.StubOffset,
966                         RelType, 0);
967       Section.StubOffset += getMaxStubSize();
968     }
969   } else if (Arch == Triple::ppc64) {
970     if (RelType == ELF::R_PPC64_REL24) {
971       // A PPC branch relocation will need a stub function if the target is
972       // an external symbol (Symbol::ST_Unknown) or if the target address
973       // is not within the signed 24-bits branch address.
974       SectionEntry &Section = Sections[SectionID];
975       uint8_t *Target = Section.Address + Offset;
976       bool RangeOverflow = false;
977       if (SymType != SymbolRef::ST_Unknown) {
978         // A function call may points to the .opd entry, so the final symbol value
979         // in calculated based in the relocation values in .opd section.
980         findOPDEntrySection(Obj, ObjSectionToID, Value);
981         uint8_t *RelocTarget = Sections[Value.SectionID].Address + Value.Addend;
982         int32_t delta = static_cast<int32_t>(Target - RelocTarget);
983         // If it is within 24-bits branch range, just set the branch target
984         if (SignExtend32<24>(delta) == delta) {
985           RelocationEntry RE(SectionID, Offset, RelType, Value.Addend);
986           if (Value.SymbolName)
987             addRelocationForSymbol(RE, Value.SymbolName);
988           else
989             addRelocationForSection(RE, Value.SectionID);
990         } else {
991           RangeOverflow = true;
992         }
993       }
994       if (SymType == SymbolRef::ST_Unknown || RangeOverflow == true) {
995         // It is an external symbol (SymbolRef::ST_Unknown) or within a range
996         // larger than 24-bits.
997         StubMap::const_iterator i = Stubs.find(Value);
998         if (i != Stubs.end()) {
999           // Symbol function stub already created, just relocate to it
1000           resolveRelocation(Section, Offset,
1001                             (uint64_t)Section.Address + i->second, RelType, 0);
1002           DEBUG(dbgs() << " Stub function found\n");
1003         } else {
1004           // Create a new stub function.
1005           DEBUG(dbgs() << " Create a new stub function\n");
1006           Stubs[Value] = Section.StubOffset;
1007           uint8_t *StubTargetAddr = createStubFunction(Section.Address +
1008                                                        Section.StubOffset);
1009           RelocationEntry RE(SectionID, StubTargetAddr - Section.Address,
1010                              ELF::R_PPC64_ADDR64, Value.Addend);
1011
1012           // Generates the 64-bits address loads as exemplified in section
1013           // 4.5.1 in PPC64 ELF ABI.
1014           RelocationEntry REhst(SectionID,
1015                                 StubTargetAddr - Section.Address + 2,
1016                                 ELF::R_PPC64_ADDR16_HIGHEST, Value.Addend);
1017           RelocationEntry REhr(SectionID,
1018                                StubTargetAddr - Section.Address + 6,
1019                                ELF::R_PPC64_ADDR16_HIGHER, Value.Addend);
1020           RelocationEntry REh(SectionID,
1021                               StubTargetAddr - Section.Address + 14,
1022                               ELF::R_PPC64_ADDR16_HI, Value.Addend);
1023           RelocationEntry REl(SectionID,
1024                               StubTargetAddr - Section.Address + 18,
1025                               ELF::R_PPC64_ADDR16_LO, Value.Addend);
1026
1027           if (Value.SymbolName) {
1028             addRelocationForSymbol(REhst, Value.SymbolName);
1029             addRelocationForSymbol(REhr,  Value.SymbolName);
1030             addRelocationForSymbol(REh,   Value.SymbolName);
1031             addRelocationForSymbol(REl,   Value.SymbolName);
1032           } else {
1033             addRelocationForSection(REhst, Value.SectionID);
1034             addRelocationForSection(REhr,  Value.SectionID);
1035             addRelocationForSection(REh,   Value.SectionID);
1036             addRelocationForSection(REl,   Value.SectionID);
1037           }
1038
1039           resolveRelocation(Section, Offset,
1040                             (uint64_t)Section.Address + Section.StubOffset,
1041                             RelType, 0);
1042           if (SymType == SymbolRef::ST_Unknown)
1043             // Restore the TOC for external calls
1044             writeInt32BE(Target+4, 0xE8410028); // ld r2,40(r1)
1045           Section.StubOffset += getMaxStubSize();
1046         }
1047       }
1048     } else {
1049       RelocationEntry RE(SectionID, Offset, RelType, Value.Addend);
1050       // Extra check to avoid relocation againt empty symbols (usually
1051       // the R_PPC64_TOC).
1052       if (Value.SymbolName && !TargetName.empty())
1053         addRelocationForSymbol(RE, Value.SymbolName);
1054       else
1055         addRelocationForSection(RE, Value.SectionID);
1056     }
1057   } else if (Arch == Triple::systemz &&
1058              (RelType == ELF::R_390_PLT32DBL ||
1059               RelType == ELF::R_390_GOTENT)) {
1060     // Create function stubs for both PLT and GOT references, regardless of
1061     // whether the GOT reference is to data or code.  The stub contains the
1062     // full address of the symbol, as needed by GOT references, and the
1063     // executable part only adds an overhead of 8 bytes.
1064     //
1065     // We could try to conserve space by allocating the code and data
1066     // parts of the stub separately.  However, as things stand, we allocate
1067     // a stub for every relocation, so using a GOT in JIT code should be
1068     // no less space efficient than using an explicit constant pool.
1069     DEBUG(dbgs() << "\t\tThis is a SystemZ indirect relocation.");
1070     SectionEntry &Section = Sections[SectionID];
1071
1072     // Look for an existing stub.
1073     StubMap::const_iterator i = Stubs.find(Value);
1074     uintptr_t StubAddress;
1075     if (i != Stubs.end()) {
1076       StubAddress = uintptr_t(Section.Address) + i->second;
1077       DEBUG(dbgs() << " Stub function found\n");
1078     } else {
1079       // Create a new stub function.
1080       DEBUG(dbgs() << " Create a new stub function\n");
1081
1082       uintptr_t BaseAddress = uintptr_t(Section.Address);
1083       uintptr_t StubAlignment = getStubAlignment();
1084       StubAddress = (BaseAddress + Section.StubOffset +
1085                      StubAlignment - 1) & -StubAlignment;
1086       unsigned StubOffset = StubAddress - BaseAddress;
1087
1088       Stubs[Value] = StubOffset;
1089       createStubFunction((uint8_t *)StubAddress);
1090       RelocationEntry RE(SectionID, StubOffset + 8,
1091                          ELF::R_390_64, Value.Addend - Addend);
1092       if (Value.SymbolName)
1093         addRelocationForSymbol(RE, Value.SymbolName);
1094       else
1095         addRelocationForSection(RE, Value.SectionID);
1096       Section.StubOffset = StubOffset + getMaxStubSize();
1097     }
1098
1099     if (RelType == ELF::R_390_GOTENT)
1100       resolveRelocation(Section, Offset, StubAddress + 8,
1101                         ELF::R_390_PC32DBL, Addend);
1102     else
1103       resolveRelocation(Section, Offset, StubAddress, RelType, Addend);
1104   } else {
1105     RelocationEntry RE(SectionID, Offset, RelType, Value.Addend);
1106     if (Value.SymbolName)
1107       addRelocationForSymbol(RE, Value.SymbolName);
1108     else
1109       addRelocationForSection(RE, Value.SectionID);
1110   }
1111 }
1112
1113 bool RuntimeDyldELF::isCompatibleFormat(const ObjectBuffer *Buffer) const {
1114   if (Buffer->getBufferSize() < strlen(ELF::ElfMagic))
1115     return false;
1116   return (memcmp(Buffer->getBufferStart(), ELF::ElfMagic, strlen(ELF::ElfMagic))) == 0;
1117 }
1118 } // namespace llvm