llvm/docs/CommandGuide/dsymutil.rst

   1 dsymutil - manipulate archived DWARF debug symbol files
   2 =======================================================
   3
   4 .. program:: dsymutil
   5
   6 SYNOPSIS
   7 --------
   8
   9 | :program:`dsymutil` [*options*] *executable*
  10
  11 DESCRIPTION
  12 -----------
  13
  14 :program:`dsymutil` links the DWARF debug information found in the object files
  15 for an executable *executable* by using debug symbols information contained in
  16 its symbol table. By default, the linked debug information is placed in a
  17 ``.dSYM`` bundle with the same name as the executable.
  18
  19 OPTIONS
  20 -------
  21 .. option:: --accelerator=<accelerator type>
  22
  23  Specify the desired type of accelerator table. Valid options are 'Apple',
  24  'Dwarf' and 'Default'.
  25
  26 .. option:: --arch <arch>
  27
  28  Link DWARF debug information only for specified CPU architecture types.
  29  Architectures may be specified by name. When using this option, an error will
  30  be returned if any architectures can not be properly linked.  This option can
  31  be specified multiple times, once for each desired architecture. All CPU
  32  architectures will be linked by default and any architectures that can't be
  33  properly linked will cause :program:`dsymutil` to return an error.
  34
  35 .. option:: --dump-debug-map
  36
  37  Dump the *executable*'s debug-map (the list of the object files containing the
  38  debug information) in YAML format and exit. Not DWARF link will take place.
  39
  40 .. option:: --flat, -f
  41
  42  Produce a flat dSYM file. A ``.dwarf`` extension will be appended to the
  43  executable name unless the output file is specified using the ``-o`` option.
  44
  45 .. option:: --gen-reproducer
  46
  47  Generate a reproducer consisting of the input object files.
  48
  49 .. option:: --help, -h
  50
  51  Print this help output.
  52
  53 .. option:: --keep-function-for-static
  54
  55  Make a static variable keep the enclosing function even if it would have been
  56  omitted otherwise.
  57
  58 .. option:: --minimize, -z
  59
  60  When used when creating a dSYM file, this option will suppress the emission of
  61  the .debug_inlines, .debug_pubnames, and .debug_pubtypes sections since
  62  dsymutil currently has better equivalents: .apple_names and .apple_types. When
  63  used in conjunction with ``--update`` option, this option will cause redundant
  64  accelerator tables to be removed.
  65
  66 .. option:: --no-odr
  67
  68  Do not use ODR (One Definition Rule) for uniquing C++ types.
  69
  70 .. option:: --no-output
  71
  72  Do the link in memory, but do not emit the result file.
  73
  74 .. option:: --no-swiftmodule-timestamp
  75
  76  Don't check the timestamp for swiftmodule files.
  77
  78 .. option:: --num-threads <threads>, -j <threads>
  79
  80  Specifies the maximum number (``n``) of simultaneous threads to use when
  81  linking multiple architectures.
  82
  83 .. option:: --object-prefix-map <prefix=remapped>
  84
  85  Remap object file paths (but no source paths) before processing.  Use
  86  this for Clang objects where the module cache location was remapped using
  87  ``-fdebug-prefix-map``; to help dsymutil find the Clang module cache.
  88
  89 .. option:: --oso-prepend-path <path>
  90
  91  Specifies a ``path`` to prepend to all debug symbol object file paths.
  92
  93 .. option:: --out <filename>, -o <filename>
  94
  95  Specifies an alternate ``path`` to place the dSYM bundle. The default dSYM
  96  bundle path is created by appending ``.dSYM`` to the executable name.
  97
  98 .. option:: --papertrail
  99
 100  When running dsymutil as part of your build system, it can be desirable for
 101  warnings to be part of the end product, rather than just being emitted to the
 102  output stream. When enabled warnings are embedded in the linked DWARF debug
 103  information.
 104
 105 .. option:: --remarks-output-format <format>
 106
 107  Specify the format to be used when serializing the linked remarks.
 108
 109 .. option:: --remarks-prepend-path <path>
 110
 111  Specify a directory to prepend the paths of the external remark files.
 112
 113 .. option:: --statistics
 114
 115  Print statistics about the contribution of each object file to the linked
 116  debug info. This prints a table after linking with the object file name, the
 117  size of the debug info in the object file (in bytes) and the size contributed
 118  (in bytes) to the linked dSYM. The table is sorted by the output size listing
 119  the object files with the largest contribution first.
 120
 121 .. option:: --symbol-map <bcsymbolmap>
 122
 123  Update the existing dSYMs inplace using symbol map specified.
 124
 125 .. option:: -s, --symtab
 126
 127  Dumps the symbol table found in *executable* or object file(s) and exits.
 128
 129 .. option:: -S
 130
 131  Output textual assembly instead of a binary dSYM companion file.
 132
 133 .. option:: --toolchain <toolchain>
 134
 135  Embed the toolchain in the dSYM bundle's property list.
 136
 137 .. option:: -u, --update
 138
 139  Update an existing dSYM file to contain the latest accelerator tables and
 140  other DWARF optimizations. This option will rebuild the '.apple_names' and
 141  '.apple_types' hashed accelerator tables.
 142
 143 .. option:: --use-reproducer <path>
 144
 145  Use the object files from the given reproducer path.
 146
 147 .. option:: --verbose
 148
 149  Display verbose information when linking.
 150
 151 .. option:: --verify
 152
 153  Run the DWARF verifier on the linked DWARF debug info.
 154
 155 .. option:: -v, --version
 156
 157  Display the version of the tool.
 158
 159 .. option:: -y
 160
 161  Treat *executable* as a YAML debug-map rather than an executable.
 162
 163 EXIT STATUS
 164 -----------
 165
 166 :program:`dsymutil` returns 0 if the DWARF debug information was linked
 167 successfully. Otherwise, it returns 1.
 168
 169 SEE ALSO
 170 --------
 171
 172 :manpage:`llvm-dwarfdump(1)`