1 //===-- llvm-nm.cpp - Symbol table dumping utility for llvm ---------------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This program is a utility that works like traditional Unix "nm",
11 // that is, it prints out the names of symbols in a bytecode file,
12 // along with some information about each symbol.
14 // This "nm" does not print symbols' addresses. It supports many of
15 // the features of GNU "nm", including its different output formats.
17 //===----------------------------------------------------------------------===//
19 #include "llvm/Module.h"
20 #include "llvm/Bitcode/ReaderWriter.h"
21 #include "llvm/Bitcode/Archive.h"
22 #include "llvm/Support/CommandLine.h"
23 #include "llvm/Support/ManagedStatic.h"
24 #include "llvm/Support/MemoryBuffer.h"
25 #include "llvm/System/Signals.h"
34 enum OutputFormatTy { bsd, sysv, posix };
35 cl::opt<OutputFormatTy>
36 OutputFormat("format",
37 cl::desc("Specify output format"),
38 cl::values(clEnumVal(bsd, "BSD format"),
39 clEnumVal(sysv, "System V format"),
40 clEnumVal(posix, "POSIX.2 format"),
41 clEnumValEnd), cl::init(bsd));
42 cl::alias OutputFormat2("f", cl::desc("Alias for --format"),
43 cl::aliasopt(OutputFormat));
46 InputFilenames(cl::Positional, cl::desc("<input bytecode files>"),
49 cl::opt<bool> UndefinedOnly("undefined-only",
50 cl::desc("Show only undefined symbols"));
51 cl::alias UndefinedOnly2("u", cl::desc("Alias for --undefined-only"),
52 cl::aliasopt(UndefinedOnly));
54 cl::opt<bool> DefinedOnly("defined-only",
55 cl::desc("Show only defined symbols"));
57 cl::opt<bool> ExternalOnly("extern-only",
58 cl::desc("Show only external symbols"));
59 cl::alias ExternalOnly2("g", cl::desc("Alias for --extern-only"),
60 cl::aliasopt(ExternalOnly));
62 cl::opt<bool> BSDFormat("B", cl::desc("Alias for --format=bsd"));
63 cl::opt<bool> POSIXFormat("P", cl::desc("Alias for --format=posix"));
65 bool MultipleFiles = false;
70 static char TypeCharForSymbol(GlobalValue &GV) {
71 if (GV.isDeclaration()) return 'U';
72 if (GV.hasLinkOnceLinkage()) return 'C';
73 if (GV.hasWeakLinkage()) return 'W';
74 if (isa<Function>(GV) && GV.hasInternalLinkage()) return 't';
75 if (isa<Function>(GV)) return 'T';
76 if (isa<GlobalVariable>(GV) && GV.hasInternalLinkage()) return 'd';
77 if (isa<GlobalVariable>(GV)) return 'D';
81 static void DumpSymbolNameForGlobalValue(GlobalValue &GV) {
82 const std::string SymbolAddrStr = " "; // Not used yet...
83 char TypeChar = TypeCharForSymbol (GV);
84 if ((TypeChar != 'U') && UndefinedOnly)
86 if ((TypeChar == 'U') && DefinedOnly)
88 if (GV.hasInternalLinkage () && ExternalOnly)
90 if (OutputFormat == posix) {
91 std::cout << GV.getName () << " " << TypeCharForSymbol (GV) << " "
92 << SymbolAddrStr << "\n";
93 } else if (OutputFormat == bsd) {
94 std::cout << SymbolAddrStr << " " << TypeCharForSymbol (GV) << " "
95 << GV.getName () << "\n";
96 } else if (OutputFormat == sysv) {
97 std::string PaddedName (GV.getName ());
98 while (PaddedName.length () < 20)
100 std::cout << PaddedName << "|" << SymbolAddrStr << "| "
101 << TypeCharForSymbol (GV)
106 static void DumpSymbolNamesFromModule(Module *M) {
107 const std::string &Filename = M->getModuleIdentifier ();
108 if (OutputFormat == posix && MultipleFiles) {
109 std::cout << Filename << ":\n";
110 } else if (OutputFormat == bsd && MultipleFiles) {
111 std::cout << "\n" << Filename << ":\n";
112 } else if (OutputFormat == sysv) {
113 std::cout << "\n\nSymbols from " << Filename << ":\n\n"
114 << "Name Value Class Type"
115 << " Size Line Section\n";
117 std::for_each (M->begin (), M->end (), DumpSymbolNameForGlobalValue);
118 std::for_each (M->global_begin (), M->global_end (), DumpSymbolNameForGlobalValue);
121 static void DumpSymbolNamesFromFile(std::string &Filename) {
122 std::string ErrorMessage;
123 sys::Path aPath(Filename);
124 // Note: Currently we do not support reading an archive from stdin.
125 if (Filename == "-" || aPath.isBitcodeFile()) {
126 std::auto_ptr<MemoryBuffer> Buffer(
127 MemoryBuffer::getFileOrSTDIN(&Filename[0], Filename.size()));
130 Result = ParseBitcodeFile(Buffer.get(), &ErrorMessage);
133 DumpSymbolNamesFromModule(Result);
135 std::cerr << ToolName << ": " << Filename << ": " << ErrorMessage << "\n";
139 } else if (aPath.isArchive()) {
141 Archive* archive = Archive::OpenAndLoad(sys::Path(Filename), &ErrorMessage);
143 std::cerr << ToolName << ": " << Filename << ": " << ErrorMessage << "\n";
144 std::vector<Module *> Modules;
145 if (archive->getAllModules(Modules, &ErrorMessage)) {
146 std::cerr << ToolName << ": " << Filename << ": " << ErrorMessage << "\n";
149 MultipleFiles = true;
150 std::for_each (Modules.begin(), Modules.end(), DumpSymbolNamesFromModule);
152 std::cerr << ToolName << ": " << Filename << ": "
153 << "unrecognizable file type\n";
158 int main(int argc, char **argv) {
159 llvm_shutdown_obj X; // Call llvm_shutdown() on exit.
160 cl::ParseCommandLineOptions(argc, argv, " llvm symbol table dumper\n");
161 sys::PrintStackTraceOnErrorSignal();
164 if (BSDFormat) OutputFormat = bsd;
165 if (POSIXFormat) OutputFormat = posix;
167 switch (InputFilenames.size()) {
168 case 0: InputFilenames.push_back("-");
170 default: MultipleFiles = true;
173 std::for_each(InputFilenames.begin(), InputFilenames.end(),
174 DumpSymbolNamesFromFile);