ADDR2LINE(1)

πŸ“¦
version 2.35.1 Β· 2 versions
, in debian bookworm, ubuntu noble, ubuntu resolute

✨ ADDR2LINE ✨

okay so bestie, quick vibe check: this is addr2line, one of the GNU Development Tools, and its whole thing is turning addresses into file names and line numbers. it's giving detective energy fr fr πŸ”πŸ’–


🌸 SYNOPSIS 🌸

addr2line [-a|--addresses]
          [-b bfdname|--target=bfdname]
          [-C|--demangle[=style]]
          [-r|--no-recurse-limit]
          [-R|--recurse-limit]
          [-e filename|--exe=filename]
          [-f|--functions] [-s|--basename]
          [-i|--inlines]
          [-p|--pretty-print]
          [-j|--section=name]
          [-H|--help] [-V|--version]
          [addr addr ...]

like, that's the whole mood. copy it, paste it, we move πŸ’…


πŸ’œ DESCRIPTION πŸ’œ

so addr2line translates addresses into file names and line numbers. you hand it an address in an executable, or an offset in a section of a relocatable object, and it uses the debugging information to figure out which file name and line number are associated with it. it's literally the translator between "here's a number" and "here's where in your code that number lives" πŸ¦‹

the executable or relocatable object you wanna use gets specified with the -e option. the default is the file a.out. and the section inside the relocatable object gets picked with the -j option.

addr2line has two modes of operation. iconique, honestly:

  • in the first one, hexadecimal addresses are specified on the command line, and addr2line displays the file name and line number for each address.
  • in the second one, addr2line reads hexadecimal addresses from standard input, and prints the file name and line number for each address on standard output. in this mode, addr2line may be used in a pipe to convert dynamically chosen addresses. pipe girlies rise πŸ™Œ

the format of the output is FILENAME:LINENO. by default each input address generates one line of output. clean, minimal, we love.

Two options can generate additional lines before each FILENAME:LINENO line (in that order).

  • if the -a option is used then a line with the input address is displayed.
  • if the -f option is used, then a line with the FUNCTIONNAME is displayed. this is the name of the function containing the address.

One option can generate additional lines after the FILENAME:LINENO line.

  • if the -i option is used and the code at the given address is present there because of inlining by the compiler then additional lines are displayed afterwards. one or two extra lines (if the -f option is used) are displayed for each inlined function. nesting!! 🌈

alternatively, if the -p option is used then each input address generates a single, long, output line containing the address, the function name, the file name and the line number. if the -i option has also been used then any inlined functions will be displayed in the same manner, but on separate lines, and prefixed by the text (inlined by).

and now the sad part 😭 if the file name or function name can not be determined, addr2line will print two question marks in their place. if the line number can not be determined, addr2line will print 0. it's giving shrug emoji, but make it a program.


✨ OPTIONS ✨

the long and short forms of options, shown here as alternatives, are equivalent. so pick your fave, no judgement 🫢

  • -a, --addresses β€” display the address before the function name, file and line number information. the address is printed with a 0x prefix to easily identify it. cute little name tag fr.
  • -b bfdname, --target=bfdname β€” specify that the object-code format for the object files is bfdname.
  • -C, --demangle[=style] β€” decode (demangle) low-level symbol names into user-level names. besides removing any initial underscore prepended by the system, this makes C++ function names readable. different compilers have different mangling styles. the optional demangling style argument can be used to choose an appropriate demangling style for your compiler. it's the "translate the cursed string back into human" button πŸ’–
  • -e filename, --exe=filename β€” specify the name of the executable for which addresses should be translated. the default file is a.out.
  • -f, --functions β€” display function names as well as file and line number information.
  • -s, --basenames β€” display only the base of each file name. just the base, bestie, no full paths.
  • -i, --inlines β€” if the address belongs to a function that was inlined, the source information for all enclosing scopes back to the first non-inlined function will also be printed. for example, if "main" inlines "callee1" which inlines "callee2", and address is from "callee2", the source information for "callee1" and "main" will also be printed. it's the family tree of function calls 🌳
  • -j, --section β€” read offsets relative to the specified section instead of absolute addresses.
  • -p, --pretty-print β€” make the output more human friendly: each location are printed on one line. if option -i is specified, lines for all enclosing scopes are prefixed with (inlined by). glow-up for your terminal πŸ’…
  • -r, -R, --recurse-limit, --no-recurse-limit, --recursion-limit, --no-recursion-limit β€” enables or disables a limit on the amount of recursion performed whilst demangling strings. since the name mangling formats allow for an inifinite level of recursion it is possible to create strings whose decoding will exhaust the amount of stack space available on the host machine, triggering a memory fault. the limit tries to prevent this from happening by restricting recursion to 2048 levels of nesting.

the default is for this limit to be enabled, but disabling it may be necessary in order to demangle truly complicated names. note however that if the recursion limit is disabled then stack exhaustion is possible and any bug reports about such an event will be rejected.

πŸ’€ okay bestie listen: turn off the recursion limit and you're on your own. stack exhaustion can happen and bug reports about it get rejected, no cap. this is the "I know what I'm doing" option and it does NOT come with a safety net.

the -r option is a synonym for the --no-recurse-limit option. the -R option is a synonym for the --recurse-limit option.

note this option is only effective if the -C or --demangle option has been enabled.

  • @file β€” read command-line options from file. the options read are inserted in place of the original @file option. if file does not exist, or cannot be read, then the option will be treated literally, and not removed.

options in file are separated by whitespace. a whitespace character may be included in an option by surrounding the entire option in either single or double quotes. any character (including a backslash) may be included by prefixing the character to be included with a backslash. the file may itself contain additional @file options; any such options will be processed recursively. it's files all the way down πŸ‡βœ¨


πŸ¦‹ SEE ALSO πŸ¦‹

info entries for binutils. go read 'em, they're the extended lore ✨


copyright (c) 1991-2020 Free Software Foundation, Inc.

permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. a copy of the license is included in the section entitled "GNU Free Documentation License". legal queen behavior, periodt πŸ‘‘


and that's the whole page, bestie!! this was binutils-2.35.1, dated 2022-11-21 β€” yes the date is giving vintage but she still ate πŸ’–πŸŒΈ go convert some addresses, you've got this πŸ’…βœ¨

πŸ“¦ where this page comes from