Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / 75bc2250ca44640737bbfccd553ba0198ef5e8c7 / . / llvm / docs / GCCFEBuildInstrs.html
blob: 262c16783947eb7dcb038adada601d49e3ff9c4a [file] [log] [blame]
Duncan Sands551d3e62008-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 Brukmanfd609662008-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 Sands551d3e62008-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 Brukmanfd609662008-12-29 21:33:30 +0000[diff] [blame]27<h1><a name="instructions">Building llvm-gcc from Source</a></h1>
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]28<!-- *********************************************************************** -->
29
30<div class="doc_text">
31
Duncan Sands7192a542008-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 Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]37
38<ol>
Misha Brukman8dab3032008-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 Sands551d3e62008-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 Sands7192a542008-06-09 20:24:05 +0000[diff] [blame]44 from a read-only mirror using subversion. To check out the 4.2 code
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]45 for first time use:</p>
46
47<div class="doc_code">
48<pre>
Duncan Sands551d3e62008-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 Brukmanfd609662008-12-29 21:33:30 +0000[diff] [blame]70<h1><a name="ada">Building the Ada front-end</a></h1>
71<!-- *********************************************************************** -->
Duncan Sands551d3e62008-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 Sands21285fc2008-04-11 13:24:43 +0000[diff] [blame]86 build it. Compilers known to work with the
Duncan Sands0c9742c2009-03-13 13:42:20 +0000[diff] [blame]87 <a href="http://llvm.org/releases/download.html">LLVM 2.5 release</a>
Duncan Sands21285fc2008-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 Sands7192a542008-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 Sands648e5d62008-02-16 09:47:41 +0000[diff] [blame]91 The LLVM parts of llvm-gcc are written in C++ so a C++ compiler is
92 needed to build them. The rest of gcc is written in C.
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]93 Some linux distributions provide a version of gcc that supports all
94 three languages (the Ada part often comes as an add-on package to
95 the rest of gcc). Otherwise it is possible to combine two versions
96 of gcc, one that supports Ada and C (such as the
Duncan Sands7192a542008-06-09 20:24:05 +0000[diff] [blame]97 <a href="http://libre.adacore.com/">2007 GNAT GPL Edition</a>)
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]98 and another which supports C++, see below.</p></li>
99 <li><p>Because the Ada front-end is experimental, it is wise to build the
Duncan Sands21285fc2008-04-11 13:24:43 +0000[diff] [blame]100 compiler with checking enabled. This causes it to run much slower, but
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]101 helps catch mistakes in the compiler (please report any problems using
102 <a href="http://llvm.org/bugs">LLVM bugzilla</a>).</p></li>
Duncan Sands61837e62009-03-24 21:16:39 +0000[diff] [blame]103 <li><p>The Ada front-end <a href="http://llvm.org/PR2007">fails to
104 bootstrap</a>, due to lack of LLVM support for
105 <tt>setjmp</tt>/<tt>longjmp</tt> style exception handling (used
106 internally by the compiler), so you must specify
107 <tt>--disable-bootstrap</tt>.</p></li>
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]108</ol>
109
110<p>Supposing appropriate compilers are available, llvm-gcc with Ada support can
111 be built on an x86-32 linux box using the following recipe:</p>
112
113<ol>
114 <li><p>Download the <a href="http://llvm.org/releases/download.html">LLVM source</a>
115 and unpack it:</p>
116
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]117<pre class="doc_code">
Duncan Sands0c9742c2009-03-13 13:42:20 +0000[diff] [blame]118wget http://llvm.org/releases/2.5/llvm-2.5.tar.gz
119tar xzf llvm-2.5.tar.gz
120mv llvm-2.5 llvm
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]121</pre>
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]122
123 <p>or <a href="GettingStarted.html#checkout">check out the
124 latest version from subversion</a>:</p>
125
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]126<pre class="doc_code">svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm</pre>
127
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]128 </li>
129
130 <li><p>Download the
131 <a href="http://llvm.org/releases/download.html">llvm-gcc-4.2 source</a>
132 and unpack it:</p>
133
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]134<pre class="doc_code">
Duncan Sands0c9742c2009-03-13 13:42:20 +0000[diff] [blame]135wget http://llvm.org/releases/2.5/llvm-gcc-4.2-2.5.source.tar.gz
136tar xzf llvm-gcc-4.2-2.5.source.tar.gz
137mv llvm-gcc4.2-2.5.source llvm-gcc-4.2
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]138</pre>
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]139
140 <p>or <a href="GettingStarted.html#checkout">check out the
141 latest version from subversion</a>:</p>
142
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]143<pre class="doc_code">
144svn co http://llvm.org/svn/llvm-project/llvm-gcc-4.2/trunk llvm-gcc-4.2
145</pre>
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]146 </li>
147
148 <li><p>Make a build directory <tt>llvm-objects</tt> for llvm and make it the
149 current directory:</p>
150
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]151<pre class="doc_code">
152mkdir llvm-objects
153cd llvm-objects
154</pre>
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]155 </li>
156
157 <li><p>Configure LLVM (here it is configured to install into <tt>/usr/local</tt>):</p>
158
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]159<pre class="doc_code">
Duncan Sands75bc2252009-04-27 11:21:35 +0000[diff] [blame^]160../llvm/configure --prefix=<b>/usr/local</b> --enable-optimized --enable-assertions
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]161</pre>
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]162
163 <p>If you have a multi-compiler setup and the C++ compiler is not the
164 default, then you can configure like this:</p>
165
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]166<pre class="doc_code">
Duncan Sands75bc2252009-04-27 11:21:35 +0000[diff] [blame^]167CXX=<b>PATH_TO_C++_COMPILER</b> ../llvm/configure --prefix=<b>/usr/local</b> --enable-optimized --enable-assertions
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]168</pre>
Duncan Sands75bc2252009-04-27 11:21:35 +0000[diff] [blame^]169
170 <p>To compile without checking (not recommended), replace
171 <tt>--enable-assertions</tt> with <tt>--disable-assertions</tt>.</p>
172
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]173 </li>
174
Duncan Sands75bc2252009-04-27 11:21:35 +0000[diff] [blame^]175 <li><p>Build LLVM:</p>
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]176
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]177<pre class="doc_code">
Duncan Sands75bc2252009-04-27 11:21:35 +0000[diff] [blame^]178make
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]179</pre>
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]180 </li>
181
182 <li><p>Install LLVM (optional):</p>
183
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]184<pre class="doc_code">
Duncan Sands75bc2252009-04-27 11:21:35 +0000[diff] [blame^]185make install
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]186</pre>
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]187 </li>
188
189 <li><p>Make a build directory <tt>llvm-gcc-4.2-objects</tt> for llvm-gcc and make it the
190 current directory:</p>
191
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]192<pre class="doc_code">
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]193cd ..
194mkdir llvm-gcc-4.2-objects
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]195cd llvm-gcc-4.2-objects
196</pre>
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]197 </li>
198
199 <li><p>Configure llvm-gcc (here it is configured to install into <tt>/usr/local</tt>).
200 The <tt>--enable-checking</tt> flag turns on sanity checks inside the compiler.
Duncan Sands75bc2252009-04-27 11:21:35 +0000[diff] [blame^]201 To turn off these checks (not recommended), replace <tt>--enable-checking</tt>
202 with <tt>--disable-checking</tt>.
Misha Brukmanb5362352009-01-03 02:35:05 +0000[diff] [blame]203 Additional languages can be appended to the <tt>--enable-languages</tt> switch,
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]204 for example <tt>--enable-languages=ada,c,c++</tt>.</p>
205
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]206<pre class="doc_code">
Misha Brukmanb5362352009-01-03 02:35:05 +0000[diff] [blame]207../llvm-gcc-4.2/configure --prefix=<b>/usr/local</b> --enable-languages=ada,c \
208 --enable-checking --enable-llvm=$PWD/../llvm-objects \
209 --disable-bootstrap --disable-multilib
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]210</pre>
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]211
212 <p>If you have a multi-compiler setup, then you can configure like this:</p>
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]213
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]214<pre class="doc_code">
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]215export CC=<b>PATH_TO_C_AND_ADA_COMPILER</b>
216export CXX=<b>PATH_TO_C++_COMPILER</b>
Misha Brukmanb5362352009-01-03 02:35:05 +0000[diff] [blame]217../llvm-gcc-4.2/configure --prefix=<b>/usr/local</b> --enable-languages=ada,c \
218 --enable-checking --enable-llvm=$PWD/../llvm-objects \
219 --disable-bootstrap --disable-multilib
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]220</pre>
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]221 </li>
222
223 <li><p>Build and install the compiler:</p>
224
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]225<pre class="doc_code">
226make
227make install
228</pre>
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]229 </li>
230</ol>
231
232</div>
233
234<!-- *********************************************************************** -->
Misha Brukmanfd609662008-12-29 21:33:30 +0000[diff] [blame]235<h1><a name="fortran">Building the Fortran front-end</a></h1>
236<!-- *********************************************************************** -->
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]237
238<div class="doc_text">
Misha Brukmanfd609662008-12-29 21:33:30 +0000[diff] [blame]239<p>To build with support for Fortran, follow the directions in the top-level
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]240<tt>README.LLVM</tt> file, adding ",fortran" to EXTRALANGS, for example:</p>
241
Misha Brukman8dab3032008-12-29 21:20:51 +0000[diff] [blame]242<pre class="doc_code">
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]243EXTRALANGS=,fortran
244</pre>
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]245
246</div>
247
248<!-- *********************************************************************** -->
Misha Brukmanfd609662008-12-29 21:33:30 +0000[diff] [blame]249<h1><a name="license">License Information</a></h1>
250<!-- *********************************************************************** -->
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]251
252<div class="doc_text">
253<p>
254The LLVM GCC frontend is licensed to you under the GNU General Public License
255and the GNU Lesser General Public License. Please see the files COPYING and
256COPYING.LIB for more details.
257</p>
258
259<p>
260More information is <a href="FAQ.html#license">available in the FAQ</a>.
261</p>
262</div>
263
264<!-- *********************************************************************** -->
265
266<hr>
267<address>
268 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman86242e12008-12-11 17:34:48 +0000[diff] [blame]269 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]270 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman86242e12008-12-11 17:34:48 +0000[diff] [blame]271 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Duncan Sands551d3e62008-02-14 17:53:22 +0000[diff] [blame]272
273 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
274 Last modified: $Date$
275</address>
276
277</body>
278</html>