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