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