aboutsummaryrefslogtreecommitdiffstats
path: root/docs/CommandGuide/llvm-nm.rst
blob: cbc7af207592cfabbb40055b0fd632a4b3edb3ad (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
llvm-nm - list LLVM bitcode and object file's symbol table
==========================================================


SYNOPSIS
--------


:program:`llvm-nm` [*options*] [*filenames...*]


DESCRIPTION
-----------


The :program:`llvm-nm` utility lists the names of symbols from the LLVM bitcode
files, object files, or :program:`ar` archives containing them, named on the
command line. Each symbol is listed along with some simple information about its
provenance. If no file name is specified, or *-* is used as a file name,
:program:`llvm-nm` will process a file on its standard input stream.

:program:`llvm-nm`'s default output format is the traditional BSD :program:`nm`
output format. Each such output record consists of an (optional) 8-digit
hexadecimal address, followed by a type code character, followed by a name, for
each symbol. One record is printed per line; fields are separated by spaces.
When the address is omitted, it is replaced by 8 spaces.

Type code characters currently supported, and their meanings, are as follows:


U

 Named object is referenced but undefined in this bitcode file



C

 Common (multiple definitions link together into one def)



W

 Weak reference (multiple definitions link together into zero or one definitions)



t

 Local function (text) object



T

 Global function (text) object



d

 Local data object



D

 Global data object



?

 Something unrecognizable



Because LLVM bitcode files typically contain objects that are not considered to
have addresses until they are linked into an executable image or dynamically
compiled "just-in-time", :program:`llvm-nm` does not print an address for any
symbol in a LLVM bitcode file, even symbols which are defined in the bitcode
file.


OPTIONS
-------


.. program:: llvm-nm


.. option:: -B    (default)

 Use BSD output format. Alias for :option:`--format=bsd`.


.. option:: -P

 Use POSIX.2 output format. Alias for :option:`--format=posix`.


.. option:: --debug-syms, -a

 Show all symbols, even debugger only.


.. option:: --defined-only

 Print only symbols defined in this file (as opposed to
 symbols which may be referenced by objects in this file, but not
 defined in this file.)


.. option:: --dynamic, -D

 Display dynamic symbols instead of normal symbols.


.. option:: --extern-only, -g

 Print only symbols whose definitions are external; that is, accessible
 from other files.


.. option:: --format=format, -f format

 Select an output format; *format* may be *sysv*, *posix*, or *bsd*. The default
 is *bsd*.


.. option:: -help

 Print a summary of command-line options and their meanings.


.. option:: --no-sort, -p

 Shows symbols in order encountered.


.. option:: --numeric-sort, -n, -v

 Sort symbols by address.


.. option:: --print-file-name, -A, -o

 Precede each symbol with the file it came from.


.. option:: --print-size, -S

 Show symbol size instead of address.


.. option:: --size-sort

 Sort symbols by size.


.. option:: --undefined-only, -u

 Print only symbols referenced but not defined in this file.


BUGS
----


 * :program:`llvm-nm` cannot demangle C++ mangled names, like GNU :program:`nm`
   can.

 * :program:`llvm-nm` does not support the full set of arguments that GNU
   :program:`nm` does.


EXIT STATUS
-----------


:program:`llvm-nm` exits with an exit code of zero.


SEE ALSO
--------


llvm-dis|llvm-dis, ar(1), nm(1)