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/ExecutionEngine/ObjectBuffer.h"
17 #include "llvm/ExecutionEngine/ObjectImage.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/MCInstrInfo.h"
24 #include "llvm/MC/MCInstPrinter.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/raw_ostream.h"
34 #include "llvm/Support/Signals.h"
35 #include "llvm/Support/TargetRegistry.h"
36 #include "llvm/Support/TargetSelect.h"
37 #include <system_error>
40 using namespace llvm::object;
42 static cl::list<std::string>
43 InputFileList(cl::Positional, cl::ZeroOrMore,
44 cl::desc("<input file>"));
52 static cl::opt<ActionType>
53 Action(cl::desc("Action to perform:"),
55 cl::values(clEnumValN(AC_Execute, "execute",
56 "Load, link, and execute the inputs."),
57 clEnumValN(AC_PrintLineInfo, "printline",
58 "Load, link, and print line information for each function."),
59 clEnumValN(AC_Verify, "verify",
60 "Load, link and verify the resulting memory image."),
63 static cl::opt<std::string>
65 cl::desc("Function to call as entry point."),
68 static cl::list<std::string>
70 cl::desc("Add library."),
73 static cl::opt<std::string>
74 TripleName("triple", cl::desc("Target triple for disassembler"));
76 static cl::list<std::string>
78 cl::desc("File containing RuntimeDyld verifier checks."),
81 static cl::opt<uint64_t>
82 TargetAddrStart("target-addr-start",
83 cl::desc("For -verify only: start of phony target address "
85 cl::init(4096), // Start at "page 1" - no allocating at "null".
88 static cl::opt<uint64_t>
89 TargetAddrEnd("target-addr-end",
90 cl::desc("For -verify only: end of phony target address range."),
94 static cl::opt<uint64_t>
95 TargetSectionSep("target-section-sep",
96 cl::desc("For -verify only: Separation between sections in "
97 "phony target address space."),
103 // A trivial memory manager that doesn't do anything fancy, just uses the
104 // support library allocation routines directly.
105 class TrivialMemoryManager : public RTDyldMemoryManager {
107 SmallVector<sys::MemoryBlock, 16> FunctionMemory;
108 SmallVector<sys::MemoryBlock, 16> DataMemory;
110 uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
112 StringRef SectionName) override;
113 uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
114 unsigned SectionID, StringRef SectionName,
115 bool IsReadOnly) override;
117 void *getPointerToNamedFunction(const std::string &Name,
118 bool AbortOnFailure = true) override {
122 bool finalizeMemory(std::string *ErrMsg) override { return false; }
124 // Invalidate instruction cache for sections with execute permissions.
125 // Some platforms with separate data cache and instruction cache require
126 // explicit cache flush, otherwise JIT code manipulations (like resolved
127 // relocations) will get to the data cache but not to the instruction cache.
128 virtual void invalidateInstructionCache();
131 uint8_t *TrivialMemoryManager::allocateCodeSection(uintptr_t Size,
134 StringRef SectionName) {
135 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, nullptr);
136 FunctionMemory.push_back(MB);
137 return (uint8_t*)MB.base();
140 uint8_t *TrivialMemoryManager::allocateDataSection(uintptr_t Size,
143 StringRef SectionName,
145 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, nullptr);
146 DataMemory.push_back(MB);
147 return (uint8_t*)MB.base();
150 void TrivialMemoryManager::invalidateInstructionCache() {
151 for (int i = 0, e = FunctionMemory.size(); i != e; ++i)
152 sys::Memory::InvalidateInstructionCache(FunctionMemory[i].base(),
153 FunctionMemory[i].size());
155 for (int i = 0, e = DataMemory.size(); i != e; ++i)
156 sys::Memory::InvalidateInstructionCache(DataMemory[i].base(),
157 DataMemory[i].size());
160 static const char *ProgramName;
162 static void Message(const char *Type, const Twine &Msg) {
163 errs() << ProgramName << ": " << Type << ": " << Msg << "\n";
166 static int Error(const Twine &Msg) {
167 Message("error", Msg);
171 static void loadDylibs() {
172 for (const std::string &Dylib : Dylibs) {
173 if (sys::fs::is_regular_file(Dylib)) {
175 if (sys::DynamicLibrary::LoadLibraryPermanently(Dylib.c_str(), &ErrMsg))
176 llvm::errs() << "Error loading '" << Dylib << "': "
179 llvm::errs() << "Dylib not found: '" << Dylib << "'.\n";
185 static int printLineInfoForInput() {
186 // Load any dylibs requested on the command line.
189 // If we don't have any input files, read from stdin.
190 if (!InputFileList.size())
191 InputFileList.push_back("-");
192 for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
193 // Instantiate a dynamic linker.
194 TrivialMemoryManager MemMgr;
195 RuntimeDyld Dyld(&MemMgr);
197 // Load the input memory buffer.
199 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
200 MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
201 if (std::error_code EC = InputBuffer.getError())
202 return Error("unable to read input: '" + EC.message() + "'");
204 std::unique_ptr<ObjectImage> LoadedObject;
205 // Load the object file
207 Dyld.loadObject(new ObjectBuffer(InputBuffer.get().release())));
209 return Error(Dyld.getErrorString());
212 // Resolve all the relocations we can.
213 Dyld.resolveRelocations();
215 std::unique_ptr<DIContext> Context(
216 DIContext::getDWARFContext(*LoadedObject->getObjectFile()));
218 // Use symbol info to iterate functions in the object.
219 for (object::symbol_iterator I = LoadedObject->begin_symbols(),
220 E = LoadedObject->end_symbols();
222 object::SymbolRef::Type SymType;
223 if (I->getType(SymType)) continue;
224 if (SymType == object::SymbolRef::ST_Function) {
228 if (I->getName(Name)) continue;
229 if (I->getAddress(Addr)) continue;
230 if (I->getSize(Size)) continue;
232 outs() << "Function: " << Name << ", Size = " << Size << "\n";
234 DILineInfoTable Lines = Context->getLineInfoForAddressRange(Addr, Size);
235 DILineInfoTable::iterator Begin = Lines.begin();
236 DILineInfoTable::iterator End = Lines.end();
237 for (DILineInfoTable::iterator It = Begin; It != End; ++It) {
238 outs() << " Line info @ " << It->first - Addr << ": "
239 << It->second.FileName << ", line:" << It->second.Line << "\n";
248 static int executeInput() {
249 // Load any dylibs requested on the command line.
252 // Instantiate a dynamic linker.
253 TrivialMemoryManager MemMgr;
254 RuntimeDyld Dyld(&MemMgr);
256 // If we don't have any input files, read from stdin.
257 if (!InputFileList.size())
258 InputFileList.push_back("-");
259 for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
260 // Load the input memory buffer.
261 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
262 MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
263 if (std::error_code EC = InputBuffer.getError())
264 return Error("unable to read input: '" + EC.message() + "'");
265 std::unique_ptr<ObjectImage> LoadedObject;
266 // Load the object file
268 Dyld.loadObject(new ObjectBuffer(InputBuffer.get().release())));
270 return Error(Dyld.getErrorString());
274 // Resolve all the relocations we can.
275 Dyld.resolveRelocations();
276 // Clear instruction cache before code will be executed.
277 MemMgr.invalidateInstructionCache();
279 // FIXME: Error out if there are unresolved relocations.
281 // Get the address of the entry point (_main by default).
282 void *MainAddress = Dyld.getSymbolAddress(EntryPoint);
284 return Error("no definition for '" + EntryPoint + "'");
286 // Invalidate the instruction cache for each loaded function.
287 for (unsigned i = 0, e = MemMgr.FunctionMemory.size(); i != e; ++i) {
288 sys::MemoryBlock &Data = MemMgr.FunctionMemory[i];
289 // Make sure the memory is executable.
290 std::string ErrorStr;
291 sys::Memory::InvalidateInstructionCache(Data.base(), Data.size());
292 if (!sys::Memory::setExecutable(Data, &ErrorStr))
293 return Error("unable to mark function executable: '" + ErrorStr + "'");
296 // Dispatch to _main().
297 errs() << "loaded '" << EntryPoint << "' at: " << (void*)MainAddress << "\n";
299 int (*Main)(int, const char**) =
300 (int(*)(int,const char**)) uintptr_t(MainAddress);
301 const char **Argv = new const char*[2];
302 // Use the name of the first input object module as argv[0] for the target.
303 Argv[0] = InputFileList[0].c_str();
305 return Main(1, Argv);
308 static int checkAllExpressions(RuntimeDyldChecker &Checker) {
309 for (const auto& CheckerFileName : CheckFiles) {
310 ErrorOr<std::unique_ptr<MemoryBuffer>> CheckerFileBuf =
311 MemoryBuffer::getFileOrSTDIN(CheckerFileName);
312 if (std::error_code EC = CheckerFileBuf.getError())
313 return Error("unable to read input '" + CheckerFileName + "': " +
316 if (!Checker.checkAllRulesInBuffer("# rtdyld-check:",
317 CheckerFileBuf.get().get()))
318 return Error("some checks in '" + CheckerFileName + "' failed");
323 // Scatter sections in all directions!
324 // Remaps section addresses for -verify mode. The following command line options
325 // can be used to customize the layout of the memory within the phony target's
327 // -target-addr-start <s> -- Specify where the phony target addres range starts.
328 // -target-addr-end <e> -- Specify where the phony target address range ends.
329 // -target-section-sep <d> -- Specify how big a gap should be left between the
330 // end of one section and the start of the next.
331 // Defaults to zero. Set to something big
332 // (e.g. 1 << 32) to stress-test stubs, GOTs, etc.
334 void remapSections(const llvm::Triple &TargetTriple,
335 const TrivialMemoryManager &MemMgr,
336 RuntimeDyld &RTDyld) {
338 // If the -target-addr-end option wasn't explicitly passed, then set it to a
339 // sensible default based on the target triple.
340 if (TargetAddrEnd.getNumOccurrences() == 0) {
341 if (TargetTriple.isArch16Bit())
342 TargetAddrEnd = (1ULL << 16) - 1;
343 else if (TargetTriple.isArch32Bit())
344 TargetAddrEnd = (1ULL << 32) - 1;
345 // TargetAddrEnd already has a sensible default for 64-bit systems, so
346 // there's nothing to do in the 64-bit case.
349 uint64_t NextSectionAddress = TargetAddrStart;
351 // Remap code sections.
352 for (const auto& CodeSection : MemMgr.FunctionMemory) {
353 RTDyld.mapSectionAddress(CodeSection.base(), NextSectionAddress);
354 NextSectionAddress += CodeSection.size() + TargetSectionSep;
357 // Remap data sections.
358 for (const auto& DataSection : MemMgr.DataMemory) {
359 RTDyld.mapSectionAddress(DataSection.base(), NextSectionAddress);
360 NextSectionAddress += DataSection.size() + TargetSectionSep;
364 // Load and link the objects specified on the command line, but do not execute
365 // anything. Instead, attach a RuntimeDyldChecker instance and call it to
366 // verify the correctness of the linked memory.
367 static int linkAndVerify() {
369 // Check for missing triple.
370 if (TripleName == "") {
371 llvm::errs() << "Error: -triple required when running in -verify mode.\n";
375 // Look up the target and build the disassembler.
376 Triple TheTriple(Triple::normalize(TripleName));
377 std::string ErrorStr;
378 const Target *TheTarget =
379 TargetRegistry::lookupTarget("", TheTriple, ErrorStr);
381 llvm::errs() << "Error accessing target '" << TripleName << "': "
385 TripleName = TheTriple.getTriple();
387 std::unique_ptr<MCSubtargetInfo> STI(
388 TheTarget->createMCSubtargetInfo(TripleName, "", ""));
389 assert(STI && "Unable to create subtarget info!");
391 std::unique_ptr<MCRegisterInfo> MRI(TheTarget->createMCRegInfo(TripleName));
392 assert(MRI && "Unable to create target register info!");
394 std::unique_ptr<MCAsmInfo> MAI(TheTarget->createMCAsmInfo(*MRI, TripleName));
395 assert(MAI && "Unable to create target asm info!");
397 MCContext Ctx(MAI.get(), MRI.get(), nullptr);
399 std::unique_ptr<MCDisassembler> Disassembler(
400 TheTarget->createMCDisassembler(*STI, Ctx));
401 assert(Disassembler && "Unable to create disassembler!");
403 std::unique_ptr<MCInstrInfo> MII(TheTarget->createMCInstrInfo());
405 std::unique_ptr<MCInstPrinter> InstPrinter(
406 TheTarget->createMCInstPrinter(0, *MAI, *MII, *MRI, *STI));
408 // Load any dylibs requested on the command line.
411 // Instantiate a dynamic linker.
412 TrivialMemoryManager MemMgr;
413 RuntimeDyld Dyld(&MemMgr);
414 RuntimeDyldChecker Checker(Dyld, Disassembler.get(), InstPrinter.get(),
417 // If we don't have any input files, read from stdin.
418 if (!InputFileList.size())
419 InputFileList.push_back("-");
420 for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
421 // Load the input memory buffer.
422 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
423 MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
424 if (std::error_code EC = InputBuffer.getError())
425 return Error("unable to read input: '" + EC.message() + "'");
427 std::unique_ptr<ObjectImage> LoadedObject;
428 // Load the object file
430 Dyld.loadObject(new ObjectBuffer(InputBuffer.get().release())));
432 return Error(Dyld.getErrorString());
436 // Re-map the section addresses into the phony target address space.
437 remapSections(TheTriple, MemMgr, Dyld);
439 // Resolve all the relocations we can.
440 Dyld.resolveRelocations();
442 int ErrorCode = checkAllExpressions(Checker);
443 if (Dyld.hasError()) {
444 errs() << "RTDyld reported an error applying relocations:\n "
445 << Dyld.getErrorString() << "\n";
452 int main(int argc, char **argv) {
453 sys::PrintStackTraceOnErrorSignal();
454 PrettyStackTraceProgram X(argc, argv);
456 ProgramName = argv[0];
457 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
459 llvm::InitializeAllTargetInfos();
460 llvm::InitializeAllTargetMCs();
461 llvm::InitializeAllDisassemblers();
463 cl::ParseCommandLineOptions(argc, argv, "llvm MC-JIT tool\n");
467 return executeInput();
468 case AC_PrintLineInfo:
469 return printLineInfoForInput();
471 return linkAndVerify();