DSYMUTIL(1)

📦
version 13.0.1 · 5 versions
, in ubuntu jammy

💅 DSYMUTIL — manipulation of archived DWARF debug symbol files

okay so welcome to the dsymutil page bestie 🌸 this is from the LLVM manual set, and it's genuinely one of those tools that's lowkey doing the most important work while nobody claps for it. we're gonna get you fluent, fr fr.

✨ SYNOPSIS ✨

dsymutil [options] executable

🦋 DESCRIPTION 🦋

So here's the vibe: dsymutil links the DWARF debug information that's hanging out inside the object files of an executable — and it does that by using the debug symbols info contained in that executable's symbol table. Iconic teamwork honestly.

By default? The linked debug info gets placed in a .dSYM bundle with the same name as the executable. That's the default main character move 👑

🎀 OPTIONS 🎀

okay buckle up, there are a LOT and every single one is here, no skips:

  • --accelerator=<accelerator type> — picks which type of accelerator table you want. Valid options are ‘Apple’, ‘Dwarf’ and ‘Default’. that's the whole list, don't get creative 💅
  • --arch <arch> — links DWARF debug info only for the specified CPU architecture types. Architectures may be specified by name. When you use this option, an error will be returned if any architectures can not be properly linked. You can specify this option multiple times — once for each desired architecture. By default, all CPU architectures get linked, and any architecture that can't be properly linked will cause dsymutil to return an error. ngl that default is strict but fair 🫶
  • --dump-debug-map — dumps the executable's debug-map (that's the list of the object files containing the debug information) in YAML format, then exits. No DWARF link will take place. it's just peeking, not touching 🙈
  • --flat, -f — produces a flat dSYM file. A .dwarf extension gets appended to the executable name unless the output file is specified using the -o option. important detail, don't forget it ✨
  • --gen-reproducer — generates a reproducer consisting of the input object files.
  • --help, -h — prints this help output. hi 👋
  • --keep-function-for-static — makes a static variable keep the enclosing function even if it would have been omitted otherwise. protective queen behavior 🥺
  • --minimize, -z — when used while creating a dSYM file, this option suppresses the emission of the .debug_inlines, .debug_pubnames, and .debug_pubtypes sections, since dsymutil currently has better equivalents: .apple_names and .apple_types. When used in conjunction with the --update option, this option will cause redundant accelerator tables to be removed. decluttering slay 🧹
  • --no-odr — do not use ODR (One Definition Rule) for uniquing C++ types.
  • --no-output — does the link in memory, but does not emit the result file. all the effort, none of the artifact 😭
  • --no-swiftmodule-timestamp — don't check the timestamp for swiftmodule files.
  • --num-threads <threads>, -j <threads> — specifies the maximum number (n) of simultaneous threads to use when linking multiple architectures. more threads, more chaos, go off 🏃‍♀️
  • --object-prefix-map <prefix=remapped> — remaps object file paths (but no source paths) before processing. Use this for Clang objects where the module cache location was remapped using -fdebug-prefix-map; this helps dsymutil find the Clang module cache. yes that flag is written exactly like that, copy it carefully 💖
  • --oso-prepend-path <path> — specifies a path to prepend to all debug symbol object file paths.
  • --out <filename>, -o <filename> — specifies an alternate path to place the dSYM bundle. The default dSYM bundle path is created by appending .dSYM to the executable name.
  • --papertrail — when running dsymutil as part of your build system, it can be desirable for warnings to be part of the end product, rather than just being emitted to the output stream. When enabled, warnings are embedded in the linked DWARF debug information. warnings but make them permanent, love that for you 📌
  • --remarks-output-format <format> — specifies the format to be used when serializing the linked remarks.
  • --remarks-prepend-path <path> — specifies a directory to prepend the paths of the external remark files.
  • --statistics — prints statistics about the contribution of each object file to the linked debug info. This prints a table after linking with the object file name, the size of the debug info in the object file (in bytes) and the size contributed (in bytes) to the linked dSYM. The table is sorted by the output size, listing the object files with the largest contribution first. leaderboard energy 👑
  • --symbol-map <bcsymbolmap> — updates the existing dSYMs inplace using the symbol map specified. yes, "inplace", that's the spelling, we don't touch it 💅
  • -s, --symtab — dumps the symbol table found in the executable or object file(s), then exits.
  • -S — outputs textual assembly instead of a binary dSYM companion file.
  • --toolchain <toolchain> — embeds the toolchain in the dSYM bundle's property list.
  • -u, --update — updates an existing dSYM file to contain the latest accelerator tables and other DWARF optimizations. This option will rebuild the ‘.apple_names’ and ‘.apple_types’ hashed accelerator tables. glow-up update ✨
  • --use-reproducer <path> — uses the object files from the given reproducer path.
  • --verbose — displays verbose information when linking. she's telling you everything 🗣️
  • --verify — runs the DWARF verifier on the linked DWARF debug info. vibe check on the DWARF, basically 🔍
  • -v, --version — displays the version of the tool.
  • -y — treats the executable as a YAML debug-map rather than an executable. plot twist 🙈

🌈 EXIT STATUS 🌈

  • dsymutil returns 0 if the DWARF debug information was linked successfully.
  • Otherwise, it returns 1.

so basically: 0 = slay, 1 = something went sideways 😭

💜 SEE ALSO 💜

🌸 AUTHOR 🌸

Maintained by the LLVM Team (https://llvm.org/). they're the ones keeping this whole thing running, show some respect 🫶

2003-2023, LLVM Project

and that's the whole page!! mwah 💋 this was DSYMUTIL(1) out of the LLVM manual set, page version 13, dated 2023-07-14 — go link some DWARF and make me proud, bestie 🦋💖

📦 where this page comes from