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