blob: 689fb101f9ce45bb3e71201e7581da9f689ef90e [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
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000135/* *** */
136
Jim Grosbach2dcef0502011-04-04 23:04:39 +0000137// A trivial memory manager that doesn't do anything fancy, just uses the
138// support library allocation routines directly.
139class TrivialMemoryManager : public RTDyldMemoryManager {
140public:
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000141 SmallVector<sys::MemoryBlock, 16> FunctionMemory;
Jim Grosbacheff0a402012-01-16 22:26:39 +0000142 SmallVector<sys::MemoryBlock, 16> DataMemory;
143
144 uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
Craig Toppere56917c2014-03-08 08:27:28 +0000145 unsigned SectionID,
146 StringRef SectionName) override;
Jim Grosbacheff0a402012-01-16 22:26:39 +0000147 uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
Filip Pizlo7aa695e02013-10-02 00:59:25 +0000148 unsigned SectionID, StringRef SectionName,
Craig Toppere56917c2014-03-08 08:27:28 +0000149 bool IsReadOnly) override;
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000150
Craig Toppere56917c2014-03-08 08:27:28 +0000151 void *getPointerToNamedFunction(const std::string &Name,
152 bool AbortOnFailure = true) override {
Craig Toppere6cb63e2014-04-25 04:24:47 +0000153 return nullptr;
Danil Malyshevbfee5422012-03-28 21:46:36 +0000154 }
155
Craig Toppere56917c2014-03-08 08:27:28 +0000156 bool finalizeMemory(std::string *ErrMsg) override { return false; }
Andrew Kaylora342cb92012-11-15 23:50:01 +0000157
Lang Hames78937c22015-07-04 01:35:26 +0000158 void addDummySymbol(const std::string &Name, uint64_t Addr) {
159 DummyExterns[Name] = Addr;
160 }
161
162 RuntimeDyld::SymbolInfo findSymbol(const std::string &Name) override {
163 auto I = DummyExterns.find(Name);
164
165 if (I != DummyExterns.end())
166 return RuntimeDyld::SymbolInfo(I->second, JITSymbolFlags::Exported);
167
168 return RTDyldMemoryManager::findSymbol(Name);
169 }
170
Tim Northover5af339a2015-06-03 18:26:52 +0000171 void registerEHFrames(uint8_t *Addr, uint64_t LoadAddr,
172 size_t Size) override {}
173 void deregisterEHFrames(uint8_t *Addr, uint64_t LoadAddr,
174 size_t Size) override {}
Davide Italianob59ea902015-10-21 22:12:03 +0000175
176 void preallocateSlab(uint64_t Size) {
177 std::string Err;
178 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, &Err);
179 if (!MB.base())
180 report_fatal_error("Can't allocate enough memory: " + Err);
181
182 PreallocSlab = MB;
183 UsePreallocation = true;
184 SlabSize = Size;
185 }
186
187 uint8_t *allocateFromSlab(uintptr_t Size, unsigned Alignment, bool isCode) {
188 Size = RoundUpToAlignment(Size, Alignment);
189 if (CurrentSlabOffset + Size > SlabSize)
190 report_fatal_error("Can't allocate enough memory. Tune --preallocate");
191
192 uintptr_t OldSlabOffset = CurrentSlabOffset;
193 sys::MemoryBlock MB((void *)OldSlabOffset, Size);
194 if (isCode)
195 FunctionMemory.push_back(MB);
196 else
197 DataMemory.push_back(MB);
198 CurrentSlabOffset += Size;
199 return (uint8_t*)OldSlabOffset;
200 }
201
Lang Hames78937c22015-07-04 01:35:26 +0000202private:
203 std::map<std::string, uint64_t> DummyExterns;
Davide Italianob59ea902015-10-21 22:12:03 +0000204 sys::MemoryBlock PreallocSlab;
205 bool UsePreallocation = false;
206 uintptr_t SlabSize = 0;
207 uintptr_t CurrentSlabOffset = 0;
Jim Grosbach2dcef0502011-04-04 23:04:39 +0000208};
209
Jim Grosbacheff0a402012-01-16 22:26:39 +0000210uint8_t *TrivialMemoryManager::allocateCodeSection(uintptr_t Size,
211 unsigned Alignment,
Filip Pizlo7aa695e02013-10-02 00:59:25 +0000212 unsigned SectionID,
213 StringRef SectionName) {
Davide Italianob59ea902015-10-21 22:12:03 +0000214 if (UsePreallocation)
215 return allocateFromSlab(Size, Alignment, true /* isCode */);
216
Davide Italiano89151a02015-10-15 00:05:32 +0000217 std::string Err;
218 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, &Err);
219 if (!MB.base())
220 report_fatal_error("MemoryManager allocation failed: " + Err);
Danil Malyshev8c17fbd2012-05-16 18:50:11 +0000221 FunctionMemory.push_back(MB);
222 return (uint8_t*)MB.base();
Jim Grosbacheff0a402012-01-16 22:26:39 +0000223}
224
225uint8_t *TrivialMemoryManager::allocateDataSection(uintptr_t Size,
226 unsigned Alignment,
Andrew Kaylora342cb92012-11-15 23:50:01 +0000227 unsigned SectionID,
Filip Pizlo7aa695e02013-10-02 00:59:25 +0000228 StringRef SectionName,
Andrew Kaylora342cb92012-11-15 23:50:01 +0000229 bool IsReadOnly) {
Davide Italianob59ea902015-10-21 22:12:03 +0000230 if (UsePreallocation)
231 return allocateFromSlab(Size, Alignment, false /* isCode */);
232
Davide Italiano89151a02015-10-15 00:05:32 +0000233 std::string Err;
234 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, &Err);
235 if (!MB.base())
236 report_fatal_error("MemoryManager allocation failed: " + Err);
Danil Malyshev8c17fbd2012-05-16 18:50:11 +0000237 DataMemory.push_back(MB);
238 return (uint8_t*)MB.base();
239}
240
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000241static const char *ProgramName;
242
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000243static int Error(const Twine &Msg) {
Davide Italianoc2e910d2015-11-20 23:12:15 +0000244 errs() << ProgramName << ": error: " << Msg << "\n";
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000245 return 1;
246}
247
Lang Hamesd311c0e2014-05-13 22:37:41 +0000248static void loadDylibs() {
249 for (const std::string &Dylib : Dylibs) {
250 if (sys::fs::is_regular_file(Dylib)) {
251 std::string ErrMsg;
252 if (sys::DynamicLibrary::LoadLibraryPermanently(Dylib.c_str(), &ErrMsg))
253 llvm::errs() << "Error loading '" << Dylib << "': "
254 << ErrMsg << "\n";
255 } else
256 llvm::errs() << "Dylib not found: '" << Dylib << "'.\n";
257 }
258}
259
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000260/* *** */
261
Keno Fischerc780e8e2015-05-21 21:24:32 +0000262static int printLineInfoForInput(bool LoadObjects, bool UseDebugObj) {
263 assert(LoadObjects || !UseDebugObj);
264
Lang Hamesd311c0e2014-05-13 22:37:41 +0000265 // Load any dylibs requested on the command line.
266 loadDylibs();
267
Andrew Kaylord55d7012013-01-25 22:50:58 +0000268 // If we don't have any input files, read from stdin.
269 if (!InputFileList.size())
270 InputFileList.push_back("-");
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000271 for (auto &File : InputFileList) {
Andrew Kaylord55d7012013-01-25 22:50:58 +0000272 // Instantiate a dynamic linker.
Benjamin Kramer9ce77082013-08-03 22:16:31 +0000273 TrivialMemoryManager MemMgr;
Lang Hames633fe142015-03-30 03:37:06 +0000274 RuntimeDyld Dyld(MemMgr, MemMgr);
Andrew Kaylord55d7012013-01-25 22:50:58 +0000275
276 // Load the input memory buffer.
Andrew Kaylord55d7012013-01-25 22:50:58 +0000277
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000278 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000279 MemoryBuffer::getFileOrSTDIN(File);
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000280 if (std::error_code EC = InputBuffer.getError())
281 return Error("unable to read input: '" + EC.message() + "'");
282
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000283 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
284 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
285
286 if (std::error_code EC = MaybeObj.getError())
287 return Error("unable to create object file: '" + EC.message() + "'");
288
289 ObjectFile &Obj = **MaybeObj;
290
Keno Fischerc780e8e2015-05-21 21:24:32 +0000291 OwningBinary<ObjectFile> DebugObj;
292 std::unique_ptr<RuntimeDyld::LoadedObjectInfo> LoadedObjInfo = nullptr;
293 ObjectFile *SymbolObj = &Obj;
294 if (LoadObjects) {
295 // Load the object file
296 LoadedObjInfo =
297 Dyld.loadObject(Obj);
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000298
Keno Fischerc780e8e2015-05-21 21:24:32 +0000299 if (Dyld.hasError())
300 return Error(Dyld.getErrorString());
Andrew Kaylord55d7012013-01-25 22:50:58 +0000301
Keno Fischerc780e8e2015-05-21 21:24:32 +0000302 // Resolve all the relocations we can.
303 Dyld.resolveRelocations();
Andrew Kaylord55d7012013-01-25 22:50:58 +0000304
Keno Fischerc780e8e2015-05-21 21:24:32 +0000305 if (UseDebugObj) {
306 DebugObj = LoadedObjInfo->getObjectForDebug(Obj);
307 SymbolObj = DebugObj.getBinary();
Lang Hames5c969332015-07-28 20:51:53 +0000308 LoadedObjInfo.reset();
Keno Fischerc780e8e2015-05-21 21:24:32 +0000309 }
310 }
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000311
Ahmed Charles56440fd2014-03-06 05:51:42 +0000312 std::unique_ptr<DIContext> Context(
Keno Fischerc780e8e2015-05-21 21:24:32 +0000313 new DWARFContextInMemory(*SymbolObj,LoadedObjInfo.get()));
Andrew Kaylord55d7012013-01-25 22:50:58 +0000314
Rafael Espindola6bf32212015-06-24 19:57:32 +0000315 std::vector<std::pair<SymbolRef, uint64_t>> SymAddr =
Rafael Espindolab109c032015-06-23 02:08:48 +0000316 object::computeSymbolSizes(*SymbolObj);
Rafael Espindolaa82ce1d2015-05-31 23:15:35 +0000317
Andrew Kaylord55d7012013-01-25 22:50:58 +0000318 // Use symbol info to iterate functions in the object.
Rafael Espindola6bf32212015-06-24 19:57:32 +0000319 for (const auto &P : SymAddr) {
Rafael Espindolab109c032015-06-23 02:08:48 +0000320 object::SymbolRef Sym = P.first;
Rafael Espindola2fa80cc2015-06-26 12:18:49 +0000321 if (Sym.getType() == object::SymbolRef::ST_Function) {
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000322 ErrorOr<StringRef> Name = Sym.getName();
323 if (!Name)
Rafael Espindolada176272015-05-31 22:13:51 +0000324 continue;
Rafael Espindolaed067c42015-07-03 18:19:00 +0000325 ErrorOr<uint64_t> AddrOrErr = Sym.getAddress();
326 if (!AddrOrErr)
Rafael Espindolada176272015-05-31 22:13:51 +0000327 continue;
Rafael Espindolaed067c42015-07-03 18:19:00 +0000328 uint64_t Addr = *AddrOrErr;
Rafael Espindolaa82ce1d2015-05-31 23:15:35 +0000329
Rafael Espindolab109c032015-06-23 02:08:48 +0000330 uint64_t Size = P.second;
Keno Fischerc780e8e2015-05-21 21:24:32 +0000331 // If we're not using the debug object, compute the address of the
332 // symbol in memory (rather than that in the unrelocated object file)
333 // and use that to query the DWARFContext.
334 if (!UseDebugObj && LoadObjects) {
Rafael Espindola8bab8892015-08-07 23:27:14 +0000335 object::section_iterator Sec = *Sym.getSection();
Keno Fischerc780e8e2015-05-21 21:24:32 +0000336 StringRef SecName;
337 Sec->getName(SecName);
338 uint64_t SectionLoadAddress =
Lang Hames2e88f4f2015-07-28 17:52:11 +0000339 LoadedObjInfo->getSectionLoadAddress(*Sec);
Keno Fischerc780e8e2015-05-21 21:24:32 +0000340 if (SectionLoadAddress != 0)
341 Addr += SectionLoadAddress - Sec->getAddress();
342 }
343
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000344 outs() << "Function: " << *Name << ", Size = " << Size
345 << ", Addr = " << Addr << "\n";
Andrew Kaylord55d7012013-01-25 22:50:58 +0000346
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000347 DILineInfoTable Lines = Context->getLineInfoForAddressRange(Addr, Size);
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000348 for (auto &D : Lines) {
349 outs() << " Line info @ " << D.first - Addr << ": "
350 << D.second.FileName << ", line:" << D.second.Line << "\n";
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000351 }
Andrew Kaylord55d7012013-01-25 22:50:58 +0000352 }
353 }
354 }
355
356 return 0;
357}
358
Davide Italianob59ea902015-10-21 22:12:03 +0000359static void doPreallocation(TrivialMemoryManager &MemMgr) {
360 // Allocate a slab of memory upfront, if required. This is used if
361 // we want to test small code models.
362 if (static_cast<intptr_t>(PreallocMemory) < 0)
363 report_fatal_error("Pre-allocated bytes of memory must be a positive integer.");
364
365 // FIXME: Limit the amount of memory that can be preallocated?
366 if (PreallocMemory != 0)
367 MemMgr.preallocateSlab(PreallocMemory);
368}
369
Jim Grosbach4d5284b2011-03-18 17:24:21 +0000370static int executeInput() {
Lang Hamesd311c0e2014-05-13 22:37:41 +0000371 // Load any dylibs requested on the command line.
372 loadDylibs();
373
Jim Grosbachf016b0a2011-03-21 22:15:52 +0000374 // Instantiate a dynamic linker.
Benjamin Kramer9ce77082013-08-03 22:16:31 +0000375 TrivialMemoryManager MemMgr;
Davide Italianob59ea902015-10-21 22:12:03 +0000376 doPreallocation(MemMgr);
Lang Hames633fe142015-03-30 03:37:06 +0000377 RuntimeDyld Dyld(MemMgr, MemMgr);
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000378
Lang Hamesc3246ad2015-04-15 21:18:41 +0000379 // FIXME: Preserve buffers until resolveRelocations time to work around a bug
380 // in RuntimeDyldELF.
381 // This fixme should be fixed ASAP. This is a very brittle workaround.
382 std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
383
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000384 // If we don't have any input files, read from stdin.
385 if (!InputFileList.size())
386 InputFileList.push_back("-");
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000387 for (auto &File : InputFileList) {
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000388 // Load the input memory buffer.
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000389 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000390 MemoryBuffer::getFileOrSTDIN(File);
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000391 if (std::error_code EC = InputBuffer.getError())
392 return Error("unable to read input: '" + EC.message() + "'");
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000393 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
394 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
395
396 if (std::error_code EC = MaybeObj.getError())
397 return Error("unable to create object file: '" + EC.message() + "'");
398
399 ObjectFile &Obj = **MaybeObj;
Lang Hamesc3246ad2015-04-15 21:18:41 +0000400 InputBuffers.push_back(std::move(*InputBuffer));
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000401
Andrew Kayloradc70562012-10-02 21:18:39 +0000402 // Load the object file
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000403 Dyld.loadObject(Obj);
404 if (Dyld.hasError()) {
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000405 return Error(Dyld.getErrorString());
406 }
Jim Grosbach40411cc2011-03-22 18:19:42 +0000407 }
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000408
Davide Italianoaf08e1b2015-11-17 16:37:52 +0000409 // Resove all the relocations we can.
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000410 // FIXME: Error out if there are unresolved relocations.
Davide Italianoaf08e1b2015-11-17 16:37:52 +0000411 Dyld.resolveRelocations();
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000412
Jim Grosbachd35159a2011-04-13 15:38:30 +0000413 // Get the address of the entry point (_main by default).
Lang Hamesb1186032015-03-11 00:43:26 +0000414 void *MainAddress = Dyld.getSymbolLocalAddress(EntryPoint);
Craig Toppere6cb63e2014-04-25 04:24:47 +0000415 if (!MainAddress)
Jim Grosbachd35159a2011-04-13 15:38:30 +0000416 return Error("no definition for '" + EntryPoint + "'");
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000417
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000418 // Invalidate the instruction cache for each loaded function.
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000419 for (auto &FM : MemMgr.FunctionMemory) {
Davide Italianoaf08e1b2015-11-17 16:37:52 +0000420
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000421 // Make sure the memory is executable.
Davide Italianoaf08e1b2015-11-17 16:37:52 +0000422 // setExecutable will call InvalidateInstructionCache.
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000423 std::string ErrorStr;
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000424 if (!sys::Memory::setExecutable(FM, &ErrorStr))
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000425 return Error("unable to mark function executable: '" + ErrorStr + "'");
426 }
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000427
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000428 // Dispatch to _main().
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000429 errs() << "loaded '" << EntryPoint << "' at: " << (void*)MainAddress << "\n";
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000430
431 int (*Main)(int, const char**) =
432 (int(*)(int,const char**)) uintptr_t(MainAddress);
433 const char **Argv = new const char*[2];
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000434 // Use the name of the first input object module as argv[0] for the target.
435 Argv[0] = InputFileList[0].c_str();
Craig Toppere6cb63e2014-04-25 04:24:47 +0000436 Argv[1] = nullptr;
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000437 return Main(1, Argv);
438}
439
Lang Hamese1c11382014-06-27 20:20:57 +0000440static int checkAllExpressions(RuntimeDyldChecker &Checker) {
441 for (const auto& CheckerFileName : CheckFiles) {
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000442 ErrorOr<std::unique_ptr<MemoryBuffer>> CheckerFileBuf =
443 MemoryBuffer::getFileOrSTDIN(CheckerFileName);
444 if (std::error_code EC = CheckerFileBuf.getError())
Lang Hamese1c11382014-06-27 20:20:57 +0000445 return Error("unable to read input '" + CheckerFileName + "': " +
446 EC.message());
447
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000448 if (!Checker.checkAllRulesInBuffer("# rtdyld-check:",
449 CheckerFileBuf.get().get()))
Lang Hamese1c11382014-06-27 20:20:57 +0000450 return Error("some checks in '" + CheckerFileName + "' failed");
451 }
452 return 0;
453}
454
Benjamin Kramerf044d3f2015-03-09 16:23:46 +0000455static std::map<void *, uint64_t>
Lang Hames778ef5b2014-09-04 04:19:54 +0000456applySpecificSectionMappings(RuntimeDyldChecker &Checker) {
457
458 std::map<void*, uint64_t> SpecificMappings;
459
460 for (StringRef Mapping : SpecificSectionMappings) {
461
462 size_t EqualsIdx = Mapping.find_first_of("=");
Lang Hames78937c22015-07-04 01:35:26 +0000463 std::string SectionIDStr = Mapping.substr(0, EqualsIdx);
Lang Hames778ef5b2014-09-04 04:19:54 +0000464 size_t ComaIdx = Mapping.find_first_of(",");
465
Davide Italiano07557fc2015-11-21 02:15:51 +0000466 if (ComaIdx == StringRef::npos)
467 report_fatal_error("Invalid section specification '" + Mapping +
468 "'. Should be '<file name>,<section name>=<addr>'");
Lang Hames778ef5b2014-09-04 04:19:54 +0000469
Lang Hames78937c22015-07-04 01:35:26 +0000470 std::string FileName = SectionIDStr.substr(0, ComaIdx);
471 std::string SectionName = SectionIDStr.substr(ComaIdx + 1);
Lang Hames778ef5b2014-09-04 04:19:54 +0000472
473 uint64_t OldAddrInt;
474 std::string ErrorMsg;
475 std::tie(OldAddrInt, ErrorMsg) =
476 Checker.getSectionAddr(FileName, SectionName, true);
477
Davide Italiano07557fc2015-11-21 02:15:51 +0000478 if (ErrorMsg != "")
479 report_fatal_error(ErrorMsg);
Lang Hames778ef5b2014-09-04 04:19:54 +0000480
481 void* OldAddr = reinterpret_cast<void*>(static_cast<uintptr_t>(OldAddrInt));
482
Lang Hames78937c22015-07-04 01:35:26 +0000483 std::string NewAddrStr = Mapping.substr(EqualsIdx + 1);
Lang Hames778ef5b2014-09-04 04:19:54 +0000484 uint64_t NewAddr;
485
Davide Italiano07557fc2015-11-21 02:15:51 +0000486 if (StringRef(NewAddrStr).getAsInteger(0, NewAddr))
487 report_fatal_error("Invalid section address in mapping '" + Mapping +
488 "'.");
Lang Hames778ef5b2014-09-04 04:19:54 +0000489
490 Checker.getRTDyld().mapSectionAddress(OldAddr, NewAddr);
491 SpecificMappings[OldAddr] = NewAddr;
492 }
493
494 return SpecificMappings;
495}
496
Lang Hames9cb73532014-07-29 23:43:13 +0000497// Scatter sections in all directions!
498// Remaps section addresses for -verify mode. The following command line options
499// can be used to customize the layout of the memory within the phony target's
500// address space:
501// -target-addr-start <s> -- Specify where the phony target addres range starts.
502// -target-addr-end <e> -- Specify where the phony target address range ends.
503// -target-section-sep <d> -- Specify how big a gap should be left between the
504// end of one section and the start of the next.
505// Defaults to zero. Set to something big
506// (e.g. 1 << 32) to stress-test stubs, GOTs, etc.
507//
Lang Hames78937c22015-07-04 01:35:26 +0000508static void remapSectionsAndSymbols(const llvm::Triple &TargetTriple,
509 TrivialMemoryManager &MemMgr,
510 RuntimeDyldChecker &Checker) {
Lang Hames778ef5b2014-09-04 04:19:54 +0000511
512 // Set up a work list (section addr/size pairs).
513 typedef std::list<std::pair<void*, uint64_t>> WorklistT;
514 WorklistT Worklist;
515
516 for (const auto& CodeSection : MemMgr.FunctionMemory)
517 Worklist.push_back(std::make_pair(CodeSection.base(), CodeSection.size()));
518 for (const auto& DataSection : MemMgr.DataMemory)
519 Worklist.push_back(std::make_pair(DataSection.base(), DataSection.size()));
520
521 // Apply any section-specific mappings that were requested on the command
522 // line.
523 typedef std::map<void*, uint64_t> AppliedMappingsT;
524 AppliedMappingsT AppliedMappings = applySpecificSectionMappings(Checker);
525
526 // Keep an "already allocated" mapping of section target addresses to sizes.
527 // Sections whose address mappings aren't specified on the command line will
528 // allocated around the explicitly mapped sections while maintaining the
529 // minimum separation.
530 std::map<uint64_t, uint64_t> AlreadyAllocated;
531
532 // Move the previously applied mappings into the already-allocated map.
533 for (WorklistT::iterator I = Worklist.begin(), E = Worklist.end();
534 I != E;) {
535 WorklistT::iterator Tmp = I;
536 ++I;
537 AppliedMappingsT::iterator AI = AppliedMappings.find(Tmp->first);
538
539 if (AI != AppliedMappings.end()) {
540 AlreadyAllocated[AI->second] = Tmp->second;
541 Worklist.erase(Tmp);
542 }
543 }
Lang Hames9cb73532014-07-29 23:43:13 +0000544
545 // If the -target-addr-end option wasn't explicitly passed, then set it to a
546 // sensible default based on the target triple.
547 if (TargetAddrEnd.getNumOccurrences() == 0) {
548 if (TargetTriple.isArch16Bit())
549 TargetAddrEnd = (1ULL << 16) - 1;
550 else if (TargetTriple.isArch32Bit())
551 TargetAddrEnd = (1ULL << 32) - 1;
552 // TargetAddrEnd already has a sensible default for 64-bit systems, so
553 // there's nothing to do in the 64-bit case.
554 }
555
Lang Hames778ef5b2014-09-04 04:19:54 +0000556 // Process any elements remaining in the worklist.
557 while (!Worklist.empty()) {
558 std::pair<void*, uint64_t> CurEntry = Worklist.front();
559 Worklist.pop_front();
Lang Hames9cb73532014-07-29 23:43:13 +0000560
Lang Hames778ef5b2014-09-04 04:19:54 +0000561 uint64_t NextSectionAddr = TargetAddrStart;
562
563 for (const auto &Alloc : AlreadyAllocated)
564 if (NextSectionAddr + CurEntry.second + TargetSectionSep <= Alloc.first)
565 break;
566 else
567 NextSectionAddr = Alloc.first + Alloc.second + TargetSectionSep;
568
569 AlreadyAllocated[NextSectionAddr] = CurEntry.second;
570 Checker.getRTDyld().mapSectionAddress(CurEntry.first, NextSectionAddr);
Lang Hames9cb73532014-07-29 23:43:13 +0000571 }
572
Lang Hames78937c22015-07-04 01:35:26 +0000573 // Add dummy symbols to the memory manager.
574 for (const auto &Mapping : DummySymbolMappings) {
575 size_t EqualsIdx = Mapping.find_first_of("=");
576
Davide Italiano07557fc2015-11-21 02:15:51 +0000577 if (EqualsIdx == StringRef::npos)
578 report_fatal_error("Invalid dummy symbol specification '" + Mapping +
579 "'. Should be '<symbol name>=<addr>'");
Lang Hames78937c22015-07-04 01:35:26 +0000580
581 std::string Symbol = Mapping.substr(0, EqualsIdx);
582 std::string AddrStr = Mapping.substr(EqualsIdx + 1);
583
584 uint64_t Addr;
Davide Italiano07557fc2015-11-21 02:15:51 +0000585 if (StringRef(AddrStr).getAsInteger(0, Addr))
586 report_fatal_error("Invalid symbol mapping '" + Mapping + "'.");
Lang Hames78937c22015-07-04 01:35:26 +0000587
588 MemMgr.addDummySymbol(Symbol, Addr);
589 }
Lang Hames9cb73532014-07-29 23:43:13 +0000590}
591
592// Load and link the objects specified on the command line, but do not execute
593// anything. Instead, attach a RuntimeDyldChecker instance and call it to
594// verify the correctness of the linked memory.
Lang Hamese1c11382014-06-27 20:20:57 +0000595static int linkAndVerify() {
596
597 // Check for missing triple.
Davide Italiano78da7592015-11-21 05:44:41 +0000598 if (TripleName == "")
599 return Error("-triple required when running in -verify mode.");
Lang Hamese1c11382014-06-27 20:20:57 +0000600
601 // Look up the target and build the disassembler.
602 Triple TheTriple(Triple::normalize(TripleName));
603 std::string ErrorStr;
604 const Target *TheTarget =
605 TargetRegistry::lookupTarget("", TheTriple, ErrorStr);
Davide Italiano78da7592015-11-21 05:44:41 +0000606 if (!TheTarget)
607 return Error("Error accessing target '" + TripleName + "': " + ErrorStr);
608
Lang Hamese1c11382014-06-27 20:20:57 +0000609 TripleName = TheTriple.getTriple();
610
611 std::unique_ptr<MCSubtargetInfo> STI(
Petar Jovanovic280e5622015-06-23 22:52:19 +0000612 TheTarget->createMCSubtargetInfo(TripleName, MCPU, ""));
Lang Hamese1c11382014-06-27 20:20:57 +0000613 assert(STI && "Unable to create subtarget info!");
614
615 std::unique_ptr<MCRegisterInfo> MRI(TheTarget->createMCRegInfo(TripleName));
616 assert(MRI && "Unable to create target register info!");
617
618 std::unique_ptr<MCAsmInfo> MAI(TheTarget->createMCAsmInfo(*MRI, TripleName));
619 assert(MAI && "Unable to create target asm info!");
620
621 MCContext Ctx(MAI.get(), MRI.get(), nullptr);
622
623 std::unique_ptr<MCDisassembler> Disassembler(
624 TheTarget->createMCDisassembler(*STI, Ctx));
625 assert(Disassembler && "Unable to create disassembler!");
626
627 std::unique_ptr<MCInstrInfo> MII(TheTarget->createMCInstrInfo());
628
Daniel Sanders50f17232015-09-15 16:17:27 +0000629 std::unique_ptr<MCInstPrinter> InstPrinter(
630 TheTarget->createMCInstPrinter(Triple(TripleName), 0, *MAI, *MII, *MRI));
Lang Hamese1c11382014-06-27 20:20:57 +0000631
632 // Load any dylibs requested on the command line.
633 loadDylibs();
634
635 // Instantiate a dynamic linker.
636 TrivialMemoryManager MemMgr;
Davide Italianob59ea902015-10-21 22:12:03 +0000637 doPreallocation(MemMgr);
Lang Hames633fe142015-03-30 03:37:06 +0000638 RuntimeDyld Dyld(MemMgr, MemMgr);
Lang Hames925e51b2014-09-03 05:42:52 +0000639 Dyld.setProcessAllSections(true);
Lang Hamesf7acddd2014-07-22 22:47:39 +0000640 RuntimeDyldChecker Checker(Dyld, Disassembler.get(), InstPrinter.get(),
641 llvm::dbgs());
Lang Hamese1c11382014-06-27 20:20:57 +0000642
Lang Hamesc3246ad2015-04-15 21:18:41 +0000643 // FIXME: Preserve buffers until resolveRelocations time to work around a bug
644 // in RuntimeDyldELF.
645 // This fixme should be fixed ASAP. This is a very brittle workaround.
646 std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
647
Lang Hamese1c11382014-06-27 20:20:57 +0000648 // If we don't have any input files, read from stdin.
649 if (!InputFileList.size())
650 InputFileList.push_back("-");
Davide Italianod91bf8e2015-10-10 00:45:24 +0000651 for (auto &Filename : InputFileList) {
Lang Hamese1c11382014-06-27 20:20:57 +0000652 // Load the input memory buffer.
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000653 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
Davide Italianod91bf8e2015-10-10 00:45:24 +0000654 MemoryBuffer::getFileOrSTDIN(Filename);
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000655
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000656 if (std::error_code EC = InputBuffer.getError())
657 return Error("unable to read input: '" + EC.message() + "'");
Lang Hamese1c11382014-06-27 20:20:57 +0000658
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000659 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
660 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
661
662 if (std::error_code EC = MaybeObj.getError())
663 return Error("unable to create object file: '" + EC.message() + "'");
664
665 ObjectFile &Obj = **MaybeObj;
Lang Hamesc3246ad2015-04-15 21:18:41 +0000666 InputBuffers.push_back(std::move(*InputBuffer));
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000667
Lang Hamese1c11382014-06-27 20:20:57 +0000668 // Load the object file
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000669 Dyld.loadObject(Obj);
670 if (Dyld.hasError()) {
Lang Hamese1c11382014-06-27 20:20:57 +0000671 return Error(Dyld.getErrorString());
672 }
673 }
674
Lang Hames78937c22015-07-04 01:35:26 +0000675 // Re-map the section addresses into the phony target address space and add
676 // dummy symbols.
677 remapSectionsAndSymbols(TheTriple, MemMgr, Checker);
Lang Hames375385f2014-07-30 03:12:41 +0000678
Lang Hamese1c11382014-06-27 20:20:57 +0000679 // Resolve all the relocations we can.
680 Dyld.resolveRelocations();
681
Lang Hames925e51b2014-09-03 05:42:52 +0000682 // Register EH frames.
683 Dyld.registerEHFrames();
684
Lang Hamesae172682014-08-05 20:51:46 +0000685 int ErrorCode = checkAllExpressions(Checker);
Davide Italiano78da7592015-11-21 05:44:41 +0000686 if (Dyld.hasError())
687 return Error("RTDyld reported an error applying relocations:\n " +
688 Dyld.getErrorString());
Lang Hamesae172682014-08-05 20:51:46 +0000689
690 return ErrorCode;
Lang Hamese1c11382014-06-27 20:20:57 +0000691}
692
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000693int main(int argc, char **argv) {
Alp Toker9f679322013-11-05 09:33:43 +0000694 sys::PrintStackTraceOnErrorSignal();
695 PrettyStackTraceProgram X(argc, argv);
696
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000697 ProgramName = argv[0];
698 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
699
Lang Hamese1c11382014-06-27 20:20:57 +0000700 llvm::InitializeAllTargetInfos();
701 llvm::InitializeAllTargetMCs();
702 llvm::InitializeAllDisassemblers();
703
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000704 cl::ParseCommandLineOptions(argc, argv, "llvm MC-JIT tool\n");
705
706 switch (Action) {
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000707 case AC_Execute:
Jim Grosbach4d5284b2011-03-18 17:24:21 +0000708 return executeInput();
Keno Fischerc780e8e2015-05-21 21:24:32 +0000709 case AC_PrintDebugLineInfo:
Keno Fischer281b6942015-05-30 19:44:53 +0000710 return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */ true);
Andrew Kaylord55d7012013-01-25 22:50:58 +0000711 case AC_PrintLineInfo:
Keno Fischer281b6942015-05-30 19:44:53 +0000712 return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */false);
713 case AC_PrintObjectLineInfo:
714 return printLineInfoForInput(/* LoadObjects */false,/* UseDebugObj */false);
Lang Hamese1c11382014-06-27 20:20:57 +0000715 case AC_Verify:
716 return linkAndVerify();
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000717 }
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000718}