blob: aa9b13d1ec1a17c6adddd1ba35888a8853a873ba [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
Benjamin Kramer43a772e2011-09-19 17:56:04 +0000306static StringRef ToolName;
Michael J. Spencer2670c252011-01-20 06:39:06 +0000307
Clement Courbetd1a3bd42019-01-18 15:26:14 +0000308typedef std::vector<std::tuple<uint64_t, StringRef, uint8_t>> SectionSymbolsTy;
Clement Courbet2d7d4a32019-01-18 09:40:19 +0000309
George Rimarc1964882019-01-18 11:33:26 +0000310SectionFilter llvm::ToolSectionFilter(llvm::object::ObjectFile const &O) {
David Majnemer42531262016-08-12 03:55:06 +0000311 return SectionFilter(
312 [](llvm::object::SectionRef const &S) {
313 if (FilterSections.empty())
314 return true;
315 llvm::StringRef String;
316 std::error_code error = S.getName(String);
317 if (error)
318 return false;
319 return is_contained(FilterSections, String);
320 },
321 O);
Colin LeMahieu77804be2015-07-29 15:45:39 +0000322}
Colin LeMahieu77804be2015-07-29 15:45:39 +0000323
Davide Italianoccd53fe2015-08-05 07:18:31 +0000324void llvm::error(std::error_code EC) {
Mark Seaborneb03ac52014-01-25 00:32:01 +0000325 if (!EC)
Davide Italianoccd53fe2015-08-05 07:18:31 +0000326 return;
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000327 WithColor::error(errs(), ToolName)
328 << "reading file: " << EC.message() << ".\n";
Davide Italiano140af642015-12-25 18:16:45 +0000329 errs().flush();
Davide Italiano7f6c3012015-08-06 00:18:52 +0000330 exit(1);
Michael J. Spencer2670c252011-01-20 06:39:06 +0000331}
332
Fangrui Songf67de6c2019-04-08 16:24:08 +0000333void llvm::error(Error E) {
334 if (!E)
335 return;
336 WithColor::error(errs(), ToolName) << toString(std::move(E));
337 exit(1);
338}
339
Kevin Enderby42398052016-06-28 23:16:13 +0000340LLVM_ATTRIBUTE_NORETURN void llvm::error(Twine Message) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000341 WithColor::error(errs(), ToolName) << Message << ".\n";
Kevin Enderby42398052016-06-28 23:16:13 +0000342 errs().flush();
343 exit(1);
344}
345
Paul Semel007dedb2018-07-18 16:39:21 +0000346void llvm::warn(StringRef Message) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000347 WithColor::warning(errs(), ToolName) << Message << ".\n";
Paul Semel007dedb2018-07-18 16:39:21 +0000348 errs().flush();
349}
350
Davide Italianoed9d95b2015-12-29 13:41:02 +0000351LLVM_ATTRIBUTE_NORETURN void llvm::report_error(StringRef File,
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000352 Twine Message) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000353 WithColor::error(errs(), ToolName)
354 << "'" << File << "': " << Message << ".\n";
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000355 exit(1);
356}
357
358LLVM_ATTRIBUTE_NORETURN void llvm::report_error(StringRef File,
Davide Italianoed9d95b2015-12-29 13:41:02 +0000359 std::error_code EC) {
Alexey Samsonov50d0fbd2015-06-04 18:34:11 +0000360 assert(EC);
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000361 WithColor::error(errs(), ToolName)
362 << "'" << File << "': " << EC.message() << ".\n";
Davide Italianoccd53fe2015-08-05 07:18:31 +0000363 exit(1);
Alexey Samsonov50d0fbd2015-06-04 18:34:11 +0000364}
365
Fangrui Songe7834bd2019-04-07 08:19:55 +0000366LLVM_ATTRIBUTE_NORETURN void llvm::report_error(Error E, StringRef File) {
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +0000367 assert(E);
368 std::string Buf;
369 raw_string_ostream OS(Buf);
Jonas Devlieghere45eb84f2018-11-11 01:46:03 +0000370 logAllUnhandledErrors(std::move(E), OS);
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +0000371 OS.flush();
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000372 WithColor::error(errs(), ToolName) << "'" << File << "': " << Buf;
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +0000373 exit(1);
374}
375
Fangrui Songe7834bd2019-04-07 08:19:55 +0000376LLVM_ATTRIBUTE_NORETURN void llvm::report_error(Error E, StringRef ArchiveName,
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000377 StringRef FileName,
Kevin Enderby9acb1092016-05-31 20:35:34 +0000378 StringRef ArchitectureName) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000379 assert(E);
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000380 WithColor::error(errs(), ToolName);
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000381 if (ArchiveName != "")
382 errs() << ArchiveName << "(" << FileName << ")";
383 else
Justin Bogner31d8b7d2016-10-26 22:37:52 +0000384 errs() << "'" << FileName << "'";
Kevin Enderby9acb1092016-05-31 20:35:34 +0000385 if (!ArchitectureName.empty())
386 errs() << " (for architecture " << ArchitectureName << ")";
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000387 std::string Buf;
388 raw_string_ostream OS(Buf);
Jonas Devlieghere45eb84f2018-11-11 01:46:03 +0000389 logAllUnhandledErrors(std::move(E), OS);
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000390 OS.flush();
Justin Bogner31d8b7d2016-10-26 22:37:52 +0000391 errs() << ": " << Buf;
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000392 exit(1);
393}
394
Fangrui Songe7834bd2019-04-07 08:19:55 +0000395LLVM_ATTRIBUTE_NORETURN void llvm::report_error(Error E, StringRef ArchiveName,
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000396 const object::Archive::Child &C,
Kevin Enderby9acb1092016-05-31 20:35:34 +0000397 StringRef ArchitectureName) {
Kevin Enderbyf4586032016-07-29 17:44:13 +0000398 Expected<StringRef> NameOrErr = C.getName();
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000399 // TODO: if we have a error getting the name then it would be nice to print
400 // the index of which archive member this is and or its offset in the
401 // archive instead of "???" as the name.
Kevin Enderbyf4586032016-07-29 17:44:13 +0000402 if (!NameOrErr) {
403 consumeError(NameOrErr.takeError());
Fangrui Songe7834bd2019-04-07 08:19:55 +0000404 llvm::report_error(std::move(E), ArchiveName, "???", ArchitectureName);
Kevin Enderbyf4586032016-07-29 17:44:13 +0000405 } else
Fangrui Songe7834bd2019-04-07 08:19:55 +0000406 llvm::report_error(std::move(E), ArchiveName, NameOrErr.get(),
Kevin Enderby9acb1092016-05-31 20:35:34 +0000407 ArchitectureName);
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000408}
409
Craig Toppere6cb63e2014-04-25 04:24:47 +0000410static const Target *getTarget(const ObjectFile *Obj = nullptr) {
Michael J. Spencer2670c252011-01-20 06:39:06 +0000411 // Figure out the target triple.
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000412 llvm::Triple TheTriple("unknown-unknown-unknown");
Michael J. Spencer05350e6d2011-01-20 07:22:04 +0000413 if (TripleName.empty()) {
George Rimar73a27232019-01-15 09:19:18 +0000414 if (Obj)
Vlad Tsyrklevichde620462017-09-19 02:22:48 +0000415 TheTriple = Obj->makeTriple();
Sam Parkerdf7c6ef2017-01-18 13:52:12 +0000416 } else {
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000417 TheTriple.setTriple(Triple::normalize(TripleName));
Vlad Tsyrklevichde620462017-09-19 02:22:48 +0000418
Sam Parkerdf7c6ef2017-01-18 13:52:12 +0000419 // Use the triple, but also try to combine with ARM build attributes.
420 if (Obj) {
421 auto Arch = Obj->getArch();
George Rimar73a27232019-01-15 09:19:18 +0000422 if (Arch == Triple::arm || Arch == Triple::armeb)
Sam Parkerdf7c6ef2017-01-18 13:52:12 +0000423 Obj->setARMSubArch(TheTriple);
Sam Parkerdf7c6ef2017-01-18 13:52:12 +0000424 }
425 }
Michael J. Spencer2670c252011-01-20 06:39:06 +0000426
427 // Get the target specific parser.
428 std::string Error;
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000429 const Target *TheTarget = TargetRegistry::lookupTarget(ArchName, TheTriple,
430 Error);
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000431 if (!TheTarget) {
432 if (Obj)
433 report_error(Obj->getFileName(), "can't find target: " + Error);
434 else
435 error("can't find target: " + Error);
436 }
Michael J. Spencer2670c252011-01-20 06:39:06 +0000437
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000438 // Update the triple name and return the found target.
439 TripleName = TheTriple.getTriple();
440 return TheTarget;
Michael J. Spencer2670c252011-01-20 06:39:06 +0000441}
442
George Rimar73a27232019-01-15 09:19:18 +0000443bool llvm::isRelocAddressLess(RelocationRef A, RelocationRef B) {
444 return A.getOffset() < B.getOffset();
Michael J. Spencer51862b32011-10-13 22:17:18 +0000445}
446
Fangrui Songf67de6c2019-04-08 16:24:08 +0000447static Error getRelocationValueString(const RelocationRef &Rel,
448 SmallVectorImpl<char> &Result) {
Rafael Espindola854038e2015-06-26 14:51:16 +0000449 const ObjectFile *Obj = Rel.getObject();
Rafael Espindola37070a52015-06-03 04:48:06 +0000450 if (auto *ELF = dyn_cast<ELFObjectFileBase>(Obj))
George Rimarc1964882019-01-18 11:33:26 +0000451 return getELFRelocationValueString(ELF, Rel, Result);
Rafael Espindola37070a52015-06-03 04:48:06 +0000452 if (auto *COFF = dyn_cast<COFFObjectFile>(Obj))
George Rimarc1964882019-01-18 11:33:26 +0000453 return getCOFFRelocationValueString(COFF, Rel, Result);
Sam Clegg4df5d762017-06-27 20:40:53 +0000454 if (auto *Wasm = dyn_cast<WasmObjectFile>(Obj))
George Rimarc1964882019-01-18 11:33:26 +0000455 return getWasmRelocationValueString(Wasm, Rel, Result);
Sam Clegg4df5d762017-06-27 20:40:53 +0000456 if (auto *MachO = dyn_cast<MachOObjectFile>(Obj))
George Rimarc1964882019-01-18 11:33:26 +0000457 return getMachORelocationValueString(MachO, Rel, Result);
Sam Clegg4df5d762017-06-27 20:40:53 +0000458 llvm_unreachable("unknown object file format");
Rafael Espindola37070a52015-06-03 04:48:06 +0000459}
460
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +0000461/// Indicates whether this relocation should hidden when listing
Rafael Espindola0ad71d92015-06-30 03:41:26 +0000462/// relocations, usually because it is the trailing part of a multipart
463/// relocation that will be printed as part of the leading relocation.
464static bool getHidden(RelocationRef RelRef) {
George Rimar73a27232019-01-15 09:19:18 +0000465 auto *MachO = dyn_cast<MachOObjectFile>(RelRef.getObject());
Rafael Espindola0ad71d92015-06-30 03:41:26 +0000466 if (!MachO)
467 return false;
468
469 unsigned Arch = MachO->getArch();
470 DataRefImpl Rel = RelRef.getRawDataRefImpl();
471 uint64_t Type = MachO->getRelocationType(Rel);
472
473 // On arches that use the generic relocations, GENERIC_RELOC_PAIR
474 // is always hidden.
George Rimar73a27232019-01-15 09:19:18 +0000475 if (Arch == Triple::x86 || Arch == Triple::arm || Arch == Triple::ppc)
476 return Type == MachO::GENERIC_RELOC_PAIR;
477
478 if (Arch == Triple::x86_64) {
Rafael Espindola0ad71d92015-06-30 03:41:26 +0000479 // On x86_64, X86_64_RELOC_UNSIGNED is hidden only when it follows
480 // an X86_64_RELOC_SUBTRACTOR.
481 if (Type == MachO::X86_64_RELOC_UNSIGNED && Rel.d.a > 0) {
482 DataRefImpl RelPrev = Rel;
483 RelPrev.d.a--;
484 uint64_t PrevType = MachO->getRelocationType(RelPrev);
485 if (PrevType == MachO::X86_64_RELOC_SUBTRACTOR)
486 return true;
487 }
488 }
489
490 return false;
491}
492
Sid Manningd9f28732018-05-14 19:46:08 +0000493namespace {
494class SourcePrinter {
495protected:
496 DILineInfo OldLineInfo;
497 const ObjectFile *Obj = nullptr;
498 std::unique_ptr<symbolize::LLVMSymbolizer> Symbolizer;
499 // File name to file contents of source
500 std::unordered_map<std::string, std::unique_ptr<MemoryBuffer>> SourceCache;
501 // Mark the line endings of the cached source
502 std::unordered_map<std::string, std::vector<StringRef>> LineCache;
503
504private:
505 bool cacheSource(const DILineInfo& LineInfoFile);
506
507public:
508 SourcePrinter() = default;
509 SourcePrinter(const ObjectFile *Obj, StringRef DefaultArch) : Obj(Obj) {
510 symbolize::LLVMSymbolizer::Options SymbolizerOpts(
511 DILineInfoSpecifier::FunctionNameKind::None, true, false, false,
512 DefaultArch);
513 Symbolizer.reset(new symbolize::LLVMSymbolizer(SymbolizerOpts));
514 }
515 virtual ~SourcePrinter() = default;
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000516 virtual void printSourceLine(raw_ostream &OS,
517 object::SectionedAddress Address,
Sid Manningd9f28732018-05-14 19:46:08 +0000518 StringRef Delimiter = "; ");
519};
520
521bool SourcePrinter::cacheSource(const DILineInfo &LineInfo) {
522 std::unique_ptr<MemoryBuffer> Buffer;
523 if (LineInfo.Source) {
524 Buffer = MemoryBuffer::getMemBuffer(*LineInfo.Source);
525 } else {
526 auto BufferOrError = MemoryBuffer::getFile(LineInfo.FileName);
527 if (!BufferOrError)
528 return false;
529 Buffer = std::move(*BufferOrError);
530 }
531 // Chomp the file to get lines
Fangrui Song47a76622019-04-07 10:16:46 +0000532 const char *BufferStart = Buffer->getBufferStart(),
533 *BufferEnd = Buffer->getBufferEnd();
534 std::vector<StringRef> &Lines = LineCache[LineInfo.FileName];
535 const char *Start = BufferStart;
536 for (const char *I = BufferStart; I != BufferEnd; ++I)
537 if (*I == '\n') {
538 Lines.emplace_back(Start, I - Start - (BufferStart < I && I[-1] == '\r'));
539 Start = I + 1;
Sid Manningd9f28732018-05-14 19:46:08 +0000540 }
Fangrui Song47a76622019-04-07 10:16:46 +0000541 if (Start < BufferEnd)
542 Lines.emplace_back(Start, BufferEnd - Start);
Sid Manningd9f28732018-05-14 19:46:08 +0000543 SourceCache[LineInfo.FileName] = std::move(Buffer);
544 return true;
545}
546
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000547void SourcePrinter::printSourceLine(raw_ostream &OS,
548 object::SectionedAddress Address,
Sid Manningd9f28732018-05-14 19:46:08 +0000549 StringRef Delimiter) {
550 if (!Symbolizer)
551 return;
552 DILineInfo LineInfo = DILineInfo();
Eric Christopher1857edb2019-03-28 01:12:13 +0000553 auto ExpectedLineInfo =
Sid Manningd9f28732018-05-14 19:46:08 +0000554 Symbolizer->symbolizeCode(Obj->getFileName(), Address);
Eric Christopher1857edb2019-03-28 01:12:13 +0000555 if (!ExpectedLineInfo)
556 consumeError(ExpectedLineInfo.takeError());
Sid Manningd9f28732018-05-14 19:46:08 +0000557 else
Eric Christopher1857edb2019-03-28 01:12:13 +0000558 LineInfo = *ExpectedLineInfo;
Sid Manningd9f28732018-05-14 19:46:08 +0000559
560 if ((LineInfo.FileName == "<invalid>") || OldLineInfo.Line == LineInfo.Line ||
561 LineInfo.Line == 0)
562 return;
563
564 if (PrintLines)
565 OS << Delimiter << LineInfo.FileName << ":" << LineInfo.Line << "\n";
566 if (PrintSource) {
567 if (SourceCache.find(LineInfo.FileName) == SourceCache.end())
568 if (!cacheSource(LineInfo))
569 return;
Fangrui Song47a76622019-04-07 10:16:46 +0000570 auto LineBuffer = LineCache.find(LineInfo.FileName);
571 if (LineBuffer != LineCache.end()) {
572 if (LineInfo.Line > LineBuffer->second.size())
573 return;
574 // Vector begins at 0, line numbers are non-zero
575 OS << Delimiter << LineBuffer->second[LineInfo.Line - 1] << '\n';
Sid Manningd9f28732018-05-14 19:46:08 +0000576 }
577 }
578 OldLineInfo = LineInfo;
579}
580
581static bool isArmElf(const ObjectFile *Obj) {
582 return (Obj->isELF() &&
583 (Obj->getArch() == Triple::aarch64 ||
584 Obj->getArch() == Triple::aarch64_be ||
585 Obj->getArch() == Triple::arm || Obj->getArch() == Triple::armeb ||
586 Obj->getArch() == Triple::thumb ||
587 Obj->getArch() == Triple::thumbeb));
588}
589
George Rimar617adef2019-01-23 13:39:12 +0000590static void printRelocation(const RelocationRef &Rel, uint64_t Address,
591 uint8_t AddrSize) {
592 StringRef Fmt =
593 AddrSize > 4 ? "\t\t%016" PRIx64 ": " : "\t\t\t%08" PRIx64 ": ";
594 SmallString<16> Name;
595 SmallString<32> Val;
596 Rel.getTypeName(Name);
597 error(getRelocationValueString(Rel, Val));
598 outs() << format(Fmt.data(), Address) << Name << "\t" << Val << "\n";
599}
600
Sid Manningd9f28732018-05-14 19:46:08 +0000601class PrettyPrinter {
602public:
603 virtual ~PrettyPrinter() = default;
604 virtual void printInst(MCInstPrinter &IP, const MCInst *MI,
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000605 ArrayRef<uint8_t> Bytes,
606 object::SectionedAddress Address, raw_ostream &OS,
607 StringRef Annot, MCSubtargetInfo const &STI,
608 SourcePrinter *SP,
Sid Manningd9f28732018-05-14 19:46:08 +0000609 std::vector<RelocationRef> *Rels = nullptr) {
610 if (SP && (PrintSource || PrintLines))
611 SP->printSourceLine(OS, Address);
612 if (!NoLeadingAddr)
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000613 OS << format("%8" PRIx64 ":", Address.Address);
Sid Manningd9f28732018-05-14 19:46:08 +0000614 if (!NoShowRawInsn) {
615 OS << "\t";
616 dumpBytes(Bytes, OS);
617 }
618 if (MI)
619 IP.printInst(MI, OS, "", STI);
620 else
621 OS << " <unknown>";
622 }
623};
624PrettyPrinter PrettyPrinterInst;
625class HexagonPrettyPrinter : public PrettyPrinter {
626public:
627 void printLead(ArrayRef<uint8_t> Bytes, uint64_t Address,
628 raw_ostream &OS) {
629 uint32_t opcode =
630 (Bytes[3] << 24) | (Bytes[2] << 16) | (Bytes[1] << 8) | Bytes[0];
631 if (!NoLeadingAddr)
632 OS << format("%8" PRIx64 ":", Address);
633 if (!NoShowRawInsn) {
634 OS << "\t";
635 dumpBytes(Bytes.slice(0, 4), OS);
636 OS << format("%08" PRIx32, opcode);
637 }
638 }
639 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000640 object::SectionedAddress Address, raw_ostream &OS,
641 StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP,
Sid Manningd9f28732018-05-14 19:46:08 +0000642 std::vector<RelocationRef> *Rels) override {
643 if (SP && (PrintSource || PrintLines))
644 SP->printSourceLine(OS, Address, "");
645 if (!MI) {
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000646 printLead(Bytes, Address.Address, OS);
Sid Manningd9f28732018-05-14 19:46:08 +0000647 OS << " <unknown>";
648 return;
649 }
650 std::string Buffer;
651 {
652 raw_string_ostream TempStream(Buffer);
653 IP.printInst(MI, TempStream, "", STI);
654 }
655 StringRef Contents(Buffer);
656 // Split off bundle attributes
657 auto PacketBundle = Contents.rsplit('\n');
658 // Split off first instruction from the rest
659 auto HeadTail = PacketBundle.first.split('\n');
660 auto Preamble = " { ";
661 auto Separator = "";
Sid Manningd9f28732018-05-14 19:46:08 +0000662
663 // Hexagon's packets require relocations to be inline rather than
664 // clustered at the end of the packet.
George Rimar617adef2019-01-23 13:39:12 +0000665 std::vector<RelocationRef>::const_iterator RelCur = Rels->begin();
666 std::vector<RelocationRef>::const_iterator RelEnd = Rels->end();
Sid Manningd9f28732018-05-14 19:46:08 +0000667 auto PrintReloc = [&]() -> void {
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000668 while ((RelCur != RelEnd) && (RelCur->getOffset() <= Address.Address)) {
669 if (RelCur->getOffset() == Address.Address) {
670 printRelocation(*RelCur, Address.Address, 4);
Sid Manningd9f28732018-05-14 19:46:08 +0000671 return;
672 }
George Rimar73a27232019-01-15 09:19:18 +0000673 ++RelCur;
Sid Manningd9f28732018-05-14 19:46:08 +0000674 }
675 };
676
George Rimar73a27232019-01-15 09:19:18 +0000677 while (!HeadTail.first.empty()) {
Sid Manningd9f28732018-05-14 19:46:08 +0000678 OS << Separator;
679 Separator = "\n";
680 if (SP && (PrintSource || PrintLines))
681 SP->printSourceLine(OS, Address, "");
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000682 printLead(Bytes, Address.Address, OS);
Sid Manningd9f28732018-05-14 19:46:08 +0000683 OS << Preamble;
684 Preamble = " ";
685 StringRef Inst;
686 auto Duplex = HeadTail.first.split('\v');
George Rimar73a27232019-01-15 09:19:18 +0000687 if (!Duplex.second.empty()) {
Sid Manningd9f28732018-05-14 19:46:08 +0000688 OS << Duplex.first;
689 OS << "; ";
690 Inst = Duplex.second;
691 }
692 else
693 Inst = HeadTail.first;
694 OS << Inst;
695 HeadTail = HeadTail.second.split('\n');
696 if (HeadTail.first.empty())
697 OS << " } " << PacketBundle.second;
698 PrintReloc();
699 Bytes = Bytes.slice(4);
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000700 Address.Address += 4;
Sid Manningd9f28732018-05-14 19:46:08 +0000701 }
702 }
703};
704HexagonPrettyPrinter HexagonPrettyPrinterInst;
705
706class AMDGCNPrettyPrinter : public PrettyPrinter {
707public:
708 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000709 object::SectionedAddress Address, raw_ostream &OS,
710 StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP,
Sid Manningd9f28732018-05-14 19:46:08 +0000711 std::vector<RelocationRef> *Rels) override {
712 if (SP && (PrintSource || PrintLines))
713 SP->printSourceLine(OS, Address);
714
715 typedef support::ulittle32_t U32;
716
717 if (MI) {
718 SmallString<40> InstStr;
719 raw_svector_ostream IS(InstStr);
720
721 IP.printInst(MI, IS, "", STI);
722
723 OS << left_justify(IS.str(), 60);
724 } else {
725 // an unrecognized encoding - this is probably data so represent it
726 // using the .long directive, or .byte directive if fewer than 4 bytes
727 // remaining
728 if (Bytes.size() >= 4) {
729 OS << format("\t.long 0x%08" PRIx32 " ",
730 static_cast<uint32_t>(*reinterpret_cast<const U32*>(Bytes.data())));
731 OS.indent(42);
732 } else {
733 OS << format("\t.byte 0x%02" PRIx8, Bytes[0]);
734 for (unsigned int i = 1; i < Bytes.size(); i++)
735 OS << format(", 0x%02" PRIx8, Bytes[i]);
736 OS.indent(55 - (6 * Bytes.size()));
737 }
738 }
739
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000740 OS << format("// %012" PRIX64 ": ", Address.Address);
Sid Manningd9f28732018-05-14 19:46:08 +0000741 if (Bytes.size() >=4) {
742 for (auto D : makeArrayRef(reinterpret_cast<const U32*>(Bytes.data()),
743 Bytes.size() / sizeof(U32)))
744 // D should be explicitly casted to uint32_t here as it is passed
745 // by format to snprintf as vararg.
746 OS << format("%08" PRIX32 " ", static_cast<uint32_t>(D));
747 } else {
748 for (unsigned int i = 0; i < Bytes.size(); i++)
749 OS << format("%02" PRIX8 " ", Bytes[i]);
750 }
751
752 if (!Annot.empty())
753 OS << "// " << Annot;
754 }
755};
756AMDGCNPrettyPrinter AMDGCNPrettyPrinterInst;
757
758class BPFPrettyPrinter : public PrettyPrinter {
759public:
760 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000761 object::SectionedAddress Address, raw_ostream &OS,
762 StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP,
Sid Manningd9f28732018-05-14 19:46:08 +0000763 std::vector<RelocationRef> *Rels) override {
764 if (SP && (PrintSource || PrintLines))
765 SP->printSourceLine(OS, Address);
766 if (!NoLeadingAddr)
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000767 OS << format("%8" PRId64 ":", Address.Address / 8);
Sid Manningd9f28732018-05-14 19:46:08 +0000768 if (!NoShowRawInsn) {
769 OS << "\t";
770 dumpBytes(Bytes, OS);
771 }
772 if (MI)
773 IP.printInst(MI, OS, "", STI);
774 else
775 OS << " <unknown>";
776 }
777};
778BPFPrettyPrinter BPFPrettyPrinterInst;
779
780PrettyPrinter &selectPrettyPrinter(Triple const &Triple) {
781 switch(Triple.getArch()) {
782 default:
783 return PrettyPrinterInst;
784 case Triple::hexagon:
785 return HexagonPrettyPrinterInst;
786 case Triple::amdgcn:
787 return AMDGCNPrettyPrinterInst;
788 case Triple::bpfel:
789 case Triple::bpfeb:
790 return BPFPrettyPrinterInst;
791 }
792}
793}
794
Sam Koltonc05d7782016-08-17 10:17:57 +0000795static uint8_t getElfSymbolType(const ObjectFile *Obj, const SymbolRef &Sym) {
796 assert(Obj->isELF());
797 if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(Obj))
798 return Elf32LEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
799 if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(Obj))
800 return Elf64LEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
801 if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(Obj))
802 return Elf32BEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
803 if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(Obj))
804 return Elf64BEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
805 llvm_unreachable("Unsupported binary format");
806}
807
Sam Parker5fba45a2017-02-08 09:44:18 +0000808template <class ELFT> static void
809addDynamicElfSymbols(const ELFObjectFile<ELFT> *Obj,
810 std::map<SectionRef, SectionSymbolsTy> &AllSymbols) {
811 for (auto Symbol : Obj->getDynamicSymbolIterators()) {
812 uint8_t SymbolType = Symbol.getELFType();
813 if (SymbolType != ELF::STT_FUNC || Symbol.getSize() == 0)
814 continue;
815
Fangrui Songe7834bd2019-04-07 08:19:55 +0000816 uint64_t Address = unwrapOrError(Symbol.getAddress(), Obj->getFileName());
817 StringRef Name = unwrapOrError(Symbol.getName(), Obj->getFileName());
818 if (Name.empty())
Sam Parker5fba45a2017-02-08 09:44:18 +0000819 continue;
820
Fangrui Songe7834bd2019-04-07 08:19:55 +0000821 section_iterator SecI =
822 unwrapOrError(Symbol.getSection(), Obj->getFileName());
Sam Parker5fba45a2017-02-08 09:44:18 +0000823 if (SecI == Obj->section_end())
824 continue;
825
Fangrui Songe7834bd2019-04-07 08:19:55 +0000826 AllSymbols[*SecI].emplace_back(Address, Name, SymbolType);
Sam Parker5fba45a2017-02-08 09:44:18 +0000827 }
828}
829
830static void
831addDynamicElfSymbols(const ObjectFile *Obj,
832 std::map<SectionRef, SectionSymbolsTy> &AllSymbols) {
833 assert(Obj->isELF());
834 if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(Obj))
835 addDynamicElfSymbols(Elf32LEObj, AllSymbols);
836 else if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(Obj))
837 addDynamicElfSymbols(Elf64LEObj, AllSymbols);
838 else if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(Obj))
839 addDynamicElfSymbols(Elf32BEObj, AllSymbols);
840 else if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(Obj))
841 addDynamicElfSymbols(Elf64BEObj, AllSymbols);
842 else
843 llvm_unreachable("Unsupported binary format");
844}
845
Joel Galenson134cf472018-08-24 15:21:57 +0000846static void addPltEntries(const ObjectFile *Obj,
847 std::map<SectionRef, SectionSymbolsTy> &AllSymbols,
848 StringSaver &Saver) {
849 Optional<SectionRef> Plt = None;
850 for (const SectionRef &Section : Obj->sections()) {
851 StringRef Name;
852 if (Section.getName(Name))
853 continue;
854 if (Name == ".plt")
855 Plt = Section;
856 }
857 if (!Plt)
858 return;
859 if (auto *ElfObj = dyn_cast<ELFObjectFileBase>(Obj)) {
860 for (auto PltEntry : ElfObj->getPltAddresses()) {
861 SymbolRef Symbol(PltEntry.first, ElfObj);
Joel Galenson134cf472018-08-24 15:21:57 +0000862 uint8_t SymbolType = getElfSymbolType(Obj, Symbol);
863
Fangrui Songe7834bd2019-04-07 08:19:55 +0000864 StringRef Name = unwrapOrError(Symbol.getName(), Obj->getFileName());
865 if (!Name.empty())
866 AllSymbols[*Plt].emplace_back(
867 PltEntry.second, Saver.save((Name + "@plt").str()), SymbolType);
Joel Galenson134cf472018-08-24 15:21:57 +0000868 }
869 }
870}
871
George Rimar70d197d2019-01-10 14:55:26 +0000872// Normally the disassembly output will skip blocks of zeroes. This function
873// returns the number of zero bytes that can be skipped when dumping the
874// disassembly of the instructions in Buf.
875static size_t countSkippableZeroBytes(ArrayRef<uint8_t> Buf) {
George Rimar70d197d2019-01-10 14:55:26 +0000876 // Find the number of leading zeroes.
877 size_t N = 0;
878 while (N < Buf.size() && !Buf[N])
879 ++N;
880
881 // We may want to skip blocks of zero bytes, but unless we see
882 // at least 8 of them in a row.
883 if (N < 8)
884 return 0;
885
886 // We skip zeroes in multiples of 4 because do not want to truncate an
887 // instruction if it starts with a zero byte.
888 return N & ~0x3;
889}
890
George Rimar121fcd72019-01-22 14:09:37 +0000891// Returns a map from sections to their relocations.
892static std::map<SectionRef, std::vector<RelocationRef>>
893getRelocsMap(llvm::object::ObjectFile const &Obj) {
894 std::map<SectionRef, std::vector<RelocationRef>> Ret;
895 for (const SectionRef &Section : ToolSectionFilter(Obj)) {
896 section_iterator RelSec = Section.getRelocatedSection();
897 if (RelSec == Obj.section_end())
898 continue;
899 std::vector<RelocationRef> &V = Ret[*RelSec];
900 for (const RelocationRef &R : Section.relocations())
901 V.push_back(R);
902 // Sort relocations by address.
903 llvm::sort(V, isRelocAddressLess);
904 }
905 return Ret;
906}
907
George Rimar4c3b2972019-01-28 10:44:01 +0000908// Used for --adjust-vma to check if address should be adjusted by the
909// specified value for a given section.
910// For ELF we do not adjust non-allocatable sections like debug ones,
911// because they are not loadable.
912// TODO: implement for other file formats.
913static bool shouldAdjustVA(const SectionRef &Section) {
914 const ObjectFile *Obj = Section.getObject();
915 if (isa<object::ELFObjectFileBase>(Obj))
916 return ELFSectionRef(Section).getFlags() & ELF::SHF_ALLOC;
917 return false;
918}
919
Fangrui Song32087b62019-04-07 16:33:24 +0000920static uint64_t
921dumpARMELFData(uint64_t SectionAddr, uint64_t Index, uint64_t End,
922 const ObjectFile *Obj, ArrayRef<uint8_t> Bytes,
923 const std::vector<uint64_t> &TextMappingSymsAddr) {
924 support::endianness Endian =
925 Obj->isLittleEndian() ? support::little : support::big;
926 while (Index < End) {
927 outs() << format("%8" PRIx64 ":", SectionAddr + Index);
928 outs() << "\t";
929 if (Index + 4 <= End) {
930 dumpBytes(Bytes.slice(Index, 4), outs());
931 outs() << "\t.word\t"
932 << format_hex(
933 support::endian::read32(Bytes.data() + Index, Endian), 10);
934 Index += 4;
935 } else if (Index + 2 <= End) {
936 dumpBytes(Bytes.slice(Index, 2), outs());
937 outs() << "\t\t.short\t"
938 << format_hex(
939 support::endian::read16(Bytes.data() + Index, Endian), 6);
940 Index += 2;
941 } else {
942 dumpBytes(Bytes.slice(Index, 1), outs());
943 outs() << "\t\t.byte\t" << format_hex(Bytes[0], 4);
944 ++Index;
945 }
946 outs() << "\n";
947 if (std::binary_search(TextMappingSymsAddr.begin(),
948 TextMappingSymsAddr.end(), Index))
949 break;
950 }
951 return Index;
952}
953
954static void dumpELFData(uint64_t SectionAddr, uint64_t Index, uint64_t End,
955 ArrayRef<uint8_t> Bytes) {
956 // print out data up to 8 bytes at a time in hex and ascii
957 uint8_t AsciiData[9] = {'\0'};
958 uint8_t Byte;
959 int NumBytes = 0;
960
961 for (; Index < End; ++Index) {
962 if (NumBytes == 0) {
963 outs() << format("%8" PRIx64 ":", SectionAddr + Index);
964 outs() << "\t";
965 }
966 Byte = Bytes.slice(Index)[0];
967 outs() << format(" %02x", Byte);
968 AsciiData[NumBytes] = isPrint(Byte) ? Byte : '.';
969
970 uint8_t IndentOffset = 0;
971 NumBytes++;
972 if (Index == End - 1 || NumBytes > 8) {
973 // Indent the space for less than 8 bytes data.
974 // 2 spaces for byte and one for space between bytes
975 IndentOffset = 3 * (8 - NumBytes);
976 for (int Excess = NumBytes; Excess < 8; Excess++)
977 AsciiData[Excess] = '\0';
978 NumBytes = 8;
979 }
980 if (NumBytes == 8) {
981 AsciiData[8] = '\0';
982 outs() << std::string(IndentOffset, ' ') << " ";
983 outs() << reinterpret_cast<char *>(AsciiData);
984 outs() << '\n';
985 NumBytes = 0;
986 }
987 }
988}
989
George Rimarbcbe98b2019-01-23 10:33:26 +0000990static void disassembleObject(const Target *TheTarget, const ObjectFile *Obj,
991 MCContext &Ctx, MCDisassembler *DisAsm,
992 const MCInstrAnalysis *MIA, MCInstPrinter *IP,
993 const MCSubtargetInfo *STI, PrettyPrinter &PIP,
994 SourcePrinter &SP, bool InlineRelocs) {
George Rimar121fcd72019-01-22 14:09:37 +0000995 std::map<SectionRef, std::vector<RelocationRef>> RelocMap;
996 if (InlineRelocs)
997 RelocMap = getRelocsMap(*Obj);
Mark Seaborn0929d3d2014-01-25 17:38:19 +0000998
David Majnemer81afca62015-07-07 22:06:59 +0000999 // Create a mapping from virtual address to symbol name. This is used to
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001000 // pretty print the symbols while disassembling.
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001001 std::map<SectionRef, SectionSymbolsTy> AllSymbols;
Sterling Augustinebc78b622018-06-28 18:57:13 +00001002 SectionSymbolsTy AbsoluteSymbols;
Fangrui Songe7834bd2019-04-07 08:19:55 +00001003 const StringRef FileName = Obj->getFileName();
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001004 for (const SymbolRef &Symbol : Obj->symbols()) {
Fangrui Songe7834bd2019-04-07 08:19:55 +00001005 uint64_t Address = unwrapOrError(Symbol.getAddress(), FileName);
David Majnemer2603a8fa2015-07-09 18:11:40 +00001006
Fangrui Songe7834bd2019-04-07 08:19:55 +00001007 StringRef Name = unwrapOrError(Symbol.getName(), FileName);
1008 if (Name.empty())
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001009 continue;
David Majnemer81afca62015-07-07 22:06:59 +00001010
Sam Koltonc05d7782016-08-17 10:17:57 +00001011 uint8_t SymbolType = ELF::STT_NOTYPE;
Matt Davis82937e42019-01-31 19:42:21 +00001012 if (Obj->isELF()) {
Sam Koltonc05d7782016-08-17 10:17:57 +00001013 SymbolType = getElfSymbolType(Obj, Symbol);
Matt Davis82937e42019-01-31 19:42:21 +00001014 if (SymbolType == ELF::STT_SECTION)
1015 continue;
1016 }
David Majnemer81afca62015-07-07 22:06:59 +00001017
Fangrui Songe7834bd2019-04-07 08:19:55 +00001018 section_iterator SecI = unwrapOrError(Symbol.getSection(), FileName);
Sterling Augustinebc78b622018-06-28 18:57:13 +00001019 if (SecI != Obj->section_end())
Fangrui Songe7834bd2019-04-07 08:19:55 +00001020 AllSymbols[*SecI].emplace_back(Address, Name, SymbolType);
Sterling Augustinebc78b622018-06-28 18:57:13 +00001021 else
Fangrui Songe7834bd2019-04-07 08:19:55 +00001022 AbsoluteSymbols.emplace_back(Address, Name, SymbolType);
David Majnemer81afca62015-07-07 22:06:59 +00001023 }
Sam Parker5fba45a2017-02-08 09:44:18 +00001024 if (AllSymbols.empty() && Obj->isELF())
1025 addDynamicElfSymbols(Obj, AllSymbols);
David Majnemer81afca62015-07-07 22:06:59 +00001026
Joel Galenson134cf472018-08-24 15:21:57 +00001027 BumpPtrAllocator A;
1028 StringSaver Saver(A);
1029 addPltEntries(Obj, AllSymbols, Saver);
1030
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001031 // Create a mapping from virtual address to section.
1032 std::vector<std::pair<uint64_t, SectionRef>> SectionAddresses;
1033 for (SectionRef Sec : Obj->sections())
1034 SectionAddresses.emplace_back(Sec.getAddress(), Sec);
1035 array_pod_sort(SectionAddresses.begin(), SectionAddresses.end());
1036
1037 // Linked executables (.exe and .dll files) typically don't include a real
1038 // symbol table but they might contain an export table.
1039 if (const auto *COFFObj = dyn_cast<COFFObjectFile>(Obj)) {
1040 for (const auto &ExportEntry : COFFObj->export_directories()) {
1041 StringRef Name;
1042 error(ExportEntry.getSymbolName(Name));
1043 if (Name.empty())
1044 continue;
1045 uint32_t RVA;
1046 error(ExportEntry.getExportRVA(RVA));
1047
1048 uint64_t VA = COFFObj->getImageBase() + RVA;
Fangrui Song545ed222019-04-07 05:32:16 +00001049 auto Sec = llvm::upper_bound(
1050 SectionAddresses, VA,
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001051 [](uint64_t LHS, const std::pair<uint64_t, SectionRef> &RHS) {
1052 return LHS < RHS.first;
1053 });
Fangrui Song545ed222019-04-07 05:32:16 +00001054 if (Sec != SectionAddresses.begin()) {
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001055 --Sec;
Sam Koltonc05d7782016-08-17 10:17:57 +00001056 AllSymbols[Sec->second].emplace_back(VA, Name, ELF::STT_NOTYPE);
Fangrui Song545ed222019-04-07 05:32:16 +00001057 } else
Sterling Augustinebc78b622018-06-28 18:57:13 +00001058 AbsoluteSymbols.emplace_back(VA, Name, ELF::STT_NOTYPE);
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001059 }
1060 }
1061
1062 // Sort all the symbols, this allows us to use a simple binary search to find
1063 // a symbol near an address.
1064 for (std::pair<const SectionRef, SectionSymbolsTy> &SecSyms : AllSymbols)
1065 array_pod_sort(SecSyms.second.begin(), SecSyms.second.end());
Sterling Augustinebc78b622018-06-28 18:57:13 +00001066 array_pod_sort(AbsoluteSymbols.begin(), AbsoluteSymbols.end());
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001067
Colin LeMahieu77804be2015-07-29 15:45:39 +00001068 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Colin LeMahieuf34933e2015-07-23 20:58:49 +00001069 if (!DisassembleAll && (!Section.isText() || Section.isVirtual()))
Mark Seaborneb03ac52014-01-25 00:32:01 +00001070 continue;
Michael J. Spencer1d6167f2011-06-25 17:55:23 +00001071
Rafael Espindola80291272014-10-08 15:28:58 +00001072 uint64_t SectionAddr = Section.getAddress();
1073 uint64_t SectSize = Section.getSize();
David Majnemer185b5b12014-11-11 09:58:25 +00001074 if (!SectSize)
1075 continue;
Simon Atanasyan2b614e12014-02-24 22:12:11 +00001076
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001077 // Get the list of all the symbols in this section.
1078 SectionSymbolsTy &Symbols = AllSymbols[Section];
Davide Italianof0706882015-10-01 21:57:09 +00001079 std::vector<uint64_t> DataMappingSymsAddr;
1080 std::vector<uint64_t> TextMappingSymsAddr;
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001081 if (isArmElf(Obj)) {
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001082 for (const auto &Symb : Symbols) {
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001083 uint64_t Address = std::get<0>(Symb);
1084 StringRef Name = std::get<1>(Symb);
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001085 if (Name.startswith("$d"))
David Majnemer153722d2015-11-18 04:35:32 +00001086 DataMappingSymsAddr.push_back(Address - SectionAddr);
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001087 if (Name.startswith("$x"))
David Majnemer153722d2015-11-18 04:35:32 +00001088 TextMappingSymsAddr.push_back(Address - SectionAddr);
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001089 if (Name.startswith("$a"))
1090 TextMappingSymsAddr.push_back(Address - SectionAddr);
1091 if (Name.startswith("$t"))
1092 TextMappingSymsAddr.push_back(Address - SectionAddr);
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001093 }
1094 }
1095
Fangrui Song0cac7262018-09-27 02:13:45 +00001096 llvm::sort(DataMappingSymsAddr);
1097 llvm::sort(TextMappingSymsAddr);
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001098
Sam Kolton3381d7a2016-10-06 13:46:08 +00001099 if (Obj->isELF() && Obj->getArch() == Triple::amdgcn) {
1100 // AMDGPU disassembler uses symbolizer for printing labels
1101 std::unique_ptr<MCRelocationInfo> RelInfo(
1102 TheTarget->createMCRelocationInfo(TripleName, Ctx));
1103 if (RelInfo) {
1104 std::unique_ptr<MCSymbolizer> Symbolizer(
1105 TheTarget->createMCSymbolizer(
1106 TripleName, nullptr, nullptr, &Symbols, &Ctx, std::move(RelInfo)));
1107 DisAsm->setSymbolizer(std::move(Symbolizer));
1108 }
1109 }
1110
Rafael Espindolaa9f810b2012-12-21 03:47:03 +00001111 StringRef SegmentName = "";
Mark Seaborneb03ac52014-01-25 00:32:01 +00001112 if (const MachOObjectFile *MachO = dyn_cast<const MachOObjectFile>(Obj)) {
Alexey Samsonov48803e52014-03-13 14:37:36 +00001113 DataRefImpl DR = Section.getRawDataRefImpl();
Rafael Espindola56f976f2013-04-18 18:08:55 +00001114 SegmentName = MachO->getSectionFinalSegmentName(DR);
Rafael Espindolaa9f810b2012-12-21 03:47:03 +00001115 }
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001116 StringRef SectionName;
1117 error(Section.getName(SectionName));
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001118
Rafael Espindola7884c952015-06-04 15:01:05 +00001119 // If the section has no symbol at the start, just insert a dummy one.
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001120 if (Symbols.empty() || std::get<0>(Symbols[0]) != 0) {
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001121 Symbols.insert(
1122 Symbols.begin(),
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001123 std::make_tuple(SectionAddr, SectionName,
1124 Section.isText() ? ELF::STT_FUNC : ELF::STT_OBJECT));
Sam Koltonc05d7782016-08-17 10:17:57 +00001125 }
Alp Tokere69170a2014-06-26 22:52:05 +00001126
1127 SmallString<40> Comments;
1128 raw_svector_ostream CommentStream(Comments);
Ahmed Bougachaad1084d2013-05-24 00:39:57 +00001129
Rafael Espindola7fc5b872014-11-12 02:04:27 +00001130 StringRef BytesStr;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001131 error(Section.getContents(BytesStr));
Fangrui Song6a0746a2019-04-07 03:58:42 +00001132 ArrayRef<uint8_t> Bytes = arrayRefFromStringRef(BytesStr);
Rafael Espindola7fc5b872014-11-12 02:04:27 +00001133
George Rimar4c3b2972019-01-28 10:44:01 +00001134 uint64_t VMAAdjustment = 0;
1135 if (shouldAdjustVA(Section))
1136 VMAAdjustment = AdjustVMA;
1137
Michael J. Spencer2670c252011-01-20 06:39:06 +00001138 uint64_t Size;
1139 uint64_t Index;
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001140 bool PrintedSection = false;
George Rimar121fcd72019-01-22 14:09:37 +00001141 std::vector<RelocationRef> Rels = RelocMap[Section];
George Rimar73a27232019-01-15 09:19:18 +00001142 std::vector<RelocationRef>::const_iterator RelCur = Rels.begin();
1143 std::vector<RelocationRef>::const_iterator RelEnd = Rels.end();
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001144 // Disassemble symbol by symbol.
George Rimar73a27232019-01-15 09:19:18 +00001145 for (unsigned SI = 0, SE = Symbols.size(); SI != SE; ++SI) {
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001146 uint64_t Start = std::get<0>(Symbols[SI]) - SectionAddr;
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001147 // The end is either the section end or the beginning of the next
1148 // symbol.
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001149 uint64_t End = (SI == SE - 1)
1150 ? SectSize
1151 : std::get<0>(Symbols[SI + 1]) - SectionAddr;
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001152 // Don't try to disassemble beyond the end of section contents.
1153 if (End > SectSize)
1154 End = SectSize;
Rafael Espindolae45c7402014-08-17 16:31:39 +00001155 // If this symbol has the same address as the next symbol, then skip it.
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001156 if (Start >= End)
Michael J. Spenceree84f642011-10-13 20:37:08 +00001157 continue;
1158
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001159 // Check if we need to skip symbol
1160 // Skip if the symbol's data is not between StartAddress and StopAddress
Fangrui Song32087b62019-04-07 16:33:24 +00001161 if (End + SectionAddr <= StartAddress ||
1162 Start + SectionAddr >= StopAddress)
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001163 continue;
Fangrui Song32087b62019-04-07 16:33:24 +00001164
1165 // Stop disassembly at the stop address specified
1166 if (End + SectionAddr > StopAddress)
1167 End = StopAddress - SectionAddr;
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001168
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001169 /// Skip if user requested specific symbols and this is not in the list
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001170 if (!DisasmFuncsSet.empty() &&
1171 !DisasmFuncsSet.count(std::get<1>(Symbols[SI])))
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001172 continue;
1173
1174 if (!PrintedSection) {
1175 PrintedSection = true;
1176 outs() << "Disassembly of section ";
1177 if (!SegmentName.empty())
1178 outs() << SegmentName << ",";
1179 outs() << SectionName << ':';
1180 }
1181
Valery Pykhtinde048052016-04-07 07:24:01 +00001182 if (Obj->isELF() && Obj->getArch() == Triple::amdgcn) {
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001183 if (std::get<2>(Symbols[SI]) == ELF::STT_AMDGPU_HSA_KERNEL) {
Sam Koltonc05d7782016-08-17 10:17:57 +00001184 // skip amd_kernel_code_t at the begining of kernel symbol (256 bytes)
1185 Start += 256;
1186 }
George Rimar73a27232019-01-15 09:19:18 +00001187 if (SI == SE - 1 ||
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001188 std::get<2>(Symbols[SI + 1]) == ELF::STT_AMDGPU_HSA_KERNEL) {
Sam Koltonc05d7782016-08-17 10:17:57 +00001189 // cut trailing zeroes at the end of kernel
1190 // cut up to 256 bytes
1191 const uint64_t EndAlign = 256;
1192 const auto Limit = End - (std::min)(EndAlign, End - Start);
1193 while (End > Limit &&
1194 *reinterpret_cast<const support::ulittle32_t*>(&Bytes[End - 4]) == 0)
1195 End -= 4;
1196 }
Valery Pykhtinde048052016-04-07 07:24:01 +00001197 }
1198
George Rimar6622d412018-12-19 10:21:45 +00001199 outs() << '\n';
George Rimar3ba0f3c02019-01-09 14:43:33 +00001200 if (!NoLeadingAddr)
George Rimar4c3b2972019-01-28 10:44:01 +00001201 outs() << format("%016" PRIx64 " ",
1202 SectionAddr + Start + VMAAdjustment);
George Rimar3ba0f3c02019-01-09 14:43:33 +00001203
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001204 StringRef SymbolName = std::get<1>(Symbols[SI]);
George Rimar6622d412018-12-19 10:21:45 +00001205 if (Demangle)
1206 outs() << demangle(SymbolName) << ":\n";
1207 else
1208 outs() << SymbolName << ":\n";
Michael J. Spencer2670c252011-01-20 06:39:06 +00001209
Francis Visoiu Mistrih18346822018-04-19 17:02:57 +00001210 // Don't print raw contents of a virtual section. A virtual section
1211 // doesn't have any contents in the file.
1212 if (Section.isVirtual()) {
1213 outs() << "...\n";
1214 continue;
1215 }
1216
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001217#ifndef NDEBUG
Mark Seaborneb03ac52014-01-25 00:32:01 +00001218 raw_ostream &DebugOut = DebugFlag ? dbgs() : nulls();
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001219#else
Mark Seaborneb03ac52014-01-25 00:32:01 +00001220 raw_ostream &DebugOut = nulls();
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001221#endif
1222
Wouter van Oortmerssenf3b762a2019-01-17 18:14:09 +00001223 // Some targets (like WebAssembly) have a special prelude at the start
1224 // of each symbol.
1225 DisAsm->onSymbolStart(SymbolName, Size, Bytes.slice(Start, End - Start),
1226 SectionAddr + Start, DebugOut, CommentStream);
1227 Start += Size;
1228
Fangrui Song32087b62019-04-07 16:33:24 +00001229 Index = Start;
1230 if (SectionAddr < StartAddress)
1231 Index = std::max<uint64_t>(Index, StartAddress - SectionAddr);
Owen Andersona0c3b972011-09-15 23:38:46 +00001232
Fangrui Song32087b62019-04-07 16:33:24 +00001233 // If there is a data symbol inside an ELF text section and we are
1234 // only disassembling text (applicable all architectures), we are in a
1235 // situation where we must print the data and not disassemble it.
1236 if (Obj->isELF() && std::get<2>(Symbols[SI]) == ELF::STT_OBJECT &&
1237 !DisassembleAll && Section.isText()) {
1238 dumpELFData(SectionAddr, Index, End, Bytes);
1239 Index = End;
1240 }
1241
1242 bool CheckARMELFData = isArmElf(Obj) &&
1243 std::get<2>(Symbols[SI]) != ELF::STT_OBJECT &&
1244 !DisassembleAll;
Fangrui Song32087b62019-04-07 16:33:24 +00001245 while (Index < End) {
1246 // AArch64 ELF binaries can interleave data and text in the same
1247 // section. We rely on the markers introduced to understand what we
1248 // need to dump. If the data marker is within a function, it is
1249 // denoted as a word/short etc.
1250 if (CheckARMELFData &&
Fangrui Song545ed222019-04-07 05:32:16 +00001251 std::binary_search(DataMappingSymsAddr.begin(),
1252 DataMappingSymsAddr.end(), Index)) {
Fangrui Song32087b62019-04-07 16:33:24 +00001253 Index = dumpARMELFData(SectionAddr, Index, End, Obj, Bytes,
1254 TextMappingSymsAddr);
1255 continue;
Davide Italianof0706882015-10-01 21:57:09 +00001256 }
1257
Fangrui Song32087b62019-04-07 16:33:24 +00001258 // When -z or --disassemble-zeroes are given we always dissasemble
1259 // them. Otherwise we might want to skip zero bytes we see.
George Rimarc5f29202019-02-19 12:38:36 +00001260 if (!DisassembleZeroes) {
1261 uint64_t MaxOffset = End - Index;
1262 // For -reloc: print zero blocks patched by relocations, so that
1263 // relocations can be shown in the dump.
1264 if (RelCur != RelEnd)
1265 MaxOffset = RelCur->getOffset() - Index;
1266
1267 if (size_t N =
1268 countSkippableZeroBytes(Bytes.slice(Index, MaxOffset))) {
1269 outs() << "\t\t..." << '\n';
1270 Index += N;
Fangrui Song32087b62019-04-07 16:33:24 +00001271 continue;
George Rimarc5f29202019-02-19 12:38:36 +00001272 }
George Rimar70d197d2019-01-10 14:55:26 +00001273 }
1274
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001275 // Disassemble a real instruction or a data when disassemble all is
1276 // provided
Fangrui Song996b9092019-04-08 01:22:38 +00001277 MCInst Inst;
Fangrui Song32087b62019-04-07 16:33:24 +00001278 bool Disassembled = DisAsm->getInstruction(
1279 Inst, Size, Bytes.slice(Index), SectionAddr + Index, DebugOut,
1280 CommentStream);
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001281 if (Size == 0)
1282 Size = 1;
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +00001283
Fangrui Song32087b62019-04-07 16:33:24 +00001284 PIP.printInst(
1285 *IP, Disassembled ? &Inst : nullptr, Bytes.slice(Index, Size),
1286 {SectionAddr + Index + VMAAdjustment, Section.getIndex()}, outs(),
1287 "", *STI, &SP, &Rels);
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001288 outs() << CommentStream.str();
1289 Comments.clear();
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001290
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001291 // Try to resolve the target of a call, tail call, etc. to a specific
1292 // symbol.
1293 if (MIA && (MIA->isCall(Inst) || MIA->isUnconditionalBranch(Inst) ||
1294 MIA->isConditionalBranch(Inst))) {
1295 uint64_t Target;
1296 if (MIA->evaluateBranch(Inst, SectionAddr + Index, Size, Target)) {
1297 // In a relocatable object, the target's section must reside in
1298 // the same section as the call instruction or it is accessed
1299 // through a relocation.
1300 //
1301 // In a non-relocatable object, the target may be in any section.
1302 //
1303 // N.B. We don't walk the relocations in the relocatable case yet.
1304 auto *TargetSectionSymbols = &Symbols;
1305 if (!Obj->isRelocatableObject()) {
Fangrui Song545ed222019-04-07 05:32:16 +00001306 auto SectionAddress = llvm::upper_bound(
1307 SectionAddresses, Target,
1308 [](uint64_t LHS, const std::pair<uint64_t, SectionRef> &RHS) {
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001309 return LHS < RHS.first;
1310 });
1311 if (SectionAddress != SectionAddresses.begin()) {
1312 --SectionAddress;
1313 TargetSectionSymbols = &AllSymbols[SectionAddress->second];
1314 } else {
Sterling Augustinebc78b622018-06-28 18:57:13 +00001315 TargetSectionSymbols = &AbsoluteSymbols;
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001316 }
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001317 }
David Majnemer2603a8fa2015-07-09 18:11:40 +00001318
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001319 // Find the first symbol in the section whose offset is less than
Sterling Augustinebc78b622018-06-28 18:57:13 +00001320 // or equal to the target. If there isn't a section that contains
1321 // the target, find the nearest preceding absolute symbol.
Fangrui Song545ed222019-04-07 05:32:16 +00001322 auto TargetSym = llvm::upper_bound(
1323 *TargetSectionSymbols, Target,
1324 [](uint64_t LHS,
1325 const std::tuple<uint64_t, StringRef, uint8_t> &RHS) {
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001326 return LHS < std::get<0>(RHS);
Sterling Augustinebc78b622018-06-28 18:57:13 +00001327 });
1328 if (TargetSym == TargetSectionSymbols->begin()) {
1329 TargetSectionSymbols = &AbsoluteSymbols;
Fangrui Song545ed222019-04-07 05:32:16 +00001330 TargetSym = llvm::upper_bound(
1331 AbsoluteSymbols, Target,
1332 [](uint64_t LHS,
1333 const std::tuple<uint64_t, StringRef, uint8_t> &RHS) {
1334 return LHS < std::get<0>(RHS);
1335 });
Sterling Augustinebc78b622018-06-28 18:57:13 +00001336 }
1337 if (TargetSym != TargetSectionSymbols->begin()) {
1338 --TargetSym;
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001339 uint64_t TargetAddress = std::get<0>(*TargetSym);
1340 StringRef TargetName = std::get<1>(*TargetSym);
1341 outs() << " <" << TargetName;
1342 uint64_t Disp = Target - TargetAddress;
Sterling Augustinebc78b622018-06-28 18:57:13 +00001343 if (Disp)
1344 outs() << "+0x" << Twine::utohexstr(Disp);
1345 outs() << '>';
David Majnemer81afca62015-07-07 22:06:59 +00001346 }
1347 }
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001348 }
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001349 outs() << "\n";
Michael J. Spencer51862b32011-10-13 22:17:18 +00001350
Sid Manningd9f28732018-05-14 19:46:08 +00001351 // Hexagon does this in pretty printer
George Rimarfd383e72019-01-23 10:52:38 +00001352 if (Obj->getArch() != Triple::hexagon) {
Sid Manningd9f28732018-05-14 19:46:08 +00001353 // Print relocation for instruction.
George Rimar73a27232019-01-15 09:19:18 +00001354 while (RelCur != RelEnd) {
George Rimar617adef2019-01-23 13:39:12 +00001355 uint64_t Offset = RelCur->getOffset();
Sid Manningd9f28732018-05-14 19:46:08 +00001356 // If this relocation is hidden, skip it.
Fangrui Song32087b62019-04-07 16:33:24 +00001357 if (getHidden(*RelCur) || SectionAddr + Offset < StartAddress) {
George Rimar73a27232019-01-15 09:19:18 +00001358 ++RelCur;
Sid Manningd9f28732018-05-14 19:46:08 +00001359 continue;
1360 }
1361
George Rimar740974d2019-01-28 10:48:54 +00001362 // Stop when RelCur's offset is past the current instruction.
George Rimar617adef2019-01-23 13:39:12 +00001363 if (Offset >= Index + Size)
George Rimar73a27232019-01-15 09:19:18 +00001364 break;
George Rimar617adef2019-01-23 13:39:12 +00001365
George Rimar4c3b2972019-01-28 10:44:01 +00001366 // When --adjust-vma is used, update the address printed.
1367 if (RelCur->getSymbol() != Obj->symbol_end()) {
1368 Expected<section_iterator> SymSI =
1369 RelCur->getSymbol()->getSection();
1370 if (SymSI && *SymSI != Obj->section_end() &&
Fangrui Song32087b62019-04-07 16:33:24 +00001371 shouldAdjustVA(**SymSI))
George Rimar4c3b2972019-01-28 10:44:01 +00001372 Offset += AdjustVMA;
1373 }
1374
George Rimar617adef2019-01-23 13:39:12 +00001375 printRelocation(*RelCur, SectionAddr + Offset,
1376 Obj->getBytesInAddress());
George Rimar73a27232019-01-15 09:19:18 +00001377 ++RelCur;
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001378 }
George Rimarfd383e72019-01-23 10:52:38 +00001379 }
Fangrui Song32087b62019-04-07 16:33:24 +00001380
1381 Index += Size;
Benjamin Kramer87ee76c2011-07-20 19:37:35 +00001382 }
Michael J. Spencer2670c252011-01-20 06:39:06 +00001383 }
1384 }
1385}
1386
George Rimarbcbe98b2019-01-23 10:33:26 +00001387static void disassembleObject(const ObjectFile *Obj, bool InlineRelocs) {
1388 if (StartAddress > StopAddress)
1389 error("Start address should be less than stop address");
1390
1391 const Target *TheTarget = getTarget(Obj);
1392
1393 // Package up features to be passed to target/subtarget
1394 SubtargetFeatures Features = Obj->getFeatures();
1395 if (!MAttrs.empty())
1396 for (unsigned I = 0; I != MAttrs.size(); ++I)
1397 Features.AddFeature(MAttrs[I]);
1398
1399 std::unique_ptr<const MCRegisterInfo> MRI(
1400 TheTarget->createMCRegInfo(TripleName));
1401 if (!MRI)
1402 report_error(Obj->getFileName(),
1403 "no register info for target " + TripleName);
1404
1405 // Set up disassembler.
1406 std::unique_ptr<const MCAsmInfo> AsmInfo(
1407 TheTarget->createMCAsmInfo(*MRI, TripleName));
1408 if (!AsmInfo)
1409 report_error(Obj->getFileName(),
1410 "no assembly info for target " + TripleName);
1411 std::unique_ptr<const MCSubtargetInfo> STI(
1412 TheTarget->createMCSubtargetInfo(TripleName, MCPU, Features.getString()));
1413 if (!STI)
1414 report_error(Obj->getFileName(),
1415 "no subtarget info for target " + TripleName);
1416 std::unique_ptr<const MCInstrInfo> MII(TheTarget->createMCInstrInfo());
1417 if (!MII)
1418 report_error(Obj->getFileName(),
1419 "no instruction info for target " + TripleName);
1420 MCObjectFileInfo MOFI;
1421 MCContext Ctx(AsmInfo.get(), MRI.get(), &MOFI);
1422 // FIXME: for now initialize MCObjectFileInfo with default values
1423 MOFI.InitMCObjectFileInfo(Triple(TripleName), false, Ctx);
1424
1425 std::unique_ptr<MCDisassembler> DisAsm(
1426 TheTarget->createMCDisassembler(*STI, Ctx));
1427 if (!DisAsm)
1428 report_error(Obj->getFileName(),
1429 "no disassembler for target " + TripleName);
1430
1431 std::unique_ptr<const MCInstrAnalysis> MIA(
1432 TheTarget->createMCInstrAnalysis(MII.get()));
1433
1434 int AsmPrinterVariant = AsmInfo->getAssemblerDialect();
1435 std::unique_ptr<MCInstPrinter> IP(TheTarget->createMCInstPrinter(
1436 Triple(TripleName), AsmPrinterVariant, *AsmInfo, *MII, *MRI));
1437 if (!IP)
1438 report_error(Obj->getFileName(),
1439 "no instruction printer for target " + TripleName);
1440 IP->setPrintImmHex(PrintImmHex);
1441
1442 PrettyPrinter &PIP = selectPrettyPrinter(Triple(TripleName));
1443 SourcePrinter SP(Obj, TheTarget->getName());
1444
Igor Kudrin2d3faad2019-02-26 12:15:14 +00001445 for (StringRef Opt : DisassemblerOptions)
1446 if (!IP->applyTargetSpecificCLOption(Opt))
1447 error("Unrecognized disassembler option: " + Opt);
1448
George Rimarbcbe98b2019-01-23 10:33:26 +00001449 disassembleObject(TheTarget, Obj, Ctx, DisAsm.get(), MIA.get(), IP.get(),
1450 STI.get(), PIP, SP, InlineRelocs);
1451}
1452
George Rimar73a27232019-01-15 09:19:18 +00001453void llvm::printRelocations(const ObjectFile *Obj) {
Greg Fitzgerald18432272014-03-20 22:55:15 +00001454 StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64 :
1455 "%08" PRIx64;
Rafael Espindola9219fe72016-03-21 20:59:15 +00001456 // Regular objdump doesn't print relocations in non-relocatable object
1457 // files.
1458 if (!Obj->isRelocatableObject())
1459 return;
Rafael Espindolac66d7612014-08-17 19:09:37 +00001460
Colin LeMahieu77804be2015-07-29 15:45:39 +00001461 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Alexey Samsonov48803e52014-03-13 14:37:36 +00001462 if (Section.relocation_begin() == Section.relocation_end())
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001463 continue;
George Rimar73a27232019-01-15 09:19:18 +00001464 StringRef SecName;
1465 error(Section.getName(SecName));
1466 outs() << "RELOCATION RECORDS FOR [" << SecName << "]:\n";
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00001467 for (const RelocationRef &Reloc : Section.relocations()) {
George Rimar73a27232019-01-15 09:19:18 +00001468 uint64_t Address = Reloc.getOffset();
1469 SmallString<32> RelocName;
1470 SmallString<32> ValueStr;
1471 if (Address < StartAddress || Address > StopAddress || getHidden(Reloc))
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00001472 continue;
George Rimar73a27232019-01-15 09:19:18 +00001473 Reloc.getTypeName(RelocName);
1474 error(getRelocationValueString(Reloc, ValueStr));
1475 outs() << format(Fmt.data(), Address) << " " << RelocName << " "
1476 << ValueStr << "\n";
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001477 }
1478 outs() << "\n";
1479 }
1480}
1481
George Rimar73a27232019-01-15 09:19:18 +00001482void llvm::printDynamicRelocations(const ObjectFile *Obj) {
Paul Semelcb0f0432018-06-07 13:30:55 +00001483 // For the moment, this option is for ELF only
1484 if (!Obj->isELF())
1485 return;
1486
1487 const auto *Elf = dyn_cast<ELFObjectFileBase>(Obj);
Paul Semelcb0f0432018-06-07 13:30:55 +00001488 if (!Elf || Elf->getEType() != ELF::ET_DYN) {
1489 error("not a dynamic object");
1490 return;
1491 }
1492
Paul Semelcb0f0432018-06-07 13:30:55 +00001493 std::vector<SectionRef> DynRelSec = Obj->dynamic_relocation_sections();
1494 if (DynRelSec.empty())
1495 return;
1496
1497 outs() << "DYNAMIC RELOCATION RECORDS\n";
George Rimar73a27232019-01-15 09:19:18 +00001498 StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64 : "%08" PRIx64;
Paul Semelcb0f0432018-06-07 13:30:55 +00001499 for (const SectionRef &Section : DynRelSec) {
1500 if (Section.relocation_begin() == Section.relocation_end())
1501 continue;
1502 for (const RelocationRef &Reloc : Section.relocations()) {
George Rimar73a27232019-01-15 09:19:18 +00001503 uint64_t Address = Reloc.getOffset();
1504 SmallString<32> RelocName;
1505 SmallString<32> ValueStr;
1506 Reloc.getTypeName(RelocName);
1507 error(getRelocationValueString(Reloc, ValueStr));
1508 outs() << format(Fmt.data(), Address) << " " << RelocName << " "
1509 << ValueStr << "\n";
Paul Semelcb0f0432018-06-07 13:30:55 +00001510 }
1511 }
1512}
1513
George Rimar87fa2e62019-01-28 14:11:35 +00001514// Returns true if we need to show LMA column when dumping section headers. We
1515// show it only when the platform is ELF and either we have at least one section
1516// whose VMA and LMA are different and/or when --show-lma flag is used.
1517static bool shouldDisplayLMA(const ObjectFile *Obj) {
1518 if (!Obj->isELF())
1519 return false;
1520 for (const SectionRef &S : ToolSectionFilter(*Obj))
1521 if (S.getAddress() != getELFSectionLMA(S))
1522 return true;
1523 return ShowLMA;
1524}
1525
George Rimar73a27232019-01-15 09:19:18 +00001526void llvm::printSectionHeaders(const ObjectFile *Obj) {
George Rimar87fa2e62019-01-28 14:11:35 +00001527 bool HasLMAColumn = shouldDisplayLMA(Obj);
1528 if (HasLMAColumn)
1529 outs() << "Sections:\n"
1530 "Idx Name Size VMA LMA "
1531 "Type\n";
1532 else
1533 outs() << "Sections:\n"
1534 "Idx Name Size VMA Type\n";
1535
Colin LeMahieu77804be2015-07-29 15:45:39 +00001536 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001537 StringRef Name;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001538 error(Section.getName(Name));
George Rimar87fa2e62019-01-28 14:11:35 +00001539 uint64_t VMA = Section.getAddress();
George Rimar4463ebe2019-01-28 16:36:12 +00001540 if (shouldAdjustVA(Section))
1541 VMA += AdjustVMA;
1542
Rafael Espindola80291272014-10-08 15:28:58 +00001543 uint64_t Size = Section.getSize();
1544 bool Text = Section.isText();
1545 bool Data = Section.isData();
1546 bool BSS = Section.isBSS();
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001547 std::string Type = (std::string(Text ? "TEXT " : "") +
Michael J. Spencer8f67d472011-10-13 20:37:20 +00001548 (Data ? "DATA " : "") + (BSS ? "BSS" : ""));
George Rimar87fa2e62019-01-28 14:11:35 +00001549
1550 if (HasLMAColumn)
1551 outs() << format("%3d %-13s %08" PRIx64 " %016" PRIx64 " %016" PRIx64
1552 " %s\n",
1553 (unsigned)Section.getIndex(), Name.str().c_str(), Size,
1554 VMA, getELFSectionLMA(Section), Type.c_str());
1555 else
1556 outs() << format("%3d %-13s %08" PRIx64 " %016" PRIx64 " %s\n",
1557 (unsigned)Section.getIndex(), Name.str().c_str(), Size,
1558 VMA, Type.c_str());
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001559 }
Xing GUO785edea2018-11-17 08:12:48 +00001560 outs() << "\n";
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001561}
1562
George Rimar73a27232019-01-15 09:19:18 +00001563void llvm::printSectionContents(const ObjectFile *Obj) {
Colin LeMahieu77804be2015-07-29 15:45:39 +00001564 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001565 StringRef Name;
1566 StringRef Contents;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001567 error(Section.getName(Name));
Rafael Espindola80291272014-10-08 15:28:58 +00001568 uint64_t BaseAddr = Section.getAddress();
David Majnemer185b5b12014-11-11 09:58:25 +00001569 uint64_t Size = Section.getSize();
1570 if (!Size)
1571 continue;
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001572
1573 outs() << "Contents of section " << Name << ":\n";
David Majnemer185b5b12014-11-11 09:58:25 +00001574 if (Section.isBSS()) {
Alexey Samsonov209095c2013-04-16 10:53:11 +00001575 outs() << format("<skipping contents of bss section at [%04" PRIx64
David Majnemer8f6b04c2014-07-14 16:20:14 +00001576 ", %04" PRIx64 ")>\n",
1577 BaseAddr, BaseAddr + Size);
Alexey Samsonov209095c2013-04-16 10:53:11 +00001578 continue;
1579 }
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001580
Davide Italianoccd53fe2015-08-05 07:18:31 +00001581 error(Section.getContents(Contents));
David Majnemer8f6b04c2014-07-14 16:20:14 +00001582
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001583 // Dump out the content as hex and printable ascii characters.
George Rimar73a27232019-01-15 09:19:18 +00001584 for (std::size_t Addr = 0, End = Contents.size(); Addr < End; Addr += 16) {
1585 outs() << format(" %04" PRIx64 " ", BaseAddr + Addr);
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001586 // Dump line of hex.
George Rimar73a27232019-01-15 09:19:18 +00001587 for (std::size_t I = 0; I < 16; ++I) {
1588 if (I != 0 && I % 4 == 0)
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001589 outs() << ' ';
George Rimar73a27232019-01-15 09:19:18 +00001590 if (Addr + I < End)
1591 outs() << hexdigit((Contents[Addr + I] >> 4) & 0xF, true)
1592 << hexdigit(Contents[Addr + I] & 0xF, true);
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001593 else
1594 outs() << " ";
1595 }
1596 // Print ascii.
1597 outs() << " ";
George Rimar73a27232019-01-15 09:19:18 +00001598 for (std::size_t I = 0; I < 16 && Addr + I < End; ++I) {
1599 if (isPrint(static_cast<unsigned char>(Contents[Addr + I]) & 0xFF))
1600 outs() << Contents[Addr + I];
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001601 else
1602 outs() << ".";
1603 }
1604 outs() << "\n";
1605 }
1606 }
1607}
1608
George Rimar73a27232019-01-15 09:19:18 +00001609void llvm::printSymbolTable(const ObjectFile *O, StringRef ArchiveName,
Kevin Enderby9acb1092016-05-31 20:35:34 +00001610 StringRef ArchitectureName) {
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001611 outs() << "SYMBOL TABLE:\n";
1612
George Rimar73a27232019-01-15 09:19:18 +00001613 if (const COFFObjectFile *Coff = dyn_cast<const COFFObjectFile>(O)) {
1614 printCOFFSymbolTable(Coff);
Rui Ueyama4e39f712014-03-18 18:58:51 +00001615 return;
1616 }
George Rimar8e0a70b2019-01-10 16:24:10 +00001617
Fangrui Songe7834bd2019-04-07 08:19:55 +00001618 const StringRef FileName = O->getFileName();
George Rimar73a27232019-01-15 09:19:18 +00001619 for (auto I = O->symbol_begin(), E = O->symbol_end(); I != E; ++I) {
George Rimar8e0a70b2019-01-10 16:24:10 +00001620 // Skip printing the special zero symbol when dumping an ELF file.
1621 // This makes the output consistent with the GNU objdump.
George Rimar73a27232019-01-15 09:19:18 +00001622 if (I == O->symbol_begin() && isa<ELFObjectFileBase>(O))
George Rimar8e0a70b2019-01-10 16:24:10 +00001623 continue;
1624
1625 const SymbolRef &Symbol = *I;
Fangrui Songe7834bd2019-04-07 08:19:55 +00001626 uint64_t Address = unwrapOrError(Symbol.getAddress(), ArchiveName, FileName,
1627 ArchitectureName);
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001628 if ((Address < StartAddress) || (Address > StopAddress))
1629 continue;
Fangrui Songe7834bd2019-04-07 08:19:55 +00001630 SymbolRef::Type Type = unwrapOrError(Symbol.getType(), ArchiveName,
1631 FileName, ArchitectureName);
Rui Ueyama4e39f712014-03-18 18:58:51 +00001632 uint32_t Flags = Symbol.getFlags();
Fangrui Songe7834bd2019-04-07 08:19:55 +00001633 section_iterator Section = unwrapOrError(Symbol.getSection(), ArchiveName,
1634 FileName, ArchitectureName);
Rafael Espindola75d5b542015-06-03 05:14:22 +00001635 StringRef Name;
Fangrui Songe7834bd2019-04-07 08:19:55 +00001636 if (Type == SymbolRef::ST_Debug && Section != O->section_end())
Rafael Espindola75d5b542015-06-03 05:14:22 +00001637 Section->getName(Name);
Fangrui Songe7834bd2019-04-07 08:19:55 +00001638 else
1639 Name = unwrapOrError(Symbol.getName(), ArchiveName, FileName,
1640 ArchitectureName);
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001641
Rui Ueyama4e39f712014-03-18 18:58:51 +00001642 bool Global = Flags & SymbolRef::SF_Global;
1643 bool Weak = Flags & SymbolRef::SF_Weak;
1644 bool Absolute = Flags & SymbolRef::SF_Absolute;
Colin LeMahieubc2f47a2015-01-23 20:06:24 +00001645 bool Common = Flags & SymbolRef::SF_Common;
Davide Italianocd2514d2015-04-30 23:08:53 +00001646 bool Hidden = Flags & SymbolRef::SF_Hidden;
David Meyer1df4b842012-02-28 23:47:53 +00001647
Rui Ueyama4e39f712014-03-18 18:58:51 +00001648 char GlobLoc = ' ';
1649 if (Type != SymbolRef::ST_Unknown)
1650 GlobLoc = Global ? 'g' : 'l';
1651 char Debug = (Type == SymbolRef::ST_Debug || Type == SymbolRef::ST_File)
1652 ? 'd' : ' ';
1653 char FileFunc = ' ';
1654 if (Type == SymbolRef::ST_File)
1655 FileFunc = 'f';
1656 else if (Type == SymbolRef::ST_Function)
1657 FileFunc = 'F';
Kristina Brooks0674f9d2018-11-11 17:47:13 +00001658 else if (Type == SymbolRef::ST_Data)
1659 FileFunc = 'O';
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001660
George Rimar73a27232019-01-15 09:19:18 +00001661 const char *Fmt = O->getBytesInAddress() > 4 ? "%016" PRIx64 :
Rui Ueyama4e39f712014-03-18 18:58:51 +00001662 "%08" PRIx64;
Michael J. Spencerd857c1c2013-01-10 22:40:50 +00001663
Rui Ueyama4e39f712014-03-18 18:58:51 +00001664 outs() << format(Fmt, Address) << " "
1665 << GlobLoc // Local -> 'l', Global -> 'g', Neither -> ' '
1666 << (Weak ? 'w' : ' ') // Weak?
1667 << ' ' // Constructor. Not supported yet.
1668 << ' ' // Warning. Not supported yet.
1669 << ' ' // Indirect reference to another symbol.
1670 << Debug // Debugging (d) or dynamic (D) symbol.
1671 << FileFunc // Name of function (F), file (f) or object (O).
1672 << ' ';
1673 if (Absolute) {
1674 outs() << "*ABS*";
Colin LeMahieubc2f47a2015-01-23 20:06:24 +00001675 } else if (Common) {
1676 outs() << "*COM*";
George Rimar73a27232019-01-15 09:19:18 +00001677 } else if (Section == O->section_end()) {
Rui Ueyama4e39f712014-03-18 18:58:51 +00001678 outs() << "*UND*";
1679 } else {
1680 if (const MachOObjectFile *MachO =
George Rimar73a27232019-01-15 09:19:18 +00001681 dyn_cast<const MachOObjectFile>(O)) {
Rui Ueyama4e39f712014-03-18 18:58:51 +00001682 DataRefImpl DR = Section->getRawDataRefImpl();
1683 StringRef SegmentName = MachO->getSectionFinalSegmentName(DR);
1684 outs() << SegmentName << ",";
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001685 }
Rui Ueyama4e39f712014-03-18 18:58:51 +00001686 StringRef SectionName;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001687 error(Section->getName(SectionName));
Rui Ueyama4e39f712014-03-18 18:58:51 +00001688 outs() << SectionName;
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001689 }
Rafael Espindola5f7ade22015-06-23 15:45:38 +00001690
1691 outs() << '\t';
George Rimar73a27232019-01-15 09:19:18 +00001692 if (Common || isa<ELFObjectFileBase>(O)) {
Rafael Espindoladbb6bd32015-06-25 22:10:04 +00001693 uint64_t Val =
1694 Common ? Symbol.getAlignment() : ELFSymbolRef(Symbol).getSize();
Rafael Espindolaae3ac082015-06-23 18:34:25 +00001695 outs() << format("\t %08" PRIx64 " ", Val);
1696 }
Rafael Espindola5f7ade22015-06-23 15:45:38 +00001697
George Rimar73a27232019-01-15 09:19:18 +00001698 if (Hidden)
Davide Italianocd2514d2015-04-30 23:08:53 +00001699 outs() << ".hidden ";
George Rimar6622d412018-12-19 10:21:45 +00001700
1701 if (Demangle)
1702 outs() << demangle(Name) << '\n';
1703 else
1704 outs() << Name << '\n';
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001705 }
1706}
1707
George Rimar73a27232019-01-15 09:19:18 +00001708static void printUnwindInfo(const ObjectFile *O) {
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001709 outs() << "Unwind info:\n\n";
1710
George Rimar73a27232019-01-15 09:19:18 +00001711 if (const COFFObjectFile *Coff = dyn_cast<COFFObjectFile>(O))
1712 printCOFFUnwindInfo(Coff);
1713 else if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(O))
Tim Northover4bd286a2014-08-01 13:07:19 +00001714 printMachOUnwindInfo(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001715 else
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001716 // TODO: Extract DWARF dump tool to objdump.
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001717 WithColor::error(errs(), ToolName)
1718 << "This operation is only currently supported "
1719 "for COFF and MachO object files.\n";
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001720}
1721
Kevin Enderbye2297dd2015-01-07 21:02:18 +00001722void llvm::printExportsTrie(const ObjectFile *o) {
Nick Kledzikd04bc352014-08-30 00:20:14 +00001723 outs() << "Exports trie:\n";
1724 if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
1725 printMachOExportsTrie(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001726 else
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001727 WithColor::error(errs(), ToolName)
1728 << "This operation is only currently supported "
1729 "for Mach-O executable files.\n";
Nick Kledzikd04bc352014-08-30 00:20:14 +00001730}
1731
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001732void llvm::printRebaseTable(ObjectFile *o) {
Nick Kledzikac431442014-09-12 21:34:15 +00001733 outs() << "Rebase table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001734 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzikac431442014-09-12 21:34:15 +00001735 printMachORebaseTable(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001736 else
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001737 WithColor::error(errs(), ToolName)
1738 << "This operation is only currently supported "
1739 "for Mach-O executable files.\n";
Nick Kledzikac431442014-09-12 21:34:15 +00001740}
1741
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001742void llvm::printBindTable(ObjectFile *o) {
Nick Kledzik56ebef42014-09-16 01:41:51 +00001743 outs() << "Bind table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001744 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzik56ebef42014-09-16 01:41:51 +00001745 printMachOBindTable(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001746 else
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001747 WithColor::error(errs(), ToolName)
1748 << "This operation is only currently supported "
1749 "for Mach-O executable files.\n";
Nick Kledzik56ebef42014-09-16 01:41:51 +00001750}
1751
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001752void llvm::printLazyBindTable(ObjectFile *o) {
Nick Kledzik56ebef42014-09-16 01:41:51 +00001753 outs() << "Lazy bind table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001754 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzik56ebef42014-09-16 01:41:51 +00001755 printMachOLazyBindTable(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001756 else
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001757 WithColor::error(errs(), ToolName)
1758 << "This operation is only currently supported "
1759 "for Mach-O executable files.\n";
Nick Kledzik56ebef42014-09-16 01:41:51 +00001760}
1761
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001762void llvm::printWeakBindTable(ObjectFile *o) {
Nick Kledzik56ebef42014-09-16 01:41:51 +00001763 outs() << "Weak bind table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00001764 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzik56ebef42014-09-16 01:41:51 +00001765 printMachOWeakBindTable(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001766 else
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001767 WithColor::error(errs(), ToolName)
1768 << "This operation is only currently supported "
1769 "for Mach-O executable files.\n";
Nick Kledzik56ebef42014-09-16 01:41:51 +00001770}
Nick Kledzikac431442014-09-12 21:34:15 +00001771
Adrian Prantl437105a2015-07-08 02:04:15 +00001772/// Dump the raw contents of the __clangast section so the output can be piped
1773/// into llvm-bcanalyzer.
1774void llvm::printRawClangAST(const ObjectFile *Obj) {
1775 if (outs().is_displayed()) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001776 WithColor::error(errs(), ToolName)
1777 << "The -raw-clang-ast option will dump the raw binary contents of "
1778 "the clang ast section.\n"
1779 "Please redirect the output to a file or another program such as "
1780 "llvm-bcanalyzer.\n";
Adrian Prantl437105a2015-07-08 02:04:15 +00001781 return;
1782 }
1783
1784 StringRef ClangASTSectionName("__clangast");
1785 if (isa<COFFObjectFile>(Obj)) {
1786 ClangASTSectionName = "clangast";
1787 }
1788
1789 Optional<object::SectionRef> ClangASTSection;
Colin LeMahieu77804be2015-07-29 15:45:39 +00001790 for (auto Sec : ToolSectionFilter(*Obj)) {
Adrian Prantl437105a2015-07-08 02:04:15 +00001791 StringRef Name;
1792 Sec.getName(Name);
1793 if (Name == ClangASTSectionName) {
1794 ClangASTSection = Sec;
1795 break;
1796 }
1797 }
1798 if (!ClangASTSection)
1799 return;
1800
1801 StringRef ClangASTContents;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001802 error(ClangASTSection.getValue().getContents(ClangASTContents));
Adrian Prantl437105a2015-07-08 02:04:15 +00001803 outs().write(ClangASTContents.data(), ClangASTContents.size());
1804}
1805
Sanjoy Das6f567a42015-06-22 18:03:02 +00001806static void printFaultMaps(const ObjectFile *Obj) {
George Rimar73a27232019-01-15 09:19:18 +00001807 StringRef FaultMapSectionName;
Sanjoy Das6f567a42015-06-22 18:03:02 +00001808
1809 if (isa<ELFObjectFileBase>(Obj)) {
1810 FaultMapSectionName = ".llvm_faultmaps";
1811 } else if (isa<MachOObjectFile>(Obj)) {
1812 FaultMapSectionName = "__llvm_faultmaps";
1813 } else {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001814 WithColor::error(errs(), ToolName)
1815 << "This operation is only currently supported "
1816 "for ELF and Mach-O executable files.\n";
Sanjoy Das6f567a42015-06-22 18:03:02 +00001817 return;
1818 }
1819
1820 Optional<object::SectionRef> FaultMapSection;
1821
Colin LeMahieu77804be2015-07-29 15:45:39 +00001822 for (auto Sec : ToolSectionFilter(*Obj)) {
Sanjoy Das6f567a42015-06-22 18:03:02 +00001823 StringRef Name;
1824 Sec.getName(Name);
1825 if (Name == FaultMapSectionName) {
1826 FaultMapSection = Sec;
1827 break;
1828 }
1829 }
1830
1831 outs() << "FaultMap table:\n";
1832
1833 if (!FaultMapSection.hasValue()) {
1834 outs() << "<not found>\n";
1835 return;
1836 }
1837
1838 StringRef FaultMapContents;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001839 error(FaultMapSection.getValue().getContents(FaultMapContents));
Sanjoy Das6f567a42015-06-22 18:03:02 +00001840
1841 FaultMapParser FMP(FaultMapContents.bytes_begin(),
1842 FaultMapContents.bytes_end());
1843
1844 outs() << FMP;
1845}
1846
George Rimar73a27232019-01-15 09:19:18 +00001847static void printPrivateFileHeaders(const ObjectFile *O, bool OnlyFirst) {
1848 if (O->isELF()) {
1849 printELFFileHeader(O);
Xing GUO56d651d2019-02-25 13:13:19 +00001850 printELFDynamicSection(O);
1851 printELFSymbolVersionInfo(O);
1852 return;
Paul Semel0913dcd2018-07-25 11:09:20 +00001853 }
George Rimar73a27232019-01-15 09:19:18 +00001854 if (O->isCOFF())
1855 return printCOFFFileHeader(O);
1856 if (O->isWasm())
1857 return printWasmFileHeader(O);
1858 if (O->isMachO()) {
1859 printMachOFileHeader(O);
1860 if (!OnlyFirst)
1861 printMachOLoadCommands(O);
Davide Italiano1bdaa202016-09-18 04:39:15 +00001862 return;
1863 }
George Rimar73a27232019-01-15 09:19:18 +00001864 report_error(O->getFileName(), "Invalid/Unsupported object file format");
Rui Ueyamac2bed422013-09-27 21:04:00 +00001865}
1866
George Rimar73a27232019-01-15 09:19:18 +00001867static void printFileHeaders(const ObjectFile *O) {
1868 if (!O->isELF() && !O->isCOFF())
1869 report_error(O->getFileName(), "Invalid/Unsupported object file format");
Paul Semeld2af4d62018-07-04 15:25:03 +00001870
George Rimar73a27232019-01-15 09:19:18 +00001871 Triple::ArchType AT = O->getArch();
Paul Semeld2af4d62018-07-04 15:25:03 +00001872 outs() << "architecture: " << Triple::getArchTypeName(AT) << "\n";
Fangrui Songe7834bd2019-04-07 08:19:55 +00001873 uint64_t Address = unwrapOrError(O->getStartAddress(), O->getFileName());
Petar Jovanovic8d947ba2018-10-19 22:16:49 +00001874
George Rimar73a27232019-01-15 09:19:18 +00001875 StringRef Fmt = O->getBytesInAddress() > 4 ? "%016" PRIx64 : "%08" PRIx64;
Paul Semeld2af4d62018-07-04 15:25:03 +00001876 outs() << "start address: "
George Rimar9b6fe7e2019-01-12 12:17:24 +00001877 << "0x" << format(Fmt.data(), Address) << "\n\n";
Paul Semeld2af4d62018-07-04 15:25:03 +00001878}
1879
Paul Semel0dc92f62018-07-05 14:43:29 +00001880static void printArchiveChild(StringRef Filename, const Archive::Child &C) {
1881 Expected<sys::fs::perms> ModeOrErr = C.getAccessMode();
1882 if (!ModeOrErr) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001883 WithColor::error(errs(), ToolName) << "ill-formed archive entry.\n";
Paul Semel0dc92f62018-07-05 14:43:29 +00001884 consumeError(ModeOrErr.takeError());
1885 return;
1886 }
1887 sys::fs::perms Mode = ModeOrErr.get();
1888 outs() << ((Mode & sys::fs::owner_read) ? "r" : "-");
1889 outs() << ((Mode & sys::fs::owner_write) ? "w" : "-");
1890 outs() << ((Mode & sys::fs::owner_exe) ? "x" : "-");
1891 outs() << ((Mode & sys::fs::group_read) ? "r" : "-");
1892 outs() << ((Mode & sys::fs::group_write) ? "w" : "-");
1893 outs() << ((Mode & sys::fs::group_exe) ? "x" : "-");
1894 outs() << ((Mode & sys::fs::others_read) ? "r" : "-");
1895 outs() << ((Mode & sys::fs::others_write) ? "w" : "-");
1896 outs() << ((Mode & sys::fs::others_exe) ? "x" : "-");
1897
1898 outs() << " ";
1899
Fangrui Songe7834bd2019-04-07 08:19:55 +00001900 outs() << format("%d/%d %6" PRId64 " ", unwrapOrError(C.getUID(), Filename),
1901 unwrapOrError(C.getGID(), Filename),
1902 unwrapOrError(C.getRawSize(), Filename));
Paul Semel0dc92f62018-07-05 14:43:29 +00001903
1904 StringRef RawLastModified = C.getRawLastModified();
1905 unsigned Seconds;
1906 if (RawLastModified.getAsInteger(10, Seconds))
1907 outs() << "(date: \"" << RawLastModified
1908 << "\" contains non-decimal chars) ";
1909 else {
1910 // Since ctime(3) returns a 26 character string of the form:
1911 // "Sun Sep 16 01:03:52 1973\n\0"
1912 // just print 24 characters.
1913 time_t t = Seconds;
1914 outs() << format("%.24s ", ctime(&t));
1915 }
1916
1917 StringRef Name = "";
1918 Expected<StringRef> NameOrErr = C.getName();
1919 if (!NameOrErr) {
1920 consumeError(NameOrErr.takeError());
Fangrui Songe7834bd2019-04-07 08:19:55 +00001921 Name = unwrapOrError(C.getRawName(), Filename);
Paul Semel0dc92f62018-07-05 14:43:29 +00001922 } else {
1923 Name = NameOrErr.get();
1924 }
1925 outs() << Name << "\n";
1926}
1927
George Rimar73a27232019-01-15 09:19:18 +00001928static void dumpObject(ObjectFile *O, const Archive *A = nullptr,
1929 const Archive::Child *C = nullptr) {
Adrian Prantl437105a2015-07-08 02:04:15 +00001930 // Avoid other output when using a raw option.
1931 if (!RawClangAST) {
1932 outs() << '\n';
George Rimar73a27232019-01-15 09:19:18 +00001933 if (A)
1934 outs() << A->getFileName() << "(" << O->getFileName() << ")";
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001935 else
George Rimar73a27232019-01-15 09:19:18 +00001936 outs() << O->getFileName();
1937 outs() << ":\tfile format " << O->getFileFormatName() << "\n\n";
Adrian Prantl437105a2015-07-08 02:04:15 +00001938 }
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001939
George Rimar73a27232019-01-15 09:19:18 +00001940 StringRef ArchiveName = A ? A->getFileName() : "";
George Rimar9b6fe7e2019-01-12 12:17:24 +00001941 if (FileHeaders)
George Rimar73a27232019-01-15 09:19:18 +00001942 printFileHeaders(O);
1943 if (ArchiveHeaders && !MachOOpt && C)
1944 printArchiveChild(ArchiveName, *C);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001945 if (Disassemble)
George Rimar73a27232019-01-15 09:19:18 +00001946 disassembleObject(O, Relocations);
Michael J. Spencer51862b32011-10-13 22:17:18 +00001947 if (Relocations && !Disassemble)
George Rimar73a27232019-01-15 09:19:18 +00001948 printRelocations(O);
Paul Semelcb0f0432018-06-07 13:30:55 +00001949 if (DynamicRelocations)
George Rimar73a27232019-01-15 09:19:18 +00001950 printDynamicRelocations(O);
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001951 if (SectionHeaders)
George Rimar73a27232019-01-15 09:19:18 +00001952 printSectionHeaders(O);
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001953 if (SectionContents)
George Rimar73a27232019-01-15 09:19:18 +00001954 printSectionContents(O);
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001955 if (SymbolTable)
George Rimar73a27232019-01-15 09:19:18 +00001956 printSymbolTable(O, ArchiveName);
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001957 if (UnwindInfo)
George Rimar73a27232019-01-15 09:19:18 +00001958 printUnwindInfo(O);
Davide Italiano1bdaa202016-09-18 04:39:15 +00001959 if (PrivateHeaders || FirstPrivateHeader)
George Rimar73a27232019-01-15 09:19:18 +00001960 printPrivateFileHeaders(O, FirstPrivateHeader);
Nick Kledzikd04bc352014-08-30 00:20:14 +00001961 if (ExportsTrie)
George Rimar73a27232019-01-15 09:19:18 +00001962 printExportsTrie(O);
Nick Kledzikac431442014-09-12 21:34:15 +00001963 if (Rebase)
George Rimar73a27232019-01-15 09:19:18 +00001964 printRebaseTable(O);
Nick Kledzik56ebef42014-09-16 01:41:51 +00001965 if (Bind)
George Rimar73a27232019-01-15 09:19:18 +00001966 printBindTable(O);
Nick Kledzik56ebef42014-09-16 01:41:51 +00001967 if (LazyBind)
George Rimar73a27232019-01-15 09:19:18 +00001968 printLazyBindTable(O);
Nick Kledzik56ebef42014-09-16 01:41:51 +00001969 if (WeakBind)
George Rimar73a27232019-01-15 09:19:18 +00001970 printWeakBindTable(O);
Adrian Prantl437105a2015-07-08 02:04:15 +00001971 if (RawClangAST)
George Rimar73a27232019-01-15 09:19:18 +00001972 printRawClangAST(O);
Sanjoy Das6f567a42015-06-22 18:03:02 +00001973 if (PrintFaultMaps)
George Rimar73a27232019-01-15 09:19:18 +00001974 printFaultMaps(O);
Igor Laevsky03a670c2016-01-26 15:09:42 +00001975 if (DwarfDumpType != DIDT_Null) {
George Rimar73a27232019-01-15 09:19:18 +00001976 std::unique_ptr<DIContext> DICtx = DWARFContext::create(*O);
Igor Laevsky03a670c2016-01-26 15:09:42 +00001977 // Dump the complete DWARF structure.
Adrian Prantlf4bc1f72017-06-01 18:18:23 +00001978 DIDumpOptions DumpOpts;
1979 DumpOpts.DumpType = DwarfDumpType;
Adrian Prantlf4bc1f72017-06-01 18:18:23 +00001980 DICtx->dump(outs(), DumpOpts);
Igor Laevsky03a670c2016-01-26 15:09:42 +00001981 }
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001982}
1983
George Rimar73a27232019-01-15 09:19:18 +00001984static void dumpObject(const COFFImportFile *I, const Archive *A,
Paul Semel0dc92f62018-07-05 14:43:29 +00001985 const Archive::Child *C = nullptr) {
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +00001986 StringRef ArchiveName = A ? A->getFileName() : "";
1987
1988 // Avoid other output when using a raw option.
1989 if (!RawClangAST)
1990 outs() << '\n'
1991 << ArchiveName << "(" << I->getFileName() << ")"
1992 << ":\tfile format COFF-import-file"
1993 << "\n\n";
1994
James Hendersonc1608c92018-10-29 14:17:08 +00001995 if (ArchiveHeaders && !MachOOpt && C)
1996 printArchiveChild(ArchiveName, *C);
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +00001997 if (SymbolTable)
1998 printCOFFSymbolTable(I);
1999}
2000
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +00002001/// Dump each object file in \a a;
George Rimar73a27232019-01-15 09:19:18 +00002002static void dumpArchive(const Archive *A) {
Mehdi Amini41af4302016-11-11 04:28:40 +00002003 Error Err = Error::success();
George Rimar73a27232019-01-15 09:19:18 +00002004 for (auto &C : A->children(Err)) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +00002005 Expected<std::unique_ptr<Binary>> ChildOrErr = C.getAsBinary();
2006 if (!ChildOrErr) {
2007 if (auto E = isNotObjectErrorInvalidFileType(ChildOrErr.takeError()))
Fangrui Songe7834bd2019-04-07 08:19:55 +00002008 report_error(std::move(E), A->getFileName(), C);
Kevin Enderbyac9e1552016-05-17 17:10:12 +00002009 continue;
2010 }
George Rimar73a27232019-01-15 09:19:18 +00002011 if (ObjectFile *O = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
2012 dumpObject(O, A, &C);
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +00002013 else if (COFFImportFile *I = dyn_cast<COFFImportFile>(&*ChildOrErr.get()))
George Rimar73a27232019-01-15 09:19:18 +00002014 dumpObject(I, A, &C);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002015 else
George Rimar73a27232019-01-15 09:19:18 +00002016 report_error(A->getFileName(), object_error::invalid_file_type);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002017 }
Lang Hamesfc209622016-07-14 02:24:01 +00002018 if (Err)
Fangrui Songe7834bd2019-04-07 08:19:55 +00002019 report_error(std::move(Err), A->getFileName());
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002020}
2021
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +00002022/// Open file and figure out how to dump it.
George Rimar73a27232019-01-15 09:19:18 +00002023static void dumpInput(StringRef file) {
Kevin Enderbye2297dd2015-01-07 21:02:18 +00002024 // If we are using the Mach-O specific object file parser, then let it parse
2025 // the file and process the command line options. So the -arch flags can
2026 // be used to select specific slices, etc.
2027 if (MachOOpt) {
George Rimar73a27232019-01-15 09:19:18 +00002028 parseInputMachO(file);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002029 return;
2030 }
2031
2032 // Attempt to open the binary.
Fangrui Songe7834bd2019-04-07 08:19:55 +00002033 OwningBinary<Binary> OBinary = unwrapOrError(createBinary(file), file);
2034 Binary &Binary = *OBinary.getBinary();
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002035
George Rimar73a27232019-01-15 09:19:18 +00002036 if (Archive *A = dyn_cast<Archive>(&Binary))
2037 dumpArchive(A);
2038 else if (ObjectFile *O = dyn_cast<ObjectFile>(&Binary))
2039 dumpObject(O);
Dave Lee3fb120f2018-08-03 00:06:38 +00002040 else if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(&Binary))
George Rimar73a27232019-01-15 09:19:18 +00002041 parseInputMachO(UB);
Jim Grosbachaf9aec02012-08-07 17:53:14 +00002042 else
Alexey Samsonov50d0fbd2015-06-04 18:34:11 +00002043 report_error(file, object_error::invalid_file_type);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002044}
2045
Michael J. Spencer2670c252011-01-20 06:39:06 +00002046int main(int argc, char **argv) {
Rui Ueyama197194b2018-04-13 18:26:06 +00002047 InitLLVM X(argc, argv);
Michael J. Spencer2670c252011-01-20 06:39:06 +00002048
2049 // Initialize targets and assembly printers/parsers.
2050 llvm::InitializeAllTargetInfos();
Evan Cheng8c886a42011-07-22 21:58:54 +00002051 llvm::InitializeAllTargetMCs();
Michael J. Spencer2670c252011-01-20 06:39:06 +00002052 llvm::InitializeAllDisassemblers();
2053
Pete Cooper28fb4fc2012-05-03 23:20:10 +00002054 // Register the target printer for --version.
2055 cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
2056
Michael J. Spencer2670c252011-01-20 06:39:06 +00002057 cl::ParseCommandLineOptions(argc, argv, "llvm object file dumper\n");
Michael J. Spencer2670c252011-01-20 06:39:06 +00002058
2059 ToolName = argv[0];
2060
2061 // Defaults to a.out if no filenames specified.
Jordan Rupprecht16a0de22018-12-20 00:57:06 +00002062 if (InputFilenames.empty())
Michael J. Spencer2670c252011-01-20 06:39:06 +00002063 InputFilenames.push_back("a.out");
2064
Fangrui Song8513cd42018-06-27 20:45:11 +00002065 if (AllHeaders)
George Rimar5e364332019-01-18 12:01:59 +00002066 ArchiveHeaders = FileHeaders = PrivateHeaders = Relocations =
2067 SectionHeaders = SymbolTable = true;
Fangrui Song8513cd42018-06-27 20:45:11 +00002068
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +00002069 if (DisassembleAll || PrintSource || PrintLines)
Colin LeMahieuf34933e2015-07-23 20:58:49 +00002070 Disassemble = true;
Paul Semel007dedb2018-07-18 16:39:21 +00002071
Michael J. Spencerbfa06782011-10-18 19:32:17 +00002072 if (!Disassemble
2073 && !Relocations
Paul Semelcb0f0432018-06-07 13:30:55 +00002074 && !DynamicRelocations
Michael J. Spencerbfa06782011-10-18 19:32:17 +00002075 && !SectionHeaders
2076 && !SectionContents
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00002077 && !SymbolTable
Michael J. Spencer209565db2013-01-06 03:56:49 +00002078 && !UnwindInfo
Nick Kledzikd04bc352014-08-30 00:20:14 +00002079 && !PrivateHeaders
Paul Semeld2af4d62018-07-04 15:25:03 +00002080 && !FileHeaders
Kevin Enderby0ae163f2016-01-13 00:25:36 +00002081 && !FirstPrivateHeader
Nick Kledzikac431442014-09-12 21:34:15 +00002082 && !ExportsTrie
Nick Kledzik56ebef42014-09-16 01:41:51 +00002083 && !Rebase
2084 && !Bind
2085 && !LazyBind
Kevin Enderby131d1772015-01-09 19:22:37 +00002086 && !WeakBind
Adrian Prantl437105a2015-07-08 02:04:15 +00002087 && !RawClangAST
Kevin Enderby13023a12015-01-15 23:19:11 +00002088 && !(UniversalHeaders && MachOOpt)
Paul Semel0dc92f62018-07-05 14:43:29 +00002089 && !ArchiveHeaders
Kevin Enderby69fe98d2015-01-23 18:52:17 +00002090 && !(IndirectSymbols && MachOOpt)
Kevin Enderby9a509442015-01-27 21:28:24 +00002091 && !(DataInCode && MachOOpt)
Kevin Enderbyf6d25852015-01-31 00:37:11 +00002092 && !(LinkOptHints && MachOOpt)
Kevin Enderbycd66be52015-03-11 22:06:32 +00002093 && !(InfoPlist && MachOOpt)
Kevin Enderbybc847fa2015-03-16 20:08:09 +00002094 && !(DylibsUsed && MachOOpt)
2095 && !(DylibId && MachOOpt)
Kevin Enderby0fc11822015-04-01 20:57:01 +00002096 && !(ObjcMetaData && MachOOpt)
Jordan Rupprecht16a0de22018-12-20 00:57:06 +00002097 && !(!FilterSections.empty() && MachOOpt)
Igor Laevsky03a670c2016-01-26 15:09:42 +00002098 && !PrintFaultMaps
2099 && DwarfDumpType == DIDT_Null) {
Michael J. Spencer2670c252011-01-20 06:39:06 +00002100 cl::PrintHelpMessage();
Dimitry Andrice4f5d012017-12-18 19:46:56 +00002101 return 2;
2102 }
2103
Rafael Aulerb0e4b912018-03-09 19:13:44 +00002104 DisasmFuncsSet.insert(DisassembleFunctions.begin(),
2105 DisassembleFunctions.end());
2106
George Rimar73a27232019-01-15 09:19:18 +00002107 llvm::for_each(InputFilenames, dumpInput);
Dimitry Andrice4f5d012017-12-18 19:46:56 +00002108
2109 return EXIT_SUCCESS;
2110}