blob: 86d239659de967d426903a690608e0a36c154bf9 [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>
Reid Spencer72a59002004-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 Lattner6a615ad2004-06-01 18:13:05 +000083
Misha Brukman03ea9d42004-08-23 17:54:45 +000084<!--=========================================================================-->
Reid Spencere0a7ddd2004-12-31 19:48:59 +000085<div class="doc_subsection"><a name="aix">Building under AIX</a></div>
Misha Brukman03ea9d42004-08-23 17:54:45 +000086<div class="doc_text">
John Criswell9e2485c2004-12-10 15:51:16 +000087<p>If you are building LLVM and the GCC front-end under AIX, do NOT use GNU
Misha Brukman03ea9d42004-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 Brukman83bd33a2003-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 Gaeke46079d22003-10-21 21:58:38 +0000101<ol>
Reid Spencere0a7ddd2004-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 Gaeke46079d22003-10-21 21:58:38 +0000112 % cd llvm
Reid Spencer0b4f4682004-12-01 05:15:44 +0000113 % ./configure --prefix=/some/path/you/can/install/to [options...]
Misha Brukmane7490532004-08-14 22:13:33 +0000114 % gmake tools-only
Reid Spencere0a7ddd2004-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 Spencer0b4f4682004-12-01 05:15:44 +0000122</li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000123
124<li><p>Add the directory containing the tools to your PATH.</p>
125<pre>
John Criswellc7f42642004-12-01 14:12:30 +0000126 % set path = ( `cd llvm/Debug/bin &amp;&amp; pwd` $path )
Misha Brukman83bd33a2003-10-23 01:48:33 +0000127</pre></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000128
Misha Brukman83bd33a2003-10-23 01:48:33 +0000129<li><p>Unpack the C/C++ front-end source into cfrontend/src.</p></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000130
Misha Brukmane7490532004-08-14 22:13:33 +0000131<li><p>Make "build" and "install" directories as siblings of the "src" tree.</p>
Brian Gaeke46079d22003-10-21 21:58:38 +0000132<pre>
133 % pwd
134 /usr/local/example/cfrontend/src
135 % cd ..
136 % mkdir build install
137 % set CFEINSTALL = `pwd`/install
Misha Brukman83bd33a2003-10-23 01:48:33 +0000138</pre></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000139
Chris Lattner6a615ad2004-06-01 18:13:05 +0000140
John Criswell9e2485c2004-12-10 15:51:16 +0000141<li><p>Configure, build, and install the GCC front-end:</p>
John Criswell55072842003-12-08 19:59:14 +0000142
143<p>
Misha Brukman31b24322004-06-21 14:00:44 +0000144<b>Linux/x86:</b><br>
Misha Brukmana964fe52004-08-09 18:37:04 +0000145<b>MacOS X/PowerPC</b> (requires dlcompat library):<br>
146<b>AIX/PowerPC:</b>
John Criswell55072842003-12-08 19:59:14 +0000147</p>
148
Brian Gaeke46079d22003-10-21 21:58:38 +0000149<pre>
150 % cd build
Misha Brukmana964fe52004-08-09 18:37:04 +0000151 % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
Reid Spencer4ac306502004-12-22 06:40:29 +0000152 --disable-shared --enable-languages=c,c++ --program-prefix=llvm-
Brian Gaeke46079d22003-10-21 21:58:38 +0000153 % gmake all; gmake install
154</pre>
155
Misha Brukman62a93432004-06-18 15:54:54 +0000156<p><b>Cygwin/x86:</b></p>
Chris Lattner893c26a2004-06-02 19:27:50 +0000157
158<pre>
159 % cd build
Misha Brukmana964fe52004-08-09 18:37:04 +0000160 % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
Reid Spencer4ac306502004-12-22 06:40:29 +0000161 --disable-shared --enable-languages=c,c++ --disable-c-mbchar \
162 --program-prefix=llvm-
Chris Lattner893c26a2004-06-02 19:27:50 +0000163 % gmake all; gmake install
164</pre>
165
166<p><b>Solaris/SPARC:</b></p>
John Criswell55072842003-12-08 19:59:14 +0000167
168<p>
John Criswell6e35eda2004-11-29 21:46:29 +0000169For Solaris/SPARC, LLVM only supports the SPARC V9 architecture. Therefore,
170the configure command line should specify sparcv9, as shown below. Also,
Brian Gaeke7e9bd802004-01-28 20:54:41 +0000171note that Solaris has trouble with various wide (multibyte) character
172functions from C as referenced from C++, so we typically configure with
173--disable-c-mbchar (cf. <a href="http://llvm.cs.uiuc.edu/PR206">Bug 206</a>).
John Criswell55072842003-12-08 19:59:14 +0000174</p>
175
176<pre>
177 % cd build
Brian Gaeke7e9bd802004-01-28 20:54:41 +0000178 % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
179 --disable-shared --enable-languages=c,c++ --host=sparcv9-sun-solaris2.8 \
Reid Spencer4ac306502004-12-22 06:40:29 +0000180 --disable-c-mbchar --program-prefix=llvm-
Brian Gaeke7e9bd802004-01-28 20:54:41 +0000181 % gmake all; gmake install
John Criswell55072842003-12-08 19:59:14 +0000182</pre>
183
Chris Lattnere38c6282003-10-23 03:55:23 +0000184 <p><b>Common Problem:</b> You may get error messages regarding the fact
Brian Gaeke46079d22003-10-21 21:58:38 +0000185 that LLVM does not support inline assembly. Here are two common
186 fixes:</p>
187
188 <ul>
189 <li><p><b>Fix 1:</b> If you have system header files that include
190 inline assembly, you may have to modify them to remove the inline
John Criswell9e2485c2004-12-10 15:51:16 +0000191 assembly and install the modified versions in
Chris Lattner37874052004-10-06 03:13:47 +0000192 <code>$CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm/include</code>.</li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000193
194 <li><b>Fix 2:</b> If you are building the C++ front-end on a CPU we
195 haven't tried yet, you will probably have to edit the appropriate
196 version of atomicity.h under
197 <code>src/libstdc++-v3/config/cpu/<i>name-of-cpu</i>/atomicity.h</code>
Misha Brukman6a2b3102004-05-12 18:49:47 +0000198 and apply a patch so that it does not use inline assembly.</li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000199 </ul>
200
John Criswell9e2485c2004-12-10 15:51:16 +0000201 <p><b>Porting to a new architecture:</b> If you are porting the front-end
202 to a new architecture or compiling in a configuration that we have
203 not tried previously, there are probably several changes you will have to make
204 to the GCC target to get it to work correctly. These include:<p>
Brian Gaeke46079d22003-10-21 21:58:38 +0000205
206 <ul>
John Criswell6e35eda2004-11-29 21:46:29 +0000207 <li>Often targets include special assembler or linker flags which
Chris Lattnere38c6282003-10-23 03:55:23 +0000208 <tt>gccas</tt>/<tt>gccld</tt> does not understand. In general, these can
209 just be removed.</li>
210 <li>LLVM currently does not support any floating point values other than
211 32-bit and 64-bit IEEE floating point. The primary effect of this is
212 that you may have to map "long double" onto "double".</li>
213 <li>The profiling hooks in GCC do not apply at all to the LLVM front-end.
214 These may need to be disabled.</li>
215 <li>No inline assembly for position independent code. At the LLVM level,
216 everything is position independent.</li>
217 <li>We handle <tt>.init</tt> and <tt>.fini</tt> differently.</li>
Chris Lattner13964e02003-10-24 16:02:34 +0000218 <li>You may have to disable multilib support in your target. Using multilib
219 support causes the GCC compiler driver to add a lot of "<tt>-L</tt>"
220 options to the link line, which do not relate to LLVM and confuse
221 <tt>gccld</tt>. To disable multilibs, delete any
222 <tt>MULTILIB_OPTIONS</tt> lines from your target files.</li>
Chris Lattnere38c6282003-10-23 03:55:23 +0000223 <li>Did we mention that we don't support inline assembly? You'll probably
224 have to add some fixinclude hacks to disable it in the system
225 headers.</li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000226 </ul>
Misha Brukman83bd33a2003-10-23 01:48:33 +0000227</li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000228
Reid Spencer4ac306502004-12-22 06:40:29 +0000229<li><p>Put <tt>$CFEINSTALL/bin</tt> into your <tt>PATH</tt> environment
230variable.</p>
231 <ul>
232 <li>sh: <tt>export PATH=$CFEINSTALL/bin:$PATH</tt></li>
233 <li>csh: <tt>setenv PATH $CFEINSTALL/bin:$PATH</tt></li>
Reid Spencer4ac306502004-12-22 06:40:29 +0000234 </ul>
235</li>
236
Chris Lattner6a615ad2004-06-01 18:13:05 +0000237<li><p>Go back into the LLVM source tree proper. Rerun configure, using
Reid Spencer4ac306502004-12-22 06:40:29 +0000238the same options as the last time. This will cause the configuration to now find
239the newly built llvm-gcc and llvm-g++ executables. </p></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000240
Chris Lattner6a615ad2004-06-01 18:13:05 +0000241<li><p>Rebuild your CVS tree. This shouldn't cause the whole thing to be
242 rebuilt, but it should build the runtime libraries. After the tree is
John Criswell9e2485c2004-12-10 15:51:16 +0000243 built, install the runtime libraries into your GCC front-end build tree.
Chris Lattner6a615ad2004-06-01 18:13:05 +0000244 These are the commands you need.</p>
Brian Gaeke46079d22003-10-21 21:58:38 +0000245<pre>
Chris Lattner6a615ad2004-06-01 18:13:05 +0000246 % gmake
Reid Spencer3149ba72004-12-04 08:13:20 +0000247 % gmake -C runtime install-bytecode
Misha Brukman83bd33a2003-10-23 01:48:33 +0000248</pre></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000249
Reid Spencerf99e59a2004-11-25 17:13:17 +0000250<li><p>Optionally, build a symbol table for the newly installed runtime
Reid Spencer4ac306502004-12-22 06:40:29 +0000251libraries. Although this step is optional, you are strongly encouraged to
252do this as the symbol tables will make a significant difference in your
253link times. Use the <tt>llvm-ranlib</tt> tool to do this, as follows:</p>
Reid Spencerf99e59a2004-11-25 17:13:17 +0000254<pre>
255 % cd $CFEINSTALL/lib
256 % llvm-ranlib libiberty.a
257 % llvm-ranlib libstdc++.a
Chris Lattner302ed2a2004-12-01 04:16:29 +0000258 % llvm-ranlib libsupc++.a
Reid Spencercfaf80c2004-12-22 16:19:05 +0000259 % cd $CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm
Reid Spencerf99e59a2004-11-25 17:13:17 +0000260 % llvm-ranlib libgcc.a
261 % llvm-ranlib libgcov.a
262</pre>
263
Brian Gaeke46079d22003-10-21 21:58:38 +0000264<li><p>Test the newly-installed C frontend by one or more of the
265following means:</p>
266 <ul>
Reid Spencer4ac306502004-12-22 06:40:29 +0000267 <li> running the feature &amp; regression tests via <tt>make check</tt></li>
Chris Lattnere38c6282003-10-23 03:55:23 +0000268 <li> compiling and running a "hello, LLVM" program in C and C++.</li>
John Criswell9e2485c2004-12-10 15:51:16 +0000269 <li> running the tests found in the <tt>llvm-test</tt> CVS module</li>
Misha Brukman6a2b3102004-05-12 18:49:47 +0000270 </ul></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000271</ol>
Misha Brukman83bd33a2003-10-23 01:48:33 +0000272</div>
Brian Gaeke46079d22003-10-21 21:58:38 +0000273
274<!-- *********************************************************************** -->
John Criswelld000e1d2003-12-18 16:43:17 +0000275<div class="doc_section">
276 <a name="license">License Information</a>
277</div>
278
279<div class="doc_text">
280<p>
281The LLVM GCC frontend is licensed to you under the GNU General Public License
282and the GNU Lesser General Public License. Please see the files COPYING and
283COPYING.LIB for more details.
284</p>
285
286<p>
287The software also has the following additional copyrights:
288</p>
289
290<pre>
John Criswelle3602102004-03-12 18:02:17 +0000291
292Copyright (c) 2003, 2004 University of Illinois at Urbana-Champaign.
293All rights reserved.
294
295Developed by:
296
297 LLVM Team
298
299 University of Illinois at Urbana-Champaign
300
301 http://llvm.cs.uiuc.edu
302
303THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
304IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
305FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
306CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
307LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
308OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE
309SOFTWARE.
310
John Criswelld000e1d2003-12-18 16:43:17 +0000311Copyright (c) 1994
312Hewlett-Packard Company
313
314Permission to use, copy, modify, distribute and sell this software
315and its documentation for any purpose is hereby granted without fee,
316provided that the above copyright notice appear in all copies and
317that both that copyright notice and this permission notice appear
318in supporting documentation. Hewlett-Packard Company makes no
319representations about the suitability of this software for any
320purpose. It is provided "as is" without express or implied warranty.
321
322Copyright (c) 1996, 1997, 1998, 1999
323Silicon Graphics Computer Systems, Inc.
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. Silicon Graphics makes no
330representations about the suitability of this software for any
331purpose. It is provided "as is" without express or implied warranty.
332</pre>
333</div>
334
335<!-- *********************************************************************** -->
Brian Gaeke46079d22003-10-21 21:58:38 +0000336
Misha Brukmanb9e57892003-10-28 21:09:29 +0000337<hr>
Misha Brukman6a2b3102004-05-12 18:49:47 +0000338<address>
339 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
340 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
341 <a href="http://validator.w3.org/check/referer"><img
342 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
343
344 Brian Gaeke<br>
345 <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
Misha Brukmanb9e57892003-10-28 21:09:29 +0000346 Last modified: $Date$
Misha Brukman6a2b3102004-05-12 18:49:47 +0000347</address>
Brian Gaeke46079d22003-10-21 21:58:38 +0000348
Misha Brukman83bd33a2003-10-23 01:48:33 +0000349</body>
350</html>