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/Object/MachO.h"
27 #include "llvm/Support/CommandLine.h"
28 #include "llvm/Support/DynamicLibrary.h"
29 #include "llvm/Support/ManagedStatic.h"
30 #include "llvm/Support/Memory.h"
31 #include "llvm/Support/MemoryBuffer.h"
32 #include "llvm/Support/PrettyStackTrace.h"
33 #include "llvm/Support/Signals.h"
34 #include "llvm/Support/TargetRegistry.h"
35 #include "llvm/Support/TargetSelect.h"
36 #include "llvm/Support/raw_ostream.h"
38 #include <system_error>
41 using namespace llvm::object;
43 static cl::list<std::string>
44 InputFileList(cl::Positional, cl::ZeroOrMore,
45 cl::desc("<input file>"));
53 static cl::opt<ActionType>
54 Action(cl::desc("Action to perform:"),
56 cl::values(clEnumValN(AC_Execute, "execute",
57 "Load, link, and execute the inputs."),
58 clEnumValN(AC_PrintLineInfo, "printline",
59 "Load, link, and print line information for each function."),
60 clEnumValN(AC_Verify, "verify",
61 "Load, link and verify the resulting memory image."),
64 static cl::opt<std::string>
66 cl::desc("Function to call as entry point."),
69 static cl::list<std::string>
71 cl::desc("Add library."),
74 static cl::opt<std::string>
75 TripleName("triple", cl::desc("Target triple for disassembler"));
77 static cl::list<std::string>
79 cl::desc("File containing RuntimeDyld verifier checks."),
82 static cl::opt<uint64_t>
83 TargetAddrStart("target-addr-start",
84 cl::desc("For -verify only: start of phony target address "
86 cl::init(4096), // Start at "page 1" - no allocating at "null".
89 static cl::opt<uint64_t>
90 TargetAddrEnd("target-addr-end",
91 cl::desc("For -verify only: end of phony target address range."),
95 static cl::opt<uint64_t>
96 TargetSectionSep("target-section-sep",
97 cl::desc("For -verify only: Separation between sections in "
98 "phony target address space."),
102 static cl::list<std::string>
103 SpecificSectionMappings("map-section",
104 cl::desc("Map a section to a specific address."),
109 // A trivial memory manager that doesn't do anything fancy, just uses the
110 // support library allocation routines directly.
111 class TrivialMemoryManager : public RTDyldMemoryManager {
113 SmallVector<sys::MemoryBlock, 16> FunctionMemory;
114 SmallVector<sys::MemoryBlock, 16> DataMemory;
116 uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
118 StringRef SectionName) override;
119 uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
120 unsigned SectionID, StringRef SectionName,
121 bool IsReadOnly) override;
123 void *getPointerToNamedFunction(const std::string &Name,
124 bool AbortOnFailure = true) override {
128 bool finalizeMemory(std::string *ErrMsg) override { return false; }
130 // Invalidate instruction cache for sections with execute permissions.
131 // Some platforms with separate data cache and instruction cache require
132 // explicit cache flush, otherwise JIT code manipulations (like resolved
133 // relocations) will get to the data cache but not to the instruction cache.
134 virtual void invalidateInstructionCache();
137 uint8_t *TrivialMemoryManager::allocateCodeSection(uintptr_t Size,
140 StringRef SectionName) {
141 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, nullptr);
142 FunctionMemory.push_back(MB);
143 return (uint8_t*)MB.base();
146 uint8_t *TrivialMemoryManager::allocateDataSection(uintptr_t Size,
149 StringRef SectionName,
151 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, nullptr);
152 DataMemory.push_back(MB);
153 return (uint8_t*)MB.base();
156 void TrivialMemoryManager::invalidateInstructionCache() {
157 for (int i = 0, e = FunctionMemory.size(); i != e; ++i)
158 sys::Memory::InvalidateInstructionCache(FunctionMemory[i].base(),
159 FunctionMemory[i].size());
161 for (int i = 0, e = DataMemory.size(); i != e; ++i)
162 sys::Memory::InvalidateInstructionCache(DataMemory[i].base(),
163 DataMemory[i].size());
166 static const char *ProgramName;
168 static void Message(const char *Type, const Twine &Msg) {
169 errs() << ProgramName << ": " << Type << ": " << Msg << "\n";
172 static int Error(const Twine &Msg) {
173 Message("error", Msg);
177 static void loadDylibs() {
178 for (const std::string &Dylib : Dylibs) {
179 if (sys::fs::is_regular_file(Dylib)) {
181 if (sys::DynamicLibrary::LoadLibraryPermanently(Dylib.c_str(), &ErrMsg))
182 llvm::errs() << "Error loading '" << Dylib << "': "
185 llvm::errs() << "Dylib not found: '" << Dylib << "'.\n";
191 static int printLineInfoForInput() {
192 // Load any dylibs requested on the command line.
195 // If we don't have any input files, read from stdin.
196 if (!InputFileList.size())
197 InputFileList.push_back("-");
198 for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
199 // Instantiate a dynamic linker.
200 TrivialMemoryManager MemMgr;
201 RuntimeDyld Dyld(MemMgr, MemMgr);
203 // Load the input memory buffer.
205 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
206 MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
207 if (std::error_code EC = InputBuffer.getError())
208 return Error("unable to read input: '" + EC.message() + "'");
210 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
211 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
213 if (std::error_code EC = MaybeObj.getError())
214 return Error("unable to create object file: '" + EC.message() + "'");
216 ObjectFile &Obj = **MaybeObj;
218 // Load the object file
219 std::unique_ptr<RuntimeDyld::LoadedObjectInfo> LoadedObjInfo =
220 Dyld.loadObject(Obj);
223 return Error(Dyld.getErrorString());
225 // Resolve all the relocations we can.
226 Dyld.resolveRelocations();
228 OwningBinary<ObjectFile> DebugObj = LoadedObjInfo->getObjectForDebug(Obj);
230 std::unique_ptr<DIContext> Context(
231 new DWARFContextInMemory(*DebugObj.getBinary()));
233 // Use symbol info to iterate functions in the object.
234 for (object::symbol_iterator I = DebugObj.getBinary()->symbol_begin(),
235 E = DebugObj.getBinary()->symbol_end();
237 object::SymbolRef::Type SymType;
238 if (I->getType(SymType)) continue;
239 if (SymType == object::SymbolRef::ST_Function) {
243 if (I->getName(Name)) continue;
244 if (I->getAddress(Addr)) continue;
245 if (I->getSize(Size)) continue;
247 outs() << "Function: " << Name << ", Size = " << Size << "\n";
249 DILineInfoTable Lines = Context->getLineInfoForAddressRange(Addr, Size);
250 DILineInfoTable::iterator Begin = Lines.begin();
251 DILineInfoTable::iterator End = Lines.end();
252 for (DILineInfoTable::iterator It = Begin; It != End; ++It) {
253 outs() << " Line info @ " << It->first - Addr << ": "
254 << It->second.FileName << ", line:" << It->second.Line << "\n";
263 static int executeInput() {
264 // Load any dylibs requested on the command line.
267 // Instantiate a dynamic linker.
268 TrivialMemoryManager MemMgr;
269 RuntimeDyld Dyld(MemMgr, MemMgr);
271 // FIXME: Preserve buffers until resolveRelocations time to work around a bug
272 // in RuntimeDyldELF.
273 // This fixme should be fixed ASAP. This is a very brittle workaround.
274 std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
276 // If we don't have any input files, read from stdin.
277 if (!InputFileList.size())
278 InputFileList.push_back("-");
279 for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
280 // Load the input memory buffer.
281 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
282 MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
283 if (std::error_code EC = InputBuffer.getError())
284 return Error("unable to read input: '" + EC.message() + "'");
285 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
286 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
288 if (std::error_code EC = MaybeObj.getError())
289 return Error("unable to create object file: '" + EC.message() + "'");
291 ObjectFile &Obj = **MaybeObj;
292 InputBuffers.push_back(std::move(*InputBuffer));
294 // Load the object file
295 Dyld.loadObject(Obj);
296 if (Dyld.hasError()) {
297 return Error(Dyld.getErrorString());
301 // Resolve all the relocations we can.
302 Dyld.resolveRelocations();
303 // Clear instruction cache before code will be executed.
304 MemMgr.invalidateInstructionCache();
306 // FIXME: Error out if there are unresolved relocations.
308 // Get the address of the entry point (_main by default).
309 void *MainAddress = Dyld.getSymbolLocalAddress(EntryPoint);
311 return Error("no definition for '" + EntryPoint + "'");
313 // Invalidate the instruction cache for each loaded function.
314 for (unsigned i = 0, e = MemMgr.FunctionMemory.size(); i != e; ++i) {
315 sys::MemoryBlock &Data = MemMgr.FunctionMemory[i];
316 // Make sure the memory is executable.
317 std::string ErrorStr;
318 sys::Memory::InvalidateInstructionCache(Data.base(), Data.size());
319 if (!sys::Memory::setExecutable(Data, &ErrorStr))
320 return Error("unable to mark function executable: '" + ErrorStr + "'");
323 // Dispatch to _main().
324 errs() << "loaded '" << EntryPoint << "' at: " << (void*)MainAddress << "\n";
326 int (*Main)(int, const char**) =
327 (int(*)(int,const char**)) uintptr_t(MainAddress);
328 const char **Argv = new const char*[2];
329 // Use the name of the first input object module as argv[0] for the target.
330 Argv[0] = InputFileList[0].c_str();
332 return Main(1, Argv);
335 static int checkAllExpressions(RuntimeDyldChecker &Checker) {
336 for (const auto& CheckerFileName : CheckFiles) {
337 ErrorOr<std::unique_ptr<MemoryBuffer>> CheckerFileBuf =
338 MemoryBuffer::getFileOrSTDIN(CheckerFileName);
339 if (std::error_code EC = CheckerFileBuf.getError())
340 return Error("unable to read input '" + CheckerFileName + "': " +
343 if (!Checker.checkAllRulesInBuffer("# rtdyld-check:",
344 CheckerFileBuf.get().get()))
345 return Error("some checks in '" + CheckerFileName + "' failed");
350 static std::map<void *, uint64_t>
351 applySpecificSectionMappings(RuntimeDyldChecker &Checker) {
353 std::map<void*, uint64_t> SpecificMappings;
355 for (StringRef Mapping : SpecificSectionMappings) {
357 size_t EqualsIdx = Mapping.find_first_of("=");
358 StringRef SectionIDStr = Mapping.substr(0, EqualsIdx);
359 size_t ComaIdx = Mapping.find_first_of(",");
361 if (ComaIdx == StringRef::npos) {
362 errs() << "Invalid section specification '" << Mapping
363 << "'. Should be '<file name>,<section name>=<addr>'\n";
367 StringRef FileName = SectionIDStr.substr(0, ComaIdx);
368 StringRef SectionName = SectionIDStr.substr(ComaIdx + 1);
371 std::string ErrorMsg;
372 std::tie(OldAddrInt, ErrorMsg) =
373 Checker.getSectionAddr(FileName, SectionName, true);
375 if (ErrorMsg != "") {
380 void* OldAddr = reinterpret_cast<void*>(static_cast<uintptr_t>(OldAddrInt));
382 StringRef NewAddrStr = Mapping.substr(EqualsIdx + 1);
385 if (NewAddrStr.getAsInteger(0, NewAddr)) {
386 errs() << "Invalid section address in mapping: " << Mapping << "\n";
390 Checker.getRTDyld().mapSectionAddress(OldAddr, NewAddr);
391 SpecificMappings[OldAddr] = NewAddr;
394 return SpecificMappings;
397 // Scatter sections in all directions!
398 // Remaps section addresses for -verify mode. The following command line options
399 // can be used to customize the layout of the memory within the phony target's
401 // -target-addr-start <s> -- Specify where the phony target addres range starts.
402 // -target-addr-end <e> -- Specify where the phony target address range ends.
403 // -target-section-sep <d> -- Specify how big a gap should be left between the
404 // end of one section and the start of the next.
405 // Defaults to zero. Set to something big
406 // (e.g. 1 << 32) to stress-test stubs, GOTs, etc.
408 static void remapSections(const llvm::Triple &TargetTriple,
409 const TrivialMemoryManager &MemMgr,
410 RuntimeDyldChecker &Checker) {
412 // Set up a work list (section addr/size pairs).
413 typedef std::list<std::pair<void*, uint64_t>> WorklistT;
416 for (const auto& CodeSection : MemMgr.FunctionMemory)
417 Worklist.push_back(std::make_pair(CodeSection.base(), CodeSection.size()));
418 for (const auto& DataSection : MemMgr.DataMemory)
419 Worklist.push_back(std::make_pair(DataSection.base(), DataSection.size()));
421 // Apply any section-specific mappings that were requested on the command
423 typedef std::map<void*, uint64_t> AppliedMappingsT;
424 AppliedMappingsT AppliedMappings = applySpecificSectionMappings(Checker);
426 // Keep an "already allocated" mapping of section target addresses to sizes.
427 // Sections whose address mappings aren't specified on the command line will
428 // allocated around the explicitly mapped sections while maintaining the
429 // minimum separation.
430 std::map<uint64_t, uint64_t> AlreadyAllocated;
432 // Move the previously applied mappings into the already-allocated map.
433 for (WorklistT::iterator I = Worklist.begin(), E = Worklist.end();
435 WorklistT::iterator Tmp = I;
437 AppliedMappingsT::iterator AI = AppliedMappings.find(Tmp->first);
439 if (AI != AppliedMappings.end()) {
440 AlreadyAllocated[AI->second] = Tmp->second;
445 // If the -target-addr-end option wasn't explicitly passed, then set it to a
446 // sensible default based on the target triple.
447 if (TargetAddrEnd.getNumOccurrences() == 0) {
448 if (TargetTriple.isArch16Bit())
449 TargetAddrEnd = (1ULL << 16) - 1;
450 else if (TargetTriple.isArch32Bit())
451 TargetAddrEnd = (1ULL << 32) - 1;
452 // TargetAddrEnd already has a sensible default for 64-bit systems, so
453 // there's nothing to do in the 64-bit case.
456 // Process any elements remaining in the worklist.
457 while (!Worklist.empty()) {
458 std::pair<void*, uint64_t> CurEntry = Worklist.front();
459 Worklist.pop_front();
461 uint64_t NextSectionAddr = TargetAddrStart;
463 for (const auto &Alloc : AlreadyAllocated)
464 if (NextSectionAddr + CurEntry.second + TargetSectionSep <= Alloc.first)
467 NextSectionAddr = Alloc.first + Alloc.second + TargetSectionSep;
469 AlreadyAllocated[NextSectionAddr] = CurEntry.second;
470 Checker.getRTDyld().mapSectionAddress(CurEntry.first, NextSectionAddr);
475 // Load and link the objects specified on the command line, but do not execute
476 // anything. Instead, attach a RuntimeDyldChecker instance and call it to
477 // verify the correctness of the linked memory.
478 static int linkAndVerify() {
480 // Check for missing triple.
481 if (TripleName == "") {
482 llvm::errs() << "Error: -triple required when running in -verify mode.\n";
486 // Look up the target and build the disassembler.
487 Triple TheTriple(Triple::normalize(TripleName));
488 std::string ErrorStr;
489 const Target *TheTarget =
490 TargetRegistry::lookupTarget("", TheTriple, ErrorStr);
492 llvm::errs() << "Error accessing target '" << TripleName << "': "
496 TripleName = TheTriple.getTriple();
498 std::unique_ptr<MCSubtargetInfo> STI(
499 TheTarget->createMCSubtargetInfo(TripleName, "", ""));
500 assert(STI && "Unable to create subtarget info!");
502 std::unique_ptr<MCRegisterInfo> MRI(TheTarget->createMCRegInfo(TripleName));
503 assert(MRI && "Unable to create target register info!");
505 std::unique_ptr<MCAsmInfo> MAI(TheTarget->createMCAsmInfo(*MRI, TripleName));
506 assert(MAI && "Unable to create target asm info!");
508 MCContext Ctx(MAI.get(), MRI.get(), nullptr);
510 std::unique_ptr<MCDisassembler> Disassembler(
511 TheTarget->createMCDisassembler(*STI, Ctx));
512 assert(Disassembler && "Unable to create disassembler!");
514 std::unique_ptr<MCInstrInfo> MII(TheTarget->createMCInstrInfo());
516 std::unique_ptr<MCInstPrinter> InstPrinter(
517 TheTarget->createMCInstPrinter(Triple(TripleName), 0, *MAI, *MII, *MRI));
519 // Load any dylibs requested on the command line.
522 // Instantiate a dynamic linker.
523 TrivialMemoryManager MemMgr;
524 RuntimeDyld Dyld(MemMgr, MemMgr);
525 Dyld.setProcessAllSections(true);
526 RuntimeDyldChecker Checker(Dyld, Disassembler.get(), InstPrinter.get(),
529 // FIXME: Preserve buffers until resolveRelocations time to work around a bug
530 // in RuntimeDyldELF.
531 // This fixme should be fixed ASAP. This is a very brittle workaround.
532 std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
534 // If we don't have any input files, read from stdin.
535 if (!InputFileList.size())
536 InputFileList.push_back("-");
537 for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
538 // Load the input memory buffer.
539 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
540 MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
542 if (std::error_code EC = InputBuffer.getError())
543 return Error("unable to read input: '" + EC.message() + "'");
545 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
546 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
548 if (std::error_code EC = MaybeObj.getError())
549 return Error("unable to create object file: '" + EC.message() + "'");
551 ObjectFile &Obj = **MaybeObj;
552 InputBuffers.push_back(std::move(*InputBuffer));
554 // Load the object file
555 Dyld.loadObject(Obj);
556 if (Dyld.hasError()) {
557 return Error(Dyld.getErrorString());
561 // Re-map the section addresses into the phony target address space.
562 remapSections(TheTriple, MemMgr, Checker);
564 // Resolve all the relocations we can.
565 Dyld.resolveRelocations();
567 // Register EH frames.
568 Dyld.registerEHFrames();
570 int ErrorCode = checkAllExpressions(Checker);
571 if (Dyld.hasError()) {
572 errs() << "RTDyld reported an error applying relocations:\n "
573 << Dyld.getErrorString() << "\n";
580 int main(int argc, char **argv) {
581 sys::PrintStackTraceOnErrorSignal();
582 PrettyStackTraceProgram X(argc, argv);
584 ProgramName = argv[0];
585 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
587 llvm::InitializeAllTargetInfos();
588 llvm::InitializeAllTargetMCs();
589 llvm::InitializeAllDisassemblers();
591 cl::ParseCommandLineOptions(argc, argv, "llvm MC-JIT tool\n");
595 return executeInput();
596 case AC_PrintLineInfo:
597 return printLineInfoForInput();
599 return linkAndVerify();