Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / d4694f9cf573ad68bc31dfe3d1fdca20d42fce28 / . / docs / CFEBuildInstrs.html
blob: 68541ed2830148278495182d1dfb27eb7f162fc1 [file] [log] [blame]
Misha Brukman6a2b3102004-05-12 18:49:47 +0000[diff] [blame]1<!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 +0000[diff] [blame]3<html>
4<head>
Misha Brukman6a2b3102004-05-12 18:49:47 +0000[diff] [blame]5 <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 +0000[diff] [blame]7 <title>Bootstrapping the LLVM C/C++ Front-End</title>
Misha Brukman83bd33a2003-10-23 01:48:33 +0000[diff] [blame]8</head>
9<body>
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]10
Misha Brukman83bd33a2003-10-23 01:48:33 +0000[diff] [blame]11<div class="doc_title">
Misha Brukmanb9e57892003-10-28 21:09:29 +0000[diff] [blame]12 Bootstrapping the LLVM C/C++ Front-End
Misha Brukman83bd33a2003-10-23 01:48:33 +0000[diff] [blame]13</div>
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]14
Brian Gaeke7af03e92003-11-12 20:47:30 +0000[diff] [blame]15<ol>
16 <li><a href="#cautionarynote">A Cautionary Note</a>
Chris Lattner6a615ad2004-06-01 18:13:05 +0000[diff] [blame]17 <ul>
Misha Brukman62a93432004-06-18 15:54:54 +0000[diff] [blame]18 <li><a href="#cygwin">Building under Cygwin</a></li>
Misha Brukman03ea9d42004-08-23 17:54:45 +0000[diff] [blame]19 <li><a href="#aix">Building under AIX</a></li>
Chris Lattner6a615ad2004-06-01 18:13:05 +0000[diff] [blame]20 </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 +0000[diff] [blame]24</ol>
25
Chris Lattner7911ce22004-05-23 21:07:27 +0000[diff] [blame]26<div class="doc_author">
Chris Lattner6a615ad2004-06-01 18:13:05 +0000[diff] [blame]27 <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 +0000[diff] [blame]29</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 +0000[diff] [blame]42
43<p><b>NOTE:</b> This is currently a somewhat fragile, error-prone
Misha Brukmanb9e57892003-10-28 21:09:29 +0000[diff] [blame]44process, 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 +0000[diff] [blame]48 <li>you are an elite GCC hacker.</li>
49</ol>
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]50
51<p>We welcome patches to help make this process simpler.</p>
Brian Gaeke7af03e92003-11-12 20:47:30 +0000[diff] [blame]52</div>
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]53
Chris Lattner6a615ad2004-06-01 18:13:05 +0000[diff] [blame]54<!--=========================================================================-->
55<div class="doc_subsection">
Misha Brukman62a93432004-06-18 15:54:54 +0000[diff] [blame]56 <a name="cygwin">Building under Cygwin</a>
Chris Lattner6a615ad2004-06-01 18:13:05 +0000[diff] [blame]57</div>
58<!--=========================================================================-->
59
60<div class="doc_text">
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]61<p>If you are building LLVM and the GCC front-end under Cygwin, please note that
Chris Lattner6a615ad2004-06-01 18:13:05 +0000[diff] [blame]62the 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>
69</div>
70
Misha Brukman03ea9d42004-08-23 17:54:45 +0000[diff] [blame]71<!--=========================================================================-->
72<div class="doc_subsection">
73 <a name="aix">Building under AIX</a>
74</div>
75<!--=========================================================================-->
76
77<div class="doc_text">
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]78<p>If you are building LLVM and the GCC front-end under AIX, do NOT use GNU
Misha Brukman03ea9d42004-08-23 17:54:45 +0000[diff] [blame]79Binutils. They are not stable under AIX and may produce incorrect and/or
80invalid code. Instead, use the system assembler and linker.
81</p>
82</div>
83
Misha Brukman83bd33a2003-10-23 01:48:33 +0000[diff] [blame]84<!-- *********************************************************************** -->
85<div class="doc_section">
86 <a name="instructions">Instructions</a>
87</div>
88<!-- *********************************************************************** -->
89
90<div class="doc_text">
91<p>
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]92<ol>
93<li><p>Configure and build the LLVM libraries and tools using:</p>
94<pre>
95 % cd llvm
Reid Spencer0b4f4682004-12-01 05:15:44 +0000[diff] [blame]96 % ./configure --prefix=/some/path/you/can/install/to [options...]
Misha Brukmane7490532004-08-14 22:13:33 +0000[diff] [blame]97 % gmake tools-only
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]98</pre>
Reid Spencer0b4f4682004-12-01 05:15:44 +0000[diff] [blame]99 <p>This will build all of the LLVM tools and libraries. The <tt>--prefix</tt>
100 option defaults to /usr/local (per configure standards) but unless you are a
101 system administrator, you probably won't be able to install LLVM there because
102 of permissions. Specify a path into which LLVM can be installed (e.g.
103 <tt>--prefix=/home/user/llvm</tt>).</p>
104</li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]105
106<li><p>Add the directory containing the tools to your PATH.</p>
107<pre>
John Criswellc7f42642004-12-01 14:12:30 +0000[diff] [blame]108 % set path = ( `cd llvm/Debug/bin &amp;&amp; pwd` $path )
Misha Brukman83bd33a2003-10-23 01:48:33 +0000[diff] [blame]109</pre></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]110
Misha Brukman83bd33a2003-10-23 01:48:33 +0000[diff] [blame]111<li><p>Unpack the C/C++ front-end source into cfrontend/src.</p></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]112
Misha Brukmane7490532004-08-14 22:13:33 +0000[diff] [blame]113<li><p>Make "build" and "install" directories as siblings of the "src" tree.</p>
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]114<pre>
115 % pwd
116 /usr/local/example/cfrontend/src
117 % cd ..
118 % mkdir build install
119 % set CFEINSTALL = `pwd`/install
Misha Brukman83bd33a2003-10-23 01:48:33 +0000[diff] [blame]120</pre></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]121
Chris Lattner6a615ad2004-06-01 18:13:05 +0000[diff] [blame]122
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]123<li><p>Configure, build, and install the GCC front-end:</p>
John Criswell55072842003-12-08 19:59:14 +0000[diff] [blame]124
125<p>
Misha Brukman31b24322004-06-21 14:00:44 +0000[diff] [blame]126<b>Linux/x86:</b><br>
Misha Brukmana964fe52004-08-09 18:37:04 +0000[diff] [blame]127<b>MacOS X/PowerPC</b> (requires dlcompat library):<br>
128<b>AIX/PowerPC:</b>
John Criswell55072842003-12-08 19:59:14 +0000[diff] [blame]129</p>
130
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]131<pre>
132 % cd build
Misha Brukmana964fe52004-08-09 18:37:04 +0000[diff] [blame]133 % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
Reid Spencer77f55302004-12-22 01:36:27 +0000[diff] [blame]134 --disable-shared --enable-languages=c,c++
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]135 % gmake all; gmake install
136</pre>
137
Misha Brukman62a93432004-06-18 15:54:54 +0000[diff] [blame]138<p><b>Cygwin/x86:</b></p>
Chris Lattner893c26a2004-06-02 19:27:50 +0000[diff] [blame]139
140<pre>
141 % cd build
Misha Brukmana964fe52004-08-09 18:37:04 +0000[diff] [blame]142 % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
Reid Spencer77f55302004-12-22 01:36:27 +0000[diff] [blame]143 --disable-shared --enable-languages=c,c++ --disable-c-mbchar
Chris Lattner893c26a2004-06-02 19:27:50 +0000[diff] [blame]144 % gmake all; gmake install
145</pre>
146
147<p><b>Solaris/SPARC:</b></p>
John Criswell55072842003-12-08 19:59:14 +0000[diff] [blame]148
149<p>
John Criswell6e35eda2004-11-29 21:46:29 +0000[diff] [blame]150For Solaris/SPARC, LLVM only supports the SPARC V9 architecture. Therefore,
151the configure command line should specify sparcv9, as shown below. Also,
Brian Gaeke7e9bd802004-01-28 20:54:41 +0000[diff] [blame]152note that Solaris has trouble with various wide (multibyte) character
153functions from C as referenced from C++, so we typically configure with
154--disable-c-mbchar (cf. <a href="http://llvm.cs.uiuc.edu/PR206">Bug 206</a>).
John Criswell55072842003-12-08 19:59:14 +0000[diff] [blame]155</p>
156
157<pre>
158 % cd build
Brian Gaeke7e9bd802004-01-28 20:54:41 +0000[diff] [blame]159 % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
160 --disable-shared --enable-languages=c,c++ --host=sparcv9-sun-solaris2.8 \
Reid Spencer77f55302004-12-22 01:36:27 +0000[diff] [blame]161 --disable-c-mbchar
Brian Gaeke7e9bd802004-01-28 20:54:41 +0000[diff] [blame]162 % gmake all; gmake install
John Criswell55072842003-12-08 19:59:14 +0000[diff] [blame]163</pre>
164
Chris Lattnere38c6282003-10-23 03:55:23 +0000[diff] [blame]165 <p><b>Common Problem:</b> You may get error messages regarding the fact
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]166 that LLVM does not support inline assembly. Here are two common
167 fixes:</p>
168
169 <ul>
170 <li><p><b>Fix 1:</b> If you have system header files that include
171 inline assembly, you may have to modify them to remove the inline
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]172 assembly and install the modified versions in
Chris Lattner37874052004-10-06 03:13:47 +0000[diff] [blame]173 <code>$CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm/include</code>.</li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]174
175 <li><b>Fix 2:</b> If you are building the C++ front-end on a CPU we
176 haven't tried yet, you will probably have to edit the appropriate
177 version of atomicity.h under
178 <code>src/libstdc++-v3/config/cpu/<i>name-of-cpu</i>/atomicity.h</code>
Misha Brukman6a2b3102004-05-12 18:49:47 +0000[diff] [blame]179 and apply a patch so that it does not use inline assembly.</li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]180 </ul>
181
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]182 <p><b>Porting to a new architecture:</b> If you are porting the front-end
183 to a new architecture or compiling in a configuration that we have
184 not tried previously, there are probably several changes you will have to make
185 to the GCC target to get it to work correctly. These include:<p>
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]186
187 <ul>
John Criswell6e35eda2004-11-29 21:46:29 +0000[diff] [blame]188 <li>Often targets include special assembler or linker flags which
Chris Lattnere38c6282003-10-23 03:55:23 +0000[diff] [blame]189 <tt>gccas</tt>/<tt>gccld</tt> does not understand. In general, these can
190 just be removed.</li>
191 <li>LLVM currently does not support any floating point values other than
192 32-bit and 64-bit IEEE floating point. The primary effect of this is
193 that you may have to map "long double" onto "double".</li>
194 <li>The profiling hooks in GCC do not apply at all to the LLVM front-end.
195 These may need to be disabled.</li>
196 <li>No inline assembly for position independent code. At the LLVM level,
197 everything is position independent.</li>
198 <li>We handle <tt>.init</tt> and <tt>.fini</tt> differently.</li>
Chris Lattner13964e02003-10-24 16:02:34 +0000[diff] [blame]199 <li>You may have to disable multilib support in your target. Using multilib
200 support causes the GCC compiler driver to add a lot of "<tt>-L</tt>"
201 options to the link line, which do not relate to LLVM and confuse
202 <tt>gccld</tt>. To disable multilibs, delete any
203 <tt>MULTILIB_OPTIONS</tt> lines from your target files.</li>
Chris Lattnere38c6282003-10-23 03:55:23 +0000[diff] [blame]204 <li>Did we mention that we don't support inline assembly? You'll probably
205 have to add some fixinclude hacks to disable it in the system
206 headers.</li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]207 </ul>
Misha Brukman83bd33a2003-10-23 01:48:33 +0000[diff] [blame]208</li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]209
Chris Lattner6a615ad2004-06-01 18:13:05 +0000[diff] [blame]210<li><p>Go back into the LLVM source tree proper. Rerun configure, using
211the <code>--with-llvmgccdir=$CFEINSTALL</code> option to specify the path
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]212to the newly built GCC front-end.</p></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]213
214<li><p>If you edited header files during the C/C++ front-end build as
215described in "Fix 1" above, you must now copy those header files from
216<code>$CFEINSTALL/<i>target-triplet</i>/sys-include</code> to
217<code>$CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm/include</code>.
218(This should be the "include" directory in the same directory as the
219libgcc.a library, which you can find by running
Misha Brukman83bd33a2003-10-23 01:48:33 +0000[diff] [blame]220<code>$CFEINSTALL/bin/gcc --print-libgcc-file-name</code>.)</p></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]221
Chris Lattner6a615ad2004-06-01 18:13:05 +0000[diff] [blame]222<li><p>Rebuild your CVS tree. This shouldn't cause the whole thing to be
223 rebuilt, but it should build the runtime libraries. After the tree is
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]224 built, install the runtime libraries into your GCC front-end build tree.
Chris Lattner6a615ad2004-06-01 18:13:05 +0000[diff] [blame]225 These are the commands you need.</p>
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]226<pre>
Chris Lattner6a615ad2004-06-01 18:13:05 +0000[diff] [blame]227 % gmake
Reid Spencer201ddef2004-12-14 22:07:29 +0000[diff] [blame]228 % mkdir $CFEINSTALL/lib
Reid Spencer3149ba72004-12-04 08:13:20 +0000[diff] [blame]229 % gmake -C runtime install-bytecode
Misha Brukman83bd33a2003-10-23 01:48:33 +0000[diff] [blame]230</pre></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]231
Reid Spencerf99e59a2004-11-25 17:13:17 +0000[diff] [blame]232<li><p>Optionally, build a symbol table for the newly installed runtime
233libraries. Although this step is optional, you are encouraged to do this as the
234symbol tables will make a significant difference in your link times. Use
235the <tt>llvm-ranlib</tt> tool to do this, as follows:</p>
236<pre>
237 % cd $CFEINSTALL/lib
238 % llvm-ranlib libiberty.a
239 % llvm-ranlib libstdc++.a
Chris Lattner302ed2a2004-12-01 04:16:29 +0000[diff] [blame]240 % llvm-ranlib libsupc++.a
Reid Spencerf99e59a2004-11-25 17:13:17 +0000[diff] [blame]241 % cd $CFEINSTALL/lib/<i>target-triplet</i>/3.4-llvm
242 % llvm-ranlib libgcc.a
243 % llvm-ranlib libgcov.a
244</pre>
245
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]246<li><p>Test the newly-installed C frontend by one or more of the
247following means:</p>
248 <ul>
Chris Lattnere38c6282003-10-23 03:55:23 +0000[diff] [blame]249 <li> compiling and running a "hello, LLVM" program in C and C++.</li>
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]250 <li> running the regression tests in <tt>llvm/test</tt>
251 <li> running the tests found in the <tt>llvm-test</tt> CVS module</li>
Misha Brukman6a2b3102004-05-12 18:49:47 +0000[diff] [blame]252 </ul></li>
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]253</ol>
Misha Brukman83bd33a2003-10-23 01:48:33 +0000[diff] [blame]254</div>
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]255
256<!-- *********************************************************************** -->
John Criswelld000e1d2003-12-18 16:43:17 +0000[diff] [blame]257<div class="doc_section">
258 <a name="license">License Information</a>
259</div>
260
261<div class="doc_text">
262<p>
263The LLVM GCC frontend is licensed to you under the GNU General Public License
264and the GNU Lesser General Public License. Please see the files COPYING and
265COPYING.LIB for more details.
266</p>
267
268<p>
269The software also has the following additional copyrights:
270</p>
271
272<pre>
John Criswelle3602102004-03-12 18:02:17 +0000[diff] [blame]273
274Copyright (c) 2003, 2004 University of Illinois at Urbana-Champaign.
275All rights reserved.
276
277Developed by:
278
279 LLVM Team
280
281 University of Illinois at Urbana-Champaign
282
283 http://llvm.cs.uiuc.edu
284
285THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
286IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
287FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
288CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
289LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
290OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE
291SOFTWARE.
292
John Criswelld000e1d2003-12-18 16:43:17 +0000[diff] [blame]293Copyright (c) 1994
294Hewlett-Packard Company
295
296Permission to use, copy, modify, distribute and sell this software
297and its documentation for any purpose is hereby granted without fee,
298provided that the above copyright notice appear in all copies and
299that both that copyright notice and this permission notice appear
300in supporting documentation. Hewlett-Packard Company makes no
301representations about the suitability of this software for any
302purpose. It is provided "as is" without express or implied warranty.
303
304Copyright (c) 1996, 1997, 1998, 1999
305Silicon Graphics Computer Systems, Inc.
306
307Permission to use, copy, modify, distribute and sell this software
308and its documentation for any purpose is hereby granted without fee,
309provided that the above copyright notice appear in all copies and
310that both that copyright notice and this permission notice appear
311in supporting documentation. Silicon Graphics makes no
312representations about the suitability of this software for any
313purpose. It is provided "as is" without express or implied warranty.
314</pre>
315</div>
316
317<!-- *********************************************************************** -->
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]318
Misha Brukmanb9e57892003-10-28 21:09:29 +0000[diff] [blame]319<hr>
Misha Brukman6a2b3102004-05-12 18:49:47 +0000[diff] [blame]320<address>
321 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
322 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
323 <a href="http://validator.w3.org/check/referer"><img
324 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
325
326 Brian Gaeke<br>
327 <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
Misha Brukmanb9e57892003-10-28 21:09:29 +0000[diff] [blame]328 Last modified: $Date$
Misha Brukman6a2b3102004-05-12 18:49:47 +0000[diff] [blame]329</address>
Brian Gaeke46079d22003-10-21 21:58:38 +0000[diff] [blame]330
Misha Brukman83bd33a2003-10-23 01:48:33 +0000[diff] [blame]331</body>
332</html>