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