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));
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));
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));
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));
86 cl::opt<bool> BSDFormat("B", cl::desc("Alias for --format=bsd"));
87 cl::opt<bool> POSIXFormat("P", cl::desc("Alias for --format=posix"));
88 cl::opt<bool> DarwinFormat("m", cl::desc("Alias for --format=darwin"));
90 static cl::list<std::string>
91 ArchFlags("arch", cl::desc("architecture(s) from a Mach-O file to dump"),
95 cl::opt<bool> PrintFileName(
97 cl::desc("Precede each symbol with the object file it came from"));
99 cl::alias PrintFileNameA("A", cl::desc("Alias for --print-file-name"),
100 cl::aliasopt(PrintFileName));
101 cl::alias PrintFileNameo("o", cl::desc("Alias for --print-file-name"),
102 cl::aliasopt(PrintFileName));
104 cl::opt<bool> DebugSyms("debug-syms",
105 cl::desc("Show all symbols, even debugger only"));
106 cl::alias DebugSymsa("a", cl::desc("Alias for --debug-syms"),
107 cl::aliasopt(DebugSyms));
109 cl::opt<bool> NumericSort("numeric-sort", cl::desc("Sort symbols by address"));
110 cl::alias NumericSortn("n", cl::desc("Alias for --numeric-sort"),
111 cl::aliasopt(NumericSort));
112 cl::alias NumericSortv("v", cl::desc("Alias for --numeric-sort"),
113 cl::aliasopt(NumericSort));
115 cl::opt<bool> NoSort("no-sort", cl::desc("Show symbols in order encountered"));
116 cl::alias NoSortp("p", cl::desc("Alias for --no-sort"), cl::aliasopt(NoSort));
118 cl::opt<bool> ReverseSort("reverse-sort", cl::desc("Sort in reverse order"));
119 cl::alias ReverseSortr("r", cl::desc("Alias for --reverse-sort"),
120 cl::aliasopt(ReverseSort));
122 cl::opt<bool> PrintSize("print-size",
123 cl::desc("Show symbol size instead of address"));
124 cl::alias PrintSizeS("S", cl::desc("Alias for --print-size"),
125 cl::aliasopt(PrintSize));
127 cl::opt<bool> SizeSort("size-sort", cl::desc("Sort symbols by size"));
129 cl::opt<bool> WithoutAliases("without-aliases", cl::Hidden,
130 cl::desc("Exclude aliases from output"));
132 cl::opt<bool> ArchiveMap("print-armap", cl::desc("Print the archive map"));
133 cl::alias ArchiveMaps("M", cl::desc("Alias for --print-armap"),
134 cl::aliasopt(ArchiveMap));
136 cl::opt<bool> JustSymbolName("just-symbol-name",
137 cl::desc("Print just the symbol's name"));
138 cl::alias JustSymbolNames("j", cl::desc("Alias for --just-symbol-name"),
139 cl::aliasopt(JustSymbolName));
141 // FIXME: This option takes exactly two strings and should be allowed anywhere
142 // on the command line. Such that "llvm-nm -s __TEXT __text foo.o" would work.
143 // But that does not as the CommandLine Library does not have a way to make
144 // this work. For now the "-s __TEXT __text" has to be last on the command
146 cl::list<std::string> SegSect("s", cl::Positional, cl::ZeroOrMore,
147 cl::desc("Dump only symbols from this segment "
148 "and section name, Mach-O only"));
150 cl::opt<bool> FormatMachOasHex("x", cl::desc("Print symbol entry in hex, "
153 cl::opt<bool> NoLLVMBitcode("no-llvm-bc",
154 cl::desc("Disable LLVM bitcode reader"));
156 bool PrintAddress = true;
158 bool MultipleFiles = false;
160 bool HadError = false;
162 std::string ToolName;
163 } // anonymous namespace
165 static void error(Twine Message, Twine Path = Twine()) {
167 errs() << ToolName << ": " << Path << ": " << Message << ".\n";
170 static bool error(std::error_code EC, Twine Path = Twine()) {
172 error(EC.message(), Path);
186 } // anonymous namespace
188 static bool compareSymbolAddress(const NMSymbol &A, const NMSymbol &B) {
189 bool ADefined = !(A.Sym.getFlags() & SymbolRef::SF_Undefined);
190 bool BDefined = !(B.Sym.getFlags() & SymbolRef::SF_Undefined);
191 return std::make_tuple(ADefined, A.Address, A.Name, A.Size) <
192 std::make_tuple(BDefined, B.Address, B.Name, B.Size);
195 static bool compareSymbolSize(const NMSymbol &A, const NMSymbol &B) {
196 return std::make_tuple(A.Size, A.Name, A.Address) <
197 std::make_tuple(B.Size, B.Name, B.Address);
200 static bool compareSymbolName(const NMSymbol &A, const NMSymbol &B) {
201 return std::make_tuple(A.Name, A.Size, A.Address) <
202 std::make_tuple(B.Name, B.Size, B.Address);
205 static char isSymbolList64Bit(SymbolicFile &Obj) {
206 if (isa<IRObjectFile>(Obj))
208 if (isa<COFFObjectFile>(Obj))
210 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj))
211 return MachO->is64Bit();
212 return cast<ELFObjectFileBase>(Obj).getBytesInAddress() == 8;
215 static StringRef CurrentFilename;
216 typedef std::vector<NMSymbol> SymbolListT;
217 static SymbolListT SymbolList;
219 // darwinPrintSymbol() is used to print a symbol from a Mach-O file when the
220 // the OutputFormat is darwin or we are printing Mach-O symbols in hex. For
221 // the darwin format it produces the same output as darwin's nm(1) -m output
222 // and when printing Mach-O symbols in hex it produces the same output as
223 // darwin's nm(1) -x format.
224 static void darwinPrintSymbol(MachOObjectFile *MachO, SymbolListT::iterator I,
225 char *SymbolAddrStr, const char *printBlanks) {
226 MachO::mach_header H;
227 MachO::mach_header_64 H_64;
228 uint32_t Filetype, Flags;
229 MachO::nlist_64 STE_64;
236 DataRefImpl SymDRI = I->Sym.getRawDataRefImpl();
237 if (MachO->is64Bit()) {
238 H_64 = MachO->MachOObjectFile::getHeader64();
239 Filetype = H_64.filetype;
241 STE_64 = MachO->getSymbol64TableEntry(SymDRI);
242 NType = STE_64.n_type;
243 NSect = STE_64.n_sect;
244 NDesc = STE_64.n_desc;
245 NStrx = STE_64.n_strx;
246 NValue = STE_64.n_value;
248 H = MachO->MachOObjectFile::getHeader();
249 Filetype = H.filetype;
251 STE = MachO->getSymbolTableEntry(SymDRI);
256 NValue = STE.n_value;
259 // If we are printing Mach-O symbols in hex do that and return.
260 if (FormatMachOasHex) {
262 const char *printFormat;
263 if (MachO->is64Bit())
264 printFormat = "%016" PRIx64;
266 printFormat = "%08" PRIx64;
267 format(printFormat, NValue).print(Str, sizeof(Str));
268 outs() << Str << ' ';
269 format("%02x", NType).print(Str, sizeof(Str));
270 outs() << Str << ' ';
271 format("%02x", NSect).print(Str, sizeof(Str));
272 outs() << Str << ' ';
273 format("%04x", NDesc).print(Str, sizeof(Str));
274 outs() << Str << ' ';
275 format("%08x", NStrx).print(Str, sizeof(Str));
276 outs() << Str << ' ';
277 outs() << I->Name << "\n";
282 if ((NType & MachO::N_TYPE) == MachO::N_INDR)
283 strcpy(SymbolAddrStr, printBlanks);
284 outs() << SymbolAddrStr << ' ';
287 switch (NType & MachO::N_TYPE) {
290 outs() << "(common) ";
291 if (MachO::GET_COMM_ALIGN(NDesc) != 0)
292 outs() << "(alignment 2^" << (int)MachO::GET_COMM_ALIGN(NDesc) << ") ";
294 if ((NType & MachO::N_TYPE) == MachO::N_PBUD)
295 outs() << "(prebound ";
298 if ((NDesc & MachO::REFERENCE_TYPE) ==
299 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
300 outs() << "undefined [lazy bound]) ";
301 else if ((NDesc & MachO::REFERENCE_TYPE) ==
302 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
303 outs() << "undefined [private lazy bound]) ";
304 else if ((NDesc & MachO::REFERENCE_TYPE) ==
305 MachO::REFERENCE_FLAG_PRIVATE_UNDEFINED_NON_LAZY)
306 outs() << "undefined [private]) ";
308 outs() << "undefined) ";
312 outs() << "(absolute) ";
315 outs() << "(indirect) ";
317 case MachO::N_SECT: {
318 section_iterator Sec = *MachO->getSymbolSection(I->Sym.getRawDataRefImpl());
319 DataRefImpl Ref = Sec->getRawDataRefImpl();
320 StringRef SectionName;
321 MachO->getSectionName(Ref, SectionName);
322 StringRef SegmentName = MachO->getSectionFinalSegmentName(Ref);
323 outs() << "(" << SegmentName << "," << SectionName << ") ";
331 if (NType & MachO::N_EXT) {
332 if (NDesc & MachO::REFERENCED_DYNAMICALLY)
333 outs() << "[referenced dynamically] ";
334 if (NType & MachO::N_PEXT) {
335 if ((NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF)
336 outs() << "weak private external ";
338 outs() << "private external ";
340 if ((NDesc & MachO::N_WEAK_REF) == MachO::N_WEAK_REF ||
341 (NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF) {
342 if ((NDesc & (MachO::N_WEAK_REF | MachO::N_WEAK_DEF)) ==
343 (MachO::N_WEAK_REF | MachO::N_WEAK_DEF))
344 outs() << "weak external automatically hidden ";
346 outs() << "weak external ";
348 outs() << "external ";
351 if (NType & MachO::N_PEXT)
352 outs() << "non-external (was a private external) ";
354 outs() << "non-external ";
357 if (Filetype == MachO::MH_OBJECT &&
358 (NDesc & MachO::N_NO_DEAD_STRIP) == MachO::N_NO_DEAD_STRIP)
359 outs() << "[no dead strip] ";
361 if (Filetype == MachO::MH_OBJECT &&
362 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
363 (NDesc & MachO::N_SYMBOL_RESOLVER) == MachO::N_SYMBOL_RESOLVER)
364 outs() << "[symbol resolver] ";
366 if (Filetype == MachO::MH_OBJECT &&
367 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
368 (NDesc & MachO::N_ALT_ENTRY) == MachO::N_ALT_ENTRY)
369 outs() << "[alt entry] ";
371 if ((NDesc & MachO::N_ARM_THUMB_DEF) == MachO::N_ARM_THUMB_DEF)
372 outs() << "[Thumb] ";
374 if ((NType & MachO::N_TYPE) == MachO::N_INDR) {
375 outs() << I->Name << " (for ";
376 StringRef IndirectName;
377 if (MachO->getIndirectName(I->Sym.getRawDataRefImpl(), IndirectName))
380 outs() << IndirectName << ")";
384 if ((Flags & MachO::MH_TWOLEVEL) == MachO::MH_TWOLEVEL &&
385 (((NType & MachO::N_TYPE) == MachO::N_UNDF && NValue == 0) ||
386 (NType & MachO::N_TYPE) == MachO::N_PBUD)) {
387 uint32_t LibraryOrdinal = MachO::GET_LIBRARY_ORDINAL(NDesc);
388 if (LibraryOrdinal != 0) {
389 if (LibraryOrdinal == MachO::EXECUTABLE_ORDINAL)
390 outs() << " (from executable)";
391 else if (LibraryOrdinal == MachO::DYNAMIC_LOOKUP_ORDINAL)
392 outs() << " (dynamically looked up)";
394 StringRef LibraryName;
395 if (MachO->getLibraryShortNameByIndex(LibraryOrdinal - 1, LibraryName))
396 outs() << " (from bad library ordinal " << LibraryOrdinal << ")";
398 outs() << " (from " << LibraryName << ")";
406 // Table that maps Darwin's Mach-O stab constants to strings to allow printing.
407 struct DarwinStabName {
411 static const struct DarwinStabName DarwinStabNames[] = {
412 {MachO::N_GSYM, "GSYM"},
413 {MachO::N_FNAME, "FNAME"},
414 {MachO::N_FUN, "FUN"},
415 {MachO::N_STSYM, "STSYM"},
416 {MachO::N_LCSYM, "LCSYM"},
417 {MachO::N_BNSYM, "BNSYM"},
419 {MachO::N_AST, "AST"},
420 {MachO::N_OPT, "OPT"},
421 {MachO::N_RSYM, "RSYM"},
422 {MachO::N_SLINE, "SLINE"},
423 {MachO::N_ENSYM, "ENSYM"},
424 {MachO::N_SSYM, "SSYM"},
426 {MachO::N_OSO, "OSO"},
427 {MachO::N_LSYM, "LSYM"},
428 {MachO::N_BINCL, "BINCL"},
429 {MachO::N_SOL, "SOL"},
430 {MachO::N_PARAMS, "PARAM"},
431 {MachO::N_VERSION, "VERS"},
432 {MachO::N_OLEVEL, "OLEV"},
433 {MachO::N_PSYM, "PSYM"},
434 {MachO::N_EINCL, "EINCL"},
435 {MachO::N_ENTRY, "ENTRY"},
436 {MachO::N_LBRAC, "LBRAC"},
437 {MachO::N_EXCL, "EXCL"},
438 {MachO::N_RBRAC, "RBRAC"},
439 {MachO::N_BCOMM, "BCOMM"},
440 {MachO::N_ECOMM, "ECOMM"},
441 {MachO::N_ECOML, "ECOML"},
442 {MachO::N_LENG, "LENG"},
445 static const char *getDarwinStabString(uint8_t NType) {
446 for (unsigned i = 0; DarwinStabNames[i].Name; i++) {
447 if (DarwinStabNames[i].NType == NType)
448 return DarwinStabNames[i].Name;
453 // darwinPrintStab() prints the n_sect, n_desc along with a symbolic name of
454 // a stab n_type value in a Mach-O file.
455 static void darwinPrintStab(MachOObjectFile *MachO, SymbolListT::iterator I) {
456 MachO::nlist_64 STE_64;
461 DataRefImpl SymDRI = I->Sym.getRawDataRefImpl();
462 if (MachO->is64Bit()) {
463 STE_64 = MachO->getSymbol64TableEntry(SymDRI);
464 NType = STE_64.n_type;
465 NSect = STE_64.n_sect;
466 NDesc = STE_64.n_desc;
468 STE = MachO->getSymbolTableEntry(SymDRI);
475 format("%02x", NSect).print(Str, sizeof(Str));
476 outs() << ' ' << Str << ' ';
477 format("%04x", NDesc).print(Str, sizeof(Str));
478 outs() << Str << ' ';
479 if (const char *stabString = getDarwinStabString(NType))
480 format("%5.5s", stabString).print(Str, sizeof(Str));
482 format(" %02x", NType).print(Str, sizeof(Str));
486 static void sortAndPrintSymbolList(SymbolicFile &Obj, bool printName,
487 std::string ArchiveName,
488 std::string ArchitectureName) {
490 std::function<bool(const NMSymbol &, const NMSymbol &)> Cmp;
492 Cmp = compareSymbolAddress;
494 Cmp = compareSymbolSize;
496 Cmp = compareSymbolName;
499 Cmp = [=](const NMSymbol &A, const NMSymbol &B) { return Cmp(B, A); };
500 std::sort(SymbolList.begin(), SymbolList.end(), Cmp);
503 if (!PrintFileName) {
504 if (OutputFormat == posix && MultipleFiles && printName) {
505 outs() << '\n' << CurrentFilename << ":\n";
506 } else if (OutputFormat == bsd && MultipleFiles && printName) {
507 outs() << "\n" << CurrentFilename << ":\n";
508 } else if (OutputFormat == sysv) {
509 outs() << "\n\nSymbols from " << CurrentFilename << ":\n\n"
510 << "Name Value Class Type"
511 << " Size Line Section\n";
515 const char *printBlanks, *printFormat;
516 if (isSymbolList64Bit(Obj)) {
518 printFormat = "%016" PRIx64;
521 printFormat = "%08" PRIx64;
524 for (SymbolListT::iterator I = SymbolList.begin(), E = SymbolList.end();
526 uint32_t SymFlags = I->Sym.getFlags();
527 bool Undefined = SymFlags & SymbolRef::SF_Undefined;
528 if (!Undefined && UndefinedOnly)
530 if (Undefined && DefinedOnly)
532 if (SizeSort && !PrintAddress)
535 if (!ArchitectureName.empty())
536 outs() << "(for architecture " << ArchitectureName << "):";
537 if (!ArchiveName.empty())
538 outs() << ArchiveName << ":";
539 outs() << CurrentFilename << ": ";
541 if (JustSymbolName || (UndefinedOnly && isa<MachOObjectFile>(Obj))) {
542 outs() << I->Name << "\n";
546 char SymbolAddrStr[18] = "";
547 char SymbolSizeStr[18] = "";
549 if (OutputFormat == sysv || I->TypeChar == 'U')
550 strcpy(SymbolAddrStr, printBlanks);
551 if (OutputFormat == sysv)
552 strcpy(SymbolSizeStr, printBlanks);
554 if (I->TypeChar != 'U')
555 format(printFormat, I->Address)
556 .print(SymbolAddrStr, sizeof(SymbolAddrStr));
557 format(printFormat, I->Size).print(SymbolSizeStr, sizeof(SymbolSizeStr));
559 // If OutputFormat is darwin or we are printing Mach-O symbols in hex and
560 // we have a MachOObjectFile, call darwinPrintSymbol to print as darwin's
561 // nm(1) -m output or hex, else if OutputFormat is darwin or we are
562 // printing Mach-O symbols in hex and not a Mach-O object fall back to
563 // OutputFormat bsd (see below).
564 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
565 if ((OutputFormat == darwin || FormatMachOasHex) && MachO) {
566 darwinPrintSymbol(MachO, I, SymbolAddrStr, printBlanks);
567 } else if (OutputFormat == posix) {
568 outs() << I->Name << " " << I->TypeChar << " " << SymbolAddrStr
569 << SymbolSizeStr << "\n";
570 } else if (OutputFormat == bsd || (OutputFormat == darwin && !MachO)) {
572 outs() << SymbolAddrStr << ' ';
574 outs() << SymbolSizeStr;
577 outs() << I->TypeChar;
578 if (I->TypeChar == '-' && MachO)
579 darwinPrintStab(MachO, I);
580 outs() << " " << I->Name << "\n";
581 } else if (OutputFormat == sysv) {
582 std::string PaddedName(I->Name);
583 while (PaddedName.length() < 20)
585 outs() << PaddedName << "|" << SymbolAddrStr << "| " << I->TypeChar
586 << " | |" << SymbolSizeStr << "| |\n";
593 static char getSymbolNMTypeChar(ELFObjectFileBase &Obj,
594 basic_symbol_iterator I) {
596 elf_symbol_iterator SymI(I);
598 ErrorOr<elf_section_iterator> SecIOrErr = SymI->getSection();
599 if (error(SecIOrErr.getError()))
602 elf_section_iterator SecI = *SecIOrErr;
603 if (SecI != Obj.section_end()) {
604 switch (SecI->getType()) {
605 case ELF::SHT_PROGBITS:
606 case ELF::SHT_DYNAMIC:
607 switch (SecI->getFlags()) {
608 case (ELF::SHF_ALLOC | ELF::SHF_EXECINSTR):
610 case (ELF::SHF_TLS | ELF::SHF_ALLOC | ELF::SHF_WRITE):
611 case (ELF::SHF_ALLOC | ELF::SHF_WRITE):
614 case (ELF::SHF_ALLOC | ELF::SHF_MERGE):
615 case (ELF::SHF_ALLOC | ELF::SHF_MERGE | ELF::SHF_STRINGS):
619 case ELF::SHT_NOBITS:
624 if (SymI->getELFType() == ELF::STT_SECTION) {
625 ErrorOr<StringRef> Name = SymI->getName();
626 if (error(Name.getError()))
628 return StringSwitch<char>(*Name)
629 .StartsWith(".debug", 'N')
630 .StartsWith(".note", 'n')
637 static char getSymbolNMTypeChar(COFFObjectFile &Obj, symbol_iterator I) {
638 COFFSymbolRef Symb = Obj.getCOFFSymbol(*I);
640 symbol_iterator SymI(I);
642 ErrorOr<StringRef> Name = SymI->getName();
643 if (error(Name.getError()))
646 char Ret = StringSwitch<char>(*Name)
647 .StartsWith(".debug", 'N')
648 .StartsWith(".sxdata", 'N')
654 uint32_t Characteristics = 0;
655 if (!COFF::isReservedSectionNumber(Symb.getSectionNumber())) {
656 ErrorOr<section_iterator> SecIOrErr = SymI->getSection();
657 if (error(SecIOrErr.getError()))
659 section_iterator SecI = *SecIOrErr;
660 const coff_section *Section = Obj.getCOFFSection(*SecI);
661 Characteristics = Section->Characteristics;
664 switch (Symb.getSectionNumber()) {
665 case COFF::IMAGE_SYM_DEBUG:
668 // Check section type.
669 if (Characteristics & COFF::IMAGE_SCN_CNT_CODE)
671 if (Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
672 return Characteristics & COFF::IMAGE_SCN_MEM_WRITE ? 'd' : 'r';
673 if (Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)
675 if (Characteristics & COFF::IMAGE_SCN_LNK_INFO)
677 // Check for section symbol.
678 if (Symb.isSectionDefinition())
685 static uint8_t getNType(MachOObjectFile &Obj, DataRefImpl Symb) {
687 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
690 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
694 static char getSymbolNMTypeChar(MachOObjectFile &Obj, basic_symbol_iterator I) {
695 DataRefImpl Symb = I->getRawDataRefImpl();
696 uint8_t NType = getNType(Obj, Symb);
698 if (NType & MachO::N_STAB)
701 switch (NType & MachO::N_TYPE) {
706 case MachO::N_SECT: {
707 section_iterator Sec = *Obj.getSymbolSection(Symb);
708 DataRefImpl Ref = Sec->getRawDataRefImpl();
709 StringRef SectionName;
710 Obj.getSectionName(Ref, SectionName);
711 StringRef SegmentName = Obj.getSectionFinalSegmentName(Ref);
712 if (SegmentName == "__TEXT" && SectionName == "__text")
714 else if (SegmentName == "__DATA" && SectionName == "__data")
716 else if (SegmentName == "__DATA" && SectionName == "__bss")
726 static char getSymbolNMTypeChar(const GlobalValue &GV) {
727 if (GV.getType()->getElementType()->isFunctionTy())
729 // FIXME: should we print 'b'? At the IR level we cannot be sure if this
730 // will be in bss or not, but we could approximate.
734 static char getSymbolNMTypeChar(IRObjectFile &Obj, basic_symbol_iterator I) {
735 const GlobalValue *GV = Obj.getSymbolGV(I->getRawDataRefImpl());
738 return getSymbolNMTypeChar(*GV);
741 static bool isObject(SymbolicFile &Obj, basic_symbol_iterator I) {
742 auto *ELF = dyn_cast<ELFObjectFileBase>(&Obj);
746 return elf_symbol_iterator(I)->getELFType() == ELF::STT_OBJECT;
749 static char getNMTypeChar(SymbolicFile &Obj, basic_symbol_iterator I) {
750 uint32_t Symflags = I->getFlags();
751 if ((Symflags & object::SymbolRef::SF_Weak) && !isa<MachOObjectFile>(Obj)) {
752 char Ret = isObject(Obj, I) ? 'v' : 'w';
753 if (!(Symflags & object::SymbolRef::SF_Undefined))
758 if (Symflags & object::SymbolRef::SF_Undefined)
761 if (Symflags & object::SymbolRef::SF_Common)
765 if (Symflags & object::SymbolRef::SF_Absolute)
767 else if (IRObjectFile *IR = dyn_cast<IRObjectFile>(&Obj))
768 Ret = getSymbolNMTypeChar(*IR, I);
769 else if (COFFObjectFile *COFF = dyn_cast<COFFObjectFile>(&Obj))
770 Ret = getSymbolNMTypeChar(*COFF, I);
771 else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj))
772 Ret = getSymbolNMTypeChar(*MachO, I);
774 Ret = getSymbolNMTypeChar(cast<ELFObjectFileBase>(Obj), I);
776 if (Symflags & object::SymbolRef::SF_Global)
782 // getNsectForSegSect() is used to implement the Mach-O "-s segname sectname"
783 // option to dump only those symbols from that section in a Mach-O file.
784 // It is called once for each Mach-O file from dumpSymbolNamesFromObject()
785 // to get the section number for that named section from the command line
786 // arguments. It returns the section number for that section in the Mach-O
787 // file or zero it is not present.
788 static unsigned getNsectForSegSect(MachOObjectFile *Obj) {
790 for (section_iterator I = Obj->section_begin(), E = Obj->section_end();
792 DataRefImpl Ref = I->getRawDataRefImpl();
793 StringRef SectionName;
794 Obj->getSectionName(Ref, SectionName);
795 StringRef SegmentName = Obj->getSectionFinalSegmentName(Ref);
796 if (SegmentName == SegSect[0] && SectionName == SegSect[1])
803 // getNsectInMachO() is used to implement the Mach-O "-s segname sectname"
804 // option to dump only those symbols from that section in a Mach-O file.
805 // It is called once for each symbol in a Mach-O file from
806 // dumpSymbolNamesFromObject() and returns the section number for that symbol
807 // if it is in a section, else it returns 0.
808 static unsigned getNsectInMachO(MachOObjectFile &Obj, BasicSymbolRef Sym) {
809 DataRefImpl Symb = Sym.getRawDataRefImpl();
811 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
812 if ((STE.n_type & MachO::N_TYPE) == MachO::N_SECT)
816 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
817 if ((STE.n_type & MachO::N_TYPE) == MachO::N_SECT)
822 static void dumpSymbolNamesFromObject(SymbolicFile &Obj, bool printName,
823 std::string ArchiveName = std::string(),
824 std::string ArchitectureName =
826 auto Symbols = Obj.symbols();
828 const auto *E = dyn_cast<ELFObjectFileBase>(&Obj);
830 error("File format has no dynamic symbol table", Obj.getFileName());
833 auto DynSymbols = E->getDynamicSymbolIterators();
835 make_range<basic_symbol_iterator>(DynSymbols.begin(), DynSymbols.end());
837 std::string NameBuffer;
838 raw_string_ostream OS(NameBuffer);
839 // If a "-s segname sectname" option was specified and this is a Mach-O
840 // file get the section number for that section in this object file.
841 unsigned int Nsect = 0;
842 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
843 if (SegSect.size() != 0 && MachO) {
844 Nsect = getNsectForSegSect(MachO);
845 // If this section is not in the object file no symbols are printed.
849 for (BasicSymbolRef Sym : Symbols) {
850 uint32_t SymFlags = Sym.getFlags();
851 if (!DebugSyms && (SymFlags & SymbolRef::SF_FormatSpecific))
853 if (WithoutAliases) {
854 if (IRObjectFile *IR = dyn_cast<IRObjectFile>(&Obj)) {
855 const GlobalValue *GV = IR->getSymbolGV(Sym.getRawDataRefImpl());
856 if (GV && isa<GlobalAlias>(GV))
860 // If a "-s segname sectname" option was specified and this is a Mach-O
861 // file and this section appears in this file, Nsect will be non-zero then
862 // see if this symbol is a symbol from that section and if not skip it.
863 if (Nsect && Nsect != getNsectInMachO(*MachO, Sym))
869 if (isa<ELFObjectFileBase>(&Obj))
870 S.Size = ELFSymbolRef(Sym).getSize();
872 if (PrintAddress && isa<ObjectFile>(Obj)) {
873 SymbolRef SymRef(Sym);
874 ErrorOr<uint64_t> AddressOrErr = SymRef.getAddress();
875 if (error(AddressOrErr.getError()))
877 S.Address = *AddressOrErr;
879 S.TypeChar = getNMTypeChar(Obj, Sym);
880 if (error(Sym.printName(OS)))
884 SymbolList.push_back(S);
888 const char *P = NameBuffer.c_str();
889 for (unsigned I = 0; I < SymbolList.size(); ++I) {
890 SymbolList[I].Name = P;
894 CurrentFilename = Obj.getFileName();
895 sortAndPrintSymbolList(Obj, printName, ArchiveName, ArchitectureName);
898 // checkMachOAndArchFlags() checks to see if the SymbolicFile is a Mach-O file
899 // and if it is and there is a list of architecture flags is specified then
900 // check to make sure this Mach-O file is one of those architectures or all
901 // architectures was specificed. If not then an error is generated and this
902 // routine returns false. Else it returns true.
903 static bool checkMachOAndArchFlags(SymbolicFile *O, std::string &Filename) {
904 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(O);
906 if (!MachO || ArchAll || ArchFlags.size() == 0)
909 MachO::mach_header H;
910 MachO::mach_header_64 H_64;
912 if (MachO->is64Bit()) {
913 H_64 = MachO->MachOObjectFile::getHeader64();
914 T = MachOObjectFile::getArch(H_64.cputype, H_64.cpusubtype);
916 H = MachO->MachOObjectFile::getHeader();
917 T = MachOObjectFile::getArch(H.cputype, H.cpusubtype);
920 ArchFlags.begin(), ArchFlags.end(),
921 [&](const std::string &Name) { return Name == T.getArchName(); })) {
922 error("No architecture specified", Filename);
928 static void dumpSymbolNamesFromFile(std::string &Filename) {
929 ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
930 MemoryBuffer::getFileOrSTDIN(Filename);
931 if (error(BufferOrErr.getError(), Filename))
934 LLVMContext &Context = getGlobalContext();
935 ErrorOr<std::unique_ptr<Binary>> BinaryOrErr = createBinary(
936 BufferOrErr.get()->getMemBufferRef(), NoLLVMBitcode ? nullptr : &Context);
937 if (error(BinaryOrErr.getError(), Filename))
939 Binary &Bin = *BinaryOrErr.get();
941 if (Archive *A = dyn_cast<Archive>(&Bin)) {
943 Archive::symbol_iterator I = A->symbol_begin();
944 Archive::symbol_iterator E = A->symbol_end();
946 outs() << "Archive map\n";
947 for (; I != E; ++I) {
948 ErrorOr<Archive::child_iterator> ErrorOrChild = I->getMember();
949 if (error(ErrorOrChild.getError()))
951 auto &C = *(ErrorOrChild.get());
952 ErrorOr<StringRef> FileNameOrErr = C.get().getName();
953 if (error(FileNameOrErr.getError()))
955 StringRef SymName = I->getName();
956 outs() << SymName << " in " << FileNameOrErr.get() << "\n";
962 for (Archive::child_iterator I = A->child_begin(), E = A->child_end();
967 ErrorOr<std::unique_ptr<Binary>> ChildOrErr = C.getAsBinary(&Context);
968 if (ChildOrErr.getError())
970 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
971 if (!checkMachOAndArchFlags(O, Filename))
973 if (!PrintFileName) {
975 if (isa<MachOObjectFile>(O)) {
976 outs() << Filename << "(" << O->getFileName() << ")";
978 outs() << O->getFileName();
981 dumpSymbolNamesFromObject(*O, false, Filename);
986 if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(&Bin)) {
987 // If we have a list of architecture flags specified dump only those.
988 if (!ArchAll && ArchFlags.size() != 0) {
989 // Look for a slice in the universal binary that matches each ArchFlag.
991 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
993 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
994 E = UB->end_objects();
996 if (ArchFlags[i] == I->getArchTypeName()) {
998 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr =
999 I->getAsObjectFile();
1000 std::string ArchiveName;
1001 std::string ArchitectureName;
1002 ArchiveName.clear();
1003 ArchitectureName.clear();
1005 ObjectFile &Obj = *ObjOrErr.get();
1006 if (ArchFlags.size() > 1) {
1008 ArchitectureName = I->getArchTypeName();
1010 outs() << "\n" << Obj.getFileName() << " (for architecture "
1011 << I->getArchTypeName() << ")"
1014 dumpSymbolNamesFromObject(Obj, false, ArchiveName,
1016 } else if (ErrorOr<std::unique_ptr<Archive>> AOrErr =
1017 I->getAsArchive()) {
1018 std::unique_ptr<Archive> &A = *AOrErr;
1019 for (Archive::child_iterator AI = A->child_begin(),
1020 AE = A->child_end();
1024 auto &C = AI->get();
1025 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
1026 C.getAsBinary(&Context);
1027 if (ChildOrErr.getError())
1029 if (SymbolicFile *O =
1030 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1031 if (PrintFileName) {
1032 ArchiveName = A->getFileName();
1033 if (ArchFlags.size() > 1)
1034 ArchitectureName = I->getArchTypeName();
1036 outs() << "\n" << A->getFileName();
1037 outs() << "(" << O->getFileName() << ")";
1038 if (ArchFlags.size() > 1) {
1039 outs() << " (for architecture " << I->getArchTypeName()
1044 dumpSymbolNamesFromObject(*O, false, ArchiveName,
1053 "file: " + Filename + " does not contain architecture");
1059 // No architecture flags were specified so if this contains a slice that
1060 // matches the host architecture dump only that.
1062 StringRef HostArchName = MachOObjectFile::getHostArch().getArchName();
1063 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1064 E = UB->end_objects();
1066 if (HostArchName == I->getArchTypeName()) {
1067 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
1068 std::string ArchiveName;
1069 ArchiveName.clear();
1071 ObjectFile &Obj = *ObjOrErr.get();
1072 dumpSymbolNamesFromObject(Obj, false);
1073 } else if (ErrorOr<std::unique_ptr<Archive>> AOrErr =
1074 I->getAsArchive()) {
1075 std::unique_ptr<Archive> &A = *AOrErr;
1076 for (Archive::child_iterator AI = A->child_begin(),
1077 AE = A->child_end();
1081 auto &C = AI->get();
1082 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
1083 C.getAsBinary(&Context);
1084 if (ChildOrErr.getError())
1086 if (SymbolicFile *O =
1087 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1089 ArchiveName = A->getFileName();
1091 outs() << "\n" << A->getFileName() << "(" << O->getFileName()
1094 dumpSymbolNamesFromObject(*O, false, ArchiveName);
1102 // Either all architectures have been specified or none have been specified
1103 // and this does not contain the host architecture so dump all the slices.
1104 bool moreThanOneArch = UB->getNumberOfObjects() > 1;
1105 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1106 E = UB->end_objects();
1108 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
1109 std::string ArchiveName;
1110 std::string ArchitectureName;
1111 ArchiveName.clear();
1112 ArchitectureName.clear();
1114 ObjectFile &Obj = *ObjOrErr.get();
1115 if (PrintFileName) {
1116 if (isa<MachOObjectFile>(Obj) && moreThanOneArch)
1117 ArchitectureName = I->getArchTypeName();
1119 if (moreThanOneArch)
1121 outs() << Obj.getFileName();
1122 if (isa<MachOObjectFile>(Obj) && moreThanOneArch)
1123 outs() << " (for architecture " << I->getArchTypeName() << ")";
1126 dumpSymbolNamesFromObject(Obj, false, ArchiveName, ArchitectureName);
1127 } else if (ErrorOr<std::unique_ptr<Archive>> AOrErr = I->getAsArchive()) {
1128 std::unique_ptr<Archive> &A = *AOrErr;
1129 for (Archive::child_iterator AI = A->child_begin(), AE = A->child_end();
1133 auto &C = AI->get();
1134 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
1135 C.getAsBinary(&Context);
1136 if (ChildOrErr.getError())
1138 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1139 if (PrintFileName) {
1140 ArchiveName = A->getFileName();
1141 if (isa<MachOObjectFile>(O) && moreThanOneArch)
1142 ArchitectureName = I->getArchTypeName();
1144 outs() << "\n" << A->getFileName();
1145 if (isa<MachOObjectFile>(O)) {
1146 outs() << "(" << O->getFileName() << ")";
1147 if (moreThanOneArch)
1148 outs() << " (for architecture " << I->getArchTypeName()
1151 outs() << ":" << O->getFileName();
1154 dumpSymbolNamesFromObject(*O, false, ArchiveName, ArchitectureName);
1161 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&Bin)) {
1162 if (!checkMachOAndArchFlags(O, Filename))
1164 dumpSymbolNamesFromObject(*O, true);
1167 error("unrecognizable file type", Filename);
1170 int main(int argc, char **argv) {
1171 // Print a stack trace if we signal out.
1172 sys::PrintStackTraceOnErrorSignal();
1173 PrettyStackTraceProgram X(argc, argv);
1175 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
1176 cl::ParseCommandLineOptions(argc, argv, "llvm symbol table dumper\n");
1178 // llvm-nm only reads binary files.
1179 if (error(sys::ChangeStdinToBinary()))
1182 llvm::InitializeAllTargetInfos();
1183 llvm::InitializeAllTargetMCs();
1184 llvm::InitializeAllAsmParsers();
1190 OutputFormat = posix;
1192 OutputFormat = darwin;
1194 // The relative order of these is important. If you pass --size-sort it should
1195 // only print out the size. However, if you pass -S --size-sort, it should
1196 // print out both the size and address.
1197 if (SizeSort && !PrintSize)
1198 PrintAddress = false;
1199 if (OutputFormat == sysv || SizeSort)
1202 switch (InputFilenames.size()) {
1204 InputFilenames.push_back("a.out");
1208 MultipleFiles = true;
1211 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
1212 if (ArchFlags[i] == "all") {
1215 if (!MachOObjectFile::isValidArch(ArchFlags[i]))
1216 error("Unknown architecture named '" + ArchFlags[i] + "'",
1217 "for the -arch option");
1221 if (SegSect.size() != 0 && SegSect.size() != 2)
1222 error("bad number of arguments (must be two arguments)",
1223 "for the -s option");
1225 std::for_each(InputFilenames.begin(), InputFilenames.end(),
1226 dumpSymbolNamesFromFile);