blob: 0722db07b6bb3b4fccedd5b5efd8b1a69182e64f [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);
Fangrui Songb688a202019-04-15 13:32:41 +0000608
609 {
610 formatted_raw_ostream FOS(OS);
611 if (!NoLeadingAddr)
612 FOS << format("%8" PRIx64 ":", Address.Address);
613 if (!NoShowRawInsn) {
614 FOS << ' ';
615 dumpBytes(Bytes, FOS);
616 }
617 FOS.flush();
618 // The output of printInst starts with a tab. Print some spaces so that
619 // the tab has 1 column and advances to the target tab stop.
620 unsigned TabStop = NoShowRawInsn ? 16 : 40;
621 unsigned Column = FOS.getColumn();
622 FOS.indent(Column < TabStop - 1 ? TabStop - 1 - Column : 7 - Column % 8);
623
624 // The dtor calls flush() to ensure the indent comes before printInst().
Sid Manningd9f28732018-05-14 19:46:08 +0000625 }
Fangrui Songb688a202019-04-15 13:32:41 +0000626
Sid Manningd9f28732018-05-14 19:46:08 +0000627 if (MI)
628 IP.printInst(MI, OS, "", STI);
629 else
Fangrui Song7d4ad142019-04-10 05:31:21 +0000630 OS << "\t<unknown>";
Sid Manningd9f28732018-05-14 19:46:08 +0000631 }
632};
633PrettyPrinter PrettyPrinterInst;
634class HexagonPrettyPrinter : public PrettyPrinter {
635public:
636 void printLead(ArrayRef<uint8_t> Bytes, uint64_t Address,
637 raw_ostream &OS) {
638 uint32_t opcode =
639 (Bytes[3] << 24) | (Bytes[2] << 16) | (Bytes[1] << 8) | Bytes[0];
640 if (!NoLeadingAddr)
641 OS << format("%8" PRIx64 ":", Address);
642 if (!NoShowRawInsn) {
643 OS << "\t";
644 dumpBytes(Bytes.slice(0, 4), OS);
Fangrui Song7d4ad142019-04-10 05:31:21 +0000645 OS << format("\t%08" PRIx32, opcode);
Sid Manningd9f28732018-05-14 19:46:08 +0000646 }
647 }
648 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000649 object::SectionedAddress Address, raw_ostream &OS,
650 StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP,
Sid Manningd9f28732018-05-14 19:46:08 +0000651 std::vector<RelocationRef> *Rels) override {
652 if (SP && (PrintSource || PrintLines))
653 SP->printSourceLine(OS, Address, "");
654 if (!MI) {
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000655 printLead(Bytes, Address.Address, OS);
Sid Manningd9f28732018-05-14 19:46:08 +0000656 OS << " <unknown>";
657 return;
658 }
659 std::string Buffer;
660 {
661 raw_string_ostream TempStream(Buffer);
662 IP.printInst(MI, TempStream, "", STI);
663 }
664 StringRef Contents(Buffer);
665 // Split off bundle attributes
666 auto PacketBundle = Contents.rsplit('\n');
667 // Split off first instruction from the rest
668 auto HeadTail = PacketBundle.first.split('\n');
669 auto Preamble = " { ";
670 auto Separator = "";
Sid Manningd9f28732018-05-14 19:46:08 +0000671
672 // Hexagon's packets require relocations to be inline rather than
673 // clustered at the end of the packet.
George Rimar617adef2019-01-23 13:39:12 +0000674 std::vector<RelocationRef>::const_iterator RelCur = Rels->begin();
675 std::vector<RelocationRef>::const_iterator RelEnd = Rels->end();
Sid Manningd9f28732018-05-14 19:46:08 +0000676 auto PrintReloc = [&]() -> void {
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000677 while ((RelCur != RelEnd) && (RelCur->getOffset() <= Address.Address)) {
678 if (RelCur->getOffset() == Address.Address) {
679 printRelocation(*RelCur, Address.Address, 4);
Sid Manningd9f28732018-05-14 19:46:08 +0000680 return;
681 }
George Rimar73a27232019-01-15 09:19:18 +0000682 ++RelCur;
Sid Manningd9f28732018-05-14 19:46:08 +0000683 }
684 };
685
George Rimar73a27232019-01-15 09:19:18 +0000686 while (!HeadTail.first.empty()) {
Sid Manningd9f28732018-05-14 19:46:08 +0000687 OS << Separator;
688 Separator = "\n";
689 if (SP && (PrintSource || PrintLines))
690 SP->printSourceLine(OS, Address, "");
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000691 printLead(Bytes, Address.Address, OS);
Sid Manningd9f28732018-05-14 19:46:08 +0000692 OS << Preamble;
693 Preamble = " ";
694 StringRef Inst;
695 auto Duplex = HeadTail.first.split('\v');
George Rimar73a27232019-01-15 09:19:18 +0000696 if (!Duplex.second.empty()) {
Sid Manningd9f28732018-05-14 19:46:08 +0000697 OS << Duplex.first;
698 OS << "; ";
699 Inst = Duplex.second;
700 }
701 else
702 Inst = HeadTail.first;
703 OS << Inst;
704 HeadTail = HeadTail.second.split('\n');
705 if (HeadTail.first.empty())
706 OS << " } " << PacketBundle.second;
707 PrintReloc();
708 Bytes = Bytes.slice(4);
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000709 Address.Address += 4;
Sid Manningd9f28732018-05-14 19:46:08 +0000710 }
711 }
712};
713HexagonPrettyPrinter HexagonPrettyPrinterInst;
714
715class AMDGCNPrettyPrinter : public PrettyPrinter {
716public:
717 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000718 object::SectionedAddress Address, raw_ostream &OS,
719 StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP,
Sid Manningd9f28732018-05-14 19:46:08 +0000720 std::vector<RelocationRef> *Rels) override {
721 if (SP && (PrintSource || PrintLines))
722 SP->printSourceLine(OS, Address);
723
724 typedef support::ulittle32_t U32;
725
726 if (MI) {
727 SmallString<40> InstStr;
728 raw_svector_ostream IS(InstStr);
729
730 IP.printInst(MI, IS, "", STI);
731
732 OS << left_justify(IS.str(), 60);
733 } else {
734 // an unrecognized encoding - this is probably data so represent it
735 // using the .long directive, or .byte directive if fewer than 4 bytes
736 // remaining
737 if (Bytes.size() >= 4) {
738 OS << format("\t.long 0x%08" PRIx32 " ",
739 static_cast<uint32_t>(*reinterpret_cast<const U32*>(Bytes.data())));
740 OS.indent(42);
741 } else {
742 OS << format("\t.byte 0x%02" PRIx8, Bytes[0]);
743 for (unsigned int i = 1; i < Bytes.size(); i++)
744 OS << format(", 0x%02" PRIx8, Bytes[i]);
745 OS.indent(55 - (6 * Bytes.size()));
746 }
747 }
748
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000749 OS << format("// %012" PRIX64 ": ", Address.Address);
Sid Manningd9f28732018-05-14 19:46:08 +0000750 if (Bytes.size() >=4) {
751 for (auto D : makeArrayRef(reinterpret_cast<const U32*>(Bytes.data()),
752 Bytes.size() / sizeof(U32)))
753 // D should be explicitly casted to uint32_t here as it is passed
754 // by format to snprintf as vararg.
755 OS << format("%08" PRIX32 " ", static_cast<uint32_t>(D));
756 } else {
757 for (unsigned int i = 0; i < Bytes.size(); i++)
758 OS << format("%02" PRIX8 " ", Bytes[i]);
759 }
760
761 if (!Annot.empty())
762 OS << "// " << Annot;
763 }
764};
765AMDGCNPrettyPrinter AMDGCNPrettyPrinterInst;
766
767class BPFPrettyPrinter : public PrettyPrinter {
768public:
769 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000770 object::SectionedAddress Address, raw_ostream &OS,
771 StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP,
Sid Manningd9f28732018-05-14 19:46:08 +0000772 std::vector<RelocationRef> *Rels) override {
773 if (SP && (PrintSource || PrintLines))
774 SP->printSourceLine(OS, Address);
775 if (!NoLeadingAddr)
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000776 OS << format("%8" PRId64 ":", Address.Address / 8);
Sid Manningd9f28732018-05-14 19:46:08 +0000777 if (!NoShowRawInsn) {
778 OS << "\t";
779 dumpBytes(Bytes, OS);
780 }
781 if (MI)
782 IP.printInst(MI, OS, "", STI);
783 else
Fangrui Song7d4ad142019-04-10 05:31:21 +0000784 OS << "\t<unknown>";
Sid Manningd9f28732018-05-14 19:46:08 +0000785 }
786};
787BPFPrettyPrinter BPFPrettyPrinterInst;
788
789PrettyPrinter &selectPrettyPrinter(Triple const &Triple) {
790 switch(Triple.getArch()) {
791 default:
792 return PrettyPrinterInst;
793 case Triple::hexagon:
794 return HexagonPrettyPrinterInst;
795 case Triple::amdgcn:
796 return AMDGCNPrettyPrinterInst;
797 case Triple::bpfel:
798 case Triple::bpfeb:
799 return BPFPrettyPrinterInst;
800 }
801}
802}
803
Sam Koltonc05d7782016-08-17 10:17:57 +0000804static uint8_t getElfSymbolType(const ObjectFile *Obj, const SymbolRef &Sym) {
805 assert(Obj->isELF());
806 if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(Obj))
807 return Elf32LEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
808 if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(Obj))
809 return Elf64LEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
810 if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(Obj))
811 return Elf32BEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
812 if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(Obj))
813 return Elf64BEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
814 llvm_unreachable("Unsupported binary format");
815}
816
Sam Parker5fba45a2017-02-08 09:44:18 +0000817template <class ELFT> static void
818addDynamicElfSymbols(const ELFObjectFile<ELFT> *Obj,
819 std::map<SectionRef, SectionSymbolsTy> &AllSymbols) {
820 for (auto Symbol : Obj->getDynamicSymbolIterators()) {
821 uint8_t SymbolType = Symbol.getELFType();
822 if (SymbolType != ELF::STT_FUNC || Symbol.getSize() == 0)
823 continue;
824
Fangrui Songe7834bd2019-04-07 08:19:55 +0000825 uint64_t Address = unwrapOrError(Symbol.getAddress(), Obj->getFileName());
826 StringRef Name = unwrapOrError(Symbol.getName(), Obj->getFileName());
827 if (Name.empty())
Sam Parker5fba45a2017-02-08 09:44:18 +0000828 continue;
829
Fangrui Songe7834bd2019-04-07 08:19:55 +0000830 section_iterator SecI =
831 unwrapOrError(Symbol.getSection(), Obj->getFileName());
Sam Parker5fba45a2017-02-08 09:44:18 +0000832 if (SecI == Obj->section_end())
833 continue;
834
Fangrui Songe7834bd2019-04-07 08:19:55 +0000835 AllSymbols[*SecI].emplace_back(Address, Name, SymbolType);
Sam Parker5fba45a2017-02-08 09:44:18 +0000836 }
837}
838
839static void
840addDynamicElfSymbols(const ObjectFile *Obj,
841 std::map<SectionRef, SectionSymbolsTy> &AllSymbols) {
842 assert(Obj->isELF());
843 if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(Obj))
844 addDynamicElfSymbols(Elf32LEObj, AllSymbols);
845 else if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(Obj))
846 addDynamicElfSymbols(Elf64LEObj, AllSymbols);
847 else if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(Obj))
848 addDynamicElfSymbols(Elf32BEObj, AllSymbols);
849 else if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(Obj))
850 addDynamicElfSymbols(Elf64BEObj, AllSymbols);
851 else
852 llvm_unreachable("Unsupported binary format");
853}
854
Joel Galenson134cf472018-08-24 15:21:57 +0000855static void addPltEntries(const ObjectFile *Obj,
856 std::map<SectionRef, SectionSymbolsTy> &AllSymbols,
857 StringSaver &Saver) {
858 Optional<SectionRef> Plt = None;
859 for (const SectionRef &Section : Obj->sections()) {
860 StringRef Name;
861 if (Section.getName(Name))
862 continue;
863 if (Name == ".plt")
864 Plt = Section;
865 }
866 if (!Plt)
867 return;
868 if (auto *ElfObj = dyn_cast<ELFObjectFileBase>(Obj)) {
869 for (auto PltEntry : ElfObj->getPltAddresses()) {
870 SymbolRef Symbol(PltEntry.first, ElfObj);
Joel Galenson134cf472018-08-24 15:21:57 +0000871 uint8_t SymbolType = getElfSymbolType(Obj, Symbol);
872
Fangrui Songe7834bd2019-04-07 08:19:55 +0000873 StringRef Name = unwrapOrError(Symbol.getName(), Obj->getFileName());
874 if (!Name.empty())
875 AllSymbols[*Plt].emplace_back(
876 PltEntry.second, Saver.save((Name + "@plt").str()), SymbolType);
Joel Galenson134cf472018-08-24 15:21:57 +0000877 }
878 }
879}
880
George Rimar70d197d2019-01-10 14:55:26 +0000881// Normally the disassembly output will skip blocks of zeroes. This function
882// returns the number of zero bytes that can be skipped when dumping the
883// disassembly of the instructions in Buf.
884static size_t countSkippableZeroBytes(ArrayRef<uint8_t> Buf) {
George Rimar70d197d2019-01-10 14:55:26 +0000885 // Find the number of leading zeroes.
886 size_t N = 0;
887 while (N < Buf.size() && !Buf[N])
888 ++N;
889
890 // We may want to skip blocks of zero bytes, but unless we see
891 // at least 8 of them in a row.
892 if (N < 8)
893 return 0;
894
895 // We skip zeroes in multiples of 4 because do not want to truncate an
896 // instruction if it starts with a zero byte.
897 return N & ~0x3;
898}
899
George Rimar121fcd72019-01-22 14:09:37 +0000900// Returns a map from sections to their relocations.
901static std::map<SectionRef, std::vector<RelocationRef>>
902getRelocsMap(llvm::object::ObjectFile const &Obj) {
903 std::map<SectionRef, std::vector<RelocationRef>> Ret;
904 for (const SectionRef &Section : ToolSectionFilter(Obj)) {
905 section_iterator RelSec = Section.getRelocatedSection();
906 if (RelSec == Obj.section_end())
907 continue;
908 std::vector<RelocationRef> &V = Ret[*RelSec];
909 for (const RelocationRef &R : Section.relocations())
910 V.push_back(R);
911 // Sort relocations by address.
912 llvm::sort(V, isRelocAddressLess);
913 }
914 return Ret;
915}
916
George Rimar4c3b2972019-01-28 10:44:01 +0000917// Used for --adjust-vma to check if address should be adjusted by the
918// specified value for a given section.
919// For ELF we do not adjust non-allocatable sections like debug ones,
920// because they are not loadable.
921// TODO: implement for other file formats.
922static bool shouldAdjustVA(const SectionRef &Section) {
923 const ObjectFile *Obj = Section.getObject();
924 if (isa<object::ELFObjectFileBase>(Obj))
925 return ELFSectionRef(Section).getFlags() & ELF::SHF_ALLOC;
926 return false;
927}
928
Fangrui Song32087b62019-04-07 16:33:24 +0000929static uint64_t
930dumpARMELFData(uint64_t SectionAddr, uint64_t Index, uint64_t End,
931 const ObjectFile *Obj, ArrayRef<uint8_t> Bytes,
932 const std::vector<uint64_t> &TextMappingSymsAddr) {
933 support::endianness Endian =
934 Obj->isLittleEndian() ? support::little : support::big;
935 while (Index < End) {
936 outs() << format("%8" PRIx64 ":", SectionAddr + Index);
937 outs() << "\t";
938 if (Index + 4 <= End) {
939 dumpBytes(Bytes.slice(Index, 4), outs());
940 outs() << "\t.word\t"
941 << format_hex(
942 support::endian::read32(Bytes.data() + Index, Endian), 10);
943 Index += 4;
944 } else if (Index + 2 <= End) {
945 dumpBytes(Bytes.slice(Index, 2), outs());
946 outs() << "\t\t.short\t"
947 << format_hex(
948 support::endian::read16(Bytes.data() + Index, Endian), 6);
949 Index += 2;
950 } else {
951 dumpBytes(Bytes.slice(Index, 1), outs());
952 outs() << "\t\t.byte\t" << format_hex(Bytes[0], 4);
953 ++Index;
954 }
955 outs() << "\n";
956 if (std::binary_search(TextMappingSymsAddr.begin(),
957 TextMappingSymsAddr.end(), Index))
958 break;
959 }
960 return Index;
961}
962
963static void dumpELFData(uint64_t SectionAddr, uint64_t Index, uint64_t End,
964 ArrayRef<uint8_t> Bytes) {
965 // print out data up to 8 bytes at a time in hex and ascii
966 uint8_t AsciiData[9] = {'\0'};
967 uint8_t Byte;
968 int NumBytes = 0;
969
970 for (; Index < End; ++Index) {
971 if (NumBytes == 0) {
972 outs() << format("%8" PRIx64 ":", SectionAddr + Index);
973 outs() << "\t";
974 }
975 Byte = Bytes.slice(Index)[0];
976 outs() << format(" %02x", Byte);
977 AsciiData[NumBytes] = isPrint(Byte) ? Byte : '.';
978
979 uint8_t IndentOffset = 0;
980 NumBytes++;
981 if (Index == End - 1 || NumBytes > 8) {
982 // Indent the space for less than 8 bytes data.
983 // 2 spaces for byte and one for space between bytes
984 IndentOffset = 3 * (8 - NumBytes);
985 for (int Excess = NumBytes; Excess < 8; Excess++)
986 AsciiData[Excess] = '\0';
987 NumBytes = 8;
988 }
989 if (NumBytes == 8) {
990 AsciiData[8] = '\0';
991 outs() << std::string(IndentOffset, ' ') << " ";
992 outs() << reinterpret_cast<char *>(AsciiData);
993 outs() << '\n';
994 NumBytes = 0;
995 }
996 }
997}
998
George Rimarbcbe98b2019-01-23 10:33:26 +0000999static void disassembleObject(const Target *TheTarget, const ObjectFile *Obj,
1000 MCContext &Ctx, MCDisassembler *DisAsm,
1001 const MCInstrAnalysis *MIA, MCInstPrinter *IP,
1002 const MCSubtargetInfo *STI, PrettyPrinter &PIP,
1003 SourcePrinter &SP, bool InlineRelocs) {
George Rimar121fcd72019-01-22 14:09:37 +00001004 std::map<SectionRef, std::vector<RelocationRef>> RelocMap;
1005 if (InlineRelocs)
1006 RelocMap = getRelocsMap(*Obj);
Mark Seaborn0929d3d2014-01-25 17:38:19 +00001007
David Majnemer81afca62015-07-07 22:06:59 +00001008 // Create a mapping from virtual address to symbol name. This is used to
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001009 // pretty print the symbols while disassembling.
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001010 std::map<SectionRef, SectionSymbolsTy> AllSymbols;
Sterling Augustinebc78b622018-06-28 18:57:13 +00001011 SectionSymbolsTy AbsoluteSymbols;
Fangrui Songe7834bd2019-04-07 08:19:55 +00001012 const StringRef FileName = Obj->getFileName();
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001013 for (const SymbolRef &Symbol : Obj->symbols()) {
Fangrui Songe7834bd2019-04-07 08:19:55 +00001014 uint64_t Address = unwrapOrError(Symbol.getAddress(), FileName);
David Majnemer2603a8fa2015-07-09 18:11:40 +00001015
Fangrui Songe7834bd2019-04-07 08:19:55 +00001016 StringRef Name = unwrapOrError(Symbol.getName(), FileName);
1017 if (Name.empty())
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001018 continue;
David Majnemer81afca62015-07-07 22:06:59 +00001019
Sam Koltonc05d7782016-08-17 10:17:57 +00001020 uint8_t SymbolType = ELF::STT_NOTYPE;
Matt Davis82937e42019-01-31 19:42:21 +00001021 if (Obj->isELF()) {
Sam Koltonc05d7782016-08-17 10:17:57 +00001022 SymbolType = getElfSymbolType(Obj, Symbol);
Matt Davis82937e42019-01-31 19:42:21 +00001023 if (SymbolType == ELF::STT_SECTION)
1024 continue;
1025 }
David Majnemer81afca62015-07-07 22:06:59 +00001026
Fangrui Songe7834bd2019-04-07 08:19:55 +00001027 section_iterator SecI = unwrapOrError(Symbol.getSection(), FileName);
Sterling Augustinebc78b622018-06-28 18:57:13 +00001028 if (SecI != Obj->section_end())
Fangrui Songe7834bd2019-04-07 08:19:55 +00001029 AllSymbols[*SecI].emplace_back(Address, Name, SymbolType);
Sterling Augustinebc78b622018-06-28 18:57:13 +00001030 else
Fangrui Songe7834bd2019-04-07 08:19:55 +00001031 AbsoluteSymbols.emplace_back(Address, Name, SymbolType);
David Majnemer81afca62015-07-07 22:06:59 +00001032 }
Sam Parker5fba45a2017-02-08 09:44:18 +00001033 if (AllSymbols.empty() && Obj->isELF())
1034 addDynamicElfSymbols(Obj, AllSymbols);
David Majnemer81afca62015-07-07 22:06:59 +00001035
Joel Galenson134cf472018-08-24 15:21:57 +00001036 BumpPtrAllocator A;
1037 StringSaver Saver(A);
1038 addPltEntries(Obj, AllSymbols, Saver);
1039
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001040 // Create a mapping from virtual address to section.
1041 std::vector<std::pair<uint64_t, SectionRef>> SectionAddresses;
1042 for (SectionRef Sec : Obj->sections())
1043 SectionAddresses.emplace_back(Sec.getAddress(), Sec);
1044 array_pod_sort(SectionAddresses.begin(), SectionAddresses.end());
1045
1046 // Linked executables (.exe and .dll files) typically don't include a real
1047 // symbol table but they might contain an export table.
1048 if (const auto *COFFObj = dyn_cast<COFFObjectFile>(Obj)) {
1049 for (const auto &ExportEntry : COFFObj->export_directories()) {
1050 StringRef Name;
1051 error(ExportEntry.getSymbolName(Name));
1052 if (Name.empty())
1053 continue;
1054 uint32_t RVA;
1055 error(ExportEntry.getExportRVA(RVA));
1056
1057 uint64_t VA = COFFObj->getImageBase() + RVA;
Fangrui Song545ed222019-04-07 05:32:16 +00001058 auto Sec = llvm::upper_bound(
1059 SectionAddresses, VA,
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001060 [](uint64_t LHS, const std::pair<uint64_t, SectionRef> &RHS) {
1061 return LHS < RHS.first;
1062 });
Fangrui Song545ed222019-04-07 05:32:16 +00001063 if (Sec != SectionAddresses.begin()) {
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001064 --Sec;
Sam Koltonc05d7782016-08-17 10:17:57 +00001065 AllSymbols[Sec->second].emplace_back(VA, Name, ELF::STT_NOTYPE);
Fangrui Song545ed222019-04-07 05:32:16 +00001066 } else
Sterling Augustinebc78b622018-06-28 18:57:13 +00001067 AbsoluteSymbols.emplace_back(VA, Name, ELF::STT_NOTYPE);
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001068 }
1069 }
1070
1071 // Sort all the symbols, this allows us to use a simple binary search to find
1072 // a symbol near an address.
1073 for (std::pair<const SectionRef, SectionSymbolsTy> &SecSyms : AllSymbols)
1074 array_pod_sort(SecSyms.second.begin(), SecSyms.second.end());
Sterling Augustinebc78b622018-06-28 18:57:13 +00001075 array_pod_sort(AbsoluteSymbols.begin(), AbsoluteSymbols.end());
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001076
Colin LeMahieu77804be2015-07-29 15:45:39 +00001077 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Colin LeMahieuf34933e2015-07-23 20:58:49 +00001078 if (!DisassembleAll && (!Section.isText() || Section.isVirtual()))
Mark Seaborneb03ac52014-01-25 00:32:01 +00001079 continue;
Michael J. Spencer1d6167f2011-06-25 17:55:23 +00001080
Rafael Espindola80291272014-10-08 15:28:58 +00001081 uint64_t SectionAddr = Section.getAddress();
1082 uint64_t SectSize = Section.getSize();
David Majnemer185b5b12014-11-11 09:58:25 +00001083 if (!SectSize)
1084 continue;
Simon Atanasyan2b614e12014-02-24 22:12:11 +00001085
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001086 // Get the list of all the symbols in this section.
1087 SectionSymbolsTy &Symbols = AllSymbols[Section];
Davide Italianof0706882015-10-01 21:57:09 +00001088 std::vector<uint64_t> DataMappingSymsAddr;
1089 std::vector<uint64_t> TextMappingSymsAddr;
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001090 if (isArmElf(Obj)) {
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001091 for (const auto &Symb : Symbols) {
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001092 uint64_t Address = std::get<0>(Symb);
1093 StringRef Name = std::get<1>(Symb);
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001094 if (Name.startswith("$d"))
David Majnemer153722d2015-11-18 04:35:32 +00001095 DataMappingSymsAddr.push_back(Address - SectionAddr);
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001096 if (Name.startswith("$x"))
David Majnemer153722d2015-11-18 04:35:32 +00001097 TextMappingSymsAddr.push_back(Address - SectionAddr);
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001098 if (Name.startswith("$a"))
1099 TextMappingSymsAddr.push_back(Address - SectionAddr);
1100 if (Name.startswith("$t"))
1101 TextMappingSymsAddr.push_back(Address - SectionAddr);
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001102 }
1103 }
1104
Fangrui Song0cac7262018-09-27 02:13:45 +00001105 llvm::sort(DataMappingSymsAddr);
1106 llvm::sort(TextMappingSymsAddr);
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001107
Sam Kolton3381d7a2016-10-06 13:46:08 +00001108 if (Obj->isELF() && Obj->getArch() == Triple::amdgcn) {
1109 // AMDGPU disassembler uses symbolizer for printing labels
1110 std::unique_ptr<MCRelocationInfo> RelInfo(
1111 TheTarget->createMCRelocationInfo(TripleName, Ctx));
1112 if (RelInfo) {
1113 std::unique_ptr<MCSymbolizer> Symbolizer(
1114 TheTarget->createMCSymbolizer(
1115 TripleName, nullptr, nullptr, &Symbols, &Ctx, std::move(RelInfo)));
1116 DisAsm->setSymbolizer(std::move(Symbolizer));
1117 }
1118 }
1119
Rafael Espindolaa9f810b2012-12-21 03:47:03 +00001120 StringRef SegmentName = "";
Mark Seaborneb03ac52014-01-25 00:32:01 +00001121 if (const MachOObjectFile *MachO = dyn_cast<const MachOObjectFile>(Obj)) {
Alexey Samsonov48803e52014-03-13 14:37:36 +00001122 DataRefImpl DR = Section.getRawDataRefImpl();
Rafael Espindola56f976f2013-04-18 18:08:55 +00001123 SegmentName = MachO->getSectionFinalSegmentName(DR);
Rafael Espindolaa9f810b2012-12-21 03:47:03 +00001124 }
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001125 StringRef SectionName;
1126 error(Section.getName(SectionName));
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001127
Rafael Espindola7884c952015-06-04 15:01:05 +00001128 // If the section has no symbol at the start, just insert a dummy one.
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001129 if (Symbols.empty() || std::get<0>(Symbols[0]) != 0) {
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001130 Symbols.insert(
1131 Symbols.begin(),
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001132 std::make_tuple(SectionAddr, SectionName,
1133 Section.isText() ? ELF::STT_FUNC : ELF::STT_OBJECT));
Sam Koltonc05d7782016-08-17 10:17:57 +00001134 }
Alp Tokere69170a2014-06-26 22:52:05 +00001135
1136 SmallString<40> Comments;
1137 raw_svector_ostream CommentStream(Comments);
Ahmed Bougachaad1084d2013-05-24 00:39:57 +00001138
Rafael Espindola7fc5b872014-11-12 02:04:27 +00001139 StringRef BytesStr;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001140 error(Section.getContents(BytesStr));
Fangrui Song6a0746a2019-04-07 03:58:42 +00001141 ArrayRef<uint8_t> Bytes = arrayRefFromStringRef(BytesStr);
Rafael Espindola7fc5b872014-11-12 02:04:27 +00001142
George Rimar4c3b2972019-01-28 10:44:01 +00001143 uint64_t VMAAdjustment = 0;
1144 if (shouldAdjustVA(Section))
1145 VMAAdjustment = AdjustVMA;
1146
Michael J. Spencer2670c252011-01-20 06:39:06 +00001147 uint64_t Size;
1148 uint64_t Index;
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001149 bool PrintedSection = false;
George Rimar121fcd72019-01-22 14:09:37 +00001150 std::vector<RelocationRef> Rels = RelocMap[Section];
George Rimar73a27232019-01-15 09:19:18 +00001151 std::vector<RelocationRef>::const_iterator RelCur = Rels.begin();
1152 std::vector<RelocationRef>::const_iterator RelEnd = Rels.end();
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001153 // Disassemble symbol by symbol.
George Rimar73a27232019-01-15 09:19:18 +00001154 for (unsigned SI = 0, SE = Symbols.size(); SI != SE; ++SI) {
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001155 uint64_t Start = std::get<0>(Symbols[SI]) - SectionAddr;
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001156 // The end is either the section end or the beginning of the next
1157 // symbol.
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001158 uint64_t End = (SI == SE - 1)
1159 ? SectSize
1160 : std::get<0>(Symbols[SI + 1]) - SectionAddr;
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001161 // Don't try to disassemble beyond the end of section contents.
1162 if (End > SectSize)
1163 End = SectSize;
Rafael Espindolae45c7402014-08-17 16:31:39 +00001164 // If this symbol has the same address as the next symbol, then skip it.
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001165 if (Start >= End)
Michael J. Spenceree84f642011-10-13 20:37:08 +00001166 continue;
1167
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001168 // Check if we need to skip symbol
1169 // Skip if the symbol's data is not between StartAddress and StopAddress
Fangrui Song32087b62019-04-07 16:33:24 +00001170 if (End + SectionAddr <= StartAddress ||
1171 Start + SectionAddr >= StopAddress)
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001172 continue;
Fangrui Song32087b62019-04-07 16:33:24 +00001173
1174 // Stop disassembly at the stop address specified
1175 if (End + SectionAddr > StopAddress)
1176 End = StopAddress - SectionAddr;
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001177
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001178 /// Skip if user requested specific symbols and this is not in the list
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001179 if (!DisasmFuncsSet.empty() &&
1180 !DisasmFuncsSet.count(std::get<1>(Symbols[SI])))
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001181 continue;
1182
1183 if (!PrintedSection) {
1184 PrintedSection = true;
1185 outs() << "Disassembly of section ";
1186 if (!SegmentName.empty())
1187 outs() << SegmentName << ",";
1188 outs() << SectionName << ':';
1189 }
1190
Valery Pykhtinde048052016-04-07 07:24:01 +00001191 if (Obj->isELF() && Obj->getArch() == Triple::amdgcn) {
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001192 if (std::get<2>(Symbols[SI]) == ELF::STT_AMDGPU_HSA_KERNEL) {
Sam Koltonc05d7782016-08-17 10:17:57 +00001193 // skip amd_kernel_code_t at the begining of kernel symbol (256 bytes)
1194 Start += 256;
1195 }
George Rimar73a27232019-01-15 09:19:18 +00001196 if (SI == SE - 1 ||
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001197 std::get<2>(Symbols[SI + 1]) == ELF::STT_AMDGPU_HSA_KERNEL) {
Sam Koltonc05d7782016-08-17 10:17:57 +00001198 // cut trailing zeroes at the end of kernel
1199 // cut up to 256 bytes
1200 const uint64_t EndAlign = 256;
1201 const auto Limit = End - (std::min)(EndAlign, End - Start);
1202 while (End > Limit &&
1203 *reinterpret_cast<const support::ulittle32_t*>(&Bytes[End - 4]) == 0)
1204 End -= 4;
1205 }
Valery Pykhtinde048052016-04-07 07:24:01 +00001206 }
1207
George Rimar6622d412018-12-19 10:21:45 +00001208 outs() << '\n';
George Rimar3ba0f3c02019-01-09 14:43:33 +00001209 if (!NoLeadingAddr)
George Rimar4c3b2972019-01-28 10:44:01 +00001210 outs() << format("%016" PRIx64 " ",
1211 SectionAddr + Start + VMAAdjustment);
George Rimar3ba0f3c02019-01-09 14:43:33 +00001212
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001213 StringRef SymbolName = std::get<1>(Symbols[SI]);
George Rimar6622d412018-12-19 10:21:45 +00001214 if (Demangle)
1215 outs() << demangle(SymbolName) << ":\n";
1216 else
1217 outs() << SymbolName << ":\n";
Michael J. Spencer2670c252011-01-20 06:39:06 +00001218
Francis Visoiu Mistrih18346822018-04-19 17:02:57 +00001219 // Don't print raw contents of a virtual section. A virtual section
1220 // doesn't have any contents in the file.
1221 if (Section.isVirtual()) {
1222 outs() << "...\n";
1223 continue;
1224 }
1225
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001226#ifndef NDEBUG
Mark Seaborneb03ac52014-01-25 00:32:01 +00001227 raw_ostream &DebugOut = DebugFlag ? dbgs() : nulls();
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001228#else
Mark Seaborneb03ac52014-01-25 00:32:01 +00001229 raw_ostream &DebugOut = nulls();
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001230#endif
1231
Wouter van Oortmerssenf3b762a2019-01-17 18:14:09 +00001232 // Some targets (like WebAssembly) have a special prelude at the start
1233 // of each symbol.
1234 DisAsm->onSymbolStart(SymbolName, Size, Bytes.slice(Start, End - Start),
1235 SectionAddr + Start, DebugOut, CommentStream);
1236 Start += Size;
1237
Fangrui Song32087b62019-04-07 16:33:24 +00001238 Index = Start;
1239 if (SectionAddr < StartAddress)
1240 Index = std::max<uint64_t>(Index, StartAddress - SectionAddr);
Owen Andersona0c3b972011-09-15 23:38:46 +00001241
Fangrui Song32087b62019-04-07 16:33:24 +00001242 // If there is a data symbol inside an ELF text section and we are
1243 // only disassembling text (applicable all architectures), we are in a
1244 // situation where we must print the data and not disassemble it.
1245 if (Obj->isELF() && std::get<2>(Symbols[SI]) == ELF::STT_OBJECT &&
1246 !DisassembleAll && Section.isText()) {
1247 dumpELFData(SectionAddr, Index, End, Bytes);
1248 Index = End;
1249 }
1250
1251 bool CheckARMELFData = isArmElf(Obj) &&
1252 std::get<2>(Symbols[SI]) != ELF::STT_OBJECT &&
1253 !DisassembleAll;
Fangrui Song32087b62019-04-07 16:33:24 +00001254 while (Index < End) {
1255 // AArch64 ELF binaries can interleave data and text in the same
1256 // section. We rely on the markers introduced to understand what we
1257 // need to dump. If the data marker is within a function, it is
1258 // denoted as a word/short etc.
1259 if (CheckARMELFData &&
Fangrui Song545ed222019-04-07 05:32:16 +00001260 std::binary_search(DataMappingSymsAddr.begin(),
1261 DataMappingSymsAddr.end(), Index)) {
Fangrui Song32087b62019-04-07 16:33:24 +00001262 Index = dumpARMELFData(SectionAddr, Index, End, Obj, Bytes,
1263 TextMappingSymsAddr);
1264 continue;
Davide Italianof0706882015-10-01 21:57:09 +00001265 }
1266
Fangrui Song32087b62019-04-07 16:33:24 +00001267 // When -z or --disassemble-zeroes are given we always dissasemble
1268 // them. Otherwise we might want to skip zero bytes we see.
George Rimarc5f29202019-02-19 12:38:36 +00001269 if (!DisassembleZeroes) {
1270 uint64_t MaxOffset = End - Index;
1271 // For -reloc: print zero blocks patched by relocations, so that
1272 // relocations can be shown in the dump.
1273 if (RelCur != RelEnd)
1274 MaxOffset = RelCur->getOffset() - Index;
1275
1276 if (size_t N =
1277 countSkippableZeroBytes(Bytes.slice(Index, MaxOffset))) {
1278 outs() << "\t\t..." << '\n';
1279 Index += N;
Fangrui Song32087b62019-04-07 16:33:24 +00001280 continue;
George Rimarc5f29202019-02-19 12:38:36 +00001281 }
George Rimar70d197d2019-01-10 14:55:26 +00001282 }
1283
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001284 // Disassemble a real instruction or a data when disassemble all is
1285 // provided
Fangrui Song996b9092019-04-08 01:22:38 +00001286 MCInst Inst;
Fangrui Song32087b62019-04-07 16:33:24 +00001287 bool Disassembled = DisAsm->getInstruction(
1288 Inst, Size, Bytes.slice(Index), SectionAddr + Index, DebugOut,
1289 CommentStream);
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001290 if (Size == 0)
1291 Size = 1;
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +00001292
Fangrui Song32087b62019-04-07 16:33:24 +00001293 PIP.printInst(
1294 *IP, Disassembled ? &Inst : nullptr, Bytes.slice(Index, Size),
1295 {SectionAddr + Index + VMAAdjustment, Section.getIndex()}, outs(),
1296 "", *STI, &SP, &Rels);
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001297 outs() << CommentStream.str();
1298 Comments.clear();
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001299
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001300 // Try to resolve the target of a call, tail call, etc. to a specific
1301 // symbol.
1302 if (MIA && (MIA->isCall(Inst) || MIA->isUnconditionalBranch(Inst) ||
1303 MIA->isConditionalBranch(Inst))) {
1304 uint64_t Target;
1305 if (MIA->evaluateBranch(Inst, SectionAddr + Index, Size, Target)) {
1306 // In a relocatable object, the target's section must reside in
1307 // the same section as the call instruction or it is accessed
1308 // through a relocation.
1309 //
1310 // In a non-relocatable object, the target may be in any section.
1311 //
1312 // N.B. We don't walk the relocations in the relocatable case yet.
1313 auto *TargetSectionSymbols = &Symbols;
1314 if (!Obj->isRelocatableObject()) {
Fangrui Song545ed222019-04-07 05:32:16 +00001315 auto SectionAddress = llvm::upper_bound(
1316 SectionAddresses, Target,
1317 [](uint64_t LHS, const std::pair<uint64_t, SectionRef> &RHS) {
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001318 return LHS < RHS.first;
1319 });
1320 if (SectionAddress != SectionAddresses.begin()) {
1321 --SectionAddress;
1322 TargetSectionSymbols = &AllSymbols[SectionAddress->second];
1323 } else {
Sterling Augustinebc78b622018-06-28 18:57:13 +00001324 TargetSectionSymbols = &AbsoluteSymbols;
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001325 }
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001326 }
David Majnemer2603a8fa2015-07-09 18:11:40 +00001327
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001328 // Find the first symbol in the section whose offset is less than
Sterling Augustinebc78b622018-06-28 18:57:13 +00001329 // or equal to the target. If there isn't a section that contains
1330 // the target, find the nearest preceding absolute symbol.
Fangrui Song545ed222019-04-07 05:32:16 +00001331 auto TargetSym = llvm::upper_bound(
1332 *TargetSectionSymbols, Target,
1333 [](uint64_t LHS,
1334 const std::tuple<uint64_t, StringRef, uint8_t> &RHS) {
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001335 return LHS < std::get<0>(RHS);
Sterling Augustinebc78b622018-06-28 18:57:13 +00001336 });
1337 if (TargetSym == TargetSectionSymbols->begin()) {
1338 TargetSectionSymbols = &AbsoluteSymbols;
Fangrui Song545ed222019-04-07 05:32:16 +00001339 TargetSym = llvm::upper_bound(
1340 AbsoluteSymbols, Target,
1341 [](uint64_t LHS,
1342 const std::tuple<uint64_t, StringRef, uint8_t> &RHS) {
1343 return LHS < std::get<0>(RHS);
1344 });
Sterling Augustinebc78b622018-06-28 18:57:13 +00001345 }
1346 if (TargetSym != TargetSectionSymbols->begin()) {
1347 --TargetSym;
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001348 uint64_t TargetAddress = std::get<0>(*TargetSym);
1349 StringRef TargetName = std::get<1>(*TargetSym);
1350 outs() << " <" << TargetName;
1351 uint64_t Disp = Target - TargetAddress;
Sterling Augustinebc78b622018-06-28 18:57:13 +00001352 if (Disp)
1353 outs() << "+0x" << Twine::utohexstr(Disp);
1354 outs() << '>';
David Majnemer81afca62015-07-07 22:06:59 +00001355 }
1356 }
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001357 }
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001358 outs() << "\n";
Michael J. Spencer51862b32011-10-13 22:17:18 +00001359
Sid Manningd9f28732018-05-14 19:46:08 +00001360 // Hexagon does this in pretty printer
George Rimarfd383e72019-01-23 10:52:38 +00001361 if (Obj->getArch() != Triple::hexagon) {
Sid Manningd9f28732018-05-14 19:46:08 +00001362 // Print relocation for instruction.
George Rimar73a27232019-01-15 09:19:18 +00001363 while (RelCur != RelEnd) {
George Rimar617adef2019-01-23 13:39:12 +00001364 uint64_t Offset = RelCur->getOffset();
Sid Manningd9f28732018-05-14 19:46:08 +00001365 // If this relocation is hidden, skip it.
Fangrui Song32087b62019-04-07 16:33:24 +00001366 if (getHidden(*RelCur) || SectionAddr + Offset < StartAddress) {
George Rimar73a27232019-01-15 09:19:18 +00001367 ++RelCur;
Sid Manningd9f28732018-05-14 19:46:08 +00001368 continue;
1369 }
1370
George Rimar740974d2019-01-28 10:48:54 +00001371 // Stop when RelCur's offset is past the current instruction.
George Rimar617adef2019-01-23 13:39:12 +00001372 if (Offset >= Index + Size)
George Rimar73a27232019-01-15 09:19:18 +00001373 break;
George Rimar617adef2019-01-23 13:39:12 +00001374
George Rimar4c3b2972019-01-28 10:44:01 +00001375 // When --adjust-vma is used, update the address printed.
1376 if (RelCur->getSymbol() != Obj->symbol_end()) {
1377 Expected<section_iterator> SymSI =
1378 RelCur->getSymbol()->getSection();
1379 if (SymSI && *SymSI != Obj->section_end() &&
Fangrui Song32087b62019-04-07 16:33:24 +00001380 shouldAdjustVA(**SymSI))
George Rimar4c3b2972019-01-28 10:44:01 +00001381 Offset += AdjustVMA;
1382 }
1383
George Rimar617adef2019-01-23 13:39:12 +00001384 printRelocation(*RelCur, SectionAddr + Offset,
1385 Obj->getBytesInAddress());
George Rimar73a27232019-01-15 09:19:18 +00001386 ++RelCur;
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001387 }
George Rimarfd383e72019-01-23 10:52:38 +00001388 }
Fangrui Song32087b62019-04-07 16:33:24 +00001389
1390 Index += Size;
Benjamin Kramer87ee76c2011-07-20 19:37:35 +00001391 }
Michael J. Spencer2670c252011-01-20 06:39:06 +00001392 }
1393 }
1394}
1395
George Rimarbcbe98b2019-01-23 10:33:26 +00001396static void disassembleObject(const ObjectFile *Obj, bool InlineRelocs) {
1397 if (StartAddress > StopAddress)
1398 error("Start address should be less than stop address");
1399
1400 const Target *TheTarget = getTarget(Obj);
1401
1402 // Package up features to be passed to target/subtarget
1403 SubtargetFeatures Features = Obj->getFeatures();
1404 if (!MAttrs.empty())
1405 for (unsigned I = 0; I != MAttrs.size(); ++I)
1406 Features.AddFeature(MAttrs[I]);
1407
1408 std::unique_ptr<const MCRegisterInfo> MRI(
1409 TheTarget->createMCRegInfo(TripleName));
1410 if (!MRI)
1411 report_error(Obj->getFileName(),
1412 "no register info for target " + TripleName);
1413
1414 // Set up disassembler.
1415 std::unique_ptr<const MCAsmInfo> AsmInfo(
1416 TheTarget->createMCAsmInfo(*MRI, TripleName));
1417 if (!AsmInfo)
1418 report_error(Obj->getFileName(),
1419 "no assembly info for target " + TripleName);
1420 std::unique_ptr<const MCSubtargetInfo> STI(
1421 TheTarget->createMCSubtargetInfo(TripleName, MCPU, Features.getString()));
1422 if (!STI)
1423 report_error(Obj->getFileName(),
1424 "no subtarget info for target " + TripleName);
1425 std::unique_ptr<const MCInstrInfo> MII(TheTarget->createMCInstrInfo());
1426 if (!MII)
1427 report_error(Obj->getFileName(),
1428 "no instruction info for target " + TripleName);
1429 MCObjectFileInfo MOFI;
1430 MCContext Ctx(AsmInfo.get(), MRI.get(), &MOFI);
1431 // FIXME: for now initialize MCObjectFileInfo with default values
1432 MOFI.InitMCObjectFileInfo(Triple(TripleName), false, Ctx);
1433
1434 std::unique_ptr<MCDisassembler> DisAsm(
1435 TheTarget->createMCDisassembler(*STI, Ctx));
1436 if (!DisAsm)
1437 report_error(Obj->getFileName(),
1438 "no disassembler for target " + TripleName);
1439
1440 std::unique_ptr<const MCInstrAnalysis> MIA(
1441 TheTarget->createMCInstrAnalysis(MII.get()));
1442
1443 int AsmPrinterVariant = AsmInfo->getAssemblerDialect();
1444 std::unique_ptr<MCInstPrinter> IP(TheTarget->createMCInstPrinter(
1445 Triple(TripleName), AsmPrinterVariant, *AsmInfo, *MII, *MRI));
1446 if (!IP)
1447 report_error(Obj->getFileName(),
1448 "no instruction printer for target " + TripleName);
1449 IP->setPrintImmHex(PrintImmHex);
1450
1451 PrettyPrinter &PIP = selectPrettyPrinter(Triple(TripleName));
1452 SourcePrinter SP(Obj, TheTarget->getName());
1453
Igor Kudrin2d3faad2019-02-26 12:15:14 +00001454 for (StringRef Opt : DisassemblerOptions)
1455 if (!IP->applyTargetSpecificCLOption(Opt))
1456 error("Unrecognized disassembler option: " + Opt);
1457
George Rimarbcbe98b2019-01-23 10:33:26 +00001458 disassembleObject(TheTarget, Obj, Ctx, DisAsm.get(), MIA.get(), IP.get(),
1459 STI.get(), PIP, SP, InlineRelocs);
1460}
1461
George Rimar73a27232019-01-15 09:19:18 +00001462void llvm::printRelocations(const ObjectFile *Obj) {
Greg Fitzgerald18432272014-03-20 22:55:15 +00001463 StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64 :
1464 "%08" PRIx64;
Rafael Espindola9219fe72016-03-21 20:59:15 +00001465 // Regular objdump doesn't print relocations in non-relocatable object
1466 // files.
1467 if (!Obj->isRelocatableObject())
1468 return;
Rafael Espindolac66d7612014-08-17 19:09:37 +00001469
Colin LeMahieu77804be2015-07-29 15:45:39 +00001470 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Alexey Samsonov48803e52014-03-13 14:37:36 +00001471 if (Section.relocation_begin() == Section.relocation_end())
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001472 continue;
George Rimar73a27232019-01-15 09:19:18 +00001473 StringRef SecName;
1474 error(Section.getName(SecName));
1475 outs() << "RELOCATION RECORDS FOR [" << SecName << "]:\n";
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00001476 for (const RelocationRef &Reloc : Section.relocations()) {
George Rimar73a27232019-01-15 09:19:18 +00001477 uint64_t Address = Reloc.getOffset();
1478 SmallString<32> RelocName;
1479 SmallString<32> ValueStr;
1480 if (Address < StartAddress || Address > StopAddress || getHidden(Reloc))
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00001481 continue;
George Rimar73a27232019-01-15 09:19:18 +00001482 Reloc.getTypeName(RelocName);
1483 error(getRelocationValueString(Reloc, ValueStr));
1484 outs() << format(Fmt.data(), Address) << " " << RelocName << " "
1485 << ValueStr << "\n";
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001486 }
1487 outs() << "\n";
1488 }
1489}
1490
George Rimar73a27232019-01-15 09:19:18 +00001491void llvm::printDynamicRelocations(const ObjectFile *Obj) {
Paul Semelcb0f0432018-06-07 13:30:55 +00001492 // For the moment, this option is for ELF only
1493 if (!Obj->isELF())
1494 return;
1495
1496 const auto *Elf = dyn_cast<ELFObjectFileBase>(Obj);
Paul Semelcb0f0432018-06-07 13:30:55 +00001497 if (!Elf || Elf->getEType() != ELF::ET_DYN) {
1498 error("not a dynamic object");
1499 return;
1500 }
1501
Paul Semelcb0f0432018-06-07 13:30:55 +00001502 std::vector<SectionRef> DynRelSec = Obj->dynamic_relocation_sections();
1503 if (DynRelSec.empty())
1504 return;
1505
1506 outs() << "DYNAMIC RELOCATION RECORDS\n";
George Rimar73a27232019-01-15 09:19:18 +00001507 StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64 : "%08" PRIx64;
Paul Semelcb0f0432018-06-07 13:30:55 +00001508 for (const SectionRef &Section : DynRelSec) {
1509 if (Section.relocation_begin() == Section.relocation_end())
1510 continue;
1511 for (const RelocationRef &Reloc : Section.relocations()) {
George Rimar73a27232019-01-15 09:19:18 +00001512 uint64_t Address = Reloc.getOffset();
1513 SmallString<32> RelocName;
1514 SmallString<32> ValueStr;
1515 Reloc.getTypeName(RelocName);
1516 error(getRelocationValueString(Reloc, ValueStr));
1517 outs() << format(Fmt.data(), Address) << " " << RelocName << " "
1518 << ValueStr << "\n";
Paul Semelcb0f0432018-06-07 13:30:55 +00001519 }
1520 }
1521}
1522
George Rimar87fa2e62019-01-28 14:11:35 +00001523// Returns true if we need to show LMA column when dumping section headers. We
1524// show it only when the platform is ELF and either we have at least one section
1525// whose VMA and LMA are different and/or when --show-lma flag is used.
1526static bool shouldDisplayLMA(const ObjectFile *Obj) {
1527 if (!Obj->isELF())
1528 return false;
1529 for (const SectionRef &S : ToolSectionFilter(*Obj))
1530 if (S.getAddress() != getELFSectionLMA(S))
1531 return true;
1532 return ShowLMA;
1533}
1534
George Rimar73a27232019-01-15 09:19:18 +00001535void llvm::printSectionHeaders(const ObjectFile *Obj) {
George Rimar87fa2e62019-01-28 14:11:35 +00001536 bool HasLMAColumn = shouldDisplayLMA(Obj);
1537 if (HasLMAColumn)
1538 outs() << "Sections:\n"
1539 "Idx Name Size VMA LMA "
1540 "Type\n";
1541 else
1542 outs() << "Sections:\n"
1543 "Idx Name Size VMA Type\n";
1544
Colin LeMahieu77804be2015-07-29 15:45:39 +00001545 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001546 StringRef Name;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001547 error(Section.getName(Name));
George Rimar87fa2e62019-01-28 14:11:35 +00001548 uint64_t VMA = Section.getAddress();
George Rimar4463ebe2019-01-28 16:36:12 +00001549 if (shouldAdjustVA(Section))
1550 VMA += AdjustVMA;
1551
Rafael Espindola80291272014-10-08 15:28:58 +00001552 uint64_t Size = Section.getSize();
1553 bool Text = Section.isText();
1554 bool Data = Section.isData();
1555 bool BSS = Section.isBSS();
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001556 std::string Type = (std::string(Text ? "TEXT " : "") +
Michael J. Spencer8f67d472011-10-13 20:37:20 +00001557 (Data ? "DATA " : "") + (BSS ? "BSS" : ""));
George Rimar87fa2e62019-01-28 14:11:35 +00001558
1559 if (HasLMAColumn)
1560 outs() << format("%3d %-13s %08" PRIx64 " %016" PRIx64 " %016" PRIx64
1561 " %s\n",
1562 (unsigned)Section.getIndex(), Name.str().c_str(), Size,
1563 VMA, getELFSectionLMA(Section), Type.c_str());
1564 else
1565 outs() << format("%3d %-13s %08" PRIx64 " %016" PRIx64 " %s\n",
1566 (unsigned)Section.getIndex(), Name.str().c_str(), Size,
1567 VMA, Type.c_str());
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001568 }
Xing GUO785edea2018-11-17 08:12:48 +00001569 outs() << "\n";
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001570}
1571
George Rimar73a27232019-01-15 09:19:18 +00001572void llvm::printSectionContents(const ObjectFile *Obj) {
Colin LeMahieu77804be2015-07-29 15:45:39 +00001573 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001574 StringRef Name;
1575 StringRef Contents;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001576 error(Section.getName(Name));
Rafael Espindola80291272014-10-08 15:28:58 +00001577 uint64_t BaseAddr = Section.getAddress();
David Majnemer185b5b12014-11-11 09:58:25 +00001578 uint64_t Size = Section.getSize();
1579 if (!Size)
1580 continue;
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001581
1582 outs() << "Contents of section " << Name << ":\n";
David Majnemer185b5b12014-11-11 09:58:25 +00001583 if (Section.isBSS()) {
Alexey Samsonov209095c2013-04-16 10:53:11 +00001584 outs() << format("<skipping contents of bss section at [%04" PRIx64
David Majnemer8f6b04c2014-07-14 16:20:14 +00001585 ", %04" PRIx64 ")>\n",
1586 BaseAddr, BaseAddr + Size);
Alexey Samsonov209095c2013-04-16 10:53:11 +00001587 continue;
1588 }
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001589
Davide Italianoccd53fe2015-08-05 07:18:31 +00001590 error(Section.getContents(Contents));
David Majnemer8f6b04c2014-07-14 16:20:14 +00001591
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001592 // Dump out the content as hex and printable ascii characters.
George Rimar73a27232019-01-15 09:19:18 +00001593 for (std::size_t Addr = 0, End = Contents.size(); Addr < End; Addr += 16) {
1594 outs() << format(" %04" PRIx64 " ", BaseAddr + Addr);
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001595 // Dump line of hex.
George Rimar73a27232019-01-15 09:19:18 +00001596 for (std::size_t I = 0; I < 16; ++I) {
1597 if (I != 0 && I % 4 == 0)
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001598 outs() << ' ';
George Rimar73a27232019-01-15 09:19:18 +00001599 if (Addr + I < End)
1600 outs() << hexdigit((Contents[Addr + I] >> 4) & 0xF, true)
1601 << hexdigit(Contents[Addr + I] & 0xF, true);
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001602 else
1603 outs() << " ";
1604 }
1605 // Print ascii.
1606 outs() << " ";
George Rimar73a27232019-01-15 09:19:18 +00001607 for (std::size_t I = 0; I < 16 && Addr + I < End; ++I) {
1608 if (isPrint(static_cast<unsigned char>(Contents[Addr + I]) & 0xFF))
1609 outs() << Contents[Addr + I];
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001610 else
1611 outs() << ".";
1612 }
1613 outs() << "\n";
1614 }
1615 }
1616}
1617
George Rimar73a27232019-01-15 09:19:18 +00001618void llvm::printSymbolTable(const ObjectFile *O, StringRef ArchiveName,
Kevin Enderby9acb1092016-05-31 20:35:34 +00001619 StringRef ArchitectureName) {
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001620 outs() << "SYMBOL TABLE:\n";
1621
George Rimar73a27232019-01-15 09:19:18 +00001622 if (const COFFObjectFile *Coff = dyn_cast<const COFFObjectFile>(O)) {
1623 printCOFFSymbolTable(Coff);
Rui Ueyama4e39f712014-03-18 18:58:51 +00001624 return;
1625 }
George Rimar8e0a70b2019-01-10 16:24:10 +00001626
Fangrui Songe7834bd2019-04-07 08:19:55 +00001627 const StringRef FileName = O->getFileName();
George Rimar73a27232019-01-15 09:19:18 +00001628 for (auto I = O->symbol_begin(), E = O->symbol_end(); I != E; ++I) {
George Rimar8e0a70b2019-01-10 16:24:10 +00001629 // Skip printing the special zero symbol when dumping an ELF file.
1630 // This makes the output consistent with the GNU objdump.
George Rimar73a27232019-01-15 09:19:18 +00001631 if (I == O->symbol_begin() && isa<ELFObjectFileBase>(O))
George Rimar8e0a70b2019-01-10 16:24:10 +00001632 continue;
1633
1634 const SymbolRef &Symbol = *I;
Fangrui Songe7834bd2019-04-07 08:19:55 +00001635 uint64_t Address = unwrapOrError(Symbol.getAddress(), ArchiveName, FileName,
1636 ArchitectureName);
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001637 if ((Address < StartAddress) || (Address > StopAddress))
1638 continue;
Fangrui Songe7834bd2019-04-07 08:19:55 +00001639 SymbolRef::Type Type = unwrapOrError(Symbol.getType(), ArchiveName,
1640 FileName, ArchitectureName);
Rui Ueyama4e39f712014-03-18 18:58:51 +00001641 uint32_t Flags = Symbol.getFlags();
Fangrui Songe7834bd2019-04-07 08:19:55 +00001642 section_iterator Section = unwrapOrError(Symbol.getSection(), ArchiveName,
1643 FileName, ArchitectureName);
Rafael Espindola75d5b542015-06-03 05:14:22 +00001644 StringRef Name;
Fangrui Songe7834bd2019-04-07 08:19:55 +00001645 if (Type == SymbolRef::ST_Debug && Section != O->section_end())
Rafael Espindola75d5b542015-06-03 05:14:22 +00001646 Section->getName(Name);
Fangrui Songe7834bd2019-04-07 08:19:55 +00001647 else
1648 Name = unwrapOrError(Symbol.getName(), ArchiveName, FileName,
1649 ArchitectureName);
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001650
Rui Ueyama4e39f712014-03-18 18:58:51 +00001651 bool Global = Flags & SymbolRef::SF_Global;
1652 bool Weak = Flags & SymbolRef::SF_Weak;
1653 bool Absolute = Flags & SymbolRef::SF_Absolute;
Colin LeMahieubc2f47a2015-01-23 20:06:24 +00001654 bool Common = Flags & SymbolRef::SF_Common;
Davide Italianocd2514d2015-04-30 23:08:53 +00001655 bool Hidden = Flags & SymbolRef::SF_Hidden;
David Meyer1df4b842012-02-28 23:47:53 +00001656
Rui Ueyama4e39f712014-03-18 18:58:51 +00001657 char GlobLoc = ' ';
1658 if (Type != SymbolRef::ST_Unknown)
1659 GlobLoc = Global ? 'g' : 'l';
1660 char Debug = (Type == SymbolRef::ST_Debug || Type == SymbolRef::ST_File)
1661 ? 'd' : ' ';
1662 char FileFunc = ' ';
1663 if (Type == SymbolRef::ST_File)
1664 FileFunc = 'f';
1665 else if (Type == SymbolRef::ST_Function)
1666 FileFunc = 'F';
Kristina Brooks0674f9d2018-11-11 17:47:13 +00001667 else if (Type == SymbolRef::ST_Data)
1668 FileFunc = 'O';
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001669
George Rimar73a27232019-01-15 09:19:18 +00001670 const char *Fmt = O->getBytesInAddress() > 4 ? "%016" PRIx64 :
Rui Ueyama4e39f712014-03-18 18:58:51 +00001671 "%08" PRIx64;
Michael J. Spencerd857c1c2013-01-10 22:40:50 +00001672
Rui Ueyama4e39f712014-03-18 18:58:51 +00001673 outs() << format(Fmt, Address) << " "
1674 << GlobLoc // Local -> 'l', Global -> 'g', Neither -> ' '
1675 << (Weak ? 'w' : ' ') // Weak?
1676 << ' ' // Constructor. Not supported yet.
1677 << ' ' // Warning. Not supported yet.
1678 << ' ' // Indirect reference to another symbol.
1679 << Debug // Debugging (d) or dynamic (D) symbol.
1680 << FileFunc // Name of function (F), file (f) or object (O).
1681 << ' ';
1682 if (Absolute) {
1683 outs() << "*ABS*";
Colin LeMahieubc2f47a2015-01-23 20:06:24 +00001684 } else if (Common) {
1685 outs() << "*COM*";
George Rimar73a27232019-01-15 09:19:18 +00001686 } else if (Section == O->section_end()) {
Rui Ueyama4e39f712014-03-18 18:58:51 +00001687 outs() << "*UND*";
1688 } else {
1689 if (const MachOObjectFile *MachO =
George Rimar73a27232019-01-15 09:19:18 +00001690 dyn_cast<const MachOObjectFile>(O)) {
Rui Ueyama4e39f712014-03-18 18:58:51 +00001691 DataRefImpl DR = Section->getRawDataRefImpl();
1692 StringRef SegmentName = MachO->getSectionFinalSegmentName(DR);
1693 outs() << SegmentName << ",";
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001694 }
Rui Ueyama4e39f712014-03-18 18:58:51 +00001695 StringRef SectionName;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001696 error(Section->getName(SectionName));
Rui Ueyama4e39f712014-03-18 18:58:51 +00001697 outs() << SectionName;
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001698 }
Rafael Espindola5f7ade22015-06-23 15:45:38 +00001699
1700 outs() << '\t';
George Rimar73a27232019-01-15 09:19:18 +00001701 if (Common || isa<ELFObjectFileBase>(O)) {
Rafael Espindoladbb6bd32015-06-25 22:10:04 +00001702 uint64_t Val =
1703 Common ? Symbol.getAlignment() : ELFSymbolRef(Symbol).getSize();
Rafael Espindolaae3ac082015-06-23 18:34:25 +00001704 outs() << format("\t %08" PRIx64 " ", Val);
1705 }
Rafael Espindola5f7ade22015-06-23 15:45:38 +00001706
George Rimar73a27232019-01-15 09:19:18 +00001707 if (Hidden)
Davide Italianocd2514d2015-04-30 23:08:53 +00001708 outs() << ".hidden ";
George Rimar6622d412018-12-19 10:21:45 +00001709
1710 if (Demangle)
1711 outs() << demangle(Name) << '\n';
1712 else
1713 outs() << Name << '\n';
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001714 }
1715}
1716
George Rimar73a27232019-01-15 09:19:18 +00001717static void printUnwindInfo(const ObjectFile *O) {
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001718 outs() << "Unwind info:\n\n";
1719
George Rimar73a27232019-01-15 09:19:18 +00001720 if (const COFFObjectFile *Coff = dyn_cast<COFFObjectFile>(O))
1721 printCOFFUnwindInfo(Coff);
1722 else if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(O))
Tim Northover4bd286a2014-08-01 13:07:19 +00001723 printMachOUnwindInfo(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001724 else
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001725 // TODO: Extract DWARF dump tool to objdump.
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001726 WithColor::error(errs(), ToolName)
1727 << "This operation is only currently supported "
1728 "for COFF and MachO object files.\n";
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001729}
1730
Kevin Enderbye2297dd2015-01-07 21:02:18 +00001731void llvm::printExportsTrie(const ObjectFile *o) {
Nick Kledzikd04bc352014-08-30 00:20:14 +00001732 outs() << "Exports trie:\n";
1733 if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
1734 printMachOExportsTrie(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001735 else
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001736 WithColor::error(errs(), ToolName)
1737 << "This operation is only currently supported "
1738 "for Mach-O executable files.\n";
Nick Kledzikd04bc352014-08-30 00:20:14 +00001739}
1740
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001741void llvm::printRebaseTable(ObjectFile *o) {
Nick Kledzikac431442014-09-12 21:34:15 +00001742 outs() << "Rebase table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001743 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzikac431442014-09-12 21:34:15 +00001744 printMachORebaseTable(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001745 else
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001746 WithColor::error(errs(), ToolName)
1747 << "This operation is only currently supported "
1748 "for Mach-O executable files.\n";
Nick Kledzikac431442014-09-12 21:34:15 +00001749}
1750
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001751void llvm::printBindTable(ObjectFile *o) {
Nick Kledzik56ebef42014-09-16 01:41:51 +00001752 outs() << "Bind table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001753 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzik56ebef42014-09-16 01:41:51 +00001754 printMachOBindTable(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001755 else
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001756 WithColor::error(errs(), ToolName)
1757 << "This operation is only currently supported "
1758 "for Mach-O executable files.\n";
Nick Kledzik56ebef42014-09-16 01:41:51 +00001759}
1760
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001761void llvm::printLazyBindTable(ObjectFile *o) {
Nick Kledzik56ebef42014-09-16 01:41:51 +00001762 outs() << "Lazy bind table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001763 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzik56ebef42014-09-16 01:41:51 +00001764 printMachOLazyBindTable(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001765 else
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001766 WithColor::error(errs(), ToolName)
1767 << "This operation is only currently supported "
1768 "for Mach-O executable files.\n";
Nick Kledzik56ebef42014-09-16 01:41:51 +00001769}
1770
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001771void llvm::printWeakBindTable(ObjectFile *o) {
Nick Kledzik56ebef42014-09-16 01:41:51 +00001772 outs() << "Weak bind table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001773 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzik56ebef42014-09-16 01:41:51 +00001774 printMachOWeakBindTable(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001775 else
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001776 WithColor::error(errs(), ToolName)
1777 << "This operation is only currently supported "
1778 "for Mach-O executable files.\n";
Nick Kledzik56ebef42014-09-16 01:41:51 +00001779}
Nick Kledzikac431442014-09-12 21:34:15 +00001780
Adrian Prantl437105a2015-07-08 02:04:15 +00001781/// Dump the raw contents of the __clangast section so the output can be piped
1782/// into llvm-bcanalyzer.
1783void llvm::printRawClangAST(const ObjectFile *Obj) {
1784 if (outs().is_displayed()) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001785 WithColor::error(errs(), ToolName)
1786 << "The -raw-clang-ast option will dump the raw binary contents of "
1787 "the clang ast section.\n"
1788 "Please redirect the output to a file or another program such as "
1789 "llvm-bcanalyzer.\n";
Adrian Prantl437105a2015-07-08 02:04:15 +00001790 return;
1791 }
1792
1793 StringRef ClangASTSectionName("__clangast");
1794 if (isa<COFFObjectFile>(Obj)) {
1795 ClangASTSectionName = "clangast";
1796 }
1797
1798 Optional<object::SectionRef> ClangASTSection;
Colin LeMahieu77804be2015-07-29 15:45:39 +00001799 for (auto Sec : ToolSectionFilter(*Obj)) {
Adrian Prantl437105a2015-07-08 02:04:15 +00001800 StringRef Name;
1801 Sec.getName(Name);
1802 if (Name == ClangASTSectionName) {
1803 ClangASTSection = Sec;
1804 break;
1805 }
1806 }
1807 if (!ClangASTSection)
1808 return;
1809
1810 StringRef ClangASTContents;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001811 error(ClangASTSection.getValue().getContents(ClangASTContents));
Adrian Prantl437105a2015-07-08 02:04:15 +00001812 outs().write(ClangASTContents.data(), ClangASTContents.size());
1813}
1814
Sanjoy Das6f567a42015-06-22 18:03:02 +00001815static void printFaultMaps(const ObjectFile *Obj) {
George Rimar73a27232019-01-15 09:19:18 +00001816 StringRef FaultMapSectionName;
Sanjoy Das6f567a42015-06-22 18:03:02 +00001817
1818 if (isa<ELFObjectFileBase>(Obj)) {
1819 FaultMapSectionName = ".llvm_faultmaps";
1820 } else if (isa<MachOObjectFile>(Obj)) {
1821 FaultMapSectionName = "__llvm_faultmaps";
1822 } else {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001823 WithColor::error(errs(), ToolName)
1824 << "This operation is only currently supported "
1825 "for ELF and Mach-O executable files.\n";
Sanjoy Das6f567a42015-06-22 18:03:02 +00001826 return;
1827 }
1828
1829 Optional<object::SectionRef> FaultMapSection;
1830
Colin LeMahieu77804be2015-07-29 15:45:39 +00001831 for (auto Sec : ToolSectionFilter(*Obj)) {
Sanjoy Das6f567a42015-06-22 18:03:02 +00001832 StringRef Name;
1833 Sec.getName(Name);
1834 if (Name == FaultMapSectionName) {
1835 FaultMapSection = Sec;
1836 break;
1837 }
1838 }
1839
1840 outs() << "FaultMap table:\n";
1841
1842 if (!FaultMapSection.hasValue()) {
1843 outs() << "<not found>\n";
1844 return;
1845 }
1846
1847 StringRef FaultMapContents;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001848 error(FaultMapSection.getValue().getContents(FaultMapContents));
Sanjoy Das6f567a42015-06-22 18:03:02 +00001849
1850 FaultMapParser FMP(FaultMapContents.bytes_begin(),
1851 FaultMapContents.bytes_end());
1852
1853 outs() << FMP;
1854}
1855
George Rimar73a27232019-01-15 09:19:18 +00001856static void printPrivateFileHeaders(const ObjectFile *O, bool OnlyFirst) {
1857 if (O->isELF()) {
1858 printELFFileHeader(O);
Xing GUO56d651d2019-02-25 13:13:19 +00001859 printELFDynamicSection(O);
1860 printELFSymbolVersionInfo(O);
1861 return;
Paul Semel0913dcd2018-07-25 11:09:20 +00001862 }
George Rimar73a27232019-01-15 09:19:18 +00001863 if (O->isCOFF())
1864 return printCOFFFileHeader(O);
1865 if (O->isWasm())
1866 return printWasmFileHeader(O);
1867 if (O->isMachO()) {
1868 printMachOFileHeader(O);
1869 if (!OnlyFirst)
1870 printMachOLoadCommands(O);
Davide Italiano1bdaa202016-09-18 04:39:15 +00001871 return;
1872 }
George Rimar73a27232019-01-15 09:19:18 +00001873 report_error(O->getFileName(), "Invalid/Unsupported object file format");
Rui Ueyamac2bed422013-09-27 21:04:00 +00001874}
1875
George Rimar73a27232019-01-15 09:19:18 +00001876static void printFileHeaders(const ObjectFile *O) {
1877 if (!O->isELF() && !O->isCOFF())
1878 report_error(O->getFileName(), "Invalid/Unsupported object file format");
Paul Semeld2af4d62018-07-04 15:25:03 +00001879
George Rimar73a27232019-01-15 09:19:18 +00001880 Triple::ArchType AT = O->getArch();
Paul Semeld2af4d62018-07-04 15:25:03 +00001881 outs() << "architecture: " << Triple::getArchTypeName(AT) << "\n";
Fangrui Songe7834bd2019-04-07 08:19:55 +00001882 uint64_t Address = unwrapOrError(O->getStartAddress(), O->getFileName());
Petar Jovanovic8d947ba2018-10-19 22:16:49 +00001883
George Rimar73a27232019-01-15 09:19:18 +00001884 StringRef Fmt = O->getBytesInAddress() > 4 ? "%016" PRIx64 : "%08" PRIx64;
Paul Semeld2af4d62018-07-04 15:25:03 +00001885 outs() << "start address: "
George Rimar9b6fe7e2019-01-12 12:17:24 +00001886 << "0x" << format(Fmt.data(), Address) << "\n\n";
Paul Semeld2af4d62018-07-04 15:25:03 +00001887}
1888
Paul Semel0dc92f62018-07-05 14:43:29 +00001889static void printArchiveChild(StringRef Filename, const Archive::Child &C) {
1890 Expected<sys::fs::perms> ModeOrErr = C.getAccessMode();
1891 if (!ModeOrErr) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001892 WithColor::error(errs(), ToolName) << "ill-formed archive entry.\n";
Paul Semel0dc92f62018-07-05 14:43:29 +00001893 consumeError(ModeOrErr.takeError());
1894 return;
1895 }
1896 sys::fs::perms Mode = ModeOrErr.get();
1897 outs() << ((Mode & sys::fs::owner_read) ? "r" : "-");
1898 outs() << ((Mode & sys::fs::owner_write) ? "w" : "-");
1899 outs() << ((Mode & sys::fs::owner_exe) ? "x" : "-");
1900 outs() << ((Mode & sys::fs::group_read) ? "r" : "-");
1901 outs() << ((Mode & sys::fs::group_write) ? "w" : "-");
1902 outs() << ((Mode & sys::fs::group_exe) ? "x" : "-");
1903 outs() << ((Mode & sys::fs::others_read) ? "r" : "-");
1904 outs() << ((Mode & sys::fs::others_write) ? "w" : "-");
1905 outs() << ((Mode & sys::fs::others_exe) ? "x" : "-");
1906
1907 outs() << " ";
1908
Fangrui Songe7834bd2019-04-07 08:19:55 +00001909 outs() << format("%d/%d %6" PRId64 " ", unwrapOrError(C.getUID(), Filename),
1910 unwrapOrError(C.getGID(), Filename),
1911 unwrapOrError(C.getRawSize(), Filename));
Paul Semel0dc92f62018-07-05 14:43:29 +00001912
1913 StringRef RawLastModified = C.getRawLastModified();
1914 unsigned Seconds;
1915 if (RawLastModified.getAsInteger(10, Seconds))
1916 outs() << "(date: \"" << RawLastModified
1917 << "\" contains non-decimal chars) ";
1918 else {
1919 // Since ctime(3) returns a 26 character string of the form:
1920 // "Sun Sep 16 01:03:52 1973\n\0"
1921 // just print 24 characters.
1922 time_t t = Seconds;
1923 outs() << format("%.24s ", ctime(&t));
1924 }
1925
1926 StringRef Name = "";
1927 Expected<StringRef> NameOrErr = C.getName();
1928 if (!NameOrErr) {
1929 consumeError(NameOrErr.takeError());
Fangrui Songe7834bd2019-04-07 08:19:55 +00001930 Name = unwrapOrError(C.getRawName(), Filename);
Paul Semel0dc92f62018-07-05 14:43:29 +00001931 } else {
1932 Name = NameOrErr.get();
1933 }
1934 outs() << Name << "\n";
1935}
1936
George Rimar73a27232019-01-15 09:19:18 +00001937static void dumpObject(ObjectFile *O, const Archive *A = nullptr,
1938 const Archive::Child *C = nullptr) {
Adrian Prantl437105a2015-07-08 02:04:15 +00001939 // Avoid other output when using a raw option.
1940 if (!RawClangAST) {
1941 outs() << '\n';
George Rimar73a27232019-01-15 09:19:18 +00001942 if (A)
1943 outs() << A->getFileName() << "(" << O->getFileName() << ")";
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001944 else
George Rimar73a27232019-01-15 09:19:18 +00001945 outs() << O->getFileName();
1946 outs() << ":\tfile format " << O->getFileFormatName() << "\n\n";
Adrian Prantl437105a2015-07-08 02:04:15 +00001947 }
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001948
George Rimar73a27232019-01-15 09:19:18 +00001949 StringRef ArchiveName = A ? A->getFileName() : "";
George Rimar9b6fe7e2019-01-12 12:17:24 +00001950 if (FileHeaders)
George Rimar73a27232019-01-15 09:19:18 +00001951 printFileHeaders(O);
1952 if (ArchiveHeaders && !MachOOpt && C)
1953 printArchiveChild(ArchiveName, *C);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001954 if (Disassemble)
George Rimar73a27232019-01-15 09:19:18 +00001955 disassembleObject(O, Relocations);
Michael J. Spencer51862b32011-10-13 22:17:18 +00001956 if (Relocations && !Disassemble)
George Rimar73a27232019-01-15 09:19:18 +00001957 printRelocations(O);
Paul Semelcb0f0432018-06-07 13:30:55 +00001958 if (DynamicRelocations)
George Rimar73a27232019-01-15 09:19:18 +00001959 printDynamicRelocations(O);
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001960 if (SectionHeaders)
George Rimar73a27232019-01-15 09:19:18 +00001961 printSectionHeaders(O);
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001962 if (SectionContents)
George Rimar73a27232019-01-15 09:19:18 +00001963 printSectionContents(O);
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001964 if (SymbolTable)
George Rimar73a27232019-01-15 09:19:18 +00001965 printSymbolTable(O, ArchiveName);
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001966 if (UnwindInfo)
George Rimar73a27232019-01-15 09:19:18 +00001967 printUnwindInfo(O);
Davide Italiano1bdaa202016-09-18 04:39:15 +00001968 if (PrivateHeaders || FirstPrivateHeader)
George Rimar73a27232019-01-15 09:19:18 +00001969 printPrivateFileHeaders(O, FirstPrivateHeader);
Nick Kledzikd04bc352014-08-30 00:20:14 +00001970 if (ExportsTrie)
George Rimar73a27232019-01-15 09:19:18 +00001971 printExportsTrie(O);
Nick Kledzikac431442014-09-12 21:34:15 +00001972 if (Rebase)
George Rimar73a27232019-01-15 09:19:18 +00001973 printRebaseTable(O);
Nick Kledzik56ebef42014-09-16 01:41:51 +00001974 if (Bind)
George Rimar73a27232019-01-15 09:19:18 +00001975 printBindTable(O);
Nick Kledzik56ebef42014-09-16 01:41:51 +00001976 if (LazyBind)
George Rimar73a27232019-01-15 09:19:18 +00001977 printLazyBindTable(O);
Nick Kledzik56ebef42014-09-16 01:41:51 +00001978 if (WeakBind)
George Rimar73a27232019-01-15 09:19:18 +00001979 printWeakBindTable(O);
Adrian Prantl437105a2015-07-08 02:04:15 +00001980 if (RawClangAST)
George Rimar73a27232019-01-15 09:19:18 +00001981 printRawClangAST(O);
Sanjoy Das6f567a42015-06-22 18:03:02 +00001982 if (PrintFaultMaps)
George Rimar73a27232019-01-15 09:19:18 +00001983 printFaultMaps(O);
Igor Laevsky03a670c2016-01-26 15:09:42 +00001984 if (DwarfDumpType != DIDT_Null) {
George Rimar73a27232019-01-15 09:19:18 +00001985 std::unique_ptr<DIContext> DICtx = DWARFContext::create(*O);
Igor Laevsky03a670c2016-01-26 15:09:42 +00001986 // Dump the complete DWARF structure.
Adrian Prantlf4bc1f72017-06-01 18:18:23 +00001987 DIDumpOptions DumpOpts;
1988 DumpOpts.DumpType = DwarfDumpType;
Adrian Prantlf4bc1f72017-06-01 18:18:23 +00001989 DICtx->dump(outs(), DumpOpts);
Igor Laevsky03a670c2016-01-26 15:09:42 +00001990 }
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001991}
1992
George Rimar73a27232019-01-15 09:19:18 +00001993static void dumpObject(const COFFImportFile *I, const Archive *A,
Paul Semel0dc92f62018-07-05 14:43:29 +00001994 const Archive::Child *C = nullptr) {
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +00001995 StringRef ArchiveName = A ? A->getFileName() : "";
1996
1997 // Avoid other output when using a raw option.
1998 if (!RawClangAST)
1999 outs() << '\n'
2000 << ArchiveName << "(" << I->getFileName() << ")"
2001 << ":\tfile format COFF-import-file"
2002 << "\n\n";
2003
James Hendersonc1608c92018-10-29 14:17:08 +00002004 if (ArchiveHeaders && !MachOOpt && C)
2005 printArchiveChild(ArchiveName, *C);
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +00002006 if (SymbolTable)
2007 printCOFFSymbolTable(I);
2008}
2009
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +00002010/// Dump each object file in \a a;
George Rimar73a27232019-01-15 09:19:18 +00002011static void dumpArchive(const Archive *A) {
Mehdi Amini41af4302016-11-11 04:28:40 +00002012 Error Err = Error::success();
George Rimar73a27232019-01-15 09:19:18 +00002013 for (auto &C : A->children(Err)) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +00002014 Expected<std::unique_ptr<Binary>> ChildOrErr = C.getAsBinary();
2015 if (!ChildOrErr) {
2016 if (auto E = isNotObjectErrorInvalidFileType(ChildOrErr.takeError()))
Fangrui Songe7834bd2019-04-07 08:19:55 +00002017 report_error(std::move(E), A->getFileName(), C);
Kevin Enderbyac9e1552016-05-17 17:10:12 +00002018 continue;
2019 }
George Rimar73a27232019-01-15 09:19:18 +00002020 if (ObjectFile *O = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
2021 dumpObject(O, A, &C);
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +00002022 else if (COFFImportFile *I = dyn_cast<COFFImportFile>(&*ChildOrErr.get()))
George Rimar73a27232019-01-15 09:19:18 +00002023 dumpObject(I, A, &C);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002024 else
Fangrui Song3f209682019-04-09 05:41:24 +00002025 report_error(errorCodeToError(object_error::invalid_file_type),
2026 A->getFileName());
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002027 }
Lang Hamesfc209622016-07-14 02:24:01 +00002028 if (Err)
Fangrui Songe7834bd2019-04-07 08:19:55 +00002029 report_error(std::move(Err), A->getFileName());
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002030}
2031
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +00002032/// Open file and figure out how to dump it.
George Rimar73a27232019-01-15 09:19:18 +00002033static void dumpInput(StringRef file) {
Kevin Enderbye2297dd2015-01-07 21:02:18 +00002034 // If we are using the Mach-O specific object file parser, then let it parse
2035 // the file and process the command line options. So the -arch flags can
2036 // be used to select specific slices, etc.
2037 if (MachOOpt) {
George Rimar73a27232019-01-15 09:19:18 +00002038 parseInputMachO(file);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002039 return;
2040 }
2041
2042 // Attempt to open the binary.
Fangrui Songe7834bd2019-04-07 08:19:55 +00002043 OwningBinary<Binary> OBinary = unwrapOrError(createBinary(file), file);
2044 Binary &Binary = *OBinary.getBinary();
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002045
George Rimar73a27232019-01-15 09:19:18 +00002046 if (Archive *A = dyn_cast<Archive>(&Binary))
2047 dumpArchive(A);
2048 else if (ObjectFile *O = dyn_cast<ObjectFile>(&Binary))
2049 dumpObject(O);
Dave Lee3fb120f2018-08-03 00:06:38 +00002050 else if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(&Binary))
George Rimar73a27232019-01-15 09:19:18 +00002051 parseInputMachO(UB);
Jim Grosbachaf9aec02012-08-07 17:53:14 +00002052 else
Fangrui Song3f209682019-04-09 05:41:24 +00002053 report_error(errorCodeToError(object_error::invalid_file_type), file);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002054}
2055
Michael J. Spencer2670c252011-01-20 06:39:06 +00002056int main(int argc, char **argv) {
Rui Ueyama197194b2018-04-13 18:26:06 +00002057 InitLLVM X(argc, argv);
Michael J. Spencer2670c252011-01-20 06:39:06 +00002058
2059 // Initialize targets and assembly printers/parsers.
2060 llvm::InitializeAllTargetInfos();
Evan Cheng8c886a42011-07-22 21:58:54 +00002061 llvm::InitializeAllTargetMCs();
Michael J. Spencer2670c252011-01-20 06:39:06 +00002062 llvm::InitializeAllDisassemblers();
2063
Pete Cooper28fb4fc2012-05-03 23:20:10 +00002064 // Register the target printer for --version.
2065 cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
2066
Michael J. Spencer2670c252011-01-20 06:39:06 +00002067 cl::ParseCommandLineOptions(argc, argv, "llvm object file dumper\n");
Michael J. Spencer2670c252011-01-20 06:39:06 +00002068
2069 ToolName = argv[0];
2070
2071 // Defaults to a.out if no filenames specified.
Jordan Rupprecht16a0de22018-12-20 00:57:06 +00002072 if (InputFilenames.empty())
Michael J. Spencer2670c252011-01-20 06:39:06 +00002073 InputFilenames.push_back("a.out");
2074
Fangrui Song8513cd42018-06-27 20:45:11 +00002075 if (AllHeaders)
George Rimar5e364332019-01-18 12:01:59 +00002076 ArchiveHeaders = FileHeaders = PrivateHeaders = Relocations =
2077 SectionHeaders = SymbolTable = true;
Fangrui Song8513cd42018-06-27 20:45:11 +00002078
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +00002079 if (DisassembleAll || PrintSource || PrintLines)
Colin LeMahieuf34933e2015-07-23 20:58:49 +00002080 Disassemble = true;
Paul Semel007dedb2018-07-18 16:39:21 +00002081
Michael J. Spencerbfa06782011-10-18 19:32:17 +00002082 if (!Disassemble
2083 && !Relocations
Paul Semelcb0f0432018-06-07 13:30:55 +00002084 && !DynamicRelocations
Michael J. Spencerbfa06782011-10-18 19:32:17 +00002085 && !SectionHeaders
2086 && !SectionContents
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00002087 && !SymbolTable
Michael J. Spencer209565db2013-01-06 03:56:49 +00002088 && !UnwindInfo
Nick Kledzikd04bc352014-08-30 00:20:14 +00002089 && !PrivateHeaders
Paul Semeld2af4d62018-07-04 15:25:03 +00002090 && !FileHeaders
Kevin Enderby0ae163f2016-01-13 00:25:36 +00002091 && !FirstPrivateHeader
Nick Kledzikac431442014-09-12 21:34:15 +00002092 && !ExportsTrie
Nick Kledzik56ebef42014-09-16 01:41:51 +00002093 && !Rebase
2094 && !Bind
2095 && !LazyBind
Kevin Enderby131d1772015-01-09 19:22:37 +00002096 && !WeakBind
Adrian Prantl437105a2015-07-08 02:04:15 +00002097 && !RawClangAST
Kevin Enderby13023a12015-01-15 23:19:11 +00002098 && !(UniversalHeaders && MachOOpt)
Paul Semel0dc92f62018-07-05 14:43:29 +00002099 && !ArchiveHeaders
Kevin Enderby69fe98d2015-01-23 18:52:17 +00002100 && !(IndirectSymbols && MachOOpt)
Kevin Enderby9a509442015-01-27 21:28:24 +00002101 && !(DataInCode && MachOOpt)
Kevin Enderbyf6d25852015-01-31 00:37:11 +00002102 && !(LinkOptHints && MachOOpt)
Kevin Enderbycd66be52015-03-11 22:06:32 +00002103 && !(InfoPlist && MachOOpt)
Kevin Enderbybc847fa2015-03-16 20:08:09 +00002104 && !(DylibsUsed && MachOOpt)
2105 && !(DylibId && MachOOpt)
Kevin Enderby0fc11822015-04-01 20:57:01 +00002106 && !(ObjcMetaData && MachOOpt)
Jordan Rupprecht16a0de22018-12-20 00:57:06 +00002107 && !(!FilterSections.empty() && MachOOpt)
Igor Laevsky03a670c2016-01-26 15:09:42 +00002108 && !PrintFaultMaps
2109 && DwarfDumpType == DIDT_Null) {
Michael J. Spencer2670c252011-01-20 06:39:06 +00002110 cl::PrintHelpMessage();
Dimitry Andrice4f5d012017-12-18 19:46:56 +00002111 return 2;
2112 }
2113
Rafael Aulerb0e4b912018-03-09 19:13:44 +00002114 DisasmFuncsSet.insert(DisassembleFunctions.begin(),
2115 DisassembleFunctions.end());
2116
George Rimar73a27232019-01-15 09:19:18 +00002117 llvm::for_each(InputFilenames, dumpInput);
Dimitry Andrice4f5d012017-12-18 19:46:56 +00002118
2119 return EXIT_SUCCESS;
2120}