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",
  11 // that is, it prints out the names of symbols in a bitcode file,
  12 // along with some information about each symbol.
  13 //
  14 // This "nm" does not print symbols' addresses. It supports many of
  15 // the features of GNU "nm", including its different output formats.
  16 //
  17 //===----------------------------------------------------------------------===//
  18
  19 #include "llvm/LLVMContext.h"
  20 #include "llvm/Module.h"
  21 #include "llvm/Bitcode/ReaderWriter.h"
  22 #include "llvm/Bitcode/Archive.h"
  23 #include "llvm/Support/CommandLine.h"
  24 #include "llvm/Support/ManagedStatic.h"
  25 #include "llvm/Support/MemoryBuffer.h"
  26 #include "llvm/Support/PrettyStackTrace.h"
  27 #include "llvm/System/Signals.h"
  28 #include <algorithm>
  29 #include <cctype>
  30 #include <cerrno>
  31 #include <cstring>
  32 #include <iostream>
  33 using namespace llvm;
  34
  35 namespace {
  36   enum OutputFormatTy { bsd, sysv, posix };
  37   cl::opt<OutputFormatTy>
  38   OutputFormat("format",
  39        cl::desc("Specify output format"),
  40          cl::values(clEnumVal(bsd,   "BSD format"),
  41                     clEnumVal(sysv,  "System V format"),
  42                     clEnumVal(posix, "POSIX.2 format"),
  43                     clEnumValEnd), cl::init(bsd));
  44   cl::alias OutputFormat2("f", cl::desc("Alias for --format"),
  45                           cl::aliasopt(OutputFormat));
  46
  47   cl::list<std::string>
  48   InputFilenames(cl::Positional, cl::desc("<input bitcode files>"),
  49                  cl::ZeroOrMore);
  50
  51   cl::opt<bool> UndefinedOnly("undefined-only",
  52                               cl::desc("Show only undefined symbols"));
  53   cl::alias UndefinedOnly2("u", cl::desc("Alias for --undefined-only"),
  54                            cl::aliasopt(UndefinedOnly));
  55
  56   cl::opt<bool> DefinedOnly("defined-only",
  57                             cl::desc("Show only defined symbols"));
  58
  59   cl::opt<bool> ExternalOnly("extern-only",
  60                              cl::desc("Show only external symbols"));
  61   cl::alias ExternalOnly2("g", cl::desc("Alias for --extern-only"),
  62                           cl::aliasopt(ExternalOnly));
  63
  64   cl::opt<bool> BSDFormat("B", cl::desc("Alias for --format=bsd"));
  65   cl::opt<bool> POSIXFormat("P", cl::desc("Alias for --format=posix"));
  66
  67   bool MultipleFiles = false;
  68
  69   std::string ToolName;
  70 }
  71
  72 static char TypeCharForSymbol(GlobalValue &GV) {
  73   if (GV.isDeclaration())                                  return 'U';
  74   if (GV.hasLinkOnceLinkage())                             return 'C';
  75   if (GV.hasCommonLinkage())                               return 'C';
  76   if (GV.hasWeakLinkage())                                 return 'W';
  77   if (isa<Function>(GV) && GV.hasInternalLinkage())        return 't';
  78   if (isa<Function>(GV))                                   return 'T';
  79   if (isa<GlobalVariable>(GV) && GV.hasInternalLinkage())  return 'd';
  80   if (isa<GlobalVariable>(GV))                             return 'D';
  81   if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(&GV)) {
  82     const GlobalValue *AliasedGV = GA->getAliasedGlobal();
  83     if (isa<Function>(AliasedGV))                          return 'T';
  84     if (isa<GlobalVariable>(AliasedGV))                    return 'D';
  85   }
  86                                                            return '?';
  87 }
  88
  89 static void DumpSymbolNameForGlobalValue(GlobalValue &GV) {
  90   // Private linkage and available_externally linkage don't exist in symtab.
  91   if (GV.hasPrivateLinkage() || GV.hasAvailableExternallyLinkage()) return;
  92
  93   const std::string SymbolAddrStr = "        "; // Not used yet...
  94   char TypeChar = TypeCharForSymbol(GV);
  95   if ((TypeChar != 'U') && UndefinedOnly)
  96     return;
  97   if ((TypeChar == 'U') && DefinedOnly)
  98     return;
  99   if (GV.hasLocalLinkage () && ExternalOnly)
 100     return;
 101   if (OutputFormat == posix) {
 102     std::cout << GV.getName () << " " << TypeCharForSymbol(GV) << " "
 103               << SymbolAddrStr << "\n";
 104   } else if (OutputFormat == bsd) {
 105     std::cout << SymbolAddrStr << " " << TypeCharForSymbol(GV) << " "
 106               << GV.getName () << "\n";
 107   } else if (OutputFormat == sysv) {
 108     std::string PaddedName (GV.getName ());
 109     while (PaddedName.length () < 20)
 110       PaddedName += " ";
 111     std::cout << PaddedName << "|" << SymbolAddrStr << "|   "
 112               << TypeCharForSymbol(GV)
 113               << "  |                  |      |     |\n";
 114   }
 115 }
 116
 117 static void DumpSymbolNamesFromModule(Module *M) {
 118   const std::string &Filename = M->getModuleIdentifier ();
 119   if (OutputFormat == posix && MultipleFiles) {
 120     std::cout << Filename << ":\n";
 121   } else if (OutputFormat == bsd && MultipleFiles) {
 122     std::cout << "\n" << Filename << ":\n";
 123   } else if (OutputFormat == sysv) {
 124     std::cout << "\n\nSymbols from " << Filename << ":\n\n"
 125               << "Name                  Value   Class        Type"
 126               << "         Size   Line  Section\n";
 127   }
 128   std::for_each (M->begin(), M->end(), DumpSymbolNameForGlobalValue);
 129   std::for_each (M->global_begin(), M->global_end(),
 130                  DumpSymbolNameForGlobalValue);
 131   std::for_each (M->alias_begin(), M->alias_end(),
 132                  DumpSymbolNameForGlobalValue);
 133 }
 134
 135 static void DumpSymbolNamesFromFile(std::string &Filename) {
 136   LLVMContext Context;
 137   std::string ErrorMessage;
 138   sys::Path aPath(Filename);
 139   // Note: Currently we do not support reading an archive from stdin.
 140   if (Filename == "-" || aPath.isBitcodeFile()) {
 141     std::auto_ptr<MemoryBuffer> Buffer(
 142                    MemoryBuffer::getFileOrSTDIN(Filename, &ErrorMessage));
 143     Module *Result = 0;
 144     if (Buffer.get())
 145       Result = ParseBitcodeFile(Buffer.get(), Context, &ErrorMessage);
 146
 147     if (Result)
 148       DumpSymbolNamesFromModule(Result);
 149     else {
 150       std::cerr << ToolName << ": " << Filename << ": " << ErrorMessage << "\n";
 151       return;
 152     }
 153
 154   } else if (aPath.isArchive()) {
 155     std::string ErrMsg;
 156     Archive* archive = Archive::OpenAndLoad(sys::Path(Filename), Context,
 157                                             &ErrorMessage);
 158     if (!archive)
 159       std::cerr << ToolName << ": " << Filename << ": " << ErrorMessage << "\n";
 160     std::vector<Module *> Modules;
 161     if (archive->getAllModules(Modules, &ErrorMessage)) {
 162       std::cerr << ToolName << ": " << Filename << ": " << ErrorMessage << "\n";
 163       return;
 164     }
 165     MultipleFiles = true;
 166     std::for_each (Modules.begin(), Modules.end(), DumpSymbolNamesFromModule);
 167   } else {
 168     std::cerr << ToolName << ": " << Filename << ": "
 169               << "unrecognizable file type\n";
 170     return;
 171   }
 172 }
 173
 174 int main(int argc, char **argv) {
 175   // Print a stack trace if we signal out.
 176   sys::PrintStackTraceOnErrorSignal();
 177   PrettyStackTraceProgram X(argc, argv);
 178
 179   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
 180   cl::ParseCommandLineOptions(argc, argv, "llvm symbol table dumper\n");
 181
 182   ToolName = argv[0];
 183   if (BSDFormat) OutputFormat = bsd;
 184   if (POSIXFormat) OutputFormat = posix;
 185
 186   switch (InputFilenames.size()) {
 187   case 0: InputFilenames.push_back("-");
 188   case 1: break;
 189   default: MultipleFiles = true;
 190   }
 191
 192   std::for_each(InputFilenames.begin(), InputFilenames.end(),
 193                 DumpSymbolNamesFromFile);
 194   return 0;
 195 }