LLVM-REMARKUTIL(1)

Hey bestie 💖 welcome to LLVM-REMARKUTIL(1) — the page for llvm-remarkutil, aka the remark utility. No cap, this is the little tool that shows you information from remark formats and converts between them. Let’s go! 🫶

💖 NAME 💖

• llvm-remarkutil — Remark utility.

✨ SYNOPSIS ✨

llvm-remarkutil [subcommmand] [options]

Yes, that’s subcommmand with three m’s in the original — we’re keeping it exactly, bestie 💅

🌸 DESCRIPTION 🌸

Utility for displaying information from, and converting between different remark formats. It’s giving “remark Swiss Army knife” energy — that’s the whole vibe. ✨

🦋 SUBCOMMANDS 🦋

• bitstream2yaml — Reserialize bitstream remarks to YAML.
• yaml2bitstream — Reserialize YAML remarks to bitstream.
• instruction-count — Output function instruction counts.
• annotation-count — Output remark type count from annotation remarks.

💅 bitstream2yaml

🛠️ USAGE

USAGE: llvm-remarkutil bitstream2yaml <input file> -o <output file>

📝 Summary

Bestie, this one takes a bitstream remark file as input, and reserializes that file as YAML. Bitstream in, YAML out — slay. 🎀

🌈 yaml2bitstream

🛠️ USAGE

USAGE: llvm-remarkutil yaml2bitstream <input file> -o <output file>

📝 Summary

This one takes a YAML remark file as input, and reserializes that file in the bitstream format. YAML in, bitstream out — reverse icon behavior. 🦋

🔥 instruction-count

🛠️ USAGE

USAGE: llvm-remarkutil instruction-count <input file>
--parser=<bitstream|yaml> [--use-debug-loc] -o <output file>

📝 Summary

Outputs instruction count remarks for every function. Instruction count remarks encode the number of instructions in a function at assembly printing time. Main character stats, but for functions. ✨

⚠️ Important: Instruction count remarks require asm-printer remarks.

CSV format is as follows:

::     Function,InstructionCount foo,123

if --use-debug-loc is passed then the CSV will include the source path, line number and column.

::     Source,Function,InstructionCount path:line:column,foo,3

💀 annotation-count

🛠️ USAGE

USAGE: llvm-remarkutil annotation-count <input file>
--parser=<bitstream|yaml> --annotation-type=<type>  [--use-debug-loc] -o
<output file>

📝 Summary

Outputs a count for annotation-type <type> remark for every function. The count expresses the number of remark checks inserted at the function. Literally counting the annotation-type <type> checks per function. 🎀

⚠️ Important: Annotation count remarks require AnnotationRemarksPass remarks.

CSV format is as follows:

::     Function,Count foo,123

if --use-debug-loc is passed then the CSV will include the source path, line number and column.

::     Source,Function,Count path:line:column,foo,3

👑 AUTHOR 👑

Maintained by the LLVM Team (https://llvm.org/). Shoutout to the LLVM Team, fr fr. 💚

📜 COPYRIGHT 📜

2003-2023, LLVM Project. Respect the copyright, bestie. 🫶

Okay that’s the whole page! 🎀 This one is LLVM 17, dated 2023-12-01, and the manual page is LLVM-REMARKUTIL(1). Bye bestie! 💅✨