blob: 7dacbb45eb07237d1709ac2462f1b4b967bb2551 [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"
Rui Ueyama197194b2018-04-13 18:26:06 +000036#include "llvm/Support/InitLLVM.h"
Chris Lattneref8f3892007-05-06 05:36:18 +000037#include "llvm/Support/MemoryBuffer.h"
Michael J. Spencerbc96f372011-12-13 23:17:29 +000038#include "llvm/Support/Program.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000039#include "llvm/Support/Signals.h"
Rafael Espindola13b69d62014-07-03 18:59:23 +000040#include "llvm/Support/TargetSelect.h"
Chandler Carruthd9903882015-01-14 11:23:27 +000041#include "llvm/Support/raw_ostream.h"
Michael J. Spencerb8672a52011-01-20 06:38:57 +000042#include <vector>
Hans Wennborg083ca9b2015-10-06 23:24:35 +000043
Brian Gaeke960707c2003-11-11 22:41:34 +000044using namespace llvm;
Michael J. Spencerb8672a52011-01-20 06:38:57 +000045using namespace object;
Brian Gaeke960707c2003-11-11 22:41:34 +000046
Brian Gaeke0af759d2003-10-16 04:43:15 +000047namespace {
Kevin Enderby980b2582014-06-05 21:21:57 +000048enum OutputFormatTy { bsd, sysv, posix, darwin };
Rafael Espindola619581c2014-01-29 04:56:19 +000049cl::opt<OutputFormatTy> OutputFormat(
50 "format", cl::desc("Specify output format"),
51 cl::values(clEnumVal(bsd, "BSD format"), clEnumVal(sysv, "System V format"),
Kevin Enderby980b2582014-06-05 21:21:57 +000052 clEnumVal(posix, "POSIX.2 format"),
Mehdi Amini732afdd2016-10-08 19:41:06 +000053 clEnumVal(darwin, "Darwin -m format")),
Rafael Espindola619581c2014-01-29 04:56:19 +000054 cl::init(bsd));
55cl::alias OutputFormat2("f", cl::desc("Alias for --format"),
56 cl::aliasopt(OutputFormat));
Brian Gaeke0af759d2003-10-16 04:43:15 +000057
Rafael Espindolaf12b8282014-02-21 20:10:59 +000058cl::list<std::string> InputFilenames(cl::Positional, cl::desc("<input files>"),
Rafael Espindola619581c2014-01-29 04:56:19 +000059 cl::ZeroOrMore);
Brian Gaeke0af759d2003-10-16 04:43:15 +000060
Rafael Espindola619581c2014-01-29 04:56:19 +000061cl::opt<bool> UndefinedOnly("undefined-only",
62 cl::desc("Show only undefined symbols"));
63cl::alias UndefinedOnly2("u", cl::desc("Alias for --undefined-only"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +000064 cl::aliasopt(UndefinedOnly), cl::Grouping);
Brian Gaeke0af759d2003-10-16 04:43:15 +000065
Rafael Espindola619581c2014-01-29 04:56:19 +000066cl::opt<bool> DynamicSyms("dynamic",
67 cl::desc("Display the dynamic symbols instead "
68 "of normal symbols."));
69cl::alias DynamicSyms2("D", cl::desc("Alias for --dynamic"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +000070 cl::aliasopt(DynamicSyms), cl::Grouping);
Michael J. Spencer8c4729f2012-02-28 00:40:37 +000071
Rafael Espindola619581c2014-01-29 04:56:19 +000072cl::opt<bool> DefinedOnly("defined-only",
73 cl::desc("Show only defined symbols"));
Kevin Enderbyacaaf902014-07-03 18:18:50 +000074cl::alias DefinedOnly2("U", cl::desc("Alias for --defined-only"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +000075 cl::aliasopt(DefinedOnly), cl::Grouping);
Brian Gaeke0af759d2003-10-16 04:43:15 +000076
Rafael Espindola619581c2014-01-29 04:56:19 +000077cl::opt<bool> ExternalOnly("extern-only",
Martin Storsjoc6320862017-11-03 07:18:21 +000078 cl::desc("Show only external symbols"),
79 cl::ZeroOrMore);
Rafael Espindola619581c2014-01-29 04:56:19 +000080cl::alias ExternalOnly2("g", cl::desc("Alias for --extern-only"),
Martin Storsjoc6320862017-11-03 07:18:21 +000081 cl::aliasopt(ExternalOnly), cl::Grouping,
82 cl::ZeroOrMore);
Brian Gaeke0af759d2003-10-16 04:43:15 +000083
Kevin Enderby9c8905c2015-11-02 23:42:05 +000084cl::opt<bool> BSDFormat("B", cl::desc("Alias for --format=bsd"),
85 cl::Grouping);
86cl::opt<bool> POSIXFormat("P", cl::desc("Alias for --format=posix"),
87 cl::Grouping);
88cl::opt<bool> DarwinFormat("m", cl::desc("Alias for --format=darwin"),
89 cl::Grouping);
Brian Gaeke0af759d2003-10-16 04:43:15 +000090
Kevin Enderby8f6dcf52014-07-01 22:44:51 +000091static cl::list<std::string>
Kevin Enderbybe84b292014-07-17 22:56:27 +000092 ArchFlags("arch", cl::desc("architecture(s) from a Mach-O file to dump"),
93 cl::ZeroOrMore);
Kevin Enderby4c8dfe42014-06-30 18:45:23 +000094bool ArchAll = false;
95
Rafael Espindola619581c2014-01-29 04:56:19 +000096cl::opt<bool> PrintFileName(
97 "print-file-name",
Michael J. Spencerb8672a52011-01-20 06:38:57 +000098 cl::desc("Precede each symbol with the object file it came from"));
99
Rafael Espindola619581c2014-01-29 04:56:19 +0000100cl::alias PrintFileNameA("A", cl::desc("Alias for --print-file-name"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000101 cl::aliasopt(PrintFileName), cl::Grouping);
Rafael Espindola619581c2014-01-29 04:56:19 +0000102cl::alias PrintFileNameo("o", cl::desc("Alias for --print-file-name"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000103 cl::aliasopt(PrintFileName), cl::Grouping);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000104
Rafael Espindola619581c2014-01-29 04:56:19 +0000105cl::opt<bool> DebugSyms("debug-syms",
106 cl::desc("Show all symbols, even debugger only"));
107cl::alias DebugSymsa("a", cl::desc("Alias for --debug-syms"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000108 cl::aliasopt(DebugSyms), cl::Grouping);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000109
Rafael Espindolab4865d62014-04-03 00:19:35 +0000110cl::opt<bool> NumericSort("numeric-sort", cl::desc("Sort symbols by address"));
Rafael Espindola619581c2014-01-29 04:56:19 +0000111cl::alias NumericSortn("n", cl::desc("Alias for --numeric-sort"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000112 cl::aliasopt(NumericSort), cl::Grouping);
Rafael Espindola619581c2014-01-29 04:56:19 +0000113cl::alias NumericSortv("v", cl::desc("Alias for --numeric-sort"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000114 cl::aliasopt(NumericSort), cl::Grouping);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000115
Rafael Espindola619581c2014-01-29 04:56:19 +0000116cl::opt<bool> NoSort("no-sort", cl::desc("Show symbols in order encountered"));
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000117cl::alias NoSortp("p", cl::desc("Alias for --no-sort"), cl::aliasopt(NoSort),
118 cl::Grouping);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000119
Sam Clegg531da002017-06-29 18:29:05 +0000120cl::opt<bool> Demangle("demangle", cl::desc("Demangle C++ symbol names"));
121cl::alias DemangleC("C", cl::desc("Alias for --demangle"), cl::aliasopt(Demangle),
122 cl::Grouping);
123
Kevin Enderby25a614b2014-07-02 23:23:58 +0000124cl::opt<bool> ReverseSort("reverse-sort", cl::desc("Sort in reverse order"));
125cl::alias ReverseSortr("r", cl::desc("Alias for --reverse-sort"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000126 cl::aliasopt(ReverseSort), cl::Grouping);
Kevin Enderby25a614b2014-07-02 23:23:58 +0000127
Rafael Espindola619581c2014-01-29 04:56:19 +0000128cl::opt<bool> PrintSize("print-size",
Rafael Espindolab4865d62014-04-03 00:19:35 +0000129 cl::desc("Show symbol size instead of address"));
Rafael Espindola619581c2014-01-29 04:56:19 +0000130cl::alias PrintSizeS("S", cl::desc("Alias for --print-size"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000131 cl::aliasopt(PrintSize), cl::Grouping);
Kevin Enderby31e85302017-01-25 21:33:38 +0000132bool MachOPrintSizeWarning = false;
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000133
Rafael Espindola619581c2014-01-29 04:56:19 +0000134cl::opt<bool> SizeSort("size-sort", cl::desc("Sort symbols by size"));
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000135
Rafael Espindola619581c2014-01-29 04:56:19 +0000136cl::opt<bool> WithoutAliases("without-aliases", cl::Hidden,
137 cl::desc("Exclude aliases from output"));
Jan Sjödin4d0c2992012-09-18 18:47:58 +0000138
Rafael Espindola619581c2014-01-29 04:56:19 +0000139cl::opt<bool> ArchiveMap("print-armap", cl::desc("Print the archive map"));
Kevin Enderby8da4bd62014-07-08 23:47:31 +0000140cl::alias ArchiveMaps("M", cl::desc("Alias for --print-armap"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000141 cl::aliasopt(ArchiveMap), cl::Grouping);
Kevin Enderby0fd8aac2014-07-03 21:51:07 +0000142
Hemant Kulkarni5e005a12016-02-10 17:51:39 +0000143enum Radix { d, o, x };
144cl::opt<Radix>
145 AddressRadix("radix", cl::desc("Radix (o/d/x) for printing symbol Values"),
146 cl::values(clEnumVal(d, "decimal"), clEnumVal(o, "octal"),
Mehdi Amini732afdd2016-10-08 19:41:06 +0000147 clEnumVal(x, "hexadecimal")),
Hemant Kulkarni5e005a12016-02-10 17:51:39 +0000148 cl::init(x));
149cl::alias RadixAlias("t", cl::desc("Alias for --radix"),
150 cl::aliasopt(AddressRadix));
151
Kevin Enderby0fd8aac2014-07-03 21:51:07 +0000152cl::opt<bool> JustSymbolName("just-symbol-name",
153 cl::desc("Print just the symbol's name"));
154cl::alias JustSymbolNames("j", cl::desc("Alias for --just-symbol-name"),
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000155 cl::aliasopt(JustSymbolName), cl::Grouping);
Kevin Enderbyfe6ad972014-07-11 20:30:00 +0000156
157// FIXME: This option takes exactly two strings and should be allowed anywhere
158// on the command line. Such that "llvm-nm -s __TEXT __text foo.o" would work.
159// But that does not as the CommandLine Library does not have a way to make
160// this work. For now the "-s __TEXT __text" has to be last on the command
161// line.
162cl::list<std::string> SegSect("s", cl::Positional, cl::ZeroOrMore,
163 cl::desc("Dump only symbols from this segment "
Davide Italiano98be3f22016-03-02 22:33:49 +0000164 "and section name, Mach-O only"));
Kevin Enderbyfe6ad972014-07-11 20:30:00 +0000165
Kevin Enderby77b968e2014-07-16 17:38:26 +0000166cl::opt<bool> FormatMachOasHex("x", cl::desc("Print symbol entry in hex, "
Kevin Enderby9c8905c2015-11-02 23:42:05 +0000167 "Mach-O only"), cl::Grouping);
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000168cl::opt<bool> AddDyldInfo("add-dyldinfo",
169 cl::desc("Add symbols from the dyldinfo not already "
170 "in the symbol table, Mach-O only"));
171cl::opt<bool> NoDyldInfo("no-dyldinfo",
172 cl::desc("Don't add any symbols from the dyldinfo, "
173 "Mach-O only"));
174cl::opt<bool> DyldInfoOnly("dyldinfo-only",
175 cl::desc("Show only symbols from the dyldinfo, "
176 "Mach-O only"));
Kevin Enderby77b968e2014-07-16 17:38:26 +0000177
Peter Collingbourne10039c02014-09-18 21:28:49 +0000178cl::opt<bool> NoLLVMBitcode("no-llvm-bc",
179 cl::desc("Disable LLVM bitcode reader"));
180
Rafael Espindolab4865d62014-04-03 00:19:35 +0000181bool PrintAddress = true;
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000182
Rafael Espindola619581c2014-01-29 04:56:19 +0000183bool MultipleFiles = false;
Brian Gaeke0af759d2003-10-16 04:43:15 +0000184
Rafael Espindola619581c2014-01-29 04:56:19 +0000185bool HadError = false;
Rafael Espindola8b82a4d2013-07-03 15:46:03 +0000186
Rafael Espindola619581c2014-01-29 04:56:19 +0000187std::string ToolName;
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000188} // anonymous namespace
Brian Gaeke0af759d2003-10-16 04:43:15 +0000189
Zachary Turner41a9ee92017-10-11 23:54:34 +0000190static void error(Twine Message, Twine Path = Twine()) {
Rafael Espindola619581c2014-01-29 04:56:19 +0000191 HadError = true;
192 errs() << ToolName << ": " << Path << ": " << Message << ".\n";
Michael J. Spencerbc96f372011-12-13 23:17:29 +0000193}
194
Zachary Turner41a9ee92017-10-11 23:54:34 +0000195static bool error(std::error_code EC, Twine Path = Twine()) {
Rafael Espindola619581c2014-01-29 04:56:19 +0000196 if (EC) {
197 error(EC.message(), Path);
Michael J. Spencerbc96f372011-12-13 23:17:29 +0000198 return true;
199 }
200 return false;
201}
202
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000203// This version of error() prints the archive name and member name, for example:
204// "libx.a(foo.o)" after the ToolName before the error message. It sets
205// HadError but returns allowing the code to move on to other archive members.
Kevin Enderby9acb1092016-05-31 20:35:34 +0000206static void error(llvm::Error E, StringRef FileName, const Archive::Child &C,
207 StringRef ArchitectureName = StringRef()) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000208 HadError = true;
209 errs() << ToolName << ": " << FileName;
210
Kevin Enderbyf4586032016-07-29 17:44:13 +0000211 Expected<StringRef> NameOrErr = C.getName();
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000212 // TODO: if we have a error getting the name then it would be nice to print
213 // the index of which archive member this is and or its offset in the
214 // archive instead of "???" as the name.
Kevin Enderbyf4586032016-07-29 17:44:13 +0000215 if (!NameOrErr) {
216 consumeError(NameOrErr.takeError());
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000217 errs() << "(" << "???" << ")";
Kevin Enderbyf4586032016-07-29 17:44:13 +0000218 } else
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000219 errs() << "(" << NameOrErr.get() << ")";
220
Kevin Enderby9acb1092016-05-31 20:35:34 +0000221 if (!ArchitectureName.empty())
222 errs() << " (for architecture " << ArchitectureName << ") ";
223
224 std::string Buf;
225 raw_string_ostream OS(Buf);
226 logAllUnhandledErrors(std::move(E), OS, "");
227 OS.flush();
228 errs() << " " << Buf << "\n";
229}
230
231// This version of error() prints the file name and which architecture slice it
232// is from, for example: "foo.o (for architecture i386)" after the ToolName
233// before the error message. It sets HadError but returns allowing the code to
234// move on to other architecture slices.
235static void error(llvm::Error E, StringRef FileName,
236 StringRef ArchitectureName = StringRef()) {
237 HadError = true;
238 errs() << ToolName << ": " << FileName;
239
240 if (!ArchitectureName.empty())
241 errs() << " (for architecture " << ArchitectureName << ") ";
242
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000243 std::string Buf;
244 raw_string_ostream OS(Buf);
245 logAllUnhandledErrors(std::move(E), OS, "");
246 OS.flush();
247 errs() << " " << Buf << "\n";
248}
249
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000250namespace {
Rafael Espindola619581c2014-01-29 04:56:19 +0000251struct NMSymbol {
Rafael Espindolab4865d62014-04-03 00:19:35 +0000252 uint64_t Address;
Rafael Espindola619581c2014-01-29 04:56:19 +0000253 uint64_t Size;
254 char TypeChar;
255 StringRef Name;
Rafael Espindola2d5d23d2015-07-06 21:36:23 +0000256 BasicSymbolRef Sym;
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000257 // The Sym field above points to the native symbol in the object file,
258 // for Mach-O when we are creating symbols from the dyld info the above
259 // pointer is null as there is no native symbol. In these cases the fields
260 // below are filled in to represent what would have been a Mach-O nlist
261 // native symbol.
262 uint32_t SymFlags;
263 SectionRef Section;
264 uint8_t NType;
265 uint8_t NSect;
266 uint16_t NDesc;
267 StringRef IndirectName;
Rafael Espindola619581c2014-01-29 04:56:19 +0000268};
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000269} // anonymous namespace
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000270
Rafael Espindolab4865d62014-04-03 00:19:35 +0000271static bool compareSymbolAddress(const NMSymbol &A, const NMSymbol &B) {
Kevin Enderbyd3cf76b2018-03-22 23:59:35 +0000272 bool ADefined;
273 if (A.Sym.getRawDataRefImpl().p)
274 ADefined = !(A.Sym.getFlags() & SymbolRef::SF_Undefined);
275 else
276 ADefined = A.TypeChar != 'U';
277 bool BDefined;
278 if (B.Sym.getRawDataRefImpl().p)
279 BDefined = !(B.Sym.getFlags() & SymbolRef::SF_Undefined);
280 else
281 BDefined = B.TypeChar != 'U';
Rafael Espindola45592c62015-07-13 22:01:02 +0000282 return std::make_tuple(ADefined, A.Address, A.Name, A.Size) <
283 std::make_tuple(BDefined, B.Address, B.Name, B.Size);
Rafael Espindola619581c2014-01-29 04:56:19 +0000284}
285
286static bool compareSymbolSize(const NMSymbol &A, const NMSymbol &B) {
Rafael Espindola45592c62015-07-13 22:01:02 +0000287 return std::make_tuple(A.Size, A.Name, A.Address) <
288 std::make_tuple(B.Size, B.Name, B.Address);
Rafael Espindola619581c2014-01-29 04:56:19 +0000289}
290
291static bool compareSymbolName(const NMSymbol &A, const NMSymbol &B) {
Rafael Espindola45592c62015-07-13 22:01:02 +0000292 return std::make_tuple(A.Name, A.Size, A.Address) <
293 std::make_tuple(B.Name, B.Size, B.Address);
Rafael Espindola619581c2014-01-29 04:56:19 +0000294}
295
Rafael Espindolaceb23382014-07-31 21:00:10 +0000296static char isSymbolList64Bit(SymbolicFile &Obj) {
Peter Collingbournedebb6f62016-11-24 01:13:09 +0000297 if (auto *IRObj = dyn_cast<IRObjectFile>(&Obj))
298 return Triple(IRObj->getTargetTriple()).isArch64Bit();
Rafael Espindola8b781852017-05-24 23:40:36 +0000299 if (isa<COFFObjectFile>(Obj) || isa<COFFImportFile>(Obj))
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000300 return false;
Sam Clegg135a4b82017-04-14 19:50:44 +0000301 if (isa<WasmObjectFile>(Obj))
302 return false;
David Blaikie328c0c12015-03-23 21:17:43 +0000303 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj))
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000304 return MachO->is64Bit();
Rafael Espindola034a4c382015-06-26 14:11:54 +0000305 return cast<ELFObjectFileBase>(Obj).getBytesInAddress() == 8;
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000306}
307
Rafael Espindola619581c2014-01-29 04:56:19 +0000308static StringRef CurrentFilename;
309typedef std::vector<NMSymbol> SymbolListT;
310static SymbolListT SymbolList;
311
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000312static char getSymbolNMTypeChar(IRObjectFile &Obj, basic_symbol_iterator I);
313
Kevin Enderby980b2582014-06-05 21:21:57 +0000314// darwinPrintSymbol() is used to print a symbol from a Mach-O file when the
Kevin Enderby77b968e2014-07-16 17:38:26 +0000315// the OutputFormat is darwin or we are printing Mach-O symbols in hex. For
316// the darwin format it produces the same output as darwin's nm(1) -m output
317// and when printing Mach-O symbols in hex it produces the same output as
318// darwin's nm(1) -x format.
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000319static void darwinPrintSymbol(SymbolicFile &Obj, SymbolListT::iterator I,
320 char *SymbolAddrStr, const char *printBlanks,
321 const char *printDashes, const char *printFormat) {
Kevin Enderby980b2582014-06-05 21:21:57 +0000322 MachO::mach_header H;
323 MachO::mach_header_64 H_64;
Reid Kleckner3afb80e2015-11-19 00:51:50 +0000324 uint32_t Filetype = MachO::MH_OBJECT;
325 uint32_t Flags = 0;
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000326 uint8_t NType = 0;
327 uint8_t NSect = 0;
328 uint16_t NDesc = 0;
329 uint32_t NStrx = 0;
330 uint64_t NValue = 0;
331 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
332 if (Obj.isIR()) {
333 uint32_t SymFlags = I->Sym.getFlags();
334 if (SymFlags & SymbolRef::SF_Global)
335 NType |= MachO::N_EXT;
336 if (SymFlags & SymbolRef::SF_Hidden)
337 NType |= MachO::N_PEXT;
338 if (SymFlags & SymbolRef::SF_Undefined)
339 NType |= MachO::N_EXT | MachO::N_UNDF;
340 else {
341 // Here we have a symbol definition. So to fake out a section name we
342 // use 1, 2 and 3 for section numbers. See below where they are used to
343 // print out fake section names.
344 NType |= MachO::N_SECT;
Davide Italianod4a48532016-02-01 19:22:16 +0000345 if (SymFlags & SymbolRef::SF_Const)
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000346 NSect = 3;
Peter Collingbournee2f1b4a2016-12-01 06:53:47 +0000347 else if (SymFlags & SymbolRef::SF_Executable)
348 NSect = 1;
349 else
350 NSect = 2;
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000351 }
352 if (SymFlags & SymbolRef::SF_Weak)
353 NDesc |= MachO::N_WEAK_DEF;
Kevin Enderby980b2582014-06-05 21:21:57 +0000354 } else {
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000355 DataRefImpl SymDRI = I->Sym.getRawDataRefImpl();
356 if (MachO->is64Bit()) {
357 H_64 = MachO->MachOObjectFile::getHeader64();
358 Filetype = H_64.filetype;
359 Flags = H_64.flags;
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000360 if (SymDRI.p){
361 MachO::nlist_64 STE_64 = MachO->getSymbol64TableEntry(SymDRI);
362 NType = STE_64.n_type;
363 NSect = STE_64.n_sect;
364 NDesc = STE_64.n_desc;
365 NStrx = STE_64.n_strx;
366 NValue = STE_64.n_value;
367 } else {
368 NType = I->NType;
369 NSect = I->NSect;
370 NDesc = I->NDesc;
371 NStrx = 0;
372 NValue = I->Address;
373 }
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000374 } else {
375 H = MachO->MachOObjectFile::getHeader();
376 Filetype = H.filetype;
377 Flags = H.flags;
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000378 if (SymDRI.p){
379 MachO::nlist STE = MachO->getSymbolTableEntry(SymDRI);
380 NType = STE.n_type;
381 NSect = STE.n_sect;
382 NDesc = STE.n_desc;
383 NStrx = STE.n_strx;
384 NValue = STE.n_value;
385 } else {
386 NType = I->NType;
387 NSect = I->NSect;
388 NDesc = I->NDesc;
389 NStrx = 0;
390 NValue = I->Address;
391 }
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000392 }
Kevin Enderby980b2582014-06-05 21:21:57 +0000393 }
394
Kevin Enderby77b968e2014-07-16 17:38:26 +0000395 // If we are printing Mach-O symbols in hex do that and return.
396 if (FormatMachOasHex) {
397 char Str[18] = "";
Kevin Enderby77b968e2014-07-16 17:38:26 +0000398 format(printFormat, NValue).print(Str, sizeof(Str));
399 outs() << Str << ' ';
400 format("%02x", NType).print(Str, sizeof(Str));
401 outs() << Str << ' ';
402 format("%02x", NSect).print(Str, sizeof(Str));
403 outs() << Str << ' ';
404 format("%04x", NDesc).print(Str, sizeof(Str));
405 outs() << Str << ' ';
406 format("%08x", NStrx).print(Str, sizeof(Str));
407 outs() << Str << ' ';
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000408 outs() << I->Name;
409 if ((NType & MachO::N_TYPE) == MachO::N_INDR) {
410 outs() << " (indirect for ";
411 format(printFormat, NValue).print(Str, sizeof(Str));
412 outs() << Str << ' ';
413 StringRef IndirectName;
414 if (I->Sym.getRawDataRefImpl().p) {
415 if (MachO->getIndirectName(I->Sym.getRawDataRefImpl(), IndirectName))
416 outs() << "?)";
417 else
418 outs() << IndirectName << ")";
419 }
420 else
421 outs() << I->IndirectName << ")";
422 }
423 outs() << "\n";
Kevin Enderby77b968e2014-07-16 17:38:26 +0000424 return;
425 }
426
Kevin Enderby980b2582014-06-05 21:21:57 +0000427 if (PrintAddress) {
428 if ((NType & MachO::N_TYPE) == MachO::N_INDR)
429 strcpy(SymbolAddrStr, printBlanks);
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000430 if (Obj.isIR() && (NType & MachO::N_TYPE) == MachO::N_TYPE)
431 strcpy(SymbolAddrStr, printDashes);
Kevin Enderby980b2582014-06-05 21:21:57 +0000432 outs() << SymbolAddrStr << ' ';
433 }
434
435 switch (NType & MachO::N_TYPE) {
436 case MachO::N_UNDF:
437 if (NValue != 0) {
438 outs() << "(common) ";
439 if (MachO::GET_COMM_ALIGN(NDesc) != 0)
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000440 outs() << "(alignment 2^" << (int)MachO::GET_COMM_ALIGN(NDesc) << ") ";
Kevin Enderby980b2582014-06-05 21:21:57 +0000441 } else {
442 if ((NType & MachO::N_TYPE) == MachO::N_PBUD)
443 outs() << "(prebound ";
444 else
445 outs() << "(";
446 if ((NDesc & MachO::REFERENCE_TYPE) ==
447 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
448 outs() << "undefined [lazy bound]) ";
449 else if ((NDesc & MachO::REFERENCE_TYPE) ==
Hans Wennborgaebe45b2016-04-11 20:36:05 +0000450 MachO::REFERENCE_FLAG_PRIVATE_UNDEFINED_LAZY)
Kevin Enderby980b2582014-06-05 21:21:57 +0000451 outs() << "undefined [private lazy bound]) ";
452 else if ((NDesc & MachO::REFERENCE_TYPE) ==
453 MachO::REFERENCE_FLAG_PRIVATE_UNDEFINED_NON_LAZY)
454 outs() << "undefined [private]) ";
455 else
456 outs() << "undefined) ";
457 }
458 break;
459 case MachO::N_ABS:
460 outs() << "(absolute) ";
461 break;
462 case MachO::N_INDR:
463 outs() << "(indirect) ";
464 break;
465 case MachO::N_SECT: {
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000466 if (Obj.isIR()) {
467 // For llvm bitcode files print out a fake section name using the values
468 // use 1, 2 and 3 for section numbers as set above.
469 if (NSect == 1)
470 outs() << "(LTO,CODE) ";
471 else if (NSect == 2)
472 outs() << "(LTO,DATA) ";
473 else if (NSect == 3)
474 outs() << "(LTO,RODATA) ";
475 else
476 outs() << "(?,?) ";
477 break;
478 }
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000479 section_iterator Sec = SectionRef();
480 if (I->Sym.getRawDataRefImpl().p) {
481 Expected<section_iterator> SecOrErr =
482 MachO->getSymbolSection(I->Sym.getRawDataRefImpl());
483 if (!SecOrErr) {
484 consumeError(SecOrErr.takeError());
485 outs() << "(?,?) ";
486 break;
487 }
488 Sec = *SecOrErr;
Kevin Enderby44550602017-09-13 21:01:49 +0000489 if (Sec == MachO->section_end()) {
490 outs() << "(?,?) ";
491 break;
492 }
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000493 } else {
494 Sec = I->Section;
Kevin Enderby1f472ea2016-01-21 21:13:27 +0000495 }
Kevin Enderby980b2582014-06-05 21:21:57 +0000496 DataRefImpl Ref = Sec->getRawDataRefImpl();
497 StringRef SectionName;
498 MachO->getSectionName(Ref, SectionName);
499 StringRef SegmentName = MachO->getSectionFinalSegmentName(Ref);
500 outs() << "(" << SegmentName << "," << SectionName << ") ";
501 break;
502 }
503 default:
504 outs() << "(?) ";
505 break;
506 }
507
508 if (NType & MachO::N_EXT) {
509 if (NDesc & MachO::REFERENCED_DYNAMICALLY)
510 outs() << "[referenced dynamically] ";
511 if (NType & MachO::N_PEXT) {
512 if ((NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF)
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000513 outs() << "weak private external ";
Kevin Enderby980b2582014-06-05 21:21:57 +0000514 else
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000515 outs() << "private external ";
Kevin Enderby980b2582014-06-05 21:21:57 +0000516 } else {
517 if ((NDesc & MachO::N_WEAK_REF) == MachO::N_WEAK_REF ||
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000518 (NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF) {
Kevin Enderby980b2582014-06-05 21:21:57 +0000519 if ((NDesc & (MachO::N_WEAK_REF | MachO::N_WEAK_DEF)) ==
520 (MachO::N_WEAK_REF | MachO::N_WEAK_DEF))
521 outs() << "weak external automatically hidden ";
522 else
523 outs() << "weak external ";
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000524 } else
Kevin Enderby980b2582014-06-05 21:21:57 +0000525 outs() << "external ";
526 }
527 } else {
528 if (NType & MachO::N_PEXT)
529 outs() << "non-external (was a private external) ";
530 else
531 outs() << "non-external ";
532 }
533
534 if (Filetype == MachO::MH_OBJECT &&
535 (NDesc & MachO::N_NO_DEAD_STRIP) == MachO::N_NO_DEAD_STRIP)
536 outs() << "[no dead strip] ";
537
538 if (Filetype == MachO::MH_OBJECT &&
539 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
540 (NDesc & MachO::N_SYMBOL_RESOLVER) == MachO::N_SYMBOL_RESOLVER)
541 outs() << "[symbol resolver] ";
542
543 if (Filetype == MachO::MH_OBJECT &&
544 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
545 (NDesc & MachO::N_ALT_ENTRY) == MachO::N_ALT_ENTRY)
546 outs() << "[alt entry] ";
547
548 if ((NDesc & MachO::N_ARM_THUMB_DEF) == MachO::N_ARM_THUMB_DEF)
549 outs() << "[Thumb] ";
550
551 if ((NType & MachO::N_TYPE) == MachO::N_INDR) {
552 outs() << I->Name << " (for ";
553 StringRef IndirectName;
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000554 if (MachO) {
555 if (I->Sym.getRawDataRefImpl().p) {
556 if (MachO->getIndirectName(I->Sym.getRawDataRefImpl(), IndirectName))
557 outs() << "?)";
558 else
559 outs() << IndirectName << ")";
560 }
561 else
562 outs() << I->IndirectName << ")";
563 } else
Kevin Enderby980b2582014-06-05 21:21:57 +0000564 outs() << "?)";
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000565 } else
Kevin Enderby980b2582014-06-05 21:21:57 +0000566 outs() << I->Name;
567
568 if ((Flags & MachO::MH_TWOLEVEL) == MachO::MH_TWOLEVEL &&
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000569 (((NType & MachO::N_TYPE) == MachO::N_UNDF && NValue == 0) ||
Kevin Enderby980b2582014-06-05 21:21:57 +0000570 (NType & MachO::N_TYPE) == MachO::N_PBUD)) {
571 uint32_t LibraryOrdinal = MachO::GET_LIBRARY_ORDINAL(NDesc);
572 if (LibraryOrdinal != 0) {
573 if (LibraryOrdinal == MachO::EXECUTABLE_ORDINAL)
574 outs() << " (from executable)";
575 else if (LibraryOrdinal == MachO::DYNAMIC_LOOKUP_ORDINAL)
576 outs() << " (dynamically looked up)";
577 else {
578 StringRef LibraryName;
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000579 if (!MachO ||
580 MachO->getLibraryShortNameByIndex(LibraryOrdinal - 1, LibraryName))
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000581 outs() << " (from bad library ordinal " << LibraryOrdinal << ")";
Kevin Enderby980b2582014-06-05 21:21:57 +0000582 else
583 outs() << " (from " << LibraryName << ")";
584 }
585 }
586 }
587
588 outs() << "\n";
589}
590
Kevin Enderby407cc212014-07-17 22:47:16 +0000591// Table that maps Darwin's Mach-O stab constants to strings to allow printing.
592struct DarwinStabName {
593 uint8_t NType;
594 const char *Name;
595};
596static const struct DarwinStabName DarwinStabNames[] = {
597 {MachO::N_GSYM, "GSYM"},
598 {MachO::N_FNAME, "FNAME"},
599 {MachO::N_FUN, "FUN"},
600 {MachO::N_STSYM, "STSYM"},
601 {MachO::N_LCSYM, "LCSYM"},
602 {MachO::N_BNSYM, "BNSYM"},
603 {MachO::N_PC, "PC"},
604 {MachO::N_AST, "AST"},
605 {MachO::N_OPT, "OPT"},
606 {MachO::N_RSYM, "RSYM"},
607 {MachO::N_SLINE, "SLINE"},
608 {MachO::N_ENSYM, "ENSYM"},
609 {MachO::N_SSYM, "SSYM"},
610 {MachO::N_SO, "SO"},
611 {MachO::N_OSO, "OSO"},
612 {MachO::N_LSYM, "LSYM"},
613 {MachO::N_BINCL, "BINCL"},
614 {MachO::N_SOL, "SOL"},
615 {MachO::N_PARAMS, "PARAM"},
616 {MachO::N_VERSION, "VERS"},
617 {MachO::N_OLEVEL, "OLEV"},
618 {MachO::N_PSYM, "PSYM"},
619 {MachO::N_EINCL, "EINCL"},
620 {MachO::N_ENTRY, "ENTRY"},
621 {MachO::N_LBRAC, "LBRAC"},
622 {MachO::N_EXCL, "EXCL"},
623 {MachO::N_RBRAC, "RBRAC"},
624 {MachO::N_BCOMM, "BCOMM"},
625 {MachO::N_ECOMM, "ECOMM"},
626 {MachO::N_ECOML, "ECOML"},
627 {MachO::N_LENG, "LENG"},
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000628 {0, nullptr}};
629
Kevin Enderby407cc212014-07-17 22:47:16 +0000630static const char *getDarwinStabString(uint8_t NType) {
631 for (unsigned i = 0; DarwinStabNames[i].Name; i++) {
632 if (DarwinStabNames[i].NType == NType)
633 return DarwinStabNames[i].Name;
634 }
Hans Wennborg083ca9b2015-10-06 23:24:35 +0000635 return nullptr;
Kevin Enderby407cc212014-07-17 22:47:16 +0000636}
637
638// darwinPrintStab() prints the n_sect, n_desc along with a symbolic name of
639// a stab n_type value in a Mach-O file.
640static void darwinPrintStab(MachOObjectFile *MachO, SymbolListT::iterator I) {
641 MachO::nlist_64 STE_64;
642 MachO::nlist STE;
643 uint8_t NType;
644 uint8_t NSect;
645 uint16_t NDesc;
Rafael Espindola2d5d23d2015-07-06 21:36:23 +0000646 DataRefImpl SymDRI = I->Sym.getRawDataRefImpl();
Kevin Enderby407cc212014-07-17 22:47:16 +0000647 if (MachO->is64Bit()) {
Rafael Espindola2d5d23d2015-07-06 21:36:23 +0000648 STE_64 = MachO->getSymbol64TableEntry(SymDRI);
Kevin Enderby407cc212014-07-17 22:47:16 +0000649 NType = STE_64.n_type;
650 NSect = STE_64.n_sect;
651 NDesc = STE_64.n_desc;
652 } else {
Rafael Espindola2d5d23d2015-07-06 21:36:23 +0000653 STE = MachO->getSymbolTableEntry(SymDRI);
Kevin Enderby407cc212014-07-17 22:47:16 +0000654 NType = STE.n_type;
655 NSect = STE.n_sect;
656 NDesc = STE.n_desc;
657 }
658
659 char Str[18] = "";
660 format("%02x", NSect).print(Str, sizeof(Str));
661 outs() << ' ' << Str << ' ';
662 format("%04x", NDesc).print(Str, sizeof(Str));
663 outs() << Str << ' ';
664 if (const char *stabString = getDarwinStabString(NType))
665 format("%5.5s", stabString).print(Str, sizeof(Str));
666 else
667 format(" %02x", NType).print(Str, sizeof(Str));
668 outs() << Str;
669}
670
Sam Clegg531da002017-06-29 18:29:05 +0000671static Optional<std::string> demangle(StringRef Name, bool StripUnderscore) {
672 if (StripUnderscore && Name.size() > 0 && Name[0] == '_')
673 Name = Name.substr(1);
674
675 if (!Name.startswith("_Z"))
676 return None;
677
678 int Status;
Eric Christopherdbb92ca2017-06-30 05:38:56 +0000679 char *Undecorated =
680 itaniumDemangle(Name.str().c_str(), nullptr, nullptr, &Status);
Sam Clegg531da002017-06-29 18:29:05 +0000681 if (Status != 0)
682 return None;
683
Eric Christopherdbb92ca2017-06-30 05:38:56 +0000684 std::string S(Undecorated);
685 free(Undecorated);
686 return S;
Sam Clegg531da002017-06-29 18:29:05 +0000687}
688
Meador Ingef74d9992016-11-23 20:17:15 +0000689static bool symbolIsDefined(const NMSymbol &Sym) {
690 return Sym.TypeChar != 'U' && Sym.TypeChar != 'w' && Sym.TypeChar != 'v';
691}
692
Rafael Espindolaceb23382014-07-31 21:00:10 +0000693static void sortAndPrintSymbolList(SymbolicFile &Obj, bool printName,
Benjamin Kramerc321e532016-06-08 19:09:22 +0000694 const std::string &ArchiveName,
695 const std::string &ArchitectureName) {
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000696 if (!NoSort) {
Rafael Espindola63d10d62015-07-06 18:48:47 +0000697 std::function<bool(const NMSymbol &, const NMSymbol &)> Cmp;
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000698 if (NumericSort)
Rafael Espindola63d10d62015-07-06 18:48:47 +0000699 Cmp = compareSymbolAddress;
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000700 else if (SizeSort)
Rafael Espindola63d10d62015-07-06 18:48:47 +0000701 Cmp = compareSymbolSize;
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000702 else
Rafael Espindola63d10d62015-07-06 18:48:47 +0000703 Cmp = compareSymbolName;
704
705 if (ReverseSort)
Rafael Espindolacab82752015-07-06 19:24:40 +0000706 Cmp = [=](const NMSymbol &A, const NMSymbol &B) { return Cmp(B, A); };
Mandeep Singh Grang8db564e2018-04-01 21:24:53 +0000707 llvm::sort(SymbolList.begin(), SymbolList.end(), Cmp);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000708 }
709
Kevin Enderby08e1bbd2014-07-24 23:31:52 +0000710 if (!PrintFileName) {
711 if (OutputFormat == posix && MultipleFiles && printName) {
712 outs() << '\n' << CurrentFilename << ":\n";
713 } else if (OutputFormat == bsd && MultipleFiles && printName) {
714 outs() << "\n" << CurrentFilename << ":\n";
715 } else if (OutputFormat == sysv) {
Sam Clegg32cfbeb2017-08-31 21:23:44 +0000716 outs() << "\n\nSymbols from " << CurrentFilename << ":\n\n";
717 if (isSymbolList64Bit(Obj))
718 outs() << "Name Value Class Type"
719 << " Size Line Section\n";
720 else
721 outs() << "Name Value Class Type"
722 << " Size Line Section\n";
Kevin Enderby08e1bbd2014-07-24 23:31:52 +0000723 }
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000724 }
725
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000726 const char *printBlanks, *printDashes, *printFormat;
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000727 if (isSymbolList64Bit(Obj)) {
728 printBlanks = " ";
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000729 printDashes = "----------------";
Hemant Kulkarni5e005a12016-02-10 17:51:39 +0000730 switch (AddressRadix) {
731 case Radix::o:
Kevin Enderby2d431c3d2016-03-29 20:18:07 +0000732 printFormat = OutputFormat == posix ? "%" PRIo64 : "%016" PRIo64;
Hemant Kulkarni5e005a12016-02-10 17:51:39 +0000733 break;
734 case Radix::x:
Kevin Enderby2d431c3d2016-03-29 20:18:07 +0000735 printFormat = OutputFormat == posix ? "%" PRIx64 : "%016" PRIx64;
Hemant Kulkarni5e005a12016-02-10 17:51:39 +0000736 break;
737 default:
Kevin Enderby2d431c3d2016-03-29 20:18:07 +0000738 printFormat = OutputFormat == posix ? "%" PRId64 : "%016" PRId64;
Hemant Kulkarni5e005a12016-02-10 17:51:39 +0000739 }
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000740 } else {
741 printBlanks = " ";
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000742 printDashes = "--------";
Hemant Kulkarni5e005a12016-02-10 17:51:39 +0000743 switch (AddressRadix) {
744 case Radix::o:
Kevin Enderby2d431c3d2016-03-29 20:18:07 +0000745 printFormat = OutputFormat == posix ? "%" PRIo64 : "%08" PRIo64;
Hemant Kulkarni5e005a12016-02-10 17:51:39 +0000746 break;
747 case Radix::x:
Kevin Enderby2d431c3d2016-03-29 20:18:07 +0000748 printFormat = OutputFormat == posix ? "%" PRIx64 : "%08" PRIx64;
Hemant Kulkarni5e005a12016-02-10 17:51:39 +0000749 break;
750 default:
Kevin Enderby2d431c3d2016-03-29 20:18:07 +0000751 printFormat = OutputFormat == posix ? "%" PRId64 : "%08" PRId64;
Hemant Kulkarni5e005a12016-02-10 17:51:39 +0000752 }
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000753 }
754
Rafael Espindola619581c2014-01-29 04:56:19 +0000755 for (SymbolListT::iterator I = SymbolList.begin(), E = SymbolList.end();
756 I != E; ++I) {
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000757 uint32_t SymFlags;
Sam Clegg531da002017-06-29 18:29:05 +0000758 std::string Name = I->Name.str();
759 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
760 if (Demangle) {
761 if (Optional<std::string> Opt = demangle(I->Name, MachO))
762 Name = *Opt;
763 }
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000764 if (I->Sym.getRawDataRefImpl().p)
765 SymFlags = I->Sym.getFlags();
766 else
767 SymFlags = I->SymFlags;
768
Rafael Espindola2d5d23d2015-07-06 21:36:23 +0000769 bool Undefined = SymFlags & SymbolRef::SF_Undefined;
Kevin Enderby1543bdf2015-10-30 19:55:32 +0000770 bool Global = SymFlags & SymbolRef::SF_Global;
Davide Italiano74237152016-01-26 19:57:42 +0000771 if ((!Undefined && UndefinedOnly) || (Undefined && DefinedOnly) ||
772 (!Global && ExternalOnly) || (SizeSort && !PrintAddress))
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000773 continue;
Kevin Enderby08e1bbd2014-07-24 23:31:52 +0000774 if (PrintFileName) {
775 if (!ArchitectureName.empty())
776 outs() << "(for architecture " << ArchitectureName << "):";
Kevin Enderby2d431c3d2016-03-29 20:18:07 +0000777 if (OutputFormat == posix && !ArchiveName.empty())
778 outs() << ArchiveName << "[" << CurrentFilename << "]: ";
779 else {
780 if (!ArchiveName.empty())
781 outs() << ArchiveName << ":";
782 outs() << CurrentFilename << ": ";
783 }
Kevin Enderby08e1bbd2014-07-24 23:31:52 +0000784 }
Sam Clegg531da002017-06-29 18:29:05 +0000785 if ((JustSymbolName ||
786 (UndefinedOnly && MachO && OutputFormat != darwin)) &&
787 OutputFormat != posix) {
788 outs() << Name << "\n";
Kevin Enderby0fd8aac2014-07-03 21:51:07 +0000789 continue;
790 }
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000791
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000792 char SymbolAddrStr[18] = "";
793 char SymbolSizeStr[18] = "";
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000794
Meador Ingef74d9992016-11-23 20:17:15 +0000795 // If the format is SysV or the symbol isn't defined, then print spaces.
796 if (OutputFormat == sysv || !symbolIsDefined(*I)) {
797 if (OutputFormat == posix) {
Kevin Enderby2d431c3d2016-03-29 20:18:07 +0000798 format(printFormat, I->Address)
799 .print(SymbolAddrStr, sizeof(SymbolAddrStr));
Meador Ingef74d9992016-11-23 20:17:15 +0000800 format(printFormat, I->Size)
801 .print(SymbolSizeStr, sizeof(SymbolSizeStr));
802 } else {
Kevin Enderby2d431c3d2016-03-29 20:18:07 +0000803 strcpy(SymbolAddrStr, printBlanks);
Meador Ingef74d9992016-11-23 20:17:15 +0000804 strcpy(SymbolSizeStr, printBlanks);
805 }
Kevin Enderby2d431c3d2016-03-29 20:18:07 +0000806 }
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000807
Meador Ingef74d9992016-11-23 20:17:15 +0000808 // Otherwise, print the symbol address and size.
809 if (symbolIsDefined(*I)) {
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000810 if (Obj.isIR())
811 strcpy(SymbolAddrStr, printDashes);
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000812 else if(MachO && I->TypeChar == 'I')
813 strcpy(SymbolAddrStr, printBlanks);
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000814 else
815 format(printFormat, I->Address)
Rafael Espindolab4865d62014-04-03 00:19:35 +0000816 .print(SymbolAddrStr, sizeof(SymbolAddrStr));
Meador Ingef74d9992016-11-23 20:17:15 +0000817 format(printFormat, I->Size).print(SymbolSizeStr, sizeof(SymbolSizeStr));
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000818 }
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000819
Kevin Enderby77b968e2014-07-16 17:38:26 +0000820 // If OutputFormat is darwin or we are printing Mach-O symbols in hex and
821 // we have a MachOObjectFile, call darwinPrintSymbol to print as darwin's
822 // nm(1) -m output or hex, else if OutputFormat is darwin or we are
823 // printing Mach-O symbols in hex and not a Mach-O object fall back to
824 // OutputFormat bsd (see below).
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000825 if ((OutputFormat == darwin || FormatMachOasHex) && (MachO || Obj.isIR())) {
826 darwinPrintSymbol(Obj, I, SymbolAddrStr, printBlanks, printDashes,
827 printFormat);
Kevin Enderby980b2582014-06-05 21:21:57 +0000828 } else if (OutputFormat == posix) {
Sam Clegg531da002017-06-29 18:29:05 +0000829 outs() << Name << " " << I->TypeChar << " ";
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000830 if (MachO)
Kevin Enderby2d431c3d2016-03-29 20:18:07 +0000831 outs() << SymbolAddrStr << " " << "0" /* SymbolSizeStr */ << "\n";
Kevin Enderbydc0dbe12015-11-10 00:31:08 +0000832 else
James Molloy08a15ce2016-03-24 09:23:51 +0000833 outs() << SymbolAddrStr << " " << SymbolSizeStr << "\n";
Kevin Enderby980b2582014-06-05 21:21:57 +0000834 } else if (OutputFormat == bsd || (OutputFormat == darwin && !MachO)) {
Rafael Espindolab4865d62014-04-03 00:19:35 +0000835 if (PrintAddress)
836 outs() << SymbolAddrStr << ' ';
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000837 if (PrintSize) {
838 outs() << SymbolSizeStr;
Rafael Espindolad7a32ea2015-06-24 10:20:30 +0000839 outs() << ' ';
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000840 }
Kevin Enderby407cc212014-07-17 22:47:16 +0000841 outs() << I->TypeChar;
842 if (I->TypeChar == '-' && MachO)
843 darwinPrintStab(MachO, I);
Sam Clegg531da002017-06-29 18:29:05 +0000844 outs() << " " << Name;
Kevin Enderbydf0d6da2017-06-19 19:38:22 +0000845 if (I->TypeChar == 'I' && MachO) {
846 outs() << " (indirect for ";
847 if (I->Sym.getRawDataRefImpl().p) {
848 StringRef IndirectName;
849 if (MachO->getIndirectName(I->Sym.getRawDataRefImpl(), IndirectName))
850 outs() << "?)";
851 else
852 outs() << IndirectName << ")";
853 } else
854 outs() << I->IndirectName << ")";
855 }
856 outs() << "\n";
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000857 } else if (OutputFormat == sysv) {
Sam Clegg531da002017-06-29 18:29:05 +0000858 std::string PaddedName(Name);
Rafael Espindola619581c2014-01-29 04:56:19 +0000859 while (PaddedName.length() < 20)
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000860 PaddedName += " ";
Rafael Espindolab4865d62014-04-03 00:19:35 +0000861 outs() << PaddedName << "|" << SymbolAddrStr << "| " << I->TypeChar
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000862 << " | |" << SymbolSizeStr << "| |\n";
863 }
864 }
865
866 SymbolList.clear();
867}
868
Rafael Espindolab39953d2015-06-26 13:11:15 +0000869static char getSymbolNMTypeChar(ELFObjectFileBase &Obj,
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000870 basic_symbol_iterator I) {
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000871 // OK, this is ELF
Rafael Espindolab39953d2015-06-26 13:11:15 +0000872 elf_symbol_iterator SymI(I);
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000873
Kevin Enderby7bd8d992016-05-02 20:28:12 +0000874 Expected<elf_section_iterator> SecIOrErr = SymI->getSection();
875 if (!SecIOrErr) {
876 consumeError(SecIOrErr.takeError());
Rafael Espindolab39953d2015-06-26 13:11:15 +0000877 return '?';
Kevin Enderby7bd8d992016-05-02 20:28:12 +0000878 }
Rafael Espindola586af97a2013-11-02 21:16:09 +0000879
Rafael Espindola8bab8892015-08-07 23:27:14 +0000880 elf_section_iterator SecI = *SecIOrErr;
Rafael Espindolab39953d2015-06-26 13:11:15 +0000881 if (SecI != Obj.section_end()) {
882 switch (SecI->getType()) {
Rafael Espindola586af97a2013-11-02 21:16:09 +0000883 case ELF::SHT_PROGBITS:
884 case ELF::SHT_DYNAMIC:
Rafael Espindolab39953d2015-06-26 13:11:15 +0000885 switch (SecI->getFlags()) {
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000886 case (ELF::SHF_ALLOC | ELF::SHF_EXECINSTR):
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000887 return 't';
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000888 case (ELF::SHF_TLS | ELF::SHF_ALLOC | ELF::SHF_WRITE):
889 case (ELF::SHF_ALLOC | ELF::SHF_WRITE):
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000890 return 'd';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000891 case ELF::SHF_ALLOC:
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000892 case (ELF::SHF_ALLOC | ELF::SHF_MERGE):
893 case (ELF::SHF_ALLOC | ELF::SHF_MERGE | ELF::SHF_STRINGS):
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000894 return 'r';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000895 }
896 break;
897 case ELF::SHT_NOBITS:
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000898 return 'b';
Meador Ingeca975582016-11-23 20:17:20 +0000899 case ELF::SHT_INIT_ARRAY:
900 case ELF::SHT_FINI_ARRAY:
901 return 't';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000902 }
903 }
904
Rafael Espindolab39953d2015-06-26 13:11:15 +0000905 if (SymI->getELFType() == ELF::STT_SECTION) {
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000906 Expected<StringRef> Name = SymI->getName();
907 if (!Name) {
908 consumeError(Name.takeError());
Rafael Espindola74375892014-02-04 00:21:18 +0000909 return '?';
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000910 }
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000911 return StringSwitch<char>(*Name)
Rafael Espindola74375892014-02-04 00:21:18 +0000912 .StartsWith(".debug", 'N')
913 .StartsWith(".note", 'n')
914 .Default('?');
Rafael Espindola586af97a2013-11-02 21:16:09 +0000915 }
916
Rafael Espindola60c1a8c2015-06-25 16:01:53 +0000917 return 'n';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000918}
919
Rafael Espindola74375892014-02-04 00:21:18 +0000920static char getSymbolNMTypeChar(COFFObjectFile &Obj, symbol_iterator I) {
David Majnemer44f51e52014-09-10 12:51:52 +0000921 COFFSymbolRef Symb = Obj.getCOFFSymbol(*I);
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000922 // OK, this is COFF.
923 symbol_iterator SymI(I);
924
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000925 Expected<StringRef> Name = SymI->getName();
926 if (!Name) {
927 consumeError(Name.takeError());
Rafael Espindola74375892014-02-04 00:21:18 +0000928 return '?';
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000929 }
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000930
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000931 char Ret = StringSwitch<char>(*Name)
Rafael Espindola586af97a2013-11-02 21:16:09 +0000932 .StartsWith(".debug", 'N')
933 .StartsWith(".sxdata", 'N')
934 .Default('?');
935
Rafael Espindola74375892014-02-04 00:21:18 +0000936 if (Ret != '?')
937 return Ret;
Rafael Espindola586af97a2013-11-02 21:16:09 +0000938
939 uint32_t Characteristics = 0;
David Majnemer44f51e52014-09-10 12:51:52 +0000940 if (!COFF::isReservedSectionNumber(Symb.getSectionNumber())) {
Kevin Enderby7bd8d992016-05-02 20:28:12 +0000941 Expected<section_iterator> SecIOrErr = SymI->getSection();
942 if (!SecIOrErr) {
943 consumeError(SecIOrErr.takeError());
Rafael Espindola74375892014-02-04 00:21:18 +0000944 return '?';
Kevin Enderby7bd8d992016-05-02 20:28:12 +0000945 }
Rafael Espindola8bab8892015-08-07 23:27:14 +0000946 section_iterator SecI = *SecIOrErr;
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000947 const coff_section *Section = Obj.getCOFFSection(*SecI);
Rafael Espindola586af97a2013-11-02 21:16:09 +0000948 Characteristics = Section->Characteristics;
Martin Storsjo14015242017-11-03 07:18:14 +0000949 StringRef SectionName;
950 Obj.getSectionName(Section, SectionName);
951 if (SectionName.startswith(".idata"))
952 return 'i';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000953 }
954
David Majnemer44f51e52014-09-10 12:51:52 +0000955 switch (Symb.getSectionNumber()) {
Rafael Espindola586af97a2013-11-02 21:16:09 +0000956 case COFF::IMAGE_SYM_DEBUG:
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000957 return 'n';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000958 default:
959 // Check section type.
960 if (Characteristics & COFF::IMAGE_SCN_CNT_CODE)
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000961 return 't';
David Majnemerc7d7c6f2014-10-31 05:07:00 +0000962 if (Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
963 return Characteristics & COFF::IMAGE_SCN_MEM_WRITE ? 'd' : 'r';
964 if (Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000965 return 'b';
David Majnemerc7d7c6f2014-10-31 05:07:00 +0000966 if (Characteristics & COFF::IMAGE_SCN_LNK_INFO)
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000967 return 'i';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000968 // Check for section symbol.
David Majnemerc7d7c6f2014-10-31 05:07:00 +0000969 if (Symb.isSectionDefinition())
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000970 return 's';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000971 }
972
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000973 return '?';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000974}
975
Rafael Espindola8b781852017-05-24 23:40:36 +0000976static char getSymbolNMTypeChar(COFFImportFile &Obj) {
977 switch (Obj.getCOFFImportHeader()->getType()) {
978 case COFF::IMPORT_CODE:
979 return 't';
980 case COFF::IMPORT_DATA:
981 return 'd';
982 case COFF::IMPORT_CONST:
983 return 'r';
984 }
985 return '?';
986}
987
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000988static char getSymbolNMTypeChar(MachOObjectFile &Obj, basic_symbol_iterator I) {
Rafael Espindola586af97a2013-11-02 21:16:09 +0000989 DataRefImpl Symb = I->getRawDataRefImpl();
Davide Italianoba284b62016-02-11 02:56:02 +0000990 uint8_t NType = Obj.is64Bit() ? Obj.getSymbol64TableEntry(Symb).n_type
991 : Obj.getSymbolTableEntry(Symb).n_type;
Rafael Espindola586af97a2013-11-02 21:16:09 +0000992
Kevin Enderby407cc212014-07-17 22:47:16 +0000993 if (NType & MachO::N_STAB)
994 return '-';
995
Rafael Espindola586af97a2013-11-02 21:16:09 +0000996 switch (NType & MachO::N_TYPE) {
Rafael Espindola586af97a2013-11-02 21:16:09 +0000997 case MachO::N_ABS:
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000998 return 's';
Tim Northovereaef0742014-05-30 13:22:59 +0000999 case MachO::N_INDR:
1000 return 'i';
Rafael Espindola586af97a2013-11-02 21:16:09 +00001001 case MachO::N_SECT: {
Kevin Enderby7bd8d992016-05-02 20:28:12 +00001002 Expected<section_iterator> SecOrErr = Obj.getSymbolSection(Symb);
1003 if (!SecOrErr) {
1004 consumeError(SecOrErr.takeError());
Kevin Enderby1f472ea2016-01-21 21:13:27 +00001005 return 's';
Kevin Enderby7bd8d992016-05-02 20:28:12 +00001006 }
Kevin Enderby1f472ea2016-01-21 21:13:27 +00001007 section_iterator Sec = *SecOrErr;
Kevin Enderby44550602017-09-13 21:01:49 +00001008 if (Sec == Obj.section_end())
1009 return 's';
Rafael Espindola586af97a2013-11-02 21:16:09 +00001010 DataRefImpl Ref = Sec->getRawDataRefImpl();
1011 StringRef SectionName;
1012 Obj.getSectionName(Ref, SectionName);
1013 StringRef SegmentName = Obj.getSectionFinalSegmentName(Ref);
Kevin Enderbyb95a0502018-01-31 00:00:41 +00001014 if (Obj.is64Bit() &&
1015 Obj.getHeader64().filetype == MachO::MH_KEXT_BUNDLE &&
1016 SegmentName == "__TEXT_EXEC" && SectionName == "__text")
1017 return 't';
Rafael Espindola586af97a2013-11-02 21:16:09 +00001018 if (SegmentName == "__TEXT" && SectionName == "__text")
Rafael Espindola22fe9c12014-02-05 05:19:19 +00001019 return 't';
Davide Italianoe4db1872016-01-26 19:28:51 +00001020 if (SegmentName == "__DATA" && SectionName == "__data")
Kevin Enderby1e1b9922014-06-19 22:49:21 +00001021 return 'd';
Davide Italianoe4db1872016-01-26 19:28:51 +00001022 if (SegmentName == "__DATA" && SectionName == "__bss")
Kevin Enderby1e1b9922014-06-19 22:49:21 +00001023 return 'b';
Davide Italianoe4db1872016-01-26 19:28:51 +00001024 return 's';
Rafael Espindola22fe9c12014-02-05 05:19:19 +00001025 }
Rafael Espindola586af97a2013-11-02 21:16:09 +00001026 }
1027
Rafael Espindola22fe9c12014-02-05 05:19:19 +00001028 return '?';
1029}
1030
Sam Clegg135a4b82017-04-14 19:50:44 +00001031static char getSymbolNMTypeChar(WasmObjectFile &Obj, basic_symbol_iterator I) {
1032 uint32_t Flags = I->getFlags();
1033 if (Flags & SymbolRef::SF_Executable)
1034 return 't';
1035 return 'd';
1036}
1037
Peter Collingbournee2f1b4a2016-12-01 06:53:47 +00001038static char getSymbolNMTypeChar(IRObjectFile &Obj, basic_symbol_iterator I) {
1039 uint32_t Flags = I->getFlags();
Rafael Espindolaf12b8282014-02-21 20:10:59 +00001040 // FIXME: should we print 'b'? At the IR level we cannot be sure if this
1041 // will be in bss or not, but we could approximate.
Peter Collingbournee2f1b4a2016-12-01 06:53:47 +00001042 if (Flags & SymbolRef::SF_Executable)
1043 return 't';
1044 else if (Triple(Obj.getTargetTriple()).isOSDarwin() &&
1045 (Flags & SymbolRef::SF_Const))
1046 return 's';
1047 else
1048 return 'd';
Rafael Espindolaf12b8282014-02-21 20:10:59 +00001049}
1050
Rafael Espindolaceb23382014-07-31 21:00:10 +00001051static bool isObject(SymbolicFile &Obj, basic_symbol_iterator I) {
Davide Italiano92e6c282016-02-08 23:50:23 +00001052 return !dyn_cast<ELFObjectFileBase>(&Obj)
Davide Italiano71c85df2016-02-08 22:58:26 +00001053 ? false
1054 : elf_symbol_iterator(I)->getELFType() == ELF::STT_OBJECT;
Rafael Espindola586af97a2013-11-02 21:16:09 +00001055}
1056
Rafael Espindolaceb23382014-07-31 21:00:10 +00001057static char getNMTypeChar(SymbolicFile &Obj, basic_symbol_iterator I) {
Rafael Espindola22fe9c12014-02-05 05:19:19 +00001058 uint32_t Symflags = I->getFlags();
1059 if ((Symflags & object::SymbolRef::SF_Weak) && !isa<MachOObjectFile>(Obj)) {
1060 char Ret = isObject(Obj, I) ? 'v' : 'w';
Davide Italianoa090a002016-02-05 21:10:48 +00001061 return (!(Symflags & object::SymbolRef::SF_Undefined)) ? toupper(Ret) : Ret;
Rafael Espindola22fe9c12014-02-05 05:19:19 +00001062 }
1063
1064 if (Symflags & object::SymbolRef::SF_Undefined)
1065 return 'U';
1066
1067 if (Symflags & object::SymbolRef::SF_Common)
1068 return 'C';
1069
1070 char Ret = '?';
1071 if (Symflags & object::SymbolRef::SF_Absolute)
1072 Ret = 'a';
Peter Collingbournee2f1b4a2016-12-01 06:53:47 +00001073 else if (IRObjectFile *IR = dyn_cast<IRObjectFile>(&Obj))
Rafael Espindolaf12b8282014-02-21 20:10:59 +00001074 Ret = getSymbolNMTypeChar(*IR, I);
Rafael Espindolaceb23382014-07-31 21:00:10 +00001075 else if (COFFObjectFile *COFF = dyn_cast<COFFObjectFile>(&Obj))
Rafael Espindola22fe9c12014-02-05 05:19:19 +00001076 Ret = getSymbolNMTypeChar(*COFF, I);
Rafael Espindola8b781852017-05-24 23:40:36 +00001077 else if (COFFImportFile *COFFImport = dyn_cast<COFFImportFile>(&Obj))
1078 Ret = getSymbolNMTypeChar(*COFFImport);
Rafael Espindolaceb23382014-07-31 21:00:10 +00001079 else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj))
Rafael Espindola22fe9c12014-02-05 05:19:19 +00001080 Ret = getSymbolNMTypeChar(*MachO, I);
Sam Clegg135a4b82017-04-14 19:50:44 +00001081 else if (WasmObjectFile *Wasm = dyn_cast<WasmObjectFile>(&Obj))
1082 Ret = getSymbolNMTypeChar(*Wasm, I);
Rafael Espindola22fe9c12014-02-05 05:19:19 +00001083 else
Rafael Espindolab39953d2015-06-26 13:11:15 +00001084 Ret = getSymbolNMTypeChar(cast<ELFObjectFileBase>(Obj), I);
Rafael Espindola22fe9c12014-02-05 05:19:19 +00001085
1086 if (Symflags & object::SymbolRef::SF_Global)
1087 Ret = toupper(Ret);
1088
1089 return Ret;
Rafael Espindola586af97a2013-11-02 21:16:09 +00001090}
1091
Kevin Enderbyfe6ad972014-07-11 20:30:00 +00001092// getNsectForSegSect() is used to implement the Mach-O "-s segname sectname"
1093// option to dump only those symbols from that section in a Mach-O file.
1094// It is called once for each Mach-O file from dumpSymbolNamesFromObject()
1095// to get the section number for that named section from the command line
1096// arguments. It returns the section number for that section in the Mach-O
1097// file or zero it is not present.
1098static unsigned getNsectForSegSect(MachOObjectFile *Obj) {
1099 unsigned Nsect = 1;
Davide Italiano9ee9fb62016-02-10 23:16:17 +00001100 for (auto &S : Obj->sections()) {
1101 DataRefImpl Ref = S.getRawDataRefImpl();
Kevin Enderbyfe6ad972014-07-11 20:30:00 +00001102 StringRef SectionName;
1103 Obj->getSectionName(Ref, SectionName);
1104 StringRef SegmentName = Obj->getSectionFinalSegmentName(Ref);
1105 if (SegmentName == SegSect[0] && SectionName == SegSect[1])
1106 return Nsect;
1107 Nsect++;
1108 }
1109 return 0;
1110}
1111
1112// getNsectInMachO() is used to implement the Mach-O "-s segname sectname"
1113// option to dump only those symbols from that section in a Mach-O file.
1114// It is called once for each symbol in a Mach-O file from
1115// dumpSymbolNamesFromObject() and returns the section number for that symbol
1116// if it is in a section, else it returns 0.
Rafael Espindolab85e10c2015-06-25 15:00:38 +00001117static unsigned getNsectInMachO(MachOObjectFile &Obj, BasicSymbolRef Sym) {
1118 DataRefImpl Symb = Sym.getRawDataRefImpl();
Kevin Enderbyfe6ad972014-07-11 20:30:00 +00001119 if (Obj.is64Bit()) {
1120 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
Davide Italianoba284b62016-02-11 02:56:02 +00001121 return (STE.n_type & MachO::N_TYPE) == MachO::N_SECT ? STE.n_sect : 0;
Kevin Enderbyfe6ad972014-07-11 20:30:00 +00001122 }
1123 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
Davide Italianoba284b62016-02-11 02:56:02 +00001124 return (STE.n_type & MachO::N_TYPE) == MachO::N_SECT ? STE.n_sect : 0;
Kevin Enderbyfe6ad972014-07-11 20:30:00 +00001125}
1126
Benjamin Kramerc321e532016-06-08 19:09:22 +00001127static void
1128dumpSymbolNamesFromObject(SymbolicFile &Obj, bool printName,
1129 const std::string &ArchiveName = std::string(),
1130 const std::string &ArchitectureName = std::string()) {
Rafael Espindolab85e10c2015-06-25 15:00:38 +00001131 auto Symbols = Obj.symbols();
Michael J. Spencer8c4729f2012-02-28 00:40:37 +00001132 if (DynamicSyms) {
Rafael Espindola11afad02015-06-25 14:39:35 +00001133 const auto *E = dyn_cast<ELFObjectFileBase>(&Obj);
1134 if (!E) {
Rafael Espindolaceb23382014-07-31 21:00:10 +00001135 error("File format has no dynamic symbol table", Obj.getFileName());
Rafael Espindola196666c2014-01-30 20:45:33 +00001136 return;
1137 }
Rafael Espindolab85e10c2015-06-25 15:00:38 +00001138 auto DynSymbols = E->getDynamicSymbolIterators();
1139 Symbols =
1140 make_range<basic_symbol_iterator>(DynSymbols.begin(), DynSymbols.end());
Michael J. Spencer8c4729f2012-02-28 00:40:37 +00001141 }
Rafael Espindolaf12b8282014-02-21 20:10:59 +00001142 std::string NameBuffer;
1143 raw_string_ostream OS(NameBuffer);
Kevin Enderbyfe6ad972014-07-11 20:30:00 +00001144 // If a "-s segname sectname" option was specified and this is a Mach-O
1145 // file get the section number for that section in this object file.
1146 unsigned int Nsect = 0;
Rafael Espindolaceb23382014-07-31 21:00:10 +00001147 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
Kevin Enderbyfe6ad972014-07-11 20:30:00 +00001148 if (SegSect.size() != 0 && MachO) {
1149 Nsect = getNsectForSegSect(MachO);
1150 // If this section is not in the object file no symbols are printed.
1151 if (Nsect == 0)
1152 return;
1153 }
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001154 if (!MachO || !DyldInfoOnly) {
1155 for (BasicSymbolRef Sym : Symbols) {
1156 uint32_t SymFlags = Sym.getFlags();
1157 if (!DebugSyms && (SymFlags & SymbolRef::SF_FormatSpecific))
1158 continue;
1159 if (WithoutAliases && (SymFlags & SymbolRef::SF_Indirect))
1160 continue;
1161 // If a "-s segname sectname" option was specified and this is a Mach-O
1162 // file and this section appears in this file, Nsect will be non-zero then
1163 // see if this symbol is a symbol from that section and if not skip it.
1164 if (Nsect && Nsect != getNsectInMachO(*MachO, Sym))
1165 continue;
1166 NMSymbol S;
Kevin Enderbya8c4c012017-06-20 00:41:04 +00001167 memset(&S, '\0', sizeof(S));
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001168 S.Size = 0;
1169 S.Address = 0;
1170 if (PrintSize) {
1171 if (isa<ELFObjectFileBase>(&Obj))
1172 S.Size = ELFSymbolRef(Sym).getSize();
Kevin Enderby931cb652016-06-24 18:24:42 +00001173 }
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001174 if (PrintAddress && isa<ObjectFile>(Obj)) {
1175 SymbolRef SymRef(Sym);
1176 Expected<uint64_t> AddressOrErr = SymRef.getAddress();
1177 if (!AddressOrErr) {
1178 consumeError(AddressOrErr.takeError());
1179 break;
1180 }
1181 S.Address = *AddressOrErr;
1182 }
1183 S.TypeChar = getNMTypeChar(Obj, Sym);
1184 std::error_code EC = Sym.printName(OS);
1185 if (EC && MachO)
1186 OS << "bad string index";
1187 else
1188 error(EC);
1189 OS << '\0';
1190 S.Sym = Sym;
1191 SymbolList.push_back(S);
Rafael Espindolab85e10c2015-06-25 15:00:38 +00001192 }
Michael J. Spencerb8672a52011-01-20 06:38:57 +00001193 }
1194
Rafael Espindolaf12b8282014-02-21 20:10:59 +00001195 OS.flush();
1196 const char *P = NameBuffer.c_str();
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001197 unsigned I;
1198 for (I = 0; I < SymbolList.size(); ++I) {
Rafael Espindolaf12b8282014-02-21 20:10:59 +00001199 SymbolList[I].Name = P;
1200 P += strlen(P) + 1;
1201 }
1202
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001203 // If this is a Mach-O file where the nlist symbol table is out of sync
1204 // with the dyld export trie then look through exports and fake up symbols
1205 // for the ones that are missing (also done with the -add-dyldinfo flag).
1206 // This is needed if strip(1) -T is run on a binary containing swift
1207 // language symbols for example. The option -only-dyldinfo will fake up
1208 // all symbols from the dyld export trie as well as the bind info.
1209 std::string ExportsNameBuffer;
1210 raw_string_ostream EOS(ExportsNameBuffer);
1211 std::string BindsNameBuffer;
1212 raw_string_ostream BOS(BindsNameBuffer);
1213 std::string LazysNameBuffer;
1214 raw_string_ostream LOS(LazysNameBuffer);
1215 std::string WeaksNameBuffer;
1216 raw_string_ostream WOS(WeaksNameBuffer);
Kevin Enderbyd3cf76b2018-03-22 23:59:35 +00001217 std::string FunctionStartsNameBuffer;
1218 raw_string_ostream FOS(FunctionStartsNameBuffer);
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001219 if (MachO && !NoDyldInfo) {
1220 MachO::mach_header H;
1221 MachO::mach_header_64 H_64;
1222 uint32_t HFlags = 0;
1223 if (MachO->is64Bit()) {
1224 H_64 = MachO->MachOObjectFile::getHeader64();
1225 HFlags = H_64.flags;
1226 } else {
1227 H = MachO->MachOObjectFile::getHeader();
1228 HFlags = H.flags;
1229 }
1230 uint64_t BaseSegmentAddress = 0;
1231 for (const auto &Command : MachO->load_commands()) {
1232 if (Command.C.cmd == MachO::LC_SEGMENT) {
1233 MachO::segment_command Seg = MachO->getSegmentLoadCommand(Command);
1234 if (Seg.fileoff == 0 && Seg.filesize != 0) {
1235 BaseSegmentAddress = Seg.vmaddr;
1236 break;
1237 }
1238 } else if (Command.C.cmd == MachO::LC_SEGMENT_64) {
1239 MachO::segment_command_64 Seg = MachO->getSegment64LoadCommand(Command);
1240 if (Seg.fileoff == 0 && Seg.filesize != 0) {
1241 BaseSegmentAddress = Seg.vmaddr;
1242 break;
1243 }
1244 }
1245 }
1246 if (DyldInfoOnly || AddDyldInfo ||
1247 HFlags & MachO::MH_NLIST_OUTOFSYNC_WITH_DYLDINFO) {
1248 unsigned ExportsAdded = 0;
Kevin Enderby3e95bd22017-07-20 23:08:41 +00001249 Error Err = Error::success();
Alexander Shaposhnikove5740342017-07-29 00:30:45 +00001250 for (const llvm::object::ExportEntry &Entry : MachO->exports(Err)) {
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001251 bool found = false;
1252 bool ReExport = false;
1253 if (!DyldInfoOnly) {
1254 for (unsigned J = 0; J < SymbolList.size() && !found; ++J) {
1255 if (SymbolList[J].Address == Entry.address() + BaseSegmentAddress &&
1256 SymbolList[J].Name == Entry.name())
1257 found = true;
1258 }
1259 }
1260 if (!found) {
1261 NMSymbol S;
Kevin Enderbya8c4c012017-06-20 00:41:04 +00001262 memset(&S, '\0', sizeof(NMSymbol));
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001263 S.Address = Entry.address() + BaseSegmentAddress;
1264 S.Size = 0;
1265 S.TypeChar = '\0';
1266 S.Name = Entry.name();
1267 // There is no symbol in the nlist symbol table for this so we set
1268 // Sym effectivly to null and the rest of code in here must test for
1269 // it and not do things like Sym.getFlags() for it.
1270 S.Sym = BasicSymbolRef();
1271 S.SymFlags = SymbolRef::SF_Global;
1272 S.Section = SectionRef();
1273 S.NType = 0;
1274 S.NSect = 0;
1275 S.NDesc = 0;
1276 S.IndirectName = StringRef();
1277
1278 uint64_t EFlags = Entry.flags();
1279 bool Abs = ((EFlags & MachO::EXPORT_SYMBOL_FLAGS_KIND_MASK) ==
1280 MachO::EXPORT_SYMBOL_FLAGS_KIND_ABSOLUTE);
1281 bool Resolver = (EFlags &
1282 MachO::EXPORT_SYMBOL_FLAGS_STUB_AND_RESOLVER);
1283 ReExport = (EFlags & MachO::EXPORT_SYMBOL_FLAGS_REEXPORT);
1284 bool WeakDef = (EFlags & MachO::EXPORT_SYMBOL_FLAGS_WEAK_DEFINITION);
1285 if (WeakDef)
1286 S.NDesc |= MachO::N_WEAK_DEF;
1287 if (Abs) {
1288 S.NType = MachO::N_EXT | MachO::N_ABS;
1289 S.TypeChar = 'A';
1290 } else if (ReExport) {
1291 S.NType = MachO::N_EXT | MachO::N_INDR;
1292 S.TypeChar = 'I';
1293 } else {
1294 S.NType = MachO::N_EXT | MachO::N_SECT;
1295 if (Resolver) {
1296 S.Address = Entry.other() + BaseSegmentAddress;
1297 if ((S.Address & 1) != 0 &&
1298 !MachO->is64Bit() && H.cputype == MachO::CPU_TYPE_ARM){
1299 S.Address &= ~1LL;
1300 S.NDesc |= MachO::N_ARM_THUMB_DEF;
1301 }
1302 } else {
1303 S.Address = Entry.address() + BaseSegmentAddress;
1304 }
1305 StringRef SegmentName = StringRef();
1306 StringRef SectionName = StringRef();
1307 for (const SectionRef &Section : MachO->sections()) {
1308 S.NSect++;
1309 Section.getName(SectionName);
1310 SegmentName = MachO->getSectionFinalSegmentName(
1311 Section.getRawDataRefImpl());
1312 if (S.Address >= Section.getAddress() &&
1313 S.Address < Section.getAddress() + Section.getSize()) {
1314 S.Section = Section;
1315 break;
1316 } else if (Entry.name() == "__mh_execute_header" &&
1317 SegmentName == "__TEXT" && SectionName == "__text") {
1318 S.Section = Section;
1319 S.NDesc |= MachO::REFERENCED_DYNAMICALLY;
1320 break;
1321 }
1322 }
1323 if (SegmentName == "__TEXT" && SectionName == "__text")
1324 S.TypeChar = 'T';
1325 else if (SegmentName == "__DATA" && SectionName == "__data")
1326 S.TypeChar = 'D';
1327 else if (SegmentName == "__DATA" && SectionName == "__bss")
1328 S.TypeChar = 'B';
1329 else
1330 S.TypeChar = 'S';
1331 }
1332 SymbolList.push_back(S);
1333
1334 EOS << Entry.name();
1335 EOS << '\0';
1336 ExportsAdded++;
1337
1338 // For ReExports there are a two more things to do, first add the
1339 // indirect name and second create the undefined symbol using the
1340 // referened dynamic library.
1341 if (ReExport) {
1342
1343 // Add the indirect name.
1344 if (Entry.otherName().empty())
1345 EOS << Entry.name();
1346 else
1347 EOS << Entry.otherName();
1348 EOS << '\0';
1349
1350 // Now create the undefined symbol using the referened dynamic
1351 // library.
1352 NMSymbol U;
Kevin Enderbya8c4c012017-06-20 00:41:04 +00001353 memset(&U, '\0', sizeof(NMSymbol));
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001354 U.Address = 0;
1355 U.Size = 0;
1356 U.TypeChar = 'U';
1357 if (Entry.otherName().empty())
1358 U.Name = Entry.name();
1359 else
1360 U.Name = Entry.otherName();
1361 // Again there is no symbol in the nlist symbol table for this so
1362 // we set Sym effectivly to null and the rest of code in here must
1363 // test for it and not do things like Sym.getFlags() for it.
1364 U.Sym = BasicSymbolRef();
1365 U.SymFlags = SymbolRef::SF_Global | SymbolRef::SF_Undefined;
1366 U.Section = SectionRef();
1367 U.NType = MachO::N_EXT | MachO::N_UNDF;
1368 U.NSect = 0;
1369 U.NDesc = 0;
1370 // The library ordinal for this undefined symbol is in the export
1371 // trie Entry.other().
1372 MachO::SET_LIBRARY_ORDINAL(U.NDesc, Entry.other());
1373 U.IndirectName = StringRef();
1374 SymbolList.push_back(U);
1375
1376 // Finally add the undefined symbol's name.
1377 if (Entry.otherName().empty())
1378 EOS << Entry.name();
1379 else
1380 EOS << Entry.otherName();
1381 EOS << '\0';
1382 ExportsAdded++;
1383 }
1384 }
1385 }
Kevin Enderby3e95bd22017-07-20 23:08:41 +00001386 if (Err)
1387 error(std::move(Err), MachO->getFileName());
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001388 // Set the symbol names and indirect names for the added symbols.
1389 if (ExportsAdded) {
1390 EOS.flush();
1391 const char *Q = ExportsNameBuffer.c_str();
1392 for (unsigned K = 0; K < ExportsAdded; K++) {
1393 SymbolList[I].Name = Q;
1394 Q += strlen(Q) + 1;
1395 if (SymbolList[I].TypeChar == 'I') {
1396 SymbolList[I].IndirectName = Q;
1397 Q += strlen(Q) + 1;
1398 }
1399 I++;
1400 }
1401 }
1402
1403 // Add the undefined symbols from the bind entries.
1404 unsigned BindsAdded = 0;
1405 Error BErr = Error::success();
1406 StringRef LastSymbolName = StringRef();
1407 for (const llvm::object::MachOBindEntry &Entry : MachO->bindTable(BErr)) {
1408 bool found = false;
1409 if (LastSymbolName == Entry.symbolName())
1410 found = true;
1411 else if(!DyldInfoOnly) {
1412 for (unsigned J = 0; J < SymbolList.size() && !found; ++J) {
1413 if (SymbolList[J].Name == Entry.symbolName())
1414 found = true;
1415 }
1416 }
1417 if (!found) {
1418 LastSymbolName = Entry.symbolName();
1419 NMSymbol B;
Kevin Enderbya8c4c012017-06-20 00:41:04 +00001420 memset(&B, '\0', sizeof(NMSymbol));
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001421 B.Address = 0;
1422 B.Size = 0;
1423 B.TypeChar = 'U';
1424 // There is no symbol in the nlist symbol table for this so we set
1425 // Sym effectivly to null and the rest of code in here must test for
1426 // it and not do things like Sym.getFlags() for it.
1427 B.Sym = BasicSymbolRef();
1428 B.SymFlags = SymbolRef::SF_Global | SymbolRef::SF_Undefined;
1429 B.NType = MachO::N_EXT | MachO::N_UNDF;
1430 B.NSect = 0;
1431 B.NDesc = 0;
1432 B.NDesc = 0;
1433 MachO::SET_LIBRARY_ORDINAL(B.NDesc, Entry.ordinal());
1434 B.IndirectName = StringRef();
1435 B.Name = Entry.symbolName();
1436 SymbolList.push_back(B);
1437 BOS << Entry.symbolName();
1438 BOS << '\0';
1439 BindsAdded++;
1440 }
1441 }
1442 if (BErr)
1443 error(std::move(BErr), MachO->getFileName());
1444 // Set the symbol names and indirect names for the added symbols.
1445 if (BindsAdded) {
1446 BOS.flush();
1447 const char *Q = BindsNameBuffer.c_str();
1448 for (unsigned K = 0; K < BindsAdded; K++) {
1449 SymbolList[I].Name = Q;
1450 Q += strlen(Q) + 1;
1451 if (SymbolList[I].TypeChar == 'I') {
1452 SymbolList[I].IndirectName = Q;
1453 Q += strlen(Q) + 1;
1454 }
1455 I++;
1456 }
1457 }
1458
1459 // Add the undefined symbols from the lazy bind entries.
1460 unsigned LazysAdded = 0;
1461 Error LErr = Error::success();
1462 LastSymbolName = StringRef();
1463 for (const llvm::object::MachOBindEntry &Entry :
1464 MachO->lazyBindTable(LErr)) {
1465 bool found = false;
1466 if (LastSymbolName == Entry.symbolName())
1467 found = true;
1468 else {
1469 // Here we must check to see it this symbol is already in the
1470 // SymbolList as it might have already have been added above via a
1471 // non-lazy (bind) entry.
1472 for (unsigned J = 0; J < SymbolList.size() && !found; ++J) {
1473 if (SymbolList[J].Name == Entry.symbolName())
1474 found = true;
1475 }
1476 }
1477 if (!found) {
1478 LastSymbolName = Entry.symbolName();
1479 NMSymbol L;
Kevin Enderbya8c4c012017-06-20 00:41:04 +00001480 memset(&L, '\0', sizeof(NMSymbol));
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001481 L.Name = Entry.symbolName();
1482 L.Address = 0;
1483 L.Size = 0;
1484 L.TypeChar = 'U';
1485 // There is no symbol in the nlist symbol table for this so we set
1486 // Sym effectivly to null and the rest of code in here must test for
1487 // it and not do things like Sym.getFlags() for it.
1488 L.Sym = BasicSymbolRef();
1489 L.SymFlags = SymbolRef::SF_Global | SymbolRef::SF_Undefined;
1490 L.NType = MachO::N_EXT | MachO::N_UNDF;
1491 L.NSect = 0;
1492 // The REFERENCE_FLAG_UNDEFINED_LAZY is no longer used but here it
1493 // makes sence since we are creating this from a lazy bind entry.
1494 L.NDesc = MachO::REFERENCE_FLAG_UNDEFINED_LAZY;
1495 MachO::SET_LIBRARY_ORDINAL(L.NDesc, Entry.ordinal());
1496 L.IndirectName = StringRef();
1497 SymbolList.push_back(L);
1498 LOS << Entry.symbolName();
1499 LOS << '\0';
1500 LazysAdded++;
1501 }
1502 }
1503 if (LErr)
1504 error(std::move(LErr), MachO->getFileName());
1505 // Set the symbol names and indirect names for the added symbols.
1506 if (LazysAdded) {
1507 LOS.flush();
1508 const char *Q = LazysNameBuffer.c_str();
1509 for (unsigned K = 0; K < LazysAdded; K++) {
1510 SymbolList[I].Name = Q;
1511 Q += strlen(Q) + 1;
1512 if (SymbolList[I].TypeChar == 'I') {
1513 SymbolList[I].IndirectName = Q;
1514 Q += strlen(Q) + 1;
1515 }
1516 I++;
1517 }
1518 }
1519
1520 // Add the undefineds symbol from the weak bind entries which are not
1521 // strong symbols.
1522 unsigned WeaksAdded = 0;
1523 Error WErr = Error::success();
1524 LastSymbolName = StringRef();
1525 for (const llvm::object::MachOBindEntry &Entry :
1526 MachO->weakBindTable(WErr)) {
1527 bool found = false;
1528 unsigned J = 0;
1529 if (LastSymbolName == Entry.symbolName() ||
1530 Entry.flags() & MachO::BIND_SYMBOL_FLAGS_NON_WEAK_DEFINITION) {
1531 found = true;
1532 } else {
1533 for (J = 0; J < SymbolList.size() && !found; ++J) {
1534 if (SymbolList[J].Name == Entry.symbolName()) {
1535 found = true;
1536 break;
1537 }
1538 }
1539 }
1540 if (!found) {
1541 LastSymbolName = Entry.symbolName();
1542 NMSymbol W;
Kevin Enderbya8c4c012017-06-20 00:41:04 +00001543 memset(&W, '\0', sizeof(NMSymbol));
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001544 W.Name = Entry.symbolName();
1545 W.Address = 0;
1546 W.Size = 0;
1547 W.TypeChar = 'U';
1548 // There is no symbol in the nlist symbol table for this so we set
1549 // Sym effectivly to null and the rest of code in here must test for
1550 // it and not do things like Sym.getFlags() for it.
1551 W.Sym = BasicSymbolRef();
1552 W.SymFlags = SymbolRef::SF_Global | SymbolRef::SF_Undefined;
1553 W.NType = MachO::N_EXT | MachO::N_UNDF;
1554 W.NSect = 0;
1555 // Odd that we are using N_WEAK_DEF on an undefined symbol but that is
1556 // what is created in this case by the linker when there are real
1557 // symbols in the nlist structs.
1558 W.NDesc = MachO::N_WEAK_DEF;
1559 W.IndirectName = StringRef();
1560 SymbolList.push_back(W);
1561 WOS << Entry.symbolName();
1562 WOS << '\0';
1563 WeaksAdded++;
1564 } else {
1565 // This is the case the symbol was previously been found and it could
1566 // have been added from a bind or lazy bind symbol. If so and not
1567 // a definition also mark it as weak.
1568 if (SymbolList[J].TypeChar == 'U')
1569 // See comment above about N_WEAK_DEF.
1570 SymbolList[J].NDesc |= MachO::N_WEAK_DEF;
1571 }
1572 }
1573 if (WErr)
1574 error(std::move(WErr), MachO->getFileName());
1575 // Set the symbol names and indirect names for the added symbols.
1576 if (WeaksAdded) {
1577 WOS.flush();
1578 const char *Q = WeaksNameBuffer.c_str();
1579 for (unsigned K = 0; K < WeaksAdded; K++) {
1580 SymbolList[I].Name = Q;
1581 Q += strlen(Q) + 1;
1582 if (SymbolList[I].TypeChar == 'I') {
1583 SymbolList[I].IndirectName = Q;
1584 Q += strlen(Q) + 1;
1585 }
1586 I++;
1587 }
1588 }
Kevin Enderbyd3cf76b2018-03-22 23:59:35 +00001589
Kevin Enderbyd9911f62018-03-29 20:04:29 +00001590 // Trying adding symbol from the function starts table and LC_MAIN entry
1591 // point.
Kevin Enderbyd3cf76b2018-03-22 23:59:35 +00001592 SmallVector<uint64_t, 8> FoundFns;
Kevin Enderby41293082018-03-29 20:49:24 +00001593 uint64_t lc_main_offset = UINT64_MAX;
Kevin Enderbyd3cf76b2018-03-22 23:59:35 +00001594 for (const auto &Command : MachO->load_commands()) {
1595 if (Command.C.cmd == MachO::LC_FUNCTION_STARTS) {
1596 // We found a function starts segment, parse the addresses for
1597 // consumption.
1598 MachO::linkedit_data_command LLC =
1599 MachO->getLinkeditDataLoadCommand(Command);
1600
1601 MachO->ReadULEB128s(LLC.dataoff, FoundFns);
Kevin Enderbyd9911f62018-03-29 20:04:29 +00001602 } else if (Command.C.cmd == MachO::LC_MAIN) {
1603 MachO::entry_point_command LCmain =
1604 MachO->getEntryPointCommand(Command);
1605 lc_main_offset = LCmain.entryoff;
Kevin Enderbyd3cf76b2018-03-22 23:59:35 +00001606 }
1607 }
1608 // See if these addresses are already in the symbol table.
1609 unsigned FunctionStartsAdded = 0;
1610 for (uint64_t f = 0; f < FoundFns.size(); f++) {
1611 bool found = false;
1612 for (unsigned J = 0; J < SymbolList.size() && !found; ++J) {
1613 if (SymbolList[J].Address == FoundFns[f] + BaseSegmentAddress)
1614 found = true;
1615 }
1616 // See this address is not already in the symbol table fake up an
1617 // nlist for it.
1618 if (!found) {
1619 NMSymbol F;
1620 memset(&F, '\0', sizeof(NMSymbol));
1621 F.Name = "<redacted function X>";
1622 F.Address = FoundFns[f] + BaseSegmentAddress;
1623 F.Size = 0;
1624 // There is no symbol in the nlist symbol table for this so we set
1625 // Sym effectivly to null and the rest of code in here must test for
1626 // it and not do things like Sym.getFlags() for it.
1627 F.Sym = BasicSymbolRef();
1628 F.SymFlags = 0;
1629 F.NType = MachO::N_SECT;
1630 F.NSect = 0;
1631 StringRef SegmentName = StringRef();
1632 StringRef SectionName = StringRef();
1633 for (const SectionRef &Section : MachO->sections()) {
1634 Section.getName(SectionName);
1635 SegmentName = MachO->getSectionFinalSegmentName(
1636 Section.getRawDataRefImpl());
1637 F.NSect++;
1638 if (F.Address >= Section.getAddress() &&
1639 F.Address < Section.getAddress() + Section.getSize()) {
1640 F.Section = Section;
1641 break;
1642 }
1643 }
1644 if (SegmentName == "__TEXT" && SectionName == "__text")
1645 F.TypeChar = 't';
1646 else if (SegmentName == "__DATA" && SectionName == "__data")
1647 F.TypeChar = 'd';
1648 else if (SegmentName == "__DATA" && SectionName == "__bss")
1649 F.TypeChar = 'b';
1650 else
1651 F.TypeChar = 's';
1652 F.NDesc = 0;
1653 F.IndirectName = StringRef();
1654 SymbolList.push_back(F);
Kevin Enderby41293082018-03-29 20:49:24 +00001655 if (FoundFns[f] == lc_main_offset)
Kevin Enderbyd9911f62018-03-29 20:04:29 +00001656 FOS << "<redacted LC_MAIN>";
1657 else
1658 FOS << "<redacted function " << f << ">";
Kevin Enderbyd3cf76b2018-03-22 23:59:35 +00001659 FOS << '\0';
1660 FunctionStartsAdded++;
1661 }
1662 }
1663 if (FunctionStartsAdded) {
1664 FOS.flush();
1665 const char *Q = FunctionStartsNameBuffer.c_str();
1666 for (unsigned K = 0; K < FunctionStartsAdded; K++) {
1667 SymbolList[I].Name = Q;
1668 Q += strlen(Q) + 1;
1669 if (SymbolList[I].TypeChar == 'I') {
1670 SymbolList[I].IndirectName = Q;
1671 Q += strlen(Q) + 1;
1672 }
1673 I++;
1674 }
1675 }
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00001676 }
1677 }
1678
Rafael Espindolaceb23382014-07-31 21:00:10 +00001679 CurrentFilename = Obj.getFileName();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001680 sortAndPrintSymbolList(Obj, printName, ArchiveName, ArchitectureName);
Brian Gaeke0af759d2003-10-16 04:43:15 +00001681}
1682
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001683// checkMachOAndArchFlags() checks to see if the SymbolicFile is a Mach-O file
1684// and if it is and there is a list of architecture flags is specified then
1685// check to make sure this Mach-O file is one of those architectures or all
1686// architectures was specificed. If not then an error is generated and this
1687// routine returns false. Else it returns true.
1688static bool checkMachOAndArchFlags(SymbolicFile *O, std::string &Filename) {
David Majnemer91160d82016-10-31 17:11:31 +00001689 auto *MachO = dyn_cast<MachOObjectFile>(O);
David Blaikie328c0c12015-03-23 21:17:43 +00001690
David Majnemer91160d82016-10-31 17:11:31 +00001691 if (!MachO || ArchAll || ArchFlags.empty())
David Blaikie328c0c12015-03-23 21:17:43 +00001692 return true;
1693
1694 MachO::mach_header H;
1695 MachO::mach_header_64 H_64;
1696 Triple T;
Kevin Enderby31e85302017-01-25 21:33:38 +00001697 const char *McpuDefault, *ArchFlag;
David Blaikie328c0c12015-03-23 21:17:43 +00001698 if (MachO->is64Bit()) {
1699 H_64 = MachO->MachOObjectFile::getHeader64();
Kevin Enderby31e85302017-01-25 21:33:38 +00001700 T = MachOObjectFile::getArchTriple(H_64.cputype, H_64.cpusubtype,
1701 &McpuDefault, &ArchFlag);
David Blaikie328c0c12015-03-23 21:17:43 +00001702 } else {
1703 H = MachO->MachOObjectFile::getHeader();
Kevin Enderby31e85302017-01-25 21:33:38 +00001704 T = MachOObjectFile::getArchTriple(H.cputype, H.cpusubtype,
1705 &McpuDefault, &ArchFlag);
David Blaikie328c0c12015-03-23 21:17:43 +00001706 }
Kevin Enderby31e85302017-01-25 21:33:38 +00001707 const std::string ArchFlagName(ArchFlag);
David Majnemer91a02f52016-08-12 04:32:45 +00001708 if (none_of(ArchFlags, [&](const std::string &Name) {
Kevin Enderby31e85302017-01-25 21:33:38 +00001709 return Name == ArchFlagName;
David Majnemer91a02f52016-08-12 04:32:45 +00001710 })) {
David Blaikie328c0c12015-03-23 21:17:43 +00001711 error("No architecture specified", Filename);
1712 return false;
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001713 }
1714 return true;
1715}
1716
Rafael Espindola619581c2014-01-29 04:56:19 +00001717static void dumpSymbolNamesFromFile(std::string &Filename) {
Rafael Espindolaadf21f22014-07-06 17:43:13 +00001718 ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
1719 MemoryBuffer::getFileOrSTDIN(Filename);
1720 if (error(BufferOrErr.getError(), Filename))
Michael J. Spencerbc96f372011-12-13 23:17:29 +00001721 return;
1722
Mehdi Amini03b42e42016-04-14 21:59:01 +00001723 LLVMContext Context;
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +00001724 Expected<std::unique_ptr<Binary>> BinaryOrErr = createBinary(
Peter Collingbourne10039c02014-09-18 21:28:49 +00001725 BufferOrErr.get()->getMemBufferRef(), NoLLVMBitcode ? nullptr : &Context);
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +00001726 if (!BinaryOrErr) {
Kevin Enderby600fb3f2016-08-05 18:19:40 +00001727 error(BinaryOrErr.takeError(), Filename);
Rafael Espindolace82a072014-01-30 19:24:00 +00001728 return;
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +00001729 }
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001730 Binary &Bin = *BinaryOrErr.get();
Shankar Easwaran15b28be2012-11-13 18:38:42 +00001731
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001732 if (Archive *A = dyn_cast<Archive>(&Bin)) {
Rafael Espindolace82a072014-01-30 19:24:00 +00001733 if (ArchiveMap) {
Rafael Espindola0115b082014-01-30 21:51:42 +00001734 Archive::symbol_iterator I = A->symbol_begin();
1735 Archive::symbol_iterator E = A->symbol_end();
Rafael Espindolace82a072014-01-30 19:24:00 +00001736 if (I != E) {
Rafael Espindola0115b082014-01-30 21:51:42 +00001737 outs() << "Archive map\n";
Rafael Espindolace82a072014-01-30 19:24:00 +00001738 for (; I != E; ++I) {
Kevin Enderby27e85bd2016-08-03 21:57:47 +00001739 Expected<Archive::Child> C = I->getMember();
1740 if (!C)
1741 error(C.takeError(), Filename);
Kevin Enderbyf4586032016-07-29 17:44:13 +00001742 Expected<StringRef> FileNameOrErr = C->getName();
1743 if (!FileNameOrErr) {
1744 error(FileNameOrErr.takeError(), Filename);
Rafael Espindolace82a072014-01-30 19:24:00 +00001745 return;
Kevin Enderbyf4586032016-07-29 17:44:13 +00001746 }
Rafael Espindolaae460022014-06-16 16:08:36 +00001747 StringRef SymName = I->getName();
1748 outs() << SymName << " in " << FileNameOrErr.get() << "\n";
Michael J. Spencer2bc774a2011-09-27 19:37:18 +00001749 }
Rafael Espindolace82a072014-01-30 19:24:00 +00001750 outs() << "\n";
Michael J. Spencer2bc774a2011-09-27 19:37:18 +00001751 }
1752 }
Alexey Samsonove6388e62013-06-18 15:03:28 +00001753
Lang Hamesfc209622016-07-14 02:24:01 +00001754 {
Mehdi Amini41af4302016-11-11 04:28:40 +00001755 Error Err = Error::success();
Lang Hamesfc209622016-07-14 02:24:01 +00001756 for (auto &C : A->children(Err)) {
1757 Expected<std::unique_ptr<Binary>> ChildOrErr = C.getAsBinary(&Context);
1758 if (!ChildOrErr) {
1759 if (auto E = isNotObjectErrorInvalidFileType(ChildOrErr.takeError()))
1760 error(std::move(E), Filename, C);
1761 continue;
Lang Hamesae610ab2016-07-14 00:37:04 +00001762 }
Lang Hamesfc209622016-07-14 02:24:01 +00001763 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
Kevin Enderby31e85302017-01-25 21:33:38 +00001764 if (!MachOPrintSizeWarning && PrintSize && isa<MachOObjectFile>(O)) {
1765 errs() << ToolName << ": warning sizes with -print-size for Mach-O "
1766 "files are always zero.\n";
1767 MachOPrintSizeWarning = true;
1768 }
Lang Hamesfc209622016-07-14 02:24:01 +00001769 if (!checkMachOAndArchFlags(O, Filename))
1770 return;
1771 if (!PrintFileName) {
1772 outs() << "\n";
1773 if (isa<MachOObjectFile>(O)) {
1774 outs() << Filename << "(" << O->getFileName() << ")";
1775 } else
1776 outs() << O->getFileName();
1777 outs() << ":\n";
1778 }
1779 dumpSymbolNamesFromObject(*O, false, Filename);
1780 }
Lang Hamesae610ab2016-07-14 00:37:04 +00001781 }
Lang Hamesfc209622016-07-14 02:24:01 +00001782 if (Err)
1783 error(std::move(Err), A->getFileName());
Rafael Espindolace82a072014-01-30 19:24:00 +00001784 }
1785 return;
1786 }
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001787 if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(&Bin)) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001788 // If we have a list of architecture flags specified dump only those.
1789 if (!ArchAll && ArchFlags.size() != 0) {
1790 // Look for a slice in the universal binary that matches each ArchFlag.
1791 bool ArchFound;
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00001792 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001793 ArchFound = false;
1794 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1795 E = UB->end_objects();
1796 I != E; ++I) {
Kevin Enderby59343a92016-12-16 22:54:02 +00001797 if (ArchFlags[i] == I->getArchFlagName()) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001798 ArchFound = true;
Kevin Enderby9acb1092016-05-31 20:35:34 +00001799 Expected<std::unique_ptr<ObjectFile>> ObjOrErr =
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00001800 I->getAsObjectFile();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001801 std::string ArchiveName;
1802 std::string ArchitectureName;
1803 ArchiveName.clear();
1804 ArchitectureName.clear();
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001805 if (ObjOrErr) {
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001806 ObjectFile &Obj = *ObjOrErr.get();
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001807 if (ArchFlags.size() > 1) {
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001808 if (PrintFileName)
Kevin Enderby59343a92016-12-16 22:54:02 +00001809 ArchitectureName = I->getArchFlagName();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001810 else
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001811 outs() << "\n" << Obj.getFileName() << " (for architecture "
Kevin Enderby59343a92016-12-16 22:54:02 +00001812 << I->getArchFlagName() << ")"
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001813 << ":\n";
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001814 }
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001815 dumpSymbolNamesFromObject(Obj, false, ArchiveName,
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001816 ArchitectureName);
Kevin Enderby9acb1092016-05-31 20:35:34 +00001817 } else if (auto E = isNotObjectErrorInvalidFileType(
1818 ObjOrErr.takeError())) {
1819 error(std::move(E), Filename, ArchFlags.size() > 1 ?
Kevin Enderby59343a92016-12-16 22:54:02 +00001820 StringRef(I->getArchFlagName()) : StringRef());
Kevin Enderby9acb1092016-05-31 20:35:34 +00001821 continue;
Kevin Enderby42398052016-06-28 23:16:13 +00001822 } else if (Expected<std::unique_ptr<Archive>> AOrErr =
Rafael Espindola0bfe8282014-12-09 21:05:36 +00001823 I->getAsArchive()) {
1824 std::unique_ptr<Archive> &A = *AOrErr;
Mehdi Amini41af4302016-11-11 04:28:40 +00001825 Error Err = Error::success();
Lang Hamesfc209622016-07-14 02:24:01 +00001826 for (auto &C : A->children(Err)) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001827 Expected<std::unique_ptr<Binary>> ChildOrErr =
Kevin Enderby7a969422015-11-05 19:24:56 +00001828 C.getAsBinary(&Context);
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001829 if (!ChildOrErr) {
1830 if (auto E = isNotObjectErrorInvalidFileType(
Kevin Enderby9acb1092016-05-31 20:35:34 +00001831 ChildOrErr.takeError())) {
1832 error(std::move(E), Filename, C, ArchFlags.size() > 1 ?
Kevin Enderby59343a92016-12-16 22:54:02 +00001833 StringRef(I->getArchFlagName()) : StringRef());
Kevin Enderby9acb1092016-05-31 20:35:34 +00001834 }
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001835 continue;
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001836 }
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00001837 if (SymbolicFile *O =
1838 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001839 if (PrintFileName) {
1840 ArchiveName = A->getFileName();
1841 if (ArchFlags.size() > 1)
Kevin Enderby59343a92016-12-16 22:54:02 +00001842 ArchitectureName = I->getArchFlagName();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001843 } else {
1844 outs() << "\n" << A->getFileName();
1845 outs() << "(" << O->getFileName() << ")";
1846 if (ArchFlags.size() > 1) {
Kevin Enderby59343a92016-12-16 22:54:02 +00001847 outs() << " (for architecture " << I->getArchFlagName()
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001848 << ")";
1849 }
1850 outs() << ":\n";
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001851 }
Rafael Espindolaceb23382014-07-31 21:00:10 +00001852 dumpSymbolNamesFromObject(*O, false, ArchiveName,
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001853 ArchitectureName);
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001854 }
1855 }
Lang Hamesfc209622016-07-14 02:24:01 +00001856 if (Err)
1857 error(std::move(Err), A->getFileName());
Kevin Enderby42398052016-06-28 23:16:13 +00001858 } else {
1859 consumeError(AOrErr.takeError());
1860 error(Filename + " for architecture " +
Kevin Enderby59343a92016-12-16 22:54:02 +00001861 StringRef(I->getArchFlagName()) +
Kevin Enderby42398052016-06-28 23:16:13 +00001862 " is not a Mach-O file or an archive file",
1863 "Mach-O universal file");
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001864 }
1865 }
1866 }
1867 if (!ArchFound) {
1868 error(ArchFlags[i],
1869 "file: " + Filename + " does not contain architecture");
1870 return;
1871 }
1872 }
1873 return;
1874 }
1875 // No architecture flags were specified so if this contains a slice that
1876 // matches the host architecture dump only that.
1877 if (!ArchAll) {
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00001878 StringRef HostArchName = MachOObjectFile::getHostArch().getArchName();
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001879 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1880 E = UB->end_objects();
1881 I != E; ++I) {
Kevin Enderby59343a92016-12-16 22:54:02 +00001882 if (HostArchName == I->getArchFlagName()) {
Kevin Enderby9acb1092016-05-31 20:35:34 +00001883 Expected<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001884 std::string ArchiveName;
1885 ArchiveName.clear();
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001886 if (ObjOrErr) {
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001887 ObjectFile &Obj = *ObjOrErr.get();
1888 dumpSymbolNamesFromObject(Obj, false);
Kevin Enderby9acb1092016-05-31 20:35:34 +00001889 } else if (auto E = isNotObjectErrorInvalidFileType(
1890 ObjOrErr.takeError())) {
1891 error(std::move(E), Filename);
1892 return;
Kevin Enderby42398052016-06-28 23:16:13 +00001893 } else if (Expected<std::unique_ptr<Archive>> AOrErr =
Rafael Espindola0bfe8282014-12-09 21:05:36 +00001894 I->getAsArchive()) {
1895 std::unique_ptr<Archive> &A = *AOrErr;
Mehdi Amini41af4302016-11-11 04:28:40 +00001896 Error Err = Error::success();
Lang Hamesfc209622016-07-14 02:24:01 +00001897 for (auto &C : A->children(Err)) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001898 Expected<std::unique_ptr<Binary>> ChildOrErr =
Kevin Enderby7a969422015-11-05 19:24:56 +00001899 C.getAsBinary(&Context);
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001900 if (!ChildOrErr) {
1901 if (auto E = isNotObjectErrorInvalidFileType(
1902 ChildOrErr.takeError()))
1903 error(std::move(E), Filename, C);
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001904 continue;
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001905 }
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00001906 if (SymbolicFile *O =
1907 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001908 if (PrintFileName)
1909 ArchiveName = A->getFileName();
1910 else
1911 outs() << "\n" << A->getFileName() << "(" << O->getFileName()
1912 << ")"
1913 << ":\n";
Rafael Espindolaceb23382014-07-31 21:00:10 +00001914 dumpSymbolNamesFromObject(*O, false, ArchiveName);
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001915 }
1916 }
Lang Hamesfc209622016-07-14 02:24:01 +00001917 if (Err)
1918 error(std::move(Err), A->getFileName());
Kevin Enderby42398052016-06-28 23:16:13 +00001919 } else {
1920 consumeError(AOrErr.takeError());
1921 error(Filename + " for architecture " +
Kevin Enderby59343a92016-12-16 22:54:02 +00001922 StringRef(I->getArchFlagName()) +
Kevin Enderby42398052016-06-28 23:16:13 +00001923 " is not a Mach-O file or an archive file",
1924 "Mach-O universal file");
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001925 }
1926 return;
1927 }
1928 }
1929 }
1930 // Either all architectures have been specified or none have been specified
1931 // and this does not contain the host architecture so dump all the slices.
Kevin Enderby1983fcf2014-06-19 22:03:18 +00001932 bool moreThanOneArch = UB->getNumberOfObjects() > 1;
Rafael Espindola0115b082014-01-30 21:51:42 +00001933 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1934 E = UB->end_objects();
Alexey Samsonove6388e62013-06-18 15:03:28 +00001935 I != E; ++I) {
Kevin Enderby9acb1092016-05-31 20:35:34 +00001936 Expected<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001937 std::string ArchiveName;
1938 std::string ArchitectureName;
1939 ArchiveName.clear();
1940 ArchitectureName.clear();
Rafael Espindola4f7932b2014-06-23 20:41:02 +00001941 if (ObjOrErr) {
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001942 ObjectFile &Obj = *ObjOrErr.get();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001943 if (PrintFileName) {
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001944 if (isa<MachOObjectFile>(Obj) && moreThanOneArch)
Kevin Enderby59343a92016-12-16 22:54:02 +00001945 ArchitectureName = I->getArchFlagName();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001946 } else {
1947 if (moreThanOneArch)
1948 outs() << "\n";
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001949 outs() << Obj.getFileName();
1950 if (isa<MachOObjectFile>(Obj) && moreThanOneArch)
Kevin Enderby59343a92016-12-16 22:54:02 +00001951 outs() << " (for architecture " << I->getArchFlagName() << ")";
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001952 outs() << ":\n";
1953 }
Rafael Espindola3f6481d2014-08-01 14:31:55 +00001954 dumpSymbolNamesFromObject(Obj, false, ArchiveName, ArchitectureName);
Kevin Enderby9acb1092016-05-31 20:35:34 +00001955 } else if (auto E = isNotObjectErrorInvalidFileType(
1956 ObjOrErr.takeError())) {
1957 error(std::move(E), Filename, moreThanOneArch ?
Kevin Enderby59343a92016-12-16 22:54:02 +00001958 StringRef(I->getArchFlagName()) : StringRef());
Kevin Enderby9acb1092016-05-31 20:35:34 +00001959 continue;
Kevin Enderby42398052016-06-28 23:16:13 +00001960 } else if (Expected<std::unique_ptr<Archive>> AOrErr =
1961 I->getAsArchive()) {
Rafael Espindola0bfe8282014-12-09 21:05:36 +00001962 std::unique_ptr<Archive> &A = *AOrErr;
Mehdi Amini41af4302016-11-11 04:28:40 +00001963 Error Err = Error::success();
Lang Hamesfc209622016-07-14 02:24:01 +00001964 for (auto &C : A->children(Err)) {
Kevin Enderby9acb1092016-05-31 20:35:34 +00001965 Expected<std::unique_ptr<Binary>> ChildOrErr =
1966 C.getAsBinary(&Context);
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001967 if (!ChildOrErr) {
1968 if (auto E = isNotObjectErrorInvalidFileType(
1969 ChildOrErr.takeError()))
Kevin Enderby9acb1092016-05-31 20:35:34 +00001970 error(std::move(E), Filename, C, moreThanOneArch ?
1971 StringRef(ArchitectureName) : StringRef());
Kevin Enderbye858a652014-05-14 21:18:50 +00001972 continue;
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001973 }
Rafael Espindolaae460022014-06-16 16:08:36 +00001974 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001975 if (PrintFileName) {
1976 ArchiveName = A->getFileName();
1977 if (isa<MachOObjectFile>(O) && moreThanOneArch)
Kevin Enderby59343a92016-12-16 22:54:02 +00001978 ArchitectureName = I->getArchFlagName();
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001979 } else {
1980 outs() << "\n" << A->getFileName();
1981 if (isa<MachOObjectFile>(O)) {
1982 outs() << "(" << O->getFileName() << ")";
1983 if (moreThanOneArch)
Kevin Enderby59343a92016-12-16 22:54:02 +00001984 outs() << " (for architecture " << I->getArchFlagName()
Kevin Enderby08e1bbd2014-07-24 23:31:52 +00001985 << ")";
1986 } else
1987 outs() << ":" << O->getFileName();
1988 outs() << ":\n";
1989 }
Rafael Espindolaceb23382014-07-31 21:00:10 +00001990 dumpSymbolNamesFromObject(*O, false, ArchiveName, ArchitectureName);
Kevin Enderbye858a652014-05-14 21:18:50 +00001991 }
1992 }
Lang Hamesfc209622016-07-14 02:24:01 +00001993 if (Err)
1994 error(std::move(Err), A->getFileName());
Kevin Enderby42398052016-06-28 23:16:13 +00001995 } else {
1996 consumeError(AOrErr.takeError());
1997 error(Filename + " for architecture " +
Kevin Enderby59343a92016-12-16 22:54:02 +00001998 StringRef(I->getArchFlagName()) +
Kevin Enderby42398052016-06-28 23:16:13 +00001999 " is not a Mach-O file or an archive file",
2000 "Mach-O universal file");
Kevin Enderbye858a652014-05-14 21:18:50 +00002001 }
Alexey Samsonove6388e62013-06-18 15:03:28 +00002002 }
Brian Gaeke618026a2003-11-19 21:57:30 +00002003 return;
Brian Gaeke0af759d2003-10-16 04:43:15 +00002004 }
Rafael Espindola3f6481d2014-08-01 14:31:55 +00002005 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&Bin)) {
Kevin Enderby31e85302017-01-25 21:33:38 +00002006 if (!MachOPrintSizeWarning && PrintSize && isa<MachOObjectFile>(O)) {
2007 errs() << ToolName << ": warning sizes with -print-size for Mach-O files "
2008 "are always zero.\n";
2009 MachOPrintSizeWarning = true;
2010 }
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00002011 if (!checkMachOAndArchFlags(O, Filename))
2012 return;
Rafael Espindolaceb23382014-07-31 21:00:10 +00002013 dumpSymbolNamesFromObject(*O, true);
Rafael Espindolace82a072014-01-30 19:24:00 +00002014 }
Brian Gaeke0af759d2003-10-16 04:43:15 +00002015}
2016
2017int main(int argc, char **argv) {
Rui Ueyama197194b2018-04-13 18:26:06 +00002018 InitLLVM X(argc, argv);
Chris Lattnere3fc2d12009-03-06 05:34:10 +00002019 cl::ParseCommandLineOptions(argc, argv, "llvm symbol table dumper\n");
Chris Lattner12439ff2004-02-19 20:32:12 +00002020
Michael J. Spencerbc96f372011-12-13 23:17:29 +00002021 // llvm-nm only reads binary files.
Rafael Espindolacb2eca02013-06-12 20:58:35 +00002022 if (error(sys::ChangeStdinToBinary()))
Michael J. Spencerbc96f372011-12-13 23:17:29 +00002023 return 1;
2024
Davide Italiano63634cb2016-01-29 23:38:05 +00002025 // These calls are needed so that we can read bitcode correctly.
Rafael Espindola13b69d62014-07-03 18:59:23 +00002026 llvm::InitializeAllTargetInfos();
2027 llvm::InitializeAllTargetMCs();
2028 llvm::InitializeAllAsmParsers();
2029
Chris Lattneref8f3892007-05-06 05:36:18 +00002030 ToolName = argv[0];
Rafael Espindola619581c2014-01-29 04:56:19 +00002031 if (BSDFormat)
2032 OutputFormat = bsd;
2033 if (POSIXFormat)
2034 OutputFormat = posix;
Kevin Enderby14a96ac2014-06-20 00:04:16 +00002035 if (DarwinFormat)
2036 OutputFormat = darwin;
Chris Lattner4aae1f42003-10-16 18:45:23 +00002037
Michael J. Spencerb8672a52011-01-20 06:38:57 +00002038 // The relative order of these is important. If you pass --size-sort it should
2039 // only print out the size. However, if you pass -S --size-sort, it should
Rafael Espindolab4865d62014-04-03 00:19:35 +00002040 // print out both the size and address.
Rafael Espindola619581c2014-01-29 04:56:19 +00002041 if (SizeSort && !PrintSize)
Rafael Espindolab4865d62014-04-03 00:19:35 +00002042 PrintAddress = false;
Rafael Espindola619581c2014-01-29 04:56:19 +00002043 if (OutputFormat == sysv || SizeSort)
2044 PrintSize = true;
Davide Italianoda570132016-02-05 22:10:42 +00002045 if (InputFilenames.empty())
Kevin Enderby4fc2edb2014-06-23 20:27:53 +00002046 InputFilenames.push_back("a.out");
Davide Italianod5353652016-02-05 22:07:09 +00002047 if (InputFilenames.size() > 1)
Rafael Espindola619581c2014-01-29 04:56:19 +00002048 MultipleFiles = true;
Chris Lattneref8f3892007-05-06 05:36:18 +00002049
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00002050 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00002051 if (ArchFlags[i] == "all") {
2052 ArchAll = true;
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00002053 } else {
Rafael Espindola72318b42014-08-08 16:30:17 +00002054 if (!MachOObjectFile::isValidArch(ArchFlags[i]))
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00002055 error("Unknown architecture named '" + ArchFlags[i] + "'",
2056 "for the -arch option");
2057 }
2058 }
2059
Kevin Enderbyfe6ad972014-07-11 20:30:00 +00002060 if (SegSect.size() != 0 && SegSect.size() != 2)
2061 error("bad number of arguments (must be two arguments)",
2062 "for the -s option");
2063
Kevin Enderbydf0d6da2017-06-19 19:38:22 +00002064 if (NoDyldInfo && (AddDyldInfo || DyldInfoOnly))
2065 error("-no-dyldinfo can't be used with -add-dyldinfo or -dyldinfo-only");
2066
Aaron Ballmanecf0e952017-11-03 20:01:25 +00002067 llvm::for_each(InputFilenames, dumpSymbolNamesFromFile);
Rafael Espindola8b82a4d2013-07-03 15:46:03 +00002068
2069 if (HadError)
2070 return 1;
Brian Gaeke0af759d2003-10-16 04:43:15 +00002071}