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"
40 #include "llvm/Support/TargetSelect.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("s", 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));
139 bool PrintAddress = true;
141 bool MultipleFiles = false;
143 bool HadError = false;
145 std::string ToolName;
148 static void error(Twine Message, Twine Path = Twine()) {
150 errs() << ToolName << ": " << Path << ": " << Message << ".\n";
153 static bool error(std::error_code EC, Twine Path = Twine()) {
155 error(EC.message(), Path);
171 static bool compareSymbolAddress(const NMSymbol &A, const NMSymbol &B) {
173 if (A.Address < B.Address)
175 else if (A.Address == B.Address && A.Name < B.Name)
177 else if (A.Address == B.Address && A.Name == B.Name && A.Size < B.Size)
182 if (A.Address > B.Address)
184 else if (A.Address == B.Address && A.Name > B.Name)
186 else if (A.Address == B.Address && A.Name == B.Name && A.Size > B.Size)
193 static bool compareSymbolSize(const NMSymbol &A, const NMSymbol &B) {
197 else if (A.Size == B.Size && A.Name < B.Name)
199 else if (A.Size == B.Size && A.Name == B.Name && A.Address < B.Address)
206 else if (A.Size == B.Size && A.Name > B.Name)
208 else if (A.Size == B.Size && A.Name == B.Name && A.Address > B.Address)
215 static bool compareSymbolName(const NMSymbol &A, const NMSymbol &B) {
219 else if (A.Name == B.Name && A.Size < B.Size)
221 else if (A.Name == B.Name && A.Size == B.Size && A.Address < B.Address)
228 else if (A.Name == B.Name && A.Size > B.Size)
230 else if (A.Name == B.Name && A.Size == B.Size && A.Address > B.Address)
237 static char isSymbolList64Bit(SymbolicFile *Obj) {
238 if (isa<IRObjectFile>(Obj))
240 else if (isa<COFFObjectFile>(Obj))
242 else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(Obj))
243 return MachO->is64Bit();
244 else if (isa<ELF32LEObjectFile>(Obj))
246 else if (isa<ELF64LEObjectFile>(Obj))
248 else if (isa<ELF32BEObjectFile>(Obj))
250 else if (isa<ELF64BEObjectFile>(Obj))
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. It produces the same output as darwin's nm(1) -m
263 static void darwinPrintSymbol(MachOObjectFile *MachO, SymbolListT::iterator I,
264 char *SymbolAddrStr, const char *printBlanks) {
265 MachO::mach_header H;
266 MachO::mach_header_64 H_64;
267 uint32_t Filetype, Flags;
268 MachO::nlist_64 STE_64;
273 if (MachO->is64Bit()) {
274 H_64 = MachO->MachOObjectFile::getHeader64();
275 Filetype = H_64.filetype;
277 STE_64 = MachO->getSymbol64TableEntry(I->Symb);
278 NType = STE_64.n_type;
279 NDesc = STE_64.n_desc;
280 NValue = STE_64.n_value;
282 H = MachO->MachOObjectFile::getHeader();
283 Filetype = H.filetype;
285 STE = MachO->getSymbolTableEntry(I->Symb);
288 NValue = STE.n_value;
292 if ((NType & MachO::N_TYPE) == MachO::N_INDR)
293 strcpy(SymbolAddrStr, printBlanks);
294 outs() << SymbolAddrStr << ' ';
297 switch (NType & MachO::N_TYPE) {
300 outs() << "(common) ";
301 if (MachO::GET_COMM_ALIGN(NDesc) != 0)
302 outs() << "(alignment 2^" << (int)MachO::GET_COMM_ALIGN(NDesc) << ") ";
304 if ((NType & MachO::N_TYPE) == MachO::N_PBUD)
305 outs() << "(prebound ";
308 if ((NDesc & MachO::REFERENCE_TYPE) ==
309 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
310 outs() << "undefined [lazy bound]) ";
311 else if ((NDesc & MachO::REFERENCE_TYPE) ==
312 MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
313 outs() << "undefined [private lazy bound]) ";
314 else if ((NDesc & MachO::REFERENCE_TYPE) ==
315 MachO::REFERENCE_FLAG_PRIVATE_UNDEFINED_NON_LAZY)
316 outs() << "undefined [private]) ";
318 outs() << "undefined) ";
322 outs() << "(absolute) ";
325 outs() << "(indirect) ";
327 case MachO::N_SECT: {
328 section_iterator Sec = MachO->section_end();
329 MachO->getSymbolSection(I->Symb, Sec);
330 DataRefImpl Ref = Sec->getRawDataRefImpl();
331 StringRef SectionName;
332 MachO->getSectionName(Ref, SectionName);
333 StringRef SegmentName = MachO->getSectionFinalSegmentName(Ref);
334 outs() << "(" << SegmentName << "," << SectionName << ") ";
342 if (NType & MachO::N_EXT) {
343 if (NDesc & MachO::REFERENCED_DYNAMICALLY)
344 outs() << "[referenced dynamically] ";
345 if (NType & MachO::N_PEXT) {
346 if ((NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF)
347 outs() << "weak private external ";
349 outs() << "private external ";
351 if ((NDesc & MachO::N_WEAK_REF) == MachO::N_WEAK_REF ||
352 (NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF) {
353 if ((NDesc & (MachO::N_WEAK_REF | MachO::N_WEAK_DEF)) ==
354 (MachO::N_WEAK_REF | MachO::N_WEAK_DEF))
355 outs() << "weak external automatically hidden ";
357 outs() << "weak external ";
359 outs() << "external ";
362 if (NType & MachO::N_PEXT)
363 outs() << "non-external (was a private external) ";
365 outs() << "non-external ";
368 if (Filetype == MachO::MH_OBJECT &&
369 (NDesc & MachO::N_NO_DEAD_STRIP) == MachO::N_NO_DEAD_STRIP)
370 outs() << "[no dead strip] ";
372 if (Filetype == MachO::MH_OBJECT &&
373 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
374 (NDesc & MachO::N_SYMBOL_RESOLVER) == MachO::N_SYMBOL_RESOLVER)
375 outs() << "[symbol resolver] ";
377 if (Filetype == MachO::MH_OBJECT &&
378 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
379 (NDesc & MachO::N_ALT_ENTRY) == MachO::N_ALT_ENTRY)
380 outs() << "[alt entry] ";
382 if ((NDesc & MachO::N_ARM_THUMB_DEF) == MachO::N_ARM_THUMB_DEF)
383 outs() << "[Thumb] ";
385 if ((NType & MachO::N_TYPE) == MachO::N_INDR) {
386 outs() << I->Name << " (for ";
387 StringRef IndirectName;
388 if (MachO->getIndirectName(I->Symb, IndirectName))
391 outs() << IndirectName << ")";
395 if ((Flags & MachO::MH_TWOLEVEL) == MachO::MH_TWOLEVEL &&
396 (((NType & MachO::N_TYPE) == MachO::N_UNDF && NValue == 0) ||
397 (NType & MachO::N_TYPE) == MachO::N_PBUD)) {
398 uint32_t LibraryOrdinal = MachO::GET_LIBRARY_ORDINAL(NDesc);
399 if (LibraryOrdinal != 0) {
400 if (LibraryOrdinal == MachO::EXECUTABLE_ORDINAL)
401 outs() << " (from executable)";
402 else if (LibraryOrdinal == MachO::DYNAMIC_LOOKUP_ORDINAL)
403 outs() << " (dynamically looked up)";
405 StringRef LibraryName;
406 if (MachO->getLibraryShortNameByIndex(LibraryOrdinal - 1, LibraryName))
407 outs() << " (from bad library ordinal " << LibraryOrdinal << ")";
409 outs() << " (from " << LibraryName << ")";
417 static void sortAndPrintSymbolList(SymbolicFile *Obj, bool printName) {
420 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolAddress);
422 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolSize);
424 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolName);
427 if (OutputFormat == posix && MultipleFiles && printName) {
428 outs() << '\n' << CurrentFilename << ":\n";
429 } else if (OutputFormat == bsd && MultipleFiles && printName) {
430 outs() << "\n" << CurrentFilename << ":\n";
431 } else if (OutputFormat == sysv) {
432 outs() << "\n\nSymbols from " << CurrentFilename << ":\n\n"
433 << "Name Value Class Type"
434 << " Size Line Section\n";
437 const char *printBlanks, *printFormat;
438 if (isSymbolList64Bit(Obj)) {
440 printFormat = "%016" PRIx64;
443 printFormat = "%08" PRIx64;
446 for (SymbolListT::iterator I = SymbolList.begin(), E = SymbolList.end();
448 if ((I->TypeChar != 'U') && UndefinedOnly)
450 if ((I->TypeChar == 'U') && DefinedOnly)
452 if (SizeSort && !PrintAddress && I->Size == UnknownAddressOrSize)
454 if (JustSymbolName) {
455 outs() << I->Name << "\n";
459 char SymbolAddrStr[18] = "";
460 char SymbolSizeStr[18] = "";
462 if (OutputFormat == sysv || I->Address == UnknownAddressOrSize)
463 strcpy(SymbolAddrStr, printBlanks);
464 if (OutputFormat == sysv)
465 strcpy(SymbolSizeStr, printBlanks);
467 if (I->Address != UnknownAddressOrSize)
468 format(printFormat, I->Address)
469 .print(SymbolAddrStr, sizeof(SymbolAddrStr));
470 if (I->Size != UnknownAddressOrSize)
471 format(printFormat, I->Size).print(SymbolSizeStr, sizeof(SymbolSizeStr));
473 // If OutputFormat is darwin and we have a MachOObjectFile print as darwin's
474 // nm(1) -m output, else if OutputFormat is darwin and not a Mach-O object
475 // fall back to OutputFormat bsd (see below).
476 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(Obj);
477 if (OutputFormat == darwin && MachO) {
478 darwinPrintSymbol(MachO, I, SymbolAddrStr, printBlanks);
479 } else if (OutputFormat == posix) {
480 outs() << I->Name << " " << I->TypeChar << " " << SymbolAddrStr
481 << SymbolSizeStr << "\n";
482 } else if (OutputFormat == bsd || (OutputFormat == darwin && !MachO)) {
484 outs() << SymbolAddrStr << ' ';
486 outs() << SymbolSizeStr;
487 if (I->Size != UnknownAddressOrSize)
490 outs() << I->TypeChar << " " << I->Name << "\n";
491 } else if (OutputFormat == sysv) {
492 std::string PaddedName(I->Name);
493 while (PaddedName.length() < 20)
495 outs() << PaddedName << "|" << SymbolAddrStr << "| " << I->TypeChar
496 << " | |" << SymbolSizeStr << "| |\n";
503 template <class ELFT>
504 static char getSymbolNMTypeChar(ELFObjectFile<ELFT> &Obj,
505 basic_symbol_iterator I) {
506 typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
507 typedef typename ELFObjectFile<ELFT>::Elf_Shdr Elf_Shdr;
510 symbol_iterator SymI(I);
512 DataRefImpl Symb = I->getRawDataRefImpl();
513 const Elf_Sym *ESym = Obj.getSymbol(Symb);
514 const ELFFile<ELFT> &EF = *Obj.getELFFile();
515 const Elf_Shdr *ESec = EF.getSection(ESym);
518 switch (ESec->sh_type) {
519 case ELF::SHT_PROGBITS:
520 case ELF::SHT_DYNAMIC:
521 switch (ESec->sh_flags) {
522 case (ELF::SHF_ALLOC | ELF::SHF_EXECINSTR):
524 case (ELF::SHF_TLS | ELF::SHF_ALLOC | ELF::SHF_WRITE):
525 case (ELF::SHF_ALLOC | ELF::SHF_WRITE):
528 case (ELF::SHF_ALLOC | ELF::SHF_MERGE):
529 case (ELF::SHF_ALLOC | ELF::SHF_MERGE | ELF::SHF_STRINGS):
533 case ELF::SHT_NOBITS:
538 if (ESym->getType() == ELF::STT_SECTION) {
540 if (error(SymI->getName(Name)))
542 return StringSwitch<char>(Name)
543 .StartsWith(".debug", 'N')
544 .StartsWith(".note", 'n')
551 static char getSymbolNMTypeChar(COFFObjectFile &Obj, symbol_iterator I) {
552 const coff_symbol *Symb = Obj.getCOFFSymbol(*I);
554 symbol_iterator SymI(I);
557 if (error(SymI->getName(Name)))
560 char Ret = StringSwitch<char>(Name)
561 .StartsWith(".debug", 'N')
562 .StartsWith(".sxdata", 'N')
568 uint32_t Characteristics = 0;
569 if (!COFF::isReservedSectionNumber(Symb->SectionNumber)) {
570 section_iterator SecI = Obj.section_end();
571 if (error(SymI->getSection(SecI)))
573 const coff_section *Section = Obj.getCOFFSection(*SecI);
574 Characteristics = Section->Characteristics;
577 switch (Symb->SectionNumber) {
578 case COFF::IMAGE_SYM_DEBUG:
581 // Check section type.
582 if (Characteristics & COFF::IMAGE_SCN_CNT_CODE)
584 else if (Characteristics & COFF::IMAGE_SCN_MEM_READ &&
585 ~Characteristics & COFF::IMAGE_SCN_MEM_WRITE) // Read only.
587 else if (Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
589 else if (Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)
591 else if (Characteristics & COFF::IMAGE_SCN_LNK_INFO)
594 // Check for section symbol.
595 else if (Symb->isSectionDefinition())
602 static uint8_t getNType(MachOObjectFile &Obj, DataRefImpl Symb) {
604 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
607 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
611 static char getSymbolNMTypeChar(MachOObjectFile &Obj, basic_symbol_iterator I) {
612 DataRefImpl Symb = I->getRawDataRefImpl();
613 uint8_t NType = getNType(Obj, Symb);
615 switch (NType & MachO::N_TYPE) {
620 case MachO::N_SECT: {
621 section_iterator Sec = Obj.section_end();
622 Obj.getSymbolSection(Symb, Sec);
623 DataRefImpl Ref = Sec->getRawDataRefImpl();
624 StringRef SectionName;
625 Obj.getSectionName(Ref, SectionName);
626 StringRef SegmentName = Obj.getSectionFinalSegmentName(Ref);
627 if (SegmentName == "__TEXT" && SectionName == "__text")
629 else if (SegmentName == "__DATA" && SectionName == "__data")
631 else if (SegmentName == "__DATA" && SectionName == "__bss")
641 static char getSymbolNMTypeChar(const GlobalValue &GV) {
642 if (GV.getType()->getElementType()->isFunctionTy())
644 // FIXME: should we print 'b'? At the IR level we cannot be sure if this
645 // will be in bss or not, but we could approximate.
649 static char getSymbolNMTypeChar(IRObjectFile &Obj, basic_symbol_iterator I) {
650 const GlobalValue *GV = Obj.getSymbolGV(I->getRawDataRefImpl());
653 return getSymbolNMTypeChar(*GV);
656 template <class ELFT>
657 static bool isObject(ELFObjectFile<ELFT> &Obj, symbol_iterator I) {
658 typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
660 DataRefImpl Symb = I->getRawDataRefImpl();
661 const Elf_Sym *ESym = Obj.getSymbol(Symb);
663 return ESym->getType() == ELF::STT_OBJECT;
666 static bool isObject(SymbolicFile *Obj, basic_symbol_iterator I) {
667 if (ELF32LEObjectFile *ELF = dyn_cast<ELF32LEObjectFile>(Obj))
668 return isObject(*ELF, I);
669 if (ELF64LEObjectFile *ELF = dyn_cast<ELF64LEObjectFile>(Obj))
670 return isObject(*ELF, I);
671 if (ELF32BEObjectFile *ELF = dyn_cast<ELF32BEObjectFile>(Obj))
672 return isObject(*ELF, I);
673 if (ELF64BEObjectFile *ELF = dyn_cast<ELF64BEObjectFile>(Obj))
674 return isObject(*ELF, I);
678 static char getNMTypeChar(SymbolicFile *Obj, basic_symbol_iterator I) {
679 uint32_t Symflags = I->getFlags();
680 if ((Symflags & object::SymbolRef::SF_Weak) && !isa<MachOObjectFile>(Obj)) {
681 char Ret = isObject(Obj, I) ? 'v' : 'w';
682 if (!(Symflags & object::SymbolRef::SF_Undefined))
687 if (Symflags & object::SymbolRef::SF_Undefined)
690 if (Symflags & object::SymbolRef::SF_Common)
694 if (Symflags & object::SymbolRef::SF_Absolute)
696 else if (IRObjectFile *IR = dyn_cast<IRObjectFile>(Obj))
697 Ret = getSymbolNMTypeChar(*IR, I);
698 else if (COFFObjectFile *COFF = dyn_cast<COFFObjectFile>(Obj))
699 Ret = getSymbolNMTypeChar(*COFF, I);
700 else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(Obj))
701 Ret = getSymbolNMTypeChar(*MachO, I);
702 else if (ELF32LEObjectFile *ELF = dyn_cast<ELF32LEObjectFile>(Obj))
703 Ret = getSymbolNMTypeChar(*ELF, I);
704 else if (ELF64LEObjectFile *ELF = dyn_cast<ELF64LEObjectFile>(Obj))
705 Ret = getSymbolNMTypeChar(*ELF, I);
706 else if (ELF32BEObjectFile *ELF = dyn_cast<ELF32BEObjectFile>(Obj))
707 Ret = getSymbolNMTypeChar(*ELF, I);
709 Ret = getSymbolNMTypeChar(*cast<ELF64BEObjectFile>(Obj), I);
711 if (Symflags & object::SymbolRef::SF_Global)
717 static void dumpSymbolNamesFromObject(SymbolicFile *Obj, bool printName) {
718 basic_symbol_iterator IBegin = Obj->symbol_begin();
719 basic_symbol_iterator IEnd = Obj->symbol_end();
722 error("File format has no dynamic symbol table", Obj->getFileName());
725 std::pair<symbol_iterator, symbol_iterator> IDyn =
726 getELFDynamicSymbolIterators(Obj);
730 std::string NameBuffer;
731 raw_string_ostream OS(NameBuffer);
732 for (basic_symbol_iterator I = IBegin; I != IEnd; ++I) {
733 uint32_t SymFlags = I->getFlags();
734 if (!DebugSyms && (SymFlags & SymbolRef::SF_FormatSpecific))
736 if (WithoutAliases) {
737 if (IRObjectFile *IR = dyn_cast<IRObjectFile>(Obj)) {
738 const GlobalValue *GV = IR->getSymbolGV(I->getRawDataRefImpl());
739 if (GV && isa<GlobalAlias>(GV))
744 S.Size = UnknownAddressOrSize;
745 S.Address = UnknownAddressOrSize;
746 if ((PrintSize || SizeSort) && isa<ObjectFile>(Obj)) {
747 symbol_iterator SymI = I;
748 if (error(SymI->getSize(S.Size)))
751 if (PrintAddress && isa<ObjectFile>(Obj))
752 if (error(symbol_iterator(I)->getAddress(S.Address)))
754 S.TypeChar = getNMTypeChar(Obj, I);
755 if (error(I->printName(OS)))
758 S.Symb = I->getRawDataRefImpl();
759 SymbolList.push_back(S);
763 const char *P = NameBuffer.c_str();
764 for (unsigned I = 0; I < SymbolList.size(); ++I) {
765 SymbolList[I].Name = P;
769 CurrentFilename = Obj->getFileName();
770 sortAndPrintSymbolList(Obj, printName);
773 // checkMachOAndArchFlags() checks to see if the SymbolicFile is a Mach-O file
774 // and if it is and there is a list of architecture flags is specified then
775 // check to make sure this Mach-O file is one of those architectures or all
776 // architectures was specificed. If not then an error is generated and this
777 // routine returns false. Else it returns true.
778 static bool checkMachOAndArchFlags(SymbolicFile *O, std::string &Filename) {
779 if (isa<MachOObjectFile>(O) && !ArchAll && ArchFlags.size() != 0) {
780 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(O);
781 bool ArchFound = false;
782 MachO::mach_header H;
783 MachO::mach_header_64 H_64;
785 if (MachO->is64Bit()) {
786 H_64 = MachO->MachOObjectFile::getHeader64();
787 T = MachOObjectFile::getArch(H_64.cputype, H_64.cpusubtype);
789 H = MachO->MachOObjectFile::getHeader();
790 T = MachOObjectFile::getArch(H.cputype, H.cpusubtype);
793 for (i = 0; i < ArchFlags.size(); ++i) {
794 if (ArchFlags[i] == T.getArchName())
800 "file: " + Filename + " does not contain architecture");
807 static void dumpSymbolNamesFromFile(std::string &Filename) {
808 ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
809 MemoryBuffer::getFileOrSTDIN(Filename);
810 if (error(BufferOrErr.getError(), Filename))
812 std::unique_ptr<MemoryBuffer> Buffer = std::move(BufferOrErr.get());
814 LLVMContext &Context = getGlobalContext();
815 ErrorOr<Binary *> BinaryOrErr = createBinary(Buffer, &Context);
816 if (error(BinaryOrErr.getError(), Filename))
819 std::unique_ptr<Binary> Bin(BinaryOrErr.get());
821 if (Archive *A = dyn_cast<Archive>(Bin.get())) {
823 Archive::symbol_iterator I = A->symbol_begin();
824 Archive::symbol_iterator E = A->symbol_end();
826 outs() << "Archive map\n";
827 for (; I != E; ++I) {
828 ErrorOr<Archive::child_iterator> C = I->getMember();
829 if (error(C.getError()))
831 ErrorOr<StringRef> FileNameOrErr = C.get()->getName();
832 if (error(FileNameOrErr.getError()))
834 StringRef SymName = I->getName();
835 outs() << SymName << " in " << FileNameOrErr.get() << "\n";
841 for (Archive::child_iterator I = A->child_begin(), E = A->child_end();
843 ErrorOr<std::unique_ptr<Binary>> ChildOrErr = I->getAsBinary(&Context);
844 if (ChildOrErr.getError())
846 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
847 if (!checkMachOAndArchFlags(O, Filename))
850 if (isa<MachOObjectFile>(O)) {
851 outs() << Filename << "(" << O->getFileName() << ")";
853 outs() << O->getFileName();
855 dumpSymbolNamesFromObject(O, false);
860 if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(Bin.get())) {
861 // If we have a list of architecture flags specified dump only those.
862 if (!ArchAll && ArchFlags.size() != 0) {
863 // Look for a slice in the universal binary that matches each ArchFlag.
865 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
867 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
868 E = UB->end_objects();
870 if (ArchFlags[i] == I->getArchTypeName()) {
872 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr =
873 I->getAsObjectFile();
874 std::unique_ptr<Archive> A;
876 std::unique_ptr<ObjectFile> Obj = std::move(ObjOrErr.get());
877 if (ArchFlags.size() > 1) {
878 outs() << "\n" << Obj->getFileName() << " (for architecture "
879 << I->getArchTypeName() << ")"
882 dumpSymbolNamesFromObject(Obj.get(), false);
883 } else if (!I->getAsArchive(A)) {
884 for (Archive::child_iterator AI = A->child_begin(),
887 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
888 AI->getAsBinary(&Context);
889 if (ChildOrErr.getError())
891 if (SymbolicFile *O =
892 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
893 outs() << "\n" << A->getFileName();
894 outs() << "(" << O->getFileName() << ")";
895 if (ArchFlags.size() > 1) {
896 outs() << " (for architecture " << I->getArchTypeName()
900 dumpSymbolNamesFromObject(O, false);
908 "file: " + Filename + " does not contain architecture");
914 // No architecture flags were specified so if this contains a slice that
915 // matches the host architecture dump only that.
917 StringRef HostArchName = MachOObjectFile::getHostArch().getArchName();
918 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
919 E = UB->end_objects();
921 if (HostArchName == I->getArchTypeName()) {
922 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
923 std::unique_ptr<Archive> A;
925 std::unique_ptr<ObjectFile> Obj = std::move(ObjOrErr.get());
926 dumpSymbolNamesFromObject(Obj.get(), false);
927 } else if (!I->getAsArchive(A)) {
928 for (Archive::child_iterator AI = A->child_begin(),
931 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
932 AI->getAsBinary(&Context);
933 if (ChildOrErr.getError())
935 if (SymbolicFile *O =
936 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
937 outs() << "\n" << A->getFileName() << "(" << O->getFileName()
940 dumpSymbolNamesFromObject(O, false);
948 // Either all architectures have been specified or none have been specified
949 // and this does not contain the host architecture so dump all the slices.
950 bool moreThanOneArch = UB->getNumberOfObjects() > 1;
951 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
952 E = UB->end_objects();
954 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
955 std::unique_ptr<Archive> A;
957 std::unique_ptr<ObjectFile> Obj = std::move(ObjOrErr.get());
960 outs() << Obj->getFileName();
961 if (isa<MachOObjectFile>(Obj.get()) && moreThanOneArch)
962 outs() << " (for architecture " << I->getArchTypeName() << ")";
964 dumpSymbolNamesFromObject(Obj.get(), false);
965 } else if (!I->getAsArchive(A)) {
966 for (Archive::child_iterator AI = A->child_begin(), AE = A->child_end();
968 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
969 AI->getAsBinary(&Context);
970 if (ChildOrErr.getError())
972 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
973 outs() << "\n" << A->getFileName();
974 if (isa<MachOObjectFile>(O)) {
975 outs() << "(" << O->getFileName() << ")";
977 outs() << " (for architecture " << I->getArchTypeName() << ")";
979 outs() << ":" << O->getFileName();
981 dumpSymbolNamesFromObject(O, false);
988 if (SymbolicFile *O = dyn_cast<SymbolicFile>(Bin.get())) {
989 if (!checkMachOAndArchFlags(O, Filename))
991 dumpSymbolNamesFromObject(O, true);
994 error("unrecognizable file type", Filename);
998 int main(int argc, char **argv) {
999 // Print a stack trace if we signal out.
1000 sys::PrintStackTraceOnErrorSignal();
1001 PrettyStackTraceProgram X(argc, argv);
1003 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
1004 cl::ParseCommandLineOptions(argc, argv, "llvm symbol table dumper\n");
1006 // llvm-nm only reads binary files.
1007 if (error(sys::ChangeStdinToBinary()))
1010 llvm::InitializeAllTargetInfos();
1011 llvm::InitializeAllTargetMCs();
1012 llvm::InitializeAllAsmParsers();
1018 OutputFormat = posix;
1020 OutputFormat = darwin;
1022 // The relative order of these is important. If you pass --size-sort it should
1023 // only print out the size. However, if you pass -S --size-sort, it should
1024 // print out both the size and address.
1025 if (SizeSort && !PrintSize)
1026 PrintAddress = false;
1027 if (OutputFormat == sysv || SizeSort)
1030 switch (InputFilenames.size()) {
1032 InputFilenames.push_back("a.out");
1036 MultipleFiles = true;
1039 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
1040 if (ArchFlags[i] == "all") {
1043 Triple T = MachOObjectFile::getArch(ArchFlags[i]);
1044 if (T.getArch() == Triple::UnknownArch)
1045 error("Unknown architecture named '" + ArchFlags[i] + "'",
1046 "for the -arch option");
1050 std::for_each(InputFilenames.begin(), InputFilenames.end(),
1051 dumpSymbolNamesFromFile);