Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / dc87c86efbf6b7473c2f1771383dba2011bb33eb / . / docs / GCCFEBuildInstrs.html
blob: b675ee76a7cb7f675eece4b5f7866381947734bf [file] [log] [blame]
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
6 <link rel="stylesheet" href="llvm.css" type="text/css" media="screen">
7 <title>Building the LLVM GCC Front-End</title>
8</head>
9<body>
10
11<div class="doc_title">
12 Building the LLVM GCC Front-End
13</div>
14
15<ol>
16 <li><a href="#instructions">Building llvm-gcc from Source</a></li>
Misha Brukmanee4a1a62008-12-29 21:33:30 +0000[diff] [blame]17 <li><a href="#ada">Building the Ada front-end</a></li>
18 <li><a href="#fortran">Building the Fortran front-end</a></li>
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]19 <li><a href="#license">License Information</a></li>
20</ol>
21
22<div class="doc_author">
23 <p>Written by the LLVM Team</p>
24</div>
25
26<!-- *********************************************************************** -->
Misha Brukmanee4a1a62008-12-29 21:33:30 +0000[diff] [blame]27<h1><a name="instructions">Building llvm-gcc from Source</a></h1>
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]28<!-- *********************************************************************** -->
29
30<div class="doc_text">
31
Duncan Sands701f2832008-06-09 20:24:05 +0000[diff] [blame]32<p>This section describes how to acquire and build llvm-gcc 4.2, which is based
33on the GCC 4.2.1 front-end. Supported languages are Ada, C, C++, Fortran,
34Objective-C and Objective-C++. Note that the instructions for building these
35front-ends are completely different (and much easier!) than those for building
36llvm-gcc3 in the past.</p>
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]37
38<ol>
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]39 <li><p>Retrieve the appropriate llvm-gcc-4.2-<i>version</i>.source.tar.gz
40 archive from the <a href="http://llvm.org/releases/">LLVM web
41 site</a>.</p>
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]42
43 <p>It is also possible to download the sources of the llvm-gcc front end
Duncan Sands701f2832008-06-09 20:24:05 +0000[diff] [blame]44 from a read-only mirror using subversion. To check out the 4.2 code
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]45 for first time use:</p>
46
47<div class="doc_code">
48<pre>
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]49svn co http://llvm.org/svn/llvm-project/llvm-gcc-4.2/trunk <i>dst-directory</i>
50</pre>
51</div>
52
53 <p>After that, the code can be be updated in the destination directory
54 using:</p>
55
56<div class="doc_code">
57<pre>svn update</pre>
58</div>
59
60 <p>The mirror is brought up to date every evening.</p></li>
61
62 <li>Follow the directions in the top-level <tt>README.LLVM</tt> file for
63 up-to-date instructions on how to build llvm-gcc. See below for building
64 with support for Ada or Fortran.
65</ol>
66
67</div>
68
69<!-- *********************************************************************** -->
Misha Brukmanee4a1a62008-12-29 21:33:30 +0000[diff] [blame]70<h1><a name="ada">Building the Ada front-end</a></h1>
71<!-- *********************************************************************** -->
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]72
73<div class="doc_text">
74<p>Building with support for Ada amounts to following the directions in the
75top-level <tt>README.LLVM</tt> file, adding ",ada" to EXTRALANGS, for example:
76<tt>EXTRALANGS=,ada</tt></p>
77
78<p>There are some complications however:</p>
79
80<ol>
81 <li><p>The only platform for which the Ada front-end is known to build is
82 32 bit intel x86 running linux. It is unlikely to build for other
83 systems without some work.</p></li>
84 <li><p>The build requires having a compiler that supports Ada, C and C++.
85 The Ada front-end is written in Ada so an Ada compiler is needed to
Duncan Sandsd3d8ad02008-04-11 13:24:43 +0000[diff] [blame]86 build it. Compilers known to work with the
Duncan Sandse132fc12009-03-13 13:42:20 +0000[diff] [blame]87 <a href="http://llvm.org/releases/download.html">LLVM 2.5 release</a>
Duncan Sandsd3d8ad02008-04-11 13:24:43 +0000[diff] [blame]88 are <a href="http://gcc.gnu.org/releases.html">gcc-4.2</a> and the
Duncan Sands701f2832008-06-09 20:24:05 +0000[diff] [blame]89 2005, 2006 and 2007 versions of the
90 <a href="http://libre.adacore.com/">GNAT GPL Edition</a>.
Duncan Sands09557102009-07-05 12:01:44 +0000[diff] [blame]91 <b>GNAT GPL 2008, gcc-4.3 and later will not work</b>.
Duncan Sands75161452008-02-16 09:47:41 +0000[diff] [blame]92 The LLVM parts of llvm-gcc are written in C++ so a C++ compiler is
93 needed to build them. The rest of gcc is written in C.
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]94 Some linux distributions provide a version of gcc that supports all
95 three languages (the Ada part often comes as an add-on package to
96 the rest of gcc). Otherwise it is possible to combine two versions
97 of gcc, one that supports Ada and C (such as the
Duncan Sands701f2832008-06-09 20:24:05 +0000[diff] [blame]98 <a href="http://libre.adacore.com/">2007 GNAT GPL Edition</a>)
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]99 and another which supports C++, see below.</p></li>
100 <li><p>Because the Ada front-end is experimental, it is wise to build the
Duncan Sandsd3d8ad02008-04-11 13:24:43 +0000[diff] [blame]101 compiler with checking enabled. This causes it to run much slower, but
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]102 helps catch mistakes in the compiler (please report any problems using
103 <a href="http://llvm.org/bugs">LLVM bugzilla</a>).</p></li>
Duncan Sands1b2365b2009-03-24 21:16:39 +0000[diff] [blame]104 <li><p>The Ada front-end <a href="http://llvm.org/PR2007">fails to
105 bootstrap</a>, due to lack of LLVM support for
106 <tt>setjmp</tt>/<tt>longjmp</tt> style exception handling (used
107 internally by the compiler), so you must specify
108 <tt>--disable-bootstrap</tt>.</p></li>
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]109</ol>
110
111<p>Supposing appropriate compilers are available, llvm-gcc with Ada support can
112 be built on an x86-32 linux box using the following recipe:</p>
113
114<ol>
115 <li><p>Download the <a href="http://llvm.org/releases/download.html">LLVM source</a>
116 and unpack it:</p>
117
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]118<pre class="doc_code">
Duncan Sandse132fc12009-03-13 13:42:20 +0000[diff] [blame]119wget http://llvm.org/releases/2.5/llvm-2.5.tar.gz
120tar xzf llvm-2.5.tar.gz
121mv llvm-2.5 llvm
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]122</pre>
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]123
124 <p>or <a href="GettingStarted.html#checkout">check out the
125 latest version from subversion</a>:</p>
126
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]127<pre class="doc_code">svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm</pre>
128
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]129 </li>
130
131 <li><p>Download the
132 <a href="http://llvm.org/releases/download.html">llvm-gcc-4.2 source</a>
133 and unpack it:</p>
134
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]135<pre class="doc_code">
Duncan Sandse132fc12009-03-13 13:42:20 +0000[diff] [blame]136wget http://llvm.org/releases/2.5/llvm-gcc-4.2-2.5.source.tar.gz
137tar xzf llvm-gcc-4.2-2.5.source.tar.gz
138mv llvm-gcc4.2-2.5.source llvm-gcc-4.2
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]139</pre>
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]140
141 <p>or <a href="GettingStarted.html#checkout">check out the
142 latest version from subversion</a>:</p>
143
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]144<pre class="doc_code">
145svn co http://llvm.org/svn/llvm-project/llvm-gcc-4.2/trunk llvm-gcc-4.2
146</pre>
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]147 </li>
148
149 <li><p>Make a build directory <tt>llvm-objects</tt> for llvm and make it the
150 current directory:</p>
151
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]152<pre class="doc_code">
153mkdir llvm-objects
154cd llvm-objects
155</pre>
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]156 </li>
157
158 <li><p>Configure LLVM (here it is configured to install into <tt>/usr/local</tt>):</p>
159
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]160<pre class="doc_code">
Duncan Sandsd46a4652009-04-27 11:21:35 +0000[diff] [blame]161../llvm/configure --prefix=<b>/usr/local</b> --enable-optimized --enable-assertions
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]162</pre>
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]163
164 <p>If you have a multi-compiler setup and the C++ compiler is not the
165 default, then you can configure like this:</p>
166
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]167<pre class="doc_code">
Duncan Sandsd46a4652009-04-27 11:21:35 +0000[diff] [blame]168CXX=<b>PATH_TO_C++_COMPILER</b> ../llvm/configure --prefix=<b>/usr/local</b> --enable-optimized --enable-assertions
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]169</pre>
Duncan Sandsd46a4652009-04-27 11:21:35 +0000[diff] [blame]170
171 <p>To compile without checking (not recommended), replace
172 <tt>--enable-assertions</tt> with <tt>--disable-assertions</tt>.</p>
173
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]174 </li>
175
Duncan Sandsd46a4652009-04-27 11:21:35 +0000[diff] [blame]176 <li><p>Build LLVM:</p>
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]177
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]178<pre class="doc_code">
Duncan Sandsd46a4652009-04-27 11:21:35 +0000[diff] [blame]179make
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]180</pre>
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]181 </li>
182
183 <li><p>Install LLVM (optional):</p>
184
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]185<pre class="doc_code">
Duncan Sandsd46a4652009-04-27 11:21:35 +0000[diff] [blame]186make install
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]187</pre>
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]188 </li>
189
190 <li><p>Make a build directory <tt>llvm-gcc-4.2-objects</tt> for llvm-gcc and make it the
191 current directory:</p>
192
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]193<pre class="doc_code">
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]194cd ..
195mkdir llvm-gcc-4.2-objects
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]196cd llvm-gcc-4.2-objects
197</pre>
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]198 </li>
199
200 <li><p>Configure llvm-gcc (here it is configured to install into <tt>/usr/local</tt>).
201 The <tt>--enable-checking</tt> flag turns on sanity checks inside the compiler.
Duncan Sandsd46a4652009-04-27 11:21:35 +0000[diff] [blame]202 To turn off these checks (not recommended), replace <tt>--enable-checking</tt>
203 with <tt>--disable-checking</tt>.
Misha Brukmandf475b82009-01-03 02:35:05 +0000[diff] [blame]204 Additional languages can be appended to the <tt>--enable-languages</tt> switch,
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]205 for example <tt>--enable-languages=ada,c,c++</tt>.</p>
206
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]207<pre class="doc_code">
Misha Brukmandf475b82009-01-03 02:35:05 +0000[diff] [blame]208../llvm-gcc-4.2/configure --prefix=<b>/usr/local</b> --enable-languages=ada,c \
209 --enable-checking --enable-llvm=$PWD/../llvm-objects \
210 --disable-bootstrap --disable-multilib
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]211</pre>
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]212
213 <p>If you have a multi-compiler setup, then you can configure like this:</p>
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]214
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]215<pre class="doc_code">
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]216export CC=<b>PATH_TO_C_AND_ADA_COMPILER</b>
217export CXX=<b>PATH_TO_C++_COMPILER</b>
Misha Brukmandf475b82009-01-03 02:35:05 +0000[diff] [blame]218../llvm-gcc-4.2/configure --prefix=<b>/usr/local</b> --enable-languages=ada,c \
219 --enable-checking --enable-llvm=$PWD/../llvm-objects \
220 --disable-bootstrap --disable-multilib
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]221</pre>
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]222 </li>
223
224 <li><p>Build and install the compiler:</p>
225
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]226<pre class="doc_code">
227make
228make install
229</pre>
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]230 </li>
231</ol>
232
233</div>
234
235<!-- *********************************************************************** -->
Misha Brukmanee4a1a62008-12-29 21:33:30 +0000[diff] [blame]236<h1><a name="fortran">Building the Fortran front-end</a></h1>
237<!-- *********************************************************************** -->
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]238
239<div class="doc_text">
Misha Brukmanee4a1a62008-12-29 21:33:30 +0000[diff] [blame]240<p>To build with support for Fortran, follow the directions in the top-level
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]241<tt>README.LLVM</tt> file, adding ",fortran" to EXTRALANGS, for example:</p>
242
Misha Brukman2064a7c2008-12-29 21:20:51 +0000[diff] [blame]243<pre class="doc_code">
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]244EXTRALANGS=,fortran
245</pre>
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]246
247</div>
248
249<!-- *********************************************************************** -->
Misha Brukmanee4a1a62008-12-29 21:33:30 +0000[diff] [blame]250<h1><a name="license">License Information</a></h1>
251<!-- *********************************************************************** -->
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]252
253<div class="doc_text">
254<p>
255The LLVM GCC frontend is licensed to you under the GNU General Public License
256and the GNU Lesser General Public License. Please see the files COPYING and
257COPYING.LIB for more details.
258</p>
259
260<p>
261More information is <a href="FAQ.html#license">available in the FAQ</a>.
262</p>
263</div>
264
265<!-- *********************************************************************** -->
266
267<hr>
268<address>
269 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman947321d2008-12-11 17:34:48 +0000[diff] [blame]270 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]271 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman947321d2008-12-11 17:34:48 +0000[diff] [blame]272 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Duncan Sandse38f3dc2008-02-14 17:53:22 +0000[diff] [blame]273
274 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
275 Last modified: $Date$
276</address>
277
278</body>
279</html>