blob: 1bcd8900a27725497c6d439599355199a55ffa16 [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",
Lang Hames78937c22015-07-04 01:35:26 +0000118 cl::desc("For -verify only: Map a section to a "
119 "specific address."),
120 cl::ZeroOrMore,
121 cl::Hidden);
122
123static cl::list<std::string>
124DummySymbolMappings("dummy-extern",
125 cl::desc("For -verify only: Inject a symbol into the extern "
126 "symbol table."),
127 cl::ZeroOrMore,
128 cl::Hidden);
Lang Hames778ef5b2014-09-04 04:19:54 +0000129
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000130/* *** */
131
Jim Grosbach2dcef0502011-04-04 23:04:39 +0000132// A trivial memory manager that doesn't do anything fancy, just uses the
133// support library allocation routines directly.
134class TrivialMemoryManager : public RTDyldMemoryManager {
135public:
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000136 SmallVector<sys::MemoryBlock, 16> FunctionMemory;
Jim Grosbacheff0a402012-01-16 22:26:39 +0000137 SmallVector<sys::MemoryBlock, 16> DataMemory;
138
139 uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
Craig Toppere56917c2014-03-08 08:27:28 +0000140 unsigned SectionID,
141 StringRef SectionName) override;
Jim Grosbacheff0a402012-01-16 22:26:39 +0000142 uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
Filip Pizlo7aa695e02013-10-02 00:59:25 +0000143 unsigned SectionID, StringRef SectionName,
Craig Toppere56917c2014-03-08 08:27:28 +0000144 bool IsReadOnly) override;
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000145
Craig Toppere56917c2014-03-08 08:27:28 +0000146 void *getPointerToNamedFunction(const std::string &Name,
147 bool AbortOnFailure = true) override {
Craig Toppere6cb63e2014-04-25 04:24:47 +0000148 return nullptr;
Danil Malyshevbfee5422012-03-28 21:46:36 +0000149 }
150
Craig Toppere56917c2014-03-08 08:27:28 +0000151 bool finalizeMemory(std::string *ErrMsg) override { return false; }
Andrew Kaylora342cb92012-11-15 23:50:01 +0000152
Danil Malyshev8c17fbd2012-05-16 18:50:11 +0000153 // Invalidate instruction cache for sections with execute permissions.
154 // Some platforms with separate data cache and instruction cache require
155 // explicit cache flush, otherwise JIT code manipulations (like resolved
156 // relocations) will get to the data cache but not to the instruction cache.
157 virtual void invalidateInstructionCache();
Tim Northover5af339a2015-06-03 18:26:52 +0000158
Lang Hames78937c22015-07-04 01:35:26 +0000159 void addDummySymbol(const std::string &Name, uint64_t Addr) {
160 DummyExterns[Name] = Addr;
161 }
162
163 RuntimeDyld::SymbolInfo findSymbol(const std::string &Name) override {
164 auto I = DummyExterns.find(Name);
165
166 if (I != DummyExterns.end())
167 return RuntimeDyld::SymbolInfo(I->second, JITSymbolFlags::Exported);
168
169 return RTDyldMemoryManager::findSymbol(Name);
170 }
171
Tim Northover5af339a2015-06-03 18:26:52 +0000172 void registerEHFrames(uint8_t *Addr, uint64_t LoadAddr,
173 size_t Size) override {}
174 void deregisterEHFrames(uint8_t *Addr, uint64_t LoadAddr,
175 size_t Size) override {}
Lang Hames78937c22015-07-04 01:35:26 +0000176private:
177 std::map<std::string, uint64_t> DummyExterns;
Jim Grosbach2dcef0502011-04-04 23:04:39 +0000178};
179
Jim Grosbacheff0a402012-01-16 22:26:39 +0000180uint8_t *TrivialMemoryManager::allocateCodeSection(uintptr_t Size,
181 unsigned Alignment,
Filip Pizlo7aa695e02013-10-02 00:59:25 +0000182 unsigned SectionID,
183 StringRef SectionName) {
Craig Toppere6cb63e2014-04-25 04:24:47 +0000184 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, nullptr);
Danil Malyshev8c17fbd2012-05-16 18:50:11 +0000185 FunctionMemory.push_back(MB);
186 return (uint8_t*)MB.base();
Jim Grosbacheff0a402012-01-16 22:26:39 +0000187}
188
189uint8_t *TrivialMemoryManager::allocateDataSection(uintptr_t Size,
190 unsigned Alignment,
Andrew Kaylora342cb92012-11-15 23:50:01 +0000191 unsigned SectionID,
Filip Pizlo7aa695e02013-10-02 00:59:25 +0000192 StringRef SectionName,
Andrew Kaylora342cb92012-11-15 23:50:01 +0000193 bool IsReadOnly) {
Craig Toppere6cb63e2014-04-25 04:24:47 +0000194 sys::MemoryBlock MB = sys::Memory::AllocateRWX(Size, nullptr, nullptr);
Danil Malyshev8c17fbd2012-05-16 18:50:11 +0000195 DataMemory.push_back(MB);
196 return (uint8_t*)MB.base();
197}
198
199void TrivialMemoryManager::invalidateInstructionCache() {
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000200 for (auto &FM : FunctionMemory)
201 sys::Memory::InvalidateInstructionCache(FM.base(), FM.size());
Danil Malyshev8c17fbd2012-05-16 18:50:11 +0000202
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000203 for (auto &DM : DataMemory)
204 sys::Memory::InvalidateInstructionCache(DM.base(), DM.size());
Jim Grosbacheff0a402012-01-16 22:26:39 +0000205}
206
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000207static const char *ProgramName;
208
209static void Message(const char *Type, const Twine &Msg) {
210 errs() << ProgramName << ": " << Type << ": " << Msg << "\n";
211}
212
213static int Error(const Twine &Msg) {
214 Message("error", Msg);
215 return 1;
216}
217
Lang Hamesd311c0e2014-05-13 22:37:41 +0000218static void loadDylibs() {
219 for (const std::string &Dylib : Dylibs) {
220 if (sys::fs::is_regular_file(Dylib)) {
221 std::string ErrMsg;
222 if (sys::DynamicLibrary::LoadLibraryPermanently(Dylib.c_str(), &ErrMsg))
223 llvm::errs() << "Error loading '" << Dylib << "': "
224 << ErrMsg << "\n";
225 } else
226 llvm::errs() << "Dylib not found: '" << Dylib << "'.\n";
227 }
228}
229
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000230/* *** */
231
Keno Fischerc780e8e2015-05-21 21:24:32 +0000232static int printLineInfoForInput(bool LoadObjects, bool UseDebugObj) {
233 assert(LoadObjects || !UseDebugObj);
234
Lang Hamesd311c0e2014-05-13 22:37:41 +0000235 // Load any dylibs requested on the command line.
236 loadDylibs();
237
Andrew Kaylord55d7012013-01-25 22:50:58 +0000238 // If we don't have any input files, read from stdin.
239 if (!InputFileList.size())
240 InputFileList.push_back("-");
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000241 for (auto &File : InputFileList) {
Andrew Kaylord55d7012013-01-25 22:50:58 +0000242 // Instantiate a dynamic linker.
Benjamin Kramer9ce77082013-08-03 22:16:31 +0000243 TrivialMemoryManager MemMgr;
Lang Hames633fe142015-03-30 03:37:06 +0000244 RuntimeDyld Dyld(MemMgr, MemMgr);
Andrew Kaylord55d7012013-01-25 22:50:58 +0000245
246 // Load the input memory buffer.
Andrew Kaylord55d7012013-01-25 22:50:58 +0000247
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000248 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000249 MemoryBuffer::getFileOrSTDIN(File);
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000250 if (std::error_code EC = InputBuffer.getError())
251 return Error("unable to read input: '" + EC.message() + "'");
252
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000253 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
254 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
255
256 if (std::error_code EC = MaybeObj.getError())
257 return Error("unable to create object file: '" + EC.message() + "'");
258
259 ObjectFile &Obj = **MaybeObj;
260
Keno Fischerc780e8e2015-05-21 21:24:32 +0000261 OwningBinary<ObjectFile> DebugObj;
262 std::unique_ptr<RuntimeDyld::LoadedObjectInfo> LoadedObjInfo = nullptr;
263 ObjectFile *SymbolObj = &Obj;
264 if (LoadObjects) {
265 // Load the object file
266 LoadedObjInfo =
267 Dyld.loadObject(Obj);
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000268
Keno Fischerc780e8e2015-05-21 21:24:32 +0000269 if (Dyld.hasError())
270 return Error(Dyld.getErrorString());
Andrew Kaylord55d7012013-01-25 22:50:58 +0000271
Keno Fischerc780e8e2015-05-21 21:24:32 +0000272 // Resolve all the relocations we can.
273 Dyld.resolveRelocations();
Andrew Kaylord55d7012013-01-25 22:50:58 +0000274
Keno Fischerc780e8e2015-05-21 21:24:32 +0000275 if (UseDebugObj) {
276 DebugObj = LoadedObjInfo->getObjectForDebug(Obj);
277 SymbolObj = DebugObj.getBinary();
Lang Hames5c969332015-07-28 20:51:53 +0000278 LoadedObjInfo.reset();
Keno Fischerc780e8e2015-05-21 21:24:32 +0000279 }
280 }
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000281
Ahmed Charles56440fd2014-03-06 05:51:42 +0000282 std::unique_ptr<DIContext> Context(
Keno Fischerc780e8e2015-05-21 21:24:32 +0000283 new DWARFContextInMemory(*SymbolObj,LoadedObjInfo.get()));
Andrew Kaylord55d7012013-01-25 22:50:58 +0000284
Rafael Espindola6bf32212015-06-24 19:57:32 +0000285 std::vector<std::pair<SymbolRef, uint64_t>> SymAddr =
Rafael Espindolab109c032015-06-23 02:08:48 +0000286 object::computeSymbolSizes(*SymbolObj);
Rafael Espindolaa82ce1d2015-05-31 23:15:35 +0000287
Andrew Kaylord55d7012013-01-25 22:50:58 +0000288 // Use symbol info to iterate functions in the object.
Rafael Espindola6bf32212015-06-24 19:57:32 +0000289 for (const auto &P : SymAddr) {
Rafael Espindolab109c032015-06-23 02:08:48 +0000290 object::SymbolRef Sym = P.first;
Rafael Espindola2fa80cc2015-06-26 12:18:49 +0000291 if (Sym.getType() == object::SymbolRef::ST_Function) {
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000292 ErrorOr<StringRef> Name = Sym.getName();
293 if (!Name)
Rafael Espindolada176272015-05-31 22:13:51 +0000294 continue;
Rafael Espindolaed067c42015-07-03 18:19:00 +0000295 ErrorOr<uint64_t> AddrOrErr = Sym.getAddress();
296 if (!AddrOrErr)
Rafael Espindolada176272015-05-31 22:13:51 +0000297 continue;
Rafael Espindolaed067c42015-07-03 18:19:00 +0000298 uint64_t Addr = *AddrOrErr;
Rafael Espindolaa82ce1d2015-05-31 23:15:35 +0000299
Rafael Espindolab109c032015-06-23 02:08:48 +0000300 uint64_t Size = P.second;
Keno Fischerc780e8e2015-05-21 21:24:32 +0000301 // If we're not using the debug object, compute the address of the
302 // symbol in memory (rather than that in the unrelocated object file)
303 // and use that to query the DWARFContext.
304 if (!UseDebugObj && LoadObjects) {
Rafael Espindola8bab8892015-08-07 23:27:14 +0000305 object::section_iterator Sec = *Sym.getSection();
Keno Fischerc780e8e2015-05-21 21:24:32 +0000306 StringRef SecName;
307 Sec->getName(SecName);
308 uint64_t SectionLoadAddress =
Lang Hames2e88f4f2015-07-28 17:52:11 +0000309 LoadedObjInfo->getSectionLoadAddress(*Sec);
Keno Fischerc780e8e2015-05-21 21:24:32 +0000310 if (SectionLoadAddress != 0)
311 Addr += SectionLoadAddress - Sec->getAddress();
312 }
313
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000314 outs() << "Function: " << *Name << ", Size = " << Size
315 << ", Addr = " << Addr << "\n";
Andrew Kaylord55d7012013-01-25 22:50:58 +0000316
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000317 DILineInfoTable Lines = Context->getLineInfoForAddressRange(Addr, Size);
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000318 for (auto &D : Lines) {
319 outs() << " Line info @ " << D.first - Addr << ": "
320 << D.second.FileName << ", line:" << D.second.Line << "\n";
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000321 }
Andrew Kaylord55d7012013-01-25 22:50:58 +0000322 }
323 }
324 }
325
326 return 0;
327}
328
Jim Grosbach4d5284b2011-03-18 17:24:21 +0000329static int executeInput() {
Lang Hamesd311c0e2014-05-13 22:37:41 +0000330 // Load any dylibs requested on the command line.
331 loadDylibs();
332
Jim Grosbachf016b0a2011-03-21 22:15:52 +0000333 // Instantiate a dynamic linker.
Benjamin Kramer9ce77082013-08-03 22:16:31 +0000334 TrivialMemoryManager MemMgr;
Lang Hames633fe142015-03-30 03:37:06 +0000335 RuntimeDyld Dyld(MemMgr, MemMgr);
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000336
Lang Hamesc3246ad2015-04-15 21:18:41 +0000337 // FIXME: Preserve buffers until resolveRelocations time to work around a bug
338 // in RuntimeDyldELF.
339 // This fixme should be fixed ASAP. This is a very brittle workaround.
340 std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
341
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000342 // If we don't have any input files, read from stdin.
343 if (!InputFileList.size())
344 InputFileList.push_back("-");
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000345 for (auto &File : InputFileList) {
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000346 // Load the input memory buffer.
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000347 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000348 MemoryBuffer::getFileOrSTDIN(File);
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000349 if (std::error_code EC = InputBuffer.getError())
350 return Error("unable to read input: '" + EC.message() + "'");
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000351 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
352 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
353
354 if (std::error_code EC = MaybeObj.getError())
355 return Error("unable to create object file: '" + EC.message() + "'");
356
357 ObjectFile &Obj = **MaybeObj;
Lang Hamesc3246ad2015-04-15 21:18:41 +0000358 InputBuffers.push_back(std::move(*InputBuffer));
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000359
Andrew Kayloradc70562012-10-02 21:18:39 +0000360 // Load the object file
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000361 Dyld.loadObject(Obj);
362 if (Dyld.hasError()) {
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000363 return Error(Dyld.getErrorString());
364 }
Jim Grosbach40411cc2011-03-22 18:19:42 +0000365 }
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000366
Jim Grosbach733d3052011-04-12 21:20:41 +0000367 // Resolve all the relocations we can.
368 Dyld.resolveRelocations();
Danil Malyshev8c17fbd2012-05-16 18:50:11 +0000369 // Clear instruction cache before code will be executed.
Benjamin Kramer5d62ad22013-08-03 22:18:45 +0000370 MemMgr.invalidateInstructionCache();
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000371
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000372 // FIXME: Error out if there are unresolved relocations.
373
Jim Grosbachd35159a2011-04-13 15:38:30 +0000374 // Get the address of the entry point (_main by default).
Lang Hamesb1186032015-03-11 00:43:26 +0000375 void *MainAddress = Dyld.getSymbolLocalAddress(EntryPoint);
Craig Toppere6cb63e2014-04-25 04:24:47 +0000376 if (!MainAddress)
Jim Grosbachd35159a2011-04-13 15:38:30 +0000377 return Error("no definition for '" + EntryPoint + "'");
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000378
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000379 // Invalidate the instruction cache for each loaded function.
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000380 for (auto &FM : MemMgr.FunctionMemory) {
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000381 // Make sure the memory is executable.
382 std::string ErrorStr;
Davide Italiano5d7e8fd2015-10-12 00:57:29 +0000383 sys::Memory::InvalidateInstructionCache(FM.base(), FM.size());
384 if (!sys::Memory::setExecutable(FM, &ErrorStr))
Jim Grosbach3ed03f12011-04-12 00:23:32 +0000385 return Error("unable to mark function executable: '" + ErrorStr + "'");
386 }
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000387
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000388 // Dispatch to _main().
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000389 errs() << "loaded '" << EntryPoint << "' at: " << (void*)MainAddress << "\n";
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000390
391 int (*Main)(int, const char**) =
392 (int(*)(int,const char**)) uintptr_t(MainAddress);
393 const char **Argv = new const char*[2];
Jim Grosbach7cb41d72011-04-13 15:49:40 +0000394 // Use the name of the first input object module as argv[0] for the target.
395 Argv[0] = InputFileList[0].c_str();
Craig Toppere6cb63e2014-04-25 04:24:47 +0000396 Argv[1] = nullptr;
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000397 return Main(1, Argv);
398}
399
Lang Hamese1c11382014-06-27 20:20:57 +0000400static int checkAllExpressions(RuntimeDyldChecker &Checker) {
401 for (const auto& CheckerFileName : CheckFiles) {
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000402 ErrorOr<std::unique_ptr<MemoryBuffer>> CheckerFileBuf =
403 MemoryBuffer::getFileOrSTDIN(CheckerFileName);
404 if (std::error_code EC = CheckerFileBuf.getError())
Lang Hamese1c11382014-06-27 20:20:57 +0000405 return Error("unable to read input '" + CheckerFileName + "': " +
406 EC.message());
407
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000408 if (!Checker.checkAllRulesInBuffer("# rtdyld-check:",
409 CheckerFileBuf.get().get()))
Lang Hamese1c11382014-06-27 20:20:57 +0000410 return Error("some checks in '" + CheckerFileName + "' failed");
411 }
412 return 0;
413}
414
Benjamin Kramerf044d3f2015-03-09 16:23:46 +0000415static std::map<void *, uint64_t>
Lang Hames778ef5b2014-09-04 04:19:54 +0000416applySpecificSectionMappings(RuntimeDyldChecker &Checker) {
417
418 std::map<void*, uint64_t> SpecificMappings;
419
420 for (StringRef Mapping : SpecificSectionMappings) {
421
422 size_t EqualsIdx = Mapping.find_first_of("=");
Lang Hames78937c22015-07-04 01:35:26 +0000423 std::string SectionIDStr = Mapping.substr(0, EqualsIdx);
Lang Hames778ef5b2014-09-04 04:19:54 +0000424 size_t ComaIdx = Mapping.find_first_of(",");
425
426 if (ComaIdx == StringRef::npos) {
427 errs() << "Invalid section specification '" << Mapping
428 << "'. Should be '<file name>,<section name>=<addr>'\n";
429 exit(1);
430 }
431
Lang Hames78937c22015-07-04 01:35:26 +0000432 std::string FileName = SectionIDStr.substr(0, ComaIdx);
433 std::string SectionName = SectionIDStr.substr(ComaIdx + 1);
Lang Hames778ef5b2014-09-04 04:19:54 +0000434
435 uint64_t OldAddrInt;
436 std::string ErrorMsg;
437 std::tie(OldAddrInt, ErrorMsg) =
438 Checker.getSectionAddr(FileName, SectionName, true);
439
440 if (ErrorMsg != "") {
441 errs() << ErrorMsg;
442 exit(1);
443 }
444
445 void* OldAddr = reinterpret_cast<void*>(static_cast<uintptr_t>(OldAddrInt));
446
Lang Hames78937c22015-07-04 01:35:26 +0000447 std::string NewAddrStr = Mapping.substr(EqualsIdx + 1);
Lang Hames778ef5b2014-09-04 04:19:54 +0000448 uint64_t NewAddr;
449
Lang Hames78937c22015-07-04 01:35:26 +0000450 if (StringRef(NewAddrStr).getAsInteger(0, NewAddr)) {
451 errs() << "Invalid section address in mapping '" << Mapping << "'.\n";
Lang Hames778ef5b2014-09-04 04:19:54 +0000452 exit(1);
453 }
454
455 Checker.getRTDyld().mapSectionAddress(OldAddr, NewAddr);
456 SpecificMappings[OldAddr] = NewAddr;
457 }
458
459 return SpecificMappings;
460}
461
Lang Hames9cb73532014-07-29 23:43:13 +0000462// Scatter sections in all directions!
463// Remaps section addresses for -verify mode. The following command line options
464// can be used to customize the layout of the memory within the phony target's
465// address space:
466// -target-addr-start <s> -- Specify where the phony target addres range starts.
467// -target-addr-end <e> -- Specify where the phony target address range ends.
468// -target-section-sep <d> -- Specify how big a gap should be left between the
469// end of one section and the start of the next.
470// Defaults to zero. Set to something big
471// (e.g. 1 << 32) to stress-test stubs, GOTs, etc.
472//
Lang Hames78937c22015-07-04 01:35:26 +0000473static void remapSectionsAndSymbols(const llvm::Triple &TargetTriple,
474 TrivialMemoryManager &MemMgr,
475 RuntimeDyldChecker &Checker) {
Lang Hames778ef5b2014-09-04 04:19:54 +0000476
477 // Set up a work list (section addr/size pairs).
478 typedef std::list<std::pair<void*, uint64_t>> WorklistT;
479 WorklistT Worklist;
480
481 for (const auto& CodeSection : MemMgr.FunctionMemory)
482 Worklist.push_back(std::make_pair(CodeSection.base(), CodeSection.size()));
483 for (const auto& DataSection : MemMgr.DataMemory)
484 Worklist.push_back(std::make_pair(DataSection.base(), DataSection.size()));
485
486 // Apply any section-specific mappings that were requested on the command
487 // line.
488 typedef std::map<void*, uint64_t> AppliedMappingsT;
489 AppliedMappingsT AppliedMappings = applySpecificSectionMappings(Checker);
490
491 // Keep an "already allocated" mapping of section target addresses to sizes.
492 // Sections whose address mappings aren't specified on the command line will
493 // allocated around the explicitly mapped sections while maintaining the
494 // minimum separation.
495 std::map<uint64_t, uint64_t> AlreadyAllocated;
496
497 // Move the previously applied mappings into the already-allocated map.
498 for (WorklistT::iterator I = Worklist.begin(), E = Worklist.end();
499 I != E;) {
500 WorklistT::iterator Tmp = I;
501 ++I;
502 AppliedMappingsT::iterator AI = AppliedMappings.find(Tmp->first);
503
504 if (AI != AppliedMappings.end()) {
505 AlreadyAllocated[AI->second] = Tmp->second;
506 Worklist.erase(Tmp);
507 }
508 }
Lang Hames9cb73532014-07-29 23:43:13 +0000509
510 // If the -target-addr-end option wasn't explicitly passed, then set it to a
511 // sensible default based on the target triple.
512 if (TargetAddrEnd.getNumOccurrences() == 0) {
513 if (TargetTriple.isArch16Bit())
514 TargetAddrEnd = (1ULL << 16) - 1;
515 else if (TargetTriple.isArch32Bit())
516 TargetAddrEnd = (1ULL << 32) - 1;
517 // TargetAddrEnd already has a sensible default for 64-bit systems, so
518 // there's nothing to do in the 64-bit case.
519 }
520
Lang Hames778ef5b2014-09-04 04:19:54 +0000521 // Process any elements remaining in the worklist.
522 while (!Worklist.empty()) {
523 std::pair<void*, uint64_t> CurEntry = Worklist.front();
524 Worklist.pop_front();
Lang Hames9cb73532014-07-29 23:43:13 +0000525
Lang Hames778ef5b2014-09-04 04:19:54 +0000526 uint64_t NextSectionAddr = TargetAddrStart;
527
528 for (const auto &Alloc : AlreadyAllocated)
529 if (NextSectionAddr + CurEntry.second + TargetSectionSep <= Alloc.first)
530 break;
531 else
532 NextSectionAddr = Alloc.first + Alloc.second + TargetSectionSep;
533
534 AlreadyAllocated[NextSectionAddr] = CurEntry.second;
535 Checker.getRTDyld().mapSectionAddress(CurEntry.first, NextSectionAddr);
Lang Hames9cb73532014-07-29 23:43:13 +0000536 }
537
Lang Hames78937c22015-07-04 01:35:26 +0000538 // Add dummy symbols to the memory manager.
539 for (const auto &Mapping : DummySymbolMappings) {
540 size_t EqualsIdx = Mapping.find_first_of("=");
541
542 if (EqualsIdx == StringRef::npos) {
543 errs() << "Invalid dummy symbol specification '" << Mapping
544 << "'. Should be '<symbol name>=<addr>'\n";
545 exit(1);
546 }
547
548 std::string Symbol = Mapping.substr(0, EqualsIdx);
549 std::string AddrStr = Mapping.substr(EqualsIdx + 1);
550
551 uint64_t Addr;
552 if (StringRef(AddrStr).getAsInteger(0, Addr)) {
553 errs() << "Invalid symbol mapping '" << Mapping << "'.\n";
554 exit(1);
555 }
556
557 MemMgr.addDummySymbol(Symbol, Addr);
558 }
Lang Hames9cb73532014-07-29 23:43:13 +0000559}
560
561// Load and link the objects specified on the command line, but do not execute
562// anything. Instead, attach a RuntimeDyldChecker instance and call it to
563// verify the correctness of the linked memory.
Lang Hamese1c11382014-06-27 20:20:57 +0000564static int linkAndVerify() {
565
566 // Check for missing triple.
567 if (TripleName == "") {
568 llvm::errs() << "Error: -triple required when running in -verify mode.\n";
569 return 1;
570 }
571
572 // Look up the target and build the disassembler.
573 Triple TheTriple(Triple::normalize(TripleName));
574 std::string ErrorStr;
575 const Target *TheTarget =
576 TargetRegistry::lookupTarget("", TheTriple, ErrorStr);
577 if (!TheTarget) {
578 llvm::errs() << "Error accessing target '" << TripleName << "': "
579 << ErrorStr << "\n";
580 return 1;
581 }
582 TripleName = TheTriple.getTriple();
583
584 std::unique_ptr<MCSubtargetInfo> STI(
Petar Jovanovic280e5622015-06-23 22:52:19 +0000585 TheTarget->createMCSubtargetInfo(TripleName, MCPU, ""));
Lang Hamese1c11382014-06-27 20:20:57 +0000586 assert(STI && "Unable to create subtarget info!");
587
588 std::unique_ptr<MCRegisterInfo> MRI(TheTarget->createMCRegInfo(TripleName));
589 assert(MRI && "Unable to create target register info!");
590
591 std::unique_ptr<MCAsmInfo> MAI(TheTarget->createMCAsmInfo(*MRI, TripleName));
592 assert(MAI && "Unable to create target asm info!");
593
594 MCContext Ctx(MAI.get(), MRI.get(), nullptr);
595
596 std::unique_ptr<MCDisassembler> Disassembler(
597 TheTarget->createMCDisassembler(*STI, Ctx));
598 assert(Disassembler && "Unable to create disassembler!");
599
600 std::unique_ptr<MCInstrInfo> MII(TheTarget->createMCInstrInfo());
601
Daniel Sanders50f17232015-09-15 16:17:27 +0000602 std::unique_ptr<MCInstPrinter> InstPrinter(
603 TheTarget->createMCInstPrinter(Triple(TripleName), 0, *MAI, *MII, *MRI));
Lang Hamese1c11382014-06-27 20:20:57 +0000604
605 // Load any dylibs requested on the command line.
606 loadDylibs();
607
608 // Instantiate a dynamic linker.
609 TrivialMemoryManager MemMgr;
Lang Hames633fe142015-03-30 03:37:06 +0000610 RuntimeDyld Dyld(MemMgr, MemMgr);
Lang Hames925e51b2014-09-03 05:42:52 +0000611 Dyld.setProcessAllSections(true);
Lang Hamesf7acddd2014-07-22 22:47:39 +0000612 RuntimeDyldChecker Checker(Dyld, Disassembler.get(), InstPrinter.get(),
613 llvm::dbgs());
Lang Hamese1c11382014-06-27 20:20:57 +0000614
Lang Hamesc3246ad2015-04-15 21:18:41 +0000615 // FIXME: Preserve buffers until resolveRelocations time to work around a bug
616 // in RuntimeDyldELF.
617 // This fixme should be fixed ASAP. This is a very brittle workaround.
618 std::vector<std::unique_ptr<MemoryBuffer>> InputBuffers;
619
Lang Hamese1c11382014-06-27 20:20:57 +0000620 // If we don't have any input files, read from stdin.
621 if (!InputFileList.size())
622 InputFileList.push_back("-");
Davide Italianod91bf8e2015-10-10 00:45:24 +0000623 for (auto &Filename : InputFileList) {
Lang Hamese1c11382014-06-27 20:20:57 +0000624 // Load the input memory buffer.
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000625 ErrorOr<std::unique_ptr<MemoryBuffer>> InputBuffer =
Davide Italianod91bf8e2015-10-10 00:45:24 +0000626 MemoryBuffer::getFileOrSTDIN(Filename);
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000627
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000628 if (std::error_code EC = InputBuffer.getError())
629 return Error("unable to read input: '" + EC.message() + "'");
Lang Hamese1c11382014-06-27 20:20:57 +0000630
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000631 ErrorOr<std::unique_ptr<ObjectFile>> MaybeObj(
632 ObjectFile::createObjectFile((*InputBuffer)->getMemBufferRef()));
633
634 if (std::error_code EC = MaybeObj.getError())
635 return Error("unable to create object file: '" + EC.message() + "'");
636
637 ObjectFile &Obj = **MaybeObj;
Lang Hamesc3246ad2015-04-15 21:18:41 +0000638 InputBuffers.push_back(std::move(*InputBuffer));
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000639
Lang Hamese1c11382014-06-27 20:20:57 +0000640 // Load the object file
Lang Hamesb5c7b1f2014-11-26 16:54:40 +0000641 Dyld.loadObject(Obj);
642 if (Dyld.hasError()) {
Lang Hamese1c11382014-06-27 20:20:57 +0000643 return Error(Dyld.getErrorString());
644 }
645 }
646
Lang Hames78937c22015-07-04 01:35:26 +0000647 // Re-map the section addresses into the phony target address space and add
648 // dummy symbols.
649 remapSectionsAndSymbols(TheTriple, MemMgr, Checker);
Lang Hames375385f2014-07-30 03:12:41 +0000650
Lang Hamese1c11382014-06-27 20:20:57 +0000651 // Resolve all the relocations we can.
652 Dyld.resolveRelocations();
653
Lang Hames925e51b2014-09-03 05:42:52 +0000654 // Register EH frames.
655 Dyld.registerEHFrames();
656
Lang Hamesae172682014-08-05 20:51:46 +0000657 int ErrorCode = checkAllExpressions(Checker);
658 if (Dyld.hasError()) {
659 errs() << "RTDyld reported an error applying relocations:\n "
660 << Dyld.getErrorString() << "\n";
661 ErrorCode = 1;
662 }
663
664 return ErrorCode;
Lang Hamese1c11382014-06-27 20:20:57 +0000665}
666
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000667int main(int argc, char **argv) {
Alp Toker9f679322013-11-05 09:33:43 +0000668 sys::PrintStackTraceOnErrorSignal();
669 PrettyStackTraceProgram X(argc, argv);
670
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000671 ProgramName = argv[0];
672 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
673
Lang Hamese1c11382014-06-27 20:20:57 +0000674 llvm::InitializeAllTargetInfos();
675 llvm::InitializeAllTargetMCs();
676 llvm::InitializeAllDisassemblers();
677
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000678 cl::ParseCommandLineOptions(argc, argv, "llvm MC-JIT tool\n");
679
680 switch (Action) {
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000681 case AC_Execute:
Jim Grosbach4d5284b2011-03-18 17:24:21 +0000682 return executeInput();
Keno Fischerc780e8e2015-05-21 21:24:32 +0000683 case AC_PrintDebugLineInfo:
Keno Fischer281b6942015-05-30 19:44:53 +0000684 return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */ true);
Andrew Kaylord55d7012013-01-25 22:50:58 +0000685 case AC_PrintLineInfo:
Keno Fischer281b6942015-05-30 19:44:53 +0000686 return printLineInfoForInput(/* LoadObjects */ true,/* UseDebugObj */false);
687 case AC_PrintObjectLineInfo:
688 return printLineInfoForInput(/* LoadObjects */false,/* UseDebugObj */false);
Lang Hamese1c11382014-06-27 20:20:57 +0000689 case AC_Verify:
690 return linkAndVerify();
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000691 }
Jim Grosbach0072cdb2011-03-18 17:11:39 +0000692}