244ed27256957b7656819bacadbded57c3296a9b
[oota-llvm.git] / tools / llvm-rtdyld / llvm-rtdyld.cpp
1 //===-- llvm-rtdyld.cpp - MCJIT Testing Tool ------------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This is a testing tool for use with the MC-JIT LLVM components.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "llvm/ADT/StringMap.h"
15 #include "llvm/DebugInfo/DWARF/DIContext.h"
16 #include "llvm/ExecutionEngine/RTDyldMemoryManager.h"
17 #include "llvm/ExecutionEngine/RuntimeDyld.h"
18 #include "llvm/ExecutionEngine/RuntimeDyldChecker.h"
19 #include "llvm/MC/MCAsmInfo.h"
20 #include "llvm/MC/MCContext.h"
21 #include "llvm/MC/MCDisassembler.h"
22 #include "llvm/MC/MCInstPrinter.h"
23 #include "llvm/MC/MCInstrInfo.h"
24 #include "llvm/MC/MCRegisterInfo.h"
25 #include "llvm/Object/MachO.h"
26 #include "llvm/Support/CommandLine.h"
27 #include "llvm/Support/DynamicLibrary.h"
28 #include "llvm/Support/ManagedStatic.h"
29 #include "llvm/Support/Memory.h"
30 #include "llvm/Support/MemoryBuffer.h"
31 #include "llvm/Support/PrettyStackTrace.h"
32 #include "llvm/Support/Signals.h"
33 #include "llvm/Support/TargetRegistry.h"
34 #include "llvm/Support/TargetSelect.h"
35 #include "llvm/Support/raw_ostream.h"
36 #include <list>
37 #include <system_error>
38
39 using namespace llvm;
40 using namespace llvm::object;
41
42 static cl::list<std::string>
43 InputFileList(cl::Positional, cl::ZeroOrMore,
44               cl::desc("<input file>"));
45
46 enum ActionType {
47   AC_Execute,
48   AC_PrintLineInfo,
49   AC_Verify
50 };
51
52 static cl::opt<ActionType>
53 Action(cl::desc("Action to perform:"),
54        cl::init(AC_Execute),
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."),
61                   clEnumValEnd));
62
63 static cl::opt<std::string>
64 EntryPoint("entry",
65            cl::desc("Function to call as entry point."),
66            cl::init("_main"));
67
68 static cl::list<std::string>
69 Dylibs("dylib",
70        cl::desc("Add library."),
71        cl::ZeroOrMore);
72
73 static cl::opt<std::string>
74 TripleName("triple", cl::desc("Target triple for disassembler"));
75
76 static cl::list<std::string>
77 CheckFiles("check",
78            cl::desc("File containing RuntimeDyld verifier checks."),
79            cl::ZeroOrMore);
80
81 static cl::opt<uint64_t>
82 TargetAddrStart("target-addr-start",
83                 cl::desc("For -verify only: start of phony target address "
84                          "range."),
85                 cl::init(4096), // Start at "page 1" - no allocating at "null".
86                 cl::Hidden);
87
88 static cl::opt<uint64_t>
89 TargetAddrEnd("target-addr-end",
90               cl::desc("For -verify only: end of phony target address range."),
91               cl::init(~0ULL),
92               cl::Hidden);
93
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."),
98                  cl::init(0),
99                  cl::Hidden);
100
101 static cl::list<std::string>
102 SpecificSectionMappings("map-section",
103                         cl::desc("Map a section to a specific address."),
104                         cl::ZeroOrMore);
105
106 /* *** */
107
108 // A trivial memory manager that doesn't do anything fancy, just uses the
109 // support library allocation routines directly.
110 class TrivialMemoryManager : public RTDyldMemoryManager {
111 public:
112   SmallVector<sys::MemoryBlock, 16> FunctionMemory;
113   SmallVector<sys::MemoryBlock, 16> DataMemory;
114
115   uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
116                                unsigned SectionID,
117                                StringRef SectionName) override;
118   uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
119                                unsigned SectionID, StringRef SectionName,
120                                bool IsReadOnly) override;
121
122   void *getPointerToNamedFunction(const std::string &Name,
123                                   bool AbortOnFailure = true) override {
124     return nullptr;
125   }
126
127   bool finalizeMemory(std::string *ErrMsg) override { return false; }
128
129   // Invalidate instruction cache for sections with execute permissions.
130   // Some platforms with separate data cache and instruction cache require
131   // explicit cache flush, otherwise JIT code manipulations (like resolved
132   // relocations) will get to the data cache but not to the instruction cache.
133   virtual void invalidateInstructionCache();
134 };
135
136 uint8_t *TrivialMemoryManager::allocateCodeSection(uintptr_t Size,
137                                                    unsigned Alignment,
138                                                    unsigned SectionID,
139                                                    StringRef SectionName) {
140   sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, nullptr);
141   FunctionMemory.push_back(MB);
142   return (uint8_t*)MB.base();
143 }
144
145 uint8_t *TrivialMemoryManager::allocateDataSection(uintptr_t Size,
146                                                    unsigned Alignment,
147                                                    unsigned SectionID,
148                                                    StringRef SectionName,
149                                                    bool IsReadOnly) {
150   sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, nullptr);
151   DataMemory.push_back(MB);
152   return (uint8_t*)MB.base();
153 }
154
155 void TrivialMemoryManager::invalidateInstructionCache() {
156   for (int i = 0, e = FunctionMemory.size(); i != e; ++i)
157     sys::Memory::InvalidateInstructionCache(FunctionMemory[i].base(),
158                                             FunctionMemory[i].size());
159
160   for (int i = 0, e = DataMemory.size(); i != e; ++i)
161     sys::Memory::InvalidateInstructionCache(DataMemory[i].base(),
162                                             DataMemory[i].size());
163 }
164
165 static const char *ProgramName;
166
167 static void Message(const char *Type, const Twine &Msg) {
168   errs() << ProgramName << ": " << Type << ": " << Msg << "\n";
169 }
170
171 static int Error(const Twine &Msg) {
172   Message("error", Msg);
173   return 1;
174 }
175
176 static void loadDylibs() {
177   for (const std::string &Dylib : Dylibs) {
178     if (sys::fs::is_regular_file(Dylib)) {
179       std::string ErrMsg;
180       if (sys::DynamicLibrary::LoadLibraryPermanently(Dylib.c_str(), &ErrMsg))
181         llvm::errs() << "Error loading '" << Dylib << "': "
182                      << ErrMsg << "\n";
183     } else
184       llvm::errs() << "Dylib not found: '" << Dylib << "'.\n";
185   }
186 }
187
188 /* *** */
189
190 static int printLineInfoForInput() {
191   // Load any dylibs requested on the command line.
192   loadDylibs();
193
194   // If we don't have any input files, read from stdin.
195   if (!InputFileList.size())
196     InputFileList.push_back("-");
197   for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
198     // Instantiate a dynamic linker.
199     TrivialMemoryManager MemMgr;
200     RuntimeDyld Dyld(MemMgr, MemMgr);
201
202     // Load the input memory buffer.
203
204     ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
205         MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
206     if (std::error_code EC = InputBuffer.getError())
207       return Error("unable to read input: '" + EC.message() + "'");
208
209     ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
210       ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
211
212     if (std::error_code EC = MaybeObj.getError())
213       return Error("unable to create object file: '" + EC.message() + "'");
214
215     ObjectFile &Obj = **MaybeObj;
216
217     // Load the object file
218     std::unique_ptr<RuntimeDyld::LoadedObjectInfo> LoadedObjInfo =
219       Dyld.loadObject(Obj);
220
221     if (Dyld.hasError())
222       return Error(Dyld.getErrorString());
223
224     // Resolve all the relocations we can.
225     Dyld.resolveRelocations();
226
227     OwningBinary<ObjectFile> DebugObj = LoadedObjInfo->getObjectForDebug(Obj);
228
229     std::unique_ptr<DIContext> Context(
230       DIContext::getDWARFContext(*DebugObj.getBinary()));
231
232     // Use symbol info to iterate functions in the object.
233     for (object::symbol_iterator I = DebugObj.getBinary()->symbol_begin(),
234                                  E = DebugObj.getBinary()->symbol_end();
235          I != E; ++I) {
236       object::SymbolRef::Type SymType;
237       if (I->getType(SymType)) continue;
238       if (SymType == object::SymbolRef::ST_Function) {
239         StringRef  Name;
240         uint64_t   Addr;
241         uint64_t   Size;
242         if (I->getName(Name)) continue;
243         if (I->getAddress(Addr)) continue;
244         if (I->getSize(Size)) continue;
245
246         outs() << "Function: " << Name << ", Size = " << Size << "\n";
247
248         DILineInfoTable Lines = Context->getLineInfoForAddressRange(Addr, Size);
249         DILineInfoTable::iterator  Begin = Lines.begin();
250         DILineInfoTable::iterator  End = Lines.end();
251         for (DILineInfoTable::iterator It = Begin; It != End; ++It) {
252           outs() << "  Line info @ " << It->first - Addr << ": "
253                  << It->second.FileName << ", line:" << It->second.Line << "\n";
254         }
255       }
256     }
257   }
258
259   return 0;
260 }
261
262 static int executeInput() {
263   // Load any dylibs requested on the command line.
264   loadDylibs();
265
266   // Instantiate a dynamic linker.
267   TrivialMemoryManager MemMgr;
268   RuntimeDyld Dyld(MemMgr, MemMgr);
269
270   // If we don't have any input files, read from stdin.
271   if (!InputFileList.size())
272     InputFileList.push_back("-");
273   for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
274     // Load the input memory buffer.
275     ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
276         MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
277     if (std::error_code EC = InputBuffer.getError())
278       return Error("unable to read input: '" + EC.message() + "'");
279     ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
280       ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
281
282     if (std::error_code EC = MaybeObj.getError())
283       return Error("unable to create object file: '" + EC.message() + "'");
284
285     ObjectFile &Obj = **MaybeObj;
286
287     // Load the object file
288     Dyld.loadObject(Obj);
289     if (Dyld.hasError()) {
290       return Error(Dyld.getErrorString());
291     }
292   }
293
294   // Resolve all the relocations we can.
295   Dyld.resolveRelocations();
296   // Clear instruction cache before code will be executed.
297   MemMgr.invalidateInstructionCache();
298
299   // FIXME: Error out if there are unresolved relocations.
300
301   // Get the address of the entry point (_main by default).
302   void *MainAddress = Dyld.getSymbolLocalAddress(EntryPoint);
303   if (!MainAddress)
304     return Error("no definition for '" + EntryPoint + "'");
305
306   // Invalidate the instruction cache for each loaded function.
307   for (unsigned i = 0, e = MemMgr.FunctionMemory.size(); i != e; ++i) {
308     sys::MemoryBlock &Data = MemMgr.FunctionMemory[i];
309     // Make sure the memory is executable.
310     std::string ErrorStr;
311     sys::Memory::InvalidateInstructionCache(Data.base(), Data.size());
312     if (!sys::Memory::setExecutable(Data, &ErrorStr))
313       return Error("unable to mark function executable: '" + ErrorStr + "'");
314   }
315
316   // Dispatch to _main().
317   errs() << "loaded '" << EntryPoint << "' at: " << (void*)MainAddress << "\n";
318
319   int (*Main)(int, const char**) =
320     (int(*)(int,const char**)) uintptr_t(MainAddress);
321   const char **Argv = new const char*[2];
322   // Use the name of the first input object module as argv[0] for the target.
323   Argv[0] = InputFileList[0].c_str();
324   Argv[1] = nullptr;
325   return Main(1, Argv);
326 }
327
328 static int checkAllExpressions(RuntimeDyldChecker &Checker) {
329   for (const auto& CheckerFileName : CheckFiles) {
330     ErrorOr<std::unique_ptr<MemoryBuffer>> CheckerFileBuf =
331         MemoryBuffer::getFileOrSTDIN(CheckerFileName);
332     if (std::error_code EC = CheckerFileBuf.getError())
333       return Error("unable to read input '" + CheckerFileName + "': " +
334                    EC.message());
335
336     if (!Checker.checkAllRulesInBuffer("# rtdyld-check:",
337                                        CheckerFileBuf.get().get()))
338       return Error("some checks in '" + CheckerFileName + "' failed");
339   }
340   return 0;
341 }
342
343 static std::map<void *, uint64_t>
344 applySpecificSectionMappings(RuntimeDyldChecker &Checker) {
345
346   std::map<void*, uint64_t> SpecificMappings;
347
348   for (StringRef Mapping : SpecificSectionMappings) {
349
350     size_t EqualsIdx = Mapping.find_first_of("=");
351     StringRef SectionIDStr = Mapping.substr(0, EqualsIdx);
352     size_t ComaIdx = Mapping.find_first_of(",");
353
354     if (ComaIdx == StringRef::npos) {
355       errs() << "Invalid section specification '" << Mapping
356              << "'. Should be '<file name>,<section name>=<addr>'\n";
357       exit(1);
358     }
359
360     StringRef FileName = SectionIDStr.substr(0, ComaIdx);
361     StringRef SectionName = SectionIDStr.substr(ComaIdx + 1);
362
363     uint64_t OldAddrInt;
364     std::string ErrorMsg;
365     std::tie(OldAddrInt, ErrorMsg) =
366       Checker.getSectionAddr(FileName, SectionName, true);
367
368     if (ErrorMsg != "") {
369       errs() << ErrorMsg;
370       exit(1);
371     }
372
373     void* OldAddr = reinterpret_cast<void*>(static_cast<uintptr_t>(OldAddrInt));
374
375     StringRef NewAddrStr = Mapping.substr(EqualsIdx + 1);
376     uint64_t NewAddr;
377
378     if (NewAddrStr.getAsInteger(0, NewAddr)) {
379       errs() << "Invalid section address in mapping: " << Mapping << "\n";
380       exit(1);
381     }
382
383     Checker.getRTDyld().mapSectionAddress(OldAddr, NewAddr);
384     SpecificMappings[OldAddr] = NewAddr;
385   }
386
387   return SpecificMappings;
388 }
389
390 // Scatter sections in all directions!
391 // Remaps section addresses for -verify mode. The following command line options
392 // can be used to customize the layout of the memory within the phony target's
393 // address space:
394 // -target-addr-start <s> -- Specify where the phony target addres range starts.
395 // -target-addr-end   <e> -- Specify where the phony target address range ends.
396 // -target-section-sep <d> -- Specify how big a gap should be left between the
397 //                            end of one section and the start of the next.
398 //                            Defaults to zero. Set to something big
399 //                            (e.g. 1 << 32) to stress-test stubs, GOTs, etc.
400 //
401 static void remapSections(const llvm::Triple &TargetTriple,
402                           const TrivialMemoryManager &MemMgr,
403                           RuntimeDyldChecker &Checker) {
404
405   // Set up a work list (section addr/size pairs).
406   typedef std::list<std::pair<void*, uint64_t>> WorklistT;
407   WorklistT Worklist;
408
409   for (const auto& CodeSection : MemMgr.FunctionMemory)
410     Worklist.push_back(std::make_pair(CodeSection.base(), CodeSection.size()));
411   for (const auto& DataSection : MemMgr.DataMemory)
412     Worklist.push_back(std::make_pair(DataSection.base(), DataSection.size()));
413
414   // Apply any section-specific mappings that were requested on the command
415   // line.
416   typedef std::map<void*, uint64_t> AppliedMappingsT;
417   AppliedMappingsT AppliedMappings = applySpecificSectionMappings(Checker);
418
419   // Keep an "already allocated" mapping of section target addresses to sizes.
420   // Sections whose address mappings aren't specified on the command line will
421   // allocated around the explicitly mapped sections while maintaining the
422   // minimum separation.
423   std::map<uint64_t, uint64_t> AlreadyAllocated;
424
425   // Move the previously applied mappings into the already-allocated map.
426   for (WorklistT::iterator I = Worklist.begin(), E = Worklist.end();
427        I != E;) {
428     WorklistT::iterator Tmp = I;
429     ++I;
430     AppliedMappingsT::iterator AI = AppliedMappings.find(Tmp->first);
431
432     if (AI != AppliedMappings.end()) {
433       AlreadyAllocated[AI->second] = Tmp->second;
434       Worklist.erase(Tmp);
435     }
436   }
437
438   // If the -target-addr-end option wasn't explicitly passed, then set it to a
439   // sensible default based on the target triple.
440   if (TargetAddrEnd.getNumOccurrences() == 0) {
441     if (TargetTriple.isArch16Bit())
442       TargetAddrEnd = (1ULL << 16) - 1;
443     else if (TargetTriple.isArch32Bit())
444       TargetAddrEnd = (1ULL << 32) - 1;
445     // TargetAddrEnd already has a sensible default for 64-bit systems, so
446     // there's nothing to do in the 64-bit case.
447   }
448
449   // Process any elements remaining in the worklist.
450   while (!Worklist.empty()) {
451     std::pair<void*, uint64_t> CurEntry = Worklist.front();
452     Worklist.pop_front();
453
454     uint64_t NextSectionAddr = TargetAddrStart;
455
456     for (const auto &Alloc : AlreadyAllocated)
457       if (NextSectionAddr + CurEntry.second + TargetSectionSep <= Alloc.first)
458         break;
459       else
460         NextSectionAddr = Alloc.first + Alloc.second + TargetSectionSep;
461
462     AlreadyAllocated[NextSectionAddr] = CurEntry.second;
463     Checker.getRTDyld().mapSectionAddress(CurEntry.first, NextSectionAddr);
464   }
465
466 }
467
468 // Load and link the objects specified on the command line, but do not execute
469 // anything. Instead, attach a RuntimeDyldChecker instance and call it to
470 // verify the correctness of the linked memory.
471 static int linkAndVerify() {
472
473   // Check for missing triple.
474   if (TripleName == "") {
475     llvm::errs() << "Error: -triple required when running in -verify mode.\n";
476     return 1;
477   }
478
479   // Look up the target and build the disassembler.
480   Triple TheTriple(Triple::normalize(TripleName));
481   std::string ErrorStr;
482   const Target *TheTarget =
483     TargetRegistry::lookupTarget("", TheTriple, ErrorStr);
484   if (!TheTarget) {
485     llvm::errs() << "Error accessing target '" << TripleName << "': "
486                  << ErrorStr << "\n";
487     return 1;
488   }
489   TripleName = TheTriple.getTriple();
490
491   std::unique_ptr<MCSubtargetInfo> STI(
492     TheTarget->createMCSubtargetInfo(TripleName, "", ""));
493   assert(STI && "Unable to create subtarget info!");
494
495   std::unique_ptr<MCRegisterInfo> MRI(TheTarget->createMCRegInfo(TripleName));
496   assert(MRI && "Unable to create target register info!");
497
498   std::unique_ptr<MCAsmInfo> MAI(TheTarget->createMCAsmInfo(*MRI, TripleName));
499   assert(MAI && "Unable to create target asm info!");
500
501   MCContext Ctx(MAI.get(), MRI.get(), nullptr);
502
503   std::unique_ptr<MCDisassembler> Disassembler(
504     TheTarget->createMCDisassembler(*STI, Ctx));
505   assert(Disassembler && "Unable to create disassembler!");
506
507   std::unique_ptr<MCInstrInfo> MII(TheTarget->createMCInstrInfo());
508
509   std::unique_ptr<MCInstPrinter> InstPrinter(
510       TheTarget->createMCInstPrinter(Triple(TripleName), 0, *MAI, *MII, *MRI));
511
512   // Load any dylibs requested on the command line.
513   loadDylibs();
514
515   // Instantiate a dynamic linker.
516   TrivialMemoryManager MemMgr;
517   RuntimeDyld Dyld(MemMgr, MemMgr);
518   Dyld.setProcessAllSections(true);
519   RuntimeDyldChecker Checker(Dyld, Disassembler.get(), InstPrinter.get(),
520                              llvm::dbgs());
521
522   // If we don't have any input files, read from stdin.
523   if (!InputFileList.size())
524     InputFileList.push_back("-");
525   for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
526     // Load the input memory buffer.
527     ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
528         MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
529
530     if (std::error_code EC = InputBuffer.getError())
531       return Error("unable to read input: '" + EC.message() + "'");
532
533     ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
534       ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
535
536     if (std::error_code EC = MaybeObj.getError())
537       return Error("unable to create object file: '" + EC.message() + "'");
538
539     ObjectFile &Obj = **MaybeObj;
540
541     // Load the object file
542     Dyld.loadObject(Obj);
543     if (Dyld.hasError()) {
544       return Error(Dyld.getErrorString());
545     }
546   }
547
548   // Re-map the section addresses into the phony target address space.
549   remapSections(TheTriple, MemMgr, Checker);
550
551   // Resolve all the relocations we can.
552   Dyld.resolveRelocations();
553
554   // Register EH frames.
555   Dyld.registerEHFrames();
556
557   int ErrorCode = checkAllExpressions(Checker);
558   if (Dyld.hasError()) {
559     errs() << "RTDyld reported an error applying relocations:\n  "
560            << Dyld.getErrorString() << "\n";
561     ErrorCode = 1;
562   }
563
564   return ErrorCode;
565 }
566
567 int main(int argc, char **argv) {
568   sys::PrintStackTraceOnErrorSignal();
569   PrettyStackTraceProgram X(argc, argv);
570
571   ProgramName = argv[0];
572   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
573
574   llvm::InitializeAllTargetInfos();
575   llvm::InitializeAllTargetMCs();
576   llvm::InitializeAllDisassemblers();
577
578   cl::ParseCommandLineOptions(argc, argv, "llvm MC-JIT tool\n");
579
580   switch (Action) {
581   case AC_Execute:
582     return executeInput();
583   case AC_PrintLineInfo:
584     return printLineInfoForInput();
585   case AC_Verify:
586     return linkAndVerify();
587   }
588 }