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("Map a section to a specific address."),
123 // A trivial memory manager that doesn't do anything fancy, just uses the
124 // support library allocation routines directly.
125 class TrivialMemoryManager : public RTDyldMemoryManager {
127 SmallVector<sys::MemoryBlock, 16> FunctionMemory;
128 SmallVector<sys::MemoryBlock, 16> DataMemory;
130 uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
132 StringRef SectionName) override;
133 uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
134 unsigned SectionID, StringRef SectionName,
135 bool IsReadOnly) override;
137 void *getPointerToNamedFunction(const std::string &Name,
138 bool AbortOnFailure = true) override {
142 bool finalizeMemory(std::string *ErrMsg) override { return false; }
144 // Invalidate instruction cache for sections with execute permissions.
145 // Some platforms with separate data cache and instruction cache require
146 // explicit cache flush, otherwise JIT code manipulations (like resolved
147 // relocations) will get to the data cache but not to the instruction cache.
148 virtual void invalidateInstructionCache();
150 void registerEHFrames(uint8_t *Addr, uint64_t LoadAddr,
151 size_t Size) override {}
152 void deregisterEHFrames(uint8_t *Addr, uint64_t LoadAddr,
153 size_t Size) override {}
156 uint8_t *TrivialMemoryManager::allocateCodeSection(uintptr_t Size,
159 StringRef SectionName) {
160 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, nullptr);
161 FunctionMemory.push_back(MB);
162 return (uint8_t*)MB.base();
165 uint8_t *TrivialMemoryManager::allocateDataSection(uintptr_t Size,
168 StringRef SectionName,
170 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, nullptr);
171 DataMemory.push_back(MB);
172 return (uint8_t*)MB.base();
175 void TrivialMemoryManager::invalidateInstructionCache() {
176 for (int i = 0, e = FunctionMemory.size(); i != e; ++i)
177 sys::Memory::InvalidateInstructionCache(FunctionMemory[i].base(),
178 FunctionMemory[i].size());
180 for (int i = 0, e = DataMemory.size(); i != e; ++i)
181 sys::Memory::InvalidateInstructionCache(DataMemory[i].base(),
182 DataMemory[i].size());
185 static const char *ProgramName;
187 static void Message(const char *Type, const Twine &Msg) {
188 errs() << ProgramName << ": " << Type << ": " << Msg << "\n";
191 static int Error(const Twine &Msg) {
192 Message("error", Msg);
196 static void loadDylibs() {
197 for (const std::string &Dylib : Dylibs) {
198 if (sys::fs::is_regular_file(Dylib)) {
200 if (sys::DynamicLibrary::LoadLibraryPermanently(Dylib.c_str(), &ErrMsg))
201 llvm::errs() << "Error loading '" << Dylib << "': "
204 llvm::errs() << "Dylib not found: '" << Dylib << "'.\n";
210 static int printLineInfoForInput(bool LoadObjects, bool UseDebugObj) {
211 assert(LoadObjects || !UseDebugObj);
213 // Load any dylibs requested on the command line.
216 // If we don't have any input files, read from stdin.
217 if (!InputFileList.size())
218 InputFileList.push_back("-");
219 for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
220 // Instantiate a dynamic linker.
221 TrivialMemoryManager MemMgr;
222 RuntimeDyld Dyld(MemMgr, MemMgr);
224 // Load the input memory buffer.
226 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
227 MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
228 if (std::error_code EC = InputBuffer.getError())
229 return Error("unable to read input: '" + EC.message() + "'");
231 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
232 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
234 if (std::error_code EC = MaybeObj.getError())
235 return Error("unable to create object file: '" + EC.message() + "'");
237 ObjectFile &Obj = **MaybeObj;
239 OwningBinary<ObjectFile> DebugObj;
240 std::unique_ptr<RuntimeDyld::LoadedObjectInfo> LoadedObjInfo = nullptr;
241 ObjectFile *SymbolObj = &Obj;
243 // Load the object file
245 Dyld.loadObject(Obj);
248 return Error(Dyld.getErrorString());
250 // Resolve all the relocations we can.
251 Dyld.resolveRelocations();
254 DebugObj = LoadedObjInfo->getObjectForDebug(Obj);
255 SymbolObj = DebugObj.getBinary();
259 std::unique_ptr<DIContext> Context(
260 new DWARFContextInMemory(*SymbolObj,LoadedObjInfo.get()));
262 std::vector<std::pair<SymbolRef, uint64_t>> SymAddr =
263 object::computeSymbolSizes(*SymbolObj);
265 // Use symbol info to iterate functions in the object.
266 for (const auto &P : SymAddr) {
267 object::SymbolRef Sym = P.first;
268 object::SymbolRef::Type SymType;
269 if (Sym.getType(SymType))
271 if (SymType == object::SymbolRef::ST_Function) {
274 if (Sym.getName(Name))
276 if (Sym.getAddress(Addr))
279 uint64_t Size = P.second;
280 // If we're not using the debug object, compute the address of the
281 // symbol in memory (rather than that in the unrelocated object file)
282 // and use that to query the DWARFContext.
283 if (!UseDebugObj && LoadObjects) {
284 object::section_iterator Sec(SymbolObj->section_end());
287 Sec->getName(SecName);
288 uint64_t SectionLoadAddress =
289 LoadedObjInfo->getSectionLoadAddress(SecName);
290 if (SectionLoadAddress != 0)
291 Addr += SectionLoadAddress - Sec->getAddress();
294 outs() << "Function: " << Name << ", Size = " << Size << ", Addr = " << Addr << "\n";
296 DILineInfoTable Lines = Context->getLineInfoForAddressRange(Addr, Size);
297 DILineInfoTable::iterator Begin = Lines.begin();
298 DILineInfoTable::iterator End = Lines.end();
299 for (DILineInfoTable::iterator It = Begin; It != End; ++It) {
300 outs() << " Line info @ " << It->first - Addr << ": "
301 << It->second.FileName << ", line:" << It->second.Line << "\n";
310 static int executeInput() {
311 // Load any dylibs requested on the command line.
314 // Instantiate a dynamic linker.
315 TrivialMemoryManager MemMgr;
316 RuntimeDyld Dyld(MemMgr, MemMgr);
318 // FIXME: Preserve buffers until resolveRelocations time to work around a bug
319 // in RuntimeDyldELF.
320 // This fixme should be fixed ASAP. This is a very brittle workaround.
321 std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
323 // If we don't have any input files, read from stdin.
324 if (!InputFileList.size())
325 InputFileList.push_back("-");
326 for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
327 // Load the input memory buffer.
328 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
329 MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
330 if (std::error_code EC = InputBuffer.getError())
331 return Error("unable to read input: '" + EC.message() + "'");
332 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
333 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
335 if (std::error_code EC = MaybeObj.getError())
336 return Error("unable to create object file: '" + EC.message() + "'");
338 ObjectFile &Obj = **MaybeObj;
339 InputBuffers.push_back(std::move(*InputBuffer));
341 // Load the object file
342 Dyld.loadObject(Obj);
343 if (Dyld.hasError()) {
344 return Error(Dyld.getErrorString());
348 // Resolve all the relocations we can.
349 Dyld.resolveRelocations();
350 // Clear instruction cache before code will be executed.
351 MemMgr.invalidateInstructionCache();
353 // FIXME: Error out if there are unresolved relocations.
355 // Get the address of the entry point (_main by default).
356 void *MainAddress = Dyld.getSymbolLocalAddress(EntryPoint);
358 return Error("no definition for '" + EntryPoint + "'");
360 // Invalidate the instruction cache for each loaded function.
361 for (unsigned i = 0, e = MemMgr.FunctionMemory.size(); i != e; ++i) {
362 sys::MemoryBlock &Data = MemMgr.FunctionMemory[i];
363 // Make sure the memory is executable.
364 std::string ErrorStr;
365 sys::Memory::InvalidateInstructionCache(Data.base(), Data.size());
366 if (!sys::Memory::setExecutable(Data, &ErrorStr))
367 return Error("unable to mark function executable: '" + ErrorStr + "'");
370 // Dispatch to _main().
371 errs() << "loaded '" << EntryPoint << "' at: " << (void*)MainAddress << "\n";
373 int (*Main)(int, const char**) =
374 (int(*)(int,const char**)) uintptr_t(MainAddress);
375 const char **Argv = new const char*[2];
376 // Use the name of the first input object module as argv[0] for the target.
377 Argv[0] = InputFileList[0].c_str();
379 return Main(1, Argv);
382 static int checkAllExpressions(RuntimeDyldChecker &Checker) {
383 for (const auto& CheckerFileName : CheckFiles) {
384 ErrorOr<std::unique_ptr<MemoryBuffer>> CheckerFileBuf =
385 MemoryBuffer::getFileOrSTDIN(CheckerFileName);
386 if (std::error_code EC = CheckerFileBuf.getError())
387 return Error("unable to read input '" + CheckerFileName + "': " +
390 if (!Checker.checkAllRulesInBuffer("# rtdyld-check:",
391 CheckerFileBuf.get().get()))
392 return Error("some checks in '" + CheckerFileName + "' failed");
397 static std::map<void *, uint64_t>
398 applySpecificSectionMappings(RuntimeDyldChecker &Checker) {
400 std::map<void*, uint64_t> SpecificMappings;
402 for (StringRef Mapping : SpecificSectionMappings) {
404 size_t EqualsIdx = Mapping.find_first_of("=");
405 StringRef SectionIDStr = Mapping.substr(0, EqualsIdx);
406 size_t ComaIdx = Mapping.find_first_of(",");
408 if (ComaIdx == StringRef::npos) {
409 errs() << "Invalid section specification '" << Mapping
410 << "'. Should be '<file name>,<section name>=<addr>'\n";
414 StringRef FileName = SectionIDStr.substr(0, ComaIdx);
415 StringRef SectionName = SectionIDStr.substr(ComaIdx + 1);
418 std::string ErrorMsg;
419 std::tie(OldAddrInt, ErrorMsg) =
420 Checker.getSectionAddr(FileName, SectionName, true);
422 if (ErrorMsg != "") {
427 void* OldAddr = reinterpret_cast<void*>(static_cast<uintptr_t>(OldAddrInt));
429 StringRef NewAddrStr = Mapping.substr(EqualsIdx + 1);
432 if (NewAddrStr.getAsInteger(0, NewAddr)) {
433 errs() << "Invalid section address in mapping: " << Mapping << "\n";
437 Checker.getRTDyld().mapSectionAddress(OldAddr, NewAddr);
438 SpecificMappings[OldAddr] = NewAddr;
441 return SpecificMappings;
444 // Scatter sections in all directions!
445 // Remaps section addresses for -verify mode. The following command line options
446 // can be used to customize the layout of the memory within the phony target's
448 // -target-addr-start <s> -- Specify where the phony target addres range starts.
449 // -target-addr-end <e> -- Specify where the phony target address range ends.
450 // -target-section-sep <d> -- Specify how big a gap should be left between the
451 // end of one section and the start of the next.
452 // Defaults to zero. Set to something big
453 // (e.g. 1 << 32) to stress-test stubs, GOTs, etc.
455 static void remapSections(const llvm::Triple &TargetTriple,
456 const TrivialMemoryManager &MemMgr,
457 RuntimeDyldChecker &Checker) {
459 // Set up a work list (section addr/size pairs).
460 typedef std::list<std::pair<void*, uint64_t>> WorklistT;
463 for (const auto& CodeSection : MemMgr.FunctionMemory)
464 Worklist.push_back(std::make_pair(CodeSection.base(), CodeSection.size()));
465 for (const auto& DataSection : MemMgr.DataMemory)
466 Worklist.push_back(std::make_pair(DataSection.base(), DataSection.size()));
468 // Apply any section-specific mappings that were requested on the command
470 typedef std::map<void*, uint64_t> AppliedMappingsT;
471 AppliedMappingsT AppliedMappings = applySpecificSectionMappings(Checker);
473 // Keep an "already allocated" mapping of section target addresses to sizes.
474 // Sections whose address mappings aren't specified on the command line will
475 // allocated around the explicitly mapped sections while maintaining the
476 // minimum separation.
477 std::map<uint64_t, uint64_t> AlreadyAllocated;
479 // Move the previously applied mappings into the already-allocated map.
480 for (WorklistT::iterator I = Worklist.begin(), E = Worklist.end();
482 WorklistT::iterator Tmp = I;
484 AppliedMappingsT::iterator AI = AppliedMappings.find(Tmp->first);
486 if (AI != AppliedMappings.end()) {
487 AlreadyAllocated[AI->second] = Tmp->second;
492 // If the -target-addr-end option wasn't explicitly passed, then set it to a
493 // sensible default based on the target triple.
494 if (TargetAddrEnd.getNumOccurrences() == 0) {
495 if (TargetTriple.isArch16Bit())
496 TargetAddrEnd = (1ULL << 16) - 1;
497 else if (TargetTriple.isArch32Bit())
498 TargetAddrEnd = (1ULL << 32) - 1;
499 // TargetAddrEnd already has a sensible default for 64-bit systems, so
500 // there's nothing to do in the 64-bit case.
503 // Process any elements remaining in the worklist.
504 while (!Worklist.empty()) {
505 std::pair<void*, uint64_t> CurEntry = Worklist.front();
506 Worklist.pop_front();
508 uint64_t NextSectionAddr = TargetAddrStart;
510 for (const auto &Alloc : AlreadyAllocated)
511 if (NextSectionAddr + CurEntry.second + TargetSectionSep <= Alloc.first)
514 NextSectionAddr = Alloc.first + Alloc.second + TargetSectionSep;
516 AlreadyAllocated[NextSectionAddr] = CurEntry.second;
517 Checker.getRTDyld().mapSectionAddress(CurEntry.first, NextSectionAddr);
522 // Load and link the objects specified on the command line, but do not execute
523 // anything. Instead, attach a RuntimeDyldChecker instance and call it to
524 // verify the correctness of the linked memory.
525 static int linkAndVerify() {
527 // Check for missing triple.
528 if (TripleName == "") {
529 llvm::errs() << "Error: -triple required when running in -verify mode.\n";
533 // Look up the target and build the disassembler.
534 Triple TheTriple(Triple::normalize(TripleName));
535 std::string ErrorStr;
536 const Target *TheTarget =
537 TargetRegistry::lookupTarget("", TheTriple, ErrorStr);
539 llvm::errs() << "Error accessing target '" << TripleName << "': "
543 TripleName = TheTriple.getTriple();
545 std::unique_ptr<MCSubtargetInfo> STI(
546 TheTarget->createMCSubtargetInfo(TripleName, MCPU, ""));
547 assert(STI && "Unable to create subtarget info!");
549 std::unique_ptr<MCRegisterInfo> MRI(TheTarget->createMCRegInfo(TripleName));
550 assert(MRI && "Unable to create target register info!");
552 std::unique_ptr<MCAsmInfo> MAI(TheTarget->createMCAsmInfo(*MRI, TripleName));
553 assert(MAI && "Unable to create target asm info!");
555 MCContext Ctx(MAI.get(), MRI.get(), nullptr);
557 std::unique_ptr<MCDisassembler> Disassembler(
558 TheTarget->createMCDisassembler(*STI, Ctx));
559 assert(Disassembler && "Unable to create disassembler!");
561 std::unique_ptr<MCInstrInfo> MII(TheTarget->createMCInstrInfo());
563 std::unique_ptr<MCInstPrinter> InstPrinter(
564 TheTarget->createMCInstPrinter(Triple(TripleName), 0, *MAI, *MII, *MRI));
566 // Load any dylibs requested on the command line.
569 // Instantiate a dynamic linker.
570 TrivialMemoryManager MemMgr;
571 RuntimeDyld Dyld(MemMgr, MemMgr);
572 Dyld.setProcessAllSections(true);
573 RuntimeDyldChecker Checker(Dyld, Disassembler.get(), InstPrinter.get(),
576 // FIXME: Preserve buffers until resolveRelocations time to work around a bug
577 // in RuntimeDyldELF.
578 // This fixme should be fixed ASAP. This is a very brittle workaround.
579 std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
581 // If we don't have any input files, read from stdin.
582 if (!InputFileList.size())
583 InputFileList.push_back("-");
584 for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
585 // Load the input memory buffer.
586 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
587 MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
589 if (std::error_code EC = InputBuffer.getError())
590 return Error("unable to read input: '" + EC.message() + "'");
592 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
593 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
595 if (std::error_code EC = MaybeObj.getError())
596 return Error("unable to create object file: '" + EC.message() + "'");
598 ObjectFile &Obj = **MaybeObj;
599 InputBuffers.push_back(std::move(*InputBuffer));
601 // Load the object file
602 Dyld.loadObject(Obj);
603 if (Dyld.hasError()) {
604 return Error(Dyld.getErrorString());
608 // Re-map the section addresses into the phony target address space.
609 remapSections(TheTriple, MemMgr, Checker);
611 // Resolve all the relocations we can.
612 Dyld.resolveRelocations();
614 // Register EH frames.
615 Dyld.registerEHFrames();
617 int ErrorCode = checkAllExpressions(Checker);
618 if (Dyld.hasError()) {
619 errs() << "RTDyld reported an error applying relocations:\n "
620 << Dyld.getErrorString() << "\n";
627 int main(int argc, char **argv) {
628 sys::PrintStackTraceOnErrorSignal();
629 PrettyStackTraceProgram X(argc, argv);
631 ProgramName = argv[0];
632 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
634 llvm::InitializeAllTargetInfos();
635 llvm::InitializeAllTargetMCs();
636 llvm::InitializeAllDisassemblers();
638 cl::ParseCommandLineOptions(argc, argv, "llvm MC-JIT tool\n");
642 return executeInput();
643 case AC_PrintDebugLineInfo:
644 return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */ true);
645 case AC_PrintLineInfo:
646 return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */false);
647 case AC_PrintObjectLineInfo:
648 return printLineInfoForInput(/* LoadObjects */false,/* UseDebugObj */false);
650 return linkAndVerify();