LLVM-STRIP(1)

πŸŽ€ LLVM-STRIP: the manual (LLVM's own, bestie edition) πŸŽ€

okay so this is the llvm-strip(1) page from the LLVM manual set, and I'm gonna walk you through it like we're texting at 2am. it's giving "underrated utility, main character energy" fr fr.


✨ NAME ✨

llvm-strip β€” object stripping tool. that's the whole vibe. it strips stuff. out of objects. slay.


🌸 SYNOPSIS 🌸

llvm-strip [options] inputs...

πŸ’– DESCRIPTION πŸ’–

so llvm-strip is a tool that strips sections and symbols from object files. that's its whole thing, and it does it well πŸ’…

lowkey important: if you don't specify any other stripping or remove options, then --strip-all gets enabled automatically. it's the default. it just happens.

by default, the input files are modified in-place 🫢. and if you pass "-" as the input file, it reads the input from the program's standard input stream instead. cute.

if the input is an archive, any requested operations get applied to each archive member individually. every single one. no member left behind πŸŽ€

and ngl, the tool is still in active development, but like β€” in most scenarios it works as a drop-in replacement for GNU's strip. iconic behavior honestly.


πŸ¦‹ GENERIC AND CROSS-PLATFORM OPTIONS πŸ¦‹

these ones are either agnostic of the file format, or they apply to multiple file formats. equal opportunity options ✨

  • --disable-deterministic-archives, -U β€” use real values for UIDs, GIDs and timestamps when updating archive member headers. no fakey zeros, the actual real ones.
  • --discard-all, -x β€” remove most local symbols from the output. different file formats may limit this to a subset of the local symbols β€” for example, file and section symbols in ELF objects will not be discarded. additionally, it removes all debug sections.
  • --enable-deterministic-archives, -D β€” enable deterministic mode when stripping archives, i.e. use 0 for archive member header UIDs, GIDs and timestamp fields. this one's on by default πŸ“
  • --help, -h β€” print a summary of command line options. when you're lost, this is your bestie.
  • --no-strip-all β€” disable --strip-all. yeah. that's it. it un-defaults the default.
  • -o <file> β€” write output to <file>. heads up: multiple input files cannot be used in combination with -o. it's one or the other, babe πŸ’€
  • --only-keep-debug β€” produce a debug file as the output that only preserves contents of sections useful for debugging purposes.

for ELF objects, this removes the contents of SHF_ALLOC sections that are not SHT_NOTE by making them SHT_NOBITS and shrinking the program headers where possible. fancy but precise.

  • --regex β€” if specified, symbol and section names specified by other switches are treated as extended POSIX regular expression patterns. regex girlies rise 🌈
  • --remove-section <section>, -R β€” remove the specified section from the output. can be specified multiple times to remove multiple sections simultaneously.
  • --strip-all-gnu β€” remove all symbols, debug sections and relocations from the output. this option is equivalent to GNU strip's --strip-all switch. same energy, different name.
  • --strip-all, -s β€” for ELF objects, remove from the output all symbols and non-alloc sections not within segments, except for .gnu.warning, .ARM.attribute sections and the section name table.

for COFF objects, remove all symbols, debug sections, and relocations from the output.

  • --strip-debug, -d, -g, -S β€” remove all debug sections from the output. four whole spellings, one job 🫢
  • --strip-symbol <symbol>, -N β€” remove all symbols named <symbol> from the output. can be specified multiple times to remove multiple symbols.
  • --strip-unneeded β€” remove from the output all local or undefined symbols that are not required by relocations. also removes all debug sections.
  • --version, -V β€” display the version of the llvm-strip executable. πŸ’œ
  • --wildcard, -w β€” allow wildcard syntax for symbol-related flags. on by default for section-related flags. incompatible with --regex ⚠️ pick a lane.

wildcard syntax allows the following special symbols:

  • * β€” any number of characters β€” equivalent to .*
  • ? β€” any single character β€” equivalent to .
  • \ β€” escape the next character β€” equivalent to \
  • [a-z] β€” character class β€” equivalent to [a-z]
  • [!a-z], [^a-z] β€” negated character class β€” equivalent to [^a-z]

additionally, starting a wildcard with '!' will prevent a match, even if another flag matches. for example -w -N '*' -N '!x' will strip all symbols except for x. not me protecting x with my life 😭

the order of wildcards does not matter. for example -w -N '*' -N '!x' is the same as -w -N '!x' -N '*'. no cap, order is irrelevant here.

  • @<FILE> β€” read command-line options and commands from response file <FILE>. like a little note passed in class πŸ“

🧚 ELF-SPECIFIC OPTIONS 🧚

these ones are implemented only for ELF objects. if you use them with other objects, llvm-strip will either emit an error or silently ignore them. (yes, silently. rude but real πŸ™ˆ)

  • --allow-broken-links β€” allow llvm-strip to remove sections even if it would leave invalid section references. any invalid sh_link fields will be set to zero. chaotic but consensual πŸ’€
  • --discard-locals, -X β€” remove local symbols starting with ".L" from the output.
  • --keep-file-symbols β€” keep symbols of type STT_FILE, even if they would otherwise be stripped. protection squad 🫢
  • --keep-section <section> β€” when removing sections from the output, do not remove sections named <section>. can be specified multiple times to keep multiple sections.
  • --keep-symbol <symbol>, -K β€” when removing symbols from the output, do not remove symbols named <symbol>. can be specified multiple times to keep multiple symbols.
  • --preserve-dates, -p β€” preserve access and modification timestamps in the output. time is a construct but we respect it ⭐
  • --strip-sections β€” remove from the output all section headers and all section data not within segments. note that many tools will not be able to use an object without section headers ⚠️ like, seriously, be careful.
  • -T β€” remove Swift symbols. that's it. one letter, big job πŸ¦‹

πŸ‘‘ EXIT STATUS πŸ‘‘

llvm-strip exits with a non-zero exit code if there is an error. otherwise, it exits with code 0. clean and simple, the way we like it ✨


πŸ’€ BUGS πŸ’€

to report bugs, please visit:

https://github.com/llvm/llvm-project/labels/tools:llvm-objcopy%2Fstrip

🌈 SEE ALSO 🌈

llvm-objcopy(1) β€” go read that one next bestie, it's the sibling 🫢


🌸 AUTHOR 🌸

maintained by the LLVM Team (https://llvm.org/). shoutout to the whole team honestly πŸ‘‘


2003-2023, LLVM Project


and that's the page!! this one's from the LLVM manual, volume 17, dated 2023-12-01 β€” so if you're citing it in your essay, that's the version, periodt πŸ’…βœ¨

πŸ“¦ where this page comes from