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/raw_ostream.h"
40 #include "llvm/Support/TargetSelect.h"
45 #include <system_error>
48 using namespace object;
51 enum OutputFormatTy { bsd, sysv, posix, darwin };
52 cl::opt<OutputFormatTy> OutputFormat(
53 "format", cl::desc("Specify output format"),
54 cl::values(clEnumVal(bsd, "BSD format"), clEnumVal(sysv, "System V format"),
55 clEnumVal(posix, "POSIX.2 format"),
56 clEnumVal(darwin, "Darwin -m format"), clEnumValEnd),
58 cl::alias OutputFormat2("f", cl::desc("Alias for --format"),
59 cl::aliasopt(OutputFormat));
61 cl::list<std::string> InputFilenames(cl::Positional, cl::desc("<input files>"),
64 cl::opt<bool> UndefinedOnly("undefined-only",
65 cl::desc("Show only undefined symbols"));
66 cl::alias UndefinedOnly2("u", cl::desc("Alias for --undefined-only"),
67 cl::aliasopt(UndefinedOnly));
69 cl::opt<bool> DynamicSyms("dynamic",
70 cl::desc("Display the dynamic symbols instead "
71 "of normal symbols."));
72 cl::alias DynamicSyms2("D", cl::desc("Alias for --dynamic"),
73 cl::aliasopt(DynamicSyms));
75 cl::opt<bool> DefinedOnly("defined-only",
76 cl::desc("Show only defined symbols"));
77 cl::alias DefinedOnly2("U", cl::desc("Alias for --defined-only"),
78 cl::aliasopt(DefinedOnly));
80 cl::opt<bool> ExternalOnly("extern-only",
81 cl::desc("Show only external symbols"));
82 cl::alias ExternalOnly2("g", cl::desc("Alias for --extern-only"),
83 cl::aliasopt(ExternalOnly));
85 cl::opt<bool> BSDFormat("B", cl::desc("Alias for --format=bsd"));
86 cl::opt<bool> POSIXFormat("P", cl::desc("Alias for --format=posix"));
87 cl::opt<bool> DarwinFormat("m", cl::desc("Alias for --format=darwin"));
89 static cl::list<std::string>
90 ArchFlags("arch", cl::desc("architecture(s) from a Mach-O file to dump"),
94 cl::opt<bool> PrintFileName(
96 cl::desc("Precede each symbol with the object file it came from"));
98 cl::alias PrintFileNameA("A", cl::desc("Alias for --print-file-name"),
99 cl::aliasopt(PrintFileName));
100 cl::alias PrintFileNameo("o", cl::desc("Alias for --print-file-name"),
101 cl::aliasopt(PrintFileName));
103 cl::opt<bool> DebugSyms("debug-syms",
104 cl::desc("Show all symbols, even debugger only"));
105 cl::alias DebugSymsa("a", cl::desc("Alias for --debug-syms"),
106 cl::aliasopt(DebugSyms));
108 cl::opt<bool> NumericSort("numeric-sort", cl::desc("Sort symbols by address"));
109 cl::alias NumericSortn("n", cl::desc("Alias for --numeric-sort"),
110 cl::aliasopt(NumericSort));
111 cl::alias NumericSortv("v", cl::desc("Alias for --numeric-sort"),
112 cl::aliasopt(NumericSort));
114 cl::opt<bool> NoSort("no-sort", cl::desc("Show symbols in order encountered"));
115 cl::alias NoSortp("p", cl::desc("Alias for --no-sort"), cl::aliasopt(NoSort));
117 cl::opt<bool> ReverseSort("reverse-sort", cl::desc("Sort in reverse order"));
118 cl::alias ReverseSortr("r", cl::desc("Alias for --reverse-sort"),
119 cl::aliasopt(ReverseSort));
121 cl::opt<bool> PrintSize("print-size",
122 cl::desc("Show symbol size instead of address"));
123 cl::alias PrintSizeS("S", cl::desc("Alias for --print-size"),
124 cl::aliasopt(PrintSize));
126 cl::opt<bool> SizeSort("size-sort", cl::desc("Sort symbols by size"));
128 cl::opt<bool> WithoutAliases("without-aliases", cl::Hidden,
129 cl::desc("Exclude aliases from output"));
131 cl::opt<bool> ArchiveMap("print-armap", cl::desc("Print the archive map"));
132 cl::alias ArchiveMaps("M", cl::desc("Alias for --print-armap"),
133 cl::aliasopt(ArchiveMap));
135 cl::opt<bool> JustSymbolName("just-symbol-name",
136 cl::desc("Print just the symbol's name"));
137 cl::alias JustSymbolNames("j", cl::desc("Alias for --just-symbol-name"),
138 cl::aliasopt(JustSymbolName));
140 // FIXME: This option takes exactly two strings and should be allowed anywhere
141 // on the command line. Such that "llvm-nm -s __TEXT __text foo.o" would work.
142 // But that does not as the CommandLine Library does not have a way to make
143 // this work. For now the "-s __TEXT __text" has to be last on the command
145 cl::list<std::string> SegSect("s", cl::Positional, cl::ZeroOrMore,
146 cl::desc("Dump only symbols from this segment "
147 "and section name, Mach-O only"));
149 cl::opt<bool> FormatMachOasHex("x", cl::desc("Print symbol entry in hex, "
152 cl::opt<bool> NoLLVMBitcode("no-llvm-bc",
153 cl::desc("Disable LLVM bitcode reader"));
155 bool PrintAddress = true;
157 bool MultipleFiles = false;
159 bool HadError = false;
161 std::string ToolName;
164 static void error(Twine Message, Twine Path = Twine()) {
166 errs() << ToolName << ": " << Path << ": " << Message << ".\n";
169 static bool error(std::error_code EC, Twine Path = Twine()) {
171 error(EC.message(), Path);
187 static bool compareSymbolAddress(const NMSymbol &A, const NMSymbol &B) {
189 if (A.Address < B.Address)
191 else if (A.Address == B.Address && A.Name < B.Name)
193 else if (A.Address == B.Address && A.Name == B.Name && A.Size < B.Size)
198 if (A.Address > B.Address)
200 else if (A.Address == B.Address && A.Name > B.Name)
202 else if (A.Address == B.Address && A.Name == B.Name && A.Size > B.Size)
209 static bool compareSymbolSize(const NMSymbol &A, const NMSymbol &B) {
213 else if (A.Size == B.Size && A.Name < B.Name)
215 else if (A.Size == B.Size && A.Name == B.Name && A.Address < B.Address)
222 else if (A.Size == B.Size && A.Name > B.Name)
224 else if (A.Size == B.Size && A.Name == B.Name && A.Address > B.Address)
231 static bool compareSymbolName(const NMSymbol &A, const NMSymbol &B) {
235 else if (A.Name == B.Name && A.Size < B.Size)
237 else if (A.Name == B.Name && A.Size == B.Size && A.Address < B.Address)
244 else if (A.Name == B.Name && A.Size > B.Size)
246 else if (A.Name == B.Name && A.Size == B.Size && A.Address > B.Address)
253 static char isSymbolList64Bit(SymbolicFile &Obj) {
254 if (isa<IRObjectFile>(Obj))
256 else if (isa<COFFObjectFile>(Obj))
258 else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj))
259 return MachO->is64Bit();
260 else if (isa<ELF32LEObjectFile>(Obj))
262 else if (isa<ELF64LEObjectFile>(Obj))
264 else if (isa<ELF32BEObjectFile>(Obj))
266 else if (isa<ELF64BEObjectFile>(Obj))
272 static StringRef CurrentFilename;
273 typedef std::vector<NMSymbol> SymbolListT;
274 static SymbolListT SymbolList;
276 // darwinPrintSymbol() is used to print a symbol from a Mach-O file when the
277 // the OutputFormat is darwin or we are printing Mach-O symbols in hex. For
278 // the darwin format it produces the same output as darwin's nm(1) -m output
279 // and when printing Mach-O symbols in hex it produces the same output as
280 // darwin's nm(1) -x format.
281 static void darwinPrintSymbol(MachOObjectFile *MachO, SymbolListT::iterator I,
282 char *SymbolAddrStr, const char *printBlanks) {
283 MachO::mach_header H;
284 MachO::mach_header_64 H_64;
285 uint32_t Filetype, Flags;
286 MachO::nlist_64 STE_64;
293 if (MachO->is64Bit()) {
294 H_64 = MachO->MachOObjectFile::getHeader64();
295 Filetype = H_64.filetype;
297 STE_64 = MachO->getSymbol64TableEntry(I->Symb);
298 NType = STE_64.n_type;
299 NSect = STE_64.n_sect;
300 NDesc = STE_64.n_desc;
301 NStrx = STE_64.n_strx;
302 NValue = STE_64.n_value;
304 H = MachO->MachOObjectFile::getHeader();
305 Filetype = H.filetype;
307 STE = MachO->getSymbolTableEntry(I->Symb);
312 NValue = STE.n_value;
315 // If we are printing Mach-O symbols in hex do that and return.
316 if (FormatMachOasHex) {
318 const char *printFormat;
319 if (MachO->is64Bit())
320 printFormat = "%016" PRIx64;
322 printFormat = "%08" PRIx64;
323 format(printFormat, NValue).print(Str, sizeof(Str));
324 outs() << Str << ' ';
325 format("%02x", NType).print(Str, sizeof(Str));
326 outs() << Str << ' ';
327 format("%02x", NSect).print(Str, sizeof(Str));
328 outs() << Str << ' ';
329 format("%04x", NDesc).print(Str, sizeof(Str));
330 outs() << Str << ' ';
331 format("%08x", NStrx).print(Str, sizeof(Str));
332 outs() << Str << ' ';
333 outs() << I->Name << "\n";
338 if ((NType & MachO::N_TYPE) == MachO::N_INDR)
339 strcpy(SymbolAddrStr, printBlanks);
340 outs() << SymbolAddrStr << ' ';
343 switch (NType & MachO::N_TYPE) {
346 outs() << "(common) ";
347 if (MachO::GET_COMM_ALIGN(NDesc) != 0)
348 outs() << "(alignment 2^" << (int)MachO::GET_COMM_ALIGN(NDesc) << ") ";
350 if ((NType & MachO::N_TYPE) == MachO::N_PBUD)
351 outs() << "(prebound ";
354 if ((NDesc & MachO::REFERENCE_TYPE) ==
355 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
356 outs() << "undefined [lazy bound]) ";
357 else if ((NDesc & MachO::REFERENCE_TYPE) ==
358 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
359 outs() << "undefined [private lazy bound]) ";
360 else if ((NDesc & MachO::REFERENCE_TYPE) ==
361 MachO::REFERENCE_FLAG_PRIVATE_UNDEFINED_NON_LAZY)
362 outs() << "undefined [private]) ";
364 outs() << "undefined) ";
368 outs() << "(absolute) ";
371 outs() << "(indirect) ";
373 case MachO::N_SECT: {
374 section_iterator Sec = MachO->section_end();
375 MachO->getSymbolSection(I->Symb, Sec);
376 DataRefImpl Ref = Sec->getRawDataRefImpl();
377 StringRef SectionName;
378 MachO->getSectionName(Ref, SectionName);
379 StringRef SegmentName = MachO->getSectionFinalSegmentName(Ref);
380 outs() << "(" << SegmentName << "," << SectionName << ") ";
388 if (NType & MachO::N_EXT) {
389 if (NDesc & MachO::REFERENCED_DYNAMICALLY)
390 outs() << "[referenced dynamically] ";
391 if (NType & MachO::N_PEXT) {
392 if ((NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF)
393 outs() << "weak private external ";
395 outs() << "private external ";
397 if ((NDesc & MachO::N_WEAK_REF) == MachO::N_WEAK_REF ||
398 (NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF) {
399 if ((NDesc & (MachO::N_WEAK_REF | MachO::N_WEAK_DEF)) ==
400 (MachO::N_WEAK_REF | MachO::N_WEAK_DEF))
401 outs() << "weak external automatically hidden ";
403 outs() << "weak external ";
405 outs() << "external ";
408 if (NType & MachO::N_PEXT)
409 outs() << "non-external (was a private external) ";
411 outs() << "non-external ";
414 if (Filetype == MachO::MH_OBJECT &&
415 (NDesc & MachO::N_NO_DEAD_STRIP) == MachO::N_NO_DEAD_STRIP)
416 outs() << "[no dead strip] ";
418 if (Filetype == MachO::MH_OBJECT &&
419 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
420 (NDesc & MachO::N_SYMBOL_RESOLVER) == MachO::N_SYMBOL_RESOLVER)
421 outs() << "[symbol resolver] ";
423 if (Filetype == MachO::MH_OBJECT &&
424 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
425 (NDesc & MachO::N_ALT_ENTRY) == MachO::N_ALT_ENTRY)
426 outs() << "[alt entry] ";
428 if ((NDesc & MachO::N_ARM_THUMB_DEF) == MachO::N_ARM_THUMB_DEF)
429 outs() << "[Thumb] ";
431 if ((NType & MachO::N_TYPE) == MachO::N_INDR) {
432 outs() << I->Name << " (for ";
433 StringRef IndirectName;
434 if (MachO->getIndirectName(I->Symb, IndirectName))
437 outs() << IndirectName << ")";
441 if ((Flags & MachO::MH_TWOLEVEL) == MachO::MH_TWOLEVEL &&
442 (((NType & MachO::N_TYPE) == MachO::N_UNDF && NValue == 0) ||
443 (NType & MachO::N_TYPE) == MachO::N_PBUD)) {
444 uint32_t LibraryOrdinal = MachO::GET_LIBRARY_ORDINAL(NDesc);
445 if (LibraryOrdinal != 0) {
446 if (LibraryOrdinal == MachO::EXECUTABLE_ORDINAL)
447 outs() << " (from executable)";
448 else if (LibraryOrdinal == MachO::DYNAMIC_LOOKUP_ORDINAL)
449 outs() << " (dynamically looked up)";
451 StringRef LibraryName;
452 if (MachO->getLibraryShortNameByIndex(LibraryOrdinal - 1, LibraryName))
453 outs() << " (from bad library ordinal " << LibraryOrdinal << ")";
455 outs() << " (from " << LibraryName << ")";
463 // Table that maps Darwin's Mach-O stab constants to strings to allow printing.
464 struct DarwinStabName {
468 static const struct DarwinStabName DarwinStabNames[] = {
469 {MachO::N_GSYM, "GSYM"},
470 {MachO::N_FNAME, "FNAME"},
471 {MachO::N_FUN, "FUN"},
472 {MachO::N_STSYM, "STSYM"},
473 {MachO::N_LCSYM, "LCSYM"},
474 {MachO::N_BNSYM, "BNSYM"},
476 {MachO::N_AST, "AST"},
477 {MachO::N_OPT, "OPT"},
478 {MachO::N_RSYM, "RSYM"},
479 {MachO::N_SLINE, "SLINE"},
480 {MachO::N_ENSYM, "ENSYM"},
481 {MachO::N_SSYM, "SSYM"},
483 {MachO::N_OSO, "OSO"},
484 {MachO::N_LSYM, "LSYM"},
485 {MachO::N_BINCL, "BINCL"},
486 {MachO::N_SOL, "SOL"},
487 {MachO::N_PARAMS, "PARAM"},
488 {MachO::N_VERSION, "VERS"},
489 {MachO::N_OLEVEL, "OLEV"},
490 {MachO::N_PSYM, "PSYM"},
491 {MachO::N_EINCL, "EINCL"},
492 {MachO::N_ENTRY, "ENTRY"},
493 {MachO::N_LBRAC, "LBRAC"},
494 {MachO::N_EXCL, "EXCL"},
495 {MachO::N_RBRAC, "RBRAC"},
496 {MachO::N_BCOMM, "BCOMM"},
497 {MachO::N_ECOMM, "ECOMM"},
498 {MachO::N_ECOML, "ECOML"},
499 {MachO::N_LENG, "LENG"},
501 static const char *getDarwinStabString(uint8_t NType) {
502 for (unsigned i = 0; DarwinStabNames[i].Name; i++) {
503 if (DarwinStabNames[i].NType == NType)
504 return DarwinStabNames[i].Name;
509 // darwinPrintStab() prints the n_sect, n_desc along with a symbolic name of
510 // a stab n_type value in a Mach-O file.
511 static void darwinPrintStab(MachOObjectFile *MachO, SymbolListT::iterator I) {
512 MachO::nlist_64 STE_64;
517 if (MachO->is64Bit()) {
518 STE_64 = MachO->getSymbol64TableEntry(I->Symb);
519 NType = STE_64.n_type;
520 NSect = STE_64.n_sect;
521 NDesc = STE_64.n_desc;
523 STE = MachO->getSymbolTableEntry(I->Symb);
530 format("%02x", NSect).print(Str, sizeof(Str));
531 outs() << ' ' << Str << ' ';
532 format("%04x", NDesc).print(Str, sizeof(Str));
533 outs() << Str << ' ';
534 if (const char *stabString = getDarwinStabString(NType))
535 format("%5.5s", stabString).print(Str, sizeof(Str));
537 format(" %02x", NType).print(Str, sizeof(Str));
541 static void sortAndPrintSymbolList(SymbolicFile &Obj, bool printName,
542 std::string ArchiveName,
543 std::string ArchitectureName) {
546 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolAddress);
548 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolSize);
550 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolName);
553 if (!PrintFileName) {
554 if (OutputFormat == posix && MultipleFiles && printName) {
555 outs() << '\n' << CurrentFilename << ":\n";
556 } else if (OutputFormat == bsd && MultipleFiles && printName) {
557 outs() << "\n" << CurrentFilename << ":\n";
558 } else if (OutputFormat == sysv) {
559 outs() << "\n\nSymbols from " << CurrentFilename << ":\n\n"
560 << "Name Value Class Type"
561 << " Size Line Section\n";
565 const char *printBlanks, *printFormat;
566 if (isSymbolList64Bit(Obj)) {
568 printFormat = "%016" PRIx64;
571 printFormat = "%08" PRIx64;
574 for (SymbolListT::iterator I = SymbolList.begin(), E = SymbolList.end();
576 if ((I->TypeChar != 'U') && UndefinedOnly)
578 if ((I->TypeChar == 'U') && DefinedOnly)
580 if (SizeSort && !PrintAddress && I->Size == UnknownAddressOrSize)
583 if (!ArchitectureName.empty())
584 outs() << "(for architecture " << ArchitectureName << "):";
585 if (!ArchiveName.empty())
586 outs() << ArchiveName << ":";
587 outs() << CurrentFilename << ": ";
589 if (JustSymbolName || (UndefinedOnly && isa<MachOObjectFile>(Obj))) {
590 outs() << I->Name << "\n";
594 char SymbolAddrStr[18] = "";
595 char SymbolSizeStr[18] = "";
597 if (OutputFormat == sysv || I->Address == UnknownAddressOrSize)
598 strcpy(SymbolAddrStr, printBlanks);
599 if (OutputFormat == sysv)
600 strcpy(SymbolSizeStr, printBlanks);
602 if (I->Address != UnknownAddressOrSize)
603 format(printFormat, I->Address)
604 .print(SymbolAddrStr, sizeof(SymbolAddrStr));
605 if (I->Size != UnknownAddressOrSize)
606 format(printFormat, I->Size).print(SymbolSizeStr, sizeof(SymbolSizeStr));
608 // If OutputFormat is darwin or we are printing Mach-O symbols in hex and
609 // we have a MachOObjectFile, call darwinPrintSymbol to print as darwin's
610 // nm(1) -m output or hex, else if OutputFormat is darwin or we are
611 // printing Mach-O symbols in hex and not a Mach-O object fall back to
612 // OutputFormat bsd (see below).
613 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
614 if ((OutputFormat == darwin || FormatMachOasHex) && MachO) {
615 darwinPrintSymbol(MachO, I, SymbolAddrStr, printBlanks);
616 } else if (OutputFormat == posix) {
617 outs() << I->Name << " " << I->TypeChar << " " << SymbolAddrStr
618 << SymbolSizeStr << "\n";
619 } else if (OutputFormat == bsd || (OutputFormat == darwin && !MachO)) {
621 outs() << SymbolAddrStr << ' ';
623 outs() << SymbolSizeStr;
624 if (I->Size != UnknownAddressOrSize)
627 outs() << I->TypeChar;
628 if (I->TypeChar == '-' && MachO)
629 darwinPrintStab(MachO, I);
630 outs() << " " << I->Name << "\n";
631 } else if (OutputFormat == sysv) {
632 std::string PaddedName(I->Name);
633 while (PaddedName.length() < 20)
635 outs() << PaddedName << "|" << SymbolAddrStr << "| " << I->TypeChar
636 << " | |" << SymbolSizeStr << "| |\n";
643 template <class ELFT>
644 static char getSymbolNMTypeChar(ELFObjectFile<ELFT> &Obj,
645 basic_symbol_iterator I) {
646 typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
647 typedef typename ELFObjectFile<ELFT>::Elf_Shdr Elf_Shdr;
650 symbol_iterator SymI(I);
652 DataRefImpl Symb = I->getRawDataRefImpl();
653 const Elf_Sym *ESym = Obj.getSymbol(Symb);
654 const ELFFile<ELFT> &EF = *Obj.getELFFile();
655 const Elf_Shdr *ESec = EF.getSection(ESym);
658 switch (ESec->sh_type) {
659 case ELF::SHT_PROGBITS:
660 case ELF::SHT_DYNAMIC:
661 switch (ESec->sh_flags) {
662 case (ELF::SHF_ALLOC | ELF::SHF_EXECINSTR):
664 case (ELF::SHF_TLS | ELF::SHF_ALLOC | ELF::SHF_WRITE):
665 case (ELF::SHF_ALLOC | ELF::SHF_WRITE):
668 case (ELF::SHF_ALLOC | ELF::SHF_MERGE):
669 case (ELF::SHF_ALLOC | ELF::SHF_MERGE | ELF::SHF_STRINGS):
673 case ELF::SHT_NOBITS:
678 if (ESym->getType() == ELF::STT_SECTION) {
680 if (error(SymI->getName(Name)))
682 return StringSwitch<char>(Name)
683 .StartsWith(".debug", 'N')
684 .StartsWith(".note", 'n')
691 static char getSymbolNMTypeChar(COFFObjectFile &Obj, symbol_iterator I) {
692 COFFSymbolRef Symb = Obj.getCOFFSymbol(*I);
694 symbol_iterator SymI(I);
697 if (error(SymI->getName(Name)))
700 char Ret = StringSwitch<char>(Name)
701 .StartsWith(".debug", 'N')
702 .StartsWith(".sxdata", 'N')
708 uint32_t Characteristics = 0;
709 if (!COFF::isReservedSectionNumber(Symb.getSectionNumber())) {
710 section_iterator SecI = Obj.section_end();
711 if (error(SymI->getSection(SecI)))
713 const coff_section *Section = Obj.getCOFFSection(*SecI);
714 Characteristics = Section->Characteristics;
717 switch (Symb.getSectionNumber()) {
718 case COFF::IMAGE_SYM_DEBUG:
721 // Check section type.
722 if (Characteristics & COFF::IMAGE_SCN_CNT_CODE)
724 if (Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
725 return Characteristics & COFF::IMAGE_SCN_MEM_WRITE ? 'd' : 'r';
726 if (Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)
728 if (Characteristics & COFF::IMAGE_SCN_LNK_INFO)
730 // Check for section symbol.
731 if (Symb.isSectionDefinition())
738 static uint8_t getNType(MachOObjectFile &Obj, DataRefImpl Symb) {
740 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
743 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
747 static char getSymbolNMTypeChar(MachOObjectFile &Obj, basic_symbol_iterator I) {
748 DataRefImpl Symb = I->getRawDataRefImpl();
749 uint8_t NType = getNType(Obj, Symb);
751 if (NType & MachO::N_STAB)
754 switch (NType & MachO::N_TYPE) {
759 case MachO::N_SECT: {
760 section_iterator Sec = Obj.section_end();
761 Obj.getSymbolSection(Symb, Sec);
762 DataRefImpl Ref = Sec->getRawDataRefImpl();
763 StringRef SectionName;
764 Obj.getSectionName(Ref, SectionName);
765 StringRef SegmentName = Obj.getSectionFinalSegmentName(Ref);
766 if (SegmentName == "__TEXT" && SectionName == "__text")
768 else if (SegmentName == "__DATA" && SectionName == "__data")
770 else if (SegmentName == "__DATA" && SectionName == "__bss")
780 static char getSymbolNMTypeChar(const GlobalValue &GV) {
781 if (GV.getType()->getElementType()->isFunctionTy())
783 // FIXME: should we print 'b'? At the IR level we cannot be sure if this
784 // will be in bss or not, but we could approximate.
788 static char getSymbolNMTypeChar(IRObjectFile &Obj, basic_symbol_iterator I) {
789 const GlobalValue *GV = Obj.getSymbolGV(I->getRawDataRefImpl());
792 return getSymbolNMTypeChar(*GV);
795 template <class ELFT>
796 static bool isELFObject(ELFObjectFile<ELFT> &Obj, symbol_iterator I) {
797 typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
799 DataRefImpl Symb = I->getRawDataRefImpl();
800 const Elf_Sym *ESym = Obj.getSymbol(Symb);
802 return ESym->getType() == ELF::STT_OBJECT;
805 static bool isObject(SymbolicFile &Obj, basic_symbol_iterator I) {
806 if (ELF32LEObjectFile *ELF = dyn_cast<ELF32LEObjectFile>(&Obj))
807 return isELFObject(*ELF, I);
808 if (ELF64LEObjectFile *ELF = dyn_cast<ELF64LEObjectFile>(&Obj))
809 return isELFObject(*ELF, I);
810 if (ELF32BEObjectFile *ELF = dyn_cast<ELF32BEObjectFile>(&Obj))
811 return isELFObject(*ELF, I);
812 if (ELF64BEObjectFile *ELF = dyn_cast<ELF64BEObjectFile>(&Obj))
813 return isELFObject(*ELF, I);
817 static char getNMTypeChar(SymbolicFile &Obj, basic_symbol_iterator I) {
818 uint32_t Symflags = I->getFlags();
819 if ((Symflags & object::SymbolRef::SF_Weak) && !isa<MachOObjectFile>(Obj)) {
820 char Ret = isObject(Obj, I) ? 'v' : 'w';
821 if (!(Symflags & object::SymbolRef::SF_Undefined))
826 if (Symflags & object::SymbolRef::SF_Undefined)
829 if (Symflags & object::SymbolRef::SF_Common)
833 if (Symflags & object::SymbolRef::SF_Absolute)
835 else if (IRObjectFile *IR = dyn_cast<IRObjectFile>(&Obj))
836 Ret = getSymbolNMTypeChar(*IR, I);
837 else if (COFFObjectFile *COFF = dyn_cast<COFFObjectFile>(&Obj))
838 Ret = getSymbolNMTypeChar(*COFF, I);
839 else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj))
840 Ret = getSymbolNMTypeChar(*MachO, I);
841 else if (ELF32LEObjectFile *ELF = dyn_cast<ELF32LEObjectFile>(&Obj))
842 Ret = getSymbolNMTypeChar(*ELF, I);
843 else if (ELF64LEObjectFile *ELF = dyn_cast<ELF64LEObjectFile>(&Obj))
844 Ret = getSymbolNMTypeChar(*ELF, I);
845 else if (ELF32BEObjectFile *ELF = dyn_cast<ELF32BEObjectFile>(&Obj))
846 Ret = getSymbolNMTypeChar(*ELF, I);
848 Ret = getSymbolNMTypeChar(cast<ELF64BEObjectFile>(Obj), I);
850 if (Symflags & object::SymbolRef::SF_Global)
856 // getNsectForSegSect() is used to implement the Mach-O "-s segname sectname"
857 // option to dump only those symbols from that section in a Mach-O file.
858 // It is called once for each Mach-O file from dumpSymbolNamesFromObject()
859 // to get the section number for that named section from the command line
860 // arguments. It returns the section number for that section in the Mach-O
861 // file or zero it is not present.
862 static unsigned getNsectForSegSect(MachOObjectFile *Obj) {
864 for (section_iterator I = Obj->section_begin(), E = Obj->section_end();
866 DataRefImpl Ref = I->getRawDataRefImpl();
867 StringRef SectionName;
868 Obj->getSectionName(Ref, SectionName);
869 StringRef SegmentName = Obj->getSectionFinalSegmentName(Ref);
870 if (SegmentName == SegSect[0] && SectionName == SegSect[1])
877 // getNsectInMachO() is used to implement the Mach-O "-s segname sectname"
878 // option to dump only those symbols from that section in a Mach-O file.
879 // It is called once for each symbol in a Mach-O file from
880 // dumpSymbolNamesFromObject() and returns the section number for that symbol
881 // if it is in a section, else it returns 0.
882 static unsigned getNsectInMachO(MachOObjectFile &Obj, basic_symbol_iterator I) {
883 DataRefImpl Symb = I->getRawDataRefImpl();
885 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
886 if ((STE.n_type & MachO::N_TYPE) == MachO::N_SECT)
890 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
891 if ((STE.n_type & MachO::N_TYPE) == MachO::N_SECT)
896 static void dumpSymbolNamesFromObject(SymbolicFile &Obj, bool printName,
897 std::string ArchiveName = std::string(),
898 std::string ArchitectureName =
900 basic_symbol_iterator IBegin = Obj.symbol_begin();
901 basic_symbol_iterator IEnd = Obj.symbol_end();
904 error("File format has no dynamic symbol table", Obj.getFileName());
907 std::pair<symbol_iterator, symbol_iterator> IDyn =
908 getELFDynamicSymbolIterators(&Obj);
912 std::string NameBuffer;
913 raw_string_ostream OS(NameBuffer);
914 // If a "-s segname sectname" option was specified and this is a Mach-O
915 // file get the section number for that section in this object file.
916 unsigned int Nsect = 0;
917 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
918 if (SegSect.size() != 0 && MachO) {
919 Nsect = getNsectForSegSect(MachO);
920 // If this section is not in the object file no symbols are printed.
924 for (basic_symbol_iterator I = IBegin; I != IEnd; ++I) {
925 uint32_t SymFlags = I->getFlags();
926 if (!DebugSyms && (SymFlags & SymbolRef::SF_FormatSpecific))
928 if (WithoutAliases) {
929 if (IRObjectFile *IR = dyn_cast<IRObjectFile>(&Obj)) {
930 const GlobalValue *GV = IR->getSymbolGV(I->getRawDataRefImpl());
931 if (GV && isa<GlobalAlias>(GV))
935 // If a "-s segname sectname" option was specified and this is a Mach-O
936 // file and this section appears in this file, Nsect will be non-zero then
937 // see if this symbol is a symbol from that section and if not skip it.
938 if (Nsect && Nsect != getNsectInMachO(*MachO, I))
941 S.Size = UnknownAddressOrSize;
942 S.Address = UnknownAddressOrSize;
943 if ((PrintSize || SizeSort) && isa<ObjectFile>(Obj)) {
944 symbol_iterator SymI = I;
945 if (error(SymI->getSize(S.Size)))
948 if (PrintAddress && isa<ObjectFile>(Obj))
949 if (error(symbol_iterator(I)->getAddress(S.Address)))
951 S.TypeChar = getNMTypeChar(Obj, I);
952 if (error(I->printName(OS)))
955 S.Symb = I->getRawDataRefImpl();
956 SymbolList.push_back(S);
960 const char *P = NameBuffer.c_str();
961 for (unsigned I = 0; I < SymbolList.size(); ++I) {
962 SymbolList[I].Name = P;
966 CurrentFilename = Obj.getFileName();
967 sortAndPrintSymbolList(Obj, printName, ArchiveName, ArchitectureName);
970 // checkMachOAndArchFlags() checks to see if the SymbolicFile is a Mach-O file
971 // and if it is and there is a list of architecture flags is specified then
972 // check to make sure this Mach-O file is one of those architectures or all
973 // architectures was specificed. If not then an error is generated and this
974 // routine returns false. Else it returns true.
975 static bool checkMachOAndArchFlags(SymbolicFile *O, std::string &Filename) {
976 if (isa<MachOObjectFile>(O) && !ArchAll && ArchFlags.size() != 0) {
977 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(O);
978 bool ArchFound = false;
979 MachO::mach_header H;
980 MachO::mach_header_64 H_64;
982 if (MachO->is64Bit()) {
983 H_64 = MachO->MachOObjectFile::getHeader64();
984 T = MachOObjectFile::getArch(H_64.cputype, H_64.cpusubtype);
986 H = MachO->MachOObjectFile::getHeader();
987 T = MachOObjectFile::getArch(H.cputype, H.cpusubtype);
990 for (i = 0; i < ArchFlags.size(); ++i) {
991 if (ArchFlags[i] == T.getArchName())
997 "file: " + Filename + " does not contain architecture");
1004 static void dumpSymbolNamesFromFile(std::string &Filename) {
1005 ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
1006 MemoryBuffer::getFileOrSTDIN(Filename);
1007 if (error(BufferOrErr.getError(), Filename))
1010 LLVMContext &Context = getGlobalContext();
1011 ErrorOr<std::unique_ptr<Binary>> BinaryOrErr = createBinary(
1012 BufferOrErr.get()->getMemBufferRef(), NoLLVMBitcode ? nullptr : &Context);
1013 if (error(BinaryOrErr.getError(), Filename))
1015 Binary &Bin = *BinaryOrErr.get();
1017 if (Archive *A = dyn_cast<Archive>(&Bin)) {
1019 Archive::symbol_iterator I = A->symbol_begin();
1020 Archive::symbol_iterator E = A->symbol_end();
1022 outs() << "Archive map\n";
1023 for (; I != E; ++I) {
1024 ErrorOr<Archive::child_iterator> C = I->getMember();
1025 if (error(C.getError()))
1027 ErrorOr<StringRef> FileNameOrErr = C.get()->getName();
1028 if (error(FileNameOrErr.getError()))
1030 StringRef SymName = I->getName();
1031 outs() << SymName << " in " << FileNameOrErr.get() << "\n";
1037 for (Archive::child_iterator I = A->child_begin(), E = A->child_end();
1039 ErrorOr<std::unique_ptr<Binary>> ChildOrErr = I->getAsBinary(&Context);
1040 if (ChildOrErr.getError())
1042 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1043 if (!checkMachOAndArchFlags(O, Filename))
1045 if (!PrintFileName) {
1047 if (isa<MachOObjectFile>(O)) {
1048 outs() << Filename << "(" << O->getFileName() << ")";
1050 outs() << O->getFileName();
1053 dumpSymbolNamesFromObject(*O, false, Filename);
1058 if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(&Bin)) {
1059 // If we have a list of architecture flags specified dump only those.
1060 if (!ArchAll && ArchFlags.size() != 0) {
1061 // Look for a slice in the universal binary that matches each ArchFlag.
1063 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
1065 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1066 E = UB->end_objects();
1068 if (ArchFlags[i] == I->getArchTypeName()) {
1070 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr =
1071 I->getAsObjectFile();
1072 std::unique_ptr<Archive> A;
1073 std::string ArchiveName;
1074 std::string ArchitectureName;
1075 ArchiveName.clear();
1076 ArchitectureName.clear();
1078 ObjectFile &Obj = *ObjOrErr.get();
1079 if (ArchFlags.size() > 1) {
1081 ArchitectureName = I->getArchTypeName();
1083 outs() << "\n" << Obj.getFileName() << " (for architecture "
1084 << I->getArchTypeName() << ")"
1087 dumpSymbolNamesFromObject(Obj, false, ArchiveName,
1089 } else if (!I->getAsArchive(A)) {
1090 for (Archive::child_iterator AI = A->child_begin(),
1091 AE = A->child_end();
1093 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
1094 AI->getAsBinary(&Context);
1095 if (ChildOrErr.getError())
1097 if (SymbolicFile *O =
1098 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1099 if (PrintFileName) {
1100 ArchiveName = A->getFileName();
1101 if (ArchFlags.size() > 1)
1102 ArchitectureName = I->getArchTypeName();
1104 outs() << "\n" << A->getFileName();
1105 outs() << "(" << O->getFileName() << ")";
1106 if (ArchFlags.size() > 1) {
1107 outs() << " (for architecture " << I->getArchTypeName()
1112 dumpSymbolNamesFromObject(*O, false, ArchiveName,
1121 "file: " + Filename + " does not contain architecture");
1127 // No architecture flags were specified so if this contains a slice that
1128 // matches the host architecture dump only that.
1130 StringRef HostArchName = MachOObjectFile::getHostArch().getArchName();
1131 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1132 E = UB->end_objects();
1134 if (HostArchName == I->getArchTypeName()) {
1135 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
1136 std::unique_ptr<Archive> A;
1137 std::string ArchiveName;
1138 ArchiveName.clear();
1140 ObjectFile &Obj = *ObjOrErr.get();
1141 dumpSymbolNamesFromObject(Obj, false);
1142 } else if (!I->getAsArchive(A)) {
1143 for (Archive::child_iterator AI = A->child_begin(),
1144 AE = A->child_end();
1146 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
1147 AI->getAsBinary(&Context);
1148 if (ChildOrErr.getError())
1150 if (SymbolicFile *O =
1151 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1153 ArchiveName = A->getFileName();
1155 outs() << "\n" << A->getFileName() << "(" << O->getFileName()
1158 dumpSymbolNamesFromObject(*O, false, ArchiveName);
1166 // Either all architectures have been specified or none have been specified
1167 // and this does not contain the host architecture so dump all the slices.
1168 bool moreThanOneArch = UB->getNumberOfObjects() > 1;
1169 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1170 E = UB->end_objects();
1172 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
1173 std::unique_ptr<Archive> A;
1174 std::string ArchiveName;
1175 std::string ArchitectureName;
1176 ArchiveName.clear();
1177 ArchitectureName.clear();
1179 ObjectFile &Obj = *ObjOrErr.get();
1180 if (PrintFileName) {
1181 if (isa<MachOObjectFile>(Obj) && moreThanOneArch)
1182 ArchitectureName = I->getArchTypeName();
1184 if (moreThanOneArch)
1186 outs() << Obj.getFileName();
1187 if (isa<MachOObjectFile>(Obj) && moreThanOneArch)
1188 outs() << " (for architecture " << I->getArchTypeName() << ")";
1191 dumpSymbolNamesFromObject(Obj, false, ArchiveName, ArchitectureName);
1192 } else if (!I->getAsArchive(A)) {
1193 for (Archive::child_iterator AI = A->child_begin(), AE = A->child_end();
1195 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
1196 AI->getAsBinary(&Context);
1197 if (ChildOrErr.getError())
1199 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1200 if (PrintFileName) {
1201 ArchiveName = A->getFileName();
1202 if (isa<MachOObjectFile>(O) && moreThanOneArch)
1203 ArchitectureName = I->getArchTypeName();
1205 outs() << "\n" << A->getFileName();
1206 if (isa<MachOObjectFile>(O)) {
1207 outs() << "(" << O->getFileName() << ")";
1208 if (moreThanOneArch)
1209 outs() << " (for architecture " << I->getArchTypeName()
1212 outs() << ":" << O->getFileName();
1215 dumpSymbolNamesFromObject(*O, false, ArchiveName, ArchitectureName);
1222 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&Bin)) {
1223 if (!checkMachOAndArchFlags(O, Filename))
1225 dumpSymbolNamesFromObject(*O, true);
1228 error("unrecognizable file type", Filename);
1232 int main(int argc, char **argv) {
1233 // Print a stack trace if we signal out.
1234 sys::PrintStackTraceOnErrorSignal();
1235 PrettyStackTraceProgram X(argc, argv);
1237 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
1238 cl::ParseCommandLineOptions(argc, argv, "llvm symbol table dumper\n");
1240 // llvm-nm only reads binary files.
1241 if (error(sys::ChangeStdinToBinary()))
1244 llvm::InitializeAllTargetInfos();
1245 llvm::InitializeAllTargetMCs();
1246 llvm::InitializeAllAsmParsers();
1252 OutputFormat = posix;
1254 OutputFormat = darwin;
1256 // The relative order of these is important. If you pass --size-sort it should
1257 // only print out the size. However, if you pass -S --size-sort, it should
1258 // print out both the size and address.
1259 if (SizeSort && !PrintSize)
1260 PrintAddress = false;
1261 if (OutputFormat == sysv || SizeSort)
1264 switch (InputFilenames.size()) {
1266 InputFilenames.push_back("a.out");
1270 MultipleFiles = true;
1273 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
1274 if (ArchFlags[i] == "all") {
1277 if (!MachOObjectFile::isValidArch(ArchFlags[i]))
1278 error("Unknown architecture named '" + ArchFlags[i] + "'",
1279 "for the -arch option");
1283 if (SegSect.size() != 0 && SegSect.size() != 2)
1284 error("bad number of arguments (must be two arguments)",
1285 "for the -s option");
1287 std::for_each(InputFilenames.begin(), InputFilenames.end(),
1288 dumpSymbolNamesFromFile);