Note that these instructions are for x86-32 linux
[oota-llvm.git] / docs / CFEBuildInstrs.html
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 C/C++ 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>
17   <li><a href="#license">License Information</a></li>
18 </ol>
19
20 <div class="doc_author">    
21   <p>Written by the LLVM Team</p>
22 </div>
23
24 <!-- *********************************************************************** -->
25 <div class="doc_section">
26   <a name="instructions">Building llvm-gcc from Source</a>
27 </div>
28 <!-- *********************************************************************** -->
29
30 <div class="doc_text">
31
32 <p>This section describes how to acquire and build llvm-gcc 4.0 and 4.2, which are
33 based on the GCC 4.0.1/4.2.1 front-ends respectively.  Both front-ends support C,
34 C++, Objective-C and Objective-C++.  The 4.2 front-end also supports Ada and
35 Fortran to some extent.  Note that the instructions for building these front-ends
36 are completely different (and much easier!) than those for building llvm-gcc3 in
37 the past.</p>
38
39 <ol>
40   <li><p>Retrieve the appropriate llvm-gcc4.x-y.z.source.tar.gz archive from the
41          <a href="http://llvm.org/releases/">llvm web site</a>.</p>
42
43       <p>It is also possible to download the sources of the llvm-gcc front end
44          from a read-only mirror using subversion.  To check out the 4.0 code
45          for first time use:</p>
46
47 <div class="doc_code">
48 <pre>
49 svn co http://llvm.org/svn/llvm-project/llvm-gcc-4.0/trunk <i>dst-directory</i>
50 </pre>
51 </div>
52
53 <p>To check out the 4.2 code use:</p>
54
55 <div class="doc_code">
56 <pre>
57 svn co http://llvm.org/svn/llvm-project/llvm-gcc-4.2/trunk <i>dst-directory</i>
58 </pre>
59 </div>
60
61       <p>After that, the code can be be updated in the destination directory
62          using:</p>
63
64 <div class="doc_code">
65 <pre>svn update</pre>
66 </div>
67
68       <p>The mirror is brought up to date every evening.</p></li>
69
70   <li>Follow the directions in the top-level <tt>README.LLVM</tt> file for
71       up-to-date instructions on how to build llvm-gcc.  See below for building
72       with support for Ada or Fortran.
73 </ol>
74
75 </div>
76
77 <!-- *********************************************************************** -->
78 <div class="doc_section">
79   <a name="license">Building the Ada front-end</a>
80 </div>
81
82 <div class="doc_text">
83 <p>Building with support for Ada amounts to following the directions in the
84 top-level <tt>README.LLVM</tt> file, adding ",ada" to EXTRALANGS, for example:
85 <tt>EXTRALANGS=,ada</tt></p>
86
87 <p>There are some complications however:</p>
88
89 <ol>
90   <li><p>The only platform for which the Ada front-end is known to build is
91       32 bit intel x86 running linux.  It is unlikely to build for other
92       systems without some work.</p></li>
93   <li><p>The build requires having a compiler that supports Ada, C and C++.
94       The Ada front-end is written in Ada so an Ada compiler is needed to
95       build it.  The LLVM parts of llvm-gcc are written in C++ so a C++
96       compiler is needed to build them.  The rest of gcc is written in C.
97       Some linux distributions provide a version of gcc that supports all
98       three languages (the Ada part often comes as an add-on package to
99       the rest of gcc).  Otherwise it is possible to combine two versions
100       of gcc, one that supports Ada and C (such as
101       <a href="http://libre.adacore.com/">GNAT GPL Edition</a>) and another
102       which supports C++, see below.</p></li>
103 </ol>
104
105 <p>Supposing appropriate compilers are available, llvm-gcc with Ada support can
106    be built on an x86-32 linux box using the following recipe:</p>
107
108 <ol>
109   <li><p>Download the <a href="http://llvm.org/releases/download.html">LLVM source</a>
110       and unpack it:</p>
111
112 <div class="doc_code">
113 <pre>wget http://llvm.org/releases/2.2/llvm-2.2.tar.gz
114 tar xzf llvm-2.2.tar.gz
115 mv llvm-2.2 llvm</pre>
116 </div>
117
118       <p>or <a href="http://llvm.org/docs/GettingStarted.html#checkout">check out the
119       latest version from subversion</a>:</p>
120
121 <div class="doc_code">
122 <pre>svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm</pre>
123 </div>
124       </li>
125
126   <li><p>Download the
127       <a href="http://llvm.org/releases/download.html">llvm-gcc-4.2 source</a>
128       and unpack it:</p>
129
130 <div class="doc_code">
131 <pre>wget http://llvm.org/releases/2.2/llvm-gcc4.2-2.2.source.tar.gz
132 tar xzf llvm-gcc4.2-2.2.source.tar.gz
133 mv llvm-gcc4.2-2.2.source llvm-gcc-4.2</pre>
134 </div>
135
136       <p>or <a href="http://llvm.org/docs/GettingStarted.html#checkout">check out the
137       latest version from subversion</a>:</p>
138
139 <div class="doc_code">
140 <pre>svn co http://llvm.org/svn/llvm-project/llvm-gcc-4.2/trunk llvm-gcc-4.2</pre>
141 </div>
142       </li>
143
144   <li><p>Make a build directory <tt>llvm-objects</tt> for llvm and make it the
145       current directory:</p>
146
147 <div class="doc_code">
148 <pre>mkdir llvm-objects
149 cd llvm-objects</pre>
150 </div>
151       </li>
152
153   <li><p>Configure LLVM (here it is configured to install into <tt>/usr/local</tt>):</p>
154
155 <div class="doc_code">
156 <pre>../llvm/configure --prefix=/usr/local</pre>
157 </div>
158
159       <p>If you have a multi-compiler setup and the C++ compiler is not the
160       default, then you can configure like this:</p>
161
162 <div class="doc_code">
163 <pre>CXX=<b>PATH_TO_C++_COMPILER</b> ../llvm/configure --prefix=/usr/local</pre>
164 </div>
165       </li>
166
167   <li><p>Build LLVM:</p>
168
169 <div class="doc_code">
170 <pre>make</pre>
171 </div>
172       </li>
173
174   <li><p>Install LLVM (optional):</p>
175
176 <div class="doc_code">
177 <pre>make install</pre>
178 </div>
179       </li>
180
181   <li><p>Make a build directory <tt>llvm-gcc-4.2-objects</tt> for llvm-gcc and make it the
182       current directory:</p>
183
184 <div class="doc_code">
185 <pre>
186 cd ..
187 mkdir llvm-gcc-4.2-objects
188 cd llvm-gcc-4.2-objects</pre>
189 </div>
190       </li>
191
192   <li><p>Configure llvm-gcc (here it is configured to install into <tt>/usr/local</tt>).
193       Additional languages can be appended to the --enable-languages switch,
194       for example <tt>--enable-languages=ada,c,c++</tt>.</p>
195
196 <div class="doc_code">
197 <pre>../llvm-gcc-4.2/configure --prefix=/usr/local --enable-languages=ada,c --enable-checking --enable-llvm=$PWD/../llvm-objects --disable-shared --disable-bootstrap --disable-multilib</pre>
198 </div>
199
200       <p>If you have a multi-compiler setup, then you can configure like this:</p>
201 <div class="doc_code">
202
203 <pre>
204 export CC=<b>PATH_TO_C_AND_ADA_COMPILER</b>
205 export CXX=<b>PATH_TO_C++_COMPILER</b>
206 ../llvm-gcc-4.2/configure --prefix=/usr/local --enable-languages=ada,c --enable-checking --enable-llvm=$PWD/../llvm-objects --disable-shared --disable-bootstrap --disable-multilib</pre>
207 </div>
208       </li>
209
210   <li><p>Build and install the compiler:</p>
211
212 <div class="doc_code">
213 <pre>make
214 make install</pre>
215 </div>
216       </li>
217 </ol>
218
219 </div>
220
221 <!-- *********************************************************************** -->
222 <div class="doc_section">
223   <a name="license">Building the Fortran front-end</a>
224 </div>
225
226 <div class="doc_text">
227 <p>
228 To build with support for Fortran, follow the directions in the top-level
229 <tt>README.LLVM</tt> file, adding ",fortran" to EXTRALANGS, for example:</p>
230
231 <div class="doc_code">
232 <pre>
233 EXTRALANGS=,fortran
234 </pre>
235 </div>
236
237 </div>
238
239 <!-- *********************************************************************** -->
240 <div class="doc_section">
241   <a name="license">License Information</a>
242 </div>
243
244 <div class="doc_text">
245 <p>
246 The LLVM GCC frontend is licensed to you under the GNU General Public License
247 and the GNU Lesser General Public License.  Please see the files COPYING and
248 COPYING.LIB for more details.
249 </p>
250
251 <p>
252 More information is <a href="FAQ.html#license">available in the FAQ</a>.
253 </p>
254 </div>
255
256 <!-- *********************************************************************** -->
257
258 <hr>
259 <address>
260   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
261   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
262   <a href="http://validator.w3.org/check/referer"><img
263   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
264
265   <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
266   Last modified: $Date$
267 </address>
268
269 </body>
270 </html>