Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / fa8a0e5256bd7b13ab7859616c6983718877f3a2 / . / docs / HowToSubmitABug.html
blob: 4aabf35058a77fddaeaf851a3a39b9fa2ca43229 [file] [log] [blame]
Misha Brukman94082392003-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 Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]9
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]10<div class="doc_title">
11 How to submit an LLVM bug report
12</div>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]13
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]14<table class="layout" style="width: 90%" >
15<tr class="layout">
16 <td class="left">
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]17<ol>
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]18 <li><a href="#introduction">Introduction - Got bugs?</a></li>
Chris Lattner8b6be362003-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>
22 <li><a href="#gccas">GCCAS bugs</a>
23 <li><a href="#gccld">GCCLD bugs</a>
24 <li><a href="#passes">Bugs in LLVM passes</a>
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]25 </ul></li>
26 <li><a href="#miscompilations">Miscompilations</a></li>
27 <li><a href="#codegen">Incorrect code generation (JIT and LLC)</a></li>
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]28</ol>
Chris Lattner4129b2a2004-05-23 21:05:39 +0000[diff] [blame]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>
Reid Spencer97510e72004-11-01 08:24:13 +0000[diff] [blame]32</div>
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]33</td>
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]34<td class="right">
Misha Brukmane849a1a2004-05-12 21:26:16 +0000[diff] [blame]35 <img src="img/Debugging.gif" alt="Debugging" width="444" height="314">
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]36</td>
37</tr>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]38</table>
39
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]40<!-- *********************************************************************** -->
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]41<div class="doc_section">
42 <a name="introduction">Introduction - Got bugs?</a>
43</div>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]44<!-- *********************************************************************** -->
45
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]46<div class="doc_text">
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]47
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]48<p>If you're working with LLVM and run into a bug, we definitely want to know
49about it. This document describes what you can do to increase the odds of
50getting it fixed quickly.</p>
51
52<p>Basically you have to do two things at a minimum. First, decide whether the
53bug <a href="#crashers">crashes the compiler</a> (or an LLVM pass), or if the
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]54compiler is <a href="#miscompilations">miscompiling</a> the program. Based on
55what type of bug it is, follow the instructions in the linked section to narrow
56down the bug so that the person who fixes it will be able to find the problem
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]57more easily.</p>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]58
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]59<p>Once you have a reduced test-case, go to <a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]60href="http://llvm.org/bugs/enter_bug.cgi">the LLVM Bug Tracking
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]61System</a>, select the category in which the bug falls, and fill out the form
62with the necessary details. The bug description should contain the following
63information:</p>
64
John Criswell4d37c7b2003-10-22 15:06:11 +0000[diff] [blame]65<ul>
Misha Brukmanafac73e2003-10-22 17:01:44 +0000[diff] [blame]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 CVS
69 repository).</li>
John Criswell4d37c7b2003-10-22 15:06:11 +0000[diff] [blame]70</ul>
71
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]72<p>Thanks for helping us make LLVM better!</p>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]73
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]74</div>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]75
76<!-- *********************************************************************** -->
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]77<div class="doc_section">
78 <a name="crashers">Crashing Bugs</a>
79</div>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]80<!-- *********************************************************************** -->
81
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]82<div class="doc_text">
83
Bill Wendlingfa8a0e52007-02-24 03:46:42 +0000[diff] [blame^]84<p>More often than not, bugs in the compiler cause it to crash&mdash;often due to an
Reid Spencer84f82f72006-08-28 00:34:19 +0000[diff] [blame]85assertion failure of some sort. If you are running <tt><b>opt</b></tt>
86directly, and something crashes, jump to the section on
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]87<a href="#passes">bugs in LLVM passes</a>. Otherwise, the most important
88piece of the puzzle is to figure out if it is the GCC-based front-end that is
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]89buggy or if it's one of the LLVM tools that has problems.</p>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]90
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]91<p>To figure out which program is crashing (the front-end,
92<tt><b>gccas</b></tt>, or <tt><b>gccld</b></tt>), run the
93<tt><b>llvm-gcc</b></tt> command line as you were when the crash occurred, but
94add a <tt>-v</tt> option to the command line. The compiler will print out a
John Criswell79926912004-03-12 20:42:16 +0000[diff] [blame]95bunch of stuff, and should end with telling you that one of
96<tt><b>cc1</b>/<b>cc1plus</b></tt>, <tt><b>gccas</b></tt>, or
97<tt><b>gccld</b></tt> crashed.</p>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]98
99<ul>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]100
John Criswell79926912004-03-12 20:42:16 +0000[diff] [blame]101 <li>If <tt><b>cc1</b></tt> or <tt><b>cc1plus</b></tt> crashed, you found a
102 problem with the front-end.
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]103 Jump ahead to the section on <a href="#front-end">front-end bugs</a>.</li>
104
105 <li>If <tt><b>gccas</b></tt> crashed, you found a bug in <a href="#gccas">one
106 of the passes in <tt><b>gccas</b></tt></a>.</li>
107
108 <li>If <tt><b>gccld</b></tt> crashed, you found a bug in <a href="#gccld">one
109 of the passes in <tt><b>gccld</b></tt></a>.</li>
110
111 <li>Otherwise, something really weird happened. Email the list with what you
112 have at this point.</li>
113
114</ul>
115
116</div>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]117
118<!-- ======================================================================= -->
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]119<div class="doc_subsection">
120 <a name="front-end">Front-end bugs</a>
121</div>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]122
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]123<div class="doc_text">
124
125<p>If the problem is in the front-end, you should re-run the same
Brian Gaekeeefe9792003-05-23 21:03:50 +0000[diff] [blame]126<tt>llvm-gcc</tt> command that resulted in the crash, but add the
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]127<tt>-save-temps</tt> option. The compiler will crash again, but it will leave
128behind a <tt><i>foo</i>.i</tt> file (containing preprocessed C source code) and
Bill Wendlingfa8a0e52007-02-24 03:46:42 +0000[diff] [blame^]129possibly <tt><i>foo</i>.s</tt> (containing LLVM assembly code) for each
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]130compiled <tt><i>foo</i>.c</tt> file. Send us the <tt><i>foo</i>.i</tt> file,
Bill Wendlingfa8a0e52007-02-24 03:46:42 +0000[diff] [blame^]131along with a brief description of the error it caused.</p>
132
133<p>The <a href="http://delta.tigris.org/">delta</a> tool helps to reduce the
134preprocessed file down to the smallest amount of code that still replicates the
135problem. You're encouraged to use delta to reduce the code to make the
136developers' lives easier. <a
137href="http://gcc.gnu.org/wiki/A_guide_to_testcase_reduction">This website</a>
138has instructions on the best way to use delta.</p>
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]139
140</div>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]141
142<!-- ======================================================================= -->
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]143<div class="doc_subsection">
144 <a name="gccas">GCCAS bugs</a>
145</div>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]146
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]147<div class="doc_text">
148
149<p>If you find that a bug crashes in the <tt><b>gccas</b></tt> stage of
Brian Gaekeeefe9792003-05-23 21:03:50 +0000[diff] [blame]150compilation, compile your test-case to a <tt>.s</tt> file with the
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]151<tt>-save-temps</tt> option to <tt><b>llvm-gcc</b></tt>. Then run:</p>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]152
Misha Brukmanf4e4feb2004-04-15 20:49:32 +0000[diff] [blame]153<div class="doc_code">
Chris Lattner4129b2a2004-05-23 21:05:39 +0000[diff] [blame]154<p><tt><b>gccas</b> -debug-pass=Arguments &lt; /dev/null -o - &gt; /dev/null</tt></p>
Misha Brukmanf4e4feb2004-04-15 20:49:32 +0000[diff] [blame]155</div>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]156
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]157<p>... which will print a list of arguments, indicating the list of passes that
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]158<tt><b>gccas</b></tt> runs. Once you have the input file and the list of
159passes, go to the section on <a href="#passes">debugging bugs in LLVM
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]160passes</a>.</p>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]161
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]162</div>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]163
164<!-- ======================================================================= -->
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]165<div class="doc_subsection">
166 <a name="gccld">GCCLD bugs</a>
167</div>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]168
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]169<div class="doc_text">
170
171<p>If you find that a bug crashes in the <tt><b>gccld</b></tt> stage of
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]172compilation, gather all of the <tt>.o</tt> bytecode files and libraries that are
173being linked together (the "<tt><b>llvm-gcc</b> -v</tt>" output should include
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]174the full list of objects linked). Then run:</p>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]175
Misha Brukmanf4e4feb2004-04-15 20:49:32 +0000[diff] [blame]176<div class="doc_code">
Chris Lattner4129b2a2004-05-23 21:05:39 +0000[diff] [blame]177<p><tt><b>llvm-as</b> &lt; /dev/null &gt; null.bc<br>
178<b>gccld</b> -debug-pass=Arguments null.bc</tt>
179</p>
Misha Brukmanf4e4feb2004-04-15 20:49:32 +0000[diff] [blame]180</div>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]181
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]182<p>... which will print a list of arguments, indicating the list of passes that
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]183<tt><b>gccld</b></tt> runs. Once you have the input files and the list of
184passes, go to the section on <a href="#passes">debugging bugs in LLVM
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]185passes</a>.</p>
186
187</div>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]188
189<!-- ======================================================================= -->
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]190<div class="doc_subsection">
191 <a name="passes">Bugs in LLVM passes</a>
192</div>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]193
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]194<div class="doc_text">
195
196<p>At this point, you should have some number of LLVM assembly files or bytecode
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]197files and a list of passes which crash when run on the specified input. In
198order to reduce the list of passes (which is probably large) and the input to
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]199something tractable, use the <tt><b>bugpoint</b></tt> tool as follows:</p>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]200
Misha Brukmanf4e4feb2004-04-15 20:49:32 +0000[diff] [blame]201<div class="doc_code">
Chris Lattner4129b2a2004-05-23 21:05:39 +0000[diff] [blame]202<p><tt><b>bugpoint</b> &lt;input files&gt; &lt;list of passes&gt;</tt></p>
Misha Brukmanf4e4feb2004-04-15 20:49:32 +0000[diff] [blame]203</div>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]204
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]205<p><tt><b>bugpoint</b></tt> will print a bunch of output as it reduces the
206test-case, but it should eventually print something like this:</p>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]207
Misha Brukmane8cad782004-04-19 03:07:29 +0000[diff] [blame]208<div class="doc_code">
Chris Lattner4129b2a2004-05-23 21:05:39 +0000[diff] [blame]209<p><tt>
210...<br>
211Emitted bytecode to 'bugpoint-reduced-simplified.bc'<br>
212<br>
213*** You can reproduce the problem with: opt bugpoint-reduced-simplified.bc -licm<br>
214</tt></p>
Misha Brukmane8cad782004-04-19 03:07:29 +0000[diff] [blame]215</div>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]216
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]217<p>Once you complete this, please send the LLVM bytecode file and the command
218line to reproduce the problem to the llvmbugs mailing list.</p>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]219
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]220</div>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]221
222<!-- *********************************************************************** -->
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]223<div class="doc_section">
224 <a name="miscompilations">Miscompilations</a>
225</div>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]226<!-- *********************************************************************** -->
227
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]228<div class="doc_text">
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]229
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]230<p>A miscompilation occurs when a pass does not correctly transform a program,
231thus producing errors that are only noticed during execution. This is different
232from producing invalid LLVM code (i.e., code not in SSA form, using values
233before defining them, etc.) which the verifier will check for after a pass
234finishes its run.</p>
235
Chris Lattner8436c212004-05-11 19:34:27 +0000[diff] [blame]236<p>If it looks like the LLVM compiler is miscompiling a program, the very first
Misha Brukman300e74b2004-05-12 00:57:24 +0000[diff] [blame]237thing to check is to make sure it is not using undefined behavior. In
238particular, check to see if the program <a
239href="http://valgrind.kde.org/">valgrind</a>s clean, passes purify, or some
Chris Lattner8436c212004-05-11 19:34:27 +0000[diff] [blame]240other memory checker tool. Many of the "LLVM bugs" that we have chased down
241ended up being bugs in the program being compiled, not LLVM.</p>
242
243<p>Once you determine that the program itself is not buggy, you should choose
244which code generator you wish to compile the program with (e.g. C backend, the
245JIT, or LLC) and optionally a series of LLVM passes to run. For example:</p>
Misha Brukmanf1d01fb2003-09-17 18:51:47 +0000[diff] [blame]246
Misha Brukmanf4e4feb2004-04-15 20:49:32 +0000[diff] [blame]247<div class="doc_code">
Chris Lattner4129b2a2004-05-23 21:05:39 +0000[diff] [blame]248<p><tt>
249<b>bugpoint</b> -run-cbe [... optzn passes ...] file-to-test.bc --args -- [program arguments]</tt></p>
Misha Brukmanf4e4feb2004-04-15 20:49:32 +0000[diff] [blame]250</div>
Misha Brukmanf1d01fb2003-09-17 18:51:47 +0000[diff] [blame]251
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]252<p><tt>bugpoint</tt> will try to narrow down your list of passes to the one pass
Misha Brukmanf1d01fb2003-09-17 18:51:47 +0000[diff] [blame]253that causes an error, and simplify the bytecode file as much as it can to assist
254you. It will print a message letting you know how to reproduce the resulting
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]255error.</p>
256
257</div>
Misha Brukmanf1d01fb2003-09-17 18:51:47 +0000[diff] [blame]258
259<!-- *********************************************************************** -->
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]260<div class="doc_section">
261 <a name="codegen">Incorrect code generation</a>
262</div>
Misha Brukmanf1d01fb2003-09-17 18:51:47 +0000[diff] [blame]263<!-- *********************************************************************** -->
264
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]265<div class="doc_text">
266
267<p>Similarly to debugging incorrect compilation by mis-behaving passes, you can
Misha Brukmanf1d01fb2003-09-17 18:51:47 +0000[diff] [blame]268debug incorrect code generation by either LLC or the JIT, using
269<tt>bugpoint</tt>. The process <tt>bugpoint</tt> follows in this case is to try
270to narrow the code down to a function that is miscompiled by one or the other
271method, but since for correctness, the entire program must be run,
272<tt>bugpoint</tt> will compile the code it deems to not be affected with the C
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]273Backend, and then link in the shared object it generates.</p>
Misha Brukmanf1d01fb2003-09-17 18:51:47 +0000[diff] [blame]274
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]275<p>To debug the JIT:</p>
276
Misha Brukmanf4e4feb2004-04-15 20:49:32 +0000[diff] [blame]277<div class="doc_code">
Misha Brukman1e4ae2b2004-05-14 18:57:24 +0000[diff] [blame]278<pre>
279bugpoint -run-jit -output=[correct output file] [bytecode file] \
280 --tool-args -- [arguments to pass to lli] \
281 --args -- [program arguments]
282</pre>
Misha Brukmanf4e4feb2004-04-15 20:49:32 +0000[diff] [blame]283</div>
Misha Brukmanf1d01fb2003-09-17 18:51:47 +0000[diff] [blame]284
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]285<p>Similarly, to debug the LLC, one would run:</p>
286
Misha Brukmanf4e4feb2004-04-15 20:49:32 +0000[diff] [blame]287<div class="doc_code">
Misha Brukman1e4ae2b2004-05-14 18:57:24 +0000[diff] [blame]288<pre>
289bugpoint -run-llc -output=[correct output file] [bytecode file] \
290 --tool-args -- [arguments to pass to llc] \
291 --args -- [program arguments]
292</pre>
Misha Brukmanf4e4feb2004-04-15 20:49:32 +0000[diff] [blame]293</div>
Misha Brukmanf1d01fb2003-09-17 18:51:47 +0000[diff] [blame]294
Misha Brukman180e8af2004-04-15 21:01:21 +0000[diff] [blame]295<p><b>Special note:</b> if you are debugging MultiSource or SPEC tests that
296already exist in the <tt>llvm/test</tt> hierarchy, there is an easier way to
297debug the JIT, LLC, and CBE, using the pre-written Makefile targets, which
298will pass the program options specified in the Makefiles:</p>
299
300<div class="doc_code">
Chris Lattner4129b2a2004-05-23 21:05:39 +0000[diff] [blame]301<p><tt>
302cd llvm/test/../../program<br>
Misha Brukman3c687a02004-05-14 19:04:07 +0000[diff] [blame]303make bugpoint-jit
Chris Lattner4129b2a2004-05-23 21:05:39 +0000[diff] [blame]304</tt></p>
Misha Brukman180e8af2004-04-15 21:01:21 +0000[diff] [blame]305</div>
306
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]307<p>At the end of a successful <tt>bugpoint</tt> run, you will be presented
Misha Brukmanf1d01fb2003-09-17 18:51:47 +0000[diff] [blame]308with two bytecode files: a <em>safe</em> file which can be compiled with the C
309backend and the <em>test</em> file which either LLC or the JIT
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]310mis-codegenerates, and thus causes the error.</p>
Misha Brukmanf1d01fb2003-09-17 18:51:47 +0000[diff] [blame]311
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]312<p>To reproduce the error that <tt>bugpoint</tt> found, it is sufficient to do
313the following:</p>
Misha Brukmanf1d01fb2003-09-17 18:51:47 +0000[diff] [blame]314
315<ol>
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]316
Misha Brukman3c687a02004-05-14 19:04:07 +0000[diff] [blame]317<li><p>Regenerate the shared object from the safe bytecode file:</p>
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]318
Misha Brukman3c687a02004-05-14 19:04:07 +0000[diff] [blame]319<div class="doc_code">
Chris Lattner4129b2a2004-05-23 21:05:39 +0000[diff] [blame]320<p><tt>
321<b>llc</b> -march=c safe.bc -o safe.c<br>
Misha Brukman3c687a02004-05-14 19:04:07 +0000[diff] [blame]322<b>gcc</b> -shared safe.c -o safe.so
Chris Lattner4129b2a2004-05-23 21:05:39 +0000[diff] [blame]323</tt></p>
Misha Brukman3c687a02004-05-14 19:04:07 +0000[diff] [blame]324</div></li>
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]325
Misha Brukman3c687a02004-05-14 19:04:07 +0000[diff] [blame]326<li><p>If debugging LLC, compile test bytecode native and link with the shared
327 object:</p>
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]328
Misha Brukman3c687a02004-05-14 19:04:07 +0000[diff] [blame]329<div class="doc_code">
Chris Lattner4129b2a2004-05-23 21:05:39 +0000[diff] [blame]330<p><tt>
331<b>llc</b> test.bc -o test.s -f<br>
332<b>gcc</b> test.s safe.so -o test.llc<br>
Misha Brukman3c687a02004-05-14 19:04:07 +0000[diff] [blame]333./test.llc [program options]
Chris Lattner4129b2a2004-05-23 21:05:39 +0000[diff] [blame]334</tt></p>
Misha Brukman3c687a02004-05-14 19:04:07 +0000[diff] [blame]335</div></li>
336
337<li><p>If debugging the JIT, load the shared object and supply the test
338 bytecode:</p>
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]339
Misha Brukman3c687a02004-05-14 19:04:07 +0000[diff] [blame]340<div class="doc_code">
Chris Lattner4129b2a2004-05-23 21:05:39 +0000[diff] [blame]341<p><tt><b>lli</b> -load=safe.so test.bc [program options]</tt></p>
Misha Brukman3c687a02004-05-14 19:04:07 +0000[diff] [blame]342</div></li>
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]343
Misha Brukmanf1d01fb2003-09-17 18:51:47 +0000[diff] [blame]344</ol>
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]345
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]346</div>
347
Chris Lattner8b6be362003-05-21 22:21:07 +0000[diff] [blame]348<!-- *********************************************************************** -->
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]349<hr>
Misha Brukman637cab02004-01-15 19:03:47 +0000[diff] [blame]350<address>
351 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
352 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
353 <a href="http://validator.w3.org/check/referer"><img
354 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
355
356 <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]357 <a href="http://llvm.org">The LLVM Compiler Infrastructure</a>
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]358 <br>
359 Last modified: $Date$
Misha Brukman637cab02004-01-15 19:03:47 +0000[diff] [blame]360</address>
Misha Brukman94082392003-10-31 18:37:20 +0000[diff] [blame]361
362</body>
363</html>