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 bool PrintAddress = true;
154 bool MultipleFiles = false;
156 bool HadError = false;
158 std::string ToolName;
161 static void error(Twine Message, Twine Path = Twine()) {
163 errs() << ToolName << ": " << Path << ": " << Message << ".\n";
166 static bool error(std::error_code EC, Twine Path = Twine()) {
168 error(EC.message(), Path);
184 static bool compareSymbolAddress(const NMSymbol &A, const NMSymbol &B) {
186 if (A.Address < B.Address)
188 else if (A.Address == B.Address && A.Name < B.Name)
190 else if (A.Address == B.Address && A.Name == B.Name && A.Size < B.Size)
195 if (A.Address > B.Address)
197 else if (A.Address == B.Address && A.Name > B.Name)
199 else if (A.Address == B.Address && A.Name == B.Name && A.Size > B.Size)
206 static bool compareSymbolSize(const NMSymbol &A, const NMSymbol &B) {
210 else if (A.Size == B.Size && A.Name < B.Name)
212 else if (A.Size == B.Size && A.Name == B.Name && A.Address < B.Address)
219 else if (A.Size == B.Size && A.Name > B.Name)
221 else if (A.Size == B.Size && A.Name == B.Name && A.Address > B.Address)
228 static bool compareSymbolName(const NMSymbol &A, const NMSymbol &B) {
232 else if (A.Name == B.Name && A.Size < B.Size)
234 else if (A.Name == B.Name && A.Size == B.Size && A.Address < B.Address)
241 else if (A.Name == B.Name && A.Size > B.Size)
243 else if (A.Name == B.Name && A.Size == B.Size && A.Address > B.Address)
250 static char isSymbolList64Bit(SymbolicFile &Obj) {
251 if (isa<IRObjectFile>(Obj))
253 else if (isa<COFFObjectFile>(Obj))
255 else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj))
256 return MachO->is64Bit();
257 else if (isa<ELF32LEObjectFile>(Obj))
259 else if (isa<ELF64LEObjectFile>(Obj))
261 else if (isa<ELF32BEObjectFile>(Obj))
263 else if (isa<ELF64BEObjectFile>(Obj))
269 static StringRef CurrentFilename;
270 typedef std::vector<NMSymbol> SymbolListT;
271 static SymbolListT SymbolList;
273 // darwinPrintSymbol() is used to print a symbol from a Mach-O file when the
274 // the OutputFormat is darwin or we are printing Mach-O symbols in hex. For
275 // the darwin format it produces the same output as darwin's nm(1) -m output
276 // and when printing Mach-O symbols in hex it produces the same output as
277 // darwin's nm(1) -x format.
278 static void darwinPrintSymbol(MachOObjectFile *MachO, SymbolListT::iterator I,
279 char *SymbolAddrStr, const char *printBlanks) {
280 MachO::mach_header H;
281 MachO::mach_header_64 H_64;
282 uint32_t Filetype, Flags;
283 MachO::nlist_64 STE_64;
290 if (MachO->is64Bit()) {
291 H_64 = MachO->MachOObjectFile::getHeader64();
292 Filetype = H_64.filetype;
294 STE_64 = MachO->getSymbol64TableEntry(I->Symb);
295 NType = STE_64.n_type;
296 NSect = STE_64.n_sect;
297 NDesc = STE_64.n_desc;
298 NStrx = STE_64.n_strx;
299 NValue = STE_64.n_value;
301 H = MachO->MachOObjectFile::getHeader();
302 Filetype = H.filetype;
304 STE = MachO->getSymbolTableEntry(I->Symb);
309 NValue = STE.n_value;
312 // If we are printing Mach-O symbols in hex do that and return.
313 if (FormatMachOasHex) {
315 const char *printFormat;
316 if (MachO->is64Bit())
317 printFormat = "%016" PRIx64;
319 printFormat = "%08" PRIx64;
320 format(printFormat, NValue).print(Str, sizeof(Str));
321 outs() << Str << ' ';
322 format("%02x", NType).print(Str, sizeof(Str));
323 outs() << Str << ' ';
324 format("%02x", NSect).print(Str, sizeof(Str));
325 outs() << Str << ' ';
326 format("%04x", NDesc).print(Str, sizeof(Str));
327 outs() << Str << ' ';
328 format("%08x", NStrx).print(Str, sizeof(Str));
329 outs() << Str << ' ';
330 outs() << I->Name << "\n";
335 if ((NType & MachO::N_TYPE) == MachO::N_INDR)
336 strcpy(SymbolAddrStr, printBlanks);
337 outs() << SymbolAddrStr << ' ';
340 switch (NType & MachO::N_TYPE) {
343 outs() << "(common) ";
344 if (MachO::GET_COMM_ALIGN(NDesc) != 0)
345 outs() << "(alignment 2^" << (int)MachO::GET_COMM_ALIGN(NDesc) << ") ";
347 if ((NType & MachO::N_TYPE) == MachO::N_PBUD)
348 outs() << "(prebound ";
351 if ((NDesc & MachO::REFERENCE_TYPE) ==
352 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
353 outs() << "undefined [lazy bound]) ";
354 else if ((NDesc & MachO::REFERENCE_TYPE) ==
355 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
356 outs() << "undefined [private lazy bound]) ";
357 else if ((NDesc & MachO::REFERENCE_TYPE) ==
358 MachO::REFERENCE_FLAG_PRIVATE_UNDEFINED_NON_LAZY)
359 outs() << "undefined [private]) ";
361 outs() << "undefined) ";
365 outs() << "(absolute) ";
368 outs() << "(indirect) ";
370 case MachO::N_SECT: {
371 section_iterator Sec = MachO->section_end();
372 MachO->getSymbolSection(I->Symb, Sec);
373 DataRefImpl Ref = Sec->getRawDataRefImpl();
374 StringRef SectionName;
375 MachO->getSectionName(Ref, SectionName);
376 StringRef SegmentName = MachO->getSectionFinalSegmentName(Ref);
377 outs() << "(" << SegmentName << "," << SectionName << ") ";
385 if (NType & MachO::N_EXT) {
386 if (NDesc & MachO::REFERENCED_DYNAMICALLY)
387 outs() << "[referenced dynamically] ";
388 if (NType & MachO::N_PEXT) {
389 if ((NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF)
390 outs() << "weak private external ";
392 outs() << "private external ";
394 if ((NDesc & MachO::N_WEAK_REF) == MachO::N_WEAK_REF ||
395 (NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF) {
396 if ((NDesc & (MachO::N_WEAK_REF | MachO::N_WEAK_DEF)) ==
397 (MachO::N_WEAK_REF | MachO::N_WEAK_DEF))
398 outs() << "weak external automatically hidden ";
400 outs() << "weak external ";
402 outs() << "external ";
405 if (NType & MachO::N_PEXT)
406 outs() << "non-external (was a private external) ";
408 outs() << "non-external ";
411 if (Filetype == MachO::MH_OBJECT &&
412 (NDesc & MachO::N_NO_DEAD_STRIP) == MachO::N_NO_DEAD_STRIP)
413 outs() << "[no dead strip] ";
415 if (Filetype == MachO::MH_OBJECT &&
416 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
417 (NDesc & MachO::N_SYMBOL_RESOLVER) == MachO::N_SYMBOL_RESOLVER)
418 outs() << "[symbol resolver] ";
420 if (Filetype == MachO::MH_OBJECT &&
421 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
422 (NDesc & MachO::N_ALT_ENTRY) == MachO::N_ALT_ENTRY)
423 outs() << "[alt entry] ";
425 if ((NDesc & MachO::N_ARM_THUMB_DEF) == MachO::N_ARM_THUMB_DEF)
426 outs() << "[Thumb] ";
428 if ((NType & MachO::N_TYPE) == MachO::N_INDR) {
429 outs() << I->Name << " (for ";
430 StringRef IndirectName;
431 if (MachO->getIndirectName(I->Symb, IndirectName))
434 outs() << IndirectName << ")";
438 if ((Flags & MachO::MH_TWOLEVEL) == MachO::MH_TWOLEVEL &&
439 (((NType & MachO::N_TYPE) == MachO::N_UNDF && NValue == 0) ||
440 (NType & MachO::N_TYPE) == MachO::N_PBUD)) {
441 uint32_t LibraryOrdinal = MachO::GET_LIBRARY_ORDINAL(NDesc);
442 if (LibraryOrdinal != 0) {
443 if (LibraryOrdinal == MachO::EXECUTABLE_ORDINAL)
444 outs() << " (from executable)";
445 else if (LibraryOrdinal == MachO::DYNAMIC_LOOKUP_ORDINAL)
446 outs() << " (dynamically looked up)";
448 StringRef LibraryName;
449 if (MachO->getLibraryShortNameByIndex(LibraryOrdinal - 1, LibraryName))
450 outs() << " (from bad library ordinal " << LibraryOrdinal << ")";
452 outs() << " (from " << LibraryName << ")";
460 // Table that maps Darwin's Mach-O stab constants to strings to allow printing.
461 struct DarwinStabName {
465 static const struct DarwinStabName DarwinStabNames[] = {
466 {MachO::N_GSYM, "GSYM"},
467 {MachO::N_FNAME, "FNAME"},
468 {MachO::N_FUN, "FUN"},
469 {MachO::N_STSYM, "STSYM"},
470 {MachO::N_LCSYM, "LCSYM"},
471 {MachO::N_BNSYM, "BNSYM"},
473 {MachO::N_AST, "AST"},
474 {MachO::N_OPT, "OPT"},
475 {MachO::N_RSYM, "RSYM"},
476 {MachO::N_SLINE, "SLINE"},
477 {MachO::N_ENSYM, "ENSYM"},
478 {MachO::N_SSYM, "SSYM"},
480 {MachO::N_OSO, "OSO"},
481 {MachO::N_LSYM, "LSYM"},
482 {MachO::N_BINCL, "BINCL"},
483 {MachO::N_SOL, "SOL"},
484 {MachO::N_PARAMS, "PARAM"},
485 {MachO::N_VERSION, "VERS"},
486 {MachO::N_OLEVEL, "OLEV"},
487 {MachO::N_PSYM, "PSYM"},
488 {MachO::N_EINCL, "EINCL"},
489 {MachO::N_ENTRY, "ENTRY"},
490 {MachO::N_LBRAC, "LBRAC"},
491 {MachO::N_EXCL, "EXCL"},
492 {MachO::N_RBRAC, "RBRAC"},
493 {MachO::N_BCOMM, "BCOMM"},
494 {MachO::N_ECOMM, "ECOMM"},
495 {MachO::N_ECOML, "ECOML"},
496 {MachO::N_LENG, "LENG"},
498 static const char *getDarwinStabString(uint8_t NType) {
499 for (unsigned i = 0; DarwinStabNames[i].Name; i++) {
500 if (DarwinStabNames[i].NType == NType)
501 return DarwinStabNames[i].Name;
506 // darwinPrintStab() prints the n_sect, n_desc along with a symbolic name of
507 // a stab n_type value in a Mach-O file.
508 static void darwinPrintStab(MachOObjectFile *MachO, SymbolListT::iterator I) {
509 MachO::nlist_64 STE_64;
514 if (MachO->is64Bit()) {
515 STE_64 = MachO->getSymbol64TableEntry(I->Symb);
516 NType = STE_64.n_type;
517 NSect = STE_64.n_sect;
518 NDesc = STE_64.n_desc;
520 STE = MachO->getSymbolTableEntry(I->Symb);
527 format("%02x", NSect).print(Str, sizeof(Str));
528 outs() << ' ' << Str << ' ';
529 format("%04x", NDesc).print(Str, sizeof(Str));
530 outs() << Str << ' ';
531 if (const char *stabString = getDarwinStabString(NType))
532 format("%5.5s", stabString).print(Str, sizeof(Str));
534 format(" %02x", NType).print(Str, sizeof(Str));
538 static void sortAndPrintSymbolList(SymbolicFile &Obj, bool printName,
539 std::string ArchiveName,
540 std::string ArchitectureName) {
543 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolAddress);
545 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolSize);
547 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolName);
550 if (!PrintFileName) {
551 if (OutputFormat == posix && MultipleFiles && printName) {
552 outs() << '\n' << CurrentFilename << ":\n";
553 } else if (OutputFormat == bsd && MultipleFiles && printName) {
554 outs() << "\n" << CurrentFilename << ":\n";
555 } else if (OutputFormat == sysv) {
556 outs() << "\n\nSymbols from " << CurrentFilename << ":\n\n"
557 << "Name Value Class Type"
558 << " Size Line Section\n";
562 const char *printBlanks, *printFormat;
563 if (isSymbolList64Bit(Obj)) {
565 printFormat = "%016" PRIx64;
568 printFormat = "%08" PRIx64;
571 for (SymbolListT::iterator I = SymbolList.begin(), E = SymbolList.end();
573 if ((I->TypeChar != 'U') && UndefinedOnly)
575 if ((I->TypeChar == 'U') && DefinedOnly)
577 if (SizeSort && !PrintAddress && I->Size == UnknownAddressOrSize)
580 if (!ArchitectureName.empty())
581 outs() << "(for architecture " << ArchitectureName << "):";
582 if (!ArchiveName.empty())
583 outs() << ArchiveName << ":";
584 outs() << CurrentFilename << ": ";
586 if (JustSymbolName || (UndefinedOnly && isa<MachOObjectFile>(Obj))) {
587 outs() << I->Name << "\n";
591 char SymbolAddrStr[18] = "";
592 char SymbolSizeStr[18] = "";
594 if (OutputFormat == sysv || I->Address == UnknownAddressOrSize)
595 strcpy(SymbolAddrStr, printBlanks);
596 if (OutputFormat == sysv)
597 strcpy(SymbolSizeStr, printBlanks);
599 if (I->Address != UnknownAddressOrSize)
600 format(printFormat, I->Address)
601 .print(SymbolAddrStr, sizeof(SymbolAddrStr));
602 if (I->Size != UnknownAddressOrSize)
603 format(printFormat, I->Size).print(SymbolSizeStr, sizeof(SymbolSizeStr));
605 // If OutputFormat is darwin or we are printing Mach-O symbols in hex and
606 // we have a MachOObjectFile, call darwinPrintSymbol to print as darwin's
607 // nm(1) -m output or hex, else if OutputFormat is darwin or we are
608 // printing Mach-O symbols in hex and not a Mach-O object fall back to
609 // OutputFormat bsd (see below).
610 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
611 if ((OutputFormat == darwin || FormatMachOasHex) && MachO) {
612 darwinPrintSymbol(MachO, I, SymbolAddrStr, printBlanks);
613 } else if (OutputFormat == posix) {
614 outs() << I->Name << " " << I->TypeChar << " " << SymbolAddrStr
615 << SymbolSizeStr << "\n";
616 } else if (OutputFormat == bsd || (OutputFormat == darwin && !MachO)) {
618 outs() << SymbolAddrStr << ' ';
620 outs() << SymbolSizeStr;
621 if (I->Size != UnknownAddressOrSize)
624 outs() << I->TypeChar;
625 if (I->TypeChar == '-' && MachO)
626 darwinPrintStab(MachO, I);
627 outs() << " " << I->Name << "\n";
628 } else if (OutputFormat == sysv) {
629 std::string PaddedName(I->Name);
630 while (PaddedName.length() < 20)
632 outs() << PaddedName << "|" << SymbolAddrStr << "| " << I->TypeChar
633 << " | |" << SymbolSizeStr << "| |\n";
640 template <class ELFT>
641 static char getSymbolNMTypeChar(ELFObjectFile<ELFT> &Obj,
642 basic_symbol_iterator I) {
643 typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
644 typedef typename ELFObjectFile<ELFT>::Elf_Shdr Elf_Shdr;
647 symbol_iterator SymI(I);
649 DataRefImpl Symb = I->getRawDataRefImpl();
650 const Elf_Sym *ESym = Obj.getSymbol(Symb);
651 const ELFFile<ELFT> &EF = *Obj.getELFFile();
652 const Elf_Shdr *ESec = EF.getSection(ESym);
655 switch (ESec->sh_type) {
656 case ELF::SHT_PROGBITS:
657 case ELF::SHT_DYNAMIC:
658 switch (ESec->sh_flags) {
659 case (ELF::SHF_ALLOC | ELF::SHF_EXECINSTR):
661 case (ELF::SHF_TLS | ELF::SHF_ALLOC | ELF::SHF_WRITE):
662 case (ELF::SHF_ALLOC | ELF::SHF_WRITE):
665 case (ELF::SHF_ALLOC | ELF::SHF_MERGE):
666 case (ELF::SHF_ALLOC | ELF::SHF_MERGE | ELF::SHF_STRINGS):
670 case ELF::SHT_NOBITS:
675 if (ESym->getType() == ELF::STT_SECTION) {
677 if (error(SymI->getName(Name)))
679 return StringSwitch<char>(Name)
680 .StartsWith(".debug", 'N')
681 .StartsWith(".note", 'n')
688 static char getSymbolNMTypeChar(COFFObjectFile &Obj, symbol_iterator I) {
689 COFFSymbolRef Symb = Obj.getCOFFSymbol(*I);
691 symbol_iterator SymI(I);
694 if (error(SymI->getName(Name)))
697 char Ret = StringSwitch<char>(Name)
698 .StartsWith(".debug", 'N')
699 .StartsWith(".sxdata", 'N')
705 uint32_t Characteristics = 0;
706 if (!COFF::isReservedSectionNumber(Symb.getSectionNumber())) {
707 section_iterator SecI = Obj.section_end();
708 if (error(SymI->getSection(SecI)))
710 const coff_section *Section = Obj.getCOFFSection(*SecI);
711 Characteristics = Section->Characteristics;
714 switch (Symb.getSectionNumber()) {
715 case COFF::IMAGE_SYM_DEBUG:
718 // Check section type.
719 if (Characteristics & COFF::IMAGE_SCN_CNT_CODE)
721 else if (Characteristics & COFF::IMAGE_SCN_MEM_READ &&
722 ~Characteristics & COFF::IMAGE_SCN_MEM_WRITE) // Read only.
724 else if (Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
726 else if (Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)
728 else if (Characteristics & COFF::IMAGE_SCN_LNK_INFO)
731 // Check for section symbol.
732 else if (Symb.isSectionDefinition())
739 static uint8_t getNType(MachOObjectFile &Obj, DataRefImpl Symb) {
741 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
744 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
748 static char getSymbolNMTypeChar(MachOObjectFile &Obj, basic_symbol_iterator I) {
749 DataRefImpl Symb = I->getRawDataRefImpl();
750 uint8_t NType = getNType(Obj, Symb);
752 if (NType & MachO::N_STAB)
755 switch (NType & MachO::N_TYPE) {
760 case MachO::N_SECT: {
761 section_iterator Sec = Obj.section_end();
762 Obj.getSymbolSection(Symb, Sec);
763 DataRefImpl Ref = Sec->getRawDataRefImpl();
764 StringRef SectionName;
765 Obj.getSectionName(Ref, SectionName);
766 StringRef SegmentName = Obj.getSectionFinalSegmentName(Ref);
767 if (SegmentName == "__TEXT" && SectionName == "__text")
769 else if (SegmentName == "__DATA" && SectionName == "__data")
771 else if (SegmentName == "__DATA" && SectionName == "__bss")
781 static char getSymbolNMTypeChar(const GlobalValue &GV) {
782 if (GV.getType()->getElementType()->isFunctionTy())
784 // FIXME: should we print 'b'? At the IR level we cannot be sure if this
785 // will be in bss or not, but we could approximate.
789 static char getSymbolNMTypeChar(IRObjectFile &Obj, basic_symbol_iterator I) {
790 const GlobalValue *GV = Obj.getSymbolGV(I->getRawDataRefImpl());
793 return getSymbolNMTypeChar(*GV);
796 template <class ELFT>
797 static bool isELFObject(ELFObjectFile<ELFT> &Obj, symbol_iterator I) {
798 typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
800 DataRefImpl Symb = I->getRawDataRefImpl();
801 const Elf_Sym *ESym = Obj.getSymbol(Symb);
803 return ESym->getType() == ELF::STT_OBJECT;
806 static bool isObject(SymbolicFile &Obj, basic_symbol_iterator I) {
807 if (ELF32LEObjectFile *ELF = dyn_cast<ELF32LEObjectFile>(&Obj))
808 return isELFObject(*ELF, I);
809 if (ELF64LEObjectFile *ELF = dyn_cast<ELF64LEObjectFile>(&Obj))
810 return isELFObject(*ELF, I);
811 if (ELF32BEObjectFile *ELF = dyn_cast<ELF32BEObjectFile>(&Obj))
812 return isELFObject(*ELF, I);
813 if (ELF64BEObjectFile *ELF = dyn_cast<ELF64BEObjectFile>(&Obj))
814 return isELFObject(*ELF, I);
818 static char getNMTypeChar(SymbolicFile &Obj, basic_symbol_iterator I) {
819 uint32_t Symflags = I->getFlags();
820 if ((Symflags & object::SymbolRef::SF_Weak) && !isa<MachOObjectFile>(Obj)) {
821 char Ret = isObject(Obj, I) ? 'v' : 'w';
822 if (!(Symflags & object::SymbolRef::SF_Undefined))
827 if (Symflags & object::SymbolRef::SF_Undefined)
830 if (Symflags & object::SymbolRef::SF_Common)
834 if (Symflags & object::SymbolRef::SF_Absolute)
836 else if (IRObjectFile *IR = dyn_cast<IRObjectFile>(&Obj))
837 Ret = getSymbolNMTypeChar(*IR, I);
838 else if (COFFObjectFile *COFF = dyn_cast<COFFObjectFile>(&Obj))
839 Ret = getSymbolNMTypeChar(*COFF, I);
840 else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj))
841 Ret = getSymbolNMTypeChar(*MachO, I);
842 else if (ELF32LEObjectFile *ELF = dyn_cast<ELF32LEObjectFile>(&Obj))
843 Ret = getSymbolNMTypeChar(*ELF, I);
844 else if (ELF64LEObjectFile *ELF = dyn_cast<ELF64LEObjectFile>(&Obj))
845 Ret = getSymbolNMTypeChar(*ELF, I);
846 else if (ELF32BEObjectFile *ELF = dyn_cast<ELF32BEObjectFile>(&Obj))
847 Ret = getSymbolNMTypeChar(*ELF, I);
849 Ret = getSymbolNMTypeChar(cast<ELF64BEObjectFile>(Obj), I);
851 if (Symflags & object::SymbolRef::SF_Global)
857 // getNsectForSegSect() is used to implement the Mach-O "-s segname sectname"
858 // option to dump only those symbols from that section in a Mach-O file.
859 // It is called once for each Mach-O file from dumpSymbolNamesFromObject()
860 // to get the section number for that named section from the command line
861 // arguments. It returns the section number for that section in the Mach-O
862 // file or zero it is not present.
863 static unsigned getNsectForSegSect(MachOObjectFile *Obj) {
865 for (section_iterator I = Obj->section_begin(), E = Obj->section_end();
867 DataRefImpl Ref = I->getRawDataRefImpl();
868 StringRef SectionName;
869 Obj->getSectionName(Ref, SectionName);
870 StringRef SegmentName = Obj->getSectionFinalSegmentName(Ref);
871 if (SegmentName == SegSect[0] && SectionName == SegSect[1])
878 // getNsectInMachO() is used to implement the Mach-O "-s segname sectname"
879 // option to dump only those symbols from that section in a Mach-O file.
880 // It is called once for each symbol in a Mach-O file from
881 // dumpSymbolNamesFromObject() and returns the section number for that symbol
882 // if it is in a section, else it returns 0.
883 static unsigned getNsectInMachO(MachOObjectFile &Obj, basic_symbol_iterator I) {
884 DataRefImpl Symb = I->getRawDataRefImpl();
886 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
887 if ((STE.n_type & MachO::N_TYPE) == MachO::N_SECT)
891 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
892 if ((STE.n_type & MachO::N_TYPE) == MachO::N_SECT)
897 static void dumpSymbolNamesFromObject(SymbolicFile &Obj, bool printName,
898 std::string ArchiveName = std::string(),
899 std::string ArchitectureName =
901 basic_symbol_iterator IBegin = Obj.symbol_begin();
902 basic_symbol_iterator IEnd = Obj.symbol_end();
905 error("File format has no dynamic symbol table", Obj.getFileName());
908 std::pair<symbol_iterator, symbol_iterator> IDyn =
909 getELFDynamicSymbolIterators(&Obj);
913 std::string NameBuffer;
914 raw_string_ostream OS(NameBuffer);
915 // If a "-s segname sectname" option was specified and this is a Mach-O
916 // file get the section number for that section in this object file.
917 unsigned int Nsect = 0;
918 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
919 if (SegSect.size() != 0 && MachO) {
920 Nsect = getNsectForSegSect(MachO);
921 // If this section is not in the object file no symbols are printed.
925 for (basic_symbol_iterator I = IBegin; I != IEnd; ++I) {
926 uint32_t SymFlags = I->getFlags();
927 if (!DebugSyms && (SymFlags & SymbolRef::SF_FormatSpecific))
929 if (WithoutAliases) {
930 if (IRObjectFile *IR = dyn_cast<IRObjectFile>(&Obj)) {
931 const GlobalValue *GV = IR->getSymbolGV(I->getRawDataRefImpl());
932 if (GV && isa<GlobalAlias>(GV))
936 // If a "-s segname sectname" option was specified and this is a Mach-O
937 // file and this section appears in this file, Nsect will be non-zero then
938 // see if this symbol is a symbol from that section and if not skip it.
939 if (Nsect && Nsect != getNsectInMachO(*MachO, I))
942 S.Size = UnknownAddressOrSize;
943 S.Address = UnknownAddressOrSize;
944 if ((PrintSize || SizeSort) && isa<ObjectFile>(Obj)) {
945 symbol_iterator SymI = I;
946 if (error(SymI->getSize(S.Size)))
949 if (PrintAddress && isa<ObjectFile>(Obj))
950 if (error(symbol_iterator(I)->getAddress(S.Address)))
952 S.TypeChar = getNMTypeChar(Obj, I);
953 if (error(I->printName(OS)))
956 S.Symb = I->getRawDataRefImpl();
957 SymbolList.push_back(S);
961 const char *P = NameBuffer.c_str();
962 for (unsigned I = 0; I < SymbolList.size(); ++I) {
963 SymbolList[I].Name = P;
967 CurrentFilename = Obj.getFileName();
968 sortAndPrintSymbolList(Obj, printName, ArchiveName, ArchitectureName);
971 // checkMachOAndArchFlags() checks to see if the SymbolicFile is a Mach-O file
972 // and if it is and there is a list of architecture flags is specified then
973 // check to make sure this Mach-O file is one of those architectures or all
974 // architectures was specificed. If not then an error is generated and this
975 // routine returns false. Else it returns true.
976 static bool checkMachOAndArchFlags(SymbolicFile *O, std::string &Filename) {
977 if (isa<MachOObjectFile>(O) && !ArchAll && ArchFlags.size() != 0) {
978 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(O);
979 bool ArchFound = false;
980 MachO::mach_header H;
981 MachO::mach_header_64 H_64;
983 if (MachO->is64Bit()) {
984 H_64 = MachO->MachOObjectFile::getHeader64();
985 T = MachOObjectFile::getArch(H_64.cputype, H_64.cpusubtype);
987 H = MachO->MachOObjectFile::getHeader();
988 T = MachOObjectFile::getArch(H.cputype, H.cpusubtype);
991 for (i = 0; i < ArchFlags.size(); ++i) {
992 if (ArchFlags[i] == T.getArchName())
998 "file: " + Filename + " does not contain architecture");
1005 static void dumpSymbolNamesFromFile(std::string &Filename) {
1006 ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
1007 MemoryBuffer::getFileOrSTDIN(Filename);
1008 if (error(BufferOrErr.getError(), Filename))
1011 LLVMContext &Context = getGlobalContext();
1012 ErrorOr<std::unique_ptr<Binary>> BinaryOrErr =
1013 createBinary(BufferOrErr.get()->getMemBufferRef(), &Context);
1014 if (error(BinaryOrErr.getError(), Filename))
1016 Binary &Bin = *BinaryOrErr.get();
1018 if (Archive *A = dyn_cast<Archive>(&Bin)) {
1020 Archive::symbol_iterator I = A->symbol_begin();
1021 Archive::symbol_iterator E = A->symbol_end();
1023 outs() << "Archive map\n";
1024 for (; I != E; ++I) {
1025 ErrorOr<Archive::child_iterator> C = I->getMember();
1026 if (error(C.getError()))
1028 ErrorOr<StringRef> FileNameOrErr = C.get()->getName();
1029 if (error(FileNameOrErr.getError()))
1031 StringRef SymName = I->getName();
1032 outs() << SymName << " in " << FileNameOrErr.get() << "\n";
1038 for (Archive::child_iterator I = A->child_begin(), E = A->child_end();
1040 ErrorOr<std::unique_ptr<Binary>> ChildOrErr = I->getAsBinary(&Context);
1041 if (ChildOrErr.getError())
1043 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1044 if (!checkMachOAndArchFlags(O, Filename))
1046 if (!PrintFileName) {
1048 if (isa<MachOObjectFile>(O)) {
1049 outs() << Filename << "(" << O->getFileName() << ")";
1051 outs() << O->getFileName();
1054 dumpSymbolNamesFromObject(*O, false, Filename);
1059 if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(&Bin)) {
1060 // If we have a list of architecture flags specified dump only those.
1061 if (!ArchAll && ArchFlags.size() != 0) {
1062 // Look for a slice in the universal binary that matches each ArchFlag.
1064 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
1066 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1067 E = UB->end_objects();
1069 if (ArchFlags[i] == I->getArchTypeName()) {
1071 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr =
1072 I->getAsObjectFile();
1073 std::unique_ptr<Archive> A;
1074 std::string ArchiveName;
1075 std::string ArchitectureName;
1076 ArchiveName.clear();
1077 ArchitectureName.clear();
1079 ObjectFile &Obj = *ObjOrErr.get();
1080 if (ArchFlags.size() > 1) {
1082 ArchitectureName = I->getArchTypeName();
1084 outs() << "\n" << Obj.getFileName() << " (for architecture "
1085 << I->getArchTypeName() << ")"
1088 dumpSymbolNamesFromObject(Obj, false, ArchiveName,
1090 } else if (!I->getAsArchive(A)) {
1091 for (Archive::child_iterator AI = A->child_begin(),
1092 AE = A->child_end();
1094 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
1095 AI->getAsBinary(&Context);
1096 if (ChildOrErr.getError())
1098 if (SymbolicFile *O =
1099 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1100 if (PrintFileName) {
1101 ArchiveName = A->getFileName();
1102 if (ArchFlags.size() > 1)
1103 ArchitectureName = I->getArchTypeName();
1105 outs() << "\n" << A->getFileName();
1106 outs() << "(" << O->getFileName() << ")";
1107 if (ArchFlags.size() > 1) {
1108 outs() << " (for architecture " << I->getArchTypeName()
1113 dumpSymbolNamesFromObject(*O, false, ArchiveName,
1122 "file: " + Filename + " does not contain architecture");
1128 // No architecture flags were specified so if this contains a slice that
1129 // matches the host architecture dump only that.
1131 StringRef HostArchName = MachOObjectFile::getHostArch().getArchName();
1132 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1133 E = UB->end_objects();
1135 if (HostArchName == I->getArchTypeName()) {
1136 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
1137 std::unique_ptr<Archive> A;
1138 std::string ArchiveName;
1139 ArchiveName.clear();
1141 ObjectFile &Obj = *ObjOrErr.get();
1142 dumpSymbolNamesFromObject(Obj, false);
1143 } else if (!I->getAsArchive(A)) {
1144 for (Archive::child_iterator AI = A->child_begin(),
1145 AE = A->child_end();
1147 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
1148 AI->getAsBinary(&Context);
1149 if (ChildOrErr.getError())
1151 if (SymbolicFile *O =
1152 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1154 ArchiveName = A->getFileName();
1156 outs() << "\n" << A->getFileName() << "(" << O->getFileName()
1159 dumpSymbolNamesFromObject(*O, false, ArchiveName);
1167 // Either all architectures have been specified or none have been specified
1168 // and this does not contain the host architecture so dump all the slices.
1169 bool moreThanOneArch = UB->getNumberOfObjects() > 1;
1170 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1171 E = UB->end_objects();
1173 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
1174 std::unique_ptr<Archive> A;
1175 std::string ArchiveName;
1176 std::string ArchitectureName;
1177 ArchiveName.clear();
1178 ArchitectureName.clear();
1180 ObjectFile &Obj = *ObjOrErr.get();
1181 if (PrintFileName) {
1182 if (isa<MachOObjectFile>(Obj) && moreThanOneArch)
1183 ArchitectureName = I->getArchTypeName();
1185 if (moreThanOneArch)
1187 outs() << Obj.getFileName();
1188 if (isa<MachOObjectFile>(Obj) && moreThanOneArch)
1189 outs() << " (for architecture " << I->getArchTypeName() << ")";
1192 dumpSymbolNamesFromObject(Obj, false, ArchiveName, ArchitectureName);
1193 } else if (!I->getAsArchive(A)) {
1194 for (Archive::child_iterator AI = A->child_begin(), AE = A->child_end();
1196 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
1197 AI->getAsBinary(&Context);
1198 if (ChildOrErr.getError())
1200 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1201 if (PrintFileName) {
1202 ArchiveName = A->getFileName();
1203 if (isa<MachOObjectFile>(O) && moreThanOneArch)
1204 ArchitectureName = I->getArchTypeName();
1206 outs() << "\n" << A->getFileName();
1207 if (isa<MachOObjectFile>(O)) {
1208 outs() << "(" << O->getFileName() << ")";
1209 if (moreThanOneArch)
1210 outs() << " (for architecture " << I->getArchTypeName()
1213 outs() << ":" << O->getFileName();
1216 dumpSymbolNamesFromObject(*O, false, ArchiveName, ArchitectureName);
1223 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&Bin)) {
1224 if (!checkMachOAndArchFlags(O, Filename))
1226 dumpSymbolNamesFromObject(*O, true);
1229 error("unrecognizable file type", Filename);
1233 int main(int argc, char **argv) {
1234 // Print a stack trace if we signal out.
1235 sys::PrintStackTraceOnErrorSignal();
1236 PrettyStackTraceProgram X(argc, argv);
1238 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
1239 cl::ParseCommandLineOptions(argc, argv, "llvm symbol table dumper\n");
1241 // llvm-nm only reads binary files.
1242 if (error(sys::ChangeStdinToBinary()))
1245 llvm::InitializeAllTargetInfos();
1246 llvm::InitializeAllTargetMCs();
1247 llvm::InitializeAllAsmParsers();
1253 OutputFormat = posix;
1255 OutputFormat = darwin;
1257 // The relative order of these is important. If you pass --size-sort it should
1258 // only print out the size. However, if you pass -S --size-sort, it should
1259 // print out both the size and address.
1260 if (SizeSort && !PrintSize)
1261 PrintAddress = false;
1262 if (OutputFormat == sysv || SizeSort)
1265 switch (InputFilenames.size()) {
1267 InputFilenames.push_back("a.out");
1271 MultipleFiles = true;
1274 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
1275 if (ArchFlags[i] == "all") {
1278 if (!MachOObjectFile::isValidArch(ArchFlags[i]))
1279 error("Unknown architecture named '" + ArchFlags[i] + "'",
1280 "for the -arch option");
1284 if (SegSect.size() != 0 && SegSect.size() != 2)
1285 error("bad number of arguments (must be two arguments)",
1286 "for the -s option");
1288 std::for_each(InputFilenames.begin(), InputFilenames.end(),
1289 dumpSymbolNamesFromFile);