lib/ExecutionEngine/RuntimeDyld/RuntimeDyld.cpp

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