blob: 0622824956a9e8be16bfb056013c743b8f69960e [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>
Chris Lattnerc8118e12005-02-21 16:35:31 +000049 <li>you want to use the latest bits from CVS.</li>
Misha Brukmanb9e57892003-10-28 21:09:29 +000050</ol>
Brian Gaeke46079d22003-10-21 21:58:38 +000051
52<p>We welcome patches to help make this process simpler.</p>
Brian Gaeke7af03e92003-11-12 20:47:30 +000053</div>
Brian Gaeke46079d22003-10-21 21:58:38 +000054
Chris Lattner6a615ad2004-06-01 18:13:05 +000055<!--=========================================================================-->
56<div class="doc_subsection">
Misha Brukman62a93432004-06-18 15:54:54 +000057 <a name="cygwin">Building under Cygwin</a>
Chris Lattner6a615ad2004-06-01 18:13:05 +000058</div>
59<!--=========================================================================-->
60
61<div class="doc_text">
John Criswell9e2485c2004-12-10 15:51:16 +000062<p>If you are building LLVM and the GCC front-end under Cygwin, please note that
Chris Lattner6a615ad2004-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 Spencer24042362004-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 Criswelld0c4a762005-05-13 20:38:44 +000072installation includes GCC 3.3.3, we <i>strongly</i> recommend that you download
Reid Spencer24042362004-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 Spencer72a59002004-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 Brukman00b95c32005-03-01 17:19:21 +000079with</p>
Reid Spencer72a59002004-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 Brukman00b95c32005-03-01 17:19:21 +000083</div>
Chris Lattner6a615ad2004-06-01 18:13:05 +000084
Misha Brukman03ea9d42004-08-23 17:54:45 +000085<!--=========================================================================-->
Reid Spencere0a7ddd2004-12-31 19:48:59 +000086<div class="doc_subsection"><a name="aix">Building under AIX</a></div>
Misha Brukman03ea9d42004-08-23 17:54:45 +000087<div class="doc_text">
John Criswell9e2485c2004-12-10 15:51:16 +000088<p>If you are building LLVM and the GCC front-end under AIX, do NOT use GNU
Misha Brukman03ea9d42004-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 Brukman83bd33a2003-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 Gaeke46079d22003-10-21 21:58:38 +0000102<ol>
Reid Spencere0a7ddd2004-12-31 19:48:59 +0000103<li><p>Configure and build the LLVM libraries and tools. There are two ways to
John Criswelld0c4a762005-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 Spencere0a7ddd2004-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 Gaeke46079d22003-10-21 21:58:38 +0000114 % cd llvm
Reid Spencer0b4f4682004-12-01 05:15:44 +0000115 % ./configure --prefix=/some/path/you/can/install/to [options...]
Misha Brukmane7490532004-08-14 22:13:33 +0000116 % gmake tools-only
Reid Spencere0a7ddd2004-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 Spencer0b4f4682004-12-01 05:15:44 +0000124</li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000125
126<li><p>Add the directory containing the tools to your PATH.</p>
127<pre>
John Criswellc7f42642004-12-01 14:12:30 +0000128 % set path = ( `cd llvm/Debug/bin &amp;&amp; pwd` $path )
Misha Brukman83bd33a2003-10-23 01:48:33 +0000129</pre></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000130
Chris Lattnerb1241b02005-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 Gaeke46079d22003-10-21 21:58:38 +0000134
John Criswelld0c4a762005-05-13 20:38:44 +0000135<li><p>Make "build" and "install" directories as siblings of the "src" tree:</p>
Brian Gaeke46079d22003-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 Brukman83bd33a2003-10-23 01:48:33 +0000142</pre></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000143
Chris Lattner6a615ad2004-06-01 18:13:05 +0000144
John Criswell9e2485c2004-12-10 15:51:16 +0000145<li><p>Configure, build, and install the GCC front-end:</p>
John Criswell55072842003-12-08 19:59:14 +0000146
147<p>
Misha Brukman31b24322004-06-21 14:00:44 +0000148<b>Linux/x86:</b><br>
Misha Brukmana964fe52004-08-09 18:37:04 +0000149<b>MacOS X/PowerPC</b> (requires dlcompat library):<br>
150<b>AIX/PowerPC:</b>
John Criswell55072842003-12-08 19:59:14 +0000151</p>
152
Brian Gaeke46079d22003-10-21 21:58:38 +0000153<pre>
154 % cd build
Misha Brukmana964fe52004-08-09 18:37:04 +0000155 % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
Reid Spencer4ac306502004-12-22 06:40:29 +0000156 --disable-shared --enable-languages=c,c++ --program-prefix=llvm-
Brian Gaeke46079d22003-10-21 21:58:38 +0000157 % gmake all; gmake install
158</pre>
159
Misha Brukman62a93432004-06-18 15:54:54 +0000160<p><b>Cygwin/x86:</b></p>
Chris Lattner893c26a2004-06-02 19:27:50 +0000161
162<pre>
163 % cd build
Misha Brukmana964fe52004-08-09 18:37:04 +0000164 % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
Reid Spencer4ac306502004-12-22 06:40:29 +0000165 --disable-shared --enable-languages=c,c++ --disable-c-mbchar \
166 --program-prefix=llvm-
Chris Lattner893c26a2004-06-02 19:27:50 +0000167 % gmake all; gmake install
168</pre>
169
170<p><b>Solaris/SPARC:</b></p>
John Criswell55072842003-12-08 19:59:14 +0000171
172<p>
John Criswell6e35eda2004-11-29 21:46:29 +0000173For Solaris/SPARC, LLVM only supports the SPARC V9 architecture. Therefore,
174the configure command line should specify sparcv9, as shown below. Also,
Brian Gaeke7e9bd802004-01-28 20:54:41 +0000175note that Solaris has trouble with various wide (multibyte) character
176functions from C as referenced from C++, so we typically configure with
177--disable-c-mbchar (cf. <a href="http://llvm.cs.uiuc.edu/PR206">Bug 206</a>).
John Criswell55072842003-12-08 19:59:14 +0000178</p>
179
180<pre>
181 % cd build
Brian Gaeke7e9bd802004-01-28 20:54:41 +0000182 % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
183 --disable-shared --enable-languages=c,c++ --host=sparcv9-sun-solaris2.8 \
Reid Spencer4ac306502004-12-22 06:40:29 +0000184 --disable-c-mbchar --program-prefix=llvm-
Brian Gaeke7e9bd802004-01-28 20:54:41 +0000185 % gmake all; gmake install
John Criswell55072842003-12-08 19:59:14 +0000186</pre>
187
Chris Lattnere38c6282003-10-23 03:55:23 +0000188 <p><b>Common Problem:</b> You may get error messages regarding the fact
Brian Gaeke46079d22003-10-21 21:58:38 +0000189 that LLVM does not support inline assembly. Here are two common
190 fixes:</p>
191
192 <ul>
193 <li><p><b>Fix 1:</b> If you have system header files that include
194 inline assembly, you may have to modify them to remove the inline
John Criswell9e2485c2004-12-10 15:51:16 +0000195 assembly and install the modified versions in
Chris Lattner37874052004-10-06 03:13:47 +0000196 <code>$CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm/include</code>.</li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000197
198 <li><b>Fix 2:</b> If you are building the C++ front-end on a CPU we
199 haven't tried yet, you will probably have to edit the appropriate
200 version of atomicity.h under
201 <code>src/libstdc++-v3/config/cpu/<i>name-of-cpu</i>/atomicity.h</code>
Misha Brukman6a2b3102004-05-12 18:49:47 +0000202 and apply a patch so that it does not use inline assembly.</li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000203 </ul>
204
John Criswell9e2485c2004-12-10 15:51:16 +0000205 <p><b>Porting to a new architecture:</b> If you are porting the front-end
206 to a new architecture or compiling in a configuration that we have
207 not tried previously, there are probably several changes you will have to make
208 to the GCC target to get it to work correctly. These include:<p>
Brian Gaeke46079d22003-10-21 21:58:38 +0000209
210 <ul>
John Criswell6e35eda2004-11-29 21:46:29 +0000211 <li>Often targets include special assembler or linker flags which
Chris Lattnere38c6282003-10-23 03:55:23 +0000212 <tt>gccas</tt>/<tt>gccld</tt> does not understand. In general, these can
213 just be removed.</li>
214 <li>LLVM currently does not support any floating point values other than
215 32-bit and 64-bit IEEE floating point. The primary effect of this is
216 that you may have to map "long double" onto "double".</li>
217 <li>The profiling hooks in GCC do not apply at all to the LLVM front-end.
218 These may need to be disabled.</li>
219 <li>No inline assembly for position independent code. At the LLVM level,
220 everything is position independent.</li>
221 <li>We handle <tt>.init</tt> and <tt>.fini</tt> differently.</li>
Chris Lattner13964e02003-10-24 16:02:34 +0000222 <li>You may have to disable multilib support in your target. Using multilib
223 support causes the GCC compiler driver to add a lot of "<tt>-L</tt>"
224 options to the link line, which do not relate to LLVM and confuse
225 <tt>gccld</tt>. To disable multilibs, delete any
226 <tt>MULTILIB_OPTIONS</tt> lines from your target files.</li>
Chris Lattnere38c6282003-10-23 03:55:23 +0000227 <li>Did we mention that we don't support inline assembly? You'll probably
228 have to add some fixinclude hacks to disable it in the system
229 headers.</li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000230 </ul>
Misha Brukman83bd33a2003-10-23 01:48:33 +0000231</li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000232
Reid Spencer4ac306502004-12-22 06:40:29 +0000233<li><p>Put <tt>$CFEINSTALL/bin</tt> into your <tt>PATH</tt> environment
234variable.</p>
235 <ul>
236 <li>sh: <tt>export PATH=$CFEINSTALL/bin:$PATH</tt></li>
237 <li>csh: <tt>setenv PATH $CFEINSTALL/bin:$PATH</tt></li>
Reid Spencer4ac306502004-12-22 06:40:29 +0000238 </ul>
239</li>
240
Chris Lattner6a615ad2004-06-01 18:13:05 +0000241<li><p>Go back into the LLVM source tree proper. Rerun configure, using
Reid Spencer4ac306502004-12-22 06:40:29 +0000242the same options as the last time. This will cause the configuration to now find
243the newly built llvm-gcc and llvm-g++ executables. </p></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000244
Chris Lattner6a615ad2004-06-01 18:13:05 +0000245<li><p>Rebuild your CVS tree. This shouldn't cause the whole thing to be
246 rebuilt, but it should build the runtime libraries. After the tree is
John Criswell9e2485c2004-12-10 15:51:16 +0000247 built, install the runtime libraries into your GCC front-end build tree.
Misha Brukman98558ae2005-03-01 17:15:23 +0000248 These are the commands you need:</p>
Brian Gaeke46079d22003-10-21 21:58:38 +0000249<pre>
Chris Lattner6a615ad2004-06-01 18:13:05 +0000250 % gmake
Reid Spencer3149ba72004-12-04 08:13:20 +0000251 % gmake -C runtime install-bytecode
Misha Brukman83bd33a2003-10-23 01:48:33 +0000252</pre></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000253
Reid Spencerf99e59a2004-11-25 17:13:17 +0000254<li><p>Optionally, build a symbol table for the newly installed runtime
Reid Spencer4ac306502004-12-22 06:40:29 +0000255libraries. Although this step is optional, you are strongly encouraged to
256do this as the symbol tables will make a significant difference in your
257link times. Use the <tt>llvm-ranlib</tt> tool to do this, as follows:</p>
Reid Spencerf99e59a2004-11-25 17:13:17 +0000258<pre>
259 % cd $CFEINSTALL/lib
260 % llvm-ranlib libiberty.a
261 % llvm-ranlib libstdc++.a
Chris Lattner302ed2a2004-12-01 04:16:29 +0000262 % llvm-ranlib libsupc++.a
Reid Spencercfaf80c2004-12-22 16:19:05 +0000263 % cd $CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm
Reid Spencerf99e59a2004-11-25 17:13:17 +0000264 % llvm-ranlib libgcc.a
265 % llvm-ranlib libgcov.a
266</pre>
267
Brian Gaeke46079d22003-10-21 21:58:38 +0000268<li><p>Test the newly-installed C frontend by one or more of the
269following means:</p>
270 <ul>
Reid Spencer4ac306502004-12-22 06:40:29 +0000271 <li> running the feature &amp; regression tests via <tt>make check</tt></li>
Chris Lattnere38c6282003-10-23 03:55:23 +0000272 <li> compiling and running a "hello, LLVM" program in C and C++.</li>
John Criswell9e2485c2004-12-10 15:51:16 +0000273 <li> running the tests found in the <tt>llvm-test</tt> CVS module</li>
Misha Brukman6a2b3102004-05-12 18:49:47 +0000274 </ul></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000275</ol>
Misha Brukman83bd33a2003-10-23 01:48:33 +0000276</div>
Brian Gaeke46079d22003-10-21 21:58:38 +0000277
278<!-- *********************************************************************** -->
John Criswelld000e1d2003-12-18 16:43:17 +0000279<div class="doc_section">
280 <a name="license">License Information</a>
281</div>
282
283<div class="doc_text">
284<p>
285The LLVM GCC frontend is licensed to you under the GNU General Public License
286and the GNU Lesser General Public License. Please see the files COPYING and
287COPYING.LIB for more details.
288</p>
289
290<p>
291The software also has the following additional copyrights:
292</p>
293
294<pre>
John Criswelle3602102004-03-12 18:02:17 +0000295
John Criswellb0aad7a2005-05-12 21:25:32 +0000296Copyright (c) 2003, 2004, 2005 University of Illinois at Urbana-Champaign.
John Criswelle3602102004-03-12 18:02:17 +0000297All rights reserved.
298
299Developed by:
300
301 LLVM Team
302
303 University of Illinois at Urbana-Champaign
304
305 http://llvm.cs.uiuc.edu
306
307THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
308IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
309FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
310CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
311LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
312OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE
313SOFTWARE.
314
John Criswelld000e1d2003-12-18 16:43:17 +0000315Copyright (c) 1994
316Hewlett-Packard Company
317
318Permission to use, copy, modify, distribute and sell this software
319and its documentation for any purpose is hereby granted without fee,
320provided that the above copyright notice appear in all copies and
321that both that copyright notice and this permission notice appear
322in supporting documentation. Hewlett-Packard Company makes no
323representations about the suitability of this software for any
324purpose. It is provided "as is" without express or implied warranty.
325
326Copyright (c) 1996, 1997, 1998, 1999
327Silicon Graphics Computer Systems, Inc.
328
329Permission to use, copy, modify, distribute and sell this software
330and its documentation for any purpose is hereby granted without fee,
331provided that the above copyright notice appear in all copies and
332that both that copyright notice and this permission notice appear
333in supporting documentation. Silicon Graphics makes no
334representations about the suitability of this software for any
335purpose. It is provided "as is" without express or implied warranty.
336</pre>
337</div>
338
339<!-- *********************************************************************** -->
Brian Gaeke46079d22003-10-21 21:58:38 +0000340
Misha Brukmanb9e57892003-10-28 21:09:29 +0000341<hr>
Misha Brukman6a2b3102004-05-12 18:49:47 +0000342<address>
343 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
344 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
345 <a href="http://validator.w3.org/check/referer"><img
346 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
347
348 Brian Gaeke<br>
349 <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
Misha Brukmanb9e57892003-10-28 21:09:29 +0000350 Last modified: $Date$
Misha Brukman6a2b3102004-05-12 18:49:47 +0000351</address>
Brian Gaeke46079d22003-10-21 21:58:38 +0000352
Misha Brukman83bd33a2003-10-23 01:48:33 +0000353</body>
354</html>