blob: 6a4f99783bbaff2e5576471fe0da2f1798623668 [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
Mehdi Aminib550cb12016-04-18 09:17:29 +000019#include "llvm/ADT/StringSwitch.h"
Zachary Turner264b5d92017-06-07 03:48:56 +000020#include "llvm/BinaryFormat/COFF.h"
Sam Clegg531da002017-06-29 18:29:05 +000021#include "llvm/Demangle/Demangle.h"
Rafael Espindolaf12b8282014-02-21 20:10:59 +000022#include "llvm/IR/Function.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000023#include "llvm/IR/LLVMContext.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"
Rafael Espindola8b781852017-05-24 23:40:36 +000026#include "llvm/Object/COFFImportFile.h"
Rafael Espindola586af97a2013-11-02 21:16:09 +000027#include "llvm/Object/ELFObjectFile.h"
Chandler Carruth442f7842014-03-04 10:07:28 +000028#include "llvm/Object/IRObjectFile.h"
Rafael Espindola586af97a2013-11-02 21:16:09 +000029#include "llvm/Object/MachO.h"
Alexey Samsonove6388e62013-06-18 15:03:28 +000030#include "llvm/Object/MachOUniversal.h"
Michael J. Spencerb8672a52011-01-20 06:38:57 +000031#include "llvm/Object/ObjectFile.h"
Sam Clegg135a4b82017-04-14 19:50:44 +000032#include "llvm/Object/Wasm.h"
Reid Spencer7c16caa2004-09-01 22:55:40 +000033#include "llvm/Support/CommandLine.h"
Michael J. Spencerb8672a52011-01-20 06:38:57 +000034#include "llvm/Support/FileSystem.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000035#include "llvm/Support/Format.h"
Chris Lattner76d46322006-12-06 01:18:01 +000036#include "llvm/Support/ManagedStatic.h"
Chris Lattneref8f3892007-05-06 05:36:18 +000037#include "llvm/Support/MemoryBuffer.h"
Chris Lattnere3fc2d12009-03-06 05:34:10 +000038#include "llvm/Support/PrettyStackTrace.h"
Michael J. Spencerbc96f372011-12-13 23:17:29 +000039#include "llvm/Support/Program.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000040#include "llvm/Support/Signals.h"
Rafael Espindola13b69d62014-07-03 18:59:23 +000041#include "llvm/Support/TargetSelect.h"
Chandler Carruthd9903882015-01-14 11:23:27 +000042#include "llvm/Support/raw_ostream.h"
Michael J. Spencerb8672a52011-01-20 06:38:57 +000043#include <vector>
Hans Wennborg083ca9b2015-10-06 23:24:35 +000044
Brian Gaeke960707c2003-11-11 22:41:34 +000045using namespace llvm;
Michael J. Spencerb8672a52011-01-20 06:38:57 +000046using namespace object;
Brian Gaeke960707c2003-11-11 22:41:34 +000047
Brian Gaeke0af759d2003-10-16 04:43:15 +000048namespace {
Kevin Enderby980b2582014-06-05 21:21:57 +000049enum OutputFormatTy { bsd, sysv, posix, darwin };
Rafael Espindola619581c2014-01-29 04:56:19 +000050cl::opt<OutputFormatTy> OutputFormat(
51 "format", cl::desc("Specify output format"),
52 cl::values(clEnumVal(bsd, "BSD format"), clEnumVal(sysv, "System V format"),
Kevin Enderby980b2582014-06-05 21:21:57 +000053 clEnumVal(posix, "POSIX.2 format"),
Mehdi Amini732afdd2016-10-08 19:41:06 +000054 clEnumVal(darwin, "Darwin -m format")),
Rafael Espindola619581c2014-01-29 04:56:19 +000055 cl::init(bsd));
56cl::alias OutputFormat2("f", cl::desc("Alias for --format"),
57 cl::aliasopt(OutputFormat));
Brian Gaeke0af759d2003-10-16 04:43:15 +000058
Rafael Espindolaf12b8282014-02-21 20:10:59 +000059cl::list<std::string> InputFilenames(cl::Positional, cl::desc("<input files>"),
Rafael Espindola619581c2014-01-29 04:56:19 +000060 cl::ZeroOrMore);
Brian Gaeke0af759d2003-10-16 04:43:15 +000061
Rafael Espindola619581c2014-01-29 04:56:19 +000062cl::opt<bool> UndefinedOnly("undefined-only",
63 cl::desc("Show only undefined symbols"));
64cl::alias UndefinedOnly2("u", cl::desc("Alias for --undefined-only"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +000065 cl::aliasopt(UndefinedOnly), cl::Grouping);
Brian Gaeke0af759d2003-10-16 04:43:15 +000066
Rafael Espindola619581c2014-01-29 04:56:19 +000067cl::opt<bool> DynamicSyms("dynamic",
68 cl::desc("Display the dynamic symbols instead "
69 "of normal symbols."));
70cl::alias DynamicSyms2("D", cl::desc("Alias for --dynamic"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +000071 cl::aliasopt(DynamicSyms), cl::Grouping);
Michael J. Spencer8c4729f2012-02-28 00:40:37 +000072
Rafael Espindola619581c2014-01-29 04:56:19 +000073cl::opt<bool> DefinedOnly("defined-only",
74 cl::desc("Show only defined symbols"));
Kevin Enderbyacaaf902014-07-03 18:18:50 +000075cl::alias DefinedOnly2("U", cl::desc("Alias for --defined-only"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +000076 cl::aliasopt(DefinedOnly), cl::Grouping);
Brian Gaeke0af759d2003-10-16 04:43:15 +000077
Rafael Espindola619581c2014-01-29 04:56:19 +000078cl::opt<bool> ExternalOnly("extern-only",
Martin Storsjoc6320862017-11-03 07:18:21 +000079 cl::desc("Show only external symbols"),
80 cl::ZeroOrMore);
Rafael Espindola619581c2014-01-29 04:56:19 +000081cl::alias ExternalOnly2("g", cl::desc("Alias for --extern-only"),
Martin Storsjoc6320862017-11-03 07:18:21 +000082 cl::aliasopt(ExternalOnly), cl::Grouping,
83 cl::ZeroOrMore);
Brian Gaeke0af759d2003-10-16 04:43:15 +000084
Kevin Enderby9c8905c2015-11-02 23:42:05 +000085cl::opt<bool> BSDFormat("B", cl::desc("Alias for --format=bsd"),
86 cl::Grouping);
87cl::opt<bool> POSIXFormat("P", cl::desc("Alias for --format=posix"),
88 cl::Grouping);
89cl::opt<bool> DarwinFormat("m", cl::desc("Alias for --format=darwin"),
90 cl::Grouping);
Brian Gaeke0af759d2003-10-16 04:43:15 +000091
Kevin Enderby8f6dcf52014-07-01 22:44:51 +000092static cl::list<std::string>
Kevin Enderbybe84b292014-07-17 22:56:27 +000093 ArchFlags("arch", cl::desc("architecture(s) from a Mach-O file to dump"),
94 cl::ZeroOrMore);
Kevin Enderby4c8dfe42014-06-30 18:45:23 +000095bool ArchAll = false;
96
Rafael Espindola619581c2014-01-29 04:56:19 +000097cl::opt<bool> PrintFileName(
98 "print-file-name",
Michael J. Spencerb8672a52011-01-20 06:38:57 +000099 cl::desc("Precede each symbol with the object file it came from"));
100
Rafael Espindola619581c2014-01-29 04:56:19 +0000101cl::alias PrintFileNameA("A", cl::desc("Alias for --print-file-name"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000102 cl::aliasopt(PrintFileName), cl::Grouping);
Rafael Espindola619581c2014-01-29 04:56:19 +0000103cl::alias PrintFileNameo("o", cl::desc("Alias for --print-file-name"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000104 cl::aliasopt(PrintFileName), cl::Grouping);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000105
Rafael Espindola619581c2014-01-29 04:56:19 +0000106cl::opt<bool> DebugSyms("debug-syms",
107 cl::desc("Show all symbols, even debugger only"));
108cl::alias DebugSymsa("a", cl::desc("Alias for --debug-syms"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000109 cl::aliasopt(DebugSyms), cl::Grouping);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000110
Rafael Espindolab4865d62014-04-03 00:19:35 +0000111cl::opt<bool> NumericSort("numeric-sort", cl::desc("Sort symbols by address"));
Rafael Espindola619581c2014-01-29 04:56:19 +0000112cl::alias NumericSortn("n", cl::desc("Alias for --numeric-sort"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000113 cl::aliasopt(NumericSort), cl::Grouping);
Rafael Espindola619581c2014-01-29 04:56:19 +0000114cl::alias NumericSortv("v", cl::desc("Alias for --numeric-sort"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000115 cl::aliasopt(NumericSort), cl::Grouping);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000116
Rafael Espindola619581c2014-01-29 04:56:19 +0000117cl::opt<bool> NoSort("no-sort", cl::desc("Show symbols in order encountered"));
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000118cl::alias NoSortp("p", cl::desc("Alias for --no-sort"), cl::aliasopt(NoSort),
119 cl::Grouping);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000120
Sam Clegg531da002017-06-29 18:29:05 +0000121cl::opt<bool> Demangle("demangle", cl::desc("Demangle C++ symbol names"));
122cl::alias DemangleC("C", cl::desc("Alias for --demangle"), cl::aliasopt(Demangle),
123 cl::Grouping);
124
Kevin Enderby25a614b2014-07-02 23:23:58 +0000125cl::opt<bool> ReverseSort("reverse-sort", cl::desc("Sort in reverse order"));
126cl::alias ReverseSortr("r", cl::desc("Alias for --reverse-sort"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000127 cl::aliasopt(ReverseSort), cl::Grouping);
Kevin Enderby25a614b2014-07-02 23:23:58 +0000128
Rafael Espindola619581c2014-01-29 04:56:19 +0000129cl::opt<bool> PrintSize("print-size",
Rafael Espindolab4865d62014-04-03 00:19:35 +0000130 cl::desc("Show symbol size instead of address"));
Rafael Espindola619581c2014-01-29 04:56:19 +0000131cl::alias PrintSizeS("S", cl::desc("Alias for --print-size"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000132 cl::aliasopt(PrintSize), cl::Grouping);
Kevin Enderby31e85302017-01-25 21:33:38 +0000133bool MachOPrintSizeWarning = false;
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000134
Rafael Espindola619581c2014-01-29 04:56:19 +0000135cl::opt<bool> SizeSort("size-sort", cl::desc("Sort symbols by size"));
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000136
Rafael Espindola619581c2014-01-29 04:56:19 +0000137cl::opt<bool> WithoutAliases("without-aliases", cl::Hidden,
138 cl::desc("Exclude aliases from output"));
Jan Sjödin4d0c2992012-09-18 18:47:58 +0000139
Rafael Espindola619581c2014-01-29 04:56:19 +0000140cl::opt<bool> ArchiveMap("print-armap", cl::desc("Print the archive map"));
Kevin Enderby8da4bd62014-07-08 23:47:31 +0000141cl::alias ArchiveMaps("M", cl::desc("Alias for --print-armap"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000142 cl::aliasopt(ArchiveMap), cl::Grouping);
Kevin Enderby0fd8aac2014-07-03 21:51:07 +0000143
Hemant Kulkarni5e005a12016-02-10 17:51:39 +0000144enum Radix { d, o, x };
145cl::opt<Radix>
146 AddressRadix("radix", cl::desc("Radix (o/d/x) for printing symbol Values"),
147 cl::values(clEnumVal(d, "decimal"), clEnumVal(o, "octal"),
Mehdi Amini732afdd2016-10-08 19:41:06 +0000148 clEnumVal(x, "hexadecimal")),
Hemant Kulkarni5e005a12016-02-10 17:51:39 +0000149 cl::init(x));
150cl::alias RadixAlias("t", cl::desc("Alias for --radix"),
151 cl::aliasopt(AddressRadix));
152
Kevin Enderby0fd8aac2014-07-03 21:51:07 +0000153cl::opt<bool> JustSymbolName("just-symbol-name",
154 cl::desc("Print just the symbol's name"));
155cl::alias JustSymbolNames("j", cl::desc("Alias for --just-symbol-name"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000156 cl::aliasopt(JustSymbolName), cl::Grouping);
Kevin Enderbyfe6ad972014-07-11 20:30:00 +0000157
158// FIXME: This option takes exactly two strings and should be allowed anywhere
159// on the command line. Such that "llvm-nm -s __TEXT __text foo.o" would work.
160// But that does not as the CommandLine Library does not have a way to make
161// this work. For now the "-s __TEXT __text" has to be last on the command
162// line.
163cl::list<std::string> SegSect("s", cl::Positional, cl::ZeroOrMore,
164 cl::desc("Dump only symbols from this segment "
Davide Italiano98be3f22016-03-02 22:33:49 +0000165 "and section name, Mach-O only"));
Kevin Enderbyfe6ad972014-07-11 20:30:00 +0000166
Kevin Enderby77b968e2014-07-16 17:38:26 +0000167cl::opt<bool> FormatMachOasHex("x", cl::desc("Print symbol entry in hex, "
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000168 "Mach-O only"), cl::Grouping);
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000169cl::opt<bool> AddDyldInfo("add-dyldinfo",
170 cl::desc("Add symbols from the dyldinfo not already "
171 "in the symbol table, Mach-O only"));
172cl::opt<bool> NoDyldInfo("no-dyldinfo",
173 cl::desc("Don't add any symbols from the dyldinfo, "
174 "Mach-O only"));
175cl::opt<bool> DyldInfoOnly("dyldinfo-only",
176 cl::desc("Show only symbols from the dyldinfo, "
177 "Mach-O only"));
Kevin Enderby77b968e2014-07-16 17:38:26 +0000178
Peter Collingbourne10039c02014-09-18 21:28:49 +0000179cl::opt<bool> NoLLVMBitcode("no-llvm-bc",
180 cl::desc("Disable LLVM bitcode reader"));
181
Rafael Espindolab4865d62014-04-03 00:19:35 +0000182bool PrintAddress = true;
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000183
Rafael Espindola619581c2014-01-29 04:56:19 +0000184bool MultipleFiles = false;
Brian Gaeke0af759d2003-10-16 04:43:15 +0000185
Rafael Espindola619581c2014-01-29 04:56:19 +0000186bool HadError = false;
Rafael Espindola8b82a4d2013-07-03 15:46:03 +0000187
Rafael Espindola619581c2014-01-29 04:56:19 +0000188std::string ToolName;
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000189} // anonymous namespace
Brian Gaeke0af759d2003-10-16 04:43:15 +0000190
Zachary Turner41a9ee92017-10-11 23:54:34 +0000191static void error(Twine Message, Twine Path = Twine()) {
Rafael Espindola619581c2014-01-29 04:56:19 +0000192 HadError = true;
193 errs() << ToolName << ": " << Path << ": " << Message << ".\n";
Michael J. Spencerbc96f372011-12-13 23:17:29 +0000194}
195
Zachary Turner41a9ee92017-10-11 23:54:34 +0000196static bool error(std::error_code EC, Twine Path = Twine()) {
Rafael Espindola619581c2014-01-29 04:56:19 +0000197 if (EC) {
198 error(EC.message(), Path);
Michael J. Spencerbc96f372011-12-13 23:17:29 +0000199 return true;
200 }
201 return false;
202}
203
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000204// This version of error() prints the archive name and member name, for example:
205// "libx.a(foo.o)" after the ToolName before the error message. It sets
206// HadError but returns allowing the code to move on to other archive members.
Kevin Enderby9acb1092016-05-31 20:35:34 +0000207static void error(llvm::Error E, StringRef FileName, const Archive::Child &C,
208 StringRef ArchitectureName = StringRef()) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000209 HadError = true;
210 errs() << ToolName << ": " << FileName;
211
Kevin Enderbyf4586032016-07-29 17:44:13 +0000212 Expected<StringRef> NameOrErr = C.getName();
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000213 // TODO: if we have a error getting the name then it would be nice to print
214 // the index of which archive member this is and or its offset in the
215 // archive instead of "???" as the name.
Kevin Enderbyf4586032016-07-29 17:44:13 +0000216 if (!NameOrErr) {
217 consumeError(NameOrErr.takeError());
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000218 errs() << "(" << "???" << ")";
Kevin Enderbyf4586032016-07-29 17:44:13 +0000219 } else
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000220 errs() << "(" << NameOrErr.get() << ")";
221
Kevin Enderby9acb1092016-05-31 20:35:34 +0000222 if (!ArchitectureName.empty())
223 errs() << " (for architecture " << ArchitectureName << ") ";
224
225 std::string Buf;
226 raw_string_ostream OS(Buf);
227 logAllUnhandledErrors(std::move(E), OS, "");
228 OS.flush();
229 errs() << " " << Buf << "\n";
230}
231
232// This version of error() prints the file name and which architecture slice it
233// is from, for example: "foo.o (for architecture i386)" after the ToolName
234// before the error message. It sets HadError but returns allowing the code to
235// move on to other architecture slices.
236static void error(llvm::Error E, StringRef FileName,
237 StringRef ArchitectureName = StringRef()) {
238 HadError = true;
239 errs() << ToolName << ": " << FileName;
240
241 if (!ArchitectureName.empty())
242 errs() << " (for architecture " << ArchitectureName << ") ";
243
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000244 std::string Buf;
245 raw_string_ostream OS(Buf);
246 logAllUnhandledErrors(std::move(E), OS, "");
247 OS.flush();
248 errs() << " " << Buf << "\n";
249}
250
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000251namespace {
Rafael Espindola619581c2014-01-29 04:56:19 +0000252struct NMSymbol {
Rafael Espindolab4865d62014-04-03 00:19:35 +0000253 uint64_t Address;
Rafael Espindola619581c2014-01-29 04:56:19 +0000254 uint64_t Size;
255 char TypeChar;
256 StringRef Name;
Rafael Espindola2d5d23d2015-07-06 21:36:23 +0000257 BasicSymbolRef Sym;
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000258 // The Sym field above points to the native symbol in the object file,
259 // for Mach-O when we are creating symbols from the dyld info the above
260 // pointer is null as there is no native symbol. In these cases the fields
261 // below are filled in to represent what would have been a Mach-O nlist
262 // native symbol.
263 uint32_t SymFlags;
264 SectionRef Section;
265 uint8_t NType;
266 uint8_t NSect;
267 uint16_t NDesc;
268 StringRef IndirectName;
Rafael Espindola619581c2014-01-29 04:56:19 +0000269};
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000270} // anonymous namespace
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000271
Rafael Espindolab4865d62014-04-03 00:19:35 +0000272static bool compareSymbolAddress(const NMSymbol &A, const NMSymbol &B) {
Kevin Enderbyd3cf76b2018-03-22 23:59:35 +0000273 bool ADefined;
274 if (A.Sym.getRawDataRefImpl().p)
275 ADefined = !(A.Sym.getFlags() & SymbolRef::SF_Undefined);
276 else
277 ADefined = A.TypeChar != 'U';
278 bool BDefined;
279 if (B.Sym.getRawDataRefImpl().p)
280 BDefined = !(B.Sym.getFlags() & SymbolRef::SF_Undefined);
281 else
282 BDefined = B.TypeChar != 'U';
Rafael Espindola45592c62015-07-13 22:01:02 +0000283 return std::make_tuple(ADefined, A.Address, A.Name, A.Size) <
284 std::make_tuple(BDefined, B.Address, B.Name, B.Size);
Rafael Espindola619581c2014-01-29 04:56:19 +0000285}
286
287static bool compareSymbolSize(const NMSymbol &A, const NMSymbol &B) {
Rafael Espindola45592c62015-07-13 22:01:02 +0000288 return std::make_tuple(A.Size, A.Name, A.Address) <
289 std::make_tuple(B.Size, B.Name, B.Address);
Rafael Espindola619581c2014-01-29 04:56:19 +0000290}
291
292static bool compareSymbolName(const NMSymbol &A, const NMSymbol &B) {
Rafael Espindola45592c62015-07-13 22:01:02 +0000293 return std::make_tuple(A.Name, A.Size, A.Address) <
294 std::make_tuple(B.Name, B.Size, B.Address);
Rafael Espindola619581c2014-01-29 04:56:19 +0000295}
296
Rafael Espindolaceb23382014-07-31 21:00:10 +0000297static char isSymbolList64Bit(SymbolicFile &Obj) {
Peter Collingbournedebb6f62016-11-24 01:13:09 +0000298 if (auto *IRObj = dyn_cast<IRObjectFile>(&Obj))
299 return Triple(IRObj->getTargetTriple()).isArch64Bit();
Rafael Espindola8b781852017-05-24 23:40:36 +0000300 if (isa<COFFObjectFile>(Obj) || isa<COFFImportFile>(Obj))
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000301 return false;
Sam Clegg135a4b82017-04-14 19:50:44 +0000302 if (isa<WasmObjectFile>(Obj))
303 return false;
David Blaikie328c0c12015-03-23 21:17:43 +0000304 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj))
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000305 return MachO->is64Bit();
Rafael Espindola034a4c382015-06-26 14:11:54 +0000306 return cast<ELFObjectFileBase>(Obj).getBytesInAddress() == 8;
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000307}
308
Rafael Espindola619581c2014-01-29 04:56:19 +0000309static StringRef CurrentFilename;
310typedef std::vector<NMSymbol> SymbolListT;
311static SymbolListT SymbolList;
312
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000313static char getSymbolNMTypeChar(IRObjectFile &Obj, basic_symbol_iterator I);
314
Kevin Enderby980b2582014-06-05 21:21:57 +0000315// darwinPrintSymbol() is used to print a symbol from a Mach-O file when the
Kevin Enderby77b968e2014-07-16 17:38:26 +0000316// the OutputFormat is darwin or we are printing Mach-O symbols in hex. For
317// the darwin format it produces the same output as darwin's nm(1) -m output
318// and when printing Mach-O symbols in hex it produces the same output as
319// darwin's nm(1) -x format.
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000320static void darwinPrintSymbol(SymbolicFile &Obj, SymbolListT::iterator I,
321 char *SymbolAddrStr, const char *printBlanks,
322 const char *printDashes, const char *printFormat) {
Kevin Enderby980b2582014-06-05 21:21:57 +0000323 MachO::mach_header H;
324 MachO::mach_header_64 H_64;
Reid Kleckner3afb80e2015-11-19 00:51:50 +0000325 uint32_t Filetype = MachO::MH_OBJECT;
326 uint32_t Flags = 0;
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000327 uint8_t NType = 0;
328 uint8_t NSect = 0;
329 uint16_t NDesc = 0;
330 uint32_t NStrx = 0;
331 uint64_t NValue = 0;
332 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
333 if (Obj.isIR()) {
334 uint32_t SymFlags = I->Sym.getFlags();
335 if (SymFlags & SymbolRef::SF_Global)
336 NType |= MachO::N_EXT;
337 if (SymFlags & SymbolRef::SF_Hidden)
338 NType |= MachO::N_PEXT;
339 if (SymFlags & SymbolRef::SF_Undefined)
340 NType |= MachO::N_EXT | MachO::N_UNDF;
341 else {
342 // Here we have a symbol definition. So to fake out a section name we
343 // use 1, 2 and 3 for section numbers. See below where they are used to
344 // print out fake section names.
345 NType |= MachO::N_SECT;
Davide Italianod4a48532016-02-01 19:22:16 +0000346 if (SymFlags & SymbolRef::SF_Const)
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000347 NSect = 3;
Peter Collingbournee2f1b4a2016-12-01 06:53:47 +0000348 else if (SymFlags & SymbolRef::SF_Executable)
349 NSect = 1;
350 else
351 NSect = 2;
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000352 }
353 if (SymFlags & SymbolRef::SF_Weak)
354 NDesc |= MachO::N_WEAK_DEF;
Kevin Enderby980b2582014-06-05 21:21:57 +0000355 } else {
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000356 DataRefImpl SymDRI = I->Sym.getRawDataRefImpl();
357 if (MachO->is64Bit()) {
358 H_64 = MachO->MachOObjectFile::getHeader64();
359 Filetype = H_64.filetype;
360 Flags = H_64.flags;
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000361 if (SymDRI.p){
362 MachO::nlist_64 STE_64 = MachO->getSymbol64TableEntry(SymDRI);
363 NType = STE_64.n_type;
364 NSect = STE_64.n_sect;
365 NDesc = STE_64.n_desc;
366 NStrx = STE_64.n_strx;
367 NValue = STE_64.n_value;
368 } else {
369 NType = I->NType;
370 NSect = I->NSect;
371 NDesc = I->NDesc;
372 NStrx = 0;
373 NValue = I->Address;
374 }
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000375 } else {
376 H = MachO->MachOObjectFile::getHeader();
377 Filetype = H.filetype;
378 Flags = H.flags;
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000379 if (SymDRI.p){
380 MachO::nlist STE = MachO->getSymbolTableEntry(SymDRI);
381 NType = STE.n_type;
382 NSect = STE.n_sect;
383 NDesc = STE.n_desc;
384 NStrx = STE.n_strx;
385 NValue = STE.n_value;
386 } else {
387 NType = I->NType;
388 NSect = I->NSect;
389 NDesc = I->NDesc;
390 NStrx = 0;
391 NValue = I->Address;
392 }
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000393 }
Kevin Enderby980b2582014-06-05 21:21:57 +0000394 }
395
Kevin Enderby77b968e2014-07-16 17:38:26 +0000396 // If we are printing Mach-O symbols in hex do that and return.
397 if (FormatMachOasHex) {
398 char Str[18] = "";
Kevin Enderby77b968e2014-07-16 17:38:26 +0000399 format(printFormat, NValue).print(Str, sizeof(Str));
400 outs() << Str << ' ';
401 format("%02x", NType).print(Str, sizeof(Str));
402 outs() << Str << ' ';
403 format("%02x", NSect).print(Str, sizeof(Str));
404 outs() << Str << ' ';
405 format("%04x", NDesc).print(Str, sizeof(Str));
406 outs() << Str << ' ';
407 format("%08x", NStrx).print(Str, sizeof(Str));
408 outs() << Str << ' ';
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000409 outs() << I->Name;
410 if ((NType & MachO::N_TYPE) == MachO::N_INDR) {
411 outs() << " (indirect for ";
412 format(printFormat, NValue).print(Str, sizeof(Str));
413 outs() << Str << ' ';
414 StringRef IndirectName;
415 if (I->Sym.getRawDataRefImpl().p) {
416 if (MachO->getIndirectName(I->Sym.getRawDataRefImpl(), IndirectName))
417 outs() << "?)";
418 else
419 outs() << IndirectName << ")";
420 }
421 else
422 outs() << I->IndirectName << ")";
423 }
424 outs() << "\n";
Kevin Enderby77b968e2014-07-16 17:38:26 +0000425 return;
426 }
427
Kevin Enderby980b2582014-06-05 21:21:57 +0000428 if (PrintAddress) {
429 if ((NType & MachO::N_TYPE) == MachO::N_INDR)
430 strcpy(SymbolAddrStr, printBlanks);
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000431 if (Obj.isIR() && (NType & MachO::N_TYPE) == MachO::N_TYPE)
432 strcpy(SymbolAddrStr, printDashes);
Kevin Enderby980b2582014-06-05 21:21:57 +0000433 outs() << SymbolAddrStr << ' ';
434 }
435
436 switch (NType & MachO::N_TYPE) {
437 case MachO::N_UNDF:
438 if (NValue != 0) {
439 outs() << "(common) ";
440 if (MachO::GET_COMM_ALIGN(NDesc) != 0)
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000441 outs() << "(alignment 2^" << (int)MachO::GET_COMM_ALIGN(NDesc) << ") ";
Kevin Enderby980b2582014-06-05 21:21:57 +0000442 } else {
443 if ((NType & MachO::N_TYPE) == MachO::N_PBUD)
444 outs() << "(prebound ";
445 else
446 outs() << "(";
447 if ((NDesc & MachO::REFERENCE_TYPE) ==
448 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
449 outs() << "undefined [lazy bound]) ";
450 else if ((NDesc & MachO::REFERENCE_TYPE) ==
Hans Wennborgaebe45b2016-04-11 20:36:05 +0000451 MachO::REFERENCE_FLAG_PRIVATE_UNDEFINED_LAZY)
Kevin Enderby980b2582014-06-05 21:21:57 +0000452 outs() << "undefined [private lazy bound]) ";
453 else if ((NDesc & MachO::REFERENCE_TYPE) ==
454 MachO::REFERENCE_FLAG_PRIVATE_UNDEFINED_NON_LAZY)
455 outs() << "undefined [private]) ";
456 else
457 outs() << "undefined) ";
458 }
459 break;
460 case MachO::N_ABS:
461 outs() << "(absolute) ";
462 break;
463 case MachO::N_INDR:
464 outs() << "(indirect) ";
465 break;
466 case MachO::N_SECT: {
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000467 if (Obj.isIR()) {
468 // For llvm bitcode files print out a fake section name using the values
469 // use 1, 2 and 3 for section numbers as set above.
470 if (NSect == 1)
471 outs() << "(LTO,CODE) ";
472 else if (NSect == 2)
473 outs() << "(LTO,DATA) ";
474 else if (NSect == 3)
475 outs() << "(LTO,RODATA) ";
476 else
477 outs() << "(?,?) ";
478 break;
479 }
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000480 section_iterator Sec = SectionRef();
481 if (I->Sym.getRawDataRefImpl().p) {
482 Expected<section_iterator> SecOrErr =
483 MachO->getSymbolSection(I->Sym.getRawDataRefImpl());
484 if (!SecOrErr) {
485 consumeError(SecOrErr.takeError());
486 outs() << "(?,?) ";
487 break;
488 }
489 Sec = *SecOrErr;
Kevin Enderby44550602017-09-13 21:01:49 +0000490 if (Sec == MachO->section_end()) {
491 outs() << "(?,?) ";
492 break;
493 }
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000494 } else {
495 Sec = I->Section;
Kevin Enderby1f472ea2016-01-21 21:13:27 +0000496 }
Kevin Enderby980b2582014-06-05 21:21:57 +0000497 DataRefImpl Ref = Sec->getRawDataRefImpl();
498 StringRef SectionName;
499 MachO->getSectionName(Ref, SectionName);
500 StringRef SegmentName = MachO->getSectionFinalSegmentName(Ref);
501 outs() << "(" << SegmentName << "," << SectionName << ") ";
502 break;
503 }
504 default:
505 outs() << "(?) ";
506 break;
507 }
508
509 if (NType & MachO::N_EXT) {
510 if (NDesc & MachO::REFERENCED_DYNAMICALLY)
511 outs() << "[referenced dynamically] ";
512 if (NType & MachO::N_PEXT) {
513 if ((NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF)
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000514 outs() << "weak private external ";
Kevin Enderby980b2582014-06-05 21:21:57 +0000515 else
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000516 outs() << "private external ";
Kevin Enderby980b2582014-06-05 21:21:57 +0000517 } else {
518 if ((NDesc & MachO::N_WEAK_REF) == MachO::N_WEAK_REF ||
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000519 (NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF) {
Kevin Enderby980b2582014-06-05 21:21:57 +0000520 if ((NDesc & (MachO::N_WEAK_REF | MachO::N_WEAK_DEF)) ==
521 (MachO::N_WEAK_REF | MachO::N_WEAK_DEF))
522 outs() << "weak external automatically hidden ";
523 else
524 outs() << "weak external ";
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000525 } else
Kevin Enderby980b2582014-06-05 21:21:57 +0000526 outs() << "external ";
527 }
528 } else {
529 if (NType & MachO::N_PEXT)
530 outs() << "non-external (was a private external) ";
531 else
532 outs() << "non-external ";
533 }
534
535 if (Filetype == MachO::MH_OBJECT &&
536 (NDesc & MachO::N_NO_DEAD_STRIP) == MachO::N_NO_DEAD_STRIP)
537 outs() << "[no dead strip] ";
538
539 if (Filetype == MachO::MH_OBJECT &&
540 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
541 (NDesc & MachO::N_SYMBOL_RESOLVER) == MachO::N_SYMBOL_RESOLVER)
542 outs() << "[symbol resolver] ";
543
544 if (Filetype == MachO::MH_OBJECT &&
545 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
546 (NDesc & MachO::N_ALT_ENTRY) == MachO::N_ALT_ENTRY)
547 outs() << "[alt entry] ";
548
549 if ((NDesc & MachO::N_ARM_THUMB_DEF) == MachO::N_ARM_THUMB_DEF)
550 outs() << "[Thumb] ";
551
552 if ((NType & MachO::N_TYPE) == MachO::N_INDR) {
553 outs() << I->Name << " (for ";
554 StringRef IndirectName;
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000555 if (MachO) {
556 if (I->Sym.getRawDataRefImpl().p) {
557 if (MachO->getIndirectName(I->Sym.getRawDataRefImpl(), IndirectName))
558 outs() << "?)";
559 else
560 outs() << IndirectName << ")";
561 }
562 else
563 outs() << I->IndirectName << ")";
564 } else
Kevin Enderby980b2582014-06-05 21:21:57 +0000565 outs() << "?)";
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000566 } else
Kevin Enderby980b2582014-06-05 21:21:57 +0000567 outs() << I->Name;
568
569 if ((Flags & MachO::MH_TWOLEVEL) == MachO::MH_TWOLEVEL &&
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000570 (((NType & MachO::N_TYPE) == MachO::N_UNDF && NValue == 0) ||
Kevin Enderby980b2582014-06-05 21:21:57 +0000571 (NType & MachO::N_TYPE) == MachO::N_PBUD)) {
572 uint32_t LibraryOrdinal = MachO::GET_LIBRARY_ORDINAL(NDesc);
573 if (LibraryOrdinal != 0) {
574 if (LibraryOrdinal == MachO::EXECUTABLE_ORDINAL)
575 outs() << " (from executable)";
576 else if (LibraryOrdinal == MachO::DYNAMIC_LOOKUP_ORDINAL)
577 outs() << " (dynamically looked up)";
578 else {
579 StringRef LibraryName;
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000580 if (!MachO ||
581 MachO->getLibraryShortNameByIndex(LibraryOrdinal - 1, LibraryName))
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000582 outs() << " (from bad library ordinal " << LibraryOrdinal << ")";
Kevin Enderby980b2582014-06-05 21:21:57 +0000583 else
584 outs() << " (from " << LibraryName << ")";
585 }
586 }
587 }
588
589 outs() << "\n";
590}
591
Kevin Enderby407cc212014-07-17 22:47:16 +0000592// Table that maps Darwin's Mach-O stab constants to strings to allow printing.
593struct DarwinStabName {
594 uint8_t NType;
595 const char *Name;
596};
597static const struct DarwinStabName DarwinStabNames[] = {
598 {MachO::N_GSYM, "GSYM"},
599 {MachO::N_FNAME, "FNAME"},
600 {MachO::N_FUN, "FUN"},
601 {MachO::N_STSYM, "STSYM"},
602 {MachO::N_LCSYM, "LCSYM"},
603 {MachO::N_BNSYM, "BNSYM"},
604 {MachO::N_PC, "PC"},
605 {MachO::N_AST, "AST"},
606 {MachO::N_OPT, "OPT"},
607 {MachO::N_RSYM, "RSYM"},
608 {MachO::N_SLINE, "SLINE"},
609 {MachO::N_ENSYM, "ENSYM"},
610 {MachO::N_SSYM, "SSYM"},
611 {MachO::N_SO, "SO"},
612 {MachO::N_OSO, "OSO"},
613 {MachO::N_LSYM, "LSYM"},
614 {MachO::N_BINCL, "BINCL"},
615 {MachO::N_SOL, "SOL"},
616 {MachO::N_PARAMS, "PARAM"},
617 {MachO::N_VERSION, "VERS"},
618 {MachO::N_OLEVEL, "OLEV"},
619 {MachO::N_PSYM, "PSYM"},
620 {MachO::N_EINCL, "EINCL"},
621 {MachO::N_ENTRY, "ENTRY"},
622 {MachO::N_LBRAC, "LBRAC"},
623 {MachO::N_EXCL, "EXCL"},
624 {MachO::N_RBRAC, "RBRAC"},
625 {MachO::N_BCOMM, "BCOMM"},
626 {MachO::N_ECOMM, "ECOMM"},
627 {MachO::N_ECOML, "ECOML"},
628 {MachO::N_LENG, "LENG"},
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000629 {0, nullptr}};
630
Kevin Enderby407cc212014-07-17 22:47:16 +0000631static const char *getDarwinStabString(uint8_t NType) {
632 for (unsigned i = 0; DarwinStabNames[i].Name; i++) {
633 if (DarwinStabNames[i].NType == NType)
634 return DarwinStabNames[i].Name;
635 }
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000636 return nullptr;
Kevin Enderby407cc212014-07-17 22:47:16 +0000637}
638
639// darwinPrintStab() prints the n_sect, n_desc along with a symbolic name of
640// a stab n_type value in a Mach-O file.
641static void darwinPrintStab(MachOObjectFile *MachO, SymbolListT::iterator I) {
642 MachO::nlist_64 STE_64;
643 MachO::nlist STE;
644 uint8_t NType;
645 uint8_t NSect;
646 uint16_t NDesc;
Rafael Espindola2d5d23d2015-07-06 21:36:23 +0000647 DataRefImpl SymDRI = I->Sym.getRawDataRefImpl();
Kevin Enderby407cc212014-07-17 22:47:16 +0000648 if (MachO->is64Bit()) {
Rafael Espindola2d5d23d2015-07-06 21:36:23 +0000649 STE_64 = MachO->getSymbol64TableEntry(SymDRI);
Kevin Enderby407cc212014-07-17 22:47:16 +0000650 NType = STE_64.n_type;
651 NSect = STE_64.n_sect;
652 NDesc = STE_64.n_desc;
653 } else {
Rafael Espindola2d5d23d2015-07-06 21:36:23 +0000654 STE = MachO->getSymbolTableEntry(SymDRI);
Kevin Enderby407cc212014-07-17 22:47:16 +0000655 NType = STE.n_type;
656 NSect = STE.n_sect;
657 NDesc = STE.n_desc;
658 }
659
660 char Str[18] = "";
661 format("%02x", NSect).print(Str, sizeof(Str));
662 outs() << ' ' << Str << ' ';
663 format("%04x", NDesc).print(Str, sizeof(Str));
664 outs() << Str << ' ';
665 if (const char *stabString = getDarwinStabString(NType))
666 format("%5.5s", stabString).print(Str, sizeof(Str));
667 else
668 format(" %02x", NType).print(Str, sizeof(Str));
669 outs() << Str;
670}
671
Sam Clegg531da002017-06-29 18:29:05 +0000672static Optional<std::string> demangle(StringRef Name, bool StripUnderscore) {
673 if (StripUnderscore && Name.size() > 0 && Name[0] == '_')
674 Name = Name.substr(1);
675
676 if (!Name.startswith("_Z"))
677 return None;
678
679 int Status;
Eric Christopherdbb92ca2017-06-30 05:38:56 +0000680 char *Undecorated =
681 itaniumDemangle(Name.str().c_str(), nullptr, nullptr, &Status);
Sam Clegg531da002017-06-29 18:29:05 +0000682 if (Status != 0)
683 return None;
684
Eric Christopherdbb92ca2017-06-30 05:38:56 +0000685 std::string S(Undecorated);
686 free(Undecorated);
687 return S;
Sam Clegg531da002017-06-29 18:29:05 +0000688}
689
Meador Ingef74d9992016-11-23 20:17:15 +0000690static bool symbolIsDefined(const NMSymbol &Sym) {
691 return Sym.TypeChar != 'U' && Sym.TypeChar != 'w' && Sym.TypeChar != 'v';
692}
693
Rafael Espindolaceb23382014-07-31 21:00:10 +0000694static void sortAndPrintSymbolList(SymbolicFile &Obj, bool printName,
Benjamin Kramerc321e532016-06-08 19:09:22 +0000695 const std::string &ArchiveName,
696 const std::string &ArchitectureName) {
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000697 if (!NoSort) {
Rafael Espindola63d10d62015-07-06 18:48:47 +0000698 std::function<bool(const NMSymbol &, const NMSymbol &)> Cmp;
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000699 if (NumericSort)
Rafael Espindola63d10d62015-07-06 18:48:47 +0000700 Cmp = compareSymbolAddress;
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000701 else if (SizeSort)
Rafael Espindola63d10d62015-07-06 18:48:47 +0000702 Cmp = compareSymbolSize;
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000703 else
Rafael Espindola63d10d62015-07-06 18:48:47 +0000704 Cmp = compareSymbolName;
705
706 if (ReverseSort)
Rafael Espindolacab82752015-07-06 19:24:40 +0000707 Cmp = [=](const NMSymbol &A, const NMSymbol &B) { return Cmp(B, A); };
Rafael Espindola63d10d62015-07-06 18:48:47 +0000708 std::sort(SymbolList.begin(), SymbolList.end(), Cmp);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000709 }
710
Kevin Enderby08e1bbd2014-07-24 23:31:52 +0000711 if (!PrintFileName) {
712 if (OutputFormat == posix && MultipleFiles && printName) {
713 outs() << '\n' << CurrentFilename << ":\n";
714 } else if (OutputFormat == bsd && MultipleFiles && printName) {
715 outs() << "\n" << CurrentFilename << ":\n";
716 } else if (OutputFormat == sysv) {
Sam Clegg32cfbeb2017-08-31 21:23:44 +0000717 outs() << "\n\nSymbols from " << CurrentFilename << ":\n\n";
718 if (isSymbolList64Bit(Obj))
719 outs() << "Name Value Class Type"
720 << " Size Line Section\n";
721 else
722 outs() << "Name Value Class Type"
723 << " Size Line Section\n";
Kevin Enderby08e1bbd2014-07-24 23:31:52 +0000724 }
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000725 }
726
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000727 const char *printBlanks, *printDashes, *printFormat;
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000728 if (isSymbolList64Bit(Obj)) {
729 printBlanks = " ";
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000730 printDashes = "----------------";
Hemant Kulkarni5e005a12016-02-10 17:51:39 +0000731 switch (AddressRadix) {
732 case Radix::o:
Kevin Enderby2d431c3d2016-03-29 20:18:07 +0000733 printFormat = OutputFormat == posix ? "%" PRIo64 : "%016" PRIo64;
Hemant Kulkarni5e005a12016-02-10 17:51:39 +0000734 break;
735 case Radix::x:
Kevin Enderby2d431c3d2016-03-29 20:18:07 +0000736 printFormat = OutputFormat == posix ? "%" PRIx64 : "%016" PRIx64;
Hemant Kulkarni5e005a12016-02-10 17:51:39 +0000737 break;
738 default:
Kevin Enderby2d431c3d2016-03-29 20:18:07 +0000739 printFormat = OutputFormat == posix ? "%" PRId64 : "%016" PRId64;
Hemant Kulkarni5e005a12016-02-10 17:51:39 +0000740 }
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000741 } else {
742 printBlanks = " ";
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000743 printDashes = "--------";
Hemant Kulkarni5e005a12016-02-10 17:51:39 +0000744 switch (AddressRadix) {
745 case Radix::o:
Kevin Enderby2d431c3d2016-03-29 20:18:07 +0000746 printFormat = OutputFormat == posix ? "%" PRIo64 : "%08" PRIo64;
Hemant Kulkarni5e005a12016-02-10 17:51:39 +0000747 break;
748 case Radix::x:
Kevin Enderby2d431c3d2016-03-29 20:18:07 +0000749 printFormat = OutputFormat == posix ? "%" PRIx64 : "%08" PRIx64;
Hemant Kulkarni5e005a12016-02-10 17:51:39 +0000750 break;
751 default:
Kevin Enderby2d431c3d2016-03-29 20:18:07 +0000752 printFormat = OutputFormat == posix ? "%" PRId64 : "%08" PRId64;
Hemant Kulkarni5e005a12016-02-10 17:51:39 +0000753 }
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000754 }
755
Rafael Espindola619581c2014-01-29 04:56:19 +0000756 for (SymbolListT::iterator I = SymbolList.begin(), E = SymbolList.end();
757 I != E; ++I) {
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000758 uint32_t SymFlags;
Sam Clegg531da002017-06-29 18:29:05 +0000759 std::string Name = I->Name.str();
760 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
761 if (Demangle) {
762 if (Optional<std::string> Opt = demangle(I->Name, MachO))
763 Name = *Opt;
764 }
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000765 if (I->Sym.getRawDataRefImpl().p)
766 SymFlags = I->Sym.getFlags();
767 else
768 SymFlags = I->SymFlags;
769
Rafael Espindola2d5d23d2015-07-06 21:36:23 +0000770 bool Undefined = SymFlags & SymbolRef::SF_Undefined;
Kevin Enderby1543bdf2015-10-30 19:55:32 +0000771 bool Global = SymFlags & SymbolRef::SF_Global;
Davide Italiano74237152016-01-26 19:57:42 +0000772 if ((!Undefined && UndefinedOnly) || (Undefined && DefinedOnly) ||
773 (!Global && ExternalOnly) || (SizeSort && !PrintAddress))
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000774 continue;
Kevin Enderby08e1bbd2014-07-24 23:31:52 +0000775 if (PrintFileName) {
776 if (!ArchitectureName.empty())
777 outs() << "(for architecture " << ArchitectureName << "):";
Kevin Enderby2d431c3d2016-03-29 20:18:07 +0000778 if (OutputFormat == posix && !ArchiveName.empty())
779 outs() << ArchiveName << "[" << CurrentFilename << "]: ";
780 else {
781 if (!ArchiveName.empty())
782 outs() << ArchiveName << ":";
783 outs() << CurrentFilename << ": ";
784 }
Kevin Enderby08e1bbd2014-07-24 23:31:52 +0000785 }
Sam Clegg531da002017-06-29 18:29:05 +0000786 if ((JustSymbolName ||
787 (UndefinedOnly && MachO && OutputFormat != darwin)) &&
788 OutputFormat != posix) {
789 outs() << Name << "\n";
Kevin Enderby0fd8aac2014-07-03 21:51:07 +0000790 continue;
791 }
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000792
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000793 char SymbolAddrStr[18] = "";
794 char SymbolSizeStr[18] = "";
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000795
Meador Ingef74d9992016-11-23 20:17:15 +0000796 // If the format is SysV or the symbol isn't defined, then print spaces.
797 if (OutputFormat == sysv || !symbolIsDefined(*I)) {
798 if (OutputFormat == posix) {
Kevin Enderby2d431c3d2016-03-29 20:18:07 +0000799 format(printFormat, I->Address)
800 .print(SymbolAddrStr, sizeof(SymbolAddrStr));
Meador Ingef74d9992016-11-23 20:17:15 +0000801 format(printFormat, I->Size)
802 .print(SymbolSizeStr, sizeof(SymbolSizeStr));
803 } else {
Kevin Enderby2d431c3d2016-03-29 20:18:07 +0000804 strcpy(SymbolAddrStr, printBlanks);
Meador Ingef74d9992016-11-23 20:17:15 +0000805 strcpy(SymbolSizeStr, printBlanks);
806 }
Kevin Enderby2d431c3d2016-03-29 20:18:07 +0000807 }
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000808
Meador Ingef74d9992016-11-23 20:17:15 +0000809 // Otherwise, print the symbol address and size.
810 if (symbolIsDefined(*I)) {
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000811 if (Obj.isIR())
812 strcpy(SymbolAddrStr, printDashes);
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000813 else if(MachO && I->TypeChar == 'I')
814 strcpy(SymbolAddrStr, printBlanks);
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000815 else
816 format(printFormat, I->Address)
Rafael Espindolab4865d62014-04-03 00:19:35 +0000817 .print(SymbolAddrStr, sizeof(SymbolAddrStr));
Meador Ingef74d9992016-11-23 20:17:15 +0000818 format(printFormat, I->Size).print(SymbolSizeStr, sizeof(SymbolSizeStr));
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000819 }
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000820
Kevin Enderby77b968e2014-07-16 17:38:26 +0000821 // If OutputFormat is darwin or we are printing Mach-O symbols in hex and
822 // we have a MachOObjectFile, call darwinPrintSymbol to print as darwin's
823 // nm(1) -m output or hex, else if OutputFormat is darwin or we are
824 // printing Mach-O symbols in hex and not a Mach-O object fall back to
825 // OutputFormat bsd (see below).
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000826 if ((OutputFormat == darwin || FormatMachOasHex) && (MachO || Obj.isIR())) {
827 darwinPrintSymbol(Obj, I, SymbolAddrStr, printBlanks, printDashes,
828 printFormat);
Kevin Enderby980b2582014-06-05 21:21:57 +0000829 } else if (OutputFormat == posix) {
Sam Clegg531da002017-06-29 18:29:05 +0000830 outs() << Name << " " << I->TypeChar << " ";
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000831 if (MachO)
Kevin Enderby2d431c3d2016-03-29 20:18:07 +0000832 outs() << SymbolAddrStr << " " << "0" /* SymbolSizeStr */ << "\n";
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000833 else
James Molloy08a15ce2016-03-24 09:23:51 +0000834 outs() << SymbolAddrStr << " " << SymbolSizeStr << "\n";
Kevin Enderby980b2582014-06-05 21:21:57 +0000835 } else if (OutputFormat == bsd || (OutputFormat == darwin && !MachO)) {
Rafael Espindolab4865d62014-04-03 00:19:35 +0000836 if (PrintAddress)
837 outs() << SymbolAddrStr << ' ';
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000838 if (PrintSize) {
839 outs() << SymbolSizeStr;
Rafael Espindolad7a32ea2015-06-24 10:20:30 +0000840 outs() << ' ';
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000841 }
Kevin Enderby407cc212014-07-17 22:47:16 +0000842 outs() << I->TypeChar;
843 if (I->TypeChar == '-' && MachO)
844 darwinPrintStab(MachO, I);
Sam Clegg531da002017-06-29 18:29:05 +0000845 outs() << " " << Name;
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000846 if (I->TypeChar == 'I' && MachO) {
847 outs() << " (indirect for ";
848 if (I->Sym.getRawDataRefImpl().p) {
849 StringRef IndirectName;
850 if (MachO->getIndirectName(I->Sym.getRawDataRefImpl(), IndirectName))
851 outs() << "?)";
852 else
853 outs() << IndirectName << ")";
854 } else
855 outs() << I->IndirectName << ")";
856 }
857 outs() << "\n";
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000858 } else if (OutputFormat == sysv) {
Sam Clegg531da002017-06-29 18:29:05 +0000859 std::string PaddedName(Name);
Rafael Espindola619581c2014-01-29 04:56:19 +0000860 while (PaddedName.length() < 20)
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000861 PaddedName += " ";
Rafael Espindolab4865d62014-04-03 00:19:35 +0000862 outs() << PaddedName << "|" << SymbolAddrStr << "| " << I->TypeChar
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000863 << " | |" << SymbolSizeStr << "| |\n";
864 }
865 }
866
867 SymbolList.clear();
868}
869
Rafael Espindolab39953d2015-06-26 13:11:15 +0000870static char getSymbolNMTypeChar(ELFObjectFileBase &Obj,
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000871 basic_symbol_iterator I) {
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000872 // OK, this is ELF
Rafael Espindolab39953d2015-06-26 13:11:15 +0000873 elf_symbol_iterator SymI(I);
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000874
Kevin Enderby7bd8d992016-05-02 20:28:12 +0000875 Expected<elf_section_iterator> SecIOrErr = SymI->getSection();
876 if (!SecIOrErr) {
877 consumeError(SecIOrErr.takeError());
Rafael Espindolab39953d2015-06-26 13:11:15 +0000878 return '?';
Kevin Enderby7bd8d992016-05-02 20:28:12 +0000879 }
Rafael Espindola586af97a2013-11-02 21:16:09 +0000880
Rafael Espindola8bab8892015-08-07 23:27:14 +0000881 elf_section_iterator SecI = *SecIOrErr;
Rafael Espindolab39953d2015-06-26 13:11:15 +0000882 if (SecI != Obj.section_end()) {
883 switch (SecI->getType()) {
Rafael Espindola586af97a2013-11-02 21:16:09 +0000884 case ELF::SHT_PROGBITS:
885 case ELF::SHT_DYNAMIC:
Rafael Espindolab39953d2015-06-26 13:11:15 +0000886 switch (SecI->getFlags()) {
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000887 case (ELF::SHF_ALLOC | ELF::SHF_EXECINSTR):
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000888 return 't';
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000889 case (ELF::SHF_TLS | ELF::SHF_ALLOC | ELF::SHF_WRITE):
890 case (ELF::SHF_ALLOC | ELF::SHF_WRITE):
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000891 return 'd';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000892 case ELF::SHF_ALLOC:
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000893 case (ELF::SHF_ALLOC | ELF::SHF_MERGE):
894 case (ELF::SHF_ALLOC | ELF::SHF_MERGE | ELF::SHF_STRINGS):
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000895 return 'r';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000896 }
897 break;
898 case ELF::SHT_NOBITS:
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000899 return 'b';
Meador Ingeca975582016-11-23 20:17:20 +0000900 case ELF::SHT_INIT_ARRAY:
901 case ELF::SHT_FINI_ARRAY:
902 return 't';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000903 }
904 }
905
Rafael Espindolab39953d2015-06-26 13:11:15 +0000906 if (SymI->getELFType() == ELF::STT_SECTION) {
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000907 Expected<StringRef> Name = SymI->getName();
908 if (!Name) {
909 consumeError(Name.takeError());
Rafael Espindola74375892014-02-04 00:21:18 +0000910 return '?';
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000911 }
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000912 return StringSwitch<char>(*Name)
Rafael Espindola74375892014-02-04 00:21:18 +0000913 .StartsWith(".debug", 'N')
914 .StartsWith(".note", 'n')
915 .Default('?');
Rafael Espindola586af97a2013-11-02 21:16:09 +0000916 }
917
Rafael Espindola60c1a8c2015-06-25 16:01:53 +0000918 return 'n';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000919}
920
Rafael Espindola74375892014-02-04 00:21:18 +0000921static char getSymbolNMTypeChar(COFFObjectFile &Obj, symbol_iterator I) {
David Majnemer44f51e52014-09-10 12:51:52 +0000922 COFFSymbolRef Symb = Obj.getCOFFSymbol(*I);
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000923 // OK, this is COFF.
924 symbol_iterator SymI(I);
925
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000926 Expected<StringRef> Name = SymI->getName();
927 if (!Name) {
928 consumeError(Name.takeError());
Rafael Espindola74375892014-02-04 00:21:18 +0000929 return '?';
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000930 }
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000931
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000932 char Ret = StringSwitch<char>(*Name)
Rafael Espindola586af97a2013-11-02 21:16:09 +0000933 .StartsWith(".debug", 'N')
934 .StartsWith(".sxdata", 'N')
935 .Default('?');
936
Rafael Espindola74375892014-02-04 00:21:18 +0000937 if (Ret != '?')
938 return Ret;
Rafael Espindola586af97a2013-11-02 21:16:09 +0000939
940 uint32_t Characteristics = 0;
David Majnemer44f51e52014-09-10 12:51:52 +0000941 if (!COFF::isReservedSectionNumber(Symb.getSectionNumber())) {
Kevin Enderby7bd8d992016-05-02 20:28:12 +0000942 Expected<section_iterator> SecIOrErr = SymI->getSection();
943 if (!SecIOrErr) {
944 consumeError(SecIOrErr.takeError());
Rafael Espindola74375892014-02-04 00:21:18 +0000945 return '?';
Kevin Enderby7bd8d992016-05-02 20:28:12 +0000946 }
Rafael Espindola8bab8892015-08-07 23:27:14 +0000947 section_iterator SecI = *SecIOrErr;
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000948 const coff_section *Section = Obj.getCOFFSection(*SecI);
Rafael Espindola586af97a2013-11-02 21:16:09 +0000949 Characteristics = Section->Characteristics;
Martin Storsjo14015242017-11-03 07:18:14 +0000950 StringRef SectionName;
951 Obj.getSectionName(Section, SectionName);
952 if (SectionName.startswith(".idata"))
953 return 'i';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000954 }
955
David Majnemer44f51e52014-09-10 12:51:52 +0000956 switch (Symb.getSectionNumber()) {
Rafael Espindola586af97a2013-11-02 21:16:09 +0000957 case COFF::IMAGE_SYM_DEBUG:
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000958 return 'n';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000959 default:
960 // Check section type.
961 if (Characteristics & COFF::IMAGE_SCN_CNT_CODE)
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000962 return 't';
David Majnemerc7d7c6f2014-10-31 05:07:00 +0000963 if (Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
964 return Characteristics & COFF::IMAGE_SCN_MEM_WRITE ? 'd' : 'r';
965 if (Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000966 return 'b';
David Majnemerc7d7c6f2014-10-31 05:07:00 +0000967 if (Characteristics & COFF::IMAGE_SCN_LNK_INFO)
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000968 return 'i';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000969 // Check for section symbol.
David Majnemerc7d7c6f2014-10-31 05:07:00 +0000970 if (Symb.isSectionDefinition())
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000971 return 's';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000972 }
973
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000974 return '?';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000975}
976
Rafael Espindola8b781852017-05-24 23:40:36 +0000977static char getSymbolNMTypeChar(COFFImportFile &Obj) {
978 switch (Obj.getCOFFImportHeader()->getType()) {
979 case COFF::IMPORT_CODE:
980 return 't';
981 case COFF::IMPORT_DATA:
982 return 'd';
983 case COFF::IMPORT_CONST:
984 return 'r';
985 }
986 return '?';
987}
988
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000989static char getSymbolNMTypeChar(MachOObjectFile &Obj, basic_symbol_iterator I) {
Rafael Espindola586af97a2013-11-02 21:16:09 +0000990 DataRefImpl Symb = I->getRawDataRefImpl();
Davide Italianoba284b62016-02-11 02:56:02 +0000991 uint8_t NType = Obj.is64Bit() ? Obj.getSymbol64TableEntry(Symb).n_type
992 : Obj.getSymbolTableEntry(Symb).n_type;
Rafael Espindola586af97a2013-11-02 21:16:09 +0000993
Kevin Enderby407cc212014-07-17 22:47:16 +0000994 if (NType & MachO::N_STAB)
995 return '-';
996
Rafael Espindola586af97a2013-11-02 21:16:09 +0000997 switch (NType & MachO::N_TYPE) {
Rafael Espindola586af97a2013-11-02 21:16:09 +0000998 case MachO::N_ABS:
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000999 return 's';
Tim Northovereaef0742014-05-30 13:22:59 +00001000 case MachO::N_INDR:
1001 return 'i';
Rafael Espindola586af97a2013-11-02 21:16:09 +00001002 case MachO::N_SECT: {
Kevin Enderby7bd8d992016-05-02 20:28:12 +00001003 Expected<section_iterator> SecOrErr = Obj.getSymbolSection(Symb);
1004 if (!SecOrErr) {
1005 consumeError(SecOrErr.takeError());
Kevin Enderby1f472ea2016-01-21 21:13:27 +00001006 return 's';
Kevin Enderby7bd8d992016-05-02 20:28:12 +00001007 }
Kevin Enderby1f472ea2016-01-21 21:13:27 +00001008 section_iterator Sec = *SecOrErr;
Kevin Enderby44550602017-09-13 21:01:49 +00001009 if (Sec == Obj.section_end())
1010 return 's';
Rafael Espindola586af97a2013-11-02 21:16:09 +00001011 DataRefImpl Ref = Sec->getRawDataRefImpl();
1012 StringRef SectionName;
1013 Obj.getSectionName(Ref, SectionName);
1014 StringRef SegmentName = Obj.getSectionFinalSegmentName(Ref);
Kevin Enderbyb95a0502018-01-31 00:00:41 +00001015 if (Obj.is64Bit() &&
1016 Obj.getHeader64().filetype == MachO::MH_KEXT_BUNDLE &&
1017 SegmentName == "__TEXT_EXEC" && SectionName == "__text")
1018 return 't';
Rafael Espindola586af97a2013-11-02 21:16:09 +00001019 if (SegmentName == "__TEXT" && SectionName == "__text")
Rafael Espindola22fe9c12014-02-05 05:19:19 +00001020 return 't';
Davide Italianoe4db1872016-01-26 19:28:51 +00001021 if (SegmentName == "__DATA" && SectionName == "__data")
Kevin Enderby1e1b9922014-06-19 22:49:21 +00001022 return 'd';
Davide Italianoe4db1872016-01-26 19:28:51 +00001023 if (SegmentName == "__DATA" && SectionName == "__bss")
Kevin Enderby1e1b9922014-06-19 22:49:21 +00001024 return 'b';
Davide Italianoe4db1872016-01-26 19:28:51 +00001025 return 's';
Rafael Espindola22fe9c12014-02-05 05:19:19 +00001026 }
Rafael Espindola586af97a2013-11-02 21:16:09 +00001027 }
1028
Rafael Espindola22fe9c12014-02-05 05:19:19 +00001029 return '?';
1030}
1031
Sam Clegg135a4b82017-04-14 19:50:44 +00001032static char getSymbolNMTypeChar(WasmObjectFile &Obj, basic_symbol_iterator I) {
1033 uint32_t Flags = I->getFlags();
1034 if (Flags & SymbolRef::SF_Executable)
1035 return 't';
1036 return 'd';
1037}
1038
Peter Collingbournee2f1b4a2016-12-01 06:53:47 +00001039static char getSymbolNMTypeChar(IRObjectFile &Obj, basic_symbol_iterator I) {
1040 uint32_t Flags = I->getFlags();
Rafael Espindolaf12b8282014-02-21 20:10:59 +00001041 // FIXME: should we print 'b'? At the IR level we cannot be sure if this
1042 // will be in bss or not, but we could approximate.
Peter Collingbournee2f1b4a2016-12-01 06:53:47 +00001043 if (Flags & SymbolRef::SF_Executable)
1044 return 't';
1045 else if (Triple(Obj.getTargetTriple()).isOSDarwin() &&
1046 (Flags & SymbolRef::SF_Const))
1047 return 's';
1048 else
1049 return 'd';
Rafael Espindolaf12b8282014-02-21 20:10:59 +00001050}
1051
Rafael Espindolaceb23382014-07-31 21:00:10 +00001052static bool isObject(SymbolicFile &Obj, basic_symbol_iterator I) {
Davide Italiano92e6c282016-02-08 23:50:23 +00001053 return !dyn_cast<ELFObjectFileBase>(&Obj)
Davide Italiano71c85df2016-02-08 22:58:26 +00001054 ? false
1055 : elf_symbol_iterator(I)->getELFType() == ELF::STT_OBJECT;
Rafael Espindola586af97a2013-11-02 21:16:09 +00001056}
1057
Rafael Espindolaceb23382014-07-31 21:00:10 +00001058static char getNMTypeChar(SymbolicFile &Obj, basic_symbol_iterator I) {
Rafael Espindola22fe9c12014-02-05 05:19:19 +00001059 uint32_t Symflags = I->getFlags();
1060 if ((Symflags & object::SymbolRef::SF_Weak) && !isa<MachOObjectFile>(Obj)) {
1061 char Ret = isObject(Obj, I) ? 'v' : 'w';
Davide Italianoa090a002016-02-05 21:10:48 +00001062 return (!(Symflags & object::SymbolRef::SF_Undefined)) ? toupper(Ret) : Ret;
Rafael Espindola22fe9c12014-02-05 05:19:19 +00001063 }
1064
1065 if (Symflags & object::SymbolRef::SF_Undefined)
1066 return 'U';
1067
1068 if (Symflags & object::SymbolRef::SF_Common)
1069 return 'C';
1070
1071 char Ret = '?';
1072 if (Symflags & object::SymbolRef::SF_Absolute)
1073 Ret = 'a';
Peter Collingbournee2f1b4a2016-12-01 06:53:47 +00001074 else if (IRObjectFile *IR = dyn_cast<IRObjectFile>(&Obj))
Rafael Espindolaf12b8282014-02-21 20:10:59 +00001075 Ret = getSymbolNMTypeChar(*IR, I);
Rafael Espindolaceb23382014-07-31 21:00:10 +00001076 else if (COFFObjectFile *COFF = dyn_cast<COFFObjectFile>(&Obj))
Rafael Espindola22fe9c12014-02-05 05:19:19 +00001077 Ret = getSymbolNMTypeChar(*COFF, I);
Rafael Espindola8b781852017-05-24 23:40:36 +00001078 else if (COFFImportFile *COFFImport = dyn_cast<COFFImportFile>(&Obj))
1079 Ret = getSymbolNMTypeChar(*COFFImport);
Rafael Espindolaceb23382014-07-31 21:00:10 +00001080 else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj))
Rafael Espindola22fe9c12014-02-05 05:19:19 +00001081 Ret = getSymbolNMTypeChar(*MachO, I);
Sam Clegg135a4b82017-04-14 19:50:44 +00001082 else if (WasmObjectFile *Wasm = dyn_cast<WasmObjectFile>(&Obj))
1083 Ret = getSymbolNMTypeChar(*Wasm, I);
Rafael Espindola22fe9c12014-02-05 05:19:19 +00001084 else
Rafael Espindolab39953d2015-06-26 13:11:15 +00001085 Ret = getSymbolNMTypeChar(cast<ELFObjectFileBase>(Obj), I);
Rafael Espindola22fe9c12014-02-05 05:19:19 +00001086
1087 if (Symflags & object::SymbolRef::SF_Global)
1088 Ret = toupper(Ret);
1089
1090 return Ret;
Rafael Espindola586af97a2013-11-02 21:16:09 +00001091}
1092
Kevin Enderbyfe6ad972014-07-11 20:30:00 +00001093// getNsectForSegSect() is used to implement the Mach-O "-s segname sectname"
1094// option to dump only those symbols from that section in a Mach-O file.
1095// It is called once for each Mach-O file from dumpSymbolNamesFromObject()
1096// to get the section number for that named section from the command line
1097// arguments. It returns the section number for that section in the Mach-O
1098// file or zero it is not present.
1099static unsigned getNsectForSegSect(MachOObjectFile *Obj) {
1100 unsigned Nsect = 1;
Davide Italiano9ee9fb62016-02-10 23:16:17 +00001101 for (auto &S : Obj->sections()) {
1102 DataRefImpl Ref = S.getRawDataRefImpl();
Kevin Enderbyfe6ad972014-07-11 20:30:00 +00001103 StringRef SectionName;
1104 Obj->getSectionName(Ref, SectionName);
1105 StringRef SegmentName = Obj->getSectionFinalSegmentName(Ref);
1106 if (SegmentName == SegSect[0] && SectionName == SegSect[1])
1107 return Nsect;
1108 Nsect++;
1109 }
1110 return 0;
1111}
1112
1113// getNsectInMachO() is used to implement the Mach-O "-s segname sectname"
1114// option to dump only those symbols from that section in a Mach-O file.
1115// It is called once for each symbol in a Mach-O file from
1116// dumpSymbolNamesFromObject() and returns the section number for that symbol
1117// if it is in a section, else it returns 0.
Rafael Espindolab85e10c2015-06-25 15:00:38 +00001118static unsigned getNsectInMachO(MachOObjectFile &Obj, BasicSymbolRef Sym) {
1119 DataRefImpl Symb = Sym.getRawDataRefImpl();
Kevin Enderbyfe6ad972014-07-11 20:30:00 +00001120 if (Obj.is64Bit()) {
1121 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
Davide Italianoba284b62016-02-11 02:56:02 +00001122 return (STE.n_type & MachO::N_TYPE) == MachO::N_SECT ? STE.n_sect : 0;
Kevin Enderbyfe6ad972014-07-11 20:30:00 +00001123 }
1124 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
Davide Italianoba284b62016-02-11 02:56:02 +00001125 return (STE.n_type & MachO::N_TYPE) == MachO::N_SECT ? STE.n_sect : 0;
Kevin Enderbyfe6ad972014-07-11 20:30:00 +00001126}
1127
Benjamin Kramerc321e532016-06-08 19:09:22 +00001128static void
1129dumpSymbolNamesFromObject(SymbolicFile &Obj, bool printName,
1130 const std::string &ArchiveName = std::string(),
1131 const std::string &ArchitectureName = std::string()) {
Rafael Espindolab85e10c2015-06-25 15:00:38 +00001132 auto Symbols = Obj.symbols();
Michael J. Spencer8c4729f2012-02-28 00:40:37 +00001133 if (DynamicSyms) {
Rafael Espindola11afad02015-06-25 14:39:35 +00001134 const auto *E = dyn_cast<ELFObjectFileBase>(&Obj);
1135 if (!E) {
Rafael Espindolaceb23382014-07-31 21:00:10 +00001136 error("File format has no dynamic symbol table", Obj.getFileName());
Rafael Espindola196666c2014-01-30 20:45:33 +00001137 return;
1138 }
Rafael Espindolab85e10c2015-06-25 15:00:38 +00001139 auto DynSymbols = E->getDynamicSymbolIterators();
1140 Symbols =
1141 make_range<basic_symbol_iterator>(DynSymbols.begin(), DynSymbols.end());
Michael J. Spencer8c4729f2012-02-28 00:40:37 +00001142 }
Rafael Espindolaf12b8282014-02-21 20:10:59 +00001143 std::string NameBuffer;
1144 raw_string_ostream OS(NameBuffer);
Kevin Enderbyfe6ad972014-07-11 20:30:00 +00001145 // If a "-s segname sectname" option was specified and this is a Mach-O
1146 // file get the section number for that section in this object file.
1147 unsigned int Nsect = 0;
Rafael Espindolaceb23382014-07-31 21:00:10 +00001148 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
Kevin Enderbyfe6ad972014-07-11 20:30:00 +00001149 if (SegSect.size() != 0 && MachO) {
1150 Nsect = getNsectForSegSect(MachO);
1151 // If this section is not in the object file no symbols are printed.
1152 if (Nsect == 0)
1153 return;
1154 }
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001155 if (!MachO || !DyldInfoOnly) {
1156 for (BasicSymbolRef Sym : Symbols) {
1157 uint32_t SymFlags = Sym.getFlags();
1158 if (!DebugSyms && (SymFlags & SymbolRef::SF_FormatSpecific))
1159 continue;
1160 if (WithoutAliases && (SymFlags & SymbolRef::SF_Indirect))
1161 continue;
1162 // If a "-s segname sectname" option was specified and this is a Mach-O
1163 // file and this section appears in this file, Nsect will be non-zero then
1164 // see if this symbol is a symbol from that section and if not skip it.
1165 if (Nsect && Nsect != getNsectInMachO(*MachO, Sym))
1166 continue;
1167 NMSymbol S;
Kevin Enderbya8c4c012017-06-20 00:41:04 +00001168 memset(&S, '\0', sizeof(S));
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001169 S.Size = 0;
1170 S.Address = 0;
1171 if (PrintSize) {
1172 if (isa<ELFObjectFileBase>(&Obj))
1173 S.Size = ELFSymbolRef(Sym).getSize();
Kevin Enderby931cb652016-06-24 18:24:42 +00001174 }
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001175 if (PrintAddress && isa<ObjectFile>(Obj)) {
1176 SymbolRef SymRef(Sym);
1177 Expected<uint64_t> AddressOrErr = SymRef.getAddress();
1178 if (!AddressOrErr) {
1179 consumeError(AddressOrErr.takeError());
1180 break;
1181 }
1182 S.Address = *AddressOrErr;
1183 }
1184 S.TypeChar = getNMTypeChar(Obj, Sym);
1185 std::error_code EC = Sym.printName(OS);
1186 if (EC && MachO)
1187 OS << "bad string index";
1188 else
1189 error(EC);
1190 OS << '\0';
1191 S.Sym = Sym;
1192 SymbolList.push_back(S);
Rafael Espindolab85e10c2015-06-25 15:00:38 +00001193 }
Michael J. Spencerb8672a52011-01-20 06:38:57 +00001194 }
1195
Rafael Espindolaf12b8282014-02-21 20:10:59 +00001196 OS.flush();
1197 const char *P = NameBuffer.c_str();
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001198 unsigned I;
1199 for (I = 0; I < SymbolList.size(); ++I) {
Rafael Espindolaf12b8282014-02-21 20:10:59 +00001200 SymbolList[I].Name = P;
1201 P += strlen(P) + 1;
1202 }
1203
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001204 // If this is a Mach-O file where the nlist symbol table is out of sync
1205 // with the dyld export trie then look through exports and fake up symbols
1206 // for the ones that are missing (also done with the -add-dyldinfo flag).
1207 // This is needed if strip(1) -T is run on a binary containing swift
1208 // language symbols for example. The option -only-dyldinfo will fake up
1209 // all symbols from the dyld export trie as well as the bind info.
1210 std::string ExportsNameBuffer;
1211 raw_string_ostream EOS(ExportsNameBuffer);
1212 std::string BindsNameBuffer;
1213 raw_string_ostream BOS(BindsNameBuffer);
1214 std::string LazysNameBuffer;
1215 raw_string_ostream LOS(LazysNameBuffer);
1216 std::string WeaksNameBuffer;
1217 raw_string_ostream WOS(WeaksNameBuffer);
Kevin Enderbyd3cf76b2018-03-22 23:59:35 +00001218 std::string FunctionStartsNameBuffer;
1219 raw_string_ostream FOS(FunctionStartsNameBuffer);
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001220 if (MachO && !NoDyldInfo) {
1221 MachO::mach_header H;
1222 MachO::mach_header_64 H_64;
1223 uint32_t HFlags = 0;
1224 if (MachO->is64Bit()) {
1225 H_64 = MachO->MachOObjectFile::getHeader64();
1226 HFlags = H_64.flags;
1227 } else {
1228 H = MachO->MachOObjectFile::getHeader();
1229 HFlags = H.flags;
1230 }
1231 uint64_t BaseSegmentAddress = 0;
1232 for (const auto &Command : MachO->load_commands()) {
1233 if (Command.C.cmd == MachO::LC_SEGMENT) {
1234 MachO::segment_command Seg = MachO->getSegmentLoadCommand(Command);
1235 if (Seg.fileoff == 0 && Seg.filesize != 0) {
1236 BaseSegmentAddress = Seg.vmaddr;
1237 break;
1238 }
1239 } else if (Command.C.cmd == MachO::LC_SEGMENT_64) {
1240 MachO::segment_command_64 Seg = MachO->getSegment64LoadCommand(Command);
1241 if (Seg.fileoff == 0 && Seg.filesize != 0) {
1242 BaseSegmentAddress = Seg.vmaddr;
1243 break;
1244 }
1245 }
1246 }
1247 if (DyldInfoOnly || AddDyldInfo ||
1248 HFlags & MachO::MH_NLIST_OUTOFSYNC_WITH_DYLDINFO) {
1249 unsigned ExportsAdded = 0;
Kevin Enderby3e95bd22017-07-20 23:08:41 +00001250 Error Err = Error::success();
Alexander Shaposhnikove5740342017-07-29 00:30:45 +00001251 for (const llvm::object::ExportEntry &Entry : MachO->exports(Err)) {
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001252 bool found = false;
1253 bool ReExport = false;
1254 if (!DyldInfoOnly) {
1255 for (unsigned J = 0; J < SymbolList.size() && !found; ++J) {
1256 if (SymbolList[J].Address == Entry.address() + BaseSegmentAddress &&
1257 SymbolList[J].Name == Entry.name())
1258 found = true;
1259 }
1260 }
1261 if (!found) {
1262 NMSymbol S;
Kevin Enderbya8c4c012017-06-20 00:41:04 +00001263 memset(&S, '\0', sizeof(NMSymbol));
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001264 S.Address = Entry.address() + BaseSegmentAddress;
1265 S.Size = 0;
1266 S.TypeChar = '\0';
1267 S.Name = Entry.name();
1268 // There is no symbol in the nlist symbol table for this so we set
1269 // Sym effectivly to null and the rest of code in here must test for
1270 // it and not do things like Sym.getFlags() for it.
1271 S.Sym = BasicSymbolRef();
1272 S.SymFlags = SymbolRef::SF_Global;
1273 S.Section = SectionRef();
1274 S.NType = 0;
1275 S.NSect = 0;
1276 S.NDesc = 0;
1277 S.IndirectName = StringRef();
1278
1279 uint64_t EFlags = Entry.flags();
1280 bool Abs = ((EFlags & MachO::EXPORT_SYMBOL_FLAGS_KIND_MASK) ==
1281 MachO::EXPORT_SYMBOL_FLAGS_KIND_ABSOLUTE);
1282 bool Resolver = (EFlags &
1283 MachO::EXPORT_SYMBOL_FLAGS_STUB_AND_RESOLVER);
1284 ReExport = (EFlags & MachO::EXPORT_SYMBOL_FLAGS_REEXPORT);
1285 bool WeakDef = (EFlags & MachO::EXPORT_SYMBOL_FLAGS_WEAK_DEFINITION);
1286 if (WeakDef)
1287 S.NDesc |= MachO::N_WEAK_DEF;
1288 if (Abs) {
1289 S.NType = MachO::N_EXT | MachO::N_ABS;
1290 S.TypeChar = 'A';
1291 } else if (ReExport) {
1292 S.NType = MachO::N_EXT | MachO::N_INDR;
1293 S.TypeChar = 'I';
1294 } else {
1295 S.NType = MachO::N_EXT | MachO::N_SECT;
1296 if (Resolver) {
1297 S.Address = Entry.other() + BaseSegmentAddress;
1298 if ((S.Address & 1) != 0 &&
1299 !MachO->is64Bit() && H.cputype == MachO::CPU_TYPE_ARM){
1300 S.Address &= ~1LL;
1301 S.NDesc |= MachO::N_ARM_THUMB_DEF;
1302 }
1303 } else {
1304 S.Address = Entry.address() + BaseSegmentAddress;
1305 }
1306 StringRef SegmentName = StringRef();
1307 StringRef SectionName = StringRef();
1308 for (const SectionRef &Section : MachO->sections()) {
1309 S.NSect++;
1310 Section.getName(SectionName);
1311 SegmentName = MachO->getSectionFinalSegmentName(
1312 Section.getRawDataRefImpl());
1313 if (S.Address >= Section.getAddress() &&
1314 S.Address < Section.getAddress() + Section.getSize()) {
1315 S.Section = Section;
1316 break;
1317 } else if (Entry.name() == "__mh_execute_header" &&
1318 SegmentName == "__TEXT" && SectionName == "__text") {
1319 S.Section = Section;
1320 S.NDesc |= MachO::REFERENCED_DYNAMICALLY;
1321 break;
1322 }
1323 }
1324 if (SegmentName == "__TEXT" && SectionName == "__text")
1325 S.TypeChar = 'T';
1326 else if (SegmentName == "__DATA" && SectionName == "__data")
1327 S.TypeChar = 'D';
1328 else if (SegmentName == "__DATA" && SectionName == "__bss")
1329 S.TypeChar = 'B';
1330 else
1331 S.TypeChar = 'S';
1332 }
1333 SymbolList.push_back(S);
1334
1335 EOS << Entry.name();
1336 EOS << '\0';
1337 ExportsAdded++;
1338
1339 // For ReExports there are a two more things to do, first add the
1340 // indirect name and second create the undefined symbol using the
1341 // referened dynamic library.
1342 if (ReExport) {
1343
1344 // Add the indirect name.
1345 if (Entry.otherName().empty())
1346 EOS << Entry.name();
1347 else
1348 EOS << Entry.otherName();
1349 EOS << '\0';
1350
1351 // Now create the undefined symbol using the referened dynamic
1352 // library.
1353 NMSymbol U;
Kevin Enderbya8c4c012017-06-20 00:41:04 +00001354 memset(&U, '\0', sizeof(NMSymbol));
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001355 U.Address = 0;
1356 U.Size = 0;
1357 U.TypeChar = 'U';
1358 if (Entry.otherName().empty())
1359 U.Name = Entry.name();
1360 else
1361 U.Name = Entry.otherName();
1362 // Again there is no symbol in the nlist symbol table for this so
1363 // we set Sym effectivly to null and the rest of code in here must
1364 // test for it and not do things like Sym.getFlags() for it.
1365 U.Sym = BasicSymbolRef();
1366 U.SymFlags = SymbolRef::SF_Global | SymbolRef::SF_Undefined;
1367 U.Section = SectionRef();
1368 U.NType = MachO::N_EXT | MachO::N_UNDF;
1369 U.NSect = 0;
1370 U.NDesc = 0;
1371 // The library ordinal for this undefined symbol is in the export
1372 // trie Entry.other().
1373 MachO::SET_LIBRARY_ORDINAL(U.NDesc, Entry.other());
1374 U.IndirectName = StringRef();
1375 SymbolList.push_back(U);
1376
1377 // Finally add the undefined symbol's name.
1378 if (Entry.otherName().empty())
1379 EOS << Entry.name();
1380 else
1381 EOS << Entry.otherName();
1382 EOS << '\0';
1383 ExportsAdded++;
1384 }
1385 }
1386 }
Kevin Enderby3e95bd22017-07-20 23:08:41 +00001387 if (Err)
1388 error(std::move(Err), MachO->getFileName());
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001389 // Set the symbol names and indirect names for the added symbols.
1390 if (ExportsAdded) {
1391 EOS.flush();
1392 const char *Q = ExportsNameBuffer.c_str();
1393 for (unsigned K = 0; K < ExportsAdded; K++) {
1394 SymbolList[I].Name = Q;
1395 Q += strlen(Q) + 1;
1396 if (SymbolList[I].TypeChar == 'I') {
1397 SymbolList[I].IndirectName = Q;
1398 Q += strlen(Q) + 1;
1399 }
1400 I++;
1401 }
1402 }
1403
1404 // Add the undefined symbols from the bind entries.
1405 unsigned BindsAdded = 0;
1406 Error BErr = Error::success();
1407 StringRef LastSymbolName = StringRef();
1408 for (const llvm::object::MachOBindEntry &Entry : MachO->bindTable(BErr)) {
1409 bool found = false;
1410 if (LastSymbolName == Entry.symbolName())
1411 found = true;
1412 else if(!DyldInfoOnly) {
1413 for (unsigned J = 0; J < SymbolList.size() && !found; ++J) {
1414 if (SymbolList[J].Name == Entry.symbolName())
1415 found = true;
1416 }
1417 }
1418 if (!found) {
1419 LastSymbolName = Entry.symbolName();
1420 NMSymbol B;
Kevin Enderbya8c4c012017-06-20 00:41:04 +00001421 memset(&B, '\0', sizeof(NMSymbol));
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001422 B.Address = 0;
1423 B.Size = 0;
1424 B.TypeChar = 'U';
1425 // There is no symbol in the nlist symbol table for this so we set
1426 // Sym effectivly to null and the rest of code in here must test for
1427 // it and not do things like Sym.getFlags() for it.
1428 B.Sym = BasicSymbolRef();
1429 B.SymFlags = SymbolRef::SF_Global | SymbolRef::SF_Undefined;
1430 B.NType = MachO::N_EXT | MachO::N_UNDF;
1431 B.NSect = 0;
1432 B.NDesc = 0;
1433 B.NDesc = 0;
1434 MachO::SET_LIBRARY_ORDINAL(B.NDesc, Entry.ordinal());
1435 B.IndirectName = StringRef();
1436 B.Name = Entry.symbolName();
1437 SymbolList.push_back(B);
1438 BOS << Entry.symbolName();
1439 BOS << '\0';
1440 BindsAdded++;
1441 }
1442 }
1443 if (BErr)
1444 error(std::move(BErr), MachO->getFileName());
1445 // Set the symbol names and indirect names for the added symbols.
1446 if (BindsAdded) {
1447 BOS.flush();
1448 const char *Q = BindsNameBuffer.c_str();
1449 for (unsigned K = 0; K < BindsAdded; K++) {
1450 SymbolList[I].Name = Q;
1451 Q += strlen(Q) + 1;
1452 if (SymbolList[I].TypeChar == 'I') {
1453 SymbolList[I].IndirectName = Q;
1454 Q += strlen(Q) + 1;
1455 }
1456 I++;
1457 }
1458 }
1459
1460 // Add the undefined symbols from the lazy bind entries.
1461 unsigned LazysAdded = 0;
1462 Error LErr = Error::success();
1463 LastSymbolName = StringRef();
1464 for (const llvm::object::MachOBindEntry &Entry :
1465 MachO->lazyBindTable(LErr)) {
1466 bool found = false;
1467 if (LastSymbolName == Entry.symbolName())
1468 found = true;
1469 else {
1470 // Here we must check to see it this symbol is already in the
1471 // SymbolList as it might have already have been added above via a
1472 // non-lazy (bind) entry.
1473 for (unsigned J = 0; J < SymbolList.size() && !found; ++J) {
1474 if (SymbolList[J].Name == Entry.symbolName())
1475 found = true;
1476 }
1477 }
1478 if (!found) {
1479 LastSymbolName = Entry.symbolName();
1480 NMSymbol L;
Kevin Enderbya8c4c012017-06-20 00:41:04 +00001481 memset(&L, '\0', sizeof(NMSymbol));
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001482 L.Name = Entry.symbolName();
1483 L.Address = 0;
1484 L.Size = 0;
1485 L.TypeChar = 'U';
1486 // There is no symbol in the nlist symbol table for this so we set
1487 // Sym effectivly to null and the rest of code in here must test for
1488 // it and not do things like Sym.getFlags() for it.
1489 L.Sym = BasicSymbolRef();
1490 L.SymFlags = SymbolRef::SF_Global | SymbolRef::SF_Undefined;
1491 L.NType = MachO::N_EXT | MachO::N_UNDF;
1492 L.NSect = 0;
1493 // The REFERENCE_FLAG_UNDEFINED_LAZY is no longer used but here it
1494 // makes sence since we are creating this from a lazy bind entry.
1495 L.NDesc = MachO::REFERENCE_FLAG_UNDEFINED_LAZY;
1496 MachO::SET_LIBRARY_ORDINAL(L.NDesc, Entry.ordinal());
1497 L.IndirectName = StringRef();
1498 SymbolList.push_back(L);
1499 LOS << Entry.symbolName();
1500 LOS << '\0';
1501 LazysAdded++;
1502 }
1503 }
1504 if (LErr)
1505 error(std::move(LErr), MachO->getFileName());
1506 // Set the symbol names and indirect names for the added symbols.
1507 if (LazysAdded) {
1508 LOS.flush();
1509 const char *Q = LazysNameBuffer.c_str();
1510 for (unsigned K = 0; K < LazysAdded; K++) {
1511 SymbolList[I].Name = Q;
1512 Q += strlen(Q) + 1;
1513 if (SymbolList[I].TypeChar == 'I') {
1514 SymbolList[I].IndirectName = Q;
1515 Q += strlen(Q) + 1;
1516 }
1517 I++;
1518 }
1519 }
1520
1521 // Add the undefineds symbol from the weak bind entries which are not
1522 // strong symbols.
1523 unsigned WeaksAdded = 0;
1524 Error WErr = Error::success();
1525 LastSymbolName = StringRef();
1526 for (const llvm::object::MachOBindEntry &Entry :
1527 MachO->weakBindTable(WErr)) {
1528 bool found = false;
1529 unsigned J = 0;
1530 if (LastSymbolName == Entry.symbolName() ||
1531 Entry.flags() & MachO::BIND_SYMBOL_FLAGS_NON_WEAK_DEFINITION) {
1532 found = true;
1533 } else {
1534 for (J = 0; J < SymbolList.size() && !found; ++J) {
1535 if (SymbolList[J].Name == Entry.symbolName()) {
1536 found = true;
1537 break;
1538 }
1539 }
1540 }
1541 if (!found) {
1542 LastSymbolName = Entry.symbolName();
1543 NMSymbol W;
Kevin Enderbya8c4c012017-06-20 00:41:04 +00001544 memset(&W, '\0', sizeof(NMSymbol));
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001545 W.Name = Entry.symbolName();
1546 W.Address = 0;
1547 W.Size = 0;
1548 W.TypeChar = 'U';
1549 // There is no symbol in the nlist symbol table for this so we set
1550 // Sym effectivly to null and the rest of code in here must test for
1551 // it and not do things like Sym.getFlags() for it.
1552 W.Sym = BasicSymbolRef();
1553 W.SymFlags = SymbolRef::SF_Global | SymbolRef::SF_Undefined;
1554 W.NType = MachO::N_EXT | MachO::N_UNDF;
1555 W.NSect = 0;
1556 // Odd that we are using N_WEAK_DEF on an undefined symbol but that is
1557 // what is created in this case by the linker when there are real
1558 // symbols in the nlist structs.
1559 W.NDesc = MachO::N_WEAK_DEF;
1560 W.IndirectName = StringRef();
1561 SymbolList.push_back(W);
1562 WOS << Entry.symbolName();
1563 WOS << '\0';
1564 WeaksAdded++;
1565 } else {
1566 // This is the case the symbol was previously been found and it could
1567 // have been added from a bind or lazy bind symbol. If so and not
1568 // a definition also mark it as weak.
1569 if (SymbolList[J].TypeChar == 'U')
1570 // See comment above about N_WEAK_DEF.
1571 SymbolList[J].NDesc |= MachO::N_WEAK_DEF;
1572 }
1573 }
1574 if (WErr)
1575 error(std::move(WErr), MachO->getFileName());
1576 // Set the symbol names and indirect names for the added symbols.
1577 if (WeaksAdded) {
1578 WOS.flush();
1579 const char *Q = WeaksNameBuffer.c_str();
1580 for (unsigned K = 0; K < WeaksAdded; K++) {
1581 SymbolList[I].Name = Q;
1582 Q += strlen(Q) + 1;
1583 if (SymbolList[I].TypeChar == 'I') {
1584 SymbolList[I].IndirectName = Q;
1585 Q += strlen(Q) + 1;
1586 }
1587 I++;
1588 }
1589 }
Kevin Enderbyd3cf76b2018-03-22 23:59:35 +00001590
Kevin Enderbyd9911f62018-03-29 20:04:29 +00001591 // Trying adding symbol from the function starts table and LC_MAIN entry
1592 // point.
Kevin Enderbyd3cf76b2018-03-22 23:59:35 +00001593 SmallVector<uint64_t, 8> FoundFns;
Kevin Enderby41293082018-03-29 20:49:24 +00001594 uint64_t lc_main_offset = UINT64_MAX;
Kevin Enderbyd3cf76b2018-03-22 23:59:35 +00001595 for (const auto &Command : MachO->load_commands()) {
1596 if (Command.C.cmd == MachO::LC_FUNCTION_STARTS) {
1597 // We found a function starts segment, parse the addresses for
1598 // consumption.
1599 MachO::linkedit_data_command LLC =
1600 MachO->getLinkeditDataLoadCommand(Command);
1601
1602 MachO->ReadULEB128s(LLC.dataoff, FoundFns);
Kevin Enderbyd9911f62018-03-29 20:04:29 +00001603 } else if (Command.C.cmd == MachO::LC_MAIN) {
1604 MachO::entry_point_command LCmain =
1605 MachO->getEntryPointCommand(Command);
1606 lc_main_offset = LCmain.entryoff;
Kevin Enderbyd3cf76b2018-03-22 23:59:35 +00001607 }
1608 }
1609 // See if these addresses are already in the symbol table.
1610 unsigned FunctionStartsAdded = 0;
1611 for (uint64_t f = 0; f < FoundFns.size(); f++) {
1612 bool found = false;
1613 for (unsigned J = 0; J < SymbolList.size() && !found; ++J) {
1614 if (SymbolList[J].Address == FoundFns[f] + BaseSegmentAddress)
1615 found = true;
1616 }
1617 // See this address is not already in the symbol table fake up an
1618 // nlist for it.
1619 if (!found) {
1620 NMSymbol F;
1621 memset(&F, '\0', sizeof(NMSymbol));
1622 F.Name = "<redacted function X>";
1623 F.Address = FoundFns[f] + BaseSegmentAddress;
1624 F.Size = 0;
1625 // There is no symbol in the nlist symbol table for this so we set
1626 // Sym effectivly to null and the rest of code in here must test for
1627 // it and not do things like Sym.getFlags() for it.
1628 F.Sym = BasicSymbolRef();
1629 F.SymFlags = 0;
1630 F.NType = MachO::N_SECT;
1631 F.NSect = 0;
1632 StringRef SegmentName = StringRef();
1633 StringRef SectionName = StringRef();
1634 for (const SectionRef &Section : MachO->sections()) {
1635 Section.getName(SectionName);
1636 SegmentName = MachO->getSectionFinalSegmentName(
1637 Section.getRawDataRefImpl());
1638 F.NSect++;
1639 if (F.Address >= Section.getAddress() &&
1640 F.Address < Section.getAddress() + Section.getSize()) {
1641 F.Section = Section;
1642 break;
1643 }
1644 }
1645 if (SegmentName == "__TEXT" && SectionName == "__text")
1646 F.TypeChar = 't';
1647 else if (SegmentName == "__DATA" && SectionName == "__data")
1648 F.TypeChar = 'd';
1649 else if (SegmentName == "__DATA" && SectionName == "__bss")
1650 F.TypeChar = 'b';
1651 else
1652 F.TypeChar = 's';
1653 F.NDesc = 0;
1654 F.IndirectName = StringRef();
1655 SymbolList.push_back(F);
Kevin Enderby41293082018-03-29 20:49:24 +00001656 if (FoundFns[f] == lc_main_offset)
Kevin Enderbyd9911f62018-03-29 20:04:29 +00001657 FOS << "<redacted LC_MAIN>";
1658 else
1659 FOS << "<redacted function " << f << ">";
Kevin Enderbyd3cf76b2018-03-22 23:59:35 +00001660 FOS << '\0';
1661 FunctionStartsAdded++;
1662 }
1663 }
1664 if (FunctionStartsAdded) {
1665 FOS.flush();
1666 const char *Q = FunctionStartsNameBuffer.c_str();
1667 for (unsigned K = 0; K < FunctionStartsAdded; K++) {
1668 SymbolList[I].Name = Q;
1669 Q += strlen(Q) + 1;
1670 if (SymbolList[I].TypeChar == 'I') {
1671 SymbolList[I].IndirectName = Q;
1672 Q += strlen(Q) + 1;
1673 }
1674 I++;
1675 }
1676 }
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001677 }
1678 }
1679
Rafael Espindolaceb23382014-07-31 21:00:10 +00001680 CurrentFilename = Obj.getFileName();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001681 sortAndPrintSymbolList(Obj, printName, ArchiveName, ArchitectureName);
Brian Gaeke0af759d2003-10-16 04:43:15 +00001682}
1683
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001684// checkMachOAndArchFlags() checks to see if the SymbolicFile is a Mach-O file
1685// and if it is and there is a list of architecture flags is specified then
1686// check to make sure this Mach-O file is one of those architectures or all
1687// architectures was specificed. If not then an error is generated and this
1688// routine returns false. Else it returns true.
1689static bool checkMachOAndArchFlags(SymbolicFile *O, std::string &Filename) {
David Majnemer91160d82016-10-31 17:11:31 +00001690 auto *MachO = dyn_cast<MachOObjectFile>(O);
David Blaikie328c0c12015-03-23 21:17:43 +00001691
David Majnemer91160d82016-10-31 17:11:31 +00001692 if (!MachO || ArchAll || ArchFlags.empty())
David Blaikie328c0c12015-03-23 21:17:43 +00001693 return true;
1694
1695 MachO::mach_header H;
1696 MachO::mach_header_64 H_64;
1697 Triple T;
Kevin Enderby31e85302017-01-25 21:33:38 +00001698 const char *McpuDefault, *ArchFlag;
David Blaikie328c0c12015-03-23 21:17:43 +00001699 if (MachO->is64Bit()) {
1700 H_64 = MachO->MachOObjectFile::getHeader64();
Kevin Enderby31e85302017-01-25 21:33:38 +00001701 T = MachOObjectFile::getArchTriple(H_64.cputype, H_64.cpusubtype,
1702 &McpuDefault, &ArchFlag);
David Blaikie328c0c12015-03-23 21:17:43 +00001703 } else {
1704 H = MachO->MachOObjectFile::getHeader();
Kevin Enderby31e85302017-01-25 21:33:38 +00001705 T = MachOObjectFile::getArchTriple(H.cputype, H.cpusubtype,
1706 &McpuDefault, &ArchFlag);
David Blaikie328c0c12015-03-23 21:17:43 +00001707 }
Kevin Enderby31e85302017-01-25 21:33:38 +00001708 const std::string ArchFlagName(ArchFlag);
David Majnemer91a02f52016-08-12 04:32:45 +00001709 if (none_of(ArchFlags, [&](const std::string &Name) {
Kevin Enderby31e85302017-01-25 21:33:38 +00001710 return Name == ArchFlagName;
David Majnemer91a02f52016-08-12 04:32:45 +00001711 })) {
David Blaikie328c0c12015-03-23 21:17:43 +00001712 error("No architecture specified", Filename);
1713 return false;
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001714 }
1715 return true;
1716}
1717
Rafael Espindola619581c2014-01-29 04:56:19 +00001718static void dumpSymbolNamesFromFile(std::string &Filename) {
Rafael Espindolaadf21f22014-07-06 17:43:13 +00001719 ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
1720 MemoryBuffer::getFileOrSTDIN(Filename);
1721 if (error(BufferOrErr.getError(), Filename))
Michael J. Spencerbc96f372011-12-13 23:17:29 +00001722 return;
1723
Mehdi Amini03b42e42016-04-14 21:59:01 +00001724 LLVMContext Context;
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +00001725 Expected<std::unique_ptr<Binary>> BinaryOrErr = createBinary(
Peter Collingbourne10039c02014-09-18 21:28:49 +00001726 BufferOrErr.get()->getMemBufferRef(), NoLLVMBitcode ? nullptr : &Context);
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +00001727 if (!BinaryOrErr) {
Kevin Enderby600fb3f2016-08-05 18:19:40 +00001728 error(BinaryOrErr.takeError(), Filename);
Rafael Espindolace82a072014-01-30 19:24:00 +00001729 return;
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +00001730 }
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001731 Binary &Bin = *BinaryOrErr.get();
Shankar Easwaran15b28be2012-11-13 18:38:42 +00001732
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001733 if (Archive *A = dyn_cast<Archive>(&Bin)) {
Rafael Espindolace82a072014-01-30 19:24:00 +00001734 if (ArchiveMap) {
Rafael Espindola0115b082014-01-30 21:51:42 +00001735 Archive::symbol_iterator I = A->symbol_begin();
1736 Archive::symbol_iterator E = A->symbol_end();
Rafael Espindolace82a072014-01-30 19:24:00 +00001737 if (I != E) {
Rafael Espindola0115b082014-01-30 21:51:42 +00001738 outs() << "Archive map\n";
Rafael Espindolace82a072014-01-30 19:24:00 +00001739 for (; I != E; ++I) {
Kevin Enderby27e85bd2016-08-03 21:57:47 +00001740 Expected<Archive::Child> C = I->getMember();
1741 if (!C)
1742 error(C.takeError(), Filename);
Kevin Enderbyf4586032016-07-29 17:44:13 +00001743 Expected<StringRef> FileNameOrErr = C->getName();
1744 if (!FileNameOrErr) {
1745 error(FileNameOrErr.takeError(), Filename);
Rafael Espindolace82a072014-01-30 19:24:00 +00001746 return;
Kevin Enderbyf4586032016-07-29 17:44:13 +00001747 }
Rafael Espindolaae460022014-06-16 16:08:36 +00001748 StringRef SymName = I->getName();
1749 outs() << SymName << " in " << FileNameOrErr.get() << "\n";
Michael J. Spencer2bc774a2011-09-27 19:37:18 +00001750 }
Rafael Espindolace82a072014-01-30 19:24:00 +00001751 outs() << "\n";
Michael J. Spencer2bc774a2011-09-27 19:37:18 +00001752 }
1753 }
Alexey Samsonove6388e62013-06-18 15:03:28 +00001754
Lang Hamesfc209622016-07-14 02:24:01 +00001755 {
Mehdi Amini41af4302016-11-11 04:28:40 +00001756 Error Err = Error::success();
Lang Hamesfc209622016-07-14 02:24:01 +00001757 for (auto &C : A->children(Err)) {
1758 Expected<std::unique_ptr<Binary>> ChildOrErr = C.getAsBinary(&Context);
1759 if (!ChildOrErr) {
1760 if (auto E = isNotObjectErrorInvalidFileType(ChildOrErr.takeError()))
1761 error(std::move(E), Filename, C);
1762 continue;
Lang Hamesae610ab2016-07-14 00:37:04 +00001763 }
Lang Hamesfc209622016-07-14 02:24:01 +00001764 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
Kevin Enderby31e85302017-01-25 21:33:38 +00001765 if (!MachOPrintSizeWarning && PrintSize && isa<MachOObjectFile>(O)) {
1766 errs() << ToolName << ": warning sizes with -print-size for Mach-O "
1767 "files are always zero.\n";
1768 MachOPrintSizeWarning = true;
1769 }
Lang Hamesfc209622016-07-14 02:24:01 +00001770 if (!checkMachOAndArchFlags(O, Filename))
1771 return;
1772 if (!PrintFileName) {
1773 outs() << "\n";
1774 if (isa<MachOObjectFile>(O)) {
1775 outs() << Filename << "(" << O->getFileName() << ")";
1776 } else
1777 outs() << O->getFileName();
1778 outs() << ":\n";
1779 }
1780 dumpSymbolNamesFromObject(*O, false, Filename);
1781 }
Lang Hamesae610ab2016-07-14 00:37:04 +00001782 }
Lang Hamesfc209622016-07-14 02:24:01 +00001783 if (Err)
1784 error(std::move(Err), A->getFileName());
Rafael Espindolace82a072014-01-30 19:24:00 +00001785 }
1786 return;
1787 }
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001788 if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(&Bin)) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001789 // If we have a list of architecture flags specified dump only those.
1790 if (!ArchAll && ArchFlags.size() != 0) {
1791 // Look for a slice in the universal binary that matches each ArchFlag.
1792 bool ArchFound;
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00001793 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001794 ArchFound = false;
1795 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1796 E = UB->end_objects();
1797 I != E; ++I) {
Kevin Enderby59343a92016-12-16 22:54:02 +00001798 if (ArchFlags[i] == I->getArchFlagName()) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001799 ArchFound = true;
Kevin Enderby9acb1092016-05-31 20:35:34 +00001800 Expected<std::unique_ptr<ObjectFile>> ObjOrErr =
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00001801 I->getAsObjectFile();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001802 std::string ArchiveName;
1803 std::string ArchitectureName;
1804 ArchiveName.clear();
1805 ArchitectureName.clear();
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001806 if (ObjOrErr) {
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001807 ObjectFile &Obj = *ObjOrErr.get();
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001808 if (ArchFlags.size() > 1) {
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001809 if (PrintFileName)
Kevin Enderby59343a92016-12-16 22:54:02 +00001810 ArchitectureName = I->getArchFlagName();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001811 else
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001812 outs() << "\n" << Obj.getFileName() << " (for architecture "
Kevin Enderby59343a92016-12-16 22:54:02 +00001813 << I->getArchFlagName() << ")"
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001814 << ":\n";
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001815 }
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001816 dumpSymbolNamesFromObject(Obj, false, ArchiveName,
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001817 ArchitectureName);
Kevin Enderby9acb1092016-05-31 20:35:34 +00001818 } else if (auto E = isNotObjectErrorInvalidFileType(
1819 ObjOrErr.takeError())) {
1820 error(std::move(E), Filename, ArchFlags.size() > 1 ?
Kevin Enderby59343a92016-12-16 22:54:02 +00001821 StringRef(I->getArchFlagName()) : StringRef());
Kevin Enderby9acb1092016-05-31 20:35:34 +00001822 continue;
Kevin Enderby42398052016-06-28 23:16:13 +00001823 } else if (Expected<std::unique_ptr<Archive>> AOrErr =
Rafael Espindola0bfe8282014-12-09 21:05:36 +00001824 I->getAsArchive()) {
1825 std::unique_ptr<Archive> &A = *AOrErr;
Mehdi Amini41af4302016-11-11 04:28:40 +00001826 Error Err = Error::success();
Lang Hamesfc209622016-07-14 02:24:01 +00001827 for (auto &C : A->children(Err)) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001828 Expected<std::unique_ptr<Binary>> ChildOrErr =
Kevin Enderby7a969422015-11-05 19:24:56 +00001829 C.getAsBinary(&Context);
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001830 if (!ChildOrErr) {
1831 if (auto E = isNotObjectErrorInvalidFileType(
Kevin Enderby9acb1092016-05-31 20:35:34 +00001832 ChildOrErr.takeError())) {
1833 error(std::move(E), Filename, C, ArchFlags.size() > 1 ?
Kevin Enderby59343a92016-12-16 22:54:02 +00001834 StringRef(I->getArchFlagName()) : StringRef());
Kevin Enderby9acb1092016-05-31 20:35:34 +00001835 }
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001836 continue;
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001837 }
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00001838 if (SymbolicFile *O =
1839 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001840 if (PrintFileName) {
1841 ArchiveName = A->getFileName();
1842 if (ArchFlags.size() > 1)
Kevin Enderby59343a92016-12-16 22:54:02 +00001843 ArchitectureName = I->getArchFlagName();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001844 } else {
1845 outs() << "\n" << A->getFileName();
1846 outs() << "(" << O->getFileName() << ")";
1847 if (ArchFlags.size() > 1) {
Kevin Enderby59343a92016-12-16 22:54:02 +00001848 outs() << " (for architecture " << I->getArchFlagName()
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001849 << ")";
1850 }
1851 outs() << ":\n";
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001852 }
Rafael Espindolaceb23382014-07-31 21:00:10 +00001853 dumpSymbolNamesFromObject(*O, false, ArchiveName,
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001854 ArchitectureName);
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001855 }
1856 }
Lang Hamesfc209622016-07-14 02:24:01 +00001857 if (Err)
1858 error(std::move(Err), A->getFileName());
Kevin Enderby42398052016-06-28 23:16:13 +00001859 } else {
1860 consumeError(AOrErr.takeError());
1861 error(Filename + " for architecture " +
Kevin Enderby59343a92016-12-16 22:54:02 +00001862 StringRef(I->getArchFlagName()) +
Kevin Enderby42398052016-06-28 23:16:13 +00001863 " is not a Mach-O file or an archive file",
1864 "Mach-O universal file");
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001865 }
1866 }
1867 }
1868 if (!ArchFound) {
1869 error(ArchFlags[i],
1870 "file: " + Filename + " does not contain architecture");
1871 return;
1872 }
1873 }
1874 return;
1875 }
1876 // No architecture flags were specified so if this contains a slice that
1877 // matches the host architecture dump only that.
1878 if (!ArchAll) {
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00001879 StringRef HostArchName = MachOObjectFile::getHostArch().getArchName();
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001880 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1881 E = UB->end_objects();
1882 I != E; ++I) {
Kevin Enderby59343a92016-12-16 22:54:02 +00001883 if (HostArchName == I->getArchFlagName()) {
Kevin Enderby9acb1092016-05-31 20:35:34 +00001884 Expected<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001885 std::string ArchiveName;
1886 ArchiveName.clear();
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001887 if (ObjOrErr) {
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001888 ObjectFile &Obj = *ObjOrErr.get();
1889 dumpSymbolNamesFromObject(Obj, false);
Kevin Enderby9acb1092016-05-31 20:35:34 +00001890 } else if (auto E = isNotObjectErrorInvalidFileType(
1891 ObjOrErr.takeError())) {
1892 error(std::move(E), Filename);
1893 return;
Kevin Enderby42398052016-06-28 23:16:13 +00001894 } else if (Expected<std::unique_ptr<Archive>> AOrErr =
Rafael Espindola0bfe8282014-12-09 21:05:36 +00001895 I->getAsArchive()) {
1896 std::unique_ptr<Archive> &A = *AOrErr;
Mehdi Amini41af4302016-11-11 04:28:40 +00001897 Error Err = Error::success();
Lang Hamesfc209622016-07-14 02:24:01 +00001898 for (auto &C : A->children(Err)) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001899 Expected<std::unique_ptr<Binary>> ChildOrErr =
Kevin Enderby7a969422015-11-05 19:24:56 +00001900 C.getAsBinary(&Context);
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001901 if (!ChildOrErr) {
1902 if (auto E = isNotObjectErrorInvalidFileType(
1903 ChildOrErr.takeError()))
1904 error(std::move(E), Filename, C);
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001905 continue;
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001906 }
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00001907 if (SymbolicFile *O =
1908 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001909 if (PrintFileName)
1910 ArchiveName = A->getFileName();
1911 else
1912 outs() << "\n" << A->getFileName() << "(" << O->getFileName()
1913 << ")"
1914 << ":\n";
Rafael Espindolaceb23382014-07-31 21:00:10 +00001915 dumpSymbolNamesFromObject(*O, false, ArchiveName);
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001916 }
1917 }
Lang Hamesfc209622016-07-14 02:24:01 +00001918 if (Err)
1919 error(std::move(Err), A->getFileName());
Kevin Enderby42398052016-06-28 23:16:13 +00001920 } else {
1921 consumeError(AOrErr.takeError());
1922 error(Filename + " for architecture " +
Kevin Enderby59343a92016-12-16 22:54:02 +00001923 StringRef(I->getArchFlagName()) +
Kevin Enderby42398052016-06-28 23:16:13 +00001924 " is not a Mach-O file or an archive file",
1925 "Mach-O universal file");
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001926 }
1927 return;
1928 }
1929 }
1930 }
1931 // Either all architectures have been specified or none have been specified
1932 // and this does not contain the host architecture so dump all the slices.
Kevin Enderby1983fcf2014-06-19 22:03:18 +00001933 bool moreThanOneArch = UB->getNumberOfObjects() > 1;
Rafael Espindola0115b082014-01-30 21:51:42 +00001934 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1935 E = UB->end_objects();
Alexey Samsonove6388e62013-06-18 15:03:28 +00001936 I != E; ++I) {
Kevin Enderby9acb1092016-05-31 20:35:34 +00001937 Expected<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001938 std::string ArchiveName;
1939 std::string ArchitectureName;
1940 ArchiveName.clear();
1941 ArchitectureName.clear();
Rafael Espindola4f7932b2014-06-23 20:41:02 +00001942 if (ObjOrErr) {
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001943 ObjectFile &Obj = *ObjOrErr.get();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001944 if (PrintFileName) {
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001945 if (isa<MachOObjectFile>(Obj) && moreThanOneArch)
Kevin Enderby59343a92016-12-16 22:54:02 +00001946 ArchitectureName = I->getArchFlagName();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001947 } else {
1948 if (moreThanOneArch)
1949 outs() << "\n";
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001950 outs() << Obj.getFileName();
1951 if (isa<MachOObjectFile>(Obj) && moreThanOneArch)
Kevin Enderby59343a92016-12-16 22:54:02 +00001952 outs() << " (for architecture " << I->getArchFlagName() << ")";
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001953 outs() << ":\n";
1954 }
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001955 dumpSymbolNamesFromObject(Obj, false, ArchiveName, ArchitectureName);
Kevin Enderby9acb1092016-05-31 20:35:34 +00001956 } else if (auto E = isNotObjectErrorInvalidFileType(
1957 ObjOrErr.takeError())) {
1958 error(std::move(E), Filename, moreThanOneArch ?
Kevin Enderby59343a92016-12-16 22:54:02 +00001959 StringRef(I->getArchFlagName()) : StringRef());
Kevin Enderby9acb1092016-05-31 20:35:34 +00001960 continue;
Kevin Enderby42398052016-06-28 23:16:13 +00001961 } else if (Expected<std::unique_ptr<Archive>> AOrErr =
1962 I->getAsArchive()) {
Rafael Espindola0bfe8282014-12-09 21:05:36 +00001963 std::unique_ptr<Archive> &A = *AOrErr;
Mehdi Amini41af4302016-11-11 04:28:40 +00001964 Error Err = Error::success();
Lang Hamesfc209622016-07-14 02:24:01 +00001965 for (auto &C : A->children(Err)) {
Kevin Enderby9acb1092016-05-31 20:35:34 +00001966 Expected<std::unique_ptr<Binary>> ChildOrErr =
1967 C.getAsBinary(&Context);
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001968 if (!ChildOrErr) {
1969 if (auto E = isNotObjectErrorInvalidFileType(
1970 ChildOrErr.takeError()))
Kevin Enderby9acb1092016-05-31 20:35:34 +00001971 error(std::move(E), Filename, C, moreThanOneArch ?
1972 StringRef(ArchitectureName) : StringRef());
Kevin Enderbye858a652014-05-14 21:18:50 +00001973 continue;
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001974 }
Rafael Espindolaae460022014-06-16 16:08:36 +00001975 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001976 if (PrintFileName) {
1977 ArchiveName = A->getFileName();
1978 if (isa<MachOObjectFile>(O) && moreThanOneArch)
Kevin Enderby59343a92016-12-16 22:54:02 +00001979 ArchitectureName = I->getArchFlagName();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001980 } else {
1981 outs() << "\n" << A->getFileName();
1982 if (isa<MachOObjectFile>(O)) {
1983 outs() << "(" << O->getFileName() << ")";
1984 if (moreThanOneArch)
Kevin Enderby59343a92016-12-16 22:54:02 +00001985 outs() << " (for architecture " << I->getArchFlagName()
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001986 << ")";
1987 } else
1988 outs() << ":" << O->getFileName();
1989 outs() << ":\n";
1990 }
Rafael Espindolaceb23382014-07-31 21:00:10 +00001991 dumpSymbolNamesFromObject(*O, false, ArchiveName, ArchitectureName);
Kevin Enderbye858a652014-05-14 21:18:50 +00001992 }
1993 }
Lang Hamesfc209622016-07-14 02:24:01 +00001994 if (Err)
1995 error(std::move(Err), A->getFileName());
Kevin Enderby42398052016-06-28 23:16:13 +00001996 } else {
1997 consumeError(AOrErr.takeError());
1998 error(Filename + " for architecture " +
Kevin Enderby59343a92016-12-16 22:54:02 +00001999 StringRef(I->getArchFlagName()) +
Kevin Enderby42398052016-06-28 23:16:13 +00002000 " is not a Mach-O file or an archive file",
2001 "Mach-O universal file");
Kevin Enderbye858a652014-05-14 21:18:50 +00002002 }
Alexey Samsonove6388e62013-06-18 15:03:28 +00002003 }
Brian Gaeke618026a2003-11-19 21:57:30 +00002004 return;
Brian Gaeke0af759d2003-10-16 04:43:15 +00002005 }
Rafael Espindola3f6481d2014-08-01 14:31:55 +00002006 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&Bin)) {
Kevin Enderby31e85302017-01-25 21:33:38 +00002007 if (!MachOPrintSizeWarning && PrintSize && isa<MachOObjectFile>(O)) {
2008 errs() << ToolName << ": warning sizes with -print-size for Mach-O files "
2009 "are always zero.\n";
2010 MachOPrintSizeWarning = true;
2011 }
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00002012 if (!checkMachOAndArchFlags(O, Filename))
2013 return;
Rafael Espindolaceb23382014-07-31 21:00:10 +00002014 dumpSymbolNamesFromObject(*O, true);
Rafael Espindolace82a072014-01-30 19:24:00 +00002015 }
Brian Gaeke0af759d2003-10-16 04:43:15 +00002016}
2017
2018int main(int argc, char **argv) {
Chris Lattnere3fc2d12009-03-06 05:34:10 +00002019 // Print a stack trace if we signal out.
Richard Smith2ad6d482016-06-09 00:53:21 +00002020 sys::PrintStackTraceOnErrorSignal(argv[0]);
Chris Lattnere3fc2d12009-03-06 05:34:10 +00002021 PrettyStackTraceProgram X(argc, argv);
Michael J. Spencer618d2192010-08-31 06:36:46 +00002022
Rafael Espindola619581c2014-01-29 04:56:19 +00002023 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
Chris Lattnere3fc2d12009-03-06 05:34:10 +00002024 cl::ParseCommandLineOptions(argc, argv, "llvm symbol table dumper\n");
Chris Lattner12439ff2004-02-19 20:32:12 +00002025
Michael J. Spencerbc96f372011-12-13 23:17:29 +00002026 // llvm-nm only reads binary files.
Rafael Espindolacb2eca02013-06-12 20:58:35 +00002027 if (error(sys::ChangeStdinToBinary()))
Michael J. Spencerbc96f372011-12-13 23:17:29 +00002028 return 1;
2029
Davide Italiano63634cb2016-01-29 23:38:05 +00002030 // These calls are needed so that we can read bitcode correctly.
Rafael Espindola13b69d62014-07-03 18:59:23 +00002031 llvm::InitializeAllTargetInfos();
2032 llvm::InitializeAllTargetMCs();
2033 llvm::InitializeAllAsmParsers();
2034
Chris Lattneref8f3892007-05-06 05:36:18 +00002035 ToolName = argv[0];
Rafael Espindola619581c2014-01-29 04:56:19 +00002036 if (BSDFormat)
2037 OutputFormat = bsd;
2038 if (POSIXFormat)
2039 OutputFormat = posix;
Kevin Enderby14a96ac2014-06-20 00:04:16 +00002040 if (DarwinFormat)
2041 OutputFormat = darwin;
Chris Lattner4aae1f42003-10-16 18:45:23 +00002042
Michael J. Spencerb8672a52011-01-20 06:38:57 +00002043 // The relative order of these is important. If you pass --size-sort it should
2044 // only print out the size. However, if you pass -S --size-sort, it should
Rafael Espindolab4865d62014-04-03 00:19:35 +00002045 // print out both the size and address.
Rafael Espindola619581c2014-01-29 04:56:19 +00002046 if (SizeSort && !PrintSize)
Rafael Espindolab4865d62014-04-03 00:19:35 +00002047 PrintAddress = false;
Rafael Espindola619581c2014-01-29 04:56:19 +00002048 if (OutputFormat == sysv || SizeSort)
2049 PrintSize = true;
Davide Italianoda570132016-02-05 22:10:42 +00002050 if (InputFilenames.empty())
Kevin Enderby4fc2edb2014-06-23 20:27:53 +00002051 InputFilenames.push_back("a.out");
Davide Italianod5353652016-02-05 22:07:09 +00002052 if (InputFilenames.size() > 1)
Rafael Espindola619581c2014-01-29 04:56:19 +00002053 MultipleFiles = true;
Chris Lattneref8f3892007-05-06 05:36:18 +00002054
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00002055 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00002056 if (ArchFlags[i] == "all") {
2057 ArchAll = true;
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00002058 } else {
Rafael Espindola72318b42014-08-08 16:30:17 +00002059 if (!MachOObjectFile::isValidArch(ArchFlags[i]))
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00002060 error("Unknown architecture named '" + ArchFlags[i] + "'",
2061 "for the -arch option");
2062 }
2063 }
2064
Kevin Enderbyfe6ad972014-07-11 20:30:00 +00002065 if (SegSect.size() != 0 && SegSect.size() != 2)
2066 error("bad number of arguments (must be two arguments)",
2067 "for the -s option");
2068
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00002069 if (NoDyldInfo && (AddDyldInfo || DyldInfoOnly))
2070 error("-no-dyldinfo can't be used with -add-dyldinfo or -dyldinfo-only");
2071
Aaron Ballmanecf0e952017-11-03 20:01:25 +00002072 llvm::for_each(InputFilenames, dumpSymbolNamesFromFile);
Rafael Espindola8b82a4d2013-07-03 15:46:03 +00002073
2074 if (HadError)
2075 return 1;
Brian Gaeke0af759d2003-10-16 04:43:15 +00002076}