blob: 03c08568caaf7550607bc7cef75d77d3c1c58a55 [file] [log] [blame]
Jim Grosbach0072cdb2011-03-18 17:11:39 +00001//===-- 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
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000014#include "llvm/ADT/StringMap.h"
Zachary Turner6489d7b2015-04-23 17:37:47 +000015#include "llvm/DebugInfo/DIContext.h"
16#include "llvm/DebugInfo/DWARF/DWARFContext.h"
Lang Hames633fe142015-03-30 03:37:06 +000017#include "llvm/ExecutionEngine/RTDyldMemoryManager.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000018#include "llvm/ExecutionEngine/RuntimeDyld.h"
Lang Hamese1c11382014-06-27 20:20:57 +000019#include "llvm/ExecutionEngine/RuntimeDyldChecker.h"
20#include "llvm/MC/MCAsmInfo.h"
21#include "llvm/MC/MCContext.h"
22#include "llvm/MC/MCDisassembler.h"
Lang Hamese1c11382014-06-27 20:20:57 +000023#include "llvm/MC/MCInstPrinter.h"
Chandler Carruthd9903882015-01-14 11:23:27 +000024#include "llvm/MC/MCInstrInfo.h"
Lang Hamese1c11382014-06-27 20:20:57 +000025#include "llvm/MC/MCRegisterInfo.h"
Pete Cooper3de83e42015-05-15 21:58:42 +000026#include "llvm/MC/MCSubtargetInfo.h"
Rafael Espindola6e040c02013-04-26 20:07:33 +000027#include "llvm/Object/MachO.h"
Rafael Espindolab109c032015-06-23 02:08:48 +000028#include "llvm/Object/SymbolSize.h"
Jim Grosbach0072cdb2011-03-18 17:11:39 +000029#include "llvm/Support/CommandLine.h"
Lang Hamesd311c0e2014-05-13 22:37:41 +000030#include "llvm/Support/DynamicLibrary.h"
Jim Grosbach0072cdb2011-03-18 17:11:39 +000031#include "llvm/Support/ManagedStatic.h"
32#include "llvm/Support/Memory.h"
33#include "llvm/Support/MemoryBuffer.h"
Alp Toker9f679322013-11-05 09:33:43 +000034#include "llvm/Support/PrettyStackTrace.h"
Lang Hamese1c11382014-06-27 20:20:57 +000035#include "llvm/Support/Signals.h"
36#include "llvm/Support/TargetRegistry.h"
37#include "llvm/Support/TargetSelect.h"
Chandler Carruthd9903882015-01-14 11:23:27 +000038#include "llvm/Support/raw_ostream.h"
Lang Hames778ef5b2014-09-04 04:19:54 +000039#include <list>
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000040#include <system_error>
Lang Hamese1c11382014-06-27 20:20:57 +000041
Jim Grosbach0072cdb2011-03-18 17:11:39 +000042using namespace llvm;
43using namespace llvm::object;
44
Jim Grosbach7cb41d72011-04-13 15:49:40 +000045static cl::list<std::string>
46InputFileList(cl::Positional, cl::ZeroOrMore,
47 cl::desc("<input file>"));
Jim Grosbach0072cdb2011-03-18 17:11:39 +000048
49enum ActionType {
Andrew Kaylord55d7012013-01-25 22:50:58 +000050 AC_Execute,
Keno Fischer281b6942015-05-30 19:44:53 +000051 AC_PrintObjectLineInfo,
Lang Hamese1c11382014-06-27 20:20:57 +000052 AC_PrintLineInfo,
Keno Fischerc780e8e2015-05-21 21:24:32 +000053 AC_PrintDebugLineInfo,
Lang Hamese1c11382014-06-27 20:20:57 +000054 AC_Verify
Jim Grosbach0072cdb2011-03-18 17:11:39 +000055};
56
57static cl::opt<ActionType>
58Action(cl::desc("Action to perform:"),
59 cl::init(AC_Execute),
60 cl::values(clEnumValN(AC_Execute, "execute",
61 "Load, link, and execute the inputs."),
Andrew Kaylord55d7012013-01-25 22:50:58 +000062 clEnumValN(AC_PrintLineInfo, "printline",
63 "Load, link, and print line information for each function."),
Keno Fischerc780e8e2015-05-21 21:24:32 +000064 clEnumValN(AC_PrintDebugLineInfo, "printdebugline",
65 "Load, link, and print line information for each function using the debug object"),
Keno Fischer281b6942015-05-30 19:44:53 +000066 clEnumValN(AC_PrintObjectLineInfo, "printobjline",
67 "Like -printlineinfo but does not load the object first"),
Lang Hamese1c11382014-06-27 20:20:57 +000068 clEnumValN(AC_Verify, "verify",
69 "Load, link and verify the resulting memory image."),
Jim Grosbach0072cdb2011-03-18 17:11:39 +000070 clEnumValEnd));
71
Jim Grosbachd35159a2011-04-13 15:38:30 +000072static cl::opt<std::string>
73EntryPoint("entry",
74 cl::desc("Function to call as entry point."),
75 cl::init("_main"));
76
Lang Hamesd311c0e2014-05-13 22:37:41 +000077static cl::list<std::string>
78Dylibs("dylib",
79 cl::desc("Add library."),
80 cl::ZeroOrMore);
81
Lang Hamese1c11382014-06-27 20:20:57 +000082static cl::opt<std::string>
83TripleName("triple", cl::desc("Target triple for disassembler"));
84
Petar Jovanovic280e5622015-06-23 22:52:19 +000085static cl::opt<std::string>
86MCPU("mcpu",
87 cl::desc("Target a specific cpu type (-mcpu=help for details)"),
88 cl::value_desc("cpu-name"),
89 cl::init(""));
90
Lang Hamese1c11382014-06-27 20:20:57 +000091static cl::list<std::string>
92CheckFiles("check",
93 cl::desc("File containing RuntimeDyld verifier checks."),
94 cl::ZeroOrMore);
95
Lang Hames9cb73532014-07-29 23:43:13 +000096static cl::opt<uint64_t>
97TargetAddrStart("target-addr-start",
98 cl::desc("For -verify only: start of phony target address "
99 "range."),
100 cl::init(4096), // Start at "page 1" - no allocating at "null".
101 cl::Hidden);
102
103static cl::opt<uint64_t>
104TargetAddrEnd("target-addr-end",
105 cl::desc("For -verify only: end of phony target address range."),
106 cl::init(~0ULL),
107 cl::Hidden);
108
109static cl::opt<uint64_t>
110TargetSectionSep("target-section-sep",
111 cl::desc("For -verify only: Separation between sections in "
112 "phony target address space."),
113 cl::init(0),
114 cl::Hidden);
115
Lang Hames778ef5b2014-09-04 04:19:54 +0000116static cl::list<std::string>
117SpecificSectionMappings("map-section",
Lang Hames78937c22015-07-04 01:35:26 +0000118 cl::desc("For -verify only: Map a section to a "
119 "specific address."),
120 cl::ZeroOrMore,
121 cl::Hidden);
122
123static cl::list<std::string>
124DummySymbolMappings("dummy-extern",
125 cl::desc("For -verify only: Inject a symbol into the extern "
126 "symbol table."),
127 cl::ZeroOrMore,
128 cl::Hidden);
Lang Hames778ef5b2014-09-04 04:19:54 +0000129
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000130/* *** */
131
Jim Grosbach2dcef0502011-04-04 23:04:39 +0000132// A trivial memory manager that doesn't do anything fancy, just uses the
133// support library allocation routines directly.
134class TrivialMemoryManager : public RTDyldMemoryManager {
135public:
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000136 SmallVector<sys::MemoryBlock, 16> FunctionMemory;
Jim Grosbacheff0a402012-01-16 22:26:39 +0000137 SmallVector<sys::MemoryBlock, 16> DataMemory;
138
139 uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
Craig Toppere56917c2014-03-08 08:27:28 +0000140 unsigned SectionID,
141 StringRef SectionName) override;
Jim Grosbacheff0a402012-01-16 22:26:39 +0000142 uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
Filip Pizlo7aa695e02013-10-02 00:59:25 +0000143 unsigned SectionID, StringRef SectionName,
Craig Toppere56917c2014-03-08 08:27:28 +0000144 bool IsReadOnly) override;
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000145
Craig Toppere56917c2014-03-08 08:27:28 +0000146 void *getPointerToNamedFunction(const std::string &Name,
147 bool AbortOnFailure = true) override {
Craig Toppere6cb63e2014-04-25 04:24:47 +0000148 return nullptr;
Danil Malyshevbfee5422012-03-28 21:46:36 +0000149 }
150
Craig Toppere56917c2014-03-08 08:27:28 +0000151 bool finalizeMemory(std::string *ErrMsg) override { return false; }
Andrew Kaylora342cb92012-11-15 23:50:01 +0000152
Danil Malyshev8c17fbd2012-05-16 18:50:11 +0000153 // Invalidate instruction cache for sections with execute permissions.
154 // Some platforms with separate data cache and instruction cache require
155 // explicit cache flush, otherwise JIT code manipulations (like resolved
156 // relocations) will get to the data cache but not to the instruction cache.
157 virtual void invalidateInstructionCache();
Tim Northover5af339a2015-06-03 18:26:52 +0000158
Lang Hames78937c22015-07-04 01:35:26 +0000159 void addDummySymbol(const std::string &Name, uint64_t Addr) {
160 DummyExterns[Name] = Addr;
161 }
162
163 RuntimeDyld::SymbolInfo findSymbol(const std::string &Name) override {
164 auto I = DummyExterns.find(Name);
165
166 if (I != DummyExterns.end())
167 return RuntimeDyld::SymbolInfo(I->second, JITSymbolFlags::Exported);
168
169 return RTDyldMemoryManager::findSymbol(Name);
170 }
171
Tim Northover5af339a2015-06-03 18:26:52 +0000172 void registerEHFrames(uint8_t *Addr, uint64_t LoadAddr,
173 size_t Size) override {}
174 void deregisterEHFrames(uint8_t *Addr, uint64_t LoadAddr,
175 size_t Size) override {}
Lang Hames78937c22015-07-04 01:35:26 +0000176private:
177 std::map<std::string, uint64_t> DummyExterns;
Jim Grosbach2dcef0502011-04-04 23:04:39 +0000178};
179
Jim Grosbacheff0a402012-01-16 22:26:39 +0000180uint8_t *TrivialMemoryManager::allocateCodeSection(uintptr_t Size,
181 unsigned Alignment,
Filip Pizlo7aa695e02013-10-02 00:59:25 +0000182 unsigned SectionID,
183 StringRef SectionName) {
Craig Toppere6cb63e2014-04-25 04:24:47 +0000184 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, nullptr);
Danil Malyshev8c17fbd2012-05-16 18:50:11 +0000185 FunctionMemory.push_back(MB);
186 return (uint8_t*)MB.base();
Jim Grosbacheff0a402012-01-16 22:26:39 +0000187}
188
189uint8_t *TrivialMemoryManager::allocateDataSection(uintptr_t Size,
190 unsigned Alignment,
Andrew Kaylora342cb92012-11-15 23:50:01 +0000191 unsigned SectionID,
Filip Pizlo7aa695e02013-10-02 00:59:25 +0000192 StringRef SectionName,
Andrew Kaylora342cb92012-11-15 23:50:01 +0000193 bool IsReadOnly) {
Craig Toppere6cb63e2014-04-25 04:24:47 +0000194 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, nullptr);
Danil Malyshev8c17fbd2012-05-16 18:50:11 +0000195 DataMemory.push_back(MB);
196 return (uint8_t*)MB.base();
197}
198
199void TrivialMemoryManager::invalidateInstructionCache() {
200 for (int i = 0, e = FunctionMemory.size(); i != e; ++i)
201 sys::Memory::InvalidateInstructionCache(FunctionMemory[i].base(),
202 FunctionMemory[i].size());
203
204 for (int i = 0, e = DataMemory.size(); i != e; ++i)
205 sys::Memory::InvalidateInstructionCache(DataMemory[i].base(),
206 DataMemory[i].size());
Jim Grosbacheff0a402012-01-16 22:26:39 +0000207}
208
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000209static const char *ProgramName;
210
211static void Message(const char *Type, const Twine &Msg) {
212 errs() << ProgramName << ": " << Type << ": " << Msg << "\n";
213}
214
215static int Error(const Twine &Msg) {
216 Message("error", Msg);
217 return 1;
218}
219
Lang Hamesd311c0e2014-05-13 22:37:41 +0000220static void loadDylibs() {
221 for (const std::string &Dylib : Dylibs) {
222 if (sys::fs::is_regular_file(Dylib)) {
223 std::string ErrMsg;
224 if (sys::DynamicLibrary::LoadLibraryPermanently(Dylib.c_str(), &ErrMsg))
225 llvm::errs() << "Error loading '" << Dylib << "': "
226 << ErrMsg << "\n";
227 } else
228 llvm::errs() << "Dylib not found: '" << Dylib << "'.\n";
229 }
230}
231
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000232/* *** */
233
Keno Fischerc780e8e2015-05-21 21:24:32 +0000234static int printLineInfoForInput(bool LoadObjects, bool UseDebugObj) {
235 assert(LoadObjects || !UseDebugObj);
236
Lang Hamesd311c0e2014-05-13 22:37:41 +0000237 // Load any dylibs requested on the command line.
238 loadDylibs();
239
Andrew Kaylord55d7012013-01-25 22:50:58 +0000240 // If we don't have any input files, read from stdin.
241 if (!InputFileList.size())
242 InputFileList.push_back("-");
243 for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
244 // Instantiate a dynamic linker.
Benjamin Kramer9ce77082013-08-03 22:16:31 +0000245 TrivialMemoryManager MemMgr;
Lang Hames633fe142015-03-30 03:37:06 +0000246 RuntimeDyld Dyld(MemMgr, MemMgr);
Andrew Kaylord55d7012013-01-25 22:50:58 +0000247
248 // Load the input memory buffer.
Andrew Kaylord55d7012013-01-25 22:50:58 +0000249
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000250 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
251 MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
252 if (std::error_code EC = InputBuffer.getError())
253 return Error("unable to read input: '" + EC.message() + "'");
254
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000255 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
256 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
257
258 if (std::error_code EC = MaybeObj.getError())
259 return Error("unable to create object file: '" + EC.message() + "'");
260
261 ObjectFile &Obj = **MaybeObj;
262
Keno Fischerc780e8e2015-05-21 21:24:32 +0000263 OwningBinary<ObjectFile> DebugObj;
264 std::unique_ptr<RuntimeDyld::LoadedObjectInfo> LoadedObjInfo = nullptr;
265 ObjectFile *SymbolObj = &Obj;
266 if (LoadObjects) {
267 // Load the object file
268 LoadedObjInfo =
269 Dyld.loadObject(Obj);
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000270
Keno Fischerc780e8e2015-05-21 21:24:32 +0000271 if (Dyld.hasError())
272 return Error(Dyld.getErrorString());
Andrew Kaylord55d7012013-01-25 22:50:58 +0000273
Keno Fischerc780e8e2015-05-21 21:24:32 +0000274 // Resolve all the relocations we can.
275 Dyld.resolveRelocations();
Andrew Kaylord55d7012013-01-25 22:50:58 +0000276
Keno Fischerc780e8e2015-05-21 21:24:32 +0000277 if (UseDebugObj) {
278 DebugObj = LoadedObjInfo->getObjectForDebug(Obj);
279 SymbolObj = DebugObj.getBinary();
Lang Hames5c969332015-07-28 20:51:53 +0000280 LoadedObjInfo.reset();
Keno Fischerc780e8e2015-05-21 21:24:32 +0000281 }
282 }
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000283
Ahmed Charles56440fd2014-03-06 05:51:42 +0000284 std::unique_ptr<DIContext> Context(
Keno Fischerc780e8e2015-05-21 21:24:32 +0000285 new DWARFContextInMemory(*SymbolObj,LoadedObjInfo.get()));
Andrew Kaylord55d7012013-01-25 22:50:58 +0000286
Rafael Espindola6bf32212015-06-24 19:57:32 +0000287 std::vector<std::pair<SymbolRef, uint64_t>> SymAddr =
Rafael Espindolab109c032015-06-23 02:08:48 +0000288 object::computeSymbolSizes(*SymbolObj);
Rafael Espindolaa82ce1d2015-05-31 23:15:35 +0000289
Andrew Kaylord55d7012013-01-25 22:50:58 +0000290 // Use symbol info to iterate functions in the object.
Rafael Espindola6bf32212015-06-24 19:57:32 +0000291 for (const auto &P : SymAddr) {
Rafael Espindolab109c032015-06-23 02:08:48 +0000292 object::SymbolRef Sym = P.first;
Rafael Espindola2fa80cc2015-06-26 12:18:49 +0000293 if (Sym.getType() == object::SymbolRef::ST_Function) {
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000294 ErrorOr<StringRef> Name = Sym.getName();
295 if (!Name)
Rafael Espindolada176272015-05-31 22:13:51 +0000296 continue;
Rafael Espindolaed067c42015-07-03 18:19:00 +0000297 ErrorOr<uint64_t> AddrOrErr = Sym.getAddress();
298 if (!AddrOrErr)
Rafael Espindolada176272015-05-31 22:13:51 +0000299 continue;
Rafael Espindolaed067c42015-07-03 18:19:00 +0000300 uint64_t Addr = *AddrOrErr;
Rafael Espindolaa82ce1d2015-05-31 23:15:35 +0000301
Rafael Espindolab109c032015-06-23 02:08:48 +0000302 uint64_t Size = P.second;
Keno Fischerc780e8e2015-05-21 21:24:32 +0000303 // If we're not using the debug object, compute the address of the
304 // symbol in memory (rather than that in the unrelocated object file)
305 // and use that to query the DWARFContext.
306 if (!UseDebugObj && LoadObjects) {
Rafael Espindola8bab8892015-08-07 23:27:14 +0000307 object::section_iterator Sec = *Sym.getSection();
Keno Fischerc780e8e2015-05-21 21:24:32 +0000308 StringRef SecName;
309 Sec->getName(SecName);
310 uint64_t SectionLoadAddress =
Lang Hames2e88f4f2015-07-28 17:52:11 +0000311 LoadedObjInfo->getSectionLoadAddress(*Sec);
Keno Fischerc780e8e2015-05-21 21:24:32 +0000312 if (SectionLoadAddress != 0)
313 Addr += SectionLoadAddress - Sec->getAddress();
314 }
315
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000316 outs() << "Function: " << *Name << ", Size = " << Size
317 << ", Addr = " << Addr << "\n";
Andrew Kaylord55d7012013-01-25 22:50:58 +0000318
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000319 DILineInfoTable Lines = Context->getLineInfoForAddressRange(Addr, Size);
320 DILineInfoTable::iterator Begin = Lines.begin();
321 DILineInfoTable::iterator End = Lines.end();
322 for (DILineInfoTable::iterator It = Begin; It != End; ++It) {
323 outs() << " Line info @ " << It->first - Addr << ": "
Alexey Samsonovd0109992014-04-18 21:36:39 +0000324 << It->second.FileName << ", line:" << It->second.Line << "\n";
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000325 }
Andrew Kaylord55d7012013-01-25 22:50:58 +0000326 }
327 }
328 }
329
330 return 0;
331}
332
Jim Grosbach4d5284b2011-03-18 17:24:21 +0000333static int executeInput() {
Lang Hamesd311c0e2014-05-13 22:37:41 +0000334 // Load any dylibs requested on the command line.
335 loadDylibs();
336
Jim Grosbachf016b0a2011-03-21 22:15:52 +0000337 // Instantiate a dynamic linker.
Benjamin Kramer9ce77082013-08-03 22:16:31 +0000338 TrivialMemoryManager MemMgr;
Lang Hames633fe142015-03-30 03:37:06 +0000339 RuntimeDyld Dyld(MemMgr, MemMgr);
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000340
Lang Hamesc3246ad2015-04-15 21:18:41 +0000341 // FIXME: Preserve buffers until resolveRelocations time to work around a bug
342 // in RuntimeDyldELF.
343 // This fixme should be fixed ASAP. This is a very brittle workaround.
344 std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
345
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000346 // If we don't have any input files, read from stdin.
347 if (!InputFileList.size())
348 InputFileList.push_back("-");
349 for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
350 // Load the input memory buffer.
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000351 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
352 MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
353 if (std::error_code EC = InputBuffer.getError())
354 return Error("unable to read input: '" + EC.message() + "'");
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000355 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
356 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
357
358 if (std::error_code EC = MaybeObj.getError())
359 return Error("unable to create object file: '" + EC.message() + "'");
360
361 ObjectFile &Obj = **MaybeObj;
Lang Hamesc3246ad2015-04-15 21:18:41 +0000362 InputBuffers.push_back(std::move(*InputBuffer));
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000363
Andrew Kayloradc70562012-10-02 21:18:39 +0000364 // Load the object file
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000365 Dyld.loadObject(Obj);
366 if (Dyld.hasError()) {
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000367 return Error(Dyld.getErrorString());
368 }
Jim Grosbach40411cc2011-03-22 18:19:42 +0000369 }
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000370
Jim Grosbach733d3052011-04-12 21:20:41 +0000371 // Resolve all the relocations we can.
372 Dyld.resolveRelocations();
Danil Malyshev8c17fbd2012-05-16 18:50:11 +0000373 // Clear instruction cache before code will be executed.
Benjamin Kramer5d62ad22013-08-03 22:18:45 +0000374 MemMgr.invalidateInstructionCache();
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000375
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000376 // FIXME: Error out if there are unresolved relocations.
377
Jim Grosbachd35159a2011-04-13 15:38:30 +0000378 // Get the address of the entry point (_main by default).
Lang Hamesb1186032015-03-11 00:43:26 +0000379 void *MainAddress = Dyld.getSymbolLocalAddress(EntryPoint);
Craig Toppere6cb63e2014-04-25 04:24:47 +0000380 if (!MainAddress)
Jim Grosbachd35159a2011-04-13 15:38:30 +0000381 return Error("no definition for '" + EntryPoint + "'");
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000382
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000383 // Invalidate the instruction cache for each loaded function.
Benjamin Kramer5d62ad22013-08-03 22:18:45 +0000384 for (unsigned i = 0, e = MemMgr.FunctionMemory.size(); i != e; ++i) {
385 sys::MemoryBlock &Data = MemMgr.FunctionMemory[i];
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000386 // Make sure the memory is executable.
387 std::string ErrorStr;
388 sys::Memory::InvalidateInstructionCache(Data.base(), Data.size());
389 if (!sys::Memory::setExecutable(Data, &ErrorStr))
390 return Error("unable to mark function executable: '" + ErrorStr + "'");
391 }
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000392
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000393 // Dispatch to _main().
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000394 errs() << "loaded '" << EntryPoint << "' at: " << (void*)MainAddress << "\n";
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000395
396 int (*Main)(int, const char**) =
397 (int(*)(int,const char**)) uintptr_t(MainAddress);
398 const char **Argv = new const char*[2];
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000399 // Use the name of the first input object module as argv[0] for the target.
400 Argv[0] = InputFileList[0].c_str();
Craig Toppere6cb63e2014-04-25 04:24:47 +0000401 Argv[1] = nullptr;
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000402 return Main(1, Argv);
403}
404
Lang Hamese1c11382014-06-27 20:20:57 +0000405static int checkAllExpressions(RuntimeDyldChecker &Checker) {
406 for (const auto& CheckerFileName : CheckFiles) {
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000407 ErrorOr<std::unique_ptr<MemoryBuffer>> CheckerFileBuf =
408 MemoryBuffer::getFileOrSTDIN(CheckerFileName);
409 if (std::error_code EC = CheckerFileBuf.getError())
Lang Hamese1c11382014-06-27 20:20:57 +0000410 return Error("unable to read input '" + CheckerFileName + "': " +
411 EC.message());
412
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000413 if (!Checker.checkAllRulesInBuffer("# rtdyld-check:",
414 CheckerFileBuf.get().get()))
Lang Hamese1c11382014-06-27 20:20:57 +0000415 return Error("some checks in '" + CheckerFileName + "' failed");
416 }
417 return 0;
418}
419
Benjamin Kramerf044d3f2015-03-09 16:23:46 +0000420static std::map<void *, uint64_t>
Lang Hames778ef5b2014-09-04 04:19:54 +0000421applySpecificSectionMappings(RuntimeDyldChecker &Checker) {
422
423 std::map<void*, uint64_t> SpecificMappings;
424
425 for (StringRef Mapping : SpecificSectionMappings) {
426
427 size_t EqualsIdx = Mapping.find_first_of("=");
Lang Hames78937c22015-07-04 01:35:26 +0000428 std::string SectionIDStr = Mapping.substr(0, EqualsIdx);
Lang Hames778ef5b2014-09-04 04:19:54 +0000429 size_t ComaIdx = Mapping.find_first_of(",");
430
431 if (ComaIdx == StringRef::npos) {
432 errs() << "Invalid section specification '" << Mapping
433 << "'. Should be '<file name>,<section name>=<addr>'\n";
434 exit(1);
435 }
436
Lang Hames78937c22015-07-04 01:35:26 +0000437 std::string FileName = SectionIDStr.substr(0, ComaIdx);
438 std::string SectionName = SectionIDStr.substr(ComaIdx + 1);
Lang Hames778ef5b2014-09-04 04:19:54 +0000439
440 uint64_t OldAddrInt;
441 std::string ErrorMsg;
442 std::tie(OldAddrInt, ErrorMsg) =
443 Checker.getSectionAddr(FileName, SectionName, true);
444
445 if (ErrorMsg != "") {
446 errs() << ErrorMsg;
447 exit(1);
448 }
449
450 void* OldAddr = reinterpret_cast<void*>(static_cast<uintptr_t>(OldAddrInt));
451
Lang Hames78937c22015-07-04 01:35:26 +0000452 std::string NewAddrStr = Mapping.substr(EqualsIdx + 1);
Lang Hames778ef5b2014-09-04 04:19:54 +0000453 uint64_t NewAddr;
454
Lang Hames78937c22015-07-04 01:35:26 +0000455 if (StringRef(NewAddrStr).getAsInteger(0, NewAddr)) {
456 errs() << "Invalid section address in mapping '" << Mapping << "'.\n";
Lang Hames778ef5b2014-09-04 04:19:54 +0000457 exit(1);
458 }
459
460 Checker.getRTDyld().mapSectionAddress(OldAddr, NewAddr);
461 SpecificMappings[OldAddr] = NewAddr;
462 }
463
464 return SpecificMappings;
465}
466
Lang Hames9cb73532014-07-29 23:43:13 +0000467// Scatter sections in all directions!
468// Remaps section addresses for -verify mode. The following command line options
469// can be used to customize the layout of the memory within the phony target's
470// address space:
471// -target-addr-start <s> -- Specify where the phony target addres range starts.
472// -target-addr-end <e> -- Specify where the phony target address range ends.
473// -target-section-sep <d> -- Specify how big a gap should be left between the
474// end of one section and the start of the next.
475// Defaults to zero. Set to something big
476// (e.g. 1 << 32) to stress-test stubs, GOTs, etc.
477//
Lang Hames78937c22015-07-04 01:35:26 +0000478static void remapSectionsAndSymbols(const llvm::Triple &TargetTriple,
479 TrivialMemoryManager &MemMgr,
480 RuntimeDyldChecker &Checker) {
Lang Hames778ef5b2014-09-04 04:19:54 +0000481
482 // Set up a work list (section addr/size pairs).
483 typedef std::list<std::pair<void*, uint64_t>> WorklistT;
484 WorklistT Worklist;
485
486 for (const auto& CodeSection : MemMgr.FunctionMemory)
487 Worklist.push_back(std::make_pair(CodeSection.base(), CodeSection.size()));
488 for (const auto& DataSection : MemMgr.DataMemory)
489 Worklist.push_back(std::make_pair(DataSection.base(), DataSection.size()));
490
491 // Apply any section-specific mappings that were requested on the command
492 // line.
493 typedef std::map<void*, uint64_t> AppliedMappingsT;
494 AppliedMappingsT AppliedMappings = applySpecificSectionMappings(Checker);
495
496 // Keep an "already allocated" mapping of section target addresses to sizes.
497 // Sections whose address mappings aren't specified on the command line will
498 // allocated around the explicitly mapped sections while maintaining the
499 // minimum separation.
500 std::map<uint64_t, uint64_t> AlreadyAllocated;
501
502 // Move the previously applied mappings into the already-allocated map.
503 for (WorklistT::iterator I = Worklist.begin(), E = Worklist.end();
504 I != E;) {
505 WorklistT::iterator Tmp = I;
506 ++I;
507 AppliedMappingsT::iterator AI = AppliedMappings.find(Tmp->first);
508
509 if (AI != AppliedMappings.end()) {
510 AlreadyAllocated[AI->second] = Tmp->second;
511 Worklist.erase(Tmp);
512 }
513 }
Lang Hames9cb73532014-07-29 23:43:13 +0000514
515 // If the -target-addr-end option wasn't explicitly passed, then set it to a
516 // sensible default based on the target triple.
517 if (TargetAddrEnd.getNumOccurrences() == 0) {
518 if (TargetTriple.isArch16Bit())
519 TargetAddrEnd = (1ULL << 16) - 1;
520 else if (TargetTriple.isArch32Bit())
521 TargetAddrEnd = (1ULL << 32) - 1;
522 // TargetAddrEnd already has a sensible default for 64-bit systems, so
523 // there's nothing to do in the 64-bit case.
524 }
525
Lang Hames778ef5b2014-09-04 04:19:54 +0000526 // Process any elements remaining in the worklist.
527 while (!Worklist.empty()) {
528 std::pair<void*, uint64_t> CurEntry = Worklist.front();
529 Worklist.pop_front();
Lang Hames9cb73532014-07-29 23:43:13 +0000530
Lang Hames778ef5b2014-09-04 04:19:54 +0000531 uint64_t NextSectionAddr = TargetAddrStart;
532
533 for (const auto &Alloc : AlreadyAllocated)
534 if (NextSectionAddr + CurEntry.second + TargetSectionSep <= Alloc.first)
535 break;
536 else
537 NextSectionAddr = Alloc.first + Alloc.second + TargetSectionSep;
538
539 AlreadyAllocated[NextSectionAddr] = CurEntry.second;
540 Checker.getRTDyld().mapSectionAddress(CurEntry.first, NextSectionAddr);
Lang Hames9cb73532014-07-29 23:43:13 +0000541 }
542
Lang Hames78937c22015-07-04 01:35:26 +0000543 // Add dummy symbols to the memory manager.
544 for (const auto &Mapping : DummySymbolMappings) {
545 size_t EqualsIdx = Mapping.find_first_of("=");
546
547 if (EqualsIdx == StringRef::npos) {
548 errs() << "Invalid dummy symbol specification '" << Mapping
549 << "'. Should be '<symbol name>=<addr>'\n";
550 exit(1);
551 }
552
553 std::string Symbol = Mapping.substr(0, EqualsIdx);
554 std::string AddrStr = Mapping.substr(EqualsIdx + 1);
555
556 uint64_t Addr;
557 if (StringRef(AddrStr).getAsInteger(0, Addr)) {
558 errs() << "Invalid symbol mapping '" << Mapping << "'.\n";
559 exit(1);
560 }
561
562 MemMgr.addDummySymbol(Symbol, Addr);
563 }
Lang Hames9cb73532014-07-29 23:43:13 +0000564}
565
566// Load and link the objects specified on the command line, but do not execute
567// anything. Instead, attach a RuntimeDyldChecker instance and call it to
568// verify the correctness of the linked memory.
Lang Hamese1c11382014-06-27 20:20:57 +0000569static int linkAndVerify() {
570
571 // Check for missing triple.
572 if (TripleName == "") {
573 llvm::errs() << "Error: -triple required when running in -verify mode.\n";
574 return 1;
575 }
576
577 // Look up the target and build the disassembler.
578 Triple TheTriple(Triple::normalize(TripleName));
579 std::string ErrorStr;
580 const Target *TheTarget =
581 TargetRegistry::lookupTarget("", TheTriple, ErrorStr);
582 if (!TheTarget) {
583 llvm::errs() << "Error accessing target '" << TripleName << "': "
584 << ErrorStr << "\n";
585 return 1;
586 }
587 TripleName = TheTriple.getTriple();
588
589 std::unique_ptr<MCSubtargetInfo> STI(
Petar Jovanovic280e5622015-06-23 22:52:19 +0000590 TheTarget->createMCSubtargetInfo(TripleName, MCPU, ""));
Lang Hamese1c11382014-06-27 20:20:57 +0000591 assert(STI && "Unable to create subtarget info!");
592
593 std::unique_ptr<MCRegisterInfo> MRI(TheTarget->createMCRegInfo(TripleName));
594 assert(MRI && "Unable to create target register info!");
595
596 std::unique_ptr<MCAsmInfo> MAI(TheTarget->createMCAsmInfo(*MRI, TripleName));
597 assert(MAI && "Unable to create target asm info!");
598
599 MCContext Ctx(MAI.get(), MRI.get(), nullptr);
600
601 std::unique_ptr<MCDisassembler> Disassembler(
602 TheTarget->createMCDisassembler(*STI, Ctx));
603 assert(Disassembler && "Unable to create disassembler!");
604
605 std::unique_ptr<MCInstrInfo> MII(TheTarget->createMCInstrInfo());
606
Daniel Sanders153010c2015-09-15 14:08:28 +0000607 std::unique_ptr<MCInstPrinter> InstPrinter(TheTarget->createMCInstPrinter(
608 TargetTuple(Triple(TripleName)), 0, *MAI, *MII, *MRI));
Lang Hamese1c11382014-06-27 20:20:57 +0000609
610 // Load any dylibs requested on the command line.
611 loadDylibs();
612
613 // Instantiate a dynamic linker.
614 TrivialMemoryManager MemMgr;
Lang Hames633fe142015-03-30 03:37:06 +0000615 RuntimeDyld Dyld(MemMgr, MemMgr);
Lang Hames925e51b2014-09-03 05:42:52 +0000616 Dyld.setProcessAllSections(true);
Lang Hamesf7acddd2014-07-22 22:47:39 +0000617 RuntimeDyldChecker Checker(Dyld, Disassembler.get(), InstPrinter.get(),
618 llvm::dbgs());
Lang Hamese1c11382014-06-27 20:20:57 +0000619
Lang Hamesc3246ad2015-04-15 21:18:41 +0000620 // FIXME: Preserve buffers until resolveRelocations time to work around a bug
621 // in RuntimeDyldELF.
622 // This fixme should be fixed ASAP. This is a very brittle workaround.
623 std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
624
Lang Hamese1c11382014-06-27 20:20:57 +0000625 // If we don't have any input files, read from stdin.
626 if (!InputFileList.size())
627 InputFileList.push_back("-");
628 for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
629 // Load the input memory buffer.
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000630 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
631 MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000632
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000633 if (std::error_code EC = InputBuffer.getError())
634 return Error("unable to read input: '" + EC.message() + "'");
Lang Hamese1c11382014-06-27 20:20:57 +0000635
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000636 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
637 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
638
639 if (std::error_code EC = MaybeObj.getError())
640 return Error("unable to create object file: '" + EC.message() + "'");
641
642 ObjectFile &Obj = **MaybeObj;
Lang Hamesc3246ad2015-04-15 21:18:41 +0000643 InputBuffers.push_back(std::move(*InputBuffer));
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000644
Lang Hamese1c11382014-06-27 20:20:57 +0000645 // Load the object file
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000646 Dyld.loadObject(Obj);
647 if (Dyld.hasError()) {
Lang Hamese1c11382014-06-27 20:20:57 +0000648 return Error(Dyld.getErrorString());
649 }
650 }
651
Lang Hames78937c22015-07-04 01:35:26 +0000652 // Re-map the section addresses into the phony target address space and add
653 // dummy symbols.
654 remapSectionsAndSymbols(TheTriple, MemMgr, Checker);
Lang Hames375385f2014-07-30 03:12:41 +0000655
Lang Hamese1c11382014-06-27 20:20:57 +0000656 // Resolve all the relocations we can.
657 Dyld.resolveRelocations();
658
Lang Hames925e51b2014-09-03 05:42:52 +0000659 // Register EH frames.
660 Dyld.registerEHFrames();
661
Lang Hamesae172682014-08-05 20:51:46 +0000662 int ErrorCode = checkAllExpressions(Checker);
663 if (Dyld.hasError()) {
664 errs() << "RTDyld reported an error applying relocations:\n "
665 << Dyld.getErrorString() << "\n";
666 ErrorCode = 1;
667 }
668
669 return ErrorCode;
Lang Hamese1c11382014-06-27 20:20:57 +0000670}
671
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000672int main(int argc, char **argv) {
Alp Toker9f679322013-11-05 09:33:43 +0000673 sys::PrintStackTraceOnErrorSignal();
674 PrettyStackTraceProgram X(argc, argv);
675
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000676 ProgramName = argv[0];
677 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
678
Lang Hamese1c11382014-06-27 20:20:57 +0000679 llvm::InitializeAllTargetInfos();
680 llvm::InitializeAllTargetMCs();
681 llvm::InitializeAllDisassemblers();
682
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000683 cl::ParseCommandLineOptions(argc, argv, "llvm MC-JIT tool\n");
684
685 switch (Action) {
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000686 case AC_Execute:
Jim Grosbach4d5284b2011-03-18 17:24:21 +0000687 return executeInput();
Keno Fischerc780e8e2015-05-21 21:24:32 +0000688 case AC_PrintDebugLineInfo:
Keno Fischer281b6942015-05-30 19:44:53 +0000689 return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */ true);
Andrew Kaylord55d7012013-01-25 22:50:58 +0000690 case AC_PrintLineInfo:
Keno Fischer281b6942015-05-30 19:44:53 +0000691 return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */false);
692 case AC_PrintObjectLineInfo:
693 return printLineInfoForInput(/* LoadObjects */false,/* UseDebugObj */false);
Lang Hamese1c11382014-06-27 20:20:57 +0000694 case AC_Verify:
695 return linkAndVerify();
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000696 }
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000697}