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/system_error.h"
47 using namespace object;
50 enum OutputFormatTy { bsd, sysv, posix };
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"), clEnumValEnd),
56 cl::alias OutputFormat2("f", cl::desc("Alias for --format"),
57 cl::aliasopt(OutputFormat));
59 cl::list<std::string> InputFilenames(cl::Positional, cl::desc("<input files>"),
62 cl::opt<bool> UndefinedOnly("undefined-only",
63 cl::desc("Show only undefined symbols"));
64 cl::alias UndefinedOnly2("u", cl::desc("Alias for --undefined-only"),
65 cl::aliasopt(UndefinedOnly));
67 cl::opt<bool> DynamicSyms("dynamic",
68 cl::desc("Display the dynamic symbols instead "
69 "of normal symbols."));
70 cl::alias DynamicSyms2("D", cl::desc("Alias for --dynamic"),
71 cl::aliasopt(DynamicSyms));
73 cl::opt<bool> DefinedOnly("defined-only",
74 cl::desc("Show only defined symbols"));
76 cl::opt<bool> ExternalOnly("extern-only",
77 cl::desc("Show only external symbols"));
78 cl::alias ExternalOnly2("g", cl::desc("Alias for --extern-only"),
79 cl::aliasopt(ExternalOnly));
81 cl::opt<bool> BSDFormat("B", cl::desc("Alias for --format=bsd"));
82 cl::opt<bool> POSIXFormat("P", cl::desc("Alias for --format=posix"));
84 cl::opt<bool> PrintFileName(
86 cl::desc("Precede each symbol with the object file it came from"));
88 cl::alias PrintFileNameA("A", cl::desc("Alias for --print-file-name"),
89 cl::aliasopt(PrintFileName));
90 cl::alias PrintFileNameo("o", cl::desc("Alias for --print-file-name"),
91 cl::aliasopt(PrintFileName));
93 cl::opt<bool> DebugSyms("debug-syms",
94 cl::desc("Show all symbols, even debugger only"));
95 cl::alias DebugSymsa("a", cl::desc("Alias for --debug-syms"),
96 cl::aliasopt(DebugSyms));
98 cl::opt<bool> NumericSort("numeric-sort", cl::desc("Sort symbols by value"));
99 cl::alias NumericSortn("n", cl::desc("Alias for --numeric-sort"),
100 cl::aliasopt(NumericSort));
101 cl::alias NumericSortv("v", cl::desc("Alias for --numeric-sort"),
102 cl::aliasopt(NumericSort));
104 cl::opt<bool> NoSort("no-sort", cl::desc("Show symbols in order encountered"));
105 cl::alias NoSortp("p", cl::desc("Alias for --no-sort"), cl::aliasopt(NoSort));
107 cl::opt<bool> PrintSize("print-size",
108 cl::desc("Show symbol size instead of value"));
109 cl::alias PrintSizeS("S", cl::desc("Alias for --print-size"),
110 cl::aliasopt(PrintSize));
112 cl::opt<bool> SizeSort("size-sort", cl::desc("Sort symbols by size"));
114 cl::opt<bool> WithoutAliases("without-aliases", cl::Hidden,
115 cl::desc("Exclude aliases from output"));
117 cl::opt<bool> ArchiveMap("print-armap", cl::desc("Print the archive map"));
118 cl::alias ArchiveMaps("s", cl::desc("Alias for --print-armap"),
119 cl::aliasopt(ArchiveMap));
120 bool PrintValue = true;
122 bool MultipleFiles = false;
124 bool HadError = false;
126 std::string ToolName;
129 static void error(Twine Message, Twine Path = Twine()) {
131 errs() << ToolName << ": " << Path << ": " << Message << ".\n";
134 static bool error(error_code EC, Twine Path = Twine()) {
136 error(EC.message(), Path);
151 static bool compareSymbolValue(const NMSymbol &A, const NMSymbol &B) {
152 if (A.Value < B.Value)
154 else if (A.Value == B.Value && A.Name < B.Name)
156 else if (A.Value == B.Value && A.Name == B.Name && A.Size < B.Size)
162 static bool compareSymbolSize(const NMSymbol &A, const NMSymbol &B) {
165 else if (A.Size == B.Size && A.Name < B.Name)
167 else if (A.Size == B.Size && A.Name == B.Name && A.Value < B.Value)
173 static bool compareSymbolName(const NMSymbol &A, const NMSymbol &B) {
176 else if (A.Name == B.Name && A.Size < B.Size)
178 else if (A.Name == B.Name && A.Size == B.Size && A.Value < B.Value)
184 static StringRef CurrentFilename;
185 typedef std::vector<NMSymbol> SymbolListT;
186 static SymbolListT SymbolList;
188 static void sortAndPrintSymbolList() {
191 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolValue);
193 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolSize);
195 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolName);
198 if (OutputFormat == posix && MultipleFiles) {
199 outs() << '\n' << CurrentFilename << ":\n";
200 } else if (OutputFormat == bsd && MultipleFiles) {
201 outs() << "\n" << CurrentFilename << ":\n";
202 } else if (OutputFormat == sysv) {
203 outs() << "\n\nSymbols from " << CurrentFilename << ":\n\n"
204 << "Name Value Class Type"
205 << " Size Line Section\n";
208 for (SymbolListT::iterator I = SymbolList.begin(), E = SymbolList.end();
210 if ((I->TypeChar != 'U') && UndefinedOnly)
212 if ((I->TypeChar == 'U') && DefinedOnly)
214 if (SizeSort && !PrintValue && I->Size == UnknownAddressOrSize)
217 char SymbolValueStr[10] = "";
218 char SymbolSizeStr[10] = "";
220 if (OutputFormat == sysv || I->Value == UnknownAddressOrSize)
221 strcpy(SymbolValueStr, " ");
222 if (OutputFormat == sysv)
223 strcpy(SymbolSizeStr, " ");
225 if (I->Value != UnknownAddressOrSize)
226 format("%08" PRIx64, I->Value)
227 .print(SymbolValueStr, sizeof(SymbolValueStr));
228 if (I->Size != UnknownAddressOrSize)
229 format("%08" PRIx64, I->Size).print(SymbolSizeStr, sizeof(SymbolSizeStr));
231 if (OutputFormat == posix) {
232 outs() << I->Name << " " << I->TypeChar << " " << SymbolValueStr
233 << SymbolSizeStr << "\n";
234 } else if (OutputFormat == bsd) {
236 outs() << SymbolValueStr << ' ';
238 outs() << SymbolSizeStr;
239 if (I->Size != UnknownAddressOrSize)
242 outs() << I->TypeChar << " " << I->Name << "\n";
243 } else if (OutputFormat == sysv) {
244 std::string PaddedName(I->Name);
245 while (PaddedName.length() < 20)
247 outs() << PaddedName << "|" << SymbolValueStr << "| " << I->TypeChar
248 << " | |" << SymbolSizeStr << "| |\n";
255 template <class ELFT>
256 static char getSymbolNMTypeChar(ELFObjectFile<ELFT> &Obj,
257 basic_symbol_iterator I) {
258 typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
259 typedef typename ELFObjectFile<ELFT>::Elf_Shdr Elf_Shdr;
262 symbol_iterator SymI(I);
264 DataRefImpl Symb = I->getRawDataRefImpl();
265 const Elf_Sym *ESym = Obj.getSymbol(Symb);
266 const ELFFile<ELFT> &EF = *Obj.getELFFile();
267 const Elf_Shdr *ESec = EF.getSection(ESym);
270 switch (ESec->sh_type) {
271 case ELF::SHT_PROGBITS:
272 case ELF::SHT_DYNAMIC:
273 switch (ESec->sh_flags) {
274 case(ELF::SHF_ALLOC | ELF::SHF_EXECINSTR) :
276 case(ELF::SHF_TLS | ELF::SHF_ALLOC | ELF::SHF_WRITE) :
277 case(ELF::SHF_ALLOC | ELF::SHF_WRITE) :
280 case(ELF::SHF_ALLOC | ELF::SHF_MERGE) :
281 case(ELF::SHF_ALLOC | ELF::SHF_MERGE | ELF::SHF_STRINGS) :
285 case ELF::SHT_NOBITS:
290 if (ESym->getType() == ELF::STT_SECTION) {
292 if (error(SymI->getName(Name)))
294 return StringSwitch<char>(Name)
295 .StartsWith(".debug", 'N')
296 .StartsWith(".note", 'n')
303 static char getSymbolNMTypeChar(COFFObjectFile &Obj, symbol_iterator I) {
304 const coff_symbol *Symb = Obj.getCOFFSymbol(*I);
306 symbol_iterator SymI(I);
309 if (error(SymI->getName(Name)))
312 char Ret = StringSwitch<char>(Name)
313 .StartsWith(".debug", 'N')
314 .StartsWith(".sxdata", 'N')
320 uint32_t Characteristics = 0;
321 if (!COFF::isReservedSectionNumber(Symb->SectionNumber)) {
322 section_iterator SecI = Obj.section_end();
323 if (error(SymI->getSection(SecI)))
325 const coff_section *Section = Obj.getCOFFSection(*SecI);
326 Characteristics = Section->Characteristics;
329 switch (Symb->SectionNumber) {
330 case COFF::IMAGE_SYM_DEBUG:
333 // Check section type.
334 if (Characteristics & COFF::IMAGE_SCN_CNT_CODE)
336 else if (Characteristics & COFF::IMAGE_SCN_MEM_READ &&
337 ~Characteristics & COFF::IMAGE_SCN_MEM_WRITE) // Read only.
339 else if (Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
341 else if (Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)
343 else if (Characteristics & COFF::IMAGE_SCN_LNK_INFO)
346 // Check for section symbol.
347 else if (Symb->isSectionDefinition())
354 static uint8_t getNType(MachOObjectFile &Obj, DataRefImpl Symb) {
356 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
359 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
363 static char getSymbolNMTypeChar(MachOObjectFile &Obj, basic_symbol_iterator I) {
364 DataRefImpl Symb = I->getRawDataRefImpl();
365 uint8_t NType = getNType(Obj, Symb);
367 switch (NType & MachO::N_TYPE) {
370 case MachO::N_SECT: {
371 section_iterator Sec = Obj.section_end();
372 Obj.getSymbolSection(Symb, Sec);
373 DataRefImpl Ref = Sec->getRawDataRefImpl();
374 StringRef SectionName;
375 Obj.getSectionName(Ref, SectionName);
376 StringRef SegmentName = Obj.getSectionFinalSegmentName(Ref);
377 if (SegmentName == "__TEXT" && SectionName == "__text")
387 static char getSymbolNMTypeChar(const GlobalValue &GV) {
388 if (isa<Function>(GV))
390 // FIXME: should we print 'b'? At the IR level we cannot be sure if this
391 // will be in bss or not, but we could approximate.
392 if (isa<GlobalVariable>(GV))
394 const GlobalAlias *GA = cast<GlobalAlias>(&GV);
395 const GlobalValue *AliasedGV = GA->getAliasedGlobal();
396 return getSymbolNMTypeChar(*AliasedGV);
399 static char getSymbolNMTypeChar(IRObjectFile &Obj, basic_symbol_iterator I) {
400 const GlobalValue &GV = Obj.getSymbolGV(I->getRawDataRefImpl());
401 return getSymbolNMTypeChar(GV);
404 template <class ELFT>
405 static bool isObject(ELFObjectFile<ELFT> &Obj, symbol_iterator I) {
406 typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
408 DataRefImpl Symb = I->getRawDataRefImpl();
409 const Elf_Sym *ESym = Obj.getSymbol(Symb);
411 return ESym->getType() == ELF::STT_OBJECT;
414 static bool isObject(SymbolicFile *Obj, basic_symbol_iterator I) {
415 if (ELF32LEObjectFile *ELF = dyn_cast<ELF32LEObjectFile>(Obj))
416 return isObject(*ELF, I);
417 if (ELF64LEObjectFile *ELF = dyn_cast<ELF64LEObjectFile>(Obj))
418 return isObject(*ELF, I);
419 if (ELF32BEObjectFile *ELF = dyn_cast<ELF32BEObjectFile>(Obj))
420 return isObject(*ELF, I);
421 if (ELF64BEObjectFile *ELF = dyn_cast<ELF64BEObjectFile>(Obj))
422 return isObject(*ELF, I);
426 static char getNMTypeChar(SymbolicFile *Obj, basic_symbol_iterator I) {
427 uint32_t Symflags = I->getFlags();
428 if ((Symflags & object::SymbolRef::SF_Weak) && !isa<MachOObjectFile>(Obj)) {
429 char Ret = isObject(Obj, I) ? 'v' : 'w';
430 if (!(Symflags & object::SymbolRef::SF_Undefined))
435 if (Symflags & object::SymbolRef::SF_Undefined)
438 if (Symflags & object::SymbolRef::SF_Common)
442 if (Symflags & object::SymbolRef::SF_Absolute)
444 else if (IRObjectFile *IR = dyn_cast<IRObjectFile>(Obj))
445 Ret = getSymbolNMTypeChar(*IR, I);
446 else if (COFFObjectFile *COFF = dyn_cast<COFFObjectFile>(Obj))
447 Ret = getSymbolNMTypeChar(*COFF, I);
448 else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(Obj))
449 Ret = getSymbolNMTypeChar(*MachO, I);
450 else if (ELF32LEObjectFile *ELF = dyn_cast<ELF32LEObjectFile>(Obj))
451 Ret = getSymbolNMTypeChar(*ELF, I);
452 else if (ELF64LEObjectFile *ELF = dyn_cast<ELF64LEObjectFile>(Obj))
453 Ret = getSymbolNMTypeChar(*ELF, I);
454 else if (ELF32BEObjectFile *ELF = dyn_cast<ELF32BEObjectFile>(Obj))
455 Ret = getSymbolNMTypeChar(*ELF, I);
457 Ret = getSymbolNMTypeChar(*cast<ELF64BEObjectFile>(Obj), I);
459 if (Symflags & object::SymbolRef::SF_Global)
465 static void dumpSymbolNamesFromObject(SymbolicFile *Obj) {
466 basic_symbol_iterator IBegin = Obj->symbol_begin();
467 basic_symbol_iterator IEnd = Obj->symbol_end();
470 error("File format has no dynamic symbol table", Obj->getFileName());
473 std::pair<symbol_iterator, symbol_iterator> IDyn =
474 getELFDynamicSymbolIterators(Obj);
478 std::string NameBuffer;
479 raw_string_ostream OS(NameBuffer);
480 for (basic_symbol_iterator I = IBegin; I != IEnd; ++I) {
481 uint32_t SymFlags = I->getFlags();
482 if (!DebugSyms && (SymFlags & SymbolRef::SF_FormatSpecific))
484 if (WithoutAliases) {
485 if (IRObjectFile *IR = dyn_cast<IRObjectFile>(Obj)) {
486 const GlobalValue &GV = IR->getSymbolGV(I->getRawDataRefImpl());
487 if(isa<GlobalAlias>(GV))
492 S.Size = UnknownAddressOrSize;
493 S.Value = UnknownAddressOrSize;
494 if ((PrintSize || SizeSort) && isa<ObjectFile>(Obj)) {
495 symbol_iterator SymI = I;
496 if (error(SymI->getSize(S.Size)))
499 if (PrintValue && isa<ObjectFile>(Obj))
500 if (error(symbol_iterator(I)->getValue(S.Value)))
502 S.TypeChar = getNMTypeChar(Obj, I);
503 if (error(I->printName(OS)))
506 SymbolList.push_back(S);
510 const char *P = NameBuffer.c_str();
511 for (unsigned I = 0; I < SymbolList.size(); ++I) {
512 SymbolList[I].Name = P;
516 CurrentFilename = Obj->getFileName();
517 sortAndPrintSymbolList();
520 static void dumpSymbolNamesFromFile(std::string &Filename) {
521 std::unique_ptr<MemoryBuffer> Buffer;
522 if (error(MemoryBuffer::getFileOrSTDIN(Filename, Buffer), Filename))
525 LLVMContext &Context = getGlobalContext();
526 ErrorOr<Binary *> BinaryOrErr = createBinary(Buffer.release(), &Context);
527 if (error(BinaryOrErr.getError(), Filename))
529 std::unique_ptr<Binary> Bin(BinaryOrErr.get());
531 if (Archive *A = dyn_cast<Archive>(Bin.get())) {
533 Archive::symbol_iterator I = A->symbol_begin();
534 Archive::symbol_iterator E = A->symbol_end();
536 outs() << "Archive map\n";
537 for (; I != E; ++I) {
538 Archive::child_iterator C;
541 if (error(I->getMember(C)))
543 if (error(I->getName(SymName)))
545 if (error(C->getName(FileName)))
547 outs() << SymName << " in " << FileName << "\n";
553 for (Archive::child_iterator I = A->child_begin(), E = A->child_end();
555 std::unique_ptr<Binary> Child;
556 if (I->getAsBinary(Child, &Context))
558 if (SymbolicFile *O = dyn_cast<SymbolicFile>(Child.get())) {
559 outs() << O->getFileName() << ":\n";
560 dumpSymbolNamesFromObject(O);
565 if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(Bin.get())) {
566 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
567 E = UB->end_objects();
569 std::unique_ptr<ObjectFile> Obj;
570 if (!I->getAsObjectFile(Obj)) {
571 outs() << Obj->getFileName() << ":\n";
572 dumpSymbolNamesFromObject(Obj.get());
577 if (SymbolicFile *O = dyn_cast<SymbolicFile>(Bin.get())) {
578 dumpSymbolNamesFromObject(O);
581 error("unrecognizable file type", Filename);
585 int main(int argc, char **argv) {
586 // Print a stack trace if we signal out.
587 sys::PrintStackTraceOnErrorSignal();
588 PrettyStackTraceProgram X(argc, argv);
590 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
591 cl::ParseCommandLineOptions(argc, argv, "llvm symbol table dumper\n");
593 // llvm-nm only reads binary files.
594 if (error(sys::ChangeStdinToBinary()))
601 OutputFormat = posix;
603 // The relative order of these is important. If you pass --size-sort it should
604 // only print out the size. However, if you pass -S --size-sort, it should
605 // print out both the size and values.
606 if (SizeSort && !PrintSize)
608 if (OutputFormat == sysv || SizeSort)
611 switch (InputFilenames.size()) {
613 InputFilenames.push_back("-");
617 MultipleFiles = true;
620 std::for_each(InputFilenames.begin(), InputFilenames.end(),
621 dumpSymbolNamesFromFile);