1 //===-- llvm-nm.cpp - Symbol table dumping utility for llvm ---------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
14 // This "nm" supports many of the features of GNU "nm", including its different
17 //===----------------------------------------------------------------------===//
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/Object/Archive.h"
24 #include "llvm/Object/ObjectFile.h"
25 #include "llvm/Support/CommandLine.h"
26 #include "llvm/Support/FileSystem.h"
27 #include "llvm/Support/ManagedStatic.h"
28 #include "llvm/Support/MemoryBuffer.h"
29 #include "llvm/Support/PrettyStackTrace.h"
30 #include "llvm/Support/Program.h"
31 #include "llvm/Support/raw_ostream.h"
32 #include "llvm/Support/Signals.h"
33 #include "llvm/Support/Format.h"
34 #include "llvm/Support/system_error.h"
41 using namespace object;
44 enum OutputFormatTy { bsd, sysv, posix };
45 cl::opt<OutputFormatTy>
46 OutputFormat("format",
47 cl::desc("Specify output format"),
48 cl::values(clEnumVal(bsd, "BSD format"),
49 clEnumVal(sysv, "System V format"),
50 clEnumVal(posix, "POSIX.2 format"),
51 clEnumValEnd), cl::init(bsd));
52 cl::alias OutputFormat2("f", cl::desc("Alias for --format"),
53 cl::aliasopt(OutputFormat));
56 InputFilenames(cl::Positional, cl::desc("<input bitcode files>"),
59 cl::opt<bool> UndefinedOnly("undefined-only",
60 cl::desc("Show only undefined symbols"));
61 cl::alias UndefinedOnly2("u", cl::desc("Alias for --undefined-only"),
62 cl::aliasopt(UndefinedOnly));
64 cl::opt<bool> DynamicSyms("dynamic",
65 cl::desc("Display the dynamic symbols instead "
66 "of normal symbols."));
67 cl::alias DynamicSyms2("D", cl::desc("Alias for --dynamic"),
68 cl::aliasopt(DynamicSyms));
70 cl::opt<bool> DefinedOnly("defined-only",
71 cl::desc("Show only defined symbols"));
73 cl::opt<bool> ExternalOnly("extern-only",
74 cl::desc("Show only external symbols"));
75 cl::alias ExternalOnly2("g", cl::desc("Alias for --extern-only"),
76 cl::aliasopt(ExternalOnly));
78 cl::opt<bool> BSDFormat("B", cl::desc("Alias for --format=bsd"));
79 cl::opt<bool> POSIXFormat("P", cl::desc("Alias for --format=posix"));
81 cl::opt<bool> PrintFileName("print-file-name",
82 cl::desc("Precede each symbol with the object file it came from"));
84 cl::alias PrintFileNameA("A", cl::desc("Alias for --print-file-name"),
85 cl::aliasopt(PrintFileName));
86 cl::alias PrintFileNameo("o", cl::desc("Alias for --print-file-name"),
87 cl::aliasopt(PrintFileName));
89 cl::opt<bool> DebugSyms("debug-syms",
90 cl::desc("Show all symbols, even debugger only"));
91 cl::alias DebugSymsa("a", cl::desc("Alias for --debug-syms"),
92 cl::aliasopt(DebugSyms));
94 cl::opt<bool> NumericSort("numeric-sort",
95 cl::desc("Sort symbols by address"));
96 cl::alias NumericSortn("n", cl::desc("Alias for --numeric-sort"),
97 cl::aliasopt(NumericSort));
98 cl::alias NumericSortv("v", cl::desc("Alias for --numeric-sort"),
99 cl::aliasopt(NumericSort));
101 cl::opt<bool> NoSort("no-sort",
102 cl::desc("Show symbols in order encountered"));
103 cl::alias NoSortp("p", cl::desc("Alias for --no-sort"),
104 cl::aliasopt(NoSort));
106 cl::opt<bool> PrintSize("print-size",
107 cl::desc("Show symbol size instead of address"));
108 cl::alias PrintSizeS("S", cl::desc("Alias for --print-size"),
109 cl::aliasopt(PrintSize));
111 cl::opt<bool> SizeSort("size-sort", cl::desc("Sort symbols by size"));
113 bool PrintAddress = true;
115 bool MultipleFiles = false;
117 std::string ToolName;
121 static void error(Twine message, Twine path = Twine()) {
122 errs() << ToolName << ": " << path << ": " << message << ".\n";
125 static bool error(error_code ec, Twine path = Twine()) {
127 error(ec.message(), path);
141 static bool CompareSymbolAddress(const NMSymbol &a, const NMSymbol &b) {
142 if (a.Address < b.Address)
144 else if (a.Address == b.Address && a.Name < b.Name)
151 static bool CompareSymbolSize(const NMSymbol &a, const NMSymbol &b) {
154 else if (a.Size == b.Size && a.Name < b.Name)
160 static bool CompareSymbolName(const NMSymbol &a, const NMSymbol &b) {
161 return a.Name < b.Name;
164 StringRef CurrentFilename;
165 typedef std::vector<NMSymbol> SymbolListT;
166 SymbolListT SymbolList;
169 static void SortAndPrintSymbolList() {
172 std::sort(SymbolList.begin(), SymbolList.end(), CompareSymbolAddress);
174 std::sort(SymbolList.begin(), SymbolList.end(), CompareSymbolSize);
176 std::sort(SymbolList.begin(), SymbolList.end(), CompareSymbolName);
179 if (OutputFormat == posix && MultipleFiles) {
180 outs() << '\n' << CurrentFilename << ":\n";
181 } else if (OutputFormat == bsd && MultipleFiles) {
182 outs() << "\n" << CurrentFilename << ":\n";
183 } else if (OutputFormat == sysv) {
184 outs() << "\n\nSymbols from " << CurrentFilename << ":\n\n"
185 << "Name Value Class Type"
186 << " Size Line Section\n";
189 for (SymbolListT::iterator i = SymbolList.begin(),
190 e = SymbolList.end(); i != e; ++i) {
191 if ((i->TypeChar != 'U') && UndefinedOnly)
193 if ((i->TypeChar == 'U') && DefinedOnly)
195 if (SizeSort && !PrintAddress && i->Size == UnknownAddressOrSize)
198 char SymbolAddrStr[10] = "";
199 char SymbolSizeStr[10] = "";
201 if (OutputFormat == sysv || i->Address == object::UnknownAddressOrSize)
202 strcpy(SymbolAddrStr, " ");
203 if (OutputFormat == sysv)
204 strcpy(SymbolSizeStr, " ");
206 if (i->Address != object::UnknownAddressOrSize)
207 format("%08" PRIx64, i->Address).print(SymbolAddrStr,
208 sizeof(SymbolAddrStr));
209 if (i->Size != object::UnknownAddressOrSize)
210 format("%08" PRIx64, i->Size).print(SymbolSizeStr, sizeof(SymbolSizeStr));
212 if (OutputFormat == posix) {
213 outs() << i->Name << " " << i->TypeChar << " "
214 << SymbolAddrStr << SymbolSizeStr << "\n";
215 } else if (OutputFormat == bsd) {
217 outs() << SymbolAddrStr << ' ';
219 outs() << SymbolSizeStr;
220 if (i->Size != object::UnknownAddressOrSize)
223 outs() << i->TypeChar << " " << i->Name << "\n";
224 } else if (OutputFormat == sysv) {
225 std::string PaddedName (i->Name);
226 while (PaddedName.length () < 20)
228 outs() << PaddedName << "|" << SymbolAddrStr << "| "
230 << " | |" << SymbolSizeStr << "| |\n";
237 static char TypeCharForSymbol(GlobalValue &GV) {
238 if (GV.isDeclaration()) return 'U';
239 if (GV.hasLinkOnceLinkage()) return 'C';
240 if (GV.hasCommonLinkage()) return 'C';
241 if (GV.hasWeakLinkage()) return 'W';
242 if (isa<Function>(GV) && GV.hasInternalLinkage()) return 't';
243 if (isa<Function>(GV)) return 'T';
244 if (isa<GlobalVariable>(GV) && GV.hasInternalLinkage()) return 'd';
245 if (isa<GlobalVariable>(GV)) return 'D';
246 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(&GV)) {
247 const GlobalValue *AliasedGV = GA->getAliasedGlobal();
248 if (isa<Function>(AliasedGV)) return 'T';
249 if (isa<GlobalVariable>(AliasedGV)) return 'D';
254 static void DumpSymbolNameForGlobalValue(GlobalValue &GV) {
255 // Private linkage and available_externally linkage don't exist in symtab.
256 if (GV.hasPrivateLinkage() ||
257 GV.hasLinkerPrivateLinkage() ||
258 GV.hasLinkerPrivateWeakLinkage() ||
259 GV.hasAvailableExternallyLinkage())
261 char TypeChar = TypeCharForSymbol(GV);
262 if (GV.hasLocalLinkage () && ExternalOnly)
266 s.Address = object::UnknownAddressOrSize;
267 s.Size = object::UnknownAddressOrSize;
268 s.TypeChar = TypeChar;
269 s.Name = GV.getName();
270 SymbolList.push_back(s);
273 static void DumpSymbolNamesFromModule(Module *M) {
274 CurrentFilename = M->getModuleIdentifier();
275 std::for_each (M->begin(), M->end(), DumpSymbolNameForGlobalValue);
276 std::for_each (M->global_begin(), M->global_end(),
277 DumpSymbolNameForGlobalValue);
278 std::for_each (M->alias_begin(), M->alias_end(),
279 DumpSymbolNameForGlobalValue);
281 SortAndPrintSymbolList();
284 static void DumpSymbolNamesFromObject(ObjectFile *obj) {
286 symbol_iterator ibegin = obj->begin_symbols();
287 symbol_iterator iend = obj->end_symbols();
289 ibegin = obj->begin_dynamic_symbols();
290 iend = obj->end_dynamic_symbols();
292 for (symbol_iterator i = ibegin; i != iend; i.increment(ec)) {
293 if (error(ec)) break;
295 if (error(i->getFlags(symflags))) break;
296 if (!DebugSyms && (symflags & SymbolRef::SF_FormatSpecific))
299 s.Size = object::UnknownAddressOrSize;
300 s.Address = object::UnknownAddressOrSize;
301 if (PrintSize || SizeSort) {
302 if (error(i->getSize(s.Size))) break;
305 if (error(i->getAddress(s.Address))) break;
306 if (error(i->getNMTypeChar(s.TypeChar))) break;
307 if (error(i->getName(s.Name))) break;
308 SymbolList.push_back(s);
311 CurrentFilename = obj->getFileName();
312 SortAndPrintSymbolList();
315 static void DumpSymbolNamesFromFile(std::string &Filename) {
316 if (Filename != "-" && !sys::fs::exists(Filename)) {
317 errs() << ToolName << ": '" << Filename << "': " << "No such file\n";
321 OwningPtr<MemoryBuffer> Buffer;
322 if (error(MemoryBuffer::getFileOrSTDIN(Filename, Buffer), Filename))
325 sys::fs::file_magic magic = sys::fs::identify_magic(Buffer->getBuffer());
327 LLVMContext &Context = getGlobalContext();
328 std::string ErrorMessage;
329 if (magic == sys::fs::file_magic::bitcode) {
331 Result = ParseBitcodeFile(Buffer.get(), Context, &ErrorMessage);
333 DumpSymbolNamesFromModule(Result);
336 error(ErrorMessage, Filename);
339 } else if (magic == sys::fs::file_magic::archive) {
340 OwningPtr<Binary> arch;
341 if (error(object::createBinary(Buffer.take(), arch), Filename))
344 if (object::Archive *a = dyn_cast<object::Archive>(arch.get())) {
345 for (object::Archive::child_iterator i = a->begin_children(),
346 e = a->end_children(); i != e; ++i) {
347 OwningPtr<Binary> child;
348 if (i->getAsBinary(child)) {
349 // Try opening it as a bitcode file.
350 OwningPtr<MemoryBuffer> buff(i->getBuffer());
353 Result = ParseBitcodeFile(buff.get(), Context, &ErrorMessage);
356 DumpSymbolNamesFromModule(Result);
361 if (object::ObjectFile *o = dyn_cast<ObjectFile>(child.get())) {
362 outs() << o->getFileName() << ":\n";
363 DumpSymbolNamesFromObject(o);
367 } else if (magic.is_object()) {
368 OwningPtr<Binary> obj;
369 if (error(object::createBinary(Buffer.take(), obj), Filename))
371 if (object::ObjectFile *o = dyn_cast<ObjectFile>(obj.get()))
372 DumpSymbolNamesFromObject(o);
374 errs() << ToolName << ": " << Filename << ": "
375 << "unrecognizable file type\n";
380 int main(int argc, char **argv) {
381 // Print a stack trace if we signal out.
382 sys::PrintStackTraceOnErrorSignal();
383 PrettyStackTraceProgram X(argc, argv);
385 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
386 cl::ParseCommandLineOptions(argc, argv, "llvm symbol table dumper\n");
388 // llvm-nm only reads binary files.
389 if (error(sys::Program::ChangeStdinToBinary()))
393 if (BSDFormat) OutputFormat = bsd;
394 if (POSIXFormat) OutputFormat = posix;
396 // The relative order of these is important. If you pass --size-sort it should
397 // only print out the size. However, if you pass -S --size-sort, it should
398 // print out both the size and address.
399 if (SizeSort && !PrintSize) PrintAddress = false;
400 if (OutputFormat == sysv || SizeSort) PrintSize = true;
402 switch (InputFilenames.size()) {
403 case 0: InputFilenames.push_back("-");
405 default: MultipleFiles = true;
408 std::for_each(InputFilenames.begin(), InputFilenames.end(),
409 DumpSymbolNamesFromFile);