blob: 315c50fd9efd0e91afcd35ce0f92c13b8fa3128a [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
243static void Message(const char *Type, const Twine &Msg) {
244 errs() << ProgramName << ": " << Type << ": " << Msg << "\n";
245}
246
247static int Error(const Twine &Msg) {
248 Message("error", Msg);
249 return 1;
250}
251
Lang Hamesd311c0e2014-05-13 22:37:41 +0000252static void loadDylibs() {
253 for (const std::string &Dylib : Dylibs) {
254 if (sys::fs::is_regular_file(Dylib)) {
255 std::string ErrMsg;
256 if (sys::DynamicLibrary::LoadLibraryPermanently(Dylib.c_str(), &ErrMsg))
257 llvm::errs() << "Error loading '" << Dylib << "': "
258 << ErrMsg << "\n";
259 } else
260 llvm::errs() << "Dylib not found: '" << Dylib << "'.\n";
261 }
262}
263
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000264/* *** */
265
Keno Fischerc780e8e2015-05-21 21:24:32 +0000266static int printLineInfoForInput(bool LoadObjects, bool UseDebugObj) {
267 assert(LoadObjects || !UseDebugObj);
268
Lang Hamesd311c0e2014-05-13 22:37:41 +0000269 // Load any dylibs requested on the command line.
270 loadDylibs();
271
Andrew Kaylord55d7012013-01-25 22:50:58 +0000272 // If we don't have any input files, read from stdin.
273 if (!InputFileList.size())
274 InputFileList.push_back("-");
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000275 for (auto &File : InputFileList) {
Andrew Kaylord55d7012013-01-25 22:50:58 +0000276 // Instantiate a dynamic linker.
Benjamin Kramer9ce77082013-08-03 22:16:31 +0000277 TrivialMemoryManager MemMgr;
Lang Hames633fe142015-03-30 03:37:06 +0000278 RuntimeDyld Dyld(MemMgr, MemMgr);
Andrew Kaylord55d7012013-01-25 22:50:58 +0000279
280 // Load the input memory buffer.
Andrew Kaylord55d7012013-01-25 22:50:58 +0000281
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000282 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000283 MemoryBuffer::getFileOrSTDIN(File);
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000284 if (std::error_code EC = InputBuffer.getError())
285 return Error("unable to read input: '" + EC.message() + "'");
286
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000287 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
288 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
289
290 if (std::error_code EC = MaybeObj.getError())
291 return Error("unable to create object file: '" + EC.message() + "'");
292
293 ObjectFile &Obj = **MaybeObj;
294
Keno Fischerc780e8e2015-05-21 21:24:32 +0000295 OwningBinary<ObjectFile> DebugObj;
296 std::unique_ptr<RuntimeDyld::LoadedObjectInfo> LoadedObjInfo = nullptr;
297 ObjectFile *SymbolObj = &Obj;
298 if (LoadObjects) {
299 // Load the object file
300 LoadedObjInfo =
301 Dyld.loadObject(Obj);
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000302
Keno Fischerc780e8e2015-05-21 21:24:32 +0000303 if (Dyld.hasError())
304 return Error(Dyld.getErrorString());
Andrew Kaylord55d7012013-01-25 22:50:58 +0000305
Keno Fischerc780e8e2015-05-21 21:24:32 +0000306 // Resolve all the relocations we can.
307 Dyld.resolveRelocations();
Andrew Kaylord55d7012013-01-25 22:50:58 +0000308
Keno Fischerc780e8e2015-05-21 21:24:32 +0000309 if (UseDebugObj) {
310 DebugObj = LoadedObjInfo->getObjectForDebug(Obj);
311 SymbolObj = DebugObj.getBinary();
Lang Hames5c969332015-07-28 20:51:53 +0000312 LoadedObjInfo.reset();
Keno Fischerc780e8e2015-05-21 21:24:32 +0000313 }
314 }
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000315
Ahmed Charles56440fd2014-03-06 05:51:42 +0000316 std::unique_ptr<DIContext> Context(
Keno Fischerc780e8e2015-05-21 21:24:32 +0000317 new DWARFContextInMemory(*SymbolObj,LoadedObjInfo.get()));
Andrew Kaylord55d7012013-01-25 22:50:58 +0000318
Rafael Espindola6bf32212015-06-24 19:57:32 +0000319 std::vector<std::pair<SymbolRef, uint64_t>> SymAddr =
Rafael Espindolab109c032015-06-23 02:08:48 +0000320 object::computeSymbolSizes(*SymbolObj);
Rafael Espindolaa82ce1d2015-05-31 23:15:35 +0000321
Andrew Kaylord55d7012013-01-25 22:50:58 +0000322 // Use symbol info to iterate functions in the object.
Rafael Espindola6bf32212015-06-24 19:57:32 +0000323 for (const auto &P : SymAddr) {
Rafael Espindolab109c032015-06-23 02:08:48 +0000324 object::SymbolRef Sym = P.first;
Rafael Espindola2fa80cc2015-06-26 12:18:49 +0000325 if (Sym.getType() == object::SymbolRef::ST_Function) {
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000326 ErrorOr<StringRef> Name = Sym.getName();
327 if (!Name)
Rafael Espindolada176272015-05-31 22:13:51 +0000328 continue;
Rafael Espindolaed067c42015-07-03 18:19:00 +0000329 ErrorOr<uint64_t> AddrOrErr = Sym.getAddress();
330 if (!AddrOrErr)
Rafael Espindolada176272015-05-31 22:13:51 +0000331 continue;
Rafael Espindolaed067c42015-07-03 18:19:00 +0000332 uint64_t Addr = *AddrOrErr;
Rafael Espindolaa82ce1d2015-05-31 23:15:35 +0000333
Rafael Espindolab109c032015-06-23 02:08:48 +0000334 uint64_t Size = P.second;
Keno Fischerc780e8e2015-05-21 21:24:32 +0000335 // If we're not using the debug object, compute the address of the
336 // symbol in memory (rather than that in the unrelocated object file)
337 // and use that to query the DWARFContext.
338 if (!UseDebugObj && LoadObjects) {
Rafael Espindola8bab8892015-08-07 23:27:14 +0000339 object::section_iterator Sec = *Sym.getSection();
Keno Fischerc780e8e2015-05-21 21:24:32 +0000340 StringRef SecName;
341 Sec->getName(SecName);
342 uint64_t SectionLoadAddress =
Lang Hames2e88f4f2015-07-28 17:52:11 +0000343 LoadedObjInfo->getSectionLoadAddress(*Sec);
Keno Fischerc780e8e2015-05-21 21:24:32 +0000344 if (SectionLoadAddress != 0)
345 Addr += SectionLoadAddress - Sec->getAddress();
346 }
347
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000348 outs() << "Function: " << *Name << ", Size = " << Size
349 << ", Addr = " << Addr << "\n";
Andrew Kaylord55d7012013-01-25 22:50:58 +0000350
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000351 DILineInfoTable Lines = Context->getLineInfoForAddressRange(Addr, Size);
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000352 for (auto &D : Lines) {
353 outs() << " Line info @ " << D.first - Addr << ": "
354 << D.second.FileName << ", line:" << D.second.Line << "\n";
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000355 }
Andrew Kaylord55d7012013-01-25 22:50:58 +0000356 }
357 }
358 }
359
360 return 0;
361}
362
Davide Italianob59ea902015-10-21 22:12:03 +0000363static void doPreallocation(TrivialMemoryManager &MemMgr) {
364 // Allocate a slab of memory upfront, if required. This is used if
365 // we want to test small code models.
366 if (static_cast<intptr_t>(PreallocMemory) < 0)
367 report_fatal_error("Pre-allocated bytes of memory must be a positive integer.");
368
369 // FIXME: Limit the amount of memory that can be preallocated?
370 if (PreallocMemory != 0)
371 MemMgr.preallocateSlab(PreallocMemory);
372}
373
Jim Grosbach4d5284b2011-03-18 17:24:21 +0000374static int executeInput() {
Lang Hamesd311c0e2014-05-13 22:37:41 +0000375 // Load any dylibs requested on the command line.
376 loadDylibs();
377
Jim Grosbachf016b0a2011-03-21 22:15:52 +0000378 // Instantiate a dynamic linker.
Benjamin Kramer9ce77082013-08-03 22:16:31 +0000379 TrivialMemoryManager MemMgr;
Davide Italianob59ea902015-10-21 22:12:03 +0000380 doPreallocation(MemMgr);
Lang Hames633fe142015-03-30 03:37:06 +0000381 RuntimeDyld Dyld(MemMgr, MemMgr);
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000382
Lang Hamesc3246ad2015-04-15 21:18:41 +0000383 // FIXME: Preserve buffers until resolveRelocations time to work around a bug
384 // in RuntimeDyldELF.
385 // This fixme should be fixed ASAP. This is a very brittle workaround.
386 std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
387
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000388 // If we don't have any input files, read from stdin.
389 if (!InputFileList.size())
390 InputFileList.push_back("-");
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000391 for (auto &File : InputFileList) {
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000392 // Load the input memory buffer.
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000393 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000394 MemoryBuffer::getFileOrSTDIN(File);
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000395 if (std::error_code EC = InputBuffer.getError())
396 return Error("unable to read input: '" + EC.message() + "'");
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000397 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
398 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
399
400 if (std::error_code EC = MaybeObj.getError())
401 return Error("unable to create object file: '" + EC.message() + "'");
402
403 ObjectFile &Obj = **MaybeObj;
Lang Hamesc3246ad2015-04-15 21:18:41 +0000404 InputBuffers.push_back(std::move(*InputBuffer));
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000405
Andrew Kayloradc70562012-10-02 21:18:39 +0000406 // Load the object file
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000407 Dyld.loadObject(Obj);
408 if (Dyld.hasError()) {
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000409 return Error(Dyld.getErrorString());
410 }
Jim Grosbach40411cc2011-03-22 18:19:42 +0000411 }
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000412
Davide Italianoaf08e1b2015-11-17 16:37:52 +0000413 // Resove all the relocations we can.
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000414 // FIXME: Error out if there are unresolved relocations.
Davide Italianoaf08e1b2015-11-17 16:37:52 +0000415 Dyld.resolveRelocations();
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000416
Jim Grosbachd35159a2011-04-13 15:38:30 +0000417 // Get the address of the entry point (_main by default).
Lang Hamesb1186032015-03-11 00:43:26 +0000418 void *MainAddress = Dyld.getSymbolLocalAddress(EntryPoint);
Craig Toppere6cb63e2014-04-25 04:24:47 +0000419 if (!MainAddress)
Jim Grosbachd35159a2011-04-13 15:38:30 +0000420 return Error("no definition for '" + EntryPoint + "'");
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000421
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000422 // Invalidate the instruction cache for each loaded function.
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000423 for (auto &FM : MemMgr.FunctionMemory) {
Davide Italianoaf08e1b2015-11-17 16:37:52 +0000424
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000425 // Make sure the memory is executable.
Davide Italianoaf08e1b2015-11-17 16:37:52 +0000426 // setExecutable will call InvalidateInstructionCache.
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000427 std::string ErrorStr;
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000428 if (!sys::Memory::setExecutable(FM, &ErrorStr))
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000429 return Error("unable to mark function executable: '" + ErrorStr + "'");
430 }
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000431
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000432 // Dispatch to _main().
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000433 errs() << "loaded '" << EntryPoint << "' at: " << (void*)MainAddress << "\n";
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000434
435 int (*Main)(int, const char**) =
436 (int(*)(int,const char**)) uintptr_t(MainAddress);
437 const char **Argv = new const char*[2];
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000438 // Use the name of the first input object module as argv[0] for the target.
439 Argv[0] = InputFileList[0].c_str();
Craig Toppere6cb63e2014-04-25 04:24:47 +0000440 Argv[1] = nullptr;
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000441 return Main(1, Argv);
442}
443
Lang Hamese1c11382014-06-27 20:20:57 +0000444static int checkAllExpressions(RuntimeDyldChecker &Checker) {
445 for (const auto& CheckerFileName : CheckFiles) {
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000446 ErrorOr<std::unique_ptr<MemoryBuffer>> CheckerFileBuf =
447 MemoryBuffer::getFileOrSTDIN(CheckerFileName);
448 if (std::error_code EC = CheckerFileBuf.getError())
Lang Hamese1c11382014-06-27 20:20:57 +0000449 return Error("unable to read input '" + CheckerFileName + "': " +
450 EC.message());
451
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000452 if (!Checker.checkAllRulesInBuffer("# rtdyld-check:",
453 CheckerFileBuf.get().get()))
Lang Hamese1c11382014-06-27 20:20:57 +0000454 return Error("some checks in '" + CheckerFileName + "' failed");
455 }
456 return 0;
457}
458
Benjamin Kramerf044d3f2015-03-09 16:23:46 +0000459static std::map<void *, uint64_t>
Lang Hames778ef5b2014-09-04 04:19:54 +0000460applySpecificSectionMappings(RuntimeDyldChecker &Checker) {
461
462 std::map<void*, uint64_t> SpecificMappings;
463
464 for (StringRef Mapping : SpecificSectionMappings) {
465
466 size_t EqualsIdx = Mapping.find_first_of("=");
Lang Hames78937c22015-07-04 01:35:26 +0000467 std::string SectionIDStr = Mapping.substr(0, EqualsIdx);
Lang Hames778ef5b2014-09-04 04:19:54 +0000468 size_t ComaIdx = Mapping.find_first_of(",");
469
470 if (ComaIdx == StringRef::npos) {
471 errs() << "Invalid section specification '" << Mapping
472 << "'. Should be '<file name>,<section name>=<addr>'\n";
473 exit(1);
474 }
475
Lang Hames78937c22015-07-04 01:35:26 +0000476 std::string FileName = SectionIDStr.substr(0, ComaIdx);
477 std::string SectionName = SectionIDStr.substr(ComaIdx + 1);
Lang Hames778ef5b2014-09-04 04:19:54 +0000478
479 uint64_t OldAddrInt;
480 std::string ErrorMsg;
481 std::tie(OldAddrInt, ErrorMsg) =
482 Checker.getSectionAddr(FileName, SectionName, true);
483
484 if (ErrorMsg != "") {
485 errs() << ErrorMsg;
486 exit(1);
487 }
488
489 void* OldAddr = reinterpret_cast<void*>(static_cast<uintptr_t>(OldAddrInt));
490
Lang Hames78937c22015-07-04 01:35:26 +0000491 std::string NewAddrStr = Mapping.substr(EqualsIdx + 1);
Lang Hames778ef5b2014-09-04 04:19:54 +0000492 uint64_t NewAddr;
493
Lang Hames78937c22015-07-04 01:35:26 +0000494 if (StringRef(NewAddrStr).getAsInteger(0, NewAddr)) {
495 errs() << "Invalid section address in mapping '" << Mapping << "'.\n";
Lang Hames778ef5b2014-09-04 04:19:54 +0000496 exit(1);
497 }
498
499 Checker.getRTDyld().mapSectionAddress(OldAddr, NewAddr);
500 SpecificMappings[OldAddr] = NewAddr;
501 }
502
503 return SpecificMappings;
504}
505
Lang Hames9cb73532014-07-29 23:43:13 +0000506// Scatter sections in all directions!
507// Remaps section addresses for -verify mode. The following command line options
508// can be used to customize the layout of the memory within the phony target's
509// address space:
510// -target-addr-start <s> -- Specify where the phony target addres range starts.
511// -target-addr-end <e> -- Specify where the phony target address range ends.
512// -target-section-sep <d> -- Specify how big a gap should be left between the
513// end of one section and the start of the next.
514// Defaults to zero. Set to something big
515// (e.g. 1 << 32) to stress-test stubs, GOTs, etc.
516//
Lang Hames78937c22015-07-04 01:35:26 +0000517static void remapSectionsAndSymbols(const llvm::Triple &TargetTriple,
518 TrivialMemoryManager &MemMgr,
519 RuntimeDyldChecker &Checker) {
Lang Hames778ef5b2014-09-04 04:19:54 +0000520
521 // Set up a work list (section addr/size pairs).
522 typedef std::list<std::pair<void*, uint64_t>> WorklistT;
523 WorklistT Worklist;
524
525 for (const auto& CodeSection : MemMgr.FunctionMemory)
526 Worklist.push_back(std::make_pair(CodeSection.base(), CodeSection.size()));
527 for (const auto& DataSection : MemMgr.DataMemory)
528 Worklist.push_back(std::make_pair(DataSection.base(), DataSection.size()));
529
530 // Apply any section-specific mappings that were requested on the command
531 // line.
532 typedef std::map<void*, uint64_t> AppliedMappingsT;
533 AppliedMappingsT AppliedMappings = applySpecificSectionMappings(Checker);
534
535 // Keep an "already allocated" mapping of section target addresses to sizes.
536 // Sections whose address mappings aren't specified on the command line will
537 // allocated around the explicitly mapped sections while maintaining the
538 // minimum separation.
539 std::map<uint64_t, uint64_t> AlreadyAllocated;
540
541 // Move the previously applied mappings into the already-allocated map.
542 for (WorklistT::iterator I = Worklist.begin(), E = Worklist.end();
543 I != E;) {
544 WorklistT::iterator Tmp = I;
545 ++I;
546 AppliedMappingsT::iterator AI = AppliedMappings.find(Tmp->first);
547
548 if (AI != AppliedMappings.end()) {
549 AlreadyAllocated[AI->second] = Tmp->second;
550 Worklist.erase(Tmp);
551 }
552 }
Lang Hames9cb73532014-07-29 23:43:13 +0000553
554 // If the -target-addr-end option wasn't explicitly passed, then set it to a
555 // sensible default based on the target triple.
556 if (TargetAddrEnd.getNumOccurrences() == 0) {
557 if (TargetTriple.isArch16Bit())
558 TargetAddrEnd = (1ULL << 16) - 1;
559 else if (TargetTriple.isArch32Bit())
560 TargetAddrEnd = (1ULL << 32) - 1;
561 // TargetAddrEnd already has a sensible default for 64-bit systems, so
562 // there's nothing to do in the 64-bit case.
563 }
564
Lang Hames778ef5b2014-09-04 04:19:54 +0000565 // Process any elements remaining in the worklist.
566 while (!Worklist.empty()) {
567 std::pair<void*, uint64_t> CurEntry = Worklist.front();
568 Worklist.pop_front();
Lang Hames9cb73532014-07-29 23:43:13 +0000569
Lang Hames778ef5b2014-09-04 04:19:54 +0000570 uint64_t NextSectionAddr = TargetAddrStart;
571
572 for (const auto &Alloc : AlreadyAllocated)
573 if (NextSectionAddr + CurEntry.second + TargetSectionSep <= Alloc.first)
574 break;
575 else
576 NextSectionAddr = Alloc.first + Alloc.second + TargetSectionSep;
577
578 AlreadyAllocated[NextSectionAddr] = CurEntry.second;
579 Checker.getRTDyld().mapSectionAddress(CurEntry.first, NextSectionAddr);
Lang Hames9cb73532014-07-29 23:43:13 +0000580 }
581
Lang Hames78937c22015-07-04 01:35:26 +0000582 // Add dummy symbols to the memory manager.
583 for (const auto &Mapping : DummySymbolMappings) {
584 size_t EqualsIdx = Mapping.find_first_of("=");
585
586 if (EqualsIdx == StringRef::npos) {
587 errs() << "Invalid dummy symbol specification '" << Mapping
588 << "'. Should be '<symbol name>=<addr>'\n";
589 exit(1);
590 }
591
592 std::string Symbol = Mapping.substr(0, EqualsIdx);
593 std::string AddrStr = Mapping.substr(EqualsIdx + 1);
594
595 uint64_t Addr;
596 if (StringRef(AddrStr).getAsInteger(0, Addr)) {
597 errs() << "Invalid symbol mapping '" << Mapping << "'.\n";
598 exit(1);
599 }
600
601 MemMgr.addDummySymbol(Symbol, Addr);
602 }
Lang Hames9cb73532014-07-29 23:43:13 +0000603}
604
605// Load and link the objects specified on the command line, but do not execute
606// anything. Instead, attach a RuntimeDyldChecker instance and call it to
607// verify the correctness of the linked memory.
Lang Hamese1c11382014-06-27 20:20:57 +0000608static int linkAndVerify() {
609
610 // Check for missing triple.
611 if (TripleName == "") {
612 llvm::errs() << "Error: -triple required when running in -verify mode.\n";
613 return 1;
614 }
615
616 // Look up the target and build the disassembler.
617 Triple TheTriple(Triple::normalize(TripleName));
618 std::string ErrorStr;
619 const Target *TheTarget =
620 TargetRegistry::lookupTarget("", TheTriple, ErrorStr);
621 if (!TheTarget) {
622 llvm::errs() << "Error accessing target '" << TripleName << "': "
623 << ErrorStr << "\n";
624 return 1;
625 }
626 TripleName = TheTriple.getTriple();
627
628 std::unique_ptr<MCSubtargetInfo> STI(
Petar Jovanovic280e5622015-06-23 22:52:19 +0000629 TheTarget->createMCSubtargetInfo(TripleName, MCPU, ""));
Lang Hamese1c11382014-06-27 20:20:57 +0000630 assert(STI && "Unable to create subtarget info!");
631
632 std::unique_ptr<MCRegisterInfo> MRI(TheTarget->createMCRegInfo(TripleName));
633 assert(MRI && "Unable to create target register info!");
634
635 std::unique_ptr<MCAsmInfo> MAI(TheTarget->createMCAsmInfo(*MRI, TripleName));
636 assert(MAI && "Unable to create target asm info!");
637
638 MCContext Ctx(MAI.get(), MRI.get(), nullptr);
639
640 std::unique_ptr<MCDisassembler> Disassembler(
641 TheTarget->createMCDisassembler(*STI, Ctx));
642 assert(Disassembler && "Unable to create disassembler!");
643
644 std::unique_ptr<MCInstrInfo> MII(TheTarget->createMCInstrInfo());
645
Daniel Sanders50f17232015-09-15 16:17:27 +0000646 std::unique_ptr<MCInstPrinter> InstPrinter(
647 TheTarget->createMCInstPrinter(Triple(TripleName), 0, *MAI, *MII, *MRI));
Lang Hamese1c11382014-06-27 20:20:57 +0000648
649 // Load any dylibs requested on the command line.
650 loadDylibs();
651
652 // Instantiate a dynamic linker.
653 TrivialMemoryManager MemMgr;
Davide Italianob59ea902015-10-21 22:12:03 +0000654 doPreallocation(MemMgr);
Lang Hames633fe142015-03-30 03:37:06 +0000655 RuntimeDyld Dyld(MemMgr, MemMgr);
Lang Hames925e51b2014-09-03 05:42:52 +0000656 Dyld.setProcessAllSections(true);
Lang Hamesf7acddd2014-07-22 22:47:39 +0000657 RuntimeDyldChecker Checker(Dyld, Disassembler.get(), InstPrinter.get(),
658 llvm::dbgs());
Lang Hamese1c11382014-06-27 20:20:57 +0000659
Lang Hamesc3246ad2015-04-15 21:18:41 +0000660 // FIXME: Preserve buffers until resolveRelocations time to work around a bug
661 // in RuntimeDyldELF.
662 // This fixme should be fixed ASAP. This is a very brittle workaround.
663 std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
664
Lang Hamese1c11382014-06-27 20:20:57 +0000665 // If we don't have any input files, read from stdin.
666 if (!InputFileList.size())
667 InputFileList.push_back("-");
Davide Italianod91bf8e2015-10-10 00:45:24 +0000668 for (auto &Filename : InputFileList) {
Lang Hamese1c11382014-06-27 20:20:57 +0000669 // Load the input memory buffer.
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000670 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
Davide Italianod91bf8e2015-10-10 00:45:24 +0000671 MemoryBuffer::getFileOrSTDIN(Filename);
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000672
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000673 if (std::error_code EC = InputBuffer.getError())
674 return Error("unable to read input: '" + EC.message() + "'");
Lang Hamese1c11382014-06-27 20:20:57 +0000675
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000676 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
677 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
678
679 if (std::error_code EC = MaybeObj.getError())
680 return Error("unable to create object file: '" + EC.message() + "'");
681
682 ObjectFile &Obj = **MaybeObj;
Lang Hamesc3246ad2015-04-15 21:18:41 +0000683 InputBuffers.push_back(std::move(*InputBuffer));
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000684
Lang Hamese1c11382014-06-27 20:20:57 +0000685 // Load the object file
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000686 Dyld.loadObject(Obj);
687 if (Dyld.hasError()) {
Lang Hamese1c11382014-06-27 20:20:57 +0000688 return Error(Dyld.getErrorString());
689 }
690 }
691
Lang Hames78937c22015-07-04 01:35:26 +0000692 // Re-map the section addresses into the phony target address space and add
693 // dummy symbols.
694 remapSectionsAndSymbols(TheTriple, MemMgr, Checker);
Lang Hames375385f2014-07-30 03:12:41 +0000695
Lang Hamese1c11382014-06-27 20:20:57 +0000696 // Resolve all the relocations we can.
697 Dyld.resolveRelocations();
698
Lang Hames925e51b2014-09-03 05:42:52 +0000699 // Register EH frames.
700 Dyld.registerEHFrames();
701
Lang Hamesae172682014-08-05 20:51:46 +0000702 int ErrorCode = checkAllExpressions(Checker);
703 if (Dyld.hasError()) {
704 errs() << "RTDyld reported an error applying relocations:\n "
705 << Dyld.getErrorString() << "\n";
706 ErrorCode = 1;
707 }
708
709 return ErrorCode;
Lang Hamese1c11382014-06-27 20:20:57 +0000710}
711
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000712int main(int argc, char **argv) {
Alp Toker9f679322013-11-05 09:33:43 +0000713 sys::PrintStackTraceOnErrorSignal();
714 PrettyStackTraceProgram X(argc, argv);
715
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000716 ProgramName = argv[0];
717 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
718
Lang Hamese1c11382014-06-27 20:20:57 +0000719 llvm::InitializeAllTargetInfos();
720 llvm::InitializeAllTargetMCs();
721 llvm::InitializeAllDisassemblers();
722
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000723 cl::ParseCommandLineOptions(argc, argv, "llvm MC-JIT tool\n");
724
725 switch (Action) {
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000726 case AC_Execute:
Jim Grosbach4d5284b2011-03-18 17:24:21 +0000727 return executeInput();
Keno Fischerc780e8e2015-05-21 21:24:32 +0000728 case AC_PrintDebugLineInfo:
Keno Fischer281b6942015-05-30 19:44:53 +0000729 return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */ true);
Andrew Kaylord55d7012013-01-25 22:50:58 +0000730 case AC_PrintLineInfo:
Keno Fischer281b6942015-05-30 19:44:53 +0000731 return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */false);
732 case AC_PrintObjectLineInfo:
733 return printLineInfoForInput(/* LoadObjects */false,/* UseDebugObj */false);
Lang Hamese1c11382014-06-27 20:20:57 +0000734 case AC_Verify:
735 return linkAndVerify();
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000736 }
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000737}