docs/HowToSubmitABug.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   2                       "http://www.w3.org/TR/html4/strict.dtd">
   3 <html>
   4 <head>
   5   <title>How to submit an LLVM bug report</title>
   6   <link rel="stylesheet" href="llvm.css" type="text/css">
   7 </head>
   8 <body>
   9
  10 <div class="doc_title">
  11   How to submit an LLVM bug report
  12 </div>
  13
  14 <table border="0" width="100%">
  15 <tr>
  16 <td valign="top">
  17
  18 <ol>
  19   <li><a href="#introduction">Introduction - Got bugs?</a></li>
  20   <li><a href="#crashers">Crashing Bugs</a>
  21     <ul>
  22     <li><a href="#front-end">Front-end bugs</a>
  23     <li><a href="#gccas">GCCAS bugs</a>
  24     <li><a href="#gccld">GCCLD bugs</a>
  25     <li><a href="#passes">Bugs in LLVM passes</a>
  26     </ul></li>
  27   <li><a href="#miscompilations">Miscompilations</a></li>
  28   <li><a href="#codegen">Incorrect code generation (JIT and LLC)</a></li>
  29
  30 </ol>
  31
  32 <div class="doc_text">
  33   <p><b>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a> and
  34                    <a href="http://misha.brukman.net">Misha Brukman</a></b></p>
  35 </div>
  36
  37 </td>
  38 <td align="right">
  39   <img src="Debugging.gif" alt="Debugging" width="444" height="314">
  40 </td>
  41 </tr>
  42 </table>
  43
  44 <!-- *********************************************************************** -->
  45 <div class="doc_section">
  46   <a name="introduction">Introduction - Got bugs?</a>
  47 </div>
  48 <!-- *********************************************************************** -->
  49
  50 <div class="doc_text">
  51
  52 <p>If you're working with LLVM and run into a bug, we definitely want to know
  53 about it.  This document describes what you can do to increase the odds of
  54 getting it fixed quickly.</p>
  55
  56 <p>Basically you have to do two things at a minimum.  First, decide whether the
  57 bug <a href="#crashers">crashes the compiler</a> (or an LLVM pass), or if the
  58 compiler is <a href="#miscompilations">miscompiling</a> the program.  Based on
  59 what type of bug it is, follow the instructions in the linked section to narrow
  60 down the bug so that the person who fixes it will be able to find the problem
  61 more easily.</p>
  62
  63 <p>Once you have a reduced test-case, go to <a
  64 href="http://llvm.cs.uiuc.edu/bugs/enter_bug.cgi">the LLVM Bug Tracking
  65 System</a>, select the category in which the bug falls, and fill out the form
  66 with the necessary details.  The bug description should contain the following
  67 information:</p>
  68
  69 <ul>
  70   <li>All information necessary to reproduce the problem.</li>
  71   <li>The reduced test-case that triggers the bug.</li>
  72   <li>The location where you obtained LLVM (if not from our CVS
  73   repository).</li>
  74 </ul>
  75
  76 <p>Thanks for helping us make LLVM better!</p>
  77
  78 </div>
  79
  80 <!-- *********************************************************************** -->
  81 <div class="doc_section">
  82   <a name="crashers">Crashing Bugs</a>
  83 </div>
  84 <!-- *********************************************************************** -->
  85
  86 <div class="doc_text">
  87
  88 <p>More often than not, bugs in the compiler cause it to crash - often due to an
  89 assertion failure of some sort.  If you are running <tt><b>opt</b></tt> or
  90 <tt><b>analyze</b></tt> directly, and something crashes, jump to the section on
  91 <a href="#passes">bugs in LLVM passes</a>.  Otherwise, the most important
  92 piece of the puzzle is to figure out if it is the GCC-based front-end that is
  93 buggy or if it's one of the LLVM tools that has problems.</p>
  94
  95 <p>To figure out which program is crashing (the front-end,
  96 <tt><b>gccas</b></tt>, or <tt><b>gccld</b></tt>), run the
  97 <tt><b>llvm-gcc</b></tt> command line as you were when the crash occurred, but
  98 add a <tt>-v</tt> option to the command line.  The compiler will print out a
  99 bunch of stuff, and should end with telling you that one of
 100 <tt><b>cc1</b>/<b>cc1plus</b></tt>, <tt><b>gccas</b></tt>, or
 101 <tt><b>gccld</b></tt> crashed.</p>
 102
 103 <ul>
 104
 105   <li>If <tt><b>cc1</b></tt> or <tt><b>cc1plus</b></tt> crashed, you found a
 106   problem with the front-end.
 107   Jump ahead to the section on <a href="#front-end">front-end bugs</a>.</li>
 108
 109   <li>If <tt><b>gccas</b></tt> crashed, you found a bug in <a href="#gccas">one
 110   of the passes in <tt><b>gccas</b></tt></a>.</li>
 111
 112   <li>If <tt><b>gccld</b></tt> crashed, you found a bug in <a href="#gccld">one
 113   of the passes in <tt><b>gccld</b></tt></a>.</li>
 114
 115   <li>Otherwise, something really weird happened. Email the list with what you
 116   have at this point.</li>
 117
 118 </ul>
 119
 120 </div>
 121
 122 <!-- ======================================================================= -->
 123 <div class="doc_subsection">
 124   <a name="front-end">Front-end bugs</a>
 125 </div>
 126
 127 <div class="doc_text">
 128
 129 <p>If the problem is in the front-end, you should re-run the same
 130 <tt>llvm-gcc</tt> command that resulted in the crash, but add the
 131 <tt>-save-temps</tt> option.  The compiler will crash again, but it will leave
 132 behind a <tt><i>foo</i>.i</tt> file (containing preprocessed C source code) and
 133 possibly <tt><i>foo</i>.s</tt> (containing LLVM assembly code), for each
 134 compiled <tt><i>foo</i>.c</tt> file. Send us the <tt><i>foo</i>.i</tt> file,
 135 along with a brief description of the error it caused.</p>
 136
 137 </div>
 138
 139 <!-- ======================================================================= -->
 140 <div class="doc_subsection">
 141   <a name="gccas">GCCAS bugs</a>
 142 </div>
 143
 144 <div class="doc_text">
 145
 146 <p>If you find that a bug crashes in the <tt><b>gccas</b></tt> stage of
 147 compilation, compile your test-case to a <tt>.s</tt> file with the
 148 <tt>-save-temps</tt> option to <tt><b>llvm-gcc</b></tt>. Then run:</p>
 149
 150 <pre>
 151   <b>gccas</b> -debug-pass=Arguments &lt; /dev/null -o - &gt; /dev/null
 152 </pre>
 153
 154 <p>... which will print a list of arguments, indicating the list of passes that
 155 <tt><b>gccas</b></tt> runs.  Once you have the input file and the list of
 156 passes, go to the section on <a href="#passes">debugging bugs in LLVM
 157 passes</a>.</p>
 158
 159 </div>
 160
 161 <!-- ======================================================================= -->
 162 <div class="doc_subsection">
 163   <a name="gccld">GCCLD bugs</a>
 164 </div>
 165
 166 <div class="doc_text">
 167
 168 <p>If you find that a bug crashes in the <tt><b>gccld</b></tt> stage of
 169 compilation, gather all of the <tt>.o</tt> bytecode files and libraries that are
 170 being linked together (the "<tt><b>llvm-gcc</b> -v</tt>" output should include
 171 the full list of objects linked).  Then run:</p>
 172
 173 <pre>
 174   <b>llvm-as</b> &lt; /dev/null &gt; null.bc
 175   <b>gccld</b> -debug-pass=Arguments null.bc
 176 </pre><p>
 177
 178 <p>... which will print a list of arguments, indicating the list of passes that
 179 <tt><b>gccld</b></tt> runs.  Once you have the input files and the list of
 180 passes, go to the section on <a href="#passes">debugging bugs in LLVM
 181 passes</a>.</p>
 182
 183 </div>
 184
 185 <!-- ======================================================================= -->
 186 <div class="doc_subsection">
 187   <a name="passes">Bugs in LLVM passes</a>
 188 </div>
 189
 190 <div class="doc_text">
 191
 192 <p>At this point, you should have some number of LLVM assembly files or bytecode
 193 files and a list of passes which crash when run on the specified input.  In
 194 order to reduce the list of passes (which is probably large) and the input to
 195 something tractable, use the <tt><b>bugpoint</b></tt> tool as follows:</p>
 196
 197 <pre>
 198   <b>bugpoint</b> &lt;input files&gt; &lt;list of passes&gt;
 199 </pre><p>
 200
 201 <p><tt><b>bugpoint</b></tt> will print a bunch of output as it reduces the
 202 test-case, but it should eventually print something like this:</p>
 203
 204 <pre>
 205   ...
 206   Emitted bytecode to 'bugpoint-reduced-simplified.bc'
 207
 208   *** You can reproduce the problem with: opt bugpoint-reduced-simplified.bc -licm
 209 </pre>
 210
 211 <p>Once you complete this, please send the LLVM bytecode file and the command
 212 line to reproduce the problem to the llvmbugs mailing list.</p>
 213
 214 </div>
 215
 216 <!-- *********************************************************************** -->
 217 <div class="doc_section">
 218   <a name="miscompilations">Miscompilations</a>
 219 </div>
 220 <!-- *********************************************************************** -->
 221
 222 <div class="doc_text">
 223
 224 <p>A miscompilation occurs when a pass does not correctly transform a program,
 225 thus producing errors that are only noticed during execution. This is different
 226 from producing invalid LLVM code (i.e., code not in SSA form, using values
 227 before defining them, etc.) which the verifier will check for after a pass
 228 finishes its run.</p>
 229
 230 <p>To debug a miscompilation, you should choose which program you wish to run
 231 the output through, e.g. C backend, the JIT, or LLC, and a selection of passes,
 232 one of which may be causing the error, and run, for example:</p>
 233
 234 <pre>
 235   <b>bugpoint</b> -run-cbe [... optimization passes ...] file-to-test.bc
 236 </pre>
 237
 238 <p><tt>bugpoint</tt> will try to narrow down your list of passes to the one pass
 239 that causes an error, and simplify the bytecode file as much as it can to assist
 240 you. It will print a message letting you know how to reproduce the resulting
 241 error.</p>
 242
 243 </div>
 244
 245 <!-- *********************************************************************** -->
 246 <div class="doc_section">
 247   <a name="codegen">Incorrect code generation</a>
 248 </div>
 249 <!-- *********************************************************************** -->
 250
 251 <div class="doc_text">
 252
 253 <p>Similarly to debugging incorrect compilation by mis-behaving passes, you can
 254 debug incorrect code generation by either LLC or the JIT, using
 255 <tt>bugpoint</tt>. The process <tt>bugpoint</tt> follows in this case is to try
 256 to narrow the code down to a function that is miscompiled by one or the other
 257 method, but since for correctness, the entire program must be run,
 258 <tt>bugpoint</tt> will compile the code it deems to not be affected with the C
 259 Backend, and then link in the shared object it generates.</p>
 260
 261 <p>To debug the JIT:</p>
 262
 263 <pre>
 264   <b>bugpoint</b> -run-jit -output=[correct output file] [bytecodefile]
 265 </pre>
 266
 267 <p>Similarly, to debug the LLC, one would run:</p>
 268
 269 <pre>
 270   <b>bugpoint</b> -run-llc -output=[correct output file] [bytecodefile]
 271 </pre>
 272
 273 <p>At the end of a successful <tt>bugpoint</tt> run, you will be presented
 274 with two bytecode files: a <em>safe</em> file which can be compiled with the C
 275 backend and the <em>test</em> file which either LLC or the JIT
 276 mis-codegenerates, and thus causes the error.</p>
 277
 278 <p>To reproduce the error that <tt>bugpoint</tt> found, it is sufficient to do
 279 the following:</p>
 280
 281 <ol>
 282
 283   <li>Regenerate the shared object from the safe bytecode file:<br>
 284
 285 <pre>
 286   <b>llc</b> -march=c safe.bc -o safe.c<br>
 287   <b>gcc</b> -shared safe.c -o safe.so
 288 </pre></li>
 289
 290   <li>If debugging LLC, compile test bytecode native and link with the shared object:<br>
 291
 292 <pre>
 293   <b>llc</b> test.bc -o test.s -f<br>
 294   gcc test.s safe.so -o test.llc<br>
 295   ./test.llc [program options]
 296 </pre></li>
 297
 298   <li>If debugging the JIT, load the shared object and supply the test
 299 bytecode:
 300
 301 <pre>
 302   <b>lli</b> -load=safe.so test.bc [program options]
 303 </pre></li>
 304
 305 </ol>
 306
 307 </div>
 308
 309 <!-- *********************************************************************** -->
 310 <hr>
 311 <address>
 312   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 313   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 314   <a href="http://validator.w3.org/check/referer"><img
 315   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
 316
 317   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
 318   <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
 319   <br>
 320   Last modified: $Date$
 321 </address>
 322
 323 </body>
 324 </html>