Remove rules against std::function from the programmer's manual
[oota-llvm.git] / tools / llvm-nm / llvm-nm.cpp
1 //===-- llvm-nm.cpp - Symbol table dumping utility for llvm ---------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
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.
13 //
14 // This "nm" supports many of the features of GNU "nm", including its different
15 // output formats.
16 //
17 //===----------------------------------------------------------------------===//
18
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"
41 #include <algorithm>
42 #include <cctype>
43 #include <cerrno>
44 #include <cstring>
45 #include <system_error>
46 #include <vector>
47 using namespace llvm;
48 using namespace object;
49
50 namespace {
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),
57     cl::init(bsd));
58 cl::alias OutputFormat2("f", cl::desc("Alias for --format"),
59                         cl::aliasopt(OutputFormat));
60
61 cl::list<std::string> InputFilenames(cl::Positional, cl::desc("<input files>"),
62                                      cl::ZeroOrMore);
63
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));
68
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));
74
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));
79
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));
84
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"));
88
89 static cl::list<std::string>
90 ArchFlags("arch", cl::desc("architecture(s) from a Mach-O file to dump"),
91           cl::ZeroOrMore);
92 bool ArchAll = false;
93
94 cl::opt<bool> PrintFileName(
95     "print-file-name",
96     cl::desc("Precede each symbol with the object file it came from"));
97
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));
102
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));
107
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));
113
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));
116
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));
120
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));
125
126 cl::opt<bool> SizeSort("size-sort", cl::desc("Sort symbols by size"));
127
128 cl::opt<bool> WithoutAliases("without-aliases", cl::Hidden,
129                              cl::desc("Exclude aliases from output"));
130
131 cl::opt<bool> ArchiveMap("print-armap", cl::desc("Print the archive map"));
132 cl::alias ArchiveMaps("M", cl::desc("Alias for --print-armap"),
133                       cl::aliasopt(ArchiveMap));
134
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
140 // FIXME: This option takes exactly two strings and should be allowed anywhere
141 // on the command line.  Such that "llvm-nm -s __TEXT __text foo.o" would work.
142 // But that does not as the CommandLine Library does not have a way to make
143 // this work.  For now the "-s __TEXT __text" has to be last on the command
144 // line.
145 cl::list<std::string> SegSect("s", cl::Positional, cl::ZeroOrMore,
146                               cl::desc("Dump only symbols from this segment "
147                                        "and section name, Mach-O only"));
148
149 cl::opt<bool> FormatMachOasHex("x", cl::desc("Print symbol entry in hex, "
150                                              "Mach-O only"));
151
152 bool PrintAddress = true;
153
154 bool MultipleFiles = false;
155
156 bool HadError = false;
157
158 std::string ToolName;
159 }
160
161 static void error(Twine Message, Twine Path = Twine()) {
162   HadError = true;
163   errs() << ToolName << ": " << Path << ": " << Message << ".\n";
164 }
165
166 static bool error(std::error_code EC, Twine Path = Twine()) {
167   if (EC) {
168     error(EC.message(), Path);
169     return true;
170   }
171   return false;
172 }
173
174 namespace {
175 struct NMSymbol {
176   uint64_t Address;
177   uint64_t Size;
178   char TypeChar;
179   StringRef Name;
180   DataRefImpl Symb;
181 };
182 }
183
184 static bool compareSymbolAddress(const NMSymbol &A, const NMSymbol &B) {
185   if (!ReverseSort) {
186     if (A.Address < B.Address)
187       return true;
188     else if (A.Address == B.Address && A.Name < B.Name)
189       return true;
190     else if (A.Address == B.Address && A.Name == B.Name && A.Size < B.Size)
191       return true;
192     else
193       return false;
194   } else {
195     if (A.Address > B.Address)
196       return true;
197     else if (A.Address == B.Address && A.Name > B.Name)
198       return true;
199     else if (A.Address == B.Address && A.Name == B.Name && A.Size > B.Size)
200       return true;
201     else
202       return false;
203   }
204 }
205
206 static bool compareSymbolSize(const NMSymbol &A, const NMSymbol &B) {
207   if (!ReverseSort) {
208     if (A.Size < B.Size)
209       return true;
210     else if (A.Size == B.Size && A.Name < B.Name)
211       return true;
212     else if (A.Size == B.Size && A.Name == B.Name && A.Address < B.Address)
213       return true;
214     else
215       return false;
216   } else {
217     if (A.Size > B.Size)
218       return true;
219     else if (A.Size == B.Size && A.Name > B.Name)
220       return true;
221     else if (A.Size == B.Size && A.Name == B.Name && A.Address > B.Address)
222       return true;
223     else
224       return false;
225   }
226 }
227
228 static bool compareSymbolName(const NMSymbol &A, const NMSymbol &B) {
229   if (!ReverseSort) {
230     if (A.Name < B.Name)
231       return true;
232     else if (A.Name == B.Name && A.Size < B.Size)
233       return true;
234     else if (A.Name == B.Name && A.Size == B.Size && A.Address < B.Address)
235       return true;
236     else
237       return false;
238   } else {
239     if (A.Name > B.Name)
240       return true;
241     else if (A.Name == B.Name && A.Size > B.Size)
242       return true;
243     else if (A.Name == B.Name && A.Size == B.Size && A.Address > B.Address)
244       return true;
245     else
246       return false;
247   }
248 }
249
250 static char isSymbolList64Bit(SymbolicFile *Obj) {
251   if (isa<IRObjectFile>(Obj))
252     return false;
253   else if (isa<COFFObjectFile>(Obj))
254     return false;
255   else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(Obj))
256     return MachO->is64Bit();
257   else if (isa<ELF32LEObjectFile>(Obj))
258     return false;
259   else if (isa<ELF64LEObjectFile>(Obj))
260     return true;
261   else if (isa<ELF32BEObjectFile>(Obj))
262     return false;
263   else if (isa<ELF64BEObjectFile>(Obj))
264     return true;
265   else
266     return false;
267 }
268
269 static StringRef CurrentFilename;
270 typedef std::vector<NMSymbol> SymbolListT;
271 static SymbolListT SymbolList;
272
273 // darwinPrintSymbol() is used to print a symbol from a Mach-O file when the
274 // the OutputFormat is darwin or we are printing Mach-O symbols in hex.  For
275 // the darwin format it produces the same output as darwin's nm(1) -m output
276 // and when printing Mach-O symbols in hex it produces the same output as
277 // darwin's nm(1) -x format.
278 static void darwinPrintSymbol(MachOObjectFile *MachO, SymbolListT::iterator I,
279                               char *SymbolAddrStr, const char *printBlanks) {
280   MachO::mach_header H;
281   MachO::mach_header_64 H_64;
282   uint32_t Filetype, Flags;
283   MachO::nlist_64 STE_64;
284   MachO::nlist STE;
285   uint8_t NType;
286   uint8_t NSect;
287   uint16_t NDesc;
288   uint32_t NStrx;
289   uint64_t NValue;
290   if (MachO->is64Bit()) {
291     H_64 = MachO->MachOObjectFile::getHeader64();
292     Filetype = H_64.filetype;
293     Flags = H_64.flags;
294     STE_64 = MachO->getSymbol64TableEntry(I->Symb);
295     NType = STE_64.n_type;
296     NSect = STE_64.n_sect;
297     NDesc = STE_64.n_desc;
298     NStrx = STE_64.n_strx;
299     NValue = STE_64.n_value;
300   } else {
301     H = MachO->MachOObjectFile::getHeader();
302     Filetype = H.filetype;
303     Flags = H.flags;
304     STE = MachO->getSymbolTableEntry(I->Symb);
305     NType = STE.n_type;
306     NSect = STE.n_sect;
307     NDesc = STE.n_desc;
308     NStrx = STE.n_strx;
309     NValue = STE.n_value;
310   }
311
312   // If we are printing Mach-O symbols in hex do that and return.
313   if (FormatMachOasHex) {
314     char Str[18] = "";
315     const char *printFormat;
316     if (MachO->is64Bit())
317       printFormat = "%016" PRIx64;
318     else
319       printFormat = "%08" PRIx64;
320     format(printFormat, NValue).print(Str, sizeof(Str));
321     outs() << Str << ' ';
322     format("%02x", NType).print(Str, sizeof(Str));
323     outs() << Str << ' ';
324     format("%02x", NSect).print(Str, sizeof(Str));
325     outs() << Str << ' ';
326     format("%04x", NDesc).print(Str, sizeof(Str));
327     outs() << Str << ' ';
328     format("%08x", NStrx).print(Str, sizeof(Str));
329     outs() << Str << ' ';
330     outs() << I->Name << "\n";
331     return;
332   }
333
334   if (PrintAddress) {
335     if ((NType & MachO::N_TYPE) == MachO::N_INDR)
336       strcpy(SymbolAddrStr, printBlanks);
337     outs() << SymbolAddrStr << ' ';
338   }
339
340   switch (NType & MachO::N_TYPE) {
341   case MachO::N_UNDF:
342     if (NValue != 0) {
343       outs() << "(common) ";
344       if (MachO::GET_COMM_ALIGN(NDesc) != 0)
345         outs() << "(alignment 2^" << (int)MachO::GET_COMM_ALIGN(NDesc) << ") ";
346     } else {
347       if ((NType & MachO::N_TYPE) == MachO::N_PBUD)
348         outs() << "(prebound ";
349       else
350         outs() << "(";
351       if ((NDesc & MachO::REFERENCE_TYPE) ==
352           MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
353         outs() << "undefined [lazy bound]) ";
354       else if ((NDesc & MachO::REFERENCE_TYPE) ==
355                MachO::REFERENCE_FLAG_UNDEFINED_LAZY)
356         outs() << "undefined [private lazy bound]) ";
357       else if ((NDesc & MachO::REFERENCE_TYPE) ==
358                MachO::REFERENCE_FLAG_PRIVATE_UNDEFINED_NON_LAZY)
359         outs() << "undefined [private]) ";
360       else
361         outs() << "undefined) ";
362     }
363     break;
364   case MachO::N_ABS:
365     outs() << "(absolute) ";
366     break;
367   case MachO::N_INDR:
368     outs() << "(indirect) ";
369     break;
370   case MachO::N_SECT: {
371     section_iterator Sec = MachO->section_end();
372     MachO->getSymbolSection(I->Symb, Sec);
373     DataRefImpl Ref = Sec->getRawDataRefImpl();
374     StringRef SectionName;
375     MachO->getSectionName(Ref, SectionName);
376     StringRef SegmentName = MachO->getSectionFinalSegmentName(Ref);
377     outs() << "(" << SegmentName << "," << SectionName << ") ";
378     break;
379   }
380   default:
381     outs() << "(?) ";
382     break;
383   }
384
385   if (NType & MachO::N_EXT) {
386     if (NDesc & MachO::REFERENCED_DYNAMICALLY)
387       outs() << "[referenced dynamically] ";
388     if (NType & MachO::N_PEXT) {
389       if ((NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF)
390         outs() << "weak private external ";
391       else
392         outs() << "private external ";
393     } else {
394       if ((NDesc & MachO::N_WEAK_REF) == MachO::N_WEAK_REF ||
395           (NDesc & MachO::N_WEAK_DEF) == MachO::N_WEAK_DEF) {
396         if ((NDesc & (MachO::N_WEAK_REF | MachO::N_WEAK_DEF)) ==
397             (MachO::N_WEAK_REF | MachO::N_WEAK_DEF))
398           outs() << "weak external automatically hidden ";
399         else
400           outs() << "weak external ";
401       } else
402         outs() << "external ";
403     }
404   } else {
405     if (NType & MachO::N_PEXT)
406       outs() << "non-external (was a private external) ";
407     else
408       outs() << "non-external ";
409   }
410
411   if (Filetype == MachO::MH_OBJECT &&
412       (NDesc & MachO::N_NO_DEAD_STRIP) == MachO::N_NO_DEAD_STRIP)
413     outs() << "[no dead strip] ";
414
415   if (Filetype == MachO::MH_OBJECT &&
416       ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
417       (NDesc & MachO::N_SYMBOL_RESOLVER) == MachO::N_SYMBOL_RESOLVER)
418     outs() << "[symbol resolver] ";
419
420   if (Filetype == MachO::MH_OBJECT &&
421       ((NType & MachO::N_TYPE) != MachO::N_UNDF) &&
422       (NDesc & MachO::N_ALT_ENTRY) == MachO::N_ALT_ENTRY)
423     outs() << "[alt entry] ";
424
425   if ((NDesc & MachO::N_ARM_THUMB_DEF) == MachO::N_ARM_THUMB_DEF)
426     outs() << "[Thumb] ";
427
428   if ((NType & MachO::N_TYPE) == MachO::N_INDR) {
429     outs() << I->Name << " (for ";
430     StringRef IndirectName;
431     if (MachO->getIndirectName(I->Symb, IndirectName))
432       outs() << "?)";
433     else
434       outs() << IndirectName << ")";
435   } else
436     outs() << I->Name;
437
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)";
447       else {
448         StringRef LibraryName;
449         if (MachO->getLibraryShortNameByIndex(LibraryOrdinal - 1, LibraryName))
450           outs() << " (from bad library ordinal " << LibraryOrdinal << ")";
451         else
452           outs() << " (from " << LibraryName << ")";
453       }
454     }
455   }
456
457   outs() << "\n";
458 }
459
460 static void sortAndPrintSymbolList(SymbolicFile *Obj, bool printName) {
461   if (!NoSort) {
462     if (NumericSort)
463       std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolAddress);
464     else if (SizeSort)
465       std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolSize);
466     else
467       std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolName);
468   }
469
470   if (OutputFormat == posix && MultipleFiles && printName) {
471     outs() << '\n' << CurrentFilename << ":\n";
472   } else if (OutputFormat == bsd && MultipleFiles && printName) {
473     outs() << "\n" << CurrentFilename << ":\n";
474   } else if (OutputFormat == sysv) {
475     outs() << "\n\nSymbols from " << CurrentFilename << ":\n\n"
476            << "Name                  Value   Class        Type"
477            << "         Size   Line  Section\n";
478   }
479
480   const char *printBlanks, *printFormat;
481   if (isSymbolList64Bit(Obj)) {
482     printBlanks = "                ";
483     printFormat = "%016" PRIx64;
484   } else {
485     printBlanks = "        ";
486     printFormat = "%08" PRIx64;
487   }
488
489   for (SymbolListT::iterator I = SymbolList.begin(), E = SymbolList.end();
490        I != E; ++I) {
491     if ((I->TypeChar != 'U') && UndefinedOnly)
492       continue;
493     if ((I->TypeChar == 'U') && DefinedOnly)
494       continue;
495     if (SizeSort && !PrintAddress && I->Size == UnknownAddressOrSize)
496       continue;
497     if (JustSymbolName) {
498       outs() << I->Name << "\n";
499       continue;
500     }
501
502     char SymbolAddrStr[18] = "";
503     char SymbolSizeStr[18] = "";
504
505     if (OutputFormat == sysv || I->Address == UnknownAddressOrSize)
506       strcpy(SymbolAddrStr, printBlanks);
507     if (OutputFormat == sysv)
508       strcpy(SymbolSizeStr, printBlanks);
509
510     if (I->Address != UnknownAddressOrSize)
511       format(printFormat, I->Address)
512           .print(SymbolAddrStr, sizeof(SymbolAddrStr));
513     if (I->Size != UnknownAddressOrSize)
514       format(printFormat, I->Size).print(SymbolSizeStr, sizeof(SymbolSizeStr));
515
516     // If OutputFormat is darwin or we are printing Mach-O symbols in hex and
517     // we have a MachOObjectFile, call darwinPrintSymbol to print as darwin's
518     // nm(1) -m output or hex, else if OutputFormat is darwin or we are
519     // printing Mach-O symbols in hex and not a Mach-O object fall back to
520     // OutputFormat bsd (see below).
521     MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(Obj);
522     if ((OutputFormat == darwin || FormatMachOasHex) && MachO) {
523       darwinPrintSymbol(MachO, I, SymbolAddrStr, printBlanks);
524     } else if (OutputFormat == posix) {
525       outs() << I->Name << " " << I->TypeChar << " " << SymbolAddrStr
526              << SymbolSizeStr << "\n";
527     } else if (OutputFormat == bsd || (OutputFormat == darwin && !MachO)) {
528       if (PrintAddress)
529         outs() << SymbolAddrStr << ' ';
530       if (PrintSize) {
531         outs() << SymbolSizeStr;
532         if (I->Size != UnknownAddressOrSize)
533           outs() << ' ';
534       }
535       outs() << I->TypeChar << " " << I->Name << "\n";
536     } else if (OutputFormat == sysv) {
537       std::string PaddedName(I->Name);
538       while (PaddedName.length() < 20)
539         PaddedName += " ";
540       outs() << PaddedName << "|" << SymbolAddrStr << "|   " << I->TypeChar
541              << "  |                  |" << SymbolSizeStr << "|     |\n";
542     }
543   }
544
545   SymbolList.clear();
546 }
547
548 template <class ELFT>
549 static char getSymbolNMTypeChar(ELFObjectFile<ELFT> &Obj,
550                                 basic_symbol_iterator I) {
551   typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
552   typedef typename ELFObjectFile<ELFT>::Elf_Shdr Elf_Shdr;
553
554   // OK, this is ELF
555   symbol_iterator SymI(I);
556
557   DataRefImpl Symb = I->getRawDataRefImpl();
558   const Elf_Sym *ESym = Obj.getSymbol(Symb);
559   const ELFFile<ELFT> &EF = *Obj.getELFFile();
560   const Elf_Shdr *ESec = EF.getSection(ESym);
561
562   if (ESec) {
563     switch (ESec->sh_type) {
564     case ELF::SHT_PROGBITS:
565     case ELF::SHT_DYNAMIC:
566       switch (ESec->sh_flags) {
567       case (ELF::SHF_ALLOC | ELF::SHF_EXECINSTR):
568         return 't';
569       case (ELF::SHF_TLS | ELF::SHF_ALLOC | ELF::SHF_WRITE):
570       case (ELF::SHF_ALLOC | ELF::SHF_WRITE):
571         return 'd';
572       case ELF::SHF_ALLOC:
573       case (ELF::SHF_ALLOC | ELF::SHF_MERGE):
574       case (ELF::SHF_ALLOC | ELF::SHF_MERGE | ELF::SHF_STRINGS):
575         return 'r';
576       }
577       break;
578     case ELF::SHT_NOBITS:
579       return 'b';
580     }
581   }
582
583   if (ESym->getType() == ELF::STT_SECTION) {
584     StringRef Name;
585     if (error(SymI->getName(Name)))
586       return '?';
587     return StringSwitch<char>(Name)
588         .StartsWith(".debug", 'N')
589         .StartsWith(".note", 'n')
590         .Default('?');
591   }
592
593   return '?';
594 }
595
596 static char getSymbolNMTypeChar(COFFObjectFile &Obj, symbol_iterator I) {
597   const coff_symbol *Symb = Obj.getCOFFSymbol(*I);
598   // OK, this is COFF.
599   symbol_iterator SymI(I);
600
601   StringRef Name;
602   if (error(SymI->getName(Name)))
603     return '?';
604
605   char Ret = StringSwitch<char>(Name)
606                  .StartsWith(".debug", 'N')
607                  .StartsWith(".sxdata", 'N')
608                  .Default('?');
609
610   if (Ret != '?')
611     return Ret;
612
613   uint32_t Characteristics = 0;
614   if (!COFF::isReservedSectionNumber(Symb->SectionNumber)) {
615     section_iterator SecI = Obj.section_end();
616     if (error(SymI->getSection(SecI)))
617       return '?';
618     const coff_section *Section = Obj.getCOFFSection(*SecI);
619     Characteristics = Section->Characteristics;
620   }
621
622   switch (Symb->SectionNumber) {
623   case COFF::IMAGE_SYM_DEBUG:
624     return 'n';
625   default:
626     // Check section type.
627     if (Characteristics & COFF::IMAGE_SCN_CNT_CODE)
628       return 't';
629     else if (Characteristics & COFF::IMAGE_SCN_MEM_READ &&
630              ~Characteristics & COFF::IMAGE_SCN_MEM_WRITE) // Read only.
631       return 'r';
632     else if (Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
633       return 'd';
634     else if (Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)
635       return 'b';
636     else if (Characteristics & COFF::IMAGE_SCN_LNK_INFO)
637       return 'i';
638
639     // Check for section symbol.
640     else if (Symb->isSectionDefinition())
641       return 's';
642   }
643
644   return '?';
645 }
646
647 static uint8_t getNType(MachOObjectFile &Obj, DataRefImpl Symb) {
648   if (Obj.is64Bit()) {
649     MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
650     return STE.n_type;
651   }
652   MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
653   return STE.n_type;
654 }
655
656 static char getSymbolNMTypeChar(MachOObjectFile &Obj, basic_symbol_iterator I) {
657   DataRefImpl Symb = I->getRawDataRefImpl();
658   uint8_t NType = getNType(Obj, Symb);
659
660   switch (NType & MachO::N_TYPE) {
661   case MachO::N_ABS:
662     return 's';
663   case MachO::N_INDR:
664     return 'i';
665   case MachO::N_SECT: {
666     section_iterator Sec = Obj.section_end();
667     Obj.getSymbolSection(Symb, Sec);
668     DataRefImpl Ref = Sec->getRawDataRefImpl();
669     StringRef SectionName;
670     Obj.getSectionName(Ref, SectionName);
671     StringRef SegmentName = Obj.getSectionFinalSegmentName(Ref);
672     if (SegmentName == "__TEXT" && SectionName == "__text")
673       return 't';
674     else if (SegmentName == "__DATA" && SectionName == "__data")
675       return 'd';
676     else if (SegmentName == "__DATA" && SectionName == "__bss")
677       return 'b';
678     else
679       return 's';
680   }
681   }
682
683   return '?';
684 }
685
686 static char getSymbolNMTypeChar(const GlobalValue &GV) {
687   if (GV.getType()->getElementType()->isFunctionTy())
688     return 't';
689   // FIXME: should we print 'b'? At the IR level we cannot be sure if this
690   // will be in bss or not, but we could approximate.
691   return 'd';
692 }
693
694 static char getSymbolNMTypeChar(IRObjectFile &Obj, basic_symbol_iterator I) {
695   const GlobalValue *GV = Obj.getSymbolGV(I->getRawDataRefImpl());
696   if (!GV)
697     return 't';
698   return getSymbolNMTypeChar(*GV);
699 }
700
701 template <class ELFT>
702 static bool isObject(ELFObjectFile<ELFT> &Obj, symbol_iterator I) {
703   typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
704
705   DataRefImpl Symb = I->getRawDataRefImpl();
706   const Elf_Sym *ESym = Obj.getSymbol(Symb);
707
708   return ESym->getType() == ELF::STT_OBJECT;
709 }
710
711 static bool isObject(SymbolicFile *Obj, basic_symbol_iterator I) {
712   if (ELF32LEObjectFile *ELF = dyn_cast<ELF32LEObjectFile>(Obj))
713     return isObject(*ELF, I);
714   if (ELF64LEObjectFile *ELF = dyn_cast<ELF64LEObjectFile>(Obj))
715     return isObject(*ELF, I);
716   if (ELF32BEObjectFile *ELF = dyn_cast<ELF32BEObjectFile>(Obj))
717     return isObject(*ELF, I);
718   if (ELF64BEObjectFile *ELF = dyn_cast<ELF64BEObjectFile>(Obj))
719     return isObject(*ELF, I);
720   return false;
721 }
722
723 static char getNMTypeChar(SymbolicFile *Obj, basic_symbol_iterator I) {
724   uint32_t Symflags = I->getFlags();
725   if ((Symflags & object::SymbolRef::SF_Weak) && !isa<MachOObjectFile>(Obj)) {
726     char Ret = isObject(Obj, I) ? 'v' : 'w';
727     if (!(Symflags & object::SymbolRef::SF_Undefined))
728       Ret = toupper(Ret);
729     return Ret;
730   }
731
732   if (Symflags & object::SymbolRef::SF_Undefined)
733     return 'U';
734
735   if (Symflags & object::SymbolRef::SF_Common)
736     return 'C';
737
738   char Ret = '?';
739   if (Symflags & object::SymbolRef::SF_Absolute)
740     Ret = 'a';
741   else if (IRObjectFile *IR = dyn_cast<IRObjectFile>(Obj))
742     Ret = getSymbolNMTypeChar(*IR, I);
743   else if (COFFObjectFile *COFF = dyn_cast<COFFObjectFile>(Obj))
744     Ret = getSymbolNMTypeChar(*COFF, I);
745   else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(Obj))
746     Ret = getSymbolNMTypeChar(*MachO, I);
747   else if (ELF32LEObjectFile *ELF = dyn_cast<ELF32LEObjectFile>(Obj))
748     Ret = getSymbolNMTypeChar(*ELF, I);
749   else if (ELF64LEObjectFile *ELF = dyn_cast<ELF64LEObjectFile>(Obj))
750     Ret = getSymbolNMTypeChar(*ELF, I);
751   else if (ELF32BEObjectFile *ELF = dyn_cast<ELF32BEObjectFile>(Obj))
752     Ret = getSymbolNMTypeChar(*ELF, I);
753   else
754     Ret = getSymbolNMTypeChar(*cast<ELF64BEObjectFile>(Obj), I);
755
756   if (Symflags & object::SymbolRef::SF_Global)
757     Ret = toupper(Ret);
758
759   return Ret;
760 }
761
762 // getNsectForSegSect() is used to implement the Mach-O "-s segname sectname"
763 // option to dump only those symbols from that section in a Mach-O file.
764 // It is called once for each Mach-O file from dumpSymbolNamesFromObject()
765 // to get the section number for that named section from the command line
766 // arguments. It returns the section number for that section in the Mach-O
767 // file or zero it is not present.
768 static unsigned getNsectForSegSect(MachOObjectFile *Obj) {
769   unsigned Nsect = 1;
770   for (section_iterator I = Obj->section_begin(), E = Obj->section_end();
771        I != E; ++I) {
772     DataRefImpl Ref = I->getRawDataRefImpl();
773     StringRef SectionName;
774     Obj->getSectionName(Ref, SectionName);
775     StringRef SegmentName = Obj->getSectionFinalSegmentName(Ref);
776     if (SegmentName == SegSect[0] && SectionName == SegSect[1])
777       return Nsect;
778     Nsect++;
779   }
780   return 0;
781 }
782
783 // getNsectInMachO() is used to implement the Mach-O "-s segname sectname"
784 // option to dump only those symbols from that section in a Mach-O file.
785 // It is called once for each symbol in a Mach-O file from
786 // dumpSymbolNamesFromObject() and returns the section number for that symbol
787 // if it is in a section, else it returns 0.
788 static unsigned getNsectInMachO(MachOObjectFile &Obj, basic_symbol_iterator I) {
789   DataRefImpl Symb = I->getRawDataRefImpl();
790   if (Obj.is64Bit()) {
791     MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
792     if ((STE.n_type & MachO::N_TYPE) == MachO::N_SECT)
793       return STE.n_sect;
794     return 0;
795   }
796   MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
797   if ((STE.n_type & MachO::N_TYPE) == MachO::N_SECT)
798     return STE.n_sect;
799   return 0;
800 }
801
802 static void dumpSymbolNamesFromObject(SymbolicFile *Obj, bool printName) {
803   basic_symbol_iterator IBegin = Obj->symbol_begin();
804   basic_symbol_iterator IEnd = Obj->symbol_end();
805   if (DynamicSyms) {
806     if (!Obj->isELF()) {
807       error("File format has no dynamic symbol table", Obj->getFileName());
808       return;
809     }
810     std::pair<symbol_iterator, symbol_iterator> IDyn =
811         getELFDynamicSymbolIterators(Obj);
812     IBegin = IDyn.first;
813     IEnd = IDyn.second;
814   }
815   std::string NameBuffer;
816   raw_string_ostream OS(NameBuffer);
817   // If a "-s segname sectname" option was specified and this is a Mach-O
818   // file get the section number for that section in this object file.
819   unsigned int Nsect = 0;
820   MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(Obj);
821   if (SegSect.size() != 0 && MachO) {
822     Nsect = getNsectForSegSect(MachO);
823     // If this section is not in the object file no symbols are printed.
824     if (Nsect == 0)
825       return;
826   }
827   for (basic_symbol_iterator I = IBegin; I != IEnd; ++I) {
828     uint32_t SymFlags = I->getFlags();
829     if (!DebugSyms && (SymFlags & SymbolRef::SF_FormatSpecific))
830       continue;
831     if (WithoutAliases) {
832       if (IRObjectFile *IR = dyn_cast<IRObjectFile>(Obj)) {
833         const GlobalValue *GV = IR->getSymbolGV(I->getRawDataRefImpl());
834         if (GV && isa<GlobalAlias>(GV))
835           continue;
836       }
837     }
838     // If a "-s segname sectname" option was specified and this is a Mach-O
839     // file and this section appears in this file, Nsect will be non-zero then
840     // see if this symbol is a symbol from that section and if not skip it.
841     if (Nsect && Nsect != getNsectInMachO(*MachO, I))
842       continue;
843     NMSymbol S;
844     S.Size = UnknownAddressOrSize;
845     S.Address = UnknownAddressOrSize;
846     if ((PrintSize || SizeSort) && isa<ObjectFile>(Obj)) {
847       symbol_iterator SymI = I;
848       if (error(SymI->getSize(S.Size)))
849         break;
850     }
851     if (PrintAddress && isa<ObjectFile>(Obj))
852       if (error(symbol_iterator(I)->getAddress(S.Address)))
853         break;
854     S.TypeChar = getNMTypeChar(Obj, I);
855     if (error(I->printName(OS)))
856       break;
857     OS << '\0';
858     S.Symb = I->getRawDataRefImpl();
859     SymbolList.push_back(S);
860   }
861
862   OS.flush();
863   const char *P = NameBuffer.c_str();
864   for (unsigned I = 0; I < SymbolList.size(); ++I) {
865     SymbolList[I].Name = P;
866     P += strlen(P) + 1;
867   }
868
869   CurrentFilename = Obj->getFileName();
870   sortAndPrintSymbolList(Obj, printName);
871 }
872
873 // checkMachOAndArchFlags() checks to see if the SymbolicFile is a Mach-O file
874 // and if it is and there is a list of architecture flags is specified then
875 // check to make sure this Mach-O file is one of those architectures or all
876 // architectures was specificed.  If not then an error is generated and this
877 // routine returns false.  Else it returns true.
878 static bool checkMachOAndArchFlags(SymbolicFile *O, std::string &Filename) {
879   if (isa<MachOObjectFile>(O) && !ArchAll && ArchFlags.size() != 0) {
880     MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(O);
881     bool ArchFound = false;
882     MachO::mach_header H;
883     MachO::mach_header_64 H_64;
884     Triple T;
885     if (MachO->is64Bit()) {
886       H_64 = MachO->MachOObjectFile::getHeader64();
887       T = MachOObjectFile::getArch(H_64.cputype, H_64.cpusubtype);
888     } else {
889       H = MachO->MachOObjectFile::getHeader();
890       T = MachOObjectFile::getArch(H.cputype, H.cpusubtype);
891     }
892     unsigned i;
893     for (i = 0; i < ArchFlags.size(); ++i) {
894       if (ArchFlags[i] == T.getArchName())
895         ArchFound = true;
896       break;
897     }
898     if (!ArchFound) {
899       error(ArchFlags[i],
900             "file: " + Filename + " does not contain architecture");
901       return false;
902     }
903   }
904   return true;
905 }
906
907 static void dumpSymbolNamesFromFile(std::string &Filename) {
908   ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
909       MemoryBuffer::getFileOrSTDIN(Filename);
910   if (error(BufferOrErr.getError(), Filename))
911     return;
912   std::unique_ptr<MemoryBuffer> Buffer = std::move(BufferOrErr.get());
913
914   LLVMContext &Context = getGlobalContext();
915   ErrorOr<Binary *> BinaryOrErr = createBinary(Buffer, &Context);
916   if (error(BinaryOrErr.getError(), Filename))
917     return;
918   Buffer.release();
919   std::unique_ptr<Binary> Bin(BinaryOrErr.get());
920
921   if (Archive *A = dyn_cast<Archive>(Bin.get())) {
922     if (ArchiveMap) {
923       Archive::symbol_iterator I = A->symbol_begin();
924       Archive::symbol_iterator E = A->symbol_end();
925       if (I != E) {
926         outs() << "Archive map\n";
927         for (; I != E; ++I) {
928           ErrorOr<Archive::child_iterator> C = I->getMember();
929           if (error(C.getError()))
930             return;
931           ErrorOr<StringRef> FileNameOrErr = C.get()->getName();
932           if (error(FileNameOrErr.getError()))
933             return;
934           StringRef SymName = I->getName();
935           outs() << SymName << " in " << FileNameOrErr.get() << "\n";
936         }
937         outs() << "\n";
938       }
939     }
940
941     for (Archive::child_iterator I = A->child_begin(), E = A->child_end();
942          I != E; ++I) {
943       ErrorOr<std::unique_ptr<Binary>> ChildOrErr = I->getAsBinary(&Context);
944       if (ChildOrErr.getError())
945         continue;
946       if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
947         if (!checkMachOAndArchFlags(O, Filename))
948           return;
949         outs() << "\n";
950         if (isa<MachOObjectFile>(O)) {
951           outs() << Filename << "(" << O->getFileName() << ")";
952         } else
953           outs() << O->getFileName();
954         outs() << ":\n";
955         dumpSymbolNamesFromObject(O, false);
956       }
957     }
958     return;
959   }
960   if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(Bin.get())) {
961     // If we have a list of architecture flags specified dump only those.
962     if (!ArchAll && ArchFlags.size() != 0) {
963       // Look for a slice in the universal binary that matches each ArchFlag.
964       bool ArchFound;
965       for (unsigned i = 0; i < ArchFlags.size(); ++i) {
966         ArchFound = false;
967         for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
968                                                    E = UB->end_objects();
969              I != E; ++I) {
970           if (ArchFlags[i] == I->getArchTypeName()) {
971             ArchFound = true;
972             ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr =
973                 I->getAsObjectFile();
974             std::unique_ptr<Archive> A;
975             if (ObjOrErr) {
976               std::unique_ptr<ObjectFile> Obj = std::move(ObjOrErr.get());
977               if (ArchFlags.size() > 1) {
978                 outs() << "\n" << Obj->getFileName() << " (for architecture "
979                        << I->getArchTypeName() << ")"
980                        << ":\n";
981               }
982               dumpSymbolNamesFromObject(Obj.get(), false);
983             } else if (!I->getAsArchive(A)) {
984               for (Archive::child_iterator AI = A->child_begin(),
985                                            AE = A->child_end();
986                    AI != AE; ++AI) {
987                 ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
988                     AI->getAsBinary(&Context);
989                 if (ChildOrErr.getError())
990                   continue;
991                 if (SymbolicFile *O =
992                         dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
993                   outs() << "\n" << A->getFileName();
994                   outs() << "(" << O->getFileName() << ")";
995                   if (ArchFlags.size() > 1) {
996                     outs() << " (for architecture " << I->getArchTypeName()
997                            << ")";
998                   }
999                   outs() << ":\n";
1000                   dumpSymbolNamesFromObject(O, false);
1001                 }
1002               }
1003             }
1004           }
1005         }
1006         if (!ArchFound) {
1007           error(ArchFlags[i],
1008                 "file: " + Filename + " does not contain architecture");
1009           return;
1010         }
1011       }
1012       return;
1013     }
1014     // No architecture flags were specified so if this contains a slice that
1015     // matches the host architecture dump only that.
1016     if (!ArchAll) {
1017       StringRef HostArchName = MachOObjectFile::getHostArch().getArchName();
1018       for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1019                                                  E = UB->end_objects();
1020            I != E; ++I) {
1021         if (HostArchName == I->getArchTypeName()) {
1022           ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
1023           std::unique_ptr<Archive> A;
1024           if (ObjOrErr) {
1025             std::unique_ptr<ObjectFile> Obj = std::move(ObjOrErr.get());
1026             dumpSymbolNamesFromObject(Obj.get(), false);
1027           } else if (!I->getAsArchive(A)) {
1028             for (Archive::child_iterator AI = A->child_begin(),
1029                                          AE = A->child_end();
1030                  AI != AE; ++AI) {
1031               ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
1032                   AI->getAsBinary(&Context);
1033               if (ChildOrErr.getError())
1034                 continue;
1035               if (SymbolicFile *O =
1036                       dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1037                 outs() << "\n" << A->getFileName() << "(" << O->getFileName()
1038                        << ")"
1039                        << ":\n";
1040                 dumpSymbolNamesFromObject(O, false);
1041               }
1042             }
1043           }
1044           return;
1045         }
1046       }
1047     }
1048     // Either all architectures have been specified or none have been specified
1049     // and this does not contain the host architecture so dump all the slices.
1050     bool moreThanOneArch = UB->getNumberOfObjects() > 1;
1051     for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
1052                                                E = UB->end_objects();
1053          I != E; ++I) {
1054       ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr = I->getAsObjectFile();
1055       std::unique_ptr<Archive> A;
1056       if (ObjOrErr) {
1057         std::unique_ptr<ObjectFile> Obj = std::move(ObjOrErr.get());
1058         if (moreThanOneArch)
1059           outs() << "\n";
1060         outs() << Obj->getFileName();
1061         if (isa<MachOObjectFile>(Obj.get()) && moreThanOneArch)
1062           outs() << " (for architecture " << I->getArchTypeName() << ")";
1063         outs() << ":\n";
1064         dumpSymbolNamesFromObject(Obj.get(), false);
1065       } else if (!I->getAsArchive(A)) {
1066         for (Archive::child_iterator AI = A->child_begin(), AE = A->child_end();
1067              AI != AE; ++AI) {
1068           ErrorOr<std::unique_ptr<Binary>> ChildOrErr =
1069               AI->getAsBinary(&Context);
1070           if (ChildOrErr.getError())
1071             continue;
1072           if (SymbolicFile *O = dyn_cast<SymbolicFile>(&*ChildOrErr.get())) {
1073             outs() << "\n" << A->getFileName();
1074             if (isa<MachOObjectFile>(O)) {
1075               outs() << "(" << O->getFileName() << ")";
1076               if (moreThanOneArch)
1077                 outs() << " (for architecture " << I->getArchTypeName() << ")";
1078             } else
1079               outs() << ":" << O->getFileName();
1080             outs() << ":\n";
1081             dumpSymbolNamesFromObject(O, false);
1082           }
1083         }
1084       }
1085     }
1086     return;
1087   }
1088   if (SymbolicFile *O = dyn_cast<SymbolicFile>(Bin.get())) {
1089     if (!checkMachOAndArchFlags(O, Filename))
1090       return;
1091     dumpSymbolNamesFromObject(O, true);
1092     return;
1093   }
1094   error("unrecognizable file type", Filename);
1095   return;
1096 }
1097
1098 int main(int argc, char **argv) {
1099   // Print a stack trace if we signal out.
1100   sys::PrintStackTraceOnErrorSignal();
1101   PrettyStackTraceProgram X(argc, argv);
1102
1103   llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
1104   cl::ParseCommandLineOptions(argc, argv, "llvm symbol table dumper\n");
1105
1106   // llvm-nm only reads binary files.
1107   if (error(sys::ChangeStdinToBinary()))
1108     return 1;
1109
1110   llvm::InitializeAllTargetInfos();
1111   llvm::InitializeAllTargetMCs();
1112   llvm::InitializeAllAsmParsers();
1113
1114   ToolName = argv[0];
1115   if (BSDFormat)
1116     OutputFormat = bsd;
1117   if (POSIXFormat)
1118     OutputFormat = posix;
1119   if (DarwinFormat)
1120     OutputFormat = darwin;
1121
1122   // The relative order of these is important. If you pass --size-sort it should
1123   // only print out the size. However, if you pass -S --size-sort, it should
1124   // print out both the size and address.
1125   if (SizeSort && !PrintSize)
1126     PrintAddress = false;
1127   if (OutputFormat == sysv || SizeSort)
1128     PrintSize = true;
1129
1130   switch (InputFilenames.size()) {
1131   case 0:
1132     InputFilenames.push_back("a.out");
1133   case 1:
1134     break;
1135   default:
1136     MultipleFiles = true;
1137   }
1138
1139   for (unsigned i = 0; i < ArchFlags.size(); ++i) {
1140     if (ArchFlags[i] == "all") {
1141       ArchAll = true;
1142     } else {
1143       Triple T = MachOObjectFile::getArch(ArchFlags[i]);
1144       if (T.getArch() == Triple::UnknownArch)
1145         error("Unknown architecture named '" + ArchFlags[i] + "'",
1146               "for the -arch option");
1147     }
1148   }
1149
1150   if (SegSect.size() != 0 && SegSect.size() != 2)
1151     error("bad number of arguments (must be two arguments)",
1152           "for the -s option");
1153
1154
1155   std::for_each(InputFilenames.begin(), InputFilenames.end(),
1156                 dumpSymbolNamesFromFile);
1157
1158   if (HadError)
1159     return 1;
1160
1161   return 0;
1162 }