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) {
189 if (A.Address < B.Address)
191 if (A.Address == B.Address && A.Name < B.Name)
193 if (A.Address == B.Address && A.Name == B.Name && A.Size < B.Size)
198 if (A.Address > B.Address)
200 if (A.Address == B.Address && A.Name > B.Name)
202 if (A.Address == B.Address && A.Name == B.Name && A.Size > B.Size)
207 static bool compareSymbolSize(const NMSymbol &A, const NMSymbol &B) {
211 if (A.Size == B.Size && A.Name < B.Name)
213 if (A.Size == B.Size && A.Name == B.Name && A.Address < B.Address)
220 if (A.Size == B.Size && A.Name > B.Name)
222 if (A.Size == B.Size && A.Name == B.Name && A.Address > B.Address)
227 static bool compareSymbolName(const NMSymbol &A, const NMSymbol &B) {
231 if (A.Name == B.Name && A.Size < B.Size)
233 if (A.Name == B.Name && A.Size == B.Size && A.Address < B.Address)
239 if (A.Name == B.Name && A.Size > B.Size)
241 if (A.Name == B.Name && A.Size == B.Size && A.Address > B.Address)
246 static char isSymbolList64Bit(SymbolicFile &Obj) {
247 if (isa<IRObjectFile>(Obj))
249 if (isa<COFFObjectFile>(Obj))
251 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj))
252 return MachO->is64Bit();
253 return cast<ELFObjectFileBase>(Obj).getBytesInAddress() == 8;
256 static StringRef CurrentFilename;
257 typedef std::vector<NMSymbol> SymbolListT;
258 static SymbolListT SymbolList;
260 // darwinPrintSymbol() is used to print a symbol from a Mach-O file when the
261 // the OutputFormat is darwin or we are printing Mach-O symbols in hex. For
262 // the darwin format it produces the same output as darwin's nm(1) -m output
263 // and when printing Mach-O symbols in hex it produces the same output as
264 // darwin's nm(1) -x format.
265 static void darwinPrintSymbol(MachOObjectFile *MachO, SymbolListT::iterator I,
266 char *SymbolAddrStr, const char *printBlanks) {
267 MachO::mach_header H;
268 MachO::mach_header_64 H_64;
269 uint32_t Filetype, Flags;
270 MachO::nlist_64 STE_64;
277 if (MachO->is64Bit()) {
278 H_64 = MachO->MachOObjectFile::getHeader64();
279 Filetype = H_64.filetype;
281 STE_64 = MachO->getSymbol64TableEntry(I->Symb);
282 NType = STE_64.n_type;
283 NSect = STE_64.n_sect;
284 NDesc = STE_64.n_desc;
285 NStrx = STE_64.n_strx;
286 NValue = STE_64.n_value;
288 H = MachO->MachOObjectFile::getHeader();
289 Filetype = H.filetype;
291 STE = MachO->getSymbolTableEntry(I->Symb);
296 NValue = STE.n_value;
299 // If we are printing Mach-O symbols in hex do that and return.
300 if (FormatMachOasHex) {
302 const char *printFormat;
303 if (MachO->is64Bit())
304 printFormat = "%016" PRIx64;
306 printFormat = "%08" PRIx64;
307 format(printFormat, NValue).print(Str, sizeof(Str));
308 outs() << Str << ' ';
309 format("%02x", NType).print(Str, sizeof(Str));
310 outs() << Str << ' ';
311 format("%02x", NSect).print(Str, sizeof(Str));
312 outs() << Str << ' ';
313 format("%04x", NDesc).print(Str, sizeof(Str));
314 outs() << Str << ' ';
315 format("%08x", NStrx).print(Str, sizeof(Str));
316 outs() << Str << ' ';
317 outs() << I->Name << "\n";
322 if ((NType & MachO::N_TYPE) == MachO::N_INDR)
323 strcpy(SymbolAddrStr, printBlanks);
324 outs() << SymbolAddrStr << ' ';
327 switch (NType & MachO::N_TYPE) {
330 outs() << "(common) ";
331 if (MachO::GET_COMM_ALIGN(NDesc) != 0)
332 outs() << "(alignment 2^" << (int)MachO::GET_COMM_ALIGN(NDesc) << ") ";
334 if ((NType & MachO::N_TYPE) == MachO::N_PBUD)
335 outs() << "(prebound ";
338 if ((NDesc & MachO::REFERENCE_TYPE) ==
339 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
340 outs() << "undefined [lazy bound]) ";
341 else if ((NDesc & MachO::REFERENCE_TYPE) ==
342 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
343 outs() << "undefined [private lazy bound]) ";
344 else if ((NDesc & MachO::REFERENCE_TYPE) ==
345 MachO::REFERENCE_FLAG_PRIVATE_UNDEFINED_NON_LAZY)
346 outs() << "undefined [private]) ";
348 outs() << "undefined) ";
352 outs() << "(absolute) ";
355 outs() << "(indirect) ";
357 case MachO::N_SECT: {
358 section_iterator Sec = MachO->section_end();
359 MachO->getSymbolSection(I->Symb, Sec);
360 DataRefImpl Ref = Sec->getRawDataRefImpl();
361 StringRef SectionName;
362 MachO->getSectionName(Ref, SectionName);
363 StringRef SegmentName = MachO->getSectionFinalSegmentName(Ref);
364 outs() << "(" << SegmentName << "," << SectionName << ") ";
372 if (NType & MachO::N_EXT) {
373 if (NDesc & MachO::REFERENCED_DYNAMICALLY)
374 outs() << "[referenced dynamically] ";
375 if (NType & MachO::N_PEXT) {
376 if ((NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF)
377 outs() << "weak private external ";
379 outs() << "private external ";
381 if ((NDesc & MachO::N_WEAK_REF) == MachO::N_WEAK_REF ||
382 (NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF) {
383 if ((NDesc & (MachO::N_WEAK_REF | MachO::N_WEAK_DEF)) ==
384 (MachO::N_WEAK_REF | MachO::N_WEAK_DEF))
385 outs() << "weak external automatically hidden ";
387 outs() << "weak external ";
389 outs() << "external ";
392 if (NType & MachO::N_PEXT)
393 outs() << "non-external (was a private external) ";
395 outs() << "non-external ";
398 if (Filetype == MachO::MH_OBJECT &&
399 (NDesc & MachO::N_NO_DEAD_STRIP) == MachO::N_NO_DEAD_STRIP)
400 outs() << "[no dead strip] ";
402 if (Filetype == MachO::MH_OBJECT &&
403 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
404 (NDesc & MachO::N_SYMBOL_RESOLVER) == MachO::N_SYMBOL_RESOLVER)
405 outs() << "[symbol resolver] ";
407 if (Filetype == MachO::MH_OBJECT &&
408 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
409 (NDesc & MachO::N_ALT_ENTRY) == MachO::N_ALT_ENTRY)
410 outs() << "[alt entry] ";
412 if ((NDesc & MachO::N_ARM_THUMB_DEF) == MachO::N_ARM_THUMB_DEF)
413 outs() << "[Thumb] ";
415 if ((NType & MachO::N_TYPE) == MachO::N_INDR) {
416 outs() << I->Name << " (for ";
417 StringRef IndirectName;
418 if (MachO->getIndirectName(I->Symb, IndirectName))
421 outs() << IndirectName << ")";
425 if ((Flags & MachO::MH_TWOLEVEL) == MachO::MH_TWOLEVEL &&
426 (((NType & MachO::N_TYPE) == MachO::N_UNDF && NValue == 0) ||
427 (NType & MachO::N_TYPE) == MachO::N_PBUD)) {
428 uint32_t LibraryOrdinal = MachO::GET_LIBRARY_ORDINAL(NDesc);
429 if (LibraryOrdinal != 0) {
430 if (LibraryOrdinal == MachO::EXECUTABLE_ORDINAL)
431 outs() << " (from executable)";
432 else if (LibraryOrdinal == MachO::DYNAMIC_LOOKUP_ORDINAL)
433 outs() << " (dynamically looked up)";
435 StringRef LibraryName;
436 if (MachO->getLibraryShortNameByIndex(LibraryOrdinal - 1, LibraryName))
437 outs() << " (from bad library ordinal " << LibraryOrdinal << ")";
439 outs() << " (from " << LibraryName << ")";
447 // Table that maps Darwin's Mach-O stab constants to strings to allow printing.
448 struct DarwinStabName {
452 static const struct DarwinStabName DarwinStabNames[] = {
453 {MachO::N_GSYM, "GSYM"},
454 {MachO::N_FNAME, "FNAME"},
455 {MachO::N_FUN, "FUN"},
456 {MachO::N_STSYM, "STSYM"},
457 {MachO::N_LCSYM, "LCSYM"},
458 {MachO::N_BNSYM, "BNSYM"},
460 {MachO::N_AST, "AST"},
461 {MachO::N_OPT, "OPT"},
462 {MachO::N_RSYM, "RSYM"},
463 {MachO::N_SLINE, "SLINE"},
464 {MachO::N_ENSYM, "ENSYM"},
465 {MachO::N_SSYM, "SSYM"},
467 {MachO::N_OSO, "OSO"},
468 {MachO::N_LSYM, "LSYM"},
469 {MachO::N_BINCL, "BINCL"},
470 {MachO::N_SOL, "SOL"},
471 {MachO::N_PARAMS, "PARAM"},
472 {MachO::N_VERSION, "VERS"},
473 {MachO::N_OLEVEL, "OLEV"},
474 {MachO::N_PSYM, "PSYM"},
475 {MachO::N_EINCL, "EINCL"},
476 {MachO::N_ENTRY, "ENTRY"},
477 {MachO::N_LBRAC, "LBRAC"},
478 {MachO::N_EXCL, "EXCL"},
479 {MachO::N_RBRAC, "RBRAC"},
480 {MachO::N_BCOMM, "BCOMM"},
481 {MachO::N_ECOMM, "ECOMM"},
482 {MachO::N_ECOML, "ECOML"},
483 {MachO::N_LENG, "LENG"},
485 static const char *getDarwinStabString(uint8_t NType) {
486 for (unsigned i = 0; DarwinStabNames[i].Name; i++) {
487 if (DarwinStabNames[i].NType == NType)
488 return DarwinStabNames[i].Name;
493 // darwinPrintStab() prints the n_sect, n_desc along with a symbolic name of
494 // a stab n_type value in a Mach-O file.
495 static void darwinPrintStab(MachOObjectFile *MachO, SymbolListT::iterator I) {
496 MachO::nlist_64 STE_64;
501 if (MachO->is64Bit()) {
502 STE_64 = MachO->getSymbol64TableEntry(I->Symb);
503 NType = STE_64.n_type;
504 NSect = STE_64.n_sect;
505 NDesc = STE_64.n_desc;
507 STE = MachO->getSymbolTableEntry(I->Symb);
514 format("%02x", NSect).print(Str, sizeof(Str));
515 outs() << ' ' << Str << ' ';
516 format("%04x", NDesc).print(Str, sizeof(Str));
517 outs() << Str << ' ';
518 if (const char *stabString = getDarwinStabString(NType))
519 format("%5.5s", stabString).print(Str, sizeof(Str));
521 format(" %02x", NType).print(Str, sizeof(Str));
525 static void sortAndPrintSymbolList(SymbolicFile &Obj, bool printName,
526 std::string ArchiveName,
527 std::string ArchitectureName) {
530 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolAddress);
532 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolSize);
534 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolName);
537 if (!PrintFileName) {
538 if (OutputFormat == posix && MultipleFiles && printName) {
539 outs() << '\n' << CurrentFilename << ":\n";
540 } else if (OutputFormat == bsd && MultipleFiles && printName) {
541 outs() << "\n" << CurrentFilename << ":\n";
542 } else if (OutputFormat == sysv) {
543 outs() << "\n\nSymbols from " << CurrentFilename << ":\n\n"
544 << "Name Value Class Type"
545 << " Size Line Section\n";
549 const char *printBlanks, *printFormat;
550 if (isSymbolList64Bit(Obj)) {
552 printFormat = "%016" PRIx64;
555 printFormat = "%08" PRIx64;
558 for (SymbolListT::iterator I = SymbolList.begin(), E = SymbolList.end();
560 if ((I->TypeChar != 'U') && UndefinedOnly)
562 if ((I->TypeChar == 'U') && DefinedOnly)
564 if (SizeSort && !PrintAddress)
567 if (!ArchitectureName.empty())
568 outs() << "(for architecture " << ArchitectureName << "):";
569 if (!ArchiveName.empty())
570 outs() << ArchiveName << ":";
571 outs() << CurrentFilename << ": ";
573 if (JustSymbolName || (UndefinedOnly && isa<MachOObjectFile>(Obj))) {
574 outs() << I->Name << "\n";
578 char SymbolAddrStr[18] = "";
579 char SymbolSizeStr[18] = "";
581 if (OutputFormat == sysv || I->Address == UnknownAddress)
582 strcpy(SymbolAddrStr, printBlanks);
583 if (OutputFormat == sysv)
584 strcpy(SymbolSizeStr, printBlanks);
586 if (I->Address != UnknownAddress)
587 format(printFormat, I->Address)
588 .print(SymbolAddrStr, sizeof(SymbolAddrStr));
589 format(printFormat, I->Size).print(SymbolSizeStr, sizeof(SymbolSizeStr));
591 // If OutputFormat is darwin or we are printing Mach-O symbols in hex and
592 // we have a MachOObjectFile, call darwinPrintSymbol to print as darwin's
593 // nm(1) -m output or hex, else if OutputFormat is darwin or we are
594 // printing Mach-O symbols in hex and not a Mach-O object fall back to
595 // OutputFormat bsd (see below).
596 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
597 if ((OutputFormat == darwin || FormatMachOasHex) && MachO) {
598 darwinPrintSymbol(MachO, I, SymbolAddrStr, printBlanks);
599 } else if (OutputFormat == posix) {
600 outs() << I->Name << " " << I->TypeChar << " " << SymbolAddrStr
601 << SymbolSizeStr << "\n";
602 } else if (OutputFormat == bsd || (OutputFormat == darwin && !MachO)) {
604 outs() << SymbolAddrStr << ' ';
606 outs() << SymbolSizeStr;
609 outs() << I->TypeChar;
610 if (I->TypeChar == '-' && MachO)
611 darwinPrintStab(MachO, I);
612 outs() << " " << I->Name << "\n";
613 } else if (OutputFormat == sysv) {
614 std::string PaddedName(I->Name);
615 while (PaddedName.length() < 20)
617 outs() << PaddedName << "|" << SymbolAddrStr << "| " << I->TypeChar
618 << " | |" << SymbolSizeStr << "| |\n";
625 static char getSymbolNMTypeChar(ELFObjectFileBase &Obj,
626 basic_symbol_iterator I) {
628 elf_symbol_iterator SymI(I);
630 elf_section_iterator SecI = Obj.section_end();
631 if (error(SymI->getSection(SecI)))
634 if (SecI != Obj.section_end()) {
635 switch (SecI->getType()) {
636 case ELF::SHT_PROGBITS:
637 case ELF::SHT_DYNAMIC:
638 switch (SecI->getFlags()) {
639 case (ELF::SHF_ALLOC | ELF::SHF_EXECINSTR):
641 case (ELF::SHF_TLS | ELF::SHF_ALLOC | ELF::SHF_WRITE):
642 case (ELF::SHF_ALLOC | ELF::SHF_WRITE):
645 case (ELF::SHF_ALLOC | ELF::SHF_MERGE):
646 case (ELF::SHF_ALLOC | ELF::SHF_MERGE | ELF::SHF_STRINGS):
650 case ELF::SHT_NOBITS:
655 if (SymI->getELFType() == ELF::STT_SECTION) {
657 if (error(SymI->getName(Name)))
659 return StringSwitch<char>(Name)
660 .StartsWith(".debug", 'N')
661 .StartsWith(".note", 'n')
668 static char getSymbolNMTypeChar(COFFObjectFile &Obj, symbol_iterator I) {
669 COFFSymbolRef Symb = Obj.getCOFFSymbol(*I);
671 symbol_iterator SymI(I);
674 if (error(SymI->getName(Name)))
677 char Ret = StringSwitch<char>(Name)
678 .StartsWith(".debug", 'N')
679 .StartsWith(".sxdata", 'N')
685 uint32_t Characteristics = 0;
686 if (!COFF::isReservedSectionNumber(Symb.getSectionNumber())) {
687 section_iterator SecI = Obj.section_end();
688 if (error(SymI->getSection(SecI)))
690 const coff_section *Section = Obj.getCOFFSection(*SecI);
691 Characteristics = Section->Characteristics;
694 switch (Symb.getSectionNumber()) {
695 case COFF::IMAGE_SYM_DEBUG:
698 // Check section type.
699 if (Characteristics & COFF::IMAGE_SCN_CNT_CODE)
701 if (Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
702 return Characteristics & COFF::IMAGE_SCN_MEM_WRITE ? 'd' : 'r';
703 if (Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)
705 if (Characteristics & COFF::IMAGE_SCN_LNK_INFO)
707 // Check for section symbol.
708 if (Symb.isSectionDefinition())
715 static uint8_t getNType(MachOObjectFile &Obj, DataRefImpl Symb) {
717 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
720 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
724 static char getSymbolNMTypeChar(MachOObjectFile &Obj, basic_symbol_iterator I) {
725 DataRefImpl Symb = I->getRawDataRefImpl();
726 uint8_t NType = getNType(Obj, Symb);
728 if (NType & MachO::N_STAB)
731 switch (NType & MachO::N_TYPE) {
736 case MachO::N_SECT: {
737 section_iterator Sec = Obj.section_end();
738 Obj.getSymbolSection(Symb, Sec);
739 DataRefImpl Ref = Sec->getRawDataRefImpl();
740 StringRef SectionName;
741 Obj.getSectionName(Ref, SectionName);
742 StringRef SegmentName = Obj.getSectionFinalSegmentName(Ref);
743 if (SegmentName == "__TEXT" && SectionName == "__text")
745 else if (SegmentName == "__DATA" && SectionName == "__data")
747 else if (SegmentName == "__DATA" && SectionName == "__bss")
757 static char getSymbolNMTypeChar(const GlobalValue &GV) {
758 if (GV.getType()->getElementType()->isFunctionTy())
760 // FIXME: should we print 'b'? At the IR level we cannot be sure if this
761 // will be in bss or not, but we could approximate.
765 static char getSymbolNMTypeChar(IRObjectFile &Obj, basic_symbol_iterator I) {
766 const GlobalValue *GV = Obj.getSymbolGV(I->getRawDataRefImpl());
769 return getSymbolNMTypeChar(*GV);
772 static bool isObject(SymbolicFile &Obj, basic_symbol_iterator I) {
773 auto *ELF = dyn_cast<ELFObjectFileBase>(&Obj);
777 return elf_symbol_iterator(I)->getELFType() == ELF::STT_OBJECT;
780 static char getNMTypeChar(SymbolicFile &Obj, basic_symbol_iterator I) {
781 uint32_t Symflags = I->getFlags();
782 if ((Symflags & object::SymbolRef::SF_Weak) && !isa<MachOObjectFile>(Obj)) {
783 char Ret = isObject(Obj, I) ? 'v' : 'w';
784 if (!(Symflags & object::SymbolRef::SF_Undefined))
789 if (Symflags & object::SymbolRef::SF_Undefined)
792 if (Symflags & object::SymbolRef::SF_Common)
796 if (Symflags & object::SymbolRef::SF_Absolute)
798 else if (IRObjectFile *IR = dyn_cast<IRObjectFile>(&Obj))
799 Ret = getSymbolNMTypeChar(*IR, I);
800 else if (COFFObjectFile *COFF = dyn_cast<COFFObjectFile>(&Obj))
801 Ret = getSymbolNMTypeChar(*COFF, I);
802 else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj))
803 Ret = getSymbolNMTypeChar(*MachO, I);
805 Ret = getSymbolNMTypeChar(cast<ELFObjectFileBase>(Obj), I);
807 if (Symflags & object::SymbolRef::SF_Global)
813 // getNsectForSegSect() is used to implement the Mach-O "-s segname sectname"
814 // option to dump only those symbols from that section in a Mach-O file.
815 // It is called once for each Mach-O file from dumpSymbolNamesFromObject()
816 // to get the section number for that named section from the command line
817 // arguments. It returns the section number for that section in the Mach-O
818 // file or zero it is not present.
819 static unsigned getNsectForSegSect(MachOObjectFile *Obj) {
821 for (section_iterator I = Obj->section_begin(), E = Obj->section_end();
823 DataRefImpl Ref = I->getRawDataRefImpl();
824 StringRef SectionName;
825 Obj->getSectionName(Ref, SectionName);
826 StringRef SegmentName = Obj->getSectionFinalSegmentName(Ref);
827 if (SegmentName == SegSect[0] && SectionName == SegSect[1])
834 // getNsectInMachO() is used to implement the Mach-O "-s segname sectname"
835 // option to dump only those symbols from that section in a Mach-O file.
836 // It is called once for each symbol in a Mach-O file from
837 // dumpSymbolNamesFromObject() and returns the section number for that symbol
838 // if it is in a section, else it returns 0.
839 static unsigned getNsectInMachO(MachOObjectFile &Obj, BasicSymbolRef Sym) {
840 DataRefImpl Symb = Sym.getRawDataRefImpl();
842 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
843 if ((STE.n_type & MachO::N_TYPE) == MachO::N_SECT)
847 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
848 if ((STE.n_type & MachO::N_TYPE) == MachO::N_SECT)
853 static void dumpSymbolNamesFromObject(SymbolicFile &Obj, bool printName,
854 std::string ArchiveName = std::string(),
855 std::string ArchitectureName =
857 auto Symbols = Obj.symbols();
859 const auto *E = dyn_cast<ELFObjectFileBase>(&Obj);
861 error("File format has no dynamic symbol table", Obj.getFileName());
864 auto DynSymbols = E->getDynamicSymbolIterators();
866 make_range<basic_symbol_iterator>(DynSymbols.begin(), DynSymbols.end());
868 std::string NameBuffer;
869 raw_string_ostream OS(NameBuffer);
870 // If a "-s segname sectname" option was specified and this is a Mach-O
871 // file get the section number for that section in this object file.
872 unsigned int Nsect = 0;
873 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
874 if (SegSect.size() != 0 && MachO) {
875 Nsect = getNsectForSegSect(MachO);
876 // If this section is not in the object file no symbols are printed.
880 for (BasicSymbolRef Sym : Symbols) {
881 uint32_t SymFlags = Sym.getFlags();
882 if (!DebugSyms && (SymFlags & SymbolRef::SF_FormatSpecific))
884 if (WithoutAliases) {
885 if (IRObjectFile *IR = dyn_cast<IRObjectFile>(&Obj)) {
886 const GlobalValue *GV = IR->getSymbolGV(Sym.getRawDataRefImpl());
887 if (GV && isa<GlobalAlias>(GV))
891 // If a "-s segname sectname" option was specified and this is a Mach-O
892 // file and this section appears in this file, Nsect will be non-zero then
893 // see if this symbol is a symbol from that section and if not skip it.
894 if (Nsect && Nsect != getNsectInMachO(*MachO, Sym))
898 S.Address = UnknownAddress;
900 if (isa<ELFObjectFileBase>(&Obj))
901 S.Size = ELFSymbolRef(Sym).getSize();
903 if (PrintAddress && isa<ObjectFile>(Obj)) {
904 if (error(SymbolRef(Sym).getAddress(S.Address)))
907 S.TypeChar = getNMTypeChar(Obj, Sym);
908 if (error(Sym.printName(OS)))
911 S.Symb = Sym.getRawDataRefImpl();
912 SymbolList.push_back(S);
916 const char *P = NameBuffer.c_str();
917 for (unsigned I = 0; I < SymbolList.size(); ++I) {
918 SymbolList[I].Name = P;
922 CurrentFilename = Obj.getFileName();
923 sortAndPrintSymbolList(Obj, printName, ArchiveName, ArchitectureName);
926 // checkMachOAndArchFlags() checks to see if the SymbolicFile is a Mach-O file
927 // and if it is and there is a list of architecture flags is specified then
928 // check to make sure this Mach-O file is one of those architectures or all
929 // architectures was specificed. If not then an error is generated and this
930 // routine returns false. Else it returns true.
931 static bool checkMachOAndArchFlags(SymbolicFile *O, std::string &Filename) {
932 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(O);
934 if (!MachO || ArchAll || ArchFlags.size() == 0)
937 MachO::mach_header H;
938 MachO::mach_header_64 H_64;
940 if (MachO->is64Bit()) {
941 H_64 = MachO->MachOObjectFile::getHeader64();
942 T = MachOObjectFile::getArch(H_64.cputype, H_64.cpusubtype);
944 H = MachO->MachOObjectFile::getHeader();
945 T = MachOObjectFile::getArch(H.cputype, H.cpusubtype);
948 ArchFlags.begin(), ArchFlags.end(),
949 [&](const std::string &Name) { return Name == T.getArchName(); })) {
950 error("No architecture specified", Filename);
956 static void dumpSymbolNamesFromFile(std::string &Filename) {
957 ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
958 MemoryBuffer::getFileOrSTDIN(Filename);
959 if (error(BufferOrErr.getError(), Filename))
962 LLVMContext &Context = getGlobalContext();
963 ErrorOr<std::unique_ptr<Binary>> BinaryOrErr = createBinary(
964 BufferOrErr.get()->getMemBufferRef(), NoLLVMBitcode ? nullptr : &Context);
965 if (error(BinaryOrErr.getError(), Filename))
967 Binary &Bin = *BinaryOrErr.get();
969 if (Archive *A = dyn_cast<Archive>(&Bin)) {
971 Archive::symbol_iterator I = A->symbol_begin();
972 Archive::symbol_iterator E = A->symbol_end();
974 outs() << "Archive map\n";
975 for (; I != E; ++I) {
976 ErrorOr<Archive::child_iterator> C = I->getMember();
977 if (error(C.getError()))
979 ErrorOr<StringRef> FileNameOrErr = C.get()->getName();
980 if (error(FileNameOrErr.getError()))
982 StringRef SymName = I->getName();
983 outs() << SymName << " in " << FileNameOrErr.get() << "\n";
989 for (Archive::child_iterator I = A->child_begin(), E = A->child_end();
991 ErrorOr<std::unique_ptr<Binary>> ChildOrErr = I->getAsBinary(&Context);
992 if (ChildOrErr.getError())
994 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
995 if (!checkMachOAndArchFlags(O, Filename))
997 if (!PrintFileName) {
999 if (isa<MachOObjectFile>(O)) {
1000 outs() << Filename << "(" << O->getFileName() << ")";
1002 outs() << O->getFileName();
1005 dumpSymbolNamesFromObject(*O, false, Filename);
1010 if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(&Bin)) {
1011 // If we have a list of architecture flags specified dump only those.
1012 if (!ArchAll && ArchFlags.size() != 0) {
1013 // Look for a slice in the universal binary that matches each ArchFlag.
1015 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
1017 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1018 E = UB->end_objects();
1020 if (ArchFlags[i] == I->getArchTypeName()) {
1022 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr =
1023 I->getAsObjectFile();
1024 std::string ArchiveName;
1025 std::string ArchitectureName;
1026 ArchiveName.clear();
1027 ArchitectureName.clear();
1029 ObjectFile &Obj = *ObjOrErr.get();
1030 if (ArchFlags.size() > 1) {
1032 ArchitectureName = I->getArchTypeName();
1034 outs() << "\n" << Obj.getFileName() << " (for architecture "
1035 << I->getArchTypeName() << ")"
1038 dumpSymbolNamesFromObject(Obj, false, ArchiveName,
1040 } else if (ErrorOr<std::unique_ptr<Archive>> AOrErr =
1041 I->getAsArchive()) {
1042 std::unique_ptr<Archive> &A = *AOrErr;
1043 for (Archive::child_iterator AI = A->child_begin(),
1044 AE = A->child_end();
1046 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
1047 AI->getAsBinary(&Context);
1048 if (ChildOrErr.getError())
1050 if (SymbolicFile *O =
1051 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1052 if (PrintFileName) {
1053 ArchiveName = A->getFileName();
1054 if (ArchFlags.size() > 1)
1055 ArchitectureName = I->getArchTypeName();
1057 outs() << "\n" << A->getFileName();
1058 outs() << "(" << O->getFileName() << ")";
1059 if (ArchFlags.size() > 1) {
1060 outs() << " (for architecture " << I->getArchTypeName()
1065 dumpSymbolNamesFromObject(*O, false, ArchiveName,
1074 "file: " + Filename + " does not contain architecture");
1080 // No architecture flags were specified so if this contains a slice that
1081 // matches the host architecture dump only that.
1083 StringRef HostArchName = MachOObjectFile::getHostArch().getArchName();
1084 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1085 E = UB->end_objects();
1087 if (HostArchName == I->getArchTypeName()) {
1088 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
1089 std::string ArchiveName;
1090 ArchiveName.clear();
1092 ObjectFile &Obj = *ObjOrErr.get();
1093 dumpSymbolNamesFromObject(Obj, false);
1094 } else if (ErrorOr<std::unique_ptr<Archive>> AOrErr =
1095 I->getAsArchive()) {
1096 std::unique_ptr<Archive> &A = *AOrErr;
1097 for (Archive::child_iterator AI = A->child_begin(),
1098 AE = A->child_end();
1100 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
1101 AI->getAsBinary(&Context);
1102 if (ChildOrErr.getError())
1104 if (SymbolicFile *O =
1105 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1107 ArchiveName = A->getFileName();
1109 outs() << "\n" << A->getFileName() << "(" << O->getFileName()
1112 dumpSymbolNamesFromObject(*O, false, ArchiveName);
1120 // Either all architectures have been specified or none have been specified
1121 // and this does not contain the host architecture so dump all the slices.
1122 bool moreThanOneArch = UB->getNumberOfObjects() > 1;
1123 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1124 E = UB->end_objects();
1126 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
1127 std::string ArchiveName;
1128 std::string ArchitectureName;
1129 ArchiveName.clear();
1130 ArchitectureName.clear();
1132 ObjectFile &Obj = *ObjOrErr.get();
1133 if (PrintFileName) {
1134 if (isa<MachOObjectFile>(Obj) && moreThanOneArch)
1135 ArchitectureName = I->getArchTypeName();
1137 if (moreThanOneArch)
1139 outs() << Obj.getFileName();
1140 if (isa<MachOObjectFile>(Obj) && moreThanOneArch)
1141 outs() << " (for architecture " << I->getArchTypeName() << ")";
1144 dumpSymbolNamesFromObject(Obj, false, ArchiveName, ArchitectureName);
1145 } else if (ErrorOr<std::unique_ptr<Archive>> AOrErr = I->getAsArchive()) {
1146 std::unique_ptr<Archive> &A = *AOrErr;
1147 for (Archive::child_iterator AI = A->child_begin(), AE = A->child_end();
1149 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
1150 AI->getAsBinary(&Context);
1151 if (ChildOrErr.getError())
1153 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1154 if (PrintFileName) {
1155 ArchiveName = A->getFileName();
1156 if (isa<MachOObjectFile>(O) && moreThanOneArch)
1157 ArchitectureName = I->getArchTypeName();
1159 outs() << "\n" << A->getFileName();
1160 if (isa<MachOObjectFile>(O)) {
1161 outs() << "(" << O->getFileName() << ")";
1162 if (moreThanOneArch)
1163 outs() << " (for architecture " << I->getArchTypeName()
1166 outs() << ":" << O->getFileName();
1169 dumpSymbolNamesFromObject(*O, false, ArchiveName, ArchitectureName);
1176 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&Bin)) {
1177 if (!checkMachOAndArchFlags(O, Filename))
1179 dumpSymbolNamesFromObject(*O, true);
1182 error("unrecognizable file type", Filename);
1186 int main(int argc, char **argv) {
1187 // Print a stack trace if we signal out.
1188 sys::PrintStackTraceOnErrorSignal();
1189 PrettyStackTraceProgram X(argc, argv);
1191 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
1192 cl::ParseCommandLineOptions(argc, argv, "llvm symbol table dumper\n");
1194 // llvm-nm only reads binary files.
1195 if (error(sys::ChangeStdinToBinary()))
1198 llvm::InitializeAllTargetInfos();
1199 llvm::InitializeAllTargetMCs();
1200 llvm::InitializeAllAsmParsers();
1206 OutputFormat = posix;
1208 OutputFormat = darwin;
1210 // The relative order of these is important. If you pass --size-sort it should
1211 // only print out the size. However, if you pass -S --size-sort, it should
1212 // print out both the size and address.
1213 if (SizeSort && !PrintSize)
1214 PrintAddress = false;
1215 if (OutputFormat == sysv || SizeSort)
1218 switch (InputFilenames.size()) {
1220 InputFilenames.push_back("a.out");
1224 MultipleFiles = true;
1227 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
1228 if (ArchFlags[i] == "all") {
1231 if (!MachOObjectFile::isValidArch(ArchFlags[i]))
1232 error("Unknown architecture named '" + ArchFlags[i] + "'",
1233 "for the -arch option");
1237 if (SegSect.size() != 0 && SegSect.size() != 2)
1238 error("bad number of arguments (must be two arguments)",
1239 "for the -s option");
1241 std::for_each(InputFilenames.begin(), InputFilenames.end(),
1242 dumpSymbolNamesFromFile);