blob: 64aae5e0c34639ef109192ac9b99b036cc8380da [file] [log] [blame]
Brian Gaeke0af759d2003-10-16 04:43:15 +00001//===-- llvm-nm.cpp - Symbol table dumping utility for llvm ---------------===//
Misha Brukman650ba8e2005-04-22 00:00:37 +00002//
John Criswell09344dc2003-10-20 17:47:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner345353d2007-12-29 20:44:31 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukman650ba8e2005-04-22 00:00:37 +00007//
John Criswell09344dc2003-10-20 17:47:21 +00008//===----------------------------------------------------------------------===//
Brian Gaeke0af759d2003-10-16 04:43:15 +00009//
Michael J. Spencer838e5ad2012-06-06 23:34:10 +000010// This program is a utility that works like traditional Unix "nm", that is, it
11// prints out the names of symbols in a bitcode or object file, along with some
12// information about each symbol.
Misha Brukman650ba8e2005-04-22 00:00:37 +000013//
Michael J. Spencer838e5ad2012-06-06 23:34:10 +000014// This "nm" supports many of the features of GNU "nm", including its different
15// output formats.
Brian Gaeke0af759d2003-10-16 04:43:15 +000016//
17//===----------------------------------------------------------------------===//
18
Rafael Espindolaf12b8282014-02-21 20:10:59 +000019#include "llvm/IR/Function.h"
20#include "llvm/IR/GlobalAlias.h"
21#include "llvm/IR/GlobalVariable.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000022#include "llvm/IR/LLVMContext.h"
Michael J. Spencer2bc774a2011-09-27 19:37:18 +000023#include "llvm/Object/Archive.h"
Rafael Espindola586af97a2013-11-02 21:16:09 +000024#include "llvm/Object/COFF.h"
25#include "llvm/Object/ELFObjectFile.h"
Chandler Carruth442f7842014-03-04 10:07:28 +000026#include "llvm/Object/IRObjectFile.h"
Rafael Espindola586af97a2013-11-02 21:16:09 +000027#include "llvm/Object/MachO.h"
Alexey Samsonove6388e62013-06-18 15:03:28 +000028#include "llvm/Object/MachOUniversal.h"
Michael J. Spencerb8672a52011-01-20 06:38:57 +000029#include "llvm/Object/ObjectFile.h"
Rui Ueyamaf078eff2014-03-18 23:37:53 +000030#include "llvm/Support/COFF.h"
Reid Spencer7c16caa2004-09-01 22:55:40 +000031#include "llvm/Support/CommandLine.h"
Michael J. Spencerb8672a52011-01-20 06:38:57 +000032#include "llvm/Support/FileSystem.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000033#include "llvm/Support/Format.h"
Chris Lattner76d46322006-12-06 01:18:01 +000034#include "llvm/Support/ManagedStatic.h"
Chris Lattneref8f3892007-05-06 05:36:18 +000035#include "llvm/Support/MemoryBuffer.h"
Chris Lattnere3fc2d12009-03-06 05:34:10 +000036#include "llvm/Support/PrettyStackTrace.h"
Michael J. Spencerbc96f372011-12-13 23:17:29 +000037#include "llvm/Support/Program.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000038#include "llvm/Support/Signals.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000039#include "llvm/Support/raw_ostream.h"
Jeff Cohenb622c112007-03-05 00:00:42 +000040#include <algorithm>
Brian Gaeke0af759d2003-10-16 04:43:15 +000041#include <cctype>
Alkis Evlogimenosf68f40e2004-04-21 16:11:40 +000042#include <cerrno>
Brian Gaeke55447b42003-11-19 21:52:09 +000043#include <cstring>
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000044#include <system_error>
Michael J. Spencerb8672a52011-01-20 06:38:57 +000045#include <vector>
Brian Gaeke960707c2003-11-11 22:41:34 +000046using namespace llvm;
Michael J. Spencerb8672a52011-01-20 06:38:57 +000047using namespace object;
Brian Gaeke960707c2003-11-11 22:41:34 +000048
Brian Gaeke0af759d2003-10-16 04:43:15 +000049namespace {
Kevin Enderby980b2582014-06-05 21:21:57 +000050enum OutputFormatTy { bsd, sysv, posix, darwin };
Rafael Espindola619581c2014-01-29 04:56:19 +000051cl::opt<OutputFormatTy> OutputFormat(
52 "format", cl::desc("Specify output format"),
53 cl::values(clEnumVal(bsd, "BSD format"), clEnumVal(sysv, "System V format"),
Kevin Enderby980b2582014-06-05 21:21:57 +000054 clEnumVal(posix, "POSIX.2 format"),
55 clEnumVal(darwin, "Darwin -m format"), clEnumValEnd),
Rafael Espindola619581c2014-01-29 04:56:19 +000056 cl::init(bsd));
57cl::alias OutputFormat2("f", cl::desc("Alias for --format"),
58 cl::aliasopt(OutputFormat));
Brian Gaeke0af759d2003-10-16 04:43:15 +000059
Rafael Espindolaf12b8282014-02-21 20:10:59 +000060cl::list<std::string> InputFilenames(cl::Positional, cl::desc("<input files>"),
Rafael Espindola619581c2014-01-29 04:56:19 +000061 cl::ZeroOrMore);
Brian Gaeke0af759d2003-10-16 04:43:15 +000062
Rafael Espindola619581c2014-01-29 04:56:19 +000063cl::opt<bool> UndefinedOnly("undefined-only",
64 cl::desc("Show only undefined symbols"));
65cl::alias UndefinedOnly2("u", cl::desc("Alias for --undefined-only"),
66 cl::aliasopt(UndefinedOnly));
Brian Gaeke0af759d2003-10-16 04:43:15 +000067
Rafael Espindola619581c2014-01-29 04:56:19 +000068cl::opt<bool> DynamicSyms("dynamic",
69 cl::desc("Display the dynamic symbols instead "
70 "of normal symbols."));
71cl::alias DynamicSyms2("D", cl::desc("Alias for --dynamic"),
72 cl::aliasopt(DynamicSyms));
Michael J. Spencer8c4729f2012-02-28 00:40:37 +000073
Rafael Espindola619581c2014-01-29 04:56:19 +000074cl::opt<bool> DefinedOnly("defined-only",
75 cl::desc("Show only defined symbols"));
Brian Gaeke0af759d2003-10-16 04:43:15 +000076
Rafael Espindola619581c2014-01-29 04:56:19 +000077cl::opt<bool> ExternalOnly("extern-only",
78 cl::desc("Show only external symbols"));
79cl::alias ExternalOnly2("g", cl::desc("Alias for --extern-only"),
80 cl::aliasopt(ExternalOnly));
Brian Gaeke0af759d2003-10-16 04:43:15 +000081
Rafael Espindola619581c2014-01-29 04:56:19 +000082cl::opt<bool> BSDFormat("B", cl::desc("Alias for --format=bsd"));
83cl::opt<bool> POSIXFormat("P", cl::desc("Alias for --format=posix"));
Kevin Enderby14a96ac2014-06-20 00:04:16 +000084cl::opt<bool> DarwinFormat("m", cl::desc("Alias for --format=darwin"));
Brian Gaeke0af759d2003-10-16 04:43:15 +000085
Kevin Enderby8f6dcf52014-07-01 22:44:51 +000086static cl::list<std::string>
87ArchFlags("arch", cl::desc("architecture(s) from a Mach-O file to dump"),
88 cl::ZeroOrMore);
Kevin Enderby4c8dfe42014-06-30 18:45:23 +000089bool ArchAll = false;
90
Rafael Espindola619581c2014-01-29 04:56:19 +000091cl::opt<bool> PrintFileName(
92 "print-file-name",
Michael J. Spencerb8672a52011-01-20 06:38:57 +000093 cl::desc("Precede each symbol with the object file it came from"));
94
Rafael Espindola619581c2014-01-29 04:56:19 +000095cl::alias PrintFileNameA("A", cl::desc("Alias for --print-file-name"),
96 cl::aliasopt(PrintFileName));
97cl::alias PrintFileNameo("o", cl::desc("Alias for --print-file-name"),
98 cl::aliasopt(PrintFileName));
Michael J. Spencerb8672a52011-01-20 06:38:57 +000099
Rafael Espindola619581c2014-01-29 04:56:19 +0000100cl::opt<bool> DebugSyms("debug-syms",
101 cl::desc("Show all symbols, even debugger only"));
102cl::alias DebugSymsa("a", cl::desc("Alias for --debug-syms"),
103 cl::aliasopt(DebugSyms));
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000104
Rafael Espindolab4865d62014-04-03 00:19:35 +0000105cl::opt<bool> NumericSort("numeric-sort", cl::desc("Sort symbols by address"));
Rafael Espindola619581c2014-01-29 04:56:19 +0000106cl::alias NumericSortn("n", cl::desc("Alias for --numeric-sort"),
107 cl::aliasopt(NumericSort));
108cl::alias NumericSortv("v", cl::desc("Alias for --numeric-sort"),
109 cl::aliasopt(NumericSort));
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000110
Rafael Espindola619581c2014-01-29 04:56:19 +0000111cl::opt<bool> NoSort("no-sort", cl::desc("Show symbols in order encountered"));
112cl::alias NoSortp("p", cl::desc("Alias for --no-sort"), cl::aliasopt(NoSort));
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000113
Kevin Enderby25a614b2014-07-02 23:23:58 +0000114cl::opt<bool> ReverseSort("reverse-sort", cl::desc("Sort in reverse order"));
115cl::alias ReverseSortr("r", cl::desc("Alias for --reverse-sort"),
116 cl::aliasopt(ReverseSort));
117
Rafael Espindola619581c2014-01-29 04:56:19 +0000118cl::opt<bool> PrintSize("print-size",
Rafael Espindolab4865d62014-04-03 00:19:35 +0000119 cl::desc("Show symbol size instead of address"));
Rafael Espindola619581c2014-01-29 04:56:19 +0000120cl::alias PrintSizeS("S", cl::desc("Alias for --print-size"),
121 cl::aliasopt(PrintSize));
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000122
Rafael Espindola619581c2014-01-29 04:56:19 +0000123cl::opt<bool> SizeSort("size-sort", cl::desc("Sort symbols by size"));
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000124
Rafael Espindola619581c2014-01-29 04:56:19 +0000125cl::opt<bool> WithoutAliases("without-aliases", cl::Hidden,
126 cl::desc("Exclude aliases from output"));
Jan Sjödin4d0c2992012-09-18 18:47:58 +0000127
Rafael Espindola619581c2014-01-29 04:56:19 +0000128cl::opt<bool> ArchiveMap("print-armap", cl::desc("Print the archive map"));
129cl::alias ArchiveMaps("s", cl::desc("Alias for --print-armap"),
130 cl::aliasopt(ArchiveMap));
Rafael Espindolab4865d62014-04-03 00:19:35 +0000131bool PrintAddress = true;
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000132
Rafael Espindola619581c2014-01-29 04:56:19 +0000133bool MultipleFiles = false;
Brian Gaeke0af759d2003-10-16 04:43:15 +0000134
Rafael Espindola619581c2014-01-29 04:56:19 +0000135bool HadError = false;
Rafael Espindola8b82a4d2013-07-03 15:46:03 +0000136
Rafael Espindola619581c2014-01-29 04:56:19 +0000137std::string ToolName;
Chris Lattneraa2372562006-05-24 17:04:05 +0000138}
Brian Gaeke0af759d2003-10-16 04:43:15 +0000139
Rafael Espindola619581c2014-01-29 04:56:19 +0000140static void error(Twine Message, Twine Path = Twine()) {
141 HadError = true;
142 errs() << ToolName << ": " << Path << ": " << Message << ".\n";
Michael J. Spencerbc96f372011-12-13 23:17:29 +0000143}
144
Rafael Espindola4453e42942014-06-13 03:07:50 +0000145static bool error(std::error_code EC, Twine Path = Twine()) {
Rafael Espindola619581c2014-01-29 04:56:19 +0000146 if (EC) {
147 error(EC.message(), Path);
Michael J. Spencerbc96f372011-12-13 23:17:29 +0000148 return true;
149 }
150 return false;
151}
152
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000153namespace {
Rafael Espindola619581c2014-01-29 04:56:19 +0000154struct NMSymbol {
Rafael Espindolab4865d62014-04-03 00:19:35 +0000155 uint64_t Address;
Rafael Espindola619581c2014-01-29 04:56:19 +0000156 uint64_t Size;
157 char TypeChar;
158 StringRef Name;
Kevin Enderby980b2582014-06-05 21:21:57 +0000159 DataRefImpl Symb;
Rafael Espindola619581c2014-01-29 04:56:19 +0000160};
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000161}
162
Rafael Espindolab4865d62014-04-03 00:19:35 +0000163static bool compareSymbolAddress(const NMSymbol &A, const NMSymbol &B) {
Kevin Enderby25a614b2014-07-02 23:23:58 +0000164 if (!ReverseSort) {
165 if (A.Address < B.Address)
166 return true;
167 else if (A.Address == B.Address && A.Name < B.Name)
168 return true;
169 else if (A.Address == B.Address && A.Name == B.Name && A.Size < B.Size)
170 return true;
171 else
172 return false;
173 } else {
174 if (A.Address > B.Address)
175 return true;
176 else if (A.Address == B.Address && A.Name > B.Name)
177 return true;
178 else if (A.Address == B.Address && A.Name == B.Name && A.Size > B.Size)
179 return true;
180 else
181 return false;
182 }
Rafael Espindola619581c2014-01-29 04:56:19 +0000183}
184
185static bool compareSymbolSize(const NMSymbol &A, const NMSymbol &B) {
Kevin Enderby25a614b2014-07-02 23:23:58 +0000186 if (!ReverseSort) {
187 if (A.Size < B.Size)
188 return true;
189 else if (A.Size == B.Size && A.Name < B.Name)
190 return true;
191 else if (A.Size == B.Size && A.Name == B.Name && A.Address < B.Address)
192 return true;
193 else
194 return false;
195 } else {
196 if (A.Size > B.Size)
197 return true;
198 else if (A.Size == B.Size && A.Name > B.Name)
199 return true;
200 else if (A.Size == B.Size && A.Name == B.Name && A.Address > B.Address)
201 return true;
202 else
203 return false;
204 }
Rafael Espindola619581c2014-01-29 04:56:19 +0000205}
206
207static bool compareSymbolName(const NMSymbol &A, const NMSymbol &B) {
Kevin Enderby25a614b2014-07-02 23:23:58 +0000208 if (!ReverseSort) {
209 if (A.Name < B.Name)
210 return true;
211 else if (A.Name == B.Name && A.Size < B.Size)
212 return true;
213 else if (A.Name == B.Name && A.Size == B.Size && A.Address < B.Address)
214 return true;
215 else
216 return false;
217 } else {
218 if (A.Name > B.Name)
219 return true;
220 else if (A.Name == B.Name && A.Size > B.Size)
221 return true;
222 else if (A.Name == B.Name && A.Size == B.Size && A.Address > B.Address)
223 return true;
224 else
225 return false;
226 }
Rafael Espindola619581c2014-01-29 04:56:19 +0000227}
228
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000229static char isSymbolList64Bit(SymbolicFile *Obj) {
Kevin Enderby15e24712014-05-12 20:45:00 +0000230 if (isa<IRObjectFile>(Obj))
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000231 return false;
Kevin Enderby15e24712014-05-12 20:45:00 +0000232 else if (isa<COFFObjectFile>(Obj))
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000233 return false;
234 else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(Obj))
235 return MachO->is64Bit();
Kevin Enderby15e24712014-05-12 20:45:00 +0000236 else if (isa<ELF32LEObjectFile>(Obj))
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000237 return false;
Kevin Enderby15e24712014-05-12 20:45:00 +0000238 else if (isa<ELF64LEObjectFile>(Obj))
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000239 return true;
Kevin Enderby15e24712014-05-12 20:45:00 +0000240 else if (isa<ELF32BEObjectFile>(Obj))
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000241 return false;
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000242 else if (isa<ELF64BEObjectFile>(Obj))
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000243 return true;
244 else
245 return false;
246}
247
Rafael Espindola619581c2014-01-29 04:56:19 +0000248static StringRef CurrentFilename;
249typedef std::vector<NMSymbol> SymbolListT;
250static SymbolListT SymbolList;
251
Kevin Enderby980b2582014-06-05 21:21:57 +0000252// darwinPrintSymbol() is used to print a symbol from a Mach-O file when the
253// the OutputFormat is darwin. It produces the same output as darwin's nm(1) -m
254// output.
255static void darwinPrintSymbol(MachOObjectFile *MachO, SymbolListT::iterator I,
256 char *SymbolAddrStr, const char *printBlanks) {
257 MachO::mach_header H;
258 MachO::mach_header_64 H_64;
259 uint32_t Filetype, Flags;
260 MachO::nlist_64 STE_64;
261 MachO::nlist STE;
262 uint8_t NType;
263 uint16_t NDesc;
264 uint64_t NValue;
265 if (MachO->is64Bit()) {
266 H_64 = MachO->MachOObjectFile::getHeader64();
267 Filetype = H_64.filetype;
268 Flags = H_64.flags;
269 STE_64 = MachO->getSymbol64TableEntry(I->Symb);
270 NType = STE_64.n_type;
271 NDesc = STE_64.n_desc;
272 NValue = STE_64.n_value;
273 } else {
274 H = MachO->MachOObjectFile::getHeader();
275 Filetype = H.filetype;
276 Flags = H.flags;
277 STE = MachO->getSymbolTableEntry(I->Symb);
278 NType = STE.n_type;
279 NDesc = STE.n_desc;
280 NValue = STE.n_value;
281 }
282
283 if (PrintAddress) {
284 if ((NType & MachO::N_TYPE) == MachO::N_INDR)
285 strcpy(SymbolAddrStr, printBlanks);
286 outs() << SymbolAddrStr << ' ';
287 }
288
289 switch (NType & MachO::N_TYPE) {
290 case MachO::N_UNDF:
291 if (NValue != 0) {
292 outs() << "(common) ";
293 if (MachO::GET_COMM_ALIGN(NDesc) != 0)
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000294 outs() << "(alignment 2^" << (int)MachO::GET_COMM_ALIGN(NDesc) << ") ";
Kevin Enderby980b2582014-06-05 21:21:57 +0000295 } else {
296 if ((NType & MachO::N_TYPE) == MachO::N_PBUD)
297 outs() << "(prebound ";
298 else
299 outs() << "(";
300 if ((NDesc & MachO::REFERENCE_TYPE) ==
301 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
302 outs() << "undefined [lazy bound]) ";
303 else if ((NDesc & MachO::REFERENCE_TYPE) ==
304 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
305 outs() << "undefined [private lazy bound]) ";
306 else if ((NDesc & MachO::REFERENCE_TYPE) ==
307 MachO::REFERENCE_FLAG_PRIVATE_UNDEFINED_NON_LAZY)
308 outs() << "undefined [private]) ";
309 else
310 outs() << "undefined) ";
311 }
312 break;
313 case MachO::N_ABS:
314 outs() << "(absolute) ";
315 break;
316 case MachO::N_INDR:
317 outs() << "(indirect) ";
318 break;
319 case MachO::N_SECT: {
320 section_iterator Sec = MachO->section_end();
321 MachO->getSymbolSection(I->Symb, Sec);
322 DataRefImpl Ref = Sec->getRawDataRefImpl();
323 StringRef SectionName;
324 MachO->getSectionName(Ref, SectionName);
325 StringRef SegmentName = MachO->getSectionFinalSegmentName(Ref);
326 outs() << "(" << SegmentName << "," << SectionName << ") ";
327 break;
328 }
329 default:
330 outs() << "(?) ";
331 break;
332 }
333
334 if (NType & MachO::N_EXT) {
335 if (NDesc & MachO::REFERENCED_DYNAMICALLY)
336 outs() << "[referenced dynamically] ";
337 if (NType & MachO::N_PEXT) {
338 if ((NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF)
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000339 outs() << "weak private external ";
Kevin Enderby980b2582014-06-05 21:21:57 +0000340 else
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000341 outs() << "private external ";
Kevin Enderby980b2582014-06-05 21:21:57 +0000342 } else {
343 if ((NDesc & MachO::N_WEAK_REF) == MachO::N_WEAK_REF ||
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000344 (NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF) {
Kevin Enderby980b2582014-06-05 21:21:57 +0000345 if ((NDesc & (MachO::N_WEAK_REF | MachO::N_WEAK_DEF)) ==
346 (MachO::N_WEAK_REF | MachO::N_WEAK_DEF))
347 outs() << "weak external automatically hidden ";
348 else
349 outs() << "weak external ";
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000350 } else
Kevin Enderby980b2582014-06-05 21:21:57 +0000351 outs() << "external ";
352 }
353 } else {
354 if (NType & MachO::N_PEXT)
355 outs() << "non-external (was a private external) ";
356 else
357 outs() << "non-external ";
358 }
359
360 if (Filetype == MachO::MH_OBJECT &&
361 (NDesc & MachO::N_NO_DEAD_STRIP) == MachO::N_NO_DEAD_STRIP)
362 outs() << "[no dead strip] ";
363
364 if (Filetype == MachO::MH_OBJECT &&
365 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
366 (NDesc & MachO::N_SYMBOL_RESOLVER) == MachO::N_SYMBOL_RESOLVER)
367 outs() << "[symbol resolver] ";
368
369 if (Filetype == MachO::MH_OBJECT &&
370 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
371 (NDesc & MachO::N_ALT_ENTRY) == MachO::N_ALT_ENTRY)
372 outs() << "[alt entry] ";
373
374 if ((NDesc & MachO::N_ARM_THUMB_DEF) == MachO::N_ARM_THUMB_DEF)
375 outs() << "[Thumb] ";
376
377 if ((NType & MachO::N_TYPE) == MachO::N_INDR) {
378 outs() << I->Name << " (for ";
379 StringRef IndirectName;
380 if (MachO->getIndirectName(I->Symb, IndirectName))
381 outs() << "?)";
382 else
383 outs() << IndirectName << ")";
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000384 } else
Kevin Enderby980b2582014-06-05 21:21:57 +0000385 outs() << I->Name;
386
387 if ((Flags & MachO::MH_TWOLEVEL) == MachO::MH_TWOLEVEL &&
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000388 (((NType & MachO::N_TYPE) == MachO::N_UNDF && NValue == 0) ||
Kevin Enderby980b2582014-06-05 21:21:57 +0000389 (NType & MachO::N_TYPE) == MachO::N_PBUD)) {
390 uint32_t LibraryOrdinal = MachO::GET_LIBRARY_ORDINAL(NDesc);
391 if (LibraryOrdinal != 0) {
392 if (LibraryOrdinal == MachO::EXECUTABLE_ORDINAL)
393 outs() << " (from executable)";
394 else if (LibraryOrdinal == MachO::DYNAMIC_LOOKUP_ORDINAL)
395 outs() << " (dynamically looked up)";
396 else {
397 StringRef LibraryName;
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000398 if (MachO->getLibraryShortNameByIndex(LibraryOrdinal - 1, LibraryName))
399 outs() << " (from bad library ordinal " << LibraryOrdinal << ")";
Kevin Enderby980b2582014-06-05 21:21:57 +0000400 else
401 outs() << " (from " << LibraryName << ")";
402 }
403 }
404 }
405
406 outs() << "\n";
407}
408
Kevin Enderby26646102014-06-20 21:29:27 +0000409static void sortAndPrintSymbolList(SymbolicFile *Obj, bool printName) {
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000410 if (!NoSort) {
411 if (NumericSort)
Rafael Espindolab4865d62014-04-03 00:19:35 +0000412 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolAddress);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000413 else if (SizeSort)
Rafael Espindola619581c2014-01-29 04:56:19 +0000414 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolSize);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000415 else
Rafael Espindola619581c2014-01-29 04:56:19 +0000416 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolName);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000417 }
418
Kevin Enderby26646102014-06-20 21:29:27 +0000419 if (OutputFormat == posix && MultipleFiles && printName) {
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000420 outs() << '\n' << CurrentFilename << ":\n";
Kevin Enderby26646102014-06-20 21:29:27 +0000421 } else if (OutputFormat == bsd && MultipleFiles && printName) {
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000422 outs() << "\n" << CurrentFilename << ":\n";
423 } else if (OutputFormat == sysv) {
424 outs() << "\n\nSymbols from " << CurrentFilename << ":\n\n"
425 << "Name Value Class Type"
426 << " Size Line Section\n";
427 }
428
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000429 const char *printBlanks, *printFormat;
430 if (isSymbolList64Bit(Obj)) {
431 printBlanks = " ";
432 printFormat = "%016" PRIx64;
433 } else {
434 printBlanks = " ";
435 printFormat = "%08" PRIx64;
436 }
437
Rafael Espindola619581c2014-01-29 04:56:19 +0000438 for (SymbolListT::iterator I = SymbolList.begin(), E = SymbolList.end();
439 I != E; ++I) {
440 if ((I->TypeChar != 'U') && UndefinedOnly)
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000441 continue;
Rafael Espindola619581c2014-01-29 04:56:19 +0000442 if ((I->TypeChar == 'U') && DefinedOnly)
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000443 continue;
Rafael Espindolab4865d62014-04-03 00:19:35 +0000444 if (SizeSort && !PrintAddress && I->Size == UnknownAddressOrSize)
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000445 continue;
446
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000447 char SymbolAddrStr[18] = "";
448 char SymbolSizeStr[18] = "";
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000449
Rafael Espindolab4865d62014-04-03 00:19:35 +0000450 if (OutputFormat == sysv || I->Address == UnknownAddressOrSize)
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000451 strcpy(SymbolAddrStr, printBlanks);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000452 if (OutputFormat == sysv)
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000453 strcpy(SymbolSizeStr, printBlanks);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000454
Rafael Espindolab4865d62014-04-03 00:19:35 +0000455 if (I->Address != UnknownAddressOrSize)
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000456 format(printFormat, I->Address)
Rafael Espindolab4865d62014-04-03 00:19:35 +0000457 .print(SymbolAddrStr, sizeof(SymbolAddrStr));
Rafael Espindola0115b082014-01-30 21:51:42 +0000458 if (I->Size != UnknownAddressOrSize)
Kevin Enderby6abc2e52014-05-09 23:57:49 +0000459 format(printFormat, I->Size).print(SymbolSizeStr, sizeof(SymbolSizeStr));
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000460
Kevin Enderby980b2582014-06-05 21:21:57 +0000461 // If OutputFormat is darwin and we have a MachOObjectFile print as darwin's
462 // nm(1) -m output, else if OutputFormat is darwin and not a Mach-O object
463 // fall back to OutputFormat bsd (see below).
464 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(Obj);
465 if (OutputFormat == darwin && MachO) {
466 darwinPrintSymbol(MachO, I, SymbolAddrStr, printBlanks);
467 } else if (OutputFormat == posix) {
Rafael Espindolab4865d62014-04-03 00:19:35 +0000468 outs() << I->Name << " " << I->TypeChar << " " << SymbolAddrStr
Rafael Espindola619581c2014-01-29 04:56:19 +0000469 << SymbolSizeStr << "\n";
Kevin Enderby980b2582014-06-05 21:21:57 +0000470 } else if (OutputFormat == bsd || (OutputFormat == darwin && !MachO)) {
Rafael Espindolab4865d62014-04-03 00:19:35 +0000471 if (PrintAddress)
472 outs() << SymbolAddrStr << ' ';
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000473 if (PrintSize) {
474 outs() << SymbolSizeStr;
Rafael Espindola0115b082014-01-30 21:51:42 +0000475 if (I->Size != UnknownAddressOrSize)
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000476 outs() << ' ';
477 }
Rafael Espindola619581c2014-01-29 04:56:19 +0000478 outs() << I->TypeChar << " " << I->Name << "\n";
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000479 } else if (OutputFormat == sysv) {
Rafael Espindola619581c2014-01-29 04:56:19 +0000480 std::string PaddedName(I->Name);
481 while (PaddedName.length() < 20)
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000482 PaddedName += " ";
Rafael Espindolab4865d62014-04-03 00:19:35 +0000483 outs() << PaddedName << "|" << SymbolAddrStr << "| " << I->TypeChar
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000484 << " | |" << SymbolSizeStr << "| |\n";
485 }
486 }
487
488 SymbolList.clear();
489}
490
Rafael Espindola586af97a2013-11-02 21:16:09 +0000491template <class ELFT>
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000492static char getSymbolNMTypeChar(ELFObjectFile<ELFT> &Obj,
493 basic_symbol_iterator I) {
Rafael Espindola586af97a2013-11-02 21:16:09 +0000494 typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
495 typedef typename ELFObjectFile<ELFT>::Elf_Shdr Elf_Shdr;
496
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000497 // OK, this is ELF
498 symbol_iterator SymI(I);
499
Rafael Espindola586af97a2013-11-02 21:16:09 +0000500 DataRefImpl Symb = I->getRawDataRefImpl();
501 const Elf_Sym *ESym = Obj.getSymbol(Symb);
502 const ELFFile<ELFT> &EF = *Obj.getELFFile();
503 const Elf_Shdr *ESec = EF.getSection(ESym);
504
Rafael Espindola586af97a2013-11-02 21:16:09 +0000505 if (ESec) {
506 switch (ESec->sh_type) {
507 case ELF::SHT_PROGBITS:
508 case ELF::SHT_DYNAMIC:
509 switch (ESec->sh_flags) {
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000510 case (ELF::SHF_ALLOC | ELF::SHF_EXECINSTR):
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000511 return 't';
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000512 case (ELF::SHF_TLS | ELF::SHF_ALLOC | ELF::SHF_WRITE):
513 case (ELF::SHF_ALLOC | ELF::SHF_WRITE):
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000514 return 'd';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000515 case ELF::SHF_ALLOC:
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000516 case (ELF::SHF_ALLOC | ELF::SHF_MERGE):
517 case (ELF::SHF_ALLOC | ELF::SHF_MERGE | ELF::SHF_STRINGS):
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000518 return 'r';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000519 }
520 break;
521 case ELF::SHT_NOBITS:
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000522 return 'b';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000523 }
524 }
525
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000526 if (ESym->getType() == ELF::STT_SECTION) {
Rafael Espindola586af97a2013-11-02 21:16:09 +0000527 StringRef Name;
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000528 if (error(SymI->getName(Name)))
Rafael Espindola74375892014-02-04 00:21:18 +0000529 return '?';
530 return StringSwitch<char>(Name)
531 .StartsWith(".debug", 'N')
532 .StartsWith(".note", 'n')
533 .Default('?');
Rafael Espindola586af97a2013-11-02 21:16:09 +0000534 }
535
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000536 return '?';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000537}
538
Rafael Espindola74375892014-02-04 00:21:18 +0000539static char getSymbolNMTypeChar(COFFObjectFile &Obj, symbol_iterator I) {
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000540 const coff_symbol *Symb = Obj.getCOFFSymbol(*I);
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000541 // OK, this is COFF.
542 symbol_iterator SymI(I);
543
Rafael Espindola619581c2014-01-29 04:56:19 +0000544 StringRef Name;
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000545 if (error(SymI->getName(Name)))
Rafael Espindola74375892014-02-04 00:21:18 +0000546 return '?';
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000547
Rafael Espindola619581c2014-01-29 04:56:19 +0000548 char Ret = StringSwitch<char>(Name)
Rafael Espindola586af97a2013-11-02 21:16:09 +0000549 .StartsWith(".debug", 'N')
550 .StartsWith(".sxdata", 'N')
551 .Default('?');
552
Rafael Espindola74375892014-02-04 00:21:18 +0000553 if (Ret != '?')
554 return Ret;
Rafael Espindola586af97a2013-11-02 21:16:09 +0000555
556 uint32_t Characteristics = 0;
Rui Ueyamaf078eff2014-03-18 23:37:53 +0000557 if (!COFF::isReservedSectionNumber(Symb->SectionNumber)) {
Rafael Espindolab5155a52014-02-10 20:24:04 +0000558 section_iterator SecI = Obj.section_end();
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000559 if (error(SymI->getSection(SecI)))
Rafael Espindola74375892014-02-04 00:21:18 +0000560 return '?';
Alexey Samsonov27dc8392014-03-18 06:53:02 +0000561 const coff_section *Section = Obj.getCOFFSection(*SecI);
Rafael Espindola586af97a2013-11-02 21:16:09 +0000562 Characteristics = Section->Characteristics;
563 }
564
Rafael Espindola619581c2014-01-29 04:56:19 +0000565 switch (Symb->SectionNumber) {
Rafael Espindola586af97a2013-11-02 21:16:09 +0000566 case COFF::IMAGE_SYM_DEBUG:
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000567 return 'n';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000568 default:
569 // Check section type.
570 if (Characteristics & COFF::IMAGE_SCN_CNT_CODE)
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000571 return 't';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000572 else if (Characteristics & COFF::IMAGE_SCN_MEM_READ &&
573 ~Characteristics & COFF::IMAGE_SCN_MEM_WRITE) // Read only.
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000574 return 'r';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000575 else if (Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000576 return 'd';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000577 else if (Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000578 return 'b';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000579 else if (Characteristics & COFF::IMAGE_SCN_LNK_INFO)
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000580 return 'i';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000581
582 // Check for section symbol.
David Majnemerddf28f22014-03-19 04:47:47 +0000583 else if (Symb->isSectionDefinition())
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000584 return 's';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000585 }
586
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000587 return '?';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000588}
589
590static uint8_t getNType(MachOObjectFile &Obj, DataRefImpl Symb) {
591 if (Obj.is64Bit()) {
592 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
593 return STE.n_type;
594 }
595 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
596 return STE.n_type;
597}
598
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000599static char getSymbolNMTypeChar(MachOObjectFile &Obj, basic_symbol_iterator I) {
Rafael Espindola586af97a2013-11-02 21:16:09 +0000600 DataRefImpl Symb = I->getRawDataRefImpl();
601 uint8_t NType = getNType(Obj, Symb);
602
Rafael Espindola586af97a2013-11-02 21:16:09 +0000603 switch (NType & MachO::N_TYPE) {
Rafael Espindola586af97a2013-11-02 21:16:09 +0000604 case MachO::N_ABS:
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000605 return 's';
Tim Northovereaef0742014-05-30 13:22:59 +0000606 case MachO::N_INDR:
607 return 'i';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000608 case MachO::N_SECT: {
Rafael Espindolab5155a52014-02-10 20:24:04 +0000609 section_iterator Sec = Obj.section_end();
Rafael Espindola586af97a2013-11-02 21:16:09 +0000610 Obj.getSymbolSection(Symb, Sec);
611 DataRefImpl Ref = Sec->getRawDataRefImpl();
612 StringRef SectionName;
613 Obj.getSectionName(Ref, SectionName);
614 StringRef SegmentName = Obj.getSectionFinalSegmentName(Ref);
615 if (SegmentName == "__TEXT" && SectionName == "__text")
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000616 return 't';
Kevin Enderby1e1b9922014-06-19 22:49:21 +0000617 else if (SegmentName == "__DATA" && SectionName == "__data")
618 return 'd';
619 else if (SegmentName == "__DATA" && SectionName == "__bss")
620 return 'b';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000621 else
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000622 return 's';
623 }
Rafael Espindola586af97a2013-11-02 21:16:09 +0000624 }
625
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000626 return '?';
627}
628
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000629static char getSymbolNMTypeChar(const GlobalValue &GV) {
Rafael Espindola64c1e182014-06-03 02:41:57 +0000630 if (GV.getType()->getElementType()->isFunctionTy())
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000631 return 't';
632 // FIXME: should we print 'b'? At the IR level we cannot be sure if this
633 // will be in bss or not, but we could approximate.
Rafael Espindola64c1e182014-06-03 02:41:57 +0000634 return 'd';
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000635}
636
637static char getSymbolNMTypeChar(IRObjectFile &Obj, basic_symbol_iterator I) {
638 const GlobalValue &GV = Obj.getSymbolGV(I->getRawDataRefImpl());
639 return getSymbolNMTypeChar(GV);
640}
641
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000642template <class ELFT>
643static bool isObject(ELFObjectFile<ELFT> &Obj, symbol_iterator I) {
644 typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
645
646 DataRefImpl Symb = I->getRawDataRefImpl();
647 const Elf_Sym *ESym = Obj.getSymbol(Symb);
648
649 return ESym->getType() == ELF::STT_OBJECT;
650}
651
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000652static bool isObject(SymbolicFile *Obj, basic_symbol_iterator I) {
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000653 if (ELF32LEObjectFile *ELF = dyn_cast<ELF32LEObjectFile>(Obj))
654 return isObject(*ELF, I);
655 if (ELF64LEObjectFile *ELF = dyn_cast<ELF64LEObjectFile>(Obj))
656 return isObject(*ELF, I);
657 if (ELF32BEObjectFile *ELF = dyn_cast<ELF32BEObjectFile>(Obj))
658 return isObject(*ELF, I);
659 if (ELF64BEObjectFile *ELF = dyn_cast<ELF64BEObjectFile>(Obj))
660 return isObject(*ELF, I);
661 return false;
Rafael Espindola586af97a2013-11-02 21:16:09 +0000662}
663
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000664static char getNMTypeChar(SymbolicFile *Obj, basic_symbol_iterator I) {
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000665 uint32_t Symflags = I->getFlags();
666 if ((Symflags & object::SymbolRef::SF_Weak) && !isa<MachOObjectFile>(Obj)) {
667 char Ret = isObject(Obj, I) ? 'v' : 'w';
668 if (!(Symflags & object::SymbolRef::SF_Undefined))
669 Ret = toupper(Ret);
670 return Ret;
671 }
672
673 if (Symflags & object::SymbolRef::SF_Undefined)
674 return 'U';
675
676 if (Symflags & object::SymbolRef::SF_Common)
677 return 'C';
678
679 char Ret = '?';
680 if (Symflags & object::SymbolRef::SF_Absolute)
681 Ret = 'a';
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000682 else if (IRObjectFile *IR = dyn_cast<IRObjectFile>(Obj))
683 Ret = getSymbolNMTypeChar(*IR, I);
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000684 else if (COFFObjectFile *COFF = dyn_cast<COFFObjectFile>(Obj))
685 Ret = getSymbolNMTypeChar(*COFF, I);
686 else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(Obj))
687 Ret = getSymbolNMTypeChar(*MachO, I);
688 else if (ELF32LEObjectFile *ELF = dyn_cast<ELF32LEObjectFile>(Obj))
689 Ret = getSymbolNMTypeChar(*ELF, I);
690 else if (ELF64LEObjectFile *ELF = dyn_cast<ELF64LEObjectFile>(Obj))
691 Ret = getSymbolNMTypeChar(*ELF, I);
692 else if (ELF32BEObjectFile *ELF = dyn_cast<ELF32BEObjectFile>(Obj))
693 Ret = getSymbolNMTypeChar(*ELF, I);
694 else
695 Ret = getSymbolNMTypeChar(*cast<ELF64BEObjectFile>(Obj), I);
696
697 if (Symflags & object::SymbolRef::SF_Global)
698 Ret = toupper(Ret);
699
700 return Ret;
Rafael Espindola586af97a2013-11-02 21:16:09 +0000701}
702
Kevin Enderby26646102014-06-20 21:29:27 +0000703static void dumpSymbolNamesFromObject(SymbolicFile *Obj, bool printName) {
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000704 basic_symbol_iterator IBegin = Obj->symbol_begin();
705 basic_symbol_iterator IEnd = Obj->symbol_end();
Michael J. Spencer8c4729f2012-02-28 00:40:37 +0000706 if (DynamicSyms) {
Rafael Espindola196666c2014-01-30 20:45:33 +0000707 if (!Obj->isELF()) {
708 error("File format has no dynamic symbol table", Obj->getFileName());
709 return;
710 }
Alexey Samsonov65056a32014-02-26 12:51:19 +0000711 std::pair<symbol_iterator, symbol_iterator> IDyn =
712 getELFDynamicSymbolIterators(Obj);
713 IBegin = IDyn.first;
714 IEnd = IDyn.second;
Michael J. Spencer8c4729f2012-02-28 00:40:37 +0000715 }
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000716 std::string NameBuffer;
717 raw_string_ostream OS(NameBuffer);
718 for (basic_symbol_iterator I = IBegin; I != IEnd; ++I) {
Rafael Espindola20122a42014-01-31 20:57:12 +0000719 uint32_t SymFlags = I->getFlags();
Rafael Espindola619581c2014-01-29 04:56:19 +0000720 if (!DebugSyms && (SymFlags & SymbolRef::SF_FormatSpecific))
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000721 continue;
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000722 if (WithoutAliases) {
723 if (IRObjectFile *IR = dyn_cast<IRObjectFile>(Obj)) {
724 const GlobalValue &GV = IR->getSymbolGV(I->getRawDataRefImpl());
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000725 if (isa<GlobalAlias>(GV))
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000726 continue;
727 }
728 }
Rafael Espindola619581c2014-01-29 04:56:19 +0000729 NMSymbol S;
Rafael Espindola0115b082014-01-30 21:51:42 +0000730 S.Size = UnknownAddressOrSize;
Rafael Espindolab4865d62014-04-03 00:19:35 +0000731 S.Address = UnknownAddressOrSize;
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000732 if ((PrintSize || SizeSort) && isa<ObjectFile>(Obj)) {
733 symbol_iterator SymI = I;
734 if (error(SymI->getSize(S.Size)))
Rafael Espindola619581c2014-01-29 04:56:19 +0000735 break;
Michael J. Spencer1d6167f2011-06-25 17:55:23 +0000736 }
Rafael Espindolab4865d62014-04-03 00:19:35 +0000737 if (PrintAddress && isa<ObjectFile>(Obj))
738 if (error(symbol_iterator(I)->getAddress(S.Address)))
Rafael Espindola619581c2014-01-29 04:56:19 +0000739 break;
740 S.TypeChar = getNMTypeChar(Obj, I);
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000741 if (error(I->printName(OS)))
Rafael Espindola619581c2014-01-29 04:56:19 +0000742 break;
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000743 OS << '\0';
Kevin Enderby980b2582014-06-05 21:21:57 +0000744 S.Symb = I->getRawDataRefImpl();
Rafael Espindola619581c2014-01-29 04:56:19 +0000745 SymbolList.push_back(S);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000746 }
747
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000748 OS.flush();
749 const char *P = NameBuffer.c_str();
750 for (unsigned I = 0; I < SymbolList.size(); ++I) {
751 SymbolList[I].Name = P;
752 P += strlen(P) + 1;
753 }
754
Rafael Espindola619581c2014-01-29 04:56:19 +0000755 CurrentFilename = Obj->getFileName();
Kevin Enderby26646102014-06-20 21:29:27 +0000756 sortAndPrintSymbolList(Obj, printName);
Brian Gaeke0af759d2003-10-16 04:43:15 +0000757}
758
Kevin Enderby4c8dfe42014-06-30 18:45:23 +0000759// checkMachOAndArchFlags() checks to see if the SymbolicFile is a Mach-O file
760// and if it is and there is a list of architecture flags is specified then
761// check to make sure this Mach-O file is one of those architectures or all
762// architectures was specificed. If not then an error is generated and this
763// routine returns false. Else it returns true.
764static bool checkMachOAndArchFlags(SymbolicFile *O, std::string &Filename) {
765 if (isa<MachOObjectFile>(O) && !ArchAll && ArchFlags.size() != 0) {
766 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(O);
767 bool ArchFound = false;
768 MachO::mach_header H;
769 MachO::mach_header_64 H_64;
770 Triple T;
771 if (MachO->is64Bit()) {
772 H_64 = MachO->MachOObjectFile::getHeader64();
773 T = MachOObjectFile::getArch(H_64.cputype, H_64.cpusubtype);
774 } else {
775 H = MachO->MachOObjectFile::getHeader();
776 T = MachOObjectFile::getArch(H.cputype, H.cpusubtype);
777 }
778 unsigned i;
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000779 for (i = 0; i < ArchFlags.size(); ++i) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +0000780 if (ArchFlags[i] == T.getArchName())
781 ArchFound = true;
782 break;
783 }
784 if (!ArchFound) {
785 error(ArchFlags[i],
786 "file: " + Filename + " does not contain architecture");
787 return false;
788 }
789 }
790 return true;
791}
792
Rafael Espindola619581c2014-01-29 04:56:19 +0000793static void dumpSymbolNamesFromFile(std::string &Filename) {
Ahmed Charles56440fd2014-03-06 05:51:42 +0000794 std::unique_ptr<MemoryBuffer> Buffer;
Michael J. Spencerbc96f372011-12-13 23:17:29 +0000795 if (error(MemoryBuffer::getFileOrSTDIN(Filename, Buffer), Filename))
796 return;
797
Owen Anderson19251ec2009-07-15 22:16:10 +0000798 LLVMContext &Context = getGlobalContext();
Rafael Espindola6304e942014-06-23 22:00:37 +0000799 ErrorOr<Binary *> BinaryOrErr = createBinary(Buffer, &Context);
Rafael Espindolace82a072014-01-30 19:24:00 +0000800 if (error(BinaryOrErr.getError(), Filename))
801 return;
Rafael Espindolac3f9b5a2014-06-23 21:53:12 +0000802 Buffer.release();
Ahmed Charles56440fd2014-03-06 05:51:42 +0000803 std::unique_ptr<Binary> Bin(BinaryOrErr.get());
Shankar Easwaran15b28be2012-11-13 18:38:42 +0000804
Rafael Espindola0115b082014-01-30 21:51:42 +0000805 if (Archive *A = dyn_cast<Archive>(Bin.get())) {
Rafael Espindolace82a072014-01-30 19:24:00 +0000806 if (ArchiveMap) {
Rafael Espindola0115b082014-01-30 21:51:42 +0000807 Archive::symbol_iterator I = A->symbol_begin();
808 Archive::symbol_iterator E = A->symbol_end();
Rafael Espindolace82a072014-01-30 19:24:00 +0000809 if (I != E) {
Rafael Espindola0115b082014-01-30 21:51:42 +0000810 outs() << "Archive map\n";
Rafael Espindolace82a072014-01-30 19:24:00 +0000811 for (; I != E; ++I) {
Rafael Espindolaae460022014-06-16 16:08:36 +0000812 ErrorOr<Archive::child_iterator> C = I->getMember();
813 if (error(C.getError()))
Michael J. Spencer9718f452013-02-03 10:48:50 +0000814 return;
Rafael Espindolaae460022014-06-16 16:08:36 +0000815 ErrorOr<StringRef> FileNameOrErr = C.get()->getName();
816 if (error(FileNameOrErr.getError()))
Rafael Espindolace82a072014-01-30 19:24:00 +0000817 return;
Rafael Espindolaae460022014-06-16 16:08:36 +0000818 StringRef SymName = I->getName();
819 outs() << SymName << " in " << FileNameOrErr.get() << "\n";
Michael J. Spencer2bc774a2011-09-27 19:37:18 +0000820 }
Rafael Espindolace82a072014-01-30 19:24:00 +0000821 outs() << "\n";
Michael J. Spencer2bc774a2011-09-27 19:37:18 +0000822 }
823 }
Alexey Samsonove6388e62013-06-18 15:03:28 +0000824
Rafael Espindola0115b082014-01-30 21:51:42 +0000825 for (Archive::child_iterator I = A->child_begin(), E = A->child_end();
Rafael Espindolace82a072014-01-30 19:24:00 +0000826 I != E; ++I) {
Rafael Espindolaae460022014-06-16 16:08:36 +0000827 ErrorOr<std::unique_ptr<Binary>> ChildOrErr = I->getAsBinary(&Context);
828 if (ChildOrErr.getError())
Rafael Espindolace82a072014-01-30 19:24:00 +0000829 continue;
Rafael Espindolaae460022014-06-16 16:08:36 +0000830 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +0000831 if (!checkMachOAndArchFlags(O, Filename))
832 return;
Kevin Enderby26646102014-06-20 21:29:27 +0000833 outs() << "\n";
Kevin Enderby1983fcf2014-06-19 22:03:18 +0000834 if (isa<MachOObjectFile>(O)) {
835 outs() << Filename << "(" << O->getFileName() << ")";
836 } else
837 outs() << O->getFileName();
838 outs() << ":\n";
Kevin Enderby26646102014-06-20 21:29:27 +0000839 dumpSymbolNamesFromObject(O, false);
Rafael Espindolace82a072014-01-30 19:24:00 +0000840 }
841 }
842 return;
843 }
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000844 if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(Bin.get())) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +0000845 // If we have a list of architecture flags specified dump only those.
846 if (!ArchAll && ArchFlags.size() != 0) {
847 // Look for a slice in the universal binary that matches each ArchFlag.
848 bool ArchFound;
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000849 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +0000850 ArchFound = false;
851 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
852 E = UB->end_objects();
853 I != E; ++I) {
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000854 if (ArchFlags[i] == I->getArchTypeName()) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +0000855 ArchFound = true;
856 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr =
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000857 I->getAsObjectFile();
Kevin Enderby4c8dfe42014-06-30 18:45:23 +0000858 std::unique_ptr<Archive> A;
859 if (ObjOrErr) {
860 std::unique_ptr<ObjectFile> Obj = std::move(ObjOrErr.get());
861 if (ArchFlags.size() > 1) {
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000862 outs() << "\n" << Obj->getFileName() << " (for architecture "
863 << I->getArchTypeName() << ")"
Kevin Enderby4c8dfe42014-06-30 18:45:23 +0000864 << ":\n";
865 }
866 dumpSymbolNamesFromObject(Obj.get(), false);
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000867 } else if (!I->getAsArchive(A)) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +0000868 for (Archive::child_iterator AI = A->child_begin(),
869 AE = A->child_end();
870 AI != AE; ++AI) {
871 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
872 AI->getAsBinary(&Context);
873 if (ChildOrErr.getError())
874 continue;
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000875 if (SymbolicFile *O =
876 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +0000877 outs() << "\n" << A->getFileName();
878 outs() << "(" << O->getFileName() << ")";
879 if (ArchFlags.size() > 1) {
880 outs() << " (for architecture " << I->getArchTypeName()
881 << ")";
882 }
883 outs() << ":\n";
884 dumpSymbolNamesFromObject(O, false);
885 }
886 }
887 }
888 }
889 }
890 if (!ArchFound) {
891 error(ArchFlags[i],
892 "file: " + Filename + " does not contain architecture");
893 return;
894 }
895 }
896 return;
897 }
898 // No architecture flags were specified so if this contains a slice that
899 // matches the host architecture dump only that.
900 if (!ArchAll) {
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000901 StringRef HostArchName = MachOObjectFile::getHostArch().getArchName();
Kevin Enderby4c8dfe42014-06-30 18:45:23 +0000902 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
903 E = UB->end_objects();
904 I != E; ++I) {
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000905 if (HostArchName == I->getArchTypeName()) {
906 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
Kevin Enderby4c8dfe42014-06-30 18:45:23 +0000907 std::unique_ptr<Archive> A;
908 if (ObjOrErr) {
909 std::unique_ptr<ObjectFile> Obj = std::move(ObjOrErr.get());
910 dumpSymbolNamesFromObject(Obj.get(), false);
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000911 } else if (!I->getAsArchive(A)) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +0000912 for (Archive::child_iterator AI = A->child_begin(),
913 AE = A->child_end();
914 AI != AE; ++AI) {
915 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
916 AI->getAsBinary(&Context);
917 if (ChildOrErr.getError())
918 continue;
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000919 if (SymbolicFile *O =
920 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
921 outs() << "\n" << A->getFileName() << "(" << O->getFileName()
922 << ")"
923 << ":\n";
Kevin Enderby4c8dfe42014-06-30 18:45:23 +0000924 dumpSymbolNamesFromObject(O, false);
925 }
926 }
927 }
928 return;
929 }
930 }
931 }
932 // Either all architectures have been specified or none have been specified
933 // and this does not contain the host architecture so dump all the slices.
Kevin Enderby1983fcf2014-06-19 22:03:18 +0000934 bool moreThanOneArch = UB->getNumberOfObjects() > 1;
Rafael Espindola0115b082014-01-30 21:51:42 +0000935 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
936 E = UB->end_objects();
Alexey Samsonove6388e62013-06-18 15:03:28 +0000937 I != E; ++I) {
Rafael Espindola4f7932b2014-06-23 20:41:02 +0000938 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
Kevin Enderbye858a652014-05-14 21:18:50 +0000939 std::unique_ptr<Archive> A;
Rafael Espindola4f7932b2014-06-23 20:41:02 +0000940 if (ObjOrErr) {
941 std::unique_ptr<ObjectFile> Obj = std::move(ObjOrErr.get());
Kevin Enderby26646102014-06-20 21:29:27 +0000942 if (moreThanOneArch)
943 outs() << "\n";
Kevin Enderby1983fcf2014-06-19 22:03:18 +0000944 outs() << Obj->getFileName();
945 if (isa<MachOObjectFile>(Obj.get()) && moreThanOneArch)
946 outs() << " (for architecture " << I->getArchTypeName() << ")";
947 outs() << ":\n";
Kevin Enderby26646102014-06-20 21:29:27 +0000948 dumpSymbolNamesFromObject(Obj.get(), false);
Kevin Enderby8f6dcf52014-07-01 22:44:51 +0000949 } else if (!I->getAsArchive(A)) {
Kevin Enderbye858a652014-05-14 21:18:50 +0000950 for (Archive::child_iterator AI = A->child_begin(), AE = A->child_end();
951 AI != AE; ++AI) {
Rafael Espindolaae460022014-06-16 16:08:36 +0000952 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
953 AI->getAsBinary(&Context);
954 if (ChildOrErr.getError())
Kevin Enderbye858a652014-05-14 21:18:50 +0000955 continue;
Rafael Espindolaae460022014-06-16 16:08:36 +0000956 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
Kevin Enderby26646102014-06-20 21:29:27 +0000957 outs() << "\n" << A->getFileName();
Kevin Enderby1983fcf2014-06-19 22:03:18 +0000958 if (isa<MachOObjectFile>(O)) {
959 outs() << "(" << O->getFileName() << ")";
960 if (moreThanOneArch)
961 outs() << " (for architecture " << I->getArchTypeName() << ")";
962 } else
963 outs() << ":" << O->getFileName();
964 outs() << ":\n";
Kevin Enderby26646102014-06-20 21:29:27 +0000965 dumpSymbolNamesFromObject(O, false);
Kevin Enderbye858a652014-05-14 21:18:50 +0000966 }
967 }
968 }
Alexey Samsonove6388e62013-06-18 15:03:28 +0000969 }
Brian Gaeke618026a2003-11-19 21:57:30 +0000970 return;
Brian Gaeke0af759d2003-10-16 04:43:15 +0000971 }
Rafael Espindolaf12b8282014-02-21 20:10:59 +0000972 if (SymbolicFile *O = dyn_cast<SymbolicFile>(Bin.get())) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +0000973 if (!checkMachOAndArchFlags(O, Filename))
974 return;
Kevin Enderby26646102014-06-20 21:29:27 +0000975 dumpSymbolNamesFromObject(O, true);
Rafael Espindolace82a072014-01-30 19:24:00 +0000976 return;
977 }
978 error("unrecognizable file type", Filename);
979 return;
Brian Gaeke0af759d2003-10-16 04:43:15 +0000980}
981
982int main(int argc, char **argv) {
Chris Lattnere3fc2d12009-03-06 05:34:10 +0000983 // Print a stack trace if we signal out.
Chris Lattneref8f3892007-05-06 05:36:18 +0000984 sys::PrintStackTraceOnErrorSignal();
Chris Lattnere3fc2d12009-03-06 05:34:10 +0000985 PrettyStackTraceProgram X(argc, argv);
Michael J. Spencer618d2192010-08-31 06:36:46 +0000986
Rafael Espindola619581c2014-01-29 04:56:19 +0000987 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
Chris Lattnere3fc2d12009-03-06 05:34:10 +0000988 cl::ParseCommandLineOptions(argc, argv, "llvm symbol table dumper\n");
Chris Lattner12439ff2004-02-19 20:32:12 +0000989
Michael J. Spencerbc96f372011-12-13 23:17:29 +0000990 // llvm-nm only reads binary files.
Rafael Espindolacb2eca02013-06-12 20:58:35 +0000991 if (error(sys::ChangeStdinToBinary()))
Michael J. Spencerbc96f372011-12-13 23:17:29 +0000992 return 1;
993
Chris Lattneref8f3892007-05-06 05:36:18 +0000994 ToolName = argv[0];
Rafael Espindola619581c2014-01-29 04:56:19 +0000995 if (BSDFormat)
996 OutputFormat = bsd;
997 if (POSIXFormat)
998 OutputFormat = posix;
Kevin Enderby14a96ac2014-06-20 00:04:16 +0000999 if (DarwinFormat)
1000 OutputFormat = darwin;
Chris Lattner4aae1f42003-10-16 18:45:23 +00001001
Michael J. Spencerb8672a52011-01-20 06:38:57 +00001002 // The relative order of these is important. If you pass --size-sort it should
1003 // only print out the size. However, if you pass -S --size-sort, it should
Rafael Espindolab4865d62014-04-03 00:19:35 +00001004 // print out both the size and address.
Rafael Espindola619581c2014-01-29 04:56:19 +00001005 if (SizeSort && !PrintSize)
Rafael Espindolab4865d62014-04-03 00:19:35 +00001006 PrintAddress = false;
Rafael Espindola619581c2014-01-29 04:56:19 +00001007 if (OutputFormat == sysv || SizeSort)
1008 PrintSize = true;
Michael J. Spencerb8672a52011-01-20 06:38:57 +00001009
Chris Lattneref8f3892007-05-06 05:36:18 +00001010 switch (InputFilenames.size()) {
Rafael Espindola619581c2014-01-29 04:56:19 +00001011 case 0:
Kevin Enderby4fc2edb2014-06-23 20:27:53 +00001012 InputFilenames.push_back("a.out");
Rafael Espindola619581c2014-01-29 04:56:19 +00001013 case 1:
1014 break;
1015 default:
1016 MultipleFiles = true;
Chris Lattner4aae1f42003-10-16 18:45:23 +00001017 }
Chris Lattneref8f3892007-05-06 05:36:18 +00001018
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00001019 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001020 if (ArchFlags[i] == "all") {
1021 ArchAll = true;
Kevin Enderby8f6dcf52014-07-01 22:44:51 +00001022 } else {
Kevin Enderby4c8dfe42014-06-30 18:45:23 +00001023 Triple T = MachOObjectFile::getArch(ArchFlags[i]);
1024 if (T.getArch() == Triple::UnknownArch)
1025 error("Unknown architecture named '" + ArchFlags[i] + "'",
1026 "for the -arch option");
1027 }
1028 }
1029
Chris Lattneref8f3892007-05-06 05:36:18 +00001030 std::for_each(InputFilenames.begin(), InputFilenames.end(),
Rafael Espindola619581c2014-01-29 04:56:19 +00001031 dumpSymbolNamesFromFile);
Rafael Espindola8b82a4d2013-07-03 15:46:03 +00001032
1033 if (HadError)
1034 return 1;
1035
Chris Lattneref8f3892007-05-06 05:36:18 +00001036 return 0;
Brian Gaeke0af759d2003-10-16 04:43:15 +00001037}