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/OwningPtr.h"
  15 #include "llvm/ADT/StringMap.h"
  16 #include "llvm/DebugInfo/DIContext.h"
  17 #include "llvm/ExecutionEngine/ObjectBuffer.h"
  18 #include "llvm/ExecutionEngine/ObjectImage.h"
  19 #include "llvm/ExecutionEngine/RuntimeDyld.h"
  20 #include "llvm/Object/MachO.h"
  21 #include "llvm/Support/CommandLine.h"
  22 #include "llvm/Support/ManagedStatic.h"
  23 #include "llvm/Support/Memory.h"
  24 #include "llvm/Support/MemoryBuffer.h"
  25 #include "llvm/Support/raw_ostream.h"
  26 #include "llvm/Support/system_error.h"
  27 using namespace llvm;
  28 using namespace llvm::object;
  29
  30 static cl::list<std::string>
  31 InputFileList(cl::Positional, cl::ZeroOrMore,
  32               cl::desc("<input file>"));
  33
  34 enum ActionType {
  35   AC_Execute,
  36   AC_PrintLineInfo
  37 };
  38
  39 static cl::opt<ActionType>
  40 Action(cl::desc("Action to perform:"),
  41        cl::init(AC_Execute),
  42        cl::values(clEnumValN(AC_Execute, "execute",
  43                              "Load, link, and execute the inputs."),
  44                   clEnumValN(AC_PrintLineInfo, "printline",
  45                              "Load, link, and print line information for each function."),
  46                   clEnumValEnd));
  47
  48 static cl::opt<std::string>
  49 EntryPoint("entry",
  50            cl::desc("Function to call as entry point."),
  51            cl::init("_main"));
  52
  53 /* *** */
  54
  55 // A trivial memory manager that doesn't do anything fancy, just uses the
  56 // support library allocation routines directly.
  57 class TrivialMemoryManager : public RTDyldMemoryManager {
  58 public:
  59   SmallVector<sys::MemoryBlock, 16> FunctionMemory;
  60   SmallVector<sys::MemoryBlock, 16> DataMemory;
  61
  62   uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
  63                                unsigned SectionID, StringRef SectionName);
  64   uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
  65                                unsigned SectionID, StringRef SectionName,
  66                                bool IsReadOnly);
  67
  68   virtual void *getPointerToNamedFunction(const std::string &Name,
  69                                           bool AbortOnFailure = true) {
  70     return 0;
  71   }
  72
  73   bool finalizeMemory(std::string *ErrMsg) { return false; }
  74
  75   // Invalidate instruction cache for sections with execute permissions.
  76   // Some platforms with separate data cache and instruction cache require
  77   // explicit cache flush, otherwise JIT code manipulations (like resolved
  78   // relocations) will get to the data cache but not to the instruction cache.
  79   virtual void invalidateInstructionCache();
  80 };
  81
  82 uint8_t *TrivialMemoryManager::allocateCodeSection(uintptr_t Size,
  83                                                    unsigned Alignment,
  84                                                    unsigned SectionID,
  85                                                    StringRef SectionName) {
  86   sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, 0, 0);
  87   FunctionMemory.push_back(MB);
  88   return (uint8_t*)MB.base();
  89 }
  90
  91 uint8_t *TrivialMemoryManager::allocateDataSection(uintptr_t Size,
  92                                                    unsigned Alignment,
  93                                                    unsigned SectionID,
  94                                                    StringRef SectionName,
  95                                                    bool IsReadOnly) {
  96   sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, 0, 0);
  97   DataMemory.push_back(MB);
  98   return (uint8_t*)MB.base();
  99 }
 100
 101 void TrivialMemoryManager::invalidateInstructionCache() {
 102   for (int i = 0, e = FunctionMemory.size(); i != e; ++i)
 103     sys::Memory::InvalidateInstructionCache(FunctionMemory[i].base(),
 104                                             FunctionMemory[i].size());
 105
 106   for (int i = 0, e = DataMemory.size(); i != e; ++i)
 107     sys::Memory::InvalidateInstructionCache(DataMemory[i].base(),
 108                                             DataMemory[i].size());
 109 }
 110
 111 static const char *ProgramName;
 112
 113 static void Message(const char *Type, const Twine &Msg) {
 114   errs() << ProgramName << ": " << Type << ": " << Msg << "\n";
 115 }
 116
 117 static int Error(const Twine &Msg) {
 118   Message("error", Msg);
 119   return 1;
 120 }
 121
 122 /* *** */
 123
 124 static int printLineInfoForInput() {
 125   // If we don't have any input files, read from stdin.
 126   if (!InputFileList.size())
 127     InputFileList.push_back("-");
 128   for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
 129     // Instantiate a dynamic linker.
 130     TrivialMemoryManager MemMgr;
 131     RuntimeDyld Dyld(&MemMgr);
 132
 133     // Load the input memory buffer.
 134     OwningPtr<MemoryBuffer> InputBuffer;
 135     OwningPtr<ObjectImage>  LoadedObject;
 136     if (error_code ec = MemoryBuffer::getFileOrSTDIN(InputFileList[i],
 137                                                      InputBuffer))
 138       return Error("unable to read input: '" + ec.message() + "'");
 139
 140     // Load the object file
 141     LoadedObject.reset(Dyld.loadObject(new ObjectBuffer(InputBuffer.take())));
 142     if (!LoadedObject) {
 143       return Error(Dyld.getErrorString());
 144     }
 145
 146     // Resolve all the relocations we can.
 147     Dyld.resolveRelocations();
 148
 149     OwningPtr<DIContext> Context(DIContext::getDWARFContext(LoadedObject->getObjectFile()));
 150
 151     // Use symbol info to iterate functions in the object.
 152     error_code ec;
 153     for (object::symbol_iterator I = LoadedObject->begin_symbols(),
 154                                  E = LoadedObject->end_symbols();
 155                           I != E && !ec;
 156                           I.increment(ec)) {
 157       object::SymbolRef::Type SymType;
 158       if (I->getType(SymType)) continue;
 159       if (SymType == object::SymbolRef::ST_Function) {
 160         StringRef  Name;
 161         uint64_t   Addr;
 162         uint64_t   Size;
 163         if (I->getName(Name)) continue;
 164         if (I->getAddress(Addr)) continue;
 165         if (I->getSize(Size)) continue;
 166
 167         outs() << "Function: " << Name << ", Size = " << Size << "\n";
 168
 169         DILineInfoTable Lines = Context->getLineInfoForAddressRange(Addr, Size);
 170         DILineInfoTable::iterator  Begin = Lines.begin();
 171         DILineInfoTable::iterator  End = Lines.end();
 172         for (DILineInfoTable::iterator It = Begin; It != End; ++It) {
 173           outs() << "  Line info @ " << It->first - Addr << ": "
 174                  << It->second.getFileName()
 175                  << ", line:" << It->second.getLine() << "\n";
 176         }
 177       }
 178     }
 179   }
 180
 181   return 0;
 182 }
 183
 184 static int executeInput() {
 185   // Instantiate a dynamic linker.
 186   TrivialMemoryManager MemMgr;
 187   RuntimeDyld Dyld(&MemMgr);
 188
 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     // Load the input memory buffer.
 194     OwningPtr<MemoryBuffer> InputBuffer;
 195     OwningPtr<ObjectImage>  LoadedObject;
 196     if (error_code ec = MemoryBuffer::getFileOrSTDIN(InputFileList[i],
 197                                                      InputBuffer))
 198       return Error("unable to read input: '" + ec.message() + "'");
 199
 200     // Load the object file
 201     LoadedObject.reset(Dyld.loadObject(new ObjectBuffer(InputBuffer.take())));
 202     if (!LoadedObject) {
 203       return Error(Dyld.getErrorString());
 204     }
 205   }
 206
 207   // Resolve all the relocations we can.
 208   Dyld.resolveRelocations();
 209   // Clear instruction cache before code will be executed.
 210   MemMgr.invalidateInstructionCache();
 211
 212   // FIXME: Error out if there are unresolved relocations.
 213
 214   // Get the address of the entry point (_main by default).
 215   void *MainAddress = Dyld.getSymbolAddress(EntryPoint);
 216   if (MainAddress == 0)
 217     return Error("no definition for '" + EntryPoint + "'");
 218
 219   // Invalidate the instruction cache for each loaded function.
 220   for (unsigned i = 0, e = MemMgr.FunctionMemory.size(); i != e; ++i) {
 221     sys::MemoryBlock &Data = MemMgr.FunctionMemory[i];
 222     // Make sure the memory is executable.
 223     std::string ErrorStr;
 224     sys::Memory::InvalidateInstructionCache(Data.base(), Data.size());
 225     if (!sys::Memory::setExecutable(Data, &ErrorStr))
 226       return Error("unable to mark function executable: '" + ErrorStr + "'");
 227   }
 228
 229   // Dispatch to _main().
 230   errs() << "loaded '" << EntryPoint << "' at: " << (void*)MainAddress << "\n";
 231
 232   int (*Main)(int, const char**) =
 233     (int(*)(int,const char**)) uintptr_t(MainAddress);
 234   const char **Argv = new const char*[2];
 235   // Use the name of the first input object module as argv[0] for the target.
 236   Argv[0] = InputFileList[0].c_str();
 237   Argv[1] = 0;
 238   return Main(1, Argv);
 239 }
 240
 241 int main(int argc, char **argv) {
 242   ProgramName = argv[0];
 243   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
 244
 245   cl::ParseCommandLineOptions(argc, argv, "llvm MC-JIT tool\n");
 246
 247   switch (Action) {
 248   case AC_Execute:
 249     return executeInput();
 250   case AC_PrintLineInfo:
 251     return printLineInfoForInput();
 252   }
 253 }