blob: addea5884726ed499c1bad80388716d4bf983162 [file] [log] [blame]
Jim Grosbach0072cdb2011-03-18 17:11:39 +00001//===-- llvm-rtdyld.cpp - MCJIT Testing Tool ------------------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This is a testing tool for use with the MC-JIT LLVM components.
11//
12//===----------------------------------------------------------------------===//
13
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000014#include "llvm/ADT/StringMap.h"
Zachary Turner6489d7b2015-04-23 17:37:47 +000015#include "llvm/DebugInfo/DIContext.h"
16#include "llvm/DebugInfo/DWARF/DWARFContext.h"
Lang Hames633fe142015-03-30 03:37:06 +000017#include "llvm/ExecutionEngine/RTDyldMemoryManager.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000018#include "llvm/ExecutionEngine/RuntimeDyld.h"
Lang Hamese1c11382014-06-27 20:20:57 +000019#include "llvm/ExecutionEngine/RuntimeDyldChecker.h"
20#include "llvm/MC/MCAsmInfo.h"
21#include "llvm/MC/MCContext.h"
22#include "llvm/MC/MCDisassembler.h"
Lang Hamese1c11382014-06-27 20:20:57 +000023#include "llvm/MC/MCInstPrinter.h"
Chandler Carruthd9903882015-01-14 11:23:27 +000024#include "llvm/MC/MCInstrInfo.h"
Lang Hamese1c11382014-06-27 20:20:57 +000025#include "llvm/MC/MCRegisterInfo.h"
Pete Cooper3de83e42015-05-15 21:58:42 +000026#include "llvm/MC/MCSubtargetInfo.h"
Rafael Espindola6e040c02013-04-26 20:07:33 +000027#include "llvm/Object/MachO.h"
Rafael Espindolab109c032015-06-23 02:08:48 +000028#include "llvm/Object/SymbolSize.h"
Jim Grosbach0072cdb2011-03-18 17:11:39 +000029#include "llvm/Support/CommandLine.h"
Lang Hamesd311c0e2014-05-13 22:37:41 +000030#include "llvm/Support/DynamicLibrary.h"
Jim Grosbach0072cdb2011-03-18 17:11:39 +000031#include "llvm/Support/ManagedStatic.h"
32#include "llvm/Support/Memory.h"
33#include "llvm/Support/MemoryBuffer.h"
Alp Toker9f679322013-11-05 09:33:43 +000034#include "llvm/Support/PrettyStackTrace.h"
Lang Hamese1c11382014-06-27 20:20:57 +000035#include "llvm/Support/Signals.h"
36#include "llvm/Support/TargetRegistry.h"
37#include "llvm/Support/TargetSelect.h"
Chandler Carruthd9903882015-01-14 11:23:27 +000038#include "llvm/Support/raw_ostream.h"
Lang Hames778ef5b2014-09-04 04:19:54 +000039#include <list>
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000040#include <system_error>
Lang Hamese1c11382014-06-27 20:20:57 +000041
Jim Grosbach0072cdb2011-03-18 17:11:39 +000042using namespace llvm;
43using namespace llvm::object;
44
Jim Grosbach7cb41d72011-04-13 15:49:40 +000045static cl::list<std::string>
46InputFileList(cl::Positional, cl::ZeroOrMore,
47 cl::desc("<input file>"));
Jim Grosbach0072cdb2011-03-18 17:11:39 +000048
49enum ActionType {
Andrew Kaylord55d7012013-01-25 22:50:58 +000050 AC_Execute,
Keno Fischer281b6942015-05-30 19:44:53 +000051 AC_PrintObjectLineInfo,
Lang Hamese1c11382014-06-27 20:20:57 +000052 AC_PrintLineInfo,
Keno Fischerc780e8e2015-05-21 21:24:32 +000053 AC_PrintDebugLineInfo,
Lang Hamese1c11382014-06-27 20:20:57 +000054 AC_Verify
Jim Grosbach0072cdb2011-03-18 17:11:39 +000055};
56
57static cl::opt<ActionType>
58Action(cl::desc("Action to perform:"),
59 cl::init(AC_Execute),
60 cl::values(clEnumValN(AC_Execute, "execute",
61 "Load, link, and execute the inputs."),
Andrew Kaylord55d7012013-01-25 22:50:58 +000062 clEnumValN(AC_PrintLineInfo, "printline",
63 "Load, link, and print line information for each function."),
Keno Fischerc780e8e2015-05-21 21:24:32 +000064 clEnumValN(AC_PrintDebugLineInfo, "printdebugline",
65 "Load, link, and print line information for each function using the debug object"),
Keno Fischer281b6942015-05-30 19:44:53 +000066 clEnumValN(AC_PrintObjectLineInfo, "printobjline",
67 "Like -printlineinfo but does not load the object first"),
Lang Hamese1c11382014-06-27 20:20:57 +000068 clEnumValN(AC_Verify, "verify",
69 "Load, link and verify the resulting memory image."),
Jim Grosbach0072cdb2011-03-18 17:11:39 +000070 clEnumValEnd));
71
Jim Grosbachd35159a2011-04-13 15:38:30 +000072static cl::opt<std::string>
73EntryPoint("entry",
74 cl::desc("Function to call as entry point."),
75 cl::init("_main"));
76
Lang Hamesd311c0e2014-05-13 22:37:41 +000077static cl::list<std::string>
78Dylibs("dylib",
79 cl::desc("Add library."),
80 cl::ZeroOrMore);
81
Lang Hamese1c11382014-06-27 20:20:57 +000082static cl::opt<std::string>
83TripleName("triple", cl::desc("Target triple for disassembler"));
84
Petar Jovanovic280e5622015-06-23 22:52:19 +000085static cl::opt<std::string>
86MCPU("mcpu",
87 cl::desc("Target a specific cpu type (-mcpu=help for details)"),
88 cl::value_desc("cpu-name"),
89 cl::init(""));
90
Lang Hamese1c11382014-06-27 20:20:57 +000091static cl::list<std::string>
92CheckFiles("check",
93 cl::desc("File containing RuntimeDyld verifier checks."),
94 cl::ZeroOrMore);
95
Lang Hames9cb73532014-07-29 23:43:13 +000096static cl::opt<uint64_t>
97TargetAddrStart("target-addr-start",
98 cl::desc("For -verify only: start of phony target address "
99 "range."),
100 cl::init(4096), // Start at "page 1" - no allocating at "null".
101 cl::Hidden);
102
103static cl::opt<uint64_t>
104TargetAddrEnd("target-addr-end",
105 cl::desc("For -verify only: end of phony target address range."),
106 cl::init(~0ULL),
107 cl::Hidden);
108
109static cl::opt<uint64_t>
110TargetSectionSep("target-section-sep",
111 cl::desc("For -verify only: Separation between sections in "
112 "phony target address space."),
113 cl::init(0),
114 cl::Hidden);
115
Lang Hames778ef5b2014-09-04 04:19:54 +0000116static cl::list<std::string>
117SpecificSectionMappings("map-section",
118 cl::desc("Map a section to a specific address."),
119 cl::ZeroOrMore);
120
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000121/* *** */
122
Jim Grosbach2dcef0502011-04-04 23:04:39 +0000123// A trivial memory manager that doesn't do anything fancy, just uses the
124// support library allocation routines directly.
125class TrivialMemoryManager : public RTDyldMemoryManager {
126public:
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000127 SmallVector<sys::MemoryBlock, 16> FunctionMemory;
Jim Grosbacheff0a402012-01-16 22:26:39 +0000128 SmallVector<sys::MemoryBlock, 16> DataMemory;
129
130 uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
Craig Toppere56917c2014-03-08 08:27:28 +0000131 unsigned SectionID,
132 StringRef SectionName) override;
Jim Grosbacheff0a402012-01-16 22:26:39 +0000133 uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
Filip Pizlo7aa695e02013-10-02 00:59:25 +0000134 unsigned SectionID, StringRef SectionName,
Craig Toppere56917c2014-03-08 08:27:28 +0000135 bool IsReadOnly) override;
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000136
Craig Toppere56917c2014-03-08 08:27:28 +0000137 void *getPointerToNamedFunction(const std::string &Name,
138 bool AbortOnFailure = true) override {
Craig Toppere6cb63e2014-04-25 04:24:47 +0000139 return nullptr;
Danil Malyshevbfee5422012-03-28 21:46:36 +0000140 }
141
Craig Toppere56917c2014-03-08 08:27:28 +0000142 bool finalizeMemory(std::string *ErrMsg) override { return false; }
Andrew Kaylora342cb92012-11-15 23:50:01 +0000143
Danil Malyshev8c17fbd2012-05-16 18:50:11 +0000144 // Invalidate instruction cache for sections with execute permissions.
145 // Some platforms with separate data cache and instruction cache require
146 // explicit cache flush, otherwise JIT code manipulations (like resolved
147 // relocations) will get to the data cache but not to the instruction cache.
148 virtual void invalidateInstructionCache();
Tim Northover5af339a2015-06-03 18:26:52 +0000149
150 void registerEHFrames(uint8_t *Addr, uint64_t LoadAddr,
151 size_t Size) override {}
152 void deregisterEHFrames(uint8_t *Addr, uint64_t LoadAddr,
153 size_t Size) override {}
Jim Grosbach2dcef0502011-04-04 23:04:39 +0000154};
155
Jim Grosbacheff0a402012-01-16 22:26:39 +0000156uint8_t *TrivialMemoryManager::allocateCodeSection(uintptr_t Size,
157 unsigned Alignment,
Filip Pizlo7aa695e02013-10-02 00:59:25 +0000158 unsigned SectionID,
159 StringRef SectionName) {
Craig Toppere6cb63e2014-04-25 04:24:47 +0000160 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, nullptr);
Danil Malyshev8c17fbd2012-05-16 18:50:11 +0000161 FunctionMemory.push_back(MB);
162 return (uint8_t*)MB.base();
Jim Grosbacheff0a402012-01-16 22:26:39 +0000163}
164
165uint8_t *TrivialMemoryManager::allocateDataSection(uintptr_t Size,
166 unsigned Alignment,
Andrew Kaylora342cb92012-11-15 23:50:01 +0000167 unsigned SectionID,
Filip Pizlo7aa695e02013-10-02 00:59:25 +0000168 StringRef SectionName,
Andrew Kaylora342cb92012-11-15 23:50:01 +0000169 bool IsReadOnly) {
Craig Toppere6cb63e2014-04-25 04:24:47 +0000170 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, nullptr);
Danil Malyshev8c17fbd2012-05-16 18:50:11 +0000171 DataMemory.push_back(MB);
172 return (uint8_t*)MB.base();
173}
174
175void TrivialMemoryManager::invalidateInstructionCache() {
176 for (int i = 0, e = FunctionMemory.size(); i != e; ++i)
177 sys::Memory::InvalidateInstructionCache(FunctionMemory[i].base(),
178 FunctionMemory[i].size());
179
180 for (int i = 0, e = DataMemory.size(); i != e; ++i)
181 sys::Memory::InvalidateInstructionCache(DataMemory[i].base(),
182 DataMemory[i].size());
Jim Grosbacheff0a402012-01-16 22:26:39 +0000183}
184
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000185static const char *ProgramName;
186
187static void Message(const char *Type, const Twine &Msg) {
188 errs() << ProgramName << ": " << Type << ": " << Msg << "\n";
189}
190
191static int Error(const Twine &Msg) {
192 Message("error", Msg);
193 return 1;
194}
195
Lang Hamesd311c0e2014-05-13 22:37:41 +0000196static void loadDylibs() {
197 for (const std::string &Dylib : Dylibs) {
198 if (sys::fs::is_regular_file(Dylib)) {
199 std::string ErrMsg;
200 if (sys::DynamicLibrary::LoadLibraryPermanently(Dylib.c_str(), &ErrMsg))
201 llvm::errs() << "Error loading '" << Dylib << "': "
202 << ErrMsg << "\n";
203 } else
204 llvm::errs() << "Dylib not found: '" << Dylib << "'.\n";
205 }
206}
207
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000208/* *** */
209
Keno Fischerc780e8e2015-05-21 21:24:32 +0000210static int printLineInfoForInput(bool LoadObjects, bool UseDebugObj) {
211 assert(LoadObjects || !UseDebugObj);
212
Lang Hamesd311c0e2014-05-13 22:37:41 +0000213 // Load any dylibs requested on the command line.
214 loadDylibs();
215
Andrew Kaylord55d7012013-01-25 22:50:58 +0000216 // If we don't have any input files, read from stdin.
217 if (!InputFileList.size())
218 InputFileList.push_back("-");
219 for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
220 // Instantiate a dynamic linker.
Benjamin Kramer9ce77082013-08-03 22:16:31 +0000221 TrivialMemoryManager MemMgr;
Lang Hames633fe142015-03-30 03:37:06 +0000222 RuntimeDyld Dyld(MemMgr, MemMgr);
Andrew Kaylord55d7012013-01-25 22:50:58 +0000223
224 // Load the input memory buffer.
Andrew Kaylord55d7012013-01-25 22:50:58 +0000225
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000226 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
227 MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
228 if (std::error_code EC = InputBuffer.getError())
229 return Error("unable to read input: '" + EC.message() + "'");
230
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000231 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
232 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
233
234 if (std::error_code EC = MaybeObj.getError())
235 return Error("unable to create object file: '" + EC.message() + "'");
236
237 ObjectFile &Obj = **MaybeObj;
238
Keno Fischerc780e8e2015-05-21 21:24:32 +0000239 OwningBinary<ObjectFile> DebugObj;
240 std::unique_ptr<RuntimeDyld::LoadedObjectInfo> LoadedObjInfo = nullptr;
241 ObjectFile *SymbolObj = &Obj;
242 if (LoadObjects) {
243 // Load the object file
244 LoadedObjInfo =
245 Dyld.loadObject(Obj);
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000246
Keno Fischerc780e8e2015-05-21 21:24:32 +0000247 if (Dyld.hasError())
248 return Error(Dyld.getErrorString());
Andrew Kaylord55d7012013-01-25 22:50:58 +0000249
Keno Fischerc780e8e2015-05-21 21:24:32 +0000250 // Resolve all the relocations we can.
251 Dyld.resolveRelocations();
Andrew Kaylord55d7012013-01-25 22:50:58 +0000252
Keno Fischerc780e8e2015-05-21 21:24:32 +0000253 if (UseDebugObj) {
254 DebugObj = LoadedObjInfo->getObjectForDebug(Obj);
255 SymbolObj = DebugObj.getBinary();
256 }
257 }
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000258
Ahmed Charles56440fd2014-03-06 05:51:42 +0000259 std::unique_ptr<DIContext> Context(
Keno Fischerc780e8e2015-05-21 21:24:32 +0000260 new DWARFContextInMemory(*SymbolObj,LoadedObjInfo.get()));
Andrew Kaylord55d7012013-01-25 22:50:58 +0000261
Rafael Espindolab109c032015-06-23 02:08:48 +0000262 ErrorOr<std::vector<std::pair<SymbolRef, uint64_t>>> SymAddrOrErr =
263 object::computeSymbolSizes(*SymbolObj);
264 if (std::error_code EC = SymAddrOrErr.getError())
265 return Error(EC.message());
Rafael Espindolaa82ce1d2015-05-31 23:15:35 +0000266
Andrew Kaylord55d7012013-01-25 22:50:58 +0000267 // Use symbol info to iterate functions in the object.
Rafael Espindolab109c032015-06-23 02:08:48 +0000268 for (const auto &P : *SymAddrOrErr) {
269 object::SymbolRef Sym = P.first;
Andrew Kaylord55d7012013-01-25 22:50:58 +0000270 object::SymbolRef::Type SymType;
Rafael Espindolada176272015-05-31 22:13:51 +0000271 if (Sym.getType(SymType))
272 continue;
Andrew Kaylord55d7012013-01-25 22:50:58 +0000273 if (SymType == object::SymbolRef::ST_Function) {
274 StringRef Name;
275 uint64_t Addr;
Rafael Espindolada176272015-05-31 22:13:51 +0000276 if (Sym.getName(Name))
277 continue;
278 if (Sym.getAddress(Addr))
279 continue;
Rafael Espindolaa82ce1d2015-05-31 23:15:35 +0000280
Rafael Espindolab109c032015-06-23 02:08:48 +0000281 uint64_t Size = P.second;
Keno Fischerc780e8e2015-05-21 21:24:32 +0000282 // If we're not using the debug object, compute the address of the
283 // symbol in memory (rather than that in the unrelocated object file)
284 // and use that to query the DWARFContext.
285 if (!UseDebugObj && LoadObjects) {
286 object::section_iterator Sec(SymbolObj->section_end());
Rafael Espindolada176272015-05-31 22:13:51 +0000287 Sym.getSection(Sec);
Keno Fischerc780e8e2015-05-21 21:24:32 +0000288 StringRef SecName;
289 Sec->getName(SecName);
290 uint64_t SectionLoadAddress =
291 LoadedObjInfo->getSectionLoadAddress(SecName);
292 if (SectionLoadAddress != 0)
293 Addr += SectionLoadAddress - Sec->getAddress();
294 }
295
296 outs() << "Function: " << Name << ", Size = " << Size << ", Addr = " << Addr << "\n";
Andrew Kaylord55d7012013-01-25 22:50:58 +0000297
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000298 DILineInfoTable Lines = Context->getLineInfoForAddressRange(Addr, Size);
299 DILineInfoTable::iterator Begin = Lines.begin();
300 DILineInfoTable::iterator End = Lines.end();
301 for (DILineInfoTable::iterator It = Begin; It != End; ++It) {
302 outs() << " Line info @ " << It->first - Addr << ": "
Alexey Samsonovd0109992014-04-18 21:36:39 +0000303 << It->second.FileName << ", line:" << It->second.Line << "\n";
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000304 }
Andrew Kaylord55d7012013-01-25 22:50:58 +0000305 }
306 }
307 }
308
309 return 0;
310}
311
Jim Grosbach4d5284b2011-03-18 17:24:21 +0000312static int executeInput() {
Lang Hamesd311c0e2014-05-13 22:37:41 +0000313 // Load any dylibs requested on the command line.
314 loadDylibs();
315
Jim Grosbachf016b0a2011-03-21 22:15:52 +0000316 // Instantiate a dynamic linker.
Benjamin Kramer9ce77082013-08-03 22:16:31 +0000317 TrivialMemoryManager MemMgr;
Lang Hames633fe142015-03-30 03:37:06 +0000318 RuntimeDyld Dyld(MemMgr, MemMgr);
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000319
Lang Hamesc3246ad2015-04-15 21:18:41 +0000320 // FIXME: Preserve buffers until resolveRelocations time to work around a bug
321 // in RuntimeDyldELF.
322 // This fixme should be fixed ASAP. This is a very brittle workaround.
323 std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
324
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000325 // If we don't have any input files, read from stdin.
326 if (!InputFileList.size())
327 InputFileList.push_back("-");
328 for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
329 // Load the input memory buffer.
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000330 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
331 MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
332 if (std::error_code EC = InputBuffer.getError())
333 return Error("unable to read input: '" + EC.message() + "'");
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000334 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
335 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
336
337 if (std::error_code EC = MaybeObj.getError())
338 return Error("unable to create object file: '" + EC.message() + "'");
339
340 ObjectFile &Obj = **MaybeObj;
Lang Hamesc3246ad2015-04-15 21:18:41 +0000341 InputBuffers.push_back(std::move(*InputBuffer));
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000342
Andrew Kayloradc70562012-10-02 21:18:39 +0000343 // Load the object file
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000344 Dyld.loadObject(Obj);
345 if (Dyld.hasError()) {
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000346 return Error(Dyld.getErrorString());
347 }
Jim Grosbach40411cc2011-03-22 18:19:42 +0000348 }
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000349
Jim Grosbach733d3052011-04-12 21:20:41 +0000350 // Resolve all the relocations we can.
351 Dyld.resolveRelocations();
Danil Malyshev8c17fbd2012-05-16 18:50:11 +0000352 // Clear instruction cache before code will be executed.
Benjamin Kramer5d62ad22013-08-03 22:18:45 +0000353 MemMgr.invalidateInstructionCache();
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000354
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000355 // FIXME: Error out if there are unresolved relocations.
356
Jim Grosbachd35159a2011-04-13 15:38:30 +0000357 // Get the address of the entry point (_main by default).
Lang Hamesb1186032015-03-11 00:43:26 +0000358 void *MainAddress = Dyld.getSymbolLocalAddress(EntryPoint);
Craig Toppere6cb63e2014-04-25 04:24:47 +0000359 if (!MainAddress)
Jim Grosbachd35159a2011-04-13 15:38:30 +0000360 return Error("no definition for '" + EntryPoint + "'");
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000361
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000362 // Invalidate the instruction cache for each loaded function.
Benjamin Kramer5d62ad22013-08-03 22:18:45 +0000363 for (unsigned i = 0, e = MemMgr.FunctionMemory.size(); i != e; ++i) {
364 sys::MemoryBlock &Data = MemMgr.FunctionMemory[i];
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000365 // Make sure the memory is executable.
366 std::string ErrorStr;
367 sys::Memory::InvalidateInstructionCache(Data.base(), Data.size());
368 if (!sys::Memory::setExecutable(Data, &ErrorStr))
369 return Error("unable to mark function executable: '" + ErrorStr + "'");
370 }
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000371
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000372 // Dispatch to _main().
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000373 errs() << "loaded '" << EntryPoint << "' at: " << (void*)MainAddress << "\n";
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000374
375 int (*Main)(int, const char**) =
376 (int(*)(int,const char**)) uintptr_t(MainAddress);
377 const char **Argv = new const char*[2];
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000378 // Use the name of the first input object module as argv[0] for the target.
379 Argv[0] = InputFileList[0].c_str();
Craig Toppere6cb63e2014-04-25 04:24:47 +0000380 Argv[1] = nullptr;
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000381 return Main(1, Argv);
382}
383
Lang Hamese1c11382014-06-27 20:20:57 +0000384static int checkAllExpressions(RuntimeDyldChecker &Checker) {
385 for (const auto& CheckerFileName : CheckFiles) {
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000386 ErrorOr<std::unique_ptr<MemoryBuffer>> CheckerFileBuf =
387 MemoryBuffer::getFileOrSTDIN(CheckerFileName);
388 if (std::error_code EC = CheckerFileBuf.getError())
Lang Hamese1c11382014-06-27 20:20:57 +0000389 return Error("unable to read input '" + CheckerFileName + "': " +
390 EC.message());
391
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000392 if (!Checker.checkAllRulesInBuffer("# rtdyld-check:",
393 CheckerFileBuf.get().get()))
Lang Hamese1c11382014-06-27 20:20:57 +0000394 return Error("some checks in '" + CheckerFileName + "' failed");
395 }
396 return 0;
397}
398
Benjamin Kramerf044d3f2015-03-09 16:23:46 +0000399static std::map<void *, uint64_t>
Lang Hames778ef5b2014-09-04 04:19:54 +0000400applySpecificSectionMappings(RuntimeDyldChecker &Checker) {
401
402 std::map<void*, uint64_t> SpecificMappings;
403
404 for (StringRef Mapping : SpecificSectionMappings) {
405
406 size_t EqualsIdx = Mapping.find_first_of("=");
407 StringRef SectionIDStr = Mapping.substr(0, EqualsIdx);
408 size_t ComaIdx = Mapping.find_first_of(",");
409
410 if (ComaIdx == StringRef::npos) {
411 errs() << "Invalid section specification '" << Mapping
412 << "'. Should be '<file name>,<section name>=<addr>'\n";
413 exit(1);
414 }
415
416 StringRef FileName = SectionIDStr.substr(0, ComaIdx);
417 StringRef SectionName = SectionIDStr.substr(ComaIdx + 1);
418
419 uint64_t OldAddrInt;
420 std::string ErrorMsg;
421 std::tie(OldAddrInt, ErrorMsg) =
422 Checker.getSectionAddr(FileName, SectionName, true);
423
424 if (ErrorMsg != "") {
425 errs() << ErrorMsg;
426 exit(1);
427 }
428
429 void* OldAddr = reinterpret_cast<void*>(static_cast<uintptr_t>(OldAddrInt));
430
431 StringRef NewAddrStr = Mapping.substr(EqualsIdx + 1);
432 uint64_t NewAddr;
433
434 if (NewAddrStr.getAsInteger(0, NewAddr)) {
435 errs() << "Invalid section address in mapping: " << Mapping << "\n";
436 exit(1);
437 }
438
439 Checker.getRTDyld().mapSectionAddress(OldAddr, NewAddr);
440 SpecificMappings[OldAddr] = NewAddr;
441 }
442
443 return SpecificMappings;
444}
445
Lang Hames9cb73532014-07-29 23:43:13 +0000446// Scatter sections in all directions!
447// Remaps section addresses for -verify mode. The following command line options
448// can be used to customize the layout of the memory within the phony target's
449// address space:
450// -target-addr-start <s> -- Specify where the phony target addres range starts.
451// -target-addr-end <e> -- Specify where the phony target address range ends.
452// -target-section-sep <d> -- Specify how big a gap should be left between the
453// end of one section and the start of the next.
454// Defaults to zero. Set to something big
455// (e.g. 1 << 32) to stress-test stubs, GOTs, etc.
456//
Benjamin Kramerf044d3f2015-03-09 16:23:46 +0000457static void remapSections(const llvm::Triple &TargetTriple,
458 const TrivialMemoryManager &MemMgr,
459 RuntimeDyldChecker &Checker) {
Lang Hames778ef5b2014-09-04 04:19:54 +0000460
461 // Set up a work list (section addr/size pairs).
462 typedef std::list<std::pair<void*, uint64_t>> WorklistT;
463 WorklistT Worklist;
464
465 for (const auto& CodeSection : MemMgr.FunctionMemory)
466 Worklist.push_back(std::make_pair(CodeSection.base(), CodeSection.size()));
467 for (const auto& DataSection : MemMgr.DataMemory)
468 Worklist.push_back(std::make_pair(DataSection.base(), DataSection.size()));
469
470 // Apply any section-specific mappings that were requested on the command
471 // line.
472 typedef std::map<void*, uint64_t> AppliedMappingsT;
473 AppliedMappingsT AppliedMappings = applySpecificSectionMappings(Checker);
474
475 // Keep an "already allocated" mapping of section target addresses to sizes.
476 // Sections whose address mappings aren't specified on the command line will
477 // allocated around the explicitly mapped sections while maintaining the
478 // minimum separation.
479 std::map<uint64_t, uint64_t> AlreadyAllocated;
480
481 // Move the previously applied mappings into the already-allocated map.
482 for (WorklistT::iterator I = Worklist.begin(), E = Worklist.end();
483 I != E;) {
484 WorklistT::iterator Tmp = I;
485 ++I;
486 AppliedMappingsT::iterator AI = AppliedMappings.find(Tmp->first);
487
488 if (AI != AppliedMappings.end()) {
489 AlreadyAllocated[AI->second] = Tmp->second;
490 Worklist.erase(Tmp);
491 }
492 }
Lang Hames9cb73532014-07-29 23:43:13 +0000493
494 // If the -target-addr-end option wasn't explicitly passed, then set it to a
495 // sensible default based on the target triple.
496 if (TargetAddrEnd.getNumOccurrences() == 0) {
497 if (TargetTriple.isArch16Bit())
498 TargetAddrEnd = (1ULL << 16) - 1;
499 else if (TargetTriple.isArch32Bit())
500 TargetAddrEnd = (1ULL << 32) - 1;
501 // TargetAddrEnd already has a sensible default for 64-bit systems, so
502 // there's nothing to do in the 64-bit case.
503 }
504
Lang Hames778ef5b2014-09-04 04:19:54 +0000505 // Process any elements remaining in the worklist.
506 while (!Worklist.empty()) {
507 std::pair<void*, uint64_t> CurEntry = Worklist.front();
508 Worklist.pop_front();
Lang Hames9cb73532014-07-29 23:43:13 +0000509
Lang Hames778ef5b2014-09-04 04:19:54 +0000510 uint64_t NextSectionAddr = TargetAddrStart;
511
512 for (const auto &Alloc : AlreadyAllocated)
513 if (NextSectionAddr + CurEntry.second + TargetSectionSep <= Alloc.first)
514 break;
515 else
516 NextSectionAddr = Alloc.first + Alloc.second + TargetSectionSep;
517
518 AlreadyAllocated[NextSectionAddr] = CurEntry.second;
519 Checker.getRTDyld().mapSectionAddress(CurEntry.first, NextSectionAddr);
Lang Hames9cb73532014-07-29 23:43:13 +0000520 }
521
Lang Hames9cb73532014-07-29 23:43:13 +0000522}
523
524// Load and link the objects specified on the command line, but do not execute
525// anything. Instead, attach a RuntimeDyldChecker instance and call it to
526// verify the correctness of the linked memory.
Lang Hamese1c11382014-06-27 20:20:57 +0000527static int linkAndVerify() {
528
529 // Check for missing triple.
530 if (TripleName == "") {
531 llvm::errs() << "Error: -triple required when running in -verify mode.\n";
532 return 1;
533 }
534
535 // Look up the target and build the disassembler.
536 Triple TheTriple(Triple::normalize(TripleName));
537 std::string ErrorStr;
538 const Target *TheTarget =
539 TargetRegistry::lookupTarget("", TheTriple, ErrorStr);
540 if (!TheTarget) {
541 llvm::errs() << "Error accessing target '" << TripleName << "': "
542 << ErrorStr << "\n";
543 return 1;
544 }
545 TripleName = TheTriple.getTriple();
546
547 std::unique_ptr<MCSubtargetInfo> STI(
Petar Jovanovic280e5622015-06-23 22:52:19 +0000548 TheTarget->createMCSubtargetInfo(TripleName, MCPU, ""));
Lang Hamese1c11382014-06-27 20:20:57 +0000549 assert(STI && "Unable to create subtarget info!");
550
551 std::unique_ptr<MCRegisterInfo> MRI(TheTarget->createMCRegInfo(TripleName));
552 assert(MRI && "Unable to create target register info!");
553
554 std::unique_ptr<MCAsmInfo> MAI(TheTarget->createMCAsmInfo(*MRI, TripleName));
555 assert(MAI && "Unable to create target asm info!");
556
557 MCContext Ctx(MAI.get(), MRI.get(), nullptr);
558
559 std::unique_ptr<MCDisassembler> Disassembler(
560 TheTarget->createMCDisassembler(*STI, Ctx));
561 assert(Disassembler && "Unable to create disassembler!");
562
563 std::unique_ptr<MCInstrInfo> MII(TheTarget->createMCInstrInfo());
564
565 std::unique_ptr<MCInstPrinter> InstPrinter(
Eric Christopherf8019402015-03-31 00:10:04 +0000566 TheTarget->createMCInstPrinter(Triple(TripleName), 0, *MAI, *MII, *MRI));
Lang Hamese1c11382014-06-27 20:20:57 +0000567
568 // Load any dylibs requested on the command line.
569 loadDylibs();
570
571 // Instantiate a dynamic linker.
572 TrivialMemoryManager MemMgr;
Lang Hames633fe142015-03-30 03:37:06 +0000573 RuntimeDyld Dyld(MemMgr, MemMgr);
Lang Hames925e51b2014-09-03 05:42:52 +0000574 Dyld.setProcessAllSections(true);
Lang Hamesf7acddd2014-07-22 22:47:39 +0000575 RuntimeDyldChecker Checker(Dyld, Disassembler.get(), InstPrinter.get(),
576 llvm::dbgs());
Lang Hamese1c11382014-06-27 20:20:57 +0000577
Lang Hamesc3246ad2015-04-15 21:18:41 +0000578 // FIXME: Preserve buffers until resolveRelocations time to work around a bug
579 // in RuntimeDyldELF.
580 // This fixme should be fixed ASAP. This is a very brittle workaround.
581 std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
582
Lang Hamese1c11382014-06-27 20:20:57 +0000583 // If we don't have any input files, read from stdin.
584 if (!InputFileList.size())
585 InputFileList.push_back("-");
586 for(unsigned i = 0, e = InputFileList.size(); i != e; ++i) {
587 // Load the input memory buffer.
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000588 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
589 MemoryBuffer::getFileOrSTDIN(InputFileList[i]);
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000590
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000591 if (std::error_code EC = InputBuffer.getError())
592 return Error("unable to read input: '" + EC.message() + "'");
Lang Hamese1c11382014-06-27 20:20:57 +0000593
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000594 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
595 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
596
597 if (std::error_code EC = MaybeObj.getError())
598 return Error("unable to create object file: '" + EC.message() + "'");
599
600 ObjectFile &Obj = **MaybeObj;
Lang Hamesc3246ad2015-04-15 21:18:41 +0000601 InputBuffers.push_back(std::move(*InputBuffer));
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000602
Lang Hamese1c11382014-06-27 20:20:57 +0000603 // Load the object file
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000604 Dyld.loadObject(Obj);
605 if (Dyld.hasError()) {
Lang Hamese1c11382014-06-27 20:20:57 +0000606 return Error(Dyld.getErrorString());
607 }
608 }
609
Lang Hames375385f2014-07-30 03:12:41 +0000610 // Re-map the section addresses into the phony target address space.
Lang Hames778ef5b2014-09-04 04:19:54 +0000611 remapSections(TheTriple, MemMgr, Checker);
Lang Hames375385f2014-07-30 03:12:41 +0000612
Lang Hamese1c11382014-06-27 20:20:57 +0000613 // Resolve all the relocations we can.
614 Dyld.resolveRelocations();
615
Lang Hames925e51b2014-09-03 05:42:52 +0000616 // Register EH frames.
617 Dyld.registerEHFrames();
618
Lang Hamesae172682014-08-05 20:51:46 +0000619 int ErrorCode = checkAllExpressions(Checker);
620 if (Dyld.hasError()) {
621 errs() << "RTDyld reported an error applying relocations:\n "
622 << Dyld.getErrorString() << "\n";
623 ErrorCode = 1;
624 }
625
626 return ErrorCode;
Lang Hamese1c11382014-06-27 20:20:57 +0000627}
628
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000629int main(int argc, char **argv) {
Alp Toker9f679322013-11-05 09:33:43 +0000630 sys::PrintStackTraceOnErrorSignal();
631 PrettyStackTraceProgram X(argc, argv);
632
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000633 ProgramName = argv[0];
634 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
635
Lang Hamese1c11382014-06-27 20:20:57 +0000636 llvm::InitializeAllTargetInfos();
637 llvm::InitializeAllTargetMCs();
638 llvm::InitializeAllDisassemblers();
639
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000640 cl::ParseCommandLineOptions(argc, argv, "llvm MC-JIT tool\n");
641
642 switch (Action) {
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000643 case AC_Execute:
Jim Grosbach4d5284b2011-03-18 17:24:21 +0000644 return executeInput();
Keno Fischerc780e8e2015-05-21 21:24:32 +0000645 case AC_PrintDebugLineInfo:
Keno Fischer281b6942015-05-30 19:44:53 +0000646 return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */ true);
Andrew Kaylord55d7012013-01-25 22:50:58 +0000647 case AC_PrintLineInfo:
Keno Fischer281b6942015-05-30 19:44:53 +0000648 return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */false);
649 case AC_PrintObjectLineInfo:
650 return printLineInfoForInput(/* LoadObjects */false,/* UseDebugObj */false);
Lang Hamese1c11382014-06-27 20:20:57 +0000651 case AC_Verify:
652 return linkAndVerify();
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000653 }
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000654}