blob: ceefe47404db380060c624285da731448665ac21 [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
George Rimar4c3b2972019-01-28 10:44:01 +000073cl::opt<unsigned long long> AdjustVMA(
74 "adjust-vma",
75 cl::desc("Increase the displayed address by the specified offset"),
76 cl::value_desc("offset"), cl::init(0));
77
Fangrui Song8513cd42018-06-27 20:45:11 +000078cl::opt<bool>
79 llvm::AllHeaders("all-headers",
80 cl::desc("Display all available header information"));
81static cl::alias AllHeadersShort("x", cl::desc("Alias for --all-headers"),
Matthew Voss0f436772019-02-19 19:46:08 +000082 cl::NotHidden, cl::Grouping,
83 cl::aliasopt(AllHeaders));
Fangrui Song8513cd42018-06-27 20:45:11 +000084
Benjamin Kramer43a772e2011-09-19 17:56:04 +000085static cl::list<std::string>
86InputFilenames(cl::Positional, cl::desc("<input object files>"),cl::ZeroOrMore);
Michael J. Spencer2670c252011-01-20 06:39:06 +000087
Kevin Enderbye2297dd2015-01-07 21:02:18 +000088cl::opt<bool>
89llvm::Disassemble("disassemble",
Benjamin Kramer43a772e2011-09-19 17:56:04 +000090 cl::desc("Display assembler mnemonics for the machine instructions"));
George Rimar845d3292019-01-18 10:41:26 +000091static cl::alias Disassembled("d", cl::desc("Alias for --disassemble"),
Matthew Voss0f436772019-02-19 19:46:08 +000092 cl::NotHidden, cl::Grouping,
93 cl::aliasopt(Disassemble));
Colin LeMahieu77804be2015-07-29 15:45:39 +000094
95cl::opt<bool>
96llvm::DisassembleAll("disassemble-all",
97 cl::desc("Display assembler mnemonics for the machine instructions"));
George Rimar845d3292019-01-18 10:41:26 +000098static cl::alias DisassembleAlld("D", cl::desc("Alias for --disassemble-all"),
Matthew Voss0f436772019-02-19 19:46:08 +000099 cl::NotHidden, cl::Grouping,
100 cl::aliasopt(DisassembleAll));
Michael J. Spencer2670c252011-01-20 06:39:06 +0000101
Zachary Turner030ad372018-08-20 22:18:21 +0000102cl::opt<bool> llvm::Demangle("demangle", cl::desc("Demangle symbols names"),
103 cl::init(false));
Paul Semel007dedb2018-07-18 16:39:21 +0000104
105static cl::alias DemangleShort("C", cl::desc("Alias for --demangle"),
Matthew Voss0f436772019-02-19 19:46:08 +0000106 cl::NotHidden, cl::Grouping,
107 cl::aliasopt(llvm::Demangle));
Paul Semel007dedb2018-07-18 16:39:21 +0000108
Rafael Aulerb0e4b912018-03-09 19:13:44 +0000109static cl::list<std::string>
Matthew Voss0f436772019-02-19 19:46:08 +0000110DisassembleFunctions("disassemble-functions",
Rafael Aulerb0e4b912018-03-09 19:13:44 +0000111 cl::CommaSeparated,
112 cl::desc("List of functions to disassemble"));
113static StringSet<> DisasmFuncsSet;
114
Kevin Enderby98da6132015-01-20 21:47:46 +0000115cl::opt<bool>
Kristina Brooks31579e92018-10-31 09:34:08 +0000116llvm::Relocations("reloc",
117 cl::desc("Display the relocation entries in the file"));
118static cl::alias RelocationsShort("r", cl::desc("Alias for --reloc"),
Matthew Voss0f436772019-02-19 19:46:08 +0000119 cl::NotHidden, cl::Grouping,
Kristina Brooks31579e92018-10-31 09:34:08 +0000120 cl::aliasopt(llvm::Relocations));
Michael J. Spencerba4a3622011-10-08 00:18:30 +0000121
Kevin Enderby98da6132015-01-20 21:47:46 +0000122cl::opt<bool>
Paul Semelcb0f0432018-06-07 13:30:55 +0000123llvm::DynamicRelocations("dynamic-reloc",
124 cl::desc("Display the dynamic relocation entries in the file"));
George Rimar845d3292019-01-18 10:41:26 +0000125static cl::alias DynamicRelocationsd("R", cl::desc("Alias for --dynamic-reloc"),
Matthew Voss0f436772019-02-19 19:46:08 +0000126 cl::NotHidden, cl::Grouping,
George Rimar845d3292019-01-18 10:41:26 +0000127 cl::aliasopt(DynamicRelocations));
Paul Semelcb0f0432018-06-07 13:30:55 +0000128
129cl::opt<bool>
James Hendersonb55b6582018-10-29 10:05:39 +0000130 llvm::SectionContents("full-contents",
131 cl::desc("Display the content of each section"));
132static cl::alias SectionContentsShort("s",
133 cl::desc("Alias for --full-contents"),
Matthew Voss0f436772019-02-19 19:46:08 +0000134 cl::NotHidden, cl::Grouping,
James Hendersonb55b6582018-10-29 10:05:39 +0000135 cl::aliasopt(SectionContents));
Michael J. Spencer4e25c022011-10-17 17:13:22 +0000136
Kristina Brooks3baa5f72018-10-31 05:45:01 +0000137cl::opt<bool> llvm::SymbolTable("syms", cl::desc("Display the symbol table"));
138static cl::alias SymbolTableShort("t", cl::desc("Alias for --syms"),
Matthew Voss0f436772019-02-19 19:46:08 +0000139 cl::NotHidden, cl::Grouping,
Kristina Brooks3baa5f72018-10-31 05:45:01 +0000140 cl::aliasopt(llvm::SymbolTable));
Michael J. Spencerbfa06782011-10-18 19:32:17 +0000141
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000142cl::opt<bool>
143llvm::ExportsTrie("exports-trie", cl::desc("Display mach-o exported symbols"));
Nick Kledzikd04bc352014-08-30 00:20:14 +0000144
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000145cl::opt<bool>
146llvm::Rebase("rebase", cl::desc("Display mach-o rebasing info"));
Nick Kledzikac431442014-09-12 21:34:15 +0000147
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000148cl::opt<bool>
149llvm::Bind("bind", cl::desc("Display mach-o binding info"));
Nick Kledzik56ebef42014-09-16 01:41:51 +0000150
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000151cl::opt<bool>
152llvm::LazyBind("lazy-bind", cl::desc("Display mach-o lazy binding info"));
Nick Kledzik56ebef42014-09-16 01:41:51 +0000153
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000154cl::opt<bool>
155llvm::WeakBind("weak-bind", cl::desc("Display mach-o weak binding info"));
Nick Kledzik56ebef42014-09-16 01:41:51 +0000156
Adrian Prantl437105a2015-07-08 02:04:15 +0000157cl::opt<bool>
158llvm::RawClangAST("raw-clang-ast",
159 cl::desc("Dump the raw binary contents of the clang AST section"));
160
Nick Kledzik56ebef42014-09-16 01:41:51 +0000161static cl::opt<bool>
Rafael Espindolaa9f810b2012-12-21 03:47:03 +0000162MachOOpt("macho", cl::desc("Use MachO specific object file parser"));
George Rimar845d3292019-01-18 10:41:26 +0000163static cl::alias MachOm("m", cl::desc("Alias for --macho"), cl::NotHidden,
Matthew Voss0f436772019-02-19 19:46:08 +0000164 cl::Grouping, cl::aliasopt(MachOOpt));
Benjamin Kramer87ee76c2011-07-20 19:37:35 +0000165
Benjamin Kramer43a772e2011-09-19 17:56:04 +0000166cl::opt<std::string>
167llvm::TripleName("triple", cl::desc("Target triple to disassemble for, "
168 "see -version for available targets"));
169
170cl::opt<std::string>
Kevin Enderbyc9595622014-08-06 23:24:41 +0000171llvm::MCPU("mcpu",
172 cl::desc("Target a specific cpu type (-mcpu=help for details)"),
173 cl::value_desc("cpu-name"),
174 cl::init(""));
175
176cl::opt<std::string>
Kevin Enderbyef3ad2f2014-12-04 23:56:27 +0000177llvm::ArchName("arch-name", cl::desc("Target arch to disassemble for, "
Michael J. Spencer2670c252011-01-20 06:39:06 +0000178 "see -version for available targets"));
179
Kevin Enderby98da6132015-01-20 21:47:46 +0000180cl::opt<bool>
181llvm::SectionHeaders("section-headers", cl::desc("Display summaries of the "
182 "headers for each section."));
George Rimar845d3292019-01-18 10:41:26 +0000183static cl::alias SectionHeadersShort("headers",
184 cl::desc("Alias for --section-headers"),
185 cl::NotHidden,
186 cl::aliasopt(SectionHeaders));
187static cl::alias SectionHeadersShorter("h",
188 cl::desc("Alias for --section-headers"),
Matthew Voss0f436772019-02-19 19:46:08 +0000189 cl::NotHidden, cl::Grouping,
George Rimar845d3292019-01-18 10:41:26 +0000190 cl::aliasopt(SectionHeaders));
Colin LeMahieufcc32762015-07-29 19:08:10 +0000191
George Rimar87fa2e62019-01-28 14:11:35 +0000192static cl::opt<bool>
193 ShowLMA("show-lma",
194 cl::desc("Display LMA column when dumping ELF section headers"));
195
Colin LeMahieu77804be2015-07-29 15:45:39 +0000196cl::list<std::string>
Colin LeMahieufcc32762015-07-29 19:08:10 +0000197llvm::FilterSections("section", cl::desc("Operate on the specified sections only. "
198 "With -macho dump segment,section"));
George Rimar845d3292019-01-18 10:41:26 +0000199cl::alias static FilterSectionsj("j", cl::desc("Alias for --section"),
Jordan Rupprechtae672b42019-03-21 18:45:44 +0000200 cl::NotHidden, cl::Grouping, cl::Prefix,
George Rimar845d3292019-01-18 10:41:26 +0000201 cl::aliasopt(llvm::FilterSections));
Nick Lewyckyfcf84622011-10-10 21:21:34 +0000202
Kevin Enderbyc9595622014-08-06 23:24:41 +0000203cl::list<std::string>
204llvm::MAttrs("mattr",
Jack Carter551efd72012-08-28 19:24:49 +0000205 cl::CommaSeparated,
206 cl::desc("Target specific attributes"),
207 cl::value_desc("a1,+a2,-a3,..."));
208
Kevin Enderbybf246f52014-09-24 23:08:22 +0000209cl::opt<bool>
210llvm::NoShowRawInsn("no-show-raw-insn", cl::desc("When disassembling "
211 "instructions, do not print "
212 "the instruction bytes."));
Saleem Abdulrasooldea14b22017-02-08 18:11:31 +0000213cl::opt<bool>
214llvm::NoLeadingAddr("no-leading-addr", cl::desc("Print no leading address"));
Eli Bendersky3a6808c2012-11-20 22:57:02 +0000215
Kevin Enderby98da6132015-01-20 21:47:46 +0000216cl::opt<bool>
217llvm::UnwindInfo("unwind-info", cl::desc("Display unwind information"));
Michael J. Spencer0c6ec482012-12-05 20:12:35 +0000218
George Rimar845d3292019-01-18 10:41:26 +0000219static cl::alias UnwindInfoShort("u", cl::desc("Alias for --unwind-info"),
Matthew Voss0f436772019-02-19 19:46:08 +0000220 cl::NotHidden, cl::Grouping,
221 cl::aliasopt(UnwindInfo));
Michael J. Spencer0c6ec482012-12-05 20:12:35 +0000222
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000223cl::opt<bool>
224llvm::PrivateHeaders("private-headers",
225 cl::desc("Display format specific file headers"));
Michael J. Spencer209565db2013-01-06 03:56:49 +0000226
Kevin Enderby0ae163f2016-01-13 00:25:36 +0000227cl::opt<bool>
228llvm::FirstPrivateHeader("private-header",
229 cl::desc("Display only the first format specific file "
230 "header"));
231
George Rimar845d3292019-01-18 10:41:26 +0000232static cl::alias PrivateHeadersShort("p",
233 cl::desc("Alias for --private-headers"),
Matthew Voss0f436772019-02-19 19:46:08 +0000234 cl::NotHidden, cl::Grouping,
George Rimar845d3292019-01-18 10:41:26 +0000235 cl::aliasopt(PrivateHeaders));
Michael J. Spencer209565db2013-01-06 03:56:49 +0000236
Paul Semeld2af4d62018-07-04 15:25:03 +0000237cl::opt<bool> llvm::FileHeaders(
238 "file-headers",
239 cl::desc("Display the contents of the overall file header"));
240
241static cl::alias FileHeadersShort("f", cl::desc("Alias for --file-headers"),
Matthew Voss0f436772019-02-19 19:46:08 +0000242 cl::NotHidden, cl::Grouping,
243 cl::aliasopt(FileHeaders));
Paul Semeld2af4d62018-07-04 15:25:03 +0000244
Colin LeMahieu14ec76e2015-06-07 21:07:17 +0000245cl::opt<bool>
Paul Semel0dc92f62018-07-05 14:43:29 +0000246 llvm::ArchiveHeaders("archive-headers",
247 cl::desc("Display archive header information"));
248
George Rimar845d3292019-01-18 10:41:26 +0000249cl::alias ArchiveHeadersShort("a", cl::desc("Alias for --archive-headers"),
Matthew Voss0f436772019-02-19 19:46:08 +0000250 cl::NotHidden, cl::Grouping,
251 cl::aliasopt(ArchiveHeaders));
Paul Semel0dc92f62018-07-05 14:43:29 +0000252
253cl::opt<bool>
Colin LeMahieu14ec76e2015-06-07 21:07:17 +0000254 llvm::PrintImmHex("print-imm-hex",
Colin LeMahieuefe37322016-04-08 18:15:37 +0000255 cl::desc("Use hex format for immediate values"));
Colin LeMahieu14ec76e2015-06-07 21:07:17 +0000256
Sanjoy Das6f567a42015-06-22 18:03:02 +0000257cl::opt<bool> PrintFaultMaps("fault-map-section",
258 cl::desc("Display contents of faultmap section"));
259
Igor Laevsky03a670c2016-01-26 15:09:42 +0000260cl::opt<DIDumpType> llvm::DwarfDumpType(
261 "dwarf", cl::init(DIDT_Null), cl::desc("Dump of dwarf debug sections:"),
Jonas Devliegherec0a758d2017-09-18 14:15:57 +0000262 cl::values(clEnumValN(DIDT_DebugFrame, "frames", ".debug_frame")));
Igor Laevsky03a670c2016-01-26 15:09:42 +0000263
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +0000264cl::opt<bool> PrintSource(
265 "source",
266 cl::desc(
Alex Denisova07169e2018-02-02 19:20:37 +0000267 "Display source inlined with disassembly. Implies disassemble object"));
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +0000268
George Rimar845d3292019-01-18 10:41:26 +0000269cl::alias PrintSourceShort("S", cl::desc("Alias for -source"), cl::NotHidden,
Matthew Voss0f436772019-02-19 19:46:08 +0000270 cl::Grouping, cl::aliasopt(PrintSource));
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +0000271
272cl::opt<bool> PrintLines("line-numbers",
273 cl::desc("Display source line numbers with "
274 "disassembly. Implies disassemble object"));
275
276cl::alias PrintLinesShort("l", cl::desc("Alias for -line-numbers"),
Matthew Voss0f436772019-02-19 19:46:08 +0000277 cl::NotHidden, cl::Grouping,
278 cl::aliasopt(PrintLines));
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +0000279
280cl::opt<unsigned long long>
281 StartAddress("start-address", cl::desc("Disassemble beginning at address"),
282 cl::value_desc("address"), cl::init(0));
283cl::opt<unsigned long long>
George Rimar70d197d2019-01-10 14:55:26 +0000284 StopAddress("stop-address",
George Rimar3687c3e92019-01-15 14:03:50 +0000285 cl::desc("Stop disassembly at address"),
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +0000286 cl::value_desc("address"), cl::init(UINT64_MAX));
George Rimar70d197d2019-01-10 14:55:26 +0000287
George Rimar3687c3e92019-01-15 14:03:50 +0000288cl::opt<bool> DisassembleZeroes(
289 "disassemble-zeroes",
290 cl::desc("Do not skip blocks of zeroes when disassembling"));
George Rimar70d197d2019-01-10 14:55:26 +0000291cl::alias DisassembleZeroesShort("z",
292 cl::desc("Alias for --disassemble-zeroes"),
Matthew Voss0f436772019-02-19 19:46:08 +0000293 cl::NotHidden, cl::Grouping,
George Rimar70d197d2019-01-10 14:55:26 +0000294 cl::aliasopt(DisassembleZeroes));
295
Igor Kudrin2d3faad2019-02-26 12:15:14 +0000296static cl::list<std::string>
297 DisassemblerOptions("disassembler-options",
298 cl::desc("Pass target specific disassembler options"),
299 cl::value_desc("options"), cl::CommaSeparated);
300static cl::alias
301 DisassemblerOptionsShort("M", cl::desc("Alias for --disassembler-options"),
Jordan Rupprechtae672b42019-03-21 18:45:44 +0000302 cl::NotHidden, cl::Grouping, cl::Prefix,
303 cl::CommaSeparated,
Igor Kudrin2d3faad2019-02-26 12:15:14 +0000304 cl::aliasopt(DisassemblerOptions));
305
Fangrui Song5f2b5cd2019-04-10 04:46:01 +0000306static cl::opt<bool>
307 Wide("wide", cl::desc("Ignored for compatibility with GNU objdump"));
308static cl::alias WideShort("w", cl::Grouping, cl::aliasopt(Wide));
309
Benjamin Kramer43a772e2011-09-19 17:56:04 +0000310static StringRef ToolName;
Michael J. Spencer2670c252011-01-20 06:39:06 +0000311
Clement Courbetd1a3bd42019-01-18 15:26:14 +0000312typedef std::vector<std::tuple<uint64_t, StringRef, uint8_t>> SectionSymbolsTy;
Clement Courbet2d7d4a32019-01-18 09:40:19 +0000313
George Rimarc1964882019-01-18 11:33:26 +0000314SectionFilter llvm::ToolSectionFilter(llvm::object::ObjectFile const &O) {
David Majnemer42531262016-08-12 03:55:06 +0000315 return SectionFilter(
316 [](llvm::object::SectionRef const &S) {
317 if (FilterSections.empty())
318 return true;
319 llvm::StringRef String;
320 std::error_code error = S.getName(String);
321 if (error)
322 return false;
323 return is_contained(FilterSections, String);
324 },
325 O);
Colin LeMahieu77804be2015-07-29 15:45:39 +0000326}
Colin LeMahieu77804be2015-07-29 15:45:39 +0000327
Davide Italianoccd53fe2015-08-05 07:18:31 +0000328void llvm::error(std::error_code EC) {
Mark Seaborneb03ac52014-01-25 00:32:01 +0000329 if (!EC)
Davide Italianoccd53fe2015-08-05 07:18:31 +0000330 return;
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000331 WithColor::error(errs(), ToolName)
332 << "reading file: " << EC.message() << ".\n";
Davide Italiano140af642015-12-25 18:16:45 +0000333 errs().flush();
Davide Italiano7f6c3012015-08-06 00:18:52 +0000334 exit(1);
Michael J. Spencer2670c252011-01-20 06:39:06 +0000335}
336
Fangrui Songf67de6c2019-04-08 16:24:08 +0000337void llvm::error(Error E) {
338 if (!E)
339 return;
340 WithColor::error(errs(), ToolName) << toString(std::move(E));
341 exit(1);
342}
343
Kevin Enderby42398052016-06-28 23:16:13 +0000344LLVM_ATTRIBUTE_NORETURN void llvm::error(Twine Message) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000345 WithColor::error(errs(), ToolName) << Message << ".\n";
Kevin Enderby42398052016-06-28 23:16:13 +0000346 errs().flush();
347 exit(1);
348}
349
Paul Semel007dedb2018-07-18 16:39:21 +0000350void llvm::warn(StringRef Message) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000351 WithColor::warning(errs(), ToolName) << Message << ".\n";
Paul Semel007dedb2018-07-18 16:39:21 +0000352 errs().flush();
353}
354
Davide Italianoed9d95b2015-12-29 13:41:02 +0000355LLVM_ATTRIBUTE_NORETURN void llvm::report_error(StringRef File,
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000356 Twine Message) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000357 WithColor::error(errs(), ToolName)
358 << "'" << File << "': " << Message << ".\n";
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000359 exit(1);
360}
361
Fangrui Songe7834bd2019-04-07 08:19:55 +0000362LLVM_ATTRIBUTE_NORETURN void llvm::report_error(Error E, StringRef File) {
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +0000363 assert(E);
364 std::string Buf;
365 raw_string_ostream OS(Buf);
Jonas Devlieghere45eb84f2018-11-11 01:46:03 +0000366 logAllUnhandledErrors(std::move(E), OS);
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +0000367 OS.flush();
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000368 WithColor::error(errs(), ToolName) << "'" << File << "': " << Buf;
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +0000369 exit(1);
370}
371
Fangrui Songe7834bd2019-04-07 08:19:55 +0000372LLVM_ATTRIBUTE_NORETURN void llvm::report_error(Error E, StringRef ArchiveName,
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000373 StringRef FileName,
Kevin Enderby9acb1092016-05-31 20:35:34 +0000374 StringRef ArchitectureName) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000375 assert(E);
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000376 WithColor::error(errs(), ToolName);
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000377 if (ArchiveName != "")
378 errs() << ArchiveName << "(" << FileName << ")";
379 else
Justin Bogner31d8b7d2016-10-26 22:37:52 +0000380 errs() << "'" << FileName << "'";
Kevin Enderby9acb1092016-05-31 20:35:34 +0000381 if (!ArchitectureName.empty())
382 errs() << " (for architecture " << ArchitectureName << ")";
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000383 std::string Buf;
384 raw_string_ostream OS(Buf);
Jonas Devlieghere45eb84f2018-11-11 01:46:03 +0000385 logAllUnhandledErrors(std::move(E), OS);
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000386 OS.flush();
Justin Bogner31d8b7d2016-10-26 22:37:52 +0000387 errs() << ": " << Buf;
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000388 exit(1);
389}
390
Fangrui Songe7834bd2019-04-07 08:19:55 +0000391LLVM_ATTRIBUTE_NORETURN void llvm::report_error(Error E, StringRef ArchiveName,
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000392 const object::Archive::Child &C,
Kevin Enderby9acb1092016-05-31 20:35:34 +0000393 StringRef ArchitectureName) {
Kevin Enderbyf4586032016-07-29 17:44:13 +0000394 Expected<StringRef> NameOrErr = C.getName();
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000395 // TODO: if we have a error getting the name then it would be nice to print
396 // the index of which archive member this is and or its offset in the
397 // archive instead of "???" as the name.
Kevin Enderbyf4586032016-07-29 17:44:13 +0000398 if (!NameOrErr) {
399 consumeError(NameOrErr.takeError());
Fangrui Songe7834bd2019-04-07 08:19:55 +0000400 llvm::report_error(std::move(E), ArchiveName, "???", ArchitectureName);
Kevin Enderbyf4586032016-07-29 17:44:13 +0000401 } else
Fangrui Songe7834bd2019-04-07 08:19:55 +0000402 llvm::report_error(std::move(E), ArchiveName, NameOrErr.get(),
Kevin Enderby9acb1092016-05-31 20:35:34 +0000403 ArchitectureName);
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000404}
405
Craig Toppere6cb63e2014-04-25 04:24:47 +0000406static const Target *getTarget(const ObjectFile *Obj = nullptr) {
Michael J. Spencer2670c252011-01-20 06:39:06 +0000407 // Figure out the target triple.
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000408 llvm::Triple TheTriple("unknown-unknown-unknown");
Michael J. Spencer05350e6d2011-01-20 07:22:04 +0000409 if (TripleName.empty()) {
George Rimar73a27232019-01-15 09:19:18 +0000410 if (Obj)
Vlad Tsyrklevichde620462017-09-19 02:22:48 +0000411 TheTriple = Obj->makeTriple();
Sam Parkerdf7c6ef2017-01-18 13:52:12 +0000412 } else {
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000413 TheTriple.setTriple(Triple::normalize(TripleName));
Vlad Tsyrklevichde620462017-09-19 02:22:48 +0000414
Sam Parkerdf7c6ef2017-01-18 13:52:12 +0000415 // Use the triple, but also try to combine with ARM build attributes.
416 if (Obj) {
417 auto Arch = Obj->getArch();
George Rimar73a27232019-01-15 09:19:18 +0000418 if (Arch == Triple::arm || Arch == Triple::armeb)
Sam Parkerdf7c6ef2017-01-18 13:52:12 +0000419 Obj->setARMSubArch(TheTriple);
Sam Parkerdf7c6ef2017-01-18 13:52:12 +0000420 }
421 }
Michael J. Spencer2670c252011-01-20 06:39:06 +0000422
423 // Get the target specific parser.
424 std::string Error;
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000425 const Target *TheTarget = TargetRegistry::lookupTarget(ArchName, TheTriple,
426 Error);
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000427 if (!TheTarget) {
428 if (Obj)
429 report_error(Obj->getFileName(), "can't find target: " + Error);
430 else
431 error("can't find target: " + Error);
432 }
Michael J. Spencer2670c252011-01-20 06:39:06 +0000433
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000434 // Update the triple name and return the found target.
435 TripleName = TheTriple.getTriple();
436 return TheTarget;
Michael J. Spencer2670c252011-01-20 06:39:06 +0000437}
438
George Rimar73a27232019-01-15 09:19:18 +0000439bool llvm::isRelocAddressLess(RelocationRef A, RelocationRef B) {
440 return A.getOffset() < B.getOffset();
Michael J. Spencer51862b32011-10-13 22:17:18 +0000441}
442
Fangrui Songf67de6c2019-04-08 16:24:08 +0000443static Error getRelocationValueString(const RelocationRef &Rel,
444 SmallVectorImpl<char> &Result) {
Rafael Espindola854038e2015-06-26 14:51:16 +0000445 const ObjectFile *Obj = Rel.getObject();
Rafael Espindola37070a52015-06-03 04:48:06 +0000446 if (auto *ELF = dyn_cast<ELFObjectFileBase>(Obj))
George Rimarc1964882019-01-18 11:33:26 +0000447 return getELFRelocationValueString(ELF, Rel, Result);
Rafael Espindola37070a52015-06-03 04:48:06 +0000448 if (auto *COFF = dyn_cast<COFFObjectFile>(Obj))
George Rimarc1964882019-01-18 11:33:26 +0000449 return getCOFFRelocationValueString(COFF, Rel, Result);
Sam Clegg4df5d762017-06-27 20:40:53 +0000450 if (auto *Wasm = dyn_cast<WasmObjectFile>(Obj))
George Rimarc1964882019-01-18 11:33:26 +0000451 return getWasmRelocationValueString(Wasm, Rel, Result);
Sam Clegg4df5d762017-06-27 20:40:53 +0000452 if (auto *MachO = dyn_cast<MachOObjectFile>(Obj))
George Rimarc1964882019-01-18 11:33:26 +0000453 return getMachORelocationValueString(MachO, Rel, Result);
Sam Clegg4df5d762017-06-27 20:40:53 +0000454 llvm_unreachable("unknown object file format");
Rafael Espindola37070a52015-06-03 04:48:06 +0000455}
456
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +0000457/// Indicates whether this relocation should hidden when listing
Rafael Espindola0ad71d92015-06-30 03:41:26 +0000458/// relocations, usually because it is the trailing part of a multipart
459/// relocation that will be printed as part of the leading relocation.
460static bool getHidden(RelocationRef RelRef) {
George Rimar73a27232019-01-15 09:19:18 +0000461 auto *MachO = dyn_cast<MachOObjectFile>(RelRef.getObject());
Rafael Espindola0ad71d92015-06-30 03:41:26 +0000462 if (!MachO)
463 return false;
464
465 unsigned Arch = MachO->getArch();
466 DataRefImpl Rel = RelRef.getRawDataRefImpl();
467 uint64_t Type = MachO->getRelocationType(Rel);
468
469 // On arches that use the generic relocations, GENERIC_RELOC_PAIR
470 // is always hidden.
George Rimar73a27232019-01-15 09:19:18 +0000471 if (Arch == Triple::x86 || Arch == Triple::arm || Arch == Triple::ppc)
472 return Type == MachO::GENERIC_RELOC_PAIR;
473
474 if (Arch == Triple::x86_64) {
Rafael Espindola0ad71d92015-06-30 03:41:26 +0000475 // On x86_64, X86_64_RELOC_UNSIGNED is hidden only when it follows
476 // an X86_64_RELOC_SUBTRACTOR.
477 if (Type == MachO::X86_64_RELOC_UNSIGNED && Rel.d.a > 0) {
478 DataRefImpl RelPrev = Rel;
479 RelPrev.d.a--;
480 uint64_t PrevType = MachO->getRelocationType(RelPrev);
481 if (PrevType == MachO::X86_64_RELOC_SUBTRACTOR)
482 return true;
483 }
484 }
485
486 return false;
487}
488
Sid Manningd9f28732018-05-14 19:46:08 +0000489namespace {
490class SourcePrinter {
491protected:
492 DILineInfo OldLineInfo;
493 const ObjectFile *Obj = nullptr;
494 std::unique_ptr<symbolize::LLVMSymbolizer> Symbolizer;
495 // File name to file contents of source
496 std::unordered_map<std::string, std::unique_ptr<MemoryBuffer>> SourceCache;
497 // Mark the line endings of the cached source
498 std::unordered_map<std::string, std::vector<StringRef>> LineCache;
499
500private:
501 bool cacheSource(const DILineInfo& LineInfoFile);
502
503public:
504 SourcePrinter() = default;
505 SourcePrinter(const ObjectFile *Obj, StringRef DefaultArch) : Obj(Obj) {
506 symbolize::LLVMSymbolizer::Options SymbolizerOpts(
507 DILineInfoSpecifier::FunctionNameKind::None, true, false, false,
508 DefaultArch);
509 Symbolizer.reset(new symbolize::LLVMSymbolizer(SymbolizerOpts));
510 }
511 virtual ~SourcePrinter() = default;
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000512 virtual void printSourceLine(raw_ostream &OS,
513 object::SectionedAddress Address,
Sid Manningd9f28732018-05-14 19:46:08 +0000514 StringRef Delimiter = "; ");
515};
516
517bool SourcePrinter::cacheSource(const DILineInfo &LineInfo) {
518 std::unique_ptr<MemoryBuffer> Buffer;
519 if (LineInfo.Source) {
520 Buffer = MemoryBuffer::getMemBuffer(*LineInfo.Source);
521 } else {
522 auto BufferOrError = MemoryBuffer::getFile(LineInfo.FileName);
523 if (!BufferOrError)
524 return false;
525 Buffer = std::move(*BufferOrError);
526 }
527 // Chomp the file to get lines
Fangrui Song47a76622019-04-07 10:16:46 +0000528 const char *BufferStart = Buffer->getBufferStart(),
529 *BufferEnd = Buffer->getBufferEnd();
530 std::vector<StringRef> &Lines = LineCache[LineInfo.FileName];
531 const char *Start = BufferStart;
532 for (const char *I = BufferStart; I != BufferEnd; ++I)
533 if (*I == '\n') {
534 Lines.emplace_back(Start, I - Start - (BufferStart < I && I[-1] == '\r'));
535 Start = I + 1;
Sid Manningd9f28732018-05-14 19:46:08 +0000536 }
Fangrui Song47a76622019-04-07 10:16:46 +0000537 if (Start < BufferEnd)
538 Lines.emplace_back(Start, BufferEnd - Start);
Sid Manningd9f28732018-05-14 19:46:08 +0000539 SourceCache[LineInfo.FileName] = std::move(Buffer);
540 return true;
541}
542
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000543void SourcePrinter::printSourceLine(raw_ostream &OS,
544 object::SectionedAddress Address,
Sid Manningd9f28732018-05-14 19:46:08 +0000545 StringRef Delimiter) {
546 if (!Symbolizer)
547 return;
548 DILineInfo LineInfo = DILineInfo();
Eric Christopher1857edb2019-03-28 01:12:13 +0000549 auto ExpectedLineInfo =
Sid Manningd9f28732018-05-14 19:46:08 +0000550 Symbolizer->symbolizeCode(Obj->getFileName(), Address);
Eric Christopher1857edb2019-03-28 01:12:13 +0000551 if (!ExpectedLineInfo)
552 consumeError(ExpectedLineInfo.takeError());
Sid Manningd9f28732018-05-14 19:46:08 +0000553 else
Eric Christopher1857edb2019-03-28 01:12:13 +0000554 LineInfo = *ExpectedLineInfo;
Sid Manningd9f28732018-05-14 19:46:08 +0000555
556 if ((LineInfo.FileName == "<invalid>") || OldLineInfo.Line == LineInfo.Line ||
557 LineInfo.Line == 0)
558 return;
559
560 if (PrintLines)
561 OS << Delimiter << LineInfo.FileName << ":" << LineInfo.Line << "\n";
562 if (PrintSource) {
563 if (SourceCache.find(LineInfo.FileName) == SourceCache.end())
564 if (!cacheSource(LineInfo))
565 return;
Fangrui Song47a76622019-04-07 10:16:46 +0000566 auto LineBuffer = LineCache.find(LineInfo.FileName);
567 if (LineBuffer != LineCache.end()) {
568 if (LineInfo.Line > LineBuffer->second.size())
569 return;
570 // Vector begins at 0, line numbers are non-zero
571 OS << Delimiter << LineBuffer->second[LineInfo.Line - 1] << '\n';
Sid Manningd9f28732018-05-14 19:46:08 +0000572 }
573 }
574 OldLineInfo = LineInfo;
575}
576
577static bool isArmElf(const ObjectFile *Obj) {
578 return (Obj->isELF() &&
579 (Obj->getArch() == Triple::aarch64 ||
580 Obj->getArch() == Triple::aarch64_be ||
581 Obj->getArch() == Triple::arm || Obj->getArch() == Triple::armeb ||
582 Obj->getArch() == Triple::thumb ||
583 Obj->getArch() == Triple::thumbeb));
584}
585
George Rimar617adef2019-01-23 13:39:12 +0000586static void printRelocation(const RelocationRef &Rel, uint64_t Address,
587 uint8_t AddrSize) {
588 StringRef Fmt =
589 AddrSize > 4 ? "\t\t%016" PRIx64 ": " : "\t\t\t%08" PRIx64 ": ";
590 SmallString<16> Name;
591 SmallString<32> Val;
592 Rel.getTypeName(Name);
593 error(getRelocationValueString(Rel, Val));
594 outs() << format(Fmt.data(), Address) << Name << "\t" << Val << "\n";
595}
596
Sid Manningd9f28732018-05-14 19:46:08 +0000597class PrettyPrinter {
598public:
599 virtual ~PrettyPrinter() = default;
600 virtual void printInst(MCInstPrinter &IP, const MCInst *MI,
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000601 ArrayRef<uint8_t> Bytes,
602 object::SectionedAddress Address, raw_ostream &OS,
603 StringRef Annot, MCSubtargetInfo const &STI,
604 SourcePrinter *SP,
Sid Manningd9f28732018-05-14 19:46:08 +0000605 std::vector<RelocationRef> *Rels = nullptr) {
606 if (SP && (PrintSource || PrintLines))
607 SP->printSourceLine(OS, Address);
608 if (!NoLeadingAddr)
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000609 OS << format("%8" PRIx64 ":", Address.Address);
Sid Manningd9f28732018-05-14 19:46:08 +0000610 if (!NoShowRawInsn) {
611 OS << "\t";
612 dumpBytes(Bytes, OS);
613 }
614 if (MI)
615 IP.printInst(MI, OS, "", STI);
616 else
617 OS << " <unknown>";
618 }
619};
620PrettyPrinter PrettyPrinterInst;
621class HexagonPrettyPrinter : public PrettyPrinter {
622public:
623 void printLead(ArrayRef<uint8_t> Bytes, uint64_t Address,
624 raw_ostream &OS) {
625 uint32_t opcode =
626 (Bytes[3] << 24) | (Bytes[2] << 16) | (Bytes[1] << 8) | Bytes[0];
627 if (!NoLeadingAddr)
628 OS << format("%8" PRIx64 ":", Address);
629 if (!NoShowRawInsn) {
630 OS << "\t";
631 dumpBytes(Bytes.slice(0, 4), OS);
632 OS << format("%08" PRIx32, opcode);
633 }
634 }
635 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000636 object::SectionedAddress Address, raw_ostream &OS,
637 StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP,
Sid Manningd9f28732018-05-14 19:46:08 +0000638 std::vector<RelocationRef> *Rels) override {
639 if (SP && (PrintSource || PrintLines))
640 SP->printSourceLine(OS, Address, "");
641 if (!MI) {
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000642 printLead(Bytes, Address.Address, OS);
Sid Manningd9f28732018-05-14 19:46:08 +0000643 OS << " <unknown>";
644 return;
645 }
646 std::string Buffer;
647 {
648 raw_string_ostream TempStream(Buffer);
649 IP.printInst(MI, TempStream, "", STI);
650 }
651 StringRef Contents(Buffer);
652 // Split off bundle attributes
653 auto PacketBundle = Contents.rsplit('\n');
654 // Split off first instruction from the rest
655 auto HeadTail = PacketBundle.first.split('\n');
656 auto Preamble = " { ";
657 auto Separator = "";
Sid Manningd9f28732018-05-14 19:46:08 +0000658
659 // Hexagon's packets require relocations to be inline rather than
660 // clustered at the end of the packet.
George Rimar617adef2019-01-23 13:39:12 +0000661 std::vector<RelocationRef>::const_iterator RelCur = Rels->begin();
662 std::vector<RelocationRef>::const_iterator RelEnd = Rels->end();
Sid Manningd9f28732018-05-14 19:46:08 +0000663 auto PrintReloc = [&]() -> void {
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000664 while ((RelCur != RelEnd) && (RelCur->getOffset() <= Address.Address)) {
665 if (RelCur->getOffset() == Address.Address) {
666 printRelocation(*RelCur, Address.Address, 4);
Sid Manningd9f28732018-05-14 19:46:08 +0000667 return;
668 }
George Rimar73a27232019-01-15 09:19:18 +0000669 ++RelCur;
Sid Manningd9f28732018-05-14 19:46:08 +0000670 }
671 };
672
George Rimar73a27232019-01-15 09:19:18 +0000673 while (!HeadTail.first.empty()) {
Sid Manningd9f28732018-05-14 19:46:08 +0000674 OS << Separator;
675 Separator = "\n";
676 if (SP && (PrintSource || PrintLines))
677 SP->printSourceLine(OS, Address, "");
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000678 printLead(Bytes, Address.Address, OS);
Sid Manningd9f28732018-05-14 19:46:08 +0000679 OS << Preamble;
680 Preamble = " ";
681 StringRef Inst;
682 auto Duplex = HeadTail.first.split('\v');
George Rimar73a27232019-01-15 09:19:18 +0000683 if (!Duplex.second.empty()) {
Sid Manningd9f28732018-05-14 19:46:08 +0000684 OS << Duplex.first;
685 OS << "; ";
686 Inst = Duplex.second;
687 }
688 else
689 Inst = HeadTail.first;
690 OS << Inst;
691 HeadTail = HeadTail.second.split('\n');
692 if (HeadTail.first.empty())
693 OS << " } " << PacketBundle.second;
694 PrintReloc();
695 Bytes = Bytes.slice(4);
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000696 Address.Address += 4;
Sid Manningd9f28732018-05-14 19:46:08 +0000697 }
698 }
699};
700HexagonPrettyPrinter HexagonPrettyPrinterInst;
701
702class AMDGCNPrettyPrinter : public PrettyPrinter {
703public:
704 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000705 object::SectionedAddress Address, raw_ostream &OS,
706 StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP,
Sid Manningd9f28732018-05-14 19:46:08 +0000707 std::vector<RelocationRef> *Rels) override {
708 if (SP && (PrintSource || PrintLines))
709 SP->printSourceLine(OS, Address);
710
711 typedef support::ulittle32_t U32;
712
713 if (MI) {
714 SmallString<40> InstStr;
715 raw_svector_ostream IS(InstStr);
716
717 IP.printInst(MI, IS, "", STI);
718
719 OS << left_justify(IS.str(), 60);
720 } else {
721 // an unrecognized encoding - this is probably data so represent it
722 // using the .long directive, or .byte directive if fewer than 4 bytes
723 // remaining
724 if (Bytes.size() >= 4) {
725 OS << format("\t.long 0x%08" PRIx32 " ",
726 static_cast<uint32_t>(*reinterpret_cast<const U32*>(Bytes.data())));
727 OS.indent(42);
728 } else {
729 OS << format("\t.byte 0x%02" PRIx8, Bytes[0]);
730 for (unsigned int i = 1; i < Bytes.size(); i++)
731 OS << format(", 0x%02" PRIx8, Bytes[i]);
732 OS.indent(55 - (6 * Bytes.size()));
733 }
734 }
735
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000736 OS << format("// %012" PRIX64 ": ", Address.Address);
Sid Manningd9f28732018-05-14 19:46:08 +0000737 if (Bytes.size() >=4) {
738 for (auto D : makeArrayRef(reinterpret_cast<const U32*>(Bytes.data()),
739 Bytes.size() / sizeof(U32)))
740 // D should be explicitly casted to uint32_t here as it is passed
741 // by format to snprintf as vararg.
742 OS << format("%08" PRIX32 " ", static_cast<uint32_t>(D));
743 } else {
744 for (unsigned int i = 0; i < Bytes.size(); i++)
745 OS << format("%02" PRIX8 " ", Bytes[i]);
746 }
747
748 if (!Annot.empty())
749 OS << "// " << Annot;
750 }
751};
752AMDGCNPrettyPrinter AMDGCNPrettyPrinterInst;
753
754class BPFPrettyPrinter : public PrettyPrinter {
755public:
756 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000757 object::SectionedAddress Address, raw_ostream &OS,
758 StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP,
Sid Manningd9f28732018-05-14 19:46:08 +0000759 std::vector<RelocationRef> *Rels) override {
760 if (SP && (PrintSource || PrintLines))
761 SP->printSourceLine(OS, Address);
762 if (!NoLeadingAddr)
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000763 OS << format("%8" PRId64 ":", Address.Address / 8);
Sid Manningd9f28732018-05-14 19:46:08 +0000764 if (!NoShowRawInsn) {
765 OS << "\t";
766 dumpBytes(Bytes, OS);
767 }
768 if (MI)
769 IP.printInst(MI, OS, "", STI);
770 else
771 OS << " <unknown>";
772 }
773};
774BPFPrettyPrinter BPFPrettyPrinterInst;
775
776PrettyPrinter &selectPrettyPrinter(Triple const &Triple) {
777 switch(Triple.getArch()) {
778 default:
779 return PrettyPrinterInst;
780 case Triple::hexagon:
781 return HexagonPrettyPrinterInst;
782 case Triple::amdgcn:
783 return AMDGCNPrettyPrinterInst;
784 case Triple::bpfel:
785 case Triple::bpfeb:
786 return BPFPrettyPrinterInst;
787 }
788}
789}
790
Sam Koltonc05d7782016-08-17 10:17:57 +0000791static uint8_t getElfSymbolType(const ObjectFile *Obj, const SymbolRef &Sym) {
792 assert(Obj->isELF());
793 if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(Obj))
794 return Elf32LEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
795 if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(Obj))
796 return Elf64LEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
797 if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(Obj))
798 return Elf32BEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
799 if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(Obj))
800 return Elf64BEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
801 llvm_unreachable("Unsupported binary format");
802}
803
Sam Parker5fba45a2017-02-08 09:44:18 +0000804template <class ELFT> static void
805addDynamicElfSymbols(const ELFObjectFile<ELFT> *Obj,
806 std::map<SectionRef, SectionSymbolsTy> &AllSymbols) {
807 for (auto Symbol : Obj->getDynamicSymbolIterators()) {
808 uint8_t SymbolType = Symbol.getELFType();
809 if (SymbolType != ELF::STT_FUNC || Symbol.getSize() == 0)
810 continue;
811
Fangrui Songe7834bd2019-04-07 08:19:55 +0000812 uint64_t Address = unwrapOrError(Symbol.getAddress(), Obj->getFileName());
813 StringRef Name = unwrapOrError(Symbol.getName(), Obj->getFileName());
814 if (Name.empty())
Sam Parker5fba45a2017-02-08 09:44:18 +0000815 continue;
816
Fangrui Songe7834bd2019-04-07 08:19:55 +0000817 section_iterator SecI =
818 unwrapOrError(Symbol.getSection(), Obj->getFileName());
Sam Parker5fba45a2017-02-08 09:44:18 +0000819 if (SecI == Obj->section_end())
820 continue;
821
Fangrui Songe7834bd2019-04-07 08:19:55 +0000822 AllSymbols[*SecI].emplace_back(Address, Name, SymbolType);
Sam Parker5fba45a2017-02-08 09:44:18 +0000823 }
824}
825
826static void
827addDynamicElfSymbols(const ObjectFile *Obj,
828 std::map<SectionRef, SectionSymbolsTy> &AllSymbols) {
829 assert(Obj->isELF());
830 if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(Obj))
831 addDynamicElfSymbols(Elf32LEObj, AllSymbols);
832 else if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(Obj))
833 addDynamicElfSymbols(Elf64LEObj, AllSymbols);
834 else if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(Obj))
835 addDynamicElfSymbols(Elf32BEObj, AllSymbols);
836 else if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(Obj))
837 addDynamicElfSymbols(Elf64BEObj, AllSymbols);
838 else
839 llvm_unreachable("Unsupported binary format");
840}
841
Joel Galenson134cf472018-08-24 15:21:57 +0000842static void addPltEntries(const ObjectFile *Obj,
843 std::map<SectionRef, SectionSymbolsTy> &AllSymbols,
844 StringSaver &Saver) {
845 Optional<SectionRef> Plt = None;
846 for (const SectionRef &Section : Obj->sections()) {
847 StringRef Name;
848 if (Section.getName(Name))
849 continue;
850 if (Name == ".plt")
851 Plt = Section;
852 }
853 if (!Plt)
854 return;
855 if (auto *ElfObj = dyn_cast<ELFObjectFileBase>(Obj)) {
856 for (auto PltEntry : ElfObj->getPltAddresses()) {
857 SymbolRef Symbol(PltEntry.first, ElfObj);
Joel Galenson134cf472018-08-24 15:21:57 +0000858 uint8_t SymbolType = getElfSymbolType(Obj, Symbol);
859
Fangrui Songe7834bd2019-04-07 08:19:55 +0000860 StringRef Name = unwrapOrError(Symbol.getName(), Obj->getFileName());
861 if (!Name.empty())
862 AllSymbols[*Plt].emplace_back(
863 PltEntry.second, Saver.save((Name + "@plt").str()), SymbolType);
Joel Galenson134cf472018-08-24 15:21:57 +0000864 }
865 }
866}
867
George Rimar70d197d2019-01-10 14:55:26 +0000868// Normally the disassembly output will skip blocks of zeroes. This function
869// returns the number of zero bytes that can be skipped when dumping the
870// disassembly of the instructions in Buf.
871static size_t countSkippableZeroBytes(ArrayRef<uint8_t> Buf) {
George Rimar70d197d2019-01-10 14:55:26 +0000872 // Find the number of leading zeroes.
873 size_t N = 0;
874 while (N < Buf.size() && !Buf[N])
875 ++N;
876
877 // We may want to skip blocks of zero bytes, but unless we see
878 // at least 8 of them in a row.
879 if (N < 8)
880 return 0;
881
882 // We skip zeroes in multiples of 4 because do not want to truncate an
883 // instruction if it starts with a zero byte.
884 return N & ~0x3;
885}
886
George Rimar121fcd72019-01-22 14:09:37 +0000887// Returns a map from sections to their relocations.
888static std::map<SectionRef, std::vector<RelocationRef>>
889getRelocsMap(llvm::object::ObjectFile const &Obj) {
890 std::map<SectionRef, std::vector<RelocationRef>> Ret;
891 for (const SectionRef &Section : ToolSectionFilter(Obj)) {
892 section_iterator RelSec = Section.getRelocatedSection();
893 if (RelSec == Obj.section_end())
894 continue;
895 std::vector<RelocationRef> &V = Ret[*RelSec];
896 for (const RelocationRef &R : Section.relocations())
897 V.push_back(R);
898 // Sort relocations by address.
899 llvm::sort(V, isRelocAddressLess);
900 }
901 return Ret;
902}
903
George Rimar4c3b2972019-01-28 10:44:01 +0000904// Used for --adjust-vma to check if address should be adjusted by the
905// specified value for a given section.
906// For ELF we do not adjust non-allocatable sections like debug ones,
907// because they are not loadable.
908// TODO: implement for other file formats.
909static bool shouldAdjustVA(const SectionRef &Section) {
910 const ObjectFile *Obj = Section.getObject();
911 if (isa<object::ELFObjectFileBase>(Obj))
912 return ELFSectionRef(Section).getFlags() & ELF::SHF_ALLOC;
913 return false;
914}
915
Fangrui Song32087b62019-04-07 16:33:24 +0000916static uint64_t
917dumpARMELFData(uint64_t SectionAddr, uint64_t Index, uint64_t End,
918 const ObjectFile *Obj, ArrayRef<uint8_t> Bytes,
919 const std::vector<uint64_t> &TextMappingSymsAddr) {
920 support::endianness Endian =
921 Obj->isLittleEndian() ? support::little : support::big;
922 while (Index < End) {
923 outs() << format("%8" PRIx64 ":", SectionAddr + Index);
924 outs() << "\t";
925 if (Index + 4 <= End) {
926 dumpBytes(Bytes.slice(Index, 4), outs());
927 outs() << "\t.word\t"
928 << format_hex(
929 support::endian::read32(Bytes.data() + Index, Endian), 10);
930 Index += 4;
931 } else if (Index + 2 <= End) {
932 dumpBytes(Bytes.slice(Index, 2), outs());
933 outs() << "\t\t.short\t"
934 << format_hex(
935 support::endian::read16(Bytes.data() + Index, Endian), 6);
936 Index += 2;
937 } else {
938 dumpBytes(Bytes.slice(Index, 1), outs());
939 outs() << "\t\t.byte\t" << format_hex(Bytes[0], 4);
940 ++Index;
941 }
942 outs() << "\n";
943 if (std::binary_search(TextMappingSymsAddr.begin(),
944 TextMappingSymsAddr.end(), Index))
945 break;
946 }
947 return Index;
948}
949
950static void dumpELFData(uint64_t SectionAddr, uint64_t Index, uint64_t End,
951 ArrayRef<uint8_t> Bytes) {
952 // print out data up to 8 bytes at a time in hex and ascii
953 uint8_t AsciiData[9] = {'\0'};
954 uint8_t Byte;
955 int NumBytes = 0;
956
957 for (; Index < End; ++Index) {
958 if (NumBytes == 0) {
959 outs() << format("%8" PRIx64 ":", SectionAddr + Index);
960 outs() << "\t";
961 }
962 Byte = Bytes.slice(Index)[0];
963 outs() << format(" %02x", Byte);
964 AsciiData[NumBytes] = isPrint(Byte) ? Byte : '.';
965
966 uint8_t IndentOffset = 0;
967 NumBytes++;
968 if (Index == End - 1 || NumBytes > 8) {
969 // Indent the space for less than 8 bytes data.
970 // 2 spaces for byte and one for space between bytes
971 IndentOffset = 3 * (8 - NumBytes);
972 for (int Excess = NumBytes; Excess < 8; Excess++)
973 AsciiData[Excess] = '\0';
974 NumBytes = 8;
975 }
976 if (NumBytes == 8) {
977 AsciiData[8] = '\0';
978 outs() << std::string(IndentOffset, ' ') << " ";
979 outs() << reinterpret_cast<char *>(AsciiData);
980 outs() << '\n';
981 NumBytes = 0;
982 }
983 }
984}
985
George Rimarbcbe98b2019-01-23 10:33:26 +0000986static void disassembleObject(const Target *TheTarget, const ObjectFile *Obj,
987 MCContext &Ctx, MCDisassembler *DisAsm,
988 const MCInstrAnalysis *MIA, MCInstPrinter *IP,
989 const MCSubtargetInfo *STI, PrettyPrinter &PIP,
990 SourcePrinter &SP, bool InlineRelocs) {
George Rimar121fcd72019-01-22 14:09:37 +0000991 std::map<SectionRef, std::vector<RelocationRef>> RelocMap;
992 if (InlineRelocs)
993 RelocMap = getRelocsMap(*Obj);
Mark Seaborn0929d3d2014-01-25 17:38:19 +0000994
David Majnemer81afca62015-07-07 22:06:59 +0000995 // Create a mapping from virtual address to symbol name. This is used to
David Majnemerfbb1c3a2015-11-18 02:49:19 +0000996 // pretty print the symbols while disassembling.
David Majnemerfbb1c3a2015-11-18 02:49:19 +0000997 std::map<SectionRef, SectionSymbolsTy> AllSymbols;
Sterling Augustinebc78b622018-06-28 18:57:13 +0000998 SectionSymbolsTy AbsoluteSymbols;
Fangrui Songe7834bd2019-04-07 08:19:55 +0000999 const StringRef FileName = Obj->getFileName();
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001000 for (const SymbolRef &Symbol : Obj->symbols()) {
Fangrui Songe7834bd2019-04-07 08:19:55 +00001001 uint64_t Address = unwrapOrError(Symbol.getAddress(), FileName);
David Majnemer2603a8fa2015-07-09 18:11:40 +00001002
Fangrui Songe7834bd2019-04-07 08:19:55 +00001003 StringRef Name = unwrapOrError(Symbol.getName(), FileName);
1004 if (Name.empty())
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001005 continue;
David Majnemer81afca62015-07-07 22:06:59 +00001006
Sam Koltonc05d7782016-08-17 10:17:57 +00001007 uint8_t SymbolType = ELF::STT_NOTYPE;
Matt Davis82937e42019-01-31 19:42:21 +00001008 if (Obj->isELF()) {
Sam Koltonc05d7782016-08-17 10:17:57 +00001009 SymbolType = getElfSymbolType(Obj, Symbol);
Matt Davis82937e42019-01-31 19:42:21 +00001010 if (SymbolType == ELF::STT_SECTION)
1011 continue;
1012 }
David Majnemer81afca62015-07-07 22:06:59 +00001013
Fangrui Songe7834bd2019-04-07 08:19:55 +00001014 section_iterator SecI = unwrapOrError(Symbol.getSection(), FileName);
Sterling Augustinebc78b622018-06-28 18:57:13 +00001015 if (SecI != Obj->section_end())
Fangrui Songe7834bd2019-04-07 08:19:55 +00001016 AllSymbols[*SecI].emplace_back(Address, Name, SymbolType);
Sterling Augustinebc78b622018-06-28 18:57:13 +00001017 else
Fangrui Songe7834bd2019-04-07 08:19:55 +00001018 AbsoluteSymbols.emplace_back(Address, Name, SymbolType);
David Majnemer81afca62015-07-07 22:06:59 +00001019 }
Sam Parker5fba45a2017-02-08 09:44:18 +00001020 if (AllSymbols.empty() && Obj->isELF())
1021 addDynamicElfSymbols(Obj, AllSymbols);
David Majnemer81afca62015-07-07 22:06:59 +00001022
Joel Galenson134cf472018-08-24 15:21:57 +00001023 BumpPtrAllocator A;
1024 StringSaver Saver(A);
1025 addPltEntries(Obj, AllSymbols, Saver);
1026
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001027 // Create a mapping from virtual address to section.
1028 std::vector<std::pair<uint64_t, SectionRef>> SectionAddresses;
1029 for (SectionRef Sec : Obj->sections())
1030 SectionAddresses.emplace_back(Sec.getAddress(), Sec);
1031 array_pod_sort(SectionAddresses.begin(), SectionAddresses.end());
1032
1033 // Linked executables (.exe and .dll files) typically don't include a real
1034 // symbol table but they might contain an export table.
1035 if (const auto *COFFObj = dyn_cast<COFFObjectFile>(Obj)) {
1036 for (const auto &ExportEntry : COFFObj->export_directories()) {
1037 StringRef Name;
1038 error(ExportEntry.getSymbolName(Name));
1039 if (Name.empty())
1040 continue;
1041 uint32_t RVA;
1042 error(ExportEntry.getExportRVA(RVA));
1043
1044 uint64_t VA = COFFObj->getImageBase() + RVA;
Fangrui Song545ed222019-04-07 05:32:16 +00001045 auto Sec = llvm::upper_bound(
1046 SectionAddresses, VA,
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001047 [](uint64_t LHS, const std::pair<uint64_t, SectionRef> &RHS) {
1048 return LHS < RHS.first;
1049 });
Fangrui Song545ed222019-04-07 05:32:16 +00001050 if (Sec != SectionAddresses.begin()) {
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001051 --Sec;
Sam Koltonc05d7782016-08-17 10:17:57 +00001052 AllSymbols[Sec->second].emplace_back(VA, Name, ELF::STT_NOTYPE);
Fangrui Song545ed222019-04-07 05:32:16 +00001053 } else
Sterling Augustinebc78b622018-06-28 18:57:13 +00001054 AbsoluteSymbols.emplace_back(VA, Name, ELF::STT_NOTYPE);
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001055 }
1056 }
1057
1058 // Sort all the symbols, this allows us to use a simple binary search to find
1059 // a symbol near an address.
1060 for (std::pair<const SectionRef, SectionSymbolsTy> &SecSyms : AllSymbols)
1061 array_pod_sort(SecSyms.second.begin(), SecSyms.second.end());
Sterling Augustinebc78b622018-06-28 18:57:13 +00001062 array_pod_sort(AbsoluteSymbols.begin(), AbsoluteSymbols.end());
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001063
Colin LeMahieu77804be2015-07-29 15:45:39 +00001064 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Colin LeMahieuf34933e2015-07-23 20:58:49 +00001065 if (!DisassembleAll && (!Section.isText() || Section.isVirtual()))
Mark Seaborneb03ac52014-01-25 00:32:01 +00001066 continue;
Michael J. Spencer1d6167f2011-06-25 17:55:23 +00001067
Rafael Espindola80291272014-10-08 15:28:58 +00001068 uint64_t SectionAddr = Section.getAddress();
1069 uint64_t SectSize = Section.getSize();
David Majnemer185b5b12014-11-11 09:58:25 +00001070 if (!SectSize)
1071 continue;
Simon Atanasyan2b614e12014-02-24 22:12:11 +00001072
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001073 // Get the list of all the symbols in this section.
1074 SectionSymbolsTy &Symbols = AllSymbols[Section];
Davide Italianof0706882015-10-01 21:57:09 +00001075 std::vector<uint64_t> DataMappingSymsAddr;
1076 std::vector<uint64_t> TextMappingSymsAddr;
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001077 if (isArmElf(Obj)) {
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001078 for (const auto &Symb : Symbols) {
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001079 uint64_t Address = std::get<0>(Symb);
1080 StringRef Name = std::get<1>(Symb);
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001081 if (Name.startswith("$d"))
David Majnemer153722d2015-11-18 04:35:32 +00001082 DataMappingSymsAddr.push_back(Address - SectionAddr);
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001083 if (Name.startswith("$x"))
David Majnemer153722d2015-11-18 04:35:32 +00001084 TextMappingSymsAddr.push_back(Address - SectionAddr);
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001085 if (Name.startswith("$a"))
1086 TextMappingSymsAddr.push_back(Address - SectionAddr);
1087 if (Name.startswith("$t"))
1088 TextMappingSymsAddr.push_back(Address - SectionAddr);
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001089 }
1090 }
1091
Fangrui Song0cac7262018-09-27 02:13:45 +00001092 llvm::sort(DataMappingSymsAddr);
1093 llvm::sort(TextMappingSymsAddr);
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001094
Sam Kolton3381d7a2016-10-06 13:46:08 +00001095 if (Obj->isELF() && Obj->getArch() == Triple::amdgcn) {
1096 // AMDGPU disassembler uses symbolizer for printing labels
1097 std::unique_ptr<MCRelocationInfo> RelInfo(
1098 TheTarget->createMCRelocationInfo(TripleName, Ctx));
1099 if (RelInfo) {
1100 std::unique_ptr<MCSymbolizer> Symbolizer(
1101 TheTarget->createMCSymbolizer(
1102 TripleName, nullptr, nullptr, &Symbols, &Ctx, std::move(RelInfo)));
1103 DisAsm->setSymbolizer(std::move(Symbolizer));
1104 }
1105 }
1106
Rafael Espindolaa9f810b2012-12-21 03:47:03 +00001107 StringRef SegmentName = "";
Mark Seaborneb03ac52014-01-25 00:32:01 +00001108 if (const MachOObjectFile *MachO = dyn_cast<const MachOObjectFile>(Obj)) {
Alexey Samsonov48803e52014-03-13 14:37:36 +00001109 DataRefImpl DR = Section.getRawDataRefImpl();
Rafael Espindola56f976f2013-04-18 18:08:55 +00001110 SegmentName = MachO->getSectionFinalSegmentName(DR);
Rafael Espindolaa9f810b2012-12-21 03:47:03 +00001111 }
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001112 StringRef SectionName;
1113 error(Section.getName(SectionName));
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001114
Rafael Espindola7884c952015-06-04 15:01:05 +00001115 // If the section has no symbol at the start, just insert a dummy one.
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001116 if (Symbols.empty() || std::get<0>(Symbols[0]) != 0) {
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001117 Symbols.insert(
1118 Symbols.begin(),
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001119 std::make_tuple(SectionAddr, SectionName,
1120 Section.isText() ? ELF::STT_FUNC : ELF::STT_OBJECT));
Sam Koltonc05d7782016-08-17 10:17:57 +00001121 }
Alp Tokere69170a2014-06-26 22:52:05 +00001122
1123 SmallString<40> Comments;
1124 raw_svector_ostream CommentStream(Comments);
Ahmed Bougachaad1084d2013-05-24 00:39:57 +00001125
Rafael Espindola7fc5b872014-11-12 02:04:27 +00001126 StringRef BytesStr;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001127 error(Section.getContents(BytesStr));
Fangrui Song6a0746a2019-04-07 03:58:42 +00001128 ArrayRef<uint8_t> Bytes = arrayRefFromStringRef(BytesStr);
Rafael Espindola7fc5b872014-11-12 02:04:27 +00001129
George Rimar4c3b2972019-01-28 10:44:01 +00001130 uint64_t VMAAdjustment = 0;
1131 if (shouldAdjustVA(Section))
1132 VMAAdjustment = AdjustVMA;
1133
Michael J. Spencer2670c252011-01-20 06:39:06 +00001134 uint64_t Size;
1135 uint64_t Index;
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001136 bool PrintedSection = false;
George Rimar121fcd72019-01-22 14:09:37 +00001137 std::vector<RelocationRef> Rels = RelocMap[Section];
George Rimar73a27232019-01-15 09:19:18 +00001138 std::vector<RelocationRef>::const_iterator RelCur = Rels.begin();
1139 std::vector<RelocationRef>::const_iterator RelEnd = Rels.end();
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001140 // Disassemble symbol by symbol.
George Rimar73a27232019-01-15 09:19:18 +00001141 for (unsigned SI = 0, SE = Symbols.size(); SI != SE; ++SI) {
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001142 uint64_t Start = std::get<0>(Symbols[SI]) - SectionAddr;
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001143 // The end is either the section end or the beginning of the next
1144 // symbol.
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001145 uint64_t End = (SI == SE - 1)
1146 ? SectSize
1147 : std::get<0>(Symbols[SI + 1]) - SectionAddr;
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001148 // Don't try to disassemble beyond the end of section contents.
1149 if (End > SectSize)
1150 End = SectSize;
Rafael Espindolae45c7402014-08-17 16:31:39 +00001151 // If this symbol has the same address as the next symbol, then skip it.
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001152 if (Start >= End)
Michael J. Spenceree84f642011-10-13 20:37:08 +00001153 continue;
1154
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001155 // Check if we need to skip symbol
1156 // Skip if the symbol's data is not between StartAddress and StopAddress
Fangrui Song32087b62019-04-07 16:33:24 +00001157 if (End + SectionAddr <= StartAddress ||
1158 Start + SectionAddr >= StopAddress)
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001159 continue;
Fangrui Song32087b62019-04-07 16:33:24 +00001160
1161 // Stop disassembly at the stop address specified
1162 if (End + SectionAddr > StopAddress)
1163 End = StopAddress - SectionAddr;
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001164
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001165 /// Skip if user requested specific symbols and this is not in the list
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001166 if (!DisasmFuncsSet.empty() &&
1167 !DisasmFuncsSet.count(std::get<1>(Symbols[SI])))
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001168 continue;
1169
1170 if (!PrintedSection) {
1171 PrintedSection = true;
1172 outs() << "Disassembly of section ";
1173 if (!SegmentName.empty())
1174 outs() << SegmentName << ",";
1175 outs() << SectionName << ':';
1176 }
1177
Valery Pykhtinde048052016-04-07 07:24:01 +00001178 if (Obj->isELF() && Obj->getArch() == Triple::amdgcn) {
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001179 if (std::get<2>(Symbols[SI]) == ELF::STT_AMDGPU_HSA_KERNEL) {
Sam Koltonc05d7782016-08-17 10:17:57 +00001180 // skip amd_kernel_code_t at the begining of kernel symbol (256 bytes)
1181 Start += 256;
1182 }
George Rimar73a27232019-01-15 09:19:18 +00001183 if (SI == SE - 1 ||
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001184 std::get<2>(Symbols[SI + 1]) == ELF::STT_AMDGPU_HSA_KERNEL) {
Sam Koltonc05d7782016-08-17 10:17:57 +00001185 // cut trailing zeroes at the end of kernel
1186 // cut up to 256 bytes
1187 const uint64_t EndAlign = 256;
1188 const auto Limit = End - (std::min)(EndAlign, End - Start);
1189 while (End > Limit &&
1190 *reinterpret_cast<const support::ulittle32_t*>(&Bytes[End - 4]) == 0)
1191 End -= 4;
1192 }
Valery Pykhtinde048052016-04-07 07:24:01 +00001193 }
1194
George Rimar6622d412018-12-19 10:21:45 +00001195 outs() << '\n';
George Rimar3ba0f3c02019-01-09 14:43:33 +00001196 if (!NoLeadingAddr)
George Rimar4c3b2972019-01-28 10:44:01 +00001197 outs() << format("%016" PRIx64 " ",
1198 SectionAddr + Start + VMAAdjustment);
George Rimar3ba0f3c02019-01-09 14:43:33 +00001199
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001200 StringRef SymbolName = std::get<1>(Symbols[SI]);
George Rimar6622d412018-12-19 10:21:45 +00001201 if (Demangle)
1202 outs() << demangle(SymbolName) << ":\n";
1203 else
1204 outs() << SymbolName << ":\n";
Michael J. Spencer2670c252011-01-20 06:39:06 +00001205
Francis Visoiu Mistrih18346822018-04-19 17:02:57 +00001206 // Don't print raw contents of a virtual section. A virtual section
1207 // doesn't have any contents in the file.
1208 if (Section.isVirtual()) {
1209 outs() << "...\n";
1210 continue;
1211 }
1212
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001213#ifndef NDEBUG
Mark Seaborneb03ac52014-01-25 00:32:01 +00001214 raw_ostream &DebugOut = DebugFlag ? dbgs() : nulls();
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001215#else
Mark Seaborneb03ac52014-01-25 00:32:01 +00001216 raw_ostream &DebugOut = nulls();
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001217#endif
1218
Wouter van Oortmerssenf3b762a2019-01-17 18:14:09 +00001219 // Some targets (like WebAssembly) have a special prelude at the start
1220 // of each symbol.
1221 DisAsm->onSymbolStart(SymbolName, Size, Bytes.slice(Start, End - Start),
1222 SectionAddr + Start, DebugOut, CommentStream);
1223 Start += Size;
1224
Fangrui Song32087b62019-04-07 16:33:24 +00001225 Index = Start;
1226 if (SectionAddr < StartAddress)
1227 Index = std::max<uint64_t>(Index, StartAddress - SectionAddr);
Owen Andersona0c3b972011-09-15 23:38:46 +00001228
Fangrui Song32087b62019-04-07 16:33:24 +00001229 // If there is a data symbol inside an ELF text section and we are
1230 // only disassembling text (applicable all architectures), we are in a
1231 // situation where we must print the data and not disassemble it.
1232 if (Obj->isELF() && std::get<2>(Symbols[SI]) == ELF::STT_OBJECT &&
1233 !DisassembleAll && Section.isText()) {
1234 dumpELFData(SectionAddr, Index, End, Bytes);
1235 Index = End;
1236 }
1237
1238 bool CheckARMELFData = isArmElf(Obj) &&
1239 std::get<2>(Symbols[SI]) != ELF::STT_OBJECT &&
1240 !DisassembleAll;
Fangrui Song32087b62019-04-07 16:33:24 +00001241 while (Index < End) {
1242 // AArch64 ELF binaries can interleave data and text in the same
1243 // section. We rely on the markers introduced to understand what we
1244 // need to dump. If the data marker is within a function, it is
1245 // denoted as a word/short etc.
1246 if (CheckARMELFData &&
Fangrui Song545ed222019-04-07 05:32:16 +00001247 std::binary_search(DataMappingSymsAddr.begin(),
1248 DataMappingSymsAddr.end(), Index)) {
Fangrui Song32087b62019-04-07 16:33:24 +00001249 Index = dumpARMELFData(SectionAddr, Index, End, Obj, Bytes,
1250 TextMappingSymsAddr);
1251 continue;
Davide Italianof0706882015-10-01 21:57:09 +00001252 }
1253
Fangrui Song32087b62019-04-07 16:33:24 +00001254 // When -z or --disassemble-zeroes are given we always dissasemble
1255 // them. Otherwise we might want to skip zero bytes we see.
George Rimarc5f29202019-02-19 12:38:36 +00001256 if (!DisassembleZeroes) {
1257 uint64_t MaxOffset = End - Index;
1258 // For -reloc: print zero blocks patched by relocations, so that
1259 // relocations can be shown in the dump.
1260 if (RelCur != RelEnd)
1261 MaxOffset = RelCur->getOffset() - Index;
1262
1263 if (size_t N =
1264 countSkippableZeroBytes(Bytes.slice(Index, MaxOffset))) {
1265 outs() << "\t\t..." << '\n';
1266 Index += N;
Fangrui Song32087b62019-04-07 16:33:24 +00001267 continue;
George Rimarc5f29202019-02-19 12:38:36 +00001268 }
George Rimar70d197d2019-01-10 14:55:26 +00001269 }
1270
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001271 // Disassemble a real instruction or a data when disassemble all is
1272 // provided
Fangrui Song996b9092019-04-08 01:22:38 +00001273 MCInst Inst;
Fangrui Song32087b62019-04-07 16:33:24 +00001274 bool Disassembled = DisAsm->getInstruction(
1275 Inst, Size, Bytes.slice(Index), SectionAddr + Index, DebugOut,
1276 CommentStream);
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001277 if (Size == 0)
1278 Size = 1;
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +00001279
Fangrui Song32087b62019-04-07 16:33:24 +00001280 PIP.printInst(
1281 *IP, Disassembled ? &Inst : nullptr, Bytes.slice(Index, Size),
1282 {SectionAddr + Index + VMAAdjustment, Section.getIndex()}, outs(),
1283 "", *STI, &SP, &Rels);
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001284 outs() << CommentStream.str();
1285 Comments.clear();
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001286
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001287 // Try to resolve the target of a call, tail call, etc. to a specific
1288 // symbol.
1289 if (MIA && (MIA->isCall(Inst) || MIA->isUnconditionalBranch(Inst) ||
1290 MIA->isConditionalBranch(Inst))) {
1291 uint64_t Target;
1292 if (MIA->evaluateBranch(Inst, SectionAddr + Index, Size, Target)) {
1293 // In a relocatable object, the target's section must reside in
1294 // the same section as the call instruction or it is accessed
1295 // through a relocation.
1296 //
1297 // In a non-relocatable object, the target may be in any section.
1298 //
1299 // N.B. We don't walk the relocations in the relocatable case yet.
1300 auto *TargetSectionSymbols = &Symbols;
1301 if (!Obj->isRelocatableObject()) {
Fangrui Song545ed222019-04-07 05:32:16 +00001302 auto SectionAddress = llvm::upper_bound(
1303 SectionAddresses, Target,
1304 [](uint64_t LHS, const std::pair<uint64_t, SectionRef> &RHS) {
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001305 return LHS < RHS.first;
1306 });
1307 if (SectionAddress != SectionAddresses.begin()) {
1308 --SectionAddress;
1309 TargetSectionSymbols = &AllSymbols[SectionAddress->second];
1310 } else {
Sterling Augustinebc78b622018-06-28 18:57:13 +00001311 TargetSectionSymbols = &AbsoluteSymbols;
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001312 }
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001313 }
David Majnemer2603a8fa2015-07-09 18:11:40 +00001314
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001315 // Find the first symbol in the section whose offset is less than
Sterling Augustinebc78b622018-06-28 18:57:13 +00001316 // or equal to the target. If there isn't a section that contains
1317 // the target, find the nearest preceding absolute symbol.
Fangrui Song545ed222019-04-07 05:32:16 +00001318 auto TargetSym = llvm::upper_bound(
1319 *TargetSectionSymbols, Target,
1320 [](uint64_t LHS,
1321 const std::tuple<uint64_t, StringRef, uint8_t> &RHS) {
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001322 return LHS < std::get<0>(RHS);
Sterling Augustinebc78b622018-06-28 18:57:13 +00001323 });
1324 if (TargetSym == TargetSectionSymbols->begin()) {
1325 TargetSectionSymbols = &AbsoluteSymbols;
Fangrui Song545ed222019-04-07 05:32:16 +00001326 TargetSym = llvm::upper_bound(
1327 AbsoluteSymbols, Target,
1328 [](uint64_t LHS,
1329 const std::tuple<uint64_t, StringRef, uint8_t> &RHS) {
1330 return LHS < std::get<0>(RHS);
1331 });
Sterling Augustinebc78b622018-06-28 18:57:13 +00001332 }
1333 if (TargetSym != TargetSectionSymbols->begin()) {
1334 --TargetSym;
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001335 uint64_t TargetAddress = std::get<0>(*TargetSym);
1336 StringRef TargetName = std::get<1>(*TargetSym);
1337 outs() << " <" << TargetName;
1338 uint64_t Disp = Target - TargetAddress;
Sterling Augustinebc78b622018-06-28 18:57:13 +00001339 if (Disp)
1340 outs() << "+0x" << Twine::utohexstr(Disp);
1341 outs() << '>';
David Majnemer81afca62015-07-07 22:06:59 +00001342 }
1343 }
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001344 }
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001345 outs() << "\n";
Michael J. Spencer51862b32011-10-13 22:17:18 +00001346
Sid Manningd9f28732018-05-14 19:46:08 +00001347 // Hexagon does this in pretty printer
George Rimarfd383e72019-01-23 10:52:38 +00001348 if (Obj->getArch() != Triple::hexagon) {
Sid Manningd9f28732018-05-14 19:46:08 +00001349 // Print relocation for instruction.
George Rimar73a27232019-01-15 09:19:18 +00001350 while (RelCur != RelEnd) {
George Rimar617adef2019-01-23 13:39:12 +00001351 uint64_t Offset = RelCur->getOffset();
Sid Manningd9f28732018-05-14 19:46:08 +00001352 // If this relocation is hidden, skip it.
Fangrui Song32087b62019-04-07 16:33:24 +00001353 if (getHidden(*RelCur) || SectionAddr + Offset < StartAddress) {
George Rimar73a27232019-01-15 09:19:18 +00001354 ++RelCur;
Sid Manningd9f28732018-05-14 19:46:08 +00001355 continue;
1356 }
1357
George Rimar740974d2019-01-28 10:48:54 +00001358 // Stop when RelCur's offset is past the current instruction.
George Rimar617adef2019-01-23 13:39:12 +00001359 if (Offset >= Index + Size)
George Rimar73a27232019-01-15 09:19:18 +00001360 break;
George Rimar617adef2019-01-23 13:39:12 +00001361
George Rimar4c3b2972019-01-28 10:44:01 +00001362 // When --adjust-vma is used, update the address printed.
1363 if (RelCur->getSymbol() != Obj->symbol_end()) {
1364 Expected<section_iterator> SymSI =
1365 RelCur->getSymbol()->getSection();
1366 if (SymSI && *SymSI != Obj->section_end() &&
Fangrui Song32087b62019-04-07 16:33:24 +00001367 shouldAdjustVA(**SymSI))
George Rimar4c3b2972019-01-28 10:44:01 +00001368 Offset += AdjustVMA;
1369 }
1370
George Rimar617adef2019-01-23 13:39:12 +00001371 printRelocation(*RelCur, SectionAddr + Offset,
1372 Obj->getBytesInAddress());
George Rimar73a27232019-01-15 09:19:18 +00001373 ++RelCur;
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001374 }
George Rimarfd383e72019-01-23 10:52:38 +00001375 }
Fangrui Song32087b62019-04-07 16:33:24 +00001376
1377 Index += Size;
Benjamin Kramer87ee76c2011-07-20 19:37:35 +00001378 }
Michael J. Spencer2670c252011-01-20 06:39:06 +00001379 }
1380 }
1381}
1382
George Rimarbcbe98b2019-01-23 10:33:26 +00001383static void disassembleObject(const ObjectFile *Obj, bool InlineRelocs) {
1384 if (StartAddress > StopAddress)
1385 error("Start address should be less than stop address");
1386
1387 const Target *TheTarget = getTarget(Obj);
1388
1389 // Package up features to be passed to target/subtarget
1390 SubtargetFeatures Features = Obj->getFeatures();
1391 if (!MAttrs.empty())
1392 for (unsigned I = 0; I != MAttrs.size(); ++I)
1393 Features.AddFeature(MAttrs[I]);
1394
1395 std::unique_ptr<const MCRegisterInfo> MRI(
1396 TheTarget->createMCRegInfo(TripleName));
1397 if (!MRI)
1398 report_error(Obj->getFileName(),
1399 "no register info for target " + TripleName);
1400
1401 // Set up disassembler.
1402 std::unique_ptr<const MCAsmInfo> AsmInfo(
1403 TheTarget->createMCAsmInfo(*MRI, TripleName));
1404 if (!AsmInfo)
1405 report_error(Obj->getFileName(),
1406 "no assembly info for target " + TripleName);
1407 std::unique_ptr<const MCSubtargetInfo> STI(
1408 TheTarget->createMCSubtargetInfo(TripleName, MCPU, Features.getString()));
1409 if (!STI)
1410 report_error(Obj->getFileName(),
1411 "no subtarget info for target " + TripleName);
1412 std::unique_ptr<const MCInstrInfo> MII(TheTarget->createMCInstrInfo());
1413 if (!MII)
1414 report_error(Obj->getFileName(),
1415 "no instruction info for target " + TripleName);
1416 MCObjectFileInfo MOFI;
1417 MCContext Ctx(AsmInfo.get(), MRI.get(), &MOFI);
1418 // FIXME: for now initialize MCObjectFileInfo with default values
1419 MOFI.InitMCObjectFileInfo(Triple(TripleName), false, Ctx);
1420
1421 std::unique_ptr<MCDisassembler> DisAsm(
1422 TheTarget->createMCDisassembler(*STI, Ctx));
1423 if (!DisAsm)
1424 report_error(Obj->getFileName(),
1425 "no disassembler for target " + TripleName);
1426
1427 std::unique_ptr<const MCInstrAnalysis> MIA(
1428 TheTarget->createMCInstrAnalysis(MII.get()));
1429
1430 int AsmPrinterVariant = AsmInfo->getAssemblerDialect();
1431 std::unique_ptr<MCInstPrinter> IP(TheTarget->createMCInstPrinter(
1432 Triple(TripleName), AsmPrinterVariant, *AsmInfo, *MII, *MRI));
1433 if (!IP)
1434 report_error(Obj->getFileName(),
1435 "no instruction printer for target " + TripleName);
1436 IP->setPrintImmHex(PrintImmHex);
1437
1438 PrettyPrinter &PIP = selectPrettyPrinter(Triple(TripleName));
1439 SourcePrinter SP(Obj, TheTarget->getName());
1440
Igor Kudrin2d3faad2019-02-26 12:15:14 +00001441 for (StringRef Opt : DisassemblerOptions)
1442 if (!IP->applyTargetSpecificCLOption(Opt))
1443 error("Unrecognized disassembler option: " + Opt);
1444
George Rimarbcbe98b2019-01-23 10:33:26 +00001445 disassembleObject(TheTarget, Obj, Ctx, DisAsm.get(), MIA.get(), IP.get(),
1446 STI.get(), PIP, SP, InlineRelocs);
1447}
1448
George Rimar73a27232019-01-15 09:19:18 +00001449void llvm::printRelocations(const ObjectFile *Obj) {
Greg Fitzgerald18432272014-03-20 22:55:15 +00001450 StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64 :
1451 "%08" PRIx64;
Rafael Espindola9219fe72016-03-21 20:59:15 +00001452 // Regular objdump doesn't print relocations in non-relocatable object
1453 // files.
1454 if (!Obj->isRelocatableObject())
1455 return;
Rafael Espindolac66d7612014-08-17 19:09:37 +00001456
Colin LeMahieu77804be2015-07-29 15:45:39 +00001457 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Alexey Samsonov48803e52014-03-13 14:37:36 +00001458 if (Section.relocation_begin() == Section.relocation_end())
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001459 continue;
George Rimar73a27232019-01-15 09:19:18 +00001460 StringRef SecName;
1461 error(Section.getName(SecName));
1462 outs() << "RELOCATION RECORDS FOR [" << SecName << "]:\n";
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00001463 for (const RelocationRef &Reloc : Section.relocations()) {
George Rimar73a27232019-01-15 09:19:18 +00001464 uint64_t Address = Reloc.getOffset();
1465 SmallString<32> RelocName;
1466 SmallString<32> ValueStr;
1467 if (Address < StartAddress || Address > StopAddress || getHidden(Reloc))
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00001468 continue;
George Rimar73a27232019-01-15 09:19:18 +00001469 Reloc.getTypeName(RelocName);
1470 error(getRelocationValueString(Reloc, ValueStr));
1471 outs() << format(Fmt.data(), Address) << " " << RelocName << " "
1472 << ValueStr << "\n";
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001473 }
1474 outs() << "\n";
1475 }
1476}
1477
George Rimar73a27232019-01-15 09:19:18 +00001478void llvm::printDynamicRelocations(const ObjectFile *Obj) {
Paul Semelcb0f0432018-06-07 13:30:55 +00001479 // For the moment, this option is for ELF only
1480 if (!Obj->isELF())
1481 return;
1482
1483 const auto *Elf = dyn_cast<ELFObjectFileBase>(Obj);
Paul Semelcb0f0432018-06-07 13:30:55 +00001484 if (!Elf || Elf->getEType() != ELF::ET_DYN) {
1485 error("not a dynamic object");
1486 return;
1487 }
1488
Paul Semelcb0f0432018-06-07 13:30:55 +00001489 std::vector<SectionRef> DynRelSec = Obj->dynamic_relocation_sections();
1490 if (DynRelSec.empty())
1491 return;
1492
1493 outs() << "DYNAMIC RELOCATION RECORDS\n";
George Rimar73a27232019-01-15 09:19:18 +00001494 StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64 : "%08" PRIx64;
Paul Semelcb0f0432018-06-07 13:30:55 +00001495 for (const SectionRef &Section : DynRelSec) {
1496 if (Section.relocation_begin() == Section.relocation_end())
1497 continue;
1498 for (const RelocationRef &Reloc : Section.relocations()) {
George Rimar73a27232019-01-15 09:19:18 +00001499 uint64_t Address = Reloc.getOffset();
1500 SmallString<32> RelocName;
1501 SmallString<32> ValueStr;
1502 Reloc.getTypeName(RelocName);
1503 error(getRelocationValueString(Reloc, ValueStr));
1504 outs() << format(Fmt.data(), Address) << " " << RelocName << " "
1505 << ValueStr << "\n";
Paul Semelcb0f0432018-06-07 13:30:55 +00001506 }
1507 }
1508}
1509
George Rimar87fa2e62019-01-28 14:11:35 +00001510// Returns true if we need to show LMA column when dumping section headers. We
1511// show it only when the platform is ELF and either we have at least one section
1512// whose VMA and LMA are different and/or when --show-lma flag is used.
1513static bool shouldDisplayLMA(const ObjectFile *Obj) {
1514 if (!Obj->isELF())
1515 return false;
1516 for (const SectionRef &S : ToolSectionFilter(*Obj))
1517 if (S.getAddress() != getELFSectionLMA(S))
1518 return true;
1519 return ShowLMA;
1520}
1521
George Rimar73a27232019-01-15 09:19:18 +00001522void llvm::printSectionHeaders(const ObjectFile *Obj) {
George Rimar87fa2e62019-01-28 14:11:35 +00001523 bool HasLMAColumn = shouldDisplayLMA(Obj);
1524 if (HasLMAColumn)
1525 outs() << "Sections:\n"
1526 "Idx Name Size VMA LMA "
1527 "Type\n";
1528 else
1529 outs() << "Sections:\n"
1530 "Idx Name Size VMA Type\n";
1531
Colin LeMahieu77804be2015-07-29 15:45:39 +00001532 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001533 StringRef Name;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001534 error(Section.getName(Name));
George Rimar87fa2e62019-01-28 14:11:35 +00001535 uint64_t VMA = Section.getAddress();
George Rimar4463ebe2019-01-28 16:36:12 +00001536 if (shouldAdjustVA(Section))
1537 VMA += AdjustVMA;
1538
Rafael Espindola80291272014-10-08 15:28:58 +00001539 uint64_t Size = Section.getSize();
1540 bool Text = Section.isText();
1541 bool Data = Section.isData();
1542 bool BSS = Section.isBSS();
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001543 std::string Type = (std::string(Text ? "TEXT " : "") +
Michael J. Spencer8f67d472011-10-13 20:37:20 +00001544 (Data ? "DATA " : "") + (BSS ? "BSS" : ""));
George Rimar87fa2e62019-01-28 14:11:35 +00001545
1546 if (HasLMAColumn)
1547 outs() << format("%3d %-13s %08" PRIx64 " %016" PRIx64 " %016" PRIx64
1548 " %s\n",
1549 (unsigned)Section.getIndex(), Name.str().c_str(), Size,
1550 VMA, getELFSectionLMA(Section), Type.c_str());
1551 else
1552 outs() << format("%3d %-13s %08" PRIx64 " %016" PRIx64 " %s\n",
1553 (unsigned)Section.getIndex(), Name.str().c_str(), Size,
1554 VMA, Type.c_str());
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001555 }
Xing GUO785edea2018-11-17 08:12:48 +00001556 outs() << "\n";
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001557}
1558
George Rimar73a27232019-01-15 09:19:18 +00001559void llvm::printSectionContents(const ObjectFile *Obj) {
Colin LeMahieu77804be2015-07-29 15:45:39 +00001560 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001561 StringRef Name;
1562 StringRef Contents;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001563 error(Section.getName(Name));
Rafael Espindola80291272014-10-08 15:28:58 +00001564 uint64_t BaseAddr = Section.getAddress();
David Majnemer185b5b12014-11-11 09:58:25 +00001565 uint64_t Size = Section.getSize();
1566 if (!Size)
1567 continue;
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001568
1569 outs() << "Contents of section " << Name << ":\n";
David Majnemer185b5b12014-11-11 09:58:25 +00001570 if (Section.isBSS()) {
Alexey Samsonov209095c2013-04-16 10:53:11 +00001571 outs() << format("<skipping contents of bss section at [%04" PRIx64
David Majnemer8f6b04c2014-07-14 16:20:14 +00001572 ", %04" PRIx64 ")>\n",
1573 BaseAddr, BaseAddr + Size);
Alexey Samsonov209095c2013-04-16 10:53:11 +00001574 continue;
1575 }
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001576
Davide Italianoccd53fe2015-08-05 07:18:31 +00001577 error(Section.getContents(Contents));
David Majnemer8f6b04c2014-07-14 16:20:14 +00001578
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001579 // Dump out the content as hex and printable ascii characters.
George Rimar73a27232019-01-15 09:19:18 +00001580 for (std::size_t Addr = 0, End = Contents.size(); Addr < End; Addr += 16) {
1581 outs() << format(" %04" PRIx64 " ", BaseAddr + Addr);
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001582 // Dump line of hex.
George Rimar73a27232019-01-15 09:19:18 +00001583 for (std::size_t I = 0; I < 16; ++I) {
1584 if (I != 0 && I % 4 == 0)
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001585 outs() << ' ';
George Rimar73a27232019-01-15 09:19:18 +00001586 if (Addr + I < End)
1587 outs() << hexdigit((Contents[Addr + I] >> 4) & 0xF, true)
1588 << hexdigit(Contents[Addr + I] & 0xF, true);
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001589 else
1590 outs() << " ";
1591 }
1592 // Print ascii.
1593 outs() << " ";
George Rimar73a27232019-01-15 09:19:18 +00001594 for (std::size_t I = 0; I < 16 && Addr + I < End; ++I) {
1595 if (isPrint(static_cast<unsigned char>(Contents[Addr + I]) & 0xFF))
1596 outs() << Contents[Addr + I];
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001597 else
1598 outs() << ".";
1599 }
1600 outs() << "\n";
1601 }
1602 }
1603}
1604
George Rimar73a27232019-01-15 09:19:18 +00001605void llvm::printSymbolTable(const ObjectFile *O, StringRef ArchiveName,
Kevin Enderby9acb1092016-05-31 20:35:34 +00001606 StringRef ArchitectureName) {
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001607 outs() << "SYMBOL TABLE:\n";
1608
George Rimar73a27232019-01-15 09:19:18 +00001609 if (const COFFObjectFile *Coff = dyn_cast<const COFFObjectFile>(O)) {
1610 printCOFFSymbolTable(Coff);
Rui Ueyama4e39f712014-03-18 18:58:51 +00001611 return;
1612 }
George Rimar8e0a70b2019-01-10 16:24:10 +00001613
Fangrui Songe7834bd2019-04-07 08:19:55 +00001614 const StringRef FileName = O->getFileName();
George Rimar73a27232019-01-15 09:19:18 +00001615 for (auto I = O->symbol_begin(), E = O->symbol_end(); I != E; ++I) {
George Rimar8e0a70b2019-01-10 16:24:10 +00001616 // Skip printing the special zero symbol when dumping an ELF file.
1617 // This makes the output consistent with the GNU objdump.
George Rimar73a27232019-01-15 09:19:18 +00001618 if (I == O->symbol_begin() && isa<ELFObjectFileBase>(O))
George Rimar8e0a70b2019-01-10 16:24:10 +00001619 continue;
1620
1621 const SymbolRef &Symbol = *I;
Fangrui Songe7834bd2019-04-07 08:19:55 +00001622 uint64_t Address = unwrapOrError(Symbol.getAddress(), ArchiveName, FileName,
1623 ArchitectureName);
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001624 if ((Address < StartAddress) || (Address > StopAddress))
1625 continue;
Fangrui Songe7834bd2019-04-07 08:19:55 +00001626 SymbolRef::Type Type = unwrapOrError(Symbol.getType(), ArchiveName,
1627 FileName, ArchitectureName);
Rui Ueyama4e39f712014-03-18 18:58:51 +00001628 uint32_t Flags = Symbol.getFlags();
Fangrui Songe7834bd2019-04-07 08:19:55 +00001629 section_iterator Section = unwrapOrError(Symbol.getSection(), ArchiveName,
1630 FileName, ArchitectureName);
Rafael Espindola75d5b542015-06-03 05:14:22 +00001631 StringRef Name;
Fangrui Songe7834bd2019-04-07 08:19:55 +00001632 if (Type == SymbolRef::ST_Debug && Section != O->section_end())
Rafael Espindola75d5b542015-06-03 05:14:22 +00001633 Section->getName(Name);
Fangrui Songe7834bd2019-04-07 08:19:55 +00001634 else
1635 Name = unwrapOrError(Symbol.getName(), ArchiveName, FileName,
1636 ArchitectureName);
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001637
Rui Ueyama4e39f712014-03-18 18:58:51 +00001638 bool Global = Flags & SymbolRef::SF_Global;
1639 bool Weak = Flags & SymbolRef::SF_Weak;
1640 bool Absolute = Flags & SymbolRef::SF_Absolute;
Colin LeMahieubc2f47a2015-01-23 20:06:24 +00001641 bool Common = Flags & SymbolRef::SF_Common;
Davide Italianocd2514d2015-04-30 23:08:53 +00001642 bool Hidden = Flags & SymbolRef::SF_Hidden;
David Meyer1df4b842012-02-28 23:47:53 +00001643
Rui Ueyama4e39f712014-03-18 18:58:51 +00001644 char GlobLoc = ' ';
1645 if (Type != SymbolRef::ST_Unknown)
1646 GlobLoc = Global ? 'g' : 'l';
1647 char Debug = (Type == SymbolRef::ST_Debug || Type == SymbolRef::ST_File)
1648 ? 'd' : ' ';
1649 char FileFunc = ' ';
1650 if (Type == SymbolRef::ST_File)
1651 FileFunc = 'f';
1652 else if (Type == SymbolRef::ST_Function)
1653 FileFunc = 'F';
Kristina Brooks0674f9d2018-11-11 17:47:13 +00001654 else if (Type == SymbolRef::ST_Data)
1655 FileFunc = 'O';
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001656
George Rimar73a27232019-01-15 09:19:18 +00001657 const char *Fmt = O->getBytesInAddress() > 4 ? "%016" PRIx64 :
Rui Ueyama4e39f712014-03-18 18:58:51 +00001658 "%08" PRIx64;
Michael J. Spencerd857c1c2013-01-10 22:40:50 +00001659
Rui Ueyama4e39f712014-03-18 18:58:51 +00001660 outs() << format(Fmt, Address) << " "
1661 << GlobLoc // Local -> 'l', Global -> 'g', Neither -> ' '
1662 << (Weak ? 'w' : ' ') // Weak?
1663 << ' ' // Constructor. Not supported yet.
1664 << ' ' // Warning. Not supported yet.
1665 << ' ' // Indirect reference to another symbol.
1666 << Debug // Debugging (d) or dynamic (D) symbol.
1667 << FileFunc // Name of function (F), file (f) or object (O).
1668 << ' ';
1669 if (Absolute) {
1670 outs() << "*ABS*";
Colin LeMahieubc2f47a2015-01-23 20:06:24 +00001671 } else if (Common) {
1672 outs() << "*COM*";
George Rimar73a27232019-01-15 09:19:18 +00001673 } else if (Section == O->section_end()) {
Rui Ueyama4e39f712014-03-18 18:58:51 +00001674 outs() << "*UND*";
1675 } else {
1676 if (const MachOObjectFile *MachO =
George Rimar73a27232019-01-15 09:19:18 +00001677 dyn_cast<const MachOObjectFile>(O)) {
Rui Ueyama4e39f712014-03-18 18:58:51 +00001678 DataRefImpl DR = Section->getRawDataRefImpl();
1679 StringRef SegmentName = MachO->getSectionFinalSegmentName(DR);
1680 outs() << SegmentName << ",";
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001681 }
Rui Ueyama4e39f712014-03-18 18:58:51 +00001682 StringRef SectionName;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001683 error(Section->getName(SectionName));
Rui Ueyama4e39f712014-03-18 18:58:51 +00001684 outs() << SectionName;
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001685 }
Rafael Espindola5f7ade22015-06-23 15:45:38 +00001686
1687 outs() << '\t';
George Rimar73a27232019-01-15 09:19:18 +00001688 if (Common || isa<ELFObjectFileBase>(O)) {
Rafael Espindoladbb6bd32015-06-25 22:10:04 +00001689 uint64_t Val =
1690 Common ? Symbol.getAlignment() : ELFSymbolRef(Symbol).getSize();
Rafael Espindolaae3ac082015-06-23 18:34:25 +00001691 outs() << format("\t %08" PRIx64 " ", Val);
1692 }
Rafael Espindola5f7ade22015-06-23 15:45:38 +00001693
George Rimar73a27232019-01-15 09:19:18 +00001694 if (Hidden)
Davide Italianocd2514d2015-04-30 23:08:53 +00001695 outs() << ".hidden ";
George Rimar6622d412018-12-19 10:21:45 +00001696
1697 if (Demangle)
1698 outs() << demangle(Name) << '\n';
1699 else
1700 outs() << Name << '\n';
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001701 }
1702}
1703
George Rimar73a27232019-01-15 09:19:18 +00001704static void printUnwindInfo(const ObjectFile *O) {
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001705 outs() << "Unwind info:\n\n";
1706
George Rimar73a27232019-01-15 09:19:18 +00001707 if (const COFFObjectFile *Coff = dyn_cast<COFFObjectFile>(O))
1708 printCOFFUnwindInfo(Coff);
1709 else if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(O))
Tim Northover4bd286a2014-08-01 13:07:19 +00001710 printMachOUnwindInfo(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001711 else
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001712 // TODO: Extract DWARF dump tool to objdump.
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001713 WithColor::error(errs(), ToolName)
1714 << "This operation is only currently supported "
1715 "for COFF and MachO object files.\n";
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001716}
1717
Kevin Enderbye2297dd2015-01-07 21:02:18 +00001718void llvm::printExportsTrie(const ObjectFile *o) {
Nick Kledzikd04bc352014-08-30 00:20:14 +00001719 outs() << "Exports trie:\n";
1720 if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
1721 printMachOExportsTrie(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001722 else
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001723 WithColor::error(errs(), ToolName)
1724 << "This operation is only currently supported "
1725 "for Mach-O executable files.\n";
Nick Kledzikd04bc352014-08-30 00:20:14 +00001726}
1727
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001728void llvm::printRebaseTable(ObjectFile *o) {
Nick Kledzikac431442014-09-12 21:34:15 +00001729 outs() << "Rebase table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001730 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzikac431442014-09-12 21:34:15 +00001731 printMachORebaseTable(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001732 else
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001733 WithColor::error(errs(), ToolName)
1734 << "This operation is only currently supported "
1735 "for Mach-O executable files.\n";
Nick Kledzikac431442014-09-12 21:34:15 +00001736}
1737
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001738void llvm::printBindTable(ObjectFile *o) {
Nick Kledzik56ebef42014-09-16 01:41:51 +00001739 outs() << "Bind table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001740 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzik56ebef42014-09-16 01:41:51 +00001741 printMachOBindTable(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001742 else
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001743 WithColor::error(errs(), ToolName)
1744 << "This operation is only currently supported "
1745 "for Mach-O executable files.\n";
Nick Kledzik56ebef42014-09-16 01:41:51 +00001746}
1747
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001748void llvm::printLazyBindTable(ObjectFile *o) {
Nick Kledzik56ebef42014-09-16 01:41:51 +00001749 outs() << "Lazy bind table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001750 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzik56ebef42014-09-16 01:41:51 +00001751 printMachOLazyBindTable(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001752 else
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001753 WithColor::error(errs(), ToolName)
1754 << "This operation is only currently supported "
1755 "for Mach-O executable files.\n";
Nick Kledzik56ebef42014-09-16 01:41:51 +00001756}
1757
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001758void llvm::printWeakBindTable(ObjectFile *o) {
Nick Kledzik56ebef42014-09-16 01:41:51 +00001759 outs() << "Weak bind table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001760 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzik56ebef42014-09-16 01:41:51 +00001761 printMachOWeakBindTable(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001762 else
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001763 WithColor::error(errs(), ToolName)
1764 << "This operation is only currently supported "
1765 "for Mach-O executable files.\n";
Nick Kledzik56ebef42014-09-16 01:41:51 +00001766}
Nick Kledzikac431442014-09-12 21:34:15 +00001767
Adrian Prantl437105a2015-07-08 02:04:15 +00001768/// Dump the raw contents of the __clangast section so the output can be piped
1769/// into llvm-bcanalyzer.
1770void llvm::printRawClangAST(const ObjectFile *Obj) {
1771 if (outs().is_displayed()) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001772 WithColor::error(errs(), ToolName)
1773 << "The -raw-clang-ast option will dump the raw binary contents of "
1774 "the clang ast section.\n"
1775 "Please redirect the output to a file or another program such as "
1776 "llvm-bcanalyzer.\n";
Adrian Prantl437105a2015-07-08 02:04:15 +00001777 return;
1778 }
1779
1780 StringRef ClangASTSectionName("__clangast");
1781 if (isa<COFFObjectFile>(Obj)) {
1782 ClangASTSectionName = "clangast";
1783 }
1784
1785 Optional<object::SectionRef> ClangASTSection;
Colin LeMahieu77804be2015-07-29 15:45:39 +00001786 for (auto Sec : ToolSectionFilter(*Obj)) {
Adrian Prantl437105a2015-07-08 02:04:15 +00001787 StringRef Name;
1788 Sec.getName(Name);
1789 if (Name == ClangASTSectionName) {
1790 ClangASTSection = Sec;
1791 break;
1792 }
1793 }
1794 if (!ClangASTSection)
1795 return;
1796
1797 StringRef ClangASTContents;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001798 error(ClangASTSection.getValue().getContents(ClangASTContents));
Adrian Prantl437105a2015-07-08 02:04:15 +00001799 outs().write(ClangASTContents.data(), ClangASTContents.size());
1800}
1801
Sanjoy Das6f567a42015-06-22 18:03:02 +00001802static void printFaultMaps(const ObjectFile *Obj) {
George Rimar73a27232019-01-15 09:19:18 +00001803 StringRef FaultMapSectionName;
Sanjoy Das6f567a42015-06-22 18:03:02 +00001804
1805 if (isa<ELFObjectFileBase>(Obj)) {
1806 FaultMapSectionName = ".llvm_faultmaps";
1807 } else if (isa<MachOObjectFile>(Obj)) {
1808 FaultMapSectionName = "__llvm_faultmaps";
1809 } else {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001810 WithColor::error(errs(), ToolName)
1811 << "This operation is only currently supported "
1812 "for ELF and Mach-O executable files.\n";
Sanjoy Das6f567a42015-06-22 18:03:02 +00001813 return;
1814 }
1815
1816 Optional<object::SectionRef> FaultMapSection;
1817
Colin LeMahieu77804be2015-07-29 15:45:39 +00001818 for (auto Sec : ToolSectionFilter(*Obj)) {
Sanjoy Das6f567a42015-06-22 18:03:02 +00001819 StringRef Name;
1820 Sec.getName(Name);
1821 if (Name == FaultMapSectionName) {
1822 FaultMapSection = Sec;
1823 break;
1824 }
1825 }
1826
1827 outs() << "FaultMap table:\n";
1828
1829 if (!FaultMapSection.hasValue()) {
1830 outs() << "<not found>\n";
1831 return;
1832 }
1833
1834 StringRef FaultMapContents;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001835 error(FaultMapSection.getValue().getContents(FaultMapContents));
Sanjoy Das6f567a42015-06-22 18:03:02 +00001836
1837 FaultMapParser FMP(FaultMapContents.bytes_begin(),
1838 FaultMapContents.bytes_end());
1839
1840 outs() << FMP;
1841}
1842
George Rimar73a27232019-01-15 09:19:18 +00001843static void printPrivateFileHeaders(const ObjectFile *O, bool OnlyFirst) {
1844 if (O->isELF()) {
1845 printELFFileHeader(O);
Xing GUO56d651d2019-02-25 13:13:19 +00001846 printELFDynamicSection(O);
1847 printELFSymbolVersionInfo(O);
1848 return;
Paul Semel0913dcd2018-07-25 11:09:20 +00001849 }
George Rimar73a27232019-01-15 09:19:18 +00001850 if (O->isCOFF())
1851 return printCOFFFileHeader(O);
1852 if (O->isWasm())
1853 return printWasmFileHeader(O);
1854 if (O->isMachO()) {
1855 printMachOFileHeader(O);
1856 if (!OnlyFirst)
1857 printMachOLoadCommands(O);
Davide Italiano1bdaa202016-09-18 04:39:15 +00001858 return;
1859 }
George Rimar73a27232019-01-15 09:19:18 +00001860 report_error(O->getFileName(), "Invalid/Unsupported object file format");
Rui Ueyamac2bed422013-09-27 21:04:00 +00001861}
1862
George Rimar73a27232019-01-15 09:19:18 +00001863static void printFileHeaders(const ObjectFile *O) {
1864 if (!O->isELF() && !O->isCOFF())
1865 report_error(O->getFileName(), "Invalid/Unsupported object file format");
Paul Semeld2af4d62018-07-04 15:25:03 +00001866
George Rimar73a27232019-01-15 09:19:18 +00001867 Triple::ArchType AT = O->getArch();
Paul Semeld2af4d62018-07-04 15:25:03 +00001868 outs() << "architecture: " << Triple::getArchTypeName(AT) << "\n";
Fangrui Songe7834bd2019-04-07 08:19:55 +00001869 uint64_t Address = unwrapOrError(O->getStartAddress(), O->getFileName());
Petar Jovanovic8d947ba2018-10-19 22:16:49 +00001870
George Rimar73a27232019-01-15 09:19:18 +00001871 StringRef Fmt = O->getBytesInAddress() > 4 ? "%016" PRIx64 : "%08" PRIx64;
Paul Semeld2af4d62018-07-04 15:25:03 +00001872 outs() << "start address: "
George Rimar9b6fe7e2019-01-12 12:17:24 +00001873 << "0x" << format(Fmt.data(), Address) << "\n\n";
Paul Semeld2af4d62018-07-04 15:25:03 +00001874}
1875
Paul Semel0dc92f62018-07-05 14:43:29 +00001876static void printArchiveChild(StringRef Filename, const Archive::Child &C) {
1877 Expected<sys::fs::perms> ModeOrErr = C.getAccessMode();
1878 if (!ModeOrErr) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001879 WithColor::error(errs(), ToolName) << "ill-formed archive entry.\n";
Paul Semel0dc92f62018-07-05 14:43:29 +00001880 consumeError(ModeOrErr.takeError());
1881 return;
1882 }
1883 sys::fs::perms Mode = ModeOrErr.get();
1884 outs() << ((Mode & sys::fs::owner_read) ? "r" : "-");
1885 outs() << ((Mode & sys::fs::owner_write) ? "w" : "-");
1886 outs() << ((Mode & sys::fs::owner_exe) ? "x" : "-");
1887 outs() << ((Mode & sys::fs::group_read) ? "r" : "-");
1888 outs() << ((Mode & sys::fs::group_write) ? "w" : "-");
1889 outs() << ((Mode & sys::fs::group_exe) ? "x" : "-");
1890 outs() << ((Mode & sys::fs::others_read) ? "r" : "-");
1891 outs() << ((Mode & sys::fs::others_write) ? "w" : "-");
1892 outs() << ((Mode & sys::fs::others_exe) ? "x" : "-");
1893
1894 outs() << " ";
1895
Fangrui Songe7834bd2019-04-07 08:19:55 +00001896 outs() << format("%d/%d %6" PRId64 " ", unwrapOrError(C.getUID(), Filename),
1897 unwrapOrError(C.getGID(), Filename),
1898 unwrapOrError(C.getRawSize(), Filename));
Paul Semel0dc92f62018-07-05 14:43:29 +00001899
1900 StringRef RawLastModified = C.getRawLastModified();
1901 unsigned Seconds;
1902 if (RawLastModified.getAsInteger(10, Seconds))
1903 outs() << "(date: \"" << RawLastModified
1904 << "\" contains non-decimal chars) ";
1905 else {
1906 // Since ctime(3) returns a 26 character string of the form:
1907 // "Sun Sep 16 01:03:52 1973\n\0"
1908 // just print 24 characters.
1909 time_t t = Seconds;
1910 outs() << format("%.24s ", ctime(&t));
1911 }
1912
1913 StringRef Name = "";
1914 Expected<StringRef> NameOrErr = C.getName();
1915 if (!NameOrErr) {
1916 consumeError(NameOrErr.takeError());
Fangrui Songe7834bd2019-04-07 08:19:55 +00001917 Name = unwrapOrError(C.getRawName(), Filename);
Paul Semel0dc92f62018-07-05 14:43:29 +00001918 } else {
1919 Name = NameOrErr.get();
1920 }
1921 outs() << Name << "\n";
1922}
1923
George Rimar73a27232019-01-15 09:19:18 +00001924static void dumpObject(ObjectFile *O, const Archive *A = nullptr,
1925 const Archive::Child *C = nullptr) {
Adrian Prantl437105a2015-07-08 02:04:15 +00001926 // Avoid other output when using a raw option.
1927 if (!RawClangAST) {
1928 outs() << '\n';
George Rimar73a27232019-01-15 09:19:18 +00001929 if (A)
1930 outs() << A->getFileName() << "(" << O->getFileName() << ")";
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001931 else
George Rimar73a27232019-01-15 09:19:18 +00001932 outs() << O->getFileName();
1933 outs() << ":\tfile format " << O->getFileFormatName() << "\n\n";
Adrian Prantl437105a2015-07-08 02:04:15 +00001934 }
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001935
George Rimar73a27232019-01-15 09:19:18 +00001936 StringRef ArchiveName = A ? A->getFileName() : "";
George Rimar9b6fe7e2019-01-12 12:17:24 +00001937 if (FileHeaders)
George Rimar73a27232019-01-15 09:19:18 +00001938 printFileHeaders(O);
1939 if (ArchiveHeaders && !MachOOpt && C)
1940 printArchiveChild(ArchiveName, *C);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001941 if (Disassemble)
George Rimar73a27232019-01-15 09:19:18 +00001942 disassembleObject(O, Relocations);
Michael J. Spencer51862b32011-10-13 22:17:18 +00001943 if (Relocations && !Disassemble)
George Rimar73a27232019-01-15 09:19:18 +00001944 printRelocations(O);
Paul Semelcb0f0432018-06-07 13:30:55 +00001945 if (DynamicRelocations)
George Rimar73a27232019-01-15 09:19:18 +00001946 printDynamicRelocations(O);
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001947 if (SectionHeaders)
George Rimar73a27232019-01-15 09:19:18 +00001948 printSectionHeaders(O);
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001949 if (SectionContents)
George Rimar73a27232019-01-15 09:19:18 +00001950 printSectionContents(O);
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001951 if (SymbolTable)
George Rimar73a27232019-01-15 09:19:18 +00001952 printSymbolTable(O, ArchiveName);
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001953 if (UnwindInfo)
George Rimar73a27232019-01-15 09:19:18 +00001954 printUnwindInfo(O);
Davide Italiano1bdaa202016-09-18 04:39:15 +00001955 if (PrivateHeaders || FirstPrivateHeader)
George Rimar73a27232019-01-15 09:19:18 +00001956 printPrivateFileHeaders(O, FirstPrivateHeader);
Nick Kledzikd04bc352014-08-30 00:20:14 +00001957 if (ExportsTrie)
George Rimar73a27232019-01-15 09:19:18 +00001958 printExportsTrie(O);
Nick Kledzikac431442014-09-12 21:34:15 +00001959 if (Rebase)
George Rimar73a27232019-01-15 09:19:18 +00001960 printRebaseTable(O);
Nick Kledzik56ebef42014-09-16 01:41:51 +00001961 if (Bind)
George Rimar73a27232019-01-15 09:19:18 +00001962 printBindTable(O);
Nick Kledzik56ebef42014-09-16 01:41:51 +00001963 if (LazyBind)
George Rimar73a27232019-01-15 09:19:18 +00001964 printLazyBindTable(O);
Nick Kledzik56ebef42014-09-16 01:41:51 +00001965 if (WeakBind)
George Rimar73a27232019-01-15 09:19:18 +00001966 printWeakBindTable(O);
Adrian Prantl437105a2015-07-08 02:04:15 +00001967 if (RawClangAST)
George Rimar73a27232019-01-15 09:19:18 +00001968 printRawClangAST(O);
Sanjoy Das6f567a42015-06-22 18:03:02 +00001969 if (PrintFaultMaps)
George Rimar73a27232019-01-15 09:19:18 +00001970 printFaultMaps(O);
Igor Laevsky03a670c2016-01-26 15:09:42 +00001971 if (DwarfDumpType != DIDT_Null) {
George Rimar73a27232019-01-15 09:19:18 +00001972 std::unique_ptr<DIContext> DICtx = DWARFContext::create(*O);
Igor Laevsky03a670c2016-01-26 15:09:42 +00001973 // Dump the complete DWARF structure.
Adrian Prantlf4bc1f72017-06-01 18:18:23 +00001974 DIDumpOptions DumpOpts;
1975 DumpOpts.DumpType = DwarfDumpType;
Adrian Prantlf4bc1f72017-06-01 18:18:23 +00001976 DICtx->dump(outs(), DumpOpts);
Igor Laevsky03a670c2016-01-26 15:09:42 +00001977 }
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001978}
1979
George Rimar73a27232019-01-15 09:19:18 +00001980static void dumpObject(const COFFImportFile *I, const Archive *A,
Paul Semel0dc92f62018-07-05 14:43:29 +00001981 const Archive::Child *C = nullptr) {
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +00001982 StringRef ArchiveName = A ? A->getFileName() : "";
1983
1984 // Avoid other output when using a raw option.
1985 if (!RawClangAST)
1986 outs() << '\n'
1987 << ArchiveName << "(" << I->getFileName() << ")"
1988 << ":\tfile format COFF-import-file"
1989 << "\n\n";
1990
James Hendersonc1608c92018-10-29 14:17:08 +00001991 if (ArchiveHeaders && !MachOOpt && C)
1992 printArchiveChild(ArchiveName, *C);
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +00001993 if (SymbolTable)
1994 printCOFFSymbolTable(I);
1995}
1996
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +00001997/// Dump each object file in \a a;
George Rimar73a27232019-01-15 09:19:18 +00001998static void dumpArchive(const Archive *A) {
Mehdi Amini41af4302016-11-11 04:28:40 +00001999 Error Err = Error::success();
George Rimar73a27232019-01-15 09:19:18 +00002000 for (auto &C : A->children(Err)) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +00002001 Expected<std::unique_ptr<Binary>> ChildOrErr = C.getAsBinary();
2002 if (!ChildOrErr) {
2003 if (auto E = isNotObjectErrorInvalidFileType(ChildOrErr.takeError()))
Fangrui Songe7834bd2019-04-07 08:19:55 +00002004 report_error(std::move(E), A->getFileName(), C);
Kevin Enderbyac9e1552016-05-17 17:10:12 +00002005 continue;
2006 }
George Rimar73a27232019-01-15 09:19:18 +00002007 if (ObjectFile *O = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
2008 dumpObject(O, A, &C);
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +00002009 else if (COFFImportFile *I = dyn_cast<COFFImportFile>(&*ChildOrErr.get()))
George Rimar73a27232019-01-15 09:19:18 +00002010 dumpObject(I, A, &C);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002011 else
Fangrui Song3f209682019-04-09 05:41:24 +00002012 report_error(errorCodeToError(object_error::invalid_file_type),
2013 A->getFileName());
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002014 }
Lang Hamesfc209622016-07-14 02:24:01 +00002015 if (Err)
Fangrui Songe7834bd2019-04-07 08:19:55 +00002016 report_error(std::move(Err), A->getFileName());
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002017}
2018
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +00002019/// Open file and figure out how to dump it.
George Rimar73a27232019-01-15 09:19:18 +00002020static void dumpInput(StringRef file) {
Kevin Enderbye2297dd2015-01-07 21:02:18 +00002021 // If we are using the Mach-O specific object file parser, then let it parse
2022 // the file and process the command line options. So the -arch flags can
2023 // be used to select specific slices, etc.
2024 if (MachOOpt) {
George Rimar73a27232019-01-15 09:19:18 +00002025 parseInputMachO(file);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002026 return;
2027 }
2028
2029 // Attempt to open the binary.
Fangrui Songe7834bd2019-04-07 08:19:55 +00002030 OwningBinary<Binary> OBinary = unwrapOrError(createBinary(file), file);
2031 Binary &Binary = *OBinary.getBinary();
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002032
George Rimar73a27232019-01-15 09:19:18 +00002033 if (Archive *A = dyn_cast<Archive>(&Binary))
2034 dumpArchive(A);
2035 else if (ObjectFile *O = dyn_cast<ObjectFile>(&Binary))
2036 dumpObject(O);
Dave Lee3fb120f2018-08-03 00:06:38 +00002037 else if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(&Binary))
George Rimar73a27232019-01-15 09:19:18 +00002038 parseInputMachO(UB);
Jim Grosbachaf9aec02012-08-07 17:53:14 +00002039 else
Fangrui Song3f209682019-04-09 05:41:24 +00002040 report_error(errorCodeToError(object_error::invalid_file_type), file);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002041}
2042
Michael J. Spencer2670c252011-01-20 06:39:06 +00002043int main(int argc, char **argv) {
Rui Ueyama197194b2018-04-13 18:26:06 +00002044 InitLLVM X(argc, argv);
Michael J. Spencer2670c252011-01-20 06:39:06 +00002045
2046 // Initialize targets and assembly printers/parsers.
2047 llvm::InitializeAllTargetInfos();
Evan Cheng8c886a42011-07-22 21:58:54 +00002048 llvm::InitializeAllTargetMCs();
Michael J. Spencer2670c252011-01-20 06:39:06 +00002049 llvm::InitializeAllDisassemblers();
2050
Pete Cooper28fb4fc2012-05-03 23:20:10 +00002051 // Register the target printer for --version.
2052 cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
2053
Michael J. Spencer2670c252011-01-20 06:39:06 +00002054 cl::ParseCommandLineOptions(argc, argv, "llvm object file dumper\n");
Michael J. Spencer2670c252011-01-20 06:39:06 +00002055
2056 ToolName = argv[0];
2057
2058 // Defaults to a.out if no filenames specified.
Jordan Rupprecht16a0de22018-12-20 00:57:06 +00002059 if (InputFilenames.empty())
Michael J. Spencer2670c252011-01-20 06:39:06 +00002060 InputFilenames.push_back("a.out");
2061
Fangrui Song8513cd42018-06-27 20:45:11 +00002062 if (AllHeaders)
George Rimar5e364332019-01-18 12:01:59 +00002063 ArchiveHeaders = FileHeaders = PrivateHeaders = Relocations =
2064 SectionHeaders = SymbolTable = true;
Fangrui Song8513cd42018-06-27 20:45:11 +00002065
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +00002066 if (DisassembleAll || PrintSource || PrintLines)
Colin LeMahieuf34933e2015-07-23 20:58:49 +00002067 Disassemble = true;
Paul Semel007dedb2018-07-18 16:39:21 +00002068
Michael J. Spencerbfa06782011-10-18 19:32:17 +00002069 if (!Disassemble
2070 && !Relocations
Paul Semelcb0f0432018-06-07 13:30:55 +00002071 && !DynamicRelocations
Michael J. Spencerbfa06782011-10-18 19:32:17 +00002072 && !SectionHeaders
2073 && !SectionContents
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00002074 && !SymbolTable
Michael J. Spencer209565db2013-01-06 03:56:49 +00002075 && !UnwindInfo
Nick Kledzikd04bc352014-08-30 00:20:14 +00002076 && !PrivateHeaders
Paul Semeld2af4d62018-07-04 15:25:03 +00002077 && !FileHeaders
Kevin Enderby0ae163f2016-01-13 00:25:36 +00002078 && !FirstPrivateHeader
Nick Kledzikac431442014-09-12 21:34:15 +00002079 && !ExportsTrie
Nick Kledzik56ebef42014-09-16 01:41:51 +00002080 && !Rebase
2081 && !Bind
2082 && !LazyBind
Kevin Enderby131d1772015-01-09 19:22:37 +00002083 && !WeakBind
Adrian Prantl437105a2015-07-08 02:04:15 +00002084 && !RawClangAST
Kevin Enderby13023a12015-01-15 23:19:11 +00002085 && !(UniversalHeaders && MachOOpt)
Paul Semel0dc92f62018-07-05 14:43:29 +00002086 && !ArchiveHeaders
Kevin Enderby69fe98d2015-01-23 18:52:17 +00002087 && !(IndirectSymbols && MachOOpt)
Kevin Enderby9a509442015-01-27 21:28:24 +00002088 && !(DataInCode && MachOOpt)
Kevin Enderbyf6d25852015-01-31 00:37:11 +00002089 && !(LinkOptHints && MachOOpt)
Kevin Enderbycd66be52015-03-11 22:06:32 +00002090 && !(InfoPlist && MachOOpt)
Kevin Enderbybc847fa2015-03-16 20:08:09 +00002091 && !(DylibsUsed && MachOOpt)
2092 && !(DylibId && MachOOpt)
Kevin Enderby0fc11822015-04-01 20:57:01 +00002093 && !(ObjcMetaData && MachOOpt)
Jordan Rupprecht16a0de22018-12-20 00:57:06 +00002094 && !(!FilterSections.empty() && MachOOpt)
Igor Laevsky03a670c2016-01-26 15:09:42 +00002095 && !PrintFaultMaps
2096 && DwarfDumpType == DIDT_Null) {
Michael J. Spencer2670c252011-01-20 06:39:06 +00002097 cl::PrintHelpMessage();
Dimitry Andrice4f5d012017-12-18 19:46:56 +00002098 return 2;
2099 }
2100
Rafael Aulerb0e4b912018-03-09 19:13:44 +00002101 DisasmFuncsSet.insert(DisassembleFunctions.begin(),
2102 DisassembleFunctions.end());
2103
George Rimar73a27232019-01-15 09:19:18 +00002104 llvm::for_each(InputFilenames, dumpInput);
Dimitry Andrice4f5d012017-12-18 19:46:56 +00002105
2106 return EXIT_SUCCESS;
2107}