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