blob: ebcfa845effd5cb5fd3b79b56b09fd71615b8ad4 [file] [log] [blame]
Misha Brukman6a2b3102004-05-12 18:49:47 +00001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
Misha Brukman83bd33a2003-10-23 01:48:33 +00003<html>
4<head>
Misha Brukman6a2b3102004-05-12 18:49:47 +00005 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
6 <link rel="stylesheet" href="llvm.css" type="text/css" media="screen">
Misha Brukmanb9e57892003-10-28 21:09:29 +00007 <title>Bootstrapping the LLVM C/C++ Front-End</title>
Misha Brukman83bd33a2003-10-23 01:48:33 +00008</head>
9<body>
Brian Gaeke46079d22003-10-21 21:58:38 +000010
Misha Brukman83bd33a2003-10-23 01:48:33 +000011<div class="doc_title">
Misha Brukmanb9e57892003-10-28 21:09:29 +000012 Bootstrapping the LLVM C/C++ Front-End
Misha Brukman83bd33a2003-10-23 01:48:33 +000013</div>
Brian Gaeke46079d22003-10-21 21:58:38 +000014
Brian Gaeke7af03e92003-11-12 20:47:30 +000015<ol>
16 <li><a href="#cautionarynote">A Cautionary Note</a>
Chris Lattner6a615ad2004-06-01 18:13:05 +000017 <ul>
Misha Brukman62a93432004-06-18 15:54:54 +000018 <li><a href="#cygwin">Building under Cygwin</a></li>
Misha Brukman03ea9d42004-08-23 17:54:45 +000019 <li><a href="#aix">Building under AIX</a></li>
Chris Lattner6a615ad2004-06-01 18:13:05 +000020 </ul>
21 </li>
22 <li><a href="#instructions">Instructions</a></li>
23 <li><a href="#license">License Information</a></li>
Brian Gaeke7af03e92003-11-12 20:47:30 +000024</ol>
25
Chris Lattner7911ce22004-05-23 21:07:27 +000026<div class="doc_author">
Chris Lattner6a615ad2004-06-01 18:13:05 +000027 <p>Written by Brian R. Gaeke and
28 <a href="http://nondot.org/sabre">Chris Lattner</a></p>
Brian Gaeke7af03e92003-11-12 20:47:30 +000029</div>
30
31<!-- *********************************************************************** -->
32<div class="doc_section">
33 <a name="cautionarynote">A Cautionary Note</a>
34</div>
35<!-- *********************************************************************** -->
36
37<div class="doc_text">
38<p>This document is intended to explain the process of building the
39LLVM C/C++ front-end, based on GCC 3.4, from its source code. You
40would have to do this, for example, if you are porting LLVM to a new
41architecture or operating system.</p>
Brian Gaeke46079d22003-10-21 21:58:38 +000042
43<p><b>NOTE:</b> This is currently a somewhat fragile, error-prone
Misha Brukmanb9e57892003-10-28 21:09:29 +000044process, and you should <b>only</b> try to do it if:</p>
45
46<ol>
47 <li>you really, really, really can't use the binaries we distribute</li>
Misha Brukmanb9e57892003-10-28 21:09:29 +000048 <li>you are an elite GCC hacker.</li>
49</ol>
Brian Gaeke46079d22003-10-21 21:58:38 +000050
51<p>We welcome patches to help make this process simpler.</p>
Brian Gaeke7af03e92003-11-12 20:47:30 +000052</div>
Brian Gaeke46079d22003-10-21 21:58:38 +000053
Chris Lattner6a615ad2004-06-01 18:13:05 +000054<!--=========================================================================-->
55<div class="doc_subsection">
Misha Brukman62a93432004-06-18 15:54:54 +000056 <a name="cygwin">Building under Cygwin</a>
Chris Lattner6a615ad2004-06-01 18:13:05 +000057</div>
58<!--=========================================================================-->
59
60<div class="doc_text">
John Criswell9e2485c2004-12-10 15:51:16 +000061<p>If you are building LLVM and the GCC front-end under Cygwin, please note that
Chris Lattner6a615ad2004-06-01 18:13:05 +000062the LLVM and GCC makefiles do not correctly handle spaces in paths. To deal
63with this issue, make sure that your LLVM and GCC source and build trees are
64located in a top-level directory (like <tt>/cygdrive/c/llvm</tt> and
65<tt>/cygdrive/c/llvm-cfrontend</tt>), not in a directory that contains a space
66(which includes your "home directory", because it lives under the "Documents
67and Settings" directory). We welcome patches to fix this issue.
68</p>
Reid Spencer24042362004-12-22 09:52:30 +000069<p>It has been found that the GCC 3.3.3 compiler provided with recent Cygwin
70versions is incapable of compiling the LLVM CFE correctly. If your Cygwin
71installation includes GCC 3.3.3 we <i>strongly</i> recommend that you download
72GCC 3.4.3, build it separately, and use it for compiling LLVM CFE. This has been
73shown to work correctly.</p>
Chris Lattner6a615ad2004-06-01 18:13:05 +000074</div>
75
Misha Brukman03ea9d42004-08-23 17:54:45 +000076<!--=========================================================================-->
77<div class="doc_subsection">
78 <a name="aix">Building under AIX</a>
79</div>
80<!--=========================================================================-->
81
82<div class="doc_text">
John Criswell9e2485c2004-12-10 15:51:16 +000083<p>If you are building LLVM and the GCC front-end under AIX, do NOT use GNU
Misha Brukman03ea9d42004-08-23 17:54:45 +000084Binutils. They are not stable under AIX and may produce incorrect and/or
85invalid code. Instead, use the system assembler and linker.
86</p>
87</div>
88
Misha Brukman83bd33a2003-10-23 01:48:33 +000089<!-- *********************************************************************** -->
90<div class="doc_section">
91 <a name="instructions">Instructions</a>
92</div>
93<!-- *********************************************************************** -->
94
95<div class="doc_text">
96<p>
Brian Gaeke46079d22003-10-21 21:58:38 +000097<ol>
98<li><p>Configure and build the LLVM libraries and tools using:</p>
99<pre>
100 % cd llvm
Reid Spencer0b4f4682004-12-01 05:15:44 +0000101 % ./configure --prefix=/some/path/you/can/install/to [options...]
Misha Brukmane7490532004-08-14 22:13:33 +0000102 % gmake tools-only
Brian Gaeke46079d22003-10-21 21:58:38 +0000103</pre>
Reid Spencer0b4f4682004-12-01 05:15:44 +0000104 <p>This will build all of the LLVM tools and libraries. The <tt>--prefix</tt>
105 option defaults to /usr/local (per configure standards) but unless you are a
106 system administrator, you probably won't be able to install LLVM there because
107 of permissions. Specify a path into which LLVM can be installed (e.g.
108 <tt>--prefix=/home/user/llvm</tt>).</p>
109</li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000110
111<li><p>Add the directory containing the tools to your PATH.</p>
112<pre>
John Criswellc7f42642004-12-01 14:12:30 +0000113 % set path = ( `cd llvm/Debug/bin &amp;&amp; pwd` $path )
Misha Brukman83bd33a2003-10-23 01:48:33 +0000114</pre></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000115
Misha Brukman83bd33a2003-10-23 01:48:33 +0000116<li><p>Unpack the C/C++ front-end source into cfrontend/src.</p></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000117
Misha Brukmane7490532004-08-14 22:13:33 +0000118<li><p>Make "build" and "install" directories as siblings of the "src" tree.</p>
Brian Gaeke46079d22003-10-21 21:58:38 +0000119<pre>
120 % pwd
121 /usr/local/example/cfrontend/src
122 % cd ..
123 % mkdir build install
124 % set CFEINSTALL = `pwd`/install
Misha Brukman83bd33a2003-10-23 01:48:33 +0000125</pre></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000126
Chris Lattner6a615ad2004-06-01 18:13:05 +0000127
John Criswell9e2485c2004-12-10 15:51:16 +0000128<li><p>Configure, build, and install the GCC front-end:</p>
John Criswell55072842003-12-08 19:59:14 +0000129
130<p>
Misha Brukman31b24322004-06-21 14:00:44 +0000131<b>Linux/x86:</b><br>
Misha Brukmana964fe52004-08-09 18:37:04 +0000132<b>MacOS X/PowerPC</b> (requires dlcompat library):<br>
133<b>AIX/PowerPC:</b>
John Criswell55072842003-12-08 19:59:14 +0000134</p>
135
Brian Gaeke46079d22003-10-21 21:58:38 +0000136<pre>
137 % cd build
Misha Brukmana964fe52004-08-09 18:37:04 +0000138 % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
Reid Spencer4ac306502004-12-22 06:40:29 +0000139 --disable-shared --enable-languages=c,c++ --program-prefix=llvm-
Brian Gaeke46079d22003-10-21 21:58:38 +0000140 % gmake all; gmake install
141</pre>
142
Misha Brukman62a93432004-06-18 15:54:54 +0000143<p><b>Cygwin/x86:</b></p>
Chris Lattner893c26a2004-06-02 19:27:50 +0000144
145<pre>
146 % cd build
Misha Brukmana964fe52004-08-09 18:37:04 +0000147 % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
Reid Spencer4ac306502004-12-22 06:40:29 +0000148 --disable-shared --enable-languages=c,c++ --disable-c-mbchar \
149 --program-prefix=llvm-
Chris Lattner893c26a2004-06-02 19:27:50 +0000150 % gmake all; gmake install
151</pre>
152
153<p><b>Solaris/SPARC:</b></p>
John Criswell55072842003-12-08 19:59:14 +0000154
155<p>
John Criswell6e35eda2004-11-29 21:46:29 +0000156For Solaris/SPARC, LLVM only supports the SPARC V9 architecture. Therefore,
157the configure command line should specify sparcv9, as shown below. Also,
Brian Gaeke7e9bd802004-01-28 20:54:41 +0000158note that Solaris has trouble with various wide (multibyte) character
159functions from C as referenced from C++, so we typically configure with
160--disable-c-mbchar (cf. <a href="http://llvm.cs.uiuc.edu/PR206">Bug 206</a>).
John Criswell55072842003-12-08 19:59:14 +0000161</p>
162
163<pre>
164 % cd build
Brian Gaeke7e9bd802004-01-28 20:54:41 +0000165 % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
166 --disable-shared --enable-languages=c,c++ --host=sparcv9-sun-solaris2.8 \
Reid Spencer4ac306502004-12-22 06:40:29 +0000167 --disable-c-mbchar --program-prefix=llvm-
Brian Gaeke7e9bd802004-01-28 20:54:41 +0000168 % gmake all; gmake install
John Criswell55072842003-12-08 19:59:14 +0000169</pre>
170
Chris Lattnere38c6282003-10-23 03:55:23 +0000171 <p><b>Common Problem:</b> You may get error messages regarding the fact
Brian Gaeke46079d22003-10-21 21:58:38 +0000172 that LLVM does not support inline assembly. Here are two common
173 fixes:</p>
174
175 <ul>
176 <li><p><b>Fix 1:</b> If you have system header files that include
177 inline assembly, you may have to modify them to remove the inline
John Criswell9e2485c2004-12-10 15:51:16 +0000178 assembly and install the modified versions in
Chris Lattner37874052004-10-06 03:13:47 +0000179 <code>$CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm/include</code>.</li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000180
181 <li><b>Fix 2:</b> If you are building the C++ front-end on a CPU we
182 haven't tried yet, you will probably have to edit the appropriate
183 version of atomicity.h under
184 <code>src/libstdc++-v3/config/cpu/<i>name-of-cpu</i>/atomicity.h</code>
Misha Brukman6a2b3102004-05-12 18:49:47 +0000185 and apply a patch so that it does not use inline assembly.</li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000186 </ul>
187
John Criswell9e2485c2004-12-10 15:51:16 +0000188 <p><b>Porting to a new architecture:</b> If you are porting the front-end
189 to a new architecture or compiling in a configuration that we have
190 not tried previously, there are probably several changes you will have to make
191 to the GCC target to get it to work correctly. These include:<p>
Brian Gaeke46079d22003-10-21 21:58:38 +0000192
193 <ul>
John Criswell6e35eda2004-11-29 21:46:29 +0000194 <li>Often targets include special assembler or linker flags which
Chris Lattnere38c6282003-10-23 03:55:23 +0000195 <tt>gccas</tt>/<tt>gccld</tt> does not understand. In general, these can
196 just be removed.</li>
197 <li>LLVM currently does not support any floating point values other than
198 32-bit and 64-bit IEEE floating point. The primary effect of this is
199 that you may have to map "long double" onto "double".</li>
200 <li>The profiling hooks in GCC do not apply at all to the LLVM front-end.
201 These may need to be disabled.</li>
202 <li>No inline assembly for position independent code. At the LLVM level,
203 everything is position independent.</li>
204 <li>We handle <tt>.init</tt> and <tt>.fini</tt> differently.</li>
Chris Lattner13964e02003-10-24 16:02:34 +0000205 <li>You may have to disable multilib support in your target. Using multilib
206 support causes the GCC compiler driver to add a lot of "<tt>-L</tt>"
207 options to the link line, which do not relate to LLVM and confuse
208 <tt>gccld</tt>. To disable multilibs, delete any
209 <tt>MULTILIB_OPTIONS</tt> lines from your target files.</li>
Chris Lattnere38c6282003-10-23 03:55:23 +0000210 <li>Did we mention that we don't support inline assembly? You'll probably
211 have to add some fixinclude hacks to disable it in the system
212 headers.</li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000213 </ul>
Misha Brukman83bd33a2003-10-23 01:48:33 +0000214</li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000215
Reid Spencer4ac306502004-12-22 06:40:29 +0000216<li><p>Put <tt>$CFEINSTALL/bin</tt> into your <tt>PATH</tt> environment
217variable.</p>
218 <ul>
219 <li>sh: <tt>export PATH=$CFEINSTALL/bin:$PATH</tt></li>
220 <li>csh: <tt>setenv PATH $CFEINSTALL/bin:$PATH</tt></li>
Reid Spencer4ac306502004-12-22 06:40:29 +0000221 </ul>
222</li>
223
Chris Lattner6a615ad2004-06-01 18:13:05 +0000224<li><p>Go back into the LLVM source tree proper. Rerun configure, using
Reid Spencer4ac306502004-12-22 06:40:29 +0000225the same options as the last time. This will cause the configuration to now find
226the newly built llvm-gcc and llvm-g++ executables. </p></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000227
228<li><p>If you edited header files during the C/C++ front-end build as
229described in "Fix 1" above, you must now copy those header files from
230<code>$CFEINSTALL/<i>target-triplet</i>/sys-include</code> to
231<code>$CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm/include</code>.
232(This should be the "include" directory in the same directory as the
233libgcc.a library, which you can find by running
Reid Spencer4ac306502004-12-22 06:40:29 +0000234<code>$CFEINSTALL/bin/llvm-gcc --print-libgcc-file-name</code>.)</p></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000235
Chris Lattner6a615ad2004-06-01 18:13:05 +0000236<li><p>Rebuild your CVS tree. This shouldn't cause the whole thing to be
237 rebuilt, but it should build the runtime libraries. After the tree is
John Criswell9e2485c2004-12-10 15:51:16 +0000238 built, install the runtime libraries into your GCC front-end build tree.
Chris Lattner6a615ad2004-06-01 18:13:05 +0000239 These are the commands you need.</p>
Brian Gaeke46079d22003-10-21 21:58:38 +0000240<pre>
Chris Lattner6a615ad2004-06-01 18:13:05 +0000241 % gmake
Reid Spencer3149ba72004-12-04 08:13:20 +0000242 % gmake -C runtime install-bytecode
Misha Brukman83bd33a2003-10-23 01:48:33 +0000243</pre></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000244
Reid Spencerf99e59a2004-11-25 17:13:17 +0000245<li><p>Optionally, build a symbol table for the newly installed runtime
Reid Spencer4ac306502004-12-22 06:40:29 +0000246libraries. Although this step is optional, you are strongly encouraged to
247do this as the symbol tables will make a significant difference in your
248link times. Use the <tt>llvm-ranlib</tt> tool to do this, as follows:</p>
Reid Spencerf99e59a2004-11-25 17:13:17 +0000249<pre>
250 % cd $CFEINSTALL/lib
251 % llvm-ranlib libiberty.a
252 % llvm-ranlib libstdc++.a
Chris Lattner302ed2a2004-12-01 04:16:29 +0000253 % llvm-ranlib libsupc++.a
Reid Spencerf99e59a2004-11-25 17:13:17 +0000254 % cd $CFEINSTALL/lib/<i>target-triplet</i>/3.4-llvm
255 % llvm-ranlib libgcc.a
256 % llvm-ranlib libgcov.a
257</pre>
258
Brian Gaeke46079d22003-10-21 21:58:38 +0000259<li><p>Test the newly-installed C frontend by one or more of the
260following means:</p>
261 <ul>
Reid Spencer4ac306502004-12-22 06:40:29 +0000262 <li> running the feature &amp; regression tests via <tt>make check</tt></li>
Chris Lattnere38c6282003-10-23 03:55:23 +0000263 <li> compiling and running a "hello, LLVM" program in C and C++.</li>
John Criswell9e2485c2004-12-10 15:51:16 +0000264 <li> running the tests found in the <tt>llvm-test</tt> CVS module</li>
Misha Brukman6a2b3102004-05-12 18:49:47 +0000265 </ul></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000266</ol>
Misha Brukman83bd33a2003-10-23 01:48:33 +0000267</div>
Brian Gaeke46079d22003-10-21 21:58:38 +0000268
269<!-- *********************************************************************** -->
John Criswelld000e1d2003-12-18 16:43:17 +0000270<div class="doc_section">
271 <a name="license">License Information</a>
272</div>
273
274<div class="doc_text">
275<p>
276The LLVM GCC frontend is licensed to you under the GNU General Public License
277and the GNU Lesser General Public License. Please see the files COPYING and
278COPYING.LIB for more details.
279</p>
280
281<p>
282The software also has the following additional copyrights:
283</p>
284
285<pre>
John Criswelle3602102004-03-12 18:02:17 +0000286
287Copyright (c) 2003, 2004 University of Illinois at Urbana-Champaign.
288All rights reserved.
289
290Developed by:
291
292 LLVM Team
293
294 University of Illinois at Urbana-Champaign
295
296 http://llvm.cs.uiuc.edu
297
298THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
299IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
300FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
301CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
302LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
303OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE
304SOFTWARE.
305
John Criswelld000e1d2003-12-18 16:43:17 +0000306Copyright (c) 1994
307Hewlett-Packard Company
308
309Permission to use, copy, modify, distribute and sell this software
310and its documentation for any purpose is hereby granted without fee,
311provided that the above copyright notice appear in all copies and
312that both that copyright notice and this permission notice appear
313in supporting documentation. Hewlett-Packard Company makes no
314representations about the suitability of this software for any
315purpose. It is provided "as is" without express or implied warranty.
316
317Copyright (c) 1996, 1997, 1998, 1999
318Silicon Graphics Computer Systems, Inc.
319
320Permission to use, copy, modify, distribute and sell this software
321and its documentation for any purpose is hereby granted without fee,
322provided that the above copyright notice appear in all copies and
323that both that copyright notice and this permission notice appear
324in supporting documentation. Silicon Graphics makes no
325representations about the suitability of this software for any
326purpose. It is provided "as is" without express or implied warranty.
327</pre>
328</div>
329
330<!-- *********************************************************************** -->
Brian Gaeke46079d22003-10-21 21:58:38 +0000331
Misha Brukmanb9e57892003-10-28 21:09:29 +0000332<hr>
Misha Brukman6a2b3102004-05-12 18:49:47 +0000333<address>
334 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
335 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
336 <a href="http://validator.w3.org/check/referer"><img
337 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
338
339 Brian Gaeke<br>
340 <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
Misha Brukmanb9e57892003-10-28 21:09:29 +0000341 Last modified: $Date$
Misha Brukman6a2b3102004-05-12 18:49:47 +0000342</address>
Brian Gaeke46079d22003-10-21 21:58:38 +0000343
Misha Brukman83bd33a2003-10-23 01:48:33 +0000344</body>
345</html>