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/IR/Module.h"
24 #include "llvm/Object/Archive.h"
25 #include "llvm/Object/COFF.h"
26 #include "llvm/Object/ELFObjectFile.h"
27 #include "llvm/Object/IRObjectFile.h"
28 #include "llvm/Object/MachO.h"
29 #include "llvm/Object/MachOUniversal.h"
30 #include "llvm/Object/ObjectFile.h"
31 #include "llvm/Support/COFF.h"
32 #include "llvm/Support/CommandLine.h"
33 #include "llvm/Support/FileSystem.h"
34 #include "llvm/Support/Format.h"
35 #include "llvm/Support/ManagedStatic.h"
36 #include "llvm/Support/MemoryBuffer.h"
37 #include "llvm/Support/PrettyStackTrace.h"
38 #include "llvm/Support/Program.h"
39 #include "llvm/Support/Signals.h"
40 #include "llvm/Support/TargetSelect.h"
41 #include "llvm/Support/raw_ostream.h"
46 #include <system_error>
50 using namespace object;
53 enum OutputFormatTy { bsd, sysv, posix, darwin };
54 cl::opt<OutputFormatTy> OutputFormat(
55 "format", cl::desc("Specify output format"),
56 cl::values(clEnumVal(bsd, "BSD format"), clEnumVal(sysv, "System V format"),
57 clEnumVal(posix, "POSIX.2 format"),
58 clEnumVal(darwin, "Darwin -m format"), clEnumValEnd),
60 cl::alias OutputFormat2("f", cl::desc("Alias for --format"),
61 cl::aliasopt(OutputFormat));
63 cl::list<std::string> InputFilenames(cl::Positional, cl::desc("<input files>"),
66 cl::opt<bool> UndefinedOnly("undefined-only",
67 cl::desc("Show only undefined symbols"));
68 cl::alias UndefinedOnly2("u", cl::desc("Alias for --undefined-only"),
69 cl::aliasopt(UndefinedOnly), cl::Grouping);
71 cl::opt<bool> DynamicSyms("dynamic",
72 cl::desc("Display the dynamic symbols instead "
73 "of normal symbols."));
74 cl::alias DynamicSyms2("D", cl::desc("Alias for --dynamic"),
75 cl::aliasopt(DynamicSyms), cl::Grouping);
77 cl::opt<bool> DefinedOnly("defined-only",
78 cl::desc("Show only defined symbols"));
79 cl::alias DefinedOnly2("U", cl::desc("Alias for --defined-only"),
80 cl::aliasopt(DefinedOnly), cl::Grouping);
82 cl::opt<bool> ExternalOnly("extern-only",
83 cl::desc("Show only external symbols"));
84 cl::alias ExternalOnly2("g", cl::desc("Alias for --extern-only"),
85 cl::aliasopt(ExternalOnly), cl::Grouping);
87 cl::opt<bool> BSDFormat("B", cl::desc("Alias for --format=bsd"),
89 cl::opt<bool> POSIXFormat("P", cl::desc("Alias for --format=posix"),
91 cl::opt<bool> DarwinFormat("m", cl::desc("Alias for --format=darwin"),
94 static cl::list<std::string>
95 ArchFlags("arch", cl::desc("architecture(s) from a Mach-O file to dump"),
99 cl::opt<bool> PrintFileName(
101 cl::desc("Precede each symbol with the object file it came from"));
103 cl::alias PrintFileNameA("A", cl::desc("Alias for --print-file-name"),
104 cl::aliasopt(PrintFileName), cl::Grouping);
105 cl::alias PrintFileNameo("o", cl::desc("Alias for --print-file-name"),
106 cl::aliasopt(PrintFileName), cl::Grouping);
108 cl::opt<bool> DebugSyms("debug-syms",
109 cl::desc("Show all symbols, even debugger only"));
110 cl::alias DebugSymsa("a", cl::desc("Alias for --debug-syms"),
111 cl::aliasopt(DebugSyms), cl::Grouping);
113 cl::opt<bool> NumericSort("numeric-sort", cl::desc("Sort symbols by address"));
114 cl::alias NumericSortn("n", cl::desc("Alias for --numeric-sort"),
115 cl::aliasopt(NumericSort), cl::Grouping);
116 cl::alias NumericSortv("v", cl::desc("Alias for --numeric-sort"),
117 cl::aliasopt(NumericSort), cl::Grouping);
119 cl::opt<bool> NoSort("no-sort", cl::desc("Show symbols in order encountered"));
120 cl::alias NoSortp("p", cl::desc("Alias for --no-sort"), cl::aliasopt(NoSort),
123 cl::opt<bool> ReverseSort("reverse-sort", cl::desc("Sort in reverse order"));
124 cl::alias ReverseSortr("r", cl::desc("Alias for --reverse-sort"),
125 cl::aliasopt(ReverseSort), cl::Grouping);
127 cl::opt<bool> PrintSize("print-size",
128 cl::desc("Show symbol size instead of address"));
129 cl::alias PrintSizeS("S", cl::desc("Alias for --print-size"),
130 cl::aliasopt(PrintSize), cl::Grouping);
132 cl::opt<bool> SizeSort("size-sort", cl::desc("Sort symbols by size"));
134 cl::opt<bool> WithoutAliases("without-aliases", cl::Hidden,
135 cl::desc("Exclude aliases from output"));
137 cl::opt<bool> ArchiveMap("print-armap", cl::desc("Print the archive map"));
138 cl::alias ArchiveMaps("M", cl::desc("Alias for --print-armap"),
139 cl::aliasopt(ArchiveMap), cl::Grouping);
141 cl::opt<bool> JustSymbolName("just-symbol-name",
142 cl::desc("Print just the symbol's name"));
143 cl::alias JustSymbolNames("j", cl::desc("Alias for --just-symbol-name"),
144 cl::aliasopt(JustSymbolName), cl::Grouping);
146 // FIXME: This option takes exactly two strings and should be allowed anywhere
147 // on the command line. Such that "llvm-nm -s __TEXT __text foo.o" would work.
148 // But that does not as the CommandLine Library does not have a way to make
149 // this work. For now the "-s __TEXT __text" has to be last on the command
151 cl::list<std::string> SegSect("s", cl::Positional, cl::ZeroOrMore,
152 cl::desc("Dump only symbols from this segment "
153 "and section name, Mach-O only"));
155 cl::opt<bool> FormatMachOasHex("x", cl::desc("Print symbol entry in hex, "
156 "Mach-O only"), cl::Grouping);
158 cl::opt<bool> NoLLVMBitcode("no-llvm-bc",
159 cl::desc("Disable LLVM bitcode reader"));
161 bool PrintAddress = true;
163 bool MultipleFiles = false;
165 bool HadError = false;
167 std::string ToolName;
168 } // anonymous namespace
170 static void error(Twine Message, Twine Path = Twine()) {
172 errs() << ToolName << ": " << Path << ": " << Message << ".\n";
175 static bool error(std::error_code EC, Twine Path = Twine()) {
177 error(EC.message(), Path);
191 } // anonymous namespace
193 static bool compareSymbolAddress(const NMSymbol &A, const NMSymbol &B) {
194 bool ADefined = !(A.Sym.getFlags() & SymbolRef::SF_Undefined);
195 bool BDefined = !(B.Sym.getFlags() & SymbolRef::SF_Undefined);
196 return std::make_tuple(ADefined, A.Address, A.Name, A.Size) <
197 std::make_tuple(BDefined, B.Address, B.Name, B.Size);
200 static bool compareSymbolSize(const NMSymbol &A, const NMSymbol &B) {
201 return std::make_tuple(A.Size, A.Name, A.Address) <
202 std::make_tuple(B.Size, B.Name, B.Address);
205 static bool compareSymbolName(const NMSymbol &A, const NMSymbol &B) {
206 return std::make_tuple(A.Name, A.Size, A.Address) <
207 std::make_tuple(B.Name, B.Size, B.Address);
210 static char isSymbolList64Bit(SymbolicFile &Obj) {
211 if (isa<IRObjectFile>(Obj)) {
212 IRObjectFile *IRobj = dyn_cast<IRObjectFile>(&Obj);
213 Module &M = IRobj->getModule();
214 if (M.getTargetTriple().empty())
216 Triple T(M.getTargetTriple());
217 return T.isArch64Bit();
219 if (isa<COFFObjectFile>(Obj))
221 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj))
222 return MachO->is64Bit();
223 return cast<ELFObjectFileBase>(Obj).getBytesInAddress() == 8;
226 static StringRef CurrentFilename;
227 typedef std::vector<NMSymbol> SymbolListT;
228 static SymbolListT SymbolList;
230 static char getSymbolNMTypeChar(IRObjectFile &Obj, basic_symbol_iterator I);
232 // darwinPrintSymbol() is used to print a symbol from a Mach-O file when the
233 // the OutputFormat is darwin or we are printing Mach-O symbols in hex. For
234 // the darwin format it produces the same output as darwin's nm(1) -m output
235 // and when printing Mach-O symbols in hex it produces the same output as
236 // darwin's nm(1) -x format.
237 static void darwinPrintSymbol(SymbolicFile &Obj, SymbolListT::iterator I,
238 char *SymbolAddrStr, const char *printBlanks,
239 const char *printDashes, const char *printFormat) {
240 MachO::mach_header H;
241 MachO::mach_header_64 H_64;
242 uint32_t Filetype, Flags;
243 MachO::nlist_64 STE_64;
250 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
252 uint32_t SymFlags = I->Sym.getFlags();
253 if (SymFlags & SymbolRef::SF_Global)
254 NType |= MachO::N_EXT;
255 if (SymFlags & SymbolRef::SF_Hidden)
256 NType |= MachO::N_PEXT;
257 if (SymFlags & SymbolRef::SF_Undefined)
258 NType |= MachO::N_EXT | MachO::N_UNDF;
260 // Here we have a symbol definition. So to fake out a section name we
261 // use 1, 2 and 3 for section numbers. See below where they are used to
262 // print out fake section names.
263 NType |= MachO::N_SECT;
264 if(SymFlags & SymbolRef::SF_Const)
267 IRObjectFile *IRobj = dyn_cast<IRObjectFile>(&Obj);
268 char c = getSymbolNMTypeChar(*IRobj, I->Sym);
275 if (SymFlags & SymbolRef::SF_Weak)
276 NDesc |= MachO::N_WEAK_DEF;
278 DataRefImpl SymDRI = I->Sym.getRawDataRefImpl();
279 if (MachO->is64Bit()) {
280 H_64 = MachO->MachOObjectFile::getHeader64();
281 Filetype = H_64.filetype;
283 STE_64 = MachO->getSymbol64TableEntry(SymDRI);
284 NType = STE_64.n_type;
285 NSect = STE_64.n_sect;
286 NDesc = STE_64.n_desc;
287 NStrx = STE_64.n_strx;
288 NValue = STE_64.n_value;
290 H = MachO->MachOObjectFile::getHeader();
291 Filetype = H.filetype;
293 STE = MachO->getSymbolTableEntry(SymDRI);
298 NValue = STE.n_value;
302 // If we are printing Mach-O symbols in hex do that and return.
303 if (FormatMachOasHex) {
305 format(printFormat, NValue).print(Str, sizeof(Str));
306 outs() << Str << ' ';
307 format("%02x", NType).print(Str, sizeof(Str));
308 outs() << Str << ' ';
309 format("%02x", NSect).print(Str, sizeof(Str));
310 outs() << Str << ' ';
311 format("%04x", NDesc).print(Str, sizeof(Str));
312 outs() << Str << ' ';
313 format("%08x", NStrx).print(Str, sizeof(Str));
314 outs() << Str << ' ';
315 outs() << I->Name << "\n";
320 if ((NType & MachO::N_TYPE) == MachO::N_INDR)
321 strcpy(SymbolAddrStr, printBlanks);
322 if (Obj.isIR() && (NType & MachO::N_TYPE) == MachO::N_TYPE)
323 strcpy(SymbolAddrStr, printDashes);
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: {
359 // For llvm bitcode files print out a fake section name using the values
360 // use 1, 2 and 3 for section numbers as set above.
362 outs() << "(LTO,CODE) ";
364 outs() << "(LTO,DATA) ";
366 outs() << "(LTO,RODATA) ";
371 section_iterator Sec = *MachO->getSymbolSection(I->Sym.getRawDataRefImpl());
372 DataRefImpl Ref = Sec->getRawDataRefImpl();
373 StringRef SectionName;
374 MachO->getSectionName(Ref, SectionName);
375 StringRef SegmentName = MachO->getSectionFinalSegmentName(Ref);
376 outs() << "(" << SegmentName << "," << SectionName << ") ";
384 if (NType & MachO::N_EXT) {
385 if (NDesc & MachO::REFERENCED_DYNAMICALLY)
386 outs() << "[referenced dynamically] ";
387 if (NType & MachO::N_PEXT) {
388 if ((NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF)
389 outs() << "weak private external ";
391 outs() << "private external ";
393 if ((NDesc & MachO::N_WEAK_REF) == MachO::N_WEAK_REF ||
394 (NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF) {
395 if ((NDesc & (MachO::N_WEAK_REF | MachO::N_WEAK_DEF)) ==
396 (MachO::N_WEAK_REF | MachO::N_WEAK_DEF))
397 outs() << "weak external automatically hidden ";
399 outs() << "weak external ";
401 outs() << "external ";
404 if (NType & MachO::N_PEXT)
405 outs() << "non-external (was a private external) ";
407 outs() << "non-external ";
410 if (Filetype == MachO::MH_OBJECT &&
411 (NDesc & MachO::N_NO_DEAD_STRIP) == MachO::N_NO_DEAD_STRIP)
412 outs() << "[no dead strip] ";
414 if (Filetype == MachO::MH_OBJECT &&
415 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
416 (NDesc & MachO::N_SYMBOL_RESOLVER) == MachO::N_SYMBOL_RESOLVER)
417 outs() << "[symbol resolver] ";
419 if (Filetype == MachO::MH_OBJECT &&
420 ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
421 (NDesc & MachO::N_ALT_ENTRY) == MachO::N_ALT_ENTRY)
422 outs() << "[alt entry] ";
424 if ((NDesc & MachO::N_ARM_THUMB_DEF) == MachO::N_ARM_THUMB_DEF)
425 outs() << "[Thumb] ";
427 if ((NType & MachO::N_TYPE) == MachO::N_INDR) {
428 outs() << I->Name << " (for ";
429 StringRef IndirectName;
431 MachO->getIndirectName(I->Sym.getRawDataRefImpl(), IndirectName))
434 outs() << IndirectName << ")";
438 if ((Flags & MachO::MH_TWOLEVEL) == MachO::MH_TWOLEVEL &&
439 (((NType & MachO::N_TYPE) == MachO::N_UNDF && NValue == 0) ||
440 (NType & MachO::N_TYPE) == MachO::N_PBUD)) {
441 uint32_t LibraryOrdinal = MachO::GET_LIBRARY_ORDINAL(NDesc);
442 if (LibraryOrdinal != 0) {
443 if (LibraryOrdinal == MachO::EXECUTABLE_ORDINAL)
444 outs() << " (from executable)";
445 else if (LibraryOrdinal == MachO::DYNAMIC_LOOKUP_ORDINAL)
446 outs() << " (dynamically looked up)";
448 StringRef LibraryName;
450 MachO->getLibraryShortNameByIndex(LibraryOrdinal - 1, LibraryName))
451 outs() << " (from bad library ordinal " << LibraryOrdinal << ")";
453 outs() << " (from " << LibraryName << ")";
461 // Table that maps Darwin's Mach-O stab constants to strings to allow printing.
462 struct DarwinStabName {
466 static const struct DarwinStabName DarwinStabNames[] = {
467 {MachO::N_GSYM, "GSYM"},
468 {MachO::N_FNAME, "FNAME"},
469 {MachO::N_FUN, "FUN"},
470 {MachO::N_STSYM, "STSYM"},
471 {MachO::N_LCSYM, "LCSYM"},
472 {MachO::N_BNSYM, "BNSYM"},
474 {MachO::N_AST, "AST"},
475 {MachO::N_OPT, "OPT"},
476 {MachO::N_RSYM, "RSYM"},
477 {MachO::N_SLINE, "SLINE"},
478 {MachO::N_ENSYM, "ENSYM"},
479 {MachO::N_SSYM, "SSYM"},
481 {MachO::N_OSO, "OSO"},
482 {MachO::N_LSYM, "LSYM"},
483 {MachO::N_BINCL, "BINCL"},
484 {MachO::N_SOL, "SOL"},
485 {MachO::N_PARAMS, "PARAM"},
486 {MachO::N_VERSION, "VERS"},
487 {MachO::N_OLEVEL, "OLEV"},
488 {MachO::N_PSYM, "PSYM"},
489 {MachO::N_EINCL, "EINCL"},
490 {MachO::N_ENTRY, "ENTRY"},
491 {MachO::N_LBRAC, "LBRAC"},
492 {MachO::N_EXCL, "EXCL"},
493 {MachO::N_RBRAC, "RBRAC"},
494 {MachO::N_BCOMM, "BCOMM"},
495 {MachO::N_ECOMM, "ECOMM"},
496 {MachO::N_ECOML, "ECOML"},
497 {MachO::N_LENG, "LENG"},
500 static const char *getDarwinStabString(uint8_t NType) {
501 for (unsigned i = 0; DarwinStabNames[i].Name; i++) {
502 if (DarwinStabNames[i].NType == NType)
503 return DarwinStabNames[i].Name;
508 // darwinPrintStab() prints the n_sect, n_desc along with a symbolic name of
509 // a stab n_type value in a Mach-O file.
510 static void darwinPrintStab(MachOObjectFile *MachO, SymbolListT::iterator I) {
511 MachO::nlist_64 STE_64;
516 DataRefImpl SymDRI = I->Sym.getRawDataRefImpl();
517 if (MachO->is64Bit()) {
518 STE_64 = MachO->getSymbol64TableEntry(SymDRI);
519 NType = STE_64.n_type;
520 NSect = STE_64.n_sect;
521 NDesc = STE_64.n_desc;
523 STE = MachO->getSymbolTableEntry(SymDRI);
530 format("%02x", NSect).print(Str, sizeof(Str));
531 outs() << ' ' << Str << ' ';
532 format("%04x", NDesc).print(Str, sizeof(Str));
533 outs() << Str << ' ';
534 if (const char *stabString = getDarwinStabString(NType))
535 format("%5.5s", stabString).print(Str, sizeof(Str));
537 format(" %02x", NType).print(Str, sizeof(Str));
541 static void sortAndPrintSymbolList(SymbolicFile &Obj, bool printName,
542 std::string ArchiveName,
543 std::string ArchitectureName) {
545 std::function<bool(const NMSymbol &, const NMSymbol &)> Cmp;
547 Cmp = compareSymbolAddress;
549 Cmp = compareSymbolSize;
551 Cmp = compareSymbolName;
554 Cmp = [=](const NMSymbol &A, const NMSymbol &B) { return Cmp(B, A); };
555 std::sort(SymbolList.begin(), SymbolList.end(), Cmp);
558 if (!PrintFileName) {
559 if (OutputFormat == posix && MultipleFiles && printName) {
560 outs() << '\n' << CurrentFilename << ":\n";
561 } else if (OutputFormat == bsd && MultipleFiles && printName) {
562 outs() << "\n" << CurrentFilename << ":\n";
563 } else if (OutputFormat == sysv) {
564 outs() << "\n\nSymbols from " << CurrentFilename << ":\n\n"
565 << "Name Value Class Type"
566 << " Size Line Section\n";
570 const char *printBlanks, *printDashes, *printFormat;
571 if (isSymbolList64Bit(Obj)) {
573 printDashes = "----------------";
574 printFormat = "%016" PRIx64;
577 printDashes = "--------";
578 printFormat = "%08" PRIx64;
581 for (SymbolListT::iterator I = SymbolList.begin(), E = SymbolList.end();
583 uint32_t SymFlags = I->Sym.getFlags();
584 bool Undefined = SymFlags & SymbolRef::SF_Undefined;
585 if (!Undefined && UndefinedOnly)
587 if (Undefined && DefinedOnly)
589 bool Global = SymFlags & SymbolRef::SF_Global;
590 if (!Global && ExternalOnly)
592 if (SizeSort && !PrintAddress)
595 if (!ArchitectureName.empty())
596 outs() << "(for architecture " << ArchitectureName << "):";
597 if (!ArchiveName.empty())
598 outs() << ArchiveName << ":";
599 outs() << CurrentFilename << ": ";
601 if ((JustSymbolName || (UndefinedOnly && isa<MachOObjectFile>(Obj) &&
602 OutputFormat != darwin)) && OutputFormat != posix) {
603 outs() << I->Name << "\n";
607 char SymbolAddrStr[18] = "";
608 char SymbolSizeStr[18] = "";
610 if (OutputFormat == sysv || I->TypeChar == 'U')
611 strcpy(SymbolAddrStr, printBlanks);
612 if (OutputFormat == sysv)
613 strcpy(SymbolSizeStr, printBlanks);
615 if (I->TypeChar != 'U') {
617 strcpy(SymbolAddrStr, printDashes);
619 format(printFormat, I->Address)
620 .print(SymbolAddrStr, sizeof(SymbolAddrStr));
622 format(printFormat, I->Size).print(SymbolSizeStr, sizeof(SymbolSizeStr));
624 // If OutputFormat is darwin or we are printing Mach-O symbols in hex and
625 // we have a MachOObjectFile, call darwinPrintSymbol to print as darwin's
626 // nm(1) -m output or hex, else if OutputFormat is darwin or we are
627 // printing Mach-O symbols in hex and not a Mach-O object fall back to
628 // OutputFormat bsd (see below).
629 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
630 if ((OutputFormat == darwin || FormatMachOasHex) && (MachO || Obj.isIR())) {
631 darwinPrintSymbol(Obj, I, SymbolAddrStr, printBlanks, printDashes,
633 } else if (OutputFormat == posix) {
634 outs() << I->Name << " " << I->TypeChar << " ";
636 outs() << I->Address << " " << "0" /* SymbolSizeStr */ << "\n";
638 outs() << SymbolAddrStr << SymbolSizeStr << "\n";
639 } else if (OutputFormat == bsd || (OutputFormat == darwin && !MachO)) {
641 outs() << SymbolAddrStr << ' ';
643 outs() << SymbolSizeStr;
646 outs() << I->TypeChar;
647 if (I->TypeChar == '-' && MachO)
648 darwinPrintStab(MachO, I);
649 outs() << " " << I->Name << "\n";
650 } else if (OutputFormat == sysv) {
651 std::string PaddedName(I->Name);
652 while (PaddedName.length() < 20)
654 outs() << PaddedName << "|" << SymbolAddrStr << "| " << I->TypeChar
655 << " | |" << SymbolSizeStr << "| |\n";
662 static char getSymbolNMTypeChar(ELFObjectFileBase &Obj,
663 basic_symbol_iterator I) {
665 elf_symbol_iterator SymI(I);
667 ErrorOr<elf_section_iterator> SecIOrErr = SymI->getSection();
668 if (error(SecIOrErr.getError()))
671 elf_section_iterator SecI = *SecIOrErr;
672 if (SecI != Obj.section_end()) {
673 switch (SecI->getType()) {
674 case ELF::SHT_PROGBITS:
675 case ELF::SHT_DYNAMIC:
676 switch (SecI->getFlags()) {
677 case (ELF::SHF_ALLOC | ELF::SHF_EXECINSTR):
679 case (ELF::SHF_TLS | ELF::SHF_ALLOC | ELF::SHF_WRITE):
680 case (ELF::SHF_ALLOC | ELF::SHF_WRITE):
683 case (ELF::SHF_ALLOC | ELF::SHF_MERGE):
684 case (ELF::SHF_ALLOC | ELF::SHF_MERGE | ELF::SHF_STRINGS):
688 case ELF::SHT_NOBITS:
693 if (SymI->getELFType() == ELF::STT_SECTION) {
694 ErrorOr<StringRef> Name = SymI->getName();
695 if (error(Name.getError()))
697 return StringSwitch<char>(*Name)
698 .StartsWith(".debug", 'N')
699 .StartsWith(".note", 'n')
706 static char getSymbolNMTypeChar(COFFObjectFile &Obj, symbol_iterator I) {
707 COFFSymbolRef Symb = Obj.getCOFFSymbol(*I);
709 symbol_iterator SymI(I);
711 ErrorOr<StringRef> Name = SymI->getName();
712 if (error(Name.getError()))
715 char Ret = StringSwitch<char>(*Name)
716 .StartsWith(".debug", 'N')
717 .StartsWith(".sxdata", 'N')
723 uint32_t Characteristics = 0;
724 if (!COFF::isReservedSectionNumber(Symb.getSectionNumber())) {
725 ErrorOr<section_iterator> SecIOrErr = SymI->getSection();
726 if (error(SecIOrErr.getError()))
728 section_iterator SecI = *SecIOrErr;
729 const coff_section *Section = Obj.getCOFFSection(*SecI);
730 Characteristics = Section->Characteristics;
733 switch (Symb.getSectionNumber()) {
734 case COFF::IMAGE_SYM_DEBUG:
737 // Check section type.
738 if (Characteristics & COFF::IMAGE_SCN_CNT_CODE)
740 if (Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
741 return Characteristics & COFF::IMAGE_SCN_MEM_WRITE ? 'd' : 'r';
742 if (Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)
744 if (Characteristics & COFF::IMAGE_SCN_LNK_INFO)
746 // Check for section symbol.
747 if (Symb.isSectionDefinition())
754 static uint8_t getNType(MachOObjectFile &Obj, DataRefImpl Symb) {
756 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
759 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
763 static char getSymbolNMTypeChar(MachOObjectFile &Obj, basic_symbol_iterator I) {
764 DataRefImpl Symb = I->getRawDataRefImpl();
765 uint8_t NType = getNType(Obj, Symb);
767 if (NType & MachO::N_STAB)
770 switch (NType & MachO::N_TYPE) {
775 case MachO::N_SECT: {
776 section_iterator Sec = *Obj.getSymbolSection(Symb);
777 DataRefImpl Ref = Sec->getRawDataRefImpl();
778 StringRef SectionName;
779 Obj.getSectionName(Ref, SectionName);
780 StringRef SegmentName = Obj.getSectionFinalSegmentName(Ref);
781 if (SegmentName == "__TEXT" && SectionName == "__text")
783 else if (SegmentName == "__DATA" && SectionName == "__data")
785 else if (SegmentName == "__DATA" && SectionName == "__bss")
795 static char getSymbolNMTypeChar(const GlobalValue &GV) {
796 if (GV.getType()->getElementType()->isFunctionTy())
798 // FIXME: should we print 'b'? At the IR level we cannot be sure if this
799 // will be in bss or not, but we could approximate.
803 static char getSymbolNMTypeChar(IRObjectFile &Obj, basic_symbol_iterator I) {
804 const GlobalValue *GV = Obj.getSymbolGV(I->getRawDataRefImpl());
807 return getSymbolNMTypeChar(*GV);
810 static bool isObject(SymbolicFile &Obj, basic_symbol_iterator I) {
811 auto *ELF = dyn_cast<ELFObjectFileBase>(&Obj);
815 return elf_symbol_iterator(I)->getELFType() == ELF::STT_OBJECT;
818 static char getNMTypeChar(SymbolicFile &Obj, basic_symbol_iterator I) {
819 uint32_t Symflags = I->getFlags();
820 if ((Symflags & object::SymbolRef::SF_Weak) && !isa<MachOObjectFile>(Obj)) {
821 char Ret = isObject(Obj, I) ? 'v' : 'w';
822 if (!(Symflags & object::SymbolRef::SF_Undefined))
827 if (Symflags & object::SymbolRef::SF_Undefined)
830 if (Symflags & object::SymbolRef::SF_Common)
834 if (Symflags & object::SymbolRef::SF_Absolute)
836 else if (IRObjectFile *IR = dyn_cast<IRObjectFile>(&Obj)) {
837 Ret = getSymbolNMTypeChar(*IR, I);
838 Triple Host(sys::getDefaultTargetTriple());
839 if (Ret == 'd' && Host.isOSDarwin()) {
840 if(Symflags & SymbolRef::SF_Const)
844 else if (COFFObjectFile *COFF = dyn_cast<COFFObjectFile>(&Obj))
845 Ret = getSymbolNMTypeChar(*COFF, I);
846 else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj))
847 Ret = getSymbolNMTypeChar(*MachO, I);
849 Ret = getSymbolNMTypeChar(cast<ELFObjectFileBase>(Obj), I);
851 if (Symflags & object::SymbolRef::SF_Global)
857 // getNsectForSegSect() is used to implement the Mach-O "-s segname sectname"
858 // option to dump only those symbols from that section in a Mach-O file.
859 // It is called once for each Mach-O file from dumpSymbolNamesFromObject()
860 // to get the section number for that named section from the command line
861 // arguments. It returns the section number for that section in the Mach-O
862 // file or zero it is not present.
863 static unsigned getNsectForSegSect(MachOObjectFile *Obj) {
865 for (section_iterator I = Obj->section_begin(), E = Obj->section_end();
867 DataRefImpl Ref = I->getRawDataRefImpl();
868 StringRef SectionName;
869 Obj->getSectionName(Ref, SectionName);
870 StringRef SegmentName = Obj->getSectionFinalSegmentName(Ref);
871 if (SegmentName == SegSect[0] && SectionName == SegSect[1])
878 // getNsectInMachO() is used to implement the Mach-O "-s segname sectname"
879 // option to dump only those symbols from that section in a Mach-O file.
880 // It is called once for each symbol in a Mach-O file from
881 // dumpSymbolNamesFromObject() and returns the section number for that symbol
882 // if it is in a section, else it returns 0.
883 static unsigned getNsectInMachO(MachOObjectFile &Obj, BasicSymbolRef Sym) {
884 DataRefImpl Symb = Sym.getRawDataRefImpl();
886 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
887 if ((STE.n_type & MachO::N_TYPE) == MachO::N_SECT)
891 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
892 if ((STE.n_type & MachO::N_TYPE) == MachO::N_SECT)
897 static void dumpSymbolNamesFromObject(SymbolicFile &Obj, bool printName,
898 std::string ArchiveName = std::string(),
899 std::string ArchitectureName =
901 auto Symbols = Obj.symbols();
903 const auto *E = dyn_cast<ELFObjectFileBase>(&Obj);
905 error("File format has no dynamic symbol table", Obj.getFileName());
908 auto DynSymbols = E->getDynamicSymbolIterators();
910 make_range<basic_symbol_iterator>(DynSymbols.begin(), DynSymbols.end());
912 std::string NameBuffer;
913 raw_string_ostream OS(NameBuffer);
914 // If a "-s segname sectname" option was specified and this is a Mach-O
915 // file get the section number for that section in this object file.
916 unsigned int Nsect = 0;
917 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(&Obj);
918 if (SegSect.size() != 0 && MachO) {
919 Nsect = getNsectForSegSect(MachO);
920 // If this section is not in the object file no symbols are printed.
924 for (BasicSymbolRef Sym : Symbols) {
925 uint32_t SymFlags = Sym.getFlags();
926 if (!DebugSyms && (SymFlags & SymbolRef::SF_FormatSpecific))
928 if (WithoutAliases) {
929 if (IRObjectFile *IR = dyn_cast<IRObjectFile>(&Obj)) {
930 const GlobalValue *GV = IR->getSymbolGV(Sym.getRawDataRefImpl());
931 if (GV && isa<GlobalAlias>(GV))
935 // If a "-s segname sectname" option was specified and this is a Mach-O
936 // file and this section appears in this file, Nsect will be non-zero then
937 // see if this symbol is a symbol from that section and if not skip it.
938 if (Nsect && Nsect != getNsectInMachO(*MachO, Sym))
944 if (isa<ELFObjectFileBase>(&Obj))
945 S.Size = ELFSymbolRef(Sym).getSize();
947 if (PrintAddress && isa<ObjectFile>(Obj)) {
948 SymbolRef SymRef(Sym);
949 ErrorOr<uint64_t> AddressOrErr = SymRef.getAddress();
950 if (error(AddressOrErr.getError()))
952 S.Address = *AddressOrErr;
954 S.TypeChar = getNMTypeChar(Obj, Sym);
955 if (error(Sym.printName(OS)))
959 SymbolList.push_back(S);
963 const char *P = NameBuffer.c_str();
964 for (unsigned I = 0; I < SymbolList.size(); ++I) {
965 SymbolList[I].Name = P;
969 CurrentFilename = Obj.getFileName();
970 sortAndPrintSymbolList(Obj, printName, ArchiveName, ArchitectureName);
973 // checkMachOAndArchFlags() checks to see if the SymbolicFile is a Mach-O file
974 // and if it is and there is a list of architecture flags is specified then
975 // check to make sure this Mach-O file is one of those architectures or all
976 // architectures was specificed. If not then an error is generated and this
977 // routine returns false. Else it returns true.
978 static bool checkMachOAndArchFlags(SymbolicFile *O, std::string &Filename) {
979 MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(O);
981 if (!MachO || ArchAll || ArchFlags.size() == 0)
984 MachO::mach_header H;
985 MachO::mach_header_64 H_64;
987 if (MachO->is64Bit()) {
988 H_64 = MachO->MachOObjectFile::getHeader64();
989 T = MachOObjectFile::getArch(H_64.cputype, H_64.cpusubtype);
991 H = MachO->MachOObjectFile::getHeader();
992 T = MachOObjectFile::getArch(H.cputype, H.cpusubtype);
995 ArchFlags.begin(), ArchFlags.end(),
996 [&](const std::string &Name) { return Name == T.getArchName(); })) {
997 error("No architecture specified", Filename);
1003 static void dumpSymbolNamesFromFile(std::string &Filename) {
1004 ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
1005 MemoryBuffer::getFileOrSTDIN(Filename);
1006 if (error(BufferOrErr.getError(), Filename))
1009 LLVMContext &Context = getGlobalContext();
1010 ErrorOr<std::unique_ptr<Binary>> BinaryOrErr = createBinary(
1011 BufferOrErr.get()->getMemBufferRef(), NoLLVMBitcode ? nullptr : &Context);
1012 if (error(BinaryOrErr.getError(), Filename))
1014 Binary &Bin = *BinaryOrErr.get();
1016 if (Archive *A = dyn_cast<Archive>(&Bin)) {
1018 Archive::symbol_iterator I = A->symbol_begin();
1019 Archive::symbol_iterator E = A->symbol_end();
1021 outs() << "Archive map\n";
1022 for (; I != E; ++I) {
1023 ErrorOr<Archive::Child> C = I->getMember();
1024 if (error(C.getError()))
1026 ErrorOr<StringRef> FileNameOrErr = C->getName();
1027 if (error(FileNameOrErr.getError()))
1029 StringRef SymName = I->getName();
1030 outs() << SymName << " in " << FileNameOrErr.get() << "\n";
1036 for (Archive::child_iterator I = A->child_begin(), E = A->child_end();
1038 if (error(I->getError()))
1041 ErrorOr<std::unique_ptr<Binary>> ChildOrErr = C.getAsBinary(&Context);
1042 if (ChildOrErr.getError())
1044 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1045 if (!checkMachOAndArchFlags(O, Filename))
1047 if (!PrintFileName) {
1049 if (isa<MachOObjectFile>(O)) {
1050 outs() << Filename << "(" << O->getFileName() << ")";
1052 outs() << O->getFileName();
1055 dumpSymbolNamesFromObject(*O, false, Filename);
1060 if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(&Bin)) {
1061 // If we have a list of architecture flags specified dump only those.
1062 if (!ArchAll && ArchFlags.size() != 0) {
1063 // Look for a slice in the universal binary that matches each ArchFlag.
1065 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
1067 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1068 E = UB->end_objects();
1070 if (ArchFlags[i] == I->getArchTypeName()) {
1072 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr =
1073 I->getAsObjectFile();
1074 std::string ArchiveName;
1075 std::string ArchitectureName;
1076 ArchiveName.clear();
1077 ArchitectureName.clear();
1079 ObjectFile &Obj = *ObjOrErr.get();
1080 if (ArchFlags.size() > 1) {
1082 ArchitectureName = I->getArchTypeName();
1084 outs() << "\n" << Obj.getFileName() << " (for architecture "
1085 << I->getArchTypeName() << ")"
1088 dumpSymbolNamesFromObject(Obj, false, ArchiveName,
1090 } else if (ErrorOr<std::unique_ptr<Archive>> AOrErr =
1091 I->getAsArchive()) {
1092 std::unique_ptr<Archive> &A = *AOrErr;
1093 for (Archive::child_iterator AI = A->child_begin(),
1094 AE = A->child_end();
1096 if (error(AI->getError()))
1098 auto &C = AI->get();
1099 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
1100 C.getAsBinary(&Context);
1101 if (ChildOrErr.getError())
1103 if (SymbolicFile *O =
1104 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1105 if (PrintFileName) {
1106 ArchiveName = A->getFileName();
1107 if (ArchFlags.size() > 1)
1108 ArchitectureName = I->getArchTypeName();
1110 outs() << "\n" << A->getFileName();
1111 outs() << "(" << O->getFileName() << ")";
1112 if (ArchFlags.size() > 1) {
1113 outs() << " (for architecture " << I->getArchTypeName()
1118 dumpSymbolNamesFromObject(*O, false, ArchiveName,
1127 "file: " + Filename + " does not contain architecture");
1133 // No architecture flags were specified so if this contains a slice that
1134 // matches the host architecture dump only that.
1136 StringRef HostArchName = MachOObjectFile::getHostArch().getArchName();
1137 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1138 E = UB->end_objects();
1140 if (HostArchName == I->getArchTypeName()) {
1141 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
1142 std::string ArchiveName;
1143 ArchiveName.clear();
1145 ObjectFile &Obj = *ObjOrErr.get();
1146 dumpSymbolNamesFromObject(Obj, false);
1147 } else if (ErrorOr<std::unique_ptr<Archive>> AOrErr =
1148 I->getAsArchive()) {
1149 std::unique_ptr<Archive> &A = *AOrErr;
1150 for (Archive::child_iterator AI = A->child_begin(),
1151 AE = A->child_end();
1153 if (error(AI->getError()))
1155 auto &C = AI->get();
1156 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
1157 C.getAsBinary(&Context);
1158 if (ChildOrErr.getError())
1160 if (SymbolicFile *O =
1161 dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1163 ArchiveName = A->getFileName();
1165 outs() << "\n" << A->getFileName() << "(" << O->getFileName()
1168 dumpSymbolNamesFromObject(*O, false, ArchiveName);
1176 // Either all architectures have been specified or none have been specified
1177 // and this does not contain the host architecture so dump all the slices.
1178 bool moreThanOneArch = UB->getNumberOfObjects() > 1;
1179 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1180 E = UB->end_objects();
1182 ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
1183 std::string ArchiveName;
1184 std::string ArchitectureName;
1185 ArchiveName.clear();
1186 ArchitectureName.clear();
1188 ObjectFile &Obj = *ObjOrErr.get();
1189 if (PrintFileName) {
1190 if (isa<MachOObjectFile>(Obj) && moreThanOneArch)
1191 ArchitectureName = I->getArchTypeName();
1193 if (moreThanOneArch)
1195 outs() << Obj.getFileName();
1196 if (isa<MachOObjectFile>(Obj) && moreThanOneArch)
1197 outs() << " (for architecture " << I->getArchTypeName() << ")";
1200 dumpSymbolNamesFromObject(Obj, false, ArchiveName, ArchitectureName);
1201 } else if (ErrorOr<std::unique_ptr<Archive>> AOrErr = I->getAsArchive()) {
1202 std::unique_ptr<Archive> &A = *AOrErr;
1203 for (Archive::child_iterator AI = A->child_begin(), AE = A->child_end();
1205 if (error(AI->getError()))
1207 auto &C = AI->get();
1208 ErrorOr<std::unique_ptr<Binary>> ChildOrErr = C.getAsBinary(&Context);
1209 if (ChildOrErr.getError())
1211 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1212 if (PrintFileName) {
1213 ArchiveName = A->getFileName();
1214 if (isa<MachOObjectFile>(O) && moreThanOneArch)
1215 ArchitectureName = I->getArchTypeName();
1217 outs() << "\n" << A->getFileName();
1218 if (isa<MachOObjectFile>(O)) {
1219 outs() << "(" << O->getFileName() << ")";
1220 if (moreThanOneArch)
1221 outs() << " (for architecture " << I->getArchTypeName()
1224 outs() << ":" << O->getFileName();
1227 dumpSymbolNamesFromObject(*O, false, ArchiveName, ArchitectureName);
1234 if (SymbolicFile *O = dyn_cast<SymbolicFile>(&Bin)) {
1235 if (!checkMachOAndArchFlags(O, Filename))
1237 dumpSymbolNamesFromObject(*O, true);
1240 error("unrecognizable file type", Filename);
1243 int main(int argc, char **argv) {
1244 // Print a stack trace if we signal out.
1245 sys::PrintStackTraceOnErrorSignal();
1246 PrettyStackTraceProgram X(argc, argv);
1248 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
1249 cl::ParseCommandLineOptions(argc, argv, "llvm symbol table dumper\n");
1251 // llvm-nm only reads binary files.
1252 if (error(sys::ChangeStdinToBinary()))
1255 llvm::InitializeAllTargetInfos();
1256 llvm::InitializeAllTargetMCs();
1257 llvm::InitializeAllAsmParsers();
1263 OutputFormat = posix;
1265 OutputFormat = darwin;
1267 // The relative order of these is important. If you pass --size-sort it should
1268 // only print out the size. However, if you pass -S --size-sort, it should
1269 // print out both the size and address.
1270 if (SizeSort && !PrintSize)
1271 PrintAddress = false;
1272 if (OutputFormat == sysv || SizeSort)
1275 switch (InputFilenames.size()) {
1277 InputFilenames.push_back("a.out");
1281 MultipleFiles = true;
1284 for (unsigned i = 0; i < ArchFlags.size(); ++i) {
1285 if (ArchFlags[i] == "all") {
1288 if (!MachOObjectFile::isValidArch(ArchFlags[i]))
1289 error("Unknown architecture named '" + ArchFlags[i] + "'",
1290 "for the -arch option");
1294 if (SegSect.size() != 0 && SegSect.size() != 2)
1295 error("bad number of arguments (must be two arguments)",
1296 "for the -s option");
1298 std::for_each(InputFilenames.begin(), InputFilenames.end(),
1299 dumpSymbolNamesFromFile);