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>
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) {
188 bool AUndefined = A.Sym.getFlags() & SymbolRef::SF_Undefined;
189 bool BUndefined = B.Sym.getFlags() & SymbolRef::SF_Undefined;
190 if (AUndefined && !BUndefined)
192 if (!AUndefined && BUndefined)
194 if (A.Address < B.Address)
196 if (A.Address == B.Address && A.Name < B.Name)
198 if (A.Address == B.Address && A.Name == B.Name && A.Size < B.Size)
203 static bool compareSymbolSize(const NMSymbol &A, const NMSymbol &B) {
206 if (A.Size == B.Size && A.Name < B.Name)
208 if (A.Size == B.Size && A.Name == B.Name && A.Address < B.Address)
213 static bool compareSymbolName(const NMSymbol &A, const NMSymbol &B) {
216 if (A.Name == B.Name && A.Size < B.Size)
218 if (A.Name == B.Name && A.Size == B.Size && A.Address < B.Address)
223 static char isSymbolList64Bit(SymbolicFile &Obj) {
224 if (isa<IRObjectFile>(Obj))
226 if (isa<COFFObjectFile>(Obj))
228 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj))
229 return MachO->is64Bit();
230 return cast<ELFObjectFileBase>(Obj).getBytesInAddress() == 8;
233 static StringRef CurrentFilename;
234 typedef std::vector<NMSymbol> SymbolListT;
235 static SymbolListT SymbolList;
237 // darwinPrintSymbol() is used to print a symbol from a Mach-O file when the
238 // the OutputFormat is darwin or we are printing Mach-O symbols in hex. For
239 // the darwin format it produces the same output as darwin's nm(1) -m output
240 // and when printing Mach-O symbols in hex it produces the same output as
241 // darwin's nm(1) -x format.
242 static void darwinPrintSymbol(MachOObjectFile *MachO, SymbolListT::iterator I,
243 char *SymbolAddrStr, const char *printBlanks) {
244 MachO::mach_header H;
245 MachO::mach_header_64 H_64;
246 uint32_t Filetype, Flags;
247 MachO::nlist_64 STE_64;
254 DataRefImpl SymDRI = I->Sym.getRawDataRefImpl();
255 if (MachO->is64Bit()) {
256 H_64 = MachO->MachOObjectFile::getHeader64();
257 Filetype = H_64.filetype;
259 STE_64 = MachO->getSymbol64TableEntry(SymDRI);
260 NType = STE_64.n_type;
261 NSect = STE_64.n_sect;
262 NDesc = STE_64.n_desc;
263 NStrx = STE_64.n_strx;
264 NValue = STE_64.n_value;
266 H = MachO->MachOObjectFile::getHeader();
267 Filetype = H.filetype;
269 STE = MachO->getSymbolTableEntry(SymDRI);
274 NValue = STE.n_value;
277 // If we are printing Mach-O symbols in hex do that and return.
278 if (FormatMachOasHex) {
280 const char *printFormat;
281 if (MachO->is64Bit())
282 printFormat = "%016" PRIx64;
284 printFormat = "%08" PRIx64;
285 format(printFormat, NValue).print(Str, sizeof(Str));
286 outs() << Str << ' ';
287 format("%02x", NType).print(Str, sizeof(Str));
288 outs() << Str << ' ';
289 format("%02x", NSect).print(Str, sizeof(Str));
290 outs() << Str << ' ';
291 format("%04x", NDesc).print(Str, sizeof(Str));
292 outs() << Str << ' ';
293 format("%08x", NStrx).print(Str, sizeof(Str));
294 outs() << Str << ' ';
295 outs() << I->Name << "\n";
300 if ((NType & MachO::N_TYPE) == MachO::N_INDR)
301 strcpy(SymbolAddrStr, printBlanks);
302 outs() << SymbolAddrStr << ' ';
305 switch (NType & MachO::N_TYPE) {
308 outs() << "(common) ";
309 if (MachO::GET_COMM_ALIGN(NDesc) != 0)
310 outs() << "(alignment 2^" << (int)MachO::GET_COMM_ALIGN(NDesc) << ") ";
312 if ((NType & MachO::N_TYPE) == MachO::N_PBUD)
313 outs() << "(prebound ";
316 if ((NDesc & MachO::REFERENCE_TYPE) ==
317 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
318 outs() << "undefined [lazy bound]) ";
319 else if ((NDesc & MachO::REFERENCE_TYPE) ==
320 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
321 outs() << "undefined [private lazy bound]) ";
322 else if ((NDesc & MachO::REFERENCE_TYPE) ==
323 MachO::REFERENCE_FLAG_PRIVATE_UNDEFINED_NON_LAZY)
324 outs() << "undefined [private]) ";
326 outs() << "undefined) ";
330 outs() << "(absolute) ";
333 outs() << "(indirect) ";
335 case MachO::N_SECT: {
336 section_iterator Sec = MachO->section_end();
337 MachO->getSymbolSection(I->Sym.getRawDataRefImpl(), Sec);
338 DataRefImpl Ref = Sec->getRawDataRefImpl();
339 StringRef SectionName;
340 MachO->getSectionName(Ref, SectionName);
341 StringRef SegmentName = MachO->getSectionFinalSegmentName(Ref);
342 outs() << "(" << SegmentName << "," << SectionName << ") ";
350 if (NType & MachO::N_EXT) {
351 if (NDesc & MachO::REFERENCED_DYNAMICALLY)
352 outs() << "[referenced dynamically] ";
353 if (NType & MachO::N_PEXT) {
354 if ((NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF)
355 outs() << "weak private external ";
357 outs() << "private external ";
359 if ((NDesc & MachO::N_WEAK_REF) == MachO::N_WEAK_REF ||
360 (NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF) {
361 if ((NDesc & (MachO::N_WEAK_REF | MachO::N_WEAK_DEF)) ==
362 (MachO::N_WEAK_REF | MachO::N_WEAK_DEF))
363 outs() << "weak external automatically hidden ";
365 outs() << "weak external ";
367 outs() << "external ";
370 if (NType & MachO::N_PEXT)
371 outs() << "non-external (was a private external) ";
373 outs() << "non-external ";
376 if (Filetype == MachO::MH_OBJECT &&
377 (NDesc & MachO::N_NO_DEAD_STRIP) == MachO::N_NO_DEAD_STRIP)
378 outs() << "[no dead strip] ";
380 if (Filetype == MachO::MH_OBJECT &&
381 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
382 (NDesc & MachO::N_SYMBOL_RESOLVER) == MachO::N_SYMBOL_RESOLVER)
383 outs() << "[symbol resolver] ";
385 if (Filetype == MachO::MH_OBJECT &&
386 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
387 (NDesc & MachO::N_ALT_ENTRY) == MachO::N_ALT_ENTRY)
388 outs() << "[alt entry] ";
390 if ((NDesc & MachO::N_ARM_THUMB_DEF) == MachO::N_ARM_THUMB_DEF)
391 outs() << "[Thumb] ";
393 if ((NType & MachO::N_TYPE) == MachO::N_INDR) {
394 outs() << I->Name << " (for ";
395 StringRef IndirectName;
396 if (MachO->getIndirectName(I->Sym.getRawDataRefImpl(), IndirectName))
399 outs() << IndirectName << ")";
403 if ((Flags & MachO::MH_TWOLEVEL) == MachO::MH_TWOLEVEL &&
404 (((NType & MachO::N_TYPE) == MachO::N_UNDF && NValue == 0) ||
405 (NType & MachO::N_TYPE) == MachO::N_PBUD)) {
406 uint32_t LibraryOrdinal = MachO::GET_LIBRARY_ORDINAL(NDesc);
407 if (LibraryOrdinal != 0) {
408 if (LibraryOrdinal == MachO::EXECUTABLE_ORDINAL)
409 outs() << " (from executable)";
410 else if (LibraryOrdinal == MachO::DYNAMIC_LOOKUP_ORDINAL)
411 outs() << " (dynamically looked up)";
413 StringRef LibraryName;
414 if (MachO->getLibraryShortNameByIndex(LibraryOrdinal - 1, LibraryName))
415 outs() << " (from bad library ordinal " << LibraryOrdinal << ")";
417 outs() << " (from " << LibraryName << ")";
425 // Table that maps Darwin's Mach-O stab constants to strings to allow printing.
426 struct DarwinStabName {
430 static const struct DarwinStabName DarwinStabNames[] = {
431 {MachO::N_GSYM, "GSYM"},
432 {MachO::N_FNAME, "FNAME"},
433 {MachO::N_FUN, "FUN"},
434 {MachO::N_STSYM, "STSYM"},
435 {MachO::N_LCSYM, "LCSYM"},
436 {MachO::N_BNSYM, "BNSYM"},
438 {MachO::N_AST, "AST"},
439 {MachO::N_OPT, "OPT"},
440 {MachO::N_RSYM, "RSYM"},
441 {MachO::N_SLINE, "SLINE"},
442 {MachO::N_ENSYM, "ENSYM"},
443 {MachO::N_SSYM, "SSYM"},
445 {MachO::N_OSO, "OSO"},
446 {MachO::N_LSYM, "LSYM"},
447 {MachO::N_BINCL, "BINCL"},
448 {MachO::N_SOL, "SOL"},
449 {MachO::N_PARAMS, "PARAM"},
450 {MachO::N_VERSION, "VERS"},
451 {MachO::N_OLEVEL, "OLEV"},
452 {MachO::N_PSYM, "PSYM"},
453 {MachO::N_EINCL, "EINCL"},
454 {MachO::N_ENTRY, "ENTRY"},
455 {MachO::N_LBRAC, "LBRAC"},
456 {MachO::N_EXCL, "EXCL"},
457 {MachO::N_RBRAC, "RBRAC"},
458 {MachO::N_BCOMM, "BCOMM"},
459 {MachO::N_ECOMM, "ECOMM"},
460 {MachO::N_ECOML, "ECOML"},
461 {MachO::N_LENG, "LENG"},
463 static const char *getDarwinStabString(uint8_t NType) {
464 for (unsigned i = 0; DarwinStabNames[i].Name; i++) {
465 if (DarwinStabNames[i].NType == NType)
466 return DarwinStabNames[i].Name;
471 // darwinPrintStab() prints the n_sect, n_desc along with a symbolic name of
472 // a stab n_type value in a Mach-O file.
473 static void darwinPrintStab(MachOObjectFile *MachO, SymbolListT::iterator I) {
474 MachO::nlist_64 STE_64;
479 DataRefImpl SymDRI = I->Sym.getRawDataRefImpl();
480 if (MachO->is64Bit()) {
481 STE_64 = MachO->getSymbol64TableEntry(SymDRI);
482 NType = STE_64.n_type;
483 NSect = STE_64.n_sect;
484 NDesc = STE_64.n_desc;
486 STE = MachO->getSymbolTableEntry(SymDRI);
493 format("%02x", NSect).print(Str, sizeof(Str));
494 outs() << ' ' << Str << ' ';
495 format("%04x", NDesc).print(Str, sizeof(Str));
496 outs() << Str << ' ';
497 if (const char *stabString = getDarwinStabString(NType))
498 format("%5.5s", stabString).print(Str, sizeof(Str));
500 format(" %02x", NType).print(Str, sizeof(Str));
504 static void sortAndPrintSymbolList(SymbolicFile &Obj, bool printName,
505 std::string ArchiveName,
506 std::string ArchitectureName) {
508 std::function<bool(const NMSymbol &, const NMSymbol &)> Cmp;
510 Cmp = compareSymbolAddress;
512 Cmp = compareSymbolSize;
514 Cmp = compareSymbolName;
517 Cmp = [=](const NMSymbol &A, const NMSymbol &B) { return Cmp(B, A); };
518 std::sort(SymbolList.begin(), SymbolList.end(), Cmp);
521 if (!PrintFileName) {
522 if (OutputFormat == posix && MultipleFiles && printName) {
523 outs() << '\n' << CurrentFilename << ":\n";
524 } else if (OutputFormat == bsd && MultipleFiles && printName) {
525 outs() << "\n" << CurrentFilename << ":\n";
526 } else if (OutputFormat == sysv) {
527 outs() << "\n\nSymbols from " << CurrentFilename << ":\n\n"
528 << "Name Value Class Type"
529 << " Size Line Section\n";
533 const char *printBlanks, *printFormat;
534 if (isSymbolList64Bit(Obj)) {
536 printFormat = "%016" PRIx64;
539 printFormat = "%08" PRIx64;
542 for (SymbolListT::iterator I = SymbolList.begin(), E = SymbolList.end();
544 uint32_t SymFlags = I->Sym.getFlags();
545 bool Undefined = SymFlags & SymbolRef::SF_Undefined;
546 if (!Undefined && UndefinedOnly)
548 if (Undefined && DefinedOnly)
550 if (SizeSort && !PrintAddress)
553 if (!ArchitectureName.empty())
554 outs() << "(for architecture " << ArchitectureName << "):";
555 if (!ArchiveName.empty())
556 outs() << ArchiveName << ":";
557 outs() << CurrentFilename << ": ";
559 if (JustSymbolName || (UndefinedOnly && isa<MachOObjectFile>(Obj))) {
560 outs() << I->Name << "\n";
564 char SymbolAddrStr[18] = "";
565 char SymbolSizeStr[18] = "";
567 if (OutputFormat == sysv || I->TypeChar == 'U')
568 strcpy(SymbolAddrStr, printBlanks);
569 if (OutputFormat == sysv)
570 strcpy(SymbolSizeStr, printBlanks);
572 if (I->TypeChar != 'U')
573 format(printFormat, I->Address)
574 .print(SymbolAddrStr, sizeof(SymbolAddrStr));
575 format(printFormat, I->Size).print(SymbolSizeStr, sizeof(SymbolSizeStr));
577 // If OutputFormat is darwin or we are printing Mach-O symbols in hex and
578 // we have a MachOObjectFile, call darwinPrintSymbol to print as darwin's
579 // nm(1) -m output or hex, else if OutputFormat is darwin or we are
580 // printing Mach-O symbols in hex and not a Mach-O object fall back to
581 // OutputFormat bsd (see below).
582 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
583 if ((OutputFormat == darwin || FormatMachOasHex) && MachO) {
584 darwinPrintSymbol(MachO, I, SymbolAddrStr, printBlanks);
585 } else if (OutputFormat == posix) {
586 outs() << I->Name << " " << I->TypeChar << " " << SymbolAddrStr
587 << SymbolSizeStr << "\n";
588 } else if (OutputFormat == bsd || (OutputFormat == darwin && !MachO)) {
590 outs() << SymbolAddrStr << ' ';
592 outs() << SymbolSizeStr;
595 outs() << I->TypeChar;
596 if (I->TypeChar == '-' && MachO)
597 darwinPrintStab(MachO, I);
598 outs() << " " << I->Name << "\n";
599 } else if (OutputFormat == sysv) {
600 std::string PaddedName(I->Name);
601 while (PaddedName.length() < 20)
603 outs() << PaddedName << "|" << SymbolAddrStr << "| " << I->TypeChar
604 << " | |" << SymbolSizeStr << "| |\n";
611 static char getSymbolNMTypeChar(ELFObjectFileBase &Obj,
612 basic_symbol_iterator I) {
614 elf_symbol_iterator SymI(I);
616 elf_section_iterator SecI = Obj.section_end();
617 if (error(SymI->getSection(SecI)))
620 if (SecI != Obj.section_end()) {
621 switch (SecI->getType()) {
622 case ELF::SHT_PROGBITS:
623 case ELF::SHT_DYNAMIC:
624 switch (SecI->getFlags()) {
625 case (ELF::SHF_ALLOC | ELF::SHF_EXECINSTR):
627 case (ELF::SHF_TLS | ELF::SHF_ALLOC | ELF::SHF_WRITE):
628 case (ELF::SHF_ALLOC | ELF::SHF_WRITE):
631 case (ELF::SHF_ALLOC | ELF::SHF_MERGE):
632 case (ELF::SHF_ALLOC | ELF::SHF_MERGE | ELF::SHF_STRINGS):
636 case ELF::SHT_NOBITS:
641 if (SymI->getELFType() == ELF::STT_SECTION) {
642 ErrorOr<StringRef> Name = SymI->getName();
643 if (error(Name.getError()))
645 return StringSwitch<char>(*Name)
646 .StartsWith(".debug", 'N')
647 .StartsWith(".note", 'n')
654 static char getSymbolNMTypeChar(COFFObjectFile &Obj, symbol_iterator I) {
655 COFFSymbolRef Symb = Obj.getCOFFSymbol(*I);
657 symbol_iterator SymI(I);
659 ErrorOr<StringRef> Name = SymI->getName();
660 if (error(Name.getError()))
663 char Ret = StringSwitch<char>(*Name)
664 .StartsWith(".debug", 'N')
665 .StartsWith(".sxdata", 'N')
671 uint32_t Characteristics = 0;
672 if (!COFF::isReservedSectionNumber(Symb.getSectionNumber())) {
673 section_iterator SecI = Obj.section_end();
674 if (error(SymI->getSection(SecI)))
676 const coff_section *Section = Obj.getCOFFSection(*SecI);
677 Characteristics = Section->Characteristics;
680 switch (Symb.getSectionNumber()) {
681 case COFF::IMAGE_SYM_DEBUG:
684 // Check section type.
685 if (Characteristics & COFF::IMAGE_SCN_CNT_CODE)
687 if (Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
688 return Characteristics & COFF::IMAGE_SCN_MEM_WRITE ? 'd' : 'r';
689 if (Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)
691 if (Characteristics & COFF::IMAGE_SCN_LNK_INFO)
693 // Check for section symbol.
694 if (Symb.isSectionDefinition())
701 static uint8_t getNType(MachOObjectFile &Obj, DataRefImpl Symb) {
703 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
706 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
710 static char getSymbolNMTypeChar(MachOObjectFile &Obj, basic_symbol_iterator I) {
711 DataRefImpl Symb = I->getRawDataRefImpl();
712 uint8_t NType = getNType(Obj, Symb);
714 if (NType & MachO::N_STAB)
717 switch (NType & MachO::N_TYPE) {
722 case MachO::N_SECT: {
723 section_iterator Sec = Obj.section_end();
724 Obj.getSymbolSection(Symb, Sec);
725 DataRefImpl Ref = Sec->getRawDataRefImpl();
726 StringRef SectionName;
727 Obj.getSectionName(Ref, SectionName);
728 StringRef SegmentName = Obj.getSectionFinalSegmentName(Ref);
729 if (SegmentName == "__TEXT" && SectionName == "__text")
731 else if (SegmentName == "__DATA" && SectionName == "__data")
733 else if (SegmentName == "__DATA" && SectionName == "__bss")
743 static char getSymbolNMTypeChar(const GlobalValue &GV) {
744 if (GV.getType()->getElementType()->isFunctionTy())
746 // FIXME: should we print 'b'? At the IR level we cannot be sure if this
747 // will be in bss or not, but we could approximate.
751 static char getSymbolNMTypeChar(IRObjectFile &Obj, basic_symbol_iterator I) {
752 const GlobalValue *GV = Obj.getSymbolGV(I->getRawDataRefImpl());
755 return getSymbolNMTypeChar(*GV);
758 static bool isObject(SymbolicFile &Obj, basic_symbol_iterator I) {
759 auto *ELF = dyn_cast<ELFObjectFileBase>(&Obj);
763 return elf_symbol_iterator(I)->getELFType() == ELF::STT_OBJECT;
766 static char getNMTypeChar(SymbolicFile &Obj, basic_symbol_iterator I) {
767 uint32_t Symflags = I->getFlags();
768 if ((Symflags & object::SymbolRef::SF_Weak) && !isa<MachOObjectFile>(Obj)) {
769 char Ret = isObject(Obj, I) ? 'v' : 'w';
770 if (!(Symflags & object::SymbolRef::SF_Undefined))
775 if (Symflags & object::SymbolRef::SF_Undefined)
778 if (Symflags & object::SymbolRef::SF_Common)
782 if (Symflags & object::SymbolRef::SF_Absolute)
784 else if (IRObjectFile *IR = dyn_cast<IRObjectFile>(&Obj))
785 Ret = getSymbolNMTypeChar(*IR, I);
786 else if (COFFObjectFile *COFF = dyn_cast<COFFObjectFile>(&Obj))
787 Ret = getSymbolNMTypeChar(*COFF, I);
788 else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj))
789 Ret = getSymbolNMTypeChar(*MachO, I);
791 Ret = getSymbolNMTypeChar(cast<ELFObjectFileBase>(Obj), I);
793 if (Symflags & object::SymbolRef::SF_Global)
799 // getNsectForSegSect() is used to implement the Mach-O "-s segname sectname"
800 // option to dump only those symbols from that section in a Mach-O file.
801 // It is called once for each Mach-O file from dumpSymbolNamesFromObject()
802 // to get the section number for that named section from the command line
803 // arguments. It returns the section number for that section in the Mach-O
804 // file or zero it is not present.
805 static unsigned getNsectForSegSect(MachOObjectFile *Obj) {
807 for (section_iterator I = Obj->section_begin(), E = Obj->section_end();
809 DataRefImpl Ref = I->getRawDataRefImpl();
810 StringRef SectionName;
811 Obj->getSectionName(Ref, SectionName);
812 StringRef SegmentName = Obj->getSectionFinalSegmentName(Ref);
813 if (SegmentName == SegSect[0] && SectionName == SegSect[1])
820 // getNsectInMachO() is used to implement the Mach-O "-s segname sectname"
821 // option to dump only those symbols from that section in a Mach-O file.
822 // It is called once for each symbol in a Mach-O file from
823 // dumpSymbolNamesFromObject() and returns the section number for that symbol
824 // if it is in a section, else it returns 0.
825 static unsigned getNsectInMachO(MachOObjectFile &Obj, BasicSymbolRef Sym) {
826 DataRefImpl Symb = Sym.getRawDataRefImpl();
828 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
829 if ((STE.n_type & MachO::N_TYPE) == MachO::N_SECT)
833 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
834 if ((STE.n_type & MachO::N_TYPE) == MachO::N_SECT)
839 static void dumpSymbolNamesFromObject(SymbolicFile &Obj, bool printName,
840 std::string ArchiveName = std::string(),
841 std::string ArchitectureName =
843 auto Symbols = Obj.symbols();
845 const auto *E = dyn_cast<ELFObjectFileBase>(&Obj);
847 error("File format has no dynamic symbol table", Obj.getFileName());
850 auto DynSymbols = E->getDynamicSymbolIterators();
852 make_range<basic_symbol_iterator>(DynSymbols.begin(), DynSymbols.end());
854 std::string NameBuffer;
855 raw_string_ostream OS(NameBuffer);
856 // If a "-s segname sectname" option was specified and this is a Mach-O
857 // file get the section number for that section in this object file.
858 unsigned int Nsect = 0;
859 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
860 if (SegSect.size() != 0 && MachO) {
861 Nsect = getNsectForSegSect(MachO);
862 // If this section is not in the object file no symbols are printed.
866 for (BasicSymbolRef Sym : Symbols) {
867 uint32_t SymFlags = Sym.getFlags();
868 if (!DebugSyms && (SymFlags & SymbolRef::SF_FormatSpecific))
870 if (WithoutAliases) {
871 if (IRObjectFile *IR = dyn_cast<IRObjectFile>(&Obj)) {
872 const GlobalValue *GV = IR->getSymbolGV(Sym.getRawDataRefImpl());
873 if (GV && isa<GlobalAlias>(GV))
877 // If a "-s segname sectname" option was specified and this is a Mach-O
878 // file and this section appears in this file, Nsect will be non-zero then
879 // see if this symbol is a symbol from that section and if not skip it.
880 if (Nsect && Nsect != getNsectInMachO(*MachO, Sym))
886 if (isa<ELFObjectFileBase>(&Obj))
887 S.Size = ELFSymbolRef(Sym).getSize();
889 if (PrintAddress && isa<ObjectFile>(Obj)) {
890 SymbolRef SymRef(Sym);
891 ErrorOr<uint64_t> AddressOrErr = SymRef.getAddress();
892 if (error(AddressOrErr.getError()))
894 S.Address = *AddressOrErr;
896 S.TypeChar = getNMTypeChar(Obj, Sym);
897 if (error(Sym.printName(OS)))
901 SymbolList.push_back(S);
905 const char *P = NameBuffer.c_str();
906 for (unsigned I = 0; I < SymbolList.size(); ++I) {
907 SymbolList[I].Name = P;
911 CurrentFilename = Obj.getFileName();
912 sortAndPrintSymbolList(Obj, printName, ArchiveName, ArchitectureName);
915 // checkMachOAndArchFlags() checks to see if the SymbolicFile is a Mach-O file
916 // and if it is and there is a list of architecture flags is specified then
917 // check to make sure this Mach-O file is one of those architectures or all
918 // architectures was specificed. If not then an error is generated and this
919 // routine returns false. Else it returns true.
920 static bool checkMachOAndArchFlags(SymbolicFile *O, std::string &Filename) {
921 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(O);
923 if (!MachO || ArchAll || ArchFlags.size() == 0)
926 MachO::mach_header H;
927 MachO::mach_header_64 H_64;
929 if (MachO->is64Bit()) {
930 H_64 = MachO->MachOObjectFile::getHeader64();
931 T = MachOObjectFile::getArch(H_64.cputype, H_64.cpusubtype);
933 H = MachO->MachOObjectFile::getHeader();
934 T = MachOObjectFile::getArch(H.cputype, H.cpusubtype);
937 ArchFlags.begin(), ArchFlags.end(),
938 [&](const std::string &Name) { return Name == T.getArchName(); })) {
939 error("No architecture specified", Filename);
945 static void dumpSymbolNamesFromFile(std::string &Filename) {
946 ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
947 MemoryBuffer::getFileOrSTDIN(Filename);
948 if (error(BufferOrErr.getError(), Filename))
951 LLVMContext &Context = getGlobalContext();
952 ErrorOr<std::unique_ptr<Binary>> BinaryOrErr = createBinary(
953 BufferOrErr.get()->getMemBufferRef(), NoLLVMBitcode ? nullptr : &Context);
954 if (error(BinaryOrErr.getError(), Filename))
956 Binary &Bin = *BinaryOrErr.get();
958 if (Archive *A = dyn_cast<Archive>(&Bin)) {
960 Archive::symbol_iterator I = A->symbol_begin();
961 Archive::symbol_iterator E = A->symbol_end();
963 outs() << "Archive map\n";
964 for (; I != E; ++I) {
965 ErrorOr<Archive::child_iterator> C = I->getMember();
966 if (error(C.getError()))
968 ErrorOr<StringRef> FileNameOrErr = C.get()->getName();
969 if (error(FileNameOrErr.getError()))
971 StringRef SymName = I->getName();
972 outs() << SymName << " in " << FileNameOrErr.get() << "\n";
978 for (Archive::child_iterator I = A->child_begin(), E = A->child_end();
980 ErrorOr<std::unique_ptr<Binary>> ChildOrErr = I->getAsBinary(&Context);
981 if (ChildOrErr.getError())
983 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
984 if (!checkMachOAndArchFlags(O, Filename))
986 if (!PrintFileName) {
988 if (isa<MachOObjectFile>(O)) {
989 outs() << Filename << "(" << O->getFileName() << ")";
991 outs() << O->getFileName();
994 dumpSymbolNamesFromObject(*O, false, Filename);
999 if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(&Bin)) {
1000 // If we have a list of architecture flags specified dump only those.
1001 if (!ArchAll && ArchFlags.size() != 0) {
1002 // Look for a slice in the universal binary that matches each ArchFlag.
1004 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
1006 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1007 E = UB->end_objects();
1009 if (ArchFlags[i] == I->getArchTypeName()) {
1011 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr =
1012 I->getAsObjectFile();
1013 std::string ArchiveName;
1014 std::string ArchitectureName;
1015 ArchiveName.clear();
1016 ArchitectureName.clear();
1018 ObjectFile &Obj = *ObjOrErr.get();
1019 if (ArchFlags.size() > 1) {
1021 ArchitectureName = I->getArchTypeName();
1023 outs() << "\n" << Obj.getFileName() << " (for architecture "
1024 << I->getArchTypeName() << ")"
1027 dumpSymbolNamesFromObject(Obj, false, ArchiveName,
1029 } else if (ErrorOr<std::unique_ptr<Archive>> AOrErr =
1030 I->getAsArchive()) {
1031 std::unique_ptr<Archive> &A = *AOrErr;
1032 for (Archive::child_iterator AI = A->child_begin(),
1033 AE = A->child_end();
1035 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
1036 AI->getAsBinary(&Context);
1037 if (ChildOrErr.getError())
1039 if (SymbolicFile *O =
1040 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1041 if (PrintFileName) {
1042 ArchiveName = A->getFileName();
1043 if (ArchFlags.size() > 1)
1044 ArchitectureName = I->getArchTypeName();
1046 outs() << "\n" << A->getFileName();
1047 outs() << "(" << O->getFileName() << ")";
1048 if (ArchFlags.size() > 1) {
1049 outs() << " (for architecture " << I->getArchTypeName()
1054 dumpSymbolNamesFromObject(*O, false, ArchiveName,
1063 "file: " + Filename + " does not contain architecture");
1069 // No architecture flags were specified so if this contains a slice that
1070 // matches the host architecture dump only that.
1072 StringRef HostArchName = MachOObjectFile::getHostArch().getArchName();
1073 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1074 E = UB->end_objects();
1076 if (HostArchName == I->getArchTypeName()) {
1077 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
1078 std::string ArchiveName;
1079 ArchiveName.clear();
1081 ObjectFile &Obj = *ObjOrErr.get();
1082 dumpSymbolNamesFromObject(Obj, false);
1083 } else if (ErrorOr<std::unique_ptr<Archive>> AOrErr =
1084 I->getAsArchive()) {
1085 std::unique_ptr<Archive> &A = *AOrErr;
1086 for (Archive::child_iterator AI = A->child_begin(),
1087 AE = A->child_end();
1089 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
1090 AI->getAsBinary(&Context);
1091 if (ChildOrErr.getError())
1093 if (SymbolicFile *O =
1094 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1096 ArchiveName = A->getFileName();
1098 outs() << "\n" << A->getFileName() << "(" << O->getFileName()
1101 dumpSymbolNamesFromObject(*O, false, ArchiveName);
1109 // Either all architectures have been specified or none have been specified
1110 // and this does not contain the host architecture so dump all the slices.
1111 bool moreThanOneArch = UB->getNumberOfObjects() > 1;
1112 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1113 E = UB->end_objects();
1115 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
1116 std::string ArchiveName;
1117 std::string ArchitectureName;
1118 ArchiveName.clear();
1119 ArchitectureName.clear();
1121 ObjectFile &Obj = *ObjOrErr.get();
1122 if (PrintFileName) {
1123 if (isa<MachOObjectFile>(Obj) && moreThanOneArch)
1124 ArchitectureName = I->getArchTypeName();
1126 if (moreThanOneArch)
1128 outs() << Obj.getFileName();
1129 if (isa<MachOObjectFile>(Obj) && moreThanOneArch)
1130 outs() << " (for architecture " << I->getArchTypeName() << ")";
1133 dumpSymbolNamesFromObject(Obj, false, ArchiveName, ArchitectureName);
1134 } else if (ErrorOr<std::unique_ptr<Archive>> AOrErr = I->getAsArchive()) {
1135 std::unique_ptr<Archive> &A = *AOrErr;
1136 for (Archive::child_iterator AI = A->child_begin(), AE = A->child_end();
1138 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
1139 AI->getAsBinary(&Context);
1140 if (ChildOrErr.getError())
1142 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1143 if (PrintFileName) {
1144 ArchiveName = A->getFileName();
1145 if (isa<MachOObjectFile>(O) && moreThanOneArch)
1146 ArchitectureName = I->getArchTypeName();
1148 outs() << "\n" << A->getFileName();
1149 if (isa<MachOObjectFile>(O)) {
1150 outs() << "(" << O->getFileName() << ")";
1151 if (moreThanOneArch)
1152 outs() << " (for architecture " << I->getArchTypeName()
1155 outs() << ":" << O->getFileName();
1158 dumpSymbolNamesFromObject(*O, false, ArchiveName, ArchitectureName);
1165 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&Bin)) {
1166 if (!checkMachOAndArchFlags(O, Filename))
1168 dumpSymbolNamesFromObject(*O, true);
1171 error("unrecognizable file type", Filename);
1175 int main(int argc, char **argv) {
1176 // Print a stack trace if we signal out.
1177 sys::PrintStackTraceOnErrorSignal();
1178 PrettyStackTraceProgram X(argc, argv);
1180 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
1181 cl::ParseCommandLineOptions(argc, argv, "llvm symbol table dumper\n");
1183 // llvm-nm only reads binary files.
1184 if (error(sys::ChangeStdinToBinary()))
1187 llvm::InitializeAllTargetInfos();
1188 llvm::InitializeAllTargetMCs();
1189 llvm::InitializeAllAsmParsers();
1195 OutputFormat = posix;
1197 OutputFormat = darwin;
1199 // The relative order of these is important. If you pass --size-sort it should
1200 // only print out the size. However, if you pass -S --size-sort, it should
1201 // print out both the size and address.
1202 if (SizeSort && !PrintSize)
1203 PrintAddress = false;
1204 if (OutputFormat == sysv || SizeSort)
1207 switch (InputFilenames.size()) {
1209 InputFilenames.push_back("a.out");
1213 MultipleFiles = true;
1216 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
1217 if (ArchFlags[i] == "all") {
1220 if (!MachOObjectFile::isValidArch(ArchFlags[i]))
1221 error("Unknown architecture named '" + ArchFlags[i] + "'",
1222 "for the -arch option");
1226 if (SegSect.size() != 0 && SegSect.size() != 2)
1227 error("bad number of arguments (must be two arguments)",
1228 "for the -s option");
1230 std::for_each(InputFilenames.begin(), InputFilenames.end(),
1231 dumpSymbolNamesFromFile);