blob: b01cab4aa301d2d82191250732198ccc9d6f4eee [file] [log] [blame]
Brian Gaeke0af759d2003-10-16 04:43:15 +00001//===-- llvm-nm.cpp - Symbol table dumping utility for llvm ---------------===//
Misha Brukman650ba8e2005-04-22 00:00:37 +00002//
John Criswell09344dc2003-10-20 17:47:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner345353d2007-12-29 20:44:31 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukman650ba8e2005-04-22 00:00:37 +00007//
John Criswell09344dc2003-10-20 17:47:21 +00008//===----------------------------------------------------------------------===//
Brian Gaeke0af759d2003-10-16 04:43:15 +00009//
Michael J. Spencer838e5ad2012-06-06 23:34:10 +000010// This program is a utility that works like traditional Unix "nm", that is, it
11// prints out the names of symbols in a bitcode or object file, along with some
12// information about each symbol.
Misha Brukman650ba8e2005-04-22 00:00:37 +000013//
Michael J. Spencer838e5ad2012-06-06 23:34:10 +000014// This "nm" supports many of the features of GNU "nm", including its different
15// output formats.
Brian Gaeke0af759d2003-10-16 04:43:15 +000016//
17//===----------------------------------------------------------------------===//
18
Rafael Espindolaf12b8282014-02-21 20:10:59 +000019#include "llvm/IR/Function.h"
20#include "llvm/IR/GlobalAlias.h"
21#include "llvm/IR/GlobalVariable.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000022#include "llvm/IR/LLVMContext.h"
Kevin Enderbydc0dbe12015-11-10 00:31:08 +000023#include "llvm/IR/Module.h"
Michael J. Spencer2bc774a2011-09-27 19:37:18 +000024#include "llvm/Object/Archive.h"
Rafael Espindola586af97a2013-11-02 21:16:09 +000025#include "llvm/Object/COFF.h"
26#include "llvm/Object/ELFObjectFile.h"
Chandler Carruth442f7842014-03-04 10:07:28 +000027#include "llvm/Object/IRObjectFile.h"
Rafael Espindola586af97a2013-11-02 21:16:09 +000028#include "llvm/Object/MachO.h"
Alexey Samsonove6388e62013-06-18 15:03:28 +000029#include "llvm/Object/MachOUniversal.h"
Michael J. Spencerb8672a52011-01-20 06:38:57 +000030#include "llvm/Object/ObjectFile.h"
Rui Ueyamaf078eff2014-03-18 23:37:53 +000031#include "llvm/Support/COFF.h"
Reid Spencer7c16caa2004-09-01 22:55:40 +000032#include "llvm/Support/CommandLine.h"
Michael J. Spencerb8672a52011-01-20 06:38:57 +000033#include "llvm/Support/FileSystem.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000034#include "llvm/Support/Format.h"
Chris Lattner76d46322006-12-06 01:18:01 +000035#include "llvm/Support/ManagedStatic.h"
Chris Lattneref8f3892007-05-06 05:36:18 +000036#include "llvm/Support/MemoryBuffer.h"
Chris Lattnere3fc2d12009-03-06 05:34:10 +000037#include "llvm/Support/PrettyStackTrace.h"
Michael J. Spencerbc96f372011-12-13 23:17:29 +000038#include "llvm/Support/Program.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000039#include "llvm/Support/Signals.h"
Rafael Espindola13b69d62014-07-03 18:59:23 +000040#include "llvm/Support/TargetSelect.h"
Chandler Carruthd9903882015-01-14 11:23:27 +000041#include "llvm/Support/raw_ostream.h"
Jeff Cohenb622c112007-03-05 00:00:42 +000042#include <algorithm>
Brian Gaeke0af759d2003-10-16 04:43:15 +000043#include <cctype>
Alkis Evlogimenosf68f40e2004-04-21 16:11:40 +000044#include <cerrno>
Brian Gaeke55447b42003-11-19 21:52:09 +000045#include <cstring>
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000046#include <system_error>
Michael J. Spencerb8672a52011-01-20 06:38:57 +000047#include <vector>
Hans Wennborg083ca9b2015-10-06 23:24:35 +000048
Brian Gaeke960707c2003-11-11 22:41:34 +000049using namespace llvm;
Michael J. Spencerb8672a52011-01-20 06:38:57 +000050using namespace object;
Brian Gaeke960707c2003-11-11 22:41:34 +000051
Brian Gaeke0af759d2003-10-16 04:43:15 +000052namespace {
Kevin Enderby980b2582014-06-05 21:21:57 +000053enum OutputFormatTy { bsd, sysv, posix, darwin };
Rafael Espindola619581c2014-01-29 04:56:19 +000054cl::opt<OutputFormatTy> OutputFormat(
55 "format", cl::desc("Specify output format"),
56 cl::values(clEnumVal(bsd, "BSD format"), clEnumVal(sysv, "System V format"),
Kevin Enderby980b2582014-06-05 21:21:57 +000057 clEnumVal(posix, "POSIX.2 format"),
58 clEnumVal(darwin, "Darwin -m format"), clEnumValEnd),
Rafael Espindola619581c2014-01-29 04:56:19 +000059 cl::init(bsd));
60cl::alias OutputFormat2("f", cl::desc("Alias for --format"),
61 cl::aliasopt(OutputFormat));
Brian Gaeke0af759d2003-10-16 04:43:15 +000062
Rafael Espindolaf12b8282014-02-21 20:10:59 +000063cl::list<std::string> InputFilenames(cl::Positional, cl::desc("<input files>"),
Rafael Espindola619581c2014-01-29 04:56:19 +000064 cl::ZeroOrMore);
Brian Gaeke0af759d2003-10-16 04:43:15 +000065
Rafael Espindola619581c2014-01-29 04:56:19 +000066cl::opt<bool> UndefinedOnly("undefined-only",
67 cl::desc("Show only undefined symbols"));
68cl::alias UndefinedOnly2("u", cl::desc("Alias for --undefined-only"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +000069 cl::aliasopt(UndefinedOnly), cl::Grouping);
Brian Gaeke0af759d2003-10-16 04:43:15 +000070
Rafael Espindola619581c2014-01-29 04:56:19 +000071cl::opt<bool> DynamicSyms("dynamic",
72 cl::desc("Display the dynamic symbols instead "
73 "of normal symbols."));
74cl::alias DynamicSyms2("D", cl::desc("Alias for --dynamic"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +000075 cl::aliasopt(DynamicSyms), cl::Grouping);
Michael J. Spencer8c4729f2012-02-28 00:40:37 +000076
Rafael Espindola619581c2014-01-29 04:56:19 +000077cl::opt<bool> DefinedOnly("defined-only",
78 cl::desc("Show only defined symbols"));
Kevin Enderbyacaaf902014-07-03 18:18:50 +000079cl::alias DefinedOnly2("U", cl::desc("Alias for --defined-only"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +000080 cl::aliasopt(DefinedOnly), cl::Grouping);
Brian Gaeke0af759d2003-10-16 04:43:15 +000081
Rafael Espindola619581c2014-01-29 04:56:19 +000082cl::opt<bool> ExternalOnly("extern-only",
83 cl::desc("Show only external symbols"));
84cl::alias ExternalOnly2("g", cl::desc("Alias for --extern-only"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +000085 cl::aliasopt(ExternalOnly), cl::Grouping);
Brian Gaeke0af759d2003-10-16 04:43:15 +000086
Kevin Enderby9c8905c2015-11-02 23:42:05 +000087cl::opt<bool> BSDFormat("B", cl::desc("Alias for --format=bsd"),
88 cl::Grouping);
89cl::opt<bool> POSIXFormat("P", cl::desc("Alias for --format=posix"),
90 cl::Grouping);
91cl::opt<bool> DarwinFormat("m", cl::desc("Alias for --format=darwin"),
92 cl::Grouping);
Brian Gaeke0af759d2003-10-16 04:43:15 +000093
Kevin Enderby8f6dcf52014-07-01 22:44:51 +000094static cl::list<std::string>
Kevin Enderbybe84b292014-07-17 22:56:27 +000095 ArchFlags("arch", cl::desc("architecture(s) from a Mach-O file to dump"),
96 cl::ZeroOrMore);
Kevin Enderby4c8dfe42014-06-30 18:45:23 +000097bool ArchAll = false;
98
Rafael Espindola619581c2014-01-29 04:56:19 +000099cl::opt<bool> PrintFileName(
100 "print-file-name",
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000101 cl::desc("Precede each symbol with the object file it came from"));
102
Rafael Espindola619581c2014-01-29 04:56:19 +0000103cl::alias PrintFileNameA("A", cl::desc("Alias for --print-file-name"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000104 cl::aliasopt(PrintFileName), cl::Grouping);
Rafael Espindola619581c2014-01-29 04:56:19 +0000105cl::alias PrintFileNameo("o", cl::desc("Alias for --print-file-name"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000106 cl::aliasopt(PrintFileName), cl::Grouping);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000107
Rafael Espindola619581c2014-01-29 04:56:19 +0000108cl::opt<bool> DebugSyms("debug-syms",
109 cl::desc("Show all symbols, even debugger only"));
110cl::alias DebugSymsa("a", cl::desc("Alias for --debug-syms"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000111 cl::aliasopt(DebugSyms), cl::Grouping);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000112
Rafael Espindolab4865d62014-04-03 00:19:35 +0000113cl::opt<bool> NumericSort("numeric-sort", cl::desc("Sort symbols by address"));
Rafael Espindola619581c2014-01-29 04:56:19 +0000114cl::alias NumericSortn("n", cl::desc("Alias for --numeric-sort"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000115 cl::aliasopt(NumericSort), cl::Grouping);
Rafael Espindola619581c2014-01-29 04:56:19 +0000116cl::alias NumericSortv("v", cl::desc("Alias for --numeric-sort"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000117 cl::aliasopt(NumericSort), cl::Grouping);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000118
Rafael Espindola619581c2014-01-29 04:56:19 +0000119cl::opt<bool> NoSort("no-sort", cl::desc("Show symbols in order encountered"));
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000120cl::alias NoSortp("p", cl::desc("Alias for --no-sort"), cl::aliasopt(NoSort),
121 cl::Grouping);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000122
Kevin Enderby25a614b2014-07-02 23:23:58 +0000123cl::opt<bool> ReverseSort("reverse-sort", cl::desc("Sort in reverse order"));
124cl::alias ReverseSortr("r", cl::desc("Alias for --reverse-sort"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000125 cl::aliasopt(ReverseSort), cl::Grouping);
Kevin Enderby25a614b2014-07-02 23:23:58 +0000126
Rafael Espindola619581c2014-01-29 04:56:19 +0000127cl::opt<bool> PrintSize("print-size",
Rafael Espindolab4865d62014-04-03 00:19:35 +0000128 cl::desc("Show symbol size instead of address"));
Rafael Espindola619581c2014-01-29 04:56:19 +0000129cl::alias PrintSizeS("S", cl::desc("Alias for --print-size"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000130 cl::aliasopt(PrintSize), cl::Grouping);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000131
Rafael Espindola619581c2014-01-29 04:56:19 +0000132cl::opt<bool> SizeSort("size-sort", cl::desc("Sort symbols by size"));
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000133
Rafael Espindola619581c2014-01-29 04:56:19 +0000134cl::opt<bool> WithoutAliases("without-aliases", cl::Hidden,
135 cl::desc("Exclude aliases from output"));
Jan Sjödin4d0c2992012-09-18 18:47:58 +0000136
Rafael Espindola619581c2014-01-29 04:56:19 +0000137cl::opt<bool> ArchiveMap("print-armap", cl::desc("Print the archive map"));
Kevin Enderby8da4bd62014-07-08 23:47:31 +0000138cl::alias ArchiveMaps("M", cl::desc("Alias for --print-armap"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000139 cl::aliasopt(ArchiveMap), cl::Grouping);
Kevin Enderby0fd8aac2014-07-03 21:51:07 +0000140
141cl::opt<bool> JustSymbolName("just-symbol-name",
142 cl::desc("Print just the symbol's name"));
143cl::alias JustSymbolNames("j", cl::desc("Alias for --just-symbol-name"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000144 cl::aliasopt(JustSymbolName), cl::Grouping);
Kevin Enderbyfe6ad972014-07-11 20:30:00 +0000145
146// FIXME: This option takes exactly two strings and should be allowed anywhere
147// on the command line. Such that "llvm-nm -s __TEXT __text foo.o" would work.
148// But that does not as the CommandLine Library does not have a way to make
149// this work. For now the "-s __TEXT __text" has to be last on the command
150// line.
151cl::list<std::string> SegSect("s", cl::Positional, cl::ZeroOrMore,
152 cl::desc("Dump only symbols from this segment "
153 "and section name, Mach-O only"));
154
Kevin Enderby77b968e2014-07-16 17:38:26 +0000155cl::opt<bool> FormatMachOasHex("x", cl::desc("Print symbol entry in hex, "
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000156 "Mach-O only"), cl::Grouping);
Kevin Enderby77b968e2014-07-16 17:38:26 +0000157
Peter Collingbourne10039c02014-09-18 21:28:49 +0000158cl::opt<bool> NoLLVMBitcode("no-llvm-bc",
159 cl::desc("Disable LLVM bitcode reader"));
160
Rafael Espindolab4865d62014-04-03 00:19:35 +0000161bool PrintAddress = true;
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000162
Rafael Espindola619581c2014-01-29 04:56:19 +0000163bool MultipleFiles = false;
Brian Gaeke0af759d2003-10-16 04:43:15 +0000164
Rafael Espindola619581c2014-01-29 04:56:19 +0000165bool HadError = false;
Rafael Espindola8b82a4d2013-07-03 15:46:03 +0000166
Rafael Espindola619581c2014-01-29 04:56:19 +0000167std::string ToolName;
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000168} // anonymous namespace
Brian Gaeke0af759d2003-10-16 04:43:15 +0000169
Rafael Espindola619581c2014-01-29 04:56:19 +0000170static void error(Twine Message, Twine Path = Twine()) {
171 HadError = true;
172 errs() << ToolName << ": " << Path << ": " << Message << ".\n";
Michael J. Spencerbc96f372011-12-13 23:17:29 +0000173}
174
Rafael Espindola4453e42942014-06-13 03:07:50 +0000175static bool error(std::error_code EC, Twine Path = Twine()) {
Rafael Espindola619581c2014-01-29 04:56:19 +0000176 if (EC) {
177 error(EC.message(), Path);
Michael J. Spencerbc96f372011-12-13 23:17:29 +0000178 return true;
179 }
180 return false;
181}
182
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000183namespace {
Rafael Espindola619581c2014-01-29 04:56:19 +0000184struct NMSymbol {
Rafael Espindolab4865d62014-04-03 00:19:35 +0000185 uint64_t Address;
Rafael Espindola619581c2014-01-29 04:56:19 +0000186 uint64_t Size;
187 char TypeChar;
188 StringRef Name;
Rafael Espindola2d5d23d2015-07-06 21:36:23 +0000189 BasicSymbolRef Sym;
Rafael Espindola619581c2014-01-29 04:56:19 +0000190};
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000191} // anonymous namespace
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000192
Rafael Espindolab4865d62014-04-03 00:19:35 +0000193static bool compareSymbolAddress(const NMSymbol &A, const NMSymbol &B) {
Rafael Espindola45592c62015-07-13 22:01:02 +0000194 bool ADefined = !(A.Sym.getFlags() & SymbolRef::SF_Undefined);
195 bool BDefined = !(B.Sym.getFlags() & SymbolRef::SF_Undefined);
196 return std::make_tuple(ADefined, A.Address, A.Name, A.Size) <
197 std::make_tuple(BDefined, B.Address, B.Name, B.Size);
Rafael Espindola619581c2014-01-29 04:56:19 +0000198}
199
200static bool compareSymbolSize(const NMSymbol &A, const NMSymbol &B) {
Rafael Espindola45592c62015-07-13 22:01:02 +0000201 return std::make_tuple(A.Size, A.Name, A.Address) <
202 std::make_tuple(B.Size, B.Name, B.Address);
Rafael Espindola619581c2014-01-29 04:56:19 +0000203}
204
205static bool compareSymbolName(const NMSymbol &A, const NMSymbol &B) {
Rafael Espindola45592c62015-07-13 22:01:02 +0000206 return std::make_tuple(A.Name, A.Size, A.Address) <
207 std::make_tuple(B.Name, B.Size, B.Address);
Rafael Espindola619581c2014-01-29 04:56:19 +0000208}
209
Rafael Espindolaceb23382014-07-31 21:00:10 +0000210static char isSymbolList64Bit(SymbolicFile &Obj) {
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000211 if (isa<IRObjectFile>(Obj)) {
212 IRObjectFile *IRobj = dyn_cast<IRObjectFile>(&Obj);
213 Module &M = IRobj->getModule();
214 if (M.getTargetTriple().empty())
215 return false;
216 Triple T(M.getTargetTriple());
217 return T.isArch64Bit();
218 }
David Blaikie328c0c12015-03-23 21:17:43 +0000219 if (isa<COFFObjectFile>(Obj))
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000220 return false;
David Blaikie328c0c12015-03-23 21:17:43 +0000221 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj))
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000222 return MachO->is64Bit();
Rafael Espindola034a4c382015-06-26 14:11:54 +0000223 return cast<ELFObjectFileBase>(Obj).getBytesInAddress() == 8;
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000224}
225
Rafael Espindola619581c2014-01-29 04:56:19 +0000226static StringRef CurrentFilename;
227typedef std::vector<NMSymbol> SymbolListT;
228static SymbolListT SymbolList;
229
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000230static char getSymbolNMTypeChar(IRObjectFile &Obj, basic_symbol_iterator I);
231
Kevin Enderby980b2582014-06-05 21:21:57 +0000232// darwinPrintSymbol() is used to print a symbol from a Mach-O file when the
Kevin Enderby77b968e2014-07-16 17:38:26 +0000233// the OutputFormat is darwin or we are printing Mach-O symbols in hex. For
234// the darwin format it produces the same output as darwin's nm(1) -m output
235// and when printing Mach-O symbols in hex it produces the same output as
236// darwin's nm(1) -x format.
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000237static void darwinPrintSymbol(SymbolicFile &Obj, SymbolListT::iterator I,
238 char *SymbolAddrStr, const char *printBlanks,
239 const char *printDashes, const char *printFormat) {
Kevin Enderby980b2582014-06-05 21:21:57 +0000240 MachO::mach_header H;
241 MachO::mach_header_64 H_64;
Reid Kleckner3afb80e2015-11-19 00:51:50 +0000242 uint32_t Filetype = MachO::MH_OBJECT;
243 uint32_t Flags = 0;
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000244 uint8_t NType = 0;
245 uint8_t NSect = 0;
246 uint16_t NDesc = 0;
247 uint32_t NStrx = 0;
248 uint64_t NValue = 0;
249 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
250 if (Obj.isIR()) {
251 uint32_t SymFlags = I->Sym.getFlags();
252 if (SymFlags & SymbolRef::SF_Global)
253 NType |= MachO::N_EXT;
254 if (SymFlags & SymbolRef::SF_Hidden)
255 NType |= MachO::N_PEXT;
256 if (SymFlags & SymbolRef::SF_Undefined)
257 NType |= MachO::N_EXT | MachO::N_UNDF;
258 else {
259 // Here we have a symbol definition. So to fake out a section name we
260 // use 1, 2 and 3 for section numbers. See below where they are used to
261 // print out fake section names.
262 NType |= MachO::N_SECT;
Davide Italianod4a48532016-02-01 19:22:16 +0000263 if (SymFlags & SymbolRef::SF_Const)
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000264 NSect = 3;
265 else {
266 IRObjectFile *IRobj = dyn_cast<IRObjectFile>(&Obj);
Davide Italianod4a48532016-02-01 19:22:16 +0000267 NSect = (getSymbolNMTypeChar(*IRobj, I->Sym) == 't') ? 1 : 2;
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000268 }
269 }
270 if (SymFlags & SymbolRef::SF_Weak)
271 NDesc |= MachO::N_WEAK_DEF;
Kevin Enderby980b2582014-06-05 21:21:57 +0000272 } else {
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000273 DataRefImpl SymDRI = I->Sym.getRawDataRefImpl();
274 if (MachO->is64Bit()) {
275 H_64 = MachO->MachOObjectFile::getHeader64();
276 Filetype = H_64.filetype;
277 Flags = H_64.flags;
Reid Kleckner3afb80e2015-11-19 00:51:50 +0000278 MachO::nlist_64 STE_64 = MachO->getSymbol64TableEntry(SymDRI);
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000279 NType = STE_64.n_type;
280 NSect = STE_64.n_sect;
281 NDesc = STE_64.n_desc;
282 NStrx = STE_64.n_strx;
283 NValue = STE_64.n_value;
284 } else {
285 H = MachO->MachOObjectFile::getHeader();
286 Filetype = H.filetype;
287 Flags = H.flags;
Reid Kleckner3afb80e2015-11-19 00:51:50 +0000288 MachO::nlist STE = MachO->getSymbolTableEntry(SymDRI);
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000289 NType = STE.n_type;
290 NSect = STE.n_sect;
291 NDesc = STE.n_desc;
292 NStrx = STE.n_strx;
293 NValue = STE.n_value;
294 }
Kevin Enderby980b2582014-06-05 21:21:57 +0000295 }
296
Kevin Enderby77b968e2014-07-16 17:38:26 +0000297 // If we are printing Mach-O symbols in hex do that and return.
298 if (FormatMachOasHex) {
299 char Str[18] = "";
Kevin Enderby77b968e2014-07-16 17:38:26 +0000300 format(printFormat, NValue).print(Str, sizeof(Str));
301 outs() << Str << ' ';
302 format("%02x", NType).print(Str, sizeof(Str));
303 outs() << Str << ' ';
304 format("%02x", NSect).print(Str, sizeof(Str));
305 outs() << Str << ' ';
306 format("%04x", NDesc).print(Str, sizeof(Str));
307 outs() << Str << ' ';
308 format("%08x", NStrx).print(Str, sizeof(Str));
309 outs() << Str << ' ';
310 outs() << I->Name << "\n";
311 return;
312 }
313
Kevin Enderby980b2582014-06-05 21:21:57 +0000314 if (PrintAddress) {
315 if ((NType & MachO::N_TYPE) == MachO::N_INDR)
316 strcpy(SymbolAddrStr, printBlanks);
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000317 if (Obj.isIR() && (NType & MachO::N_TYPE) == MachO::N_TYPE)
318 strcpy(SymbolAddrStr, printDashes);
Kevin Enderby980b2582014-06-05 21:21:57 +0000319 outs() << SymbolAddrStr << ' ';
320 }
321
322 switch (NType & MachO::N_TYPE) {
323 case MachO::N_UNDF:
324 if (NValue != 0) {
325 outs() << "(common) ";
326 if (MachO::GET_COMM_ALIGN(NDesc) != 0)
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000327 outs() << "(alignment 2^" << (int)MachO::GET_COMM_ALIGN(NDesc) << ") ";
Kevin Enderby980b2582014-06-05 21:21:57 +0000328 } else {
329 if ((NType & MachO::N_TYPE) == MachO::N_PBUD)
330 outs() << "(prebound ";
331 else
332 outs() << "(";
333 if ((NDesc & MachO::REFERENCE_TYPE) ==
334 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
335 outs() << "undefined [lazy bound]) ";
336 else if ((NDesc & MachO::REFERENCE_TYPE) ==
337 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
338 outs() << "undefined [private lazy bound]) ";
339 else if ((NDesc & MachO::REFERENCE_TYPE) ==
340 MachO::REFERENCE_FLAG_PRIVATE_UNDEFINED_NON_LAZY)
341 outs() << "undefined [private]) ";
342 else
343 outs() << "undefined) ";
344 }
345 break;
346 case MachO::N_ABS:
347 outs() << "(absolute) ";
348 break;
349 case MachO::N_INDR:
350 outs() << "(indirect) ";
351 break;
352 case MachO::N_SECT: {
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000353 if (Obj.isIR()) {
354 // For llvm bitcode files print out a fake section name using the values
355 // use 1, 2 and 3 for section numbers as set above.
356 if (NSect == 1)
357 outs() << "(LTO,CODE) ";
358 else if (NSect == 2)
359 outs() << "(LTO,DATA) ";
360 else if (NSect == 3)
361 outs() << "(LTO,RODATA) ";
362 else
363 outs() << "(?,?) ";
364 break;
365 }
Kevin Enderby1f472ea2016-01-21 21:13:27 +0000366 ErrorOr<section_iterator> SecOrErr =
367 MachO->getSymbolSection(I->Sym.getRawDataRefImpl());
368 if (SecOrErr.getError()) {
369 outs() << "(?,?) ";
370 break;
371 }
372 section_iterator Sec = *SecOrErr;
Kevin Enderby980b2582014-06-05 21:21:57 +0000373 DataRefImpl Ref = Sec->getRawDataRefImpl();
374 StringRef SectionName;
375 MachO->getSectionName(Ref, SectionName);
376 StringRef SegmentName = MachO->getSectionFinalSegmentName(Ref);
377 outs() << "(" << SegmentName << "," << SectionName << ") ";
378 break;
379 }
380 default:
381 outs() << "(?) ";
382 break;
383 }
384
385 if (NType & MachO::N_EXT) {
386 if (NDesc & MachO::REFERENCED_DYNAMICALLY)
387 outs() << "[referenced dynamically] ";
388 if (NType & MachO::N_PEXT) {
389 if ((NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF)
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000390 outs() << "weak private external ";
Kevin Enderby980b2582014-06-05 21:21:57 +0000391 else
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000392 outs() << "private external ";
Kevin Enderby980b2582014-06-05 21:21:57 +0000393 } else {
394 if ((NDesc & MachO::N_WEAK_REF) == MachO::N_WEAK_REF ||
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000395 (NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF) {
Kevin Enderby980b2582014-06-05 21:21:57 +0000396 if ((NDesc & (MachO::N_WEAK_REF | MachO::N_WEAK_DEF)) ==
397 (MachO::N_WEAK_REF | MachO::N_WEAK_DEF))
398 outs() << "weak external automatically hidden ";
399 else
400 outs() << "weak external ";
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000401 } else
Kevin Enderby980b2582014-06-05 21:21:57 +0000402 outs() << "external ";
403 }
404 } else {
405 if (NType & MachO::N_PEXT)
406 outs() << "non-external (was a private external) ";
407 else
408 outs() << "non-external ";
409 }
410
411 if (Filetype == MachO::MH_OBJECT &&
412 (NDesc & MachO::N_NO_DEAD_STRIP) == MachO::N_NO_DEAD_STRIP)
413 outs() << "[no dead strip] ";
414
415 if (Filetype == MachO::MH_OBJECT &&
416 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
417 (NDesc & MachO::N_SYMBOL_RESOLVER) == MachO::N_SYMBOL_RESOLVER)
418 outs() << "[symbol resolver] ";
419
420 if (Filetype == MachO::MH_OBJECT &&
421 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
422 (NDesc & MachO::N_ALT_ENTRY) == MachO::N_ALT_ENTRY)
423 outs() << "[alt entry] ";
424
425 if ((NDesc & MachO::N_ARM_THUMB_DEF) == MachO::N_ARM_THUMB_DEF)
426 outs() << "[Thumb] ";
427
428 if ((NType & MachO::N_TYPE) == MachO::N_INDR) {
429 outs() << I->Name << " (for ";
430 StringRef IndirectName;
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000431 if (!MachO ||
432 MachO->getIndirectName(I->Sym.getRawDataRefImpl(), IndirectName))
Kevin Enderby980b2582014-06-05 21:21:57 +0000433 outs() << "?)";
434 else
435 outs() << IndirectName << ")";
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000436 } else
Kevin Enderby980b2582014-06-05 21:21:57 +0000437 outs() << I->Name;
438
439 if ((Flags & MachO::MH_TWOLEVEL) == MachO::MH_TWOLEVEL &&
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000440 (((NType & MachO::N_TYPE) == MachO::N_UNDF && NValue == 0) ||
Kevin Enderby980b2582014-06-05 21:21:57 +0000441 (NType & MachO::N_TYPE) == MachO::N_PBUD)) {
442 uint32_t LibraryOrdinal = MachO::GET_LIBRARY_ORDINAL(NDesc);
443 if (LibraryOrdinal != 0) {
444 if (LibraryOrdinal == MachO::EXECUTABLE_ORDINAL)
445 outs() << " (from executable)";
446 else if (LibraryOrdinal == MachO::DYNAMIC_LOOKUP_ORDINAL)
447 outs() << " (dynamically looked up)";
448 else {
449 StringRef LibraryName;
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000450 if (!MachO ||
451 MachO->getLibraryShortNameByIndex(LibraryOrdinal - 1, LibraryName))
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000452 outs() << " (from bad library ordinal " << LibraryOrdinal << ")";
Kevin Enderby980b2582014-06-05 21:21:57 +0000453 else
454 outs() << " (from " << LibraryName << ")";
455 }
456 }
457 }
458
459 outs() << "\n";
460}
461
Kevin Enderby407cc212014-07-17 22:47:16 +0000462// Table that maps Darwin's Mach-O stab constants to strings to allow printing.
463struct DarwinStabName {
464 uint8_t NType;
465 const char *Name;
466};
467static const struct DarwinStabName DarwinStabNames[] = {
468 {MachO::N_GSYM, "GSYM"},
469 {MachO::N_FNAME, "FNAME"},
470 {MachO::N_FUN, "FUN"},
471 {MachO::N_STSYM, "STSYM"},
472 {MachO::N_LCSYM, "LCSYM"},
473 {MachO::N_BNSYM, "BNSYM"},
474 {MachO::N_PC, "PC"},
475 {MachO::N_AST, "AST"},
476 {MachO::N_OPT, "OPT"},
477 {MachO::N_RSYM, "RSYM"},
478 {MachO::N_SLINE, "SLINE"},
479 {MachO::N_ENSYM, "ENSYM"},
480 {MachO::N_SSYM, "SSYM"},
481 {MachO::N_SO, "SO"},
482 {MachO::N_OSO, "OSO"},
483 {MachO::N_LSYM, "LSYM"},
484 {MachO::N_BINCL, "BINCL"},
485 {MachO::N_SOL, "SOL"},
486 {MachO::N_PARAMS, "PARAM"},
487 {MachO::N_VERSION, "VERS"},
488 {MachO::N_OLEVEL, "OLEV"},
489 {MachO::N_PSYM, "PSYM"},
490 {MachO::N_EINCL, "EINCL"},
491 {MachO::N_ENTRY, "ENTRY"},
492 {MachO::N_LBRAC, "LBRAC"},
493 {MachO::N_EXCL, "EXCL"},
494 {MachO::N_RBRAC, "RBRAC"},
495 {MachO::N_BCOMM, "BCOMM"},
496 {MachO::N_ECOMM, "ECOMM"},
497 {MachO::N_ECOML, "ECOML"},
498 {MachO::N_LENG, "LENG"},
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000499 {0, nullptr}};
500
Kevin Enderby407cc212014-07-17 22:47:16 +0000501static const char *getDarwinStabString(uint8_t NType) {
502 for (unsigned i = 0; DarwinStabNames[i].Name; i++) {
503 if (DarwinStabNames[i].NType == NType)
504 return DarwinStabNames[i].Name;
505 }
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000506 return nullptr;
Kevin Enderby407cc212014-07-17 22:47:16 +0000507}
508
509// darwinPrintStab() prints the n_sect, n_desc along with a symbolic name of
510// a stab n_type value in a Mach-O file.
511static void darwinPrintStab(MachOObjectFile *MachO, SymbolListT::iterator I) {
512 MachO::nlist_64 STE_64;
513 MachO::nlist STE;
514 uint8_t NType;
515 uint8_t NSect;
516 uint16_t NDesc;
Rafael Espindola2d5d23d2015-07-06 21:36:23 +0000517 DataRefImpl SymDRI = I->Sym.getRawDataRefImpl();
Kevin Enderby407cc212014-07-17 22:47:16 +0000518 if (MachO->is64Bit()) {
Rafael Espindola2d5d23d2015-07-06 21:36:23 +0000519 STE_64 = MachO->getSymbol64TableEntry(SymDRI);
Kevin Enderby407cc212014-07-17 22:47:16 +0000520 NType = STE_64.n_type;
521 NSect = STE_64.n_sect;
522 NDesc = STE_64.n_desc;
523 } else {
Rafael Espindola2d5d23d2015-07-06 21:36:23 +0000524 STE = MachO->getSymbolTableEntry(SymDRI);
Kevin Enderby407cc212014-07-17 22:47:16 +0000525 NType = STE.n_type;
526 NSect = STE.n_sect;
527 NDesc = STE.n_desc;
528 }
529
530 char Str[18] = "";
531 format("%02x", NSect).print(Str, sizeof(Str));
532 outs() << ' ' << Str << ' ';
533 format("%04x", NDesc).print(Str, sizeof(Str));
534 outs() << Str << ' ';
535 if (const char *stabString = getDarwinStabString(NType))
536 format("%5.5s", stabString).print(Str, sizeof(Str));
537 else
538 format(" %02x", NType).print(Str, sizeof(Str));
539 outs() << Str;
540}
541
Rafael Espindolaceb23382014-07-31 21:00:10 +0000542static void sortAndPrintSymbolList(SymbolicFile &Obj, bool printName,
Kevin Enderby08e1bbd2014-07-24 23:31:52 +0000543 std::string ArchiveName,
544 std::string ArchitectureName) {
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000545 if (!NoSort) {
Rafael Espindola63d10d62015-07-06 18:48:47 +0000546 std::function<bool(const NMSymbol &, const NMSymbol &)> Cmp;
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000547 if (NumericSort)
Rafael Espindola63d10d62015-07-06 18:48:47 +0000548 Cmp = compareSymbolAddress;
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000549 else if (SizeSort)
Rafael Espindola63d10d62015-07-06 18:48:47 +0000550 Cmp = compareSymbolSize;
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000551 else
Rafael Espindola63d10d62015-07-06 18:48:47 +0000552 Cmp = compareSymbolName;
553
554 if (ReverseSort)
Rafael Espindolacab82752015-07-06 19:24:40 +0000555 Cmp = [=](const NMSymbol &A, const NMSymbol &B) { return Cmp(B, A); };
Rafael Espindola63d10d62015-07-06 18:48:47 +0000556 std::sort(SymbolList.begin(), SymbolList.end(), Cmp);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000557 }
558
Kevin Enderby08e1bbd2014-07-24 23:31:52 +0000559 if (!PrintFileName) {
560 if (OutputFormat == posix && MultipleFiles && printName) {
561 outs() << '\n' << CurrentFilename << ":\n";
562 } else if (OutputFormat == bsd && MultipleFiles && printName) {
563 outs() << "\n" << CurrentFilename << ":\n";
564 } else if (OutputFormat == sysv) {
565 outs() << "\n\nSymbols from " << CurrentFilename << ":\n\n"
566 << "Name Value Class Type"
567 << " Size Line Section\n";
568 }
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000569 }
570
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000571 const char *printBlanks, *printDashes, *printFormat;
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000572 if (isSymbolList64Bit(Obj)) {
573 printBlanks = " ";
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000574 printDashes = "----------------";
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000575 printFormat = "%016" PRIx64;
576 } else {
577 printBlanks = " ";
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000578 printDashes = "--------";
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000579 printFormat = "%08" PRIx64;
580 }
581
Rafael Espindola619581c2014-01-29 04:56:19 +0000582 for (SymbolListT::iterator I = SymbolList.begin(), E = SymbolList.end();
583 I != E; ++I) {
Rafael Espindola2d5d23d2015-07-06 21:36:23 +0000584 uint32_t SymFlags = I->Sym.getFlags();
585 bool Undefined = SymFlags & SymbolRef::SF_Undefined;
Kevin Enderby1543bdf2015-10-30 19:55:32 +0000586 bool Global = SymFlags & SymbolRef::SF_Global;
Davide Italiano74237152016-01-26 19:57:42 +0000587 if ((!Undefined && UndefinedOnly) || (Undefined && DefinedOnly) ||
588 (!Global && ExternalOnly) || (SizeSort && !PrintAddress))
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000589 continue;
Kevin Enderby08e1bbd2014-07-24 23:31:52 +0000590 if (PrintFileName) {
591 if (!ArchitectureName.empty())
592 outs() << "(for architecture " << ArchitectureName << "):";
593 if (!ArchiveName.empty())
594 outs() << ArchiveName << ":";
595 outs() << CurrentFilename << ": ";
596 }
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000597 if ((JustSymbolName || (UndefinedOnly && isa<MachOObjectFile>(Obj) &&
598 OutputFormat != darwin)) && OutputFormat != posix) {
Kevin Enderby0fd8aac2014-07-03 21:51:07 +0000599 outs() << I->Name << "\n";
600 continue;
601 }
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000602
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000603 char SymbolAddrStr[18] = "";
604 char SymbolSizeStr[18] = "";
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000605
Rafael Espindolabe8b0ea2015-07-07 17:12:59 +0000606 if (OutputFormat == sysv || I->TypeChar == 'U')
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000607 strcpy(SymbolAddrStr, printBlanks);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000608 if (OutputFormat == sysv)
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000609 strcpy(SymbolSizeStr, printBlanks);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000610
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000611 if (I->TypeChar != 'U') {
612 if (Obj.isIR())
613 strcpy(SymbolAddrStr, printDashes);
614 else
615 format(printFormat, I->Address)
Rafael Espindolab4865d62014-04-03 00:19:35 +0000616 .print(SymbolAddrStr, sizeof(SymbolAddrStr));
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000617 }
Rafael Espindolad7a32ea2015-06-24 10:20:30 +0000618 format(printFormat, I->Size).print(SymbolSizeStr, sizeof(SymbolSizeStr));
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000619
Kevin Enderby77b968e2014-07-16 17:38:26 +0000620 // If OutputFormat is darwin or we are printing Mach-O symbols in hex and
621 // we have a MachOObjectFile, call darwinPrintSymbol to print as darwin's
622 // nm(1) -m output or hex, else if OutputFormat is darwin or we are
623 // printing Mach-O symbols in hex and not a Mach-O object fall back to
624 // OutputFormat bsd (see below).
Rafael Espindolaceb23382014-07-31 21:00:10 +0000625 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000626 if ((OutputFormat == darwin || FormatMachOasHex) && (MachO || Obj.isIR())) {
627 darwinPrintSymbol(Obj, I, SymbolAddrStr, printBlanks, printDashes,
628 printFormat);
Kevin Enderby980b2582014-06-05 21:21:57 +0000629 } else if (OutputFormat == posix) {
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000630 outs() << I->Name << " " << I->TypeChar << " ";
631 if (MachO)
632 outs() << I->Address << " " << "0" /* SymbolSizeStr */ << "\n";
633 else
634 outs() << SymbolAddrStr << SymbolSizeStr << "\n";
Kevin Enderby980b2582014-06-05 21:21:57 +0000635 } else if (OutputFormat == bsd || (OutputFormat == darwin && !MachO)) {
Rafael Espindolab4865d62014-04-03 00:19:35 +0000636 if (PrintAddress)
637 outs() << SymbolAddrStr << ' ';
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000638 if (PrintSize) {
639 outs() << SymbolSizeStr;
Rafael Espindolad7a32ea2015-06-24 10:20:30 +0000640 outs() << ' ';
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000641 }
Kevin Enderby407cc212014-07-17 22:47:16 +0000642 outs() << I->TypeChar;
643 if (I->TypeChar == '-' && MachO)
644 darwinPrintStab(MachO, I);
645 outs() << " " << I->Name << "\n";
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000646 } else if (OutputFormat == sysv) {
Rafael Espindola619581c2014-01-29 04:56:19 +0000647 std::string PaddedName(I->Name);
648 while (PaddedName.length() < 20)
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000649 PaddedName += " ";
Rafael Espindolab4865d62014-04-03 00:19:35 +0000650 outs() << PaddedName << "|" << SymbolAddrStr << "| " << I->TypeChar
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000651 << " | |" << SymbolSizeStr << "| |\n";
652 }
653 }
654
655 SymbolList.clear();
656}
657
Rafael Espindolab39953d2015-06-26 13:11:15 +0000658static char getSymbolNMTypeChar(ELFObjectFileBase &Obj,
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000659 basic_symbol_iterator I) {
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000660 // OK, this is ELF
Rafael Espindolab39953d2015-06-26 13:11:15 +0000661 elf_symbol_iterator SymI(I);
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000662
Rafael Espindola8bab8892015-08-07 23:27:14 +0000663 ErrorOr<elf_section_iterator> SecIOrErr = SymI->getSection();
664 if (error(SecIOrErr.getError()))
Rafael Espindolab39953d2015-06-26 13:11:15 +0000665 return '?';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000666
Rafael Espindola8bab8892015-08-07 23:27:14 +0000667 elf_section_iterator SecI = *SecIOrErr;
Rafael Espindolab39953d2015-06-26 13:11:15 +0000668 if (SecI != Obj.section_end()) {
669 switch (SecI->getType()) {
Rafael Espindola586af97a2013-11-02 21:16:09 +0000670 case ELF::SHT_PROGBITS:
671 case ELF::SHT_DYNAMIC:
Rafael Espindolab39953d2015-06-26 13:11:15 +0000672 switch (SecI->getFlags()) {
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000673 case (ELF::SHF_ALLOC | ELF::SHF_EXECINSTR):
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000674 return 't';
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000675 case (ELF::SHF_TLS | ELF::SHF_ALLOC | ELF::SHF_WRITE):
676 case (ELF::SHF_ALLOC | ELF::SHF_WRITE):
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000677 return 'd';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000678 case ELF::SHF_ALLOC:
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000679 case (ELF::SHF_ALLOC | ELF::SHF_MERGE):
680 case (ELF::SHF_ALLOC | ELF::SHF_MERGE | ELF::SHF_STRINGS):
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000681 return 'r';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000682 }
683 break;
684 case ELF::SHT_NOBITS:
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000685 return 'b';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000686 }
687 }
688
Rafael Espindolab39953d2015-06-26 13:11:15 +0000689 if (SymI->getELFType() == ELF::STT_SECTION) {
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000690 ErrorOr<StringRef> Name = SymI->getName();
691 if (error(Name.getError()))
Rafael Espindola74375892014-02-04 00:21:18 +0000692 return '?';
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000693 return StringSwitch<char>(*Name)
Rafael Espindola74375892014-02-04 00:21:18 +0000694 .StartsWith(".debug", 'N')
695 .StartsWith(".note", 'n')
696 .Default('?');
Rafael Espindola586af97a2013-11-02 21:16:09 +0000697 }
698
Rafael Espindola60c1a8c2015-06-25 16:01:53 +0000699 return 'n';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000700}
701
Rafael Espindola74375892014-02-04 00:21:18 +0000702static char getSymbolNMTypeChar(COFFObjectFile &Obj, symbol_iterator I) {
David Majnemer44f51e52014-09-10 12:51:52 +0000703 COFFSymbolRef Symb = Obj.getCOFFSymbol(*I);
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000704 // OK, this is COFF.
705 symbol_iterator SymI(I);
706
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000707 ErrorOr<StringRef> Name = SymI->getName();
708 if (error(Name.getError()))
Rafael Espindola74375892014-02-04 00:21:18 +0000709 return '?';
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000710
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000711 char Ret = StringSwitch<char>(*Name)
Rafael Espindola586af97a2013-11-02 21:16:09 +0000712 .StartsWith(".debug", 'N')
713 .StartsWith(".sxdata", 'N')
714 .Default('?');
715
Rafael Espindola74375892014-02-04 00:21:18 +0000716 if (Ret != '?')
717 return Ret;
Rafael Espindola586af97a2013-11-02 21:16:09 +0000718
719 uint32_t Characteristics = 0;
David Majnemer44f51e52014-09-10 12:51:52 +0000720 if (!COFF::isReservedSectionNumber(Symb.getSectionNumber())) {
Rafael Espindola8bab8892015-08-07 23:27:14 +0000721 ErrorOr<section_iterator> SecIOrErr = SymI->getSection();
722 if (error(SecIOrErr.getError()))
Rafael Espindola74375892014-02-04 00:21:18 +0000723 return '?';
Rafael Espindola8bab8892015-08-07 23:27:14 +0000724 section_iterator SecI = *SecIOrErr;
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000725 const coff_section *Section = Obj.getCOFFSection(*SecI);
Rafael Espindola586af97a2013-11-02 21:16:09 +0000726 Characteristics = Section->Characteristics;
727 }
728
David Majnemer44f51e52014-09-10 12:51:52 +0000729 switch (Symb.getSectionNumber()) {
Rafael Espindola586af97a2013-11-02 21:16:09 +0000730 case COFF::IMAGE_SYM_DEBUG:
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000731 return 'n';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000732 default:
733 // Check section type.
734 if (Characteristics & COFF::IMAGE_SCN_CNT_CODE)
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000735 return 't';
David Majnemerc7d7c6f2014-10-31 05:07:00 +0000736 if (Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
737 return Characteristics & COFF::IMAGE_SCN_MEM_WRITE ? 'd' : 'r';
738 if (Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000739 return 'b';
David Majnemerc7d7c6f2014-10-31 05:07:00 +0000740 if (Characteristics & COFF::IMAGE_SCN_LNK_INFO)
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000741 return 'i';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000742 // Check for section symbol.
David Majnemerc7d7c6f2014-10-31 05:07:00 +0000743 if (Symb.isSectionDefinition())
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000744 return 's';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000745 }
746
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000747 return '?';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000748}
749
750static uint8_t getNType(MachOObjectFile &Obj, DataRefImpl Symb) {
751 if (Obj.is64Bit()) {
752 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
753 return STE.n_type;
754 }
755 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
756 return STE.n_type;
757}
758
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000759static char getSymbolNMTypeChar(MachOObjectFile &Obj, basic_symbol_iterator I) {
Rafael Espindola586af97a2013-11-02 21:16:09 +0000760 DataRefImpl Symb = I->getRawDataRefImpl();
761 uint8_t NType = getNType(Obj, Symb);
762
Kevin Enderby407cc212014-07-17 22:47:16 +0000763 if (NType & MachO::N_STAB)
764 return '-';
765
Rafael Espindola586af97a2013-11-02 21:16:09 +0000766 switch (NType & MachO::N_TYPE) {
Rafael Espindola586af97a2013-11-02 21:16:09 +0000767 case MachO::N_ABS:
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000768 return 's';
Tim Northovereaef0742014-05-30 13:22:59 +0000769 case MachO::N_INDR:
770 return 'i';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000771 case MachO::N_SECT: {
Kevin Enderby1f472ea2016-01-21 21:13:27 +0000772 ErrorOr<section_iterator> SecOrErr = Obj.getSymbolSection(Symb);
773 if (SecOrErr.getError())
774 return 's';
775 section_iterator Sec = *SecOrErr;
Rafael Espindola586af97a2013-11-02 21:16:09 +0000776 DataRefImpl Ref = Sec->getRawDataRefImpl();
777 StringRef SectionName;
778 Obj.getSectionName(Ref, SectionName);
779 StringRef SegmentName = Obj.getSectionFinalSegmentName(Ref);
780 if (SegmentName == "__TEXT" && SectionName == "__text")
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000781 return 't';
Davide Italianoe4db1872016-01-26 19:28:51 +0000782 if (SegmentName == "__DATA" && SectionName == "__data")
Kevin Enderby1e1b9922014-06-19 22:49:21 +0000783 return 'd';
Davide Italianoe4db1872016-01-26 19:28:51 +0000784 if (SegmentName == "__DATA" && SectionName == "__bss")
Kevin Enderby1e1b9922014-06-19 22:49:21 +0000785 return 'b';
Davide Italianoe4db1872016-01-26 19:28:51 +0000786 return 's';
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000787 }
Rafael Espindola586af97a2013-11-02 21:16:09 +0000788 }
789
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000790 return '?';
791}
792
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000793static char getSymbolNMTypeChar(const GlobalValue &GV) {
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000794 // FIXME: should we print 'b'? At the IR level we cannot be sure if this
795 // will be in bss or not, but we could approximate.
Davide Italiano71c85df2016-02-08 22:58:26 +0000796 return (GV.getValueType()->isFunctionTy()) ? 't' : 'd';
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000797}
798
799static char getSymbolNMTypeChar(IRObjectFile &Obj, basic_symbol_iterator I) {
Rafael Espindola13b69d62014-07-03 18:59:23 +0000800 const GlobalValue *GV = Obj.getSymbolGV(I->getRawDataRefImpl());
Davide Italiano71c85df2016-02-08 22:58:26 +0000801 return (!GV) ? 't' : getSymbolNMTypeChar(*GV);
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000802}
803
Rafael Espindolaceb23382014-07-31 21:00:10 +0000804static bool isObject(SymbolicFile &Obj, basic_symbol_iterator I) {
Davide Italiano71c85df2016-02-08 22:58:26 +0000805 return (!dyn_cast<ELFObjectFileBase>(&Obj))
806 ? false
807 : elf_symbol_iterator(I)->getELFType() == ELF::STT_OBJECT;
Rafael Espindola586af97a2013-11-02 21:16:09 +0000808}
809
Rafael Espindolaceb23382014-07-31 21:00:10 +0000810static char getNMTypeChar(SymbolicFile &Obj, basic_symbol_iterator I) {
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000811 uint32_t Symflags = I->getFlags();
812 if ((Symflags & object::SymbolRef::SF_Weak) && !isa<MachOObjectFile>(Obj)) {
813 char Ret = isObject(Obj, I) ? 'v' : 'w';
Davide Italianoa090a002016-02-05 21:10:48 +0000814 return (!(Symflags & object::SymbolRef::SF_Undefined)) ? toupper(Ret) : Ret;
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000815 }
816
817 if (Symflags & object::SymbolRef::SF_Undefined)
818 return 'U';
819
820 if (Symflags & object::SymbolRef::SF_Common)
821 return 'C';
822
823 char Ret = '?';
824 if (Symflags & object::SymbolRef::SF_Absolute)
825 Ret = 'a';
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000826 else if (IRObjectFile *IR = dyn_cast<IRObjectFile>(&Obj)) {
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000827 Ret = getSymbolNMTypeChar(*IR, I);
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000828 Triple Host(sys::getDefaultTargetTriple());
Davide Italianoa090a002016-02-05 21:10:48 +0000829 if (Ret == 'd' && Host.isOSDarwin() && Symflags & SymbolRef::SF_Const)
830 Ret = 's';
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000831 }
Rafael Espindolaceb23382014-07-31 21:00:10 +0000832 else if (COFFObjectFile *COFF = dyn_cast<COFFObjectFile>(&Obj))
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000833 Ret = getSymbolNMTypeChar(*COFF, I);
Rafael Espindolaceb23382014-07-31 21:00:10 +0000834 else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj))
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000835 Ret = getSymbolNMTypeChar(*MachO, I);
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000836 else
Rafael Espindolab39953d2015-06-26 13:11:15 +0000837 Ret = getSymbolNMTypeChar(cast<ELFObjectFileBase>(Obj), I);
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000838
839 if (Symflags & object::SymbolRef::SF_Global)
840 Ret = toupper(Ret);
841
842 return Ret;
Rafael Espindola586af97a2013-11-02 21:16:09 +0000843}
844
Kevin Enderbyfe6ad972014-07-11 20:30:00 +0000845// getNsectForSegSect() is used to implement the Mach-O "-s segname sectname"
846// option to dump only those symbols from that section in a Mach-O file.
847// It is called once for each Mach-O file from dumpSymbolNamesFromObject()
848// to get the section number for that named section from the command line
849// arguments. It returns the section number for that section in the Mach-O
850// file or zero it is not present.
851static unsigned getNsectForSegSect(MachOObjectFile *Obj) {
852 unsigned Nsect = 1;
853 for (section_iterator I = Obj->section_begin(), E = Obj->section_end();
854 I != E; ++I) {
855 DataRefImpl Ref = I->getRawDataRefImpl();
856 StringRef SectionName;
857 Obj->getSectionName(Ref, SectionName);
858 StringRef SegmentName = Obj->getSectionFinalSegmentName(Ref);
859 if (SegmentName == SegSect[0] && SectionName == SegSect[1])
860 return Nsect;
861 Nsect++;
862 }
863 return 0;
864}
865
866// getNsectInMachO() is used to implement the Mach-O "-s segname sectname"
867// option to dump only those symbols from that section in a Mach-O file.
868// It is called once for each symbol in a Mach-O file from
869// dumpSymbolNamesFromObject() and returns the section number for that symbol
870// if it is in a section, else it returns 0.
Rafael Espindolab85e10c2015-06-25 15:00:38 +0000871static unsigned getNsectInMachO(MachOObjectFile &Obj, BasicSymbolRef Sym) {
872 DataRefImpl Symb = Sym.getRawDataRefImpl();
Kevin Enderbyfe6ad972014-07-11 20:30:00 +0000873 if (Obj.is64Bit()) {
874 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
875 if ((STE.n_type & MachO::N_TYPE) == MachO::N_SECT)
876 return STE.n_sect;
877 return 0;
878 }
879 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
880 if ((STE.n_type & MachO::N_TYPE) == MachO::N_SECT)
881 return STE.n_sect;
882 return 0;
883}
884
Rafael Espindolaceb23382014-07-31 21:00:10 +0000885static void dumpSymbolNamesFromObject(SymbolicFile &Obj, bool printName,
Kevin Enderby08e1bbd2014-07-24 23:31:52 +0000886 std::string ArchiveName = std::string(),
887 std::string ArchitectureName =
888 std::string()) {
Rafael Espindolab85e10c2015-06-25 15:00:38 +0000889 auto Symbols = Obj.symbols();
Michael J. Spencer8c4729f2012-02-28 00:40:37 +0000890 if (DynamicSyms) {
Rafael Espindola11afad02015-06-25 14:39:35 +0000891 const auto *E = dyn_cast<ELFObjectFileBase>(&Obj);
892 if (!E) {
Rafael Espindolaceb23382014-07-31 21:00:10 +0000893 error("File format has no dynamic symbol table", Obj.getFileName());
Rafael Espindola196666c2014-01-30 20:45:33 +0000894 return;
895 }
Rafael Espindolab85e10c2015-06-25 15:00:38 +0000896 auto DynSymbols = E->getDynamicSymbolIterators();
897 Symbols =
898 make_range<basic_symbol_iterator>(DynSymbols.begin(), DynSymbols.end());
Michael J. Spencer8c4729f2012-02-28 00:40:37 +0000899 }
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000900 std::string NameBuffer;
901 raw_string_ostream OS(NameBuffer);
Kevin Enderbyfe6ad972014-07-11 20:30:00 +0000902 // If a "-s segname sectname" option was specified and this is a Mach-O
903 // file get the section number for that section in this object file.
904 unsigned int Nsect = 0;
Rafael Espindolaceb23382014-07-31 21:00:10 +0000905 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
Kevin Enderbyfe6ad972014-07-11 20:30:00 +0000906 if (SegSect.size() != 0 && MachO) {
907 Nsect = getNsectForSegSect(MachO);
908 // If this section is not in the object file no symbols are printed.
909 if (Nsect == 0)
910 return;
911 }
Rafael Espindolab85e10c2015-06-25 15:00:38 +0000912 for (BasicSymbolRef Sym : Symbols) {
913 uint32_t SymFlags = Sym.getFlags();
Rafael Espindola619581c2014-01-29 04:56:19 +0000914 if (!DebugSyms && (SymFlags & SymbolRef::SF_FormatSpecific))
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000915 continue;
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000916 if (WithoutAliases) {
Rafael Espindolaceb23382014-07-31 21:00:10 +0000917 if (IRObjectFile *IR = dyn_cast<IRObjectFile>(&Obj)) {
Rafael Espindolab85e10c2015-06-25 15:00:38 +0000918 const GlobalValue *GV = IR->getSymbolGV(Sym.getRawDataRefImpl());
Rafael Espindola13b69d62014-07-03 18:59:23 +0000919 if (GV && isa<GlobalAlias>(GV))
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000920 continue;
921 }
922 }
Kevin Enderbyfe6ad972014-07-11 20:30:00 +0000923 // If a "-s segname sectname" option was specified and this is a Mach-O
924 // file and this section appears in this file, Nsect will be non-zero then
925 // see if this symbol is a symbol from that section and if not skip it.
Rafael Espindolab85e10c2015-06-25 15:00:38 +0000926 if (Nsect && Nsect != getNsectInMachO(*MachO, Sym))
Kevin Enderbyfe6ad972014-07-11 20:30:00 +0000927 continue;
Rafael Espindola619581c2014-01-29 04:56:19 +0000928 NMSymbol S;
Rafael Espindolad7a32ea2015-06-24 10:20:30 +0000929 S.Size = 0;
Rafael Espindolabe8b0ea2015-07-07 17:12:59 +0000930 S.Address = 0;
Rafael Espindolad7a32ea2015-06-24 10:20:30 +0000931 if (PrintSize) {
Rafael Espindoladbb6bd32015-06-25 22:10:04 +0000932 if (isa<ELFObjectFileBase>(&Obj))
933 S.Size = ELFSymbolRef(Sym).getSize();
Michael J. Spencer1d6167f2011-06-25 17:55:23 +0000934 }
Rafael Espindolab85e10c2015-06-25 15:00:38 +0000935 if (PrintAddress && isa<ObjectFile>(Obj)) {
Rafael Espindola80c33542015-07-06 18:18:44 +0000936 SymbolRef SymRef(Sym);
Rafael Espindolabe8b0ea2015-07-07 17:12:59 +0000937 ErrorOr<uint64_t> AddressOrErr = SymRef.getAddress();
938 if (error(AddressOrErr.getError()))
939 break;
940 S.Address = *AddressOrErr;
Rafael Espindolab85e10c2015-06-25 15:00:38 +0000941 }
942 S.TypeChar = getNMTypeChar(Obj, Sym);
Kevin Enderbyf681ec52016-01-22 18:47:14 +0000943 std::error_code EC = Sym.printName(OS);
944 if (EC && MachO)
945 OS << "bad string index";
946 else
947 error(EC);
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000948 OS << '\0';
Rafael Espindola2d5d23d2015-07-06 21:36:23 +0000949 S.Sym = Sym;
Rafael Espindola619581c2014-01-29 04:56:19 +0000950 SymbolList.push_back(S);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000951 }
952
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000953 OS.flush();
954 const char *P = NameBuffer.c_str();
955 for (unsigned I = 0; I < SymbolList.size(); ++I) {
956 SymbolList[I].Name = P;
957 P += strlen(P) + 1;
958 }
959
Rafael Espindolaceb23382014-07-31 21:00:10 +0000960 CurrentFilename = Obj.getFileName();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +0000961 sortAndPrintSymbolList(Obj, printName, ArchiveName, ArchitectureName);
Brian Gaeke0af759d2003-10-16 04:43:15 +0000962}
963
Kevin Enderby4c8dfe42014-06-30 18:45:23 +0000964// checkMachOAndArchFlags() checks to see if the SymbolicFile is a Mach-O file
965// and if it is and there is a list of architecture flags is specified then
966// check to make sure this Mach-O file is one of those architectures or all
967// architectures was specificed. If not then an error is generated and this
968// routine returns false. Else it returns true.
969static bool checkMachOAndArchFlags(SymbolicFile *O, std::string &Filename) {
David Blaikie328c0c12015-03-23 21:17:43 +0000970 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(O);
971
972 if (!MachO || ArchAll || ArchFlags.size() == 0)
973 return true;
974
975 MachO::mach_header H;
976 MachO::mach_header_64 H_64;
977 Triple T;
978 if (MachO->is64Bit()) {
979 H_64 = MachO->MachOObjectFile::getHeader64();
980 T = MachOObjectFile::getArch(H_64.cputype, H_64.cpusubtype);
981 } else {
982 H = MachO->MachOObjectFile::getHeader();
983 T = MachOObjectFile::getArch(H.cputype, H.cpusubtype);
984 }
985 if (std::none_of(
986 ArchFlags.begin(), ArchFlags.end(),
987 [&](const std::string &Name) { return Name == T.getArchName(); })) {
988 error("No architecture specified", Filename);
989 return false;
Kevin Enderby4c8dfe42014-06-30 18:45:23 +0000990 }
991 return true;
992}
993
Rafael Espindola619581c2014-01-29 04:56:19 +0000994static void dumpSymbolNamesFromFile(std::string &Filename) {
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000995 ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
996 MemoryBuffer::getFileOrSTDIN(Filename);
997 if (error(BufferOrErr.getError(), Filename))
Michael J. Spencerbc96f372011-12-13 23:17:29 +0000998 return;
999
Owen Anderson19251ec2009-07-15 22:16:10 +00001000 LLVMContext &Context = getGlobalContext();
Peter Collingbourne10039c02014-09-18 21:28:49 +00001001 ErrorOr<std::unique_ptr<Binary>> BinaryOrErr = createBinary(
1002 BufferOrErr.get()->getMemBufferRef(), NoLLVMBitcode ? nullptr : &Context);
Rafael Espindolace82a072014-01-30 19:24:00 +00001003 if (error(BinaryOrErr.getError(), Filename))
1004 return;
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001005 Binary &Bin = *BinaryOrErr.get();
Shankar Easwaran15b28be2012-11-13 18:38:42 +00001006
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001007 if (Archive *A = dyn_cast<Archive>(&Bin)) {
Rafael Espindolace82a072014-01-30 19:24:00 +00001008 if (ArchiveMap) {
Rafael Espindola0115b082014-01-30 21:51:42 +00001009 Archive::symbol_iterator I = A->symbol_begin();
1010 Archive::symbol_iterator E = A->symbol_end();
Rafael Espindolace82a072014-01-30 19:24:00 +00001011 if (I != E) {
Rafael Espindola0115b082014-01-30 21:51:42 +00001012 outs() << "Archive map\n";
Rafael Espindolace82a072014-01-30 19:24:00 +00001013 for (; I != E; ++I) {
Rafael Espindola52151b32015-11-03 01:32:40 +00001014 ErrorOr<Archive::Child> C = I->getMember();
Kevin Enderbyda9dd052015-10-21 17:13:20 +00001015 if (error(C.getError()))
Michael J. Spencer9718f452013-02-03 10:48:50 +00001016 return;
Rafael Espindola52151b32015-11-03 01:32:40 +00001017 ErrorOr<StringRef> FileNameOrErr = C->getName();
Rafael Espindolaae460022014-06-16 16:08:36 +00001018 if (error(FileNameOrErr.getError()))
Rafael Espindolace82a072014-01-30 19:24:00 +00001019 return;
Rafael Espindolaae460022014-06-16 16:08:36 +00001020 StringRef SymName = I->getName();
1021 outs() << SymName << " in " << FileNameOrErr.get() << "\n";
Michael J. Spencer2bc774a2011-09-27 19:37:18 +00001022 }
Rafael Espindolace82a072014-01-30 19:24:00 +00001023 outs() << "\n";
Michael J. Spencer2bc774a2011-09-27 19:37:18 +00001024 }
1025 }
Alexey Samsonove6388e62013-06-18 15:03:28 +00001026
Rafael Espindola0115b082014-01-30 21:51:42 +00001027 for (Archive::child_iterator I = A->child_begin(), E = A->child_end();
Rafael Espindolace82a072014-01-30 19:24:00 +00001028 I != E; ++I) {
Kevin Enderby7a969422015-11-05 19:24:56 +00001029 if (error(I->getError()))
1030 return;
1031 auto &C = I->get();
1032 ErrorOr<std::unique_ptr<Binary>> ChildOrErr = C.getAsBinary(&Context);
Rafael Espindolaae460022014-06-16 16:08:36 +00001033 if (ChildOrErr.getError())
Rafael Espindolace82a072014-01-30 19:24:00 +00001034 continue;
Rafael Espindolaae460022014-06-16 16:08:36 +00001035 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001036 if (!checkMachOAndArchFlags(O, Filename))
1037 return;
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001038 if (!PrintFileName) {
1039 outs() << "\n";
1040 if (isa<MachOObjectFile>(O)) {
1041 outs() << Filename << "(" << O->getFileName() << ")";
1042 } else
1043 outs() << O->getFileName();
1044 outs() << ":\n";
1045 }
Rafael Espindolaceb23382014-07-31 21:00:10 +00001046 dumpSymbolNamesFromObject(*O, false, Filename);
Rafael Espindolace82a072014-01-30 19:24:00 +00001047 }
1048 }
1049 return;
1050 }
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001051 if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(&Bin)) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001052 // If we have a list of architecture flags specified dump only those.
1053 if (!ArchAll && ArchFlags.size() != 0) {
1054 // Look for a slice in the universal binary that matches each ArchFlag.
1055 bool ArchFound;
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00001056 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001057 ArchFound = false;
1058 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1059 E = UB->end_objects();
1060 I != E; ++I) {
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00001061 if (ArchFlags[i] == I->getArchTypeName()) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001062 ArchFound = true;
1063 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr =
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00001064 I->getAsObjectFile();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001065 std::string ArchiveName;
1066 std::string ArchitectureName;
1067 ArchiveName.clear();
1068 ArchitectureName.clear();
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001069 if (ObjOrErr) {
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001070 ObjectFile &Obj = *ObjOrErr.get();
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001071 if (ArchFlags.size() > 1) {
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001072 if (PrintFileName)
1073 ArchitectureName = I->getArchTypeName();
1074 else
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001075 outs() << "\n" << Obj.getFileName() << " (for architecture "
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001076 << I->getArchTypeName() << ")"
1077 << ":\n";
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001078 }
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001079 dumpSymbolNamesFromObject(Obj, false, ArchiveName,
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001080 ArchitectureName);
Rafael Espindola0bfe8282014-12-09 21:05:36 +00001081 } else if (ErrorOr<std::unique_ptr<Archive>> AOrErr =
1082 I->getAsArchive()) {
1083 std::unique_ptr<Archive> &A = *AOrErr;
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001084 for (Archive::child_iterator AI = A->child_begin(),
1085 AE = A->child_end();
1086 AI != AE; ++AI) {
Kevin Enderby7a969422015-11-05 19:24:56 +00001087 if (error(AI->getError()))
1088 return;
1089 auto &C = AI->get();
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001090 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
Kevin Enderby7a969422015-11-05 19:24:56 +00001091 C.getAsBinary(&Context);
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001092 if (ChildOrErr.getError())
1093 continue;
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00001094 if (SymbolicFile *O =
1095 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001096 if (PrintFileName) {
1097 ArchiveName = A->getFileName();
1098 if (ArchFlags.size() > 1)
1099 ArchitectureName = I->getArchTypeName();
1100 } else {
1101 outs() << "\n" << A->getFileName();
1102 outs() << "(" << O->getFileName() << ")";
1103 if (ArchFlags.size() > 1) {
1104 outs() << " (for architecture " << I->getArchTypeName()
1105 << ")";
1106 }
1107 outs() << ":\n";
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001108 }
Rafael Espindolaceb23382014-07-31 21:00:10 +00001109 dumpSymbolNamesFromObject(*O, false, ArchiveName,
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001110 ArchitectureName);
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001111 }
1112 }
1113 }
1114 }
1115 }
1116 if (!ArchFound) {
1117 error(ArchFlags[i],
1118 "file: " + Filename + " does not contain architecture");
1119 return;
1120 }
1121 }
1122 return;
1123 }
1124 // No architecture flags were specified so if this contains a slice that
1125 // matches the host architecture dump only that.
1126 if (!ArchAll) {
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00001127 StringRef HostArchName = MachOObjectFile::getHostArch().getArchName();
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001128 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1129 E = UB->end_objects();
1130 I != E; ++I) {
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00001131 if (HostArchName == I->getArchTypeName()) {
1132 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001133 std::string ArchiveName;
1134 ArchiveName.clear();
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001135 if (ObjOrErr) {
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001136 ObjectFile &Obj = *ObjOrErr.get();
1137 dumpSymbolNamesFromObject(Obj, false);
Rafael Espindola0bfe8282014-12-09 21:05:36 +00001138 } else if (ErrorOr<std::unique_ptr<Archive>> AOrErr =
1139 I->getAsArchive()) {
1140 std::unique_ptr<Archive> &A = *AOrErr;
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001141 for (Archive::child_iterator AI = A->child_begin(),
1142 AE = A->child_end();
1143 AI != AE; ++AI) {
Kevin Enderby7a969422015-11-05 19:24:56 +00001144 if (error(AI->getError()))
1145 return;
1146 auto &C = AI->get();
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001147 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
Kevin Enderby7a969422015-11-05 19:24:56 +00001148 C.getAsBinary(&Context);
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001149 if (ChildOrErr.getError())
1150 continue;
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00001151 if (SymbolicFile *O =
1152 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001153 if (PrintFileName)
1154 ArchiveName = A->getFileName();
1155 else
1156 outs() << "\n" << A->getFileName() << "(" << O->getFileName()
1157 << ")"
1158 << ":\n";
Rafael Espindolaceb23382014-07-31 21:00:10 +00001159 dumpSymbolNamesFromObject(*O, false, ArchiveName);
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001160 }
1161 }
1162 }
1163 return;
1164 }
1165 }
1166 }
1167 // Either all architectures have been specified or none have been specified
1168 // and this does not contain the host architecture so dump all the slices.
Kevin Enderby1983fcf2014-06-19 22:03:18 +00001169 bool moreThanOneArch = UB->getNumberOfObjects() > 1;
Rafael Espindola0115b082014-01-30 21:51:42 +00001170 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1171 E = UB->end_objects();
Alexey Samsonove6388e62013-06-18 15:03:28 +00001172 I != E; ++I) {
Rafael Espindola4f7932b2014-06-23 20:41:02 +00001173 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001174 std::string ArchiveName;
1175 std::string ArchitectureName;
1176 ArchiveName.clear();
1177 ArchitectureName.clear();
Rafael Espindola4f7932b2014-06-23 20:41:02 +00001178 if (ObjOrErr) {
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001179 ObjectFile &Obj = *ObjOrErr.get();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001180 if (PrintFileName) {
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001181 if (isa<MachOObjectFile>(Obj) && moreThanOneArch)
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001182 ArchitectureName = I->getArchTypeName();
1183 } else {
1184 if (moreThanOneArch)
1185 outs() << "\n";
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001186 outs() << Obj.getFileName();
1187 if (isa<MachOObjectFile>(Obj) && moreThanOneArch)
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001188 outs() << " (for architecture " << I->getArchTypeName() << ")";
1189 outs() << ":\n";
1190 }
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001191 dumpSymbolNamesFromObject(Obj, false, ArchiveName, ArchitectureName);
Rafael Espindola0bfe8282014-12-09 21:05:36 +00001192 } else if (ErrorOr<std::unique_ptr<Archive>> AOrErr = I->getAsArchive()) {
1193 std::unique_ptr<Archive> &A = *AOrErr;
Kevin Enderbye858a652014-05-14 21:18:50 +00001194 for (Archive::child_iterator AI = A->child_begin(), AE = A->child_end();
1195 AI != AE; ++AI) {
Kevin Enderby7a969422015-11-05 19:24:56 +00001196 if (error(AI->getError()))
1197 return;
1198 auto &C = AI->get();
1199 ErrorOr<std::unique_ptr<Binary>> ChildOrErr = C.getAsBinary(&Context);
Rafael Espindolaae460022014-06-16 16:08:36 +00001200 if (ChildOrErr.getError())
Kevin Enderbye858a652014-05-14 21:18:50 +00001201 continue;
Rafael Espindolaae460022014-06-16 16:08:36 +00001202 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001203 if (PrintFileName) {
1204 ArchiveName = A->getFileName();
1205 if (isa<MachOObjectFile>(O) && moreThanOneArch)
1206 ArchitectureName = I->getArchTypeName();
1207 } else {
1208 outs() << "\n" << A->getFileName();
1209 if (isa<MachOObjectFile>(O)) {
1210 outs() << "(" << O->getFileName() << ")";
1211 if (moreThanOneArch)
1212 outs() << " (for architecture " << I->getArchTypeName()
1213 << ")";
1214 } else
1215 outs() << ":" << O->getFileName();
1216 outs() << ":\n";
1217 }
Rafael Espindolaceb23382014-07-31 21:00:10 +00001218 dumpSymbolNamesFromObject(*O, false, ArchiveName, ArchitectureName);
Kevin Enderbye858a652014-05-14 21:18:50 +00001219 }
1220 }
1221 }
Alexey Samsonove6388e62013-06-18 15:03:28 +00001222 }
Brian Gaeke618026a2003-11-19 21:57:30 +00001223 return;
Brian Gaeke0af759d2003-10-16 04:43:15 +00001224 }
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001225 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&Bin)) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001226 if (!checkMachOAndArchFlags(O, Filename))
1227 return;
Rafael Espindolaceb23382014-07-31 21:00:10 +00001228 dumpSymbolNamesFromObject(*O, true);
Rafael Espindolace82a072014-01-30 19:24:00 +00001229 }
Brian Gaeke0af759d2003-10-16 04:43:15 +00001230}
1231
1232int main(int argc, char **argv) {
Chris Lattnere3fc2d12009-03-06 05:34:10 +00001233 // Print a stack trace if we signal out.
Chris Lattneref8f3892007-05-06 05:36:18 +00001234 sys::PrintStackTraceOnErrorSignal();
Chris Lattnere3fc2d12009-03-06 05:34:10 +00001235 PrettyStackTraceProgram X(argc, argv);
Michael J. Spencer618d2192010-08-31 06:36:46 +00001236
Rafael Espindola619581c2014-01-29 04:56:19 +00001237 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
Chris Lattnere3fc2d12009-03-06 05:34:10 +00001238 cl::ParseCommandLineOptions(argc, argv, "llvm symbol table dumper\n");
Chris Lattner12439ff2004-02-19 20:32:12 +00001239
Michael J. Spencerbc96f372011-12-13 23:17:29 +00001240 // llvm-nm only reads binary files.
Rafael Espindolacb2eca02013-06-12 20:58:35 +00001241 if (error(sys::ChangeStdinToBinary()))
Michael J. Spencerbc96f372011-12-13 23:17:29 +00001242 return 1;
1243
Davide Italiano63634cb2016-01-29 23:38:05 +00001244 // These calls are needed so that we can read bitcode correctly.
Rafael Espindola13b69d62014-07-03 18:59:23 +00001245 llvm::InitializeAllTargetInfos();
1246 llvm::InitializeAllTargetMCs();
1247 llvm::InitializeAllAsmParsers();
1248
Chris Lattneref8f3892007-05-06 05:36:18 +00001249 ToolName = argv[0];
Rafael Espindola619581c2014-01-29 04:56:19 +00001250 if (BSDFormat)
1251 OutputFormat = bsd;
1252 if (POSIXFormat)
1253 OutputFormat = posix;
Kevin Enderby14a96ac2014-06-20 00:04:16 +00001254 if (DarwinFormat)
1255 OutputFormat = darwin;
Chris Lattner4aae1f42003-10-16 18:45:23 +00001256
Michael J. Spencerb8672a52011-01-20 06:38:57 +00001257 // The relative order of these is important. If you pass --size-sort it should
1258 // only print out the size. However, if you pass -S --size-sort, it should
Rafael Espindolab4865d62014-04-03 00:19:35 +00001259 // print out both the size and address.
Rafael Espindola619581c2014-01-29 04:56:19 +00001260 if (SizeSort && !PrintSize)
Rafael Espindolab4865d62014-04-03 00:19:35 +00001261 PrintAddress = false;
Rafael Espindola619581c2014-01-29 04:56:19 +00001262 if (OutputFormat == sysv || SizeSort)
1263 PrintSize = true;
Davide Italianoda570132016-02-05 22:10:42 +00001264 if (InputFilenames.empty())
Kevin Enderby4fc2edb2014-06-23 20:27:53 +00001265 InputFilenames.push_back("a.out");
Davide Italianod5353652016-02-05 22:07:09 +00001266 if (InputFilenames.size() > 1)
Rafael Espindola619581c2014-01-29 04:56:19 +00001267 MultipleFiles = true;
Chris Lattneref8f3892007-05-06 05:36:18 +00001268
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00001269 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001270 if (ArchFlags[i] == "all") {
1271 ArchAll = true;
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00001272 } else {
Rafael Espindola72318b42014-08-08 16:30:17 +00001273 if (!MachOObjectFile::isValidArch(ArchFlags[i]))
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001274 error("Unknown architecture named '" + ArchFlags[i] + "'",
1275 "for the -arch option");
1276 }
1277 }
1278
Kevin Enderbyfe6ad972014-07-11 20:30:00 +00001279 if (SegSect.size() != 0 && SegSect.size() != 2)
1280 error("bad number of arguments (must be two arguments)",
1281 "for the -s option");
1282
Chris Lattneref8f3892007-05-06 05:36:18 +00001283 std::for_each(InputFilenames.begin(), InputFilenames.end(),
Rafael Espindola619581c2014-01-29 04:56:19 +00001284 dumpSymbolNamesFromFile);
Rafael Espindola8b82a4d2013-07-03 15:46:03 +00001285
1286 if (HadError)
1287 return 1;
1288
Chris Lattneref8f3892007-05-06 05:36:18 +00001289 return 0;
Brian Gaeke0af759d2003-10-16 04:43:15 +00001290}