blob: f9f4bf29b5f9f0d019b5aac6ab9f3d5f03ab7a42 [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
72installation includes GCC 3.3.3 we <i>strongly</i> recommend that you download
73GCC 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
104do this: either with <i>objdir</i> == <i>srcdir</i> or not. It is recommended
105that <i>srcdir</i> not be the same as <i>objdir</i>:</p>
106<ul>
107 <li>With <i>objdir</i> != <i>srcdir</i>:<pre>
108 % cd <i>objdir</i>
109 % <i>srcdir</i>/configure --prefix=/some/path/you/can/install/to [options...]
110 % gmake tools-only
111 </pre></li>
112 <li>With <i>objdir</i> == <i>srcdir</i>:<pre>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000113 % cd llvm
Reid Spencerf6a10fa2004-12-01 05:15:44 +0000114 % ./configure --prefix=/some/path/you/can/install/to [options...]
Misha Brukman9b5bdf92004-08-14 22:13:33 +0000115 % gmake tools-only
Reid Spencercdf4d462004-12-31 19:48:59 +0000116 </pre></li>
117</ul>
118<p>This will build all of the LLVM tools and libraries. The <tt>--prefix</tt>
119option defaults to /usr/local (per configure standards) but unless you are a
120system administrator, you probably won't be able to install LLVM there because
121of permissions. Specify a path into which LLVM can be installed (e.g.
122<tt>--prefix=/home/user/llvm</tt>).</p>
Reid Spencerf6a10fa2004-12-01 05:15:44 +0000123</li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000124
125<li><p>Add the directory containing the tools to your PATH.</p>
126<pre>
John Criswell51f8ded2004-12-01 14:12:30 +0000127 % set path = ( `cd llvm/Debug/bin &amp;&amp; pwd` $path )
Misha Brukman0ccf5192003-10-23 01:48:33 +0000128</pre></li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000129
Chris Lattnerbebf14d2005-02-11 21:17:26 +0000130<li><p>Unpack the C/C++ front-end source into cfrontend/src, either by
131 untar'ing an llvm-gcc.tar.gz file or checking out CVS into this
132 directory.</p></li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000133
Misha Brukman9b5bdf92004-08-14 22:13:33 +0000134<li><p>Make "build" and "install" directories as siblings of the "src" tree.</p>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000135<pre>
136 % pwd
137 /usr/local/example/cfrontend/src
138 % cd ..
139 % mkdir build install
140 % set CFEINSTALL = `pwd`/install
Misha Brukman0ccf5192003-10-23 01:48:33 +0000141</pre></li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000142
Chris Lattnerbbdec032004-06-01 18:13:05 +0000143
John Criswelldfe6a862004-12-10 15:51:16 +0000144<li><p>Configure, build, and install the GCC front-end:</p>
John Criswellffc722a72003-12-08 19:59:14 +0000145
146<p>
Misha Brukmane54cbdd2004-06-21 14:00:44 +0000147<b>Linux/x86:</b><br>
Misha Brukman65c79252004-08-09 18:37:04 +0000148<b>MacOS X/PowerPC</b> (requires dlcompat library):<br>
149<b>AIX/PowerPC:</b>
John Criswellffc722a72003-12-08 19:59:14 +0000150</p>
151
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000152<pre>
153 % cd build
Misha Brukman65c79252004-08-09 18:37:04 +0000154 % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
Reid Spencerc659a4b2004-12-22 06:40:29 +0000155 --disable-shared --enable-languages=c,c++ --program-prefix=llvm-
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000156 % gmake all; gmake install
157</pre>
158
Misha Brukman35d842e2004-06-18 15:54:54 +0000159<p><b>Cygwin/x86:</b></p>
Chris Lattner8c85ec92004-06-02 19:27:50 +0000160
161<pre>
162 % cd build
Misha Brukman65c79252004-08-09 18:37:04 +0000163 % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
Reid Spencerc659a4b2004-12-22 06:40:29 +0000164 --disable-shared --enable-languages=c,c++ --disable-c-mbchar \
165 --program-prefix=llvm-
Chris Lattner8c85ec92004-06-02 19:27:50 +0000166 % gmake all; gmake install
167</pre>
168
169<p><b>Solaris/SPARC:</b></p>
John Criswellffc722a72003-12-08 19:59:14 +0000170
171<p>
John Criswellfc1a1dd2004-11-29 21:46:29 +0000172For Solaris/SPARC, LLVM only supports the SPARC V9 architecture. Therefore,
173the configure command line should specify sparcv9, as shown below. Also,
Brian Gaeke0119fba2004-01-28 20:54:41 +0000174note that Solaris has trouble with various wide (multibyte) character
175functions from C as referenced from C++, so we typically configure with
176--disable-c-mbchar (cf. <a href="http://llvm.cs.uiuc.edu/PR206">Bug 206</a>).
John Criswellffc722a72003-12-08 19:59:14 +0000177</p>
178
179<pre>
180 % cd build
Brian Gaeke0119fba2004-01-28 20:54:41 +0000181 % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
182 --disable-shared --enable-languages=c,c++ --host=sparcv9-sun-solaris2.8 \
Reid Spencerc659a4b2004-12-22 06:40:29 +0000183 --disable-c-mbchar --program-prefix=llvm-
Brian Gaeke0119fba2004-01-28 20:54:41 +0000184 % gmake all; gmake install
John Criswellffc722a72003-12-08 19:59:14 +0000185</pre>
186
Chris Lattnerf9b71182003-10-23 03:55:23 +0000187 <p><b>Common Problem:</b> You may get error messages regarding the fact
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000188 that LLVM does not support inline assembly. Here are two common
189 fixes:</p>
190
191 <ul>
192 <li><p><b>Fix 1:</b> If you have system header files that include
193 inline assembly, you may have to modify them to remove the inline
John Criswelldfe6a862004-12-10 15:51:16 +0000194 assembly and install the modified versions in
Chris Lattner18b88f72004-10-06 03:13:47 +0000195 <code>$CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm/include</code>.</li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000196
197 <li><b>Fix 2:</b> If you are building the C++ front-end on a CPU we
198 haven't tried yet, you will probably have to edit the appropriate
199 version of atomicity.h under
200 <code>src/libstdc++-v3/config/cpu/<i>name-of-cpu</i>/atomicity.h</code>
Misha Brukman4478f2b2004-05-12 18:49:47 +0000201 and apply a patch so that it does not use inline assembly.</li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000202 </ul>
203
John Criswelldfe6a862004-12-10 15:51:16 +0000204 <p><b>Porting to a new architecture:</b> If you are porting the front-end
205 to a new architecture or compiling in a configuration that we have
206 not tried previously, there are probably several changes you will have to make
207 to the GCC target to get it to work correctly. These include:<p>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000208
209 <ul>
John Criswellfc1a1dd2004-11-29 21:46:29 +0000210 <li>Often targets include special assembler or linker flags which
Chris Lattnerf9b71182003-10-23 03:55:23 +0000211 <tt>gccas</tt>/<tt>gccld</tt> does not understand. In general, these can
212 just be removed.</li>
213 <li>LLVM currently does not support any floating point values other than
214 32-bit and 64-bit IEEE floating point. The primary effect of this is
215 that you may have to map "long double" onto "double".</li>
216 <li>The profiling hooks in GCC do not apply at all to the LLVM front-end.
217 These may need to be disabled.</li>
218 <li>No inline assembly for position independent code. At the LLVM level,
219 everything is position independent.</li>
220 <li>We handle <tt>.init</tt> and <tt>.fini</tt> differently.</li>
Chris Lattnerd6f136c2003-10-24 16:02:34 +0000221 <li>You may have to disable multilib support in your target. Using multilib
222 support causes the GCC compiler driver to add a lot of "<tt>-L</tt>"
223 options to the link line, which do not relate to LLVM and confuse
224 <tt>gccld</tt>. To disable multilibs, delete any
225 <tt>MULTILIB_OPTIONS</tt> lines from your target files.</li>
Chris Lattnerf9b71182003-10-23 03:55:23 +0000226 <li>Did we mention that we don't support inline assembly? You'll probably
227 have to add some fixinclude hacks to disable it in the system
228 headers.</li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000229 </ul>
Misha Brukman0ccf5192003-10-23 01:48:33 +0000230</li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000231
Reid Spencerc659a4b2004-12-22 06:40:29 +0000232<li><p>Put <tt>$CFEINSTALL/bin</tt> into your <tt>PATH</tt> environment
233variable.</p>
234 <ul>
235 <li>sh: <tt>export PATH=$CFEINSTALL/bin:$PATH</tt></li>
236 <li>csh: <tt>setenv PATH $CFEINSTALL/bin:$PATH</tt></li>
Reid Spencerc659a4b2004-12-22 06:40:29 +0000237 </ul>
238</li>
239
Chris Lattnerbbdec032004-06-01 18:13:05 +0000240<li><p>Go back into the LLVM source tree proper. Rerun configure, using
Reid Spencerc659a4b2004-12-22 06:40:29 +0000241the same options as the last time. This will cause the configuration to now find
242the newly built llvm-gcc and llvm-g++ executables. </p></li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000243
Chris Lattnerbbdec032004-06-01 18:13:05 +0000244<li><p>Rebuild your CVS tree. This shouldn't cause the whole thing to be
245 rebuilt, but it should build the runtime libraries. After the tree is
John Criswelldfe6a862004-12-10 15:51:16 +0000246 built, install the runtime libraries into your GCC front-end build tree.
Misha Brukmana9b86762005-03-01 17:15:23 +0000247 These are the commands you need:</p>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000248<pre>
Chris Lattnerbbdec032004-06-01 18:13:05 +0000249 % gmake
Reid Spencer9cb0f702004-12-04 08:13:20 +0000250 % gmake -C runtime install-bytecode
Misha Brukman0ccf5192003-10-23 01:48:33 +0000251</pre></li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000252
Reid Spencer02c571b2004-11-25 17:13:17 +0000253<li><p>Optionally, build a symbol table for the newly installed runtime
Reid Spencerc659a4b2004-12-22 06:40:29 +0000254libraries. Although this step is optional, you are strongly encouraged to
255do this as the symbol tables will make a significant difference in your
256link times. Use the <tt>llvm-ranlib</tt> tool to do this, as follows:</p>
Reid Spencer02c571b2004-11-25 17:13:17 +0000257<pre>
258 % cd $CFEINSTALL/lib
259 % llvm-ranlib libiberty.a
260 % llvm-ranlib libstdc++.a
Chris Lattner2a2ebd12004-12-01 04:16:29 +0000261 % llvm-ranlib libsupc++.a
Reid Spencere0699f72004-12-22 16:19:05 +0000262 % cd $CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm
Reid Spencer02c571b2004-11-25 17:13:17 +0000263 % llvm-ranlib libgcc.a
264 % llvm-ranlib libgcov.a
265</pre>
266
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000267<li><p>Test the newly-installed C frontend by one or more of the
268following means:</p>
269 <ul>
Reid Spencerc659a4b2004-12-22 06:40:29 +0000270 <li> running the feature &amp; regression tests via <tt>make check</tt></li>
Chris Lattnerf9b71182003-10-23 03:55:23 +0000271 <li> compiling and running a "hello, LLVM" program in C and C++.</li>
John Criswelldfe6a862004-12-10 15:51:16 +0000272 <li> running the tests found in the <tt>llvm-test</tt> CVS module</li>
Misha Brukman4478f2b2004-05-12 18:49:47 +0000273 </ul></li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000274</ol>
Misha Brukman0ccf5192003-10-23 01:48:33 +0000275</div>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000276
277<!-- *********************************************************************** -->
John Criswell86a3a482003-12-18 16:43:17 +0000278<div class="doc_section">
279 <a name="license">License Information</a>
280</div>
281
282<div class="doc_text">
283<p>
284The LLVM GCC frontend is licensed to you under the GNU General Public License
285and the GNU Lesser General Public License. Please see the files COPYING and
286COPYING.LIB for more details.
287</p>
288
289<p>
290The software also has the following additional copyrights:
291</p>
292
293<pre>
John Criswell50f289a2004-03-12 18:02:17 +0000294
295Copyright (c) 2003, 2004 University of Illinois at Urbana-Champaign.
296All rights reserved.
297
298Developed by:
299
300 LLVM Team
301
302 University of Illinois at Urbana-Champaign
303
304 http://llvm.cs.uiuc.edu
305
306THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
307IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
308FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
309CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
310LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
311OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE
312SOFTWARE.
313
John Criswell86a3a482003-12-18 16:43:17 +0000314Copyright (c) 1994
315Hewlett-Packard Company
316
317Permission to use, copy, modify, distribute and sell this software
318and its documentation for any purpose is hereby granted without fee,
319provided that the above copyright notice appear in all copies and
320that both that copyright notice and this permission notice appear
321in supporting documentation. Hewlett-Packard Company makes no
322representations about the suitability of this software for any
323purpose. It is provided "as is" without express or implied warranty.
324
325Copyright (c) 1996, 1997, 1998, 1999
326Silicon Graphics Computer Systems, Inc.
327
328Permission to use, copy, modify, distribute and sell this software
329and its documentation for any purpose is hereby granted without fee,
330provided that the above copyright notice appear in all copies and
331that both that copyright notice and this permission notice appear
332in supporting documentation. Silicon Graphics makes no
333representations about the suitability of this software for any
334purpose. It is provided "as is" without express or implied warranty.
335</pre>
336</div>
337
338<!-- *********************************************************************** -->
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000339
Misha Brukmanb7c3b6d2003-10-28 21:09:29 +0000340<hr>
Misha Brukman4478f2b2004-05-12 18:49:47 +0000341<address>
342 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
343 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
344 <a href="http://validator.w3.org/check/referer"><img
345 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
346
347 Brian Gaeke<br>
348 <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
Misha Brukmanb7c3b6d2003-10-28 21:09:29 +0000349 Last modified: $Date$
Misha Brukman4478f2b2004-05-12 18:49:47 +0000350</address>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000351
Misha Brukman0ccf5192003-10-23 01:48:33 +0000352</body>
353</html>