LLVM-READOBJ(1)

📦
version 13.0.1 · 5 versions
, in ubuntu jammy

💅 llvm-readobj — the LLVM Object Reader, bestie edition

okay so this is a page from the LLVM manual set (yep, that LLVM 💜) and it's literally all about peeking inside object files. let's go 🎀

✨ SYNOPSIS ✨

llvm-readobj [options] [input…]

🦋 DESCRIPTION 🦋

so llvm-readobj is this iconic little tool that displays low-level, format-specific info about one or more object files. like, it shows you the guts. no cap 🔥

and listen: if input is -, then llvm-readobj reads from standard input. otherwise it reads from the filenames you gave it. simple as that 🫶

🌸 DIFFERENCES TO LLVM-READELF 🌸

so llvm-readelf is an alias for the llvm-readobj tool, but with a slightly different command-line interface and output that's GNU compatible. and here's the list of how they differ, bestie:

  • llvm-readelf uses GNU for the --elf-output-style option by default. llvm-readobj uses LLVM.
  • llvm-readelf allows single-letter grouped flags (e.g. llvm-readelf -SW is the same as llvm-readelf -S -W). llvm-readobj does not allow grouping.
  • llvm-readelf provides -s as an alias for --symbols, for GNU readelf compatibility, whereas it's an alias for --section-headers in llvm-readobj. (yes this is a whole thing 😭)
  • llvm-readobj provides -t as an alias for --symbols. llvm-readelf does not.
  • llvm-readobj provides --sr, --sd, --st and --dt as aliases for --section-relocations, --section-data, --section-symbols and --dyn-symbols respectively. llvm-readelf does not provide these aliases, to avoid conflicting with grouped flags.

✨ GENERAL AND MULTI-FORMAT OPTIONS ✨

these ones work across more than one file format, or they're just not about file formats at all 💫

  • --all — equivalent to specifying all the main display options relevant to the file format. the "give me everything" move 👑
  • --addrsig — display the address-significance table.
  • --expand-relocs — when used with --relocs, display each relocation in an expanded multi-line format. so roomy ✨
  • --file-header, -h — display file headers.
  • --headers, -e — equivalent to setting: --file-header, --program-headers, and --sections.
  • --help — display a summary of command line options.
  • --hex-dump=<section[,section,...]>, -x — display the specified section(s) as hexadecimal bytes. section may be a section index or section name.
  • --needed-libs — display the needed libraries.
  • --relocations, --relocs, -r — display the relocation entries in the file.
  • --sections, --section-headers, -S — display all sections.
  • --section-data, --sd — when used with --sections, display section data for each section shown. this option has no effect for GNU style output (just so you know 🫶).
  • --section-relocations, --sr — when used with --sections, display relocations for each section shown. this option has no effect for GNU style output.
  • --section-symbols, --st — when used with --sections, display symbols for each section shown. this option has no effect for GNU style output.
  • --stackmap — display contents of the stackmap section.
  • --string-dump=<section[,section,...]>, -p — display the specified section(s) as a list of strings. section may be a section index or section name.
  • --string-table — display contents of the string table.
  • --symbols, --syms, -s — display the symbol table.
  • --unwind, -u — display unwind information.
  • --version — display the version of the llvm-readobj executable.
  • @<FILE> — read command-line options from response file <FILE>.

🧚 ELF SPECIFIC OPTIONS 🧚

these ones are implemented only for the ELF file format, iykyk 💜

  • --arch-specific, -A — display architecture-specific information, e.g. the ARM attributes section on ARM.
  • --bb-addr-map — display the contents of the basic block address map section(s), which contain the address of each function, along with the relative offset of each basic block.
  • --demangle, -C — display demangled symbol names in the output.
  • --dependent-libraries — display the dependent libraries section.
  • --dyn-relocations — display the dynamic relocation entries.
  • --dyn-symbols, --dyn-syms, --dt — display the dynamic symbol table.
  • --dynamic-table, --dynamic, -d — display the dynamic table.
  • --cg-profile — display the callgraph profile section.
  • --histogram, -I — display a bucket list histogram for dynamic symbol hash tables.
  • --elf-linker-options — display the linker options section.
  • --elf-output-style=<value> — format ELF information in the specified style. valid options are LLVM and GNU. LLVM output (the default) is an expanded and structured format, whilst GNU output mimics the equivalent GNU readelf output.
  • --section-groups, -g — display section groups.
  • --gnu-hash-table — display the GNU hash table for dynamic symbols.
  • --hash-symbols — display the expanded hash table with dynamic symbol data.
  • --hash-table — display the hash table for dynamic symbols.
  • --notes, -n — display all notes.
  • --program-headers, --segments, -l — display the program headers.
  • --raw-relr — do not decode relocations in RELR relocation sections when displaying them.
  • --section-mapping — display the section to segment mapping.
  • --stack-sizes — display the contents of the stack sizes section(s), i.e. pairs of function names and the size of their stack frames. currently only implemented for GNU style output 👀
  • --version-info, -V — display version sections.

🌈 MACH-O SPECIFIC OPTIONS 🌈

only for the Mach-O file format, bestie 🍓

  • --macho-data-in-code — display the Data in Code command.
  • --macho-dsymtab — display the Dsymtab command.
  • --macho-indirect-symbols — display indirect symbols.
  • --macho-linker-options — display the Mach-O-specific linker options.
  • --macho-segment — display the Segment command.
  • --macho-version-min — display the version min command.

⭐ PE/COFF SPECIFIC OPTIONS ⭐

only for the PE/COFF file format 💫

  • --codeview — display CodeView debug information.
  • --codeview-ghash — enable global hashing for CodeView type stream de-duplication.
  • --codeview-merged-types — display the merged CodeView type stream.
  • --codeview-subsection-bytes — dump raw contents of CodeView debug sections and records.
  • --coff-basereloc — display the .reloc section.
  • --coff-debug-directory — display the debug directory.
  • --coff-tls-directory — display the TLS directory.
  • --coff-directives — display the .drectve section.
  • --coff-exports — display the export table.
  • --coff-imports — display the import table.
  • --coff-load-config — display the load config.
  • --coff-resources — display the .rsrc section.

🎀 EXIT STATUS 🎀

llvm-readobj returns 0 under normal operation. it returns a non-zero exit code if there were any errors. (so like, 0 = slay, non-zero = something went off 💀)

👑 SEE ALSO 👑

llvm-nm(1), llvm-objdump(1), llvm-readelf(1)

💖 AUTHOR 💖

maintained by the LLVM Team (https://llvm.org/). iconic behavior, honestly 🫶

2003-2023, LLVM Project

okay that's the whole page, bestie, go forth and read some objects 💅✨

signed off with love — this was LLVM manual page, version 13, dated 2023-07-14 🦋

📦 where this page comes from