LLVM-OPT-REPORT(1)

πŸŽ€ LLVM-OPT-REPORT(1) β€” optimization report generator, bestie πŸŽ€

✨ NAME ✨

llvm-opt-report β€” generate optimization report from YAML. Periodt. πŸ’…

🌈 SYNOPSIS 🌈

llvm-opt-report [options] [input]

πŸ’– DESCRIPTION πŸ’–

Okay so llvm-opt-report is literally the tool that generates an optimization report from YAML optimization record files. Bestie, listen: you need to create an input YAML optimization record file before running llvm-opt-report β€” no input YAML, no report. It provides information on the execution time, memory usage, and other details of each optimization pass. It’s giving β€œreceipts for your optimizer.” 😭

First you create that YAML optimization record file with clang:

$ clang -c foo.c -o foo.o -O3 -fsave-optimization-record

Then you create a report using the llvm-opt-report command with the YAML optimization record file foo.opt.yaml as input:

$ llvm-opt-report foo.opt.yaml -o foo.lst

foo.lst is the generated optimization report. Slay. ✨

And it looks like this, no cap:

< foo.c
 1          | void bar();
 2          | void foo() { bar(); }
 3          |
 4          | void Test(int *res, int *c, int *d, int *p, int n) {
 5          |   int i;
 6          |
 7          | #pragma clang loop vectorize(assume_safety)
 8     V4,1 |   for (i = 0; i < 1600; i++) {
 9          |     res[i] = (p[i] == 0) ? res[i] : res[i] + d[i];
10          |   }
11          |
12  U16     |   for (i = 0; i < 16; i++) {
13          |     res[i] = (p[i] == 0) ? res[i] : res[i] + d[i];
14          |   }
15          |
16 I        |   foo();
17          |
18          |   foo(); bar(); foo();
   I        |   ^
   I        |                 ^
19          | }
20          |

Symbols printed on the left side of the program indicate what kind of optimization was performed. The meanings of the symbols are as follows:

  • I β€” the function is inlined.
  • U β€” the loop is unrolled. The following number indicates the unroll factor.
  • V β€” the loop is vectorized. The following numbers indicate the vector length and the interleave factor.
Note: If a specific line of code is output twice, it means that the same optimization pass was applied to that line of code twice, and the pass was able to further optimize the code on the second iteration. Lowkey iconic behavior. πŸ‘‘

πŸ’… OPTIONS πŸ’…

If input is "-" or omitted, llvm-opt-report reads from standard input. Otherwise, it will read from the specified filename.

If the -o option is omitted, then llvm-opt-report will send its output to standard output. If the -o option specifies "-", then the output will also be sent to standard output. Streaming queen. πŸ¦‹

  • --help β€” display available options.
  • --version β€” display the version of this program.
  • --format=<string> β€” the format of the optimization record file. The argument is one of the following:
    • yaml
    • yaml-strtab
    • bitstream
  • --no-demangle β€” do not demangle function names.
  • -o=<string> β€” output file.
  • -r=<string> β€” root for relative input paths.
  • -s β€” do not include vectorization factors, etc.

πŸ”₯ EXIT STATUS πŸ”₯

llvm-opt-report returns 0 on success. Otherwise, an error message is printed to standard error, and the tool returns 1. Simple, clean, no plot twists. πŸ“

πŸ‘‘ Author πŸ‘‘

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

2003-2026, LLVM Project β€” the legal lore. πŸ’œ


πŸ’– That’s the whole LLVM-OPT-REPORT(1) moment β€” version 15, dated 2026-09-09. Bye bestie! 🫢✨

πŸ“¦ where this page comes from