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   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   6   <title>How to submit an LLVM bug report</title>
   7   <link rel="stylesheet" href="_static/llvm.css" type="text/css">
   8 </head>
   9 <body>
  10
  11 <h1>
  12   How to submit an LLVM bug report
  13 </h1>
  14
  15 <table class="layout" style="width: 90%" >
  16 <tr class="layout">
  17   <td class="left">
  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="#ct_optimizer">Compile-time optimization bugs</a>
  24     <li><a href="#ct_codegen">Code generator bugs</a>
  25     </ul></li>
  26   <li><a href="#miscompilations">Miscompilations</a></li>
  27   <li><a href="#codegen">Incorrect code generation (JIT and LLC)</a></li>
  28 </ol>
  29 <div class="doc_author">
  30   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a> and
  31                 <a href="http://misha.brukman.net">Misha Brukman</a></p>
  32 </div>
  33 </td>
  34 </tr>
  35 </table>
  36
  37 <!-- *********************************************************************** -->
  38 <h2>
  39   <a name="introduction">Introduction - Got bugs?</a>
  40 </h2>
  41 <!-- *********************************************************************** -->
  42
  43 <div>
  44
  45 <p>If you're working with LLVM and run into a bug, we definitely want to know
  46 about it.  This document describes what you can do to increase the odds of
  47 getting it fixed quickly.</p>
  48
  49 <p>Basically you have to do two things at a minimum.  First, decide whether the
  50 bug <a href="#crashers">crashes the compiler</a> (or an LLVM pass), or if the
  51 compiler is <a href="#miscompilations">miscompiling</a> the program (i.e., the
  52 compiler successfully produces an executable, but it doesn't run right).  Based
  53 on
  54 what type of bug it is, follow the instructions in the linked section to narrow
  55 down the bug so that the person who fixes it will be able to find the problem
  56 more easily.</p>
  57
  58 <p>Once you have a reduced test-case, go to <a
  59 href="http://llvm.org/bugs/enter_bug.cgi">the LLVM Bug Tracking
  60 System</a> and fill out the form with the necessary details (note that you don't
  61 need to pick a category, just use the "new-bugs" category if you're not sure).
  62 The bug description should contain the following
  63 information:</p>
  64
  65 <ul>
  66   <li>All information necessary to reproduce the problem.</li>
  67   <li>The reduced test-case that triggers the bug.</li>
  68   <li>The location where you obtained LLVM (if not from our Subversion
  69   repository).</li>
  70 </ul>
  71
  72 <p>Thanks for helping us make LLVM better!</p>
  73
  74 </div>
  75
  76 <!-- *********************************************************************** -->
  77 <h2>
  78   <a name="crashers">Crashing Bugs</a>
  79 </h2>
  80 <!-- *********************************************************************** -->
  81
  82 <div>
  83
  84 <p>More often than not, bugs in the compiler cause it to crash&mdash;often due
  85 to an assertion failure of some sort. The most important
  86 piece of the puzzle is to figure out if it is crashing in the GCC front-end
  87 or if it is one of the LLVM libraries (e.g. the optimizer or code generator)
  88 that has problems.</p>
  89
  90 <p>To figure out which component is crashing (the front-end,
  91 optimizer or code generator), run the
  92 <tt><b>llvm-gcc</b></tt> command line as you were when the crash occurred, but
  93 with the following extra command line options:</p>
  94
  95 <ul>
  96   <li><tt><b>-O0 -emit-llvm</b></tt>: If <tt>llvm-gcc</tt> still crashes when
  97   passed these options (which disable the optimizer and code generator), then
  98   the crash is in the front-end.  Jump ahead to the section on <a
  99   href="#front-end">front-end bugs</a>.</li>
 100
 101   <li><tt><b>-emit-llvm</b></tt>: If <tt>llvm-gcc</tt> crashes with this option
 102   (which disables the code generator), you found an optimizer bug.  Jump ahead
 103   to <a href="#ct_optimizer"> compile-time optimization bugs</a>.</li>
 104
 105   <li>Otherwise, you have a code generator crash.  Jump ahead to <a
 106   href="#ct_codegen">code generator bugs</a>.</li>
 107
 108 </ul>
 109
 110 <!-- ======================================================================= -->
 111 <h3>
 112   <a name="front-end">Front-end bugs</a>
 113 </h3>
 114
 115 <div>
 116
 117 <p>If the problem is in the front-end, you should re-run the same
 118 <tt>llvm-gcc</tt> command that resulted in the crash, but add the
 119 <tt>-save-temps</tt> option.  The compiler will crash again, but it will leave
 120 behind a <tt><i>foo</i>.i</tt> file (containing preprocessed C source code) and
 121 possibly <tt><i>foo</i>.s</tt> for each
 122 compiled <tt><i>foo</i>.c</tt> file. Send us the <tt><i>foo</i>.i</tt> file,
 123 along with the options you passed to llvm-gcc, and a brief description of the
 124 error it caused.</p>
 125
 126 <p>The <a href="http://delta.tigris.org/">delta</a> tool helps to reduce the
 127 preprocessed file down to the smallest amount of code that still replicates the
 128 problem. You're encouraged to use delta to reduce the code to make the
 129 developers' lives easier. <a
 130 href="http://gcc.gnu.org/wiki/A_guide_to_testcase_reduction">This website</a>
 131 has instructions on the best way to use delta.</p>
 132
 133 </div>
 134
 135 <!-- ======================================================================= -->
 136 <h3>
 137   <a name="ct_optimizer">Compile-time optimization bugs</a>
 138 </h3>
 139
 140 <div>
 141
 142 <p>If you find that a bug crashes in the optimizer, compile your test-case to a
 143 <tt>.bc</tt> file by passing "<tt><b>-emit-llvm -O0 -c -o foo.bc</b></tt>".
 144 Then run:</p>
 145
 146 <div class="doc_code">
 147 <p><tt><b>opt</b> -std-compile-opts -debug-pass=Arguments foo.bc
 148     -disable-output</tt></p>
 149 </div>
 150
 151 <p>This command should do two things: it should print out a list of passes, and
 152 then it should crash in the same way as llvm-gcc.  If it doesn't crash, please
 153 follow the instructions for a <a href="#front-end">front-end bug</a>.</p>
 154
 155 <p>If this does crash, then you should be able to debug this with the following
 156 bugpoint command:</p>
 157
 158 <div class="doc_code">
 159 <p><tt><b>bugpoint</b> foo.bc &lt;list of passes printed by
 160 <b>opt</b>&gt;</tt></p>
 161 </div>
 162
 163 <p>Please run this, then file a bug with the instructions and reduced .bc files
 164 that bugpoint emits.  If something goes wrong with bugpoint, please submit the
 165 "foo.bc" file and the list of passes printed by <b>opt</b>.</p>
 166
 167 </div>
 168
 169 <!-- ======================================================================= -->
 170 <h3>
 171   <a name="ct_codegen">Code generator bugs</a>
 172 </h3>
 173
 174 <div>
 175
 176 <p>If you find a bug that crashes llvm-gcc in the code generator, compile your
 177 source file to a .bc file by passing "<tt><b>-emit-llvm -c -o foo.bc</b></tt>"
 178 to llvm-gcc (in addition to the options you already pass).  Once your have
 179 foo.bc, one of the following commands should fail:</p>
 180
 181 <ol>
 182 <li><tt><b>llc</b> foo.bc</tt></li>
 183 <li><tt><b>llc</b> foo.bc -relocation-model=pic</tt></li>
 184 <li><tt><b>llc</b> foo.bc -relocation-model=static</tt></li>
 185 </ol>
 186
 187 <p>If none of these crash, please follow the instructions for a
 188 <a href="#front-end">front-end bug</a>.  If one of these do crash, you should
 189 be able to reduce this with one of the following bugpoint command lines (use
 190 the one corresponding to the command above that failed):</p>
 191
 192 <ol>
 193 <li><tt><b>bugpoint</b> -run-llc foo.bc</tt></li>
 194 <li><tt><b>bugpoint</b> -run-llc foo.bc --tool-args
 195            -relocation-model=pic</tt></li>
 196 <li><tt><b>bugpoint</b> -run-llc foo.bc --tool-args
 197            -relocation-model=static</tt></li>
 198 </ol>
 199
 200 <p>Please run this, then file a bug with the instructions and reduced .bc file
 201 that bugpoint emits.  If something goes wrong with bugpoint, please submit the
 202 "foo.bc" file and the option that llc crashes with.</p>
 203
 204 </div>
 205
 206 </div>
 207
 208 <!-- *********************************************************************** -->
 209 <h2>
 210   <a name="miscompilations">Miscompilations</a>
 211 </h2>
 212 <!-- *********************************************************************** -->
 213
 214 <div>
 215
 216 <p>If llvm-gcc successfully produces an executable, but that executable doesn't
 217 run right, this is either a bug in the code or a bug in the
 218 compiler.  The first thing to check is to make sure it is not using undefined
 219 behavior (e.g. reading a variable before it is defined).  In particular, check
 220 to see if the program <a href="http://valgrind.org/">valgrind</a>s clean,
 221 passes purify, or some other memory checker tool.  Many of the "LLVM bugs" that
 222 we have chased down ended up being bugs in the program being compiled, not
 223  LLVM.</p>
 224
 225 <p>Once you determine that the program itself is not buggy, you should choose
 226 which code generator you wish to compile the program with (e.g. C backend, the
 227 JIT, or LLC) and optionally a series of LLVM passes to run.  For example:</p>
 228
 229 <div class="doc_code">
 230 <p><tt>
 231 <b>bugpoint</b> -run-cbe [... optzn passes ...] file-to-test.bc --args -- [program arguments]</tt></p>
 232 </div>
 233
 234 <p><tt>bugpoint</tt> will try to narrow down your list of passes to the one pass
 235 that causes an error, and simplify the bitcode file as much as it can to assist
 236 you. It will print a message letting you know how to reproduce the resulting
 237 error.</p>
 238
 239 </div>
 240
 241 <!-- *********************************************************************** -->
 242 <h2>
 243   <a name="codegen">Incorrect code generation</a>
 244 </h2>
 245 <!-- *********************************************************************** -->
 246
 247 <div>
 248
 249 <p>Similarly to debugging incorrect compilation by mis-behaving passes, you can
 250 debug incorrect code generation by either LLC or the JIT, using
 251 <tt>bugpoint</tt>. The process <tt>bugpoint</tt> follows in this case is to try
 252 to narrow the code down to a function that is miscompiled by one or the other
 253 method, but since for correctness, the entire program must be run,
 254 <tt>bugpoint</tt> will compile the code it deems to not be affected with the C
 255 Backend, and then link in the shared object it generates.</p>
 256
 257 <p>To debug the JIT:</p>
 258
 259 <div class="doc_code">
 260 <pre>
 261 bugpoint -run-jit -output=[correct output file] [bitcode file]  \
 262          --tool-args -- [arguments to pass to lli]              \
 263          --args -- [program arguments]
 264 </pre>
 265 </div>
 266
 267 <p>Similarly, to debug the LLC, one would run:</p>
 268
 269 <div class="doc_code">
 270 <pre>
 271 bugpoint -run-llc -output=[correct output file] [bitcode file]  \
 272          --tool-args -- [arguments to pass to llc]              \
 273          --args -- [program arguments]
 274 </pre>
 275 </div>
 276
 277 <p><b>Special note:</b> if you are debugging MultiSource or SPEC tests that
 278 already exist in the <tt>llvm/test</tt> hierarchy, there is an easier way to
 279 debug the JIT, LLC, and CBE, using the pre-written Makefile targets, which
 280 will pass the program options specified in the Makefiles:</p>
 281
 282 <div class="doc_code">
 283 <p><tt>
 284 cd llvm/test/../../program<br>
 285 make bugpoint-jit
 286 </tt></p>
 287 </div>
 288
 289 <p>At the end of a successful <tt>bugpoint</tt> run, you will be presented
 290 with two bitcode files: a <em>safe</em> file which can be compiled with the C
 291 backend and the <em>test</em> file which either LLC or the JIT
 292 mis-codegenerates, and thus causes the error.</p>
 293
 294 <p>To reproduce the error that <tt>bugpoint</tt> found, it is sufficient to do
 295 the following:</p>
 296
 297 <ol>
 298
 299 <li><p>Regenerate the shared object from the safe bitcode file:</p>
 300
 301 <div class="doc_code">
 302 <p><tt>
 303 <b>llc</b> -march=c safe.bc -o safe.c<br>
 304 <b>gcc</b> -shared safe.c -o safe.so
 305 </tt></p>
 306 </div></li>
 307
 308 <li><p>If debugging LLC, compile test bitcode native and link with the shared
 309     object:</p>
 310
 311 <div class="doc_code">
 312 <p><tt>
 313 <b>llc</b> test.bc -o test.s<br>
 314 <b>gcc</b> test.s safe.so -o test.llc<br>
 315 ./test.llc [program options]
 316 </tt></p>
 317 </div></li>
 318
 319 <li><p>If debugging the JIT, load the shared object and supply the test
 320     bitcode:</p>
 321
 322 <div class="doc_code">
 323 <p><tt><b>lli</b> -load=safe.so test.bc [program options]</tt></p>
 324 </div></li>
 325
 326 </ol>
 327
 328 </div>
 329
 330 <!-- *********************************************************************** -->
 331 <hr>
 332 <address>
 333   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 334   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
 335   <a href="http://validator.w3.org/check/referer"><img
 336   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
 337
 338   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
 339   <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a>
 340   <br>
 341   Last modified: $Date$
 342 </address>
 343
 344 </body>
 345 </html>