blob: 0e871336deb83ca2aa1345113c8439ded797076a [file] [log] [blame]
Misha Brukman00c73d22003-11-07 19:43:14 +00001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
Guochun Shif4688a82002-07-17 23:05:56 +00003<html>
Misha Brukman00c73d22003-11-07 19:43:14 +00004<head>
Reid Spencer748d82e2004-11-15 21:15:12 +00005 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Misha Brukman00c73d22003-11-07 19:43:14 +00006 <title>Getting Started with LLVM System</title>
7 <link rel="stylesheet" href="llvm.css" type="text/css">
8</head>
9<body>
John Criswell85ed3612003-06-12 19:34:44 +000010
Misha Brukman00c73d22003-11-07 19:43:14 +000011<div class="doc_title">
12 Getting Started with the LLVM System
13</div>
John Criswell85ed3612003-06-12 19:34:44 +000014
Misha Brukman00c73d22003-11-07 19:43:14 +000015<ul>
16 <li><a href="#overview">Overview</a>
17 <li><a href="#quickstart">Getting Started Quickly (A Summary)</a>
18 <li><a href="#requirements">Requirements</a>
Chris Lattner96768ea2003-02-14 04:22:13 +000019 <ol>
Misha Brukman00c73d22003-11-07 19:43:14 +000020 <li><a href="#hardware">Hardware</a>
21 <li><a href="#software">Software</a>
Chris Lattner95e92582004-07-18 22:32:22 +000022 <li><a href="#brokengcc">Broken versions of GCC</a>
Misha Brukman00c73d22003-11-07 19:43:14 +000023 </ol></li>
John Criswell7a73b802003-06-30 21:59:07 +000024
Misha Brukman00c73d22003-11-07 19:43:14 +000025 <li><a href="#starting">Getting Started with LLVM</a>
John Criswell0b459202003-07-08 20:35:59 +000026 <ol>
Misha Brukman00c73d22003-11-07 19:43:14 +000027 <li><a href="#terminology">Terminology and Notation</a>
28 <li><a href="#environment">Setting Up Your Environment</a>
29 <li><a href="#unpack">Unpacking the LLVM Archives</a>
30 <li><a href="#checkout">Checkout LLVM from CVS</a>
31 <li><a href="#installcf">Install the GCC Front End</a>
32 <li><a href="#config">Local LLVM Configuration</a>
33 <li><a href="#compile">Compiling the LLVM Suite Source Code</a>
Reid Spencerd30a9712006-07-27 06:41:31 +000034 <li><a href="#cross-compile">Cross-Compiling LLVM</a>
Misha Brukman00c73d22003-11-07 19:43:14 +000035 <li><a href="#objfiles">The Location of LLVM Object Files</a>
Chris Lattnera553f622004-03-25 20:38:40 +000036 <li><a href="#optionalconfig">Optional Configuration Items</a>
Misha Brukman00c73d22003-11-07 19:43:14 +000037 </ol></li>
John Criswell0b459202003-07-08 20:35:59 +000038
Misha Brukman00c73d22003-11-07 19:43:14 +000039 <li><a href="#layout">Program layout</a>
40 <ol>
41 <li><a href="#cvsdir"><tt>CVS</tt> directories</a>
Reid Spencerc4b09ba2004-12-08 16:18:26 +000042 <li><a href="#examples"><tt>llvm/examples</tt></a>
Misha Brukman00c73d22003-11-07 19:43:14 +000043 <li><a href="#include"><tt>llvm/include</tt></a>
44 <li><a href="#lib"><tt>llvm/lib</tt></a>
Reid Spencerc4b09ba2004-12-08 16:18:26 +000045 <li><a href="#projects"><tt>llvm/projects</tt></a>
Misha Brukman00c73d22003-11-07 19:43:14 +000046 <li><a href="#runtime"><tt>llvm/runtime</tt></a>
47 <li><a href="#test"><tt>llvm/test</tt></a>
Reid Spencer77d90192004-09-05 20:50:22 +000048 <li><a href="#llvmtest"><tt>llvm-test</tt></a>
Misha Brukman00c73d22003-11-07 19:43:14 +000049 <li><a href="#tools"><tt>llvm/tools</tt></a>
50 <li><a href="#utils"><tt>llvm/utils</tt></a>
Reid Spencerc4b09ba2004-12-08 16:18:26 +000051 <li><a href="#win32"><tt>llvm/win32</tt></a>
Misha Brukman00c73d22003-11-07 19:43:14 +000052 </ol></li>
John Criswell0f6d7c02003-10-27 18:18:16 +000053
Misha Brukman00c73d22003-11-07 19:43:14 +000054 <li><a href="#tutorial">An Example Using the LLVM Tool Chain</a>
Chris Lattner9abd8af2006-09-07 04:19:09 +000055 <ol>
56 <li><a href="#tutorial4">Example with llvm-gcc4</a></li>
Chris Lattner9abd8af2006-09-07 04:19:09 +000057 </ol>
Misha Brukman00c73d22003-11-07 19:43:14 +000058 <li><a href="#problems">Common Problems</a>
59 <li><a href="#links">Links</a>
60</ul>
61
Chris Lattner7911ce22004-05-23 21:07:27 +000062<div class="doc_author">
63 <p>Written by:
64 <a href="mailto:criswell@uiuc.edu">John Criswell</a>,
65 <a href="mailto:sabre@nondot.org">Chris Lattner</a>,
66 <a href="http://misha.brukman.net">Misha Brukman</a>,
67 <a href="http://www.cs.uiuc.edu/~vadve">Vikram Adve</a>, and
68 <a href="mailto:gshi1@uiuc.edu">Guochun Shi</a>.
69 </p>
70</div>
Misha Brukman00c73d22003-11-07 19:43:14 +000071
72
73<!-- *********************************************************************** -->
74<div class="doc_section">
75 <a name="overview"><b>Overview</b></a>
76</div>
77<!-- *********************************************************************** -->
78
79<div class="doc_text">
80
81<p>Welcome to LLVM! In order to get started, you first need to know some
82basic information.</p>
83
84<p>First, LLVM comes in two pieces. The first piece is the LLVM suite. This
85contains all of the tools, libraries, and header files needed to use the low
86level virtual machine. It contains an assembler, disassembler, bytecode
Reid Spencer84f82f72006-08-28 00:34:19 +000087analyzer and bytecode optimizer. It also contains a test suite that can be
Misha Brukman00c73d22003-11-07 19:43:14 +000088used to test the LLVM tools and the GCC front end.</p>
89
90<p>The second piece is the GCC front end. This component provides a version of
91GCC that compiles C and C++ code into LLVM bytecode. Currently, the GCC front
Chris Lattner82ad9f12007-03-06 06:27:34 +000092end uses the GCC parser to convert code to LLVM. Once
Misha Brukman00c73d22003-11-07 19:43:14 +000093compiled into LLVM bytecode, a program can be manipulated with the LLVM tools
94from the LLVM suite.</p>
95
John Criswell3d8ba512004-12-08 17:53:54 +000096<p>
97There is a third, optional piece called llvm-test. It is a suite of programs
98with a testing harness that can be used to further test LLVM's functionality
99and performance.
100</p>
101
Misha Brukman00c73d22003-11-07 19:43:14 +0000102</div>
103
104<!-- *********************************************************************** -->
105<div class="doc_section">
106 <a name="quickstart"><b>Getting Started Quickly (A Summary)</b></a>
107</div>
108<!-- *********************************************************************** -->
109
110<div class="doc_text">
111
112<p>Here's the short story for getting up and running quickly with LLVM:</p>
113
114<ol>
Reid Spencer9f547912004-11-08 00:29:22 +0000115 <li>Read the documentation.</li>
116 <li>Read the documentation.</li>
117 <li>Remember that you were warned twice about reading the documentation.</li>
Misha Brukman9106eca2005-02-03 22:25:23 +0000118 <li>Install the GCC front end if you intend to compile C or C++:
Misha Brukman00c73d22003-11-07 19:43:14 +0000119 <ol>
Reid Spencerd4694f92004-12-22 06:29:07 +0000120 <li><tt>cd <i>where-you-want-the-C-front-end-to-live</i></tt></li>
Tanya Lattnerf7b6be02006-11-20 06:04:46 +0000121 <li><tt>gunzip --stdout llvm-gcc.<i>platform</i>.tar.gz | tar -xvf -</tt>
Reid Spencerd4694f92004-12-22 06:29:07 +0000122 </li>
Tanya Lattnerf7b6be02006-11-20 06:04:46 +0000123 <li><tt>cd llvm-gcc3.4/<i>platform</i> (llvm-gcc3.4 only)<br>
Reid Spencerd4694f92004-12-22 06:29:07 +0000124 ./fixheaders</tt></li>
Tanya Lattnerf7b6be02006-11-20 06:04:46 +0000125 <li>Add llvm-gcc's "bin" directory to your PATH variable.</li>
Misha Brukman00c73d22003-11-07 19:43:14 +0000126 </ol></li>
127
Misha Brukman9106eca2005-02-03 22:25:23 +0000128 <li>Get the LLVM Source Code
Misha Brukman00c73d22003-11-07 19:43:14 +0000129 <ul>
Misha Brukman9106eca2005-02-03 22:25:23 +0000130 <li>With the distributed files (or use <a href="#checkout">CVS</a>):
Misha Brukman00c73d22003-11-07 19:43:14 +0000131 <ol>
132 <li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
John Criswell364cec42004-03-12 20:31:37 +0000133 <li><tt>gunzip --stdout llvm-<i>version</i>.tar.gz | tar -xvf -</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000134 </ol></li>
135
Misha Brukman00c73d22003-11-07 19:43:14 +0000136 </ul></li>
137
Misha Brukman9106eca2005-02-03 22:25:23 +0000138 <li><b>[Optional]</b> Get the Test Suite Source Code
John Criswell9e2485c2004-12-10 15:51:16 +0000139 <ul>
Misha Brukman9106eca2005-02-03 22:25:23 +0000140 <li>With the distributed files (or use <a href="#checkout">CVS</a>):
John Criswell9e2485c2004-12-10 15:51:16 +0000141 <ol>
142 <li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
143 <li><tt>cd llvm/projects</tt>
144 <li><tt>gunzip --stdout llvm-test-<i>version</i>.tar.gz | tar -xvf -</tt>
John Criswell9e2485c2004-12-10 15:51:16 +0000145 </ol></li>
146
John Criswell9e2485c2004-12-10 15:51:16 +0000147 </ul></li>
148
149
Misha Brukman00c73d22003-11-07 19:43:14 +0000150 <li>Configure the LLVM Build Environment
151 <ol>
Misha Brukman9106eca2005-02-03 22:25:23 +0000152 <li><tt>cd <i>where-you-want-to-build-llvm</i></tt></li>
153 <li><tt><i>/path/to/llvm/</i>configure [options]</tt><br>
154 Some common options:
155
Misha Brukman00c73d22003-11-07 19:43:14 +0000156 <ul>
Reid Spencerd4694f92004-12-22 06:29:07 +0000157 <li><tt>--prefix=<i>directory</i></tt>
158 <p>Specify for <i>directory</i> the full pathname of where you
Misha Brukman9106eca2005-02-03 22:25:23 +0000159 want the LLVM tools and libraries to be installed (default
160 <tt>/usr/local</tt>).</p></li>
Reid Spencerfef93b72004-12-26 05:47:26 +0000161 <li><tt>--with-llvmgccdir=<i>directory</i></tt>
162 <p>Optionally, specify for <i>directory</i> the full pathname of the
John Criswell838bce52005-05-09 16:39:27 +0000163 C/C++ front end installation to use with this LLVM configuration. If
Reid Spencerfef93b72004-12-26 05:47:26 +0000164 not specified, the PATH will be searched.</p></li>
Misha Brukman00c73d22003-11-07 19:43:14 +0000165 <li><tt>--enable-spec2000=<i>directory</i></tt>
166 <p>Enable the SPEC2000 benchmarks for testing. The SPEC2000
167 benchmarks should be available in
168 <tt><i>directory</i></tt>.</p></li>
169 </ul>
170 </ol></li>
171
172 <li>Build the LLVM Suite:
173 <ol>
Chris Lattner95e92582004-07-18 22:32:22 +0000174 <li><tt>gmake -k |&amp; tee gnumake.out
175 &nbsp;&nbsp;&nbsp;# this is csh or tcsh syntax</tt></li>
Chris Lattner78ce3b82007-01-04 07:06:05 +0000176 <li>If you get an "internal compiler error (ICE)" or test failures, see
177 <a href="#brokengcc">below</a>.</li>
Misha Brukman00c73d22003-11-07 19:43:14 +0000178 </ol>
179
180</ol>
181
Chris Lattnerfcd37252004-06-21 22:52:48 +0000182<p>Consult the <a href="#starting">Getting Started with LLVM</a> section for
Misha Brukman00c73d22003-11-07 19:43:14 +0000183detailed information on configuring and compiling LLVM. See <a
184href="#environment">Setting Up Your Environment</a> for tips that simplify
185working with the GCC front end and LLVM tools. Go to <a href="#layout">Program
186Layout</a> to learn about the layout of the source code tree.</p>
187
188</div>
189
190<!-- *********************************************************************** -->
191<div class="doc_section">
192 <a name="requirements"><b>Requirements</b></a>
193</div>
194<!-- *********************************************************************** -->
195
196<div class="doc_text">
197
198<p>Before you begin to use the LLVM system, review the requirements given below.
199This may save you some trouble by knowing ahead of time what hardware and
200software you will need.</p>
201
202</div>
203
204<!-- ======================================================================= -->
205<div class="doc_subsection">
206 <a name="hardware"><b>Hardware</b></a>
207</div>
208
209<div class="doc_text">
210
211<p>LLVM is known to work on the following platforms:</p>
212
Chris Lattner9abd8af2006-09-07 04:19:09 +0000213<table cellpadding="3" summary="Known LLVM platforms">
Misha Brukman14ab5372004-11-15 05:19:53 +0000214<tr>
215 <th>OS</th>
216 <th>Arch</th>
Misha Brukman69def742004-11-19 21:53:22 +0000217 <th>Compilers</th>
Misha Brukman14ab5372004-11-15 05:19:53 +0000218</tr>
219<tr>
220 <td>Linux</td>
Chris Lattner7db3f522005-02-09 21:15:51 +0000221 <td>x86<sup><a href="#pf_1">1</a></sup></td>
Misha Brukman69def742004-11-19 21:53:22 +0000222 <td>GCC</td>
Misha Brukman14ab5372004-11-15 05:19:53 +0000223</tr>
224<tr>
225 <td>Solaris</td>
226 <td>V9 (Ultrasparc)</td>
Misha Brukman69def742004-11-19 21:53:22 +0000227 <td>GCC</td>
Misha Brukman14ab5372004-11-15 05:19:53 +0000228</tr>
229<tr>
230 <td>FreeBSD</td>
Chris Lattner7db3f522005-02-09 21:15:51 +0000231 <td>x86<sup><a href="#pf_1">1</a></sup></td>
Misha Brukman69def742004-11-19 21:53:22 +0000232 <td>GCC</td>
Misha Brukman14ab5372004-11-15 05:19:53 +0000233</tr>
234<tr>
Chris Lattner7db3f522005-02-09 21:15:51 +0000235 <td>MacOS X<sup><a href="#pf_2">2</a></sup></td>
Misha Brukman14ab5372004-11-15 05:19:53 +0000236 <td>PowerPC</td>
Misha Brukman69def742004-11-19 21:53:22 +0000237 <td>GCC</td>
Misha Brukman14ab5372004-11-15 05:19:53 +0000238</tr>
239<tr>
Tanya Lattner993b9802006-04-20 04:35:34 +0000240 <td>MacOS X<sup><a href="#pf_2">2</a></sup></td>
241 <td>x86</td>
242 <td>GCC</td>
243
244</tr>
245<tr>
Misha Brukman69def742004-11-19 21:53:22 +0000246 <td>Cygwin/Win32</td>
Chris Lattner6947e552006-07-21 00:06:27 +0000247 <td>x86<sup><a href="#pf_1">1</a>,<a href="#pf_8">8</a></sup></td>
Reid Spencer65e8f5b2004-12-23 19:39:54 +0000248 <td>GCC 3.4.X, binutils 2.15</td>
Misha Brukman69def742004-11-19 21:53:22 +0000249</tr>
Misha Brukmanc155a0a2004-12-23 07:14:56 +0000250<tr>
Chris Lattner8ccb87f2005-02-09 20:43:48 +0000251 <td>MinGW/Win32</td>
Chris Lattner6947e552006-07-21 00:06:27 +0000252 <td>x86<sup><a href="#pf_1">1</a>,<a href="#pf_6">6</a>,<a href="#pf_8">8</a></sup></td>
Chris Lattner8ccb87f2005-02-09 20:43:48 +0000253 <td>GCC 3.4.X, binutils 2.15</td>
254</tr>
255<tr>
Misha Brukmanc155a0a2004-12-23 07:14:56 +0000256 <td>Linux</td>
Chris Lattner7db3f522005-02-09 21:15:51 +0000257 <td>amd64<sup><a href="#pf_3">3</a></sup></td>
Misha Brukmanc155a0a2004-12-23 07:14:56 +0000258 <td>GCC</td>
259</tr>
Misha Brukman69def742004-11-19 21:53:22 +0000260</table>
261
262<p>LLVM has partial support for the following platforms:</p>
263
Chris Lattner9abd8af2006-09-07 04:19:09 +0000264<table summary="LLVM partial platform support">
Misha Brukman69def742004-11-19 21:53:22 +0000265<tr>
266 <th>OS</th>
267 <th>Arch</th>
268 <th>Compilers</th>
Misha Brukman14ab5372004-11-15 05:19:53 +0000269</tr>
Misha Brukman00117692004-11-15 21:05:08 +0000270<tr>
Misha Brukman69def742004-11-19 21:53:22 +0000271 <td>Windows</td>
Chris Lattner7db3f522005-02-09 21:15:51 +0000272 <td>x86<sup><a href="#pf_1">1</a></sup></td>
273 <td>Visual Studio .NET<sup><a href="#pf_4">4</a>,<a href="#pf_5">5</a></sup></td>
Misha Brukman69def742004-11-19 21:53:22 +0000274<tr>
Chris Lattner7db3f522005-02-09 21:15:51 +0000275 <td>AIX<sup><a href="#pf_3">3</a>,<a href="#pf_4">4</a></sup></td>
Misha Brukman00117692004-11-15 21:05:08 +0000276 <td>PowerPC</td>
Misha Brukman69def742004-11-19 21:53:22 +0000277 <td>GCC</td>
278</tr>
279<tr>
Chris Lattner7db3f522005-02-09 21:15:51 +0000280 <td>Linux<sup><a href="#pf_3">3</a>,<a href="#pf_5">5</a></sup></td>
Misha Brukman69def742004-11-19 21:53:22 +0000281 <td>PowerPC</td>
282 <td>GCC</td>
Misha Brukman00117692004-11-15 21:05:08 +0000283</tr>
John Criswell75162552005-05-09 16:49:59 +0000284
285<tr>
286 <td>Linux<sup><a href="#pf_7">7</a></sup></td>
287 <td>Alpha</td>
288 <td>GCC</td>
289</tr>
290<tr>
291 <td>Linux<sup><a href="#pf_7">7</a></sup></td>
292 <td>Itanium (IA-64)</td>
293 <td>GCC</td>
294</tr>
Duraid Madinae8714af2005-05-10 06:57:53 +0000295<tr>
296 <td>HP-UX<sup><a href="#pf_7">7</a></sup></td>
297 <td>Itanium (IA-64)</td>
298 <td>HP aCC</td>
299</tr>
Misha Brukman14ab5372004-11-15 05:19:53 +0000300</table>
Misha Brukman00c73d22003-11-07 19:43:14 +0000301
Misha Brukmana892ead2005-02-09 21:01:26 +0000302<p><b>Notes:</b></p>
303
Misha Brukman6d8e1532005-02-09 22:38:47 +0000304<div class="doc_notes">
305<ol>
306<li><a name="pf_1">Code generation supported for Pentium processors and
307up</a></li>
308<li><a name="pf_2">Code generation supported for 32-bit ABI only</a></li>
309<li><a name="pf_3">No native code generation</a></li>
310<li><a name="pf_4">Build is not complete: one or more tools don't link</a></li>
311<li><a name="pf_5">The GCC-based C/C++ frontend does not build</a></li>
Chris Lattner5907d402006-08-14 20:45:25 +0000312<li><a name="pf_6">The port is done using the MSYS shell.</a>
Misha Brukmana892ead2005-02-09 21:01:26 +0000313<a href="http://www.mingw.org/MinGWiki/">Download</a> and install
Chris Lattner6947e552006-07-21 00:06:27 +0000314bison (excl. M4.exe) and flex in that order. Build binutils-2.15 from source,
Chris Lattner5907d402006-08-14 20:45:25 +0000315if necessary. Bison &amp; flex can be also grabbed from GNUWin32 sf.net
316project.</li>
John Criswell75162552005-05-09 16:49:59 +0000317<li><a name="pf_7">Native code generation exists but is not complete.</a></li>
Chris Lattner5907d402006-08-14 20:45:25 +0000318<li><a name="pf_8">Binutils</a> up to post-2.17 has bug in bfd/cofflink.c
Chris Lattner6947e552006-07-21 00:06:27 +0000319 preventing LLVM from building correctly. Several workarounds have been
320 introduced into LLVM build system, but the bug can occur anytime in the
Chris Lattner5907d402006-08-14 20:45:25 +0000321 future. We highly recommend that you rebuild your current binutils with the
Chris Lattner6947e552006-07-21 00:06:27 +0000322 patch from <a href="http://sourceware.org/bugzilla/show_bug.cgi?id=2659">
Chris Lattner5907d402006-08-14 20:45:25 +0000323 Binutils bugzilla</a>, if it wasn't already applied.</li>
Misha Brukmana892ead2005-02-09 21:01:26 +0000324</ol>
Misha Brukmana892ead2005-02-09 21:01:26 +0000325</div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000326
Misha Brukman69def742004-11-19 21:53:22 +0000327<p>Note that you will need about 1-3 GB of space for a full LLVM build in Debug
John Criswell8bfe6a72005-05-18 19:43:33 +0000328mode, depending on the system (it is so large because of all the debugging
329information and the fact that the libraries are statically linked into multiple
330tools). If you do not need many of the tools and you are space-conscious,
Misha Brukman69def742004-11-19 21:53:22 +0000331you can disable them individually in <tt>llvm/tools/Makefile</tt>. The Release
332build requires considerably less space.</p>
333
Misha Brukman00c73d22003-11-07 19:43:14 +0000334<p>The LLVM suite <i>may</i> compile on other platforms, but it is not
335guaranteed to do so. If compilation is successful, the LLVM utilities should be
336able to assemble, disassemble, analyze, and optimize LLVM bytecode. Code
337generation should work as well, although the generated native code may not work
338on your platform.</p>
339
340<p>The GCC front end is not very portable at the moment. If you want to get it
Misha Brukman22e9e332004-08-09 19:57:01 +0000341to work on another platform, you can download a copy of the source and <a
342href="CFEBuildInstrs.html">try to compile it</a> on your platform.</p>
Misha Brukman00c73d22003-11-07 19:43:14 +0000343
344</div>
345
346<!-- ======================================================================= -->
Reid Spencer748d82e2004-11-15 21:15:12 +0000347<div class="doc_subsection"><a name="software"><b>Software</b></a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000348<div class="doc_text">
Reid Spencer748d82e2004-11-15 21:15:12 +0000349 <p>Compiling LLVM requires that you have several software packages
350 installed. The table below lists those required packages. The Package column
351 is the usual name for the software package that LLVM depends on. The Version
352 column provides "known to work" versions of the package. The Notes column
353 describes how LLVM uses the package and provides other details.</p>
Chris Lattner9abd8af2006-09-07 04:19:09 +0000354 <table summary="Packages required to compile LLVM">
Reid Spencer748d82e2004-11-15 21:15:12 +0000355 <tr><th>Package</th><th>Version</th><th>Notes</th></tr>
Misha Brukman00c73d22003-11-07 19:43:14 +0000356
Reid Spencer748d82e2004-11-15 21:15:12 +0000357 <tr>
358 <td><a href="http://savannah.gnu.org/projects/make">GNU Make</a></td>
359 <td>3.79, 3.79.1</td>
360 <td>Makefile/build processor</td>
361 </tr>
Misha Brukman00c73d22003-11-07 19:43:14 +0000362
Reid Spencer748d82e2004-11-15 21:15:12 +0000363 <tr>
364 <td><a href="http://gcc.gnu.org">GCC</a></td>
365 <td>3.4.2</td>
Misha Brukman6d8e1532005-02-09 22:38:47 +0000366 <td>C/C++ compiler<sup><a href="#sf1">1</a></sup></td>
Reid Spencer748d82e2004-11-15 21:15:12 +0000367 </tr>
Misha Brukman00c73d22003-11-07 19:43:14 +0000368
Reid Spencer748d82e2004-11-15 21:15:12 +0000369 <tr>
Chris Lattner2286cab2005-09-06 04:07:15 +0000370 <td><a href="http://www.gnu.org/software/texinfo">TeXinfo</a></td>
371 <td>4.5</td>
372 <td>For building the CFE</td>
373 </tr>
374
375 <tr>
Reid Spencer748d82e2004-11-15 21:15:12 +0000376 <td><a href="http://www.gnu.org/software/flex">Flex</a></td>
377 <td>2.5.4</td>
378 <td>LEX compiler</td>
379 </tr>
Misha Brukman00c73d22003-11-07 19:43:14 +0000380
Reid Spencer748d82e2004-11-15 21:15:12 +0000381 <tr>
382 <td><a href="http://www.gnu.org/software/bison/bison.html">Bison</a></td>
Jeff Cohen4896c5d2006-01-04 06:51:22 +0000383 <td>1.28, 1.35, 1.75, 1.875d, 2.0, or 2.1<br>(not 1.85 or 1.875)</td>
Reid Spencer748d82e2004-11-15 21:15:12 +0000384 <td>YACC compiler</td>
385 </tr>
Misha Brukman00c73d22003-11-07 19:43:14 +0000386
Reid Spencer748d82e2004-11-15 21:15:12 +0000387 <tr>
Misha Brukman6d8e1532005-02-09 22:38:47 +0000388 <td><a href="https://www.cvshome.org/downloads.html">CVS</a></td>
389 <td>&ge;1.11</td>
390 <td>CVS access to LLVM<sup><a href="#sf2">2</a></sup></td>
391 </tr>
392
393 <tr>
Reid Spencer748d82e2004-11-15 21:15:12 +0000394 <td><a href="http://savannah.gnu.org/projects/dejagnu">DejaGnu</a></td>
395 <td>1.4.2</td>
Misha Brukman6d8e1532005-02-09 22:38:47 +0000396 <td>Automated test suite<sup><a href="#sf3">3</a></sup></td>
Reid Spencer748d82e2004-11-15 21:15:12 +0000397 </tr>
Misha Brukman00c73d22003-11-07 19:43:14 +0000398
Reid Spencer748d82e2004-11-15 21:15:12 +0000399 <tr>
400 <td><a href="http://www.tcl.tk/software/tcltk/">tcl</a></td>
401 <td>8.3, 8.4</td>
Misha Brukman6d8e1532005-02-09 22:38:47 +0000402 <td>Automated test suite<sup><a href="#sf3">3</a></sup></td>
Reid Spencer748d82e2004-11-15 21:15:12 +0000403 </tr>
Misha Brukman00c73d22003-11-07 19:43:14 +0000404
Reid Spencer748d82e2004-11-15 21:15:12 +0000405 <tr>
406 <td><a href="http://expect.nist.gov/">expect</a></td>
407 <td>5.38.0</td>
Misha Brukman6d8e1532005-02-09 22:38:47 +0000408 <td>Automated test suite<sup><a href="#sf3">3</a></sup></td>
Reid Spencer748d82e2004-11-15 21:15:12 +0000409 </tr>
410
411 <tr>
412 <td><a href="http://www.perl.com/download.csp">perl</a></td>
Reid Spencer200d93b2004-12-09 17:55:37 +0000413 <td>&ge;5.6.0</td>
Reid Spencer748d82e2004-11-15 21:15:12 +0000414 <td>Nightly tester, utilities</td>
415 </tr>
416
417 <tr>
Misha Brukman6d8e1532005-02-09 22:38:47 +0000418 <td><a href="http://savannah.gnu.org/projects/m4">GNU M4</a>
419 <td>1.4</td>
420 <td>Macro processor for configuration<sup><a href="#sf4">4</a></sup></td>
Reid Spencer748d82e2004-11-15 21:15:12 +0000421 </tr>
422
423 <tr>
Misha Brukman6d8e1532005-02-09 22:38:47 +0000424 <td><a href="http://www.gnu.org/software/autoconf">GNU Autoconf</a></td>
425 <td>2.59</td>
426 <td>Configuration script builder<sup><a href="#sf4">4</a></sup></td>
427 </tr>
428
429 <tr>
430 <td><a href="http://www.gnu.org/software/automake">GNU Automake</a></td>
431 <td>1.9.2</td>
432 <td>aclocal macro generator<sup><a href="#sf4">4</a></sup></td>
433 </tr>
434
435 <tr>
436 <td><a href="http://savannah.gnu.org/projects/libtool">libtool</a></td>
437 <td>1.5.10</td>
438 <td>Shared library manager<sup><a href="#sf4">4</a></sup></td>
Reid Spencer748d82e2004-11-15 21:15:12 +0000439 </tr>
440
441 </table>
442
Misha Brukman6d8e1532005-02-09 22:38:47 +0000443 <p><b>Notes:</b></p>
444 <div class="doc_notes">
Reid Spencer748d82e2004-11-15 21:15:12 +0000445 <ol>
Chris Lattner9abd8af2006-09-07 04:19:09 +0000446 <li><a name="sf1">Only the C and C++ languages are needed so there's no
Misha Brukman6d8e1532005-02-09 22:38:47 +0000447 need to build the other languages for LLVM's purposes.</a> See
448 <a href="#brokengcc">below</a> for specific version info.</li>
449 <li><a name="sf2">You only need CVS if you intend to build from the
450 latest LLVM sources. If you're working from a release distribution, you
451 don't need CVS.</a></li>
452 <li><a name="sf3">Only needed if you want to run the automated test
453 suite in the <tt>llvm/test</tt> directory.</a></li>
454 <li><a name="sf4">If you want to make changes to the configure scripts,
Reid Spencer748d82e2004-11-15 21:15:12 +0000455 you will need GNU autoconf (2.59), and consequently, GNU M4 (version 1.4
Reid Spencer200d93b2004-12-09 17:55:37 +0000456 or higher). You will also need automake (1.9.2). We only use aclocal
457 from that package.</a></li>
Reid Spencer748d82e2004-11-15 21:15:12 +0000458 </ol>
Misha Brukman6d8e1532005-02-09 22:38:47 +0000459 </div>
460
Reid Spencer748d82e2004-11-15 21:15:12 +0000461 <p>Additionally, your compilation host is expected to have the usual
462 plethora of Unix utilities. Specifically:</p>
463 <ul>
464 <li><b>ar</b> - archive library builder</li>
465 <li><b>bzip2*</b> - bzip2 command for distribution generation</li>
466 <li><b>bunzip2*</b> - bunzip2 command for distribution checking</li>
467 <li><b>chmod</b> - change permissions on a file</li>
John Criswellc4ef3f22004-12-08 16:55:27 +0000468 <li><b>cat</b> - output concatenation utility</li>
Reid Spencer748d82e2004-11-15 21:15:12 +0000469 <li><b>cp</b> - copy files</li>
470 <li><b>date</b> - print the current date/time </li>
471 <li><b>echo</b> - print to standard output</li>
472 <li><b>egrep</b> - extended regular expression search utility</li>
473 <li><b>etags</b> - C/C++ tag file creator for vim/emacs</li>
474 <li><b>find</b> - find files/dirs in a file system</li>
475 <li><b>grep</b> - regular expression search utility</li>
476 <li><b>gzip*</b> - gzip command for distribution generation</li>
477 <li><b>gunzip*</b> - gunzip command for distribution checking</li>
478 <li><b>install</b> - install directories/files </li>
479 <li><b>mkdir</b> - create a directory</li>
480 <li><b>mv</b> - move (rename) files</li>
481 <li><b>ranlib</b> - symbol table builder for archive libraries</li>
Misha Brukman616bd052004-11-20 01:27:40 +0000482 <li><b>rm</b> - remove (delete) files and directories</li>
Reid Spencer748d82e2004-11-15 21:15:12 +0000483 <li><b>sed</b> - stream editor for transforming output</li>
484 <li><b>sh</b> - Bourne shell for make build scripts</li>
485 <li><b>tar</b> - tape archive for distribution generation</li>
486 <li><b>test</b> - test things in file system</li>
487 <li><b>unzip*</b> - unzip command for distribution checking</li>
488 <li><b>zip*</b> - zip command for distribution generation</li>
489 </ul>
Chris Lattner95e92582004-07-18 22:32:22 +0000490</div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000491
Chris Lattner95e92582004-07-18 22:32:22 +0000492<!-- ======================================================================= -->
493<div class="doc_subsection">
494 <a name="brokengcc">Broken versions of GCC</a>
495</div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000496
Chris Lattner95e92582004-07-18 22:32:22 +0000497<div class="doc_text">
498
499<p>LLVM is very demanding of the host C++ compiler, and as such tends to expose
500bugs in the compiler. In particular, several versions of GCC crash when trying
Chris Lattner6557f182006-06-16 17:20:33 +0000501to compile LLVM. We routinely use GCC 3.3.3, 3.4.0, and Apple 4.0.1
502successfully with them (however, see below). Other versions of GCC will
503probably work as well. GCC versions listed
Chris Lattner95e92582004-07-18 22:32:22 +0000504here are known to not work. If you are using one of these versions, please try
505to upgrade your GCC to something more recent. If you run into a problem with a
506version of GCC not listed here, please <a href="mailto:llvmdev@cs.uiuc.edu">let
507us know</a>. Please use the "<tt>gcc -v</tt>" command to find out which version
508of GCC you are using.
509</p>
510
511<p><b>GCC versions prior to 3.0</b>: GCC 2.96.x and before had several
512problems in the STL that effectively prevent it from compiling LLVM.
513</p>
514
John Criswell294ba022004-11-23 22:06:24 +0000515<p><b>GCC 3.2.2</b>: This version of GCC fails to compile LLVM.</p>
516
Chris Lattner95e92582004-07-18 22:32:22 +0000517<p><b>GCC 3.3.2</b>: This version of GCC suffered from a <a
518href="http://gcc.gnu.org/PR13392">serious bug</a> which causes it to crash in
519the "<tt>convert_from_eh_region_ranges_1</tt>" GCC function.</p>
Chris Lattner25e7b162005-02-12 20:11:13 +0000520
Chris Lattner8e64f152005-02-13 22:20:49 +0000521<p><b>Cygwin GCC 3.3.3</b>: The version of GCC 3.3.3 commonly shipped with
522 Cygwin does not work. Please <a href="CFEBuildInstrs.html#cygwin">upgrade
523 to a newer version</a> if possible.</p>
524<p><b>SuSE GCC 3.3.3</b>: The version of GCC 3.3.3 shipped with SuSE 9.1 (and
525 possibly others) does not compile LLVM correctly (it appears that exception
526 handling is broken in some cases). Please download the FSF 3.3.3 or upgrade
527 to a newer version of GCC.</p>
Chris Lattner77c2af62007-04-01 20:14:46 +0000528<p><b>GCC 3.4.x</b> on X86-64/amd64</b>: GCC <a href="http://llvm.org/PR1056">
529 miscompiles portions of LLVM</a>.</p>
Chris Lattnerf2b5e6e2005-05-15 22:26:45 +0000530<p><b>IA-64 GCC 4.0.0</b>: The IA-64 version of GCC 4.0.0 is known to
531 miscompile LLVM.</p>
Chris Lattnerdd197912006-06-16 19:53:39 +0000532<p><b>Apple Xcode 2.3</b>: GCC crashes when compiling LLVM at -O3 (which is the
533 default with ENABLE_OPTIMIZED=1. To work around this, build with
534 "ENABLE_OPTIMIZED=1 OPTIMIZE_OPTION=-O2".</p>
Chris Lattnerc40eb5e2006-09-07 17:34:27 +0000535<p><b>GCC 4.1.1</b>: GCC fails to build LLVM with template concept check errors
536 compiling some files. At the time of this writing, GCC mainline (4.2)
537 did not share the problem.</p>
Chris Lattner78ce3b82007-01-04 07:06:05 +0000538<p><b>GCC 4.1.1 on X86-64/amd64</b>: GCC <a href="http://llvm.org/PR1063">
539 miscompiles portions of LLVM</a> when compiling llvm itself into 64-bit
540 code. LLVM will appear to mostly work but will be buggy, e.g. failing
541 portions of its testsuite.</p>
Reid Spencer72f92f02007-04-11 21:28:31 +0000542<p><b>GCC 4.1.2 on OpenSUSE</b>: Seg faults during libstdc++ build and on x86_64
543platforms compiling md5.c gets a mangled constant.</p>
Reid Spencer7a119082006-11-04 00:33:42 +0000544<p><b>GNU ld 2.16.X</b>. Some 2.16.X versions of the ld linker will produce very
545long warning messages complaining that some ".gnu.linkonce.t.*" symbol was
546defined in a discarded section. You can safely ignore these messages as they are
547erroneous and the linkage is correct. These messages disappear using ld
5482.17.</p>
Misha Brukman00c73d22003-11-07 19:43:14 +0000549</div>
550
Chris Lattner95e92582004-07-18 22:32:22 +0000551
552
Misha Brukman00c73d22003-11-07 19:43:14 +0000553<!-- *********************************************************************** -->
554<div class="doc_section">
555 <a name="starting"><b>Getting Started with LLVM</b></a>
556</div>
557<!-- *********************************************************************** -->
558
Chris Lattner95e92582004-07-18 22:32:22 +0000559<div class="doc_text">
560
561<p>The remainder of this guide is meant to get you up and running with
562LLVM and to give you some basic information about the LLVM environment.</p>
563
564<p>The later sections of this guide describe the <a
565href="#layout">general layout</a> of the the LLVM source tree, a <a
566href="#tutorial">simple example</a> using the LLVM tool chain, and <a
567href="#links">links</a> to find more information about LLVM or to get
568help via e-mail.</p>
569</div>
570
Misha Brukman00c73d22003-11-07 19:43:14 +0000571<!-- ======================================================================= -->
572<div class="doc_subsection">
573 <a name="terminology">Terminology and Notation</a>
574</div>
575
576<div class="doc_text">
577
578<p>Throughout this manual, the following names are used to denote paths
579specific to the local system and working environment. <i>These are not
580environment variables you need to set but just strings used in the rest
581of this document below</i>. In any of the examples below, simply replace
582each of these names with the appropriate pathname on your local system.
583All these paths are absolute:</p>
584
Misha Brukman54111c42004-01-20 00:20:17 +0000585<dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000586 <dt>SRC_ROOT
587 <dd>
588 This is the top level directory of the LLVM source tree.
Chris Lattner9abd8af2006-09-07 04:19:09 +0000589 <br><br>
John Criswell0f6d7c02003-10-27 18:18:16 +0000590
Misha Brukman00c73d22003-11-07 19:43:14 +0000591 <dt>OBJ_ROOT
592 <dd>
593 This is the top level directory of the LLVM object tree (i.e. the
594 tree where object files and compiled programs will be placed. It
595 can be the same as SRC_ROOT).
Chris Lattner9abd8af2006-09-07 04:19:09 +0000596 <br><br>
Misha Brukman00c73d22003-11-07 19:43:14 +0000597
598 <dt>LLVMGCCDIR
599 <dd>
Reid Spencerfef93b72004-12-26 05:47:26 +0000600 This is where the LLVM GCC Front End is installed.
Misha Brukman00c73d22003-11-07 19:43:14 +0000601 <p>
602 For the pre-built GCC front end binaries, the LLVMGCCDIR is
Tanya Lattnerf7b6be02006-11-20 06:04:46 +0000603 <tt>llvm-gcc/<i>platform</i>/llvm-gcc</tt>.
Misha Brukman00c73d22003-11-07 19:43:14 +0000604</dl>
605
606</div>
607
608<!-- ======================================================================= -->
609<div class="doc_subsection">
610 <a name="environment">Setting Up Your Environment</a>
611</div>
612
613<div class="doc_text">
614
615<p>
Misha Brukman8f0cad12005-02-03 18:28:08 +0000616In order to compile and use LLVM, you may need to set some environment
617variables.
Misha Brukman00c73d22003-11-07 19:43:14 +0000618
Misha Brukman54111c42004-01-20 00:20:17 +0000619<dl>
Reid Spencerf96eb572004-12-15 00:14:01 +0000620 <dt><tt>LLVM_LIB_SEARCH_PATH</tt>=<tt>/path/to/your/bytecode/libs</tt></dt>
Misha Brukman8f0cad12005-02-03 18:28:08 +0000621 <dd>[Optional] This environment variable helps LLVM linking tools find the
John Criswell8bfe6a72005-05-18 19:43:33 +0000622 locations of your bytecode libraries. It is provided only as a
Misha Brukman8f0cad12005-02-03 18:28:08 +0000623 convenience since you can specify the paths using the -L options of the
John Criswell8bfe6a72005-05-18 19:43:33 +0000624 tools and the C/C++ front-end will automatically use the bytecode files
625 installed in its
Misha Brukman8f0cad12005-02-03 18:28:08 +0000626 <tt>lib</tt> directory.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000627</dl>
628
629</div>
630
631<!-- ======================================================================= -->
632<div class="doc_subsection">
Misha Brukman54111c42004-01-20 00:20:17 +0000633 <a name="unpack">Unpacking the LLVM Archives</a>
Misha Brukman00c73d22003-11-07 19:43:14 +0000634</div>
635
636<div class="doc_text">
637
638<p>
639If you have the LLVM distribution, you will need to unpack it before you
John Criswelld000e1d2003-12-18 16:43:17 +0000640can begin to compile it. LLVM is distributed as a set of two files: the LLVM
John Criswell9e2485c2004-12-10 15:51:16 +0000641suite and the LLVM GCC front end compiled for your platform. There is an
642additional test suite that is optional. Each file is a TAR archive that is
643compressed with the gzip program.
Misha Brukman00c73d22003-11-07 19:43:14 +0000644</p>
645
Misha Brukman3ce11032005-02-02 18:01:57 +0000646<p>The files are as follows, with <em>x.y</em> marking the version number:
Misha Brukman54111c42004-01-20 00:20:17 +0000647<dl>
Misha Brukman3ce11032005-02-02 18:01:57 +0000648 <dt><tt>llvm-x.y.tar.gz</tt></dt>
649 <dd>Source release for the LLVM libraries and tools.<br/></dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000650
Misha Brukman3ce11032005-02-02 18:01:57 +0000651 <dt><tt>llvm-test-x.y.tar.gz</tt></dt>
Chris Lattner7db3f522005-02-09 21:15:51 +0000652 <dd>Source release for the LLVM test suite.</dd>
Misha Brukman8f9e6d62004-11-23 19:26:24 +0000653
Chris Lattner1ef81af2006-04-20 05:08:23 +0000654 <dt><tt>llvm-gcc4-x.y.source.tar.gz</tt></dt>
655 <dd>Source release of the llvm-gcc4 front end. See README.LLVM in the root
656 directory for build instructions.<br/></dd>
657
Tanya Lattnerf7b6be02006-11-20 06:04:46 +0000658 <dt><tt>llvm-gcc4-x.y-platform.tar.gz</tt></dt>
659 <dd>Binary release of the llvm-gcc4 front end for a specific platform.<br/></dd>
Chris Lattner1ef81af2006-04-20 05:08:23 +0000660
Misha Brukman00c73d22003-11-07 19:43:14 +0000661</dl>
662
Jim Laskey6c3acb72006-07-31 21:37:55 +0000663<p>It is also possible to download the sources of the llvm-gcc4 front end from a
664read-only subversion mirror at
665svn://anonsvn.opensource.apple.com/svn/llvm/trunk. </p>
Jim Laskey3261f0b2006-06-16 23:20:21 +0000666
Misha Brukman00c73d22003-11-07 19:43:14 +0000667</div>
668
669<!-- ======================================================================= -->
670<div class="doc_subsection">
Misha Brukman54111c42004-01-20 00:20:17 +0000671 <a name="checkout">Checkout LLVM from CVS</a>
Misha Brukman00c73d22003-11-07 19:43:14 +0000672</div>
673
674<div class="doc_text">
675
676<p>If you have access to our CVS repository, you can get a fresh copy of
677the entire source code. All you need to do is check it out from CVS as
678follows:</p>
679
680<ul>
681<li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
Chris Lattnerc75a04b2006-08-03 22:14:43 +0000682 <li><tt>cvs -d :pserver:anon@llvm.org:/var/cvs/llvm login</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000683 <li>Hit the return key when prompted for the password.
Chris Lattnerc75a04b2006-08-03 22:14:43 +0000684 <li><tt>cvs -z3 -d :pserver:anon@llvm.org:/var/cvs/llvm co
Misha Brukman00c73d22003-11-07 19:43:14 +0000685 llvm</tt>
686</ul>
687
688<p>This will create an '<tt>llvm</tt>' directory in the current
689directory and fully populate it with the LLVM source code, Makefiles,
690test directories, and local copies of documentation files.</p>
691
Misha Brukman54111c42004-01-20 00:20:17 +0000692<p>If you want to get a specific release (as opposed to the most recent
693revision), you can specify a label. The following releases have the following
Misha Brukman3ce11032005-02-02 18:01:57 +0000694labels:</p>
Misha Brukman54111c42004-01-20 00:20:17 +0000695
John Criswelld000e1d2003-12-18 16:43:17 +0000696<ul>
Tanya Lattner134693a2006-11-20 06:07:10 +0000697<li>Release 1.9: <b>RELEASE_19</b></li>
Tanya Lattnerf7b6be02006-11-20 06:04:46 +0000698<li>Release 1.8: <b>RELEASE_18</b></li>
Tanya Lattner993b9802006-04-20 04:35:34 +0000699<li>Release 1.7: <b>RELEASE_17</b></li>
John Criswellc0c186d2005-11-08 21:11:33 +0000700<li>Release 1.6: <b>RELEASE_16</b></li>
John Criswell75162552005-05-09 16:49:59 +0000701<li>Release 1.5: <b>RELEASE_15</b></li>
Reid Spencer66db92e2004-12-08 16:51:31 +0000702<li>Release 1.4: <b>RELEASE_14</b></li>
John Criswell18b74642004-08-16 14:51:33 +0000703<li>Release 1.3: <b>RELEASE_13</b></li>
Misha Brukmanb9be2bf2004-05-12 19:25:59 +0000704<li>Release 1.2: <b>RELEASE_12</b></li>
705<li>Release 1.1: <b>RELEASE_11</b></li>
706<li>Release 1.0: <b>RELEASE_1</b></li>
John Criswelld000e1d2003-12-18 16:43:17 +0000707</ul>
John Criswelld000e1d2003-12-18 16:43:17 +0000708
Reid Spencer66db92e2004-12-08 16:51:31 +0000709<p>If you would like to get the LLVM test suite (a separate package as of 1.4),
710you get it from the CVS repository:</p>
711<pre>
712 cd llvm/projects
Chris Lattnerc75a04b2006-08-03 22:14:43 +0000713 cvs -z3 -d :pserver:anon@llvm.org:/var/cvs/llvm co llvm-test
Reid Spencer66db92e2004-12-08 16:51:31 +0000714</pre>
715<p>By placing it in the <tt>llvm/projects</tt>, it will be automatically
John Criswellc4ef3f22004-12-08 16:55:27 +0000716configured by the LLVM configure script as well as automatically updated when
Reid Spencer66db92e2004-12-08 16:51:31 +0000717you run <tt>cvs update</tt>.</p>
718
Chris Lattner82ad9f12007-03-06 06:27:34 +0000719<p>If you would like to get the GCC front end source code, you can also get it
720and build it yourself. Please follow <a href="CFEBuildInstrs.html">these
721instructions</a> to successfully get and build the LLVM GCC front-end.</p>
Chris Lattner604fdc12004-06-28 17:14:01 +0000722
Misha Brukman00c73d22003-11-07 19:43:14 +0000723</div>
724
725<!-- ======================================================================= -->
726<div class="doc_subsection">
Misha Brukman54111c42004-01-20 00:20:17 +0000727 <a name="installcf">Install the GCC Front End</a>
Misha Brukman00c73d22003-11-07 19:43:14 +0000728</div>
729
730<div class="doc_text">
731
Chris Lattnerbcb38cf2007-02-14 07:33:00 +0000732<p>Before configuring and compiling the LLVM suite, you can optionally extract the
733LLVM GCC front end from the binary distribution. It is used for running the
734llvm-test testsuite and for compiling C/C++ programs. Note that you can optionally
735<a href="CFEBuildInstrs.html">build llvm-gcc yourself</a> after building the
736main LLVM repository.</p>
Misha Brukman00c73d22003-11-07 19:43:14 +0000737
738<p>To install the GCC front end, do the following:</p>
739
740<ol>
741 <li><tt>cd <i>where-you-want-the-front-end-to-live</i></tt></li>
Tanya Lattnerf7b6be02006-11-20 06:04:46 +0000742 <li><tt>gunzip --stdout llvmgcc-<i>version</i>.<i>platform</i>.tar.gz | tar -xvf
Misha Brukman00c73d22003-11-07 19:43:14 +0000743 -</tt></li>
744</ol>
745
Chris Lattnerbcb38cf2007-02-14 07:33:00 +0000746<p>Once the binary is uncompressed, you should add a symlink for llvm-gcc and
747llvm-g++ to some directory in your path. When you configure LLVM, it will
748automatically detect llvm-gcc's presence (if it is in your path) enabling its
749use in llvm-test. Note that you can always build or install llvm-gcc at any
750pointer after building the main LLVM repository: just reconfigure llvm and
751llvm-test will pick it up.
752</p>
753
Misha Brukman00c73d22003-11-07 19:43:14 +0000754<p>The binary versions of the GCC front end may not suit all of your needs. For
755example, the binary distribution may include an old version of a system header
756file, not "fix" a header file that needs to be fixed for GCC, or it may be
757linked with libraries not available on your system.</p>
758
759<p>In cases like these, you may want to try <a
760href="CFEBuildInstrs.html">building the GCC front end from source.</a> This is
Chris Lattnerf76e7bb2007-02-14 07:34:22 +0000761much easier now than it was in the past.</p>
Misha Brukman00c73d22003-11-07 19:43:14 +0000762
763</div>
764
765<!-- ======================================================================= -->
766<div class="doc_subsection">
767 <a name="config">Local LLVM Configuration</a>
768</div>
769
770<div class="doc_text">
771
772<p>Once checked out from the CVS repository, the LLVM suite source code must be
Reid Spencer66db92e2004-12-08 16:51:31 +0000773configured via the <tt>configure</tt> script. This script sets variables in the
774various <tt>*.in</tt> files, most notably <tt>llvm/Makefile.config</tt> and
775<tt>llvm/include/Config/config.h</tt>. It also populates <i>OBJ_ROOT</i> with
776the Makefiles needed to begin building LLVM.</p>
Misha Brukman00c73d22003-11-07 19:43:14 +0000777
778<p>The following environment variables are used by the <tt>configure</tt>
779script to configure the build system:</p>
780
Chris Lattner9abd8af2006-09-07 04:19:09 +0000781<table summary="LLVM configure script environment variables">
Reid Spencerd3f876c2004-11-01 08:19:36 +0000782 <tr><th>Variable</th><th>Purpose</th></tr>
Misha Brukman00c73d22003-11-07 19:43:14 +0000783 <tr>
784 <td>CC</td>
785 <td>Tells <tt>configure</tt> which C compiler to use. By default,
786 <tt>configure</tt> will look for the first GCC C compiler in
787 <tt>PATH</tt>. Use this variable to override
788 <tt>configure</tt>'s default behavior.</td>
789 </tr>
Misha Brukman00c73d22003-11-07 19:43:14 +0000790 <tr>
791 <td>CXX</td>
792 <td>Tells <tt>configure</tt> which C++ compiler to use. By default,
793 <tt>configure</tt> will look for the first GCC C++ compiler in
794 <tt>PATH</tt>. Use this variable to override
795 <tt>configure</tt>'s default behavior.</td>
796 </tr>
797</table>
798
799<p>The following options can be used to set or enable LLVM specific options:</p>
800
Misha Brukman54111c42004-01-20 00:20:17 +0000801<dl>
Reid Spencerfef93b72004-12-26 05:47:26 +0000802 <dt><i>--with-llvmgccdir</i></dt>
803 <dd>Path to the LLVM C/C++ FrontEnd to be used with this LLVM configuration.
804 The value of this option should specify the full pathname of the C/C++ Front
805 End to be used. If this option is not provided, the PATH will be searched for
806 a program named <i>llvm-gcc</i> and the C/C++ FrontEnd install directory will
807 be inferred from the path found. If the option is not given, and no llvm-gcc
808 can be found in the path then a warning will be produced by
809 <tt>configure</tt> indicating this situation. LLVM may still be built with
810 the <tt>tools-only</tt> target but attempting to build the runtime libraries
811 will fail as these libraries require llvm-gcc and llvm-g++. See
812 <a href="#installcf">Install the GCC Front End</a> for details on installing
813 the C/C++ Front End. See
814 <a href="CFEBuildInstrs.html">Bootstrapping the LLVM C/C++ Front-End</a>
815 for details on building the C/C++ Front End.</dd>
Reid Spencer66db92e2004-12-08 16:51:31 +0000816 <dt><i>--with-tclinclude</i></dt>
John Criswell8bfe6a72005-05-18 19:43:33 +0000817 <dd>Path to the tcl include directory under which <tt>tclsh</tt> can be
Reid Spencer66db92e2004-12-08 16:51:31 +0000818 found. Use this if you have multiple tcl installations on your machine and you
819 want to use a specific one (8.x) for LLVM. LLVM only uses tcl for running the
820 dejagnu based test suite in <tt>llvm/test</tt>. If you don't specify this
John Criswell8bfe6a72005-05-18 19:43:33 +0000821 option, the LLVM configure script will search for the tcl 8.4 and 8.3
822 releases.
Chris Lattner9abd8af2006-09-07 04:19:09 +0000823 <br><br>
Reid Spencer66db92e2004-12-08 16:51:31 +0000824 </dd>
825 <dt><i>--enable-optimized</i></dt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000826 <dd>
827 Enables optimized compilation by default (debugging symbols are removed
828 and GCC optimization flags are enabled). The default is to use an
829 unoptimized build (also known as a debug build).
Chris Lattner9abd8af2006-09-07 04:19:09 +0000830 <br><br>
Reid Spencer66db92e2004-12-08 16:51:31 +0000831 </dd>
Reid Spencer9d57b4d2005-12-21 03:46:45 +0000832 <dt><i>--enable-debug-runtime</i></dt>
833 <dd>
834 Enables debug symbols in the runtime libraries. The default is to strip
835 debug symbols from the runtime libraries.
836 </dd>
Reid Spencer66db92e2004-12-08 16:51:31 +0000837 <dt><i>--enable-jit</i></dt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000838 <dd>
John Criswelld000e1d2003-12-18 16:43:17 +0000839 Compile the Just In Time (JIT) compiler functionality. This is not
840 available
Misha Brukman00c73d22003-11-07 19:43:14 +0000841 on all platforms. The default is dependent on platform, so it is best
842 to explicitly enable it if you want it.
Chris Lattner9abd8af2006-09-07 04:19:09 +0000843 <br><br>
Reid Spencer66db92e2004-12-08 16:51:31 +0000844 </dd>
Reid Spencer2dedcf52005-04-22 17:58:03 +0000845 <dt><i>--enable-targets=</i><tt>target-option</tt></dt>
846 <dd>Controls which targets will be built and linked into llc. The default
847 value for <tt>target_options</tt> is "all" which builds and links all
848 available targets. The value "host-only" can be specified to build only a
849 native compiler (no cross-compiler targets available). The "native" target is
850 selected as the target of the build host. You can also specify a comma
851 separated list of target names that you want available in llc. The target
John Criswell8bfe6a72005-05-18 19:43:33 +0000852 names use all lower case. The current set of targets is: <br/>
Reid Spencer2dedcf52005-04-22 17:58:03 +0000853 <tt>alpha, ia64, powerpc, skeleton, sparc, x86</tt>.
Chris Lattner9abd8af2006-09-07 04:19:09 +0000854 <br><br></dd>
Reid Spencer66db92e2004-12-08 16:51:31 +0000855 <dt><i>--enable-doxygen</i></dt>
856 <dd>Look for the doxygen program and enable construction of doxygen based
857 documentation from the source code. This is disabled by default because
858 generating the documentation can take a long time and producess 100s of
859 megabytes of output.</dd>
Anton Korobeynikov8cea37b2007-01-23 12:35:46 +0000860 <dt><i>--with-udis86</i></dt>
861 <dd>LLVM can use external disassembler library for various purposes (now it's
862 used only for examining code produced by JIT). This option will enable usage
863 of <a href="http://udis86.sourceforge.net/">udis86</a> x86 (both 32 and 64
864 bits) disassembler library.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000865</dl>
866
867<p>To configure LLVM, follow these steps:</p>
868
869<ol>
870 <li>Change directory into the object root directory:
John Criswell0f6d7c02003-10-27 18:18:16 +0000871 <br>
Misha Brukman00c73d22003-11-07 19:43:14 +0000872 <tt>cd <i>OBJ_ROOT</i></tt>
Chris Lattner9abd8af2006-09-07 04:19:09 +0000873 <br><br>
John Criswell0f6d7c02003-10-27 18:18:16 +0000874
Misha Brukman00c73d22003-11-07 19:43:14 +0000875 <li>Run the <tt>configure</tt> script located in the LLVM source tree:
876 <br>
Reid Spencer66db92e2004-12-08 16:51:31 +0000877 <tt><i>SRC_ROOT</i>/configure --prefix=/install/path [other options]</tt>
Chris Lattner9abd8af2006-09-07 04:19:09 +0000878 <br><br>
Misha Brukman00c73d22003-11-07 19:43:14 +0000879</ol>
John Criswell85ed3612003-06-12 19:34:44 +0000880
Misha Brukman00c73d22003-11-07 19:43:14 +0000881</div>
John Criswell85ed3612003-06-12 19:34:44 +0000882
Misha Brukman00c73d22003-11-07 19:43:14 +0000883<!-- ======================================================================= -->
884<div class="doc_subsection">
885 <a name="compile">Compiling the LLVM Suite Source Code</a>
886</div>
John Criswell85ed3612003-06-12 19:34:44 +0000887
Misha Brukman00c73d22003-11-07 19:43:14 +0000888<div class="doc_text">
John Criswell0b459202003-07-08 20:35:59 +0000889
Misha Brukman00c73d22003-11-07 19:43:14 +0000890<p>Once you have configured LLVM, you can build it. There are three types of
891builds:</p>
John Criswell0b459202003-07-08 20:35:59 +0000892
Misha Brukman54111c42004-01-20 00:20:17 +0000893<dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000894 <dt>Debug Builds
John Criswellce760f62003-07-03 16:01:38 +0000895 <dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000896 These builds are the default when one types <tt>gmake</tt> (unless the
897 <tt>--enable-optimized</tt> option was used during configuration). The
898 build system will compile the tools and libraries with debugging
899 information.
Chris Lattner9abd8af2006-09-07 04:19:09 +0000900 <br><br>
Misha Brukman00c73d22003-11-07 19:43:14 +0000901
902 <dt>Release (Optimized) Builds
John Criswellce760f62003-07-03 16:01:38 +0000903 <dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000904 These builds are enabled with the <tt>--enable-optimized</tt> option to
905 <tt>configure</tt> or by specifying <tt>ENABLE_OPTIMIZED=1</tt> on the
906 <tt>gmake</tt> command line. For these builds, the build system will
907 compile the tools and libraries with GCC optimizations enabled and strip
908 debugging information from the libraries and executables it generates.
Chris Lattner9abd8af2006-09-07 04:19:09 +0000909 <br><br>
Misha Brukman00c73d22003-11-07 19:43:14 +0000910
911 <dt>Profile Builds
John Criswellce760f62003-07-03 16:01:38 +0000912 <dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000913 These builds are for use with profiling. They compile profiling
914 information into the code for use with programs like <tt>gprof</tt>.
915 Profile builds must be started by specifying <tt>ENABLE_PROFILING=1</tt>
916 on the <tt>gmake</tt> command line.
917</dl>
John Criswell7a73b802003-06-30 21:59:07 +0000918
Misha Brukman00c73d22003-11-07 19:43:14 +0000919<p>Once you have LLVM configured, you can build it by entering the
920<i>OBJ_ROOT</i> directory and issuing the following command:</p>
John Criswell20d2d3e2003-10-10 14:26:14 +0000921
Misha Brukman00c73d22003-11-07 19:43:14 +0000922<p><tt>gmake</tt></p>
John Criswell20d2d3e2003-10-10 14:26:14 +0000923
Chris Lattner95e92582004-07-18 22:32:22 +0000924<p>If the build fails, please <a href="#brokengcc">check here</a> to see if you
John Criswell3d8ba512004-12-08 17:53:54 +0000925are using a version of GCC that is known not to compile LLVM.</p>
Chris Lattner95e92582004-07-18 22:32:22 +0000926
927<p>
928If you have multiple processors in your machine, you may wish to use some of
Misha Brukman00c73d22003-11-07 19:43:14 +0000929the parallel build options provided by GNU Make. For example, you could use the
930command:</p>
John Criswell85ed3612003-06-12 19:34:44 +0000931
Misha Brukman00c73d22003-11-07 19:43:14 +0000932<p><tt>gmake -j2</tt></p>
John Criswellce760f62003-07-03 16:01:38 +0000933
Misha Brukman00c73d22003-11-07 19:43:14 +0000934<p>There are several special targets which are useful when working with the LLVM
935source code:</p>
John Criswellce760f62003-07-03 16:01:38 +0000936
Misha Brukman54111c42004-01-20 00:20:17 +0000937<dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000938 <dt><tt>gmake clean</tt>
939 <dd>
940 Removes all files generated by the build. This includes object files,
941 generated C/C++ files, libraries, and executables.
Chris Lattner9abd8af2006-09-07 04:19:09 +0000942 <br><br>
John Criswellce760f62003-07-03 16:01:38 +0000943
Reid Spencer66db92e2004-12-08 16:51:31 +0000944 <dt><tt>gmake dist-clean</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000945 <dd>
Misha Brukmanad38e962004-08-21 23:40:49 +0000946 Removes everything that <tt>gmake clean</tt> does, but also removes files
947 generated by <tt>configure</tt>. It attempts to return the source tree to the
948 original state in which it was shipped.
Chris Lattner9abd8af2006-09-07 04:19:09 +0000949 <br><br>
John Criswellce760f62003-07-03 16:01:38 +0000950
Misha Brukmane51c3562004-08-23 20:25:33 +0000951 <dt><tt>gmake install</tt>
952 <dd>
John Criswell3d8ba512004-12-08 17:53:54 +0000953 Installs LLVM header files, libraries, tools, and documentation in a
954 hierarchy
Reid Spencer66db92e2004-12-08 16:51:31 +0000955 under $PREFIX, specified with <tt>./configure --prefix=[dir]</tt>, which
956 defaults to <tt>/usr/local</tt>.
Chris Lattner9abd8af2006-09-07 04:19:09 +0000957 <br><br>
958
Reid Spencer66db92e2004-12-08 16:51:31 +0000959 <dt><tt>gmake -C runtime install-bytecode</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000960 <dd>
Reid Spencer7863c402004-11-11 07:30:27 +0000961 Assuming you built LLVM into $OBJDIR, when this command is run, it will
962 install bytecode libraries into the GCC front end's bytecode library
963 directory. If you need to update your bytecode libraries,
Misha Brukmanad38e962004-08-21 23:40:49 +0000964 this is the target to use once you've built them.
Chris Lattner9abd8af2006-09-07 04:19:09 +0000965 <br><br>
Misha Brukman00c73d22003-11-07 19:43:14 +0000966</dl>
John Criswellce760f62003-07-03 16:01:38 +0000967
Reid Spencer66db92e2004-12-08 16:51:31 +0000968<p>Please see the <a href="MakefileGuide.html">Makefile Guide</a> for further
969details on these <tt>make</tt> targets and descriptions of other targets
970available.</p>
971
Misha Brukman00c73d22003-11-07 19:43:14 +0000972<p>It is also possible to override default values from <tt>configure</tt> by
973declaring variables on the command line. The following are some examples:</p>
John Criswellce760f62003-07-03 16:01:38 +0000974
Misha Brukman54111c42004-01-20 00:20:17 +0000975<dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000976 <dt><tt>gmake ENABLE_OPTIMIZED=1</tt>
977 <dd>
978 Perform a Release (Optimized) build.
Chris Lattner9abd8af2006-09-07 04:19:09 +0000979 <br><br>
John Criswellce760f62003-07-03 16:01:38 +0000980
Reid Spencer004ba032006-04-09 23:45:38 +0000981 <dt><tt>gmake ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1</tt>
Chris Lattnerd4651262006-03-21 01:10:57 +0000982 <dd>
Reid Spencer004ba032006-04-09 23:45:38 +0000983 Perform a Release (Optimized) build without assertions enabled.
Chris Lattner9abd8af2006-09-07 04:19:09 +0000984 <br><br>
Chris Lattnerd4651262006-03-21 01:10:57 +0000985
Misha Brukman00c73d22003-11-07 19:43:14 +0000986 <dt><tt>gmake ENABLE_PROFILING=1</tt>
987 <dd>
988 Perform a Profiling build.
Chris Lattner9abd8af2006-09-07 04:19:09 +0000989 <br><br>
John Criswellce760f62003-07-03 16:01:38 +0000990
Misha Brukman00c73d22003-11-07 19:43:14 +0000991 <dt><tt>gmake VERBOSE=1</tt>
992 <dd>
993 Print what <tt>gmake</tt> is doing on standard output.
Chris Lattner9abd8af2006-09-07 04:19:09 +0000994 <br><br>
Reid Spencer66db92e2004-12-08 16:51:31 +0000995
996 <dt><tt>gmake TOOL_VERBOSE=1</tt></dt>
997 <dd>Ask each tool invoked by the makefiles to print out what it is doing on
John Criswell3d8ba512004-12-08 17:53:54 +0000998 the standard output. This also implies <tt>VERBOSE=1</tt>.
Chris Lattner9abd8af2006-09-07 04:19:09 +0000999 <br><br></dd>
Misha Brukman00c73d22003-11-07 19:43:14 +00001000</dl>
John Criswellce760f62003-07-03 16:01:38 +00001001
Misha Brukman00c73d22003-11-07 19:43:14 +00001002<p>Every directory in the LLVM object tree includes a <tt>Makefile</tt> to build
1003it and any subdirectories that it contains. Entering any directory inside the
1004LLVM object tree and typing <tt>gmake</tt> should rebuild anything in or below
1005that directory that is out of date.</p>
John Criswellce760f62003-07-03 16:01:38 +00001006
Misha Brukman00c73d22003-11-07 19:43:14 +00001007</div>
John Criswell20d2d3e2003-10-10 14:26:14 +00001008
Misha Brukman00c73d22003-11-07 19:43:14 +00001009<!-- ======================================================================= -->
1010<div class="doc_subsection">
Reid Spencerd30a9712006-07-27 06:41:31 +00001011 <a name="cross-compile">Cross-Compiling LLVM</a>
Reid Spencer17850ef2006-07-27 05:43:30 +00001012</div>
1013
1014<div class="doc_text">
Reid Spencerd30a9712006-07-27 06:41:31 +00001015 <p>It is possible to cross-compile LLVM. That is, you can create LLVM
1016 executables and libraries for a platform different than the one one which you
1017 are compiling. To do this, a few additional steps are
1018 required. <sup><a href="#ccn_1">1</a></sup> To cross-compile LLVM, use
Reid Spencer17850ef2006-07-27 05:43:30 +00001019 these instructions:</p>
1020 <ol>
Reid Spencerd30a9712006-07-27 06:41:31 +00001021 <li>Configure and build LLVM as a native compiler. You will need
Reid Spencer17850ef2006-07-27 05:43:30 +00001022 just <tt>TableGen</tt> from that build.
1023 <ul>
1024 <li>If you have <tt>$LLVM_OBJ_ROOT=$LLVM_SRC_ROOT</tt> just execute
1025 <tt>make -C utils/TableGen</tt> after configuring.</li>
1026 <li>Otherwise you will need to monitor building process and terminate
1027 it just after <tt>TableGen</tt> was built.</li>
1028 </ul>
1029 </li>
1030 <li>Copy the TableGen binary to somewhere safe (out of your build tree).
1031 </li>
Reid Spencerd30a9712006-07-27 06:41:31 +00001032 <li>Configure LLVM to build with a cross-compiler. To do this, supply the
Reid Spencer17850ef2006-07-27 05:43:30 +00001033 configure script with <tt>--build</tt> and <tt>--host</tt> options that
Reid Spencerd30a9712006-07-27 06:41:31 +00001034 are different. The values of these options must be legal target triples
1035 that your GCC compiler supports.</li>
Reid Spencer17850ef2006-07-27 05:43:30 +00001036 <li>Put the saved <tt>TableGen</tt> executable into the
1037 into <tt>$LLVM_OBJ_ROOT/{BUILD_TYPE}/bin</tt> directory (e.g. into
1038 <tt>.../Release/bin</tt> for a Release build).</li>
1039 <li>Build LLVM as usual.</li>
1040 </ol>
Reid Spencerd30a9712006-07-27 06:41:31 +00001041 <p>The result of such a build will produce executables that are not executable
1042 on your build host (--build option) but can be executed on your compile host
1043 (--host option).</p>
Reid Spencer17850ef2006-07-27 05:43:30 +00001044 <p><b>Notes:</b></p>
1045 <div class="doc_notes">
1046 <ol>
1047 <li><a name="ccn_1">Cross-compiling</a> was tested only with Linux as
1048 build platform and Windows as host using mingw32 cross-compiler. Other
1049 combinations have not been tested.</li>
1050 </ol>
1051 </div>
1052</div>
1053
1054<!-- ======================================================================= -->
1055<div class="doc_subsection">
Misha Brukman00c73d22003-11-07 19:43:14 +00001056 <a name="objfiles">The Location of LLVM Object Files</a>
1057</div>
John Criswell20d2d3e2003-10-10 14:26:14 +00001058
Misha Brukman00c73d22003-11-07 19:43:14 +00001059<div class="doc_text">
John Criswellce760f62003-07-03 16:01:38 +00001060
Misha Brukman00c73d22003-11-07 19:43:14 +00001061<p>The LLVM build system is capable of sharing a single LLVM source tree among
1062several LLVM builds. Hence, it is possible to build LLVM for several different
1063platforms or configurations using the same source tree.</p>
John Criswellce760f62003-07-03 16:01:38 +00001064
Misha Brukman00c73d22003-11-07 19:43:14 +00001065<p>This is accomplished in the typical autoconf manner:</p>
John Criswellce760f62003-07-03 16:01:38 +00001066
Misha Brukman00c73d22003-11-07 19:43:14 +00001067<ul>
1068 <li><p>Change directory to where the LLVM object files should live:</p>
John Criswellce760f62003-07-03 16:01:38 +00001069
Misha Brukman00c73d22003-11-07 19:43:14 +00001070 <p><tt>cd <i>OBJ_ROOT</i></tt></p></li>
John Criswellce760f62003-07-03 16:01:38 +00001071
Misha Brukman00c73d22003-11-07 19:43:14 +00001072 <li><p>Run the <tt>configure</tt> script found in the LLVM source
1073 directory:</p>
John Criswellce760f62003-07-03 16:01:38 +00001074
Misha Brukman00c73d22003-11-07 19:43:14 +00001075 <p><tt><i>SRC_ROOT</i>/configure</tt></p></li>
1076</ul>
John Criswell85ed3612003-06-12 19:34:44 +00001077
Misha Brukman00c73d22003-11-07 19:43:14 +00001078<p>The LLVM build will place files underneath <i>OBJ_ROOT</i> in directories
1079named after the build type:</p>
John Criswell85ed3612003-06-12 19:34:44 +00001080
Misha Brukman54111c42004-01-20 00:20:17 +00001081<dl>
Misha Brukman00c73d22003-11-07 19:43:14 +00001082 <dt>Debug Builds
1083 <dd>
Misha Brukman54111c42004-01-20 00:20:17 +00001084 <dl>
Misha Brukman00c73d22003-11-07 19:43:14 +00001085 <dt>Tools
Reid Spencer66db92e2004-12-08 16:51:31 +00001086 <dd><tt><i>OBJ_ROOT</i>/Debug/bin</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +00001087 <dt>Libraries
Reid Spencer66db92e2004-12-08 16:51:31 +00001088 <dd><tt><i>OBJ_ROOT</i>/Debug/lib</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +00001089 </dl>
Chris Lattner9abd8af2006-09-07 04:19:09 +00001090 <br><br>
John Criswell85ed3612003-06-12 19:34:44 +00001091
Misha Brukman00c73d22003-11-07 19:43:14 +00001092 <dt>Release Builds
1093 <dd>
Misha Brukman54111c42004-01-20 00:20:17 +00001094 <dl>
Misha Brukman00c73d22003-11-07 19:43:14 +00001095 <dt>Tools
Reid Spencer66db92e2004-12-08 16:51:31 +00001096 <dd><tt><i>OBJ_ROOT</i>/Release/bin</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +00001097 <dt>Libraries
Reid Spencer66db92e2004-12-08 16:51:31 +00001098 <dd><tt><i>OBJ_ROOT</i>/Release/lib</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +00001099 </dl>
Chris Lattner9abd8af2006-09-07 04:19:09 +00001100 <br><br>
John Criswell85ed3612003-06-12 19:34:44 +00001101
Misha Brukman00c73d22003-11-07 19:43:14 +00001102 <dt>Profile Builds
1103 <dd>
Misha Brukman54111c42004-01-20 00:20:17 +00001104 <dl>
Misha Brukman00c73d22003-11-07 19:43:14 +00001105 <dt>Tools
Reid Spencer66db92e2004-12-08 16:51:31 +00001106 <dd><tt><i>OBJ_ROOT</i>/Profile/bin</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +00001107 <dt>Libraries
Reid Spencer66db92e2004-12-08 16:51:31 +00001108 <dd><tt><i>OBJ_ROOT</i>/Profile/lib</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +00001109 </dl>
1110</dl>
John Criswell85ed3612003-06-12 19:34:44 +00001111
Misha Brukman00c73d22003-11-07 19:43:14 +00001112</div>
Chris Lattner7fe7f812002-07-24 19:51:14 +00001113
Chris Lattnera553f622004-03-25 20:38:40 +00001114<!-- ======================================================================= -->
1115<div class="doc_subsection">
1116 <a name="optionalconfig">Optional Configuration Items</a>
1117</div>
1118
1119<div class="doc_text">
1120
1121<p>
Misha Brukman9106eca2005-02-03 22:25:23 +00001122If you're running on a Linux system that supports the "<a
Reid Spencer66db92e2004-12-08 16:51:31 +00001123 href="http://www.tat.physik.uni-tuebingen.de/~rguenth/linux/binfmt_misc.html">
1124 binfmt_misc</a>"
Chris Lattnera553f622004-03-25 20:38:40 +00001125module, and you have root access on the system, you can set your system up to
1126execute LLVM bytecode files directly. To do this, use commands like this (the
1127first command may not be required if you are already using the module):</p>
1128
Misha Brukman9106eca2005-02-03 22:25:23 +00001129<div class="doc_code">
Chris Lattnera553f622004-03-25 20:38:40 +00001130<pre>
1131 $ mount -t binfmt_misc none /proc/sys/fs/binfmt_misc
Misha Brukman9106eca2005-02-03 22:25:23 +00001132 $ echo ':llvm:M::llvm::/path/to/lli:' &gt; /proc/sys/fs/binfmt_misc/register
Chris Lattnera553f622004-03-25 20:38:40 +00001133 $ chmod u+x hello.bc (if needed)
1134 $ ./hello.bc
1135</pre>
Misha Brukman9106eca2005-02-03 22:25:23 +00001136</div>
Chris Lattnera553f622004-03-25 20:38:40 +00001137
1138<p>
1139This allows you to execute LLVM bytecode files directly. Thanks to Jack
1140Cummings for pointing this out!
1141</p>
1142
1143</div>
1144
1145
Misha Brukman00c73d22003-11-07 19:43:14 +00001146<!-- *********************************************************************** -->
1147<div class="doc_section">
1148 <a name="layout"><b>Program Layout</b></a>
1149</div>
1150<!-- *********************************************************************** -->
John Criswell85ed3612003-06-12 19:34:44 +00001151
Misha Brukman00c73d22003-11-07 19:43:14 +00001152<div class="doc_text">
John Criswell85ed3612003-06-12 19:34:44 +00001153
Misha Brukman00c73d22003-11-07 19:43:14 +00001154<p>One useful source of information about the LLVM source base is the LLVM <a
John Criswell364cec42004-03-12 20:31:37 +00001155href="http://www.doxygen.org">doxygen</a> documentation available at <tt><a
Reid Spencer05fe4b02006-03-14 05:39:39 +00001156href="http://llvm.org/doxygen/">http://llvm.org/doxygen/</a></tt>.
Misha Brukman00c73d22003-11-07 19:43:14 +00001157The following is a brief introduction to code layout:</p>
John Criswell85ed3612003-06-12 19:34:44 +00001158
Misha Brukman00c73d22003-11-07 19:43:14 +00001159</div>
John Criswell85ed3612003-06-12 19:34:44 +00001160
Misha Brukman00c73d22003-11-07 19:43:14 +00001161<!-- ======================================================================= -->
Reid Spencer77d90192004-09-05 20:50:22 +00001162<div class="doc_subsection"><a name="cvsdir"><tt>CVS</tt> directories</a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +00001163<div class="doc_text">
Misha Brukman00c73d22003-11-07 19:43:14 +00001164<p>Every directory checked out of CVS will contain a <tt>CVS</tt> directory; for
1165the most part these can just be ignored.</p>
Reid Spencerc4b09ba2004-12-08 16:18:26 +00001166</div>
John Criswell85ed3612003-06-12 19:34:44 +00001167
Reid Spencerc4b09ba2004-12-08 16:18:26 +00001168<!-- ======================================================================= -->
1169<div class="doc_subsection"><a name="examples"><tt>llvm/examples</tt></a></div>
1170<div class="doc_text">
1171 <p>This directory contains some simple examples of how to use the LLVM IR and
1172 JIT.</p>
Misha Brukman00c73d22003-11-07 19:43:14 +00001173</div>
John Criswell85ed3612003-06-12 19:34:44 +00001174
Misha Brukman00c73d22003-11-07 19:43:14 +00001175<!-- ======================================================================= -->
Reid Spencer77d90192004-09-05 20:50:22 +00001176<div class="doc_subsection"><a name="include"><tt>llvm/include</tt></a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +00001177<div class="doc_text">
1178
1179<p>This directory contains public header files exported from the LLVM
1180library. The three main subdirectories of this directory are:</p>
1181
Reid Spencer77d90192004-09-05 20:50:22 +00001182<dl>
1183 <dt><tt><b>llvm/include/llvm</b></tt></dt>
1184 <dd>This directory contains all of the LLVM specific header files. This
1185 directory also has subdirectories for different portions of LLVM:
1186 <tt>Analysis</tt>, <tt>CodeGen</tt>, <tt>Target</tt>, <tt>Transforms</tt>,
1187 etc...</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +00001188
Reid Spencer77d90192004-09-05 20:50:22 +00001189 <dt><tt><b>llvm/include/llvm/Support</b></tt></dt>
1190 <dd>This directory contains generic support libraries that are provided with
1191 LLVM but not necessarily specific to LLVM. For example, some C++ STL utilities
1192 and a Command Line option processing library store their header files here.
1193 </dd>
Misha Brukman00c73d22003-11-07 19:43:14 +00001194
Reid Spencer77d90192004-09-05 20:50:22 +00001195 <dt><tt><b>llvm/include/llvm/Config</b></tt></dt>
1196 <dd>This directory contains header files configured by the <tt>configure</tt>
1197 script. They wrap "standard" UNIX and C header files. Source code can
1198 include these header files which automatically take care of the conditional
1199 #includes that the <tt>configure</tt> script generates.</dd>
1200</dl>
Misha Brukman00c73d22003-11-07 19:43:14 +00001201</div>
1202
1203<!-- ======================================================================= -->
Reid Spencer77d90192004-09-05 20:50:22 +00001204<div class="doc_subsection"><a name="lib"><tt>llvm/lib</tt></a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +00001205<div class="doc_text">
1206
1207<p>This directory contains most of the source files of the LLVM system. In LLVM,
1208almost all code exists in libraries, making it very easy to share code among the
1209different <a href="#tools">tools</a>.</p>
1210
Misha Brukman54111c42004-01-20 00:20:17 +00001211<dl>
Reid Spencer77d90192004-09-05 20:50:22 +00001212 <dt><tt><b>llvm/lib/VMCore/</b></tt></dt>
1213 <dd> This directory holds the core LLVM source files that implement core
1214 classes like Instruction and BasicBlock.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +00001215
Reid Spencer77d90192004-09-05 20:50:22 +00001216 <dt><tt><b>llvm/lib/AsmParser/</b></tt></dt>
1217 <dd>This directory holds the source code for the LLVM assembly language parser
1218 library.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +00001219
Reid Spencer77d90192004-09-05 20:50:22 +00001220 <dt><tt><b>llvm/lib/ByteCode/</b></tt></dt>
1221 <dd>This directory holds code for reading and write LLVM bytecode.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +00001222
Reid Spencer77d90192004-09-05 20:50:22 +00001223 <dt><tt><b>llvm/lib/Analysis/</b></tt><dd>This directory contains a variety of
Misha Brukman00c73d22003-11-07 19:43:14 +00001224 different program analyses, such as Dominator Information, Call Graphs,
1225 Induction Variables, Interval Identification, Natural Loop Identification,
Reid Spencer77d90192004-09-05 20:50:22 +00001226 etc.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +00001227
Reid Spencer77d90192004-09-05 20:50:22 +00001228 <dt><tt><b>llvm/lib/Transforms/</b></tt></dt>
1229 <dd> This directory contains the source code for the LLVM to LLVM program
1230 transformations, such as Aggressive Dead Code Elimination, Sparse Conditional
1231 Constant Propagation, Inlining, Loop Invariant Code Motion, Dead Global
1232 Elimination, and many others.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +00001233
Reid Spencer77d90192004-09-05 20:50:22 +00001234 <dt><tt><b>llvm/lib/Target/</b></tt></dt>
1235 <dd> This directory contains files that describe various target architectures
Chris Lattner2a607032006-04-20 17:42:23 +00001236 for code generation. For example, the <tt>llvm/lib/Target/X86</tt>
1237 directory holds the X86 machine description while
John Criswell8bfe6a72005-05-18 19:43:33 +00001238 <tt>llvm/lib/Target/CBackend</tt> implements the LLVM-to-C converter.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +00001239
Reid Spencer77d90192004-09-05 20:50:22 +00001240 <dt><tt><b>llvm/lib/CodeGen/</b></tt></dt>
1241 <dd> This directory contains the major parts of the code generator: Instruction
1242 Selector, Instruction Scheduling, and Register Allocation.</dd>
John Criswell85ed3612003-06-12 19:34:44 +00001243
Reid Spencer77d90192004-09-05 20:50:22 +00001244 <dt><tt><b>llvm/lib/Debugger/</b></tt></dt>
1245 <dd> This directory contains the source level debugger library that makes
1246 it possible to instrument LLVM programs so that a debugger could identify
1247 source code locations at which the program is executing.</dd>
1248
1249 <dt><tt><b>llvm/lib/ExecutionEngine/</b></tt></dt>
1250 <dd> This directory contains libraries for executing LLVM bytecode directly
1251 at runtime in both interpreted and JIT compiled fashions.</dd>
1252
1253 <dt><tt><b>llvm/lib/Support/</b></tt></dt>
1254 <dd> This directory contains the source code that corresponds to the header
1255 files located in <tt>llvm/include/Support/</tt>.</dd>
1256
1257 <dt><tt><b>llvm/lib/System/</b></tt></dt>
1258 <dd>This directory contains the operating system abstraction layer that
1259 shields LLVM from platform-specific coding.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +00001260</dl>
John Criswell7a73b802003-06-30 21:59:07 +00001261
Misha Brukman00c73d22003-11-07 19:43:14 +00001262</div>
John Criswell85ed3612003-06-12 19:34:44 +00001263
Misha Brukman00c73d22003-11-07 19:43:14 +00001264<!-- ======================================================================= -->
Reid Spencerc4b09ba2004-12-08 16:18:26 +00001265<div class="doc_subsection"><a name="projects"><tt>llvm/projects</tt></a></div>
1266<div class="doc_text">
1267 <p>This directory contains projects that are not strictly part of LLVM but are
1268 shipped with LLVM. This is also the directory where you should create your own
1269 LLVM-based projects. See <tt>llvm/projects/sample</tt> for an example of how
1270 to set up your own project. See <tt>llvm/projects/Stacker</tt> for a fully
1271 functional example of a compiler front end.</p>
1272</div>
1273
1274<!-- ======================================================================= -->
Reid Spencer77d90192004-09-05 20:50:22 +00001275<div class="doc_subsection"><a name="runtime"><tt>llvm/runtime</tt></a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +00001276<div class="doc_text">
John Criswell85ed3612003-06-12 19:34:44 +00001277
Misha Brukman00c73d22003-11-07 19:43:14 +00001278<p>This directory contains libraries which are compiled into LLVM bytecode and
1279used when linking programs with the GCC front end. Most of these libraries are
1280skeleton versions of real libraries; for example, libc is a stripped down
1281version of glibc.</p>
John Criswell85ed3612003-06-12 19:34:44 +00001282
Misha Brukman00c73d22003-11-07 19:43:14 +00001283<p>Unlike the rest of the LLVM suite, this directory needs the LLVM GCC front
1284end to compile.</p>
John Criswell85ed3612003-06-12 19:34:44 +00001285
Misha Brukman00c73d22003-11-07 19:43:14 +00001286</div>
John Criswell85ed3612003-06-12 19:34:44 +00001287
Misha Brukman00c73d22003-11-07 19:43:14 +00001288<!-- ======================================================================= -->
Reid Spencer77d90192004-09-05 20:50:22 +00001289<div class="doc_subsection"><a name="test"><tt>llvm/test</tt></a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +00001290<div class="doc_text">
Reid Spencer77d90192004-09-05 20:50:22 +00001291 <p>This directory contains feature and regression tests and other basic sanity
1292 checks on the LLVM infrastructure. These are intended to run quickly and cover
1293 a lot of territory without being exhaustive.</p>
Misha Brukman00c73d22003-11-07 19:43:14 +00001294</div>
John Criswell85ed3612003-06-12 19:34:44 +00001295
Misha Brukman00c73d22003-11-07 19:43:14 +00001296<!-- ======================================================================= -->
Reid Spencer77d90192004-09-05 20:50:22 +00001297<div class="doc_subsection"><a name="llvmtest"><tt>llvm-test</tt></a></div>
1298<div class="doc_text">
John Criswell3d8ba512004-12-08 17:53:54 +00001299 <p>This is not a directory in the normal llvm module; it is a separate CVS
Misha Brukmane12215f2004-11-15 23:20:51 +00001300 module that must be checked out (usually to <tt>projects/llvm-test</tt>). This
John Criswell3d8ba512004-12-08 17:53:54 +00001301 module contains a comprehensive correctness, performance, and benchmarking
1302 test
Reid Spencer77d90192004-09-05 20:50:22 +00001303 suite for LLVM. It is a separate CVS module because not every LLVM user is
John Criswell838bce52005-05-09 16:39:27 +00001304 interested in downloading or building such a comprehensive test suite. For
1305 further details on this test suite, please see the
Reid Spencer77d90192004-09-05 20:50:22 +00001306 <a href="TestingGuide.html">Testing Guide</a> document.</p>
Misha Brukman00c73d22003-11-07 19:43:14 +00001307</div>
John Criswell85ed3612003-06-12 19:34:44 +00001308
Reid Spencer77d90192004-09-05 20:50:22 +00001309<!-- ======================================================================= -->
1310<div class="doc_subsection"><a name="tools"><tt>llvm/tools</tt></a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +00001311<div class="doc_text">
John Criswell20d2d3e2003-10-10 14:26:14 +00001312
Misha Brukman00c73d22003-11-07 19:43:14 +00001313<p>The <b>tools</b> directory contains the executables built out of the
1314libraries above, which form the main part of the user interface. You can
1315always get help for a tool by typing <tt>tool_name --help</tt>. The
Misha Brukmane12215f2004-11-15 23:20:51 +00001316following is a brief introduction to the most important tools. More detailed
1317information is in the <a href="CommandGuide/index.html">Command Guide</a>.</p>
John Criswell20d2d3e2003-10-10 14:26:14 +00001318
Misha Brukman54111c42004-01-20 00:20:17 +00001319<dl>
John Criswell85ed3612003-06-12 19:34:44 +00001320
Reid Spencer77d90192004-09-05 20:50:22 +00001321 <dt><tt><b>bugpoint</b></tt></dt>
1322 <dd><tt>bugpoint</tt> is used to debug
Misha Brukman00c73d22003-11-07 19:43:14 +00001323 optimization passes or code generation backends by narrowing down the
1324 given test case to the minimum number of passes and/or instructions that
1325 still cause a problem, whether it is a crash or miscompilation. See <a
1326 href="HowToSubmitABug.html">HowToSubmitABug.html</a> for more information
Reid Spencer77d90192004-09-05 20:50:22 +00001327 on using <tt>bugpoint</tt>.</dd>
John Criswell85ed3612003-06-12 19:34:44 +00001328
Reid Spencer77d90192004-09-05 20:50:22 +00001329 <dt><tt><b>llvmc</b></tt></dt>
1330 <dd>The LLVM Compiler Driver. This program can
1331 be configured to utilize both LLVM and non-LLVM compilation tools to enable
1332 pre-processing, translation, optimization, assembly, and linking of programs
1333 all from one command line. <tt>llvmc</tt> also takes care of processing the
1334 dependent libraries found in bytecode. This reduces the need to get the
Reid Spencer079e9452004-12-08 18:00:30 +00001335 traditional <tt>-l&lt;name&gt;</tt> options right on the command line. Please
John Criswell8bfe6a72005-05-18 19:43:33 +00001336 note that this tool, while functional, is still experimental and not feature
1337 complete.</dd>
Reid Spencer77d90192004-09-05 20:50:22 +00001338
1339 <dt><tt><b>llvm-ar</b></tt></dt>
1340 <dd>The archiver produces an archive containing
Misha Brukman00c73d22003-11-07 19:43:14 +00001341 the given LLVM bytecode files, optionally with an index for faster
Reid Spencer77d90192004-09-05 20:50:22 +00001342 lookup.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +00001343
Reid Spencer77d90192004-09-05 20:50:22 +00001344 <dt><tt><b>llvm-as</b></tt></dt>
1345 <dd>The assembler transforms the human readable LLVM assembly to LLVM
1346 bytecode.</dd>
John Criswell85ed3612003-06-12 19:34:44 +00001347
Reid Spencer77d90192004-09-05 20:50:22 +00001348 <dt><tt><b>llvm-dis</b></tt></dt>
1349 <dd>The disassembler transforms the LLVM bytecode to human readable
1350 LLVM assembly.</dd>
John Criswell85ed3612003-06-12 19:34:44 +00001351
Reid Spencer079e9452004-12-08 18:00:30 +00001352 <dt><tt><b>llvm-ld</b></tt></dt>
Reid Spencer434262a2007-02-09 15:59:08 +00001353 <dd><tt>llvm-ld</tt> is a general purpose and extensible linker for LLVM.
1354 This is the linker invoked by <tt>llvmc</tt>. It performsn standard link time
1355 optimizations and allows optimization modules to be loaded and run so that
1356 language specific optimizations can be applied at link time.</dd>
Reid Spencer079e9452004-12-08 18:00:30 +00001357
Reid Spencer77d90192004-09-05 20:50:22 +00001358 <dt><tt><b>llvm-link</b></tt></dt>
1359 <dd><tt>llvm-link</tt>, not surprisingly, links multiple LLVM modules into
1360 a single program.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +00001361
Reid Spencer77d90192004-09-05 20:50:22 +00001362 <dt><tt><b>lli</b></tt></dt>
1363 <dd><tt>lli</tt> is the LLVM interpreter, which
Misha Brukman00c73d22003-11-07 19:43:14 +00001364 can directly execute LLVM bytecode (although very slowly...). In addition
1365 to a simple interpreter, <tt>lli</tt> also has a tracing mode (entered by
1366 specifying <tt>-trace</tt> on the command line). Finally, for
John Criswelld9eceee2004-12-08 18:04:14 +00001367 architectures that support it (currently x86, Sparc, and PowerPC), by default,
Misha Brukman00c73d22003-11-07 19:43:14 +00001368 <tt>lli</tt> will function as a Just-In-Time compiler (if the
1369 functionality was compiled in), and will execute the code <i>much</i>
Reid Spencer77d90192004-09-05 20:50:22 +00001370 faster than the interpreter.</dd>
Misha Brukmanef0ad412003-10-06 19:23:34 +00001371
Reid Spencer77d90192004-09-05 20:50:22 +00001372 <dt><tt><b>llc</b></tt></dt>
1373 <dd> <tt>llc</tt> is the LLVM backend compiler, which
John Criswell8bfe6a72005-05-18 19:43:33 +00001374 translates LLVM bytecode to a native code assembly file or to C code (with
Reid Spencer77d90192004-09-05 20:50:22 +00001375 the -march=c option).</dd>
Misha Brukmanef0ad412003-10-06 19:23:34 +00001376
Reid Spencerd4694f92004-12-22 06:29:07 +00001377 <dt><tt><b>llvm-gcc</b></tt></dt>
Reid Spencer434262a2007-02-09 15:59:08 +00001378 <dd><tt>llvm-gcc</tt> is a GCC-based C frontend that has been retargeted to
1379 use LLVM as its backend instead of GCC's RTL backend. It can also emit LLVM
1380 byte code or assembly (with the <tt>-emit-llvm</tt> option) instead of the
1381 usual machine code output. It works just like any other GCC compiler,
1382 taking the typical <tt>-c, -S, -E, -o</tt> options that are typically used.
1383 Additionally, the the source code for <tt>llvm-gcc</tt> is available as a
1384 separate CVS module.</dd>
John Criswell85ed3612003-06-12 19:34:44 +00001385
Reid Spencer77d90192004-09-05 20:50:22 +00001386 <dt><tt><b>opt</b></tt></dt>
Reid Spencer84f82f72006-08-28 00:34:19 +00001387 <dd><tt>opt</tt> reads LLVM bytecode, applies a series of LLVM to LLVM
1388 transformations (which are specified on the command line), and then outputs
1389 the resultant bytecode. The '<tt>opt --help</tt>' command is a good way to
1390 get a list of the program transformations available in LLVM.<br/>
1391 <dd><tt>opt</tt> can also be used to run a specific analysis on an input
1392 LLVM bytecode file and print out the results. It is primarily useful for
1393 debugging analyses, or familiarizing yourself with what an analysis does.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +00001394</dl>
Misha Brukman00c73d22003-11-07 19:43:14 +00001395</div>
John Criswell85ed3612003-06-12 19:34:44 +00001396
Misha Brukman00c73d22003-11-07 19:43:14 +00001397<!-- ======================================================================= -->
Reid Spencer77d90192004-09-05 20:50:22 +00001398<div class="doc_subsection"><a name="utils"><tt>llvm/utils</tt></a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +00001399<div class="doc_text">
John Criswell85ed3612003-06-12 19:34:44 +00001400
Misha Brukman00c73d22003-11-07 19:43:14 +00001401<p>This directory contains utilities for working with LLVM source code, and some
1402of the utilities are actually required as part of the build process because they
1403are code generators for parts of LLVM infrastructure.</p>
John Criswell85ed3612003-06-12 19:34:44 +00001404
Misha Brukman54111c42004-01-20 00:20:17 +00001405<dl>
Misha Brukman54111c42004-01-20 00:20:17 +00001406 <dt><tt><b>codegen-diff</b></tt> <dd><tt>codegen-diff</tt> is a script
Misha Brukman00c73d22003-11-07 19:43:14 +00001407 that finds differences between code that LLC generates and code that LLI
1408 generates. This is a useful tool if you are debugging one of them,
1409 assuming that the other generates correct output. For the full user
Chris Lattner9abd8af2006-09-07 04:19:09 +00001410 manual, run <tt>`perldoc codegen-diff'</tt>.<br><br>
Misha Brukmanc103adf2003-08-11 18:45:46 +00001411
Misha Brukman54111c42004-01-20 00:20:17 +00001412 <dt><tt><b>cvsupdate</b></tt> <dd><tt>cvsupdate</tt> is a script that will
Misha Brukman00c73d22003-11-07 19:43:14 +00001413 update your CVS tree, but produce a much cleaner and more organized output
1414 than simply running <tt>`cvs -z3 up -dP'</tt> will. For example, it will group
1415 together all the new and updated files and modified files in separate
1416 sections, so you can see at a glance what has changed. If you are at the
1417 top of your LLVM CVS tree, running <tt>utils/cvsupdate</tt> is the
Chris Lattner9abd8af2006-09-07 04:19:09 +00001418 preferred way of updating the tree.<br><br>
Misha Brukmanc103adf2003-08-11 18:45:46 +00001419
Misha Brukman54111c42004-01-20 00:20:17 +00001420 <dt><tt><b>emacs/</b></tt> <dd>The <tt>emacs</tt> directory contains
Misha Brukman00c73d22003-11-07 19:43:14 +00001421 syntax-highlighting files which will work with Emacs and XEmacs editors,
1422 providing syntax highlighting support for LLVM assembly files and TableGen
1423 description files. For information on how to use the syntax files, consult
Chris Lattner9abd8af2006-09-07 04:19:09 +00001424 the <tt>README</tt> file in that directory.<br><br>
Misha Brukmanc103adf2003-08-11 18:45:46 +00001425
Misha Brukman54111c42004-01-20 00:20:17 +00001426 <dt><tt><b>getsrcs.sh</b></tt> <dd>The <tt>getsrcs.sh</tt> script finds
Misha Brukman00c73d22003-11-07 19:43:14 +00001427 and outputs all non-generated source files, which is useful if one wishes
1428 to do a lot of development across directories and does not want to
1429 individually find each file. One way to use it is to run, for example:
1430 <tt>xemacs `utils/getsources.sh`</tt> from the top of your LLVM source
Chris Lattner9abd8af2006-09-07 04:19:09 +00001431 tree.<br><br>
1432
Reid Spencer77d90192004-09-05 20:50:22 +00001433 <dt><tt><b>llvmgrep</b></tt></dt>
1434 <dd>This little tool performs an "egrep -H -n" on each source file in LLVM and
1435 passes to it a regular expression provided on <tt>llvmgrep</tt>'s command
1436 line. This is a very efficient way of searching the source base for a
1437 particular regular expression.</dd>
1438
Misha Brukman54111c42004-01-20 00:20:17 +00001439 <dt><tt><b>makellvm</b></tt> <dd>The <tt>makellvm</tt> script compiles all
Misha Brukman00c73d22003-11-07 19:43:14 +00001440 files in the current directory and then compiles and links the tool that
1441 is the first argument. For example, assuming you are in the directory
1442 <tt>llvm/lib/Target/Sparc</tt>, if <tt>makellvm</tt> is in your path,
1443 simply running <tt>makellvm llc</tt> will make a build of the current
1444 directory, switch to directory <tt>llvm/tools/llc</tt> and build it,
Chris Lattner9abd8af2006-09-07 04:19:09 +00001445 causing a re-linking of LLC.<br><br>
Misha Brukmanc103adf2003-08-11 18:45:46 +00001446
Misha Brukman00c73d22003-11-07 19:43:14 +00001447 <dt><tt><b>NightlyTest.pl</b></tt> and
Misha Brukman54111c42004-01-20 00:20:17 +00001448 <tt><b>NightlyTestTemplate.html</b></tt> <dd>These files are used in a
Misha Brukman00c73d22003-11-07 19:43:14 +00001449 cron script to generate nightly status reports of the functionality of
1450 tools, and the results can be seen by following the appropriate link on
Chris Lattner9abd8af2006-09-07 04:19:09 +00001451 the <a href="http://llvm.org/">LLVM homepage</a>.<br><br>
Misha Brukmanc103adf2003-08-11 18:45:46 +00001452
Misha Brukman54111c42004-01-20 00:20:17 +00001453 <dt><tt><b>TableGen/</b></tt> <dd>The <tt>TableGen</tt> directory contains
Misha Brukman00c73d22003-11-07 19:43:14 +00001454 the tool used to generate register descriptions, instruction set
1455 descriptions, and even assemblers from common TableGen description
Chris Lattner9abd8af2006-09-07 04:19:09 +00001456 files.<br><br>
Misha Brukmanc103adf2003-08-11 18:45:46 +00001457
Misha Brukman54111c42004-01-20 00:20:17 +00001458 <dt><tt><b>vim/</b></tt> <dd>The <tt>vim</tt> directory contains
Misha Brukman00c73d22003-11-07 19:43:14 +00001459 syntax-highlighting files which will work with the VIM editor, providing
1460 syntax highlighting support for LLVM assembly files and TableGen
1461 description files. For information on how to use the syntax files, consult
Chris Lattner9abd8af2006-09-07 04:19:09 +00001462 the <tt>README</tt> file in that directory.<br><br>
Misha Brukmanc103adf2003-08-11 18:45:46 +00001463
Misha Brukman00c73d22003-11-07 19:43:14 +00001464</dl>
Misha Brukmanc103adf2003-08-11 18:45:46 +00001465
Misha Brukman00c73d22003-11-07 19:43:14 +00001466</div>
Misha Brukmanc103adf2003-08-11 18:45:46 +00001467
Reid Spencerc4b09ba2004-12-08 16:18:26 +00001468<!-- ======================================================================= -->
1469<div class="doc_subsection"><a name="win32"><tt>llvm/win32</tt></a></div>
1470<div class="doc_text">
1471 <p>This directory contains build scripts and project files for use with
1472 Visual C++. This allows developers on Windows to build LLVM without the need
John Criswell3d8ba512004-12-08 17:53:54 +00001473 for Cygwin. The contents of this directory should be considered experimental
Reid Spencerc4b09ba2004-12-08 16:18:26 +00001474 at this time.
1475 </p>
1476</div>
Misha Brukman00c73d22003-11-07 19:43:14 +00001477<!-- *********************************************************************** -->
1478<div class="doc_section">
1479 <a name="tutorial">An Example Using the LLVM Tool Chain</a>
1480</div>
1481<!-- *********************************************************************** -->
Misha Brukmanc103adf2003-08-11 18:45:46 +00001482
Misha Brukman00c73d22003-11-07 19:43:14 +00001483<div class="doc_text">
Chris Lattner59075882007-01-04 07:08:27 +00001484<p>This section gives an example of using LLVM. llvm-gcc3 is now obsolete,
1485so we only include instructiosn for llvm-gcc4.
Chris Lattner5907d402006-08-14 20:45:25 +00001486</p>
Chris Lattner9abd8af2006-09-07 04:19:09 +00001487
1488<p><b>Note:</b> The <i>gcc4</i> frontend's invocation is <b><i>considerably different</i></b>
1489from the previous <i>gcc3</i> frontend. In particular, the <i>gcc4</i> frontend <b><i>does not</i></b>
1490create bytecode by default: <i>gcc4</i> produces native code. As the example below illustrates,
1491the '--emit-llvm' flag is needed to produce LLVM bytecode output. For <i>makefiles</i> and
1492<i>configure</i> scripts, the CFLAGS variable needs '--emit-llvm' to produce bytecode
1493output.</p>
Chris Lattner5907d402006-08-14 20:45:25 +00001494</div>
1495
1496<!-- ======================================================================= -->
Chris Lattner9abd8af2006-09-07 04:19:09 +00001497<div class="doc_subsection"><a name="tutorial4">Example with llvm-gcc4</a></div>
Chris Lattner5907d402006-08-14 20:45:25 +00001498
1499<div class="doc_text">
1500
1501<ol>
1502 <li>First, create a simple C file, name it 'hello.c':
1503 <pre>
1504 #include &lt;stdio.h&gt;
1505 int main() {
1506 printf("hello world\n");
1507 return 0;
1508 }
1509 </pre></li>
1510
1511 <li><p>Next, compile the C file into a native executable:</p>
1512
1513 <p><tt>% llvm-gcc hello.c -o hello</tt></p>
1514
1515 <p>Note that llvm-gcc works just like GCC by default. The standard -S and
1516 -c arguments work as usual (producing a native .s or .o file,
1517 respectively). </p>
1518
1519 <li><p>Next, compile the C file into a LLVM bytecode file:</p>
1520 <p><tt>% llvm-gcc -O3 -emit-llvm hello.c -c -o hello.bc</tt></p>
1521
1522 <p>The -emit-llvm option can be used with the -S or -c options to emit an
1523 LLVM ".ll" or ".bc" file (respectively) for the code. This allows you
1524 to use the <a href="CommandGuide/index.html">standard LLVM tools</a> on
1525 the bytecode file.</p>
1526
1527 <p>Unlike llvm-gcc3, llvm-gcc4 correctly responds to -O[0123] arguments.
1528 </p></li>
1529
1530 <li><p>Run the program in both forms. To run the program, use:</p>
1531
1532 <p><tt>% ./hello</tt></p>
1533
1534 <p>and</p>
1535
Chris Lattner6e3b7c22006-08-14 20:51:35 +00001536 <p><tt>% lli hello.bc</tt></p>
Chris Lattner5907d402006-08-14 20:45:25 +00001537
1538 <p>The second examples shows how to invoke the LLVM JIT, <a
Chris Lattner6e3b7c22006-08-14 20:51:35 +00001539 href="CommandGuide/html/lli.html">lli</a>.</p></li>
Chris Lattner5907d402006-08-14 20:45:25 +00001540
1541 <li><p>Use the <tt>llvm-dis</tt> utility to take a look at the LLVM assembly
1542 code:</p>
1543
Chris Lattner9abd8af2006-09-07 04:19:09 +00001544 <p><tt>% llvm-dis &lt; hello.bc | less</tt><br><br></li>
Chris Lattner5907d402006-08-14 20:45:25 +00001545
1546 <li><p>Compile the program to native assembly using the LLC code
1547 generator:</p>
1548
1549 <p><tt>% llc hello.bc -o hello.s</tt></p>
1550
1551 <li><p>Assemble the native assembly language file into a program:</p>
1552
1553 <p><b>Solaris:</b><tt>% /opt/SUNWspro/bin/cc -xarch=v9 hello.s -o hello.native</tt></p>
1554 <p><b>Others:</b><tt>% gcc hello.s -o hello.native</tt></p>
1555
1556 <li><p>Execute the native code program:</p>
1557
Chris Lattner6e3b7c22006-08-14 20:51:35 +00001558 <p><tt>% ./hello.native</tt></p>
Chris Lattner5907d402006-08-14 20:45:25 +00001559
1560 <p>Note that using llvm-gcc to compile directly to native code (i.e. when
1561 the -emit-llvm option is not present) does steps 6/7/8 for you.</p>
Chris Lattner6e3b7c22006-08-14 20:51:35 +00001562 </li>
Chris Lattner5907d402006-08-14 20:45:25 +00001563
1564</ol>
1565
1566</div>
1567
John Criswell85ed3612003-06-12 19:34:44 +00001568
Misha Brukman00c73d22003-11-07 19:43:14 +00001569<!-- *********************************************************************** -->
1570<div class="doc_section">
1571 <a name="problems">Common Problems</a>
1572</div>
1573<!-- *********************************************************************** -->
John Criswellce760f62003-07-03 16:01:38 +00001574
Misha Brukman00c73d22003-11-07 19:43:14 +00001575<div class="doc_text">
John Criswellce760f62003-07-03 16:01:38 +00001576
Misha Brukman00c73d22003-11-07 19:43:14 +00001577<p>If you are having problems building or using LLVM, or if you have any other
1578general questions about LLVM, please consult the <a href="FAQ.html">Frequently
1579Asked Questions</a> page.</p>
John Criswell85ed3612003-06-12 19:34:44 +00001580
Misha Brukman00c73d22003-11-07 19:43:14 +00001581</div>
John Criswell85ed3612003-06-12 19:34:44 +00001582
Misha Brukman00c73d22003-11-07 19:43:14 +00001583<!-- *********************************************************************** -->
1584<div class="doc_section">
1585 <a name="links">Links</a>
1586</div>
1587<!-- *********************************************************************** -->
John Criswell85ed3612003-06-12 19:34:44 +00001588
Misha Brukman00c73d22003-11-07 19:43:14 +00001589<div class="doc_text">
John Criswell85ed3612003-06-12 19:34:44 +00001590
Misha Brukman00c73d22003-11-07 19:43:14 +00001591<p>This document is just an <b>introduction</b> to how to use LLVM to do
1592some simple things... there are many more interesting and complicated things
1593that you can do that aren't documented here (but we'll gladly accept a patch
1594if you want to write something up!). For more information about LLVM, check
1595out:</p>
John Criswell85ed3612003-06-12 19:34:44 +00001596
Misha Brukman00c73d22003-11-07 19:43:14 +00001597<ul>
Reid Spencer05fe4b02006-03-14 05:39:39 +00001598 <li><a href="http://llvm.org/">LLVM homepage</a></li>
1599 <li><a href="http://llvm.org/doxygen/">LLVM doxygen tree</a></li>
1600 <li><a href="http://llvm.org/docs/Projects.html">Starting a Project
Misha Brukman00c73d22003-11-07 19:43:14 +00001601 that Uses LLVM</a></li>
1602</ul>
1603
1604</div>
1605
1606<!-- *********************************************************************** -->
1607
1608<hr>
Misha Brukman142207b2003-11-22 01:30:01 +00001609<address>
Misha Brukman54111c42004-01-20 00:20:17 +00001610 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1611 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
1612 <a href="http://validator.w3.org/check/referer"><img
1613 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
1614
Misha Brukman142207b2003-11-22 01:30:01 +00001615 <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
Reid Spencer77d90192004-09-05 20:50:22 +00001616 <a href="http://llvm.x10sys.com/rspencer/">Reid Spencer</a><br>
Reid Spencer05fe4b02006-03-14 05:39:39 +00001617 <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
Misha Brukman00c73d22003-11-07 19:43:14 +00001618 Last modified: $Date$
Misha Brukman142207b2003-11-22 01:30:01 +00001619</address>
Misha Brukman00c73d22003-11-07 19:43:14 +00001620</body>
Guochun Shif4688a82002-07-17 23:05:56 +00001621</html>