tools/llvm-rtdyld/llvm-rtdyld.cpp

   1 //===-- llvm-rtdyld.cpp - MCJIT Testing Tool ------------------------------===//
   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 // This is a testing tool for use with the MC-JIT LLVM components.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/ADT/StringMap.h"
  15 #include "llvm/DebugInfo/DIContext.h"
  16 #include "llvm/DebugInfo/DWARF/DWARFContext.h"
  17 #include "llvm/ExecutionEngine/RTDyldMemoryManager.h"
  18 #include "llvm/ExecutionEngine/RuntimeDyld.h"
  19 #include "llvm/ExecutionEngine/RuntimeDyldChecker.h"
  20 #include "llvm/MC/MCAsmInfo.h"
  21 #include "llvm/MC/MCContext.h"
  22 #include "llvm/MC/MCDisassembler.h"
  23 #include "llvm/MC/MCInstPrinter.h"
  24 #include "llvm/MC/MCInstrInfo.h"
  25 #include "llvm/MC/MCRegisterInfo.h"
  26 #include "llvm/MC/MCSubtargetInfo.h"
  27 #include "llvm/Object/MachO.h"
  28 #include "llvm/Object/SymbolSize.h"
  29 #include "llvm/Support/CommandLine.h"
  30 #include "llvm/Support/DynamicLibrary.h"
  31 #include "llvm/Support/ManagedStatic.h"
  32 #include "llvm/Support/Memory.h"
  33 #include "llvm/Support/MemoryBuffer.h"
  34 #include "llvm/Support/PrettyStackTrace.h"
  35 #include "llvm/Support/Signals.h"
  36 #include "llvm/Support/TargetRegistry.h"
  37 #include "llvm/Support/TargetSelect.h"
  38 #include "llvm/Support/raw_ostream.h"
  39 #include <list>
  40 #include <system_error>
  41
  42 using namespace llvm;
  43 using namespace llvm::object;
  44
  45 static cl::list<std::string>
  46 InputFileList(cl::Positional, cl::ZeroOrMore,
  47               cl::desc("<input file>"));
  48
  49 enum ActionType {
  50   AC_Execute,
  51   AC_PrintObjectLineInfo,
  52   AC_PrintLineInfo,
  53   AC_PrintDebugLineInfo,
  54   AC_Verify
  55 };
  56
  57 static cl::opt<ActionType>
  58 Action(cl::desc("Action to perform:"),
  59        cl::init(AC_Execute),
  60        cl::values(clEnumValN(AC_Execute, "execute",
  61                              "Load, link, and execute the inputs."),
  62                   clEnumValN(AC_PrintLineInfo, "printline",
  63                              "Load, link, and print line information for each function."),
  64                   clEnumValN(AC_PrintDebugLineInfo, "printdebugline",
  65                              "Load, link, and print line information for each function using the debug object"),
  66                   clEnumValN(AC_PrintObjectLineInfo, "printobjline",
  67                              "Like -printlineinfo but does not load the object first"),
  68                   clEnumValN(AC_Verify, "verify",
  69                              "Load, link and verify the resulting memory image."),
  70                   clEnumValEnd));
  71
  72 static cl::opt<std::string>
  73 EntryPoint("entry",
  74            cl::desc("Function to call as entry point."),
  75            cl::init("_main"));
  76
  77 static cl::list<std::string>
  78 Dylibs("dylib",
  79        cl::desc("Add library."),
  80        cl::ZeroOrMore);
  81
  82 static cl::opt<std::string>
  83 TripleName("triple", cl::desc("Target triple for disassembler"));
  84
  85 static cl::opt<std::string>
  86 MCPU("mcpu",
  87      cl::desc("Target a specific cpu type (-mcpu=help for details)"),
  88      cl::value_desc("cpu-name"),
  89      cl::init(""));
  90
  91 static cl::list<std::string>
  92 CheckFiles("check",
  93            cl::desc("File containing RuntimeDyld verifier checks."),
  94            cl::ZeroOrMore);
  95
  96 static cl::opt<uint64_t>
  97 PreallocMemory("preallocate",
  98               cl::desc("Allocate memory upfront rather than on-demand"),
  99               cl::init(0));
 100
 101 static cl::opt<uint64_t>
 102 TargetAddrStart("target-addr-start",
 103                 cl::desc("For -verify only: start of phony target address "
 104                          "range."),
 105                 cl::init(4096), // Start at "page 1" - no allocating at "null".
 106                 cl::Hidden);
 107
 108 static cl::opt<uint64_t>
 109 TargetAddrEnd("target-addr-end",
 110               cl::desc("For -verify only: end of phony target address range."),
 111               cl::init(~0ULL),
 112               cl::Hidden);
 113
 114 static cl::opt<uint64_t>
 115 TargetSectionSep("target-section-sep",
 116                  cl::desc("For -verify only: Separation between sections in "
 117                           "phony target address space."),
 118                  cl::init(0),
 119                  cl::Hidden);
 120
 121 static cl::list<std::string>
 122 SpecificSectionMappings("map-section",
 123                         cl::desc("For -verify only: Map a section to a "
 124                                  "specific address."),
 125                         cl::ZeroOrMore,
 126                         cl::Hidden);
 127
 128 static cl::list<std::string>
 129 DummySymbolMappings("dummy-extern",
 130                     cl::desc("For -verify only: Inject a symbol into the extern "
 131                              "symbol table."),
 132                     cl::ZeroOrMore,
 133                     cl::Hidden);
 134
 135 /* *** */
 136
 137 // A trivial memory manager that doesn't do anything fancy, just uses the
 138 // support library allocation routines directly.
 139 class TrivialMemoryManager : public RTDyldMemoryManager {
 140 public:
 141   SmallVector<sys::MemoryBlock, 16> FunctionMemory;
 142   SmallVector<sys::MemoryBlock, 16> DataMemory;
 143
 144   uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
 145                                unsigned SectionID,
 146                                StringRef SectionName) override;
 147   uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
 148                                unsigned SectionID, StringRef SectionName,
 149                                bool IsReadOnly) override;
 150
 151   void *getPointerToNamedFunction(const std::string &Name,
 152                                   bool AbortOnFailure = true) override {
 153     return nullptr;
 154   }
 155
 156   bool finalizeMemory(std::string *ErrMsg) override { return false; }
 157
 158   void addDummySymbol(const std::string &Name, uint64_t Addr) {
 159     DummyExterns[Name] = Addr;
 160   }
 161
 162   RuntimeDyld::SymbolInfo findSymbol(const std::string &Name) override {
 163     auto I = DummyExterns.find(Name);
 164
 165     if (I != DummyExterns.end())
 166       return RuntimeDyld::SymbolInfo(I->second, JITSymbolFlags::Exported);
 167
 168     return RTDyldMemoryManager::findSymbol(Name);
 169   }
 170
 171   void registerEHFrames(uint8_t *Addr, uint64_t LoadAddr,
 172                         size_t Size) override {}
 173   void deregisterEHFrames(uint8_t *Addr, uint64_t LoadAddr,
 174                           size_t Size) override {}
 175
 176   void preallocateSlab(uint64_t Size) {
 177     std::string Err;
 178     sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, &Err);
 179     if (!MB.base())
 180       report_fatal_error("Can't allocate enough memory: " + Err);
 181
 182     PreallocSlab = MB;
 183     UsePreallocation = true;
 184     SlabSize = Size;
 185   }
 186
 187   uint8_t *allocateFromSlab(uintptr_t Size, unsigned Alignment, bool isCode) {
 188     Size = RoundUpToAlignment(Size, Alignment);
 189     if (CurrentSlabOffset + Size > SlabSize)
 190       report_fatal_error("Can't allocate enough memory. Tune --preallocate");
 191
 192     uintptr_t OldSlabOffset = CurrentSlabOffset;
 193     sys::MemoryBlock MB((void *)OldSlabOffset, Size);
 194     if (isCode)
 195       FunctionMemory.push_back(MB);
 196     else
 197       DataMemory.push_back(MB);
 198     CurrentSlabOffset += Size;
 199     return (uint8_t*)OldSlabOffset;
 200   }
 201
 202 private:
 203   std::map<std::string, uint64_t> DummyExterns;
 204   sys::MemoryBlock PreallocSlab;
 205   bool UsePreallocation = false;
 206   uintptr_t SlabSize = 0;
 207   uintptr_t CurrentSlabOffset = 0;
 208 };
 209
 210 uint8_t *TrivialMemoryManager::allocateCodeSection(uintptr_t Size,
 211                                                    unsigned Alignment,
 212                                                    unsigned SectionID,
 213                                                    StringRef SectionName) {
 214   if (UsePreallocation)
 215     return allocateFromSlab(Size, Alignment, true /* isCode */);
 216
 217   std::string Err;
 218   sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, &Err);
 219   if (!MB.base())
 220     report_fatal_error("MemoryManager allocation failed: " + Err);
 221   FunctionMemory.push_back(MB);
 222   return (uint8_t*)MB.base();
 223 }
 224
 225 uint8_t *TrivialMemoryManager::allocateDataSection(uintptr_t Size,
 226                                                    unsigned Alignment,
 227                                                    unsigned SectionID,
 228                                                    StringRef SectionName,
 229                                                    bool IsReadOnly) {
 230   if (UsePreallocation)
 231     return allocateFromSlab(Size, Alignment, false /* isCode */);
 232
 233   std::string Err;
 234   sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, &Err);
 235   if (!MB.base())
 236     report_fatal_error("MemoryManager allocation failed: " + Err);
 237   DataMemory.push_back(MB);
 238   return (uint8_t*)MB.base();
 239 }
 240
 241 static const char *ProgramName;
 242
 243 static int Error(const Twine &Msg) {
 244   errs() << ProgramName << ": error: " << Msg << "\n";
 245   return 1;
 246 }
 247
 248 static void loadDylibs() {
 249   for (const std::string &Dylib : Dylibs) {
 250     if (sys::fs::is_regular_file(Dylib)) {
 251       std::string ErrMsg;
 252       if (sys::DynamicLibrary::LoadLibraryPermanently(Dylib.c_str(), &ErrMsg))
 253         report_fatal_error("Error loading '" + Dylib + "': " + ErrMsg);
 254     } else
 255       report_fatal_error("Dylib not found: '" + Dylib + "'.");
 256   }
 257 }
 258
 259 /* *** */
 260
 261 static int printLineInfoForInput(bool LoadObjects, bool UseDebugObj) {
 262   assert(LoadObjects || !UseDebugObj);
 263
 264   // Load any dylibs requested on the command line.
 265   loadDylibs();
 266
 267   // If we don't have any input files, read from stdin.
 268   if (!InputFileList.size())
 269     InputFileList.push_back("-");
 270   for (auto &File : InputFileList) {
 271     // Instantiate a dynamic linker.
 272     TrivialMemoryManager MemMgr;
 273     RuntimeDyld Dyld(MemMgr, MemMgr);
 274
 275     // Load the input memory buffer.
 276
 277     ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
 278         MemoryBuffer::getFileOrSTDIN(File);
 279     if (std::error_code EC = InputBuffer.getError())
 280       return Error("unable to read input: '" + EC.message() + "'");
 281
 282     ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
 283       ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
 284
 285     if (std::error_code EC = MaybeObj.getError())
 286       return Error("unable to create object file: '" + EC.message() + "'");
 287
 288     ObjectFile &Obj = **MaybeObj;
 289
 290     OwningBinary<ObjectFile> DebugObj;
 291     std::unique_ptr<RuntimeDyld::LoadedObjectInfo> LoadedObjInfo = nullptr;
 292     ObjectFile *SymbolObj = &Obj;
 293     if (LoadObjects) {
 294       // Load the object file
 295       LoadedObjInfo =
 296         Dyld.loadObject(Obj);
 297
 298       if (Dyld.hasError())
 299         return Error(Dyld.getErrorString());
 300
 301       // Resolve all the relocations we can.
 302       Dyld.resolveRelocations();
 303
 304       if (UseDebugObj) {
 305         DebugObj = LoadedObjInfo->getObjectForDebug(Obj);
 306         SymbolObj = DebugObj.getBinary();
 307         LoadedObjInfo.reset();
 308       }
 309     }
 310
 311     std::unique_ptr<DIContext> Context(
 312       new DWARFContextInMemory(*SymbolObj,LoadedObjInfo.get()));
 313
 314     std::vector<std::pair<SymbolRef, uint64_t>> SymAddr =
 315         object::computeSymbolSizes(*SymbolObj);
 316
 317     // Use symbol info to iterate functions in the object.
 318     for (const auto &P : SymAddr) {
 319       object::SymbolRef Sym = P.first;
 320       if (Sym.getType() == object::SymbolRef::ST_Function) {
 321         ErrorOr<StringRef> Name = Sym.getName();
 322         if (!Name)
 323           continue;
 324         ErrorOr<uint64_t> AddrOrErr = Sym.getAddress();
 325         if (!AddrOrErr)
 326           continue;
 327         uint64_t Addr = *AddrOrErr;
 328
 329         uint64_t Size = P.second;
 330         // If we're not using the debug object, compute the address of the
 331         // symbol in memory (rather than that in the unrelocated object file)
 332         // and use that to query the DWARFContext.
 333         if (!UseDebugObj && LoadObjects) {
 334           object::section_iterator Sec = *Sym.getSection();
 335           StringRef SecName;
 336           Sec->getName(SecName);
 337           uint64_t SectionLoadAddress =
 338             LoadedObjInfo->getSectionLoadAddress(*Sec);
 339           if (SectionLoadAddress != 0)
 340             Addr += SectionLoadAddress - Sec->getAddress();
 341         }
 342
 343         outs() << "Function: " << *Name << ", Size = " << Size
 344                << ", Addr = " << Addr << "\n";
 345
 346         DILineInfoTable Lines = Context->getLineInfoForAddressRange(Addr, Size);
 347         for (auto &D : Lines) {
 348           outs() << "  Line info @ " << D.first - Addr << ": "
 349                  << D.second.FileName << ", line:" << D.second.Line << "\n";
 350         }
 351       }
 352     }
 353   }
 354
 355   return 0;
 356 }
 357
 358 static void doPreallocation(TrivialMemoryManager &MemMgr) {
 359   // Allocate a slab of memory upfront, if required. This is used if
 360   // we want to test small code models.
 361   if (static_cast<intptr_t>(PreallocMemory) < 0)
 362     report_fatal_error("Pre-allocated bytes of memory must be a positive integer.");
 363
 364   // FIXME: Limit the amount of memory that can be preallocated?
 365   if (PreallocMemory != 0)
 366     MemMgr.preallocateSlab(PreallocMemory);
 367 }
 368
 369 static int executeInput() {
 370   // Load any dylibs requested on the command line.
 371   loadDylibs();
 372
 373   // Instantiate a dynamic linker.
 374   TrivialMemoryManager MemMgr;
 375   doPreallocation(MemMgr);
 376   RuntimeDyld Dyld(MemMgr, MemMgr);
 377
 378   // FIXME: Preserve buffers until resolveRelocations time to work around a bug
 379   //        in RuntimeDyldELF.
 380   // This fixme should be fixed ASAP. This is a very brittle workaround.
 381   std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
 382
 383   // If we don't have any input files, read from stdin.
 384   if (!InputFileList.size())
 385     InputFileList.push_back("-");
 386   for (auto &File : InputFileList) {
 387     // Load the input memory buffer.
 388     ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
 389         MemoryBuffer::getFileOrSTDIN(File);
 390     if (std::error_code EC = InputBuffer.getError())
 391       return Error("unable to read input: '" + EC.message() + "'");
 392     ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
 393       ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
 394
 395     if (std::error_code EC = MaybeObj.getError())
 396       return Error("unable to create object file: '" + EC.message() + "'");
 397
 398     ObjectFile &Obj = **MaybeObj;
 399     InputBuffers.push_back(std::move(*InputBuffer));
 400
 401     // Load the object file
 402     Dyld.loadObject(Obj);
 403     if (Dyld.hasError()) {
 404       return Error(Dyld.getErrorString());
 405     }
 406   }
 407
 408   // Resove all the relocations we can.
 409   // FIXME: Error out if there are unresolved relocations.
 410   Dyld.resolveRelocations();
 411
 412   // Get the address of the entry point (_main by default).
 413   void *MainAddress = Dyld.getSymbolLocalAddress(EntryPoint);
 414   if (!MainAddress)
 415     return Error("no definition for '" + EntryPoint + "'");
 416
 417   // Invalidate the instruction cache for each loaded function.
 418   for (auto &FM : MemMgr.FunctionMemory) {
 419
 420     // Make sure the memory is executable.
 421     // setExecutable will call InvalidateInstructionCache.
 422     std::string ErrorStr;
 423     if (!sys::Memory::setExecutable(FM, &ErrorStr))
 424       return Error("unable to mark function executable: '" + ErrorStr + "'");
 425   }
 426
 427   // Dispatch to _main().
 428   errs() << "loaded '" << EntryPoint << "' at: " << (void*)MainAddress << "\n";
 429
 430   int (*Main)(int, const char**) =
 431     (int(*)(int,const char**)) uintptr_t(MainAddress);
 432   const char **Argv = new const char*[2];
 433   // Use the name of the first input object module as argv[0] for the target.
 434   Argv[0] = InputFileList[0].c_str();
 435   Argv[1] = nullptr;
 436   return Main(1, Argv);
 437 }
 438
 439 static int checkAllExpressions(RuntimeDyldChecker &Checker) {
 440   for (const auto& CheckerFileName : CheckFiles) {
 441     ErrorOr<std::unique_ptr<MemoryBuffer>> CheckerFileBuf =
 442         MemoryBuffer::getFileOrSTDIN(CheckerFileName);
 443     if (std::error_code EC = CheckerFileBuf.getError())
 444       return Error("unable to read input '" + CheckerFileName + "': " +
 445                    EC.message());
 446
 447     if (!Checker.checkAllRulesInBuffer("# rtdyld-check:",
 448                                        CheckerFileBuf.get().get()))
 449       return Error("some checks in '" + CheckerFileName + "' failed");
 450   }
 451   return 0;
 452 }
 453
 454 static std::map<void *, uint64_t>
 455 applySpecificSectionMappings(RuntimeDyldChecker &Checker) {
 456
 457   std::map<void*, uint64_t> SpecificMappings;
 458
 459   for (StringRef Mapping : SpecificSectionMappings) {
 460
 461     size_t EqualsIdx = Mapping.find_first_of("=");
 462     std::string SectionIDStr = Mapping.substr(0, EqualsIdx);
 463     size_t ComaIdx = Mapping.find_first_of(",");
 464
 465     if (ComaIdx == StringRef::npos)
 466       report_fatal_error("Invalid section specification '" + Mapping +
 467                          "'. Should be '<file name>,<section name>=<addr>'");
 468
 469     std::string FileName = SectionIDStr.substr(0, ComaIdx);
 470     std::string SectionName = SectionIDStr.substr(ComaIdx + 1);
 471
 472     uint64_t OldAddrInt;
 473     std::string ErrorMsg;
 474     std::tie(OldAddrInt, ErrorMsg) =
 475       Checker.getSectionAddr(FileName, SectionName, true);
 476
 477     if (ErrorMsg != "")
 478       report_fatal_error(ErrorMsg);
 479
 480     void* OldAddr = reinterpret_cast<void*>(static_cast<uintptr_t>(OldAddrInt));
 481
 482     std::string NewAddrStr = Mapping.substr(EqualsIdx + 1);
 483     uint64_t NewAddr;
 484
 485     if (StringRef(NewAddrStr).getAsInteger(0, NewAddr))
 486       report_fatal_error("Invalid section address in mapping '" + Mapping +
 487                          "'.");
 488
 489     Checker.getRTDyld().mapSectionAddress(OldAddr, NewAddr);
 490     SpecificMappings[OldAddr] = NewAddr;
 491   }
 492
 493   return SpecificMappings;
 494 }
 495
 496 // Scatter sections in all directions!
 497 // Remaps section addresses for -verify mode. The following command line options
 498 // can be used to customize the layout of the memory within the phony target's
 499 // address space:
 500 // -target-addr-start <s> -- Specify where the phony target addres range starts.
 501 // -target-addr-end   <e> -- Specify where the phony target address range ends.
 502 // -target-section-sep <d> -- Specify how big a gap should be left between the
 503 //                            end of one section and the start of the next.
 504 //                            Defaults to zero. Set to something big
 505 //                            (e.g. 1 << 32) to stress-test stubs, GOTs, etc.
 506 //
 507 static void remapSectionsAndSymbols(const llvm::Triple &TargetTriple,
 508                                     TrivialMemoryManager &MemMgr,
 509                                     RuntimeDyldChecker &Checker) {
 510
 511   // Set up a work list (section addr/size pairs).
 512   typedef std::list<std::pair<void*, uint64_t>> WorklistT;
 513   WorklistT Worklist;
 514
 515   for (const auto& CodeSection : MemMgr.FunctionMemory)
 516     Worklist.push_back(std::make_pair(CodeSection.base(), CodeSection.size()));
 517   for (const auto& DataSection : MemMgr.DataMemory)
 518     Worklist.push_back(std::make_pair(DataSection.base(), DataSection.size()));
 519
 520   // Apply any section-specific mappings that were requested on the command
 521   // line.
 522   typedef std::map<void*, uint64_t> AppliedMappingsT;
 523   AppliedMappingsT AppliedMappings = applySpecificSectionMappings(Checker);
 524
 525   // Keep an "already allocated" mapping of section target addresses to sizes.
 526   // Sections whose address mappings aren't specified on the command line will
 527   // allocated around the explicitly mapped sections while maintaining the
 528   // minimum separation.
 529   std::map<uint64_t, uint64_t> AlreadyAllocated;
 530
 531   // Move the previously applied mappings into the already-allocated map.
 532   for (WorklistT::iterator I = Worklist.begin(), E = Worklist.end();
 533        I != E;) {
 534     WorklistT::iterator Tmp = I;
 535     ++I;
 536     AppliedMappingsT::iterator AI = AppliedMappings.find(Tmp->first);
 537
 538     if (AI != AppliedMappings.end()) {
 539       AlreadyAllocated[AI->second] = Tmp->second;
 540       Worklist.erase(Tmp);
 541     }
 542   }
 543
 544   // If the -target-addr-end option wasn't explicitly passed, then set it to a
 545   // sensible default based on the target triple.
 546   if (TargetAddrEnd.getNumOccurrences() == 0) {
 547     if (TargetTriple.isArch16Bit())
 548       TargetAddrEnd = (1ULL << 16) - 1;
 549     else if (TargetTriple.isArch32Bit())
 550       TargetAddrEnd = (1ULL << 32) - 1;
 551     // TargetAddrEnd already has a sensible default for 64-bit systems, so
 552     // there's nothing to do in the 64-bit case.
 553   }
 554
 555   // Process any elements remaining in the worklist.
 556   while (!Worklist.empty()) {
 557     std::pair<void*, uint64_t> CurEntry = Worklist.front();
 558     Worklist.pop_front();
 559
 560     uint64_t NextSectionAddr = TargetAddrStart;
 561
 562     for (const auto &Alloc : AlreadyAllocated)
 563       if (NextSectionAddr + CurEntry.second + TargetSectionSep <= Alloc.first)
 564         break;
 565       else
 566         NextSectionAddr = Alloc.first + Alloc.second + TargetSectionSep;
 567
 568     AlreadyAllocated[NextSectionAddr] = CurEntry.second;
 569     Checker.getRTDyld().mapSectionAddress(CurEntry.first, NextSectionAddr);
 570   }
 571
 572   // Add dummy symbols to the memory manager.
 573   for (const auto &Mapping : DummySymbolMappings) {
 574     size_t EqualsIdx = Mapping.find_first_of("=");
 575
 576     if (EqualsIdx == StringRef::npos)
 577       report_fatal_error("Invalid dummy symbol specification '" + Mapping +
 578                          "'. Should be '<symbol name>=<addr>'");
 579
 580     std::string Symbol = Mapping.substr(0, EqualsIdx);
 581     std::string AddrStr = Mapping.substr(EqualsIdx + 1);
 582
 583     uint64_t Addr;
 584     if (StringRef(AddrStr).getAsInteger(0, Addr))
 585       report_fatal_error("Invalid symbol mapping '" + Mapping + "'.");
 586
 587     MemMgr.addDummySymbol(Symbol, Addr);
 588   }
 589 }
 590
 591 // Load and link the objects specified on the command line, but do not execute
 592 // anything. Instead, attach a RuntimeDyldChecker instance and call it to
 593 // verify the correctness of the linked memory.
 594 static int linkAndVerify() {
 595
 596   // Check for missing triple.
 597   if (TripleName == "")
 598     return Error("-triple required when running in -verify mode.");
 599
 600   // Look up the target and build the disassembler.
 601   Triple TheTriple(Triple::normalize(TripleName));
 602   std::string ErrorStr;
 603   const Target *TheTarget =
 604     TargetRegistry::lookupTarget("", TheTriple, ErrorStr);
 605   if (!TheTarget)
 606     return Error("Error accessing target '" + TripleName + "': " + ErrorStr);
 607
 608   TripleName = TheTriple.getTriple();
 609
 610   std::unique_ptr<MCSubtargetInfo> STI(
 611     TheTarget->createMCSubtargetInfo(TripleName, MCPU, ""));
 612   if (!STI)
 613     return Error("Unable to create subtarget info!");
 614
 615   std::unique_ptr<MCRegisterInfo> MRI(TheTarget->createMCRegInfo(TripleName));
 616   if (!MRI)
 617     return Error("Unable to create target register info!");
 618
 619   std::unique_ptr<MCAsmInfo> MAI(TheTarget->createMCAsmInfo(*MRI, TripleName));
 620   if (!MAI)
 621     return Error("Unable to create target asm info!");
 622
 623   MCContext Ctx(MAI.get(), MRI.get(), nullptr);
 624
 625   std::unique_ptr<MCDisassembler> Disassembler(
 626     TheTarget->createMCDisassembler(*STI, Ctx));
 627   if (!Disassembler)
 628     return Error("Unable to create disassembler!");
 629
 630   std::unique_ptr<MCInstrInfo> MII(TheTarget->createMCInstrInfo());
 631
 632   std::unique_ptr<MCInstPrinter> InstPrinter(
 633       TheTarget->createMCInstPrinter(Triple(TripleName), 0, *MAI, *MII, *MRI));
 634
 635   // Load any dylibs requested on the command line.
 636   loadDylibs();
 637
 638   // Instantiate a dynamic linker.
 639   TrivialMemoryManager MemMgr;
 640   doPreallocation(MemMgr);
 641   RuntimeDyld Dyld(MemMgr, MemMgr);
 642   Dyld.setProcessAllSections(true);
 643   RuntimeDyldChecker Checker(Dyld, Disassembler.get(), InstPrinter.get(),
 644                              llvm::dbgs());
 645
 646   // FIXME: Preserve buffers until resolveRelocations time to work around a bug
 647   //        in RuntimeDyldELF.
 648   // This fixme should be fixed ASAP. This is a very brittle workaround.
 649   std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
 650
 651   // If we don't have any input files, read from stdin.
 652   if (!InputFileList.size())
 653     InputFileList.push_back("-");
 654   for (auto &Filename : InputFileList) {
 655     // Load the input memory buffer.
 656     ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
 657         MemoryBuffer::getFileOrSTDIN(Filename);
 658
 659     if (std::error_code EC = InputBuffer.getError())
 660       return Error("unable to read input: '" + EC.message() + "'");
 661
 662     ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
 663       ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
 664
 665     if (std::error_code EC = MaybeObj.getError())
 666       return Error("unable to create object file: '" + EC.message() + "'");
 667
 668     ObjectFile &Obj = **MaybeObj;
 669     InputBuffers.push_back(std::move(*InputBuffer));
 670
 671     // Load the object file
 672     Dyld.loadObject(Obj);
 673     if (Dyld.hasError()) {
 674       return Error(Dyld.getErrorString());
 675     }
 676   }
 677
 678   // Re-map the section addresses into the phony target address space and add
 679   // dummy symbols.
 680   remapSectionsAndSymbols(TheTriple, MemMgr, Checker);
 681
 682   // Resolve all the relocations we can.
 683   Dyld.resolveRelocations();
 684
 685   // Register EH frames.
 686   Dyld.registerEHFrames();
 687
 688   int ErrorCode = checkAllExpressions(Checker);
 689   if (Dyld.hasError())
 690     return Error("RTDyld reported an error applying relocations:\n  " +
 691                  Dyld.getErrorString());
 692
 693   return ErrorCode;
 694 }
 695
 696 int main(int argc, char **argv) {
 697   sys::PrintStackTraceOnErrorSignal();
 698   PrettyStackTraceProgram X(argc, argv);
 699
 700   ProgramName = argv[0];
 701   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
 702
 703   llvm::InitializeAllTargetInfos();
 704   llvm::InitializeAllTargetMCs();
 705   llvm::InitializeAllDisassemblers();
 706
 707   cl::ParseCommandLineOptions(argc, argv, "llvm MC-JIT tool\n");
 708
 709   switch (Action) {
 710   case AC_Execute:
 711     return executeInput();
 712   case AC_PrintDebugLineInfo:
 713     return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */ true);
 714   case AC_PrintLineInfo:
 715     return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */false);
 716   case AC_PrintObjectLineInfo:
 717     return printLineInfoForInput(/* LoadObjects */false,/* UseDebugObj */false);
 718   case AC_Verify:
 719     return linkAndVerify();
 720   }
 721 }