[RISCV] Regenerate autogen test to remove spurious diff
[llvm-project.git] / llvm / docs / CommandGuide / bugpoint.rst
blob971807e7e983fb3e905777284f7da20156ee6625
1 bugpoint - automatic test case reduction tool
2 =============================================
4 .. program:: bugpoint
6 SYNOPSIS
7 --------
9 **bugpoint** [*options*] [*input LLVM ll/bc files*] [*LLVM passes*] **--args**
10 *program arguments*
12 DESCRIPTION
13 -----------
15 **bugpoint** narrows down the source of problems in LLVM tools and passes.  It
16 can be used to debug three types of failures: optimizer crashes, miscompilations
17 by optimizers, or bad native code generation (including problems in the static
18 and JIT compilers).  It aims to reduce large test cases to small, useful ones.
19 For more information on the design and inner workings of **bugpoint**, as well as
20 advice for using bugpoint, see :doc:`/Bugpoint` in the LLVM
21 distribution.
23 OPTIONS
24 -------
26 **--additional-so** *library*
28  Load the dynamic shared object *library* into the test program whenever it is
29  run.  This is useful if you are debugging programs which depend on non-LLVM
30  libraries (such as the X or curses libraries) to run.
32 **--append-exit-code**\ =\ *{true,false}*
34  Append the test programs exit code to the output file so that a change in exit
35  code is considered a test failure. Defaults to false.
37 **--args** *program args*
39  Pass all arguments specified after **--args** to the test program whenever it runs.
40  Note that if any of the *program args* start with a "``-``", you should use:
42  .. code-block:: bash
44       bugpoint [bugpoint args] --args -- [program args]
46  The "``--``" right after the **--args** option tells **bugpoint** to consider
47  any options starting with "``-``" to be part of the **--args** option, not as
48  options to **bugpoint** itself.
50 **--tool-args** *tool args*
52  Pass all arguments specified after **--tool-args** to the LLVM tool under test
53  (**llc**, **lli**, etc.) whenever it runs.  You should use this option in the
54  following way:
56  .. code-block:: bash
58       bugpoint [bugpoint args] --tool-args -- [tool args]
60  The "``--``" right after the **--tool-args** option tells **bugpoint** to
61  consider any options starting with "``-``" to be part of the **--tool-args**
62  option, not as options to **bugpoint** itself. (See **--args**, above.)
64 **--safe-tool-args** *tool args*
66  Pass all arguments specified after **--safe-tool-args** to the "safe" execution
67  tool.
69 **--gcc-tool-args** *gcc tool args*
71  Pass all arguments specified after **--gcc-tool-args** to the invocation of
72  **gcc**.
74 **--opt-args** *opt args*
76  Pass all arguments specified after **--opt-args** to the invocation of **opt**.
78 **--disable-{dce,simplifycfg}**
80  Do not run the specified passes to clean up and reduce the size of the test
81  program. By default, **bugpoint** uses these passes internally when attempting to
82  reduce test programs.  If you're trying to find a bug in one of these passes,
83  **bugpoint** may crash.
85 **--enable-valgrind**
87  Use valgrind to find faults in the optimization phase. This will allow
88  bugpoint to find otherwise asymptomatic problems caused by memory
89  mis-management.
91 **-find-bugs**
93  Continually randomize the specified passes and run them on the test program
94  until a bug is found or the user kills **bugpoint**.
96 **-help**
98  Print a summary of command line options.
100 **--input** *filename*
102  Open *filename* and redirect the standard input of the test program, whenever
103  it runs, to come from that file.
105 **--load** *plugin*
107  Load the dynamic object *plugin* into **bugpoint** itself.  This object should
108  register new optimization passes.  Once loaded, the object will add new command
109  line options to enable various optimizations.  To see the new complete list of
110  optimizations, use the **-help** and **--load** options together; for example:
112  .. code-block:: bash
114       bugpoint --load myNewPass.so -help
116 **--mlimit** *megabytes*
118  Specifies an upper limit on memory usage of the optimization and codegen. Set
119  to zero to disable the limit.
121 **--output** *filename*
123  Whenever the test program produces output on its standard output stream, it
124  should match the contents of *filename* (the "reference output"). If you
125  do not use this option, **bugpoint** will attempt to generate a reference output
126  by compiling the program with the "safe" backend and running it.
128 **--run-{int,jit,llc,custom}**
130  Whenever the test program is compiled, **bugpoint** should generate code for it
131  using the specified code generator.  These options allow you to choose the
132  interpreter, the JIT compiler, the static native code compiler, or a
133  custom command (see **--exec-command**) respectively.
135 **--safe-{llc,custom}**
137  When debugging a code generator, **bugpoint** should use the specified code
138  generator as the "safe" code generator. This is a known-good code generator
139  used to generate the "reference output" if it has not been provided, and to
140  compile portions of the program that as they are excluded from the testcase.
141  These options allow you to choose the
142  static native code compiler, or a custom command, (see **--exec-command**)
143  respectively. The interpreter and the JIT backends cannot currently
144  be used as the "safe" backends.
146 **--exec-command** *command*
148  This option defines the command to use with the **--run-custom** and
149  **--safe-custom** options to execute the bitcode testcase. This can
150  be useful for cross-compilation.
152 **--compile-command** *command*
154  This option defines the command to use with the **--compile-custom**
155  option to compile the bitcode testcase. The command should exit with a
156  failure exit code if the file is "interesting" and should exit with a
157  success exit code (i.e. 0) otherwise (this is the same as if it crashed on
158  "interesting" inputs).
160  This can be useful for
161  testing compiler output without running any link or execute stages. To
162  generate a reduced unit test, you may add CHECK directives to the
163  testcase and pass the name of an executable compile-command script in this form:
165  .. code-block:: sh
167       #!/bin/sh
168       llc "$@"
169       not FileCheck [bugpoint input file].ll < bugpoint-test-program.s
171  This script will "fail" as long as FileCheck passes. So the result
172  will be the minimum bitcode that passes FileCheck.
174 **--safe-path** *path*
176  This option defines the path to the command to execute with the
177  **--safe-{int,jit,llc,custom}**
178  option.
180 **--verbose-errors**\ =\ *{true,false}*
182  The default behavior of bugpoint is to print "<crash>" when it finds a reduced
183  test that crashes compilation. This flag prints the output of the crashing
184  program to stderr. This is useful to make sure it is the same error being
185  tracked down and not a different error that happens to crash the compiler as
186  well. Defaults to false.
188 EXIT STATUS
189 -----------
191 If **bugpoint** succeeds in finding a problem, it will exit with 0.  Otherwise,
192 if an error occurs, it will exit with a non-zero value.
194 SEE ALSO
195 --------
197 :manpage:`opt(1)`