1 //===-- llvm-rtdyld.cpp - MCJIT Testing Tool ------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This is a testing tool for use with the MC-JIT LLVM components.
12 //===----------------------------------------------------------------------===//
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"
40 #include <system_error>
43 using namespace llvm::object;
45 static cl::list<std::string>
46 InputFileList(cl::Positional, cl::ZeroOrMore,
47 cl::desc("<input file>"));
51 AC_PrintObjectLineInfo,
53 AC_PrintDebugLineInfo,
57 static cl::opt<ActionType>
58 Action(cl::desc("Action to perform:"),
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."),
72 static cl::opt<std::string>
74 cl::desc("Function to call as entry point."),
77 static cl::list<std::string>
79 cl::desc("Add library."),
82 static cl::opt<std::string>
83 TripleName("triple", cl::desc("Target triple for disassembler"));
85 static cl::opt<std::string>
87 cl::desc("Target a specific cpu type (-mcpu=help for details)"),
88 cl::value_desc("cpu-name"),
91 static cl::list<std::string>
93 cl::desc("File containing RuntimeDyld verifier checks."),
96 static cl::opt<uint64_t>
97 TargetAddrStart("target-addr-start",
98 cl::desc("For -verify only: start of phony target address "
100 cl::init(4096), // Start at "page 1" - no allocating at "null".
103 static cl::opt<uint64_t>
104 TargetAddrEnd("target-addr-end",
105 cl::desc("For -verify only: end of phony target address range."),
109 static cl::opt<uint64_t>
110 TargetSectionSep("target-section-sep",
111 cl::desc("For -verify only: Separation between sections in "
112 "phony target address space."),
116 static cl::list<std::string>
117 SpecificSectionMappings("map-section",
118 cl::desc("For -verify only: Map a section to a "
119 "specific address."),
123 static cl::list<std::string>
124 DummySymbolMappings("dummy-extern",
125 cl::desc("For -verify only: Inject a symbol into the extern "
132 // A trivial memory manager that doesn't do anything fancy, just uses the
133 // support library allocation routines directly.
134 class TrivialMemoryManager : public RTDyldMemoryManager {
136 SmallVector<sys::MemoryBlock, 16> FunctionMemory;
137 SmallVector<sys::MemoryBlock, 16> DataMemory;
139 uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
141 StringRef SectionName) override;
142 uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
143 unsigned SectionID, StringRef SectionName,
144 bool IsReadOnly) override;
146 void *getPointerToNamedFunction(const std::string &Name,
147 bool AbortOnFailure = true) override {
151 bool finalizeMemory(std::string *ErrMsg) override { return false; }
153 // Invalidate instruction cache for sections with execute permissions.
154 // Some platforms with separate data cache and instruction cache require
155 // explicit cache flush, otherwise JIT code manipulations (like resolved
156 // relocations) will get to the data cache but not to the instruction cache.
157 virtual void invalidateInstructionCache();
159 void addDummySymbol(const std::string &Name, uint64_t Addr) {
160 DummyExterns[Name] = Addr;
163 RuntimeDyld::SymbolInfo findSymbol(const std::string &Name) override {
164 auto I = DummyExterns.find(Name);
166 if (I != DummyExterns.end())
167 return RuntimeDyld::SymbolInfo(I->second, JITSymbolFlags::Exported);
169 return RTDyldMemoryManager::findSymbol(Name);
172 void registerEHFrames(uint8_t *Addr, uint64_t LoadAddr,
173 size_t Size) override {}
174 void deregisterEHFrames(uint8_t *Addr, uint64_t LoadAddr,
175 size_t Size) override {}
177 std::map<std::string, uint64_t> DummyExterns;
180 uint8_t *TrivialMemoryManager::allocateCodeSection(uintptr_t Size,
183 StringRef SectionName) {
184 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, nullptr);
185 FunctionMemory.push_back(MB);
186 return (uint8_t*)MB.base();
189 uint8_t *TrivialMemoryManager::allocateDataSection(uintptr_t Size,
192 StringRef SectionName,
194 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, nullptr);
195 DataMemory.push_back(MB);
196 return (uint8_t*)MB.base();
199 void TrivialMemoryManager::invalidateInstructionCache() {
200 for (auto &FM : FunctionMemory)
201 sys::Memory::InvalidateInstructionCache(FM.base(), FM.size());
203 for (auto &DM : DataMemory)
204 sys::Memory::InvalidateInstructionCache(DM.base(), DM.size());
207 static const char *ProgramName;
209 static void Message(const char *Type, const Twine &Msg) {
210 errs() << ProgramName << ": " << Type << ": " << Msg << "\n";
213 static int Error(const Twine &Msg) {
214 Message("error", Msg);
218 static void loadDylibs() {
219 for (const std::string &Dylib : Dylibs) {
220 if (sys::fs::is_regular_file(Dylib)) {
222 if (sys::DynamicLibrary::LoadLibraryPermanently(Dylib.c_str(), &ErrMsg))
223 llvm::errs() << "Error loading '" << Dylib << "': "
226 llvm::errs() << "Dylib not found: '" << Dylib << "'.\n";
232 static int printLineInfoForInput(bool LoadObjects, bool UseDebugObj) {
233 assert(LoadObjects || !UseDebugObj);
235 // Load any dylibs requested on the command line.
238 // If we don't have any input files, read from stdin.
239 if (!InputFileList.size())
240 InputFileList.push_back("-");
241 for (auto &File : InputFileList) {
242 // Instantiate a dynamic linker.
243 TrivialMemoryManager MemMgr;
244 RuntimeDyld Dyld(MemMgr, MemMgr);
246 // Load the input memory buffer.
248 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
249 MemoryBuffer::getFileOrSTDIN(File);
250 if (std::error_code EC = InputBuffer.getError())
251 return Error("unable to read input: '" + EC.message() + "'");
253 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
254 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
256 if (std::error_code EC = MaybeObj.getError())
257 return Error("unable to create object file: '" + EC.message() + "'");
259 ObjectFile &Obj = **MaybeObj;
261 OwningBinary<ObjectFile> DebugObj;
262 std::unique_ptr<RuntimeDyld::LoadedObjectInfo> LoadedObjInfo = nullptr;
263 ObjectFile *SymbolObj = &Obj;
265 // Load the object file
267 Dyld.loadObject(Obj);
270 return Error(Dyld.getErrorString());
272 // Resolve all the relocations we can.
273 Dyld.resolveRelocations();
276 DebugObj = LoadedObjInfo->getObjectForDebug(Obj);
277 SymbolObj = DebugObj.getBinary();
278 LoadedObjInfo.reset();
282 std::unique_ptr<DIContext> Context(
283 new DWARFContextInMemory(*SymbolObj,LoadedObjInfo.get()));
285 std::vector<std::pair<SymbolRef, uint64_t>> SymAddr =
286 object::computeSymbolSizes(*SymbolObj);
288 // Use symbol info to iterate functions in the object.
289 for (const auto &P : SymAddr) {
290 object::SymbolRef Sym = P.first;
291 if (Sym.getType() == object::SymbolRef::ST_Function) {
292 ErrorOr<StringRef> Name = Sym.getName();
295 ErrorOr<uint64_t> AddrOrErr = Sym.getAddress();
298 uint64_t Addr = *AddrOrErr;
300 uint64_t Size = P.second;
301 // If we're not using the debug object, compute the address of the
302 // symbol in memory (rather than that in the unrelocated object file)
303 // and use that to query the DWARFContext.
304 if (!UseDebugObj && LoadObjects) {
305 object::section_iterator Sec = *Sym.getSection();
307 Sec->getName(SecName);
308 uint64_t SectionLoadAddress =
309 LoadedObjInfo->getSectionLoadAddress(*Sec);
310 if (SectionLoadAddress != 0)
311 Addr += SectionLoadAddress - Sec->getAddress();
314 outs() << "Function: " << *Name << ", Size = " << Size
315 << ", Addr = " << Addr << "\n";
317 DILineInfoTable Lines = Context->getLineInfoForAddressRange(Addr, Size);
318 for (auto &D : Lines) {
319 outs() << " Line info @ " << D.first - Addr << ": "
320 << D.second.FileName << ", line:" << D.second.Line << "\n";
329 static int executeInput() {
330 // Load any dylibs requested on the command line.
333 // Instantiate a dynamic linker.
334 TrivialMemoryManager MemMgr;
335 RuntimeDyld Dyld(MemMgr, MemMgr);
337 // FIXME: Preserve buffers until resolveRelocations time to work around a bug
338 // in RuntimeDyldELF.
339 // This fixme should be fixed ASAP. This is a very brittle workaround.
340 std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
342 // If we don't have any input files, read from stdin.
343 if (!InputFileList.size())
344 InputFileList.push_back("-");
345 for (auto &File : InputFileList) {
346 // Load the input memory buffer.
347 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
348 MemoryBuffer::getFileOrSTDIN(File);
349 if (std::error_code EC = InputBuffer.getError())
350 return Error("unable to read input: '" + EC.message() + "'");
351 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
352 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
354 if (std::error_code EC = MaybeObj.getError())
355 return Error("unable to create object file: '" + EC.message() + "'");
357 ObjectFile &Obj = **MaybeObj;
358 InputBuffers.push_back(std::move(*InputBuffer));
360 // Load the object file
361 Dyld.loadObject(Obj);
362 if (Dyld.hasError()) {
363 return Error(Dyld.getErrorString());
367 // Resolve all the relocations we can.
368 Dyld.resolveRelocations();
369 // Clear instruction cache before code will be executed.
370 MemMgr.invalidateInstructionCache();
372 // FIXME: Error out if there are unresolved relocations.
374 // Get the address of the entry point (_main by default).
375 void *MainAddress = Dyld.getSymbolLocalAddress(EntryPoint);
377 return Error("no definition for '" + EntryPoint + "'");
379 // Invalidate the instruction cache for each loaded function.
380 for (auto &FM : MemMgr.FunctionMemory) {
381 // Make sure the memory is executable.
382 std::string ErrorStr;
383 sys::Memory::InvalidateInstructionCache(FM.base(), FM.size());
384 if (!sys::Memory::setExecutable(FM, &ErrorStr))
385 return Error("unable to mark function executable: '" + ErrorStr + "'");
388 // Dispatch to _main().
389 errs() << "loaded '" << EntryPoint << "' at: " << (void*)MainAddress << "\n";
391 int (*Main)(int, const char**) =
392 (int(*)(int,const char**)) uintptr_t(MainAddress);
393 const char **Argv = new const char*[2];
394 // Use the name of the first input object module as argv[0] for the target.
395 Argv[0] = InputFileList[0].c_str();
397 return Main(1, Argv);
400 static int checkAllExpressions(RuntimeDyldChecker &Checker) {
401 for (const auto& CheckerFileName : CheckFiles) {
402 ErrorOr<std::unique_ptr<MemoryBuffer>> CheckerFileBuf =
403 MemoryBuffer::getFileOrSTDIN(CheckerFileName);
404 if (std::error_code EC = CheckerFileBuf.getError())
405 return Error("unable to read input '" + CheckerFileName + "': " +
408 if (!Checker.checkAllRulesInBuffer("# rtdyld-check:",
409 CheckerFileBuf.get().get()))
410 return Error("some checks in '" + CheckerFileName + "' failed");
415 static std::map<void *, uint64_t>
416 applySpecificSectionMappings(RuntimeDyldChecker &Checker) {
418 std::map<void*, uint64_t> SpecificMappings;
420 for (StringRef Mapping : SpecificSectionMappings) {
422 size_t EqualsIdx = Mapping.find_first_of("=");
423 std::string SectionIDStr = Mapping.substr(0, EqualsIdx);
424 size_t ComaIdx = Mapping.find_first_of(",");
426 if (ComaIdx == StringRef::npos) {
427 errs() << "Invalid section specification '" << Mapping
428 << "'. Should be '<file name>,<section name>=<addr>'\n";
432 std::string FileName = SectionIDStr.substr(0, ComaIdx);
433 std::string SectionName = SectionIDStr.substr(ComaIdx + 1);
436 std::string ErrorMsg;
437 std::tie(OldAddrInt, ErrorMsg) =
438 Checker.getSectionAddr(FileName, SectionName, true);
440 if (ErrorMsg != "") {
445 void* OldAddr = reinterpret_cast<void*>(static_cast<uintptr_t>(OldAddrInt));
447 std::string NewAddrStr = Mapping.substr(EqualsIdx + 1);
450 if (StringRef(NewAddrStr).getAsInteger(0, NewAddr)) {
451 errs() << "Invalid section address in mapping '" << Mapping << "'.\n";
455 Checker.getRTDyld().mapSectionAddress(OldAddr, NewAddr);
456 SpecificMappings[OldAddr] = NewAddr;
459 return SpecificMappings;
462 // Scatter sections in all directions!
463 // Remaps section addresses for -verify mode. The following command line options
464 // can be used to customize the layout of the memory within the phony target's
466 // -target-addr-start <s> -- Specify where the phony target addres range starts.
467 // -target-addr-end <e> -- Specify where the phony target address range ends.
468 // -target-section-sep <d> -- Specify how big a gap should be left between the
469 // end of one section and the start of the next.
470 // Defaults to zero. Set to something big
471 // (e.g. 1 << 32) to stress-test stubs, GOTs, etc.
473 static void remapSectionsAndSymbols(const llvm::Triple &TargetTriple,
474 TrivialMemoryManager &MemMgr,
475 RuntimeDyldChecker &Checker) {
477 // Set up a work list (section addr/size pairs).
478 typedef std::list<std::pair<void*, uint64_t>> WorklistT;
481 for (const auto& CodeSection : MemMgr.FunctionMemory)
482 Worklist.push_back(std::make_pair(CodeSection.base(), CodeSection.size()));
483 for (const auto& DataSection : MemMgr.DataMemory)
484 Worklist.push_back(std::make_pair(DataSection.base(), DataSection.size()));
486 // Apply any section-specific mappings that were requested on the command
488 typedef std::map<void*, uint64_t> AppliedMappingsT;
489 AppliedMappingsT AppliedMappings = applySpecificSectionMappings(Checker);
491 // Keep an "already allocated" mapping of section target addresses to sizes.
492 // Sections whose address mappings aren't specified on the command line will
493 // allocated around the explicitly mapped sections while maintaining the
494 // minimum separation.
495 std::map<uint64_t, uint64_t> AlreadyAllocated;
497 // Move the previously applied mappings into the already-allocated map.
498 for (WorklistT::iterator I = Worklist.begin(), E = Worklist.end();
500 WorklistT::iterator Tmp = I;
502 AppliedMappingsT::iterator AI = AppliedMappings.find(Tmp->first);
504 if (AI != AppliedMappings.end()) {
505 AlreadyAllocated[AI->second] = Tmp->second;
510 // If the -target-addr-end option wasn't explicitly passed, then set it to a
511 // sensible default based on the target triple.
512 if (TargetAddrEnd.getNumOccurrences() == 0) {
513 if (TargetTriple.isArch16Bit())
514 TargetAddrEnd = (1ULL << 16) - 1;
515 else if (TargetTriple.isArch32Bit())
516 TargetAddrEnd = (1ULL << 32) - 1;
517 // TargetAddrEnd already has a sensible default for 64-bit systems, so
518 // there's nothing to do in the 64-bit case.
521 // Process any elements remaining in the worklist.
522 while (!Worklist.empty()) {
523 std::pair<void*, uint64_t> CurEntry = Worklist.front();
524 Worklist.pop_front();
526 uint64_t NextSectionAddr = TargetAddrStart;
528 for (const auto &Alloc : AlreadyAllocated)
529 if (NextSectionAddr + CurEntry.second + TargetSectionSep <= Alloc.first)
532 NextSectionAddr = Alloc.first + Alloc.second + TargetSectionSep;
534 AlreadyAllocated[NextSectionAddr] = CurEntry.second;
535 Checker.getRTDyld().mapSectionAddress(CurEntry.first, NextSectionAddr);
538 // Add dummy symbols to the memory manager.
539 for (const auto &Mapping : DummySymbolMappings) {
540 size_t EqualsIdx = Mapping.find_first_of("=");
542 if (EqualsIdx == StringRef::npos) {
543 errs() << "Invalid dummy symbol specification '" << Mapping
544 << "'. Should be '<symbol name>=<addr>'\n";
548 std::string Symbol = Mapping.substr(0, EqualsIdx);
549 std::string AddrStr = Mapping.substr(EqualsIdx + 1);
552 if (StringRef(AddrStr).getAsInteger(0, Addr)) {
553 errs() << "Invalid symbol mapping '" << Mapping << "'.\n";
557 MemMgr.addDummySymbol(Symbol, Addr);
561 // Load and link the objects specified on the command line, but do not execute
562 // anything. Instead, attach a RuntimeDyldChecker instance and call it to
563 // verify the correctness of the linked memory.
564 static int linkAndVerify() {
566 // Check for missing triple.
567 if (TripleName == "") {
568 llvm::errs() << "Error: -triple required when running in -verify mode.\n";
572 // Look up the target and build the disassembler.
573 Triple TheTriple(Triple::normalize(TripleName));
574 std::string ErrorStr;
575 const Target *TheTarget =
576 TargetRegistry::lookupTarget("", TheTriple, ErrorStr);
578 llvm::errs() << "Error accessing target '" << TripleName << "': "
582 TripleName = TheTriple.getTriple();
584 std::unique_ptr<MCSubtargetInfo> STI(
585 TheTarget->createMCSubtargetInfo(TripleName, MCPU, ""));
586 assert(STI && "Unable to create subtarget info!");
588 std::unique_ptr<MCRegisterInfo> MRI(TheTarget->createMCRegInfo(TripleName));
589 assert(MRI && "Unable to create target register info!");
591 std::unique_ptr<MCAsmInfo> MAI(TheTarget->createMCAsmInfo(*MRI, TripleName));
592 assert(MAI && "Unable to create target asm info!");
594 MCContext Ctx(MAI.get(), MRI.get(), nullptr);
596 std::unique_ptr<MCDisassembler> Disassembler(
597 TheTarget->createMCDisassembler(*STI, Ctx));
598 assert(Disassembler && "Unable to create disassembler!");
600 std::unique_ptr<MCInstrInfo> MII(TheTarget->createMCInstrInfo());
602 std::unique_ptr<MCInstPrinter> InstPrinter(
603 TheTarget->createMCInstPrinter(Triple(TripleName), 0, *MAI, *MII, *MRI));
605 // Load any dylibs requested on the command line.
608 // Instantiate a dynamic linker.
609 TrivialMemoryManager MemMgr;
610 RuntimeDyld Dyld(MemMgr, MemMgr);
611 Dyld.setProcessAllSections(true);
612 RuntimeDyldChecker Checker(Dyld, Disassembler.get(), InstPrinter.get(),
615 // FIXME: Preserve buffers until resolveRelocations time to work around a bug
616 // in RuntimeDyldELF.
617 // This fixme should be fixed ASAP. This is a very brittle workaround.
618 std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
620 // If we don't have any input files, read from stdin.
621 if (!InputFileList.size())
622 InputFileList.push_back("-");
623 for (auto &Filename : InputFileList) {
624 // Load the input memory buffer.
625 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
626 MemoryBuffer::getFileOrSTDIN(Filename);
628 if (std::error_code EC = InputBuffer.getError())
629 return Error("unable to read input: '" + EC.message() + "'");
631 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
632 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
634 if (std::error_code EC = MaybeObj.getError())
635 return Error("unable to create object file: '" + EC.message() + "'");
637 ObjectFile &Obj = **MaybeObj;
638 InputBuffers.push_back(std::move(*InputBuffer));
640 // Load the object file
641 Dyld.loadObject(Obj);
642 if (Dyld.hasError()) {
643 return Error(Dyld.getErrorString());
647 // Re-map the section addresses into the phony target address space and add
649 remapSectionsAndSymbols(TheTriple, MemMgr, Checker);
651 // Resolve all the relocations we can.
652 Dyld.resolveRelocations();
654 // Register EH frames.
655 Dyld.registerEHFrames();
657 int ErrorCode = checkAllExpressions(Checker);
658 if (Dyld.hasError()) {
659 errs() << "RTDyld reported an error applying relocations:\n "
660 << Dyld.getErrorString() << "\n";
667 int main(int argc, char **argv) {
668 sys::PrintStackTraceOnErrorSignal();
669 PrettyStackTraceProgram X(argc, argv);
671 ProgramName = argv[0];
672 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
674 llvm::InitializeAllTargetInfos();
675 llvm::InitializeAllTargetMCs();
676 llvm::InitializeAllDisassemblers();
678 cl::ParseCommandLineOptions(argc, argv, "llvm MC-JIT tool\n");
682 return executeInput();
683 case AC_PrintDebugLineInfo:
684 return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */ true);
685 case AC_PrintLineInfo:
686 return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */false);
687 case AC_PrintObjectLineInfo:
688 return printLineInfoForInput(/* LoadObjects */false,/* UseDebugObj */false);
690 return linkAndVerify();