blob: 59c9a0c990f335dbe28b3bb9c6eb061a6a2db0d6 [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>
Davide Italianob59ea902015-10-21 22:12:03 +000097PreallocMemory("preallocate",
98 cl::desc("Allocate memory upfront rather than on-demand"),
99 cl::init(0));
100
101static cl::opt<uint64_t>
Lang Hames9cb73532014-07-29 23:43:13 +0000102TargetAddrStart("target-addr-start",
103 cl::desc("For -verify only: start of phony target address "
104 "range."),
105 cl::init(4096), // Start at "page 1" - no allocating at "null".
106 cl::Hidden);
107
108static cl::opt<uint64_t>
109TargetAddrEnd("target-addr-end",
110 cl::desc("For -verify only: end of phony target address range."),
111 cl::init(~0ULL),
112 cl::Hidden);
113
114static cl::opt<uint64_t>
115TargetSectionSep("target-section-sep",
116 cl::desc("For -verify only: Separation between sections in "
117 "phony target address space."),
118 cl::init(0),
119 cl::Hidden);
120
Lang Hames778ef5b2014-09-04 04:19:54 +0000121static cl::list<std::string>
122SpecificSectionMappings("map-section",
Lang Hames78937c22015-07-04 01:35:26 +0000123 cl::desc("For -verify only: Map a section to a "
124 "specific address."),
125 cl::ZeroOrMore,
126 cl::Hidden);
127
128static cl::list<std::string>
129DummySymbolMappings("dummy-extern",
130 cl::desc("For -verify only: Inject a symbol into the extern "
131 "symbol table."),
132 cl::ZeroOrMore,
133 cl::Hidden);
Lang Hames778ef5b2014-09-04 04:19:54 +0000134
Sanjoy Dasd5658b02015-11-23 21:47:51 +0000135static cl::opt<bool>
136PrintAllocationRequests("print-alloc-requests",
137 cl::desc("Print allocation requests made to the memory "
138 "manager by RuntimeDyld"),
139 cl::Hidden);
140
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000141/* *** */
142
Jim Grosbach2dcef0502011-04-04 23:04:39 +0000143// A trivial memory manager that doesn't do anything fancy, just uses the
144// support library allocation routines directly.
145class TrivialMemoryManager : public RTDyldMemoryManager {
146public:
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000147 SmallVector<sys::MemoryBlock, 16> FunctionMemory;
Jim Grosbacheff0a402012-01-16 22:26:39 +0000148 SmallVector<sys::MemoryBlock, 16> DataMemory;
149
150 uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
Craig Toppere56917c2014-03-08 08:27:28 +0000151 unsigned SectionID,
152 StringRef SectionName) override;
Jim Grosbacheff0a402012-01-16 22:26:39 +0000153 uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
Filip Pizlo7aa695e02013-10-02 00:59:25 +0000154 unsigned SectionID, StringRef SectionName,
Craig Toppere56917c2014-03-08 08:27:28 +0000155 bool IsReadOnly) override;
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000156
Craig Toppere56917c2014-03-08 08:27:28 +0000157 void *getPointerToNamedFunction(const std::string &Name,
158 bool AbortOnFailure = true) override {
Craig Toppere6cb63e2014-04-25 04:24:47 +0000159 return nullptr;
Danil Malyshevbfee5422012-03-28 21:46:36 +0000160 }
161
Craig Toppere56917c2014-03-08 08:27:28 +0000162 bool finalizeMemory(std::string *ErrMsg) override { return false; }
Andrew Kaylora342cb92012-11-15 23:50:01 +0000163
Lang Hames78937c22015-07-04 01:35:26 +0000164 void addDummySymbol(const std::string &Name, uint64_t Addr) {
165 DummyExterns[Name] = Addr;
166 }
167
168 RuntimeDyld::SymbolInfo findSymbol(const std::string &Name) override {
169 auto I = DummyExterns.find(Name);
170
171 if (I != DummyExterns.end())
172 return RuntimeDyld::SymbolInfo(I->second, JITSymbolFlags::Exported);
173
174 return RTDyldMemoryManager::findSymbol(Name);
175 }
176
Tim Northover5af339a2015-06-03 18:26:52 +0000177 void registerEHFrames(uint8_t *Addr, uint64_t LoadAddr,
178 size_t Size) override {}
179 void deregisterEHFrames(uint8_t *Addr, uint64_t LoadAddr,
180 size_t Size) override {}
Davide Italianob59ea902015-10-21 22:12:03 +0000181
182 void preallocateSlab(uint64_t Size) {
183 std::string Err;
184 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, &Err);
185 if (!MB.base())
186 report_fatal_error("Can't allocate enough memory: " + Err);
187
188 PreallocSlab = MB;
189 UsePreallocation = true;
190 SlabSize = Size;
191 }
192
193 uint8_t *allocateFromSlab(uintptr_t Size, unsigned Alignment, bool isCode) {
194 Size = RoundUpToAlignment(Size, Alignment);
195 if (CurrentSlabOffset + Size > SlabSize)
196 report_fatal_error("Can't allocate enough memory. Tune --preallocate");
197
198 uintptr_t OldSlabOffset = CurrentSlabOffset;
199 sys::MemoryBlock MB((void *)OldSlabOffset, Size);
200 if (isCode)
201 FunctionMemory.push_back(MB);
202 else
203 DataMemory.push_back(MB);
204 CurrentSlabOffset += Size;
205 return (uint8_t*)OldSlabOffset;
206 }
207
Lang Hames78937c22015-07-04 01:35:26 +0000208private:
209 std::map<std::string, uint64_t> DummyExterns;
Davide Italianob59ea902015-10-21 22:12:03 +0000210 sys::MemoryBlock PreallocSlab;
211 bool UsePreallocation = false;
212 uintptr_t SlabSize = 0;
213 uintptr_t CurrentSlabOffset = 0;
Jim Grosbach2dcef0502011-04-04 23:04:39 +0000214};
215
Jim Grosbacheff0a402012-01-16 22:26:39 +0000216uint8_t *TrivialMemoryManager::allocateCodeSection(uintptr_t Size,
217 unsigned Alignment,
Filip Pizlo7aa695e02013-10-02 00:59:25 +0000218 unsigned SectionID,
219 StringRef SectionName) {
Sanjoy Dasd5658b02015-11-23 21:47:51 +0000220 if (PrintAllocationRequests)
221 outs() << "allocateCodeSection(Size = " << Size << ", Alignment = "
222 << Alignment << ", SectionName = " << SectionName << ")\n";
223
Davide Italianob59ea902015-10-21 22:12:03 +0000224 if (UsePreallocation)
225 return allocateFromSlab(Size, Alignment, true /* isCode */);
226
Davide Italiano89151a02015-10-15 00:05:32 +0000227 std::string Err;
228 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, &Err);
229 if (!MB.base())
230 report_fatal_error("MemoryManager allocation failed: " + Err);
Danil Malyshev8c17fbd2012-05-16 18:50:11 +0000231 FunctionMemory.push_back(MB);
232 return (uint8_t*)MB.base();
Jim Grosbacheff0a402012-01-16 22:26:39 +0000233}
234
235uint8_t *TrivialMemoryManager::allocateDataSection(uintptr_t Size,
236 unsigned Alignment,
Andrew Kaylora342cb92012-11-15 23:50:01 +0000237 unsigned SectionID,
Filip Pizlo7aa695e02013-10-02 00:59:25 +0000238 StringRef SectionName,
Andrew Kaylora342cb92012-11-15 23:50:01 +0000239 bool IsReadOnly) {
Sanjoy Dasd5658b02015-11-23 21:47:51 +0000240 if (PrintAllocationRequests)
241 outs() << "allocateDataSection(Size = " << Size << ", Alignment = "
242 << Alignment << ", SectionName = " << SectionName << ")\n";
243
Davide Italianob59ea902015-10-21 22:12:03 +0000244 if (UsePreallocation)
245 return allocateFromSlab(Size, Alignment, false /* isCode */);
246
Davide Italiano89151a02015-10-15 00:05:32 +0000247 std::string Err;
248 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, &Err);
249 if (!MB.base())
250 report_fatal_error("MemoryManager allocation failed: " + Err);
Danil Malyshev8c17fbd2012-05-16 18:50:11 +0000251 DataMemory.push_back(MB);
252 return (uint8_t*)MB.base();
253}
254
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000255static const char *ProgramName;
256
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000257static int Error(const Twine &Msg) {
Davide Italianoc2e910d2015-11-20 23:12:15 +0000258 errs() << ProgramName << ": error: " << Msg << "\n";
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000259 return 1;
260}
261
Lang Hamesd311c0e2014-05-13 22:37:41 +0000262static void loadDylibs() {
263 for (const std::string &Dylib : Dylibs) {
Davide Italiano5cdf9362015-11-22 01:58:33 +0000264 if (!sys::fs::is_regular_file(Dylib))
Davide Italiano41d0fa72015-11-21 05:58:19 +0000265 report_fatal_error("Dylib not found: '" + Dylib + "'.");
Davide Italiano5cdf9362015-11-22 01:58:33 +0000266 std::string ErrMsg;
267 if (sys::DynamicLibrary::LoadLibraryPermanently(Dylib.c_str(), &ErrMsg))
268 report_fatal_error("Error loading '" + Dylib + "': " + ErrMsg);
Lang Hamesd311c0e2014-05-13 22:37:41 +0000269 }
270}
271
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000272/* *** */
273
Keno Fischerc780e8e2015-05-21 21:24:32 +0000274static int printLineInfoForInput(bool LoadObjects, bool UseDebugObj) {
275 assert(LoadObjects || !UseDebugObj);
276
Lang Hamesd311c0e2014-05-13 22:37:41 +0000277 // Load any dylibs requested on the command line.
278 loadDylibs();
279
Andrew Kaylord55d7012013-01-25 22:50:58 +0000280 // If we don't have any input files, read from stdin.
281 if (!InputFileList.size())
282 InputFileList.push_back("-");
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000283 for (auto &File : InputFileList) {
Andrew Kaylord55d7012013-01-25 22:50:58 +0000284 // Instantiate a dynamic linker.
Benjamin Kramer9ce77082013-08-03 22:16:31 +0000285 TrivialMemoryManager MemMgr;
Lang Hames633fe142015-03-30 03:37:06 +0000286 RuntimeDyld Dyld(MemMgr, MemMgr);
Andrew Kaylord55d7012013-01-25 22:50:58 +0000287
288 // Load the input memory buffer.
Andrew Kaylord55d7012013-01-25 22:50:58 +0000289
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000290 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000291 MemoryBuffer::getFileOrSTDIN(File);
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000292 if (std::error_code EC = InputBuffer.getError())
293 return Error("unable to read input: '" + EC.message() + "'");
294
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000295 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
296 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
297
298 if (std::error_code EC = MaybeObj.getError())
299 return Error("unable to create object file: '" + EC.message() + "'");
300
301 ObjectFile &Obj = **MaybeObj;
302
Keno Fischerc780e8e2015-05-21 21:24:32 +0000303 OwningBinary<ObjectFile> DebugObj;
304 std::unique_ptr<RuntimeDyld::LoadedObjectInfo> LoadedObjInfo = nullptr;
305 ObjectFile *SymbolObj = &Obj;
306 if (LoadObjects) {
307 // Load the object file
308 LoadedObjInfo =
309 Dyld.loadObject(Obj);
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000310
Keno Fischerc780e8e2015-05-21 21:24:32 +0000311 if (Dyld.hasError())
312 return Error(Dyld.getErrorString());
Andrew Kaylord55d7012013-01-25 22:50:58 +0000313
Keno Fischerc780e8e2015-05-21 21:24:32 +0000314 // Resolve all the relocations we can.
315 Dyld.resolveRelocations();
Andrew Kaylord55d7012013-01-25 22:50:58 +0000316
Keno Fischerc780e8e2015-05-21 21:24:32 +0000317 if (UseDebugObj) {
318 DebugObj = LoadedObjInfo->getObjectForDebug(Obj);
319 SymbolObj = DebugObj.getBinary();
Lang Hames5c969332015-07-28 20:51:53 +0000320 LoadedObjInfo.reset();
Keno Fischerc780e8e2015-05-21 21:24:32 +0000321 }
322 }
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000323
Ahmed Charles56440fd2014-03-06 05:51:42 +0000324 std::unique_ptr<DIContext> Context(
Keno Fischerc780e8e2015-05-21 21:24:32 +0000325 new DWARFContextInMemory(*SymbolObj,LoadedObjInfo.get()));
Andrew Kaylord55d7012013-01-25 22:50:58 +0000326
Rafael Espindola6bf32212015-06-24 19:57:32 +0000327 std::vector<std::pair<SymbolRef, uint64_t>> SymAddr =
Rafael Espindolab109c032015-06-23 02:08:48 +0000328 object::computeSymbolSizes(*SymbolObj);
Rafael Espindolaa82ce1d2015-05-31 23:15:35 +0000329
Andrew Kaylord55d7012013-01-25 22:50:58 +0000330 // Use symbol info to iterate functions in the object.
Rafael Espindola6bf32212015-06-24 19:57:32 +0000331 for (const auto &P : SymAddr) {
Rafael Espindolab109c032015-06-23 02:08:48 +0000332 object::SymbolRef Sym = P.first;
Rafael Espindola2fa80cc2015-06-26 12:18:49 +0000333 if (Sym.getType() == object::SymbolRef::ST_Function) {
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000334 ErrorOr<StringRef> Name = Sym.getName();
335 if (!Name)
Rafael Espindolada176272015-05-31 22:13:51 +0000336 continue;
Rafael Espindolaed067c42015-07-03 18:19:00 +0000337 ErrorOr<uint64_t> AddrOrErr = Sym.getAddress();
338 if (!AddrOrErr)
Rafael Espindolada176272015-05-31 22:13:51 +0000339 continue;
Rafael Espindolaed067c42015-07-03 18:19:00 +0000340 uint64_t Addr = *AddrOrErr;
Rafael Espindolaa82ce1d2015-05-31 23:15:35 +0000341
Rafael Espindolab109c032015-06-23 02:08:48 +0000342 uint64_t Size = P.second;
Keno Fischerc780e8e2015-05-21 21:24:32 +0000343 // If we're not using the debug object, compute the address of the
344 // symbol in memory (rather than that in the unrelocated object file)
345 // and use that to query the DWARFContext.
346 if (!UseDebugObj && LoadObjects) {
Rafael Espindola8bab8892015-08-07 23:27:14 +0000347 object::section_iterator Sec = *Sym.getSection();
Keno Fischerc780e8e2015-05-21 21:24:32 +0000348 StringRef SecName;
349 Sec->getName(SecName);
350 uint64_t SectionLoadAddress =
Lang Hames2e88f4f2015-07-28 17:52:11 +0000351 LoadedObjInfo->getSectionLoadAddress(*Sec);
Keno Fischerc780e8e2015-05-21 21:24:32 +0000352 if (SectionLoadAddress != 0)
353 Addr += SectionLoadAddress - Sec->getAddress();
354 }
355
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000356 outs() << "Function: " << *Name << ", Size = " << Size
357 << ", Addr = " << Addr << "\n";
Andrew Kaylord55d7012013-01-25 22:50:58 +0000358
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000359 DILineInfoTable Lines = Context->getLineInfoForAddressRange(Addr, Size);
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000360 for (auto &D : Lines) {
361 outs() << " Line info @ " << D.first - Addr << ": "
362 << D.second.FileName << ", line:" << D.second.Line << "\n";
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000363 }
Andrew Kaylord55d7012013-01-25 22:50:58 +0000364 }
365 }
366 }
367
368 return 0;
369}
370
Davide Italianob59ea902015-10-21 22:12:03 +0000371static void doPreallocation(TrivialMemoryManager &MemMgr) {
372 // Allocate a slab of memory upfront, if required. This is used if
373 // we want to test small code models.
374 if (static_cast<intptr_t>(PreallocMemory) < 0)
375 report_fatal_error("Pre-allocated bytes of memory must be a positive integer.");
376
377 // FIXME: Limit the amount of memory that can be preallocated?
378 if (PreallocMemory != 0)
379 MemMgr.preallocateSlab(PreallocMemory);
380}
381
Jim Grosbach4d5284b2011-03-18 17:24:21 +0000382static int executeInput() {
Lang Hamesd311c0e2014-05-13 22:37:41 +0000383 // Load any dylibs requested on the command line.
384 loadDylibs();
385
Jim Grosbachf016b0a2011-03-21 22:15:52 +0000386 // Instantiate a dynamic linker.
Benjamin Kramer9ce77082013-08-03 22:16:31 +0000387 TrivialMemoryManager MemMgr;
Davide Italianob59ea902015-10-21 22:12:03 +0000388 doPreallocation(MemMgr);
Lang Hames633fe142015-03-30 03:37:06 +0000389 RuntimeDyld Dyld(MemMgr, MemMgr);
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000390
Lang Hamesc3246ad2015-04-15 21:18:41 +0000391 // FIXME: Preserve buffers until resolveRelocations time to work around a bug
392 // in RuntimeDyldELF.
393 // This fixme should be fixed ASAP. This is a very brittle workaround.
394 std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
395
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000396 // If we don't have any input files, read from stdin.
397 if (!InputFileList.size())
398 InputFileList.push_back("-");
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000399 for (auto &File : InputFileList) {
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000400 // Load the input memory buffer.
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000401 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000402 MemoryBuffer::getFileOrSTDIN(File);
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000403 if (std::error_code EC = InputBuffer.getError())
404 return Error("unable to read input: '" + EC.message() + "'");
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000405 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
406 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
407
408 if (std::error_code EC = MaybeObj.getError())
409 return Error("unable to create object file: '" + EC.message() + "'");
410
411 ObjectFile &Obj = **MaybeObj;
Lang Hamesc3246ad2015-04-15 21:18:41 +0000412 InputBuffers.push_back(std::move(*InputBuffer));
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000413
Andrew Kayloradc70562012-10-02 21:18:39 +0000414 // Load the object file
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000415 Dyld.loadObject(Obj);
416 if (Dyld.hasError()) {
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000417 return Error(Dyld.getErrorString());
418 }
Jim Grosbach40411cc2011-03-22 18:19:42 +0000419 }
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000420
Davide Italianoaf08e1b2015-11-17 16:37:52 +0000421 // Resove all the relocations we can.
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000422 // FIXME: Error out if there are unresolved relocations.
Davide Italianoaf08e1b2015-11-17 16:37:52 +0000423 Dyld.resolveRelocations();
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000424
Jim Grosbachd35159a2011-04-13 15:38:30 +0000425 // Get the address of the entry point (_main by default).
Lang Hamesb1186032015-03-11 00:43:26 +0000426 void *MainAddress = Dyld.getSymbolLocalAddress(EntryPoint);
Craig Toppere6cb63e2014-04-25 04:24:47 +0000427 if (!MainAddress)
Jim Grosbachd35159a2011-04-13 15:38:30 +0000428 return Error("no definition for '" + EntryPoint + "'");
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000429
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000430 // Invalidate the instruction cache for each loaded function.
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000431 for (auto &FM : MemMgr.FunctionMemory) {
Davide Italianoaf08e1b2015-11-17 16:37:52 +0000432
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000433 // Make sure the memory is executable.
Davide Italianoaf08e1b2015-11-17 16:37:52 +0000434 // setExecutable will call InvalidateInstructionCache.
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000435 std::string ErrorStr;
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000436 if (!sys::Memory::setExecutable(FM, &ErrorStr))
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000437 return Error("unable to mark function executable: '" + ErrorStr + "'");
438 }
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000439
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000440 // Dispatch to _main().
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000441 errs() << "loaded '" << EntryPoint << "' at: " << (void*)MainAddress << "\n";
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000442
443 int (*Main)(int, const char**) =
444 (int(*)(int,const char**)) uintptr_t(MainAddress);
445 const char **Argv = new const char*[2];
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000446 // Use the name of the first input object module as argv[0] for the target.
447 Argv[0] = InputFileList[0].c_str();
Craig Toppere6cb63e2014-04-25 04:24:47 +0000448 Argv[1] = nullptr;
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000449 return Main(1, Argv);
450}
451
Lang Hamese1c11382014-06-27 20:20:57 +0000452static int checkAllExpressions(RuntimeDyldChecker &Checker) {
453 for (const auto& CheckerFileName : CheckFiles) {
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000454 ErrorOr<std::unique_ptr<MemoryBuffer>> CheckerFileBuf =
455 MemoryBuffer::getFileOrSTDIN(CheckerFileName);
456 if (std::error_code EC = CheckerFileBuf.getError())
Lang Hamese1c11382014-06-27 20:20:57 +0000457 return Error("unable to read input '" + CheckerFileName + "': " +
458 EC.message());
459
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000460 if (!Checker.checkAllRulesInBuffer("# rtdyld-check:",
461 CheckerFileBuf.get().get()))
Lang Hamese1c11382014-06-27 20:20:57 +0000462 return Error("some checks in '" + CheckerFileName + "' failed");
463 }
464 return 0;
465}
466
Benjamin Kramerf044d3f2015-03-09 16:23:46 +0000467static std::map<void *, uint64_t>
Lang Hames778ef5b2014-09-04 04:19:54 +0000468applySpecificSectionMappings(RuntimeDyldChecker &Checker) {
469
470 std::map<void*, uint64_t> SpecificMappings;
471
472 for (StringRef Mapping : SpecificSectionMappings) {
473
474 size_t EqualsIdx = Mapping.find_first_of("=");
Lang Hames78937c22015-07-04 01:35:26 +0000475 std::string SectionIDStr = Mapping.substr(0, EqualsIdx);
Lang Hames778ef5b2014-09-04 04:19:54 +0000476 size_t ComaIdx = Mapping.find_first_of(",");
477
Davide Italiano07557fc2015-11-21 02:15:51 +0000478 if (ComaIdx == StringRef::npos)
479 report_fatal_error("Invalid section specification '" + Mapping +
480 "'. Should be '<file name>,<section name>=<addr>'");
Lang Hames778ef5b2014-09-04 04:19:54 +0000481
Lang Hames78937c22015-07-04 01:35:26 +0000482 std::string FileName = SectionIDStr.substr(0, ComaIdx);
483 std::string SectionName = SectionIDStr.substr(ComaIdx + 1);
Lang Hames778ef5b2014-09-04 04:19:54 +0000484
485 uint64_t OldAddrInt;
486 std::string ErrorMsg;
487 std::tie(OldAddrInt, ErrorMsg) =
488 Checker.getSectionAddr(FileName, SectionName, true);
489
Davide Italiano07557fc2015-11-21 02:15:51 +0000490 if (ErrorMsg != "")
491 report_fatal_error(ErrorMsg);
Lang Hames778ef5b2014-09-04 04:19:54 +0000492
493 void* OldAddr = reinterpret_cast<void*>(static_cast<uintptr_t>(OldAddrInt));
494
Lang Hames78937c22015-07-04 01:35:26 +0000495 std::string NewAddrStr = Mapping.substr(EqualsIdx + 1);
Lang Hames778ef5b2014-09-04 04:19:54 +0000496 uint64_t NewAddr;
497
Davide Italiano07557fc2015-11-21 02:15:51 +0000498 if (StringRef(NewAddrStr).getAsInteger(0, NewAddr))
499 report_fatal_error("Invalid section address in mapping '" + Mapping +
500 "'.");
Lang Hames778ef5b2014-09-04 04:19:54 +0000501
502 Checker.getRTDyld().mapSectionAddress(OldAddr, NewAddr);
503 SpecificMappings[OldAddr] = NewAddr;
504 }
505
506 return SpecificMappings;
507}
508
Lang Hames9cb73532014-07-29 23:43:13 +0000509// Scatter sections in all directions!
510// Remaps section addresses for -verify mode. The following command line options
511// can be used to customize the layout of the memory within the phony target's
512// address space:
513// -target-addr-start <s> -- Specify where the phony target addres range starts.
514// -target-addr-end <e> -- Specify where the phony target address range ends.
515// -target-section-sep <d> -- Specify how big a gap should be left between the
516// end of one section and the start of the next.
517// Defaults to zero. Set to something big
518// (e.g. 1 << 32) to stress-test stubs, GOTs, etc.
519//
Lang Hames78937c22015-07-04 01:35:26 +0000520static void remapSectionsAndSymbols(const llvm::Triple &TargetTriple,
521 TrivialMemoryManager &MemMgr,
522 RuntimeDyldChecker &Checker) {
Lang Hames778ef5b2014-09-04 04:19:54 +0000523
524 // Set up a work list (section addr/size pairs).
525 typedef std::list<std::pair<void*, uint64_t>> WorklistT;
526 WorklistT Worklist;
527
528 for (const auto& CodeSection : MemMgr.FunctionMemory)
529 Worklist.push_back(std::make_pair(CodeSection.base(), CodeSection.size()));
530 for (const auto& DataSection : MemMgr.DataMemory)
531 Worklist.push_back(std::make_pair(DataSection.base(), DataSection.size()));
532
533 // Apply any section-specific mappings that were requested on the command
534 // line.
535 typedef std::map<void*, uint64_t> AppliedMappingsT;
536 AppliedMappingsT AppliedMappings = applySpecificSectionMappings(Checker);
537
538 // Keep an "already allocated" mapping of section target addresses to sizes.
539 // Sections whose address mappings aren't specified on the command line will
540 // allocated around the explicitly mapped sections while maintaining the
541 // minimum separation.
542 std::map<uint64_t, uint64_t> AlreadyAllocated;
543
544 // Move the previously applied mappings into the already-allocated map.
545 for (WorklistT::iterator I = Worklist.begin(), E = Worklist.end();
546 I != E;) {
547 WorklistT::iterator Tmp = I;
548 ++I;
549 AppliedMappingsT::iterator AI = AppliedMappings.find(Tmp->first);
550
551 if (AI != AppliedMappings.end()) {
552 AlreadyAllocated[AI->second] = Tmp->second;
553 Worklist.erase(Tmp);
554 }
555 }
Lang Hames9cb73532014-07-29 23:43:13 +0000556
557 // If the -target-addr-end option wasn't explicitly passed, then set it to a
558 // sensible default based on the target triple.
559 if (TargetAddrEnd.getNumOccurrences() == 0) {
560 if (TargetTriple.isArch16Bit())
561 TargetAddrEnd = (1ULL << 16) - 1;
562 else if (TargetTriple.isArch32Bit())
563 TargetAddrEnd = (1ULL << 32) - 1;
564 // TargetAddrEnd already has a sensible default for 64-bit systems, so
565 // there's nothing to do in the 64-bit case.
566 }
567
Lang Hames778ef5b2014-09-04 04:19:54 +0000568 // Process any elements remaining in the worklist.
569 while (!Worklist.empty()) {
570 std::pair<void*, uint64_t> CurEntry = Worklist.front();
571 Worklist.pop_front();
Lang Hames9cb73532014-07-29 23:43:13 +0000572
Lang Hames778ef5b2014-09-04 04:19:54 +0000573 uint64_t NextSectionAddr = TargetAddrStart;
574
575 for (const auto &Alloc : AlreadyAllocated)
576 if (NextSectionAddr + CurEntry.second + TargetSectionSep <= Alloc.first)
577 break;
578 else
579 NextSectionAddr = Alloc.first + Alloc.second + TargetSectionSep;
580
581 AlreadyAllocated[NextSectionAddr] = CurEntry.second;
582 Checker.getRTDyld().mapSectionAddress(CurEntry.first, NextSectionAddr);
Lang Hames9cb73532014-07-29 23:43:13 +0000583 }
584
Lang Hames78937c22015-07-04 01:35:26 +0000585 // Add dummy symbols to the memory manager.
586 for (const auto &Mapping : DummySymbolMappings) {
587 size_t EqualsIdx = Mapping.find_first_of("=");
588
Davide Italiano07557fc2015-11-21 02:15:51 +0000589 if (EqualsIdx == StringRef::npos)
590 report_fatal_error("Invalid dummy symbol specification '" + Mapping +
591 "'. Should be '<symbol name>=<addr>'");
Lang Hames78937c22015-07-04 01:35:26 +0000592
593 std::string Symbol = Mapping.substr(0, EqualsIdx);
594 std::string AddrStr = Mapping.substr(EqualsIdx + 1);
595
596 uint64_t Addr;
Davide Italiano07557fc2015-11-21 02:15:51 +0000597 if (StringRef(AddrStr).getAsInteger(0, Addr))
598 report_fatal_error("Invalid symbol mapping '" + Mapping + "'.");
Lang Hames78937c22015-07-04 01:35:26 +0000599
600 MemMgr.addDummySymbol(Symbol, Addr);
601 }
Lang Hames9cb73532014-07-29 23:43:13 +0000602}
603
604// Load and link the objects specified on the command line, but do not execute
605// anything. Instead, attach a RuntimeDyldChecker instance and call it to
606// verify the correctness of the linked memory.
Lang Hamese1c11382014-06-27 20:20:57 +0000607static int linkAndVerify() {
608
609 // Check for missing triple.
Davide Italiano78da7592015-11-21 05:44:41 +0000610 if (TripleName == "")
611 return Error("-triple required when running in -verify mode.");
Lang Hamese1c11382014-06-27 20:20:57 +0000612
613 // Look up the target and build the disassembler.
614 Triple TheTriple(Triple::normalize(TripleName));
615 std::string ErrorStr;
616 const Target *TheTarget =
617 TargetRegistry::lookupTarget("", TheTriple, ErrorStr);
Davide Italiano78da7592015-11-21 05:44:41 +0000618 if (!TheTarget)
619 return Error("Error accessing target '" + TripleName + "': " + ErrorStr);
620
Lang Hamese1c11382014-06-27 20:20:57 +0000621 TripleName = TheTriple.getTriple();
622
623 std::unique_ptr<MCSubtargetInfo> STI(
Petar Jovanovic280e5622015-06-23 22:52:19 +0000624 TheTarget->createMCSubtargetInfo(TripleName, MCPU, ""));
Davide Italianoebb27af2015-11-21 05:49:07 +0000625 if (!STI)
626 return Error("Unable to create subtarget info!");
Lang Hamese1c11382014-06-27 20:20:57 +0000627
628 std::unique_ptr<MCRegisterInfo> MRI(TheTarget->createMCRegInfo(TripleName));
Davide Italianoebb27af2015-11-21 05:49:07 +0000629 if (!MRI)
630 return Error("Unable to create target register info!");
Lang Hamese1c11382014-06-27 20:20:57 +0000631
632 std::unique_ptr<MCAsmInfo> MAI(TheTarget->createMCAsmInfo(*MRI, TripleName));
Davide Italianoebb27af2015-11-21 05:49:07 +0000633 if (!MAI)
634 return Error("Unable to create target asm info!");
Lang Hamese1c11382014-06-27 20:20:57 +0000635
636 MCContext Ctx(MAI.get(), MRI.get(), nullptr);
637
638 std::unique_ptr<MCDisassembler> Disassembler(
639 TheTarget->createMCDisassembler(*STI, Ctx));
Davide Italianoebb27af2015-11-21 05:49:07 +0000640 if (!Disassembler)
641 return Error("Unable to create disassembler!");
Lang Hamese1c11382014-06-27 20:20:57 +0000642
643 std::unique_ptr<MCInstrInfo> MII(TheTarget->createMCInstrInfo());
644
Daniel Sanders50f17232015-09-15 16:17:27 +0000645 std::unique_ptr<MCInstPrinter> InstPrinter(
646 TheTarget->createMCInstPrinter(Triple(TripleName), 0, *MAI, *MII, *MRI));
Lang Hamese1c11382014-06-27 20:20:57 +0000647
648 // Load any dylibs requested on the command line.
649 loadDylibs();
650
651 // Instantiate a dynamic linker.
652 TrivialMemoryManager MemMgr;
Davide Italianob59ea902015-10-21 22:12:03 +0000653 doPreallocation(MemMgr);
Lang Hames633fe142015-03-30 03:37:06 +0000654 RuntimeDyld Dyld(MemMgr, MemMgr);
Lang Hames925e51b2014-09-03 05:42:52 +0000655 Dyld.setProcessAllSections(true);
Lang Hamesf7acddd2014-07-22 22:47:39 +0000656 RuntimeDyldChecker Checker(Dyld, Disassembler.get(), InstPrinter.get(),
657 llvm::dbgs());
Lang Hamese1c11382014-06-27 20:20:57 +0000658
Lang Hamesc3246ad2015-04-15 21:18:41 +0000659 // FIXME: Preserve buffers until resolveRelocations time to work around a bug
660 // in RuntimeDyldELF.
661 // This fixme should be fixed ASAP. This is a very brittle workaround.
662 std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
663
Lang Hamese1c11382014-06-27 20:20:57 +0000664 // If we don't have any input files, read from stdin.
665 if (!InputFileList.size())
666 InputFileList.push_back("-");
Davide Italianod91bf8e2015-10-10 00:45:24 +0000667 for (auto &Filename : InputFileList) {
Lang Hamese1c11382014-06-27 20:20:57 +0000668 // Load the input memory buffer.
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000669 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
Davide Italianod91bf8e2015-10-10 00:45:24 +0000670 MemoryBuffer::getFileOrSTDIN(Filename);
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000671
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000672 if (std::error_code EC = InputBuffer.getError())
673 return Error("unable to read input: '" + EC.message() + "'");
Lang Hamese1c11382014-06-27 20:20:57 +0000674
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000675 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
676 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
677
678 if (std::error_code EC = MaybeObj.getError())
679 return Error("unable to create object file: '" + EC.message() + "'");
680
681 ObjectFile &Obj = **MaybeObj;
Lang Hamesc3246ad2015-04-15 21:18:41 +0000682 InputBuffers.push_back(std::move(*InputBuffer));
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000683
Lang Hamese1c11382014-06-27 20:20:57 +0000684 // Load the object file
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000685 Dyld.loadObject(Obj);
686 if (Dyld.hasError()) {
Lang Hamese1c11382014-06-27 20:20:57 +0000687 return Error(Dyld.getErrorString());
688 }
689 }
690
Lang Hames78937c22015-07-04 01:35:26 +0000691 // Re-map the section addresses into the phony target address space and add
692 // dummy symbols.
693 remapSectionsAndSymbols(TheTriple, MemMgr, Checker);
Lang Hames375385f2014-07-30 03:12:41 +0000694
Lang Hamese1c11382014-06-27 20:20:57 +0000695 // Resolve all the relocations we can.
696 Dyld.resolveRelocations();
697
Lang Hames925e51b2014-09-03 05:42:52 +0000698 // Register EH frames.
699 Dyld.registerEHFrames();
700
Lang Hamesae172682014-08-05 20:51:46 +0000701 int ErrorCode = checkAllExpressions(Checker);
Davide Italiano78da7592015-11-21 05:44:41 +0000702 if (Dyld.hasError())
703 return Error("RTDyld reported an error applying relocations:\n " +
704 Dyld.getErrorString());
Lang Hamesae172682014-08-05 20:51:46 +0000705
706 return ErrorCode;
Lang Hamese1c11382014-06-27 20:20:57 +0000707}
708
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000709int main(int argc, char **argv) {
Alp Toker9f679322013-11-05 09:33:43 +0000710 sys::PrintStackTraceOnErrorSignal();
711 PrettyStackTraceProgram X(argc, argv);
712
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000713 ProgramName = argv[0];
714 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
715
Lang Hamese1c11382014-06-27 20:20:57 +0000716 llvm::InitializeAllTargetInfos();
717 llvm::InitializeAllTargetMCs();
718 llvm::InitializeAllDisassemblers();
719
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000720 cl::ParseCommandLineOptions(argc, argv, "llvm MC-JIT tool\n");
721
722 switch (Action) {
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000723 case AC_Execute:
Jim Grosbach4d5284b2011-03-18 17:24:21 +0000724 return executeInput();
Keno Fischerc780e8e2015-05-21 21:24:32 +0000725 case AC_PrintDebugLineInfo:
Keno Fischer281b6942015-05-30 19:44:53 +0000726 return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */ true);
Andrew Kaylord55d7012013-01-25 22:50:58 +0000727 case AC_PrintLineInfo:
Keno Fischer281b6942015-05-30 19:44:53 +0000728 return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */false);
729 case AC_PrintObjectLineInfo:
730 return printLineInfoForInput(/* LoadObjects */false,/* UseDebugObj */false);
Lang Hamese1c11382014-06-27 20:20:57 +0000731 case AC_Verify:
732 return linkAndVerify();
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000733 }
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000734}