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::list<std::string>
87 cl::desc("File containing RuntimeDyld verifier checks."),
90 static cl::opt<uint64_t>
91 TargetAddrStart("target-addr-start",
92 cl::desc("For -verify only: start of phony target address "
94 cl::init(4096), // Start at "page 1" - no allocating at "null".
97 static cl::opt<uint64_t>
98 TargetAddrEnd("target-addr-end",
99 cl::desc("For -verify only: end of phony target address range."),
103 static cl::opt<uint64_t>
104 TargetSectionSep("target-section-sep",
105 cl::desc("For -verify only: Separation between sections in "
106 "phony target address space."),
110 static cl::list<std::string>
111 SpecificSectionMappings("map-section",
112 cl::desc("Map a section to a specific address."),
117 // A trivial memory manager that doesn't do anything fancy, just uses the
118 // support library allocation routines directly.
119 class TrivialMemoryManager : public RTDyldMemoryManager {
121 SmallVector<sys::MemoryBlock, 16> FunctionMemory;
122 SmallVector<sys::MemoryBlock, 16> DataMemory;
124 uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
126 StringRef SectionName) override;
127 uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
128 unsigned SectionID, StringRef SectionName,
129 bool IsReadOnly) override;
131 void *getPointerToNamedFunction(const std::string &Name,
132 bool AbortOnFailure = true) override {
136 bool finalizeMemory(std::string *ErrMsg) override { return false; }
138 // Invalidate instruction cache for sections with execute permissions.
139 // Some platforms with separate data cache and instruction cache require
140 // explicit cache flush, otherwise JIT code manipulations (like resolved
141 // relocations) will get to the data cache but not to the instruction cache.
142 virtual void invalidateInstructionCache();
144 void registerEHFrames(uint8_t *Addr, uint64_t LoadAddr,
145 size_t Size) override {}
146 void deregisterEHFrames(uint8_t *Addr, uint64_t LoadAddr,
147 size_t Size) override {}
150 uint8_t *TrivialMemoryManager::allocateCodeSection(uintptr_t Size,
153 StringRef SectionName) {
154 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, nullptr);
155 FunctionMemory.push_back(MB);
156 return (uint8_t*)MB.base();
159 uint8_t *TrivialMemoryManager::allocateDataSection(uintptr_t Size,
162 StringRef SectionName,
164 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, nullptr);
165 DataMemory.push_back(MB);
166 return (uint8_t*)MB.base();
169 void TrivialMemoryManager::invalidateInstructionCache() {
170 for (int i = 0, e = FunctionMemory.size(); i != e; ++i)
171 sys::Memory::InvalidateInstructionCache(FunctionMemory[i].base(),
172 FunctionMemory[i].size());
174 for (int i = 0, e = DataMemory.size(); i != e; ++i)
175 sys::Memory::InvalidateInstructionCache(DataMemory[i].base(),
176 DataMemory[i].size());
179 static const char *ProgramName;
181 static void Message(const char *Type, const Twine &Msg) {
182 errs() << ProgramName << ": " << Type << ": " << Msg << "\n";
185 static int Error(const Twine &Msg) {
186 Message("error", Msg);
190 static void loadDylibs() {
191 for (const std::string &Dylib : Dylibs) {
192 if (sys::fs::is_regular_file(Dylib)) {
194 if (sys::DynamicLibrary::LoadLibraryPermanently(Dylib.c_str(), &ErrMsg))
195 llvm::errs() << "Error loading '" << Dylib << "': "
198 llvm::errs() << "Dylib not found: '" << Dylib << "'.\n";
204 static int printLineInfoForInput(bool LoadObjects, bool UseDebugObj) {
205 assert(LoadObjects || !UseDebugObj);
207 // Load any dylibs requested on the command line.
210 // If we don't have any input files, read from stdin.
211 if (!InputFileList.size())
212 InputFileList.push_back("-");
213 for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
214 // Instantiate a dynamic linker.
215 TrivialMemoryManager MemMgr;
216 RuntimeDyld Dyld(MemMgr, MemMgr);
218 // Load the input memory buffer.
220 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
221 MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
222 if (std::error_code EC = InputBuffer.getError())
223 return Error("unable to read input: '" + EC.message() + "'");
225 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
226 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
228 if (std::error_code EC = MaybeObj.getError())
229 return Error("unable to create object file: '" + EC.message() + "'");
231 ObjectFile &Obj = **MaybeObj;
233 OwningBinary<ObjectFile> DebugObj;
234 std::unique_ptr<RuntimeDyld::LoadedObjectInfo> LoadedObjInfo = nullptr;
235 ObjectFile *SymbolObj = &Obj;
237 // Load the object file
239 Dyld.loadObject(Obj);
242 return Error(Dyld.getErrorString());
244 // Resolve all the relocations we can.
245 Dyld.resolveRelocations();
248 DebugObj = LoadedObjInfo->getObjectForDebug(Obj);
249 SymbolObj = DebugObj.getBinary();
253 std::unique_ptr<DIContext> Context(
254 new DWARFContextInMemory(*SymbolObj,LoadedObjInfo.get()));
256 ErrorOr<std::vector<std::pair<SymbolRef, uint64_t>>> SymAddrOrErr =
257 object::computeSymbolSizes(*SymbolObj);
258 if (std::error_code EC = SymAddrOrErr.getError())
259 return Error(EC.message());
261 // Use symbol info to iterate functions in the object.
262 for (const auto &P : *SymAddrOrErr) {
263 object::SymbolRef Sym = P.first;
264 object::SymbolRef::Type SymType;
265 if (Sym.getType(SymType))
267 if (SymType == object::SymbolRef::ST_Function) {
270 if (Sym.getName(Name))
272 if (Sym.getAddress(Addr))
275 uint64_t Size = P.second;
276 // If we're not using the debug object, compute the address of the
277 // symbol in memory (rather than that in the unrelocated object file)
278 // and use that to query the DWARFContext.
279 if (!UseDebugObj && LoadObjects) {
280 object::section_iterator Sec(SymbolObj->section_end());
283 Sec->getName(SecName);
284 uint64_t SectionLoadAddress =
285 LoadedObjInfo->getSectionLoadAddress(SecName);
286 if (SectionLoadAddress != 0)
287 Addr += SectionLoadAddress - Sec->getAddress();
290 outs() << "Function: " << Name << ", Size = " << Size << ", Addr = " << Addr << "\n";
292 DILineInfoTable Lines = Context->getLineInfoForAddressRange(Addr, Size);
293 DILineInfoTable::iterator Begin = Lines.begin();
294 DILineInfoTable::iterator End = Lines.end();
295 for (DILineInfoTable::iterator It = Begin; It != End; ++It) {
296 outs() << " Line info @ " << It->first - Addr << ": "
297 << It->second.FileName << ", line:" << It->second.Line << "\n";
306 static int executeInput() {
307 // Load any dylibs requested on the command line.
310 // Instantiate a dynamic linker.
311 TrivialMemoryManager MemMgr;
312 RuntimeDyld Dyld(MemMgr, MemMgr);
314 // FIXME: Preserve buffers until resolveRelocations time to work around a bug
315 // in RuntimeDyldELF.
316 // This fixme should be fixed ASAP. This is a very brittle workaround.
317 std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
319 // If we don't have any input files, read from stdin.
320 if (!InputFileList.size())
321 InputFileList.push_back("-");
322 for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
323 // Load the input memory buffer.
324 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
325 MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
326 if (std::error_code EC = InputBuffer.getError())
327 return Error("unable to read input: '" + EC.message() + "'");
328 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
329 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
331 if (std::error_code EC = MaybeObj.getError())
332 return Error("unable to create object file: '" + EC.message() + "'");
334 ObjectFile &Obj = **MaybeObj;
335 InputBuffers.push_back(std::move(*InputBuffer));
337 // Load the object file
338 Dyld.loadObject(Obj);
339 if (Dyld.hasError()) {
340 return Error(Dyld.getErrorString());
344 // Resolve all the relocations we can.
345 Dyld.resolveRelocations();
346 // Clear instruction cache before code will be executed.
347 MemMgr.invalidateInstructionCache();
349 // FIXME: Error out if there are unresolved relocations.
351 // Get the address of the entry point (_main by default).
352 void *MainAddress = Dyld.getSymbolLocalAddress(EntryPoint);
354 return Error("no definition for '" + EntryPoint + "'");
356 // Invalidate the instruction cache for each loaded function.
357 for (unsigned i = 0, e = MemMgr.FunctionMemory.size(); i != e; ++i) {
358 sys::MemoryBlock &Data = MemMgr.FunctionMemory[i];
359 // Make sure the memory is executable.
360 std::string ErrorStr;
361 sys::Memory::InvalidateInstructionCache(Data.base(), Data.size());
362 if (!sys::Memory::setExecutable(Data, &ErrorStr))
363 return Error("unable to mark function executable: '" + ErrorStr + "'");
366 // Dispatch to _main().
367 errs() << "loaded '" << EntryPoint << "' at: " << (void*)MainAddress << "\n";
369 int (*Main)(int, const char**) =
370 (int(*)(int,const char**)) uintptr_t(MainAddress);
371 const char **Argv = new const char*[2];
372 // Use the name of the first input object module as argv[0] for the target.
373 Argv[0] = InputFileList[0].c_str();
375 return Main(1, Argv);
378 static int checkAllExpressions(RuntimeDyldChecker &Checker) {
379 for (const auto& CheckerFileName : CheckFiles) {
380 ErrorOr<std::unique_ptr<MemoryBuffer>> CheckerFileBuf =
381 MemoryBuffer::getFileOrSTDIN(CheckerFileName);
382 if (std::error_code EC = CheckerFileBuf.getError())
383 return Error("unable to read input '" + CheckerFileName + "': " +
386 if (!Checker.checkAllRulesInBuffer("# rtdyld-check:",
387 CheckerFileBuf.get().get()))
388 return Error("some checks in '" + CheckerFileName + "' failed");
393 static std::map<void *, uint64_t>
394 applySpecificSectionMappings(RuntimeDyldChecker &Checker) {
396 std::map<void*, uint64_t> SpecificMappings;
398 for (StringRef Mapping : SpecificSectionMappings) {
400 size_t EqualsIdx = Mapping.find_first_of("=");
401 StringRef SectionIDStr = Mapping.substr(0, EqualsIdx);
402 size_t ComaIdx = Mapping.find_first_of(",");
404 if (ComaIdx == StringRef::npos) {
405 errs() << "Invalid section specification '" << Mapping
406 << "'. Should be '<file name>,<section name>=<addr>'\n";
410 StringRef FileName = SectionIDStr.substr(0, ComaIdx);
411 StringRef SectionName = SectionIDStr.substr(ComaIdx + 1);
414 std::string ErrorMsg;
415 std::tie(OldAddrInt, ErrorMsg) =
416 Checker.getSectionAddr(FileName, SectionName, true);
418 if (ErrorMsg != "") {
423 void* OldAddr = reinterpret_cast<void*>(static_cast<uintptr_t>(OldAddrInt));
425 StringRef NewAddrStr = Mapping.substr(EqualsIdx + 1);
428 if (NewAddrStr.getAsInteger(0, NewAddr)) {
429 errs() << "Invalid section address in mapping: " << Mapping << "\n";
433 Checker.getRTDyld().mapSectionAddress(OldAddr, NewAddr);
434 SpecificMappings[OldAddr] = NewAddr;
437 return SpecificMappings;
440 // Scatter sections in all directions!
441 // Remaps section addresses for -verify mode. The following command line options
442 // can be used to customize the layout of the memory within the phony target's
444 // -target-addr-start <s> -- Specify where the phony target addres range starts.
445 // -target-addr-end <e> -- Specify where the phony target address range ends.
446 // -target-section-sep <d> -- Specify how big a gap should be left between the
447 // end of one section and the start of the next.
448 // Defaults to zero. Set to something big
449 // (e.g. 1 << 32) to stress-test stubs, GOTs, etc.
451 static void remapSections(const llvm::Triple &TargetTriple,
452 const TrivialMemoryManager &MemMgr,
453 RuntimeDyldChecker &Checker) {
455 // Set up a work list (section addr/size pairs).
456 typedef std::list<std::pair<void*, uint64_t>> WorklistT;
459 for (const auto& CodeSection : MemMgr.FunctionMemory)
460 Worklist.push_back(std::make_pair(CodeSection.base(), CodeSection.size()));
461 for (const auto& DataSection : MemMgr.DataMemory)
462 Worklist.push_back(std::make_pair(DataSection.base(), DataSection.size()));
464 // Apply any section-specific mappings that were requested on the command
466 typedef std::map<void*, uint64_t> AppliedMappingsT;
467 AppliedMappingsT AppliedMappings = applySpecificSectionMappings(Checker);
469 // Keep an "already allocated" mapping of section target addresses to sizes.
470 // Sections whose address mappings aren't specified on the command line will
471 // allocated around the explicitly mapped sections while maintaining the
472 // minimum separation.
473 std::map<uint64_t, uint64_t> AlreadyAllocated;
475 // Move the previously applied mappings into the already-allocated map.
476 for (WorklistT::iterator I = Worklist.begin(), E = Worklist.end();
478 WorklistT::iterator Tmp = I;
480 AppliedMappingsT::iterator AI = AppliedMappings.find(Tmp->first);
482 if (AI != AppliedMappings.end()) {
483 AlreadyAllocated[AI->second] = Tmp->second;
488 // If the -target-addr-end option wasn't explicitly passed, then set it to a
489 // sensible default based on the target triple.
490 if (TargetAddrEnd.getNumOccurrences() == 0) {
491 if (TargetTriple.isArch16Bit())
492 TargetAddrEnd = (1ULL << 16) - 1;
493 else if (TargetTriple.isArch32Bit())
494 TargetAddrEnd = (1ULL << 32) - 1;
495 // TargetAddrEnd already has a sensible default for 64-bit systems, so
496 // there's nothing to do in the 64-bit case.
499 // Process any elements remaining in the worklist.
500 while (!Worklist.empty()) {
501 std::pair<void*, uint64_t> CurEntry = Worklist.front();
502 Worklist.pop_front();
504 uint64_t NextSectionAddr = TargetAddrStart;
506 for (const auto &Alloc : AlreadyAllocated)
507 if (NextSectionAddr + CurEntry.second + TargetSectionSep <= Alloc.first)
510 NextSectionAddr = Alloc.first + Alloc.second + TargetSectionSep;
512 AlreadyAllocated[NextSectionAddr] = CurEntry.second;
513 Checker.getRTDyld().mapSectionAddress(CurEntry.first, NextSectionAddr);
518 // Load and link the objects specified on the command line, but do not execute
519 // anything. Instead, attach a RuntimeDyldChecker instance and call it to
520 // verify the correctness of the linked memory.
521 static int linkAndVerify() {
523 // Check for missing triple.
524 if (TripleName == "") {
525 llvm::errs() << "Error: -triple required when running in -verify mode.\n";
529 // Look up the target and build the disassembler.
530 Triple TheTriple(Triple::normalize(TripleName));
531 std::string ErrorStr;
532 const Target *TheTarget =
533 TargetRegistry::lookupTarget("", TheTriple, ErrorStr);
535 llvm::errs() << "Error accessing target '" << TripleName << "': "
539 TripleName = TheTriple.getTriple();
541 std::unique_ptr<MCSubtargetInfo> STI(
542 TheTarget->createMCSubtargetInfo(TripleName, "", ""));
543 assert(STI && "Unable to create subtarget info!");
545 std::unique_ptr<MCRegisterInfo> MRI(TheTarget->createMCRegInfo(TripleName));
546 assert(MRI && "Unable to create target register info!");
548 std::unique_ptr<MCAsmInfo> MAI(TheTarget->createMCAsmInfo(*MRI, TripleName));
549 assert(MAI && "Unable to create target asm info!");
551 MCContext Ctx(MAI.get(), MRI.get(), nullptr);
553 std::unique_ptr<MCDisassembler> Disassembler(
554 TheTarget->createMCDisassembler(*STI, Ctx));
555 assert(Disassembler && "Unable to create disassembler!");
557 std::unique_ptr<MCInstrInfo> MII(TheTarget->createMCInstrInfo());
559 std::unique_ptr<MCInstPrinter> InstPrinter(
560 TheTarget->createMCInstPrinter(Triple(TripleName), 0, *MAI, *MII, *MRI));
562 // Load any dylibs requested on the command line.
565 // Instantiate a dynamic linker.
566 TrivialMemoryManager MemMgr;
567 RuntimeDyld Dyld(MemMgr, MemMgr);
568 Dyld.setProcessAllSections(true);
569 RuntimeDyldChecker Checker(Dyld, Disassembler.get(), InstPrinter.get(),
572 // FIXME: Preserve buffers until resolveRelocations time to work around a bug
573 // in RuntimeDyldELF.
574 // This fixme should be fixed ASAP. This is a very brittle workaround.
575 std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
577 // If we don't have any input files, read from stdin.
578 if (!InputFileList.size())
579 InputFileList.push_back("-");
580 for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
581 // Load the input memory buffer.
582 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
583 MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
585 if (std::error_code EC = InputBuffer.getError())
586 return Error("unable to read input: '" + EC.message() + "'");
588 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
589 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
591 if (std::error_code EC = MaybeObj.getError())
592 return Error("unable to create object file: '" + EC.message() + "'");
594 ObjectFile &Obj = **MaybeObj;
595 InputBuffers.push_back(std::move(*InputBuffer));
597 // Load the object file
598 Dyld.loadObject(Obj);
599 if (Dyld.hasError()) {
600 return Error(Dyld.getErrorString());
604 // Re-map the section addresses into the phony target address space.
605 remapSections(TheTriple, MemMgr, Checker);
607 // Resolve all the relocations we can.
608 Dyld.resolveRelocations();
610 // Register EH frames.
611 Dyld.registerEHFrames();
613 int ErrorCode = checkAllExpressions(Checker);
614 if (Dyld.hasError()) {
615 errs() << "RTDyld reported an error applying relocations:\n "
616 << Dyld.getErrorString() << "\n";
623 int main(int argc, char **argv) {
624 sys::PrintStackTraceOnErrorSignal();
625 PrettyStackTraceProgram X(argc, argv);
627 ProgramName = argv[0];
628 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
630 llvm::InitializeAllTargetInfos();
631 llvm::InitializeAllTargetMCs();
632 llvm::InitializeAllDisassemblers();
634 cl::ParseCommandLineOptions(argc, argv, "llvm MC-JIT tool\n");
638 return executeInput();
639 case AC_PrintDebugLineInfo:
640 return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */ true);
641 case AC_PrintLineInfo:
642 return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */false);
643 case AC_PrintObjectLineInfo:
644 return printLineInfoForInput(/* LoadObjects */false,/* UseDebugObj */false);
646 return linkAndVerify();