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