BUGPOINT(1)

🌸 NAME 🌸

okay so bestie, meet bugpoint(1) — the automatic test case reduction tool. It's giving "take your giant messy repro and make it smol" energy, and honestly? iconic. 💅

✨ SYNOPSIS ✨

bugpoint [options] [input LLVM ll/bc files] [LLVM passes] –args program arguments

💖 DESCRIPTION 💖

bugpoint narrows down the source of problems in LLVM tools and passes. no cap, it's a whole detective era 🕵️‍♀️

It can debug three types of failures:

• optimizer crashes
• miscompilations by optimizers
• bad native code generation (including problems in the static and JIT compilers)

It aims to reduce large test cases to small, useful ones. For more information on the design and inner workings of bugpoint, as well as advice for using bugpoint, see /Bugpoint in the LLVM distribution. iykyk, the lore is in the docs 📚

💅 OPTIONS 💅

slay, here's the full menu — every single flag, no skips, no cap. 🍓

• –additional-so library — load the dynamic shared object library into the test program whenever it is run. This is useful if you are debugging programs which depend on non-LLVM libraries (such as the X or curses libraries) to run. fr fr
• –append-exit-code={true,false} — append the test program's exit code to the output file so that a change in exit code is considered a test failure. Defaults to false.
• –args program args — pass all arguments specified after –args to the test program whenever it runs. Note that if any of the program args start with a “-”, you should use:

bugpoint [bugpoint args] --args -- [program args]

The “--” right after the –args option tells bugpoint to consider any options starting with “-” to be part of the –args option, not as options to bugpoint itself.

• –tool-args tool args — pass all arguments specified after –tool-args to the LLVM tool under test (llc, lli, etc.) whenever it runs. You should use this option in the following way:

bugpoint [bugpoint args] --tool-args -- [tool args]

The “--” right after the –tool-args option tells bugpoint to consider any options starting with “-” to be part of the –tool-args option, not as options to bugpoint itself. (See –args, above.)

• –safe-tool-args tool args — pass all arguments specified after –safe-tool-args to the “safe” execution tool.
• –gcc-tool-args gcc tool args — pass all arguments specified after –gcc-tool-args to the invocation of gcc.
• –opt-args opt args — pass all arguments specified after –opt-args to the invocation of opt.
• –disable-{dce,simplifycfg} — do not run the specified passes to clean up and reduce the size of the test program. By default, bugpoint uses these passes internally when attempting to reduce test programs. If you're trying to find a bug in one of these passes, bugpoint may crash. danger, bestie — proceed with caution 💀
• –enable-valgrind — use valgrind to find faults in the optimization phase. This will allow bugpoint to find otherwise asymptomatic problems caused by memory mis-management.
• -find-bugs — continually randomize the specified passes and run them on the test program until a bug is found or the user kills bugpoint. chaos mode activated 🙈
• -help — print a summary of command line options.
• –input filename — open filename and redirect the standard input of the test program, whenever it runs, to come from that file.
• –load plugin — load the dynamic object plugin into bugpoint itself. This object should register new optimization passes. Once loaded, the object will add new command line options to enable various optimizations. To see the new complete list of optimizations, use the -help and –load options together; for example:

bugpoint --load myNewPass.so -help

• –mlimit megabytes — specifies an upper limit on memory usage of the optimization and codegen. Set to zero to disable the limit.
• –output filename — whenever the test program produces output on its standard output stream, it should match the contents of filename (the “reference output”). If you do not use this option, bugpoint will attempt to generate a reference output by compiling the program with the “safe” backend and running it.
• –run-{int,jit,llc,custom} — whenever the test program is compiled, bugpoint should generate code for it using the specified code generator. These options allow you to choose the interpreter, the JIT compiler, the static native code compiler, or a custom command (see –exec-command) respectively.
• –safe-{llc,custom} — when debugging a code generator, bugpoint should use the specified code generator as the “safe” code generator. This is a known-good code generator used to generate the “reference output” if it has not been provided, and to compile portions of the program that as they are excluded from the testcase. These options allow you to choose the static native code compiler, or a custom command, (see –exec-command) respectively. The interpreter and the JIT backends cannot currently be used as the “safe” backends. important caveat, bestie
• –exec-command command — this option defines the command to use with the –run-custom and –safe-custom options to execute the bitcode testcase. This can be useful for cross-compilation.
• –compile-command command — this option defines the command to use with the –compile-custom option to compile the bitcode testcase. The command should exit with a failure exit code if the file is “interesting” and should exit with a success exit code (i.e. 0) otherwise (this is the same as if it crashed on “interesting” inputs).

This can be useful for testing compiler output without running any link or execute stages. To generate a reduced unit test, you may add CHECK directives to the testcase and pass the name of an executable compile-command script in this form:

#!/bin/sh
llc "$@"
not FileCheck [bugpoint input file].ll < bugpoint-test-program.s

This script will “fail” as long as FileCheck passes. So the result will be the minimum bitcode that passes FileCheck.

• –safe-path path — this option defines the path to the command to execute with the –safe-{int,jit,llc,custom} option.
• –verbose-errors={true,false} — the default behavior of bugpoint is to print “<crash>” when it finds a reduced test that crashes compilation. This flag prints the output of the crashing program to stderr. This is useful to make sure it is the same error being tracked down and not a different error that happens to crash the compiler as well. Defaults to false.

🚪 EXIT STATUS 🚪

If bugpoint succeeds in finding a problem, it will exit with 0. Otherwise, if an error occurs, it will exit with a non-zero value. simple as that ✨

👀 SEE ALSO 👀

• opt(1)

👑 AUTHOR 👑

Maintained by the LLVM Team (https://llvm.org/). royalty behavior 👑

🎀 COPYRIGHT 🎀

2003-2023, LLVM Project

---

mwah 😘 — this page is version 15, dated 2023-07-14, and it's the BUGPOINT(1) manual. bye bestie, go reduce some bugs 💖