1 //===-- llvm-nm.cpp - Symbol table dumping utility for llvm ---------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // 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.
14 // This "nm" supports many of the features of GNU "nm", including its different
17 //===----------------------------------------------------------------------===//
19 #include "llvm/IR/Function.h"
20 #include "llvm/IR/GlobalAlias.h"
21 #include "llvm/IR/GlobalVariable.h"
22 #include "llvm/IR/LLVMContext.h"
23 #include "llvm/Object/Archive.h"
24 #include "llvm/Object/COFF.h"
25 #include "llvm/Object/ELFObjectFile.h"
26 #include "llvm/Object/IRObjectFile.h"
27 #include "llvm/Object/MachO.h"
28 #include "llvm/Object/MachOUniversal.h"
29 #include "llvm/Object/ObjectFile.h"
30 #include "llvm/Support/COFF.h"
31 #include "llvm/Support/CommandLine.h"
32 #include "llvm/Support/FileSystem.h"
33 #include "llvm/Support/Format.h"
34 #include "llvm/Support/ManagedStatic.h"
35 #include "llvm/Support/MemoryBuffer.h"
36 #include "llvm/Support/PrettyStackTrace.h"
37 #include "llvm/Support/Program.h"
38 #include "llvm/Support/Signals.h"
39 #include "llvm/Support/TargetSelect.h"
40 #include "llvm/Support/raw_ostream.h"
45 #include <system_error>
49 using namespace object;
52 enum OutputFormatTy { bsd, sysv, posix, darwin };
53 cl::opt<OutputFormatTy> OutputFormat(
54 "format", cl::desc("Specify output format"),
55 cl::values(clEnumVal(bsd, "BSD format"), clEnumVal(sysv, "System V format"),
56 clEnumVal(posix, "POSIX.2 format"),
57 clEnumVal(darwin, "Darwin -m format"), clEnumValEnd),
59 cl::alias OutputFormat2("f", cl::desc("Alias for --format"),
60 cl::aliasopt(OutputFormat));
62 cl::list<std::string> InputFilenames(cl::Positional, cl::desc("<input files>"),
65 cl::opt<bool> UndefinedOnly("undefined-only",
66 cl::desc("Show only undefined symbols"));
67 cl::alias UndefinedOnly2("u", cl::desc("Alias for --undefined-only"),
68 cl::aliasopt(UndefinedOnly), cl::Grouping);
70 cl::opt<bool> DynamicSyms("dynamic",
71 cl::desc("Display the dynamic symbols instead "
72 "of normal symbols."));
73 cl::alias DynamicSyms2("D", cl::desc("Alias for --dynamic"),
74 cl::aliasopt(DynamicSyms), cl::Grouping);
76 cl::opt<bool> DefinedOnly("defined-only",
77 cl::desc("Show only defined symbols"));
78 cl::alias DefinedOnly2("U", cl::desc("Alias for --defined-only"),
79 cl::aliasopt(DefinedOnly), cl::Grouping);
81 cl::opt<bool> ExternalOnly("extern-only",
82 cl::desc("Show only external symbols"));
83 cl::alias ExternalOnly2("g", cl::desc("Alias for --extern-only"),
84 cl::aliasopt(ExternalOnly), cl::Grouping);
86 cl::opt<bool> BSDFormat("B", cl::desc("Alias for --format=bsd"),
88 cl::opt<bool> POSIXFormat("P", cl::desc("Alias for --format=posix"),
90 cl::opt<bool> DarwinFormat("m", cl::desc("Alias for --format=darwin"),
93 static cl::list<std::string>
94 ArchFlags("arch", cl::desc("architecture(s) from a Mach-O file to dump"),
98 cl::opt<bool> PrintFileName(
100 cl::desc("Precede each symbol with the object file it came from"));
102 cl::alias PrintFileNameA("A", cl::desc("Alias for --print-file-name"),
103 cl::aliasopt(PrintFileName), cl::Grouping);
104 cl::alias PrintFileNameo("o", cl::desc("Alias for --print-file-name"),
105 cl::aliasopt(PrintFileName), cl::Grouping);
107 cl::opt<bool> DebugSyms("debug-syms",
108 cl::desc("Show all symbols, even debugger only"));
109 cl::alias DebugSymsa("a", cl::desc("Alias for --debug-syms"),
110 cl::aliasopt(DebugSyms), cl::Grouping);
112 cl::opt<bool> NumericSort("numeric-sort", cl::desc("Sort symbols by address"));
113 cl::alias NumericSortn("n", cl::desc("Alias for --numeric-sort"),
114 cl::aliasopt(NumericSort), cl::Grouping);
115 cl::alias NumericSortv("v", cl::desc("Alias for --numeric-sort"),
116 cl::aliasopt(NumericSort), cl::Grouping);
118 cl::opt<bool> NoSort("no-sort", cl::desc("Show symbols in order encountered"));
119 cl::alias NoSortp("p", cl::desc("Alias for --no-sort"), cl::aliasopt(NoSort),
122 cl::opt<bool> ReverseSort("reverse-sort", cl::desc("Sort in reverse order"));
123 cl::alias ReverseSortr("r", cl::desc("Alias for --reverse-sort"),
124 cl::aliasopt(ReverseSort), cl::Grouping);
126 cl::opt<bool> PrintSize("print-size",
127 cl::desc("Show symbol size instead of address"));
128 cl::alias PrintSizeS("S", cl::desc("Alias for --print-size"),
129 cl::aliasopt(PrintSize), cl::Grouping);
131 cl::opt<bool> SizeSort("size-sort", cl::desc("Sort symbols by size"));
133 cl::opt<bool> WithoutAliases("without-aliases", cl::Hidden,
134 cl::desc("Exclude aliases from output"));
136 cl::opt<bool> ArchiveMap("print-armap", cl::desc("Print the archive map"));
137 cl::alias ArchiveMaps("M", cl::desc("Alias for --print-armap"),
138 cl::aliasopt(ArchiveMap), cl::Grouping);
140 cl::opt<bool> JustSymbolName("just-symbol-name",
141 cl::desc("Print just the symbol's name"));
142 cl::alias JustSymbolNames("j", cl::desc("Alias for --just-symbol-name"),
143 cl::aliasopt(JustSymbolName), cl::Grouping);
145 // FIXME: This option takes exactly two strings and should be allowed anywhere
146 // on the command line. Such that "llvm-nm -s __TEXT __text foo.o" would work.
147 // But that does not as the CommandLine Library does not have a way to make
148 // this work. For now the "-s __TEXT __text" has to be last on the command
150 cl::list<std::string> SegSect("s", cl::Positional, cl::ZeroOrMore,
151 cl::desc("Dump only symbols from this segment "
152 "and section name, Mach-O only"));
154 cl::opt<bool> FormatMachOasHex("x", cl::desc("Print symbol entry in hex, "
155 "Mach-O only"), cl::Grouping);
157 cl::opt<bool> NoLLVMBitcode("no-llvm-bc",
158 cl::desc("Disable LLVM bitcode reader"));
160 bool PrintAddress = true;
162 bool MultipleFiles = false;
164 bool HadError = false;
166 std::string ToolName;
167 } // anonymous namespace
169 static void error(Twine Message, Twine Path = Twine()) {
171 errs() << ToolName << ": " << Path << ": " << Message << ".\n";
174 static bool error(std::error_code EC, Twine Path = Twine()) {
176 error(EC.message(), Path);
190 } // anonymous namespace
192 static bool compareSymbolAddress(const NMSymbol &A, const NMSymbol &B) {
193 bool ADefined = !(A.Sym.getFlags() & SymbolRef::SF_Undefined);
194 bool BDefined = !(B.Sym.getFlags() & SymbolRef::SF_Undefined);
195 return std::make_tuple(ADefined, A.Address, A.Name, A.Size) <
196 std::make_tuple(BDefined, B.Address, B.Name, B.Size);
199 static bool compareSymbolSize(const NMSymbol &A, const NMSymbol &B) {
200 return std::make_tuple(A.Size, A.Name, A.Address) <
201 std::make_tuple(B.Size, B.Name, B.Address);
204 static bool compareSymbolName(const NMSymbol &A, const NMSymbol &B) {
205 return std::make_tuple(A.Name, A.Size, A.Address) <
206 std::make_tuple(B.Name, B.Size, B.Address);
209 static char isSymbolList64Bit(SymbolicFile &Obj) {
210 if (isa<IRObjectFile>(Obj))
212 if (isa<COFFObjectFile>(Obj))
214 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj))
215 return MachO->is64Bit();
216 return cast<ELFObjectFileBase>(Obj).getBytesInAddress() == 8;
219 static StringRef CurrentFilename;
220 typedef std::vector<NMSymbol> SymbolListT;
221 static SymbolListT SymbolList;
223 // darwinPrintSymbol() is used to print a symbol from a Mach-O file when the
224 // the OutputFormat is darwin or we are printing Mach-O symbols in hex. For
225 // the darwin format it produces the same output as darwin's nm(1) -m output
226 // and when printing Mach-O symbols in hex it produces the same output as
227 // darwin's nm(1) -x format.
228 static void darwinPrintSymbol(MachOObjectFile *MachO, SymbolListT::iterator I,
229 char *SymbolAddrStr, const char *printBlanks) {
230 MachO::mach_header H;
231 MachO::mach_header_64 H_64;
232 uint32_t Filetype, Flags;
233 MachO::nlist_64 STE_64;
240 DataRefImpl SymDRI = I->Sym.getRawDataRefImpl();
241 if (MachO->is64Bit()) {
242 H_64 = MachO->MachOObjectFile::getHeader64();
243 Filetype = H_64.filetype;
245 STE_64 = MachO->getSymbol64TableEntry(SymDRI);
246 NType = STE_64.n_type;
247 NSect = STE_64.n_sect;
248 NDesc = STE_64.n_desc;
249 NStrx = STE_64.n_strx;
250 NValue = STE_64.n_value;
252 H = MachO->MachOObjectFile::getHeader();
253 Filetype = H.filetype;
255 STE = MachO->getSymbolTableEntry(SymDRI);
260 NValue = STE.n_value;
263 // If we are printing Mach-O symbols in hex do that and return.
264 if (FormatMachOasHex) {
266 const char *printFormat;
267 if (MachO->is64Bit())
268 printFormat = "%016" PRIx64;
270 printFormat = "%08" PRIx64;
271 format(printFormat, NValue).print(Str, sizeof(Str));
272 outs() << Str << ' ';
273 format("%02x", NType).print(Str, sizeof(Str));
274 outs() << Str << ' ';
275 format("%02x", NSect).print(Str, sizeof(Str));
276 outs() << Str << ' ';
277 format("%04x", NDesc).print(Str, sizeof(Str));
278 outs() << Str << ' ';
279 format("%08x", NStrx).print(Str, sizeof(Str));
280 outs() << Str << ' ';
281 outs() << I->Name << "\n";
286 if ((NType & MachO::N_TYPE) == MachO::N_INDR)
287 strcpy(SymbolAddrStr, printBlanks);
288 outs() << SymbolAddrStr << ' ';
291 switch (NType & MachO::N_TYPE) {
294 outs() << "(common) ";
295 if (MachO::GET_COMM_ALIGN(NDesc) != 0)
296 outs() << "(alignment 2^" << (int)MachO::GET_COMM_ALIGN(NDesc) << ") ";
298 if ((NType & MachO::N_TYPE) == MachO::N_PBUD)
299 outs() << "(prebound ";
302 if ((NDesc & MachO::REFERENCE_TYPE) ==
303 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
304 outs() << "undefined [lazy bound]) ";
305 else if ((NDesc & MachO::REFERENCE_TYPE) ==
306 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
307 outs() << "undefined [private lazy bound]) ";
308 else if ((NDesc & MachO::REFERENCE_TYPE) ==
309 MachO::REFERENCE_FLAG_PRIVATE_UNDEFINED_NON_LAZY)
310 outs() << "undefined [private]) ";
312 outs() << "undefined) ";
316 outs() << "(absolute) ";
319 outs() << "(indirect) ";
321 case MachO::N_SECT: {
322 section_iterator Sec = *MachO->getSymbolSection(I->Sym.getRawDataRefImpl());
323 DataRefImpl Ref = Sec->getRawDataRefImpl();
324 StringRef SectionName;
325 MachO->getSectionName(Ref, SectionName);
326 StringRef SegmentName = MachO->getSectionFinalSegmentName(Ref);
327 outs() << "(" << SegmentName << "," << SectionName << ") ";
335 if (NType & MachO::N_EXT) {
336 if (NDesc & MachO::REFERENCED_DYNAMICALLY)
337 outs() << "[referenced dynamically] ";
338 if (NType & MachO::N_PEXT) {
339 if ((NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF)
340 outs() << "weak private external ";
342 outs() << "private external ";
344 if ((NDesc & MachO::N_WEAK_REF) == MachO::N_WEAK_REF ||
345 (NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF) {
346 if ((NDesc & (MachO::N_WEAK_REF | MachO::N_WEAK_DEF)) ==
347 (MachO::N_WEAK_REF | MachO::N_WEAK_DEF))
348 outs() << "weak external automatically hidden ";
350 outs() << "weak external ";
352 outs() << "external ";
355 if (NType & MachO::N_PEXT)
356 outs() << "non-external (was a private external) ";
358 outs() << "non-external ";
361 if (Filetype == MachO::MH_OBJECT &&
362 (NDesc & MachO::N_NO_DEAD_STRIP) == MachO::N_NO_DEAD_STRIP)
363 outs() << "[no dead strip] ";
365 if (Filetype == MachO::MH_OBJECT &&
366 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
367 (NDesc & MachO::N_SYMBOL_RESOLVER) == MachO::N_SYMBOL_RESOLVER)
368 outs() << "[symbol resolver] ";
370 if (Filetype == MachO::MH_OBJECT &&
371 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
372 (NDesc & MachO::N_ALT_ENTRY) == MachO::N_ALT_ENTRY)
373 outs() << "[alt entry] ";
375 if ((NDesc & MachO::N_ARM_THUMB_DEF) == MachO::N_ARM_THUMB_DEF)
376 outs() << "[Thumb] ";
378 if ((NType & MachO::N_TYPE) == MachO::N_INDR) {
379 outs() << I->Name << " (for ";
380 StringRef IndirectName;
381 if (MachO->getIndirectName(I->Sym.getRawDataRefImpl(), IndirectName))
384 outs() << IndirectName << ")";
388 if ((Flags & MachO::MH_TWOLEVEL) == MachO::MH_TWOLEVEL &&
389 (((NType & MachO::N_TYPE) == MachO::N_UNDF && NValue == 0) ||
390 (NType & MachO::N_TYPE) == MachO::N_PBUD)) {
391 uint32_t LibraryOrdinal = MachO::GET_LIBRARY_ORDINAL(NDesc);
392 if (LibraryOrdinal != 0) {
393 if (LibraryOrdinal == MachO::EXECUTABLE_ORDINAL)
394 outs() << " (from executable)";
395 else if (LibraryOrdinal == MachO::DYNAMIC_LOOKUP_ORDINAL)
396 outs() << " (dynamically looked up)";
398 StringRef LibraryName;
399 if (MachO->getLibraryShortNameByIndex(LibraryOrdinal - 1, LibraryName))
400 outs() << " (from bad library ordinal " << LibraryOrdinal << ")";
402 outs() << " (from " << LibraryName << ")";
410 // Table that maps Darwin's Mach-O stab constants to strings to allow printing.
411 struct DarwinStabName {
415 static const struct DarwinStabName DarwinStabNames[] = {
416 {MachO::N_GSYM, "GSYM"},
417 {MachO::N_FNAME, "FNAME"},
418 {MachO::N_FUN, "FUN"},
419 {MachO::N_STSYM, "STSYM"},
420 {MachO::N_LCSYM, "LCSYM"},
421 {MachO::N_BNSYM, "BNSYM"},
423 {MachO::N_AST, "AST"},
424 {MachO::N_OPT, "OPT"},
425 {MachO::N_RSYM, "RSYM"},
426 {MachO::N_SLINE, "SLINE"},
427 {MachO::N_ENSYM, "ENSYM"},
428 {MachO::N_SSYM, "SSYM"},
430 {MachO::N_OSO, "OSO"},
431 {MachO::N_LSYM, "LSYM"},
432 {MachO::N_BINCL, "BINCL"},
433 {MachO::N_SOL, "SOL"},
434 {MachO::N_PARAMS, "PARAM"},
435 {MachO::N_VERSION, "VERS"},
436 {MachO::N_OLEVEL, "OLEV"},
437 {MachO::N_PSYM, "PSYM"},
438 {MachO::N_EINCL, "EINCL"},
439 {MachO::N_ENTRY, "ENTRY"},
440 {MachO::N_LBRAC, "LBRAC"},
441 {MachO::N_EXCL, "EXCL"},
442 {MachO::N_RBRAC, "RBRAC"},
443 {MachO::N_BCOMM, "BCOMM"},
444 {MachO::N_ECOMM, "ECOMM"},
445 {MachO::N_ECOML, "ECOML"},
446 {MachO::N_LENG, "LENG"},
449 static const char *getDarwinStabString(uint8_t NType) {
450 for (unsigned i = 0; DarwinStabNames[i].Name; i++) {
451 if (DarwinStabNames[i].NType == NType)
452 return DarwinStabNames[i].Name;
457 // darwinPrintStab() prints the n_sect, n_desc along with a symbolic name of
458 // a stab n_type value in a Mach-O file.
459 static void darwinPrintStab(MachOObjectFile *MachO, SymbolListT::iterator I) {
460 MachO::nlist_64 STE_64;
465 DataRefImpl SymDRI = I->Sym.getRawDataRefImpl();
466 if (MachO->is64Bit()) {
467 STE_64 = MachO->getSymbol64TableEntry(SymDRI);
468 NType = STE_64.n_type;
469 NSect = STE_64.n_sect;
470 NDesc = STE_64.n_desc;
472 STE = MachO->getSymbolTableEntry(SymDRI);
479 format("%02x", NSect).print(Str, sizeof(Str));
480 outs() << ' ' << Str << ' ';
481 format("%04x", NDesc).print(Str, sizeof(Str));
482 outs() << Str << ' ';
483 if (const char *stabString = getDarwinStabString(NType))
484 format("%5.5s", stabString).print(Str, sizeof(Str));
486 format(" %02x", NType).print(Str, sizeof(Str));
490 static void sortAndPrintSymbolList(SymbolicFile &Obj, bool printName,
491 std::string ArchiveName,
492 std::string ArchitectureName) {
494 std::function<bool(const NMSymbol &, const NMSymbol &)> Cmp;
496 Cmp = compareSymbolAddress;
498 Cmp = compareSymbolSize;
500 Cmp = compareSymbolName;
503 Cmp = [=](const NMSymbol &A, const NMSymbol &B) { return Cmp(B, A); };
504 std::sort(SymbolList.begin(), SymbolList.end(), Cmp);
507 if (!PrintFileName) {
508 if (OutputFormat == posix && MultipleFiles && printName) {
509 outs() << '\n' << CurrentFilename << ":\n";
510 } else if (OutputFormat == bsd && MultipleFiles && printName) {
511 outs() << "\n" << CurrentFilename << ":\n";
512 } else if (OutputFormat == sysv) {
513 outs() << "\n\nSymbols from " << CurrentFilename << ":\n\n"
514 << "Name Value Class Type"
515 << " Size Line Section\n";
519 const char *printBlanks, *printFormat;
520 if (isSymbolList64Bit(Obj)) {
522 printFormat = "%016" PRIx64;
525 printFormat = "%08" PRIx64;
528 for (SymbolListT::iterator I = SymbolList.begin(), E = SymbolList.end();
530 uint32_t SymFlags = I->Sym.getFlags();
531 bool Undefined = SymFlags & SymbolRef::SF_Undefined;
532 if (!Undefined && UndefinedOnly)
534 if (Undefined && DefinedOnly)
536 bool Global = SymFlags & SymbolRef::SF_Global;
537 if (!Global && ExternalOnly)
539 if (SizeSort && !PrintAddress)
542 if (!ArchitectureName.empty())
543 outs() << "(for architecture " << ArchitectureName << "):";
544 if (!ArchiveName.empty())
545 outs() << ArchiveName << ":";
546 outs() << CurrentFilename << ": ";
548 if (JustSymbolName || (UndefinedOnly && isa<MachOObjectFile>(Obj))) {
549 outs() << I->Name << "\n";
553 char SymbolAddrStr[18] = "";
554 char SymbolSizeStr[18] = "";
556 if (OutputFormat == sysv || I->TypeChar == 'U')
557 strcpy(SymbolAddrStr, printBlanks);
558 if (OutputFormat == sysv)
559 strcpy(SymbolSizeStr, printBlanks);
561 if (I->TypeChar != 'U')
562 format(printFormat, I->Address)
563 .print(SymbolAddrStr, sizeof(SymbolAddrStr));
564 format(printFormat, I->Size).print(SymbolSizeStr, sizeof(SymbolSizeStr));
566 // If OutputFormat is darwin or we are printing Mach-O symbols in hex and
567 // we have a MachOObjectFile, call darwinPrintSymbol to print as darwin's
568 // nm(1) -m output or hex, else if OutputFormat is darwin or we are
569 // printing Mach-O symbols in hex and not a Mach-O object fall back to
570 // OutputFormat bsd (see below).
571 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
572 if ((OutputFormat == darwin || FormatMachOasHex) && MachO) {
573 darwinPrintSymbol(MachO, I, SymbolAddrStr, printBlanks);
574 } else if (OutputFormat == posix) {
575 outs() << I->Name << " " << I->TypeChar << " " << SymbolAddrStr
576 << SymbolSizeStr << "\n";
577 } else if (OutputFormat == bsd || (OutputFormat == darwin && !MachO)) {
579 outs() << SymbolAddrStr << ' ';
581 outs() << SymbolSizeStr;
584 outs() << I->TypeChar;
585 if (I->TypeChar == '-' && MachO)
586 darwinPrintStab(MachO, I);
587 outs() << " " << I->Name << "\n";
588 } else if (OutputFormat == sysv) {
589 std::string PaddedName(I->Name);
590 while (PaddedName.length() < 20)
592 outs() << PaddedName << "|" << SymbolAddrStr << "| " << I->TypeChar
593 << " | |" << SymbolSizeStr << "| |\n";
600 static char getSymbolNMTypeChar(ELFObjectFileBase &Obj,
601 basic_symbol_iterator I) {
603 elf_symbol_iterator SymI(I);
605 ErrorOr<elf_section_iterator> SecIOrErr = SymI->getSection();
606 if (error(SecIOrErr.getError()))
609 elf_section_iterator SecI = *SecIOrErr;
610 if (SecI != Obj.section_end()) {
611 switch (SecI->getType()) {
612 case ELF::SHT_PROGBITS:
613 case ELF::SHT_DYNAMIC:
614 switch (SecI->getFlags()) {
615 case (ELF::SHF_ALLOC | ELF::SHF_EXECINSTR):
617 case (ELF::SHF_TLS | ELF::SHF_ALLOC | ELF::SHF_WRITE):
618 case (ELF::SHF_ALLOC | ELF::SHF_WRITE):
621 case (ELF::SHF_ALLOC | ELF::SHF_MERGE):
622 case (ELF::SHF_ALLOC | ELF::SHF_MERGE | ELF::SHF_STRINGS):
626 case ELF::SHT_NOBITS:
631 if (SymI->getELFType() == ELF::STT_SECTION) {
632 ErrorOr<StringRef> Name = SymI->getName();
633 if (error(Name.getError()))
635 return StringSwitch<char>(*Name)
636 .StartsWith(".debug", 'N')
637 .StartsWith(".note", 'n')
644 static char getSymbolNMTypeChar(COFFObjectFile &Obj, symbol_iterator I) {
645 COFFSymbolRef Symb = Obj.getCOFFSymbol(*I);
647 symbol_iterator SymI(I);
649 ErrorOr<StringRef> Name = SymI->getName();
650 if (error(Name.getError()))
653 char Ret = StringSwitch<char>(*Name)
654 .StartsWith(".debug", 'N')
655 .StartsWith(".sxdata", 'N')
661 uint32_t Characteristics = 0;
662 if (!COFF::isReservedSectionNumber(Symb.getSectionNumber())) {
663 ErrorOr<section_iterator> SecIOrErr = SymI->getSection();
664 if (error(SecIOrErr.getError()))
666 section_iterator SecI = *SecIOrErr;
667 const coff_section *Section = Obj.getCOFFSection(*SecI);
668 Characteristics = Section->Characteristics;
671 switch (Symb.getSectionNumber()) {
672 case COFF::IMAGE_SYM_DEBUG:
675 // Check section type.
676 if (Characteristics & COFF::IMAGE_SCN_CNT_CODE)
678 if (Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
679 return Characteristics & COFF::IMAGE_SCN_MEM_WRITE ? 'd' : 'r';
680 if (Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)
682 if (Characteristics & COFF::IMAGE_SCN_LNK_INFO)
684 // Check for section symbol.
685 if (Symb.isSectionDefinition())
692 static uint8_t getNType(MachOObjectFile &Obj, DataRefImpl Symb) {
694 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
697 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
701 static char getSymbolNMTypeChar(MachOObjectFile &Obj, basic_symbol_iterator I) {
702 DataRefImpl Symb = I->getRawDataRefImpl();
703 uint8_t NType = getNType(Obj, Symb);
705 if (NType & MachO::N_STAB)
708 switch (NType & MachO::N_TYPE) {
713 case MachO::N_SECT: {
714 section_iterator Sec = *Obj.getSymbolSection(Symb);
715 DataRefImpl Ref = Sec->getRawDataRefImpl();
716 StringRef SectionName;
717 Obj.getSectionName(Ref, SectionName);
718 StringRef SegmentName = Obj.getSectionFinalSegmentName(Ref);
719 if (SegmentName == "__TEXT" && SectionName == "__text")
721 else if (SegmentName == "__DATA" && SectionName == "__data")
723 else if (SegmentName == "__DATA" && SectionName == "__bss")
733 static char getSymbolNMTypeChar(const GlobalValue &GV) {
734 if (GV.getType()->getElementType()->isFunctionTy())
736 // FIXME: should we print 'b'? At the IR level we cannot be sure if this
737 // will be in bss or not, but we could approximate.
741 static char getSymbolNMTypeChar(IRObjectFile &Obj, basic_symbol_iterator I) {
742 const GlobalValue *GV = Obj.getSymbolGV(I->getRawDataRefImpl());
745 return getSymbolNMTypeChar(*GV);
748 static bool isObject(SymbolicFile &Obj, basic_symbol_iterator I) {
749 auto *ELF = dyn_cast<ELFObjectFileBase>(&Obj);
753 return elf_symbol_iterator(I)->getELFType() == ELF::STT_OBJECT;
756 static char getNMTypeChar(SymbolicFile &Obj, basic_symbol_iterator I) {
757 uint32_t Symflags = I->getFlags();
758 if ((Symflags & object::SymbolRef::SF_Weak) && !isa<MachOObjectFile>(Obj)) {
759 char Ret = isObject(Obj, I) ? 'v' : 'w';
760 if (!(Symflags & object::SymbolRef::SF_Undefined))
765 if (Symflags & object::SymbolRef::SF_Undefined)
768 if (Symflags & object::SymbolRef::SF_Common)
772 if (Symflags & object::SymbolRef::SF_Absolute)
774 else if (IRObjectFile *IR = dyn_cast<IRObjectFile>(&Obj))
775 Ret = getSymbolNMTypeChar(*IR, I);
776 else if (COFFObjectFile *COFF = dyn_cast<COFFObjectFile>(&Obj))
777 Ret = getSymbolNMTypeChar(*COFF, I);
778 else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj))
779 Ret = getSymbolNMTypeChar(*MachO, I);
781 Ret = getSymbolNMTypeChar(cast<ELFObjectFileBase>(Obj), I);
783 if (Symflags & object::SymbolRef::SF_Global)
789 // getNsectForSegSect() is used to implement the Mach-O "-s segname sectname"
790 // option to dump only those symbols from that section in a Mach-O file.
791 // It is called once for each Mach-O file from dumpSymbolNamesFromObject()
792 // to get the section number for that named section from the command line
793 // arguments. It returns the section number for that section in the Mach-O
794 // file or zero it is not present.
795 static unsigned getNsectForSegSect(MachOObjectFile *Obj) {
797 for (section_iterator I = Obj->section_begin(), E = Obj->section_end();
799 DataRefImpl Ref = I->getRawDataRefImpl();
800 StringRef SectionName;
801 Obj->getSectionName(Ref, SectionName);
802 StringRef SegmentName = Obj->getSectionFinalSegmentName(Ref);
803 if (SegmentName == SegSect[0] && SectionName == SegSect[1])
810 // getNsectInMachO() is used to implement the Mach-O "-s segname sectname"
811 // option to dump only those symbols from that section in a Mach-O file.
812 // It is called once for each symbol in a Mach-O file from
813 // dumpSymbolNamesFromObject() and returns the section number for that symbol
814 // if it is in a section, else it returns 0.
815 static unsigned getNsectInMachO(MachOObjectFile &Obj, BasicSymbolRef Sym) {
816 DataRefImpl Symb = Sym.getRawDataRefImpl();
818 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
819 if ((STE.n_type & MachO::N_TYPE) == MachO::N_SECT)
823 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
824 if ((STE.n_type & MachO::N_TYPE) == MachO::N_SECT)
829 static void dumpSymbolNamesFromObject(SymbolicFile &Obj, bool printName,
830 std::string ArchiveName = std::string(),
831 std::string ArchitectureName =
833 auto Symbols = Obj.symbols();
835 const auto *E = dyn_cast<ELFObjectFileBase>(&Obj);
837 error("File format has no dynamic symbol table", Obj.getFileName());
840 auto DynSymbols = E->getDynamicSymbolIterators();
842 make_range<basic_symbol_iterator>(DynSymbols.begin(), DynSymbols.end());
844 std::string NameBuffer;
845 raw_string_ostream OS(NameBuffer);
846 // If a "-s segname sectname" option was specified and this is a Mach-O
847 // file get the section number for that section in this object file.
848 unsigned int Nsect = 0;
849 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
850 if (SegSect.size() != 0 && MachO) {
851 Nsect = getNsectForSegSect(MachO);
852 // If this section is not in the object file no symbols are printed.
856 for (BasicSymbolRef Sym : Symbols) {
857 uint32_t SymFlags = Sym.getFlags();
858 if (!DebugSyms && (SymFlags & SymbolRef::SF_FormatSpecific))
860 if (WithoutAliases) {
861 if (IRObjectFile *IR = dyn_cast<IRObjectFile>(&Obj)) {
862 const GlobalValue *GV = IR->getSymbolGV(Sym.getRawDataRefImpl());
863 if (GV && isa<GlobalAlias>(GV))
867 // If a "-s segname sectname" option was specified and this is a Mach-O
868 // file and this section appears in this file, Nsect will be non-zero then
869 // see if this symbol is a symbol from that section and if not skip it.
870 if (Nsect && Nsect != getNsectInMachO(*MachO, Sym))
876 if (isa<ELFObjectFileBase>(&Obj))
877 S.Size = ELFSymbolRef(Sym).getSize();
879 if (PrintAddress && isa<ObjectFile>(Obj)) {
880 SymbolRef SymRef(Sym);
881 ErrorOr<uint64_t> AddressOrErr = SymRef.getAddress();
882 if (error(AddressOrErr.getError()))
884 S.Address = *AddressOrErr;
886 S.TypeChar = getNMTypeChar(Obj, Sym);
887 if (error(Sym.printName(OS)))
891 SymbolList.push_back(S);
895 const char *P = NameBuffer.c_str();
896 for (unsigned I = 0; I < SymbolList.size(); ++I) {
897 SymbolList[I].Name = P;
901 CurrentFilename = Obj.getFileName();
902 sortAndPrintSymbolList(Obj, printName, ArchiveName, ArchitectureName);
905 // checkMachOAndArchFlags() checks to see if the SymbolicFile is a Mach-O file
906 // and if it is and there is a list of architecture flags is specified then
907 // check to make sure this Mach-O file is one of those architectures or all
908 // architectures was specificed. If not then an error is generated and this
909 // routine returns false. Else it returns true.
910 static bool checkMachOAndArchFlags(SymbolicFile *O, std::string &Filename) {
911 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(O);
913 if (!MachO || ArchAll || ArchFlags.size() == 0)
916 MachO::mach_header H;
917 MachO::mach_header_64 H_64;
919 if (MachO->is64Bit()) {
920 H_64 = MachO->MachOObjectFile::getHeader64();
921 T = MachOObjectFile::getArch(H_64.cputype, H_64.cpusubtype);
923 H = MachO->MachOObjectFile::getHeader();
924 T = MachOObjectFile::getArch(H.cputype, H.cpusubtype);
927 ArchFlags.begin(), ArchFlags.end(),
928 [&](const std::string &Name) { return Name == T.getArchName(); })) {
929 error("No architecture specified", Filename);
935 static void dumpSymbolNamesFromFile(std::string &Filename) {
936 ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
937 MemoryBuffer::getFileOrSTDIN(Filename);
938 if (error(BufferOrErr.getError(), Filename))
941 LLVMContext &Context = getGlobalContext();
942 ErrorOr<std::unique_ptr<Binary>> BinaryOrErr = createBinary(
943 BufferOrErr.get()->getMemBufferRef(), NoLLVMBitcode ? nullptr : &Context);
944 if (error(BinaryOrErr.getError(), Filename))
946 Binary &Bin = *BinaryOrErr.get();
948 if (Archive *A = dyn_cast<Archive>(&Bin)) {
950 Archive::symbol_iterator I = A->symbol_begin();
951 Archive::symbol_iterator E = A->symbol_end();
953 outs() << "Archive map\n";
954 for (; I != E; ++I) {
955 ErrorOr<Archive::Child> C = I->getMember();
956 if (error(C.getError()))
958 ErrorOr<StringRef> FileNameOrErr = C->getName();
959 if (error(FileNameOrErr.getError()))
961 StringRef SymName = I->getName();
962 outs() << SymName << " in " << FileNameOrErr.get() << "\n";
968 for (Archive::child_iterator I = A->child_begin(), E = A->child_end();
970 if (error(I->getError()))
973 ErrorOr<std::unique_ptr<Binary>> ChildOrErr = C.getAsBinary(&Context);
974 if (ChildOrErr.getError())
976 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
977 if (!checkMachOAndArchFlags(O, Filename))
979 if (!PrintFileName) {
981 if (isa<MachOObjectFile>(O)) {
982 outs() << Filename << "(" << O->getFileName() << ")";
984 outs() << O->getFileName();
987 dumpSymbolNamesFromObject(*O, false, Filename);
992 if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(&Bin)) {
993 // If we have a list of architecture flags specified dump only those.
994 if (!ArchAll && ArchFlags.size() != 0) {
995 // Look for a slice in the universal binary that matches each ArchFlag.
997 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
999 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1000 E = UB->end_objects();
1002 if (ArchFlags[i] == I->getArchTypeName()) {
1004 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr =
1005 I->getAsObjectFile();
1006 std::string ArchiveName;
1007 std::string ArchitectureName;
1008 ArchiveName.clear();
1009 ArchitectureName.clear();
1011 ObjectFile &Obj = *ObjOrErr.get();
1012 if (ArchFlags.size() > 1) {
1014 ArchitectureName = I->getArchTypeName();
1016 outs() << "\n" << Obj.getFileName() << " (for architecture "
1017 << I->getArchTypeName() << ")"
1020 dumpSymbolNamesFromObject(Obj, false, ArchiveName,
1022 } else if (ErrorOr<std::unique_ptr<Archive>> AOrErr =
1023 I->getAsArchive()) {
1024 std::unique_ptr<Archive> &A = *AOrErr;
1025 for (Archive::child_iterator AI = A->child_begin(),
1026 AE = A->child_end();
1028 if (error(AI->getError()))
1030 auto &C = AI->get();
1031 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
1032 C.getAsBinary(&Context);
1033 if (ChildOrErr.getError())
1035 if (SymbolicFile *O =
1036 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1037 if (PrintFileName) {
1038 ArchiveName = A->getFileName();
1039 if (ArchFlags.size() > 1)
1040 ArchitectureName = I->getArchTypeName();
1042 outs() << "\n" << A->getFileName();
1043 outs() << "(" << O->getFileName() << ")";
1044 if (ArchFlags.size() > 1) {
1045 outs() << " (for architecture " << I->getArchTypeName()
1050 dumpSymbolNamesFromObject(*O, false, ArchiveName,
1059 "file: " + Filename + " does not contain architecture");
1065 // No architecture flags were specified so if this contains a slice that
1066 // matches the host architecture dump only that.
1068 StringRef HostArchName = MachOObjectFile::getHostArch().getArchName();
1069 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1070 E = UB->end_objects();
1072 if (HostArchName == I->getArchTypeName()) {
1073 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
1074 std::string ArchiveName;
1075 ArchiveName.clear();
1077 ObjectFile &Obj = *ObjOrErr.get();
1078 dumpSymbolNamesFromObject(Obj, false);
1079 } else if (ErrorOr<std::unique_ptr<Archive>> AOrErr =
1080 I->getAsArchive()) {
1081 std::unique_ptr<Archive> &A = *AOrErr;
1082 for (Archive::child_iterator AI = A->child_begin(),
1083 AE = A->child_end();
1085 if (error(AI->getError()))
1087 auto &C = AI->get();
1088 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
1089 C.getAsBinary(&Context);
1090 if (ChildOrErr.getError())
1092 if (SymbolicFile *O =
1093 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1095 ArchiveName = A->getFileName();
1097 outs() << "\n" << A->getFileName() << "(" << O->getFileName()
1100 dumpSymbolNamesFromObject(*O, false, ArchiveName);
1108 // Either all architectures have been specified or none have been specified
1109 // and this does not contain the host architecture so dump all the slices.
1110 bool moreThanOneArch = UB->getNumberOfObjects() > 1;
1111 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1112 E = UB->end_objects();
1114 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
1115 std::string ArchiveName;
1116 std::string ArchitectureName;
1117 ArchiveName.clear();
1118 ArchitectureName.clear();
1120 ObjectFile &Obj = *ObjOrErr.get();
1121 if (PrintFileName) {
1122 if (isa<MachOObjectFile>(Obj) && moreThanOneArch)
1123 ArchitectureName = I->getArchTypeName();
1125 if (moreThanOneArch)
1127 outs() << Obj.getFileName();
1128 if (isa<MachOObjectFile>(Obj) && moreThanOneArch)
1129 outs() << " (for architecture " << I->getArchTypeName() << ")";
1132 dumpSymbolNamesFromObject(Obj, false, ArchiveName, ArchitectureName);
1133 } else if (ErrorOr<std::unique_ptr<Archive>> AOrErr = I->getAsArchive()) {
1134 std::unique_ptr<Archive> &A = *AOrErr;
1135 for (Archive::child_iterator AI = A->child_begin(), AE = A->child_end();
1137 if (error(AI->getError()))
1139 auto &C = AI->get();
1140 ErrorOr<std::unique_ptr<Binary>> ChildOrErr = C.getAsBinary(&Context);
1141 if (ChildOrErr.getError())
1143 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1144 if (PrintFileName) {
1145 ArchiveName = A->getFileName();
1146 if (isa<MachOObjectFile>(O) && moreThanOneArch)
1147 ArchitectureName = I->getArchTypeName();
1149 outs() << "\n" << A->getFileName();
1150 if (isa<MachOObjectFile>(O)) {
1151 outs() << "(" << O->getFileName() << ")";
1152 if (moreThanOneArch)
1153 outs() << " (for architecture " << I->getArchTypeName()
1156 outs() << ":" << O->getFileName();
1159 dumpSymbolNamesFromObject(*O, false, ArchiveName, ArchitectureName);
1166 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&Bin)) {
1167 if (!checkMachOAndArchFlags(O, Filename))
1169 dumpSymbolNamesFromObject(*O, true);
1172 error("unrecognizable file type", Filename);
1175 int main(int argc, char **argv) {
1176 // Print a stack trace if we signal out.
1177 sys::PrintStackTraceOnErrorSignal();
1178 PrettyStackTraceProgram X(argc, argv);
1180 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
1181 cl::ParseCommandLineOptions(argc, argv, "llvm symbol table dumper\n");
1183 // llvm-nm only reads binary files.
1184 if (error(sys::ChangeStdinToBinary()))
1187 llvm::InitializeAllTargetInfos();
1188 llvm::InitializeAllTargetMCs();
1189 llvm::InitializeAllAsmParsers();
1195 OutputFormat = posix;
1197 OutputFormat = darwin;
1199 // The relative order of these is important. If you pass --size-sort it should
1200 // only print out the size. However, if you pass -S --size-sort, it should
1201 // print out both the size and address.
1202 if (SizeSort && !PrintSize)
1203 PrintAddress = false;
1204 if (OutputFormat == sysv || SizeSort)
1207 switch (InputFilenames.size()) {
1209 InputFilenames.push_back("a.out");
1213 MultipleFiles = true;
1216 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
1217 if (ArchFlags[i] == "all") {
1220 if (!MachOObjectFile::isValidArch(ArchFlags[i]))
1221 error("Unknown architecture named '" + ArchFlags[i] + "'",
1222 "for the -arch option");
1226 if (SegSect.size() != 0 && SegSect.size() != 2)
1227 error("bad number of arguments (must be two arguments)",
1228 "for the -s option");
1230 std::for_each(InputFilenames.begin(), InputFilenames.end(),
1231 dumpSymbolNamesFromFile);