DSYMUTIL(1)

📦
version 17.0.6 · 7 versions
, in opensuse-leap 16.0

✨ DSYMUTIL(1) — LLVM's debug-symbol bestie ✨

okay bestie, welcome to the DSYMUTIL(1) page from LLVM — yes, the one and only. This is the manual for dsymutil, and we're gonna walk through it like a group chat, no cap. 💅

💖 NAME 💖

dsymutil — manipulate archived DWARF debug symbol files. That's the whole name vibe: it's the tool that handles archived DWARF debug symbol files. 🦋

🦋 SYNOPSIS 🦋

dsymutil [options] executable

💖 DESCRIPTION 💖

okay so dsymutil links the DWARF debug information found in the object files for an executable by using the debug symbols information contained in its symbol table. By default, the linked debug information is placed in a .dSYM bundle with the same name as the executable. That's the main-character move. ✨

💅 OPTIONS 💅

  • --accelerator=<accelerator type> — pick the desired type of accelerator table, bestie. Valid options are Apple, Dwarf, Default, and None. ✨
  • --arch <arch> — link DWARF debug information only for the specified CPU architecture types. Architectures may be specified by name. When using this option, an error will be returned if any architectures can not be properly linked. This option can be specified multiple times, once for each desired architecture. All CPU architectures will be linked by default, and any architectures that can't be properly linked will cause dsymutil to return an error. That's a lot of arch drama, but it's all true. 💀
  • --dump-debug-map — dump the executable's debug-map (the list of the object files containing the debug information) in YAML format and exit. No DWARF link will take place. So it's just a peek, not a whole makeover. iykyk. 🦋
  • --fat64 — use a 64-bit header when emitting universal binaries. Big header energy. ✨
  • --flat, -f — produce a flat dSYM file. A .dwarf extension will be appended to the executable name unless the output file is specified using the -o option. Flat and cute. 🎀
  • --gen-reproducer — generate a reproducer consisting of the input object files. Alias for --reproducer=GenerateOnExit. iykyk. 💅
  • --help, -h — print this help output. The classic. 🫶
  • --keep-function-for-static — make a static variable keep the enclosing function even if it would have been omitted otherwise. Protective function energy, honestly. 💖
  • --minimize, -z — when used while creating a dSYM file, this option will suppress 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 --update option, this option will cause redundant accelerator tables to be removed. Minimalist queen. 💅
  • --no-odr — do not use ODR (One Definition Rule) for uniquing C++ types. No ODR, just vibes. 😭
  • --no-output — do the link in memory, but do not emit the result file. All the work, none of the file. not me crying. 😭
  • --no-swiftmodule-timestamp — don't check the timestamp for swiftmodule files. Timestamp? Not today. 🙈
  • --num-threads <threads>, -j <threads> — specifies the maximum number (n) of simultaneous threads to use when linking multiple architectures. Thread count go brrr. 🔥
  • --object-prefix-map <prefix=remapped> — remap 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; to help dsymutil find the Clang module cache. Path remapping slay. ✨
  • --oso-prepend-path <path> — specifies a path to prepend to all debug symbol object file paths. Prepend that path, bestie. ✨
  • --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. Output location flex. 💖
  • --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 with a paper trail, iconic. 🎀
  • --remarks-drop-without-debug — drop remarks without valid debug locations. Without this flag, all remarks are kept. Good to know. ⭐
  • --remarks-output-format <format> — specify the format to be used when serializing the linked remarks. Format picker moment. ✨
  • --remarks-prepend-path <path> — specify a directory to prepend the paths of the external remark files. Prepend path, but for remarks. 🫶
  • --reproducer <mode> — specify the reproducer generation mode. Valid options are GenerateOnExit, GenerateOnCrash, Use, and Off. Mode select, but make it debug. 💅
  • --statistics — print 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. Stats table realness. ✨
  • --symbol-map <bcsymbolmap> — update the existing dSYMs inplace using the symbol map specified. Symbol map update, inplace. ✨
  • -s, --symtab — dumps the symbol table found in executable or object file(s) and exits. Symtab peek and dip. 👑 (okay that emoji is extra but deserved.)
  • -S — output textual assembly instead of a binary dSYM companion file. Assembly text, not binary. ✨
  • --toolchain <toolchain> — embed the toolchain in the dSYM bundle's property list. Toolchain info, literally embedded. 🎀
  • -u, --update — update 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 an old dSYM. 💅
  • --use-reproducer <path> — use the object files from the given reproducer path. Alias for --reproducer=Use. Reproducer path activated. ✨
  • --verbose — display verbose information when linking. Tell me everything, bestie. ✨
  • --verify — run the DWARF verifier on the linked DWARF debug info. Verification vibe check, ngl. ⭐
  • -v, --version — display the version of the tool. Version check. 🫶
  • -y — treat executable as a YAML debug-map rather than an executable. YAML mode, not executable mode. iykyk. 🦋

🌈 EXIT STATUS 🌈

dsymutil returns 0 if the DWARF debug information was linked successfully. Otherwise, it returns 1. That's the whole vibe check: 0 = slay, 1 = not slay, periodt. 💖

🎀 SEE ALSO 🎀

👑 AUTHOR 👑

Maintained by the LLVM Team (https://llvm.org/). Crown them, fr fr. 👑

2003-2023, LLVM Project. The legal bestie has spoken. 🍓

okay that's the whole DSYMUTIL(1) page, bestie — brought to you by LLVM, version 17, dated 2023-12-01. Go link some DWARF and slay. 💅✨

📦 where this page comes from