blob: d6423a3e693c21660f102797ed8e8562a020c7d5 [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) {
307 object::section_iterator Sec(SymbolObj->section_end());
Rafael Espindolada176272015-05-31 22:13:51 +0000308 Sym.getSection(Sec);
Keno Fischerc780e8e2015-05-21 21:24:32 +0000309 StringRef SecName;
310 Sec->getName(SecName);
311 uint64_t SectionLoadAddress =
Lang Hames2e88f4f2015-07-28 17:52:11 +0000312 LoadedObjInfo->getSectionLoadAddress(*Sec);
Keno Fischerc780e8e2015-05-21 21:24:32 +0000313 if (SectionLoadAddress != 0)
314 Addr += SectionLoadAddress - Sec->getAddress();
315 }
316
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000317 outs() << "Function: " << *Name << ", Size = " << Size
318 << ", Addr = " << Addr << "\n";
Andrew Kaylord55d7012013-01-25 22:50:58 +0000319
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000320 DILineInfoTable Lines = Context->getLineInfoForAddressRange(Addr, Size);
321 DILineInfoTable::iterator Begin = Lines.begin();
322 DILineInfoTable::iterator End = Lines.end();
323 for (DILineInfoTable::iterator It = Begin; It != End; ++It) {
324 outs() << " Line info @ " << It->first - Addr << ": "
Alexey Samsonovd0109992014-04-18 21:36:39 +0000325 << It->second.FileName << ", line:" << It->second.Line << "\n";
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000326 }
Andrew Kaylord55d7012013-01-25 22:50:58 +0000327 }
328 }
329 }
330
331 return 0;
332}
333
Jim Grosbach4d5284b2011-03-18 17:24:21 +0000334static int executeInput() {
Lang Hamesd311c0e2014-05-13 22:37:41 +0000335 // Load any dylibs requested on the command line.
336 loadDylibs();
337
Jim Grosbachf016b0a2011-03-21 22:15:52 +0000338 // Instantiate a dynamic linker.
Benjamin Kramer9ce77082013-08-03 22:16:31 +0000339 TrivialMemoryManager MemMgr;
Lang Hames633fe142015-03-30 03:37:06 +0000340 RuntimeDyld Dyld(MemMgr, MemMgr);
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000341
Lang Hamesc3246ad2015-04-15 21:18:41 +0000342 // FIXME: Preserve buffers until resolveRelocations time to work around a bug
343 // in RuntimeDyldELF.
344 // This fixme should be fixed ASAP. This is a very brittle workaround.
345 std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
346
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000347 // If we don't have any input files, read from stdin.
348 if (!InputFileList.size())
349 InputFileList.push_back("-");
350 for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
351 // Load the input memory buffer.
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000352 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
353 MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
354 if (std::error_code EC = InputBuffer.getError())
355 return Error("unable to read input: '" + EC.message() + "'");
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000356 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
357 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
358
359 if (std::error_code EC = MaybeObj.getError())
360 return Error("unable to create object file: '" + EC.message() + "'");
361
362 ObjectFile &Obj = **MaybeObj;
Lang Hamesc3246ad2015-04-15 21:18:41 +0000363 InputBuffers.push_back(std::move(*InputBuffer));
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000364
Andrew Kayloradc70562012-10-02 21:18:39 +0000365 // Load the object file
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000366 Dyld.loadObject(Obj);
367 if (Dyld.hasError()) {
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000368 return Error(Dyld.getErrorString());
369 }
Jim Grosbach40411cc2011-03-22 18:19:42 +0000370 }
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000371
Jim Grosbach733d3052011-04-12 21:20:41 +0000372 // Resolve all the relocations we can.
373 Dyld.resolveRelocations();
Danil Malyshev8c17fbd2012-05-16 18:50:11 +0000374 // Clear instruction cache before code will be executed.
Benjamin Kramer5d62ad22013-08-03 22:18:45 +0000375 MemMgr.invalidateInstructionCache();
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000376
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000377 // FIXME: Error out if there are unresolved relocations.
378
Jim Grosbachd35159a2011-04-13 15:38:30 +0000379 // Get the address of the entry point (_main by default).
Lang Hamesb1186032015-03-11 00:43:26 +0000380 void *MainAddress = Dyld.getSymbolLocalAddress(EntryPoint);
Craig Toppere6cb63e2014-04-25 04:24:47 +0000381 if (!MainAddress)
Jim Grosbachd35159a2011-04-13 15:38:30 +0000382 return Error("no definition for '" + EntryPoint + "'");
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000383
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000384 // Invalidate the instruction cache for each loaded function.
Benjamin Kramer5d62ad22013-08-03 22:18:45 +0000385 for (unsigned i = 0, e = MemMgr.FunctionMemory.size(); i != e; ++i) {
386 sys::MemoryBlock &Data = MemMgr.FunctionMemory[i];
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000387 // Make sure the memory is executable.
388 std::string ErrorStr;
389 sys::Memory::InvalidateInstructionCache(Data.base(), Data.size());
390 if (!sys::Memory::setExecutable(Data, &ErrorStr))
391 return Error("unable to mark function executable: '" + ErrorStr + "'");
392 }
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000393
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000394 // Dispatch to _main().
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000395 errs() << "loaded '" << EntryPoint << "' at: " << (void*)MainAddress << "\n";
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000396
397 int (*Main)(int, const char**) =
398 (int(*)(int,const char**)) uintptr_t(MainAddress);
399 const char **Argv = new const char*[2];
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000400 // Use the name of the first input object module as argv[0] for the target.
401 Argv[0] = InputFileList[0].c_str();
Craig Toppere6cb63e2014-04-25 04:24:47 +0000402 Argv[1] = nullptr;
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000403 return Main(1, Argv);
404}
405
Lang Hamese1c11382014-06-27 20:20:57 +0000406static int checkAllExpressions(RuntimeDyldChecker &Checker) {
407 for (const auto& CheckerFileName : CheckFiles) {
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000408 ErrorOr<std::unique_ptr<MemoryBuffer>> CheckerFileBuf =
409 MemoryBuffer::getFileOrSTDIN(CheckerFileName);
410 if (std::error_code EC = CheckerFileBuf.getError())
Lang Hamese1c11382014-06-27 20:20:57 +0000411 return Error("unable to read input '" + CheckerFileName + "': " +
412 EC.message());
413
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000414 if (!Checker.checkAllRulesInBuffer("# rtdyld-check:",
415 CheckerFileBuf.get().get()))
Lang Hamese1c11382014-06-27 20:20:57 +0000416 return Error("some checks in '" + CheckerFileName + "' failed");
417 }
418 return 0;
419}
420
Benjamin Kramerf044d3f2015-03-09 16:23:46 +0000421static std::map<void *, uint64_t>
Lang Hames778ef5b2014-09-04 04:19:54 +0000422applySpecificSectionMappings(RuntimeDyldChecker &Checker) {
423
424 std::map<void*, uint64_t> SpecificMappings;
425
426 for (StringRef Mapping : SpecificSectionMappings) {
427
428 size_t EqualsIdx = Mapping.find_first_of("=");
Lang Hames78937c22015-07-04 01:35:26 +0000429 std::string SectionIDStr = Mapping.substr(0, EqualsIdx);
Lang Hames778ef5b2014-09-04 04:19:54 +0000430 size_t ComaIdx = Mapping.find_first_of(",");
431
432 if (ComaIdx == StringRef::npos) {
433 errs() << "Invalid section specification '" << Mapping
434 << "'. Should be '<file name>,<section name>=<addr>'\n";
435 exit(1);
436 }
437
Lang Hames78937c22015-07-04 01:35:26 +0000438 std::string FileName = SectionIDStr.substr(0, ComaIdx);
439 std::string SectionName = SectionIDStr.substr(ComaIdx + 1);
Lang Hames778ef5b2014-09-04 04:19:54 +0000440
441 uint64_t OldAddrInt;
442 std::string ErrorMsg;
443 std::tie(OldAddrInt, ErrorMsg) =
444 Checker.getSectionAddr(FileName, SectionName, true);
445
446 if (ErrorMsg != "") {
447 errs() << ErrorMsg;
448 exit(1);
449 }
450
451 void* OldAddr = reinterpret_cast<void*>(static_cast<uintptr_t>(OldAddrInt));
452
Lang Hames78937c22015-07-04 01:35:26 +0000453 std::string NewAddrStr = Mapping.substr(EqualsIdx + 1);
Lang Hames778ef5b2014-09-04 04:19:54 +0000454 uint64_t NewAddr;
455
Lang Hames78937c22015-07-04 01:35:26 +0000456 if (StringRef(NewAddrStr).getAsInteger(0, NewAddr)) {
457 errs() << "Invalid section address in mapping '" << Mapping << "'.\n";
Lang Hames778ef5b2014-09-04 04:19:54 +0000458 exit(1);
459 }
460
461 Checker.getRTDyld().mapSectionAddress(OldAddr, NewAddr);
462 SpecificMappings[OldAddr] = NewAddr;
463 }
464
465 return SpecificMappings;
466}
467
Lang Hames9cb73532014-07-29 23:43:13 +0000468// Scatter sections in all directions!
469// Remaps section addresses for -verify mode. The following command line options
470// can be used to customize the layout of the memory within the phony target's
471// address space:
472// -target-addr-start <s> -- Specify where the phony target addres range starts.
473// -target-addr-end <e> -- Specify where the phony target address range ends.
474// -target-section-sep <d> -- Specify how big a gap should be left between the
475// end of one section and the start of the next.
476// Defaults to zero. Set to something big
477// (e.g. 1 << 32) to stress-test stubs, GOTs, etc.
478//
Lang Hames78937c22015-07-04 01:35:26 +0000479static void remapSectionsAndSymbols(const llvm::Triple &TargetTriple,
480 TrivialMemoryManager &MemMgr,
481 RuntimeDyldChecker &Checker) {
Lang Hames778ef5b2014-09-04 04:19:54 +0000482
483 // Set up a work list (section addr/size pairs).
484 typedef std::list<std::pair<void*, uint64_t>> WorklistT;
485 WorklistT Worklist;
486
487 for (const auto& CodeSection : MemMgr.FunctionMemory)
488 Worklist.push_back(std::make_pair(CodeSection.base(), CodeSection.size()));
489 for (const auto& DataSection : MemMgr.DataMemory)
490 Worklist.push_back(std::make_pair(DataSection.base(), DataSection.size()));
491
492 // Apply any section-specific mappings that were requested on the command
493 // line.
494 typedef std::map<void*, uint64_t> AppliedMappingsT;
495 AppliedMappingsT AppliedMappings = applySpecificSectionMappings(Checker);
496
497 // Keep an "already allocated" mapping of section target addresses to sizes.
498 // Sections whose address mappings aren't specified on the command line will
499 // allocated around the explicitly mapped sections while maintaining the
500 // minimum separation.
501 std::map<uint64_t, uint64_t> AlreadyAllocated;
502
503 // Move the previously applied mappings into the already-allocated map.
504 for (WorklistT::iterator I = Worklist.begin(), E = Worklist.end();
505 I != E;) {
506 WorklistT::iterator Tmp = I;
507 ++I;
508 AppliedMappingsT::iterator AI = AppliedMappings.find(Tmp->first);
509
510 if (AI != AppliedMappings.end()) {
511 AlreadyAllocated[AI->second] = Tmp->second;
512 Worklist.erase(Tmp);
513 }
514 }
Lang Hames9cb73532014-07-29 23:43:13 +0000515
516 // If the -target-addr-end option wasn't explicitly passed, then set it to a
517 // sensible default based on the target triple.
518 if (TargetAddrEnd.getNumOccurrences() == 0) {
519 if (TargetTriple.isArch16Bit())
520 TargetAddrEnd = (1ULL << 16) - 1;
521 else if (TargetTriple.isArch32Bit())
522 TargetAddrEnd = (1ULL << 32) - 1;
523 // TargetAddrEnd already has a sensible default for 64-bit systems, so
524 // there's nothing to do in the 64-bit case.
525 }
526
Lang Hames778ef5b2014-09-04 04:19:54 +0000527 // Process any elements remaining in the worklist.
528 while (!Worklist.empty()) {
529 std::pair<void*, uint64_t> CurEntry = Worklist.front();
530 Worklist.pop_front();
Lang Hames9cb73532014-07-29 23:43:13 +0000531
Lang Hames778ef5b2014-09-04 04:19:54 +0000532 uint64_t NextSectionAddr = TargetAddrStart;
533
534 for (const auto &Alloc : AlreadyAllocated)
535 if (NextSectionAddr + CurEntry.second + TargetSectionSep <= Alloc.first)
536 break;
537 else
538 NextSectionAddr = Alloc.first + Alloc.second + TargetSectionSep;
539
540 AlreadyAllocated[NextSectionAddr] = CurEntry.second;
541 Checker.getRTDyld().mapSectionAddress(CurEntry.first, NextSectionAddr);
Lang Hames9cb73532014-07-29 23:43:13 +0000542 }
543
Lang Hames78937c22015-07-04 01:35:26 +0000544 // Add dummy symbols to the memory manager.
545 for (const auto &Mapping : DummySymbolMappings) {
546 size_t EqualsIdx = Mapping.find_first_of("=");
547
548 if (EqualsIdx == StringRef::npos) {
549 errs() << "Invalid dummy symbol specification '" << Mapping
550 << "'. Should be '<symbol name>=<addr>'\n";
551 exit(1);
552 }
553
554 std::string Symbol = Mapping.substr(0, EqualsIdx);
555 std::string AddrStr = Mapping.substr(EqualsIdx + 1);
556
557 uint64_t Addr;
558 if (StringRef(AddrStr).getAsInteger(0, Addr)) {
559 errs() << "Invalid symbol mapping '" << Mapping << "'.\n";
560 exit(1);
561 }
562
563 MemMgr.addDummySymbol(Symbol, Addr);
564 }
Lang Hames9cb73532014-07-29 23:43:13 +0000565}
566
567// Load and link the objects specified on the command line, but do not execute
568// anything. Instead, attach a RuntimeDyldChecker instance and call it to
569// verify the correctness of the linked memory.
Lang Hamese1c11382014-06-27 20:20:57 +0000570static int linkAndVerify() {
571
572 // Check for missing triple.
573 if (TripleName == "") {
574 llvm::errs() << "Error: -triple required when running in -verify mode.\n";
575 return 1;
576 }
577
578 // Look up the target and build the disassembler.
579 Triple TheTriple(Triple::normalize(TripleName));
580 std::string ErrorStr;
581 const Target *TheTarget =
582 TargetRegistry::lookupTarget("", TheTriple, ErrorStr);
583 if (!TheTarget) {
584 llvm::errs() << "Error accessing target '" << TripleName << "': "
585 << ErrorStr << "\n";
586 return 1;
587 }
588 TripleName = TheTriple.getTriple();
589
590 std::unique_ptr<MCSubtargetInfo> STI(
Petar Jovanovic280e5622015-06-23 22:52:19 +0000591 TheTarget->createMCSubtargetInfo(TripleName, MCPU, ""));
Lang Hamese1c11382014-06-27 20:20:57 +0000592 assert(STI && "Unable to create subtarget info!");
593
594 std::unique_ptr<MCRegisterInfo> MRI(TheTarget->createMCRegInfo(TripleName));
595 assert(MRI && "Unable to create target register info!");
596
597 std::unique_ptr<MCAsmInfo> MAI(TheTarget->createMCAsmInfo(*MRI, TripleName));
598 assert(MAI && "Unable to create target asm info!");
599
600 MCContext Ctx(MAI.get(), MRI.get(), nullptr);
601
602 std::unique_ptr<MCDisassembler> Disassembler(
603 TheTarget->createMCDisassembler(*STI, Ctx));
604 assert(Disassembler && "Unable to create disassembler!");
605
606 std::unique_ptr<MCInstrInfo> MII(TheTarget->createMCInstrInfo());
607
608 std::unique_ptr<MCInstPrinter> InstPrinter(
Eric Christopherf8019402015-03-31 00:10:04 +0000609 TheTarget->createMCInstPrinter(Triple(TripleName), 0, *MAI, *MII, *MRI));
Lang Hamese1c11382014-06-27 20:20:57 +0000610
611 // Load any dylibs requested on the command line.
612 loadDylibs();
613
614 // Instantiate a dynamic linker.
615 TrivialMemoryManager MemMgr;
Lang Hames633fe142015-03-30 03:37:06 +0000616 RuntimeDyld Dyld(MemMgr, MemMgr);
Lang Hames925e51b2014-09-03 05:42:52 +0000617 Dyld.setProcessAllSections(true);
Lang Hamesf7acddd2014-07-22 22:47:39 +0000618 RuntimeDyldChecker Checker(Dyld, Disassembler.get(), InstPrinter.get(),
619 llvm::dbgs());
Lang Hamese1c11382014-06-27 20:20:57 +0000620
Lang Hamesc3246ad2015-04-15 21:18:41 +0000621 // FIXME: Preserve buffers until resolveRelocations time to work around a bug
622 // in RuntimeDyldELF.
623 // This fixme should be fixed ASAP. This is a very brittle workaround.
624 std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
625
Lang Hamese1c11382014-06-27 20:20:57 +0000626 // If we don't have any input files, read from stdin.
627 if (!InputFileList.size())
628 InputFileList.push_back("-");
629 for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
630 // Load the input memory buffer.
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000631 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
632 MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000633
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000634 if (std::error_code EC = InputBuffer.getError())
635 return Error("unable to read input: '" + EC.message() + "'");
Lang Hamese1c11382014-06-27 20:20:57 +0000636
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000637 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
638 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
639
640 if (std::error_code EC = MaybeObj.getError())
641 return Error("unable to create object file: '" + EC.message() + "'");
642
643 ObjectFile &Obj = **MaybeObj;
Lang Hamesc3246ad2015-04-15 21:18:41 +0000644 InputBuffers.push_back(std::move(*InputBuffer));
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000645
Lang Hamese1c11382014-06-27 20:20:57 +0000646 // Load the object file
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000647 Dyld.loadObject(Obj);
648 if (Dyld.hasError()) {
Lang Hamese1c11382014-06-27 20:20:57 +0000649 return Error(Dyld.getErrorString());
650 }
651 }
652
Lang Hames78937c22015-07-04 01:35:26 +0000653 // Re-map the section addresses into the phony target address space and add
654 // dummy symbols.
655 remapSectionsAndSymbols(TheTriple, MemMgr, Checker);
Lang Hames375385f2014-07-30 03:12:41 +0000656
Lang Hamese1c11382014-06-27 20:20:57 +0000657 // Resolve all the relocations we can.
658 Dyld.resolveRelocations();
659
Lang Hames925e51b2014-09-03 05:42:52 +0000660 // Register EH frames.
661 Dyld.registerEHFrames();
662
Lang Hamesae172682014-08-05 20:51:46 +0000663 int ErrorCode = checkAllExpressions(Checker);
664 if (Dyld.hasError()) {
665 errs() << "RTDyld reported an error applying relocations:\n "
666 << Dyld.getErrorString() << "\n";
667 ErrorCode = 1;
668 }
669
670 return ErrorCode;
Lang Hamese1c11382014-06-27 20:20:57 +0000671}
672
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000673int main(int argc, char **argv) {
Alp Toker9f679322013-11-05 09:33:43 +0000674 sys::PrintStackTraceOnErrorSignal();
675 PrettyStackTraceProgram X(argc, argv);
676
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000677 ProgramName = argv[0];
678 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
679
Lang Hamese1c11382014-06-27 20:20:57 +0000680 llvm::InitializeAllTargetInfos();
681 llvm::InitializeAllTargetMCs();
682 llvm::InitializeAllDisassemblers();
683
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000684 cl::ParseCommandLineOptions(argc, argv, "llvm MC-JIT tool\n");
685
686 switch (Action) {
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000687 case AC_Execute:
Jim Grosbach4d5284b2011-03-18 17:24:21 +0000688 return executeInput();
Keno Fischerc780e8e2015-05-21 21:24:32 +0000689 case AC_PrintDebugLineInfo:
Keno Fischer281b6942015-05-30 19:44:53 +0000690 return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */ true);
Andrew Kaylord55d7012013-01-25 22:50:58 +0000691 case AC_PrintLineInfo:
Keno Fischer281b6942015-05-30 19:44:53 +0000692 return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */false);
693 case AC_PrintObjectLineInfo:
694 return printLineInfoForInput(/* LoadObjects */false,/* UseDebugObj */false);
Lang Hamese1c11382014-06-27 20:20:57 +0000695 case AC_Verify:
696 return linkAndVerify();
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000697 }
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000698}