| blob | 9a5f3a2aa9156cc77840266a4e63b872f2eacca2 |
1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 . ds -- \(*W-
28 . ds PI pi
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31 . ds L" ""
32 . ds R" ""
33 . ds C` ""
34 . ds C' ""
35 'br\}
36 .el\{\
37 . ds -- \|\(em\|
38 . ds PI \(*p
39 . ds L" ``
40 . ds R" ''
41 . ds C`
42 . ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el .ds Aq '
48 .\"
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
60 . if \nF \{\
61 . de IX
62 . tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 . if !\nF==2 \{\
65 . nr % 0
66 . nr F 2
67 . \}
68 . \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear. Run. Save yourself. No user-serviceable parts.
74 . \" fudge factors for nroff and troff
75 .if n \{\
76 . ds #H 0
77 . ds #V .8m
78 . ds #F .3m
79 . ds #[ \f1
80 . ds #] \fP
81 .\}
82 .if t \{\
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 . ds #V .6m
85 . ds #F 0
86 . ds #[ \&
87 . ds #] \&
88 .\}
89 . \" simple accents for nroff and troff
90 .if n \{\
91 . ds ' \&
92 . ds ` \&
93 . ds ^ \&
94 . ds , \&
95 . ds ~ ~
96 . ds /
97 .\}
98 .if t \{\
99 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 . \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 . \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 . \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 . ds : e
123 . ds 8 ss
124 . ds o a
125 . ds d- d\h'-1'\(ga
126 . ds D- D\h'-1'\(hy
127 . ds th \o'bp'
128 . ds Th \o'LP'
129 . ds ae ae
130 . ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "ADDR2LINE 1"
136 .TH ADDR2LINE 1 "2022-02-09" "binutils-2.38" "GNU Development Tools"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 addr2line \- convert addresses into file names and line numbers
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 addr2line [\fB\-a\fR|\fB\-\-addresses\fR]
146 [\fB\-b\fR \fIbfdname\fR|\fB\-\-target=\fR\fIbfdname\fR]
147 [\fB\-C\fR|\fB\-\-demangle\fR[=\fIstyle\fR]]
148 [\fB\-r\fR|\fB\-\-no\-recurse\-limit\fR]
149 [\fB\-R\fR|\fB\-\-recurse\-limit\fR]
150 [\fB\-e\fR \fIfilename\fR|\fB\-\-exe=\fR\fIfilename\fR]
151 [\fB\-f\fR|\fB\-\-functions\fR] [\fB\-s\fR|\fB\-\-basename\fR]
152 [\fB\-i\fR|\fB\-\-inlines\fR]
153 [\fB\-p\fR|\fB\-\-pretty\-print\fR]
154 [\fB\-j\fR|\fB\-\-section=\fR\fIname\fR]
155 [\fB\-H\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR]
156 [addr addr ...]
157 .SH "DESCRIPTION"
158 .IX Header "DESCRIPTION"
159 \&\fBaddr2line\fR translates addresses into file names and line numbers.
160 Given an address in an executable or an offset in a section of a relocatable
161 object, it uses the debugging information to figure out which file name and
162 line number are associated with it.
163 .PP
164 The executable or relocatable object to use is specified with the \fB\-e\fR
165 option. The default is the file \fIa.out\fR. The section in the relocatable
166 object to use is specified with the \fB\-j\fR option.
167 .PP
168 \&\fBaddr2line\fR has two modes of operation.
169 .PP
170 In the first, hexadecimal addresses are specified on the command line,
171 and \fBaddr2line\fR displays the file name and line number for each
172 address.
173 .PP
174 In the second, \fBaddr2line\fR reads hexadecimal addresses from
175 standard input, and prints the file name and line number for each
176 address on standard output. In this mode, \fBaddr2line\fR may be used
177 in a pipe to convert dynamically chosen addresses.
178 .PP
179 The format of the output is \fB\s-1FILENAME:LINENO\s0\fR. By default
180 each input address generates one line of output.
181 .PP
182 Two options can generate additional lines before each
183 \&\fB\s-1FILENAME:LINENO\s0\fR line (in that order).
184 .PP
185 If the \fB\-a\fR option is used then a line with the input address
186 is displayed.
187 .PP
188 If the \fB\-f\fR option is used, then a line with the
189 \&\fB\s-1FUNCTIONNAME\s0\fR is displayed. This is the name of the function
190 containing the address.
191 .PP
192 One option can generate additional lines after the
193 \&\fB\s-1FILENAME:LINENO\s0\fR line.
194 .PP
195 If the \fB\-i\fR option is used and the code at the given address is
196 present there because of inlining by the compiler then additional
197 lines are displayed afterwards. One or two extra lines (if the
198 \&\fB\-f\fR option is used) are displayed for each inlined function.
199 .PP
200 Alternatively if the \fB\-p\fR option is used then each input
201 address generates a single, long, output line containing the address,
202 the function name, the file name and the line number. If the
203 \&\fB\-i\fR option has also been used then any inlined functions will
204 be displayed in the same manner, but on separate lines, and prefixed
205 by the text \fB(inlined by)\fR.
206 .PP
207 If the file name or function name can not be determined,
208 \&\fBaddr2line\fR will print two question marks in their place. If the
209 line number can not be determined, \fBaddr2line\fR will print 0.
210 .SH "OPTIONS"
211 .IX Header "OPTIONS"
212 The long and short forms of options, shown here as alternatives, are
213 equivalent.
214 .IP "\fB\-a\fR" 4
215 .IX Item "-a"
216 .PD 0
217 .IP "\fB\-\-addresses\fR" 4
218 .IX Item "--addresses"
219 .PD
220 Display the address before the function name, file and line number
221 information. The address is printed with a \fB0x\fR prefix to easily
222 identify it.
223 .IP "\fB\-b\fR \fIbfdname\fR" 4
224 .IX Item "-b bfdname"
225 .PD 0
226 .IP "\fB\-\-target=\fR\fIbfdname\fR" 4
227 .IX Item "--target=bfdname"
228 .PD
229 Specify that the object-code format for the object files is
230 \&\fIbfdname\fR.
231 .IP "\fB\-C\fR" 4
232 .IX Item "-C"
233 .PD 0
234 .IP "\fB\-\-demangle[=\fR\fIstyle\fR\fB]\fR" 4
235 .IX Item "--demangle[=style]"
236 .PD
237 Decode (\fIdemangle\fR) low-level symbol names into user-level names.
238 Besides removing any initial underscore prepended by the system, this
239 makes \*(C+ function names readable. Different compilers have different
240 mangling styles. The optional demangling style argument can be used to
241 choose an appropriate demangling style for your compiler.
242 .IP "\fB\-e\fR \fIfilename\fR" 4
243 .IX Item "-e filename"
244 .PD 0
245 .IP "\fB\-\-exe=\fR\fIfilename\fR" 4
246 .IX Item "--exe=filename"
247 .PD
248 Specify the name of the executable for which addresses should be
249 translated. The default file is \fIa.out\fR.
250 .IP "\fB\-f\fR" 4
251 .IX Item "-f"
252 .PD 0
253 .IP "\fB\-\-functions\fR" 4
254 .IX Item "--functions"
255 .PD
256 Display function names as well as file and line number information.
257 .IP "\fB\-s\fR" 4
258 .IX Item "-s"
259 .PD 0
260 .IP "\fB\-\-basenames\fR" 4
261 .IX Item "--basenames"
262 .PD
263 Display only the base of each file name.
264 .IP "\fB\-i\fR" 4
265 .IX Item "-i"
266 .PD 0
267 .IP "\fB\-\-inlines\fR" 4
268 .IX Item "--inlines"
269 .PD
270 If the address belongs to a function that was inlined, the source
271 information for all enclosing scopes back to the first non-inlined
272 function will also be printed. For example, if \f(CW\*(C`main\*(C'\fR inlines
273 \&\f(CW\*(C`callee1\*(C'\fR which inlines \f(CW\*(C`callee2\*(C'\fR, and address is from
274 \&\f(CW\*(C`callee2\*(C'\fR, the source information for \f(CW\*(C`callee1\*(C'\fR and \f(CW\*(C`main\*(C'\fR
275 will also be printed.
276 .IP "\fB\-j\fR" 4
277 .IX Item "-j"
278 .PD 0
279 .IP "\fB\-\-section\fR" 4
280 .IX Item "--section"
281 .PD
282 Read offsets relative to the specified section instead of absolute addresses.
283 .IP "\fB\-p\fR" 4
284 .IX Item "-p"
285 .PD 0
286 .IP "\fB\-\-pretty\-print\fR" 4
287 .IX Item "--pretty-print"
288 .PD
289 Make the output more human friendly: each location are printed on one line.
290 If option \fB\-i\fR is specified, lines for all enclosing scopes are
291 prefixed with \fB(inlined by)\fR.
292 .IP "\fB\-r\fR" 4
293 .IX Item "-r"
294 .PD 0
295 .IP "\fB\-R\fR" 4
296 .IX Item "-R"
297 .IP "\fB\-\-recurse\-limit\fR" 4
298 .IX Item "--recurse-limit"
299 .IP "\fB\-\-no\-recurse\-limit\fR" 4
300 .IX Item "--no-recurse-limit"
301 .IP "\fB\-\-recursion\-limit\fR" 4
302 .IX Item "--recursion-limit"
303 .IP "\fB\-\-no\-recursion\-limit\fR" 4
304 .IX Item "--no-recursion-limit"
305 .PD
306 Enables or disables a limit on the amount of recursion performed
307 whilst demangling strings. Since the name mangling formats allow for
308 an infinite level of recursion it is possible to create strings whose
309 decoding will exhaust the amount of stack space available on the host
310 machine, triggering a memory fault. The limit tries to prevent this
311 from happening by restricting recursion to 2048 levels of nesting.
312 .Sp
313 The default is for this limit to be enabled, but disabling it may be
314 necessary in order to demangle truly complicated names. Note however
315 that if the recursion limit is disabled then stack exhaustion is
316 possible and any bug reports about such an event will be rejected.
317 .Sp
318 The \fB\-r\fR option is a synonym for the
319 \&\fB\-\-no\-recurse\-limit\fR option. The \fB\-R\fR option is a
320 synonym for the \fB\-\-recurse\-limit\fR option.
321 .Sp
322 Note this option is only effective if the \fB\-C\fR or
323 \&\fB\-\-demangle\fR option has been enabled.
324 .IP "\fB@\fR\fIfile\fR" 4
325 .IX Item "@file"
326 Read command-line options from \fIfile\fR. The options read are
327 inserted in place of the original @\fIfile\fR option. If \fIfile\fR
328 does not exist, or cannot be read, then the option will be treated
329 literally, and not removed.
330 .Sp
331 Options in \fIfile\fR are separated by whitespace. A whitespace
332 character may be included in an option by surrounding the entire
333 option in either single or double quotes. Any character (including a
334 backslash) may be included by prefixing the character to be included
335 with a backslash. The \fIfile\fR may itself contain additional
336 @\fIfile\fR options; any such options will be processed recursively.
337 .SH "SEE ALSO"
338 .IX Header "SEE ALSO"
339 Info entries for \fIbinutils\fR.
340 .SH "COPYRIGHT"
341 .IX Header "COPYRIGHT"
342 Copyright (c) 1991\-2022 Free Software Foundation, Inc.
343 .PP
344 Permission is granted to copy, distribute and/or modify this document
345 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.3
346 or any later version published by the Free Software Foundation;
347 with no Invariant Sections, with no Front-Cover Texts, and with no
348 Back-Cover Texts. A copy of the license is included in the
349 section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R".