blob: eb7a318775d6ff54bc789c96174500a2def4300e [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>
49</ol>
Brian Gaeke0142c1e2003-10-21 21:58:38 +000050
51<p>We welcome patches to help make this process simpler.</p>
Brian Gaekee6406a82003-11-12 20:47:30 +000052</div>
Brian Gaeke0142c1e2003-10-21 21:58:38 +000053
Chris Lattnerbbdec032004-06-01 18:13:05 +000054<!--=========================================================================-->
55<div class="doc_subsection">
Misha Brukman35d842e2004-06-18 15:54:54 +000056 <a name="cygwin">Building under Cygwin</a>
Chris Lattnerbbdec032004-06-01 18:13:05 +000057</div>
58<!--=========================================================================-->
59
60<div class="doc_text">
John Criswelldfe6a862004-12-10 15:51:16 +000061<p>If you are building LLVM and the GCC front-end under Cygwin, please note that
Chris Lattnerbbdec032004-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 Spencer3e41cd52004-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>
Reid Spencer1097f7d2004-12-23 19:49:54 +000074<p>Some versions of Cygwin utilize an experimental version of GNU binutils that
75will cause the GNU <tt>ld</tt> linker to fail an assertion when linking
76components of the libstdc++. It is recommended that you replace the entire
77binutils package with version 2.15 such that "<tt>ld --version</tt>" responds
78with<br/>
79<pre>GNU ld version 2.15</pre>
80not with:<br/>
81<pre>GNU ld version 2.15.91 20040725</pre>
82</p></div>
Chris Lattnerbbdec032004-06-01 18:13:05 +000083
Misha Brukman39efd012004-08-23 17:54:45 +000084<!--=========================================================================-->
Reid Spencercdf4d462004-12-31 19:48:59 +000085<div class="doc_subsection"><a name="aix">Building under AIX</a></div>
Misha Brukman39efd012004-08-23 17:54:45 +000086<div class="doc_text">
John Criswelldfe6a862004-12-10 15:51:16 +000087<p>If you are building LLVM and the GCC front-end under AIX, do NOT use GNU
Misha Brukman39efd012004-08-23 17:54:45 +000088Binutils. They are not stable under AIX and may produce incorrect and/or
89invalid code. Instead, use the system assembler and linker.
90</p>
91</div>
92
Misha Brukman0ccf5192003-10-23 01:48:33 +000093<!-- *********************************************************************** -->
94<div class="doc_section">
95 <a name="instructions">Instructions</a>
96</div>
97<!-- *********************************************************************** -->
98
99<div class="doc_text">
100<p>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000101<ol>
Reid Spencercdf4d462004-12-31 19:48:59 +0000102<li><p>Configure and build the LLVM libraries and tools. There are two ways to
103do this: either with <i>objdir</i> == <i>srcdir</i> or not. It is recommended
104that <i>srcdir</i> not be the same as <i>objdir</i>:</p>
105<ul>
106 <li>With <i>objdir</i> != <i>srcdir</i>:<pre>
107 % cd <i>objdir</i>
108 % <i>srcdir</i>/configure --prefix=/some/path/you/can/install/to [options...]
109 % gmake tools-only
110 </pre></li>
111 <li>With <i>objdir</i> == <i>srcdir</i>:<pre>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000112 % cd llvm
Reid Spencerf6a10fa2004-12-01 05:15:44 +0000113 % ./configure --prefix=/some/path/you/can/install/to [options...]
Misha Brukman9b5bdf92004-08-14 22:13:33 +0000114 % gmake tools-only
Reid Spencercdf4d462004-12-31 19:48:59 +0000115 </pre></li>
116</ul>
117<p>This will build all of the LLVM tools and libraries. The <tt>--prefix</tt>
118option defaults to /usr/local (per configure standards) but unless you are a
119system administrator, you probably won't be able to install LLVM there because
120of permissions. Specify a path into which LLVM can be installed (e.g.
121<tt>--prefix=/home/user/llvm</tt>).</p>
Reid Spencerf6a10fa2004-12-01 05:15:44 +0000122</li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000123
124<li><p>Add the directory containing the tools to your PATH.</p>
125<pre>
John Criswell51f8ded2004-12-01 14:12:30 +0000126 % set path = ( `cd llvm/Debug/bin &amp;&amp; pwd` $path )
Misha Brukman0ccf5192003-10-23 01:48:33 +0000127</pre></li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000128
Chris Lattnerbebf14d2005-02-11 21:17:26 +0000129<li><p>Unpack the C/C++ front-end source into cfrontend/src, either by
130 untar'ing an llvm-gcc.tar.gz file or checking out CVS into this
131 directory.</p></li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000132
Misha Brukman9b5bdf92004-08-14 22:13:33 +0000133<li><p>Make "build" and "install" directories as siblings of the "src" tree.</p>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000134<pre>
135 % pwd
136 /usr/local/example/cfrontend/src
137 % cd ..
138 % mkdir build install
139 % set CFEINSTALL = `pwd`/install
Misha Brukman0ccf5192003-10-23 01:48:33 +0000140</pre></li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000141
Chris Lattnerbbdec032004-06-01 18:13:05 +0000142
John Criswelldfe6a862004-12-10 15:51:16 +0000143<li><p>Configure, build, and install the GCC front-end:</p>
John Criswellffc722a72003-12-08 19:59:14 +0000144
145<p>
Misha Brukmane54cbdd2004-06-21 14:00:44 +0000146<b>Linux/x86:</b><br>
Misha Brukman65c79252004-08-09 18:37:04 +0000147<b>MacOS X/PowerPC</b> (requires dlcompat library):<br>
148<b>AIX/PowerPC:</b>
John Criswellffc722a72003-12-08 19:59:14 +0000149</p>
150
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000151<pre>
152 % cd build
Misha Brukman65c79252004-08-09 18:37:04 +0000153 % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
Reid Spencerc659a4b2004-12-22 06:40:29 +0000154 --disable-shared --enable-languages=c,c++ --program-prefix=llvm-
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000155 % gmake all; gmake install
156</pre>
157
Misha Brukman35d842e2004-06-18 15:54:54 +0000158<p><b>Cygwin/x86:</b></p>
Chris Lattner8c85ec92004-06-02 19:27:50 +0000159
160<pre>
161 % cd build
Misha Brukman65c79252004-08-09 18:37:04 +0000162 % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
Reid Spencerc659a4b2004-12-22 06:40:29 +0000163 --disable-shared --enable-languages=c,c++ --disable-c-mbchar \
164 --program-prefix=llvm-
Chris Lattner8c85ec92004-06-02 19:27:50 +0000165 % gmake all; gmake install
166</pre>
167
168<p><b>Solaris/SPARC:</b></p>
John Criswellffc722a72003-12-08 19:59:14 +0000169
170<p>
John Criswellfc1a1dd2004-11-29 21:46:29 +0000171For Solaris/SPARC, LLVM only supports the SPARC V9 architecture. Therefore,
172the configure command line should specify sparcv9, as shown below. Also,
Brian Gaeke0119fba2004-01-28 20:54:41 +0000173note that Solaris has trouble with various wide (multibyte) character
174functions from C as referenced from C++, so we typically configure with
175--disable-c-mbchar (cf. <a href="http://llvm.cs.uiuc.edu/PR206">Bug 206</a>).
John Criswellffc722a72003-12-08 19:59:14 +0000176</p>
177
178<pre>
179 % cd build
Brian Gaeke0119fba2004-01-28 20:54:41 +0000180 % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
181 --disable-shared --enable-languages=c,c++ --host=sparcv9-sun-solaris2.8 \
Reid Spencerc659a4b2004-12-22 06:40:29 +0000182 --disable-c-mbchar --program-prefix=llvm-
Brian Gaeke0119fba2004-01-28 20:54:41 +0000183 % gmake all; gmake install
John Criswellffc722a72003-12-08 19:59:14 +0000184</pre>
185
Chris Lattnerf9b71182003-10-23 03:55:23 +0000186 <p><b>Common Problem:</b> You may get error messages regarding the fact
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000187 that LLVM does not support inline assembly. Here are two common
188 fixes:</p>
189
190 <ul>
191 <li><p><b>Fix 1:</b> If you have system header files that include
192 inline assembly, you may have to modify them to remove the inline
John Criswelldfe6a862004-12-10 15:51:16 +0000193 assembly and install the modified versions in
Chris Lattner18b88f72004-10-06 03:13:47 +0000194 <code>$CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm/include</code>.</li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000195
196 <li><b>Fix 2:</b> If you are building the C++ front-end on a CPU we
197 haven't tried yet, you will probably have to edit the appropriate
198 version of atomicity.h under
199 <code>src/libstdc++-v3/config/cpu/<i>name-of-cpu</i>/atomicity.h</code>
Misha Brukman4478f2b2004-05-12 18:49:47 +0000200 and apply a patch so that it does not use inline assembly.</li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000201 </ul>
202
John Criswelldfe6a862004-12-10 15:51:16 +0000203 <p><b>Porting to a new architecture:</b> If you are porting the front-end
204 to a new architecture or compiling in a configuration that we have
205 not tried previously, there are probably several changes you will have to make
206 to the GCC target to get it to work correctly. These include:<p>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000207
208 <ul>
John Criswellfc1a1dd2004-11-29 21:46:29 +0000209 <li>Often targets include special assembler or linker flags which
Chris Lattnerf9b71182003-10-23 03:55:23 +0000210 <tt>gccas</tt>/<tt>gccld</tt> does not understand. In general, these can
211 just be removed.</li>
212 <li>LLVM currently does not support any floating point values other than
213 32-bit and 64-bit IEEE floating point. The primary effect of this is
214 that you may have to map "long double" onto "double".</li>
215 <li>The profiling hooks in GCC do not apply at all to the LLVM front-end.
216 These may need to be disabled.</li>
217 <li>No inline assembly for position independent code. At the LLVM level,
218 everything is position independent.</li>
219 <li>We handle <tt>.init</tt> and <tt>.fini</tt> differently.</li>
Chris Lattnerd6f136c2003-10-24 16:02:34 +0000220 <li>You may have to disable multilib support in your target. Using multilib
221 support causes the GCC compiler driver to add a lot of "<tt>-L</tt>"
222 options to the link line, which do not relate to LLVM and confuse
223 <tt>gccld</tt>. To disable multilibs, delete any
224 <tt>MULTILIB_OPTIONS</tt> lines from your target files.</li>
Chris Lattnerf9b71182003-10-23 03:55:23 +0000225 <li>Did we mention that we don't support inline assembly? You'll probably
226 have to add some fixinclude hacks to disable it in the system
227 headers.</li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000228 </ul>
Misha Brukman0ccf5192003-10-23 01:48:33 +0000229</li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000230
Reid Spencerc659a4b2004-12-22 06:40:29 +0000231<li><p>Put <tt>$CFEINSTALL/bin</tt> into your <tt>PATH</tt> environment
232variable.</p>
233 <ul>
234 <li>sh: <tt>export PATH=$CFEINSTALL/bin:$PATH</tt></li>
235 <li>csh: <tt>setenv PATH $CFEINSTALL/bin:$PATH</tt></li>
Reid Spencerc659a4b2004-12-22 06:40:29 +0000236 </ul>
237</li>
238
Chris Lattnerbbdec032004-06-01 18:13:05 +0000239<li><p>Go back into the LLVM source tree proper. Rerun configure, using
Reid Spencerc659a4b2004-12-22 06:40:29 +0000240the same options as the last time. This will cause the configuration to now find
241the newly built llvm-gcc and llvm-g++ executables. </p></li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000242
Chris Lattnerbbdec032004-06-01 18:13:05 +0000243<li><p>Rebuild your CVS tree. This shouldn't cause the whole thing to be
244 rebuilt, but it should build the runtime libraries. After the tree is
John Criswelldfe6a862004-12-10 15:51:16 +0000245 built, install the runtime libraries into your GCC front-end build tree.
Chris Lattnerbbdec032004-06-01 18:13:05 +0000246 These are the commands you need.</p>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000247<pre>
Chris Lattnerbbdec032004-06-01 18:13:05 +0000248 % gmake
Reid Spencer9cb0f702004-12-04 08:13:20 +0000249 % gmake -C runtime install-bytecode
Misha Brukman0ccf5192003-10-23 01:48:33 +0000250</pre></li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000251
Reid Spencer02c571b2004-11-25 17:13:17 +0000252<li><p>Optionally, build a symbol table for the newly installed runtime
Reid Spencerc659a4b2004-12-22 06:40:29 +0000253libraries. Although this step is optional, you are strongly encouraged to
254do this as the symbol tables will make a significant difference in your
255link times. Use the <tt>llvm-ranlib</tt> tool to do this, as follows:</p>
Reid Spencer02c571b2004-11-25 17:13:17 +0000256<pre>
257 % cd $CFEINSTALL/lib
258 % llvm-ranlib libiberty.a
259 % llvm-ranlib libstdc++.a
Chris Lattner2a2ebd12004-12-01 04:16:29 +0000260 % llvm-ranlib libsupc++.a
Reid Spencere0699f72004-12-22 16:19:05 +0000261 % cd $CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm
Reid Spencer02c571b2004-11-25 17:13:17 +0000262 % llvm-ranlib libgcc.a
263 % llvm-ranlib libgcov.a
264</pre>
265
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000266<li><p>Test the newly-installed C frontend by one or more of the
267following means:</p>
268 <ul>
Reid Spencerc659a4b2004-12-22 06:40:29 +0000269 <li> running the feature &amp; regression tests via <tt>make check</tt></li>
Chris Lattnerf9b71182003-10-23 03:55:23 +0000270 <li> compiling and running a "hello, LLVM" program in C and C++.</li>
John Criswelldfe6a862004-12-10 15:51:16 +0000271 <li> running the tests found in the <tt>llvm-test</tt> CVS module</li>
Misha Brukman4478f2b2004-05-12 18:49:47 +0000272 </ul></li>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000273</ol>
Misha Brukman0ccf5192003-10-23 01:48:33 +0000274</div>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000275
276<!-- *********************************************************************** -->
John Criswell86a3a482003-12-18 16:43:17 +0000277<div class="doc_section">
278 <a name="license">License Information</a>
279</div>
280
281<div class="doc_text">
282<p>
283The LLVM GCC frontend is licensed to you under the GNU General Public License
284and the GNU Lesser General Public License. Please see the files COPYING and
285COPYING.LIB for more details.
286</p>
287
288<p>
289The software also has the following additional copyrights:
290</p>
291
292<pre>
John Criswell50f289a2004-03-12 18:02:17 +0000293
294Copyright (c) 2003, 2004 University of Illinois at Urbana-Champaign.
295All rights reserved.
296
297Developed by:
298
299 LLVM Team
300
301 University of Illinois at Urbana-Champaign
302
303 http://llvm.cs.uiuc.edu
304
305THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
306IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
307FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
308CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
309LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
310OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE
311SOFTWARE.
312
John Criswell86a3a482003-12-18 16:43:17 +0000313Copyright (c) 1994
314Hewlett-Packard Company
315
316Permission to use, copy, modify, distribute and sell this software
317and its documentation for any purpose is hereby granted without fee,
318provided that the above copyright notice appear in all copies and
319that both that copyright notice and this permission notice appear
320in supporting documentation. Hewlett-Packard Company makes no
321representations about the suitability of this software for any
322purpose. It is provided "as is" without express or implied warranty.
323
324Copyright (c) 1996, 1997, 1998, 1999
325Silicon Graphics Computer Systems, Inc.
326
327Permission to use, copy, modify, distribute and sell this software
328and its documentation for any purpose is hereby granted without fee,
329provided that the above copyright notice appear in all copies and
330that both that copyright notice and this permission notice appear
331in supporting documentation. Silicon Graphics makes no
332representations about the suitability of this software for any
333purpose. It is provided "as is" without express or implied warranty.
334</pre>
335</div>
336
337<!-- *********************************************************************** -->
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000338
Misha Brukmanb7c3b6d2003-10-28 21:09:29 +0000339<hr>
Misha Brukman4478f2b2004-05-12 18:49:47 +0000340<address>
341 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
342 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
343 <a href="http://validator.w3.org/check/referer"><img
344 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
345
346 Brian Gaeke<br>
347 <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
Misha Brukmanb7c3b6d2003-10-28 21:09:29 +0000348 Last modified: $Date$
Misha Brukman4478f2b2004-05-12 18:49:47 +0000349</address>
Brian Gaeke0142c1e2003-10-21 21:58:38 +0000350
Misha Brukman0ccf5192003-10-23 01:48:33 +0000351</body>
352</html>