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