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', 'Default' and 'None'.
  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:: --build-variant-suffix <suffix=buildvariant>
  36
  37  Specify the build variant suffix used to build the executable file.
  38  There can be multiple variants for the binary of a product, each built
  39  slightly differently. The most common build variants are 'debug' and
  40  'profile'. Setting the DYLD_IMAGE_SUFFIX environment variable will
  41  cause dyld to load the specified variant at runtime.
  42
  43 .. option:: --dump-debug-map
  44
  45  Dump the *executable*'s debug-map (the list of the object files containing the
  46  debug information) in YAML format and exit. No DWARF link will take place.
  47
  48  .. option:: -D <path>
  49
  50  Specify a directory that contain dSYM files to search for.
  51  This is used for mergeable libraries, so dsymutil knows where to look
  52  for dSYM files with  debug information about symbols present in those
  53  libraries.
  54
  55 .. option:: --fat64
  56
  57  Use a 64-bit header when emitting universal binaries.
  58
  59 .. option:: --flat, -f
  60
  61  Produce a flat dSYM file. A ``.dwarf`` extension will be appended to the
  62  executable name unless the output file is specified using the ``-o`` option.
  63
  64 .. option:: --gen-reproducer
  65
  66  Generate a reproducer consisting of the input object files. Alias for
  67  --reproducer=GenerateOnExit.
  68
  69 .. option:: --help, -h
  70
  71  Print this help output.
  72
  73 .. option:: --keep-function-for-static
  74
  75  Make a static variable keep the enclosing function even if it would have been
  76  omitted otherwise.
  77
  78 .. option:: --minimize, -z
  79
  80  When used when creating a dSYM file, this option will suppress the emission of
  81  the .debug_inlines, .debug_pubnames, and .debug_pubtypes sections since
  82  dsymutil currently has better equivalents: .apple_names and .apple_types. When
  83  used in conjunction with ``--update`` option, this option will cause redundant
  84  accelerator tables to be removed.
  85
  86 .. option:: --no-object-timestamp
  87
  88  Don't check timestamp for object files.
  89
  90 .. option:: --no-odr
  91
  92  Do not use ODR (One Definition Rule) for uniquing C++ types.
  93
  94 .. option:: --no-output
  95
  96  Do the link in memory, but do not emit the result file.
  97
  98 .. option:: --no-swiftmodule-timestamp
  99
 100  Don't check the timestamp for swiftmodule files.
 101
 102 .. option:: --num-threads <threads>, -j <threads>
 103
 104  Specifies the maximum number (``n``) of simultaneous threads to use when
 105  linking multiple architectures.
 106
 107 .. option:: --object-prefix-map <prefix=remapped>
 108
 109  Remap object file paths (but no source paths) before processing.  Use
 110  this for Clang objects where the module cache location was remapped using
 111  ``-fdebug-prefix-map``; to help dsymutil find the Clang module cache.
 112
 113 .. option:: --oso-prepend-path <path>
 114
 115  Specifies a ``path`` to prepend to all debug symbol object file paths.
 116
 117 .. option:: --out <filename>, -o <filename>
 118
 119  Specifies an alternate ``path`` to place the dSYM bundle. The default dSYM
 120  bundle path is created by appending ``.dSYM`` to the executable name.
 121
 122 .. option:: -q, --quiet
 123
 124  Enable quiet mode and limit output.
 125
 126 .. option:: --remarks-drop-without-debug
 127
 128  Drop remarks without valid debug locations. Without this flags, all remarks are kept.
 129
 130 .. option:: --remarks-output-format <format>
 131
 132  Specify the format to be used when serializing the linked remarks.
 133
 134 .. option:: --remarks-prepend-path <path>
 135
 136  Specify a directory to prepend the paths of the external remark files.
 137
 138 .. option:: --reproducer <mode>
 139
 140  Specify the reproducer generation mode. Valid options are 'GenerateOnExit',
 141  'GenerateOnCrash', 'Use', 'Off'.
 142
 143 .. option:: --statistics
 144
 145  Print statistics about the contribution of each object file to the linked
 146  debug info. This prints a table after linking with the object file name, the
 147  size of the debug info in the object file (in bytes) and the size contributed
 148  (in bytes) to the linked dSYM. The table is sorted by the output size listing
 149  the object files with the largest contribution first.
 150
 151 .. option:: -s, --symtab
 152
 153  Dumps the symbol table found in *executable* or object file(s) and exits.
 154
 155 .. option:: -S
 156
 157  Output textual assembly instead of a binary dSYM companion file.
 158
 159 .. option:: --toolchain <toolchain>
 160
 161  Embed the toolchain in the dSYM bundle's property list.
 162
 163 .. option:: -u, --update
 164
 165  Update an existing dSYM file to contain the latest accelerator tables and
 166  other DWARF optimizations. This option will rebuild the '.apple_names' and
 167  '.apple_types' hashed accelerator tables.
 168
 169 .. option:: --use-reproducer <path>
 170
 171  Use the object files from the given reproducer path. Alias for
 172  --reproducer=Use.
 173
 174 .. option:: --verbose
 175
 176  Display verbose information when linking.
 177
 178 .. option:: --verify
 179
 180  Run the DWARF verifier on the linked DWARF debug info.
 181
 182 .. option:: -v, --version
 183
 184  Display the version of the tool.
 185
 186 .. option:: -y
 187
 188  Treat *executable* as a YAML debug-map rather than an executable.
 189
 190 EXIT STATUS
 191 -----------
 192
 193 :program:`dsymutil` returns 0 if the DWARF debug information was linked
 194 successfully. Otherwise, it returns 1.
 195
 196 SEE ALSO
 197 --------
 198
 199 :manpage:`llvm-dwarfdump(1)`