blob: fd18454a8f0bb279f75d64e7213516bd5e34d03a [file] [log] [blame]
Brian Gaeke0af759d2003-10-16 04:43:15 +00001//===-- llvm-nm.cpp - Symbol table dumping utility for llvm ---------------===//
Misha Brukman650ba8e2005-04-22 00:00:37 +00002//
John Criswell09344dc2003-10-20 17:47:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner345353d2007-12-29 20:44:31 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukman650ba8e2005-04-22 00:00:37 +00007//
John Criswell09344dc2003-10-20 17:47:21 +00008//===----------------------------------------------------------------------===//
Brian Gaeke0af759d2003-10-16 04:43:15 +00009//
Michael J. Spencer838e5ad2012-06-06 23:34:10 +000010// 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.
Misha Brukman650ba8e2005-04-22 00:00:37 +000013//
Michael J. Spencer838e5ad2012-06-06 23:34:10 +000014// This "nm" supports many of the features of GNU "nm", including its different
15// output formats.
Brian Gaeke0af759d2003-10-16 04:43:15 +000016//
17//===----------------------------------------------------------------------===//
18
Chandler Carruth9fb823b2013-01-02 11:36:10 +000019#include "llvm/IR/LLVMContext.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000020#include "llvm/Bitcode/ReaderWriter.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000021#include "llvm/IR/Module.h"
Michael J. Spencer2bc774a2011-09-27 19:37:18 +000022#include "llvm/Object/Archive.h"
Rafael Espindola586af97a2013-11-02 21:16:09 +000023#include "llvm/Object/COFF.h"
24#include "llvm/Object/ELFObjectFile.h"
25#include "llvm/Object/MachO.h"
Alexey Samsonove6388e62013-06-18 15:03:28 +000026#include "llvm/Object/MachOUniversal.h"
Michael J. Spencerb8672a52011-01-20 06:38:57 +000027#include "llvm/Object/ObjectFile.h"
Reid Spencer7c16caa2004-09-01 22:55:40 +000028#include "llvm/Support/CommandLine.h"
Michael J. Spencerb8672a52011-01-20 06:38:57 +000029#include "llvm/Support/FileSystem.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000030#include "llvm/Support/Format.h"
Chris Lattner76d46322006-12-06 01:18:01 +000031#include "llvm/Support/ManagedStatic.h"
Chris Lattneref8f3892007-05-06 05:36:18 +000032#include "llvm/Support/MemoryBuffer.h"
Chris Lattnere3fc2d12009-03-06 05:34:10 +000033#include "llvm/Support/PrettyStackTrace.h"
Michael J. Spencerbc96f372011-12-13 23:17:29 +000034#include "llvm/Support/Program.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000035#include "llvm/Support/Signals.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000036#include "llvm/Support/raw_ostream.h"
Michael J. Spencer7b6fef82010-12-09 17:36:48 +000037#include "llvm/Support/system_error.h"
Jeff Cohenb622c112007-03-05 00:00:42 +000038#include <algorithm>
Brian Gaeke0af759d2003-10-16 04:43:15 +000039#include <cctype>
Alkis Evlogimenosf68f40e2004-04-21 16:11:40 +000040#include <cerrno>
Brian Gaeke55447b42003-11-19 21:52:09 +000041#include <cstring>
Michael J. Spencerb8672a52011-01-20 06:38:57 +000042#include <vector>
Brian Gaeke960707c2003-11-11 22:41:34 +000043using namespace llvm;
Michael J. Spencerb8672a52011-01-20 06:38:57 +000044using namespace object;
Brian Gaeke960707c2003-11-11 22:41:34 +000045
Brian Gaeke0af759d2003-10-16 04:43:15 +000046namespace {
Rafael Espindolace82a072014-01-30 19:24:00 +000047enum OutputFormatTy { bsd, sysv, posix };
Rafael Espindola619581c2014-01-29 04:56:19 +000048cl::opt<OutputFormatTy> OutputFormat(
49 "format", cl::desc("Specify output format"),
50 cl::values(clEnumVal(bsd, "BSD format"), clEnumVal(sysv, "System V format"),
51 clEnumVal(posix, "POSIX.2 format"), clEnumValEnd),
52 cl::init(bsd));
53cl::alias OutputFormat2("f", cl::desc("Alias for --format"),
54 cl::aliasopt(OutputFormat));
Brian Gaeke0af759d2003-10-16 04:43:15 +000055
Rafael Espindola619581c2014-01-29 04:56:19 +000056cl::list<std::string> InputFilenames(cl::Positional,
57 cl::desc("<input bitcode files>"),
58 cl::ZeroOrMore);
Brian Gaeke0af759d2003-10-16 04:43:15 +000059
Rafael Espindola619581c2014-01-29 04:56:19 +000060cl::opt<bool> UndefinedOnly("undefined-only",
61 cl::desc("Show only undefined symbols"));
62cl::alias UndefinedOnly2("u", cl::desc("Alias for --undefined-only"),
63 cl::aliasopt(UndefinedOnly));
Brian Gaeke0af759d2003-10-16 04:43:15 +000064
Rafael Espindola619581c2014-01-29 04:56:19 +000065cl::opt<bool> DynamicSyms("dynamic",
66 cl::desc("Display the dynamic symbols instead "
67 "of normal symbols."));
68cl::alias DynamicSyms2("D", cl::desc("Alias for --dynamic"),
69 cl::aliasopt(DynamicSyms));
Michael J. Spencer8c4729f2012-02-28 00:40:37 +000070
Rafael Espindola619581c2014-01-29 04:56:19 +000071cl::opt<bool> DefinedOnly("defined-only",
72 cl::desc("Show only defined symbols"));
Brian Gaeke0af759d2003-10-16 04:43:15 +000073
Rafael Espindola619581c2014-01-29 04:56:19 +000074cl::opt<bool> ExternalOnly("extern-only",
75 cl::desc("Show only external symbols"));
76cl::alias ExternalOnly2("g", cl::desc("Alias for --extern-only"),
77 cl::aliasopt(ExternalOnly));
Brian Gaeke0af759d2003-10-16 04:43:15 +000078
Rafael Espindola619581c2014-01-29 04:56:19 +000079cl::opt<bool> BSDFormat("B", cl::desc("Alias for --format=bsd"));
80cl::opt<bool> POSIXFormat("P", cl::desc("Alias for --format=posix"));
Brian Gaeke0af759d2003-10-16 04:43:15 +000081
Rafael Espindola619581c2014-01-29 04:56:19 +000082cl::opt<bool> PrintFileName(
83 "print-file-name",
Michael J. Spencerb8672a52011-01-20 06:38:57 +000084 cl::desc("Precede each symbol with the object file it came from"));
85
Rafael Espindola619581c2014-01-29 04:56:19 +000086cl::alias PrintFileNameA("A", cl::desc("Alias for --print-file-name"),
87 cl::aliasopt(PrintFileName));
88cl::alias PrintFileNameo("o", cl::desc("Alias for --print-file-name"),
89 cl::aliasopt(PrintFileName));
Michael J. Spencerb8672a52011-01-20 06:38:57 +000090
Rafael Espindola619581c2014-01-29 04:56:19 +000091cl::opt<bool> DebugSyms("debug-syms",
92 cl::desc("Show all symbols, even debugger only"));
93cl::alias DebugSymsa("a", cl::desc("Alias for --debug-syms"),
94 cl::aliasopt(DebugSyms));
Michael J. Spencerb8672a52011-01-20 06:38:57 +000095
Rafael Espindola619581c2014-01-29 04:56:19 +000096cl::opt<bool> NumericSort("numeric-sort", cl::desc("Sort symbols by address"));
97cl::alias NumericSortn("n", cl::desc("Alias for --numeric-sort"),
98 cl::aliasopt(NumericSort));
99cl::alias NumericSortv("v", cl::desc("Alias for --numeric-sort"),
100 cl::aliasopt(NumericSort));
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000101
Rafael Espindola619581c2014-01-29 04:56:19 +0000102cl::opt<bool> NoSort("no-sort", cl::desc("Show symbols in order encountered"));
103cl::alias NoSortp("p", cl::desc("Alias for --no-sort"), cl::aliasopt(NoSort));
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000104
Rafael Espindola619581c2014-01-29 04:56:19 +0000105cl::opt<bool> PrintSize("print-size",
106 cl::desc("Show symbol size instead of address"));
107cl::alias PrintSizeS("S", cl::desc("Alias for --print-size"),
108 cl::aliasopt(PrintSize));
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000109
Rafael Espindola619581c2014-01-29 04:56:19 +0000110cl::opt<bool> SizeSort("size-sort", cl::desc("Sort symbols by size"));
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000111
Rafael Espindola619581c2014-01-29 04:56:19 +0000112cl::opt<bool> WithoutAliases("without-aliases", cl::Hidden,
113 cl::desc("Exclude aliases from output"));
Jan Sjödin4d0c2992012-09-18 18:47:58 +0000114
Rafael Espindola619581c2014-01-29 04:56:19 +0000115cl::opt<bool> ArchiveMap("print-armap", cl::desc("Print the archive map"));
116cl::alias ArchiveMaps("s", cl::desc("Alias for --print-armap"),
117 cl::aliasopt(ArchiveMap));
118bool PrintAddress = true;
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000119
Rafael Espindola619581c2014-01-29 04:56:19 +0000120bool MultipleFiles = false;
Brian Gaeke0af759d2003-10-16 04:43:15 +0000121
Rafael Espindola619581c2014-01-29 04:56:19 +0000122bool HadError = false;
Rafael Espindola8b82a4d2013-07-03 15:46:03 +0000123
Rafael Espindola619581c2014-01-29 04:56:19 +0000124std::string ToolName;
Chris Lattneraa2372562006-05-24 17:04:05 +0000125}
Brian Gaeke0af759d2003-10-16 04:43:15 +0000126
Rafael Espindola619581c2014-01-29 04:56:19 +0000127static void error(Twine Message, Twine Path = Twine()) {
128 HadError = true;
129 errs() << ToolName << ": " << Path << ": " << Message << ".\n";
Michael J. Spencerbc96f372011-12-13 23:17:29 +0000130}
131
Rafael Espindola619581c2014-01-29 04:56:19 +0000132static bool error(error_code EC, Twine Path = Twine()) {
133 if (EC) {
134 error(EC.message(), Path);
Michael J. Spencerbc96f372011-12-13 23:17:29 +0000135 return true;
136 }
137 return false;
138}
139
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000140namespace {
Rafael Espindola619581c2014-01-29 04:56:19 +0000141struct NMSymbol {
142 uint64_t Address;
143 uint64_t Size;
144 char TypeChar;
145 StringRef Name;
146};
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000147}
148
Rafael Espindola619581c2014-01-29 04:56:19 +0000149static bool compareSymbolAddress(const NMSymbol &A, const NMSymbol &B) {
150 if (A.Address < B.Address)
151 return true;
152 else if (A.Address == B.Address && A.Name < B.Name)
153 return true;
154 else if (A.Address == B.Address && A.Name == B.Name && A.Size < B.Size)
155 return true;
156 else
157 return false;
158}
159
160static bool compareSymbolSize(const NMSymbol &A, const NMSymbol &B) {
161 if (A.Size < B.Size)
162 return true;
163 else if (A.Size == B.Size && A.Name < B.Name)
164 return true;
165 else if (A.Size == B.Size && A.Name == B.Name && A.Address < B.Address)
166 return true;
167 else
168 return false;
169}
170
171static bool compareSymbolName(const NMSymbol &A, const NMSymbol &B) {
172 if (A.Name < B.Name)
173 return true;
174 else if (A.Name == B.Name && A.Size < B.Size)
175 return true;
176 else if (A.Name == B.Name && A.Size == B.Size && A.Address < B.Address)
177 return true;
178 else
179 return false;
180}
181
182static StringRef CurrentFilename;
183typedef std::vector<NMSymbol> SymbolListT;
184static SymbolListT SymbolList;
185
186static void sortAndPrintSymbolList() {
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000187 if (!NoSort) {
188 if (NumericSort)
Rafael Espindola619581c2014-01-29 04:56:19 +0000189 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolAddress);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000190 else if (SizeSort)
Rafael Espindola619581c2014-01-29 04:56:19 +0000191 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolSize);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000192 else
Rafael Espindola619581c2014-01-29 04:56:19 +0000193 std::sort(SymbolList.begin(), SymbolList.end(), compareSymbolName);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000194 }
195
196 if (OutputFormat == posix && MultipleFiles) {
197 outs() << '\n' << CurrentFilename << ":\n";
198 } else if (OutputFormat == bsd && MultipleFiles) {
199 outs() << "\n" << CurrentFilename << ":\n";
200 } else if (OutputFormat == sysv) {
201 outs() << "\n\nSymbols from " << CurrentFilename << ":\n\n"
202 << "Name Value Class Type"
203 << " Size Line Section\n";
204 }
205
Rafael Espindola619581c2014-01-29 04:56:19 +0000206 for (SymbolListT::iterator I = SymbolList.begin(), E = SymbolList.end();
207 I != E; ++I) {
208 if ((I->TypeChar != 'U') && UndefinedOnly)
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000209 continue;
Rafael Espindola619581c2014-01-29 04:56:19 +0000210 if ((I->TypeChar == 'U') && DefinedOnly)
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000211 continue;
Rafael Espindola619581c2014-01-29 04:56:19 +0000212 if (SizeSort && !PrintAddress && I->Size == UnknownAddressOrSize)
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000213 continue;
214
215 char SymbolAddrStr[10] = "";
216 char SymbolSizeStr[10] = "";
217
Rafael Espindola0115b082014-01-30 21:51:42 +0000218 if (OutputFormat == sysv || I->Address == UnknownAddressOrSize)
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000219 strcpy(SymbolAddrStr, " ");
220 if (OutputFormat == sysv)
221 strcpy(SymbolSizeStr, " ");
222
Rafael Espindola0115b082014-01-30 21:51:42 +0000223 if (I->Address != UnknownAddressOrSize)
Rafael Espindola619581c2014-01-29 04:56:19 +0000224 format("%08" PRIx64, I->Address)
225 .print(SymbolAddrStr, sizeof(SymbolAddrStr));
Rafael Espindola0115b082014-01-30 21:51:42 +0000226 if (I->Size != UnknownAddressOrSize)
Rafael Espindola619581c2014-01-29 04:56:19 +0000227 format("%08" PRIx64, I->Size).print(SymbolSizeStr, sizeof(SymbolSizeStr));
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000228
229 if (OutputFormat == posix) {
Rafael Espindola619581c2014-01-29 04:56:19 +0000230 outs() << I->Name << " " << I->TypeChar << " " << SymbolAddrStr
231 << SymbolSizeStr << "\n";
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000232 } else if (OutputFormat == bsd) {
233 if (PrintAddress)
234 outs() << SymbolAddrStr << ' ';
235 if (PrintSize) {
236 outs() << SymbolSizeStr;
Rafael Espindola0115b082014-01-30 21:51:42 +0000237 if (I->Size != UnknownAddressOrSize)
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000238 outs() << ' ';
239 }
Rafael Espindola619581c2014-01-29 04:56:19 +0000240 outs() << I->TypeChar << " " << I->Name << "\n";
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000241 } else if (OutputFormat == sysv) {
Rafael Espindola619581c2014-01-29 04:56:19 +0000242 std::string PaddedName(I->Name);
243 while (PaddedName.length() < 20)
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000244 PaddedName += " ";
Rafael Espindola619581c2014-01-29 04:56:19 +0000245 outs() << PaddedName << "|" << SymbolAddrStr << "| " << I->TypeChar
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000246 << " | |" << SymbolSizeStr << "| |\n";
247 }
248 }
249
250 SymbolList.clear();
251}
252
Rafael Espindola619581c2014-01-29 04:56:19 +0000253static char typeCharForSymbol(GlobalValue &GV) {
254 if (GV.isDeclaration())
255 return 'U';
256 if (GV.hasLinkOnceLinkage())
257 return 'C';
258 if (GV.hasCommonLinkage())
259 return 'C';
260 if (GV.hasWeakLinkage())
261 return 'W';
262 if (isa<Function>(GV) && GV.hasInternalLinkage())
263 return 't';
264 if (isa<Function>(GV))
265 return 'T';
266 if (isa<GlobalVariable>(GV) && GV.hasInternalLinkage())
267 return 'd';
268 if (isa<GlobalVariable>(GV))
269 return 'D';
Lauro Ramos Venancioed95f7f2007-06-27 22:08:09 +0000270 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(&GV)) {
271 const GlobalValue *AliasedGV = GA->getAliasedGlobal();
Rafael Espindola619581c2014-01-29 04:56:19 +0000272 if (isa<Function>(AliasedGV))
273 return 'T';
274 if (isa<GlobalVariable>(AliasedGV))
275 return 'D';
Lauro Ramos Venancioed95f7f2007-06-27 22:08:09 +0000276 }
Rafael Espindola619581c2014-01-29 04:56:19 +0000277 return '?';
Brian Gaeke0af759d2003-10-16 04:43:15 +0000278}
279
Rafael Espindola619581c2014-01-29 04:56:19 +0000280static void dumpSymbolNameForGlobalValue(GlobalValue &GV) {
Chris Lattner184f1be2009-04-13 05:44:34 +0000281 // Private linkage and available_externally linkage don't exist in symtab.
Rafael Espindola619581c2014-01-29 04:56:19 +0000282 if (GV.hasPrivateLinkage() || GV.hasLinkerPrivateLinkage() ||
283 GV.hasLinkerPrivateWeakLinkage() || GV.hasAvailableExternallyLinkage())
Bill Wendling03bcd6e2010-07-01 21:55:59 +0000284 return;
Rafael Espindola619581c2014-01-29 04:56:19 +0000285 char TypeChar = typeCharForSymbol(GV);
286 if (GV.hasLocalLinkage() && ExternalOnly)
Brian Gaeke0af759d2003-10-16 04:43:15 +0000287 return;
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000288
Rafael Espindola619581c2014-01-29 04:56:19 +0000289 NMSymbol S;
Rafael Espindola0115b082014-01-30 21:51:42 +0000290 S.Address = UnknownAddressOrSize;
291 S.Size = UnknownAddressOrSize;
Rafael Espindola619581c2014-01-29 04:56:19 +0000292 S.TypeChar = TypeChar;
293 S.Name = GV.getName();
294 SymbolList.push_back(S);
Brian Gaeke0af759d2003-10-16 04:43:15 +0000295}
296
Rafael Espindola619581c2014-01-29 04:56:19 +0000297static void dumpSymbolNamesFromModule(Module *M) {
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000298 CurrentFilename = M->getModuleIdentifier();
Rafael Espindola619581c2014-01-29 04:56:19 +0000299 std::for_each(M->begin(), M->end(), dumpSymbolNameForGlobalValue);
300 std::for_each(M->global_begin(), M->global_end(),
301 dumpSymbolNameForGlobalValue);
Jan Sjödin4d0c2992012-09-18 18:47:58 +0000302 if (!WithoutAliases)
Rafael Espindola619581c2014-01-29 04:56:19 +0000303 std::for_each(M->alias_begin(), M->alias_end(),
304 dumpSymbolNameForGlobalValue);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000305
Rafael Espindola619581c2014-01-29 04:56:19 +0000306 sortAndPrintSymbolList();
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000307}
308
Rafael Espindola586af97a2013-11-02 21:16:09 +0000309template <class ELFT>
Rafael Espindola74375892014-02-04 00:21:18 +0000310static char getSymbolNMTypeChar(ELFObjectFile<ELFT> &Obj, symbol_iterator I) {
Rafael Espindola586af97a2013-11-02 21:16:09 +0000311 typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
312 typedef typename ELFObjectFile<ELFT>::Elf_Shdr Elf_Shdr;
313
314 DataRefImpl Symb = I->getRawDataRefImpl();
315 const Elf_Sym *ESym = Obj.getSymbol(Symb);
316 const ELFFile<ELFT> &EF = *Obj.getELFFile();
317 const Elf_Shdr *ESec = EF.getSection(ESym);
318
Rafael Espindola586af97a2013-11-02 21:16:09 +0000319 if (ESec) {
320 switch (ESec->sh_type) {
321 case ELF::SHT_PROGBITS:
322 case ELF::SHT_DYNAMIC:
323 switch (ESec->sh_flags) {
324 case(ELF::SHF_ALLOC | ELF::SHF_EXECINSTR) :
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000325 return 't';
Rafael Espindola9fa52152014-01-30 00:42:30 +0000326 case(ELF::SHF_TLS | ELF::SHF_ALLOC | ELF::SHF_WRITE) :
Rafael Espindola586af97a2013-11-02 21:16:09 +0000327 case(ELF::SHF_ALLOC | ELF::SHF_WRITE) :
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000328 return 'd';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000329 case ELF::SHF_ALLOC:
330 case(ELF::SHF_ALLOC | ELF::SHF_MERGE) :
331 case(ELF::SHF_ALLOC | ELF::SHF_MERGE | ELF::SHF_STRINGS) :
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000332 return 'r';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000333 }
334 break;
335 case ELF::SHT_NOBITS:
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000336 return 'b';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000337 }
338 }
339
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000340 if (ESym->getType() == ELF::STT_SECTION) {
Rafael Espindola586af97a2013-11-02 21:16:09 +0000341 StringRef Name;
Rafael Espindola74375892014-02-04 00:21:18 +0000342 if (error(I->getName(Name)))
343 return '?';
344 return StringSwitch<char>(Name)
345 .StartsWith(".debug", 'N')
346 .StartsWith(".note", 'n')
347 .Default('?');
Rafael Espindola586af97a2013-11-02 21:16:09 +0000348 }
349
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000350 return '?';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000351}
352
Rafael Espindola74375892014-02-04 00:21:18 +0000353static char getSymbolNMTypeChar(COFFObjectFile &Obj, symbol_iterator I) {
Rafael Espindola619581c2014-01-29 04:56:19 +0000354 const coff_symbol *Symb = Obj.getCOFFSymbol(I);
355 StringRef Name;
Rafael Espindola74375892014-02-04 00:21:18 +0000356 if (error(I->getName(Name)))
357 return '?';
Rafael Espindola619581c2014-01-29 04:56:19 +0000358 char Ret = StringSwitch<char>(Name)
Rafael Espindola586af97a2013-11-02 21:16:09 +0000359 .StartsWith(".debug", 'N')
360 .StartsWith(".sxdata", 'N')
361 .Default('?');
362
Rafael Espindola74375892014-02-04 00:21:18 +0000363 if (Ret != '?')
364 return Ret;
Rafael Espindola586af97a2013-11-02 21:16:09 +0000365
366 uint32_t Characteristics = 0;
Rafael Espindola619581c2014-01-29 04:56:19 +0000367 if (Symb->SectionNumber > 0) {
Rafael Espindolab5155a52014-02-10 20:24:04 +0000368 section_iterator SecI = Obj.section_end();
Rafael Espindola74375892014-02-04 00:21:18 +0000369 if (error(I->getSection(SecI)))
370 return '?';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000371 const coff_section *Section = Obj.getCOFFSection(SecI);
372 Characteristics = Section->Characteristics;
373 }
374
Rafael Espindola619581c2014-01-29 04:56:19 +0000375 switch (Symb->SectionNumber) {
Rafael Espindola586af97a2013-11-02 21:16:09 +0000376 case COFF::IMAGE_SYM_DEBUG:
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000377 return 'n';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000378 default:
379 // Check section type.
380 if (Characteristics & COFF::IMAGE_SCN_CNT_CODE)
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000381 return 't';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000382 else if (Characteristics & COFF::IMAGE_SCN_MEM_READ &&
383 ~Characteristics & COFF::IMAGE_SCN_MEM_WRITE) // Read only.
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000384 return 'r';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000385 else if (Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000386 return 'd';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000387 else if (Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000388 return 'b';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000389 else if (Characteristics & COFF::IMAGE_SCN_LNK_INFO)
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000390 return 'i';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000391
392 // Check for section symbol.
Rafael Espindola619581c2014-01-29 04:56:19 +0000393 else if (Symb->StorageClass == COFF::IMAGE_SYM_CLASS_STATIC &&
394 Symb->Value == 0)
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000395 return 's';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000396 }
397
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000398 return '?';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000399}
400
401static uint8_t getNType(MachOObjectFile &Obj, DataRefImpl Symb) {
402 if (Obj.is64Bit()) {
403 MachO::nlist_64 STE = Obj.getSymbol64TableEntry(Symb);
404 return STE.n_type;
405 }
406 MachO::nlist STE = Obj.getSymbolTableEntry(Symb);
407 return STE.n_type;
408}
409
Rafael Espindola74375892014-02-04 00:21:18 +0000410static char getSymbolNMTypeChar(MachOObjectFile &Obj, symbol_iterator I) {
Rafael Espindola586af97a2013-11-02 21:16:09 +0000411 DataRefImpl Symb = I->getRawDataRefImpl();
412 uint8_t NType = getNType(Obj, Symb);
413
Rafael Espindola586af97a2013-11-02 21:16:09 +0000414 switch (NType & MachO::N_TYPE) {
Rafael Espindola586af97a2013-11-02 21:16:09 +0000415 case MachO::N_ABS:
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000416 return 's';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000417 case MachO::N_SECT: {
Rafael Espindolab5155a52014-02-10 20:24:04 +0000418 section_iterator Sec = Obj.section_end();
Rafael Espindola586af97a2013-11-02 21:16:09 +0000419 Obj.getSymbolSection(Symb, Sec);
420 DataRefImpl Ref = Sec->getRawDataRefImpl();
421 StringRef SectionName;
422 Obj.getSectionName(Ref, SectionName);
423 StringRef SegmentName = Obj.getSectionFinalSegmentName(Ref);
424 if (SegmentName == "__TEXT" && SectionName == "__text")
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000425 return 't';
Rafael Espindola586af97a2013-11-02 21:16:09 +0000426 else
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000427 return 's';
428 }
Rafael Espindola586af97a2013-11-02 21:16:09 +0000429 }
430
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000431 return '?';
432}
433
434template <class ELFT>
435static bool isObject(ELFObjectFile<ELFT> &Obj, symbol_iterator I) {
436 typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
437
438 DataRefImpl Symb = I->getRawDataRefImpl();
439 const Elf_Sym *ESym = Obj.getSymbol(Symb);
440
441 return ESym->getType() == ELF::STT_OBJECT;
442}
443
444static bool isObject(ObjectFile *Obj, symbol_iterator I) {
445 if (ELF32LEObjectFile *ELF = dyn_cast<ELF32LEObjectFile>(Obj))
446 return isObject(*ELF, I);
447 if (ELF64LEObjectFile *ELF = dyn_cast<ELF64LEObjectFile>(Obj))
448 return isObject(*ELF, I);
449 if (ELF32BEObjectFile *ELF = dyn_cast<ELF32BEObjectFile>(Obj))
450 return isObject(*ELF, I);
451 if (ELF64BEObjectFile *ELF = dyn_cast<ELF64BEObjectFile>(Obj))
452 return isObject(*ELF, I);
453 return false;
Rafael Espindola586af97a2013-11-02 21:16:09 +0000454}
455
456static char getNMTypeChar(ObjectFile *Obj, symbol_iterator I) {
Rafael Espindola22fe9c12014-02-05 05:19:19 +0000457 uint32_t Symflags = I->getFlags();
458 if ((Symflags & object::SymbolRef::SF_Weak) && !isa<MachOObjectFile>(Obj)) {
459 char Ret = isObject(Obj, I) ? 'v' : 'w';
460 if (!(Symflags & object::SymbolRef::SF_Undefined))
461 Ret = toupper(Ret);
462 return Ret;
463 }
464
465 if (Symflags & object::SymbolRef::SF_Undefined)
466 return 'U';
467
468 if (Symflags & object::SymbolRef::SF_Common)
469 return 'C';
470
471 char Ret = '?';
472 if (Symflags & object::SymbolRef::SF_Absolute)
473 Ret = 'a';
474 else if (COFFObjectFile *COFF = dyn_cast<COFFObjectFile>(Obj))
475 Ret = getSymbolNMTypeChar(*COFF, I);
476 else if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(Obj))
477 Ret = getSymbolNMTypeChar(*MachO, I);
478 else if (ELF32LEObjectFile *ELF = dyn_cast<ELF32LEObjectFile>(Obj))
479 Ret = getSymbolNMTypeChar(*ELF, I);
480 else if (ELF64LEObjectFile *ELF = dyn_cast<ELF64LEObjectFile>(Obj))
481 Ret = getSymbolNMTypeChar(*ELF, I);
482 else if (ELF32BEObjectFile *ELF = dyn_cast<ELF32BEObjectFile>(Obj))
483 Ret = getSymbolNMTypeChar(*ELF, I);
484 else
485 Ret = getSymbolNMTypeChar(*cast<ELF64BEObjectFile>(Obj), I);
486
487 if (Symflags & object::SymbolRef::SF_Global)
488 Ret = toupper(Ret);
489
490 return Ret;
Rafael Espindola586af97a2013-11-02 21:16:09 +0000491}
492
Rafael Espindola196666c2014-01-30 20:45:33 +0000493static void getDynamicSymbolIterators(ObjectFile *Obj, symbol_iterator &Begin,
494 symbol_iterator &End) {
495 if (ELF32LEObjectFile *ELF = dyn_cast<ELF32LEObjectFile>(Obj)) {
Rafael Espindolab5155a52014-02-10 20:24:04 +0000496 Begin = ELF->dynamic_symbol_begin();
497 End = ELF->dynamic_symbol_end();
Rafael Espindola196666c2014-01-30 20:45:33 +0000498 return;
499 }
500 if (ELF64LEObjectFile *ELF = dyn_cast<ELF64LEObjectFile>(Obj)) {
Rafael Espindolab5155a52014-02-10 20:24:04 +0000501 Begin = ELF->dynamic_symbol_begin();
502 End = ELF->dynamic_symbol_end();
Rafael Espindola196666c2014-01-30 20:45:33 +0000503 return;
504 }
505 if (ELF32BEObjectFile *ELF = dyn_cast<ELF32BEObjectFile>(Obj)) {
Rafael Espindolab5155a52014-02-10 20:24:04 +0000506 Begin = ELF->dynamic_symbol_begin();
507 End = ELF->dynamic_symbol_end();
Rafael Espindola196666c2014-01-30 20:45:33 +0000508 return;
509 }
510 ELF64BEObjectFile *ELF = cast<ELF64BEObjectFile>(Obj);
Rafael Espindolab5155a52014-02-10 20:24:04 +0000511 Begin = ELF->dynamic_symbol_begin();
512 End = ELF->dynamic_symbol_end();
Rafael Espindola196666c2014-01-30 20:45:33 +0000513 return;
514}
515
Rafael Espindola619581c2014-01-29 04:56:19 +0000516static void dumpSymbolNamesFromObject(ObjectFile *Obj) {
Rafael Espindolab5155a52014-02-10 20:24:04 +0000517 symbol_iterator IBegin = Obj->symbol_begin();
518 symbol_iterator IEnd = Obj->symbol_end();
Michael J. Spencer8c4729f2012-02-28 00:40:37 +0000519 if (DynamicSyms) {
Rafael Espindola196666c2014-01-30 20:45:33 +0000520 if (!Obj->isELF()) {
521 error("File format has no dynamic symbol table", Obj->getFileName());
522 return;
523 }
524 getDynamicSymbolIterators(Obj, IBegin, IEnd);
Michael J. Spencer8c4729f2012-02-28 00:40:37 +0000525 }
Rafael Espindola5e812af2014-01-30 02:49:50 +0000526 for (symbol_iterator I = IBegin; I != IEnd; ++I) {
Rafael Espindola20122a42014-01-31 20:57:12 +0000527 uint32_t SymFlags = I->getFlags();
Rafael Espindola619581c2014-01-29 04:56:19 +0000528 if (!DebugSyms && (SymFlags & SymbolRef::SF_FormatSpecific))
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000529 continue;
Rafael Espindola619581c2014-01-29 04:56:19 +0000530 NMSymbol S;
Rafael Espindola0115b082014-01-30 21:51:42 +0000531 S.Size = UnknownAddressOrSize;
532 S.Address = UnknownAddressOrSize;
Michael J. Spencer1d6167f2011-06-25 17:55:23 +0000533 if (PrintSize || SizeSort) {
Rafael Espindola619581c2014-01-29 04:56:19 +0000534 if (error(I->getSize(S.Size)))
535 break;
Michael J. Spencer1d6167f2011-06-25 17:55:23 +0000536 }
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000537 if (PrintAddress)
Rafael Espindola619581c2014-01-29 04:56:19 +0000538 if (error(I->getAddress(S.Address)))
539 break;
540 S.TypeChar = getNMTypeChar(Obj, I);
541 if (error(I->getName(S.Name)))
542 break;
543 SymbolList.push_back(S);
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000544 }
545
Rafael Espindola619581c2014-01-29 04:56:19 +0000546 CurrentFilename = Obj->getFileName();
547 sortAndPrintSymbolList();
Brian Gaeke0af759d2003-10-16 04:43:15 +0000548}
549
Rafael Espindola619581c2014-01-29 04:56:19 +0000550static void dumpSymbolNamesFromFile(std::string &Filename) {
Michael J. Spencerbc96f372011-12-13 23:17:29 +0000551 OwningPtr<MemoryBuffer> Buffer;
552 if (error(MemoryBuffer::getFileOrSTDIN(Filename, Buffer), Filename))
553 return;
554
Rafael Espindola619581c2014-01-29 04:56:19 +0000555 sys::fs::file_magic Magic = sys::fs::identify_magic(Buffer->getBuffer());
Michael J. Spencerbc96f372011-12-13 23:17:29 +0000556
Owen Anderson19251ec2009-07-15 22:16:10 +0000557 LLVMContext &Context = getGlobalContext();
Rafael Espindola619581c2014-01-29 04:56:19 +0000558 if (Magic == sys::fs::file_magic::bitcode) {
Rafael Espindola8f31e212014-01-15 01:08:23 +0000559 ErrorOr<Module *> ModuleOrErr = parseBitcodeFile(Buffer.get(), Context);
560 if (error(ModuleOrErr.getError(), Filename)) {
561 return;
562 } else {
563 Module *Result = ModuleOrErr.get();
Rafael Espindola619581c2014-01-29 04:56:19 +0000564 dumpSymbolNamesFromModule(Result);
Nuno Lopesbc561522009-09-10 14:56:31 +0000565 delete Result;
Brian Gaeke55447b42003-11-19 21:52:09 +0000566 }
Rafael Espindolace82a072014-01-30 19:24:00 +0000567 return;
568 }
Michael J. Spencerbc96f372011-12-13 23:17:29 +0000569
Rafael Espindola0115b082014-01-30 21:51:42 +0000570 ErrorOr<Binary *> BinaryOrErr = createBinary(Buffer.take(), Magic);
Rafael Espindolace82a072014-01-30 19:24:00 +0000571 if (error(BinaryOrErr.getError(), Filename))
572 return;
573 OwningPtr<Binary> Bin(BinaryOrErr.get());
Shankar Easwaran15b28be2012-11-13 18:38:42 +0000574
Rafael Espindola0115b082014-01-30 21:51:42 +0000575 if (Archive *A = dyn_cast<Archive>(Bin.get())) {
Rafael Espindolace82a072014-01-30 19:24:00 +0000576 if (ArchiveMap) {
Rafael Espindola0115b082014-01-30 21:51:42 +0000577 Archive::symbol_iterator I = A->symbol_begin();
578 Archive::symbol_iterator E = A->symbol_end();
Rafael Espindolace82a072014-01-30 19:24:00 +0000579 if (I != E) {
Rafael Espindola0115b082014-01-30 21:51:42 +0000580 outs() << "Archive map\n";
Rafael Espindolace82a072014-01-30 19:24:00 +0000581 for (; I != E; ++I) {
Rafael Espindola0115b082014-01-30 21:51:42 +0000582 Archive::child_iterator C;
Rafael Espindolace82a072014-01-30 19:24:00 +0000583 StringRef SymName;
584 StringRef FileName;
585 if (error(I->getMember(C)))
Michael J. Spencer9718f452013-02-03 10:48:50 +0000586 return;
Rafael Espindolace82a072014-01-30 19:24:00 +0000587 if (error(I->getName(SymName)))
588 return;
589 if (error(C->getName(FileName)))
590 return;
591 outs() << SymName << " in " << FileName << "\n";
Michael J. Spencer2bc774a2011-09-27 19:37:18 +0000592 }
Rafael Espindolace82a072014-01-30 19:24:00 +0000593 outs() << "\n";
Michael J. Spencer2bc774a2011-09-27 19:37:18 +0000594 }
595 }
Alexey Samsonove6388e62013-06-18 15:03:28 +0000596
Rafael Espindola0115b082014-01-30 21:51:42 +0000597 for (Archive::child_iterator I = A->child_begin(), E = A->child_end();
Rafael Espindolace82a072014-01-30 19:24:00 +0000598 I != E; ++I) {
599 OwningPtr<Binary> Child;
600 if (I->getAsBinary(Child)) {
601 // Try opening it as a bitcode file.
602 OwningPtr<MemoryBuffer> Buff;
603 if (error(I->getMemoryBuffer(Buff)))
604 return;
605
606 ErrorOr<Module *> ModuleOrErr = parseBitcodeFile(Buff.get(), Context);
607 if (ModuleOrErr) {
608 Module *Result = ModuleOrErr.get();
609 dumpSymbolNamesFromModule(Result);
610 delete Result;
611 }
612 continue;
613 }
Rafael Espindola0115b082014-01-30 21:51:42 +0000614 if (ObjectFile *O = dyn_cast<ObjectFile>(Child.get())) {
Rafael Espindolace82a072014-01-30 19:24:00 +0000615 outs() << O->getFileName() << ":\n";
616 dumpSymbolNamesFromObject(O);
617 }
618 }
619 return;
620 }
Rafael Espindola0115b082014-01-30 21:51:42 +0000621 if (MachOUniversalBinary *UB =
Rafael Espindolace82a072014-01-30 19:24:00 +0000622 dyn_cast<object::MachOUniversalBinary>(Bin.get())) {
Rafael Espindola0115b082014-01-30 21:51:42 +0000623 for (MachOUniversalBinary::object_iterator I = UB->begin_objects(),
624 E = UB->end_objects();
Alexey Samsonove6388e62013-06-18 15:03:28 +0000625 I != E; ++I) {
626 OwningPtr<ObjectFile> Obj;
627 if (!I->getAsObjectFile(Obj)) {
628 outs() << Obj->getFileName() << ":\n";
Rafael Espindola619581c2014-01-29 04:56:19 +0000629 dumpSymbolNamesFromObject(Obj.get());
Alexey Samsonove6388e62013-06-18 15:03:28 +0000630 }
631 }
Brian Gaeke618026a2003-11-19 21:57:30 +0000632 return;
Brian Gaeke0af759d2003-10-16 04:43:15 +0000633 }
Rafael Espindola0115b082014-01-30 21:51:42 +0000634 if (ObjectFile *O = dyn_cast<ObjectFile>(Bin.get())) {
Rafael Espindolace82a072014-01-30 19:24:00 +0000635 dumpSymbolNamesFromObject(O);
636 return;
637 }
638 error("unrecognizable file type", Filename);
639 return;
Brian Gaeke0af759d2003-10-16 04:43:15 +0000640}
641
642int main(int argc, char **argv) {
Chris Lattnere3fc2d12009-03-06 05:34:10 +0000643 // Print a stack trace if we signal out.
Chris Lattneref8f3892007-05-06 05:36:18 +0000644 sys::PrintStackTraceOnErrorSignal();
Chris Lattnere3fc2d12009-03-06 05:34:10 +0000645 PrettyStackTraceProgram X(argc, argv);
Michael J. Spencer618d2192010-08-31 06:36:46 +0000646
Rafael Espindola619581c2014-01-29 04:56:19 +0000647 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
Chris Lattnere3fc2d12009-03-06 05:34:10 +0000648 cl::ParseCommandLineOptions(argc, argv, "llvm symbol table dumper\n");
Chris Lattner12439ff2004-02-19 20:32:12 +0000649
Michael J. Spencerbc96f372011-12-13 23:17:29 +0000650 // llvm-nm only reads binary files.
Rafael Espindolacb2eca02013-06-12 20:58:35 +0000651 if (error(sys::ChangeStdinToBinary()))
Michael J. Spencerbc96f372011-12-13 23:17:29 +0000652 return 1;
653
Chris Lattneref8f3892007-05-06 05:36:18 +0000654 ToolName = argv[0];
Rafael Espindola619581c2014-01-29 04:56:19 +0000655 if (BSDFormat)
656 OutputFormat = bsd;
657 if (POSIXFormat)
658 OutputFormat = posix;
Chris Lattner4aae1f42003-10-16 18:45:23 +0000659
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000660 // The relative order of these is important. If you pass --size-sort it should
661 // only print out the size. However, if you pass -S --size-sort, it should
662 // print out both the size and address.
Rafael Espindola619581c2014-01-29 04:56:19 +0000663 if (SizeSort && !PrintSize)
664 PrintAddress = false;
665 if (OutputFormat == sysv || SizeSort)
666 PrintSize = true;
Michael J. Spencerb8672a52011-01-20 06:38:57 +0000667
Chris Lattneref8f3892007-05-06 05:36:18 +0000668 switch (InputFilenames.size()) {
Rafael Espindola619581c2014-01-29 04:56:19 +0000669 case 0:
670 InputFilenames.push_back("-");
671 case 1:
672 break;
673 default:
674 MultipleFiles = true;
Chris Lattner4aae1f42003-10-16 18:45:23 +0000675 }
Chris Lattneref8f3892007-05-06 05:36:18 +0000676
677 std::for_each(InputFilenames.begin(), InputFilenames.end(),
Rafael Espindola619581c2014-01-29 04:56:19 +0000678 dumpSymbolNamesFromFile);
Rafael Espindola8b82a4d2013-07-03 15:46:03 +0000679
680 if (HadError)
681 return 1;
682
Chris Lattneref8f3892007-05-06 05:36:18 +0000683 return 0;
Brian Gaeke0af759d2003-10-16 04:43:15 +0000684}