blob: d35d0c60a6f37e729f17b38ff69fb5f2d96192f8 [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"
Benjamin Kramerf57c1972016-01-26 16:44:37 +000022#include "llvm/MC/MCDisassembler/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) {
Rui Ueyamada00f2f2016-01-14 21:06:47 +0000194 Size = alignTo(Size, Alignment);
Davide Italianob59ea902015-10-21 22:12:03 +0000195 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
Lang Hames9e964f32016-03-25 17:25:34 +0000257static int ErrorAndExit(const Twine &Msg) {
Davide Italianoc2e910d2015-11-20 23:12:15 +0000258 errs() << ProgramName << ": error: " << Msg << "\n";
Lang Hames9e964f32016-03-25 17:25:34 +0000259 exit(1);
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000260}
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())
Lang Hames9e964f32016-03-25 17:25:34 +0000293 ErrorAndExit("unable to read input: '" + EC.message() + "'");
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000294
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())
Lang Hames9e964f32016-03-25 17:25:34 +0000299 ErrorAndExit("unable to create object file: '" + EC.message() + "'");
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000300
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())
Lang Hames9e964f32016-03-25 17:25:34 +0000312 ErrorAndExit(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;
Kevin Enderby5afbc1c2016-03-23 20:27:00 +0000333 ErrorOr<SymbolRef::Type> TypeOrErr = Sym.getType();
334 if (!TypeOrErr)
335 continue;
336 SymbolRef::Type Type = *TypeOrErr;
337 if (Type == object::SymbolRef::ST_Function) {
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000338 ErrorOr<StringRef> Name = Sym.getName();
339 if (!Name)
Rafael Espindolada176272015-05-31 22:13:51 +0000340 continue;
Rafael Espindolaed067c42015-07-03 18:19:00 +0000341 ErrorOr<uint64_t> AddrOrErr = Sym.getAddress();
342 if (!AddrOrErr)
Rafael Espindolada176272015-05-31 22:13:51 +0000343 continue;
Rafael Espindolaed067c42015-07-03 18:19:00 +0000344 uint64_t Addr = *AddrOrErr;
Rafael Espindolaa82ce1d2015-05-31 23:15:35 +0000345
Rafael Espindolab109c032015-06-23 02:08:48 +0000346 uint64_t Size = P.second;
Keno Fischerc780e8e2015-05-21 21:24:32 +0000347 // If we're not using the debug object, compute the address of the
348 // symbol in memory (rather than that in the unrelocated object file)
349 // and use that to query the DWARFContext.
350 if (!UseDebugObj && LoadObjects) {
Rafael Espindola8bab8892015-08-07 23:27:14 +0000351 object::section_iterator Sec = *Sym.getSection();
Keno Fischerc780e8e2015-05-21 21:24:32 +0000352 StringRef SecName;
353 Sec->getName(SecName);
354 uint64_t SectionLoadAddress =
Lang Hames2e88f4f2015-07-28 17:52:11 +0000355 LoadedObjInfo->getSectionLoadAddress(*Sec);
Keno Fischerc780e8e2015-05-21 21:24:32 +0000356 if (SectionLoadAddress != 0)
357 Addr += SectionLoadAddress - Sec->getAddress();
358 }
359
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000360 outs() << "Function: " << *Name << ", Size = " << Size
361 << ", Addr = " << Addr << "\n";
Andrew Kaylord55d7012013-01-25 22:50:58 +0000362
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000363 DILineInfoTable Lines = Context->getLineInfoForAddressRange(Addr, Size);
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000364 for (auto &D : Lines) {
365 outs() << " Line info @ " << D.first - Addr << ": "
366 << D.second.FileName << ", line:" << D.second.Line << "\n";
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000367 }
Andrew Kaylord55d7012013-01-25 22:50:58 +0000368 }
369 }
370 }
371
372 return 0;
373}
374
Davide Italianob59ea902015-10-21 22:12:03 +0000375static void doPreallocation(TrivialMemoryManager &MemMgr) {
376 // Allocate a slab of memory upfront, if required. This is used if
377 // we want to test small code models.
378 if (static_cast<intptr_t>(PreallocMemory) < 0)
379 report_fatal_error("Pre-allocated bytes of memory must be a positive integer.");
380
381 // FIXME: Limit the amount of memory that can be preallocated?
382 if (PreallocMemory != 0)
383 MemMgr.preallocateSlab(PreallocMemory);
384}
385
Jim Grosbach4d5284b2011-03-18 17:24:21 +0000386static int executeInput() {
Lang Hamesd311c0e2014-05-13 22:37:41 +0000387 // Load any dylibs requested on the command line.
388 loadDylibs();
389
Jim Grosbachf016b0a2011-03-21 22:15:52 +0000390 // Instantiate a dynamic linker.
Benjamin Kramer9ce77082013-08-03 22:16:31 +0000391 TrivialMemoryManager MemMgr;
Davide Italianob59ea902015-10-21 22:12:03 +0000392 doPreallocation(MemMgr);
Lang Hames633fe142015-03-30 03:37:06 +0000393 RuntimeDyld Dyld(MemMgr, MemMgr);
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000394
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000395 // If we don't have any input files, read from stdin.
396 if (!InputFileList.size())
397 InputFileList.push_back("-");
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000398 for (auto &File : InputFileList) {
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000399 // Load the input memory buffer.
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000400 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000401 MemoryBuffer::getFileOrSTDIN(File);
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000402 if (std::error_code EC = InputBuffer.getError())
Lang Hames9e964f32016-03-25 17:25:34 +0000403 ErrorAndExit("unable to read input: '" + EC.message() + "'");
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000404 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
405 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
406
407 if (std::error_code EC = MaybeObj.getError())
Lang Hames9e964f32016-03-25 17:25:34 +0000408 ErrorAndExit("unable to create object file: '" + EC.message() + "'");
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000409
410 ObjectFile &Obj = **MaybeObj;
411
Andrew Kayloradc70562012-10-02 21:18:39 +0000412 // Load the object file
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000413 Dyld.loadObject(Obj);
414 if (Dyld.hasError()) {
Lang Hames9e964f32016-03-25 17:25:34 +0000415 ErrorAndExit(Dyld.getErrorString());
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000416 }
Jim Grosbach40411cc2011-03-22 18:19:42 +0000417 }
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000418
Davide Italianoaf08e1b2015-11-17 16:37:52 +0000419 // Resove all the relocations we can.
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000420 // FIXME: Error out if there are unresolved relocations.
Davide Italianoaf08e1b2015-11-17 16:37:52 +0000421 Dyld.resolveRelocations();
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000422
Jim Grosbachd35159a2011-04-13 15:38:30 +0000423 // Get the address of the entry point (_main by default).
Lang Hamesb1186032015-03-11 00:43:26 +0000424 void *MainAddress = Dyld.getSymbolLocalAddress(EntryPoint);
Craig Toppere6cb63e2014-04-25 04:24:47 +0000425 if (!MainAddress)
Lang Hames9e964f32016-03-25 17:25:34 +0000426 ErrorAndExit("no definition for '" + EntryPoint + "'");
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000427
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000428 // Invalidate the instruction cache for each loaded function.
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000429 for (auto &FM : MemMgr.FunctionMemory) {
Davide Italianoaf08e1b2015-11-17 16:37:52 +0000430
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000431 // Make sure the memory is executable.
Davide Italianoaf08e1b2015-11-17 16:37:52 +0000432 // setExecutable will call InvalidateInstructionCache.
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000433 std::string ErrorStr;
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000434 if (!sys::Memory::setExecutable(FM, &ErrorStr))
Lang Hames9e964f32016-03-25 17:25:34 +0000435 ErrorAndExit("unable to mark function executable: '" + ErrorStr + "'");
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000436 }
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000437
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000438 // Dispatch to _main().
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000439 errs() << "loaded '" << EntryPoint << "' at: " << (void*)MainAddress << "\n";
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000440
441 int (*Main)(int, const char**) =
442 (int(*)(int,const char**)) uintptr_t(MainAddress);
443 const char **Argv = new const char*[2];
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000444 // Use the name of the first input object module as argv[0] for the target.
445 Argv[0] = InputFileList[0].c_str();
Craig Toppere6cb63e2014-04-25 04:24:47 +0000446 Argv[1] = nullptr;
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000447 return Main(1, Argv);
448}
449
Lang Hamese1c11382014-06-27 20:20:57 +0000450static int checkAllExpressions(RuntimeDyldChecker &Checker) {
451 for (const auto& CheckerFileName : CheckFiles) {
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000452 ErrorOr<std::unique_ptr<MemoryBuffer>> CheckerFileBuf =
453 MemoryBuffer::getFileOrSTDIN(CheckerFileName);
454 if (std::error_code EC = CheckerFileBuf.getError())
Lang Hames9e964f32016-03-25 17:25:34 +0000455 ErrorAndExit("unable to read input '" + CheckerFileName + "': " +
Lang Hamese1c11382014-06-27 20:20:57 +0000456 EC.message());
457
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000458 if (!Checker.checkAllRulesInBuffer("# rtdyld-check:",
459 CheckerFileBuf.get().get()))
Lang Hames9e964f32016-03-25 17:25:34 +0000460 ErrorAndExit("some checks in '" + CheckerFileName + "' failed");
Lang Hamese1c11382014-06-27 20:20:57 +0000461 }
462 return 0;
463}
464
Benjamin Kramerf044d3f2015-03-09 16:23:46 +0000465static std::map<void *, uint64_t>
Lang Hames778ef5b2014-09-04 04:19:54 +0000466applySpecificSectionMappings(RuntimeDyldChecker &Checker) {
467
468 std::map<void*, uint64_t> SpecificMappings;
469
470 for (StringRef Mapping : SpecificSectionMappings) {
471
472 size_t EqualsIdx = Mapping.find_first_of("=");
Lang Hames78937c22015-07-04 01:35:26 +0000473 std::string SectionIDStr = Mapping.substr(0, EqualsIdx);
Lang Hames778ef5b2014-09-04 04:19:54 +0000474 size_t ComaIdx = Mapping.find_first_of(",");
475
Davide Italiano07557fc2015-11-21 02:15:51 +0000476 if (ComaIdx == StringRef::npos)
477 report_fatal_error("Invalid section specification '" + Mapping +
478 "'. Should be '<file name>,<section name>=<addr>'");
Lang Hames778ef5b2014-09-04 04:19:54 +0000479
Lang Hames78937c22015-07-04 01:35:26 +0000480 std::string FileName = SectionIDStr.substr(0, ComaIdx);
481 std::string SectionName = SectionIDStr.substr(ComaIdx + 1);
Lang Hames778ef5b2014-09-04 04:19:54 +0000482
483 uint64_t OldAddrInt;
484 std::string ErrorMsg;
485 std::tie(OldAddrInt, ErrorMsg) =
486 Checker.getSectionAddr(FileName, SectionName, true);
487
Davide Italiano07557fc2015-11-21 02:15:51 +0000488 if (ErrorMsg != "")
489 report_fatal_error(ErrorMsg);
Lang Hames778ef5b2014-09-04 04:19:54 +0000490
491 void* OldAddr = reinterpret_cast<void*>(static_cast<uintptr_t>(OldAddrInt));
492
Lang Hames78937c22015-07-04 01:35:26 +0000493 std::string NewAddrStr = Mapping.substr(EqualsIdx + 1);
Lang Hames778ef5b2014-09-04 04:19:54 +0000494 uint64_t NewAddr;
495
Davide Italiano07557fc2015-11-21 02:15:51 +0000496 if (StringRef(NewAddrStr).getAsInteger(0, NewAddr))
497 report_fatal_error("Invalid section address in mapping '" + Mapping +
498 "'.");
Lang Hames778ef5b2014-09-04 04:19:54 +0000499
500 Checker.getRTDyld().mapSectionAddress(OldAddr, NewAddr);
501 SpecificMappings[OldAddr] = NewAddr;
502 }
503
504 return SpecificMappings;
505}
506
Lang Hames9cb73532014-07-29 23:43:13 +0000507// Scatter sections in all directions!
508// Remaps section addresses for -verify mode. The following command line options
509// can be used to customize the layout of the memory within the phony target's
510// address space:
511// -target-addr-start <s> -- Specify where the phony target addres range starts.
512// -target-addr-end <e> -- Specify where the phony target address range ends.
513// -target-section-sep <d> -- Specify how big a gap should be left between the
514// end of one section and the start of the next.
515// Defaults to zero. Set to something big
516// (e.g. 1 << 32) to stress-test stubs, GOTs, etc.
517//
Lang Hames78937c22015-07-04 01:35:26 +0000518static void remapSectionsAndSymbols(const llvm::Triple &TargetTriple,
519 TrivialMemoryManager &MemMgr,
520 RuntimeDyldChecker &Checker) {
Lang Hames778ef5b2014-09-04 04:19:54 +0000521
522 // Set up a work list (section addr/size pairs).
523 typedef std::list<std::pair<void*, uint64_t>> WorklistT;
524 WorklistT Worklist;
525
526 for (const auto& CodeSection : MemMgr.FunctionMemory)
527 Worklist.push_back(std::make_pair(CodeSection.base(), CodeSection.size()));
528 for (const auto& DataSection : MemMgr.DataMemory)
529 Worklist.push_back(std::make_pair(DataSection.base(), DataSection.size()));
530
531 // Apply any section-specific mappings that were requested on the command
532 // line.
533 typedef std::map<void*, uint64_t> AppliedMappingsT;
534 AppliedMappingsT AppliedMappings = applySpecificSectionMappings(Checker);
535
536 // Keep an "already allocated" mapping of section target addresses to sizes.
537 // Sections whose address mappings aren't specified on the command line will
538 // allocated around the explicitly mapped sections while maintaining the
539 // minimum separation.
540 std::map<uint64_t, uint64_t> AlreadyAllocated;
541
542 // Move the previously applied mappings into the already-allocated map.
543 for (WorklistT::iterator I = Worklist.begin(), E = Worklist.end();
544 I != E;) {
545 WorklistT::iterator Tmp = I;
546 ++I;
547 AppliedMappingsT::iterator AI = AppliedMappings.find(Tmp->first);
548
549 if (AI != AppliedMappings.end()) {
550 AlreadyAllocated[AI->second] = Tmp->second;
551 Worklist.erase(Tmp);
552 }
553 }
Lang Hames9cb73532014-07-29 23:43:13 +0000554
555 // If the -target-addr-end option wasn't explicitly passed, then set it to a
556 // sensible default based on the target triple.
557 if (TargetAddrEnd.getNumOccurrences() == 0) {
558 if (TargetTriple.isArch16Bit())
559 TargetAddrEnd = (1ULL << 16) - 1;
560 else if (TargetTriple.isArch32Bit())
561 TargetAddrEnd = (1ULL << 32) - 1;
562 // TargetAddrEnd already has a sensible default for 64-bit systems, so
563 // there's nothing to do in the 64-bit case.
564 }
565
Lang Hames778ef5b2014-09-04 04:19:54 +0000566 // Process any elements remaining in the worklist.
567 while (!Worklist.empty()) {
568 std::pair<void*, uint64_t> CurEntry = Worklist.front();
569 Worklist.pop_front();
Lang Hames9cb73532014-07-29 23:43:13 +0000570
Lang Hames778ef5b2014-09-04 04:19:54 +0000571 uint64_t NextSectionAddr = TargetAddrStart;
572
573 for (const auto &Alloc : AlreadyAllocated)
574 if (NextSectionAddr + CurEntry.second + TargetSectionSep <= Alloc.first)
575 break;
576 else
577 NextSectionAddr = Alloc.first + Alloc.second + TargetSectionSep;
578
579 AlreadyAllocated[NextSectionAddr] = CurEntry.second;
580 Checker.getRTDyld().mapSectionAddress(CurEntry.first, NextSectionAddr);
Lang Hames9cb73532014-07-29 23:43:13 +0000581 }
582
Lang Hames78937c22015-07-04 01:35:26 +0000583 // Add dummy symbols to the memory manager.
584 for (const auto &Mapping : DummySymbolMappings) {
585 size_t EqualsIdx = Mapping.find_first_of("=");
586
Davide Italiano07557fc2015-11-21 02:15:51 +0000587 if (EqualsIdx == StringRef::npos)
588 report_fatal_error("Invalid dummy symbol specification '" + Mapping +
589 "'. Should be '<symbol name>=<addr>'");
Lang Hames78937c22015-07-04 01:35:26 +0000590
591 std::string Symbol = Mapping.substr(0, EqualsIdx);
592 std::string AddrStr = Mapping.substr(EqualsIdx + 1);
593
594 uint64_t Addr;
Davide Italiano07557fc2015-11-21 02:15:51 +0000595 if (StringRef(AddrStr).getAsInteger(0, Addr))
596 report_fatal_error("Invalid symbol mapping '" + Mapping + "'.");
Lang Hames78937c22015-07-04 01:35:26 +0000597
598 MemMgr.addDummySymbol(Symbol, Addr);
599 }
Lang Hames9cb73532014-07-29 23:43:13 +0000600}
601
602// Load and link the objects specified on the command line, but do not execute
603// anything. Instead, attach a RuntimeDyldChecker instance and call it to
604// verify the correctness of the linked memory.
Lang Hamese1c11382014-06-27 20:20:57 +0000605static int linkAndVerify() {
606
607 // Check for missing triple.
Davide Italiano78da7592015-11-21 05:44:41 +0000608 if (TripleName == "")
Lang Hames9e964f32016-03-25 17:25:34 +0000609 ErrorAndExit("-triple required when running in -verify mode.");
Lang Hamese1c11382014-06-27 20:20:57 +0000610
611 // Look up the target and build the disassembler.
612 Triple TheTriple(Triple::normalize(TripleName));
613 std::string ErrorStr;
614 const Target *TheTarget =
615 TargetRegistry::lookupTarget("", TheTriple, ErrorStr);
Davide Italiano78da7592015-11-21 05:44:41 +0000616 if (!TheTarget)
Lang Hames9e964f32016-03-25 17:25:34 +0000617 ErrorAndExit("Error accessing target '" + TripleName + "': " + ErrorStr);
Davide Italiano78da7592015-11-21 05:44:41 +0000618
Lang Hamese1c11382014-06-27 20:20:57 +0000619 TripleName = TheTriple.getTriple();
620
621 std::unique_ptr<MCSubtargetInfo> STI(
Petar Jovanovic280e5622015-06-23 22:52:19 +0000622 TheTarget->createMCSubtargetInfo(TripleName, MCPU, ""));
Davide Italianoebb27af2015-11-21 05:49:07 +0000623 if (!STI)
Lang Hames9e964f32016-03-25 17:25:34 +0000624 ErrorAndExit("Unable to create subtarget info!");
Lang Hamese1c11382014-06-27 20:20:57 +0000625
626 std::unique_ptr<MCRegisterInfo> MRI(TheTarget->createMCRegInfo(TripleName));
Davide Italianoebb27af2015-11-21 05:49:07 +0000627 if (!MRI)
Lang Hames9e964f32016-03-25 17:25:34 +0000628 ErrorAndExit("Unable to create target register info!");
Lang Hamese1c11382014-06-27 20:20:57 +0000629
630 std::unique_ptr<MCAsmInfo> MAI(TheTarget->createMCAsmInfo(*MRI, TripleName));
Davide Italianoebb27af2015-11-21 05:49:07 +0000631 if (!MAI)
Lang Hames9e964f32016-03-25 17:25:34 +0000632 ErrorAndExit("Unable to create target asm info!");
Lang Hamese1c11382014-06-27 20:20:57 +0000633
634 MCContext Ctx(MAI.get(), MRI.get(), nullptr);
635
636 std::unique_ptr<MCDisassembler> Disassembler(
637 TheTarget->createMCDisassembler(*STI, Ctx));
Davide Italianoebb27af2015-11-21 05:49:07 +0000638 if (!Disassembler)
Lang Hames9e964f32016-03-25 17:25:34 +0000639 ErrorAndExit("Unable to create disassembler!");
Lang Hamese1c11382014-06-27 20:20:57 +0000640
641 std::unique_ptr<MCInstrInfo> MII(TheTarget->createMCInstrInfo());
642
Daniel Sanders50f17232015-09-15 16:17:27 +0000643 std::unique_ptr<MCInstPrinter> InstPrinter(
644 TheTarget->createMCInstPrinter(Triple(TripleName), 0, *MAI, *MII, *MRI));
Lang Hamese1c11382014-06-27 20:20:57 +0000645
646 // Load any dylibs requested on the command line.
647 loadDylibs();
648
649 // Instantiate a dynamic linker.
650 TrivialMemoryManager MemMgr;
Davide Italianob59ea902015-10-21 22:12:03 +0000651 doPreallocation(MemMgr);
Lang Hames633fe142015-03-30 03:37:06 +0000652 RuntimeDyld Dyld(MemMgr, MemMgr);
Lang Hames925e51b2014-09-03 05:42:52 +0000653 Dyld.setProcessAllSections(true);
Lang Hamesf7acddd2014-07-22 22:47:39 +0000654 RuntimeDyldChecker Checker(Dyld, Disassembler.get(), InstPrinter.get(),
655 llvm::dbgs());
Lang Hamese1c11382014-06-27 20:20:57 +0000656
657 // If we don't have any input files, read from stdin.
658 if (!InputFileList.size())
659 InputFileList.push_back("-");
Davide Italianod91bf8e2015-10-10 00:45:24 +0000660 for (auto &Filename : InputFileList) {
Lang Hamese1c11382014-06-27 20:20:57 +0000661 // Load the input memory buffer.
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000662 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
Davide Italianod91bf8e2015-10-10 00:45:24 +0000663 MemoryBuffer::getFileOrSTDIN(Filename);
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000664
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000665 if (std::error_code EC = InputBuffer.getError())
Lang Hames9e964f32016-03-25 17:25:34 +0000666 ErrorAndExit("unable to read input: '" + EC.message() + "'");
Lang Hamese1c11382014-06-27 20:20:57 +0000667
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000668 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
669 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
670
671 if (std::error_code EC = MaybeObj.getError())
Lang Hames9e964f32016-03-25 17:25:34 +0000672 ErrorAndExit("unable to create object file: '" + EC.message() + "'");
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000673
674 ObjectFile &Obj = **MaybeObj;
675
Lang Hamese1c11382014-06-27 20:20:57 +0000676 // Load the object file
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000677 Dyld.loadObject(Obj);
678 if (Dyld.hasError()) {
Lang Hames9e964f32016-03-25 17:25:34 +0000679 ErrorAndExit(Dyld.getErrorString());
Lang Hamese1c11382014-06-27 20:20:57 +0000680 }
681 }
682
Lang Hames78937c22015-07-04 01:35:26 +0000683 // Re-map the section addresses into the phony target address space and add
684 // dummy symbols.
685 remapSectionsAndSymbols(TheTriple, MemMgr, Checker);
Lang Hames375385f2014-07-30 03:12:41 +0000686
Lang Hamese1c11382014-06-27 20:20:57 +0000687 // Resolve all the relocations we can.
688 Dyld.resolveRelocations();
689
Lang Hames925e51b2014-09-03 05:42:52 +0000690 // Register EH frames.
691 Dyld.registerEHFrames();
692
Lang Hamesae172682014-08-05 20:51:46 +0000693 int ErrorCode = checkAllExpressions(Checker);
Davide Italiano78da7592015-11-21 05:44:41 +0000694 if (Dyld.hasError())
Lang Hames9e964f32016-03-25 17:25:34 +0000695 ErrorAndExit("RTDyld reported an error applying relocations:\n " +
Davide Italiano78da7592015-11-21 05:44:41 +0000696 Dyld.getErrorString());
Lang Hamesae172682014-08-05 20:51:46 +0000697
698 return ErrorCode;
Lang Hamese1c11382014-06-27 20:20:57 +0000699}
700
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000701int main(int argc, char **argv) {
Alp Toker9f679322013-11-05 09:33:43 +0000702 sys::PrintStackTraceOnErrorSignal();
703 PrettyStackTraceProgram X(argc, argv);
704
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000705 ProgramName = argv[0];
706 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
707
Lang Hamese1c11382014-06-27 20:20:57 +0000708 llvm::InitializeAllTargetInfos();
709 llvm::InitializeAllTargetMCs();
710 llvm::InitializeAllDisassemblers();
711
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000712 cl::ParseCommandLineOptions(argc, argv, "llvm MC-JIT tool\n");
713
714 switch (Action) {
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000715 case AC_Execute:
Jim Grosbach4d5284b2011-03-18 17:24:21 +0000716 return executeInput();
Keno Fischerc780e8e2015-05-21 21:24:32 +0000717 case AC_PrintDebugLineInfo:
Keno Fischer281b6942015-05-30 19:44:53 +0000718 return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */ true);
Andrew Kaylord55d7012013-01-25 22:50:58 +0000719 case AC_PrintLineInfo:
Keno Fischer281b6942015-05-30 19:44:53 +0000720 return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */false);
721 case AC_PrintObjectLineInfo:
722 return printLineInfoForInput(/* LoadObjects */false,/* UseDebugObj */false);
Lang Hamese1c11382014-06-27 20:20:57 +0000723 case AC_Verify:
724 return linkAndVerify();
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000725 }
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000726}