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