blob: fe873c00913377dedaf5f6b5d199e0b26c0987cf [file] [log] [blame]
Michael J. Spencer2670c252011-01-20 06:39:06 +00001//===-- llvm-objdump.cpp - Object file dumping utility for llvm -----------===//
2//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Michael J. Spencer2670c252011-01-20 06:39:06 +00006//
7//===----------------------------------------------------------------------===//
8//
9// This program is a utility that works like binutils "objdump", that is, it
10// dumps out a plethora of information about an object file depending on the
11// flags.
12//
Michael J. Spencerd7e70032013-02-05 20:27:22 +000013// The flags and output of this program should be near identical to those of
14// binutils objdump.
15//
Michael J. Spencer2670c252011-01-20 06:39:06 +000016//===----------------------------------------------------------------------===//
17
Benjamin Kramer43a772e2011-09-19 17:56:04 +000018#include "llvm-objdump.h"
Sanjoy Das6f567a42015-06-22 18:03:02 +000019#include "llvm/ADT/Optional.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000020#include "llvm/ADT/STLExtras.h"
Michael J. Spencer4e25c022011-10-17 17:13:22 +000021#include "llvm/ADT/StringExtras.h"
Rafael Aulerb0e4b912018-03-09 19:13:44 +000022#include "llvm/ADT/StringSet.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000023#include "llvm/ADT/Triple.h"
Sanjoy Das3f1bc3b2015-06-23 20:09:03 +000024#include "llvm/CodeGen/FaultMaps.h"
Igor Laevsky03a670c2016-01-26 15:09:42 +000025#include "llvm/DebugInfo/DWARF/DWARFContext.h"
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +000026#include "llvm/DebugInfo/Symbolize/Symbolize.h"
Paul Semel007dedb2018-07-18 16:39:21 +000027#include "llvm/Demangle/Demangle.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"
Dave Lee3fb120f2018-08-03 00:06:38 +000044#include "llvm/Object/MachOUniversal.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000045#include "llvm/Object/ObjectFile.h"
Sam Clegg4df5d762017-06-27 20:40:53 +000046#include "llvm/Object/Wasm.h"
Michael J. Spencerba4a3622011-10-08 00:18:30 +000047#include "llvm/Support/Casting.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000048#include "llvm/Support/CommandLine.h"
49#include "llvm/Support/Debug.h"
Alexey Samsonov50d0fbd2015-06-04 18:34:11 +000050#include "llvm/Support/Errc.h"
Michael J. Spencerba4a3622011-10-08 00:18:30 +000051#include "llvm/Support/FileSystem.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000052#include "llvm/Support/Format.h"
Benjamin Kramerbf115312011-07-25 23:04:36 +000053#include "llvm/Support/GraphWriter.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000054#include "llvm/Support/Host.h"
Rui Ueyama197194b2018-04-13 18:26:06 +000055#include "llvm/Support/InitLLVM.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000056#include "llvm/Support/MemoryBuffer.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000057#include "llvm/Support/SourceMgr.h"
Joel Galenson134cf472018-08-24 15:21:57 +000058#include "llvm/Support/StringSaver.h"
Evan Cheng2bb40352011-08-24 18:08:43 +000059#include "llvm/Support/TargetRegistry.h"
60#include "llvm/Support/TargetSelect.h"
Jonas Devliegheree787efd2018-11-11 22:12:04 +000061#include "llvm/Support/WithColor.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000062#include "llvm/Support/raw_ostream.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000063#include <algorithm>
Benjamin Kramera5177e62012-03-23 11:49:32 +000064#include <cctype>
Michael J. Spencer2670c252011-01-20 06:39:06 +000065#include <cstring>
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000066#include <system_error>
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +000067#include <unordered_map>
Rafael Espindolac398e672017-07-19 22:27:28 +000068#include <utility>
Ahmed Bougacha17926472013-08-21 07:29:02 +000069
Michael J. Spencer2670c252011-01-20 06:39:06 +000070using namespace llvm;
71using namespace object;
72
Fangrui Song8513cd42018-06-27 20:45:11 +000073cl::opt<bool>
74 llvm::AllHeaders("all-headers",
75 cl::desc("Display all available header information"));
76static cl::alias AllHeadersShort("x", cl::desc("Alias for --all-headers"),
George Rimar845d3292019-01-18 10:41:26 +000077 cl::NotHidden, cl::aliasopt(AllHeaders));
Fangrui Song8513cd42018-06-27 20:45:11 +000078
Benjamin Kramer43a772e2011-09-19 17:56:04 +000079static cl::list<std::string>
80InputFilenames(cl::Positional, cl::desc("<input object files>"),cl::ZeroOrMore);
Michael J. Spencer2670c252011-01-20 06:39:06 +000081
Kevin Enderbye2297dd2015-01-07 21:02:18 +000082cl::opt<bool>
83llvm::Disassemble("disassemble",
Benjamin Kramer43a772e2011-09-19 17:56:04 +000084 cl::desc("Display assembler mnemonics for the machine instructions"));
George Rimar845d3292019-01-18 10:41:26 +000085static cl::alias Disassembled("d", cl::desc("Alias for --disassemble"),
86 cl::NotHidden, cl::aliasopt(Disassemble));
Colin LeMahieu77804be2015-07-29 15:45:39 +000087
88cl::opt<bool>
89llvm::DisassembleAll("disassemble-all",
90 cl::desc("Display assembler mnemonics for the machine instructions"));
George Rimar845d3292019-01-18 10:41:26 +000091static cl::alias DisassembleAlld("D", cl::desc("Alias for --disassemble-all"),
92 cl::NotHidden, cl::aliasopt(DisassembleAll));
Michael J. Spencer2670c252011-01-20 06:39:06 +000093
Zachary Turner030ad372018-08-20 22:18:21 +000094cl::opt<bool> llvm::Demangle("demangle", cl::desc("Demangle symbols names"),
95 cl::init(false));
Paul Semel007dedb2018-07-18 16:39:21 +000096
97static cl::alias DemangleShort("C", cl::desc("Alias for --demangle"),
George Rimar845d3292019-01-18 10:41:26 +000098 cl::NotHidden, cl::aliasopt(llvm::Demangle));
Paul Semel007dedb2018-07-18 16:39:21 +000099
Rafael Aulerb0e4b912018-03-09 19:13:44 +0000100static cl::list<std::string>
101DisassembleFunctions("df",
102 cl::CommaSeparated,
103 cl::desc("List of functions to disassemble"));
104static StringSet<> DisasmFuncsSet;
105
Kevin Enderby98da6132015-01-20 21:47:46 +0000106cl::opt<bool>
Kristina Brooks31579e92018-10-31 09:34:08 +0000107llvm::Relocations("reloc",
108 cl::desc("Display the relocation entries in the file"));
109static cl::alias RelocationsShort("r", cl::desc("Alias for --reloc"),
110 cl::NotHidden,
111 cl::aliasopt(llvm::Relocations));
Michael J. Spencerba4a3622011-10-08 00:18:30 +0000112
Kevin Enderby98da6132015-01-20 21:47:46 +0000113cl::opt<bool>
Paul Semelcb0f0432018-06-07 13:30:55 +0000114llvm::DynamicRelocations("dynamic-reloc",
115 cl::desc("Display the dynamic relocation entries in the file"));
George Rimar845d3292019-01-18 10:41:26 +0000116static cl::alias DynamicRelocationsd("R", cl::desc("Alias for --dynamic-reloc"),
117 cl::NotHidden,
118 cl::aliasopt(DynamicRelocations));
Paul Semelcb0f0432018-06-07 13:30:55 +0000119
120cl::opt<bool>
James Hendersonb55b6582018-10-29 10:05:39 +0000121 llvm::SectionContents("full-contents",
122 cl::desc("Display the content of each section"));
123static cl::alias SectionContentsShort("s",
124 cl::desc("Alias for --full-contents"),
George Rimar845d3292019-01-18 10:41:26 +0000125 cl::NotHidden,
James Hendersonb55b6582018-10-29 10:05:39 +0000126 cl::aliasopt(SectionContents));
Michael J. Spencer4e25c022011-10-17 17:13:22 +0000127
Kristina Brooks3baa5f72018-10-31 05:45:01 +0000128cl::opt<bool> llvm::SymbolTable("syms", cl::desc("Display the symbol table"));
129static cl::alias SymbolTableShort("t", cl::desc("Alias for --syms"),
Kristina Brooks889356e2018-10-31 09:35:25 +0000130 cl::NotHidden,
Kristina Brooks3baa5f72018-10-31 05:45:01 +0000131 cl::aliasopt(llvm::SymbolTable));
Michael J. Spencerbfa06782011-10-18 19:32:17 +0000132
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000133cl::opt<bool>
134llvm::ExportsTrie("exports-trie", cl::desc("Display mach-o exported symbols"));
Nick Kledzikd04bc352014-08-30 00:20:14 +0000135
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000136cl::opt<bool>
137llvm::Rebase("rebase", cl::desc("Display mach-o rebasing info"));
Nick Kledzikac431442014-09-12 21:34:15 +0000138
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000139cl::opt<bool>
140llvm::Bind("bind", cl::desc("Display mach-o binding info"));
Nick Kledzik56ebef42014-09-16 01:41:51 +0000141
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000142cl::opt<bool>
143llvm::LazyBind("lazy-bind", cl::desc("Display mach-o lazy binding info"));
Nick Kledzik56ebef42014-09-16 01:41:51 +0000144
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000145cl::opt<bool>
146llvm::WeakBind("weak-bind", cl::desc("Display mach-o weak binding info"));
Nick Kledzik56ebef42014-09-16 01:41:51 +0000147
Adrian Prantl437105a2015-07-08 02:04:15 +0000148cl::opt<bool>
149llvm::RawClangAST("raw-clang-ast",
150 cl::desc("Dump the raw binary contents of the clang AST section"));
151
Nick Kledzik56ebef42014-09-16 01:41:51 +0000152static cl::opt<bool>
Rafael Espindolaa9f810b2012-12-21 03:47:03 +0000153MachOOpt("macho", cl::desc("Use MachO specific object file parser"));
George Rimar845d3292019-01-18 10:41:26 +0000154static cl::alias MachOm("m", cl::desc("Alias for --macho"), cl::NotHidden,
155 cl::aliasopt(MachOOpt));
Benjamin Kramer87ee76c2011-07-20 19:37:35 +0000156
Benjamin Kramer43a772e2011-09-19 17:56:04 +0000157cl::opt<std::string>
158llvm::TripleName("triple", cl::desc("Target triple to disassemble for, "
159 "see -version for available targets"));
160
161cl::opt<std::string>
Kevin Enderbyc9595622014-08-06 23:24:41 +0000162llvm::MCPU("mcpu",
163 cl::desc("Target a specific cpu type (-mcpu=help for details)"),
164 cl::value_desc("cpu-name"),
165 cl::init(""));
166
167cl::opt<std::string>
Kevin Enderbyef3ad2f2014-12-04 23:56:27 +0000168llvm::ArchName("arch-name", cl::desc("Target arch to disassemble for, "
Michael J. Spencer2670c252011-01-20 06:39:06 +0000169 "see -version for available targets"));
170
Kevin Enderby98da6132015-01-20 21:47:46 +0000171cl::opt<bool>
172llvm::SectionHeaders("section-headers", cl::desc("Display summaries of the "
173 "headers for each section."));
George Rimar845d3292019-01-18 10:41:26 +0000174static cl::alias SectionHeadersShort("headers",
175 cl::desc("Alias for --section-headers"),
176 cl::NotHidden,
177 cl::aliasopt(SectionHeaders));
178static cl::alias SectionHeadersShorter("h",
179 cl::desc("Alias for --section-headers"),
180 cl::NotHidden,
181 cl::aliasopt(SectionHeaders));
Colin LeMahieufcc32762015-07-29 19:08:10 +0000182
Colin LeMahieu77804be2015-07-29 15:45:39 +0000183cl::list<std::string>
Colin LeMahieufcc32762015-07-29 19:08:10 +0000184llvm::FilterSections("section", cl::desc("Operate on the specified sections only. "
185 "With -macho dump segment,section"));
George Rimar845d3292019-01-18 10:41:26 +0000186cl::alias static FilterSectionsj("j", cl::desc("Alias for --section"),
187 cl::NotHidden,
188 cl::aliasopt(llvm::FilterSections));
Nick Lewyckyfcf84622011-10-10 21:21:34 +0000189
Kevin Enderbyc9595622014-08-06 23:24:41 +0000190cl::list<std::string>
191llvm::MAttrs("mattr",
Jack Carter551efd72012-08-28 19:24:49 +0000192 cl::CommaSeparated,
193 cl::desc("Target specific attributes"),
194 cl::value_desc("a1,+a2,-a3,..."));
195
Kevin Enderbybf246f52014-09-24 23:08:22 +0000196cl::opt<bool>
197llvm::NoShowRawInsn("no-show-raw-insn", cl::desc("When disassembling "
198 "instructions, do not print "
199 "the instruction bytes."));
Saleem Abdulrasooldea14b22017-02-08 18:11:31 +0000200cl::opt<bool>
201llvm::NoLeadingAddr("no-leading-addr", cl::desc("Print no leading address"));
Eli Bendersky3a6808c2012-11-20 22:57:02 +0000202
Kevin Enderby98da6132015-01-20 21:47:46 +0000203cl::opt<bool>
204llvm::UnwindInfo("unwind-info", cl::desc("Display unwind information"));
Michael J. Spencer0c6ec482012-12-05 20:12:35 +0000205
George Rimar845d3292019-01-18 10:41:26 +0000206static cl::alias UnwindInfoShort("u", cl::desc("Alias for --unwind-info"),
207 cl::NotHidden, cl::aliasopt(UnwindInfo));
Michael J. Spencer0c6ec482012-12-05 20:12:35 +0000208
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000209cl::opt<bool>
210llvm::PrivateHeaders("private-headers",
211 cl::desc("Display format specific file headers"));
Michael J. Spencer209565db2013-01-06 03:56:49 +0000212
Kevin Enderby0ae163f2016-01-13 00:25:36 +0000213cl::opt<bool>
214llvm::FirstPrivateHeader("private-header",
215 cl::desc("Display only the first format specific file "
216 "header"));
217
George Rimar845d3292019-01-18 10:41:26 +0000218static cl::alias PrivateHeadersShort("p",
219 cl::desc("Alias for --private-headers"),
220 cl::NotHidden,
221 cl::aliasopt(PrivateHeaders));
Michael J. Spencer209565db2013-01-06 03:56:49 +0000222
Paul Semeld2af4d62018-07-04 15:25:03 +0000223cl::opt<bool> llvm::FileHeaders(
224 "file-headers",
225 cl::desc("Display the contents of the overall file header"));
226
227static cl::alias FileHeadersShort("f", cl::desc("Alias for --file-headers"),
George Rimar845d3292019-01-18 10:41:26 +0000228 cl::NotHidden, cl::aliasopt(FileHeaders));
Paul Semeld2af4d62018-07-04 15:25:03 +0000229
Colin LeMahieu14ec76e2015-06-07 21:07:17 +0000230cl::opt<bool>
Paul Semel0dc92f62018-07-05 14:43:29 +0000231 llvm::ArchiveHeaders("archive-headers",
232 cl::desc("Display archive header information"));
233
George Rimar845d3292019-01-18 10:41:26 +0000234cl::alias ArchiveHeadersShort("a", cl::desc("Alias for --archive-headers"),
235 cl::NotHidden, cl::aliasopt(ArchiveHeaders));
Paul Semel0dc92f62018-07-05 14:43:29 +0000236
237cl::opt<bool>
Colin LeMahieu14ec76e2015-06-07 21:07:17 +0000238 llvm::PrintImmHex("print-imm-hex",
Colin LeMahieuefe37322016-04-08 18:15:37 +0000239 cl::desc("Use hex format for immediate values"));
Colin LeMahieu14ec76e2015-06-07 21:07:17 +0000240
Sanjoy Das6f567a42015-06-22 18:03:02 +0000241cl::opt<bool> PrintFaultMaps("fault-map-section",
242 cl::desc("Display contents of faultmap section"));
243
Igor Laevsky03a670c2016-01-26 15:09:42 +0000244cl::opt<DIDumpType> llvm::DwarfDumpType(
245 "dwarf", cl::init(DIDT_Null), cl::desc("Dump of dwarf debug sections:"),
Jonas Devliegherec0a758d2017-09-18 14:15:57 +0000246 cl::values(clEnumValN(DIDT_DebugFrame, "frames", ".debug_frame")));
Igor Laevsky03a670c2016-01-26 15:09:42 +0000247
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +0000248cl::opt<bool> PrintSource(
249 "source",
250 cl::desc(
Alex Denisova07169e2018-02-02 19:20:37 +0000251 "Display source inlined with disassembly. Implies disassemble object"));
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +0000252
George Rimar845d3292019-01-18 10:41:26 +0000253cl::alias PrintSourceShort("S", cl::desc("Alias for -source"), cl::NotHidden,
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +0000254 cl::aliasopt(PrintSource));
255
256cl::opt<bool> PrintLines("line-numbers",
257 cl::desc("Display source line numbers with "
258 "disassembly. Implies disassemble object"));
259
260cl::alias PrintLinesShort("l", cl::desc("Alias for -line-numbers"),
George Rimar845d3292019-01-18 10:41:26 +0000261 cl::NotHidden, cl::aliasopt(PrintLines));
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +0000262
263cl::opt<unsigned long long>
264 StartAddress("start-address", cl::desc("Disassemble beginning at address"),
265 cl::value_desc("address"), cl::init(0));
266cl::opt<unsigned long long>
George Rimar70d197d2019-01-10 14:55:26 +0000267 StopAddress("stop-address",
George Rimar3687c3e92019-01-15 14:03:50 +0000268 cl::desc("Stop disassembly at address"),
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +0000269 cl::value_desc("address"), cl::init(UINT64_MAX));
George Rimar70d197d2019-01-10 14:55:26 +0000270
George Rimar3687c3e92019-01-15 14:03:50 +0000271cl::opt<bool> DisassembleZeroes(
272 "disassemble-zeroes",
273 cl::desc("Do not skip blocks of zeroes when disassembling"));
George Rimar70d197d2019-01-10 14:55:26 +0000274cl::alias DisassembleZeroesShort("z",
275 cl::desc("Alias for --disassemble-zeroes"),
George Rimar845d3292019-01-18 10:41:26 +0000276 cl::NotHidden,
George Rimar70d197d2019-01-10 14:55:26 +0000277 cl::aliasopt(DisassembleZeroes));
278
Benjamin Kramer43a772e2011-09-19 17:56:04 +0000279static StringRef ToolName;
Michael J. Spencer2670c252011-01-20 06:39:06 +0000280
Clement Courbetd1a3bd42019-01-18 15:26:14 +0000281typedef std::vector<std::tuple<uint64_t, StringRef, uint8_t>> SectionSymbolsTy;
Clement Courbet2d7d4a32019-01-18 09:40:19 +0000282
George Rimarc1964882019-01-18 11:33:26 +0000283SectionFilter llvm::ToolSectionFilter(llvm::object::ObjectFile const &O) {
David Majnemer42531262016-08-12 03:55:06 +0000284 return SectionFilter(
285 [](llvm::object::SectionRef const &S) {
286 if (FilterSections.empty())
287 return true;
288 llvm::StringRef String;
289 std::error_code error = S.getName(String);
290 if (error)
291 return false;
292 return is_contained(FilterSections, String);
293 },
294 O);
Colin LeMahieu77804be2015-07-29 15:45:39 +0000295}
Colin LeMahieu77804be2015-07-29 15:45:39 +0000296
Davide Italianoccd53fe2015-08-05 07:18:31 +0000297void llvm::error(std::error_code EC) {
Mark Seaborneb03ac52014-01-25 00:32:01 +0000298 if (!EC)
Davide Italianoccd53fe2015-08-05 07:18:31 +0000299 return;
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000300 WithColor::error(errs(), ToolName)
301 << "reading file: " << EC.message() << ".\n";
Davide Italiano140af642015-12-25 18:16:45 +0000302 errs().flush();
Davide Italiano7f6c3012015-08-06 00:18:52 +0000303 exit(1);
Michael J. Spencer2670c252011-01-20 06:39:06 +0000304}
305
Kevin Enderby42398052016-06-28 23:16:13 +0000306LLVM_ATTRIBUTE_NORETURN void llvm::error(Twine Message) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000307 WithColor::error(errs(), ToolName) << Message << ".\n";
Kevin Enderby42398052016-06-28 23:16:13 +0000308 errs().flush();
309 exit(1);
310}
311
Paul Semel007dedb2018-07-18 16:39:21 +0000312void llvm::warn(StringRef Message) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000313 WithColor::warning(errs(), ToolName) << Message << ".\n";
Paul Semel007dedb2018-07-18 16:39:21 +0000314 errs().flush();
315}
316
Davide Italianoed9d95b2015-12-29 13:41:02 +0000317LLVM_ATTRIBUTE_NORETURN void llvm::report_error(StringRef File,
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000318 Twine Message) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000319 WithColor::error(errs(), ToolName)
320 << "'" << File << "': " << Message << ".\n";
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000321 exit(1);
322}
323
324LLVM_ATTRIBUTE_NORETURN void llvm::report_error(StringRef File,
Davide Italianoed9d95b2015-12-29 13:41:02 +0000325 std::error_code EC) {
Alexey Samsonov50d0fbd2015-06-04 18:34:11 +0000326 assert(EC);
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000327 WithColor::error(errs(), ToolName)
328 << "'" << File << "': " << EC.message() << ".\n";
Davide Italianoccd53fe2015-08-05 07:18:31 +0000329 exit(1);
Alexey Samsonov50d0fbd2015-06-04 18:34:11 +0000330}
331
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +0000332LLVM_ATTRIBUTE_NORETURN void llvm::report_error(StringRef File,
333 llvm::Error E) {
334 assert(E);
335 std::string Buf;
336 raw_string_ostream OS(Buf);
Jonas Devlieghere45eb84f2018-11-11 01:46:03 +0000337 logAllUnhandledErrors(std::move(E), OS);
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +0000338 OS.flush();
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000339 WithColor::error(errs(), ToolName) << "'" << File << "': " << Buf;
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +0000340 exit(1);
341}
342
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000343LLVM_ATTRIBUTE_NORETURN void llvm::report_error(StringRef ArchiveName,
344 StringRef FileName,
Kevin Enderby9acb1092016-05-31 20:35:34 +0000345 llvm::Error E,
346 StringRef ArchitectureName) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000347 assert(E);
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000348 WithColor::error(errs(), ToolName);
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000349 if (ArchiveName != "")
350 errs() << ArchiveName << "(" << FileName << ")";
351 else
Justin Bogner31d8b7d2016-10-26 22:37:52 +0000352 errs() << "'" << FileName << "'";
Kevin Enderby9acb1092016-05-31 20:35:34 +0000353 if (!ArchitectureName.empty())
354 errs() << " (for architecture " << ArchitectureName << ")";
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000355 std::string Buf;
356 raw_string_ostream OS(Buf);
Jonas Devlieghere45eb84f2018-11-11 01:46:03 +0000357 logAllUnhandledErrors(std::move(E), OS);
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000358 OS.flush();
Justin Bogner31d8b7d2016-10-26 22:37:52 +0000359 errs() << ": " << Buf;
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000360 exit(1);
361}
362
363LLVM_ATTRIBUTE_NORETURN void llvm::report_error(StringRef ArchiveName,
364 const object::Archive::Child &C,
Kevin Enderby9acb1092016-05-31 20:35:34 +0000365 llvm::Error E,
366 StringRef ArchitectureName) {
Kevin Enderbyf4586032016-07-29 17:44:13 +0000367 Expected<StringRef> NameOrErr = C.getName();
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000368 // TODO: if we have a error getting the name then it would be nice to print
369 // the index of which archive member this is and or its offset in the
370 // archive instead of "???" as the name.
Kevin Enderbyf4586032016-07-29 17:44:13 +0000371 if (!NameOrErr) {
372 consumeError(NameOrErr.takeError());
Kevin Enderby9acb1092016-05-31 20:35:34 +0000373 llvm::report_error(ArchiveName, "???", std::move(E), ArchitectureName);
Kevin Enderbyf4586032016-07-29 17:44:13 +0000374 } else
Kevin Enderby9acb1092016-05-31 20:35:34 +0000375 llvm::report_error(ArchiveName, NameOrErr.get(), std::move(E),
376 ArchitectureName);
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000377}
378
Craig Toppere6cb63e2014-04-25 04:24:47 +0000379static const Target *getTarget(const ObjectFile *Obj = nullptr) {
Michael J. Spencer2670c252011-01-20 06:39:06 +0000380 // Figure out the target triple.
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000381 llvm::Triple TheTriple("unknown-unknown-unknown");
Michael J. Spencer05350e6d2011-01-20 07:22:04 +0000382 if (TripleName.empty()) {
George Rimar73a27232019-01-15 09:19:18 +0000383 if (Obj)
Vlad Tsyrklevichde620462017-09-19 02:22:48 +0000384 TheTriple = Obj->makeTriple();
Sam Parkerdf7c6ef2017-01-18 13:52:12 +0000385 } else {
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000386 TheTriple.setTriple(Triple::normalize(TripleName));
Vlad Tsyrklevichde620462017-09-19 02:22:48 +0000387
Sam Parkerdf7c6ef2017-01-18 13:52:12 +0000388 // Use the triple, but also try to combine with ARM build attributes.
389 if (Obj) {
390 auto Arch = Obj->getArch();
George Rimar73a27232019-01-15 09:19:18 +0000391 if (Arch == Triple::arm || Arch == Triple::armeb)
Sam Parkerdf7c6ef2017-01-18 13:52:12 +0000392 Obj->setARMSubArch(TheTriple);
Sam Parkerdf7c6ef2017-01-18 13:52:12 +0000393 }
394 }
Michael J. Spencer2670c252011-01-20 06:39:06 +0000395
396 // Get the target specific parser.
397 std::string Error;
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000398 const Target *TheTarget = TargetRegistry::lookupTarget(ArchName, TheTriple,
399 Error);
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000400 if (!TheTarget) {
401 if (Obj)
402 report_error(Obj->getFileName(), "can't find target: " + Error);
403 else
404 error("can't find target: " + Error);
405 }
Michael J. Spencer2670c252011-01-20 06:39:06 +0000406
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000407 // Update the triple name and return the found target.
408 TripleName = TheTriple.getTriple();
409 return TheTarget;
Michael J. Spencer2670c252011-01-20 06:39:06 +0000410}
411
George Rimar73a27232019-01-15 09:19:18 +0000412bool llvm::isRelocAddressLess(RelocationRef A, RelocationRef B) {
413 return A.getOffset() < B.getOffset();
Michael J. Spencer51862b32011-10-13 22:17:18 +0000414}
415
Rafael Espindola37070a52015-06-03 04:48:06 +0000416static std::error_code getRelocationValueString(const RelocationRef &Rel,
417 SmallVectorImpl<char> &Result) {
Rafael Espindola854038e2015-06-26 14:51:16 +0000418 const ObjectFile *Obj = Rel.getObject();
Rafael Espindola37070a52015-06-03 04:48:06 +0000419 if (auto *ELF = dyn_cast<ELFObjectFileBase>(Obj))
George Rimarc1964882019-01-18 11:33:26 +0000420 return getELFRelocationValueString(ELF, Rel, Result);
Rafael Espindola37070a52015-06-03 04:48:06 +0000421 if (auto *COFF = dyn_cast<COFFObjectFile>(Obj))
George Rimarc1964882019-01-18 11:33:26 +0000422 return getCOFFRelocationValueString(COFF, Rel, Result);
Sam Clegg4df5d762017-06-27 20:40:53 +0000423 if (auto *Wasm = dyn_cast<WasmObjectFile>(Obj))
George Rimarc1964882019-01-18 11:33:26 +0000424 return getWasmRelocationValueString(Wasm, Rel, Result);
Sam Clegg4df5d762017-06-27 20:40:53 +0000425 if (auto *MachO = dyn_cast<MachOObjectFile>(Obj))
George Rimarc1964882019-01-18 11:33:26 +0000426 return getMachORelocationValueString(MachO, Rel, Result);
Sam Clegg4df5d762017-06-27 20:40:53 +0000427 llvm_unreachable("unknown object file format");
Rafael Espindola37070a52015-06-03 04:48:06 +0000428}
429
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +0000430/// Indicates whether this relocation should hidden when listing
Rafael Espindola0ad71d92015-06-30 03:41:26 +0000431/// relocations, usually because it is the trailing part of a multipart
432/// relocation that will be printed as part of the leading relocation.
433static bool getHidden(RelocationRef RelRef) {
George Rimar73a27232019-01-15 09:19:18 +0000434 auto *MachO = dyn_cast<MachOObjectFile>(RelRef.getObject());
Rafael Espindola0ad71d92015-06-30 03:41:26 +0000435 if (!MachO)
436 return false;
437
438 unsigned Arch = MachO->getArch();
439 DataRefImpl Rel = RelRef.getRawDataRefImpl();
440 uint64_t Type = MachO->getRelocationType(Rel);
441
442 // On arches that use the generic relocations, GENERIC_RELOC_PAIR
443 // is always hidden.
George Rimar73a27232019-01-15 09:19:18 +0000444 if (Arch == Triple::x86 || Arch == Triple::arm || Arch == Triple::ppc)
445 return Type == MachO::GENERIC_RELOC_PAIR;
446
447 if (Arch == Triple::x86_64) {
Rafael Espindola0ad71d92015-06-30 03:41:26 +0000448 // On x86_64, X86_64_RELOC_UNSIGNED is hidden only when it follows
449 // an X86_64_RELOC_SUBTRACTOR.
450 if (Type == MachO::X86_64_RELOC_UNSIGNED && Rel.d.a > 0) {
451 DataRefImpl RelPrev = Rel;
452 RelPrev.d.a--;
453 uint64_t PrevType = MachO->getRelocationType(RelPrev);
454 if (PrevType == MachO::X86_64_RELOC_SUBTRACTOR)
455 return true;
456 }
457 }
458
459 return false;
460}
461
Sid Manningd9f28732018-05-14 19:46:08 +0000462namespace {
463class SourcePrinter {
464protected:
465 DILineInfo OldLineInfo;
466 const ObjectFile *Obj = nullptr;
467 std::unique_ptr<symbolize::LLVMSymbolizer> Symbolizer;
468 // File name to file contents of source
469 std::unordered_map<std::string, std::unique_ptr<MemoryBuffer>> SourceCache;
470 // Mark the line endings of the cached source
471 std::unordered_map<std::string, std::vector<StringRef>> LineCache;
472
473private:
474 bool cacheSource(const DILineInfo& LineInfoFile);
475
476public:
477 SourcePrinter() = default;
478 SourcePrinter(const ObjectFile *Obj, StringRef DefaultArch) : Obj(Obj) {
479 symbolize::LLVMSymbolizer::Options SymbolizerOpts(
480 DILineInfoSpecifier::FunctionNameKind::None, true, false, false,
481 DefaultArch);
482 Symbolizer.reset(new symbolize::LLVMSymbolizer(SymbolizerOpts));
483 }
484 virtual ~SourcePrinter() = default;
485 virtual void printSourceLine(raw_ostream &OS, uint64_t Address,
486 StringRef Delimiter = "; ");
487};
488
489bool SourcePrinter::cacheSource(const DILineInfo &LineInfo) {
490 std::unique_ptr<MemoryBuffer> Buffer;
491 if (LineInfo.Source) {
492 Buffer = MemoryBuffer::getMemBuffer(*LineInfo.Source);
493 } else {
494 auto BufferOrError = MemoryBuffer::getFile(LineInfo.FileName);
495 if (!BufferOrError)
496 return false;
497 Buffer = std::move(*BufferOrError);
498 }
499 // Chomp the file to get lines
500 size_t BufferSize = Buffer->getBufferSize();
501 const char *BufferStart = Buffer->getBufferStart();
502 for (const char *Start = BufferStart, *End = BufferStart;
503 End < BufferStart + BufferSize; End++)
504 if (*End == '\n' || End == BufferStart + BufferSize - 1 ||
505 (*End == '\r' && *(End + 1) == '\n')) {
506 LineCache[LineInfo.FileName].push_back(StringRef(Start, End - Start));
507 if (*End == '\r')
508 End++;
509 Start = End + 1;
510 }
511 SourceCache[LineInfo.FileName] = std::move(Buffer);
512 return true;
513}
514
515void SourcePrinter::printSourceLine(raw_ostream &OS, uint64_t Address,
516 StringRef Delimiter) {
517 if (!Symbolizer)
518 return;
519 DILineInfo LineInfo = DILineInfo();
520 auto ExpectecLineInfo =
521 Symbolizer->symbolizeCode(Obj->getFileName(), Address);
522 if (!ExpectecLineInfo)
523 consumeError(ExpectecLineInfo.takeError());
524 else
525 LineInfo = *ExpectecLineInfo;
526
527 if ((LineInfo.FileName == "<invalid>") || OldLineInfo.Line == LineInfo.Line ||
528 LineInfo.Line == 0)
529 return;
530
531 if (PrintLines)
532 OS << Delimiter << LineInfo.FileName << ":" << LineInfo.Line << "\n";
533 if (PrintSource) {
534 if (SourceCache.find(LineInfo.FileName) == SourceCache.end())
535 if (!cacheSource(LineInfo))
536 return;
537 auto FileBuffer = SourceCache.find(LineInfo.FileName);
538 if (FileBuffer != SourceCache.end()) {
539 auto LineBuffer = LineCache.find(LineInfo.FileName);
540 if (LineBuffer != LineCache.end()) {
541 if (LineInfo.Line > LineBuffer->second.size())
542 return;
543 // Vector begins at 0, line numbers are non-zero
544 OS << Delimiter << LineBuffer->second[LineInfo.Line - 1].ltrim()
545 << "\n";
546 }
547 }
548 }
549 OldLineInfo = LineInfo;
550}
551
552static bool isArmElf(const ObjectFile *Obj) {
553 return (Obj->isELF() &&
554 (Obj->getArch() == Triple::aarch64 ||
555 Obj->getArch() == Triple::aarch64_be ||
556 Obj->getArch() == Triple::arm || Obj->getArch() == Triple::armeb ||
557 Obj->getArch() == Triple::thumb ||
558 Obj->getArch() == Triple::thumbeb));
559}
560
561class PrettyPrinter {
562public:
563 virtual ~PrettyPrinter() = default;
564 virtual void printInst(MCInstPrinter &IP, const MCInst *MI,
565 ArrayRef<uint8_t> Bytes, uint64_t Address,
566 raw_ostream &OS, StringRef Annot,
567 MCSubtargetInfo const &STI, SourcePrinter *SP,
568 std::vector<RelocationRef> *Rels = nullptr) {
569 if (SP && (PrintSource || PrintLines))
570 SP->printSourceLine(OS, Address);
571 if (!NoLeadingAddr)
572 OS << format("%8" PRIx64 ":", Address);
573 if (!NoShowRawInsn) {
574 OS << "\t";
575 dumpBytes(Bytes, OS);
576 }
577 if (MI)
578 IP.printInst(MI, OS, "", STI);
579 else
580 OS << " <unknown>";
581 }
582};
583PrettyPrinter PrettyPrinterInst;
584class HexagonPrettyPrinter : public PrettyPrinter {
585public:
586 void printLead(ArrayRef<uint8_t> Bytes, uint64_t Address,
587 raw_ostream &OS) {
588 uint32_t opcode =
589 (Bytes[3] << 24) | (Bytes[2] << 16) | (Bytes[1] << 8) | Bytes[0];
590 if (!NoLeadingAddr)
591 OS << format("%8" PRIx64 ":", Address);
592 if (!NoShowRawInsn) {
593 OS << "\t";
594 dumpBytes(Bytes.slice(0, 4), OS);
595 OS << format("%08" PRIx32, opcode);
596 }
597 }
598 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
599 uint64_t Address, raw_ostream &OS, StringRef Annot,
600 MCSubtargetInfo const &STI, SourcePrinter *SP,
601 std::vector<RelocationRef> *Rels) override {
602 if (SP && (PrintSource || PrintLines))
603 SP->printSourceLine(OS, Address, "");
604 if (!MI) {
605 printLead(Bytes, Address, OS);
606 OS << " <unknown>";
607 return;
608 }
609 std::string Buffer;
610 {
611 raw_string_ostream TempStream(Buffer);
612 IP.printInst(MI, TempStream, "", STI);
613 }
614 StringRef Contents(Buffer);
615 // Split off bundle attributes
616 auto PacketBundle = Contents.rsplit('\n');
617 // Split off first instruction from the rest
618 auto HeadTail = PacketBundle.first.split('\n');
619 auto Preamble = " { ";
620 auto Separator = "";
621 StringRef Fmt = "\t\t\t%08" PRIx64 ": ";
George Rimar73a27232019-01-15 09:19:18 +0000622 std::vector<RelocationRef>::const_iterator RelCur = Rels->begin();
623 std::vector<RelocationRef>::const_iterator RelEnd = Rels->end();
Sid Manningd9f28732018-05-14 19:46:08 +0000624
625 // Hexagon's packets require relocations to be inline rather than
626 // clustered at the end of the packet.
627 auto PrintReloc = [&]() -> void {
George Rimar73a27232019-01-15 09:19:18 +0000628 while ((RelCur != RelEnd) && (RelCur->getOffset() <= Address)) {
629 if (RelCur->getOffset() == Address) {
630 SmallString<16> Name;
631 SmallString<32> Val;
632 RelCur->getTypeName(Name);
633 error(getRelocationValueString(*RelCur, Val));
634 OS << Separator << format(Fmt.data(), Address) << Name << "\t" << Val
Sid Manningd9f28732018-05-14 19:46:08 +0000635 << "\n";
636 return;
637 }
George Rimar73a27232019-01-15 09:19:18 +0000638 ++RelCur;
Sid Manningd9f28732018-05-14 19:46:08 +0000639 }
640 };
641
George Rimar73a27232019-01-15 09:19:18 +0000642 while (!HeadTail.first.empty()) {
Sid Manningd9f28732018-05-14 19:46:08 +0000643 OS << Separator;
644 Separator = "\n";
645 if (SP && (PrintSource || PrintLines))
646 SP->printSourceLine(OS, Address, "");
647 printLead(Bytes, Address, OS);
648 OS << Preamble;
649 Preamble = " ";
650 StringRef Inst;
651 auto Duplex = HeadTail.first.split('\v');
George Rimar73a27232019-01-15 09:19:18 +0000652 if (!Duplex.second.empty()) {
Sid Manningd9f28732018-05-14 19:46:08 +0000653 OS << Duplex.first;
654 OS << "; ";
655 Inst = Duplex.second;
656 }
657 else
658 Inst = HeadTail.first;
659 OS << Inst;
660 HeadTail = HeadTail.second.split('\n');
661 if (HeadTail.first.empty())
662 OS << " } " << PacketBundle.second;
663 PrintReloc();
664 Bytes = Bytes.slice(4);
665 Address += 4;
666 }
667 }
668};
669HexagonPrettyPrinter HexagonPrettyPrinterInst;
670
671class AMDGCNPrettyPrinter : public PrettyPrinter {
672public:
673 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
674 uint64_t Address, raw_ostream &OS, StringRef Annot,
675 MCSubtargetInfo const &STI, SourcePrinter *SP,
676 std::vector<RelocationRef> *Rels) override {
677 if (SP && (PrintSource || PrintLines))
678 SP->printSourceLine(OS, Address);
679
680 typedef support::ulittle32_t U32;
681
682 if (MI) {
683 SmallString<40> InstStr;
684 raw_svector_ostream IS(InstStr);
685
686 IP.printInst(MI, IS, "", STI);
687
688 OS << left_justify(IS.str(), 60);
689 } else {
690 // an unrecognized encoding - this is probably data so represent it
691 // using the .long directive, or .byte directive if fewer than 4 bytes
692 // remaining
693 if (Bytes.size() >= 4) {
694 OS << format("\t.long 0x%08" PRIx32 " ",
695 static_cast<uint32_t>(*reinterpret_cast<const U32*>(Bytes.data())));
696 OS.indent(42);
697 } else {
698 OS << format("\t.byte 0x%02" PRIx8, Bytes[0]);
699 for (unsigned int i = 1; i < Bytes.size(); i++)
700 OS << format(", 0x%02" PRIx8, Bytes[i]);
701 OS.indent(55 - (6 * Bytes.size()));
702 }
703 }
704
705 OS << format("// %012" PRIX64 ": ", Address);
706 if (Bytes.size() >=4) {
707 for (auto D : makeArrayRef(reinterpret_cast<const U32*>(Bytes.data()),
708 Bytes.size() / sizeof(U32)))
709 // D should be explicitly casted to uint32_t here as it is passed
710 // by format to snprintf as vararg.
711 OS << format("%08" PRIX32 " ", static_cast<uint32_t>(D));
712 } else {
713 for (unsigned int i = 0; i < Bytes.size(); i++)
714 OS << format("%02" PRIX8 " ", Bytes[i]);
715 }
716
717 if (!Annot.empty())
718 OS << "// " << Annot;
719 }
720};
721AMDGCNPrettyPrinter AMDGCNPrettyPrinterInst;
722
723class BPFPrettyPrinter : public PrettyPrinter {
724public:
725 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
726 uint64_t Address, raw_ostream &OS, StringRef Annot,
727 MCSubtargetInfo const &STI, SourcePrinter *SP,
728 std::vector<RelocationRef> *Rels) override {
729 if (SP && (PrintSource || PrintLines))
730 SP->printSourceLine(OS, Address);
731 if (!NoLeadingAddr)
732 OS << format("%8" PRId64 ":", Address / 8);
733 if (!NoShowRawInsn) {
734 OS << "\t";
735 dumpBytes(Bytes, OS);
736 }
737 if (MI)
738 IP.printInst(MI, OS, "", STI);
739 else
740 OS << " <unknown>";
741 }
742};
743BPFPrettyPrinter BPFPrettyPrinterInst;
744
745PrettyPrinter &selectPrettyPrinter(Triple const &Triple) {
746 switch(Triple.getArch()) {
747 default:
748 return PrettyPrinterInst;
749 case Triple::hexagon:
750 return HexagonPrettyPrinterInst;
751 case Triple::amdgcn:
752 return AMDGCNPrettyPrinterInst;
753 case Triple::bpfel:
754 case Triple::bpfeb:
755 return BPFPrettyPrinterInst;
756 }
757}
758}
759
Sam Koltonc05d7782016-08-17 10:17:57 +0000760static uint8_t getElfSymbolType(const ObjectFile *Obj, const SymbolRef &Sym) {
761 assert(Obj->isELF());
762 if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(Obj))
763 return Elf32LEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
764 if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(Obj))
765 return Elf64LEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
766 if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(Obj))
767 return Elf32BEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
768 if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(Obj))
769 return Elf64BEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
770 llvm_unreachable("Unsupported binary format");
771}
772
Sam Parker5fba45a2017-02-08 09:44:18 +0000773template <class ELFT> static void
774addDynamicElfSymbols(const ELFObjectFile<ELFT> *Obj,
775 std::map<SectionRef, SectionSymbolsTy> &AllSymbols) {
776 for (auto Symbol : Obj->getDynamicSymbolIterators()) {
777 uint8_t SymbolType = Symbol.getELFType();
778 if (SymbolType != ELF::STT_FUNC || Symbol.getSize() == 0)
779 continue;
780
781 Expected<uint64_t> AddressOrErr = Symbol.getAddress();
782 if (!AddressOrErr)
783 report_error(Obj->getFileName(), AddressOrErr.takeError());
Sam Parker5fba45a2017-02-08 09:44:18 +0000784
785 Expected<StringRef> Name = Symbol.getName();
786 if (!Name)
787 report_error(Obj->getFileName(), Name.takeError());
788 if (Name->empty())
789 continue;
790
791 Expected<section_iterator> SectionOrErr = Symbol.getSection();
792 if (!SectionOrErr)
793 report_error(Obj->getFileName(), SectionOrErr.takeError());
794 section_iterator SecI = *SectionOrErr;
795 if (SecI == Obj->section_end())
796 continue;
797
George Rimar73a27232019-01-15 09:19:18 +0000798 AllSymbols[*SecI].emplace_back(*AddressOrErr, *Name, SymbolType);
Sam Parker5fba45a2017-02-08 09:44:18 +0000799 }
800}
801
802static void
803addDynamicElfSymbols(const ObjectFile *Obj,
804 std::map<SectionRef, SectionSymbolsTy> &AllSymbols) {
805 assert(Obj->isELF());
806 if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(Obj))
807 addDynamicElfSymbols(Elf32LEObj, AllSymbols);
808 else if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(Obj))
809 addDynamicElfSymbols(Elf64LEObj, AllSymbols);
810 else if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(Obj))
811 addDynamicElfSymbols(Elf32BEObj, AllSymbols);
812 else if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(Obj))
813 addDynamicElfSymbols(Elf64BEObj, AllSymbols);
814 else
815 llvm_unreachable("Unsupported binary format");
816}
817
Joel Galenson134cf472018-08-24 15:21:57 +0000818static void addPltEntries(const ObjectFile *Obj,
819 std::map<SectionRef, SectionSymbolsTy> &AllSymbols,
820 StringSaver &Saver) {
821 Optional<SectionRef> Plt = None;
822 for (const SectionRef &Section : Obj->sections()) {
823 StringRef Name;
824 if (Section.getName(Name))
825 continue;
826 if (Name == ".plt")
827 Plt = Section;
828 }
829 if (!Plt)
830 return;
831 if (auto *ElfObj = dyn_cast<ELFObjectFileBase>(Obj)) {
832 for (auto PltEntry : ElfObj->getPltAddresses()) {
833 SymbolRef Symbol(PltEntry.first, ElfObj);
Joel Galenson134cf472018-08-24 15:21:57 +0000834 uint8_t SymbolType = getElfSymbolType(Obj, Symbol);
835
836 Expected<StringRef> NameOrErr = Symbol.getName();
837 if (!NameOrErr)
838 report_error(Obj->getFileName(), NameOrErr.takeError());
839 if (NameOrErr->empty())
840 continue;
841 StringRef Name = Saver.save((*NameOrErr + "@plt").str());
842
843 AllSymbols[*Plt].emplace_back(PltEntry.second, Name, SymbolType);
844 }
845 }
846}
847
George Rimar70d197d2019-01-10 14:55:26 +0000848// Normally the disassembly output will skip blocks of zeroes. This function
849// returns the number of zero bytes that can be skipped when dumping the
850// disassembly of the instructions in Buf.
851static size_t countSkippableZeroBytes(ArrayRef<uint8_t> Buf) {
852 // When -z or --disassemble-zeroes are given we always dissasemble them.
853 if (DisassembleZeroes)
854 return 0;
855
856 // Find the number of leading zeroes.
857 size_t N = 0;
858 while (N < Buf.size() && !Buf[N])
859 ++N;
860
861 // We may want to skip blocks of zero bytes, but unless we see
862 // at least 8 of them in a row.
863 if (N < 8)
864 return 0;
865
866 // We skip zeroes in multiples of 4 because do not want to truncate an
867 // instruction if it starts with a zero byte.
868 return N & ~0x3;
869}
870
George Rimar121fcd72019-01-22 14:09:37 +0000871// Returns a map from sections to their relocations.
872static std::map<SectionRef, std::vector<RelocationRef>>
873getRelocsMap(llvm::object::ObjectFile const &Obj) {
874 std::map<SectionRef, std::vector<RelocationRef>> Ret;
875 for (const SectionRef &Section : ToolSectionFilter(Obj)) {
876 section_iterator RelSec = Section.getRelocatedSection();
877 if (RelSec == Obj.section_end())
878 continue;
879 std::vector<RelocationRef> &V = Ret[*RelSec];
880 for (const RelocationRef &R : Section.relocations())
881 V.push_back(R);
882 // Sort relocations by address.
883 llvm::sort(V, isRelocAddressLess);
884 }
885 return Ret;
886}
887
George Rimarbcbe98b2019-01-23 10:33:26 +0000888static void disassembleObject(const Target *TheTarget, const ObjectFile *Obj,
889 MCContext &Ctx, MCDisassembler *DisAsm,
890 const MCInstrAnalysis *MIA, MCInstPrinter *IP,
891 const MCSubtargetInfo *STI, PrettyPrinter &PIP,
892 SourcePrinter &SP, bool InlineRelocs) {
893 StringRef Fmt = Obj->getBytesInAddress() > 4 ? "\t\t%016" PRIx64 ": "
894 : "\t\t\t%08" PRIx64 ": ";
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +0000895
George Rimar121fcd72019-01-22 14:09:37 +0000896 std::map<SectionRef, std::vector<RelocationRef>> RelocMap;
897 if (InlineRelocs)
898 RelocMap = getRelocsMap(*Obj);
Mark Seaborn0929d3d2014-01-25 17:38:19 +0000899
David Majnemer81afca62015-07-07 22:06:59 +0000900 // Create a mapping from virtual address to symbol name. This is used to
David Majnemerfbb1c3a2015-11-18 02:49:19 +0000901 // pretty print the symbols while disassembling.
David Majnemerfbb1c3a2015-11-18 02:49:19 +0000902 std::map<SectionRef, SectionSymbolsTy> AllSymbols;
Sterling Augustinebc78b622018-06-28 18:57:13 +0000903 SectionSymbolsTy AbsoluteSymbols;
David Majnemerfbb1c3a2015-11-18 02:49:19 +0000904 for (const SymbolRef &Symbol : Obj->symbols()) {
Kevin Enderby931cb652016-06-24 18:24:42 +0000905 Expected<uint64_t> AddressOrErr = Symbol.getAddress();
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000906 if (!AddressOrErr)
907 report_error(Obj->getFileName(), AddressOrErr.takeError());
David Majnemerfbb1c3a2015-11-18 02:49:19 +0000908 uint64_t Address = *AddressOrErr;
David Majnemer2603a8fa2015-07-09 18:11:40 +0000909
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000910 Expected<StringRef> Name = Symbol.getName();
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000911 if (!Name)
912 report_error(Obj->getFileName(), Name.takeError());
David Majnemerfbb1c3a2015-11-18 02:49:19 +0000913 if (Name->empty())
914 continue;
David Majnemer81afca62015-07-07 22:06:59 +0000915
Kevin Enderby7bd8d992016-05-02 20:28:12 +0000916 Expected<section_iterator> SectionOrErr = Symbol.getSection();
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000917 if (!SectionOrErr)
918 report_error(Obj->getFileName(), SectionOrErr.takeError());
Hemant Kulkarni5b60f632016-08-25 19:41:08 +0000919
Sam Koltonc05d7782016-08-17 10:17:57 +0000920 uint8_t SymbolType = ELF::STT_NOTYPE;
Hemant Kulkarni5b60f632016-08-25 19:41:08 +0000921 if (Obj->isELF())
Sam Koltonc05d7782016-08-17 10:17:57 +0000922 SymbolType = getElfSymbolType(Obj, Symbol);
David Majnemer81afca62015-07-07 22:06:59 +0000923
Sterling Augustinebc78b622018-06-28 18:57:13 +0000924 section_iterator SecI = *SectionOrErr;
925 if (SecI != Obj->section_end())
926 AllSymbols[*SecI].emplace_back(Address, *Name, SymbolType);
927 else
928 AbsoluteSymbols.emplace_back(Address, *Name, SymbolType);
929
Sam Koltonc05d7782016-08-17 10:17:57 +0000930
David Majnemer81afca62015-07-07 22:06:59 +0000931 }
Sam Parker5fba45a2017-02-08 09:44:18 +0000932 if (AllSymbols.empty() && Obj->isELF())
933 addDynamicElfSymbols(Obj, AllSymbols);
David Majnemer81afca62015-07-07 22:06:59 +0000934
Joel Galenson134cf472018-08-24 15:21:57 +0000935 BumpPtrAllocator A;
936 StringSaver Saver(A);
937 addPltEntries(Obj, AllSymbols, Saver);
938
David Majnemerfbb1c3a2015-11-18 02:49:19 +0000939 // Create a mapping from virtual address to section.
940 std::vector<std::pair<uint64_t, SectionRef>> SectionAddresses;
941 for (SectionRef Sec : Obj->sections())
942 SectionAddresses.emplace_back(Sec.getAddress(), Sec);
943 array_pod_sort(SectionAddresses.begin(), SectionAddresses.end());
944
945 // Linked executables (.exe and .dll files) typically don't include a real
946 // symbol table but they might contain an export table.
947 if (const auto *COFFObj = dyn_cast<COFFObjectFile>(Obj)) {
948 for (const auto &ExportEntry : COFFObj->export_directories()) {
949 StringRef Name;
950 error(ExportEntry.getSymbolName(Name));
951 if (Name.empty())
952 continue;
953 uint32_t RVA;
954 error(ExportEntry.getExportRVA(RVA));
955
956 uint64_t VA = COFFObj->getImageBase() + RVA;
957 auto Sec = std::upper_bound(
958 SectionAddresses.begin(), SectionAddresses.end(), VA,
959 [](uint64_t LHS, const std::pair<uint64_t, SectionRef> &RHS) {
960 return LHS < RHS.first;
961 });
962 if (Sec != SectionAddresses.begin())
963 --Sec;
964 else
965 Sec = SectionAddresses.end();
966
967 if (Sec != SectionAddresses.end())
Sam Koltonc05d7782016-08-17 10:17:57 +0000968 AllSymbols[Sec->second].emplace_back(VA, Name, ELF::STT_NOTYPE);
Sterling Augustinebc78b622018-06-28 18:57:13 +0000969 else
970 AbsoluteSymbols.emplace_back(VA, Name, ELF::STT_NOTYPE);
David Majnemerfbb1c3a2015-11-18 02:49:19 +0000971 }
972 }
973
974 // Sort all the symbols, this allows us to use a simple binary search to find
975 // a symbol near an address.
976 for (std::pair<const SectionRef, SectionSymbolsTy> &SecSyms : AllSymbols)
977 array_pod_sort(SecSyms.second.begin(), SecSyms.second.end());
Sterling Augustinebc78b622018-06-28 18:57:13 +0000978 array_pod_sort(AbsoluteSymbols.begin(), AbsoluteSymbols.end());
David Majnemerfbb1c3a2015-11-18 02:49:19 +0000979
Colin LeMahieu77804be2015-07-29 15:45:39 +0000980 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Colin LeMahieuf34933e2015-07-23 20:58:49 +0000981 if (!DisassembleAll && (!Section.isText() || Section.isVirtual()))
Mark Seaborneb03ac52014-01-25 00:32:01 +0000982 continue;
Michael J. Spencer1d6167f2011-06-25 17:55:23 +0000983
Rafael Espindola80291272014-10-08 15:28:58 +0000984 uint64_t SectionAddr = Section.getAddress();
985 uint64_t SectSize = Section.getSize();
David Majnemer185b5b12014-11-11 09:58:25 +0000986 if (!SectSize)
987 continue;
Simon Atanasyan2b614e12014-02-24 22:12:11 +0000988
David Majnemerfbb1c3a2015-11-18 02:49:19 +0000989 // Get the list of all the symbols in this section.
990 SectionSymbolsTy &Symbols = AllSymbols[Section];
Davide Italianof0706882015-10-01 21:57:09 +0000991 std::vector<uint64_t> DataMappingSymsAddr;
992 std::vector<uint64_t> TextMappingSymsAddr;
Hemant Kulkarni5b60f632016-08-25 19:41:08 +0000993 if (isArmElf(Obj)) {
David Majnemerfbb1c3a2015-11-18 02:49:19 +0000994 for (const auto &Symb : Symbols) {
Clement Courbetd1a3bd42019-01-18 15:26:14 +0000995 uint64_t Address = std::get<0>(Symb);
996 StringRef Name = std::get<1>(Symb);
David Majnemerfbb1c3a2015-11-18 02:49:19 +0000997 if (Name.startswith("$d"))
David Majnemer153722d2015-11-18 04:35:32 +0000998 DataMappingSymsAddr.push_back(Address - SectionAddr);
David Majnemerfbb1c3a2015-11-18 02:49:19 +0000999 if (Name.startswith("$x"))
David Majnemer153722d2015-11-18 04:35:32 +00001000 TextMappingSymsAddr.push_back(Address - SectionAddr);
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001001 if (Name.startswith("$a"))
1002 TextMappingSymsAddr.push_back(Address - SectionAddr);
1003 if (Name.startswith("$t"))
1004 TextMappingSymsAddr.push_back(Address - SectionAddr);
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001005 }
1006 }
1007
Fangrui Song0cac7262018-09-27 02:13:45 +00001008 llvm::sort(DataMappingSymsAddr);
1009 llvm::sort(TextMappingSymsAddr);
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001010
Sam Kolton3381d7a2016-10-06 13:46:08 +00001011 if (Obj->isELF() && Obj->getArch() == Triple::amdgcn) {
1012 // AMDGPU disassembler uses symbolizer for printing labels
1013 std::unique_ptr<MCRelocationInfo> RelInfo(
1014 TheTarget->createMCRelocationInfo(TripleName, Ctx));
1015 if (RelInfo) {
1016 std::unique_ptr<MCSymbolizer> Symbolizer(
1017 TheTarget->createMCSymbolizer(
1018 TripleName, nullptr, nullptr, &Symbols, &Ctx, std::move(RelInfo)));
1019 DisAsm->setSymbolizer(std::move(Symbolizer));
1020 }
1021 }
1022
Rafael Espindolaa9f810b2012-12-21 03:47:03 +00001023 StringRef SegmentName = "";
Mark Seaborneb03ac52014-01-25 00:32:01 +00001024 if (const MachOObjectFile *MachO = dyn_cast<const MachOObjectFile>(Obj)) {
Alexey Samsonov48803e52014-03-13 14:37:36 +00001025 DataRefImpl DR = Section.getRawDataRefImpl();
Rafael Espindola56f976f2013-04-18 18:08:55 +00001026 SegmentName = MachO->getSectionFinalSegmentName(DR);
Rafael Espindolaa9f810b2012-12-21 03:47:03 +00001027 }
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001028 StringRef SectionName;
1029 error(Section.getName(SectionName));
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001030
Rafael Espindola7884c952015-06-04 15:01:05 +00001031 // If the section has no symbol at the start, just insert a dummy one.
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001032 if (Symbols.empty() || std::get<0>(Symbols[0]) != 0) {
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001033 Symbols.insert(
1034 Symbols.begin(),
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001035 std::make_tuple(SectionAddr, SectionName,
1036 Section.isText() ? ELF::STT_FUNC : ELF::STT_OBJECT));
Sam Koltonc05d7782016-08-17 10:17:57 +00001037 }
Alp Tokere69170a2014-06-26 22:52:05 +00001038
1039 SmallString<40> Comments;
1040 raw_svector_ostream CommentStream(Comments);
Ahmed Bougachaad1084d2013-05-24 00:39:57 +00001041
Rafael Espindola7fc5b872014-11-12 02:04:27 +00001042 StringRef BytesStr;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001043 error(Section.getContents(BytesStr));
Aaron Ballman106fd7b2014-11-12 14:01:17 +00001044 ArrayRef<uint8_t> Bytes(reinterpret_cast<const uint8_t *>(BytesStr.data()),
1045 BytesStr.size());
Rafael Espindola7fc5b872014-11-12 02:04:27 +00001046
Michael J. Spencer2670c252011-01-20 06:39:06 +00001047 uint64_t Size;
1048 uint64_t Index;
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001049 bool PrintedSection = false;
Michael J. Spencer2670c252011-01-20 06:39:06 +00001050
George Rimar121fcd72019-01-22 14:09:37 +00001051 std::vector<RelocationRef> Rels = RelocMap[Section];
George Rimar73a27232019-01-15 09:19:18 +00001052 std::vector<RelocationRef>::const_iterator RelCur = Rels.begin();
1053 std::vector<RelocationRef>::const_iterator RelEnd = Rels.end();
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001054 // Disassemble symbol by symbol.
George Rimar73a27232019-01-15 09:19:18 +00001055 for (unsigned SI = 0, SE = Symbols.size(); SI != SE; ++SI) {
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001056 uint64_t Start = std::get<0>(Symbols[SI]) - SectionAddr;
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001057 // The end is either the section end or the beginning of the next
1058 // symbol.
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001059 uint64_t End = (SI == SE - 1)
1060 ? SectSize
1061 : std::get<0>(Symbols[SI + 1]) - SectionAddr;
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001062 // Don't try to disassemble beyond the end of section contents.
1063 if (End > SectSize)
1064 End = SectSize;
Rafael Espindolae45c7402014-08-17 16:31:39 +00001065 // If this symbol has the same address as the next symbol, then skip it.
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001066 if (Start >= End)
Michael J. Spenceree84f642011-10-13 20:37:08 +00001067 continue;
1068
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001069 // Check if we need to skip symbol
1070 // Skip if the symbol's data is not between StartAddress and StopAddress
1071 if (End + SectionAddr < StartAddress ||
1072 Start + SectionAddr > StopAddress) {
1073 continue;
1074 }
1075
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001076 /// Skip if user requested specific symbols and this is not in the list
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001077 if (!DisasmFuncsSet.empty() &&
1078 !DisasmFuncsSet.count(std::get<1>(Symbols[SI])))
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001079 continue;
1080
1081 if (!PrintedSection) {
1082 PrintedSection = true;
1083 outs() << "Disassembly of section ";
1084 if (!SegmentName.empty())
1085 outs() << SegmentName << ",";
1086 outs() << SectionName << ':';
1087 }
1088
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001089 // Stop disassembly at the stop address specified
1090 if (End + SectionAddr > StopAddress)
1091 End = StopAddress - SectionAddr;
1092
Valery Pykhtinde048052016-04-07 07:24:01 +00001093 if (Obj->isELF() && Obj->getArch() == Triple::amdgcn) {
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001094 if (std::get<2>(Symbols[SI]) == ELF::STT_AMDGPU_HSA_KERNEL) {
Sam Koltonc05d7782016-08-17 10:17:57 +00001095 // skip amd_kernel_code_t at the begining of kernel symbol (256 bytes)
1096 Start += 256;
1097 }
George Rimar73a27232019-01-15 09:19:18 +00001098 if (SI == SE - 1 ||
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001099 std::get<2>(Symbols[SI + 1]) == ELF::STT_AMDGPU_HSA_KERNEL) {
Sam Koltonc05d7782016-08-17 10:17:57 +00001100 // cut trailing zeroes at the end of kernel
1101 // cut up to 256 bytes
1102 const uint64_t EndAlign = 256;
1103 const auto Limit = End - (std::min)(EndAlign, End - Start);
1104 while (End > Limit &&
1105 *reinterpret_cast<const support::ulittle32_t*>(&Bytes[End - 4]) == 0)
1106 End -= 4;
1107 }
Valery Pykhtinde048052016-04-07 07:24:01 +00001108 }
1109
George Rimar6622d412018-12-19 10:21:45 +00001110 outs() << '\n';
George Rimar3ba0f3c02019-01-09 14:43:33 +00001111 if (!NoLeadingAddr)
1112 outs() << format("%016" PRIx64 " ", SectionAddr + Start);
1113
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001114 StringRef SymbolName = std::get<1>(Symbols[SI]);
George Rimar6622d412018-12-19 10:21:45 +00001115 if (Demangle)
1116 outs() << demangle(SymbolName) << ":\n";
1117 else
1118 outs() << SymbolName << ":\n";
Michael J. Spencer2670c252011-01-20 06:39:06 +00001119
Francis Visoiu Mistrih18346822018-04-19 17:02:57 +00001120 // Don't print raw contents of a virtual section. A virtual section
1121 // doesn't have any contents in the file.
1122 if (Section.isVirtual()) {
1123 outs() << "...\n";
1124 continue;
1125 }
1126
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001127#ifndef NDEBUG
Mark Seaborneb03ac52014-01-25 00:32:01 +00001128 raw_ostream &DebugOut = DebugFlag ? dbgs() : nulls();
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001129#else
Mark Seaborneb03ac52014-01-25 00:32:01 +00001130 raw_ostream &DebugOut = nulls();
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001131#endif
1132
Wouter van Oortmerssenf3b762a2019-01-17 18:14:09 +00001133 // Some targets (like WebAssembly) have a special prelude at the start
1134 // of each symbol.
1135 DisAsm->onSymbolStart(SymbolName, Size, Bytes.slice(Start, End - Start),
1136 SectionAddr + Start, DebugOut, CommentStream);
1137 Start += Size;
1138
Benjamin Kramer43a772e2011-09-19 17:56:04 +00001139 for (Index = Start; Index < End; Index += Size) {
1140 MCInst Inst;
Owen Andersona0c3b972011-09-15 23:38:46 +00001141
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001142 if (Index + SectionAddr < StartAddress ||
1143 Index + SectionAddr > StopAddress) {
1144 // skip byte by byte till StartAddress is reached
1145 Size = 1;
1146 continue;
1147 }
Davide Italianof0706882015-10-01 21:57:09 +00001148 // AArch64 ELF binaries can interleave data and text in the
1149 // same section. We rely on the markers introduced to
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001150 // understand what we need to dump. If the data marker is within a
1151 // function, it is denoted as a word/short etc
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001152 if (isArmElf(Obj) && std::get<2>(Symbols[SI]) != ELF::STT_OBJECT &&
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001153 !DisassembleAll) {
Davide Italianof0706882015-10-01 21:57:09 +00001154 uint64_t Stride = 0;
1155
1156 auto DAI = std::lower_bound(DataMappingSymsAddr.begin(),
1157 DataMappingSymsAddr.end(), Index);
1158 if (DAI != DataMappingSymsAddr.end() && *DAI == Index) {
1159 // Switch to data.
1160 while (Index < End) {
1161 outs() << format("%8" PRIx64 ":", SectionAddr + Index);
1162 outs() << "\t";
1163 if (Index + 4 <= End) {
1164 Stride = 4;
1165 dumpBytes(Bytes.slice(Index, 4), outs());
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001166 outs() << "\t.word\t";
1167 uint32_t Data = 0;
1168 if (Obj->isLittleEndian()) {
1169 const auto Word =
1170 reinterpret_cast<const support::ulittle32_t *>(
1171 Bytes.data() + Index);
1172 Data = *Word;
1173 } else {
1174 const auto Word = reinterpret_cast<const support::ubig32_t *>(
1175 Bytes.data() + Index);
1176 Data = *Word;
1177 }
1178 outs() << "0x" << format("%08" PRIx32, Data);
Davide Italianof0706882015-10-01 21:57:09 +00001179 } else if (Index + 2 <= End) {
1180 Stride = 2;
1181 dumpBytes(Bytes.slice(Index, 2), outs());
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001182 outs() << "\t\t.short\t";
1183 uint16_t Data = 0;
1184 if (Obj->isLittleEndian()) {
1185 const auto Short =
1186 reinterpret_cast<const support::ulittle16_t *>(
1187 Bytes.data() + Index);
1188 Data = *Short;
1189 } else {
1190 const auto Short =
1191 reinterpret_cast<const support::ubig16_t *>(Bytes.data() +
1192 Index);
1193 Data = *Short;
1194 }
1195 outs() << "0x" << format("%04" PRIx16, Data);
Davide Italianof0706882015-10-01 21:57:09 +00001196 } else {
1197 Stride = 1;
1198 dumpBytes(Bytes.slice(Index, 1), outs());
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001199 outs() << "\t\t.byte\t";
1200 outs() << "0x" << format("%02" PRIx8, Bytes.slice(Index, 1)[0]);
Davide Italianof0706882015-10-01 21:57:09 +00001201 }
1202 Index += Stride;
1203 outs() << "\n";
1204 auto TAI = std::lower_bound(TextMappingSymsAddr.begin(),
1205 TextMappingSymsAddr.end(), Index);
1206 if (TAI != TextMappingSymsAddr.end() && *TAI == Index)
1207 break;
1208 }
1209 }
1210 }
1211
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001212 // If there is a data symbol inside an ELF text section and we are only
1213 // disassembling text (applicable all architectures),
1214 // we are in a situation where we must print the data and not
1215 // disassemble it.
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001216 if (Obj->isELF() && std::get<2>(Symbols[SI]) == ELF::STT_OBJECT &&
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001217 !DisassembleAll && Section.isText()) {
1218 // print out data up to 8 bytes at a time in hex and ascii
1219 uint8_t AsciiData[9] = {'\0'};
1220 uint8_t Byte;
1221 int NumBytes = 0;
1222
1223 for (Index = Start; Index < End; Index += 1) {
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001224 if (((SectionAddr + Index) < StartAddress) ||
1225 ((SectionAddr + Index) > StopAddress))
1226 continue;
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001227 if (NumBytes == 0) {
1228 outs() << format("%8" PRIx64 ":", SectionAddr + Index);
1229 outs() << "\t";
1230 }
1231 Byte = Bytes.slice(Index)[0];
1232 outs() << format(" %02x", Byte);
Michael Kruse6f1da6e2018-07-26 15:31:41 +00001233 AsciiData[NumBytes] = isPrint(Byte) ? Byte : '.';
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001234
1235 uint8_t IndentOffset = 0;
1236 NumBytes++;
1237 if (Index == End - 1 || NumBytes > 8) {
1238 // Indent the space for less than 8 bytes data.
1239 // 2 spaces for byte and one for space between bytes
1240 IndentOffset = 3 * (8 - NumBytes);
1241 for (int Excess = 8 - NumBytes; Excess < 8; Excess++)
1242 AsciiData[Excess] = '\0';
1243 NumBytes = 8;
1244 }
1245 if (NumBytes == 8) {
1246 AsciiData[8] = '\0';
1247 outs() << std::string(IndentOffset, ' ') << " ";
1248 outs() << reinterpret_cast<char *>(AsciiData);
1249 outs() << '\n';
1250 NumBytes = 0;
1251 }
1252 }
1253 }
Davide Italianof0706882015-10-01 21:57:09 +00001254 if (Index >= End)
1255 break;
1256
George Rimar70d197d2019-01-10 14:55:26 +00001257 if (size_t N =
1258 countSkippableZeroBytes(Bytes.slice(Index, End - Index))) {
1259 outs() << "\t\t..." << '\n';
1260 Index += N;
1261 if (Index >= End)
1262 break;
1263 }
1264
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001265 // Disassemble a real instruction or a data when disassemble all is
1266 // provided
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001267 bool Disassembled = DisAsm->getInstruction(Inst, Size, Bytes.slice(Index),
1268 SectionAddr + Index, DebugOut,
1269 CommentStream);
1270 if (Size == 0)
1271 Size = 1;
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +00001272
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001273 PIP.printInst(*IP, Disassembled ? &Inst : nullptr,
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +00001274 Bytes.slice(Index, Size), SectionAddr + Index, outs(), "",
Sid Manningd9f28732018-05-14 19:46:08 +00001275 *STI, &SP, &Rels);
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001276 outs() << CommentStream.str();
1277 Comments.clear();
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001278
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001279 // Try to resolve the target of a call, tail call, etc. to a specific
1280 // symbol.
1281 if (MIA && (MIA->isCall(Inst) || MIA->isUnconditionalBranch(Inst) ||
1282 MIA->isConditionalBranch(Inst))) {
1283 uint64_t Target;
1284 if (MIA->evaluateBranch(Inst, SectionAddr + Index, Size, Target)) {
1285 // In a relocatable object, the target's section must reside in
1286 // the same section as the call instruction or it is accessed
1287 // through a relocation.
1288 //
1289 // In a non-relocatable object, the target may be in any section.
1290 //
1291 // N.B. We don't walk the relocations in the relocatable case yet.
1292 auto *TargetSectionSymbols = &Symbols;
1293 if (!Obj->isRelocatableObject()) {
1294 auto SectionAddress = std::upper_bound(
1295 SectionAddresses.begin(), SectionAddresses.end(), Target,
1296 [](uint64_t LHS,
1297 const std::pair<uint64_t, SectionRef> &RHS) {
1298 return LHS < RHS.first;
1299 });
1300 if (SectionAddress != SectionAddresses.begin()) {
1301 --SectionAddress;
1302 TargetSectionSymbols = &AllSymbols[SectionAddress->second];
1303 } else {
Sterling Augustinebc78b622018-06-28 18:57:13 +00001304 TargetSectionSymbols = &AbsoluteSymbols;
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001305 }
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001306 }
David Majnemer2603a8fa2015-07-09 18:11:40 +00001307
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001308 // Find the first symbol in the section whose offset is less than
Sterling Augustinebc78b622018-06-28 18:57:13 +00001309 // or equal to the target. If there isn't a section that contains
1310 // the target, find the nearest preceding absolute symbol.
1311 auto TargetSym = std::upper_bound(
1312 TargetSectionSymbols->begin(), TargetSectionSymbols->end(),
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001313 Target, [](uint64_t LHS,
1314 const std::tuple<uint64_t, StringRef, uint8_t> &RHS) {
1315 return LHS < std::get<0>(RHS);
Sterling Augustinebc78b622018-06-28 18:57:13 +00001316 });
1317 if (TargetSym == TargetSectionSymbols->begin()) {
1318 TargetSectionSymbols = &AbsoluteSymbols;
1319 TargetSym = std::upper_bound(
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001320 AbsoluteSymbols.begin(), AbsoluteSymbols.end(),
1321 Target, [](uint64_t LHS,
1322 const std::tuple<uint64_t, StringRef, uint8_t> &RHS) {
1323 return LHS < std::get<0>(RHS);
1324 });
Sterling Augustinebc78b622018-06-28 18:57:13 +00001325 }
1326 if (TargetSym != TargetSectionSymbols->begin()) {
1327 --TargetSym;
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001328 uint64_t TargetAddress = std::get<0>(*TargetSym);
1329 StringRef TargetName = std::get<1>(*TargetSym);
1330 outs() << " <" << TargetName;
1331 uint64_t Disp = Target - TargetAddress;
Sterling Augustinebc78b622018-06-28 18:57:13 +00001332 if (Disp)
1333 outs() << "+0x" << Twine::utohexstr(Disp);
1334 outs() << '>';
David Majnemer81afca62015-07-07 22:06:59 +00001335 }
1336 }
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001337 }
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001338 outs() << "\n";
Michael J. Spencer51862b32011-10-13 22:17:18 +00001339
Sid Manningd9f28732018-05-14 19:46:08 +00001340 // Hexagon does this in pretty printer
1341 if (Obj->getArch() != Triple::hexagon)
1342 // Print relocation for instruction.
George Rimar73a27232019-01-15 09:19:18 +00001343 while (RelCur != RelEnd) {
1344 uint64_t Addr = RelCur->getOffset();
1345 SmallString<16> Name;
1346 SmallString<32> Val;
Owen Andersonfa3e5202011-10-25 20:35:53 +00001347
Sid Manningd9f28732018-05-14 19:46:08 +00001348 // If this relocation is hidden, skip it.
George Rimar73a27232019-01-15 09:19:18 +00001349 if (getHidden(*RelCur) || ((SectionAddr + Addr) < StartAddress)) {
1350 ++RelCur;
Sid Manningd9f28732018-05-14 19:46:08 +00001351 continue;
1352 }
1353
1354 // Stop when rel_cur's address is past the current instruction.
George Rimar73a27232019-01-15 09:19:18 +00001355 if (Addr >= Index + Size)
1356 break;
1357 RelCur->getTypeName(Name);
1358 error(getRelocationValueString(*RelCur, Val));
1359 outs() << format(Fmt.data(), SectionAddr + Addr) << Name << "\t"
1360 << Val << "\n";
1361 ++RelCur;
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001362 }
Benjamin Kramer87ee76c2011-07-20 19:37:35 +00001363 }
Michael J. Spencer2670c252011-01-20 06:39:06 +00001364 }
1365 }
1366}
1367
George Rimarbcbe98b2019-01-23 10:33:26 +00001368static void disassembleObject(const ObjectFile *Obj, bool InlineRelocs) {
1369 if (StartAddress > StopAddress)
1370 error("Start address should be less than stop address");
1371
1372 const Target *TheTarget = getTarget(Obj);
1373
1374 // Package up features to be passed to target/subtarget
1375 SubtargetFeatures Features = Obj->getFeatures();
1376 if (!MAttrs.empty())
1377 for (unsigned I = 0; I != MAttrs.size(); ++I)
1378 Features.AddFeature(MAttrs[I]);
1379
1380 std::unique_ptr<const MCRegisterInfo> MRI(
1381 TheTarget->createMCRegInfo(TripleName));
1382 if (!MRI)
1383 report_error(Obj->getFileName(),
1384 "no register info for target " + TripleName);
1385
1386 // Set up disassembler.
1387 std::unique_ptr<const MCAsmInfo> AsmInfo(
1388 TheTarget->createMCAsmInfo(*MRI, TripleName));
1389 if (!AsmInfo)
1390 report_error(Obj->getFileName(),
1391 "no assembly info for target " + TripleName);
1392 std::unique_ptr<const MCSubtargetInfo> STI(
1393 TheTarget->createMCSubtargetInfo(TripleName, MCPU, Features.getString()));
1394 if (!STI)
1395 report_error(Obj->getFileName(),
1396 "no subtarget info for target " + TripleName);
1397 std::unique_ptr<const MCInstrInfo> MII(TheTarget->createMCInstrInfo());
1398 if (!MII)
1399 report_error(Obj->getFileName(),
1400 "no instruction info for target " + TripleName);
1401 MCObjectFileInfo MOFI;
1402 MCContext Ctx(AsmInfo.get(), MRI.get(), &MOFI);
1403 // FIXME: for now initialize MCObjectFileInfo with default values
1404 MOFI.InitMCObjectFileInfo(Triple(TripleName), false, Ctx);
1405
1406 std::unique_ptr<MCDisassembler> DisAsm(
1407 TheTarget->createMCDisassembler(*STI, Ctx));
1408 if (!DisAsm)
1409 report_error(Obj->getFileName(),
1410 "no disassembler for target " + TripleName);
1411
1412 std::unique_ptr<const MCInstrAnalysis> MIA(
1413 TheTarget->createMCInstrAnalysis(MII.get()));
1414
1415 int AsmPrinterVariant = AsmInfo->getAssemblerDialect();
1416 std::unique_ptr<MCInstPrinter> IP(TheTarget->createMCInstPrinter(
1417 Triple(TripleName), AsmPrinterVariant, *AsmInfo, *MII, *MRI));
1418 if (!IP)
1419 report_error(Obj->getFileName(),
1420 "no instruction printer for target " + TripleName);
1421 IP->setPrintImmHex(PrintImmHex);
1422
1423 PrettyPrinter &PIP = selectPrettyPrinter(Triple(TripleName));
1424 SourcePrinter SP(Obj, TheTarget->getName());
1425
1426 disassembleObject(TheTarget, Obj, Ctx, DisAsm.get(), MIA.get(), IP.get(),
1427 STI.get(), PIP, SP, InlineRelocs);
1428}
1429
George Rimar73a27232019-01-15 09:19:18 +00001430void llvm::printRelocations(const ObjectFile *Obj) {
Greg Fitzgerald18432272014-03-20 22:55:15 +00001431 StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64 :
1432 "%08" PRIx64;
Rafael Espindola9219fe72016-03-21 20:59:15 +00001433 // Regular objdump doesn't print relocations in non-relocatable object
1434 // files.
1435 if (!Obj->isRelocatableObject())
1436 return;
Rafael Espindolac66d7612014-08-17 19:09:37 +00001437
Colin LeMahieu77804be2015-07-29 15:45:39 +00001438 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Alexey Samsonov48803e52014-03-13 14:37:36 +00001439 if (Section.relocation_begin() == Section.relocation_end())
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001440 continue;
George Rimar73a27232019-01-15 09:19:18 +00001441 StringRef SecName;
1442 error(Section.getName(SecName));
1443 outs() << "RELOCATION RECORDS FOR [" << SecName << "]:\n";
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00001444 for (const RelocationRef &Reloc : Section.relocations()) {
George Rimar73a27232019-01-15 09:19:18 +00001445 uint64_t Address = Reloc.getOffset();
1446 SmallString<32> RelocName;
1447 SmallString<32> ValueStr;
1448 if (Address < StartAddress || Address > StopAddress || getHidden(Reloc))
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00001449 continue;
George Rimar73a27232019-01-15 09:19:18 +00001450 Reloc.getTypeName(RelocName);
1451 error(getRelocationValueString(Reloc, ValueStr));
1452 outs() << format(Fmt.data(), Address) << " " << RelocName << " "
1453 << ValueStr << "\n";
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001454 }
1455 outs() << "\n";
1456 }
1457}
1458
George Rimar73a27232019-01-15 09:19:18 +00001459void llvm::printDynamicRelocations(const ObjectFile *Obj) {
Paul Semelcb0f0432018-06-07 13:30:55 +00001460 // For the moment, this option is for ELF only
1461 if (!Obj->isELF())
1462 return;
1463
1464 const auto *Elf = dyn_cast<ELFObjectFileBase>(Obj);
Paul Semelcb0f0432018-06-07 13:30:55 +00001465 if (!Elf || Elf->getEType() != ELF::ET_DYN) {
1466 error("not a dynamic object");
1467 return;
1468 }
1469
Paul Semelcb0f0432018-06-07 13:30:55 +00001470 std::vector<SectionRef> DynRelSec = Obj->dynamic_relocation_sections();
1471 if (DynRelSec.empty())
1472 return;
1473
1474 outs() << "DYNAMIC RELOCATION RECORDS\n";
George Rimar73a27232019-01-15 09:19:18 +00001475 StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64 : "%08" PRIx64;
Paul Semelcb0f0432018-06-07 13:30:55 +00001476 for (const SectionRef &Section : DynRelSec) {
1477 if (Section.relocation_begin() == Section.relocation_end())
1478 continue;
1479 for (const RelocationRef &Reloc : Section.relocations()) {
George Rimar73a27232019-01-15 09:19:18 +00001480 uint64_t Address = Reloc.getOffset();
1481 SmallString<32> RelocName;
1482 SmallString<32> ValueStr;
1483 Reloc.getTypeName(RelocName);
1484 error(getRelocationValueString(Reloc, ValueStr));
1485 outs() << format(Fmt.data(), Address) << " " << RelocName << " "
1486 << ValueStr << "\n";
Paul Semelcb0f0432018-06-07 13:30:55 +00001487 }
1488 }
1489}
1490
George Rimar73a27232019-01-15 09:19:18 +00001491void llvm::printSectionHeaders(const ObjectFile *Obj) {
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001492 outs() << "Sections:\n"
1493 "Idx Name Size Address Type\n";
Colin LeMahieu77804be2015-07-29 15:45:39 +00001494 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001495 StringRef Name;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001496 error(Section.getName(Name));
Rafael Espindola80291272014-10-08 15:28:58 +00001497 uint64_t Address = Section.getAddress();
1498 uint64_t Size = Section.getSize();
1499 bool Text = Section.isText();
1500 bool Data = Section.isData();
1501 bool BSS = Section.isBSS();
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001502 std::string Type = (std::string(Text ? "TEXT " : "") +
Michael J. Spencer8f67d472011-10-13 20:37:20 +00001503 (Data ? "DATA " : "") + (BSS ? "BSS" : ""));
George Rimare35e6442018-07-18 08:34:35 +00001504 outs() << format("%3d %-13s %08" PRIx64 " %016" PRIx64 " %s\n",
George Rimarc1090da2018-07-18 09:25:36 +00001505 (unsigned)Section.getIndex(), Name.str().c_str(), Size,
1506 Address, Type.c_str());
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001507 }
Xing GUO785edea2018-11-17 08:12:48 +00001508 outs() << "\n";
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001509}
1510
George Rimar73a27232019-01-15 09:19:18 +00001511void llvm::printSectionContents(const ObjectFile *Obj) {
Rafael Espindola4453e42942014-06-13 03:07:50 +00001512 std::error_code EC;
Colin LeMahieu77804be2015-07-29 15:45:39 +00001513 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001514 StringRef Name;
1515 StringRef Contents;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001516 error(Section.getName(Name));
Rafael Espindola80291272014-10-08 15:28:58 +00001517 uint64_t BaseAddr = Section.getAddress();
David Majnemer185b5b12014-11-11 09:58:25 +00001518 uint64_t Size = Section.getSize();
1519 if (!Size)
1520 continue;
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001521
1522 outs() << "Contents of section " << Name << ":\n";
David Majnemer185b5b12014-11-11 09:58:25 +00001523 if (Section.isBSS()) {
Alexey Samsonov209095c2013-04-16 10:53:11 +00001524 outs() << format("<skipping contents of bss section at [%04" PRIx64
David Majnemer8f6b04c2014-07-14 16:20:14 +00001525 ", %04" PRIx64 ")>\n",
1526 BaseAddr, BaseAddr + Size);
Alexey Samsonov209095c2013-04-16 10:53:11 +00001527 continue;
1528 }
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001529
Davide Italianoccd53fe2015-08-05 07:18:31 +00001530 error(Section.getContents(Contents));
David Majnemer8f6b04c2014-07-14 16:20:14 +00001531
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001532 // Dump out the content as hex and printable ascii characters.
George Rimar73a27232019-01-15 09:19:18 +00001533 for (std::size_t Addr = 0, End = Contents.size(); Addr < End; Addr += 16) {
1534 outs() << format(" %04" PRIx64 " ", BaseAddr + Addr);
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001535 // Dump line of hex.
George Rimar73a27232019-01-15 09:19:18 +00001536 for (std::size_t I = 0; I < 16; ++I) {
1537 if (I != 0 && I % 4 == 0)
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001538 outs() << ' ';
George Rimar73a27232019-01-15 09:19:18 +00001539 if (Addr + I < End)
1540 outs() << hexdigit((Contents[Addr + I] >> 4) & 0xF, true)
1541 << hexdigit(Contents[Addr + I] & 0xF, true);
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001542 else
1543 outs() << " ";
1544 }
1545 // Print ascii.
1546 outs() << " ";
George Rimar73a27232019-01-15 09:19:18 +00001547 for (std::size_t I = 0; I < 16 && Addr + I < End; ++I) {
1548 if (isPrint(static_cast<unsigned char>(Contents[Addr + I]) & 0xFF))
1549 outs() << Contents[Addr + I];
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001550 else
1551 outs() << ".";
1552 }
1553 outs() << "\n";
1554 }
1555 }
1556}
1557
George Rimar73a27232019-01-15 09:19:18 +00001558void llvm::printSymbolTable(const ObjectFile *O, StringRef ArchiveName,
Kevin Enderby9acb1092016-05-31 20:35:34 +00001559 StringRef ArchitectureName) {
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001560 outs() << "SYMBOL TABLE:\n";
1561
George Rimar73a27232019-01-15 09:19:18 +00001562 if (const COFFObjectFile *Coff = dyn_cast<const COFFObjectFile>(O)) {
1563 printCOFFSymbolTable(Coff);
Rui Ueyama4e39f712014-03-18 18:58:51 +00001564 return;
1565 }
George Rimar8e0a70b2019-01-10 16:24:10 +00001566
George Rimar73a27232019-01-15 09:19:18 +00001567 for (auto I = O->symbol_begin(), E = O->symbol_end(); I != E; ++I) {
George Rimar8e0a70b2019-01-10 16:24:10 +00001568 // Skip printing the special zero symbol when dumping an ELF file.
1569 // This makes the output consistent with the GNU objdump.
George Rimar73a27232019-01-15 09:19:18 +00001570 if (I == O->symbol_begin() && isa<ELFObjectFileBase>(O))
George Rimar8e0a70b2019-01-10 16:24:10 +00001571 continue;
1572
1573 const SymbolRef &Symbol = *I;
Kevin Enderby931cb652016-06-24 18:24:42 +00001574 Expected<uint64_t> AddressOrError = Symbol.getAddress();
1575 if (!AddressOrError)
George Rimar73a27232019-01-15 09:19:18 +00001576 report_error(ArchiveName, O->getFileName(), AddressOrError.takeError(),
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001577 ArchitectureName);
Rafael Espindolaed067c42015-07-03 18:19:00 +00001578 uint64_t Address = *AddressOrError;
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001579 if ((Address < StartAddress) || (Address > StopAddress))
1580 continue;
Kevin Enderby7bd8d992016-05-02 20:28:12 +00001581 Expected<SymbolRef::Type> TypeOrError = Symbol.getType();
1582 if (!TypeOrError)
George Rimar73a27232019-01-15 09:19:18 +00001583 report_error(ArchiveName, O->getFileName(), TypeOrError.takeError(),
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001584 ArchitectureName);
Kevin Enderby5afbc1c2016-03-23 20:27:00 +00001585 SymbolRef::Type Type = *TypeOrError;
Rui Ueyama4e39f712014-03-18 18:58:51 +00001586 uint32_t Flags = Symbol.getFlags();
Kevin Enderby7bd8d992016-05-02 20:28:12 +00001587 Expected<section_iterator> SectionOrErr = Symbol.getSection();
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001588 if (!SectionOrErr)
George Rimar73a27232019-01-15 09:19:18 +00001589 report_error(ArchiveName, O->getFileName(), SectionOrErr.takeError(),
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001590 ArchitectureName);
Rafael Espindola8bab8892015-08-07 23:27:14 +00001591 section_iterator Section = *SectionOrErr;
Rafael Espindola75d5b542015-06-03 05:14:22 +00001592 StringRef Name;
George Rimar73a27232019-01-15 09:19:18 +00001593 if (Type == SymbolRef::ST_Debug && Section != O->section_end()) {
Rafael Espindola75d5b542015-06-03 05:14:22 +00001594 Section->getName(Name);
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +00001595 } else {
Kevin Enderby81e8b7d2016-04-20 21:24:34 +00001596 Expected<StringRef> NameOrErr = Symbol.getName();
1597 if (!NameOrErr)
George Rimar73a27232019-01-15 09:19:18 +00001598 report_error(ArchiveName, O->getFileName(), NameOrErr.takeError(),
Kevin Enderby9acb1092016-05-31 20:35:34 +00001599 ArchitectureName);
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +00001600 Name = *NameOrErr;
Rafael Espindola75d5b542015-06-03 05:14:22 +00001601 }
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001602
Rui Ueyama4e39f712014-03-18 18:58:51 +00001603 bool Global = Flags & SymbolRef::SF_Global;
1604 bool Weak = Flags & SymbolRef::SF_Weak;
1605 bool Absolute = Flags & SymbolRef::SF_Absolute;
Colin LeMahieubc2f47a2015-01-23 20:06:24 +00001606 bool Common = Flags & SymbolRef::SF_Common;
Davide Italianocd2514d2015-04-30 23:08:53 +00001607 bool Hidden = Flags & SymbolRef::SF_Hidden;
David Meyer1df4b842012-02-28 23:47:53 +00001608
Rui Ueyama4e39f712014-03-18 18:58:51 +00001609 char GlobLoc = ' ';
1610 if (Type != SymbolRef::ST_Unknown)
1611 GlobLoc = Global ? 'g' : 'l';
1612 char Debug = (Type == SymbolRef::ST_Debug || Type == SymbolRef::ST_File)
1613 ? 'd' : ' ';
1614 char FileFunc = ' ';
1615 if (Type == SymbolRef::ST_File)
1616 FileFunc = 'f';
1617 else if (Type == SymbolRef::ST_Function)
1618 FileFunc = 'F';
Kristina Brooks0674f9d2018-11-11 17:47:13 +00001619 else if (Type == SymbolRef::ST_Data)
1620 FileFunc = 'O';
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001621
George Rimar73a27232019-01-15 09:19:18 +00001622 const char *Fmt = O->getBytesInAddress() > 4 ? "%016" PRIx64 :
Rui Ueyama4e39f712014-03-18 18:58:51 +00001623 "%08" PRIx64;
Michael J. Spencerd857c1c2013-01-10 22:40:50 +00001624
Rui Ueyama4e39f712014-03-18 18:58:51 +00001625 outs() << format(Fmt, Address) << " "
1626 << GlobLoc // Local -> 'l', Global -> 'g', Neither -> ' '
1627 << (Weak ? 'w' : ' ') // Weak?
1628 << ' ' // Constructor. Not supported yet.
1629 << ' ' // Warning. Not supported yet.
1630 << ' ' // Indirect reference to another symbol.
1631 << Debug // Debugging (d) or dynamic (D) symbol.
1632 << FileFunc // Name of function (F), file (f) or object (O).
1633 << ' ';
1634 if (Absolute) {
1635 outs() << "*ABS*";
Colin LeMahieubc2f47a2015-01-23 20:06:24 +00001636 } else if (Common) {
1637 outs() << "*COM*";
George Rimar73a27232019-01-15 09:19:18 +00001638 } else if (Section == O->section_end()) {
Rui Ueyama4e39f712014-03-18 18:58:51 +00001639 outs() << "*UND*";
1640 } else {
1641 if (const MachOObjectFile *MachO =
George Rimar73a27232019-01-15 09:19:18 +00001642 dyn_cast<const MachOObjectFile>(O)) {
Rui Ueyama4e39f712014-03-18 18:58:51 +00001643 DataRefImpl DR = Section->getRawDataRefImpl();
1644 StringRef SegmentName = MachO->getSectionFinalSegmentName(DR);
1645 outs() << SegmentName << ",";
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001646 }
Rui Ueyama4e39f712014-03-18 18:58:51 +00001647 StringRef SectionName;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001648 error(Section->getName(SectionName));
Rui Ueyama4e39f712014-03-18 18:58:51 +00001649 outs() << SectionName;
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001650 }
Rafael Espindola5f7ade22015-06-23 15:45:38 +00001651
1652 outs() << '\t';
George Rimar73a27232019-01-15 09:19:18 +00001653 if (Common || isa<ELFObjectFileBase>(O)) {
Rafael Espindoladbb6bd32015-06-25 22:10:04 +00001654 uint64_t Val =
1655 Common ? Symbol.getAlignment() : ELFSymbolRef(Symbol).getSize();
Rafael Espindolaae3ac082015-06-23 18:34:25 +00001656 outs() << format("\t %08" PRIx64 " ", Val);
1657 }
Rafael Espindola5f7ade22015-06-23 15:45:38 +00001658
George Rimar73a27232019-01-15 09:19:18 +00001659 if (Hidden)
Davide Italianocd2514d2015-04-30 23:08:53 +00001660 outs() << ".hidden ";
George Rimar6622d412018-12-19 10:21:45 +00001661
1662 if (Demangle)
1663 outs() << demangle(Name) << '\n';
1664 else
1665 outs() << Name << '\n';
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001666 }
1667}
1668
George Rimar73a27232019-01-15 09:19:18 +00001669static void printUnwindInfo(const ObjectFile *O) {
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001670 outs() << "Unwind info:\n\n";
1671
George Rimar73a27232019-01-15 09:19:18 +00001672 if (const COFFObjectFile *Coff = dyn_cast<COFFObjectFile>(O))
1673 printCOFFUnwindInfo(Coff);
1674 else if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(O))
Tim Northover4bd286a2014-08-01 13:07:19 +00001675 printMachOUnwindInfo(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001676 else
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001677 // TODO: Extract DWARF dump tool to objdump.
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001678 WithColor::error(errs(), ToolName)
1679 << "This operation is only currently supported "
1680 "for COFF and MachO object files.\n";
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001681}
1682
Kevin Enderbye2297dd2015-01-07 21:02:18 +00001683void llvm::printExportsTrie(const ObjectFile *o) {
Nick Kledzikd04bc352014-08-30 00:20:14 +00001684 outs() << "Exports trie:\n";
1685 if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
1686 printMachOExportsTrie(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001687 else
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001688 WithColor::error(errs(), ToolName)
1689 << "This operation is only currently supported "
1690 "for Mach-O executable files.\n";
Nick Kledzikd04bc352014-08-30 00:20:14 +00001691}
1692
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001693void llvm::printRebaseTable(ObjectFile *o) {
Nick Kledzikac431442014-09-12 21:34:15 +00001694 outs() << "Rebase table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001695 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzikac431442014-09-12 21:34:15 +00001696 printMachORebaseTable(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001697 else
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001698 WithColor::error(errs(), ToolName)
1699 << "This operation is only currently supported "
1700 "for Mach-O executable files.\n";
Nick Kledzikac431442014-09-12 21:34:15 +00001701}
1702
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001703void llvm::printBindTable(ObjectFile *o) {
Nick Kledzik56ebef42014-09-16 01:41:51 +00001704 outs() << "Bind table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001705 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzik56ebef42014-09-16 01:41:51 +00001706 printMachOBindTable(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001707 else
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001708 WithColor::error(errs(), ToolName)
1709 << "This operation is only currently supported "
1710 "for Mach-O executable files.\n";
Nick Kledzik56ebef42014-09-16 01:41:51 +00001711}
1712
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001713void llvm::printLazyBindTable(ObjectFile *o) {
Nick Kledzik56ebef42014-09-16 01:41:51 +00001714 outs() << "Lazy bind table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001715 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzik56ebef42014-09-16 01:41:51 +00001716 printMachOLazyBindTable(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001717 else
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001718 WithColor::error(errs(), ToolName)
1719 << "This operation is only currently supported "
1720 "for Mach-O executable files.\n";
Nick Kledzik56ebef42014-09-16 01:41:51 +00001721}
1722
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001723void llvm::printWeakBindTable(ObjectFile *o) {
Nick Kledzik56ebef42014-09-16 01:41:51 +00001724 outs() << "Weak bind table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001725 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzik56ebef42014-09-16 01:41:51 +00001726 printMachOWeakBindTable(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001727 else
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001728 WithColor::error(errs(), ToolName)
1729 << "This operation is only currently supported "
1730 "for Mach-O executable files.\n";
Nick Kledzik56ebef42014-09-16 01:41:51 +00001731}
Nick Kledzikac431442014-09-12 21:34:15 +00001732
Adrian Prantl437105a2015-07-08 02:04:15 +00001733/// Dump the raw contents of the __clangast section so the output can be piped
1734/// into llvm-bcanalyzer.
1735void llvm::printRawClangAST(const ObjectFile *Obj) {
1736 if (outs().is_displayed()) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001737 WithColor::error(errs(), ToolName)
1738 << "The -raw-clang-ast option will dump the raw binary contents of "
1739 "the clang ast section.\n"
1740 "Please redirect the output to a file or another program such as "
1741 "llvm-bcanalyzer.\n";
Adrian Prantl437105a2015-07-08 02:04:15 +00001742 return;
1743 }
1744
1745 StringRef ClangASTSectionName("__clangast");
1746 if (isa<COFFObjectFile>(Obj)) {
1747 ClangASTSectionName = "clangast";
1748 }
1749
1750 Optional<object::SectionRef> ClangASTSection;
Colin LeMahieu77804be2015-07-29 15:45:39 +00001751 for (auto Sec : ToolSectionFilter(*Obj)) {
Adrian Prantl437105a2015-07-08 02:04:15 +00001752 StringRef Name;
1753 Sec.getName(Name);
1754 if (Name == ClangASTSectionName) {
1755 ClangASTSection = Sec;
1756 break;
1757 }
1758 }
1759 if (!ClangASTSection)
1760 return;
1761
1762 StringRef ClangASTContents;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001763 error(ClangASTSection.getValue().getContents(ClangASTContents));
Adrian Prantl437105a2015-07-08 02:04:15 +00001764 outs().write(ClangASTContents.data(), ClangASTContents.size());
1765}
1766
Sanjoy Das6f567a42015-06-22 18:03:02 +00001767static void printFaultMaps(const ObjectFile *Obj) {
George Rimar73a27232019-01-15 09:19:18 +00001768 StringRef FaultMapSectionName;
Sanjoy Das6f567a42015-06-22 18:03:02 +00001769
1770 if (isa<ELFObjectFileBase>(Obj)) {
1771 FaultMapSectionName = ".llvm_faultmaps";
1772 } else if (isa<MachOObjectFile>(Obj)) {
1773 FaultMapSectionName = "__llvm_faultmaps";
1774 } else {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001775 WithColor::error(errs(), ToolName)
1776 << "This operation is only currently supported "
1777 "for ELF and Mach-O executable files.\n";
Sanjoy Das6f567a42015-06-22 18:03:02 +00001778 return;
1779 }
1780
1781 Optional<object::SectionRef> FaultMapSection;
1782
Colin LeMahieu77804be2015-07-29 15:45:39 +00001783 for (auto Sec : ToolSectionFilter(*Obj)) {
Sanjoy Das6f567a42015-06-22 18:03:02 +00001784 StringRef Name;
1785 Sec.getName(Name);
1786 if (Name == FaultMapSectionName) {
1787 FaultMapSection = Sec;
1788 break;
1789 }
1790 }
1791
1792 outs() << "FaultMap table:\n";
1793
1794 if (!FaultMapSection.hasValue()) {
1795 outs() << "<not found>\n";
1796 return;
1797 }
1798
1799 StringRef FaultMapContents;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001800 error(FaultMapSection.getValue().getContents(FaultMapContents));
Sanjoy Das6f567a42015-06-22 18:03:02 +00001801
1802 FaultMapParser FMP(FaultMapContents.bytes_begin(),
1803 FaultMapContents.bytes_end());
1804
1805 outs() << FMP;
1806}
1807
George Rimar73a27232019-01-15 09:19:18 +00001808static void printPrivateFileHeaders(const ObjectFile *O, bool OnlyFirst) {
1809 if (O->isELF()) {
1810 printELFFileHeader(O);
1811 return printELFDynamicSection(O);
Paul Semel0913dcd2018-07-25 11:09:20 +00001812 }
George Rimar73a27232019-01-15 09:19:18 +00001813 if (O->isCOFF())
1814 return printCOFFFileHeader(O);
1815 if (O->isWasm())
1816 return printWasmFileHeader(O);
1817 if (O->isMachO()) {
1818 printMachOFileHeader(O);
1819 if (!OnlyFirst)
1820 printMachOLoadCommands(O);
Davide Italiano1bdaa202016-09-18 04:39:15 +00001821 return;
1822 }
George Rimar73a27232019-01-15 09:19:18 +00001823 report_error(O->getFileName(), "Invalid/Unsupported object file format");
Rui Ueyamac2bed422013-09-27 21:04:00 +00001824}
1825
George Rimar73a27232019-01-15 09:19:18 +00001826static void printFileHeaders(const ObjectFile *O) {
1827 if (!O->isELF() && !O->isCOFF())
1828 report_error(O->getFileName(), "Invalid/Unsupported object file format");
Paul Semeld2af4d62018-07-04 15:25:03 +00001829
George Rimar73a27232019-01-15 09:19:18 +00001830 Triple::ArchType AT = O->getArch();
Paul Semeld2af4d62018-07-04 15:25:03 +00001831 outs() << "architecture: " << Triple::getArchTypeName(AT) << "\n";
George Rimar73a27232019-01-15 09:19:18 +00001832 Expected<uint64_t> StartAddrOrErr = O->getStartAddress();
Paul Semeld2af4d62018-07-04 15:25:03 +00001833 if (!StartAddrOrErr)
George Rimar73a27232019-01-15 09:19:18 +00001834 report_error(O->getFileName(), StartAddrOrErr.takeError());
Petar Jovanovic8d947ba2018-10-19 22:16:49 +00001835
George Rimar73a27232019-01-15 09:19:18 +00001836 StringRef Fmt = O->getBytesInAddress() > 4 ? "%016" PRIx64 : "%08" PRIx64;
Petar Jovanovic8d947ba2018-10-19 22:16:49 +00001837 uint64_t Address = StartAddrOrErr.get();
Paul Semeld2af4d62018-07-04 15:25:03 +00001838 outs() << "start address: "
George Rimar9b6fe7e2019-01-12 12:17:24 +00001839 << "0x" << format(Fmt.data(), Address) << "\n\n";
Paul Semeld2af4d62018-07-04 15:25:03 +00001840}
1841
Paul Semel0dc92f62018-07-05 14:43:29 +00001842static void printArchiveChild(StringRef Filename, const Archive::Child &C) {
1843 Expected<sys::fs::perms> ModeOrErr = C.getAccessMode();
1844 if (!ModeOrErr) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001845 WithColor::error(errs(), ToolName) << "ill-formed archive entry.\n";
Paul Semel0dc92f62018-07-05 14:43:29 +00001846 consumeError(ModeOrErr.takeError());
1847 return;
1848 }
1849 sys::fs::perms Mode = ModeOrErr.get();
1850 outs() << ((Mode & sys::fs::owner_read) ? "r" : "-");
1851 outs() << ((Mode & sys::fs::owner_write) ? "w" : "-");
1852 outs() << ((Mode & sys::fs::owner_exe) ? "x" : "-");
1853 outs() << ((Mode & sys::fs::group_read) ? "r" : "-");
1854 outs() << ((Mode & sys::fs::group_write) ? "w" : "-");
1855 outs() << ((Mode & sys::fs::group_exe) ? "x" : "-");
1856 outs() << ((Mode & sys::fs::others_read) ? "r" : "-");
1857 outs() << ((Mode & sys::fs::others_write) ? "w" : "-");
1858 outs() << ((Mode & sys::fs::others_exe) ? "x" : "-");
1859
1860 outs() << " ";
1861
1862 Expected<unsigned> UIDOrErr = C.getUID();
1863 if (!UIDOrErr)
1864 report_error(Filename, UIDOrErr.takeError());
1865 unsigned UID = UIDOrErr.get();
1866 outs() << format("%d/", UID);
1867
1868 Expected<unsigned> GIDOrErr = C.getGID();
1869 if (!GIDOrErr)
1870 report_error(Filename, GIDOrErr.takeError());
1871 unsigned GID = GIDOrErr.get();
1872 outs() << format("%-d ", GID);
1873
1874 Expected<uint64_t> Size = C.getRawSize();
1875 if (!Size)
1876 report_error(Filename, Size.takeError());
1877 outs() << format("%6" PRId64, Size.get()) << " ";
1878
1879 StringRef RawLastModified = C.getRawLastModified();
1880 unsigned Seconds;
1881 if (RawLastModified.getAsInteger(10, Seconds))
1882 outs() << "(date: \"" << RawLastModified
1883 << "\" contains non-decimal chars) ";
1884 else {
1885 // Since ctime(3) returns a 26 character string of the form:
1886 // "Sun Sep 16 01:03:52 1973\n\0"
1887 // just print 24 characters.
1888 time_t t = Seconds;
1889 outs() << format("%.24s ", ctime(&t));
1890 }
1891
1892 StringRef Name = "";
1893 Expected<StringRef> NameOrErr = C.getName();
1894 if (!NameOrErr) {
1895 consumeError(NameOrErr.takeError());
1896 Expected<StringRef> RawNameOrErr = C.getRawName();
1897 if (!RawNameOrErr)
1898 report_error(Filename, NameOrErr.takeError());
1899 Name = RawNameOrErr.get();
1900 } else {
1901 Name = NameOrErr.get();
1902 }
1903 outs() << Name << "\n";
1904}
1905
George Rimar73a27232019-01-15 09:19:18 +00001906static void dumpObject(ObjectFile *O, const Archive *A = nullptr,
1907 const Archive::Child *C = nullptr) {
Adrian Prantl437105a2015-07-08 02:04:15 +00001908 // Avoid other output when using a raw option.
1909 if (!RawClangAST) {
1910 outs() << '\n';
George Rimar73a27232019-01-15 09:19:18 +00001911 if (A)
1912 outs() << A->getFileName() << "(" << O->getFileName() << ")";
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001913 else
George Rimar73a27232019-01-15 09:19:18 +00001914 outs() << O->getFileName();
1915 outs() << ":\tfile format " << O->getFileFormatName() << "\n\n";
Adrian Prantl437105a2015-07-08 02:04:15 +00001916 }
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001917
George Rimar73a27232019-01-15 09:19:18 +00001918 StringRef ArchiveName = A ? A->getFileName() : "";
George Rimar9b6fe7e2019-01-12 12:17:24 +00001919 if (FileHeaders)
George Rimar73a27232019-01-15 09:19:18 +00001920 printFileHeaders(O);
1921 if (ArchiveHeaders && !MachOOpt && C)
1922 printArchiveChild(ArchiveName, *C);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001923 if (Disassemble)
George Rimar73a27232019-01-15 09:19:18 +00001924 disassembleObject(O, Relocations);
Michael J. Spencer51862b32011-10-13 22:17:18 +00001925 if (Relocations && !Disassemble)
George Rimar73a27232019-01-15 09:19:18 +00001926 printRelocations(O);
Paul Semelcb0f0432018-06-07 13:30:55 +00001927 if (DynamicRelocations)
George Rimar73a27232019-01-15 09:19:18 +00001928 printDynamicRelocations(O);
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001929 if (SectionHeaders)
George Rimar73a27232019-01-15 09:19:18 +00001930 printSectionHeaders(O);
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001931 if (SectionContents)
George Rimar73a27232019-01-15 09:19:18 +00001932 printSectionContents(O);
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001933 if (SymbolTable)
George Rimar73a27232019-01-15 09:19:18 +00001934 printSymbolTable(O, ArchiveName);
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001935 if (UnwindInfo)
George Rimar73a27232019-01-15 09:19:18 +00001936 printUnwindInfo(O);
Davide Italiano1bdaa202016-09-18 04:39:15 +00001937 if (PrivateHeaders || FirstPrivateHeader)
George Rimar73a27232019-01-15 09:19:18 +00001938 printPrivateFileHeaders(O, FirstPrivateHeader);
Nick Kledzikd04bc352014-08-30 00:20:14 +00001939 if (ExportsTrie)
George Rimar73a27232019-01-15 09:19:18 +00001940 printExportsTrie(O);
Nick Kledzikac431442014-09-12 21:34:15 +00001941 if (Rebase)
George Rimar73a27232019-01-15 09:19:18 +00001942 printRebaseTable(O);
Nick Kledzik56ebef42014-09-16 01:41:51 +00001943 if (Bind)
George Rimar73a27232019-01-15 09:19:18 +00001944 printBindTable(O);
Nick Kledzik56ebef42014-09-16 01:41:51 +00001945 if (LazyBind)
George Rimar73a27232019-01-15 09:19:18 +00001946 printLazyBindTable(O);
Nick Kledzik56ebef42014-09-16 01:41:51 +00001947 if (WeakBind)
George Rimar73a27232019-01-15 09:19:18 +00001948 printWeakBindTable(O);
Adrian Prantl437105a2015-07-08 02:04:15 +00001949 if (RawClangAST)
George Rimar73a27232019-01-15 09:19:18 +00001950 printRawClangAST(O);
Sanjoy Das6f567a42015-06-22 18:03:02 +00001951 if (PrintFaultMaps)
George Rimar73a27232019-01-15 09:19:18 +00001952 printFaultMaps(O);
Igor Laevsky03a670c2016-01-26 15:09:42 +00001953 if (DwarfDumpType != DIDT_Null) {
George Rimar73a27232019-01-15 09:19:18 +00001954 std::unique_ptr<DIContext> DICtx = DWARFContext::create(*O);
Igor Laevsky03a670c2016-01-26 15:09:42 +00001955 // Dump the complete DWARF structure.
Adrian Prantlf4bc1f72017-06-01 18:18:23 +00001956 DIDumpOptions DumpOpts;
1957 DumpOpts.DumpType = DwarfDumpType;
Adrian Prantlf4bc1f72017-06-01 18:18:23 +00001958 DICtx->dump(outs(), DumpOpts);
Igor Laevsky03a670c2016-01-26 15:09:42 +00001959 }
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001960}
1961
George Rimar73a27232019-01-15 09:19:18 +00001962static void dumpObject(const COFFImportFile *I, const Archive *A,
Paul Semel0dc92f62018-07-05 14:43:29 +00001963 const Archive::Child *C = nullptr) {
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +00001964 StringRef ArchiveName = A ? A->getFileName() : "";
1965
1966 // Avoid other output when using a raw option.
1967 if (!RawClangAST)
1968 outs() << '\n'
1969 << ArchiveName << "(" << I->getFileName() << ")"
1970 << ":\tfile format COFF-import-file"
1971 << "\n\n";
1972
James Hendersonc1608c92018-10-29 14:17:08 +00001973 if (ArchiveHeaders && !MachOOpt && C)
1974 printArchiveChild(ArchiveName, *C);
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +00001975 if (SymbolTable)
1976 printCOFFSymbolTable(I);
1977}
1978
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +00001979/// Dump each object file in \a a;
George Rimar73a27232019-01-15 09:19:18 +00001980static void dumpArchive(const Archive *A) {
Mehdi Amini41af4302016-11-11 04:28:40 +00001981 Error Err = Error::success();
George Rimar73a27232019-01-15 09:19:18 +00001982 for (auto &C : A->children(Err)) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001983 Expected<std::unique_ptr<Binary>> ChildOrErr = C.getAsBinary();
1984 if (!ChildOrErr) {
1985 if (auto E = isNotObjectErrorInvalidFileType(ChildOrErr.takeError()))
George Rimar73a27232019-01-15 09:19:18 +00001986 report_error(A->getFileName(), C, std::move(E));
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001987 continue;
1988 }
George Rimar73a27232019-01-15 09:19:18 +00001989 if (ObjectFile *O = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
1990 dumpObject(O, A, &C);
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +00001991 else if (COFFImportFile *I = dyn_cast<COFFImportFile>(&*ChildOrErr.get()))
George Rimar73a27232019-01-15 09:19:18 +00001992 dumpObject(I, A, &C);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001993 else
George Rimar73a27232019-01-15 09:19:18 +00001994 report_error(A->getFileName(), object_error::invalid_file_type);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001995 }
Lang Hamesfc209622016-07-14 02:24:01 +00001996 if (Err)
George Rimar73a27232019-01-15 09:19:18 +00001997 report_error(A->getFileName(), std::move(Err));
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001998}
1999
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +00002000/// Open file and figure out how to dump it.
George Rimar73a27232019-01-15 09:19:18 +00002001static void dumpInput(StringRef file) {
Kevin Enderbye2297dd2015-01-07 21:02:18 +00002002 // If we are using the Mach-O specific object file parser, then let it parse
2003 // the file and process the command line options. So the -arch flags can
2004 // be used to select specific slices, etc.
2005 if (MachOOpt) {
George Rimar73a27232019-01-15 09:19:18 +00002006 parseInputMachO(file);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002007 return;
2008 }
2009
2010 // Attempt to open the binary.
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +00002011 Expected<OwningBinary<Binary>> BinaryOrErr = createBinary(file);
2012 if (!BinaryOrErr)
Kevin Enderbyb34e3a12016-05-05 17:43:35 +00002013 report_error(file, BinaryOrErr.takeError());
Rafael Espindola48af1c22014-08-19 18:44:46 +00002014 Binary &Binary = *BinaryOrErr.get().getBinary();
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002015
George Rimar73a27232019-01-15 09:19:18 +00002016 if (Archive *A = dyn_cast<Archive>(&Binary))
2017 dumpArchive(A);
2018 else if (ObjectFile *O = dyn_cast<ObjectFile>(&Binary))
2019 dumpObject(O);
Dave Lee3fb120f2018-08-03 00:06:38 +00002020 else if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(&Binary))
George Rimar73a27232019-01-15 09:19:18 +00002021 parseInputMachO(UB);
Jim Grosbachaf9aec02012-08-07 17:53:14 +00002022 else
Alexey Samsonov50d0fbd2015-06-04 18:34:11 +00002023 report_error(file, object_error::invalid_file_type);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002024}
2025
Michael J. Spencer2670c252011-01-20 06:39:06 +00002026int main(int argc, char **argv) {
Rui Ueyama197194b2018-04-13 18:26:06 +00002027 InitLLVM X(argc, argv);
Michael J. Spencer2670c252011-01-20 06:39:06 +00002028
2029 // Initialize targets and assembly printers/parsers.
2030 llvm::InitializeAllTargetInfos();
Evan Cheng8c886a42011-07-22 21:58:54 +00002031 llvm::InitializeAllTargetMCs();
Michael J. Spencer2670c252011-01-20 06:39:06 +00002032 llvm::InitializeAllDisassemblers();
2033
Pete Cooper28fb4fc2012-05-03 23:20:10 +00002034 // Register the target printer for --version.
2035 cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
2036
Michael J. Spencer2670c252011-01-20 06:39:06 +00002037 cl::ParseCommandLineOptions(argc, argv, "llvm object file dumper\n");
Michael J. Spencer2670c252011-01-20 06:39:06 +00002038
2039 ToolName = argv[0];
2040
2041 // Defaults to a.out if no filenames specified.
Jordan Rupprecht16a0de22018-12-20 00:57:06 +00002042 if (InputFilenames.empty())
Michael J. Spencer2670c252011-01-20 06:39:06 +00002043 InputFilenames.push_back("a.out");
2044
Fangrui Song8513cd42018-06-27 20:45:11 +00002045 if (AllHeaders)
George Rimar5e364332019-01-18 12:01:59 +00002046 ArchiveHeaders = FileHeaders = PrivateHeaders = Relocations =
2047 SectionHeaders = SymbolTable = true;
Fangrui Song8513cd42018-06-27 20:45:11 +00002048
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +00002049 if (DisassembleAll || PrintSource || PrintLines)
Colin LeMahieuf34933e2015-07-23 20:58:49 +00002050 Disassemble = true;
Paul Semel007dedb2018-07-18 16:39:21 +00002051
Michael J. Spencerbfa06782011-10-18 19:32:17 +00002052 if (!Disassemble
2053 && !Relocations
Paul Semelcb0f0432018-06-07 13:30:55 +00002054 && !DynamicRelocations
Michael J. Spencerbfa06782011-10-18 19:32:17 +00002055 && !SectionHeaders
2056 && !SectionContents
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00002057 && !SymbolTable
Michael J. Spencer209565db2013-01-06 03:56:49 +00002058 && !UnwindInfo
Nick Kledzikd04bc352014-08-30 00:20:14 +00002059 && !PrivateHeaders
Paul Semeld2af4d62018-07-04 15:25:03 +00002060 && !FileHeaders
Kevin Enderby0ae163f2016-01-13 00:25:36 +00002061 && !FirstPrivateHeader
Nick Kledzikac431442014-09-12 21:34:15 +00002062 && !ExportsTrie
Nick Kledzik56ebef42014-09-16 01:41:51 +00002063 && !Rebase
2064 && !Bind
2065 && !LazyBind
Kevin Enderby131d1772015-01-09 19:22:37 +00002066 && !WeakBind
Adrian Prantl437105a2015-07-08 02:04:15 +00002067 && !RawClangAST
Kevin Enderby13023a12015-01-15 23:19:11 +00002068 && !(UniversalHeaders && MachOOpt)
Paul Semel0dc92f62018-07-05 14:43:29 +00002069 && !ArchiveHeaders
Kevin Enderby69fe98d2015-01-23 18:52:17 +00002070 && !(IndirectSymbols && MachOOpt)
Kevin Enderby9a509442015-01-27 21:28:24 +00002071 && !(DataInCode && MachOOpt)
Kevin Enderbyf6d25852015-01-31 00:37:11 +00002072 && !(LinkOptHints && MachOOpt)
Kevin Enderbycd66be52015-03-11 22:06:32 +00002073 && !(InfoPlist && MachOOpt)
Kevin Enderbybc847fa2015-03-16 20:08:09 +00002074 && !(DylibsUsed && MachOOpt)
2075 && !(DylibId && MachOOpt)
Kevin Enderby0fc11822015-04-01 20:57:01 +00002076 && !(ObjcMetaData && MachOOpt)
Jordan Rupprecht16a0de22018-12-20 00:57:06 +00002077 && !(!FilterSections.empty() && MachOOpt)
Igor Laevsky03a670c2016-01-26 15:09:42 +00002078 && !PrintFaultMaps
2079 && DwarfDumpType == DIDT_Null) {
Michael J. Spencer2670c252011-01-20 06:39:06 +00002080 cl::PrintHelpMessage();
Dimitry Andrice4f5d012017-12-18 19:46:56 +00002081 return 2;
2082 }
2083
Rafael Aulerb0e4b912018-03-09 19:13:44 +00002084 DisasmFuncsSet.insert(DisassembleFunctions.begin(),
2085 DisassembleFunctions.end());
2086
George Rimar73a27232019-01-15 09:19:18 +00002087 llvm::for_each(InputFilenames, dumpInput);
Dimitry Andrice4f5d012017-12-18 19:46:56 +00002088
2089 return EXIT_SUCCESS;
2090}