blob: ffec81050481be4c95f5b3edca3fd036b3fb47e6 [file] [log] [blame]
Misha Brukman4478f2b2004-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 Brukman0ccf5192003-10-23 01:48:33 +00003<html>
4<head>
Misha Brukman4478f2b2004-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 Brukmanb7c3b6d2003-10-28 21:09:29 +00007 <title>Bootstrapping the LLVM C/C++ Front-End</title>
Misha Brukman0ccf5192003-10-23 01:48:33 +00008</head>
9<body>
Brian Gaeke0142c1e2003-10-21 21:58:38 +000010
Misha Brukman0ccf5192003-10-23 01:48:33 +000011<div class="doc_title">
Misha Brukmanb7c3b6d2003-10-28 21:09:29 +000012 Bootstrapping the LLVM C/C++ Front-End
Misha Brukman0ccf5192003-10-23 01:48:33 +000013</div>
Brian Gaeke0142c1e2003-10-21 21:58:38 +000014
Brian Gaekee6406a82003-11-12 20:47:30 +000015<ol>
16 <li><a href="#cautionarynote">A Cautionary Note</a>
Chris Lattnerbbdec032004-06-01 18:13:05 +000017 <ul>
Misha Brukman35d842e2004-06-18 15:54:54 +000018 <li><a href="#cygwin">Building under Cygwin</a></li>
Misha Brukman39efd012004-08-23 17:54:45 +000019 <li><a href="#aix">Building under AIX</a></li>
Chris Lattnerbbdec032004-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 Gaekee6406a82003-11-12 20:47:30 +000024</ol>
25
Chris Lattner020e1fc2004-05-23 21:07:27 +000026<div class="doc_author">
Chris Lattnerbbdec032004-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 Gaekee6406a82003-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 Gaeke0142c1e2003-10-21 21:58:38 +000042
43<p><b>NOTE:</b> This is currently a somewhat fragile, error-prone
Misha Brukmanb7c3b6d2003-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 Brukmanb7c3b6d2003-10-28 21:09:29 +000048 <li>you are an elite GCC hacker.</li>
Chris Lattner25170b02005-02-21 16:35:31 +000049 <li>you want to use the latest bits from CVS.</li>
Misha Brukmanb7c3b6d2003-10-28 21:09:29 +000050</ol>
Brian Gaeke0142c1e2003-10-21 21:58:38 +000051
52<p>We welcome patches to help make this process simpler.</p>
Brian Gaekee6406a82003-11-12 20:47:30 +000053</div>
Brian Gaeke0142c1e2003-10-21 21:58:38 +000054
Chris Lattnerbbdec032004-06-01 18:13:05 +000055<!--=========================================================================-->
56<div class="doc_subsection">
Misha Brukman35d842e2004-06-18 15:54:54 +000057 <a name="cygwin">Building under Cygwin</a>
Chris Lattnerbbdec032004-06-01 18:13:05 +000058</div>
59<!--=========================================================================-->
60
61<div class="doc_text">
John Criswelldfe6a862004-12-10 15:51:16 +000062<p>If you are building LLVM and the GCC front-end under Cygwin, please note that
Chris Lattnerbbdec032004-06-01 18:13:05 +000063the LLVM and GCC makefiles do not correctly handle spaces in paths. To deal
64with this issue, make sure that your LLVM and GCC source and build trees are
65located in a top-level directory (like <tt>/cygdrive/c/llvm</tt> and
66<tt>/cygdrive/c/llvm-cfrontend</tt>), not in a directory that contains a space
67(which includes your "home directory", because it lives under the "Documents
68and Settings" directory). We welcome patches to fix this issue.
69</p>
Reid Spencer3e41cd52004-12-22 09:52:30 +000070<p>It has been found that the GCC 3.3.3 compiler provided with recent Cygwin
71versions is incapable of compiling the LLVM CFE correctly. If your Cygwin
John Criswell608f4802005-05-13 20:38:44 +000072installation includes GCC 3.3.3, we <i>strongly</i> recommend that you download
Reid Spencer3e41cd52004-12-22 09:52:30 +000073GCC 3.4.3, build it separately, and use it for compiling LLVM CFE. This has been
74shown to work correctly.</p>
Reid Spencer1097f7d2004-12-23 19:49:54 +000075<p>Some versions of Cygwin utilize an experimental version of GNU binutils that
76will cause the GNU <tt>ld</tt> linker to fail an assertion when linking
77components of the libstdc++. It is recommended that you replace the entire
78binutils package with version 2.15 such that "<tt>ld --version</tt>" responds
Misha Brukmane4fad6b2005-03-01 17:19:21 +000079with</p>
Reid Spencer1097f7d2004-12-23 19:49:54 +000080<pre>GNU ld version 2.15</pre>
81not with:<br/>
82<pre>GNU ld version 2.15.91 20040725</pre>
Misha Brukmane4fad6b2005-03-01 17:19:21 +000083</div>
Chris Lattnerbbdec032004-06-01 18:13:05 +000084
Misha Brukman39efd012004-08-23 17:54:45 +000085<!--=========================================================================-->
Reid Spencercdf4d462004-12-31 19:48:59 +000086<div class="doc_subsection"><a name="aix">Building under AIX</a></div>
Misha Brukman39efd012004-08-23 17:54:45 +000087<div class="doc_text">
John Criswelldfe6a862004-12-10 15:51:16 +000088<p>If you are building LLVM and the GCC front-end under AIX, do NOT use GNU
Misha Brukman39efd012004-08-23 17:54:45 +000089Binutils. They are not stable under AIX and may produce incorrect and/or
90invalid code. Instead, use the system assembler and linker.
91</p>
92</div>
93
Misha Brukman0ccf5192003-10-23 01:48:33 +000094<!-- *********************************************************************** -->
95<div class="doc_section">
96 <a name="instructions">Instructions</a>
97</div>
98<!-- *********************************************************************** -->
99
100<div class="doc_text">
101<p>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000102<ol>
Reid Spencercdf4d462004-12-31 19:48:59 +0000103<li><p>Configure and build the LLVM libraries and tools. There are two ways to
John Criswell608f4802005-05-13 20:38:44 +0000104do this: either with <i>objdir</i> == <i>srcdir</i> or
105<i>objdir</i> != <i>srcdir</i>. It is recommended
Reid Spencercdf4d462004-12-31 19:48:59 +0000106that <i>srcdir</i> not be the same as <i>objdir</i>:</p>
107<ul>
108 <li>With <i>objdir</i> != <i>srcdir</i>:<pre>
109 % cd <i>objdir</i>
110 % <i>srcdir</i>/configure --prefix=/some/path/you/can/install/to [options...]
111 % gmake tools-only
112 </pre></li>
113 <li>With <i>objdir</i> == <i>srcdir</i>:<pre>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000114 % cd llvm
Reid Spencerf6a10fa2004-12-01 05:15:44 +0000115 % ./configure --prefix=/some/path/you/can/install/to [options...]
Misha Brukman9b5bdf92004-08-14 22:13:33 +0000116 % gmake tools-only
Reid Spencercdf4d462004-12-31 19:48:59 +0000117 </pre></li>
118</ul>
119<p>This will build all of the LLVM tools and libraries. The <tt>--prefix</tt>
120option defaults to /usr/local (per configure standards) but unless you are a
121system administrator, you probably won't be able to install LLVM there because
122of permissions. Specify a path into which LLVM can be installed (e.g.
123<tt>--prefix=/home/user/llvm</tt>).</p>
Reid Spencerf6a10fa2004-12-01 05:15:44 +0000124</li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000125
126<li><p>Add the directory containing the tools to your PATH.</p>
127<pre>
John Criswell51f8ded2004-12-01 14:12:30 +0000128 % set path = ( `cd llvm/Debug/bin &amp;&amp; pwd` $path )
Misha Brukman0ccf5192003-10-23 01:48:33 +0000129</pre></li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000130
Chris Lattnerbebf14d2005-02-11 21:17:26 +0000131<li><p>Unpack the C/C++ front-end source into cfrontend/src, either by
132 untar'ing an llvm-gcc.tar.gz file or checking out CVS into this
133 directory.</p></li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000134
John Criswell608f4802005-05-13 20:38:44 +0000135<li><p>Make "build" and "install" directories as siblings of the "src" tree:</p>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000136<pre>
137 % pwd
138 /usr/local/example/cfrontend/src
139 % cd ..
140 % mkdir build install
141 % set CFEINSTALL = `pwd`/install
Misha Brukman0ccf5192003-10-23 01:48:33 +0000142</pre></li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000143
Chris Lattnerbbdec032004-06-01 18:13:05 +0000144
John Criswelldfe6a862004-12-10 15:51:16 +0000145<li><p>Configure, build, and install the GCC front-end:</p>
John Criswellffc722a72003-12-08 19:59:14 +0000146
147<p>
Misha Brukmane54cbdd2004-06-21 14:00:44 +0000148<b>Linux/x86:</b><br>
Misha Brukman65c79252004-08-09 18:37:04 +0000149<b>MacOS X/PowerPC</b> (requires dlcompat library):<br>
150<b>AIX/PowerPC:</b>
John Criswellffc722a72003-12-08 19:59:14 +0000151</p>
152
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000153<pre>
154 % cd build
Misha Brukman65c79252004-08-09 18:37:04 +0000155 % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
Reid Spencerc659a4b2004-12-22 06:40:29 +0000156 --disable-shared --enable-languages=c,c++ --program-prefix=llvm-
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000157 % gmake all; gmake install
158</pre>
159
Misha Brukman35d842e2004-06-18 15:54:54 +0000160<p><b>Cygwin/x86:</b></p>
Chris Lattner8c85ec92004-06-02 19:27:50 +0000161
162<pre>
163 % cd build
Misha Brukman65c79252004-08-09 18:37:04 +0000164 % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
Reid Spencerc659a4b2004-12-22 06:40:29 +0000165 --disable-shared --enable-languages=c,c++ --disable-c-mbchar \
166 --program-prefix=llvm-
Chris Lattner8c85ec92004-06-02 19:27:50 +0000167 % gmake all; gmake install
168</pre>
169
170<p><b>Solaris/SPARC:</b></p>
John Criswellffc722a72003-12-08 19:59:14 +0000171
172<p>
John Criswell48761352005-05-13 20:54:44 +0000173The GCC front-end can be configured for either SPARC V8 (32 bit) or SPARC V9 (64
174bit). This changes, among other things, the sizes of integer types and the
175macros defined for conditional compilation.
176</p>
177
178<p>
179The SPARC V8 backend is still beta quality software. Unless you are working on
180the SPARC V8 backend, you should specify sparcv9 on the configure command line,
181as shown below. Also,
Brian Gaeke0119fba2004-01-28 20:54:41 +0000182note that Solaris has trouble with various wide (multibyte) character
183functions from C as referenced from C++, so we typically configure with
184--disable-c-mbchar (cf. <a href="http://llvm.cs.uiuc.edu/PR206">Bug 206</a>).
John Criswellffc722a72003-12-08 19:59:14 +0000185</p>
186
187<pre>
188 % cd build
Brian Gaeke0119fba2004-01-28 20:54:41 +0000189 % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
190 --disable-shared --enable-languages=c,c++ --host=sparcv9-sun-solaris2.8 \
Reid Spencerc659a4b2004-12-22 06:40:29 +0000191 --disable-c-mbchar --program-prefix=llvm-
Brian Gaeke0119fba2004-01-28 20:54:41 +0000192 % gmake all; gmake install
John Criswellffc722a72003-12-08 19:59:14 +0000193</pre>
194
Chris Lattnerf9b71182003-10-23 03:55:23 +0000195 <p><b>Common Problem:</b> You may get error messages regarding the fact
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000196 that LLVM does not support inline assembly. Here are two common
197 fixes:</p>
198
199 <ul>
200 <li><p><b>Fix 1:</b> If you have system header files that include
201 inline assembly, you may have to modify them to remove the inline
John Criswelldfe6a862004-12-10 15:51:16 +0000202 assembly and install the modified versions in
Chris Lattner18b88f72004-10-06 03:13:47 +0000203 <code>$CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm/include</code>.</li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000204
205 <li><b>Fix 2:</b> If you are building the C++ front-end on a CPU we
206 haven't tried yet, you will probably have to edit the appropriate
207 version of atomicity.h under
208 <code>src/libstdc++-v3/config/cpu/<i>name-of-cpu</i>/atomicity.h</code>
Misha Brukman4478f2b2004-05-12 18:49:47 +0000209 and apply a patch so that it does not use inline assembly.</li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000210 </ul>
211
John Criswelldfe6a862004-12-10 15:51:16 +0000212 <p><b>Porting to a new architecture:</b> If you are porting the front-end
213 to a new architecture or compiling in a configuration that we have
214 not tried previously, there are probably several changes you will have to make
215 to the GCC target to get it to work correctly. These include:<p>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000216
217 <ul>
John Criswellfc1a1dd2004-11-29 21:46:29 +0000218 <li>Often targets include special assembler or linker flags which
Chris Lattnerf9b71182003-10-23 03:55:23 +0000219 <tt>gccas</tt>/<tt>gccld</tt> does not understand. In general, these can
220 just be removed.</li>
221 <li>LLVM currently does not support any floating point values other than
222 32-bit and 64-bit IEEE floating point. The primary effect of this is
223 that you may have to map "long double" onto "double".</li>
224 <li>The profiling hooks in GCC do not apply at all to the LLVM front-end.
225 These may need to be disabled.</li>
226 <li>No inline assembly for position independent code. At the LLVM level,
227 everything is position independent.</li>
228 <li>We handle <tt>.init</tt> and <tt>.fini</tt> differently.</li>
Chris Lattnerd6f136c2003-10-24 16:02:34 +0000229 <li>You may have to disable multilib support in your target. Using multilib
230 support causes the GCC compiler driver to add a lot of "<tt>-L</tt>"
231 options to the link line, which do not relate to LLVM and confuse
232 <tt>gccld</tt>. To disable multilibs, delete any
233 <tt>MULTILIB_OPTIONS</tt> lines from your target files.</li>
Chris Lattnerf9b71182003-10-23 03:55:23 +0000234 <li>Did we mention that we don't support inline assembly? You'll probably
235 have to add some fixinclude hacks to disable it in the system
236 headers.</li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000237 </ul>
Misha Brukman0ccf5192003-10-23 01:48:33 +0000238</li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000239
Reid Spencerc659a4b2004-12-22 06:40:29 +0000240<li><p>Put <tt>$CFEINSTALL/bin</tt> into your <tt>PATH</tt> environment
241variable.</p>
242 <ul>
243 <li>sh: <tt>export PATH=$CFEINSTALL/bin:$PATH</tt></li>
244 <li>csh: <tt>setenv PATH $CFEINSTALL/bin:$PATH</tt></li>
Reid Spencerc659a4b2004-12-22 06:40:29 +0000245 </ul>
246</li>
247
Chris Lattnerbbdec032004-06-01 18:13:05 +0000248<li><p>Go back into the LLVM source tree proper. Rerun configure, using
Reid Spencerc659a4b2004-12-22 06:40:29 +0000249the same options as the last time. This will cause the configuration to now find
250the newly built llvm-gcc and llvm-g++ executables. </p></li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000251
Chris Lattnerbbdec032004-06-01 18:13:05 +0000252<li><p>Rebuild your CVS tree. This shouldn't cause the whole thing to be
253 rebuilt, but it should build the runtime libraries. After the tree is
John Criswelldfe6a862004-12-10 15:51:16 +0000254 built, install the runtime libraries into your GCC front-end build tree.
Misha Brukmana9b86762005-03-01 17:15:23 +0000255 These are the commands you need:</p>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000256<pre>
Chris Lattnerbbdec032004-06-01 18:13:05 +0000257 % gmake
Reid Spencer9cb0f702004-12-04 08:13:20 +0000258 % gmake -C runtime install-bytecode
Misha Brukman0ccf5192003-10-23 01:48:33 +0000259</pre></li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000260
Reid Spencer02c571b2004-11-25 17:13:17 +0000261<li><p>Optionally, build a symbol table for the newly installed runtime
Reid Spencerc659a4b2004-12-22 06:40:29 +0000262libraries. Although this step is optional, you are strongly encouraged to
263do this as the symbol tables will make a significant difference in your
264link times. Use the <tt>llvm-ranlib</tt> tool to do this, as follows:</p>
Reid Spencer02c571b2004-11-25 17:13:17 +0000265<pre>
266 % cd $CFEINSTALL/lib
267 % llvm-ranlib libiberty.a
268 % llvm-ranlib libstdc++.a
Chris Lattner2a2ebd12004-12-01 04:16:29 +0000269 % llvm-ranlib libsupc++.a
Reid Spencere0699f72004-12-22 16:19:05 +0000270 % cd $CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm
Reid Spencer02c571b2004-11-25 17:13:17 +0000271 % llvm-ranlib libgcc.a
272 % llvm-ranlib libgcov.a
273</pre>
274
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000275<li><p>Test the newly-installed C frontend by one or more of the
276following means:</p>
277 <ul>
Reid Spencerc659a4b2004-12-22 06:40:29 +0000278 <li> running the feature &amp; regression tests via <tt>make check</tt></li>
Chris Lattnerf9b71182003-10-23 03:55:23 +0000279 <li> compiling and running a "hello, LLVM" program in C and C++.</li>
John Criswelldfe6a862004-12-10 15:51:16 +0000280 <li> running the tests found in the <tt>llvm-test</tt> CVS module</li>
Misha Brukman4478f2b2004-05-12 18:49:47 +0000281 </ul></li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000282</ol>
Misha Brukman0ccf5192003-10-23 01:48:33 +0000283</div>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000284
285<!-- *********************************************************************** -->
John Criswell86a3a482003-12-18 16:43:17 +0000286<div class="doc_section">
287 <a name="license">License Information</a>
288</div>
289
290<div class="doc_text">
291<p>
292The LLVM GCC frontend is licensed to you under the GNU General Public License
293and the GNU Lesser General Public License. Please see the files COPYING and
294COPYING.LIB for more details.
295</p>
296
297<p>
298The software also has the following additional copyrights:
299</p>
300
301<pre>
John Criswell50f289a2004-03-12 18:02:17 +0000302
John Criswelld85e1a82005-05-12 21:25:32 +0000303Copyright (c) 2003, 2004, 2005 University of Illinois at Urbana-Champaign.
John Criswell50f289a2004-03-12 18:02:17 +0000304All rights reserved.
305
306Developed by:
307
308 LLVM Team
309
310 University of Illinois at Urbana-Champaign
311
312 http://llvm.cs.uiuc.edu
313
314THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
315IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
316FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
317CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
318LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
319OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE
320SOFTWARE.
321
John Criswell86a3a482003-12-18 16:43:17 +0000322Copyright (c) 1994
323Hewlett-Packard Company
324
325Permission to use, copy, modify, distribute and sell this software
326and its documentation for any purpose is hereby granted without fee,
327provided that the above copyright notice appear in all copies and
328that both that copyright notice and this permission notice appear
329in supporting documentation. Hewlett-Packard Company makes no
330representations about the suitability of this software for any
331purpose. It is provided "as is" without express or implied warranty.
332
333Copyright (c) 1996, 1997, 1998, 1999
334Silicon Graphics Computer Systems, Inc.
335
336Permission to use, copy, modify, distribute and sell this software
337and its documentation for any purpose is hereby granted without fee,
338provided that the above copyright notice appear in all copies and
339that both that copyright notice and this permission notice appear
340in supporting documentation. Silicon Graphics makes no
341representations about the suitability of this software for any
342purpose. It is provided "as is" without express or implied warranty.
343</pre>
344</div>
345
346<!-- *********************************************************************** -->
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000347
Misha Brukmanb7c3b6d2003-10-28 21:09:29 +0000348<hr>
Misha Brukman4478f2b2004-05-12 18:49:47 +0000349<address>
350 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
351 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
352 <a href="http://validator.w3.org/check/referer"><img
353 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
354
355 Brian Gaeke<br>
356 <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
Misha Brukmanb7c3b6d2003-10-28 21:09:29 +0000357 Last modified: $Date$
Misha Brukman4478f2b2004-05-12 18:49:47 +0000358</address>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000359
Misha Brukman0ccf5192003-10-23 01:48:33 +0000360</body>
361</html>