xref: /freebsd/usr.bin/clang/llvm-readobj/llvm-readobj.1 (revision 95eb4b873b6a8b527c5bd78d7191975dfca38998)
Man page generated from reStructuredText.
. . .nr rst2man-indent-level 0 . \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .rstReportMargin pre:
. RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .rstReportMargin post:
.. . RE indent \\n[an-margin]
old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1 new: \\n[rst2man-indent\\n[rst2man-indent-level]]
..
"LLVM-READOBJ" "1" "2023-05-24" "16" "LLVM"
NAME
llvm-readobj - LLVM Object Reader
SYNOPSIS
llvm-readobj [options] [input...]
DESCRIPTION
The llvm-readobj tool displays low-level format-specific information about one or more object files. If input is \(dq-\(dq, llvm-readobj reads from standard input. Otherwise, it will read from the specified filenames.
DIFFERENCES TO LLVM-READELF
llvm-readelf is an alias for the llvm-readobj tool with a slightly different command-line interface and output that is GNU compatible. Following is a list of differences between llvm-readelf and llvm-readobj: NDENT 0.0
\(bu 2
llvm-readelf uses GNU for the \%--elf-output-style option by default. llvm-readobj uses LLVM.
\(bu 2
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.
\(bu 2
llvm-readelf provides \%-s as an alias for \%--symbols, for GNU readelf compatibility, whereas it is an alias for \%--section-headers in llvm-readobj.
\(bu 2
llvm-readobj provides -t as an alias for \%--symbols. llvm-readelf does not.
\(bu 2
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. NINDENT
GENERAL AND MULTI-FORMAT OPTIONS
These options are applicable to more than one file format, or are unrelated to file formats. NDENT 0.0

--all Equivalent to specifying all the main display options relevant to the file format. NINDENT NDENT 0.0

--addrsig Display the address-significance table. NINDENT NDENT 0.0

--expand-relocs When used with \%--relocs, display each relocation in an expanded multi-line format. NINDENT NDENT 0.0

--file-header, -h Display file headers. NINDENT NDENT 0.0

--headers, -e Equivalent to setting: \%--file-header, \%--program-headers, and \%--sections. NINDENT NDENT 0.0

--help Display a summary of command line options. NINDENT NDENT 0.0

--hex-dump=<section[,section,...]>, -x Display the specified section(s) as hexadecimal bytes. section may be a section index or section name. NINDENT NDENT 0.0

--needed-libs Display the needed libraries. NINDENT NDENT 0.0

--relocations, --relocs, -r Display the relocation entries in the file. NINDENT NDENT 0.0

--sections, --section-headers, -S Display all sections. NINDENT NDENT 0.0

--section-data, --sd When used with \%--sections, display section data for each section shown. This option has no effect for GNU style output. NINDENT NDENT 0.0

--section-relocations, --sr When used with \%--sections, display relocations for each section shown. This option has no effect for GNU style output. NINDENT NDENT 0.0

--section-symbols, --st When used with \%--sections, display symbols for each section shown. This option has no effect for GNU style output. NINDENT NDENT 0.0

--sort-symbols=<sort_key[,sort_key]> Specify the keys to sort symbols before displaying symtab. Valid values for sort_key are name and type. NINDENT NDENT 0.0

--stackmap Display contents of the stackmap section. NINDENT NDENT 0.0

--string-dump=<section[,section,...]>, -p Display the specified section(s) as a list of strings. section may be a section index or section name. NINDENT NDENT 0.0

--string-table Display contents of the string table. NINDENT NDENT 0.0

--symbols, --syms, -s Display the symbol table. NINDENT NDENT 0.0

--unwind, -u Display unwind information. NINDENT NDENT 0.0

--version Display the version of the llvm-readobj executable. NINDENT NDENT 0.0

@<FILE> Read command-line options from response file <FILE>. NINDENT

ELF SPECIFIC OPTIONS
The following options are implemented only for the ELF file format. NDENT 0.0

--arch-specific, -A Display architecture-specific information, e.g. the ARM attributes section on ARM. NINDENT NDENT 0.0

--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. NINDENT NDENT 0.0

--demangle, -C Display demangled symbol names in the output. NINDENT NDENT 0.0

--dependent-libraries Display the dependent libraries section. NINDENT NDENT 0.0

--dyn-relocations Display the dynamic relocation entries. NINDENT NDENT 0.0

--dyn-symbols, --dyn-syms, --dt Display the dynamic symbol table. NINDENT NDENT 0.0

--dynamic-table, --dynamic, -d Display the dynamic table. NINDENT NDENT 0.0

--cg-profile Display the callgraph profile section. NINDENT NDENT 0.0

--histogram, -I Display a bucket list histogram for dynamic symbol hash tables. NINDENT NDENT 0.0

--elf-linker-options Display the linker options section. NINDENT NDENT 0.0

--elf-output-style=<value> Format ELF information in the specified style. Valid options are LLVM, GNU, and JSON. LLVM output (the default) is an expanded and structured format. GNU output mimics the equivalent GNU readelf output. JSON is JSON formatted output intended for machine consumption. NINDENT NDENT 0.0

--section-groups, -g Display section groups. NINDENT NDENT 0.0

--gnu-hash-table Display the GNU hash table for dynamic symbols. NINDENT NDENT 0.0

--hash-symbols Display the expanded hash table with dynamic symbol data. NINDENT NDENT 0.0

--hash-table Display the hash table for dynamic symbols. NINDENT NDENT 0.0

--notes, -n Display all notes. NINDENT NDENT 0.0

--pretty-print When used with \%--elf-output-style, JSON output will be formatted in a more readable format. NINDENT NDENT 0.0

--program-headers, --segments, -l Display the program headers. NINDENT NDENT 0.0

--raw-relr Do not decode relocations in RELR relocation sections when displaying them. NINDENT NDENT 0.0

--section-mapping Display the section to segment mapping. NINDENT NDENT 0.0

--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. NINDENT NDENT 0.0

--version-info, -V Display version sections. NINDENT

MACH-O SPECIFIC OPTIONS
The following options are implemented only for the Mach-O file format. NDENT 0.0

--macho-data-in-code Display the Data in Code command. NINDENT NDENT 0.0

--macho-dsymtab Display the Dsymtab command. NINDENT NDENT 0.0

--macho-indirect-symbols Display indirect symbols. NINDENT NDENT 0.0

--macho-linker-options Display the Mach-O-specific linker options. NINDENT NDENT 0.0

--macho-segment Display the Segment command. NINDENT NDENT 0.0

--macho-version-min Display the version min command. NINDENT

PE/COFF SPECIFIC OPTIONS
The following options are implemented only for the PE/COFF file format. NDENT 0.0

--codeview Display CodeView debug information. NINDENT NDENT 0.0

--codeview-ghash Enable global hashing for CodeView type stream de-duplication. NINDENT NDENT 0.0

--codeview-merged-types Display the merged CodeView type stream. NINDENT NDENT 0.0

--codeview-subsection-bytes Dump raw contents of CodeView debug sections and records. NINDENT NDENT 0.0

--coff-basereloc Display the .reloc section. NINDENT NDENT 0.0

--coff-debug-directory Display the debug directory. NINDENT NDENT 0.0

--coff-tls-directory Display the TLS directory. NINDENT NDENT 0.0

--coff-directives Display the .drectve section. NINDENT NDENT 0.0

--coff-exports Display the export table. NINDENT NDENT 0.0

--coff-imports Display the import table. NINDENT NDENT 0.0

--coff-load-config Display the load config. NINDENT NDENT 0.0

--coff-resources Display the .rsrc section. NINDENT

XCOFF SPECIFIC OPTIONS
The following options are implemented only for the XCOFF file format. NDENT 0.0

--auxiliary-header Display XCOFF Auxiliary header. NINDENT NDENT 0.0

--exception-section Display XCOFF exception section entries. NINDENT NDENT 0.0

--loader-section-header Display XCOFF loader section header. NINDENT NDENT 0.0

--loader-section-symbols Display symbol table of loader section. NINDENT NDENT 0.0

--loader-section-relocations Display relocation entries of loader section. NINDENT

EXIT STATUS
llvm-readobj returns 0 under normal operation. It returns a non-zero exit code if there were any errors.
SEE ALSO
llvm-nm(1), llvm-objdump(1), llvm-readelf(1)
AUTHOR
Maintained by the LLVM Team (https://llvm.org/).
COPYRIGHT
2003-2023, LLVM Project Generated by docutils manpage writer.
.