llvm/docs/CommandGuide/llvm-readelf.rst

   1 llvm-readelf - GNU-style LLVM Object Reader
   2 ===========================================
   3
   4 .. program:: llvm-readelf
   5
   6 SYNOPSIS
   7 --------
   8
   9 :program:`llvm-readelf` [*options*] [*input...*]
  10
  11 DESCRIPTION
  12 -----------
  13
  14 The :program:`llvm-readelf` tool displays low-level format-specific information
  15 about one or more object files.
  16
  17 If ``input`` is "``-``", :program:`llvm-readelf` reads from standard
  18 input. Otherwise, it will read from the specified ``filenames``.
  19
  20 OPTIONS
  21 -------
  22
  23 .. option:: --all, -a
  24
  25  Equivalent to specifying all the main display options relevant to the file
  26  format.
  27
  28 .. option:: --addrsig
  29
  30  Display the address-significance table.
  31
  32 .. option:: --arch-specific, -A
  33
  34  Display architecture-specific information, e.g. the ARM attributes section on ARM.
  35
  36 .. option:: --bb-addr-map
  37
  38  Display the contents of the basic block address map section(s), which contain the
  39  address of each function, along with the relative offset of each basic block.
  40
  41 .. option:: --demangle, -C
  42
  43  Display demangled symbol names in the output.
  44
  45 .. option:: --dependent-libraries
  46
  47  Display the dependent libraries section.
  48
  49 .. option:: --dyn-relocations
  50
  51  Display the dynamic relocation entries.
  52
  53 .. option:: --dyn-symbols, --dyn-syms
  54
  55  Display the dynamic symbol table.
  56
  57 .. option:: --dynamic-table, --dynamic, -d
  58
  59  Display the dynamic table.
  60
  61 .. option:: --cg-profile
  62
  63  Display the callgraph profile section.
  64
  65 .. option:: --histogram, -I
  66
  67  Display a bucket list histogram for dynamic symbol hash tables.
  68
  69 .. option:: --elf-linker-options
  70
  71  Display the linker options section.
  72
  73 .. option:: --elf-output-style=<value>
  74
  75  Format ELF information in the specified style. Valid options are ``LLVM``,
  76  ``GNU``, and ``JSON``. ``LLVM`` output is an expanded and structured format.
  77  ``GNU`` (the default) output mimics the equivalent GNU :program:`readelf`
  78  output. ``JSON`` is JSON formatted output intended for machine consumption.
  79
  80 .. option:: --extra-sym-info
  81
  82  Display extra information (section name) when showing symbols.
  83
  84 .. option:: --section-groups, -g
  85
  86  Display section groups.
  87
  88 .. option:: --expand-relocs
  89
  90  When used with :option:`--relocations`, display each relocation in an expanded
  91  multi-line format.
  92
  93 .. option:: --file-header, -h
  94
  95  Display file headers.
  96
  97 .. option:: --gnu-hash-table
  98
  99  Display the GNU hash table for dynamic symbols.
 100
 101 .. option:: --hash-symbols
 102
 103  Display the expanded hash table with dynamic symbol data.
 104
 105 .. option:: --hash-table
 106
 107  Display the hash table for dynamic symbols.
 108
 109 .. option:: --headers, -e
 110
 111  Equivalent to setting: :option:`--file-header`, :option:`--program-headers`,
 112  and :option:`--sections`.
 113
 114 .. option:: --help
 115
 116  Display a summary of command line options.
 117
 118 .. option:: --hex-dump=<section[,section,...]>, -x
 119
 120  Display the specified section(s) as hexadecimal bytes. ``section`` may be a
 121  section index or section name.
 122
 123 .. option:: --memtag
 124
 125  Display information about memory tagging present in the binary. This includes
 126  various memtag-specific dynamic entries, decoded global descriptor sections,
 127  and decoded Android-specific ELF notes.
 128
 129 .. option:: --needed-libs
 130
 131  Display the needed libraries.
 132
 133 .. option:: --no-demangle
 134
 135  Do not display demangled symbol names in the output. On by default.
 136
 137 .. option:: --notes, -n
 138
 139  Display all notes.
 140
 141 .. option:: --pretty-print
 142
 143  When used with :option:`--elf-output-style`, JSON output will be formatted in
 144  a more readable format.
 145
 146 .. option:: --program-headers, --segments, -l
 147
 148  Display the program headers.
 149
 150 .. option:: --raw-relr
 151
 152  Do not decode relocations in RELR relocation sections when displaying them.
 153
 154 .. option:: --relocations, --relocs, -r
 155
 156  Display the relocation entries in the file.
 157
 158 .. option:: --sections, --section-headers, -S
 159
 160  Display all sections.
 161
 162 .. option:: --section-data
 163
 164  When used with :option:`--sections`, display section data for each section
 165  shown. This option has no effect for GNU style output.
 166
 167 .. option:: --section-details, -t
 168
 169  Display all section details. Used as an alternative to :option:`--sections`.
 170
 171 .. option:: --section-mapping
 172
 173  Display the section to segment mapping.
 174
 175 .. option:: --section-relocations
 176
 177  When used with :option:`--sections`, display relocations for each section
 178  shown. This option has no effect for GNU style output.
 179
 180 .. option:: --section-symbols
 181
 182  When used with :option:`--sections`, display symbols for each section shown.
 183  This option has no effect for GNU style output.
 184
 185 .. option:: --stackmap
 186
 187  Display contents of the stackmap section.
 188
 189 .. option:: --stack-sizes
 190
 191  Display the contents of the stack sizes section(s), i.e. pairs of function
 192  names and the size of their stack frames. Currently only implemented for GNU
 193  style output.
 194
 195 .. option:: --string-dump=<section[,section,...]>, -p
 196
 197  Display the specified section(s) as a list of strings. ``section`` may be a
 198  section index or section name.
 199
 200 .. option:: --symbols, --syms, -s
 201
 202  Display the symbol table. Also display the dynamic symbol table when using GNU output style for ELF.
 203
 204 .. option:: --unwind, -u
 205
 206  Display unwind information.
 207
 208 .. option:: --version
 209
 210  Display the version of the :program:`llvm-readelf` executable.
 211
 212 .. option:: --version-info, -V
 213
 214  Display version sections.
 215
 216 .. option:: --wide, -W
 217
 218  Ignored for GNU readelf compatibility. The output is already similar to when using -W with GNU readelf.
 219
 220 .. option:: @<FILE>
 221
 222  Read command-line options from response file `<FILE>`.
 223
 224 EXIT STATUS
 225 -----------
 226
 227 :program:`llvm-readelf` returns 0 under normal operation. It returns a non-zero
 228 exit code if there were any errors.
 229
 230 SEE ALSO
 231 --------
 232
 233 :manpage:`llvm-nm(1)`, :manpage:`llvm-objdump(1)`, :manpage:`llvm-readobj(1)`