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