1llvm-nm - list LLVM bitcode and object file's symbol table
2==========================================================
3
4.. program:: llvm-nm
5
6SYNOPSIS
7--------
8
9:program:`llvm-nm` [*options*] [*filenames...*]
10
11DESCRIPTION
12-----------
13
14The :program:`llvm-nm` utility lists the names of symbols from LLVM bitcode
15files, object files, and archives. Each symbol is listed along with some simple
16information about its provenance. If no filename is specified, *a.out* is used
17as the input. If *-* is used as a filename, :program:`llvm-nm` will read a file
18from its standard input stream.
19
20:program:`llvm-nm`'s default output format is the traditional BSD :program:`nm`
21output format. Each such output record consists of an (optional) 8-digit
22hexadecimal address, followed by a type code character, followed by a name, for
23each symbol. One record is printed per line; fields are separated by spaces.
24When the address is omitted, it is replaced by 8 spaces.
25
26The supported type code characters are as follows. Where both lower and
27upper-case characters are listed for the same meaning, a lower-case character
28represents a local symbol, whilst an upper-case character represents a global
29(external) symbol:
30
31a, A
32
33 Absolute symbol.
34
35b, B
36
37 Uninitialized data (bss) object.
38
39C
40
41 Common symbol. Multiple definitions link together into one definition.
42
43d, D
44
45 Writable data object.
46
47i, I
48
49 COFF: .idata symbol or symbol in a section with IMAGE_SCN_LNK_INFO set.
50
51n
52
53 ELF: local symbol from non-alloc section.
54
55 COFF: debug symbol.
56
57N
58
59 ELF: debug section symbol, or global symbol from non-alloc section.
60
61s, S
62
63 COFF: section symbol.
64
65 Mach-O: absolute symbol or symbol from a section other than __TEXT_EXEC __text,
66 __TEXT __text, __DATA __data, or __DATA __bss.
67
68r, R
69
70 Read-only data object.
71
72t, T
73
74 Code (text) object.
75
76u
77
78 ELF: GNU unique symbol.
79
80U
81
82 Named object is undefined in this file.
83
84v
85
86 ELF: Undefined weak object. It is not a link failure if the object is not
87 defined.
88
89V
90
91 ELF: Defined weak object symbol. This definition will only be used if no
92 regular definitions exist in a link. If multiple weak definitions and no
93 regular definitions exist, one of the weak definitions will be used.
94
95w
96
97 Undefined weak symbol other than an ELF object symbol. It is not a link failure
98 if the symbol is not defined.
99
100W
101
102 Defined weak symbol other than an ELF object symbol. This definition will only
103 be used if no regular definitions exist in a link. If multiple weak definitions
104 and no regular definitions exist, one of the weak definitions will be used.
105
106\-
107
108 Mach-O: N_STAB symbol.
109
110?
111
112 Something unrecognizable.
113
114Because LLVM bitcode files typically contain objects that are not considered to
115have addresses until they are linked into an executable image or dynamically
116compiled "just-in-time", :program:`llvm-nm` does not print an address for any
117symbol in an LLVM bitcode file, even symbols which are defined in the bitcode
118file.
119
120OPTIONS
121-------
122
123.. program:: llvm-nm
124
125.. option:: -B
126
127 Use BSD output format. Alias for ``--format=bsd``.
128
129.. option:: -X
130
131 Specify the type of XCOFF object file, ELF object file, or IR object file input
132 from command line or from archive files that llvm-nm should examine. The
133 mode must be one of the following:
134
135   32
136         Process only 32-bit object files.
137   64
138         Process only 64-bit object files.
139   32_64
140         Process both 32-bit and 64-bit object files.
141   any
142         Process all the supported object files.
143
144.. option:: --debug-syms, -a
145
146 Show all symbols, even those usually suppressed.
147
148.. option:: --defined-only, -U
149
150 Print only symbols defined in this file.
151
152.. option:: --demangle, -C
153
154 Demangle symbol names.
155
156.. option:: --dynamic, -D
157
158 Display dynamic symbols instead of normal symbols.
159
160.. option:: --export-symbols
161
162 Print sorted symbols with their visibility (if applicable), with duplicates
163 removed.
164
165.. option:: --extern-only, -g
166
167 Print only symbols whose definitions are external; that is, accessible from
168 other files.
169
170.. option:: --format=<format>, -f
171
172 Select an output format; *format* may be *sysv*, *posix*, *darwin*, *bsd* or
173 *just-symbols*.
174 The default is *bsd*.
175
176.. option:: --help, -h
177
178 Print a summary of command-line options and their meanings.
179
180.. option:: -j
181
182 Print just the symbol names. Alias for `--format=just-symbols``.
183
184.. option:: -m
185
186 Use Darwin format. Alias for ``--format=darwin``.
187
188.. option:: --no-demangle
189
190 Don't demangle symbol names. This is the default.
191
192.. option:: --no-llvm-bc
193
194 Disable the LLVM bitcode reader.
195
196.. option:: --no-sort, -p
197
198 Show symbols in the order encountered.
199
200.. option:: --no-weak, -W
201
202 Don't print weak symbols.
203
204.. option:: --numeric-sort, -n, -v
205
206 Sort symbols by address.
207
208.. option:: --portability, -P
209
210 Use POSIX.2 output format.  Alias for ``--format=posix``.
211
212.. option:: --print-armap
213
214 Print the archive symbol table, in addition to the symbols.
215
216.. option:: --print-file-name, -A, -o
217
218 Precede each symbol with the file it came from.
219
220.. option:: --print-size, -S
221
222 Show symbol size as well as address (not applicable for Mach-O).
223
224.. option:: --quiet
225
226 Suppress 'no symbols' diagnostic.
227
228.. option:: --radix=<RADIX>, -t
229
230 Specify the radix of the symbol address(es). Values accepted are *d* (decimal),
231 *x* (hexadecimal) and *o* (octal).
232
233.. option:: --reverse-sort, -r
234
235 Sort symbols in reverse order.
236
237.. option:: --size-sort
238
239 Sort symbols by size.
240
241.. option:: --special-syms
242
243 Do not filter special symbols from the output.
244
245.. option:: --undefined-only, -u
246
247 Print only undefined symbols.
248
249.. option:: --version, -V
250
251 Display the version of the :program:`llvm-nm` executable, then exit. Does not
252 stack with other commands.
253
254.. option:: @<FILE>
255
256 Read command-line options from response file `<FILE>`.
257
258MACH-O SPECIFIC OPTIONS
259-----------------------
260
261.. option:: --add-dyldinfo
262
263 Add symbols from the dyldinfo, if they are not already in the symbol table.
264 This is the default.
265
266.. option:: --add-inlinedinfo
267
268 Add symbols from the inlined libraries, TBD file inputs only.
269
270.. option:: --arch=<arch1[,arch2,...]>
271
272 Dump the symbols from the specified architecture(s).
273
274.. option:: --dyldinfo-only
275
276 Dump only symbols from the dyldinfo.
277
278.. option:: --no-dyldinfo
279
280 Do not add any symbols from the dyldinfo.
281
282.. option:: -s <segment> <section>
283
284 Dump only symbols from this segment and section name.
285
286.. option:: -x
287
288 Print symbol entry in hex.
289
290XCOFF SPECIFIC OPTIONS
291----------------------
292
293.. option:: --no-rsrc
294
295  Exclude resource file symbols (``__rsrc``) from export symbol list.
296
297BUGS
298----
299
300 * :program:`llvm-nm` does not support the full set of arguments that GNU
301   :program:`nm` does.
302
303EXIT STATUS
304-----------
305
306:program:`llvm-nm` exits with an exit code of zero.
307
308SEE ALSO
309--------
310
311:manpage:`llvm-ar(1)`, :manpage:`llvm-objdump(1)`, :manpage:`llvm-readelf(1)`,
312:manpage:`llvm-readobj(1)`
313