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"));
77 cl::opt<bool> ExternalOnly("extern-only",
78 cl::desc("Show only external symbols"));
79 cl::alias ExternalOnly2("g", cl::desc("Alias for --extern-only"),
80 cl::aliasopt(ExternalOnly));
82 cl::opt<bool> BSDFormat("B", cl::desc("Alias for --format=bsd"));
83 cl::opt<bool> POSIXFormat("P", cl::desc("Alias for --format=posix"));
84 cl::opt<bool> DarwinFormat("m", cl::desc("Alias for --format=darwin"));
86 static cl::list<std::string>
87 ArchFlags("arch", cl::desc("architecture(s) from a Mach-O file to dump"),
91 cl::opt<bool> PrintFileName(
93 cl::desc("Precede each symbol with the object file it came from"));
95 cl::alias PrintFileNameA("A", cl::desc("Alias for --print-file-name"),
96 cl::aliasopt(PrintFileName));
97 cl::alias PrintFileNameo("o", cl::desc("Alias for --print-file-name"),
98 cl::aliasopt(PrintFileName));
100 cl::opt<bool> DebugSyms("debug-syms",
101 cl::desc("Show all symbols, even debugger only"));
102 cl::alias DebugSymsa("a", cl::desc("Alias for --debug-syms"),
103 cl::aliasopt(DebugSyms));
105 cl::opt<bool> NumericSort("numeric-sort", cl::desc("Sort symbols by address"));
106 cl::alias NumericSortn("n", cl::desc("Alias for --numeric-sort"),
107 cl::aliasopt(NumericSort));
108 cl::alias NumericSortv("v", cl::desc("Alias for --numeric-sort"),
109 cl::aliasopt(NumericSort));
111 cl::opt<bool> NoSort("no-sort", cl::desc("Show symbols in order encountered"));
112 cl::alias NoSortp("p", cl::desc("Alias for --no-sort"), cl::aliasopt(NoSort));
114 cl::opt<bool> ReverseSort("reverse-sort", cl::desc("Sort in reverse order"));
115 cl::alias ReverseSortr("r", cl::desc("Alias for --reverse-sort"),
116 cl::aliasopt(ReverseSort));
118 cl::opt<bool> PrintSize("print-size",
119 cl::desc("Show symbol size instead of address"));
120 cl::alias PrintSizeS("S", cl::desc("Alias for --print-size"),
121 cl::aliasopt(PrintSize));
123 cl::opt<bool> SizeSort("size-sort", cl::desc("Sort symbols by size"));
125 cl::opt<bool> WithoutAliases("without-aliases", cl::Hidden,
126 cl::desc("Exclude aliases from output"));
128 cl::opt<bool> ArchiveMap("print-armap", cl::desc("Print the archive map"));
129 cl::alias ArchiveMaps("s", cl::desc("Alias for --print-armap"),
130 cl::aliasopt(ArchiveMap));
131 bool PrintAddress = true;
133 bool MultipleFiles = false;
135 bool HadError = false;
137 std::string ToolName;
140 static void error(Twine Message, Twine Path = Twine()) {
142 errs() << ToolName << ": " << Path << ": " << Message << ".\n";
145 static bool error(std::error_code EC, Twine Path = Twine()) {
147 error(EC.message(), Path);
163 static bool compareSymbolAddress(const NMSymbol &A, const NMSymbol &B) {
165 if (A.Address < B.Address)
167 else if (A.Address == B.Address && A.Name < B.Name)
169 else if (A.Address == B.Address && A.Name == B.Name && A.Size < B.Size)
174 if (A.Address > B.Address)
176 else if (A.Address == B.Address && A.Name > B.Name)
178 else if (A.Address == B.Address && A.Name == B.Name && A.Size > B.Size)
185 static bool compareSymbolSize(const NMSymbol &A, const NMSymbol &B) {
189 else if (A.Size == B.Size && A.Name < B.Name)
191 else if (A.Size == B.Size && A.Name == B.Name && A.Address < B.Address)
198 else if (A.Size == B.Size && A.Name > B.Name)
200 else if (A.Size == B.Size && A.Name == B.Name && A.Address > B.Address)
207 static bool compareSymbolName(const NMSymbol &A, const NMSymbol &B) {
211 else if (A.Name == B.Name && A.Size < B.Size)
213 else if (A.Name == B.Name && A.Size == B.Size && A.Address < B.Address)
220 else if (A.Name == B.Name && A.Size > B.Size)
222 else if (A.Name == B.Name && A.Size == B.Size && A.Address > B.Address)
229 static char isSymbolList64Bit(SymbolicFile *Obj) {
230 if (isa<IRObjectFile>(Obj))
232 else if (isa<COFFObjectFile>(Obj))
234 else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(Obj))
235 return MachO->is64Bit();
236 else if (isa<ELF32LEObjectFile>(Obj))
238 else if (isa<ELF64LEObjectFile>(Obj))
240 else if (isa<ELF32BEObjectFile>(Obj))
242 else if (isa<ELF64BEObjectFile>(Obj))
248 static StringRef CurrentFilename;
249 typedef std::vector<NMSymbol> SymbolListT;
250 static SymbolListT SymbolList;
252 // darwinPrintSymbol() is used to print a symbol from a Mach-O file when the
253 // the OutputFormat is darwin. It produces the same output as darwin's nm(1) -m
255 static void darwinPrintSymbol(MachOObjectFile *MachO, SymbolListT::iterator I,
256 char *SymbolAddrStr, const char *printBlanks) {
257 MachO::mach_header H;
258 MachO::mach_header_64 H_64;
259 uint32_t Filetype, Flags;
260 MachO::nlist_64 STE_64;
265 if (MachO->is64Bit()) {
266 H_64 = MachO->MachOObjectFile::getHeader64();
267 Filetype = H_64.filetype;
269 STE_64 = MachO->getSymbol64TableEntry(I->Symb);
270 NType = STE_64.n_type;
271 NDesc = STE_64.n_desc;
272 NValue = STE_64.n_value;
274 H = MachO->MachOObjectFile::getHeader();
275 Filetype = H.filetype;
277 STE = MachO->getSymbolTableEntry(I->Symb);
280 NValue = STE.n_value;
284 if ((NType & MachO::N_TYPE) == MachO::N_INDR)
285 strcpy(SymbolAddrStr, printBlanks);
286 outs() << SymbolAddrStr << ' ';
289 switch (NType & MachO::N_TYPE) {
292 outs() << "(common) ";
293 if (MachO::GET_COMM_ALIGN(NDesc) != 0)
294 outs() << "(alignment 2^" << (int)MachO::GET_COMM_ALIGN(NDesc) << ") ";
296 if ((NType & MachO::N_TYPE) == MachO::N_PBUD)
297 outs() << "(prebound ";
300 if ((NDesc & MachO::REFERENCE_TYPE) ==
301 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
302 outs() << "undefined [lazy bound]) ";
303 else if ((NDesc & MachO::REFERENCE_TYPE) ==
304 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
305 outs() << "undefined [private lazy bound]) ";
306 else if ((NDesc & MachO::REFERENCE_TYPE) ==
307 MachO::REFERENCE_FLAG_PRIVATE_UNDEFINED_NON_LAZY)
308 outs() << "undefined [private]) ";
310 outs() << "undefined) ";
314 outs() << "(absolute) ";
317 outs() << "(indirect) ";
319 case MachO::N_SECT: {
320 section_iterator Sec = MachO->section_end();
321 MachO->getSymbolSection(I->Symb, Sec);
322 DataRefImpl Ref = Sec->getRawDataRefImpl();
323 StringRef SectionName;
324 MachO->getSectionName(Ref, SectionName);
325 StringRef SegmentName = MachO->getSectionFinalSegmentName(Ref);
326 outs() << "(" << SegmentName << "," << SectionName << ") ";
334 if (NType & MachO::N_EXT) {
335 if (NDesc & MachO::REFERENCED_DYNAMICALLY)
336 outs() << "[referenced dynamically] ";
337 if (NType & MachO::N_PEXT) {
338 if ((NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF)
339 outs() << "weak private external ";
341 outs() << "private external ";
343 if ((NDesc & MachO::N_WEAK_REF) == MachO::N_WEAK_REF ||
344 (NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF) {
345 if ((NDesc & (MachO::N_WEAK_REF | MachO::N_WEAK_DEF)) ==
346 (MachO::N_WEAK_REF | MachO::N_WEAK_DEF))
347 outs() << "weak external automatically hidden ";
349 outs() << "weak external ";
351 outs() << "external ";
354 if (NType & MachO::N_PEXT)
355 outs() << "non-external (was a private external) ";
357 outs() << "non-external ";
360 if (Filetype == MachO::MH_OBJECT &&
361 (NDesc & MachO::N_NO_DEAD_STRIP) == MachO::N_NO_DEAD_STRIP)
362 outs() << "[no dead strip] ";
364 if (Filetype == MachO::MH_OBJECT &&
365 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
366 (NDesc & MachO::N_SYMBOL_RESOLVER) == MachO::N_SYMBOL_RESOLVER)
367 outs() << "[symbol resolver] ";
369 if (Filetype == MachO::MH_OBJECT &&
370 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
371 (NDesc & MachO::N_ALT_ENTRY) == MachO::N_ALT_ENTRY)
372 outs() << "[alt entry] ";
374 if ((NDesc & MachO::N_ARM_THUMB_DEF) == MachO::N_ARM_THUMB_DEF)
375 outs() << "[Thumb] ";
377 if ((NType & MachO::N_TYPE) == MachO::N_INDR) {
378 outs() << I->Name << " (for ";
379 StringRef IndirectName;
380 if (MachO->getIndirectName(I->Symb, IndirectName))
383 outs() << IndirectName << ")";
387 if ((Flags & MachO::MH_TWOLEVEL) == MachO::MH_TWOLEVEL &&
388 (((NType & MachO::N_TYPE) == MachO::N_UNDF && NValue == 0) ||
389 (NType & MachO::N_TYPE) == MachO::N_PBUD)) {
390 uint32_t LibraryOrdinal = MachO::GET_LIBRARY_ORDINAL(NDesc);
391 if (LibraryOrdinal != 0) {
392 if (LibraryOrdinal == MachO::EXECUTABLE_ORDINAL)
393 outs() << " (from executable)";
394 else if (LibraryOrdinal == MachO::DYNAMIC_LOOKUP_ORDINAL)
395 outs() << " (dynamically looked up)";
397 StringRef LibraryName;
398 if (MachO->getLibraryShortNameByIndex(LibraryOrdinal - 1, LibraryName))
399 outs() << " (from bad library ordinal " << LibraryOrdinal << ")";
401 outs() << " (from " << LibraryName << ")";
409 static void sortAndPrintSymbolList(SymbolicFile *Obj, bool printName) {
412 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolAddress);
414 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolSize);
416 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolName);
419 if (OutputFormat == posix && MultipleFiles && printName) {
420 outs() << '\n' << CurrentFilename << ":\n";
421 } else if (OutputFormat == bsd && MultipleFiles && printName) {
422 outs() << "\n" << CurrentFilename << ":\n";
423 } else if (OutputFormat == sysv) {
424 outs() << "\n\nSymbols from " << CurrentFilename << ":\n\n"
425 << "Name Value Class Type"
426 << " Size Line Section\n";
429 const char *printBlanks, *printFormat;
430 if (isSymbolList64Bit(Obj)) {
432 printFormat = "%016" PRIx64;
435 printFormat = "%08" PRIx64;
438 for (SymbolListT::iterator I = SymbolList.begin(), E = SymbolList.end();
440 if ((I->TypeChar != 'U') && UndefinedOnly)
442 if ((I->TypeChar == 'U') && DefinedOnly)
444 if (SizeSort && !PrintAddress && I->Size == UnknownAddressOrSize)
447 char SymbolAddrStr[18] = "";
448 char SymbolSizeStr[18] = "";
450 if (OutputFormat == sysv || I->Address == UnknownAddressOrSize)
451 strcpy(SymbolAddrStr, printBlanks);
452 if (OutputFormat == sysv)
453 strcpy(SymbolSizeStr, printBlanks);
455 if (I->Address != UnknownAddressOrSize)
456 format(printFormat, I->Address)
457 .print(SymbolAddrStr, sizeof(SymbolAddrStr));
458 if (I->Size != UnknownAddressOrSize)
459 format(printFormat, I->Size).print(SymbolSizeStr, sizeof(SymbolSizeStr));
461 // If OutputFormat is darwin and we have a MachOObjectFile print as darwin's
462 // nm(1) -m output, else if OutputFormat is darwin and not a Mach-O object
463 // fall back to OutputFormat bsd (see below).
464 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(Obj);
465 if (OutputFormat == darwin && MachO) {
466 darwinPrintSymbol(MachO, I, SymbolAddrStr, printBlanks);
467 } else if (OutputFormat == posix) {
468 outs() << I->Name << " " << I->TypeChar << " " << SymbolAddrStr
469 << SymbolSizeStr << "\n";
470 } else if (OutputFormat == bsd || (OutputFormat == darwin && !MachO)) {
472 outs() << SymbolAddrStr << ' ';
474 outs() << SymbolSizeStr;
475 if (I->Size != UnknownAddressOrSize)
478 outs() << I->TypeChar << " " << I->Name << "\n";
479 } else if (OutputFormat == sysv) {
480 std::string PaddedName(I->Name);
481 while (PaddedName.length() < 20)
483 outs() << PaddedName << "|" << SymbolAddrStr << "| " << I->TypeChar
484 << " | |" << SymbolSizeStr << "| |\n";
491 template <class ELFT>
492 static char getSymbolNMTypeChar(ELFObjectFile<ELFT> &Obj,
493 basic_symbol_iterator I) {
494 typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
495 typedef typename ELFObjectFile<ELFT>::Elf_Shdr Elf_Shdr;
498 symbol_iterator SymI(I);
500 DataRefImpl Symb = I->getRawDataRefImpl();
501 const Elf_Sym *ESym = Obj.getSymbol(Symb);
502 const ELFFile<ELFT> &EF = *Obj.getELFFile();
503 const Elf_Shdr *ESec = EF.getSection(ESym);
506 switch (ESec->sh_type) {
507 case ELF::SHT_PROGBITS:
508 case ELF::SHT_DYNAMIC:
509 switch (ESec->sh_flags) {
510 case (ELF::SHF_ALLOC | ELF::SHF_EXECINSTR):
512 case (ELF::SHF_TLS | ELF::SHF_ALLOC | ELF::SHF_WRITE):
513 case (ELF::SHF_ALLOC | ELF::SHF_WRITE):
516 case (ELF::SHF_ALLOC | ELF::SHF_MERGE):
517 case (ELF::SHF_ALLOC | ELF::SHF_MERGE | ELF::SHF_STRINGS):
521 case ELF::SHT_NOBITS:
526 if (ESym->getType() == ELF::STT_SECTION) {
528 if (error(SymI->getName(Name)))
530 return StringSwitch<char>(Name)
531 .StartsWith(".debug", 'N')
532 .StartsWith(".note", 'n')
539 static char getSymbolNMTypeChar(COFFObjectFile &Obj, symbol_iterator I) {
540 const coff_symbol *Symb = Obj.getCOFFSymbol(*I);
542 symbol_iterator SymI(I);
545 if (error(SymI->getName(Name)))
548 char Ret = StringSwitch<char>(Name)
549 .StartsWith(".debug", 'N')
550 .StartsWith(".sxdata", 'N')
556 uint32_t Characteristics = 0;
557 if (!COFF::isReservedSectionNumber(Symb->SectionNumber)) {
558 section_iterator SecI = Obj.section_end();
559 if (error(SymI->getSection(SecI)))
561 const coff_section *Section = Obj.getCOFFSection(*SecI);
562 Characteristics = Section->Characteristics;
565 switch (Symb->SectionNumber) {
566 case COFF::IMAGE_SYM_DEBUG:
569 // Check section type.
570 if (Characteristics & COFF::IMAGE_SCN_CNT_CODE)
572 else if (Characteristics & COFF::IMAGE_SCN_MEM_READ &&
573 ~Characteristics & COFF::IMAGE_SCN_MEM_WRITE) // Read only.
575 else if (Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
577 else if (Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)
579 else if (Characteristics & COFF::IMAGE_SCN_LNK_INFO)
582 // Check for section symbol.
583 else if (Symb->isSectionDefinition())
590 static uint8_t getNType(MachOObjectFile &Obj, DataRefImpl Symb) {
592 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
595 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
599 static char getSymbolNMTypeChar(MachOObjectFile &Obj, basic_symbol_iterator I) {
600 DataRefImpl Symb = I->getRawDataRefImpl();
601 uint8_t NType = getNType(Obj, Symb);
603 switch (NType & MachO::N_TYPE) {
608 case MachO::N_SECT: {
609 section_iterator Sec = Obj.section_end();
610 Obj.getSymbolSection(Symb, Sec);
611 DataRefImpl Ref = Sec->getRawDataRefImpl();
612 StringRef SectionName;
613 Obj.getSectionName(Ref, SectionName);
614 StringRef SegmentName = Obj.getSectionFinalSegmentName(Ref);
615 if (SegmentName == "__TEXT" && SectionName == "__text")
617 else if (SegmentName == "__DATA" && SectionName == "__data")
619 else if (SegmentName == "__DATA" && SectionName == "__bss")
629 static char getSymbolNMTypeChar(const GlobalValue &GV) {
630 if (GV.getType()->getElementType()->isFunctionTy())
632 // FIXME: should we print 'b'? At the IR level we cannot be sure if this
633 // will be in bss or not, but we could approximate.
637 static char getSymbolNMTypeChar(IRObjectFile &Obj, basic_symbol_iterator I) {
638 const GlobalValue &GV = Obj.getSymbolGV(I->getRawDataRefImpl());
639 return getSymbolNMTypeChar(GV);
642 template <class ELFT>
643 static bool isObject(ELFObjectFile<ELFT> &Obj, symbol_iterator I) {
644 typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
646 DataRefImpl Symb = I->getRawDataRefImpl();
647 const Elf_Sym *ESym = Obj.getSymbol(Symb);
649 return ESym->getType() == ELF::STT_OBJECT;
652 static bool isObject(SymbolicFile *Obj, basic_symbol_iterator I) {
653 if (ELF32LEObjectFile *ELF = dyn_cast<ELF32LEObjectFile>(Obj))
654 return isObject(*ELF, I);
655 if (ELF64LEObjectFile *ELF = dyn_cast<ELF64LEObjectFile>(Obj))
656 return isObject(*ELF, I);
657 if (ELF32BEObjectFile *ELF = dyn_cast<ELF32BEObjectFile>(Obj))
658 return isObject(*ELF, I);
659 if (ELF64BEObjectFile *ELF = dyn_cast<ELF64BEObjectFile>(Obj))
660 return isObject(*ELF, I);
664 static char getNMTypeChar(SymbolicFile *Obj, basic_symbol_iterator I) {
665 uint32_t Symflags = I->getFlags();
666 if ((Symflags & object::SymbolRef::SF_Weak) && !isa<MachOObjectFile>(Obj)) {
667 char Ret = isObject(Obj, I) ? 'v' : 'w';
668 if (!(Symflags & object::SymbolRef::SF_Undefined))
673 if (Symflags & object::SymbolRef::SF_Undefined)
676 if (Symflags & object::SymbolRef::SF_Common)
680 if (Symflags & object::SymbolRef::SF_Absolute)
682 else if (IRObjectFile *IR = dyn_cast<IRObjectFile>(Obj))
683 Ret = getSymbolNMTypeChar(*IR, I);
684 else if (COFFObjectFile *COFF = dyn_cast<COFFObjectFile>(Obj))
685 Ret = getSymbolNMTypeChar(*COFF, I);
686 else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(Obj))
687 Ret = getSymbolNMTypeChar(*MachO, I);
688 else if (ELF32LEObjectFile *ELF = dyn_cast<ELF32LEObjectFile>(Obj))
689 Ret = getSymbolNMTypeChar(*ELF, I);
690 else if (ELF64LEObjectFile *ELF = dyn_cast<ELF64LEObjectFile>(Obj))
691 Ret = getSymbolNMTypeChar(*ELF, I);
692 else if (ELF32BEObjectFile *ELF = dyn_cast<ELF32BEObjectFile>(Obj))
693 Ret = getSymbolNMTypeChar(*ELF, I);
695 Ret = getSymbolNMTypeChar(*cast<ELF64BEObjectFile>(Obj), I);
697 if (Symflags & object::SymbolRef::SF_Global)
703 static void dumpSymbolNamesFromObject(SymbolicFile *Obj, bool printName) {
704 basic_symbol_iterator IBegin = Obj->symbol_begin();
705 basic_symbol_iterator IEnd = Obj->symbol_end();
708 error("File format has no dynamic symbol table", Obj->getFileName());
711 std::pair<symbol_iterator, symbol_iterator> IDyn =
712 getELFDynamicSymbolIterators(Obj);
716 std::string NameBuffer;
717 raw_string_ostream OS(NameBuffer);
718 for (basic_symbol_iterator I = IBegin; I != IEnd; ++I) {
719 uint32_t SymFlags = I->getFlags();
720 if (!DebugSyms && (SymFlags & SymbolRef::SF_FormatSpecific))
722 if (WithoutAliases) {
723 if (IRObjectFile *IR = dyn_cast<IRObjectFile>(Obj)) {
724 const GlobalValue &GV = IR->getSymbolGV(I->getRawDataRefImpl());
725 if (isa<GlobalAlias>(GV))
730 S.Size = UnknownAddressOrSize;
731 S.Address = UnknownAddressOrSize;
732 if ((PrintSize || SizeSort) && isa<ObjectFile>(Obj)) {
733 symbol_iterator SymI = I;
734 if (error(SymI->getSize(S.Size)))
737 if (PrintAddress && isa<ObjectFile>(Obj))
738 if (error(symbol_iterator(I)->getAddress(S.Address)))
740 S.TypeChar = getNMTypeChar(Obj, I);
741 if (error(I->printName(OS)))
744 S.Symb = I->getRawDataRefImpl();
745 SymbolList.push_back(S);
749 const char *P = NameBuffer.c_str();
750 for (unsigned I = 0; I < SymbolList.size(); ++I) {
751 SymbolList[I].Name = P;
755 CurrentFilename = Obj->getFileName();
756 sortAndPrintSymbolList(Obj, printName);
759 // checkMachOAndArchFlags() checks to see if the SymbolicFile is a Mach-O file
760 // and if it is and there is a list of architecture flags is specified then
761 // check to make sure this Mach-O file is one of those architectures or all
762 // architectures was specificed. If not then an error is generated and this
763 // routine returns false. Else it returns true.
764 static bool checkMachOAndArchFlags(SymbolicFile *O, std::string &Filename) {
765 if (isa<MachOObjectFile>(O) && !ArchAll && ArchFlags.size() != 0) {
766 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(O);
767 bool ArchFound = false;
768 MachO::mach_header H;
769 MachO::mach_header_64 H_64;
771 if (MachO->is64Bit()) {
772 H_64 = MachO->MachOObjectFile::getHeader64();
773 T = MachOObjectFile::getArch(H_64.cputype, H_64.cpusubtype);
775 H = MachO->MachOObjectFile::getHeader();
776 T = MachOObjectFile::getArch(H.cputype, H.cpusubtype);
779 for (i = 0; i < ArchFlags.size(); ++i) {
780 if (ArchFlags[i] == T.getArchName())
786 "file: " + Filename + " does not contain architecture");
793 static void dumpSymbolNamesFromFile(std::string &Filename) {
794 std::unique_ptr<MemoryBuffer> Buffer;
795 if (error(MemoryBuffer::getFileOrSTDIN(Filename, Buffer), Filename))
798 LLVMContext &Context = getGlobalContext();
799 ErrorOr<Binary *> BinaryOrErr = createBinary(Buffer, &Context);
800 if (error(BinaryOrErr.getError(), Filename))
803 std::unique_ptr<Binary> Bin(BinaryOrErr.get());
805 if (Archive *A = dyn_cast<Archive>(Bin.get())) {
807 Archive::symbol_iterator I = A->symbol_begin();
808 Archive::symbol_iterator E = A->symbol_end();
810 outs() << "Archive map\n";
811 for (; I != E; ++I) {
812 ErrorOr<Archive::child_iterator> C = I->getMember();
813 if (error(C.getError()))
815 ErrorOr<StringRef> FileNameOrErr = C.get()->getName();
816 if (error(FileNameOrErr.getError()))
818 StringRef SymName = I->getName();
819 outs() << SymName << " in " << FileNameOrErr.get() << "\n";
825 for (Archive::child_iterator I = A->child_begin(), E = A->child_end();
827 ErrorOr<std::unique_ptr<Binary>> ChildOrErr = I->getAsBinary(&Context);
828 if (ChildOrErr.getError())
830 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
831 if (!checkMachOAndArchFlags(O, Filename))
834 if (isa<MachOObjectFile>(O)) {
835 outs() << Filename << "(" << O->getFileName() << ")";
837 outs() << O->getFileName();
839 dumpSymbolNamesFromObject(O, false);
844 if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(Bin.get())) {
845 // If we have a list of architecture flags specified dump only those.
846 if (!ArchAll && ArchFlags.size() != 0) {
847 // Look for a slice in the universal binary that matches each ArchFlag.
849 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
851 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
852 E = UB->end_objects();
854 if (ArchFlags[i] == I->getArchTypeName()) {
856 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr =
857 I->getAsObjectFile();
858 std::unique_ptr<Archive> A;
860 std::unique_ptr<ObjectFile> Obj = std::move(ObjOrErr.get());
861 if (ArchFlags.size() > 1) {
862 outs() << "\n" << Obj->getFileName() << " (for architecture "
863 << I->getArchTypeName() << ")"
866 dumpSymbolNamesFromObject(Obj.get(), false);
867 } else if (!I->getAsArchive(A)) {
868 for (Archive::child_iterator AI = A->child_begin(),
871 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
872 AI->getAsBinary(&Context);
873 if (ChildOrErr.getError())
875 if (SymbolicFile *O =
876 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
877 outs() << "\n" << A->getFileName();
878 outs() << "(" << O->getFileName() << ")";
879 if (ArchFlags.size() > 1) {
880 outs() << " (for architecture " << I->getArchTypeName()
884 dumpSymbolNamesFromObject(O, false);
892 "file: " + Filename + " does not contain architecture");
898 // No architecture flags were specified so if this contains a slice that
899 // matches the host architecture dump only that.
901 StringRef HostArchName = MachOObjectFile::getHostArch().getArchName();
902 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
903 E = UB->end_objects();
905 if (HostArchName == I->getArchTypeName()) {
906 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
907 std::unique_ptr<Archive> A;
909 std::unique_ptr<ObjectFile> Obj = std::move(ObjOrErr.get());
910 dumpSymbolNamesFromObject(Obj.get(), false);
911 } else if (!I->getAsArchive(A)) {
912 for (Archive::child_iterator AI = A->child_begin(),
915 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
916 AI->getAsBinary(&Context);
917 if (ChildOrErr.getError())
919 if (SymbolicFile *O =
920 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
921 outs() << "\n" << A->getFileName() << "(" << O->getFileName()
924 dumpSymbolNamesFromObject(O, false);
932 // Either all architectures have been specified or none have been specified
933 // and this does not contain the host architecture so dump all the slices.
934 bool moreThanOneArch = UB->getNumberOfObjects() > 1;
935 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
936 E = UB->end_objects();
938 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
939 std::unique_ptr<Archive> A;
941 std::unique_ptr<ObjectFile> Obj = std::move(ObjOrErr.get());
944 outs() << Obj->getFileName();
945 if (isa<MachOObjectFile>(Obj.get()) && moreThanOneArch)
946 outs() << " (for architecture " << I->getArchTypeName() << ")";
948 dumpSymbolNamesFromObject(Obj.get(), false);
949 } else if (!I->getAsArchive(A)) {
950 for (Archive::child_iterator AI = A->child_begin(), AE = A->child_end();
952 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
953 AI->getAsBinary(&Context);
954 if (ChildOrErr.getError())
956 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
957 outs() << "\n" << A->getFileName();
958 if (isa<MachOObjectFile>(O)) {
959 outs() << "(" << O->getFileName() << ")";
961 outs() << " (for architecture " << I->getArchTypeName() << ")";
963 outs() << ":" << O->getFileName();
965 dumpSymbolNamesFromObject(O, false);
972 if (SymbolicFile *O = dyn_cast<SymbolicFile>(Bin.get())) {
973 if (!checkMachOAndArchFlags(O, Filename))
975 dumpSymbolNamesFromObject(O, true);
978 error("unrecognizable file type", Filename);
982 int main(int argc, char **argv) {
983 // Print a stack trace if we signal out.
984 sys::PrintStackTraceOnErrorSignal();
985 PrettyStackTraceProgram X(argc, argv);
987 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
988 cl::ParseCommandLineOptions(argc, argv, "llvm symbol table dumper\n");
990 // llvm-nm only reads binary files.
991 if (error(sys::ChangeStdinToBinary()))
998 OutputFormat = posix;
1000 OutputFormat = darwin;
1002 // The relative order of these is important. If you pass --size-sort it should
1003 // only print out the size. However, if you pass -S --size-sort, it should
1004 // print out both the size and address.
1005 if (SizeSort && !PrintSize)
1006 PrintAddress = false;
1007 if (OutputFormat == sysv || SizeSort)
1010 switch (InputFilenames.size()) {
1012 InputFilenames.push_back("a.out");
1016 MultipleFiles = true;
1019 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
1020 if (ArchFlags[i] == "all") {
1023 Triple T = MachOObjectFile::getArch(ArchFlags[i]);
1024 if (T.getArch() == Triple::UnknownArch)
1025 error("Unknown architecture named '" + ArchFlags[i] + "'",
1026 "for the -arch option");
1030 std::for_each(InputFilenames.begin(), InputFilenames.end(),
1031 dumpSymbolNamesFromFile);