ADDR2LINE(1)

📦
version 2.40.50~ti1ubuntu1 · 2 versions
, in ubuntu noble

💖 ADDR2LINE 💖

okay so bestie, welcome to addr2line, one of the GNU Development Tools, and it's literally the translator of the debugging world 💅

✨ NAME ✨

addr2line — convert addresses or symbol+offset into file names and line numbers

🌸 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 ...]

🦋 DESCRIPTION 🦋

So here's the vibe: addr2line takes addresses, or symbol+offset, and turns them into file names and line numbers. That's it. That's the whole job. You hand it an address or a symbol+offset in an executable, or an offset in a section of a relocatable object, and it digs through the debugging information to figure out which file name and which line number go with it. no cap 🫶

Which executable or relocatable object it should look at? That's the -e option, bestie. And if you don't say anything, the default is the file a.out. The section inside the relocatable object is set with the -j option.

addr2line has two modes of operation, and honestly both are iconic:

  1. Mode one: you put hexadecimal addresses or symbol+offset right there on the command line, and addr2line shows you the file name and line number for each one.
  2. Mode two: addr2line reads hexadecimal addresses or symbol+offset from standard input, and prints the file name and line number for each address on standard output. In this mode it's perfect for a pipe, so you can convert dynamically chosen addresses on the fly. main character energy fr fr 🔥

The output format is FILENAME:LINENO. By default, each input address gives you exactly one line of output.

Two options can add extra lines before each FILENAME:LINENO line (in that order):

  • If you use -a, you get a line with the input address.
  • If you use -f, you get a line with the FUNCTIONNAME. That's the name of the function containing the address.

One option can add extra lines after the FILENAME:LINENO line:

  • If you use -i and the code at that address is there because the compiler inlined it, then extra lines show up afterwards. You get one or two extra lines (two if you're also using -f) for each inlined function.

Alternatively, if you use -p, then every input address gives you a single, long, gorgeous output line containing the address, the function name, the file name and the line number. And if you also used -i, then any inlined functions get displayed the same way, but on separate lines, each prefixed with the text (inlined by). obsessed.

If the file name or function name can't be determined, addr2line prints two question marks in their place. If the line number can't be determined, addr2line prints 0. 😭

When you use symbol+offset, the +offset is optional — except when the symbol is ambiguous with a hex number. The resolved symbols can be mangled or unmangled, except unmangled symbols with + are not allowed. (iykyk)

💅 OPTIONS 💅

The long and short forms of options, shown here as alternatives, are equivalent. pick your fighter 💖

  • -a, --addresses — Display the address before the function name, file and line number information. The address is printed with a 0x prefix so you can spot it easily. 👑
  • *-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.
  • *-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.
  • -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. the way that nesting just keeps going 😳
  • -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). 💅
  • -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 infinite 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. 💀

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. 🧚

🌈 SEE ALSO 🌈

  • Info entries for binutils.

Copyright (c) 1991-2023 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".

and that's the whole page bestie, you ate 🫶 go forth and turn your cryptic little addresses into actual file names and line numbers 💖✨

binutils-2.40.50 · 2023-07-04 · ADDR2LINE(1) — slay, thanks for reading, mwah 💋

📦 where this page comes from