docs/CommandGuide/bugpoint.pod

   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<--args> I<program args>
  33
  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:
  36
  37     bugpoint [bugpoint args] --args -- [program args]
  38
  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
  41 B<bugpoint> itself.
  42
  43 =item B<--tool-args> I<tool args>
  44
  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
  47 following way:
  48
  49     bugpoint [bugpoint args] --tool-args -- [tool args]
  50
  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.)
  54
  55 =item B<--check-exit-code>=I<{true,false}>
  56
  57 Assume a non-zero exit code or core dump from the test program is a failure.
  58 Defaults to true.
  59
  60 =item B<--disable-{dce,simplifycfg}>
  61
  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.
  66
  67 =item B<-find-bugs>
  68
  69 Continually randomize the specified passes and run them on the test program
  70 until a bug is found or the user kills B<bugpoint>.
  71
  72 =item B<--help>
  73
  74 Print a summary of command line options.
  75
  76 =item B<--input> F<filename>
  77
  78 Open F<filename> and redirect the standard input of the test program, whenever
  79 it runs, to come from that file.
  80
  81 =item B<--load> F<plugin>
  82
  83 Load the dynamic object F<plugin> into B<bugpoint> itself.  This object should
  84 register new optimization passes.  Once loaded, the object will add new command
  85 line options to enable various optimizations.  To see the new complete list of
  86 optimizations, use the B<--help> and B<--load> options together; for example:
  87
  88     bugpoint --load myNewPass.so --help
  89
  90 =item B<--output> F<filename>
  91
  92 Whenever the test program produces output on its standard output stream, it
  93 should match the contents of F<filename> (the "reference output"). If you
  94 do not use this option, B<bugpoint> will attempt to generate a reference output
  95 by compiling the program with the C backend and running it.
  96
  97 =item B<--profile-info-file> F<filename>
  98
  99 Profile file loaded by B<--profile-loader>.
 100
 101 =item B<--run-{int,jit,llc,cbe}>
 102
 103 Whenever the test program is compiled, B<bugpoint> should generate code for it
 104 using the specified code generator.  These options allow you to choose the
 105 interpreter, the JIT compiler, the static native code compiler, or the C
 106 backend, respectively.
 107
 108 =item B<--enable-valgrind>
 109
 110 Use valgrind to find faults in the optimization phase. This will allow
 111 bugpoint to find otherwise asymptomatic problems caused by memory
 112 mis-management.
 113
 114 =back
 115
 116 =head1 EXIT STATUS
 117
 118 If B<bugpoint> succeeds in finding a problem, it will exit with 0.  Otherwise,
 119 if an error occurs, it will exit with a non-zero value.
 120
 121 =head1 SEE ALSO
 122
 123 L<opt|opt>
 124
 125 =head1 AUTHOR
 126
 127 Maintained by the LLVM Team (L<http://llvm.org>).
 128
 129 =cut