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/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>
  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 /* *** */
  82
  83 // A trivial memory manager that doesn't do anything fancy, just uses the
  84 // support library allocation routines directly.
  85 class TrivialMemoryManager : public RTDyldMemoryManager {
  86 public:
  87   SmallVector<sys::MemoryBlock, 16> FunctionMemory;
  88   SmallVector<sys::MemoryBlock, 16> DataMemory;
  89
  90   uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
  91                                unsigned SectionID,
  92                                StringRef SectionName) override;
  93   uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
  94                                unsigned SectionID, StringRef SectionName,
  95                                bool IsReadOnly) override;
  96
  97   void *getPointerToNamedFunction(const std::string &Name,
  98                                   bool AbortOnFailure = true) override {
  99     return nullptr;
 100   }
 101
 102   bool finalizeMemory(std::string *ErrMsg) override { return false; }
 103
 104   // Invalidate instruction cache for sections with execute permissions.
 105   // Some platforms with separate data cache and instruction cache require
 106   // explicit cache flush, otherwise JIT code manipulations (like resolved
 107   // relocations) will get to the data cache but not to the instruction cache.
 108   virtual void invalidateInstructionCache();
 109 };
 110
 111 uint8_t *TrivialMemoryManager::allocateCodeSection(uintptr_t Size,
 112                                                    unsigned Alignment,
 113                                                    unsigned SectionID,
 114                                                    StringRef SectionName) {
 115   sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, nullptr);
 116   FunctionMemory.push_back(MB);
 117   return (uint8_t*)MB.base();
 118 }
 119
 120 uint8_t *TrivialMemoryManager::allocateDataSection(uintptr_t Size,
 121                                                    unsigned Alignment,
 122                                                    unsigned SectionID,
 123                                                    StringRef SectionName,
 124                                                    bool IsReadOnly) {
 125   sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, nullptr);
 126   DataMemory.push_back(MB);
 127   return (uint8_t*)MB.base();
 128 }
 129
 130 void TrivialMemoryManager::invalidateInstructionCache() {
 131   for (int i = 0, e = FunctionMemory.size(); i != e; ++i)
 132     sys::Memory::InvalidateInstructionCache(FunctionMemory[i].base(),
 133                                             FunctionMemory[i].size());
 134
 135   for (int i = 0, e = DataMemory.size(); i != e; ++i)
 136     sys::Memory::InvalidateInstructionCache(DataMemory[i].base(),
 137                                             DataMemory[i].size());
 138 }
 139
 140 static const char *ProgramName;
 141
 142 static void Message(const char *Type, const Twine &Msg) {
 143   errs() << ProgramName << ": " << Type << ": " << Msg << "\n";
 144 }
 145
 146 static int Error(const Twine &Msg) {
 147   Message("error", Msg);
 148   return 1;
 149 }
 150
 151 static void loadDylibs() {
 152   for (const std::string &Dylib : Dylibs) {
 153     if (sys::fs::is_regular_file(Dylib)) {
 154       std::string ErrMsg;
 155       if (sys::DynamicLibrary::LoadLibraryPermanently(Dylib.c_str(), &ErrMsg))
 156         llvm::errs() << "Error loading '" << Dylib << "': "
 157                      << ErrMsg << "\n";
 158     } else
 159       llvm::errs() << "Dylib not found: '" << Dylib << "'.\n";
 160   }
 161 }
 162
 163 /* *** */
 164
 165 static int printLineInfoForInput() {
 166   // Load any dylibs requested on the command line.
 167   loadDylibs();
 168
 169   // If we don't have any input files, read from stdin.
 170   if (!InputFileList.size())
 171     InputFileList.push_back("-");
 172   for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
 173     // Instantiate a dynamic linker.
 174     TrivialMemoryManager MemMgr;
 175     RuntimeDyld Dyld(&MemMgr);
 176
 177     // Load the input memory buffer.
 178     std::unique_ptr<MemoryBuffer> InputBuffer;
 179     std::unique_ptr<ObjectImage> LoadedObject;
 180     if (std::error_code ec =
 181             MemoryBuffer::getFileOrSTDIN(InputFileList[i], InputBuffer))
 182       return Error("unable to read input: '" + ec.message() + "'");
 183
 184     // Load the object file
 185     LoadedObject.reset(Dyld.loadObject(new ObjectBuffer(InputBuffer.release())));
 186     if (!LoadedObject) {
 187       return Error(Dyld.getErrorString());
 188     }
 189
 190     // Resolve all the relocations we can.
 191     Dyld.resolveRelocations();
 192
 193     std::unique_ptr<DIContext> Context(
 194         DIContext::getDWARFContext(LoadedObject->getObjectFile()));
 195
 196     // Use symbol info to iterate functions in the object.
 197     for (object::symbol_iterator I = LoadedObject->begin_symbols(),
 198                                  E = LoadedObject->end_symbols();
 199          I != E; ++I) {
 200       object::SymbolRef::Type SymType;
 201       if (I->getType(SymType)) continue;
 202       if (SymType == object::SymbolRef::ST_Function) {
 203         StringRef  Name;
 204         uint64_t   Addr;
 205         uint64_t   Size;
 206         if (I->getName(Name)) continue;
 207         if (I->getAddress(Addr)) continue;
 208         if (I->getSize(Size)) continue;
 209
 210         outs() << "Function: " << Name << ", Size = " << Size << "\n";
 211
 212         DILineInfoTable Lines = Context->getLineInfoForAddressRange(Addr, Size);
 213         DILineInfoTable::iterator  Begin = Lines.begin();
 214         DILineInfoTable::iterator  End = Lines.end();
 215         for (DILineInfoTable::iterator It = Begin; It != End; ++It) {
 216           outs() << "  Line info @ " << It->first - Addr << ": "
 217                  << It->second.FileName << ", line:" << It->second.Line << "\n";
 218         }
 219       }
 220     }
 221   }
 222
 223   return 0;
 224 }
 225
 226 static int executeInput() {
 227   // Load any dylibs requested on the command line.
 228   loadDylibs();
 229
 230   // Instantiate a dynamic linker.
 231   TrivialMemoryManager MemMgr;
 232   RuntimeDyld Dyld(&MemMgr);
 233
 234   // If we don't have any input files, read from stdin.
 235   if (!InputFileList.size())
 236     InputFileList.push_back("-");
 237   for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
 238     // Load the input memory buffer.
 239     std::unique_ptr<MemoryBuffer> InputBuffer;
 240     std::unique_ptr<ObjectImage> LoadedObject;
 241     if (std::error_code ec =
 242             MemoryBuffer::getFileOrSTDIN(InputFileList[i], InputBuffer))
 243       return Error("unable to read input: '" + ec.message() + "'");
 244
 245     // Load the object file
 246     LoadedObject.reset(Dyld.loadObject(new ObjectBuffer(InputBuffer.release())));
 247     if (!LoadedObject) {
 248       return Error(Dyld.getErrorString());
 249     }
 250   }
 251
 252   // Resolve all the relocations we can.
 253   Dyld.resolveRelocations();
 254   // Clear instruction cache before code will be executed.
 255   MemMgr.invalidateInstructionCache();
 256
 257   // FIXME: Error out if there are unresolved relocations.
 258
 259   // Get the address of the entry point (_main by default).
 260   void *MainAddress = Dyld.getSymbolAddress(EntryPoint);
 261   if (!MainAddress)
 262     return Error("no definition for '" + EntryPoint + "'");
 263
 264   // Invalidate the instruction cache for each loaded function.
 265   for (unsigned i = 0, e = MemMgr.FunctionMemory.size(); i != e; ++i) {
 266     sys::MemoryBlock &Data = MemMgr.FunctionMemory[i];
 267     // Make sure the memory is executable.
 268     std::string ErrorStr;
 269     sys::Memory::InvalidateInstructionCache(Data.base(), Data.size());
 270     if (!sys::Memory::setExecutable(Data, &ErrorStr))
 271       return Error("unable to mark function executable: '" + ErrorStr + "'");
 272   }
 273
 274   // Dispatch to _main().
 275   errs() << "loaded '" << EntryPoint << "' at: " << (void*)MainAddress << "\n";
 276
 277   int (*Main)(int, const char**) =
 278     (int(*)(int,const char**)) uintptr_t(MainAddress);
 279   const char **Argv = new const char*[2];
 280   // Use the name of the first input object module as argv[0] for the target.
 281   Argv[0] = InputFileList[0].c_str();
 282   Argv[1] = nullptr;
 283   return Main(1, Argv);
 284 }
 285
 286 static int checkAllExpressions(RuntimeDyldChecker &Checker) {
 287   for (const auto& CheckerFileName : CheckFiles) {
 288     std::unique_ptr<MemoryBuffer> CheckerFileBuf;
 289     if (std::error_code EC =
 290           MemoryBuffer::getFileOrSTDIN(CheckerFileName, CheckerFileBuf))
 291       return Error("unable to read input '" + CheckerFileName + "': " +
 292                    EC.message());
 293
 294     if (!Checker.checkAllRulesInBuffer("# rtdyld-check:", CheckerFileBuf.get()))
 295       return Error("some checks in '" + CheckerFileName + "' failed");
 296   }
 297   return 0;
 298 }
 299
 300 static int linkAndVerify() {
 301
 302   // Check for missing triple.
 303   if (TripleName == "") {
 304     llvm::errs() << "Error: -triple required when running in -verify mode.\n";
 305     return 1;
 306   }
 307
 308   // Look up the target and build the disassembler.
 309   Triple TheTriple(Triple::normalize(TripleName));
 310   std::string ErrorStr;
 311   const Target *TheTarget =
 312     TargetRegistry::lookupTarget("", TheTriple, ErrorStr);
 313   if (!TheTarget) {
 314     llvm::errs() << "Error accessing target '" << TripleName << "': "
 315                  << ErrorStr << "\n";
 316     return 1;
 317   }
 318   TripleName = TheTriple.getTriple();
 319
 320   std::unique_ptr<MCSubtargetInfo> STI(
 321     TheTarget->createMCSubtargetInfo(TripleName, "", ""));
 322   assert(STI && "Unable to create subtarget info!");
 323
 324   std::unique_ptr<MCRegisterInfo> MRI(TheTarget->createMCRegInfo(TripleName));
 325   assert(MRI && "Unable to create target register info!");
 326
 327   std::unique_ptr<MCAsmInfo> MAI(TheTarget->createMCAsmInfo(*MRI, TripleName));
 328   assert(MAI && "Unable to create target asm info!");
 329
 330   MCContext Ctx(MAI.get(), MRI.get(), nullptr);
 331
 332   std::unique_ptr<MCDisassembler> Disassembler(
 333     TheTarget->createMCDisassembler(*STI, Ctx));
 334   assert(Disassembler && "Unable to create disassembler!");
 335
 336   std::unique_ptr<MCInstrInfo> MII(TheTarget->createMCInstrInfo());
 337
 338   std::unique_ptr<MCInstPrinter> InstPrinter(
 339     TheTarget->createMCInstPrinter(0, *MAI, *MII, *MRI, *STI));
 340
 341   // Load any dylibs requested on the command line.
 342   loadDylibs();
 343
 344   // Instantiate a dynamic linker.
 345   TrivialMemoryManager MemMgr;
 346   RuntimeDyld Dyld(&MemMgr);
 347
 348   // If we don't have any input files, read from stdin.
 349   if (!InputFileList.size())
 350     InputFileList.push_back("-");
 351   for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
 352     // Load the input memory buffer.
 353     std::unique_ptr<MemoryBuffer> InputBuffer;
 354     std::unique_ptr<ObjectImage> LoadedObject;
 355     if (std::error_code ec =
 356             MemoryBuffer::getFileOrSTDIN(InputFileList[i], InputBuffer))
 357       return Error("unable to read input: '" + ec.message() + "'");
 358
 359     // Load the object file
 360     LoadedObject.reset(
 361       Dyld.loadObject(new ObjectBuffer(InputBuffer.release())));
 362     if (!LoadedObject) {
 363       return Error(Dyld.getErrorString());
 364     }
 365   }
 366
 367   // Resolve all the relocations we can.
 368   Dyld.resolveRelocations();
 369
 370   RuntimeDyldChecker Checker(Dyld, Disassembler.get(), InstPrinter.get(),
 371                              llvm::dbgs());
 372   return checkAllExpressions(Checker);
 373 }
 374
 375 int main(int argc, char **argv) {
 376   sys::PrintStackTraceOnErrorSignal();
 377   PrettyStackTraceProgram X(argc, argv);
 378
 379   ProgramName = argv[0];
 380   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
 381
 382   llvm::InitializeAllTargetInfos();
 383   llvm::InitializeAllTargetMCs();
 384   llvm::InitializeAllDisassemblers();
 385
 386   cl::ParseCommandLineOptions(argc, argv, "llvm MC-JIT tool\n");
 387
 388   switch (Action) {
 389   case AC_Execute:
 390     return executeInput();
 391   case AC_PrintLineInfo:
 392     return printLineInfoForInput();
 393   case AC_Verify:
 394     return linkAndVerify();
 395   }
 396 }