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