blob: 48018c365266014cb1f47020f2aac53fa1f59860 [file] [log] [blame]
Michael J. Spencer2670c252011-01-20 06:39:06 +00001//===-- llvm-objdump.cpp - Object file dumping utility for llvm -----------===//
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 program is a utility that works like binutils "objdump", that is, it
11// dumps out a plethora of information about an object file depending on the
12// flags.
13//
Michael J. Spencerd7e70032013-02-05 20:27:22 +000014// The flags and output of this program should be near identical to those of
15// binutils objdump.
16//
Michael J. Spencer2670c252011-01-20 06:39:06 +000017//===----------------------------------------------------------------------===//
18
Benjamin Kramer43a772e2011-09-19 17:56:04 +000019#include "llvm-objdump.h"
Sanjoy Das6f567a42015-06-22 18:03:02 +000020#include "llvm/ADT/Optional.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000021#include "llvm/ADT/STLExtras.h"
Michael J. Spencer4e25c022011-10-17 17:13:22 +000022#include "llvm/ADT/StringExtras.h"
Rafael Aulerb0e4b912018-03-09 19:13:44 +000023#include "llvm/ADT/StringSet.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000024#include "llvm/ADT/Triple.h"
Sanjoy Das3f1bc3b2015-06-23 20:09:03 +000025#include "llvm/CodeGen/FaultMaps.h"
Igor Laevsky03a670c2016-01-26 15:09:42 +000026#include "llvm/DebugInfo/DWARF/DWARFContext.h"
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +000027#include "llvm/DebugInfo/Symbolize/Symbolize.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000028#include "llvm/MC/MCAsmInfo.h"
Ahmed Bougachaad1084d2013-05-24 00:39:57 +000029#include "llvm/MC/MCContext.h"
Benjamin Kramerf57c1972016-01-26 16:44:37 +000030#include "llvm/MC/MCDisassembler/MCDisassembler.h"
31#include "llvm/MC/MCDisassembler/MCRelocationInfo.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000032#include "llvm/MC/MCInst.h"
33#include "llvm/MC/MCInstPrinter.h"
Ahmed Bougachaaa790682013-05-24 01:07:04 +000034#include "llvm/MC/MCInstrAnalysis.h"
Craig Topper54bfde72012-04-02 06:09:36 +000035#include "llvm/MC/MCInstrInfo.h"
Ahmed Bougachaad1084d2013-05-24 00:39:57 +000036#include "llvm/MC/MCObjectFileInfo.h"
Jim Grosbachfd93a592012-03-05 19:33:20 +000037#include "llvm/MC/MCRegisterInfo.h"
Ahmed Bougachaaa790682013-05-24 01:07:04 +000038#include "llvm/MC/MCSubtargetInfo.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000039#include "llvm/Object/Archive.h"
40#include "llvm/Object/COFF.h"
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +000041#include "llvm/Object/COFFImportFile.h"
Benjamin Kramerf57c1972016-01-26 16:44:37 +000042#include "llvm/Object/ELFObjectFile.h"
Rafael Espindolaa9f810b2012-12-21 03:47:03 +000043#include "llvm/Object/MachO.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000044#include "llvm/Object/ObjectFile.h"
Sam Clegg4df5d762017-06-27 20:40:53 +000045#include "llvm/Object/Wasm.h"
Michael J. Spencerba4a3622011-10-08 00:18:30 +000046#include "llvm/Support/Casting.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000047#include "llvm/Support/CommandLine.h"
48#include "llvm/Support/Debug.h"
Alexey Samsonov50d0fbd2015-06-04 18:34:11 +000049#include "llvm/Support/Errc.h"
Michael J. Spencerba4a3622011-10-08 00:18:30 +000050#include "llvm/Support/FileSystem.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000051#include "llvm/Support/Format.h"
Benjamin Kramerbf115312011-07-25 23:04:36 +000052#include "llvm/Support/GraphWriter.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000053#include "llvm/Support/Host.h"
Rui Ueyama197194b2018-04-13 18:26:06 +000054#include "llvm/Support/InitLLVM.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000055#include "llvm/Support/MemoryBuffer.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000056#include "llvm/Support/SourceMgr.h"
Evan Cheng2bb40352011-08-24 18:08:43 +000057#include "llvm/Support/TargetRegistry.h"
58#include "llvm/Support/TargetSelect.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000059#include "llvm/Support/raw_ostream.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000060#include <algorithm>
Benjamin Kramera5177e62012-03-23 11:49:32 +000061#include <cctype>
Michael J. Spencer2670c252011-01-20 06:39:06 +000062#include <cstring>
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000063#include <system_error>
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +000064#include <unordered_map>
Rafael Espindolac398e672017-07-19 22:27:28 +000065#include <utility>
Ahmed Bougacha17926472013-08-21 07:29:02 +000066
Michael J. Spencer2670c252011-01-20 06:39:06 +000067using namespace llvm;
68using namespace object;
69
Benjamin Kramer43a772e2011-09-19 17:56:04 +000070static cl::list<std::string>
71InputFilenames(cl::Positional, cl::desc("<input object files>"),cl::ZeroOrMore);
Michael J. Spencer2670c252011-01-20 06:39:06 +000072
Kevin Enderbye2297dd2015-01-07 21:02:18 +000073cl::opt<bool>
74llvm::Disassemble("disassemble",
Benjamin Kramer43a772e2011-09-19 17:56:04 +000075 cl::desc("Display assembler mnemonics for the machine instructions"));
76static cl::alias
77Disassembled("d", cl::desc("Alias for --disassemble"),
Colin LeMahieu77804be2015-07-29 15:45:39 +000078 cl::aliasopt(Disassemble));
79
80cl::opt<bool>
81llvm::DisassembleAll("disassemble-all",
82 cl::desc("Display assembler mnemonics for the machine instructions"));
83static cl::alias
84DisassembleAlld("D", cl::desc("Alias for --disassemble-all"),
Colin LeMahieuf34933e2015-07-23 20:58:49 +000085 cl::aliasopt(DisassembleAll));
Michael J. Spencer2670c252011-01-20 06:39:06 +000086
Rafael Aulerb0e4b912018-03-09 19:13:44 +000087static cl::list<std::string>
88DisassembleFunctions("df",
89 cl::CommaSeparated,
90 cl::desc("List of functions to disassemble"));
91static StringSet<> DisasmFuncsSet;
92
Kevin Enderby98da6132015-01-20 21:47:46 +000093cl::opt<bool>
94llvm::Relocations("r", cl::desc("Display the relocation entries in the file"));
Michael J. Spencerba4a3622011-10-08 00:18:30 +000095
Kevin Enderby98da6132015-01-20 21:47:46 +000096cl::opt<bool>
97llvm::SectionContents("s", cl::desc("Display the content of each section"));
Michael J. Spencer4e25c022011-10-17 17:13:22 +000098
Kevin Enderby98da6132015-01-20 21:47:46 +000099cl::opt<bool>
100llvm::SymbolTable("t", cl::desc("Display the symbol table"));
Michael J. Spencerbfa06782011-10-18 19:32:17 +0000101
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000102cl::opt<bool>
103llvm::ExportsTrie("exports-trie", cl::desc("Display mach-o exported symbols"));
Nick Kledzikd04bc352014-08-30 00:20:14 +0000104
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000105cl::opt<bool>
106llvm::Rebase("rebase", cl::desc("Display mach-o rebasing info"));
Nick Kledzikac431442014-09-12 21:34:15 +0000107
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000108cl::opt<bool>
109llvm::Bind("bind", cl::desc("Display mach-o binding info"));
Nick Kledzik56ebef42014-09-16 01:41:51 +0000110
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000111cl::opt<bool>
112llvm::LazyBind("lazy-bind", cl::desc("Display mach-o lazy binding info"));
Nick Kledzik56ebef42014-09-16 01:41:51 +0000113
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000114cl::opt<bool>
115llvm::WeakBind("weak-bind", cl::desc("Display mach-o weak binding info"));
Nick Kledzik56ebef42014-09-16 01:41:51 +0000116
Adrian Prantl437105a2015-07-08 02:04:15 +0000117cl::opt<bool>
118llvm::RawClangAST("raw-clang-ast",
119 cl::desc("Dump the raw binary contents of the clang AST section"));
120
Nick Kledzik56ebef42014-09-16 01:41:51 +0000121static cl::opt<bool>
Rafael Espindolaa9f810b2012-12-21 03:47:03 +0000122MachOOpt("macho", cl::desc("Use MachO specific object file parser"));
Benjamin Kramer43a772e2011-09-19 17:56:04 +0000123static cl::alias
Rafael Espindolaa9f810b2012-12-21 03:47:03 +0000124MachOm("m", cl::desc("Alias for --macho"), cl::aliasopt(MachOOpt));
Benjamin Kramer87ee76c2011-07-20 19:37:35 +0000125
Benjamin Kramer43a772e2011-09-19 17:56:04 +0000126cl::opt<std::string>
127llvm::TripleName("triple", cl::desc("Target triple to disassemble for, "
128 "see -version for available targets"));
129
130cl::opt<std::string>
Kevin Enderbyc9595622014-08-06 23:24:41 +0000131llvm::MCPU("mcpu",
132 cl::desc("Target a specific cpu type (-mcpu=help for details)"),
133 cl::value_desc("cpu-name"),
134 cl::init(""));
135
136cl::opt<std::string>
Kevin Enderbyef3ad2f2014-12-04 23:56:27 +0000137llvm::ArchName("arch-name", cl::desc("Target arch to disassemble for, "
Michael J. Spencer2670c252011-01-20 06:39:06 +0000138 "see -version for available targets"));
139
Kevin Enderby98da6132015-01-20 21:47:46 +0000140cl::opt<bool>
141llvm::SectionHeaders("section-headers", cl::desc("Display summaries of the "
142 "headers for each section."));
Nick Lewyckyfcf84622011-10-10 21:21:34 +0000143static cl::alias
144SectionHeadersShort("headers", cl::desc("Alias for --section-headers"),
145 cl::aliasopt(SectionHeaders));
146static cl::alias
147SectionHeadersShorter("h", cl::desc("Alias for --section-headers"),
148 cl::aliasopt(SectionHeaders));
Colin LeMahieufcc32762015-07-29 19:08:10 +0000149
Colin LeMahieu77804be2015-07-29 15:45:39 +0000150cl::list<std::string>
Colin LeMahieufcc32762015-07-29 19:08:10 +0000151llvm::FilterSections("section", cl::desc("Operate on the specified sections only. "
152 "With -macho dump segment,section"));
153cl::alias
154static FilterSectionsj("j", cl::desc("Alias for --section"),
155 cl::aliasopt(llvm::FilterSections));
Nick Lewyckyfcf84622011-10-10 21:21:34 +0000156
Kevin Enderbyc9595622014-08-06 23:24:41 +0000157cl::list<std::string>
158llvm::MAttrs("mattr",
Jack Carter551efd72012-08-28 19:24:49 +0000159 cl::CommaSeparated,
160 cl::desc("Target specific attributes"),
161 cl::value_desc("a1,+a2,-a3,..."));
162
Kevin Enderbybf246f52014-09-24 23:08:22 +0000163cl::opt<bool>
164llvm::NoShowRawInsn("no-show-raw-insn", cl::desc("When disassembling "
165 "instructions, do not print "
166 "the instruction bytes."));
Saleem Abdulrasooldea14b22017-02-08 18:11:31 +0000167cl::opt<bool>
168llvm::NoLeadingAddr("no-leading-addr", cl::desc("Print no leading address"));
Eli Bendersky3a6808c2012-11-20 22:57:02 +0000169
Kevin Enderby98da6132015-01-20 21:47:46 +0000170cl::opt<bool>
171llvm::UnwindInfo("unwind-info", cl::desc("Display unwind information"));
Michael J. Spencer0c6ec482012-12-05 20:12:35 +0000172
173static cl::alias
174UnwindInfoShort("u", cl::desc("Alias for --unwind-info"),
175 cl::aliasopt(UnwindInfo));
176
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000177cl::opt<bool>
178llvm::PrivateHeaders("private-headers",
179 cl::desc("Display format specific file headers"));
Michael J. Spencer209565db2013-01-06 03:56:49 +0000180
Kevin Enderby0ae163f2016-01-13 00:25:36 +0000181cl::opt<bool>
182llvm::FirstPrivateHeader("private-header",
183 cl::desc("Display only the first format specific file "
184 "header"));
185
Michael J. Spencer209565db2013-01-06 03:56:49 +0000186static cl::alias
187PrivateHeadersShort("p", cl::desc("Alias for --private-headers"),
188 cl::aliasopt(PrivateHeaders));
189
Colin LeMahieu14ec76e2015-06-07 21:07:17 +0000190cl::opt<bool>
191 llvm::PrintImmHex("print-imm-hex",
Colin LeMahieuefe37322016-04-08 18:15:37 +0000192 cl::desc("Use hex format for immediate values"));
Colin LeMahieu14ec76e2015-06-07 21:07:17 +0000193
Sanjoy Das6f567a42015-06-22 18:03:02 +0000194cl::opt<bool> PrintFaultMaps("fault-map-section",
195 cl::desc("Display contents of faultmap section"));
196
Igor Laevsky03a670c2016-01-26 15:09:42 +0000197cl::opt<DIDumpType> llvm::DwarfDumpType(
198 "dwarf", cl::init(DIDT_Null), cl::desc("Dump of dwarf debug sections:"),
Jonas Devliegherec0a758d2017-09-18 14:15:57 +0000199 cl::values(clEnumValN(DIDT_DebugFrame, "frames", ".debug_frame")));
Igor Laevsky03a670c2016-01-26 15:09:42 +0000200
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +0000201cl::opt<bool> PrintSource(
202 "source",
203 cl::desc(
Alex Denisova07169e2018-02-02 19:20:37 +0000204 "Display source inlined with disassembly. Implies disassemble object"));
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +0000205
206cl::alias PrintSourceShort("S", cl::desc("Alias for -source"),
207 cl::aliasopt(PrintSource));
208
209cl::opt<bool> PrintLines("line-numbers",
210 cl::desc("Display source line numbers with "
211 "disassembly. Implies disassemble object"));
212
213cl::alias PrintLinesShort("l", cl::desc("Alias for -line-numbers"),
214 cl::aliasopt(PrintLines));
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +0000215
216cl::opt<unsigned long long>
217 StartAddress("start-address", cl::desc("Disassemble beginning at address"),
218 cl::value_desc("address"), cl::init(0));
219cl::opt<unsigned long long>
220 StopAddress("stop-address", cl::desc("Stop disassembly at address"),
221 cl::value_desc("address"), cl::init(UINT64_MAX));
Benjamin Kramer43a772e2011-09-19 17:56:04 +0000222static StringRef ToolName;
Michael J. Spencer2670c252011-01-20 06:39:06 +0000223
Sam Parker5fba45a2017-02-08 09:44:18 +0000224typedef std::vector<std::tuple<uint64_t, StringRef, uint8_t>> SectionSymbolsTy;
225
Colin LeMahieu77804be2015-07-29 15:45:39 +0000226namespace {
Colin LeMahieufcc32762015-07-29 19:08:10 +0000227typedef std::function<bool(llvm::object::SectionRef const &)> FilterPredicate;
Colin LeMahieu77804be2015-07-29 15:45:39 +0000228
229class SectionFilterIterator {
230public:
231 SectionFilterIterator(FilterPredicate P,
232 llvm::object::section_iterator const &I,
233 llvm::object::section_iterator const &E)
Benjamin Kramer82de7d32016-05-27 14:27:24 +0000234 : Predicate(std::move(P)), Iterator(I), End(E) {
Colin LeMahieu77804be2015-07-29 15:45:39 +0000235 ScanPredicate();
236 }
Benjamin Kramerac9257b2015-09-24 14:52:52 +0000237 const llvm::object::SectionRef &operator*() const { return *Iterator; }
Colin LeMahieu77804be2015-07-29 15:45:39 +0000238 SectionFilterIterator &operator++() {
239 ++Iterator;
240 ScanPredicate();
241 return *this;
242 }
243 bool operator!=(SectionFilterIterator const &Other) const {
244 return Iterator != Other.Iterator;
245 }
246
247private:
248 void ScanPredicate() {
Colin LeMahieuda1723f2015-07-29 19:21:13 +0000249 while (Iterator != End && !Predicate(*Iterator)) {
Colin LeMahieu77804be2015-07-29 15:45:39 +0000250 ++Iterator;
251 }
252 }
253 FilterPredicate Predicate;
254 llvm::object::section_iterator Iterator;
255 llvm::object::section_iterator End;
256};
257
258class SectionFilter {
259public:
260 SectionFilter(FilterPredicate P, llvm::object::ObjectFile const &O)
Benjamin Kramer82de7d32016-05-27 14:27:24 +0000261 : Predicate(std::move(P)), Object(O) {}
Colin LeMahieu77804be2015-07-29 15:45:39 +0000262 SectionFilterIterator begin() {
263 return SectionFilterIterator(Predicate, Object.section_begin(),
264 Object.section_end());
265 }
266 SectionFilterIterator end() {
267 return SectionFilterIterator(Predicate, Object.section_end(),
268 Object.section_end());
269 }
270
271private:
272 FilterPredicate Predicate;
273 llvm::object::ObjectFile const &Object;
274};
275SectionFilter ToolSectionFilter(llvm::object::ObjectFile const &O) {
David Majnemer42531262016-08-12 03:55:06 +0000276 return SectionFilter(
277 [](llvm::object::SectionRef const &S) {
278 if (FilterSections.empty())
279 return true;
280 llvm::StringRef String;
281 std::error_code error = S.getName(String);
282 if (error)
283 return false;
284 return is_contained(FilterSections, String);
285 },
286 O);
Colin LeMahieu77804be2015-07-29 15:45:39 +0000287}
288}
289
Davide Italianoccd53fe2015-08-05 07:18:31 +0000290void llvm::error(std::error_code EC) {
Mark Seaborneb03ac52014-01-25 00:32:01 +0000291 if (!EC)
Davide Italianoccd53fe2015-08-05 07:18:31 +0000292 return;
Michael J. Spencer1d6167f2011-06-25 17:55:23 +0000293
Davide Italiano140af642015-12-25 18:16:45 +0000294 errs() << ToolName << ": error reading file: " << EC.message() << ".\n";
295 errs().flush();
Davide Italiano7f6c3012015-08-06 00:18:52 +0000296 exit(1);
Michael J. Spencer2670c252011-01-20 06:39:06 +0000297}
298
Kevin Enderby42398052016-06-28 23:16:13 +0000299LLVM_ATTRIBUTE_NORETURN void llvm::error(Twine Message) {
300 errs() << ToolName << ": " << Message << ".\n";
301 errs().flush();
302 exit(1);
303}
304
Davide Italianoed9d95b2015-12-29 13:41:02 +0000305LLVM_ATTRIBUTE_NORETURN void llvm::report_error(StringRef File,
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000306 Twine Message) {
307 errs() << ToolName << ": '" << File << "': " << Message << ".\n";
308 exit(1);
309}
310
311LLVM_ATTRIBUTE_NORETURN void llvm::report_error(StringRef File,
Davide Italianoed9d95b2015-12-29 13:41:02 +0000312 std::error_code EC) {
Alexey Samsonov50d0fbd2015-06-04 18:34:11 +0000313 assert(EC);
314 errs() << ToolName << ": '" << File << "': " << EC.message() << ".\n";
Davide Italianoccd53fe2015-08-05 07:18:31 +0000315 exit(1);
Alexey Samsonov50d0fbd2015-06-04 18:34:11 +0000316}
317
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +0000318LLVM_ATTRIBUTE_NORETURN void llvm::report_error(StringRef File,
319 llvm::Error E) {
320 assert(E);
321 std::string Buf;
322 raw_string_ostream OS(Buf);
323 logAllUnhandledErrors(std::move(E), OS, "");
324 OS.flush();
Kevin Enderbyb34e3a12016-05-05 17:43:35 +0000325 errs() << ToolName << ": '" << File << "': " << Buf;
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +0000326 exit(1);
327}
328
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000329LLVM_ATTRIBUTE_NORETURN void llvm::report_error(StringRef ArchiveName,
330 StringRef FileName,
Kevin Enderby9acb1092016-05-31 20:35:34 +0000331 llvm::Error E,
332 StringRef ArchitectureName) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000333 assert(E);
334 errs() << ToolName << ": ";
335 if (ArchiveName != "")
336 errs() << ArchiveName << "(" << FileName << ")";
337 else
Justin Bogner31d8b7d2016-10-26 22:37:52 +0000338 errs() << "'" << FileName << "'";
Kevin Enderby9acb1092016-05-31 20:35:34 +0000339 if (!ArchitectureName.empty())
340 errs() << " (for architecture " << ArchitectureName << ")";
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000341 std::string Buf;
342 raw_string_ostream OS(Buf);
343 logAllUnhandledErrors(std::move(E), OS, "");
344 OS.flush();
Justin Bogner31d8b7d2016-10-26 22:37:52 +0000345 errs() << ": " << Buf;
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000346 exit(1);
347}
348
349LLVM_ATTRIBUTE_NORETURN void llvm::report_error(StringRef ArchiveName,
350 const object::Archive::Child &C,
Kevin Enderby9acb1092016-05-31 20:35:34 +0000351 llvm::Error E,
352 StringRef ArchitectureName) {
Kevin Enderbyf4586032016-07-29 17:44:13 +0000353 Expected<StringRef> NameOrErr = C.getName();
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000354 // TODO: if we have a error getting the name then it would be nice to print
355 // the index of which archive member this is and or its offset in the
356 // archive instead of "???" as the name.
Kevin Enderbyf4586032016-07-29 17:44:13 +0000357 if (!NameOrErr) {
358 consumeError(NameOrErr.takeError());
Kevin Enderby9acb1092016-05-31 20:35:34 +0000359 llvm::report_error(ArchiveName, "???", std::move(E), ArchitectureName);
Kevin Enderbyf4586032016-07-29 17:44:13 +0000360 } else
Kevin Enderby9acb1092016-05-31 20:35:34 +0000361 llvm::report_error(ArchiveName, NameOrErr.get(), std::move(E),
362 ArchitectureName);
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000363}
364
Craig Toppere6cb63e2014-04-25 04:24:47 +0000365static const Target *getTarget(const ObjectFile *Obj = nullptr) {
Michael J. Spencer2670c252011-01-20 06:39:06 +0000366 // Figure out the target triple.
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000367 llvm::Triple TheTriple("unknown-unknown-unknown");
Michael J. Spencer05350e6d2011-01-20 07:22:04 +0000368 if (TripleName.empty()) {
Ahmed Bougachaad1084d2013-05-24 00:39:57 +0000369 if (Obj) {
Vlad Tsyrklevichde620462017-09-19 02:22:48 +0000370 TheTriple = Obj->makeTriple();
Ahmed Bougachaad1084d2013-05-24 00:39:57 +0000371 }
Sam Parkerdf7c6ef2017-01-18 13:52:12 +0000372 } else {
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000373 TheTriple.setTriple(Triple::normalize(TripleName));
Vlad Tsyrklevichde620462017-09-19 02:22:48 +0000374
Sam Parkerdf7c6ef2017-01-18 13:52:12 +0000375 // Use the triple, but also try to combine with ARM build attributes.
376 if (Obj) {
377 auto Arch = Obj->getArch();
378 if (Arch == Triple::arm || Arch == Triple::armeb) {
379 Obj->setARMSubArch(TheTriple);
380 }
381 }
382 }
Michael J. Spencer2670c252011-01-20 06:39:06 +0000383
384 // Get the target specific parser.
385 std::string Error;
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000386 const Target *TheTarget = TargetRegistry::lookupTarget(ArchName, TheTriple,
387 Error);
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000388 if (!TheTarget) {
389 if (Obj)
390 report_error(Obj->getFileName(), "can't find target: " + Error);
391 else
392 error("can't find target: " + Error);
393 }
Michael J. Spencer2670c252011-01-20 06:39:06 +0000394
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000395 // Update the triple name and return the found target.
396 TripleName = TheTriple.getTriple();
397 return TheTarget;
Michael J. Spencer2670c252011-01-20 06:39:06 +0000398}
399
Michael J. Spencer0c6ec482012-12-05 20:12:35 +0000400bool llvm::RelocAddressLess(RelocationRef a, RelocationRef b) {
Rafael Espindola704cd842015-07-06 15:47:43 +0000401 return a.getOffset() < b.getOffset();
Michael J. Spencer51862b32011-10-13 22:17:18 +0000402}
403
Rafael Espindola37070a52015-06-03 04:48:06 +0000404template <class ELFT>
Rafael Espindola37070a52015-06-03 04:48:06 +0000405static std::error_code getRelocationValueString(const ELFObjectFile<ELFT> *Obj,
Rafael Espindolaa01ff222015-08-10 20:50:40 +0000406 const RelocationRef &RelRef,
Rafael Espindola37070a52015-06-03 04:48:06 +0000407 SmallVectorImpl<char> &Result) {
Rafael Espindolaa01ff222015-08-10 20:50:40 +0000408 DataRefImpl Rel = RelRef.getRawDataRefImpl();
409
Rafael Espindola37070a52015-06-03 04:48:06 +0000410 typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
411 typedef typename ELFObjectFile<ELFT>::Elf_Shdr Elf_Shdr;
Rafael Espindola7f162ec2015-07-02 14:21:38 +0000412 typedef typename ELFObjectFile<ELFT>::Elf_Rela Elf_Rela;
413
Rafael Espindola37070a52015-06-03 04:48:06 +0000414 const ELFFile<ELFT> &EF = *Obj->getELFFile();
415
Davide Italiano6cf09262016-11-16 05:10:28 +0000416 auto SecOrErr = EF.getSection(Rel.d.a);
417 if (!SecOrErr)
418 return errorToErrorCode(SecOrErr.takeError());
Rafael Espindola6def3042015-07-01 12:56:27 +0000419 const Elf_Shdr *Sec = *SecOrErr;
Davide Italiano6cf09262016-11-16 05:10:28 +0000420 auto SymTabOrErr = EF.getSection(Sec->sh_link);
421 if (!SymTabOrErr)
422 return errorToErrorCode(SymTabOrErr.takeError());
Rafael Espindola6def3042015-07-01 12:56:27 +0000423 const Elf_Shdr *SymTab = *SymTabOrErr;
Rafael Espindola719dc7c2015-06-29 12:38:31 +0000424 assert(SymTab->sh_type == ELF::SHT_SYMTAB ||
425 SymTab->sh_type == ELF::SHT_DYNSYM);
Davide Italiano6cf09262016-11-16 05:10:28 +0000426 auto StrTabSec = EF.getSection(SymTab->sh_link);
427 if (!StrTabSec)
428 return errorToErrorCode(StrTabSec.takeError());
429 auto StrTabOrErr = EF.getStringTable(*StrTabSec);
430 if (!StrTabOrErr)
431 return errorToErrorCode(StrTabOrErr.takeError());
Rafael Espindola6a1bfb22015-06-29 14:39:25 +0000432 StringRef StrTab = *StrTabOrErr;
Rafael Espindolaa01ff222015-08-10 20:50:40 +0000433 uint8_t type = RelRef.getType();
Rafael Espindola37070a52015-06-03 04:48:06 +0000434 StringRef res;
435 int64_t addend = 0;
Rafael Espindola6def3042015-07-01 12:56:27 +0000436 switch (Sec->sh_type) {
Rafael Espindola37070a52015-06-03 04:48:06 +0000437 default:
438 return object_error::parse_failed;
439 case ELF::SHT_REL: {
Rafael Espindola37070a52015-06-03 04:48:06 +0000440 // TODO: Read implicit addend from section data.
441 break;
442 }
443 case ELF::SHT_RELA: {
Rafael Espindola7f162ec2015-07-02 14:21:38 +0000444 const Elf_Rela *ERela = Obj->getRela(Rel);
Rafael Espindola7f162ec2015-07-02 14:21:38 +0000445 addend = ERela->r_addend;
Rafael Espindola37070a52015-06-03 04:48:06 +0000446 break;
447 }
448 }
Rafael Espindolaa01ff222015-08-10 20:50:40 +0000449 symbol_iterator SI = RelRef.getSymbol();
450 const Elf_Sym *symb = Obj->getSymbol(SI->getRawDataRefImpl());
Rafael Espindola75d5b542015-06-03 05:14:22 +0000451 StringRef Target;
Rafael Espindola75d5b542015-06-03 05:14:22 +0000452 if (symb->getType() == ELF::STT_SECTION) {
Kevin Enderby7bd8d992016-05-02 20:28:12 +0000453 Expected<section_iterator> SymSI = SI->getSection();
454 if (!SymSI)
455 return errorToErrorCode(SymSI.takeError());
Rafael Espindolaa01ff222015-08-10 20:50:40 +0000456 const Elf_Shdr *SymSec = Obj->getSection((*SymSI)->getRawDataRefImpl());
Davide Italiano6cf09262016-11-16 05:10:28 +0000457 auto SecName = EF.getSectionName(SymSec);
458 if (!SecName)
459 return errorToErrorCode(SecName.takeError());
Rafael Espindola75d5b542015-06-03 05:14:22 +0000460 Target = *SecName;
461 } else {
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000462 Expected<StringRef> SymName = symb->getName(StrTab);
Rafael Espindola75d5b542015-06-03 05:14:22 +0000463 if (!SymName)
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000464 return errorToErrorCode(SymName.takeError());
Rafael Espindola75d5b542015-06-03 05:14:22 +0000465 Target = *SymName;
466 }
Rafael Espindola37070a52015-06-03 04:48:06 +0000467 switch (EF.getHeader()->e_machine) {
468 case ELF::EM_X86_64:
469 switch (type) {
470 case ELF::R_X86_64_PC8:
471 case ELF::R_X86_64_PC16:
472 case ELF::R_X86_64_PC32: {
473 std::string fmtbuf;
474 raw_string_ostream fmt(fmtbuf);
Rafael Espindola75d5b542015-06-03 05:14:22 +0000475 fmt << Target << (addend < 0 ? "" : "+") << addend << "-P";
Rafael Espindola37070a52015-06-03 04:48:06 +0000476 fmt.flush();
477 Result.append(fmtbuf.begin(), fmtbuf.end());
478 } break;
479 case ELF::R_X86_64_8:
480 case ELF::R_X86_64_16:
481 case ELF::R_X86_64_32:
482 case ELF::R_X86_64_32S:
483 case ELF::R_X86_64_64: {
484 std::string fmtbuf;
485 raw_string_ostream fmt(fmtbuf);
Rafael Espindola75d5b542015-06-03 05:14:22 +0000486 fmt << Target << (addend < 0 ? "" : "+") << addend;
Rafael Espindola37070a52015-06-03 04:48:06 +0000487 fmt.flush();
488 Result.append(fmtbuf.begin(), fmtbuf.end());
489 } break;
490 default:
491 res = "Unknown";
492 }
493 break;
Jacques Pienaarea9f25a2016-03-01 21:21:42 +0000494 case ELF::EM_LANAI:
Dylan McKay11661122016-09-28 13:15:17 +0000495 case ELF::EM_AVR:
Rafael Espindola37070a52015-06-03 04:48:06 +0000496 case ELF::EM_AARCH64: {
497 std::string fmtbuf;
498 raw_string_ostream fmt(fmtbuf);
Rafael Espindola75d5b542015-06-03 05:14:22 +0000499 fmt << Target;
Rafael Espindola37070a52015-06-03 04:48:06 +0000500 if (addend != 0)
501 fmt << (addend < 0 ? "" : "+") << addend;
502 fmt.flush();
503 Result.append(fmtbuf.begin(), fmtbuf.end());
504 break;
505 }
506 case ELF::EM_386:
Michael Kupersteina3b79dd2015-11-04 11:21:50 +0000507 case ELF::EM_IAMCU:
Rafael Espindola37070a52015-06-03 04:48:06 +0000508 case ELF::EM_ARM:
509 case ELF::EM_HEXAGON:
510 case ELF::EM_MIPS:
Alexei Starovoitovcfb51f52016-07-15 22:27:55 +0000511 case ELF::EM_BPF:
Alex Bradbury1524f622016-11-01 16:59:37 +0000512 case ELF::EM_RISCV:
Rafael Espindola75d5b542015-06-03 05:14:22 +0000513 res = Target;
Rafael Espindola37070a52015-06-03 04:48:06 +0000514 break;
Dan Gohman46350172016-01-12 20:56:01 +0000515 case ELF::EM_WEBASSEMBLY:
516 switch (type) {
517 case ELF::R_WEBASSEMBLY_DATA: {
518 std::string fmtbuf;
519 raw_string_ostream fmt(fmtbuf);
520 fmt << Target << (addend < 0 ? "" : "+") << addend;
521 fmt.flush();
522 Result.append(fmtbuf.begin(), fmtbuf.end());
523 break;
524 }
525 case ELF::R_WEBASSEMBLY_FUNCTION:
526 res = Target;
527 break;
528 default:
529 res = "Unknown";
530 }
531 break;
Rafael Espindola37070a52015-06-03 04:48:06 +0000532 default:
533 res = "Unknown";
534 }
535 if (Result.empty())
536 Result.append(res.begin(), res.end());
Rui Ueyama7d099192015-06-09 15:20:42 +0000537 return std::error_code();
Rafael Espindola37070a52015-06-03 04:48:06 +0000538}
539
540static std::error_code getRelocationValueString(const ELFObjectFileBase *Obj,
Rafael Espindolaa01ff222015-08-10 20:50:40 +0000541 const RelocationRef &Rel,
Rafael Espindola37070a52015-06-03 04:48:06 +0000542 SmallVectorImpl<char> &Result) {
Rafael Espindola37070a52015-06-03 04:48:06 +0000543 if (auto *ELF32LE = dyn_cast<ELF32LEObjectFile>(Obj))
544 return getRelocationValueString(ELF32LE, Rel, Result);
545 if (auto *ELF64LE = dyn_cast<ELF64LEObjectFile>(Obj))
546 return getRelocationValueString(ELF64LE, Rel, Result);
547 if (auto *ELF32BE = dyn_cast<ELF32BEObjectFile>(Obj))
548 return getRelocationValueString(ELF32BE, Rel, Result);
549 auto *ELF64BE = cast<ELF64BEObjectFile>(Obj);
550 return getRelocationValueString(ELF64BE, Rel, Result);
551}
552
553static std::error_code getRelocationValueString(const COFFObjectFile *Obj,
554 const RelocationRef &Rel,
555 SmallVectorImpl<char> &Result) {
556 symbol_iterator SymI = Rel.getSymbol();
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000557 Expected<StringRef> SymNameOrErr = SymI->getName();
558 if (!SymNameOrErr)
559 return errorToErrorCode(SymNameOrErr.takeError());
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000560 StringRef SymName = *SymNameOrErr;
Rafael Espindola37070a52015-06-03 04:48:06 +0000561 Result.append(SymName.begin(), SymName.end());
Rui Ueyama7d099192015-06-09 15:20:42 +0000562 return std::error_code();
Rafael Espindola37070a52015-06-03 04:48:06 +0000563}
564
565static void printRelocationTargetName(const MachOObjectFile *O,
566 const MachO::any_relocation_info &RE,
567 raw_string_ostream &fmt) {
568 bool IsScattered = O->isRelocationScattered(RE);
569
570 // Target of a scattered relocation is an address. In the interest of
571 // generating pretty output, scan through the symbol table looking for a
572 // symbol that aligns with that address. If we find one, print it.
573 // Otherwise, we just print the hex address of the target.
574 if (IsScattered) {
575 uint32_t Val = O->getPlainRelocationSymbolNum(RE);
576
577 for (const SymbolRef &Symbol : O->symbols()) {
578 std::error_code ec;
Kevin Enderby931cb652016-06-24 18:24:42 +0000579 Expected<uint64_t> Addr = Symbol.getAddress();
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000580 if (!Addr)
581 report_error(O->getFileName(), Addr.takeError());
Rafael Espindolaed067c42015-07-03 18:19:00 +0000582 if (*Addr != Val)
Rafael Espindola37070a52015-06-03 04:48:06 +0000583 continue;
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000584 Expected<StringRef> Name = Symbol.getName();
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000585 if (!Name)
586 report_error(O->getFileName(), Name.takeError());
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000587 fmt << *Name;
Rafael Espindola37070a52015-06-03 04:48:06 +0000588 return;
589 }
590
591 // If we couldn't find a symbol that this relocation refers to, try
592 // to find a section beginning instead.
Colin LeMahieu77804be2015-07-29 15:45:39 +0000593 for (const SectionRef &Section : ToolSectionFilter(*O)) {
Rafael Espindola37070a52015-06-03 04:48:06 +0000594 std::error_code ec;
595
596 StringRef Name;
597 uint64_t Addr = Section.getAddress();
598 if (Addr != Val)
599 continue;
600 if ((ec = Section.getName(Name)))
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000601 report_error(O->getFileName(), ec);
Rafael Espindola37070a52015-06-03 04:48:06 +0000602 fmt << Name;
603 return;
604 }
605
606 fmt << format("0x%x", Val);
607 return;
608 }
609
610 StringRef S;
611 bool isExtern = O->getPlainRelocationExternal(RE);
612 uint64_t Val = O->getPlainRelocationSymbolNum(RE);
613
Martin Storsjo8c0317d2017-07-13 17:03:02 +0000614 if (O->getAnyRelocationType(RE) == MachO::ARM64_RELOC_ADDEND) {
Simon Dardis38867052017-08-07 12:29:38 +0000615 fmt << format("0x%0" PRIx64, Val);
Martin Storsjo8c0317d2017-07-13 17:03:02 +0000616 return;
617 } else if (isExtern) {
Rafael Espindola37070a52015-06-03 04:48:06 +0000618 symbol_iterator SI = O->symbol_begin();
619 advance(SI, Val);
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000620 Expected<StringRef> SOrErr = SI->getName();
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000621 if (!SOrErr)
622 report_error(O->getFileName(), SOrErr.takeError());
Davide Italianoccd53fe2015-08-05 07:18:31 +0000623 S = *SOrErr;
Rafael Espindola37070a52015-06-03 04:48:06 +0000624 } else {
625 section_iterator SI = O->section_begin();
626 // Adjust for the fact that sections are 1-indexed.
Kevin Enderby3fc91882017-11-03 21:32:44 +0000627 if (Val == 0) {
628 fmt << "0 (?,?)";
629 return;
630 }
631 uint32_t i = Val - 1;
632 while (i != 0 && SI != O->section_end()) {
633 i--;
634 advance(SI, 1);
635 }
636 if (SI == O->section_end())
637 fmt << Val << " (?,?)";
638 else
639 SI->getName(S);
Rafael Espindola37070a52015-06-03 04:48:06 +0000640 }
641
642 fmt << S;
643}
644
Sam Clegg4df5d762017-06-27 20:40:53 +0000645static std::error_code getRelocationValueString(const WasmObjectFile *Obj,
646 const RelocationRef &RelRef,
647 SmallVectorImpl<char> &Result) {
648 const wasm::WasmRelocation& Rel = Obj->getWasmRelocation(RelRef);
Sam Cleggf676cdd2018-04-26 16:41:51 +0000649 symbol_iterator SI = RelRef.getSymbol();
Sam Clegg4df5d762017-06-27 20:40:53 +0000650 std::string fmtbuf;
651 raw_string_ostream fmt(fmtbuf);
Sam Clegg8c4b0ce2018-04-26 17:05:04 +0000652 if (SI == Obj->symbol_end()) {
653 // Not all wasm relocations have symbols associated with them.
654 // In particular R_WEBASSEMBLY_TYPE_INDEX_LEB.
Sam Cleggf676cdd2018-04-26 16:41:51 +0000655 fmt << Rel.Index;
656 } else {
Sam Clegg8c4b0ce2018-04-26 17:05:04 +0000657 Expected<StringRef> SymNameOrErr = SI->getName();
658 if (!SymNameOrErr)
659 return errorToErrorCode(SymNameOrErr.takeError());
Sam Cleggf676cdd2018-04-26 16:41:51 +0000660 StringRef SymName = *SymNameOrErr;
661 Result.append(SymName.begin(), SymName.end());
662 }
663 fmt << (Rel.Addend < 0 ? "" : "+") << Rel.Addend;
Sam Clegg4df5d762017-06-27 20:40:53 +0000664 fmt.flush();
665 Result.append(fmtbuf.begin(), fmtbuf.end());
666 return std::error_code();
667}
668
Rafael Espindola37070a52015-06-03 04:48:06 +0000669static std::error_code getRelocationValueString(const MachOObjectFile *Obj,
670 const RelocationRef &RelRef,
671 SmallVectorImpl<char> &Result) {
672 DataRefImpl Rel = RelRef.getRawDataRefImpl();
673 MachO::any_relocation_info RE = Obj->getRelocation(Rel);
674
675 unsigned Arch = Obj->getArch();
676
677 std::string fmtbuf;
678 raw_string_ostream fmt(fmtbuf);
679 unsigned Type = Obj->getAnyRelocationType(RE);
680 bool IsPCRel = Obj->getAnyRelocationPCRel(RE);
681
682 // Determine any addends that should be displayed with the relocation.
683 // These require decoding the relocation type, which is triple-specific.
684
685 // X86_64 has entirely custom relocation types.
686 if (Arch == Triple::x86_64) {
687 bool isPCRel = Obj->getAnyRelocationPCRel(RE);
688
689 switch (Type) {
690 case MachO::X86_64_RELOC_GOT_LOAD:
691 case MachO::X86_64_RELOC_GOT: {
692 printRelocationTargetName(Obj, RE, fmt);
693 fmt << "@GOT";
694 if (isPCRel)
695 fmt << "PCREL";
696 break;
697 }
698 case MachO::X86_64_RELOC_SUBTRACTOR: {
699 DataRefImpl RelNext = Rel;
700 Obj->moveRelocationNext(RelNext);
701 MachO::any_relocation_info RENext = Obj->getRelocation(RelNext);
702
703 // X86_64_RELOC_SUBTRACTOR must be followed by a relocation of type
704 // X86_64_RELOC_UNSIGNED.
705 // NOTE: Scattered relocations don't exist on x86_64.
706 unsigned RType = Obj->getAnyRelocationType(RENext);
707 if (RType != MachO::X86_64_RELOC_UNSIGNED)
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000708 report_error(Obj->getFileName(), "Expected X86_64_RELOC_UNSIGNED after "
709 "X86_64_RELOC_SUBTRACTOR.");
Rafael Espindola37070a52015-06-03 04:48:06 +0000710
711 // The X86_64_RELOC_UNSIGNED contains the minuend symbol;
712 // X86_64_RELOC_SUBTRACTOR contains the subtrahend.
713 printRelocationTargetName(Obj, RENext, fmt);
714 fmt << "-";
715 printRelocationTargetName(Obj, RE, fmt);
716 break;
717 }
718 case MachO::X86_64_RELOC_TLV:
719 printRelocationTargetName(Obj, RE, fmt);
720 fmt << "@TLV";
721 if (isPCRel)
722 fmt << "P";
723 break;
724 case MachO::X86_64_RELOC_SIGNED_1:
725 printRelocationTargetName(Obj, RE, fmt);
726 fmt << "-1";
727 break;
728 case MachO::X86_64_RELOC_SIGNED_2:
729 printRelocationTargetName(Obj, RE, fmt);
730 fmt << "-2";
731 break;
732 case MachO::X86_64_RELOC_SIGNED_4:
733 printRelocationTargetName(Obj, RE, fmt);
734 fmt << "-4";
735 break;
736 default:
737 printRelocationTargetName(Obj, RE, fmt);
738 break;
739 }
740 // X86 and ARM share some relocation types in common.
741 } else if (Arch == Triple::x86 || Arch == Triple::arm ||
742 Arch == Triple::ppc) {
743 // Generic relocation types...
744 switch (Type) {
745 case MachO::GENERIC_RELOC_PAIR: // prints no info
Rui Ueyama7d099192015-06-09 15:20:42 +0000746 return std::error_code();
Rafael Espindola37070a52015-06-03 04:48:06 +0000747 case MachO::GENERIC_RELOC_SECTDIFF: {
748 DataRefImpl RelNext = Rel;
749 Obj->moveRelocationNext(RelNext);
750 MachO::any_relocation_info RENext = Obj->getRelocation(RelNext);
751
752 // X86 sect diff's must be followed by a relocation of type
753 // GENERIC_RELOC_PAIR.
754 unsigned RType = Obj->getAnyRelocationType(RENext);
755
756 if (RType != MachO::GENERIC_RELOC_PAIR)
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000757 report_error(Obj->getFileName(), "Expected GENERIC_RELOC_PAIR after "
758 "GENERIC_RELOC_SECTDIFF.");
Rafael Espindola37070a52015-06-03 04:48:06 +0000759
760 printRelocationTargetName(Obj, RE, fmt);
761 fmt << "-";
762 printRelocationTargetName(Obj, RENext, fmt);
763 break;
764 }
765 }
766
767 if (Arch == Triple::x86 || Arch == Triple::ppc) {
768 switch (Type) {
769 case MachO::GENERIC_RELOC_LOCAL_SECTDIFF: {
770 DataRefImpl RelNext = Rel;
771 Obj->moveRelocationNext(RelNext);
772 MachO::any_relocation_info RENext = Obj->getRelocation(RelNext);
773
774 // X86 sect diff's must be followed by a relocation of type
775 // GENERIC_RELOC_PAIR.
776 unsigned RType = Obj->getAnyRelocationType(RENext);
777 if (RType != MachO::GENERIC_RELOC_PAIR)
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000778 report_error(Obj->getFileName(), "Expected GENERIC_RELOC_PAIR after "
779 "GENERIC_RELOC_LOCAL_SECTDIFF.");
Rafael Espindola37070a52015-06-03 04:48:06 +0000780
781 printRelocationTargetName(Obj, RE, fmt);
782 fmt << "-";
783 printRelocationTargetName(Obj, RENext, fmt);
784 break;
785 }
786 case MachO::GENERIC_RELOC_TLV: {
787 printRelocationTargetName(Obj, RE, fmt);
788 fmt << "@TLV";
789 if (IsPCRel)
790 fmt << "P";
791 break;
792 }
793 default:
794 printRelocationTargetName(Obj, RE, fmt);
795 }
796 } else { // ARM-specific relocations
797 switch (Type) {
798 case MachO::ARM_RELOC_HALF:
799 case MachO::ARM_RELOC_HALF_SECTDIFF: {
800 // Half relocations steal a bit from the length field to encode
801 // whether this is an upper16 or a lower16 relocation.
Martin Storsjofa5183b2017-07-13 05:54:08 +0000802 bool isUpper = (Obj->getAnyRelocationLength(RE) & 0x1) == 1;
Rafael Espindola37070a52015-06-03 04:48:06 +0000803
804 if (isUpper)
805 fmt << ":upper16:(";
806 else
807 fmt << ":lower16:(";
808 printRelocationTargetName(Obj, RE, fmt);
809
810 DataRefImpl RelNext = Rel;
811 Obj->moveRelocationNext(RelNext);
812 MachO::any_relocation_info RENext = Obj->getRelocation(RelNext);
813
814 // ARM half relocs must be followed by a relocation of type
815 // ARM_RELOC_PAIR.
816 unsigned RType = Obj->getAnyRelocationType(RENext);
817 if (RType != MachO::ARM_RELOC_PAIR)
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000818 report_error(Obj->getFileName(), "Expected ARM_RELOC_PAIR after "
819 "ARM_RELOC_HALF");
Rafael Espindola37070a52015-06-03 04:48:06 +0000820
821 // NOTE: The half of the target virtual address is stashed in the
822 // address field of the secondary relocation, but we can't reverse
823 // engineer the constant offset from it without decoding the movw/movt
824 // instruction to find the other half in its immediate field.
825
826 // ARM_RELOC_HALF_SECTDIFF encodes the second section in the
827 // symbol/section pointer of the follow-on relocation.
828 if (Type == MachO::ARM_RELOC_HALF_SECTDIFF) {
829 fmt << "-";
830 printRelocationTargetName(Obj, RENext, fmt);
831 }
832
833 fmt << ")";
834 break;
835 }
836 default: { printRelocationTargetName(Obj, RE, fmt); }
837 }
838 }
839 } else
840 printRelocationTargetName(Obj, RE, fmt);
841
842 fmt.flush();
843 Result.append(fmtbuf.begin(), fmtbuf.end());
Rui Ueyama7d099192015-06-09 15:20:42 +0000844 return std::error_code();
Rafael Espindola37070a52015-06-03 04:48:06 +0000845}
846
847static std::error_code getRelocationValueString(const RelocationRef &Rel,
848 SmallVectorImpl<char> &Result) {
Rafael Espindola854038e2015-06-26 14:51:16 +0000849 const ObjectFile *Obj = Rel.getObject();
Rafael Espindola37070a52015-06-03 04:48:06 +0000850 if (auto *ELF = dyn_cast<ELFObjectFileBase>(Obj))
851 return getRelocationValueString(ELF, Rel, Result);
852 if (auto *COFF = dyn_cast<COFFObjectFile>(Obj))
853 return getRelocationValueString(COFF, Rel, Result);
Sam Clegg4df5d762017-06-27 20:40:53 +0000854 if (auto *Wasm = dyn_cast<WasmObjectFile>(Obj))
855 return getRelocationValueString(Wasm, Rel, Result);
856 if (auto *MachO = dyn_cast<MachOObjectFile>(Obj))
857 return getRelocationValueString(MachO, Rel, Result);
858 llvm_unreachable("unknown object file format");
Rafael Espindola37070a52015-06-03 04:48:06 +0000859}
860
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +0000861/// Indicates whether this relocation should hidden when listing
Rafael Espindola0ad71d92015-06-30 03:41:26 +0000862/// relocations, usually because it is the trailing part of a multipart
863/// relocation that will be printed as part of the leading relocation.
864static bool getHidden(RelocationRef RelRef) {
865 const ObjectFile *Obj = RelRef.getObject();
866 auto *MachO = dyn_cast<MachOObjectFile>(Obj);
867 if (!MachO)
868 return false;
869
870 unsigned Arch = MachO->getArch();
871 DataRefImpl Rel = RelRef.getRawDataRefImpl();
872 uint64_t Type = MachO->getRelocationType(Rel);
873
874 // On arches that use the generic relocations, GENERIC_RELOC_PAIR
875 // is always hidden.
876 if (Arch == Triple::x86 || Arch == Triple::arm || Arch == Triple::ppc) {
877 if (Type == MachO::GENERIC_RELOC_PAIR)
878 return true;
879 } else if (Arch == Triple::x86_64) {
880 // On x86_64, X86_64_RELOC_UNSIGNED is hidden only when it follows
881 // an X86_64_RELOC_SUBTRACTOR.
882 if (Type == MachO::X86_64_RELOC_UNSIGNED && Rel.d.a > 0) {
883 DataRefImpl RelPrev = Rel;
884 RelPrev.d.a--;
885 uint64_t PrevType = MachO->getRelocationType(RelPrev);
886 if (PrevType == MachO::X86_64_RELOC_SUBTRACTOR)
887 return true;
888 }
889 }
890
891 return false;
892}
893
Sid Manningd9f28732018-05-14 19:46:08 +0000894namespace {
895class SourcePrinter {
896protected:
897 DILineInfo OldLineInfo;
898 const ObjectFile *Obj = nullptr;
899 std::unique_ptr<symbolize::LLVMSymbolizer> Symbolizer;
900 // File name to file contents of source
901 std::unordered_map<std::string, std::unique_ptr<MemoryBuffer>> SourceCache;
902 // Mark the line endings of the cached source
903 std::unordered_map<std::string, std::vector<StringRef>> LineCache;
904
905private:
906 bool cacheSource(const DILineInfo& LineInfoFile);
907
908public:
909 SourcePrinter() = default;
910 SourcePrinter(const ObjectFile *Obj, StringRef DefaultArch) : Obj(Obj) {
911 symbolize::LLVMSymbolizer::Options SymbolizerOpts(
912 DILineInfoSpecifier::FunctionNameKind::None, true, false, false,
913 DefaultArch);
914 Symbolizer.reset(new symbolize::LLVMSymbolizer(SymbolizerOpts));
915 }
916 virtual ~SourcePrinter() = default;
917 virtual void printSourceLine(raw_ostream &OS, uint64_t Address,
918 StringRef Delimiter = "; ");
919};
920
921bool SourcePrinter::cacheSource(const DILineInfo &LineInfo) {
922 std::unique_ptr<MemoryBuffer> Buffer;
923 if (LineInfo.Source) {
924 Buffer = MemoryBuffer::getMemBuffer(*LineInfo.Source);
925 } else {
926 auto BufferOrError = MemoryBuffer::getFile(LineInfo.FileName);
927 if (!BufferOrError)
928 return false;
929 Buffer = std::move(*BufferOrError);
930 }
931 // Chomp the file to get lines
932 size_t BufferSize = Buffer->getBufferSize();
933 const char *BufferStart = Buffer->getBufferStart();
934 for (const char *Start = BufferStart, *End = BufferStart;
935 End < BufferStart + BufferSize; End++)
936 if (*End == '\n' || End == BufferStart + BufferSize - 1 ||
937 (*End == '\r' && *(End + 1) == '\n')) {
938 LineCache[LineInfo.FileName].push_back(StringRef(Start, End - Start));
939 if (*End == '\r')
940 End++;
941 Start = End + 1;
942 }
943 SourceCache[LineInfo.FileName] = std::move(Buffer);
944 return true;
945}
946
947void SourcePrinter::printSourceLine(raw_ostream &OS, uint64_t Address,
948 StringRef Delimiter) {
949 if (!Symbolizer)
950 return;
951 DILineInfo LineInfo = DILineInfo();
952 auto ExpectecLineInfo =
953 Symbolizer->symbolizeCode(Obj->getFileName(), Address);
954 if (!ExpectecLineInfo)
955 consumeError(ExpectecLineInfo.takeError());
956 else
957 LineInfo = *ExpectecLineInfo;
958
959 if ((LineInfo.FileName == "<invalid>") || OldLineInfo.Line == LineInfo.Line ||
960 LineInfo.Line == 0)
961 return;
962
963 if (PrintLines)
964 OS << Delimiter << LineInfo.FileName << ":" << LineInfo.Line << "\n";
965 if (PrintSource) {
966 if (SourceCache.find(LineInfo.FileName) == SourceCache.end())
967 if (!cacheSource(LineInfo))
968 return;
969 auto FileBuffer = SourceCache.find(LineInfo.FileName);
970 if (FileBuffer != SourceCache.end()) {
971 auto LineBuffer = LineCache.find(LineInfo.FileName);
972 if (LineBuffer != LineCache.end()) {
973 if (LineInfo.Line > LineBuffer->second.size())
974 return;
975 // Vector begins at 0, line numbers are non-zero
976 OS << Delimiter << LineBuffer->second[LineInfo.Line - 1].ltrim()
977 << "\n";
978 }
979 }
980 }
981 OldLineInfo = LineInfo;
982}
983
984static bool isArmElf(const ObjectFile *Obj) {
985 return (Obj->isELF() &&
986 (Obj->getArch() == Triple::aarch64 ||
987 Obj->getArch() == Triple::aarch64_be ||
988 Obj->getArch() == Triple::arm || Obj->getArch() == Triple::armeb ||
989 Obj->getArch() == Triple::thumb ||
990 Obj->getArch() == Triple::thumbeb));
991}
992
993class PrettyPrinter {
994public:
995 virtual ~PrettyPrinter() = default;
996 virtual void printInst(MCInstPrinter &IP, const MCInst *MI,
997 ArrayRef<uint8_t> Bytes, uint64_t Address,
998 raw_ostream &OS, StringRef Annot,
999 MCSubtargetInfo const &STI, SourcePrinter *SP,
1000 std::vector<RelocationRef> *Rels = nullptr) {
1001 if (SP && (PrintSource || PrintLines))
1002 SP->printSourceLine(OS, Address);
1003 if (!NoLeadingAddr)
1004 OS << format("%8" PRIx64 ":", Address);
1005 if (!NoShowRawInsn) {
1006 OS << "\t";
1007 dumpBytes(Bytes, OS);
1008 }
1009 if (MI)
1010 IP.printInst(MI, OS, "", STI);
1011 else
1012 OS << " <unknown>";
1013 }
1014};
1015PrettyPrinter PrettyPrinterInst;
1016class HexagonPrettyPrinter : public PrettyPrinter {
1017public:
1018 void printLead(ArrayRef<uint8_t> Bytes, uint64_t Address,
1019 raw_ostream &OS) {
1020 uint32_t opcode =
1021 (Bytes[3] << 24) | (Bytes[2] << 16) | (Bytes[1] << 8) | Bytes[0];
1022 if (!NoLeadingAddr)
1023 OS << format("%8" PRIx64 ":", Address);
1024 if (!NoShowRawInsn) {
1025 OS << "\t";
1026 dumpBytes(Bytes.slice(0, 4), OS);
1027 OS << format("%08" PRIx32, opcode);
1028 }
1029 }
1030 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
1031 uint64_t Address, raw_ostream &OS, StringRef Annot,
1032 MCSubtargetInfo const &STI, SourcePrinter *SP,
1033 std::vector<RelocationRef> *Rels) override {
1034 if (SP && (PrintSource || PrintLines))
1035 SP->printSourceLine(OS, Address, "");
1036 if (!MI) {
1037 printLead(Bytes, Address, OS);
1038 OS << " <unknown>";
1039 return;
1040 }
1041 std::string Buffer;
1042 {
1043 raw_string_ostream TempStream(Buffer);
1044 IP.printInst(MI, TempStream, "", STI);
1045 }
1046 StringRef Contents(Buffer);
1047 // Split off bundle attributes
1048 auto PacketBundle = Contents.rsplit('\n');
1049 // Split off first instruction from the rest
1050 auto HeadTail = PacketBundle.first.split('\n');
1051 auto Preamble = " { ";
1052 auto Separator = "";
1053 StringRef Fmt = "\t\t\t%08" PRIx64 ": ";
1054 std::vector<RelocationRef>::const_iterator rel_cur = Rels->begin();
1055 std::vector<RelocationRef>::const_iterator rel_end = Rels->end();
1056
1057 // Hexagon's packets require relocations to be inline rather than
1058 // clustered at the end of the packet.
1059 auto PrintReloc = [&]() -> void {
1060 while ((rel_cur != rel_end) && (rel_cur->getOffset() <= Address)) {
1061 if (rel_cur->getOffset() == Address) {
1062 SmallString<16> name;
1063 SmallString<32> val;
1064 rel_cur->getTypeName(name);
1065 error(getRelocationValueString(*rel_cur, val));
1066 OS << Separator << format(Fmt.data(), Address) << name << "\t" << val
1067 << "\n";
1068 return;
1069 }
1070 rel_cur++;
1071 }
1072 };
1073
1074 while(!HeadTail.first.empty()) {
1075 OS << Separator;
1076 Separator = "\n";
1077 if (SP && (PrintSource || PrintLines))
1078 SP->printSourceLine(OS, Address, "");
1079 printLead(Bytes, Address, OS);
1080 OS << Preamble;
1081 Preamble = " ";
1082 StringRef Inst;
1083 auto Duplex = HeadTail.first.split('\v');
1084 if(!Duplex.second.empty()){
1085 OS << Duplex.first;
1086 OS << "; ";
1087 Inst = Duplex.second;
1088 }
1089 else
1090 Inst = HeadTail.first;
1091 OS << Inst;
1092 HeadTail = HeadTail.second.split('\n');
1093 if (HeadTail.first.empty())
1094 OS << " } " << PacketBundle.second;
1095 PrintReloc();
1096 Bytes = Bytes.slice(4);
1097 Address += 4;
1098 }
1099 }
1100};
1101HexagonPrettyPrinter HexagonPrettyPrinterInst;
1102
1103class AMDGCNPrettyPrinter : public PrettyPrinter {
1104public:
1105 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
1106 uint64_t Address, raw_ostream &OS, StringRef Annot,
1107 MCSubtargetInfo const &STI, SourcePrinter *SP,
1108 std::vector<RelocationRef> *Rels) override {
1109 if (SP && (PrintSource || PrintLines))
1110 SP->printSourceLine(OS, Address);
1111
1112 typedef support::ulittle32_t U32;
1113
1114 if (MI) {
1115 SmallString<40> InstStr;
1116 raw_svector_ostream IS(InstStr);
1117
1118 IP.printInst(MI, IS, "", STI);
1119
1120 OS << left_justify(IS.str(), 60);
1121 } else {
1122 // an unrecognized encoding - this is probably data so represent it
1123 // using the .long directive, or .byte directive if fewer than 4 bytes
1124 // remaining
1125 if (Bytes.size() >= 4) {
1126 OS << format("\t.long 0x%08" PRIx32 " ",
1127 static_cast<uint32_t>(*reinterpret_cast<const U32*>(Bytes.data())));
1128 OS.indent(42);
1129 } else {
1130 OS << format("\t.byte 0x%02" PRIx8, Bytes[0]);
1131 for (unsigned int i = 1; i < Bytes.size(); i++)
1132 OS << format(", 0x%02" PRIx8, Bytes[i]);
1133 OS.indent(55 - (6 * Bytes.size()));
1134 }
1135 }
1136
1137 OS << format("// %012" PRIX64 ": ", Address);
1138 if (Bytes.size() >=4) {
1139 for (auto D : makeArrayRef(reinterpret_cast<const U32*>(Bytes.data()),
1140 Bytes.size() / sizeof(U32)))
1141 // D should be explicitly casted to uint32_t here as it is passed
1142 // by format to snprintf as vararg.
1143 OS << format("%08" PRIX32 " ", static_cast<uint32_t>(D));
1144 } else {
1145 for (unsigned int i = 0; i < Bytes.size(); i++)
1146 OS << format("%02" PRIX8 " ", Bytes[i]);
1147 }
1148
1149 if (!Annot.empty())
1150 OS << "// " << Annot;
1151 }
1152};
1153AMDGCNPrettyPrinter AMDGCNPrettyPrinterInst;
1154
1155class BPFPrettyPrinter : public PrettyPrinter {
1156public:
1157 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
1158 uint64_t Address, raw_ostream &OS, StringRef Annot,
1159 MCSubtargetInfo const &STI, SourcePrinter *SP,
1160 std::vector<RelocationRef> *Rels) override {
1161 if (SP && (PrintSource || PrintLines))
1162 SP->printSourceLine(OS, Address);
1163 if (!NoLeadingAddr)
1164 OS << format("%8" PRId64 ":", Address / 8);
1165 if (!NoShowRawInsn) {
1166 OS << "\t";
1167 dumpBytes(Bytes, OS);
1168 }
1169 if (MI)
1170 IP.printInst(MI, OS, "", STI);
1171 else
1172 OS << " <unknown>";
1173 }
1174};
1175BPFPrettyPrinter BPFPrettyPrinterInst;
1176
1177PrettyPrinter &selectPrettyPrinter(Triple const &Triple) {
1178 switch(Triple.getArch()) {
1179 default:
1180 return PrettyPrinterInst;
1181 case Triple::hexagon:
1182 return HexagonPrettyPrinterInst;
1183 case Triple::amdgcn:
1184 return AMDGCNPrettyPrinterInst;
1185 case Triple::bpfel:
1186 case Triple::bpfeb:
1187 return BPFPrettyPrinterInst;
1188 }
1189}
1190}
1191
Sam Koltonc05d7782016-08-17 10:17:57 +00001192static uint8_t getElfSymbolType(const ObjectFile *Obj, const SymbolRef &Sym) {
1193 assert(Obj->isELF());
1194 if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(Obj))
1195 return Elf32LEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
1196 if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(Obj))
1197 return Elf64LEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
1198 if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(Obj))
1199 return Elf32BEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
1200 if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(Obj))
1201 return Elf64BEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
1202 llvm_unreachable("Unsupported binary format");
1203}
1204
Sam Parker5fba45a2017-02-08 09:44:18 +00001205template <class ELFT> static void
1206addDynamicElfSymbols(const ELFObjectFile<ELFT> *Obj,
1207 std::map<SectionRef, SectionSymbolsTy> &AllSymbols) {
1208 for (auto Symbol : Obj->getDynamicSymbolIterators()) {
1209 uint8_t SymbolType = Symbol.getELFType();
1210 if (SymbolType != ELF::STT_FUNC || Symbol.getSize() == 0)
1211 continue;
1212
1213 Expected<uint64_t> AddressOrErr = Symbol.getAddress();
1214 if (!AddressOrErr)
1215 report_error(Obj->getFileName(), AddressOrErr.takeError());
1216 uint64_t Address = *AddressOrErr;
1217
1218 Expected<StringRef> Name = Symbol.getName();
1219 if (!Name)
1220 report_error(Obj->getFileName(), Name.takeError());
1221 if (Name->empty())
1222 continue;
1223
1224 Expected<section_iterator> SectionOrErr = Symbol.getSection();
1225 if (!SectionOrErr)
1226 report_error(Obj->getFileName(), SectionOrErr.takeError());
1227 section_iterator SecI = *SectionOrErr;
1228 if (SecI == Obj->section_end())
1229 continue;
1230
1231 AllSymbols[*SecI].emplace_back(Address, *Name, SymbolType);
1232 }
1233}
1234
1235static void
1236addDynamicElfSymbols(const ObjectFile *Obj,
1237 std::map<SectionRef, SectionSymbolsTy> &AllSymbols) {
1238 assert(Obj->isELF());
1239 if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(Obj))
1240 addDynamicElfSymbols(Elf32LEObj, AllSymbols);
1241 else if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(Obj))
1242 addDynamicElfSymbols(Elf64LEObj, AllSymbols);
1243 else if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(Obj))
1244 addDynamicElfSymbols(Elf32BEObj, AllSymbols);
1245 else if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(Obj))
1246 addDynamicElfSymbols(Elf64BEObj, AllSymbols);
1247 else
1248 llvm_unreachable("Unsupported binary format");
1249}
1250
Michael J. Spencer51862b32011-10-13 22:17:18 +00001251static void DisassembleObject(const ObjectFile *Obj, bool InlineRelocs) {
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001252 if (StartAddress > StopAddress)
1253 error("Start address should be less than stop address");
1254
Jim Grosbachaf9aec02012-08-07 17:53:14 +00001255 const Target *TheTarget = getTarget(Obj);
Michael J. Spencer2670c252011-01-20 06:39:06 +00001256
Jack Carter551efd72012-08-28 19:24:49 +00001257 // Package up features to be passed to target/subtarget
Daniel Sanders1d148642016-06-16 09:17:03 +00001258 SubtargetFeatures Features = Obj->getFeatures();
Jack Carter551efd72012-08-28 19:24:49 +00001259 if (MAttrs.size()) {
Jack Carter551efd72012-08-28 19:24:49 +00001260 for (unsigned i = 0; i != MAttrs.size(); ++i)
1261 Features.AddFeature(MAttrs[i]);
Jack Carter551efd72012-08-28 19:24:49 +00001262 }
1263
Ahmed Charles56440fd2014-03-06 05:51:42 +00001264 std::unique_ptr<const MCRegisterInfo> MRI(
1265 TheTarget->createMCRegInfo(TripleName));
Davide Italiano711e4952015-12-17 01:59:50 +00001266 if (!MRI)
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001267 report_error(Obj->getFileName(), "no register info for target " +
1268 TripleName);
Ahmed Bougacha0835ca12013-05-16 21:28:23 +00001269
1270 // Set up disassembler.
Ahmed Charles56440fd2014-03-06 05:51:42 +00001271 std::unique_ptr<const MCAsmInfo> AsmInfo(
1272 TheTarget->createMCAsmInfo(*MRI, TripleName));
Davide Italiano711e4952015-12-17 01:59:50 +00001273 if (!AsmInfo)
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001274 report_error(Obj->getFileName(), "no assembly info for target " +
1275 TripleName);
Ahmed Charles56440fd2014-03-06 05:51:42 +00001276 std::unique_ptr<const MCSubtargetInfo> STI(
Daniel Sanders1d148642016-06-16 09:17:03 +00001277 TheTarget->createMCSubtargetInfo(TripleName, MCPU, Features.getString()));
Davide Italiano711e4952015-12-17 01:59:50 +00001278 if (!STI)
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001279 report_error(Obj->getFileName(), "no subtarget info for target " +
1280 TripleName);
Ahmed Charles56440fd2014-03-06 05:51:42 +00001281 std::unique_ptr<const MCInstrInfo> MII(TheTarget->createMCInstrInfo());
Davide Italiano711e4952015-12-17 01:59:50 +00001282 if (!MII)
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001283 report_error(Obj->getFileName(), "no instruction info for target " +
1284 TripleName);
Sam Kolton3381d7a2016-10-06 13:46:08 +00001285 MCObjectFileInfo MOFI;
1286 MCContext Ctx(AsmInfo.get(), MRI.get(), &MOFI);
1287 // FIXME: for now initialize MCObjectFileInfo with default values
Rafael Espindola9f929952017-08-02 20:32:26 +00001288 MOFI.InitMCObjectFileInfo(Triple(TripleName), false, Ctx);
Lang Hamesa1bc0f52014-04-15 04:40:56 +00001289
1290 std::unique_ptr<MCDisassembler> DisAsm(
1291 TheTarget->createMCDisassembler(*STI, Ctx));
Davide Italiano711e4952015-12-17 01:59:50 +00001292 if (!DisAsm)
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001293 report_error(Obj->getFileName(), "no disassembler for target " +
1294 TripleName);
Ahmed Bougachaad1084d2013-05-24 00:39:57 +00001295
Ahmed Charles56440fd2014-03-06 05:51:42 +00001296 std::unique_ptr<const MCInstrAnalysis> MIA(
1297 TheTarget->createMCInstrAnalysis(MII.get()));
Ahmed Bougachaaa790682013-05-24 01:07:04 +00001298
Ahmed Bougacha0835ca12013-05-16 21:28:23 +00001299 int AsmPrinterVariant = AsmInfo->getAssemblerDialect();
Daniel Sanders50f17232015-09-15 16:17:27 +00001300 std::unique_ptr<MCInstPrinter> IP(TheTarget->createMCInstPrinter(
1301 Triple(TripleName), AsmPrinterVariant, *AsmInfo, *MII, *MRI));
Davide Italiano711e4952015-12-17 01:59:50 +00001302 if (!IP)
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001303 report_error(Obj->getFileName(), "no instruction printer for target " +
1304 TripleName);
Colin LeMahieu14ec76e2015-06-07 21:07:17 +00001305 IP->setPrintImmHex(PrintImmHex);
Colin LeMahieu35436a22015-05-29 14:48:25 +00001306 PrettyPrinter &PIP = selectPrettyPrinter(Triple(TripleName));
Ahmed Bougacha0835ca12013-05-16 21:28:23 +00001307
Greg Fitzgerald18432272014-03-20 22:55:15 +00001308 StringRef Fmt = Obj->getBytesInAddress() > 4 ? "\t\t%016" PRIx64 ": " :
1309 "\t\t\t%08" PRIx64 ": ";
1310
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +00001311 SourcePrinter SP(Obj, TheTarget->getName());
1312
Mark Seaborn0929d3d2014-01-25 17:38:19 +00001313 // Create a mapping, RelocSecs = SectionRelocMap[S], where sections
1314 // in RelocSecs contain the relocations for section S.
Rafael Espindola4453e42942014-06-13 03:07:50 +00001315 std::error_code EC;
Alexey Samsonov48803e52014-03-13 14:37:36 +00001316 std::map<SectionRef, SmallVector<SectionRef, 1>> SectionRelocMap;
Colin LeMahieu77804be2015-07-29 15:45:39 +00001317 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Alexey Samsonov48803e52014-03-13 14:37:36 +00001318 section_iterator Sec2 = Section.getRelocatedSection();
Rafael Espindolab5155a52014-02-10 20:24:04 +00001319 if (Sec2 != Obj->section_end())
Alexey Samsonov48803e52014-03-13 14:37:36 +00001320 SectionRelocMap[*Sec2].push_back(Section);
Mark Seaborn0929d3d2014-01-25 17:38:19 +00001321 }
1322
David Majnemer81afca62015-07-07 22:06:59 +00001323 // Create a mapping from virtual address to symbol name. This is used to
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001324 // pretty print the symbols while disassembling.
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001325 std::map<SectionRef, SectionSymbolsTy> AllSymbols;
1326 for (const SymbolRef &Symbol : Obj->symbols()) {
Kevin Enderby931cb652016-06-24 18:24:42 +00001327 Expected<uint64_t> AddressOrErr = Symbol.getAddress();
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001328 if (!AddressOrErr)
1329 report_error(Obj->getFileName(), AddressOrErr.takeError());
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001330 uint64_t Address = *AddressOrErr;
David Majnemer2603a8fa2015-07-09 18:11:40 +00001331
Kevin Enderby81e8b7d2016-04-20 21:24:34 +00001332 Expected<StringRef> Name = Symbol.getName();
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001333 if (!Name)
1334 report_error(Obj->getFileName(), Name.takeError());
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001335 if (Name->empty())
1336 continue;
David Majnemer81afca62015-07-07 22:06:59 +00001337
Kevin Enderby7bd8d992016-05-02 20:28:12 +00001338 Expected<section_iterator> SectionOrErr = Symbol.getSection();
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001339 if (!SectionOrErr)
1340 report_error(Obj->getFileName(), SectionOrErr.takeError());
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001341 section_iterator SecI = *SectionOrErr;
1342 if (SecI == Obj->section_end())
1343 continue;
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001344
Sam Koltonc05d7782016-08-17 10:17:57 +00001345 uint8_t SymbolType = ELF::STT_NOTYPE;
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001346 if (Obj->isELF())
Sam Koltonc05d7782016-08-17 10:17:57 +00001347 SymbolType = getElfSymbolType(Obj, Symbol);
David Majnemer81afca62015-07-07 22:06:59 +00001348
Sam Koltonc05d7782016-08-17 10:17:57 +00001349 AllSymbols[*SecI].emplace_back(Address, *Name, SymbolType);
1350
David Majnemer81afca62015-07-07 22:06:59 +00001351 }
Sam Parker5fba45a2017-02-08 09:44:18 +00001352 if (AllSymbols.empty() && Obj->isELF())
1353 addDynamicElfSymbols(Obj, AllSymbols);
David Majnemer81afca62015-07-07 22:06:59 +00001354
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001355 // Create a mapping from virtual address to section.
1356 std::vector<std::pair<uint64_t, SectionRef>> SectionAddresses;
1357 for (SectionRef Sec : Obj->sections())
1358 SectionAddresses.emplace_back(Sec.getAddress(), Sec);
1359 array_pod_sort(SectionAddresses.begin(), SectionAddresses.end());
1360
1361 // Linked executables (.exe and .dll files) typically don't include a real
1362 // symbol table but they might contain an export table.
1363 if (const auto *COFFObj = dyn_cast<COFFObjectFile>(Obj)) {
1364 for (const auto &ExportEntry : COFFObj->export_directories()) {
1365 StringRef Name;
1366 error(ExportEntry.getSymbolName(Name));
1367 if (Name.empty())
1368 continue;
1369 uint32_t RVA;
1370 error(ExportEntry.getExportRVA(RVA));
1371
1372 uint64_t VA = COFFObj->getImageBase() + RVA;
1373 auto Sec = std::upper_bound(
1374 SectionAddresses.begin(), SectionAddresses.end(), VA,
1375 [](uint64_t LHS, const std::pair<uint64_t, SectionRef> &RHS) {
1376 return LHS < RHS.first;
1377 });
1378 if (Sec != SectionAddresses.begin())
1379 --Sec;
1380 else
1381 Sec = SectionAddresses.end();
1382
1383 if (Sec != SectionAddresses.end())
Sam Koltonc05d7782016-08-17 10:17:57 +00001384 AllSymbols[Sec->second].emplace_back(VA, Name, ELF::STT_NOTYPE);
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001385 }
1386 }
1387
1388 // Sort all the symbols, this allows us to use a simple binary search to find
1389 // a symbol near an address.
1390 for (std::pair<const SectionRef, SectionSymbolsTy> &SecSyms : AllSymbols)
1391 array_pod_sort(SecSyms.second.begin(), SecSyms.second.end());
1392
Colin LeMahieu77804be2015-07-29 15:45:39 +00001393 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Colin LeMahieuf34933e2015-07-23 20:58:49 +00001394 if (!DisassembleAll && (!Section.isText() || Section.isVirtual()))
Mark Seaborneb03ac52014-01-25 00:32:01 +00001395 continue;
Michael J. Spencer1d6167f2011-06-25 17:55:23 +00001396
Rafael Espindola80291272014-10-08 15:28:58 +00001397 uint64_t SectionAddr = Section.getAddress();
1398 uint64_t SectSize = Section.getSize();
David Majnemer185b5b12014-11-11 09:58:25 +00001399 if (!SectSize)
1400 continue;
Simon Atanasyan2b614e12014-02-24 22:12:11 +00001401
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001402 // Get the list of all the symbols in this section.
1403 SectionSymbolsTy &Symbols = AllSymbols[Section];
Davide Italianof0706882015-10-01 21:57:09 +00001404 std::vector<uint64_t> DataMappingSymsAddr;
1405 std::vector<uint64_t> TextMappingSymsAddr;
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001406 if (isArmElf(Obj)) {
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001407 for (const auto &Symb : Symbols) {
Sam Koltonc05d7782016-08-17 10:17:57 +00001408 uint64_t Address = std::get<0>(Symb);
1409 StringRef Name = std::get<1>(Symb);
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001410 if (Name.startswith("$d"))
David Majnemer153722d2015-11-18 04:35:32 +00001411 DataMappingSymsAddr.push_back(Address - SectionAddr);
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001412 if (Name.startswith("$x"))
David Majnemer153722d2015-11-18 04:35:32 +00001413 TextMappingSymsAddr.push_back(Address - SectionAddr);
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001414 if (Name.startswith("$a"))
1415 TextMappingSymsAddr.push_back(Address - SectionAddr);
1416 if (Name.startswith("$t"))
1417 TextMappingSymsAddr.push_back(Address - SectionAddr);
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001418 }
1419 }
1420
Mandeep Singh Grang8db564e2018-04-01 21:24:53 +00001421 llvm::sort(DataMappingSymsAddr.begin(), DataMappingSymsAddr.end());
1422 llvm::sort(TextMappingSymsAddr.begin(), TextMappingSymsAddr.end());
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001423
Sam Kolton3381d7a2016-10-06 13:46:08 +00001424 if (Obj->isELF() && Obj->getArch() == Triple::amdgcn) {
1425 // AMDGPU disassembler uses symbolizer for printing labels
1426 std::unique_ptr<MCRelocationInfo> RelInfo(
1427 TheTarget->createMCRelocationInfo(TripleName, Ctx));
1428 if (RelInfo) {
1429 std::unique_ptr<MCSymbolizer> Symbolizer(
1430 TheTarget->createMCSymbolizer(
1431 TripleName, nullptr, nullptr, &Symbols, &Ctx, std::move(RelInfo)));
1432 DisAsm->setSymbolizer(std::move(Symbolizer));
1433 }
1434 }
1435
Michael J. Spencer51862b32011-10-13 22:17:18 +00001436 // Make a list of all the relocations for this section.
1437 std::vector<RelocationRef> Rels;
1438 if (InlineRelocs) {
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00001439 for (const SectionRef &RelocSec : SectionRelocMap[Section]) {
1440 for (const RelocationRef &Reloc : RelocSec.relocations()) {
1441 Rels.push_back(Reloc);
1442 }
Michael J. Spencer51862b32011-10-13 22:17:18 +00001443 }
1444 }
1445
1446 // Sort relocations by address.
Mandeep Singh Grang8db564e2018-04-01 21:24:53 +00001447 llvm::sort(Rels.begin(), Rels.end(), RelocAddressLess);
Michael J. Spencer51862b32011-10-13 22:17:18 +00001448
Rafael Espindolaa9f810b2012-12-21 03:47:03 +00001449 StringRef SegmentName = "";
Mark Seaborneb03ac52014-01-25 00:32:01 +00001450 if (const MachOObjectFile *MachO = dyn_cast<const MachOObjectFile>(Obj)) {
Alexey Samsonov48803e52014-03-13 14:37:36 +00001451 DataRefImpl DR = Section.getRawDataRefImpl();
Rafael Espindola56f976f2013-04-18 18:08:55 +00001452 SegmentName = MachO->getSectionFinalSegmentName(DR);
Rafael Espindolaa9f810b2012-12-21 03:47:03 +00001453 }
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001454 StringRef SectionName;
1455 error(Section.getName(SectionName));
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001456
Rafael Espindola7884c952015-06-04 15:01:05 +00001457 // If the section has no symbol at the start, just insert a dummy one.
Sam Koltonc05d7782016-08-17 10:17:57 +00001458 if (Symbols.empty() || std::get<0>(Symbols[0]) != 0) {
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001459 Symbols.insert(
1460 Symbols.begin(),
1461 std::make_tuple(SectionAddr, SectionName,
1462 Section.isText() ? ELF::STT_FUNC : ELF::STT_OBJECT));
Sam Koltonc05d7782016-08-17 10:17:57 +00001463 }
Alp Tokere69170a2014-06-26 22:52:05 +00001464
1465 SmallString<40> Comments;
1466 raw_svector_ostream CommentStream(Comments);
Ahmed Bougachaad1084d2013-05-24 00:39:57 +00001467
Rafael Espindola7fc5b872014-11-12 02:04:27 +00001468 StringRef BytesStr;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001469 error(Section.getContents(BytesStr));
Aaron Ballman106fd7b2014-11-12 14:01:17 +00001470 ArrayRef<uint8_t> Bytes(reinterpret_cast<const uint8_t *>(BytesStr.data()),
1471 BytesStr.size());
Rafael Espindola7fc5b872014-11-12 02:04:27 +00001472
Michael J. Spencer2670c252011-01-20 06:39:06 +00001473 uint64_t Size;
1474 uint64_t Index;
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001475 bool PrintedSection = false;
Michael J. Spencer2670c252011-01-20 06:39:06 +00001476
Michael J. Spencer51862b32011-10-13 22:17:18 +00001477 std::vector<RelocationRef>::const_iterator rel_cur = Rels.begin();
1478 std::vector<RelocationRef>::const_iterator rel_end = Rels.end();
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001479 // Disassemble symbol by symbol.
1480 for (unsigned si = 0, se = Symbols.size(); si != se; ++si) {
Sam Koltonc05d7782016-08-17 10:17:57 +00001481 uint64_t Start = std::get<0>(Symbols[si]) - SectionAddr;
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001482 // The end is either the section end or the beginning of the next
1483 // symbol.
1484 uint64_t End =
Sam Koltonc05d7782016-08-17 10:17:57 +00001485 (si == se - 1) ? SectSize : std::get<0>(Symbols[si + 1]) - SectionAddr;
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001486 // Don't try to disassemble beyond the end of section contents.
1487 if (End > SectSize)
1488 End = SectSize;
Rafael Espindolae45c7402014-08-17 16:31:39 +00001489 // If this symbol has the same address as the next symbol, then skip it.
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001490 if (Start >= End)
Michael J. Spenceree84f642011-10-13 20:37:08 +00001491 continue;
1492
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001493 // Check if we need to skip symbol
1494 // Skip if the symbol's data is not between StartAddress and StopAddress
1495 if (End + SectionAddr < StartAddress ||
1496 Start + SectionAddr > StopAddress) {
1497 continue;
1498 }
1499
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001500 /// Skip if user requested specific symbols and this is not in the list
1501 if (!DisasmFuncsSet.empty() &&
1502 !DisasmFuncsSet.count(std::get<1>(Symbols[si])))
1503 continue;
1504
1505 if (!PrintedSection) {
1506 PrintedSection = true;
1507 outs() << "Disassembly of section ";
1508 if (!SegmentName.empty())
1509 outs() << SegmentName << ",";
1510 outs() << SectionName << ':';
1511 }
1512
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001513 // Stop disassembly at the stop address specified
1514 if (End + SectionAddr > StopAddress)
1515 End = StopAddress - SectionAddr;
1516
Valery Pykhtinde048052016-04-07 07:24:01 +00001517 if (Obj->isELF() && Obj->getArch() == Triple::amdgcn) {
Sam Koltonc05d7782016-08-17 10:17:57 +00001518 if (std::get<2>(Symbols[si]) == ELF::STT_AMDGPU_HSA_KERNEL) {
1519 // skip amd_kernel_code_t at the begining of kernel symbol (256 bytes)
1520 Start += 256;
1521 }
1522 if (si == se - 1 ||
1523 std::get<2>(Symbols[si + 1]) == ELF::STT_AMDGPU_HSA_KERNEL) {
1524 // cut trailing zeroes at the end of kernel
1525 // cut up to 256 bytes
1526 const uint64_t EndAlign = 256;
1527 const auto Limit = End - (std::min)(EndAlign, End - Start);
1528 while (End > Limit &&
1529 *reinterpret_cast<const support::ulittle32_t*>(&Bytes[End - 4]) == 0)
1530 End -= 4;
1531 }
Valery Pykhtinde048052016-04-07 07:24:01 +00001532 }
1533
Sam Koltonc05d7782016-08-17 10:17:57 +00001534 outs() << '\n' << std::get<1>(Symbols[si]) << ":\n";
Michael J. Spencer2670c252011-01-20 06:39:06 +00001535
Francis Visoiu Mistrih18346822018-04-19 17:02:57 +00001536 // Don't print raw contents of a virtual section. A virtual section
1537 // doesn't have any contents in the file.
1538 if (Section.isVirtual()) {
1539 outs() << "...\n";
1540 continue;
1541 }
1542
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001543#ifndef NDEBUG
Mark Seaborneb03ac52014-01-25 00:32:01 +00001544 raw_ostream &DebugOut = DebugFlag ? dbgs() : nulls();
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001545#else
Mark Seaborneb03ac52014-01-25 00:32:01 +00001546 raw_ostream &DebugOut = nulls();
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001547#endif
1548
Benjamin Kramer43a772e2011-09-19 17:56:04 +00001549 for (Index = Start; Index < End; Index += Size) {
1550 MCInst Inst;
Owen Andersona0c3b972011-09-15 23:38:46 +00001551
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001552 if (Index + SectionAddr < StartAddress ||
1553 Index + SectionAddr > StopAddress) {
1554 // skip byte by byte till StartAddress is reached
1555 Size = 1;
1556 continue;
1557 }
Davide Italianof0706882015-10-01 21:57:09 +00001558 // AArch64 ELF binaries can interleave data and text in the
1559 // same section. We rely on the markers introduced to
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001560 // understand what we need to dump. If the data marker is within a
1561 // function, it is denoted as a word/short etc
1562 if (isArmElf(Obj) && std::get<2>(Symbols[si]) != ELF::STT_OBJECT &&
1563 !DisassembleAll) {
Davide Italianof0706882015-10-01 21:57:09 +00001564 uint64_t Stride = 0;
1565
1566 auto DAI = std::lower_bound(DataMappingSymsAddr.begin(),
1567 DataMappingSymsAddr.end(), Index);
1568 if (DAI != DataMappingSymsAddr.end() && *DAI == Index) {
1569 // Switch to data.
1570 while (Index < End) {
1571 outs() << format("%8" PRIx64 ":", SectionAddr + Index);
1572 outs() << "\t";
1573 if (Index + 4 <= End) {
1574 Stride = 4;
1575 dumpBytes(Bytes.slice(Index, 4), outs());
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001576 outs() << "\t.word\t";
1577 uint32_t Data = 0;
1578 if (Obj->isLittleEndian()) {
1579 const auto Word =
1580 reinterpret_cast<const support::ulittle32_t *>(
1581 Bytes.data() + Index);
1582 Data = *Word;
1583 } else {
1584 const auto Word = reinterpret_cast<const support::ubig32_t *>(
1585 Bytes.data() + Index);
1586 Data = *Word;
1587 }
1588 outs() << "0x" << format("%08" PRIx32, Data);
Davide Italianof0706882015-10-01 21:57:09 +00001589 } else if (Index + 2 <= End) {
1590 Stride = 2;
1591 dumpBytes(Bytes.slice(Index, 2), outs());
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001592 outs() << "\t\t.short\t";
1593 uint16_t Data = 0;
1594 if (Obj->isLittleEndian()) {
1595 const auto Short =
1596 reinterpret_cast<const support::ulittle16_t *>(
1597 Bytes.data() + Index);
1598 Data = *Short;
1599 } else {
1600 const auto Short =
1601 reinterpret_cast<const support::ubig16_t *>(Bytes.data() +
1602 Index);
1603 Data = *Short;
1604 }
1605 outs() << "0x" << format("%04" PRIx16, Data);
Davide Italianof0706882015-10-01 21:57:09 +00001606 } else {
1607 Stride = 1;
1608 dumpBytes(Bytes.slice(Index, 1), outs());
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001609 outs() << "\t\t.byte\t";
1610 outs() << "0x" << format("%02" PRIx8, Bytes.slice(Index, 1)[0]);
Davide Italianof0706882015-10-01 21:57:09 +00001611 }
1612 Index += Stride;
1613 outs() << "\n";
1614 auto TAI = std::lower_bound(TextMappingSymsAddr.begin(),
1615 TextMappingSymsAddr.end(), Index);
1616 if (TAI != TextMappingSymsAddr.end() && *TAI == Index)
1617 break;
1618 }
1619 }
1620 }
1621
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001622 // If there is a data symbol inside an ELF text section and we are only
1623 // disassembling text (applicable all architectures),
1624 // we are in a situation where we must print the data and not
1625 // disassemble it.
1626 if (Obj->isELF() && std::get<2>(Symbols[si]) == ELF::STT_OBJECT &&
1627 !DisassembleAll && Section.isText()) {
1628 // print out data up to 8 bytes at a time in hex and ascii
1629 uint8_t AsciiData[9] = {'\0'};
1630 uint8_t Byte;
1631 int NumBytes = 0;
1632
1633 for (Index = Start; Index < End; Index += 1) {
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001634 if (((SectionAddr + Index) < StartAddress) ||
1635 ((SectionAddr + Index) > StopAddress))
1636 continue;
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001637 if (NumBytes == 0) {
1638 outs() << format("%8" PRIx64 ":", SectionAddr + Index);
1639 outs() << "\t";
1640 }
1641 Byte = Bytes.slice(Index)[0];
1642 outs() << format(" %02x", Byte);
1643 AsciiData[NumBytes] = isprint(Byte) ? Byte : '.';
1644
1645 uint8_t IndentOffset = 0;
1646 NumBytes++;
1647 if (Index == End - 1 || NumBytes > 8) {
1648 // Indent the space for less than 8 bytes data.
1649 // 2 spaces for byte and one for space between bytes
1650 IndentOffset = 3 * (8 - NumBytes);
1651 for (int Excess = 8 - NumBytes; Excess < 8; Excess++)
1652 AsciiData[Excess] = '\0';
1653 NumBytes = 8;
1654 }
1655 if (NumBytes == 8) {
1656 AsciiData[8] = '\0';
1657 outs() << std::string(IndentOffset, ' ') << " ";
1658 outs() << reinterpret_cast<char *>(AsciiData);
1659 outs() << '\n';
1660 NumBytes = 0;
1661 }
1662 }
1663 }
Davide Italianof0706882015-10-01 21:57:09 +00001664 if (Index >= End)
1665 break;
1666
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001667 // Disassemble a real instruction or a data when disassemble all is
1668 // provided
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001669 bool Disassembled = DisAsm->getInstruction(Inst, Size, Bytes.slice(Index),
1670 SectionAddr + Index, DebugOut,
1671 CommentStream);
1672 if (Size == 0)
1673 Size = 1;
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +00001674
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001675 PIP.printInst(*IP, Disassembled ? &Inst : nullptr,
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +00001676 Bytes.slice(Index, Size), SectionAddr + Index, outs(), "",
Sid Manningd9f28732018-05-14 19:46:08 +00001677 *STI, &SP, &Rels);
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001678 outs() << CommentStream.str();
1679 Comments.clear();
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001680
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001681 // Try to resolve the target of a call, tail call, etc. to a specific
1682 // symbol.
1683 if (MIA && (MIA->isCall(Inst) || MIA->isUnconditionalBranch(Inst) ||
1684 MIA->isConditionalBranch(Inst))) {
1685 uint64_t Target;
1686 if (MIA->evaluateBranch(Inst, SectionAddr + Index, Size, Target)) {
1687 // In a relocatable object, the target's section must reside in
1688 // the same section as the call instruction or it is accessed
1689 // through a relocation.
1690 //
1691 // In a non-relocatable object, the target may be in any section.
1692 //
1693 // N.B. We don't walk the relocations in the relocatable case yet.
1694 auto *TargetSectionSymbols = &Symbols;
1695 if (!Obj->isRelocatableObject()) {
1696 auto SectionAddress = std::upper_bound(
1697 SectionAddresses.begin(), SectionAddresses.end(), Target,
1698 [](uint64_t LHS,
1699 const std::pair<uint64_t, SectionRef> &RHS) {
1700 return LHS < RHS.first;
1701 });
1702 if (SectionAddress != SectionAddresses.begin()) {
1703 --SectionAddress;
1704 TargetSectionSymbols = &AllSymbols[SectionAddress->second];
1705 } else {
1706 TargetSectionSymbols = nullptr;
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001707 }
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001708 }
David Majnemer2603a8fa2015-07-09 18:11:40 +00001709
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001710 // Find the first symbol in the section whose offset is less than
1711 // or equal to the target.
1712 if (TargetSectionSymbols) {
1713 auto TargetSym = std::upper_bound(
1714 TargetSectionSymbols->begin(), TargetSectionSymbols->end(),
1715 Target, [](uint64_t LHS,
Sam Koltonc05d7782016-08-17 10:17:57 +00001716 const std::tuple<uint64_t, StringRef, uint8_t> &RHS) {
1717 return LHS < std::get<0>(RHS);
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001718 });
1719 if (TargetSym != TargetSectionSymbols->begin()) {
1720 --TargetSym;
1721 uint64_t TargetAddress = std::get<0>(*TargetSym);
1722 StringRef TargetName = std::get<1>(*TargetSym);
1723 outs() << " <" << TargetName;
1724 uint64_t Disp = Target - TargetAddress;
1725 if (Disp)
Benjamin Kramer3a13ed62017-12-28 16:58:54 +00001726 outs() << "+0x" << Twine::utohexstr(Disp);
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001727 outs() << '>';
David Majnemer81afca62015-07-07 22:06:59 +00001728 }
1729 }
1730 }
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001731 }
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001732 outs() << "\n";
Michael J. Spencer51862b32011-10-13 22:17:18 +00001733
Sid Manningd9f28732018-05-14 19:46:08 +00001734 // Hexagon does this in pretty printer
1735 if (Obj->getArch() != Triple::hexagon)
1736 // Print relocation for instruction.
1737 while (rel_cur != rel_end) {
1738 bool hidden = getHidden(*rel_cur);
1739 uint64_t addr = rel_cur->getOffset();
1740 SmallString<16> name;
1741 SmallString<32> val;
Owen Andersonfa3e5202011-10-25 20:35:53 +00001742
Sid Manningd9f28732018-05-14 19:46:08 +00001743 // If this relocation is hidden, skip it.
1744 if (hidden || ((SectionAddr + addr) < StartAddress)) {
1745 ++rel_cur;
1746 continue;
1747 }
1748
1749 // Stop when rel_cur's address is past the current instruction.
1750 if (addr >= Index + Size) break;
1751 rel_cur->getTypeName(name);
1752 error(getRelocationValueString(*rel_cur, val));
1753 outs() << format(Fmt.data(), SectionAddr + addr) << name
1754 << "\t" << val << "\n";
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001755 ++rel_cur;
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001756 }
Benjamin Kramer87ee76c2011-07-20 19:37:35 +00001757 }
Michael J. Spencer2670c252011-01-20 06:39:06 +00001758 }
1759 }
1760}
1761
Kevin Enderby98da6132015-01-20 21:47:46 +00001762void llvm::PrintRelocations(const ObjectFile *Obj) {
Greg Fitzgerald18432272014-03-20 22:55:15 +00001763 StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64 :
1764 "%08" PRIx64;
Rafael Espindola9219fe72016-03-21 20:59:15 +00001765 // Regular objdump doesn't print relocations in non-relocatable object
1766 // files.
1767 if (!Obj->isRelocatableObject())
1768 return;
Rafael Espindolac66d7612014-08-17 19:09:37 +00001769
Colin LeMahieu77804be2015-07-29 15:45:39 +00001770 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Alexey Samsonov48803e52014-03-13 14:37:36 +00001771 if (Section.relocation_begin() == Section.relocation_end())
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001772 continue;
1773 StringRef secname;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001774 error(Section.getName(secname));
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001775 outs() << "RELOCATION RECORDS FOR [" << secname << "]:\n";
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00001776 for (const RelocationRef &Reloc : Section.relocations()) {
Rafael Espindola0ad71d92015-06-30 03:41:26 +00001777 bool hidden = getHidden(Reloc);
Rafael Espindola96d071c2015-06-29 23:29:12 +00001778 uint64_t address = Reloc.getOffset();
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001779 SmallString<32> relocname;
1780 SmallString<32> valuestr;
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001781 if (address < StartAddress || address > StopAddress || hidden)
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00001782 continue;
Rafael Espindola41bb4322015-06-30 04:08:37 +00001783 Reloc.getTypeName(relocname);
Davide Italianoccd53fe2015-08-05 07:18:31 +00001784 error(getRelocationValueString(Reloc, valuestr));
Greg Fitzgerald18432272014-03-20 22:55:15 +00001785 outs() << format(Fmt.data(), address) << " " << relocname << " "
1786 << valuestr << "\n";
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001787 }
1788 outs() << "\n";
1789 }
1790}
1791
Kevin Enderby98da6132015-01-20 21:47:46 +00001792void llvm::PrintSectionHeaders(const ObjectFile *Obj) {
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001793 outs() << "Sections:\n"
1794 "Idx Name Size Address Type\n";
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001795 unsigned i = 0;
Colin LeMahieu77804be2015-07-29 15:45:39 +00001796 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001797 StringRef Name;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001798 error(Section.getName(Name));
Rafael Espindola80291272014-10-08 15:28:58 +00001799 uint64_t Address = Section.getAddress();
1800 uint64_t Size = Section.getSize();
1801 bool Text = Section.isText();
1802 bool Data = Section.isData();
1803 bool BSS = Section.isBSS();
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001804 std::string Type = (std::string(Text ? "TEXT " : "") +
Michael J. Spencer8f67d472011-10-13 20:37:20 +00001805 (Data ? "DATA " : "") + (BSS ? "BSS" : ""));
Alexey Samsonov48803e52014-03-13 14:37:36 +00001806 outs() << format("%3d %-13s %08" PRIx64 " %016" PRIx64 " %s\n", i,
1807 Name.str().c_str(), Size, Address, Type.c_str());
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001808 ++i;
1809 }
1810}
1811
Kevin Enderby98da6132015-01-20 21:47:46 +00001812void llvm::PrintSectionContents(const ObjectFile *Obj) {
Rafael Espindola4453e42942014-06-13 03:07:50 +00001813 std::error_code EC;
Colin LeMahieu77804be2015-07-29 15:45:39 +00001814 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001815 StringRef Name;
1816 StringRef Contents;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001817 error(Section.getName(Name));
Rafael Espindola80291272014-10-08 15:28:58 +00001818 uint64_t BaseAddr = Section.getAddress();
David Majnemer185b5b12014-11-11 09:58:25 +00001819 uint64_t Size = Section.getSize();
1820 if (!Size)
1821 continue;
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001822
1823 outs() << "Contents of section " << Name << ":\n";
David Majnemer185b5b12014-11-11 09:58:25 +00001824 if (Section.isBSS()) {
Alexey Samsonov209095c2013-04-16 10:53:11 +00001825 outs() << format("<skipping contents of bss section at [%04" PRIx64
David Majnemer8f6b04c2014-07-14 16:20:14 +00001826 ", %04" PRIx64 ")>\n",
1827 BaseAddr, BaseAddr + Size);
Alexey Samsonov209095c2013-04-16 10:53:11 +00001828 continue;
1829 }
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001830
Davide Italianoccd53fe2015-08-05 07:18:31 +00001831 error(Section.getContents(Contents));
David Majnemer8f6b04c2014-07-14 16:20:14 +00001832
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001833 // Dump out the content as hex and printable ascii characters.
1834 for (std::size_t addr = 0, end = Contents.size(); addr < end; addr += 16) {
Benjamin Kramer82803112012-03-10 02:04:38 +00001835 outs() << format(" %04" PRIx64 " ", BaseAddr + addr);
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001836 // Dump line of hex.
1837 for (std::size_t i = 0; i < 16; ++i) {
1838 if (i != 0 && i % 4 == 0)
1839 outs() << ' ';
1840 if (addr + i < end)
1841 outs() << hexdigit((Contents[addr + i] >> 4) & 0xF, true)
1842 << hexdigit(Contents[addr + i] & 0xF, true);
1843 else
1844 outs() << " ";
1845 }
1846 // Print ascii.
1847 outs() << " ";
1848 for (std::size_t i = 0; i < 16 && addr + i < end; ++i) {
Guy Benyei83c74e92013-02-12 21:21:59 +00001849 if (std::isprint(static_cast<unsigned char>(Contents[addr + i]) & 0xFF))
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001850 outs() << Contents[addr + i];
1851 else
1852 outs() << ".";
1853 }
1854 outs() << "\n";
1855 }
1856 }
1857}
1858
Kevin Enderby9acb1092016-05-31 20:35:34 +00001859void llvm::PrintSymbolTable(const ObjectFile *o, StringRef ArchiveName,
1860 StringRef ArchitectureName) {
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001861 outs() << "SYMBOL TABLE:\n";
1862
Rui Ueyama4e39f712014-03-18 18:58:51 +00001863 if (const COFFObjectFile *coff = dyn_cast<const COFFObjectFile>(o)) {
Davide Italianoe85abf72015-12-20 09:54:34 +00001864 printCOFFSymbolTable(coff);
Rui Ueyama4e39f712014-03-18 18:58:51 +00001865 return;
1866 }
1867 for (const SymbolRef &Symbol : o->symbols()) {
Kevin Enderby931cb652016-06-24 18:24:42 +00001868 Expected<uint64_t> AddressOrError = Symbol.getAddress();
1869 if (!AddressOrError)
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001870 report_error(ArchiveName, o->getFileName(), AddressOrError.takeError(),
1871 ArchitectureName);
Rafael Espindolaed067c42015-07-03 18:19:00 +00001872 uint64_t Address = *AddressOrError;
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001873 if ((Address < StartAddress) || (Address > StopAddress))
1874 continue;
Kevin Enderby7bd8d992016-05-02 20:28:12 +00001875 Expected<SymbolRef::Type> TypeOrError = Symbol.getType();
1876 if (!TypeOrError)
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001877 report_error(ArchiveName, o->getFileName(), TypeOrError.takeError(),
1878 ArchitectureName);
Kevin Enderby5afbc1c2016-03-23 20:27:00 +00001879 SymbolRef::Type Type = *TypeOrError;
Rui Ueyama4e39f712014-03-18 18:58:51 +00001880 uint32_t Flags = Symbol.getFlags();
Kevin Enderby7bd8d992016-05-02 20:28:12 +00001881 Expected<section_iterator> SectionOrErr = Symbol.getSection();
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001882 if (!SectionOrErr)
1883 report_error(ArchiveName, o->getFileName(), SectionOrErr.takeError(),
1884 ArchitectureName);
Rafael Espindola8bab8892015-08-07 23:27:14 +00001885 section_iterator Section = *SectionOrErr;
Rafael Espindola75d5b542015-06-03 05:14:22 +00001886 StringRef Name;
1887 if (Type == SymbolRef::ST_Debug && Section != o->section_end()) {
1888 Section->getName(Name);
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +00001889 } else {
Kevin Enderby81e8b7d2016-04-20 21:24:34 +00001890 Expected<StringRef> NameOrErr = Symbol.getName();
1891 if (!NameOrErr)
Kevin Enderby9acb1092016-05-31 20:35:34 +00001892 report_error(ArchiveName, o->getFileName(), NameOrErr.takeError(),
1893 ArchitectureName);
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +00001894 Name = *NameOrErr;
Rafael Espindola75d5b542015-06-03 05:14:22 +00001895 }
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001896
Rui Ueyama4e39f712014-03-18 18:58:51 +00001897 bool Global = Flags & SymbolRef::SF_Global;
1898 bool Weak = Flags & SymbolRef::SF_Weak;
1899 bool Absolute = Flags & SymbolRef::SF_Absolute;
Colin LeMahieubc2f47a2015-01-23 20:06:24 +00001900 bool Common = Flags & SymbolRef::SF_Common;
Davide Italianocd2514d2015-04-30 23:08:53 +00001901 bool Hidden = Flags & SymbolRef::SF_Hidden;
David Meyer1df4b842012-02-28 23:47:53 +00001902
Rui Ueyama4e39f712014-03-18 18:58:51 +00001903 char GlobLoc = ' ';
1904 if (Type != SymbolRef::ST_Unknown)
1905 GlobLoc = Global ? 'g' : 'l';
1906 char Debug = (Type == SymbolRef::ST_Debug || Type == SymbolRef::ST_File)
1907 ? 'd' : ' ';
1908 char FileFunc = ' ';
1909 if (Type == SymbolRef::ST_File)
1910 FileFunc = 'f';
1911 else if (Type == SymbolRef::ST_Function)
1912 FileFunc = 'F';
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001913
Rui Ueyama4e39f712014-03-18 18:58:51 +00001914 const char *Fmt = o->getBytesInAddress() > 4 ? "%016" PRIx64 :
1915 "%08" PRIx64;
Michael J. Spencerd857c1c2013-01-10 22:40:50 +00001916
Rui Ueyama4e39f712014-03-18 18:58:51 +00001917 outs() << format(Fmt, Address) << " "
1918 << GlobLoc // Local -> 'l', Global -> 'g', Neither -> ' '
1919 << (Weak ? 'w' : ' ') // Weak?
1920 << ' ' // Constructor. Not supported yet.
1921 << ' ' // Warning. Not supported yet.
1922 << ' ' // Indirect reference to another symbol.
1923 << Debug // Debugging (d) or dynamic (D) symbol.
1924 << FileFunc // Name of function (F), file (f) or object (O).
1925 << ' ';
1926 if (Absolute) {
1927 outs() << "*ABS*";
Colin LeMahieubc2f47a2015-01-23 20:06:24 +00001928 } else if (Common) {
1929 outs() << "*COM*";
Rui Ueyama4e39f712014-03-18 18:58:51 +00001930 } else if (Section == o->section_end()) {
1931 outs() << "*UND*";
1932 } else {
1933 if (const MachOObjectFile *MachO =
1934 dyn_cast<const MachOObjectFile>(o)) {
1935 DataRefImpl DR = Section->getRawDataRefImpl();
1936 StringRef SegmentName = MachO->getSectionFinalSegmentName(DR);
1937 outs() << SegmentName << ",";
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001938 }
Rui Ueyama4e39f712014-03-18 18:58:51 +00001939 StringRef SectionName;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001940 error(Section->getName(SectionName));
Rui Ueyama4e39f712014-03-18 18:58:51 +00001941 outs() << SectionName;
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001942 }
Rafael Espindola5f7ade22015-06-23 15:45:38 +00001943
1944 outs() << '\t';
Rafael Espindolaae3ac082015-06-23 18:34:25 +00001945 if (Common || isa<ELFObjectFileBase>(o)) {
Rafael Espindoladbb6bd32015-06-25 22:10:04 +00001946 uint64_t Val =
1947 Common ? Symbol.getAlignment() : ELFSymbolRef(Symbol).getSize();
Rafael Espindolaae3ac082015-06-23 18:34:25 +00001948 outs() << format("\t %08" PRIx64 " ", Val);
1949 }
Rafael Espindola5f7ade22015-06-23 15:45:38 +00001950
Davide Italianocd2514d2015-04-30 23:08:53 +00001951 if (Hidden) {
1952 outs() << ".hidden ";
1953 }
1954 outs() << Name
Rui Ueyama4e39f712014-03-18 18:58:51 +00001955 << '\n';
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001956 }
1957}
1958
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001959static void PrintUnwindInfo(const ObjectFile *o) {
1960 outs() << "Unwind info:\n\n";
1961
1962 if (const COFFObjectFile *coff = dyn_cast<COFFObjectFile>(o)) {
1963 printCOFFUnwindInfo(coff);
Tim Northover4bd286a2014-08-01 13:07:19 +00001964 } else if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
1965 printMachOUnwindInfo(MachO);
1966 else {
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001967 // TODO: Extract DWARF dump tool to objdump.
1968 errs() << "This operation is only currently supported "
Tim Northover4bd286a2014-08-01 13:07:19 +00001969 "for COFF and MachO object files.\n";
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001970 return;
1971 }
1972}
1973
Kevin Enderbye2297dd2015-01-07 21:02:18 +00001974void llvm::printExportsTrie(const ObjectFile *o) {
Nick Kledzikd04bc352014-08-30 00:20:14 +00001975 outs() << "Exports trie:\n";
1976 if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
1977 printMachOExportsTrie(MachO);
1978 else {
1979 errs() << "This operation is only currently supported "
1980 "for Mach-O executable files.\n";
1981 return;
1982 }
1983}
1984
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001985void llvm::printRebaseTable(ObjectFile *o) {
Nick Kledzikac431442014-09-12 21:34:15 +00001986 outs() << "Rebase table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001987 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzikac431442014-09-12 21:34:15 +00001988 printMachORebaseTable(MachO);
1989 else {
1990 errs() << "This operation is only currently supported "
1991 "for Mach-O executable files.\n";
1992 return;
1993 }
1994}
1995
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001996void llvm::printBindTable(ObjectFile *o) {
Nick Kledzik56ebef42014-09-16 01:41:51 +00001997 outs() << "Bind table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001998 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzik56ebef42014-09-16 01:41:51 +00001999 printMachOBindTable(MachO);
2000 else {
2001 errs() << "This operation is only currently supported "
2002 "for Mach-O executable files.\n";
2003 return;
2004 }
2005}
2006
Kevin Enderbya8d256c2017-03-20 19:46:55 +00002007void llvm::printLazyBindTable(ObjectFile *o) {
Nick Kledzik56ebef42014-09-16 01:41:51 +00002008 outs() << "Lazy bind table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00002009 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzik56ebef42014-09-16 01:41:51 +00002010 printMachOLazyBindTable(MachO);
2011 else {
2012 errs() << "This operation is only currently supported "
2013 "for Mach-O executable files.\n";
2014 return;
2015 }
2016}
2017
Kevin Enderbya8d256c2017-03-20 19:46:55 +00002018void llvm::printWeakBindTable(ObjectFile *o) {
Nick Kledzik56ebef42014-09-16 01:41:51 +00002019 outs() << "Weak bind table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00002020 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzik56ebef42014-09-16 01:41:51 +00002021 printMachOWeakBindTable(MachO);
2022 else {
2023 errs() << "This operation is only currently supported "
2024 "for Mach-O executable files.\n";
2025 return;
2026 }
2027}
Nick Kledzikac431442014-09-12 21:34:15 +00002028
Adrian Prantl437105a2015-07-08 02:04:15 +00002029/// Dump the raw contents of the __clangast section so the output can be piped
2030/// into llvm-bcanalyzer.
2031void llvm::printRawClangAST(const ObjectFile *Obj) {
2032 if (outs().is_displayed()) {
2033 errs() << "The -raw-clang-ast option will dump the raw binary contents of "
2034 "the clang ast section.\n"
2035 "Please redirect the output to a file or another program such as "
2036 "llvm-bcanalyzer.\n";
2037 return;
2038 }
2039
2040 StringRef ClangASTSectionName("__clangast");
2041 if (isa<COFFObjectFile>(Obj)) {
2042 ClangASTSectionName = "clangast";
2043 }
2044
2045 Optional<object::SectionRef> ClangASTSection;
Colin LeMahieu77804be2015-07-29 15:45:39 +00002046 for (auto Sec : ToolSectionFilter(*Obj)) {
Adrian Prantl437105a2015-07-08 02:04:15 +00002047 StringRef Name;
2048 Sec.getName(Name);
2049 if (Name == ClangASTSectionName) {
2050 ClangASTSection = Sec;
2051 break;
2052 }
2053 }
2054 if (!ClangASTSection)
2055 return;
2056
2057 StringRef ClangASTContents;
Davide Italianoccd53fe2015-08-05 07:18:31 +00002058 error(ClangASTSection.getValue().getContents(ClangASTContents));
Adrian Prantl437105a2015-07-08 02:04:15 +00002059 outs().write(ClangASTContents.data(), ClangASTContents.size());
2060}
2061
Sanjoy Das6f567a42015-06-22 18:03:02 +00002062static void printFaultMaps(const ObjectFile *Obj) {
2063 const char *FaultMapSectionName = nullptr;
2064
2065 if (isa<ELFObjectFileBase>(Obj)) {
2066 FaultMapSectionName = ".llvm_faultmaps";
2067 } else if (isa<MachOObjectFile>(Obj)) {
2068 FaultMapSectionName = "__llvm_faultmaps";
2069 } else {
2070 errs() << "This operation is only currently supported "
2071 "for ELF and Mach-O executable files.\n";
2072 return;
2073 }
2074
2075 Optional<object::SectionRef> FaultMapSection;
2076
Colin LeMahieu77804be2015-07-29 15:45:39 +00002077 for (auto Sec : ToolSectionFilter(*Obj)) {
Sanjoy Das6f567a42015-06-22 18:03:02 +00002078 StringRef Name;
2079 Sec.getName(Name);
2080 if (Name == FaultMapSectionName) {
2081 FaultMapSection = Sec;
2082 break;
2083 }
2084 }
2085
2086 outs() << "FaultMap table:\n";
2087
2088 if (!FaultMapSection.hasValue()) {
2089 outs() << "<not found>\n";
2090 return;
2091 }
2092
2093 StringRef FaultMapContents;
Davide Italianoccd53fe2015-08-05 07:18:31 +00002094 error(FaultMapSection.getValue().getContents(FaultMapContents));
Sanjoy Das6f567a42015-06-22 18:03:02 +00002095
2096 FaultMapParser FMP(FaultMapContents.bytes_begin(),
2097 FaultMapContents.bytes_end());
2098
2099 outs() << FMP;
2100}
2101
Davide Italiano1bdaa202016-09-18 04:39:15 +00002102static void printPrivateFileHeaders(const ObjectFile *o, bool onlyFirst) {
Kevin Enderby0ae163f2016-01-13 00:25:36 +00002103 if (o->isELF())
Davide Italiano1bdaa202016-09-18 04:39:15 +00002104 return printELFFileHeader(o);
2105 if (o->isCOFF())
2106 return printCOFFFileHeader(o);
Derek Schuff2c6f75d2016-11-30 16:49:11 +00002107 if (o->isWasm())
2108 return printWasmFileHeader(o);
Davide Italiano1bdaa202016-09-18 04:39:15 +00002109 if (o->isMachO()) {
Kevin Enderby0ae163f2016-01-13 00:25:36 +00002110 printMachOFileHeader(o);
Davide Italiano1bdaa202016-09-18 04:39:15 +00002111 if (!onlyFirst)
2112 printMachOLoadCommands(o);
2113 return;
2114 }
Kevin Enderby7fa40c92016-11-16 22:17:38 +00002115 report_error(o->getFileName(), "Invalid/Unsupported object file format");
Rui Ueyamac2bed422013-09-27 21:04:00 +00002116}
2117
Kevin Enderbya8d256c2017-03-20 19:46:55 +00002118static void DumpObject(ObjectFile *o, const Archive *a = nullptr) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +00002119 StringRef ArchiveName = a != nullptr ? a->getFileName() : "";
Adrian Prantl437105a2015-07-08 02:04:15 +00002120 // Avoid other output when using a raw option.
2121 if (!RawClangAST) {
2122 outs() << '\n';
Kevin Enderbyac9e1552016-05-17 17:10:12 +00002123 if (a)
2124 outs() << a->getFileName() << "(" << o->getFileName() << ")";
2125 else
2126 outs() << o->getFileName();
2127 outs() << ":\tfile format " << o->getFileFormatName() << "\n\n";
Adrian Prantl437105a2015-07-08 02:04:15 +00002128 }
Michael J. Spencer4e25c022011-10-17 17:13:22 +00002129
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002130 if (Disassemble)
Michael J. Spencer51862b32011-10-13 22:17:18 +00002131 DisassembleObject(o, Relocations);
2132 if (Relocations && !Disassemble)
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002133 PrintRelocations(o);
Nick Lewyckyfcf84622011-10-10 21:21:34 +00002134 if (SectionHeaders)
2135 PrintSectionHeaders(o);
Michael J. Spencer4e25c022011-10-17 17:13:22 +00002136 if (SectionContents)
2137 PrintSectionContents(o);
Michael J. Spencerbfa06782011-10-18 19:32:17 +00002138 if (SymbolTable)
Kevin Enderbyac9e1552016-05-17 17:10:12 +00002139 PrintSymbolTable(o, ArchiveName);
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00002140 if (UnwindInfo)
2141 PrintUnwindInfo(o);
Davide Italiano1bdaa202016-09-18 04:39:15 +00002142 if (PrivateHeaders || FirstPrivateHeader)
2143 printPrivateFileHeaders(o, FirstPrivateHeader);
Nick Kledzikd04bc352014-08-30 00:20:14 +00002144 if (ExportsTrie)
2145 printExportsTrie(o);
Nick Kledzikac431442014-09-12 21:34:15 +00002146 if (Rebase)
2147 printRebaseTable(o);
Nick Kledzik56ebef42014-09-16 01:41:51 +00002148 if (Bind)
2149 printBindTable(o);
2150 if (LazyBind)
2151 printLazyBindTable(o);
2152 if (WeakBind)
2153 printWeakBindTable(o);
Adrian Prantl437105a2015-07-08 02:04:15 +00002154 if (RawClangAST)
2155 printRawClangAST(o);
Sanjoy Das6f567a42015-06-22 18:03:02 +00002156 if (PrintFaultMaps)
2157 printFaultMaps(o);
Igor Laevsky03a670c2016-01-26 15:09:42 +00002158 if (DwarfDumpType != DIDT_Null) {
Rafael Espindolac398e672017-07-19 22:27:28 +00002159 std::unique_ptr<DIContext> DICtx = DWARFContext::create(*o);
Igor Laevsky03a670c2016-01-26 15:09:42 +00002160 // Dump the complete DWARF structure.
Adrian Prantlf4bc1f72017-06-01 18:18:23 +00002161 DIDumpOptions DumpOpts;
2162 DumpOpts.DumpType = DwarfDumpType;
Adrian Prantlf4bc1f72017-06-01 18:18:23 +00002163 DICtx->dump(outs(), DumpOpts);
Igor Laevsky03a670c2016-01-26 15:09:42 +00002164 }
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002165}
2166
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +00002167static void DumpObject(const COFFImportFile *I, const Archive *A) {
2168 StringRef ArchiveName = A ? A->getFileName() : "";
2169
2170 // Avoid other output when using a raw option.
2171 if (!RawClangAST)
2172 outs() << '\n'
2173 << ArchiveName << "(" << I->getFileName() << ")"
2174 << ":\tfile format COFF-import-file"
2175 << "\n\n";
2176
2177 if (SymbolTable)
2178 printCOFFSymbolTable(I);
2179}
2180
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +00002181/// Dump each object file in \a a;
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002182static void DumpArchive(const Archive *a) {
Mehdi Amini41af4302016-11-11 04:28:40 +00002183 Error Err = Error::success();
Lang Hamesfc209622016-07-14 02:24:01 +00002184 for (auto &C : a->children(Err)) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +00002185 Expected<std::unique_ptr<Binary>> ChildOrErr = C.getAsBinary();
2186 if (!ChildOrErr) {
2187 if (auto E = isNotObjectErrorInvalidFileType(ChildOrErr.takeError()))
2188 report_error(a->getFileName(), C, std::move(E));
2189 continue;
2190 }
Rafael Espindolaae460022014-06-16 16:08:36 +00002191 if (ObjectFile *o = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
Kevin Enderbyac9e1552016-05-17 17:10:12 +00002192 DumpObject(o, a);
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +00002193 else if (COFFImportFile *I = dyn_cast<COFFImportFile>(&*ChildOrErr.get()))
2194 DumpObject(I, a);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002195 else
Alexey Samsonov50d0fbd2015-06-04 18:34:11 +00002196 report_error(a->getFileName(), object_error::invalid_file_type);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002197 }
Lang Hamesfc209622016-07-14 02:24:01 +00002198 if (Err)
2199 report_error(a->getFileName(), std::move(Err));
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002200}
2201
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +00002202/// Open file and figure out how to dump it.
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002203static void DumpInput(StringRef file) {
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002204
Kevin Enderbye2297dd2015-01-07 21:02:18 +00002205 // If we are using the Mach-O specific object file parser, then let it parse
2206 // the file and process the command line options. So the -arch flags can
2207 // be used to select specific slices, etc.
2208 if (MachOOpt) {
2209 ParseInputMachO(file);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002210 return;
2211 }
2212
2213 // Attempt to open the binary.
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +00002214 Expected<OwningBinary<Binary>> BinaryOrErr = createBinary(file);
2215 if (!BinaryOrErr)
Kevin Enderbyb34e3a12016-05-05 17:43:35 +00002216 report_error(file, BinaryOrErr.takeError());
Rafael Espindola48af1c22014-08-19 18:44:46 +00002217 Binary &Binary = *BinaryOrErr.get().getBinary();
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002218
Rafael Espindola3f6481d2014-08-01 14:31:55 +00002219 if (Archive *a = dyn_cast<Archive>(&Binary))
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002220 DumpArchive(a);
Rafael Espindola3f6481d2014-08-01 14:31:55 +00002221 else if (ObjectFile *o = dyn_cast<ObjectFile>(&Binary))
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002222 DumpObject(o);
Jim Grosbachaf9aec02012-08-07 17:53:14 +00002223 else
Alexey Samsonov50d0fbd2015-06-04 18:34:11 +00002224 report_error(file, object_error::invalid_file_type);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002225}
2226
Michael J. Spencer2670c252011-01-20 06:39:06 +00002227int main(int argc, char **argv) {
Rui Ueyama197194b2018-04-13 18:26:06 +00002228 InitLLVM X(argc, argv);
Michael J. Spencer2670c252011-01-20 06:39:06 +00002229
2230 // Initialize targets and assembly printers/parsers.
2231 llvm::InitializeAllTargetInfos();
Evan Cheng8c886a42011-07-22 21:58:54 +00002232 llvm::InitializeAllTargetMCs();
Michael J. Spencer2670c252011-01-20 06:39:06 +00002233 llvm::InitializeAllDisassemblers();
2234
Pete Cooper28fb4fc2012-05-03 23:20:10 +00002235 // Register the target printer for --version.
2236 cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
2237
Michael J. Spencer2670c252011-01-20 06:39:06 +00002238 cl::ParseCommandLineOptions(argc, argv, "llvm object file dumper\n");
2239 TripleName = Triple::normalize(TripleName);
2240
2241 ToolName = argv[0];
2242
2243 // Defaults to a.out if no filenames specified.
2244 if (InputFilenames.size() == 0)
2245 InputFilenames.push_back("a.out");
2246
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +00002247 if (DisassembleAll || PrintSource || PrintLines)
Colin LeMahieuf34933e2015-07-23 20:58:49 +00002248 Disassemble = true;
Michael J. Spencerbfa06782011-10-18 19:32:17 +00002249 if (!Disassemble
2250 && !Relocations
2251 && !SectionHeaders
2252 && !SectionContents
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00002253 && !SymbolTable
Michael J. Spencer209565db2013-01-06 03:56:49 +00002254 && !UnwindInfo
Nick Kledzikd04bc352014-08-30 00:20:14 +00002255 && !PrivateHeaders
Kevin Enderby0ae163f2016-01-13 00:25:36 +00002256 && !FirstPrivateHeader
Nick Kledzikac431442014-09-12 21:34:15 +00002257 && !ExportsTrie
Nick Kledzik56ebef42014-09-16 01:41:51 +00002258 && !Rebase
2259 && !Bind
2260 && !LazyBind
Kevin Enderby131d1772015-01-09 19:22:37 +00002261 && !WeakBind
Adrian Prantl437105a2015-07-08 02:04:15 +00002262 && !RawClangAST
Kevin Enderby13023a12015-01-15 23:19:11 +00002263 && !(UniversalHeaders && MachOOpt)
Kevin Enderbya7bdc7e2015-01-22 18:55:27 +00002264 && !(ArchiveHeaders && MachOOpt)
Kevin Enderby69fe98d2015-01-23 18:52:17 +00002265 && !(IndirectSymbols && MachOOpt)
Kevin Enderby9a509442015-01-27 21:28:24 +00002266 && !(DataInCode && MachOOpt)
Kevin Enderbyf6d25852015-01-31 00:37:11 +00002267 && !(LinkOptHints && MachOOpt)
Kevin Enderbycd66be52015-03-11 22:06:32 +00002268 && !(InfoPlist && MachOOpt)
Kevin Enderbybc847fa2015-03-16 20:08:09 +00002269 && !(DylibsUsed && MachOOpt)
2270 && !(DylibId && MachOOpt)
Kevin Enderby0fc11822015-04-01 20:57:01 +00002271 && !(ObjcMetaData && MachOOpt)
Colin LeMahieufcc32762015-07-29 19:08:10 +00002272 && !(FilterSections.size() != 0 && MachOOpt)
Igor Laevsky03a670c2016-01-26 15:09:42 +00002273 && !PrintFaultMaps
2274 && DwarfDumpType == DIDT_Null) {
Michael J. Spencer2670c252011-01-20 06:39:06 +00002275 cl::PrintHelpMessage();
Dimitry Andrice4f5d012017-12-18 19:46:56 +00002276 return 2;
2277 }
2278
Rafael Aulerb0e4b912018-03-09 19:13:44 +00002279 DisasmFuncsSet.insert(DisassembleFunctions.begin(),
2280 DisassembleFunctions.end());
2281
Dimitry Andrice4f5d012017-12-18 19:46:56 +00002282 llvm::for_each(InputFilenames, DumpInput);
2283
2284 return EXIT_SUCCESS;
2285}