1 =pod 2 3 =head1 NAME 4 5 bugpoint - automatic test case reduction tool 6 7 =head1 SYNOPSIS 8 9 B<bugpoint> [I<options>] [I<input LLVM ll/bc files>] [I<LLVM passes>] B<--args> 10 I<program arguments> 11 12 =head1 DESCRIPTION 13 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 20 distribution. 21 22 =head1 OPTIONS 23 24 =over 25 26 =item B<--additional-so> F<library> 27 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. 31 32 =item B<--append-exit-code>=I<{true,false}> 33 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. 36 37 =item B<--args> I<program args> 38 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: 41 42 bugpoint [bugpoint args] --args -- [program args] 43 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 46 B<bugpoint> itself. 47 48 =item B<--tool-args> I<tool args> 49 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 52 following way: 53 54 bugpoint [bugpoint args] --tool-args -- [tool args] 55 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.) 59 60 =item B<--safe-tool-args> I<tool args> 61 62 Pass all arguments specified after B<--safe-tool-args> to the "safe" execution 63 tool. 64 65 =item B<--gcc-tool-args> I<gcc tool args> 66 67 Pass all arguments specified after B<--gcc-tool-args> to the invocation of 68 B<gcc>. 69 70 =item B<--opt-args> I<opt args> 71 72 Pass all arguments specified after B<--opt-args> to the invocation of B<opt>. 73 74 =item B<--disable-{dce,simplifycfg}> 75 76 Do not run the specified passes to clean up and reduce the size of the test 77 program. By default, B<bugpoint> uses these passes internally when attempting to 78 reduce test programs. If you're trying to find a bug in one of these passes, 79 B<bugpoint> may crash. 80 81 =item B<--enable-valgrind> 82 83 Use valgrind to find faults in the optimization phase. This will allow 84 bugpoint to find otherwise asymptomatic problems caused by memory 85 mis-management. 86 87 =item B<-find-bugs> 88 89 Continually randomize the specified passes and run them on the test program 90 until a bug is found or the user kills B<bugpoint>. 91 92 =item B<-help> 93 94 Print a summary of command line options. 95 96 =item B<--input> F<filename> 97 98 Open F<filename> and redirect the standard input of the test program, whenever 99 it runs, to come from that file. 100 101 =item B<--load> F<plugin> 102 103 Load the dynamic object F<plugin> into B<bugpoint> itself. This object should 104 register new optimization passes. Once loaded, the object will add new command 105 line options to enable various optimizations. To see the new complete list of 106 optimizations, use the B<-help> and B<--load> options together; for example: 107 108 bugpoint --load myNewPass.so -help 109 110 =item B<--mlimit> F<megabytes> 111 112 Specifies an upper limit on memory usage of the optimization and codegen. Set 113 to zero to disable the limit. 114 115 =item B<--output> F<filename> 116 117 Whenever the test program produces output on its standard output stream, it 118 should match the contents of F<filename> (the "reference output"). If you 119 do not use this option, B<bugpoint> will attempt to generate a reference output 120 by compiling the program with the "safe" backend and running it. 121 122 =item B<--profile-info-file> F<filename> 123 124 Profile file loaded by B<--profile-loader>. 125 126 =item B<--run-{int,jit,llc,cbe,custom}> 127 128 Whenever the test program is compiled, B<bugpoint> should generate code for it 129 using the specified code generator. These options allow you to choose the 130 interpreter, the JIT compiler, the static native code compiler, the C 131 backend, or a custom command (see B<--exec-command>) respectively. 132 133 =item B<--safe-{llc,cbe,custom}> 134 135 When debugging a code generator, B<bugpoint> should use the specified code 136 generator as the "safe" code generator. This is a known-good code generator 137 used to generate the "reference output" if it has not been provided, and to 138 compile portions of the program that as they are excluded from the testcase. 139 These options allow you to choose the 140 static native code compiler, the C backend, or a custom command, 141 (see B<--exec-command>) respectively. The interpreter and the JIT backends 142 cannot currently be used as the "safe" backends. 143 144 =item B<--exec-command> I<command> 145 146 This option defines the command to use with the B<--run-custom> and 147 B<--safe-custom> options to execute the bitcode testcase. This can 148 be useful for cross-compilation. 149 150 =item B<--compile-command> I<command> 151 152 This option defines the command to use with the B<--compile-custom> 153 option to compile the bitcode testcase. This can be useful for 154 testing compiler output without running any link or execute stages. To 155 generate a reduced unit test, you may add CHECK directives to the 156 testcase and pass the name of an executable compile-command script in this form: 157 158 #!/bin/sh 159 llc "$@" 160 not FileCheck [bugpoint input file].ll < bugpoint-test-program.s 161 162 This script will "fail" as long as FileCheck passes. So the result 163 will be the minimum bitcode that passes FileCheck. 164 165 =item B<--safe-path> I<path> 166 167 This option defines the path to the command to execute with the 168 B<--safe-{int,jit,llc,cbe,custom}> 169 option. 170 171 =back 172 173 =head1 EXIT STATUS 174 175 If B<bugpoint> succeeds in finding a problem, it will exit with 0. Otherwise, 176 if an error occurs, it will exit with a non-zero value. 177 178 =head1 SEE ALSO 179 180 L<opt|opt> 181 182 =head1 AUTHOR 183 184 Maintained by the LLVM Team (L<http://llvm.org/>). 185 186 =cut 187
