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/OwningPtr.h"
15 #include "llvm/ADT/StringMap.h"
16 #include "llvm/ExecutionEngine/ObjectBuffer.h"
17 #include "llvm/ExecutionEngine/ObjectImage.h"
18 #include "llvm/ExecutionEngine/RuntimeDyld.h"
19 #include "llvm/Object/MachOObject.h"
20 #include "llvm/Support/CommandLine.h"
21 #include "llvm/Support/ManagedStatic.h"
22 #include "llvm/Support/Memory.h"
23 #include "llvm/Support/MemoryBuffer.h"
24 #include "llvm/Support/raw_ostream.h"
25 #include "llvm/Support/system_error.h"
27 using namespace llvm::object;
29 static cl::list<std::string>
30 InputFileList(cl::Positional, cl::ZeroOrMore,
31 cl::desc("<input file>"));
37 static cl::opt<ActionType>
38 Action(cl::desc("Action to perform:"),
40 cl::values(clEnumValN(AC_Execute, "execute",
41 "Load, link, and execute the inputs."),
44 static cl::opt<std::string>
46 cl::desc("Function to call as entry point."),
51 // A trivial memory manager that doesn't do anything fancy, just uses the
52 // support library allocation routines directly.
53 class TrivialMemoryManager : public RTDyldMemoryManager {
55 SmallVector<sys::MemoryBlock, 16> FunctionMemory;
56 SmallVector<sys::MemoryBlock, 16> DataMemory;
58 uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
60 uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
61 unsigned SectionID, bool IsReadOnly);
63 virtual void *getPointerToNamedFunction(const std::string &Name,
64 bool AbortOnFailure = true) {
68 bool applyPermissions(std::string *ErrMsg) { return false; }
70 // Invalidate instruction cache for sections with execute permissions.
71 // Some platforms with separate data cache and instruction cache require
72 // explicit cache flush, otherwise JIT code manipulations (like resolved
73 // relocations) will get to the data cache but not to the instruction cache.
74 virtual void invalidateInstructionCache();
77 uint8_t *TrivialMemoryManager::allocateCodeSection(uintptr_t Size,
80 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, 0, 0);
81 FunctionMemory.push_back(MB);
82 return (uint8_t*)MB.base();
85 uint8_t *TrivialMemoryManager::allocateDataSection(uintptr_t Size,
89 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, 0, 0);
90 DataMemory.push_back(MB);
91 return (uint8_t*)MB.base();
94 void TrivialMemoryManager::invalidateInstructionCache() {
95 for (int i = 0, e = FunctionMemory.size(); i != e; ++i)
96 sys::Memory::InvalidateInstructionCache(FunctionMemory[i].base(),
97 FunctionMemory[i].size());
99 for (int i = 0, e = DataMemory.size(); i != e; ++i)
100 sys::Memory::InvalidateInstructionCache(DataMemory[i].base(),
101 DataMemory[i].size());
104 static const char *ProgramName;
106 static void Message(const char *Type, const Twine &Msg) {
107 errs() << ProgramName << ": " << Type << ": " << Msg << "\n";
110 static int Error(const Twine &Msg) {
111 Message("error", Msg);
117 static int executeInput() {
118 // Instantiate a dynamic linker.
119 TrivialMemoryManager *MemMgr = new TrivialMemoryManager;
120 RuntimeDyld Dyld(MemMgr);
122 // If we don't have any input files, read from stdin.
123 if (!InputFileList.size())
124 InputFileList.push_back("-");
125 for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
126 // Load the input memory buffer.
127 OwningPtr<MemoryBuffer> InputBuffer;
128 OwningPtr<ObjectImage> LoadedObject;
129 if (error_code ec = MemoryBuffer::getFileOrSTDIN(InputFileList[i],
131 return Error("unable to read input: '" + ec.message() + "'");
133 // Load the object file
134 LoadedObject.reset(Dyld.loadObject(new ObjectBuffer(InputBuffer.take())));
136 return Error(Dyld.getErrorString());
140 // Resolve all the relocations we can.
141 Dyld.resolveRelocations();
142 // Clear instruction cache before code will be executed.
143 MemMgr->invalidateInstructionCache();
145 // FIXME: Error out if there are unresolved relocations.
147 // Get the address of the entry point (_main by default).
148 void *MainAddress = Dyld.getSymbolAddress(EntryPoint);
149 if (MainAddress == 0)
150 return Error("no definition for '" + EntryPoint + "'");
152 // Invalidate the instruction cache for each loaded function.
153 for (unsigned i = 0, e = MemMgr->FunctionMemory.size(); i != e; ++i) {
154 sys::MemoryBlock &Data = MemMgr->FunctionMemory[i];
155 // Make sure the memory is executable.
156 std::string ErrorStr;
157 sys::Memory::InvalidateInstructionCache(Data.base(), Data.size());
158 if (!sys::Memory::setExecutable(Data, &ErrorStr))
159 return Error("unable to mark function executable: '" + ErrorStr + "'");
162 // Dispatch to _main().
163 errs() << "loaded '" << EntryPoint << "' at: " << (void*)MainAddress << "\n";
165 int (*Main)(int, const char**) =
166 (int(*)(int,const char**)) uintptr_t(MainAddress);
167 const char **Argv = new const char*[2];
168 // Use the name of the first input object module as argv[0] for the target.
169 Argv[0] = InputFileList[0].c_str();
171 return Main(1, Argv);
174 int main(int argc, char **argv) {
175 ProgramName = argv[0];
176 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
178 cl::ParseCommandLineOptions(argc, argv, "llvm MC-JIT tool\n");
182 return executeInput();