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