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
  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:: --dyn-relocations
  46
  47  Display the dynamic relocation entries.
  48
  49 .. option:: --dyn-symbols, --dyn-syms
  50
  51  Display the dynamic symbol table.
  52
  53 .. option:: --dynamic-table, --dynamic, -d
  54
  55  Display the dynamic table.
  56
  57 .. option:: --cg-profile
  58
  59  Display the callgraph profile section.
  60
  61 .. option:: --histogram, -I
  62
  63  Display a bucket list histogram for dynamic symbol hash tables.
  64
  65 .. option:: --elf-linker-options
  66
  67  Display the linker options section.
  68
  69 .. option:: --elf-output-style=<value>
  70
  71  Format ELF information in the specified style. Valid options are ``LLVM`` and
  72  ``GNU``. ``LLVM`` output is an expanded and structured format, whilst ``GNU``
  73  (the default) output mimics the equivalent GNU :program:`readelf` output.
  74
  75 .. option:: --section-groups, -g
  76
  77  Display section groups.
  78
  79 .. option:: --expand-relocs
  80
  81  When used with :option:`--relocations`, display each relocation in an expanded
  82  multi-line format.
  83
  84 .. option:: --file-header, -h
  85
  86  Display file headers.
  87
  88 .. option:: --gnu-hash-table
  89
  90  Display the GNU hash table for dynamic symbols.
  91
  92 .. option:: --hash-symbols
  93
  94  Display the expanded hash table with dynamic symbol data.
  95
  96 .. option:: --hash-table
  97
  98  Display the hash table for dynamic symbols.
  99
 100 .. option:: --headers, -e
 101
 102  Equivalent to setting: :option:`--file-header`, :option:`--program-headers`,
 103  and :option:`--sections`.
 104
 105 .. option:: --help
 106
 107  Display a summary of command line options.
 108
 109 .. option:: --hex-dump=<section[,section,...]>, -x
 110
 111  Display the specified section(s) as hexadecimal bytes. ``section`` may be a
 112  section index or section name.
 113
 114 .. option:: --needed-libs
 115
 116  Display the needed libraries.
 117
 118 .. option:: --notes, -n
 119
 120  Display all notes.
 121
 122 .. option:: --program-headers, --segments, -l
 123
 124  Display the program headers.
 125
 126 .. option:: --raw-relr
 127
 128  Do not decode relocations in RELR relocation sections when displaying them.
 129
 130 .. option:: --relocations, --relocs, -r
 131
 132  Display the relocation entries in the file.
 133
 134 .. option:: --sections, --section-headers, -S
 135
 136  Display all sections.
 137
 138 .. option:: --section-data
 139
 140  When used with :option:`--sections`, display section data for each section
 141  shown. This option has no effect for GNU style output.
 142
 143 .. option:: --section-details, -t
 144
 145  Display all section details. Used as an alternative to :option:`--sections`.
 146
 147 .. option:: --section-mapping
 148
 149  Display the section to segment mapping.
 150
 151 .. option:: --section-relocations
 152
 153  When used with :option:`--sections`, display relocations for each section
 154  shown. This option has no effect for GNU style output.
 155
 156 .. option:: --section-symbols
 157
 158  When used with :option:`--sections`, display symbols for each section shown.
 159  This option has no effect for GNU style output.
 160
 161 .. option:: --stackmap
 162
 163  Display contents of the stackmap section.
 164
 165 .. option:: --stack-sizes
 166
 167  Display the contents of the stack sizes section(s), i.e. pairs of function
 168  names and the size of their stack frames. Currently only implemented for GNU
 169  style output.
 170
 171 .. option:: --string-dump=<section[,section,...]>, -p
 172
 173  Display the specified section(s) as a list of strings. ``section`` may be a
 174  section index or section name.
 175
 176 .. option:: --symbols, --syms, -s
 177
 178  Display the symbol table.
 179
 180 .. option:: --unwind, -u
 181
 182  Display unwind information.
 183
 184 .. option:: --version
 185
 186  Display the version of the :program:`llvm-readelf` executable.
 187
 188 .. option:: --version-info, -V
 189
 190  Display version sections.
 191
 192 .. option:: @<FILE>
 193
 194  Read command-line options from response file `<FILE>`.
 195
 196 EXIT STATUS
 197 -----------
 198
 199 :program:`llvm-readelf` returns 0 under normal operation. It returns a non-zero
 200 exit code if there were any errors.
 201
 202 SEE ALSO
 203 --------
 204
 205 :manpage:`llvm-nm(1)`, :manpage:`llvm-objdump(1)`, :manpage:`llvm-readobj(1)`