5 bugpoint - automatic test case reduction tool
9 B<bugpoint> [I<options>] [I<input LLVM ll/bc files>] [I<LLVM passes>] B<--args>
14 B<bugpoint> narrows down the source of problems in LLVM tools and passes. It
15 can be used to debug three types of failures: optimizer crashes, miscompilations
16 by optimizers, or bad native code generation (including problems in the static
17 and JIT compilers). It aims to reduce large test cases to small, useful ones.
18 For more information on the design and inner workings of B<bugpoint>, as well as
19 advice for using bugpoint, see F<llvm/docs/Bugpoint.html> in the LLVM
26 =item B<--additional-so> F<library>
28 Load the dynamic shared object F<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 =item B<--args> I<program args>
34 Pass all arguments specified after -args to the test program whenever it runs.
35 Note that if any of the I<program args> start with a '-', you should use:
37 bugpoint [bugpoint args] --args -- [program args]
39 The "--" right after the B<--args> option tells B<bugpoint> to consider any
40 options starting with C<-> to be part of the B<--args> option, not as options to
43 =item B<--tool-args> I<tool args>
45 Pass all arguments specified after --tool-args to the LLVM tool under test
46 (B<llc>, B<lli>, etc.) whenever it runs. You should use this option in the
49 bugpoint [bugpoint args] --tool-args -- [tool args]
51 The "--" right after the B<--tool-args> option tells B<bugpoint> to consider any
52 options starting with C<-> to be part of the B<--tool-args> option, not as
53 options to B<bugpoint> itself. (See B<--args>, above.)
55 =item B<--check-exit-code>=I<{true,false}>
57 Assume a non-zero exit code or core dump from the test program is a failure.
60 =item B<--disable-{dce,simplifycfg}>
62 Do not run the specified passes to clean up and reduce the size of the test
63 program. By default, B<bugpoint> uses these passes internally when attempting to
64 reduce test programs. If you're trying to find a bug in one of these passes,
65 B<bugpoint> may crash.
67 =item B<--enable-valgrind>
69 Use valgrind to find faults in the optimization phase. This will allow
70 bugpoint to find otherwise asymptomatic problems caused by memory
75 Continually randomize the specified passes and run them on the test program
76 until a bug is found or the user kills B<bugpoint>.
80 Print a summary of command line options.
82 =item B<--input> F<filename>
84 Open F<filename> and redirect the standard input of the test program, whenever
85 it runs, to come from that file.
87 =item B<--load> F<plugin>
89 Load the dynamic object F<plugin> into B<bugpoint> itself. This object should
90 register new optimization passes. Once loaded, the object will add new command
91 line options to enable various optimizations. To see the new complete list of
92 optimizations, use the B<--help> and B<--load> options together; for example:
94 bugpoint --load myNewPass.so --help
96 =item B<--mlimit> F<megabytes>
98 Specifies an upper limit on memory usage of the optimization and codegen. Set
99 to zero to disable the limit.
101 =item B<--output> F<filename>
103 Whenever the test program produces output on its standard output stream, it
104 should match the contents of F<filename> (the "reference output"). If you
105 do not use this option, B<bugpoint> will attempt to generate a reference output
106 by compiling the program with the C backend and running it.
108 =item B<--profile-info-file> F<filename>
110 Profile file loaded by B<--profile-loader>.
112 =item B<--run-{int,jit,llc,cbe}>
114 Whenever the test program is compiled, B<bugpoint> should generate code for it
115 using the specified code generator. These options allow you to choose the
116 interpreter, the JIT compiler, the static native code compiler, or the C
117 backend, respectively.
123 If B<bugpoint> succeeds in finding a problem, it will exit with 0. Otherwise,
124 if an error occurs, it will exit with a non-zero value.
132 Maintained by the LLVM Team (L<http://llvm.org>).