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<--append-exit-code>=I<{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 =item B<--args> I<program args>
39 Pass all arguments specified after -args to the test program whenever it runs.
40 Note that if any of the I<program args> start with a '-', you should use:
42 bugpoint [bugpoint args] --args -- [program args]
44 The "--" right after the B<--args> option tells B<bugpoint> to consider any
45 options starting with C<-> to be part of the B<--args> option, not as options to
48 =item B<--tool-args> I<tool args>
50 Pass all arguments specified after --tool-args to the LLVM tool under test
51 (B<llc>, B<lli>, etc.) whenever it runs. You should use this option in the
54 bugpoint [bugpoint args] --tool-args -- [tool args]
56 The "--" right after the B<--tool-args> option tells B<bugpoint> to consider any
57 options starting with C<-> to be part of the B<--tool-args> option, not as
58 options to B<bugpoint> itself. (See B<--args>, above.)
60 =item B<--safe-tool-args> I<tool args>
62 Pass all arguments specified after --safe-tool-args to the "safe" execution
65 =item B<--disable-{dce,simplifycfg}>
67 Do not run the specified passes to clean up and reduce the size of the test
68 program. By default, B<bugpoint> uses these passes internally when attempting to
69 reduce test programs. If you're trying to find a bug in one of these passes,
70 B<bugpoint> may crash.
72 =item B<--enable-valgrind>
74 Use valgrind to find faults in the optimization phase. This will allow
75 bugpoint to find otherwise asymptomatic problems caused by memory
80 Continually randomize the specified passes and run them on the test program
81 until a bug is found or the user kills B<bugpoint>.
85 Print a summary of command line options.
87 =item B<--input> F<filename>
89 Open F<filename> and redirect the standard input of the test program, whenever
90 it runs, to come from that file.
92 =item B<--load> F<plugin>
94 Load the dynamic object F<plugin> into B<bugpoint> itself. This object should
95 register new optimization passes. Once loaded, the object will add new command
96 line options to enable various optimizations. To see the new complete list of
97 optimizations, use the B<--help> and B<--load> options together; for example:
99 bugpoint --load myNewPass.so --help
101 =item B<--mlimit> F<megabytes>
103 Specifies an upper limit on memory usage of the optimization and codegen. Set
104 to zero to disable the limit.
106 =item B<--output> F<filename>
108 Whenever the test program produces output on its standard output stream, it
109 should match the contents of F<filename> (the "reference output"). If you
110 do not use this option, B<bugpoint> will attempt to generate a reference output
111 by compiling the program with the "safe" backend and running it.
113 =item B<--profile-info-file> F<filename>
115 Profile file loaded by B<--profile-loader>.
117 =item B<--run-{int,jit,llc,cbe,custom}>
119 Whenever the test program is compiled, B<bugpoint> should generate code for it
120 using the specified code generator. These options allow you to choose the
121 interpreter, the JIT compiler, the static native code compiler, the C
122 backend, or a custom command (see B<--exec-command>) respectively.
124 =item B<--safe-{llc,cbe,custom}>
126 When debugging a code generator, B<bugpoint> should use the specified code
127 generator as the "safe" code generator. This is a known-good code generator
128 used to generate the "reference output" if it has not been provided, and to
129 compile portions of the program that as they are excluded from the testcase.
130 These options allow you to choose the
131 static native code compiler, the C backend, or a custom command,
132 (see B<--exec-command>) respectively. The interpreter and the JIT backends
133 cannot currently be used as the "safe" backends.
135 =item B<--exec-command> I<command>
137 This option defines the command to use with the B<--run-custom> and
138 B<--safe-custom> options to execute the bitcode testcase. This can
139 be useful for cross-compilation.
141 =item B<--safe-path> I<path>
143 This option defines the path to the command to execute with the
144 B<--safe-{int,jit,llc,cbe,custom}>
151 If B<bugpoint> succeeds in finding a problem, it will exit with 0. Otherwise,
152 if an error occurs, it will exit with a non-zero value.
160 Maintained by the LLVM Team (L<http://llvm.org>).