1 //===-- llvm-nm.cpp - Symbol table dumping utility for llvm ---------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This program is a utility that works like traditional Unix "nm", that is, it
11 // prints out the names of symbols in a bitcode or object file, along with some
12 // information about each symbol.
14 // This "nm" supports many of the features of GNU "nm", including its different
17 //===----------------------------------------------------------------------===//
19 #include "llvm/IR/Function.h"
20 #include "llvm/IR/GlobalAlias.h"
21 #include "llvm/IR/GlobalVariable.h"
22 #include "llvm/IR/LLVMContext.h"
23 #include "llvm/Object/Archive.h"
24 #include "llvm/Object/COFF.h"
25 #include "llvm/Object/ELFObjectFile.h"
26 #include "llvm/Object/IRObjectFile.h"
27 #include "llvm/Object/MachO.h"
28 #include "llvm/Object/MachOUniversal.h"
29 #include "llvm/Object/ObjectFile.h"
30 #include "llvm/Support/COFF.h"
31 #include "llvm/Support/CommandLine.h"
32 #include "llvm/Support/FileSystem.h"
33 #include "llvm/Support/Format.h"
34 #include "llvm/Support/ManagedStatic.h"
35 #include "llvm/Support/MemoryBuffer.h"
36 #include "llvm/Support/PrettyStackTrace.h"
37 #include "llvm/Support/Program.h"
38 #include "llvm/Support/Signals.h"
39 #include "llvm/Support/raw_ostream.h"
44 #include <system_error>
47 using namespace object;
50 enum OutputFormatTy { bsd, sysv, posix, darwin };
51 cl::opt<OutputFormatTy> OutputFormat(
52 "format", cl::desc("Specify output format"),
53 cl::values(clEnumVal(bsd, "BSD format"), clEnumVal(sysv, "System V format"),
54 clEnumVal(posix, "POSIX.2 format"),
55 clEnumVal(darwin, "Darwin -m format"), clEnumValEnd),
57 cl::alias OutputFormat2("f", cl::desc("Alias for --format"),
58 cl::aliasopt(OutputFormat));
60 cl::list<std::string> InputFilenames(cl::Positional, cl::desc("<input files>"),
63 cl::opt<bool> UndefinedOnly("undefined-only",
64 cl::desc("Show only undefined symbols"));
65 cl::alias UndefinedOnly2("u", cl::desc("Alias for --undefined-only"),
66 cl::aliasopt(UndefinedOnly));
68 cl::opt<bool> DynamicSyms("dynamic",
69 cl::desc("Display the dynamic symbols instead "
70 "of normal symbols."));
71 cl::alias DynamicSyms2("D", cl::desc("Alias for --dynamic"),
72 cl::aliasopt(DynamicSyms));
74 cl::opt<bool> DefinedOnly("defined-only",
75 cl::desc("Show only defined symbols"));
76 cl::alias DefinedOnly2("U", cl::desc("Alias for --defined-only"),
77 cl::aliasopt(DefinedOnly));
79 cl::opt<bool> ExternalOnly("extern-only",
80 cl::desc("Show only external symbols"));
81 cl::alias ExternalOnly2("g", cl::desc("Alias for --extern-only"),
82 cl::aliasopt(ExternalOnly));
84 cl::opt<bool> BSDFormat("B", cl::desc("Alias for --format=bsd"));
85 cl::opt<bool> POSIXFormat("P", cl::desc("Alias for --format=posix"));
86 cl::opt<bool> DarwinFormat("m", cl::desc("Alias for --format=darwin"));
88 static cl::list<std::string>
89 ArchFlags("arch", cl::desc("architecture(s) from a Mach-O file to dump"),
93 cl::opt<bool> PrintFileName(
95 cl::desc("Precede each symbol with the object file it came from"));
97 cl::alias PrintFileNameA("A", cl::desc("Alias for --print-file-name"),
98 cl::aliasopt(PrintFileName));
99 cl::alias PrintFileNameo("o", cl::desc("Alias for --print-file-name"),
100 cl::aliasopt(PrintFileName));
102 cl::opt<bool> DebugSyms("debug-syms",
103 cl::desc("Show all symbols, even debugger only"));
104 cl::alias DebugSymsa("a", cl::desc("Alias for --debug-syms"),
105 cl::aliasopt(DebugSyms));
107 cl::opt<bool> NumericSort("numeric-sort", cl::desc("Sort symbols by address"));
108 cl::alias NumericSortn("n", cl::desc("Alias for --numeric-sort"),
109 cl::aliasopt(NumericSort));
110 cl::alias NumericSortv("v", cl::desc("Alias for --numeric-sort"),
111 cl::aliasopt(NumericSort));
113 cl::opt<bool> NoSort("no-sort", cl::desc("Show symbols in order encountered"));
114 cl::alias NoSortp("p", cl::desc("Alias for --no-sort"), cl::aliasopt(NoSort));
116 cl::opt<bool> ReverseSort("reverse-sort", cl::desc("Sort in reverse order"));
117 cl::alias ReverseSortr("r", cl::desc("Alias for --reverse-sort"),
118 cl::aliasopt(ReverseSort));
120 cl::opt<bool> PrintSize("print-size",
121 cl::desc("Show symbol size instead of address"));
122 cl::alias PrintSizeS("S", cl::desc("Alias for --print-size"),
123 cl::aliasopt(PrintSize));
125 cl::opt<bool> SizeSort("size-sort", cl::desc("Sort symbols by size"));
127 cl::opt<bool> WithoutAliases("without-aliases", cl::Hidden,
128 cl::desc("Exclude aliases from output"));
130 cl::opt<bool> ArchiveMap("print-armap", cl::desc("Print the archive map"));
131 cl::alias ArchiveMaps("s", cl::desc("Alias for --print-armap"),
132 cl::aliasopt(ArchiveMap));
133 bool PrintAddress = true;
135 bool MultipleFiles = false;
137 bool HadError = false;
139 std::string ToolName;
142 static void error(Twine Message, Twine Path = Twine()) {
144 errs() << ToolName << ": " << Path << ": " << Message << ".\n";
147 static bool error(std::error_code EC, Twine Path = Twine()) {
149 error(EC.message(), Path);
165 static bool compareSymbolAddress(const NMSymbol &A, const NMSymbol &B) {
167 if (A.Address < B.Address)
169 else if (A.Address == B.Address && A.Name < B.Name)
171 else if (A.Address == B.Address && A.Name == B.Name && A.Size < B.Size)
176 if (A.Address > B.Address)
178 else if (A.Address == B.Address && A.Name > B.Name)
180 else if (A.Address == B.Address && A.Name == B.Name && A.Size > B.Size)
187 static bool compareSymbolSize(const NMSymbol &A, const NMSymbol &B) {
191 else if (A.Size == B.Size && A.Name < B.Name)
193 else if (A.Size == B.Size && A.Name == B.Name && A.Address < B.Address)
200 else if (A.Size == B.Size && A.Name > B.Name)
202 else if (A.Size == B.Size && A.Name == B.Name && A.Address > B.Address)
209 static bool compareSymbolName(const NMSymbol &A, const NMSymbol &B) {
213 else if (A.Name == B.Name && A.Size < B.Size)
215 else if (A.Name == B.Name && A.Size == B.Size && A.Address < B.Address)
222 else if (A.Name == B.Name && A.Size > B.Size)
224 else if (A.Name == B.Name && A.Size == B.Size && A.Address > B.Address)
231 static char isSymbolList64Bit(SymbolicFile *Obj) {
232 if (isa<IRObjectFile>(Obj))
234 else if (isa<COFFObjectFile>(Obj))
236 else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(Obj))
237 return MachO->is64Bit();
238 else if (isa<ELF32LEObjectFile>(Obj))
240 else if (isa<ELF64LEObjectFile>(Obj))
242 else if (isa<ELF32BEObjectFile>(Obj))
244 else if (isa<ELF64BEObjectFile>(Obj))
250 static StringRef CurrentFilename;
251 typedef std::vector<NMSymbol> SymbolListT;
252 static SymbolListT SymbolList;
254 // darwinPrintSymbol() is used to print a symbol from a Mach-O file when the
255 // the OutputFormat is darwin. It produces the same output as darwin's nm(1) -m
257 static void darwinPrintSymbol(MachOObjectFile *MachO, SymbolListT::iterator I,
258 char *SymbolAddrStr, const char *printBlanks) {
259 MachO::mach_header H;
260 MachO::mach_header_64 H_64;
261 uint32_t Filetype, Flags;
262 MachO::nlist_64 STE_64;
267 if (MachO->is64Bit()) {
268 H_64 = MachO->MachOObjectFile::getHeader64();
269 Filetype = H_64.filetype;
271 STE_64 = MachO->getSymbol64TableEntry(I->Symb);
272 NType = STE_64.n_type;
273 NDesc = STE_64.n_desc;
274 NValue = STE_64.n_value;
276 H = MachO->MachOObjectFile::getHeader();
277 Filetype = H.filetype;
279 STE = MachO->getSymbolTableEntry(I->Symb);
282 NValue = STE.n_value;
286 if ((NType & MachO::N_TYPE) == MachO::N_INDR)
287 strcpy(SymbolAddrStr, printBlanks);
288 outs() << SymbolAddrStr << ' ';
291 switch (NType & MachO::N_TYPE) {
294 outs() << "(common) ";
295 if (MachO::GET_COMM_ALIGN(NDesc) != 0)
296 outs() << "(alignment 2^" << (int)MachO::GET_COMM_ALIGN(NDesc) << ") ";
298 if ((NType & MachO::N_TYPE) == MachO::N_PBUD)
299 outs() << "(prebound ";
302 if ((NDesc & MachO::REFERENCE_TYPE) ==
303 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
304 outs() << "undefined [lazy bound]) ";
305 else if ((NDesc & MachO::REFERENCE_TYPE) ==
306 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
307 outs() << "undefined [private lazy bound]) ";
308 else if ((NDesc & MachO::REFERENCE_TYPE) ==
309 MachO::REFERENCE_FLAG_PRIVATE_UNDEFINED_NON_LAZY)
310 outs() << "undefined [private]) ";
312 outs() << "undefined) ";
316 outs() << "(absolute) ";
319 outs() << "(indirect) ";
321 case MachO::N_SECT: {
322 section_iterator Sec = MachO->section_end();
323 MachO->getSymbolSection(I->Symb, Sec);
324 DataRefImpl Ref = Sec->getRawDataRefImpl();
325 StringRef SectionName;
326 MachO->getSectionName(Ref, SectionName);
327 StringRef SegmentName = MachO->getSectionFinalSegmentName(Ref);
328 outs() << "(" << SegmentName << "," << SectionName << ") ";
336 if (NType & MachO::N_EXT) {
337 if (NDesc & MachO::REFERENCED_DYNAMICALLY)
338 outs() << "[referenced dynamically] ";
339 if (NType & MachO::N_PEXT) {
340 if ((NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF)
341 outs() << "weak private external ";
343 outs() << "private external ";
345 if ((NDesc & MachO::N_WEAK_REF) == MachO::N_WEAK_REF ||
346 (NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF) {
347 if ((NDesc & (MachO::N_WEAK_REF | MachO::N_WEAK_DEF)) ==
348 (MachO::N_WEAK_REF | MachO::N_WEAK_DEF))
349 outs() << "weak external automatically hidden ";
351 outs() << "weak external ";
353 outs() << "external ";
356 if (NType & MachO::N_PEXT)
357 outs() << "non-external (was a private external) ";
359 outs() << "non-external ";
362 if (Filetype == MachO::MH_OBJECT &&
363 (NDesc & MachO::N_NO_DEAD_STRIP) == MachO::N_NO_DEAD_STRIP)
364 outs() << "[no dead strip] ";
366 if (Filetype == MachO::MH_OBJECT &&
367 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
368 (NDesc & MachO::N_SYMBOL_RESOLVER) == MachO::N_SYMBOL_RESOLVER)
369 outs() << "[symbol resolver] ";
371 if (Filetype == MachO::MH_OBJECT &&
372 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
373 (NDesc & MachO::N_ALT_ENTRY) == MachO::N_ALT_ENTRY)
374 outs() << "[alt entry] ";
376 if ((NDesc & MachO::N_ARM_THUMB_DEF) == MachO::N_ARM_THUMB_DEF)
377 outs() << "[Thumb] ";
379 if ((NType & MachO::N_TYPE) == MachO::N_INDR) {
380 outs() << I->Name << " (for ";
381 StringRef IndirectName;
382 if (MachO->getIndirectName(I->Symb, IndirectName))
385 outs() << IndirectName << ")";
389 if ((Flags & MachO::MH_TWOLEVEL) == MachO::MH_TWOLEVEL &&
390 (((NType & MachO::N_TYPE) == MachO::N_UNDF && NValue == 0) ||
391 (NType & MachO::N_TYPE) == MachO::N_PBUD)) {
392 uint32_t LibraryOrdinal = MachO::GET_LIBRARY_ORDINAL(NDesc);
393 if (LibraryOrdinal != 0) {
394 if (LibraryOrdinal == MachO::EXECUTABLE_ORDINAL)
395 outs() << " (from executable)";
396 else if (LibraryOrdinal == MachO::DYNAMIC_LOOKUP_ORDINAL)
397 outs() << " (dynamically looked up)";
399 StringRef LibraryName;
400 if (MachO->getLibraryShortNameByIndex(LibraryOrdinal - 1, LibraryName))
401 outs() << " (from bad library ordinal " << LibraryOrdinal << ")";
403 outs() << " (from " << LibraryName << ")";
411 static void sortAndPrintSymbolList(SymbolicFile *Obj, bool printName) {
414 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolAddress);
416 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolSize);
418 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolName);
421 if (OutputFormat == posix && MultipleFiles && printName) {
422 outs() << '\n' << CurrentFilename << ":\n";
423 } else if (OutputFormat == bsd && MultipleFiles && printName) {
424 outs() << "\n" << CurrentFilename << ":\n";
425 } else if (OutputFormat == sysv) {
426 outs() << "\n\nSymbols from " << CurrentFilename << ":\n\n"
427 << "Name Value Class Type"
428 << " Size Line Section\n";
431 const char *printBlanks, *printFormat;
432 if (isSymbolList64Bit(Obj)) {
434 printFormat = "%016" PRIx64;
437 printFormat = "%08" PRIx64;
440 for (SymbolListT::iterator I = SymbolList.begin(), E = SymbolList.end();
442 if ((I->TypeChar != 'U') && UndefinedOnly)
444 if ((I->TypeChar == 'U') && DefinedOnly)
446 if (SizeSort && !PrintAddress && I->Size == UnknownAddressOrSize)
449 char SymbolAddrStr[18] = "";
450 char SymbolSizeStr[18] = "";
452 if (OutputFormat == sysv || I->Address == UnknownAddressOrSize)
453 strcpy(SymbolAddrStr, printBlanks);
454 if (OutputFormat == sysv)
455 strcpy(SymbolSizeStr, printBlanks);
457 if (I->Address != UnknownAddressOrSize)
458 format(printFormat, I->Address)
459 .print(SymbolAddrStr, sizeof(SymbolAddrStr));
460 if (I->Size != UnknownAddressOrSize)
461 format(printFormat, I->Size).print(SymbolSizeStr, sizeof(SymbolSizeStr));
463 // If OutputFormat is darwin and we have a MachOObjectFile print as darwin's
464 // nm(1) -m output, else if OutputFormat is darwin and not a Mach-O object
465 // fall back to OutputFormat bsd (see below).
466 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(Obj);
467 if (OutputFormat == darwin && MachO) {
468 darwinPrintSymbol(MachO, I, SymbolAddrStr, printBlanks);
469 } else if (OutputFormat == posix) {
470 outs() << I->Name << " " << I->TypeChar << " " << SymbolAddrStr
471 << SymbolSizeStr << "\n";
472 } else if (OutputFormat == bsd || (OutputFormat == darwin && !MachO)) {
474 outs() << SymbolAddrStr << ' ';
476 outs() << SymbolSizeStr;
477 if (I->Size != UnknownAddressOrSize)
480 outs() << I->TypeChar << " " << I->Name << "\n";
481 } else if (OutputFormat == sysv) {
482 std::string PaddedName(I->Name);
483 while (PaddedName.length() < 20)
485 outs() << PaddedName << "|" << SymbolAddrStr << "| " << I->TypeChar
486 << " | |" << SymbolSizeStr << "| |\n";
493 template <class ELFT>
494 static char getSymbolNMTypeChar(ELFObjectFile<ELFT> &Obj,
495 basic_symbol_iterator I) {
496 typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
497 typedef typename ELFObjectFile<ELFT>::Elf_Shdr Elf_Shdr;
500 symbol_iterator SymI(I);
502 DataRefImpl Symb = I->getRawDataRefImpl();
503 const Elf_Sym *ESym = Obj.getSymbol(Symb);
504 const ELFFile<ELFT> &EF = *Obj.getELFFile();
505 const Elf_Shdr *ESec = EF.getSection(ESym);
508 switch (ESec->sh_type) {
509 case ELF::SHT_PROGBITS:
510 case ELF::SHT_DYNAMIC:
511 switch (ESec->sh_flags) {
512 case (ELF::SHF_ALLOC | ELF::SHF_EXECINSTR):
514 case (ELF::SHF_TLS | ELF::SHF_ALLOC | ELF::SHF_WRITE):
515 case (ELF::SHF_ALLOC | ELF::SHF_WRITE):
518 case (ELF::SHF_ALLOC | ELF::SHF_MERGE):
519 case (ELF::SHF_ALLOC | ELF::SHF_MERGE | ELF::SHF_STRINGS):
523 case ELF::SHT_NOBITS:
528 if (ESym->getType() == ELF::STT_SECTION) {
530 if (error(SymI->getName(Name)))
532 return StringSwitch<char>(Name)
533 .StartsWith(".debug", 'N')
534 .StartsWith(".note", 'n')
541 static char getSymbolNMTypeChar(COFFObjectFile &Obj, symbol_iterator I) {
542 const coff_symbol *Symb = Obj.getCOFFSymbol(*I);
544 symbol_iterator SymI(I);
547 if (error(SymI->getName(Name)))
550 char Ret = StringSwitch<char>(Name)
551 .StartsWith(".debug", 'N')
552 .StartsWith(".sxdata", 'N')
558 uint32_t Characteristics = 0;
559 if (!COFF::isReservedSectionNumber(Symb->SectionNumber)) {
560 section_iterator SecI = Obj.section_end();
561 if (error(SymI->getSection(SecI)))
563 const coff_section *Section = Obj.getCOFFSection(*SecI);
564 Characteristics = Section->Characteristics;
567 switch (Symb->SectionNumber) {
568 case COFF::IMAGE_SYM_DEBUG:
571 // Check section type.
572 if (Characteristics & COFF::IMAGE_SCN_CNT_CODE)
574 else if (Characteristics & COFF::IMAGE_SCN_MEM_READ &&
575 ~Characteristics & COFF::IMAGE_SCN_MEM_WRITE) // Read only.
577 else if (Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
579 else if (Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)
581 else if (Characteristics & COFF::IMAGE_SCN_LNK_INFO)
584 // Check for section symbol.
585 else if (Symb->isSectionDefinition())
592 static uint8_t getNType(MachOObjectFile &Obj, DataRefImpl Symb) {
594 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
597 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
601 static char getSymbolNMTypeChar(MachOObjectFile &Obj, basic_symbol_iterator I) {
602 DataRefImpl Symb = I->getRawDataRefImpl();
603 uint8_t NType = getNType(Obj, Symb);
605 switch (NType & MachO::N_TYPE) {
610 case MachO::N_SECT: {
611 section_iterator Sec = Obj.section_end();
612 Obj.getSymbolSection(Symb, Sec);
613 DataRefImpl Ref = Sec->getRawDataRefImpl();
614 StringRef SectionName;
615 Obj.getSectionName(Ref, SectionName);
616 StringRef SegmentName = Obj.getSectionFinalSegmentName(Ref);
617 if (SegmentName == "__TEXT" && SectionName == "__text")
619 else if (SegmentName == "__DATA" && SectionName == "__data")
621 else if (SegmentName == "__DATA" && SectionName == "__bss")
631 static char getSymbolNMTypeChar(const GlobalValue &GV) {
632 if (GV.getType()->getElementType()->isFunctionTy())
634 // FIXME: should we print 'b'? At the IR level we cannot be sure if this
635 // will be in bss or not, but we could approximate.
639 static char getSymbolNMTypeChar(IRObjectFile &Obj, basic_symbol_iterator I) {
640 const GlobalValue &GV = Obj.getSymbolGV(I->getRawDataRefImpl());
641 return getSymbolNMTypeChar(GV);
644 template <class ELFT>
645 static bool isObject(ELFObjectFile<ELFT> &Obj, symbol_iterator I) {
646 typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
648 DataRefImpl Symb = I->getRawDataRefImpl();
649 const Elf_Sym *ESym = Obj.getSymbol(Symb);
651 return ESym->getType() == ELF::STT_OBJECT;
654 static bool isObject(SymbolicFile *Obj, basic_symbol_iterator I) {
655 if (ELF32LEObjectFile *ELF = dyn_cast<ELF32LEObjectFile>(Obj))
656 return isObject(*ELF, I);
657 if (ELF64LEObjectFile *ELF = dyn_cast<ELF64LEObjectFile>(Obj))
658 return isObject(*ELF, I);
659 if (ELF32BEObjectFile *ELF = dyn_cast<ELF32BEObjectFile>(Obj))
660 return isObject(*ELF, I);
661 if (ELF64BEObjectFile *ELF = dyn_cast<ELF64BEObjectFile>(Obj))
662 return isObject(*ELF, I);
666 static char getNMTypeChar(SymbolicFile *Obj, basic_symbol_iterator I) {
667 uint32_t Symflags = I->getFlags();
668 if ((Symflags & object::SymbolRef::SF_Weak) && !isa<MachOObjectFile>(Obj)) {
669 char Ret = isObject(Obj, I) ? 'v' : 'w';
670 if (!(Symflags & object::SymbolRef::SF_Undefined))
675 if (Symflags & object::SymbolRef::SF_Undefined)
678 if (Symflags & object::SymbolRef::SF_Common)
682 if (Symflags & object::SymbolRef::SF_Absolute)
684 else if (IRObjectFile *IR = dyn_cast<IRObjectFile>(Obj))
685 Ret = getSymbolNMTypeChar(*IR, I);
686 else if (COFFObjectFile *COFF = dyn_cast<COFFObjectFile>(Obj))
687 Ret = getSymbolNMTypeChar(*COFF, I);
688 else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(Obj))
689 Ret = getSymbolNMTypeChar(*MachO, I);
690 else if (ELF32LEObjectFile *ELF = dyn_cast<ELF32LEObjectFile>(Obj))
691 Ret = getSymbolNMTypeChar(*ELF, I);
692 else if (ELF64LEObjectFile *ELF = dyn_cast<ELF64LEObjectFile>(Obj))
693 Ret = getSymbolNMTypeChar(*ELF, I);
694 else if (ELF32BEObjectFile *ELF = dyn_cast<ELF32BEObjectFile>(Obj))
695 Ret = getSymbolNMTypeChar(*ELF, I);
697 Ret = getSymbolNMTypeChar(*cast<ELF64BEObjectFile>(Obj), I);
699 if (Symflags & object::SymbolRef::SF_Global)
705 static void dumpSymbolNamesFromObject(SymbolicFile *Obj, bool printName) {
706 basic_symbol_iterator IBegin = Obj->symbol_begin();
707 basic_symbol_iterator IEnd = Obj->symbol_end();
710 error("File format has no dynamic symbol table", Obj->getFileName());
713 std::pair<symbol_iterator, symbol_iterator> IDyn =
714 getELFDynamicSymbolIterators(Obj);
718 std::string NameBuffer;
719 raw_string_ostream OS(NameBuffer);
720 for (basic_symbol_iterator I = IBegin; I != IEnd; ++I) {
721 uint32_t SymFlags = I->getFlags();
722 if (!DebugSyms && (SymFlags & SymbolRef::SF_FormatSpecific))
724 if (WithoutAliases) {
725 if (IRObjectFile *IR = dyn_cast<IRObjectFile>(Obj)) {
726 const GlobalValue &GV = IR->getSymbolGV(I->getRawDataRefImpl());
727 if (isa<GlobalAlias>(GV))
732 S.Size = UnknownAddressOrSize;
733 S.Address = UnknownAddressOrSize;
734 if ((PrintSize || SizeSort) && isa<ObjectFile>(Obj)) {
735 symbol_iterator SymI = I;
736 if (error(SymI->getSize(S.Size)))
739 if (PrintAddress && isa<ObjectFile>(Obj))
740 if (error(symbol_iterator(I)->getAddress(S.Address)))
742 S.TypeChar = getNMTypeChar(Obj, I);
743 if (error(I->printName(OS)))
746 S.Symb = I->getRawDataRefImpl();
747 SymbolList.push_back(S);
751 const char *P = NameBuffer.c_str();
752 for (unsigned I = 0; I < SymbolList.size(); ++I) {
753 SymbolList[I].Name = P;
757 CurrentFilename = Obj->getFileName();
758 sortAndPrintSymbolList(Obj, printName);
761 // checkMachOAndArchFlags() checks to see if the SymbolicFile is a Mach-O file
762 // and if it is and there is a list of architecture flags is specified then
763 // check to make sure this Mach-O file is one of those architectures or all
764 // architectures was specificed. If not then an error is generated and this
765 // routine returns false. Else it returns true.
766 static bool checkMachOAndArchFlags(SymbolicFile *O, std::string &Filename) {
767 if (isa<MachOObjectFile>(O) && !ArchAll && ArchFlags.size() != 0) {
768 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(O);
769 bool ArchFound = false;
770 MachO::mach_header H;
771 MachO::mach_header_64 H_64;
773 if (MachO->is64Bit()) {
774 H_64 = MachO->MachOObjectFile::getHeader64();
775 T = MachOObjectFile::getArch(H_64.cputype, H_64.cpusubtype);
777 H = MachO->MachOObjectFile::getHeader();
778 T = MachOObjectFile::getArch(H.cputype, H.cpusubtype);
781 for (i = 0; i < ArchFlags.size(); ++i) {
782 if (ArchFlags[i] == T.getArchName())
788 "file: " + Filename + " does not contain architecture");
795 static void dumpSymbolNamesFromFile(std::string &Filename) {
796 std::unique_ptr<MemoryBuffer> Buffer;
797 if (error(MemoryBuffer::getFileOrSTDIN(Filename, Buffer), Filename))
800 LLVMContext &Context = getGlobalContext();
801 ErrorOr<Binary *> BinaryOrErr = createBinary(Buffer, &Context);
802 if (error(BinaryOrErr.getError(), Filename))
805 std::unique_ptr<Binary> Bin(BinaryOrErr.get());
807 if (Archive *A = dyn_cast<Archive>(Bin.get())) {
809 Archive::symbol_iterator I = A->symbol_begin();
810 Archive::symbol_iterator E = A->symbol_end();
812 outs() << "Archive map\n";
813 for (; I != E; ++I) {
814 ErrorOr<Archive::child_iterator> C = I->getMember();
815 if (error(C.getError()))
817 ErrorOr<StringRef> FileNameOrErr = C.get()->getName();
818 if (error(FileNameOrErr.getError()))
820 StringRef SymName = I->getName();
821 outs() << SymName << " in " << FileNameOrErr.get() << "\n";
827 for (Archive::child_iterator I = A->child_begin(), E = A->child_end();
829 ErrorOr<std::unique_ptr<Binary>> ChildOrErr = I->getAsBinary(&Context);
830 if (ChildOrErr.getError())
832 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
833 if (!checkMachOAndArchFlags(O, Filename))
836 if (isa<MachOObjectFile>(O)) {
837 outs() << Filename << "(" << O->getFileName() << ")";
839 outs() << O->getFileName();
841 dumpSymbolNamesFromObject(O, false);
846 if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(Bin.get())) {
847 // If we have a list of architecture flags specified dump only those.
848 if (!ArchAll && ArchFlags.size() != 0) {
849 // Look for a slice in the universal binary that matches each ArchFlag.
851 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
853 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
854 E = UB->end_objects();
856 if (ArchFlags[i] == I->getArchTypeName()) {
858 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr =
859 I->getAsObjectFile();
860 std::unique_ptr<Archive> A;
862 std::unique_ptr<ObjectFile> Obj = std::move(ObjOrErr.get());
863 if (ArchFlags.size() > 1) {
864 outs() << "\n" << Obj->getFileName() << " (for architecture "
865 << I->getArchTypeName() << ")"
868 dumpSymbolNamesFromObject(Obj.get(), false);
869 } else if (!I->getAsArchive(A)) {
870 for (Archive::child_iterator AI = A->child_begin(),
873 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
874 AI->getAsBinary(&Context);
875 if (ChildOrErr.getError())
877 if (SymbolicFile *O =
878 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
879 outs() << "\n" << A->getFileName();
880 outs() << "(" << O->getFileName() << ")";
881 if (ArchFlags.size() > 1) {
882 outs() << " (for architecture " << I->getArchTypeName()
886 dumpSymbolNamesFromObject(O, false);
894 "file: " + Filename + " does not contain architecture");
900 // No architecture flags were specified so if this contains a slice that
901 // matches the host architecture dump only that.
903 StringRef HostArchName = MachOObjectFile::getHostArch().getArchName();
904 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
905 E = UB->end_objects();
907 if (HostArchName == I->getArchTypeName()) {
908 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
909 std::unique_ptr<Archive> A;
911 std::unique_ptr<ObjectFile> Obj = std::move(ObjOrErr.get());
912 dumpSymbolNamesFromObject(Obj.get(), false);
913 } else if (!I->getAsArchive(A)) {
914 for (Archive::child_iterator AI = A->child_begin(),
917 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
918 AI->getAsBinary(&Context);
919 if (ChildOrErr.getError())
921 if (SymbolicFile *O =
922 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
923 outs() << "\n" << A->getFileName() << "(" << O->getFileName()
926 dumpSymbolNamesFromObject(O, false);
934 // Either all architectures have been specified or none have been specified
935 // and this does not contain the host architecture so dump all the slices.
936 bool moreThanOneArch = UB->getNumberOfObjects() > 1;
937 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
938 E = UB->end_objects();
940 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
941 std::unique_ptr<Archive> A;
943 std::unique_ptr<ObjectFile> Obj = std::move(ObjOrErr.get());
946 outs() << Obj->getFileName();
947 if (isa<MachOObjectFile>(Obj.get()) && moreThanOneArch)
948 outs() << " (for architecture " << I->getArchTypeName() << ")";
950 dumpSymbolNamesFromObject(Obj.get(), false);
951 } else if (!I->getAsArchive(A)) {
952 for (Archive::child_iterator AI = A->child_begin(), AE = A->child_end();
954 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
955 AI->getAsBinary(&Context);
956 if (ChildOrErr.getError())
958 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
959 outs() << "\n" << A->getFileName();
960 if (isa<MachOObjectFile>(O)) {
961 outs() << "(" << O->getFileName() << ")";
963 outs() << " (for architecture " << I->getArchTypeName() << ")";
965 outs() << ":" << O->getFileName();
967 dumpSymbolNamesFromObject(O, false);
974 if (SymbolicFile *O = dyn_cast<SymbolicFile>(Bin.get())) {
975 if (!checkMachOAndArchFlags(O, Filename))
977 dumpSymbolNamesFromObject(O, true);
980 error("unrecognizable file type", Filename);
984 int main(int argc, char **argv) {
985 // Print a stack trace if we signal out.
986 sys::PrintStackTraceOnErrorSignal();
987 PrettyStackTraceProgram X(argc, argv);
989 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
990 cl::ParseCommandLineOptions(argc, argv, "llvm symbol table dumper\n");
992 // llvm-nm only reads binary files.
993 if (error(sys::ChangeStdinToBinary()))
1000 OutputFormat = posix;
1002 OutputFormat = darwin;
1004 // The relative order of these is important. If you pass --size-sort it should
1005 // only print out the size. However, if you pass -S --size-sort, it should
1006 // print out both the size and address.
1007 if (SizeSort && !PrintSize)
1008 PrintAddress = false;
1009 if (OutputFormat == sysv || SizeSort)
1012 switch (InputFilenames.size()) {
1014 InputFilenames.push_back("a.out");
1018 MultipleFiles = true;
1021 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
1022 if (ArchFlags[i] == "all") {
1025 Triple T = MachOObjectFile::getArch(ArchFlags[i]);
1026 if (T.getArch() == Triple::UnknownArch)
1027 error("Unknown architecture named '" + ArchFlags[i] + "'",
1028 "for the -arch option");
1032 std::for_each(InputFilenames.begin(), InputFilenames.end(),
1033 dumpSymbolNamesFromFile);