Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / fcccd6bd178ea97a6ab7e9e0a539aa1de46e40e3 / . / docs / GettingStarted.html
blob: d225355eb5121cb9c314bb243d358efbf6ba4cfe [file] [log] [blame]
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1<!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 +0000[diff] [blame]3<html>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]4<head>
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]6 <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 +0000[diff] [blame]10
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]11<div class="doc_title">
12 Getting Started with the LLVM System
13</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]14
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]15<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 +0000[diff] [blame]19 <ol>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]20 <li><a href="#hardware">Hardware</a>
21 <li><a href="#software">Software</a>
Chris Lattner95e92582004-07-18 22:32:22 +0000[diff] [blame]22 <li><a href="#brokengcc">Broken versions of GCC</a>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]23 </ol></li>
John Criswell7a73b802003-06-30 21:59:07 +0000[diff] [blame]24
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]25 <li><a href="#starting">Getting Started with LLVM</a>
John Criswell0b459202003-07-08 20:35:59 +0000[diff] [blame]26 <ol>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]27 <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>
34 <li><a href="#objfiles">The Location of LLVM Object Files</a>
Chris Lattnera553f622004-03-25 20:38:40 +0000[diff] [blame]35 <li><a href="#optionalconfig">Optional Configuration Items</a>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]36 </ol></li>
John Criswell0b459202003-07-08 20:35:59 +0000[diff] [blame]37
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]38 <li><a href="#layout">Program layout</a>
39 <ol>
40 <li><a href="#cvsdir"><tt>CVS</tt> directories</a>
Reid Spencerc4b09ba2004-12-08 16:18:26 +0000[diff] [blame]41 <li><a href="#examples"><tt>llvm/examples</tt></a>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]42 <li><a href="#include"><tt>llvm/include</tt></a>
43 <li><a href="#lib"><tt>llvm/lib</tt></a>
Reid Spencerc4b09ba2004-12-08 16:18:26 +0000[diff] [blame]44 <li><a href="#projects"><tt>llvm/projects</tt></a>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]45 <li><a href="#runtime"><tt>llvm/runtime</tt></a>
46 <li><a href="#test"><tt>llvm/test</tt></a>
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]47 <li><a href="#llvmtest"><tt>llvm-test</tt></a>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]48 <li><a href="#tools"><tt>llvm/tools</tt></a>
49 <li><a href="#utils"><tt>llvm/utils</tt></a>
Reid Spencerc4b09ba2004-12-08 16:18:26 +0000[diff] [blame]50 <li><a href="#win32"><tt>llvm/win32</tt></a>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]51 </ol></li>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]52
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]53 <li><a href="#tutorial">An Example Using the LLVM Tool Chain</a>
54 <li><a href="#problems">Common Problems</a>
55 <li><a href="#links">Links</a>
56</ul>
57
Chris Lattner7911ce22004-05-23 21:07:27 +0000[diff] [blame]58<div class="doc_author">
59 <p>Written by:
60 <a href="mailto:criswell@uiuc.edu">John Criswell</a>,
61 <a href="mailto:sabre@nondot.org">Chris Lattner</a>,
62 <a href="http://misha.brukman.net">Misha Brukman</a>,
63 <a href="http://www.cs.uiuc.edu/~vadve">Vikram Adve</a>, and
64 <a href="mailto:gshi1@uiuc.edu">Guochun Shi</a>.
65 </p>
66</div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]67
68
69<!-- *********************************************************************** -->
70<div class="doc_section">
71 <a name="overview"><b>Overview</b></a>
72</div>
73<!-- *********************************************************************** -->
74
75<div class="doc_text">
76
77<p>Welcome to LLVM! In order to get started, you first need to know some
78basic information.</p>
79
80<p>First, LLVM comes in two pieces. The first piece is the LLVM suite. This
81contains all of the tools, libraries, and header files needed to use the low
82level virtual machine. It contains an assembler, disassembler, bytecode
83analyzer, and bytecode optimizer. It also contains a test suite that can be
84used to test the LLVM tools and the GCC front end.</p>
85
86<p>The second piece is the GCC front end. This component provides a version of
87GCC that compiles C and C++ code into LLVM bytecode. Currently, the GCC front
88end is a modified version of GCC 3.4 (we track the GCC 3.4 development). Once
89compiled into LLVM bytecode, a program can be manipulated with the LLVM tools
90from the LLVM suite.</p>
91
John Criswell3d8ba512004-12-08 17:53:54 +0000[diff] [blame]92<p>
93There is a third, optional piece called llvm-test. It is a suite of programs
94with a testing harness that can be used to further test LLVM's functionality
95and performance.
96</p>
97
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]98</div>
99
100<!-- *********************************************************************** -->
101<div class="doc_section">
102 <a name="quickstart"><b>Getting Started Quickly (A Summary)</b></a>
103</div>
104<!-- *********************************************************************** -->
105
106<div class="doc_text">
107
108<p>Here's the short story for getting up and running quickly with LLVM:</p>
109
110<ol>
Reid Spencer9f547912004-11-08 00:29:22 +0000[diff] [blame]111 <li>Read the documentation.</li>
112 <li>Read the documentation.</li>
113 <li>Remember that you were warned twice about reading the documentation.</li>
Misha Brukman9106eca2005-02-03 22:25:23 +0000[diff] [blame]114 <li>Install the GCC front end if you intend to compile C or C++:
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]115 <ol>
Reid Spencerd4694f92004-12-22 06:29:07 +0000[diff] [blame]116 <li><tt>cd <i>where-you-want-the-C-front-end-to-live</i></tt></li>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]117 <li><tt>gunzip --stdout cfrontend.<i>platform</i>.tar.gz | tar -xvf -</tt>
Reid Spencerd4694f92004-12-22 06:29:07 +0000[diff] [blame]118 </li>
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]119 <li><tt>cd cfrontend/<i>platform</i><br>
Reid Spencerd4694f92004-12-22 06:29:07 +0000[diff] [blame]120 ./fixheaders</tt></li>
John Criswell838bce52005-05-09 16:39:27 +0000[diff] [blame]121 <li>Add the cfrontend's "bin" directory to your PATH variable.</li>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]122 </ol></li>
123
Misha Brukman9106eca2005-02-03 22:25:23 +0000[diff] [blame]124 <li>Get the LLVM Source Code
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]125 <ul>
Misha Brukman9106eca2005-02-03 22:25:23 +0000[diff] [blame]126 <li>With the distributed files (or use <a href="#checkout">CVS</a>):
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]127 <ol>
128 <li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
John Criswell364cec42004-03-12 20:31:37 +0000[diff] [blame]129 <li><tt>gunzip --stdout llvm-<i>version</i>.tar.gz | tar -xvf -</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]130 </ol></li>
131
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]132 </ul></li>
133
Misha Brukman9106eca2005-02-03 22:25:23 +0000[diff] [blame]134 <li><b>[Optional]</b> Get the Test Suite Source Code
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]135 <ul>
Misha Brukman9106eca2005-02-03 22:25:23 +0000[diff] [blame]136 <li>With the distributed files (or use <a href="#checkout">CVS</a>):
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]137 <ol>
138 <li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
139 <li><tt>cd llvm/projects</tt>
140 <li><tt>gunzip --stdout llvm-test-<i>version</i>.tar.gz | tar -xvf -</tt>
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]141 </ol></li>
142
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]143 </ul></li>
144
145
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]146 <li>Configure the LLVM Build Environment
147 <ol>
Misha Brukman9106eca2005-02-03 22:25:23 +0000[diff] [blame]148 <li><tt>cd <i>where-you-want-to-build-llvm</i></tt></li>
149 <li><tt><i>/path/to/llvm/</i>configure [options]</tt><br>
150 Some common options:
151
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]152 <ul>
Reid Spencerd4694f92004-12-22 06:29:07 +0000[diff] [blame]153 <li><tt>--prefix=<i>directory</i></tt>
154 <p>Specify for <i>directory</i> the full pathname of where you
Misha Brukman9106eca2005-02-03 22:25:23 +0000[diff] [blame]155 want the LLVM tools and libraries to be installed (default
156 <tt>/usr/local</tt>).</p></li>
Reid Spencerfef93b72004-12-26 05:47:26 +0000[diff] [blame]157 <li><tt>--with-llvmgccdir=<i>directory</i></tt>
158 <p>Optionally, specify for <i>directory</i> the full pathname of the
John Criswell838bce52005-05-09 16:39:27 +0000[diff] [blame]159 C/C++ front end installation to use with this LLVM configuration. If
Reid Spencerfef93b72004-12-26 05:47:26 +0000[diff] [blame]160 not specified, the PATH will be searched.</p></li>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]161 <li><tt>--enable-spec2000=<i>directory</i></tt>
162 <p>Enable the SPEC2000 benchmarks for testing. The SPEC2000
163 benchmarks should be available in
164 <tt><i>directory</i></tt>.</p></li>
165 </ul>
166 </ol></li>
167
168 <li>Build the LLVM Suite:
169 <ol>
Chris Lattner95e92582004-07-18 22:32:22 +0000[diff] [blame]170 <li><tt>gmake -k |&amp; tee gnumake.out
171 &nbsp;&nbsp;&nbsp;# this is csh or tcsh syntax</tt></li>
172 <li>If you get an "internal compiler error (ICE)" see <a href="#brokengcc">below</a>.</li>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]173 </ol>
174
175</ol>
176
Chris Lattnerfcd37252004-06-21 22:52:48 +0000[diff] [blame]177<p>Consult the <a href="#starting">Getting Started with LLVM</a> section for
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]178detailed information on configuring and compiling LLVM. See <a
179href="#environment">Setting Up Your Environment</a> for tips that simplify
180working with the GCC front end and LLVM tools. Go to <a href="#layout">Program
181Layout</a> to learn about the layout of the source code tree.</p>
182
183</div>
184
185<!-- *********************************************************************** -->
186<div class="doc_section">
187 <a name="requirements"><b>Requirements</b></a>
188</div>
189<!-- *********************************************************************** -->
190
191<div class="doc_text">
192
193<p>Before you begin to use the LLVM system, review the requirements given below.
194This may save you some trouble by knowing ahead of time what hardware and
195software you will need.</p>
196
197</div>
198
199<!-- ======================================================================= -->
200<div class="doc_subsection">
201 <a name="hardware"><b>Hardware</b></a>
202</div>
203
204<div class="doc_text">
205
206<p>LLVM is known to work on the following platforms:</p>
207
Misha Brukman14ab5372004-11-15 05:19:53 +0000[diff] [blame]208<table cellpadding="3">
209<tr>
210 <th>OS</th>
211 <th>Arch</th>
Misha Brukman69def742004-11-19 21:53:22 +0000[diff] [blame]212 <th>Compilers</th>
Misha Brukman14ab5372004-11-15 05:19:53 +0000[diff] [blame]213</tr>
214<tr>
215 <td>Linux</td>
Chris Lattner7db3f522005-02-09 21:15:51 +0000[diff] [blame]216 <td>x86<sup><a href="#pf_1">1</a></sup></td>
Misha Brukman69def742004-11-19 21:53:22 +0000[diff] [blame]217 <td>GCC</td>
Misha Brukman14ab5372004-11-15 05:19:53 +0000[diff] [blame]218</tr>
219<tr>
220 <td>Solaris</td>
221 <td>V9 (Ultrasparc)</td>
Misha Brukman69def742004-11-19 21:53:22 +0000[diff] [blame]222 <td>GCC</td>
Misha Brukman14ab5372004-11-15 05:19:53 +0000[diff] [blame]223</tr>
224<tr>
225 <td>FreeBSD</td>
Chris Lattner7db3f522005-02-09 21:15:51 +0000[diff] [blame]226 <td>x86<sup><a href="#pf_1">1</a></sup></td>
Misha Brukman69def742004-11-19 21:53:22 +0000[diff] [blame]227 <td>GCC</td>
Misha Brukman14ab5372004-11-15 05:19:53 +0000[diff] [blame]228</tr>
229<tr>
Chris Lattner7db3f522005-02-09 21:15:51 +0000[diff] [blame]230 <td>MacOS X<sup><a href="#pf_2">2</a></sup></td>
Misha Brukman14ab5372004-11-15 05:19:53 +0000[diff] [blame]231 <td>PowerPC</td>
Misha Brukman69def742004-11-19 21:53:22 +0000[diff] [blame]232 <td>GCC</td>
Misha Brukman14ab5372004-11-15 05:19:53 +0000[diff] [blame]233</tr>
234<tr>
Tanya Lattner993b9802006-04-20 04:35:34 +0000[diff] [blame]235 <td>MacOS X<sup><a href="#pf_2">2</a></sup></td>
236 <td>x86</td>
237 <td>GCC</td>
238
239</tr>
240<tr>
Misha Brukman69def742004-11-19 21:53:22 +0000[diff] [blame]241 <td>Cygwin/Win32</td>
Chris Lattner7db3f522005-02-09 21:15:51 +0000[diff] [blame]242 <td>x86<sup><a href="#pf_1">1</a></sup></td>
Reid Spencer65e8f5b2004-12-23 19:39:54 +0000[diff] [blame]243 <td>GCC 3.4.X, binutils 2.15</td>
Misha Brukman69def742004-11-19 21:53:22 +0000[diff] [blame]244</tr>
Misha Brukmanc155a0a2004-12-23 07:14:56 +0000[diff] [blame]245<tr>
Chris Lattner8ccb87f2005-02-09 20:43:48 +0000[diff] [blame]246 <td>MinGW/Win32</td>
Chris Lattner7db3f522005-02-09 21:15:51 +0000[diff] [blame]247 <td>x86<sup><a href="#pf_1">1</a>,<a href="#pf_6">6</a></sup></td>
Chris Lattner8ccb87f2005-02-09 20:43:48 +0000[diff] [blame]248 <td>GCC 3.4.X, binutils 2.15</td>
249</tr>
250<tr>
Misha Brukmanc155a0a2004-12-23 07:14:56 +0000[diff] [blame]251 <td>Linux</td>
Chris Lattner7db3f522005-02-09 21:15:51 +0000[diff] [blame]252 <td>amd64<sup><a href="#pf_3">3</a></sup></td>
Misha Brukmanc155a0a2004-12-23 07:14:56 +0000[diff] [blame]253 <td>GCC</td>
254</tr>
Misha Brukman69def742004-11-19 21:53:22 +0000[diff] [blame]255</table>
256
257<p>LLVM has partial support for the following platforms:</p>
258
259<table>
260<tr>
261 <th>OS</th>
262 <th>Arch</th>
263 <th>Compilers</th>
Misha Brukman14ab5372004-11-15 05:19:53 +0000[diff] [blame]264</tr>
Misha Brukman00117692004-11-15 21:05:08 +0000[diff] [blame]265<tr>
Misha Brukman69def742004-11-19 21:53:22 +0000[diff] [blame]266 <td>Windows</td>
Chris Lattner7db3f522005-02-09 21:15:51 +0000[diff] [blame]267 <td>x86<sup><a href="#pf_1">1</a></sup></td>
268 <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 +0000[diff] [blame]269<tr>
Chris Lattner7db3f522005-02-09 21:15:51 +0000[diff] [blame]270 <td>AIX<sup><a href="#pf_3">3</a>,<a href="#pf_4">4</a></sup></td>
Misha Brukman00117692004-11-15 21:05:08 +0000[diff] [blame]271 <td>PowerPC</td>
Misha Brukman69def742004-11-19 21:53:22 +0000[diff] [blame]272 <td>GCC</td>
273</tr>
274<tr>
Chris Lattner7db3f522005-02-09 21:15:51 +0000[diff] [blame]275 <td>Linux<sup><a href="#pf_3">3</a>,<a href="#pf_5">5</a></sup></td>
Misha Brukman69def742004-11-19 21:53:22 +0000[diff] [blame]276 <td>PowerPC</td>
277 <td>GCC</td>
Misha Brukman00117692004-11-15 21:05:08 +0000[diff] [blame]278</tr>
John Criswell75162552005-05-09 16:49:59 +0000[diff] [blame]279
280<tr>
281 <td>Linux<sup><a href="#pf_7">7</a></sup></td>
282 <td>Alpha</td>
283 <td>GCC</td>
284</tr>
285<tr>
286 <td>Linux<sup><a href="#pf_7">7</a></sup></td>
287 <td>Itanium (IA-64)</td>
288 <td>GCC</td>
289</tr>
Duraid Madinae8714af2005-05-10 06:57:53 +0000[diff] [blame]290<tr>
291 <td>HP-UX<sup><a href="#pf_7">7</a></sup></td>
292 <td>Itanium (IA-64)</td>
293 <td>HP aCC</td>
294</tr>
Misha Brukman14ab5372004-11-15 05:19:53 +0000[diff] [blame]295</table>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]296
Misha Brukmana892ead2005-02-09 21:01:26 +0000[diff] [blame]297<p><b>Notes:</b></p>
298
Misha Brukman6d8e1532005-02-09 22:38:47 +0000[diff] [blame]299<div class="doc_notes">
300<ol>
301<li><a name="pf_1">Code generation supported for Pentium processors and
302up</a></li>
303<li><a name="pf_2">Code generation supported for 32-bit ABI only</a></li>
304<li><a name="pf_3">No native code generation</a></li>
305<li><a name="pf_4">Build is not complete: one or more tools don't link</a></li>
306<li><a name="pf_5">The GCC-based C/C++ frontend does not build</a></li>
307<li><a name="pf_6">The port is done using the MSYS shell.
Misha Brukmana892ead2005-02-09 21:01:26 +0000[diff] [blame]308<a href="http://www.mingw.org/MinGWiki/">Download</a> and install
309bison (excl. M4.exe) and flex in that order. Build binutils-2.15 from source,
Chris Lattner27ae0272005-02-09 22:52:46 +0000[diff] [blame]310if necessary.</li>
John Criswell75162552005-05-09 16:49:59 +0000[diff] [blame]311<li><a name="pf_7">Native code generation exists but is not complete.</a></li>
Misha Brukmana892ead2005-02-09 21:01:26 +0000[diff] [blame]312</ol>
Misha Brukmana892ead2005-02-09 21:01:26 +0000[diff] [blame]313</div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]314
Misha Brukman69def742004-11-19 21:53:22 +0000[diff] [blame]315<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 +0000[diff] [blame]316mode, depending on the system (it is so large because of all the debugging
317information and the fact that the libraries are statically linked into multiple
318tools). If you do not need many of the tools and you are space-conscious,
Misha Brukman69def742004-11-19 21:53:22 +0000[diff] [blame]319you can disable them individually in <tt>llvm/tools/Makefile</tt>. The Release
320build requires considerably less space.</p>
321
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]322<p>The LLVM suite <i>may</i> compile on other platforms, but it is not
323guaranteed to do so. If compilation is successful, the LLVM utilities should be
324able to assemble, disassemble, analyze, and optimize LLVM bytecode. Code
325generation should work as well, although the generated native code may not work
326on your platform.</p>
327
328<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 +0000[diff] [blame]329to work on another platform, you can download a copy of the source and <a
330href="CFEBuildInstrs.html">try to compile it</a> on your platform.</p>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]331
332</div>
333
334<!-- ======================================================================= -->
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]335<div class="doc_subsection"><a name="software"><b>Software</b></a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]336<div class="doc_text">
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]337 <p>Compiling LLVM requires that you have several software packages
338 installed. The table below lists those required packages. The Package column
339 is the usual name for the software package that LLVM depends on. The Version
340 column provides "known to work" versions of the package. The Notes column
341 describes how LLVM uses the package and provides other details.</p>
342 <table>
343 <tr><th>Package</th><th>Version</th><th>Notes</th></tr>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]344
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]345 <tr>
346 <td><a href="http://savannah.gnu.org/projects/make">GNU Make</a></td>
347 <td>3.79, 3.79.1</td>
348 <td>Makefile/build processor</td>
349 </tr>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]350
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]351 <tr>
352 <td><a href="http://gcc.gnu.org">GCC</a></td>
353 <td>3.4.2</td>
Misha Brukman6d8e1532005-02-09 22:38:47 +0000[diff] [blame]354 <td>C/C++ compiler<sup><a href="#sf1">1</a></sup></td>
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]355 </tr>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]356
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]357 <tr>
Chris Lattner2286cab2005-09-06 04:07:15 +0000[diff] [blame]358 <td><a href="http://www.gnu.org/software/texinfo">TeXinfo</a></td>
359 <td>4.5</td>
360 <td>For building the CFE</td>
361 </tr>
362
363 <tr>
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]364 <td><a href="http://www.gnu.org/software/flex">Flex</a></td>
365 <td>2.5.4</td>
366 <td>LEX compiler</td>
367 </tr>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]368
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]369 <tr>
370 <td><a href="http://www.gnu.org/software/bison/bison.html">Bison</a></td>
Jeff Cohen4896c5d2006-01-04 06:51:22 +0000[diff] [blame]371 <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 +0000[diff] [blame]372 <td>YACC compiler</td>
373 </tr>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]374
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]375 <tr>
Misha Brukman6d8e1532005-02-09 22:38:47 +0000[diff] [blame]376 <td><a href="https://www.cvshome.org/downloads.html">CVS</a></td>
377 <td>&ge;1.11</td>
378 <td>CVS access to LLVM<sup><a href="#sf2">2</a></sup></td>
379 </tr>
380
381 <tr>
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]382 <td><a href="http://savannah.gnu.org/projects/dejagnu">DejaGnu</a></td>
383 <td>1.4.2</td>
Misha Brukman6d8e1532005-02-09 22:38:47 +0000[diff] [blame]384 <td>Automated test suite<sup><a href="#sf3">3</a></sup></td>
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]385 </tr>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]386
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]387 <tr>
388 <td><a href="http://www.tcl.tk/software/tcltk/">tcl</a></td>
389 <td>8.3, 8.4</td>
Misha Brukman6d8e1532005-02-09 22:38:47 +0000[diff] [blame]390 <td>Automated test suite<sup><a href="#sf3">3</a></sup></td>
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]391 </tr>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]392
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]393 <tr>
394 <td><a href="http://expect.nist.gov/">expect</a></td>
395 <td>5.38.0</td>
Misha Brukman6d8e1532005-02-09 22:38:47 +0000[diff] [blame]396 <td>Automated test suite<sup><a href="#sf3">3</a></sup></td>
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]397 </tr>
398
399 <tr>
400 <td><a href="http://www.perl.com/download.csp">perl</a></td>
Reid Spencer200d93b2004-12-09 17:55:37 +0000[diff] [blame]401 <td>&ge;5.6.0</td>
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]402 <td>Nightly tester, utilities</td>
403 </tr>
404
405 <tr>
Misha Brukman6d8e1532005-02-09 22:38:47 +0000[diff] [blame]406 <td><a href="http://savannah.gnu.org/projects/m4">GNU M4</a>
407 <td>1.4</td>
408 <td>Macro processor for configuration<sup><a href="#sf4">4</a></sup></td>
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]409 </tr>
410
411 <tr>
Misha Brukman6d8e1532005-02-09 22:38:47 +0000[diff] [blame]412 <td><a href="http://www.gnu.org/software/autoconf">GNU Autoconf</a></td>
413 <td>2.59</td>
414 <td>Configuration script builder<sup><a href="#sf4">4</a></sup></td>
415 </tr>
416
417 <tr>
418 <td><a href="http://www.gnu.org/software/automake">GNU Automake</a></td>
419 <td>1.9.2</td>
420 <td>aclocal macro generator<sup><a href="#sf4">4</a></sup></td>
421 </tr>
422
423 <tr>
424 <td><a href="http://savannah.gnu.org/projects/libtool">libtool</a></td>
425 <td>1.5.10</td>
426 <td>Shared library manager<sup><a href="#sf4">4</a></sup></td>
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]427 </tr>
428
429 </table>
430
Misha Brukman6d8e1532005-02-09 22:38:47 +0000[diff] [blame]431 <p><b>Notes:</b></p>
432 <div class="doc_notes">
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]433 <ol>
Misha Brukman6d8e1532005-02-09 22:38:47 +0000[diff] [blame]434 <li><a name="sf3">Only the C and C++ languages are needed so there's no
435 need to build the other languages for LLVM's purposes.</a> See
436 <a href="#brokengcc">below</a> for specific version info.</li>
437 <li><a name="sf2">You only need CVS if you intend to build from the
438 latest LLVM sources. If you're working from a release distribution, you
439 don't need CVS.</a></li>
440 <li><a name="sf3">Only needed if you want to run the automated test
441 suite in the <tt>llvm/test</tt> directory.</a></li>
442 <li><a name="sf4">If you want to make changes to the configure scripts,
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]443 you will need GNU autoconf (2.59), and consequently, GNU M4 (version 1.4
Reid Spencer200d93b2004-12-09 17:55:37 +0000[diff] [blame]444 or higher). You will also need automake (1.9.2). We only use aclocal
445 from that package.</a></li>
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]446 </ol>
Misha Brukman6d8e1532005-02-09 22:38:47 +0000[diff] [blame]447 </div>
448
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]449 <p>Additionally, your compilation host is expected to have the usual
450 plethora of Unix utilities. Specifically:</p>
451 <ul>
452 <li><b>ar</b> - archive library builder</li>
453 <li><b>bzip2*</b> - bzip2 command for distribution generation</li>
454 <li><b>bunzip2*</b> - bunzip2 command for distribution checking</li>
455 <li><b>chmod</b> - change permissions on a file</li>
John Criswellc4ef3f22004-12-08 16:55:27 +0000[diff] [blame]456 <li><b>cat</b> - output concatenation utility</li>
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]457 <li><b>cp</b> - copy files</li>
458 <li><b>date</b> - print the current date/time </li>
459 <li><b>echo</b> - print to standard output</li>
460 <li><b>egrep</b> - extended regular expression search utility</li>
461 <li><b>etags</b> - C/C++ tag file creator for vim/emacs</li>
462 <li><b>find</b> - find files/dirs in a file system</li>
463 <li><b>grep</b> - regular expression search utility</li>
464 <li><b>gzip*</b> - gzip command for distribution generation</li>
465 <li><b>gunzip*</b> - gunzip command for distribution checking</li>
466 <li><b>install</b> - install directories/files </li>
467 <li><b>mkdir</b> - create a directory</li>
468 <li><b>mv</b> - move (rename) files</li>
469 <li><b>ranlib</b> - symbol table builder for archive libraries</li>
Misha Brukman616bd052004-11-20 01:27:40 +0000[diff] [blame]470 <li><b>rm</b> - remove (delete) files and directories</li>
Reid Spencer748d82e2004-11-15 21:15:12 +0000[diff] [blame]471 <li><b>sed</b> - stream editor for transforming output</li>
472 <li><b>sh</b> - Bourne shell for make build scripts</li>
473 <li><b>tar</b> - tape archive for distribution generation</li>
474 <li><b>test</b> - test things in file system</li>
475 <li><b>unzip*</b> - unzip command for distribution checking</li>
476 <li><b>zip*</b> - zip command for distribution generation</li>
477 </ul>
Chris Lattner95e92582004-07-18 22:32:22 +0000[diff] [blame]478</div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]479
Chris Lattner95e92582004-07-18 22:32:22 +0000[diff] [blame]480<!-- ======================================================================= -->
481<div class="doc_subsection">
482 <a name="brokengcc">Broken versions of GCC</a>
483</div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]484
Chris Lattner95e92582004-07-18 22:32:22 +0000[diff] [blame]485<div class="doc_text">
486
487<p>LLVM is very demanding of the host C++ compiler, and as such tends to expose
488bugs in the compiler. In particular, several versions of GCC crash when trying
489to compile LLVM. We routinely use GCC 3.3.3 and GCC 3.4.0 and have had success
Chris Lattner8e64f152005-02-13 22:20:49 +0000[diff] [blame]490with them (however, see below). Other versions of GCC will probably
Chris Lattner25e7b162005-02-12 20:11:13 +0000[diff] [blame]491work as well. GCC versions listed
Chris Lattner95e92582004-07-18 22:32:22 +0000[diff] [blame]492here are known to not work. If you are using one of these versions, please try
493to upgrade your GCC to something more recent. If you run into a problem with a
494version of GCC not listed here, please <a href="mailto:llvmdev@cs.uiuc.edu">let
495us know</a>. Please use the "<tt>gcc -v</tt>" command to find out which version
496of GCC you are using.
497</p>
498
499<p><b>GCC versions prior to 3.0</b>: GCC 2.96.x and before had several
500problems in the STL that effectively prevent it from compiling LLVM.
501</p>
502
John Criswell294ba022004-11-23 22:06:24 +0000[diff] [blame]503<p><b>GCC 3.2.2</b>: This version of GCC fails to compile LLVM.</p>
504
Chris Lattner95e92582004-07-18 22:32:22 +0000[diff] [blame]505<p><b>GCC 3.3.2</b>: This version of GCC suffered from a <a
506href="http://gcc.gnu.org/PR13392">serious bug</a> which causes it to crash in
507the "<tt>convert_from_eh_region_ranges_1</tt>" GCC function.</p>
Chris Lattner25e7b162005-02-12 20:11:13 +0000[diff] [blame]508
Chris Lattner8e64f152005-02-13 22:20:49 +0000[diff] [blame]509<p><b>Cygwin GCC 3.3.3</b>: The version of GCC 3.3.3 commonly shipped with
510 Cygwin does not work. Please <a href="CFEBuildInstrs.html#cygwin">upgrade
511 to a newer version</a> if possible.</p>
512<p><b>SuSE GCC 3.3.3</b>: The version of GCC 3.3.3 shipped with SuSE 9.1 (and
513 possibly others) does not compile LLVM correctly (it appears that exception
514 handling is broken in some cases). Please download the FSF 3.3.3 or upgrade
515 to a newer version of GCC.</p>
Chris Lattnerf2b5e6e2005-05-15 22:26:45 +0000[diff] [blame]516<p><b>IA-64 GCC 4.0.0</b>: The IA-64 version of GCC 4.0.0 is known to
517 miscompile LLVM.</p>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]518</div>
519
Chris Lattner95e92582004-07-18 22:32:22 +0000[diff] [blame]520
521
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]522<!-- *********************************************************************** -->
523<div class="doc_section">
524 <a name="starting"><b>Getting Started with LLVM</b></a>
525</div>
526<!-- *********************************************************************** -->
527
Chris Lattner95e92582004-07-18 22:32:22 +0000[diff] [blame]528<div class="doc_text">
529
530<p>The remainder of this guide is meant to get you up and running with
531LLVM and to give you some basic information about the LLVM environment.</p>
532
533<p>The later sections of this guide describe the <a
534href="#layout">general layout</a> of the the LLVM source tree, a <a
535href="#tutorial">simple example</a> using the LLVM tool chain, and <a
536href="#links">links</a> to find more information about LLVM or to get
537help via e-mail.</p>
538</div>
539
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]540<!-- ======================================================================= -->
541<div class="doc_subsection">
542 <a name="terminology">Terminology and Notation</a>
543</div>
544
545<div class="doc_text">
546
547<p>Throughout this manual, the following names are used to denote paths
548specific to the local system and working environment. <i>These are not
549environment variables you need to set but just strings used in the rest
550of this document below</i>. In any of the examples below, simply replace
551each of these names with the appropriate pathname on your local system.
552All these paths are absolute:</p>
553
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]554<dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]555 <dt>SRC_ROOT
556 <dd>
557 This is the top level directory of the LLVM source tree.
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]558 <p>
559
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]560 <dt>OBJ_ROOT
561 <dd>
562 This is the top level directory of the LLVM object tree (i.e. the
563 tree where object files and compiled programs will be placed. It
564 can be the same as SRC_ROOT).
565 <p>
566
567 <dt>LLVMGCCDIR
568 <dd>
Reid Spencerfef93b72004-12-26 05:47:26 +0000[diff] [blame]569 This is where the LLVM GCC Front End is installed.
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]570 <p>
571 For the pre-built GCC front end binaries, the LLVMGCCDIR is
572 <tt>cfrontend/<i>platform</i>/llvm-gcc</tt>.
573</dl>
574
575</div>
576
577<!-- ======================================================================= -->
578<div class="doc_subsection">
579 <a name="environment">Setting Up Your Environment</a>
580</div>
581
582<div class="doc_text">
583
584<p>
Misha Brukman8f0cad12005-02-03 18:28:08 +0000[diff] [blame]585In order to compile and use LLVM, you may need to set some environment
586variables.
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]587
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]588<dl>
Reid Spencerf96eb572004-12-15 00:14:01 +0000[diff] [blame]589 <dt><tt>LLVM_LIB_SEARCH_PATH</tt>=<tt>/path/to/your/bytecode/libs</tt></dt>
Misha Brukman8f0cad12005-02-03 18:28:08 +0000[diff] [blame]590 <dd>[Optional] This environment variable helps LLVM linking tools find the
John Criswell8bfe6a72005-05-18 19:43:33 +0000[diff] [blame]591 locations of your bytecode libraries. It is provided only as a
Misha Brukman8f0cad12005-02-03 18:28:08 +0000[diff] [blame]592 convenience since you can specify the paths using the -L options of the
John Criswell8bfe6a72005-05-18 19:43:33 +0000[diff] [blame]593 tools and the C/C++ front-end will automatically use the bytecode files
594 installed in its
Misha Brukman8f0cad12005-02-03 18:28:08 +0000[diff] [blame]595 <tt>lib</tt> directory.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]596</dl>
597
598</div>
599
600<!-- ======================================================================= -->
601<div class="doc_subsection">
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]602 <a name="unpack">Unpacking the LLVM Archives</a>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]603</div>
604
605<div class="doc_text">
606
607<p>
608If you have the LLVM distribution, you will need to unpack it before you
John Criswelld000e1d2003-12-18 16:43:17 +0000[diff] [blame]609can begin to compile it. LLVM is distributed as a set of two files: the LLVM
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]610suite and the LLVM GCC front end compiled for your platform. There is an
611additional test suite that is optional. Each file is a TAR archive that is
612compressed with the gzip program.
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]613</p>
614
Misha Brukman3ce11032005-02-02 18:01:57 +0000[diff] [blame]615<p>The files are as follows, with <em>x.y</em> marking the version number:
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]616<dl>
Misha Brukman3ce11032005-02-02 18:01:57 +0000[diff] [blame]617 <dt><tt>llvm-x.y.tar.gz</tt></dt>
618 <dd>Source release for the LLVM libraries and tools.<br/></dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]619
Misha Brukman3ce11032005-02-02 18:01:57 +0000[diff] [blame]620 <dt><tt>llvm-test-x.y.tar.gz</tt></dt>
Chris Lattner7db3f522005-02-09 21:15:51 +0000[diff] [blame]621 <dd>Source release for the LLVM test suite.</dd>
Misha Brukman8f9e6d62004-11-23 19:26:24 +0000[diff] [blame]622
Misha Brukman3ce11032005-02-02 18:01:57 +0000[diff] [blame]623 <dt><tt>cfrontend-x.y.source.tar.gz</tt></dt>
624 <dd>Source release of the GCC front end.<br/></dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]625
Misha Brukman3ce11032005-02-02 18:01:57 +0000[diff] [blame]626 <dt><tt>cfrontend-x.y.sparc-sun-solaris2.8.tar.gz</tt></dt>
627 <dd>Binary release of the GCC front end for Solaris/Sparc.
Reid Spencer129f94e2004-12-08 16:25:25 +0000[diff] [blame]628 <br/></dd>
John Criswelld000e1d2003-12-18 16:43:17 +0000[diff] [blame]629
Misha Brukman3ce11032005-02-02 18:01:57 +0000[diff] [blame]630 <dt><tt>cfrontend-x.y.i686-redhat-linux-gnu.tar.gz</tt></dt>
631 <dd>Binary release of the GCC front end for Linux/x86.<br/></dd>
John Criswelld000e1d2003-12-18 16:43:17 +0000[diff] [blame]632
Tanya Lattner993b9802006-04-20 04:35:34 +0000[diff] [blame]633 <dt><tt>cfrontend-x.y.powerpc-apple-darwin8.5.0.tar.gz</tt></dt>
Misha Brukman3ce11032005-02-02 18:01:57 +0000[diff] [blame]634 <dd>Binary release of the GCC front end for MacOS X/PPC.<br/></dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]635</dl>
636
637</div>
638
639<!-- ======================================================================= -->
640<div class="doc_subsection">
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]641 <a name="checkout">Checkout LLVM from CVS</a>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]642</div>
643
644<div class="doc_text">
645
646<p>If you have access to our CVS repository, you can get a fresh copy of
647the entire source code. All you need to do is check it out from CVS as
648follows:</p>
649
650<ul>
651<li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
652 <li><tt>cvs -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm login</tt>
653 <li>Hit the return key when prompted for the password.
654 <li><tt>cvs -z3 -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm co
655 llvm</tt>
656</ul>
657
658<p>This will create an '<tt>llvm</tt>' directory in the current
659directory and fully populate it with the LLVM source code, Makefiles,
660test directories, and local copies of documentation files.</p>
661
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]662<p>If you want to get a specific release (as opposed to the most recent
663revision), you can specify a label. The following releases have the following
Misha Brukman3ce11032005-02-02 18:01:57 +0000[diff] [blame]664labels:</p>
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]665
John Criswelld000e1d2003-12-18 16:43:17 +0000[diff] [blame]666<ul>
Tanya Lattner993b9802006-04-20 04:35:34 +0000[diff] [blame]667<li>Release 1.7: <b>RELEASE_17</b></li>
John Criswellc0c186d2005-11-08 21:11:33 +0000[diff] [blame]668<li>Release 1.6: <b>RELEASE_16</b></li>
John Criswell75162552005-05-09 16:49:59 +0000[diff] [blame]669<li>Release 1.5: <b>RELEASE_15</b></li>
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]670<li>Release 1.4: <b>RELEASE_14</b></li>
John Criswell18b74642004-08-16 14:51:33 +0000[diff] [blame]671<li>Release 1.3: <b>RELEASE_13</b></li>
Misha Brukmanb9be2bf2004-05-12 19:25:59 +0000[diff] [blame]672<li>Release 1.2: <b>RELEASE_12</b></li>
673<li>Release 1.1: <b>RELEASE_11</b></li>
674<li>Release 1.0: <b>RELEASE_1</b></li>
John Criswelld000e1d2003-12-18 16:43:17 +0000[diff] [blame]675</ul>
John Criswelld000e1d2003-12-18 16:43:17 +0000[diff] [blame]676
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]677<p>If you would like to get the LLVM test suite (a separate package as of 1.4),
678you get it from the CVS repository:</p>
679<pre>
680 cd llvm/projects
681 cvs -z3 -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm co llvm-test
682</pre>
683<p>By placing it in the <tt>llvm/projects</tt>, it will be automatically
John Criswellc4ef3f22004-12-08 16:55:27 +0000[diff] [blame]684configured by the LLVM configure script as well as automatically updated when
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]685you run <tt>cvs update</tt>.</p>
686
Tanya Lattner993b9802006-04-20 04:35:34 +0000[diff] [blame]687<p>If you would like to get the GCC 3.4 front end source code, you can also get it from the CVS repository:</p>
Misha Brukmanb9be2bf2004-05-12 19:25:59 +0000[diff] [blame]688
Chris Lattner604fdc12004-06-28 17:14:01 +0000[diff] [blame]689<pre>
690 cvs -z3 -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm co llvm-gcc
Misha Brukmanb9be2bf2004-05-12 19:25:59 +0000[diff] [blame]691</pre>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]692
Chris Lattner604fdc12004-06-28 17:14:01 +0000[diff] [blame]693<p>Please note that you must follow <a href="CFEBuildInstrs.html">these
John Criswell3d8ba512004-12-08 17:53:54 +0000[diff] [blame]694instructions</a> to successfully build the LLVM GCC front-end.</p>
Chris Lattner604fdc12004-06-28 17:14:01 +0000[diff] [blame]695
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]696</div>
697
698<!-- ======================================================================= -->
699<div class="doc_subsection">
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]700 <a name="installcf">Install the GCC Front End</a>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]701</div>
702
703<div class="doc_text">
704
705<p>Before configuring and compiling the LLVM suite, you need to extract the LLVM
706GCC front end from the binary distribution. It is used for building the
707bytecode libraries later used by the GCC front end for linking programs, and its
708location must be specified when the LLVM suite is configured.</p>
709
710<p>To install the GCC front end, do the following:</p>
711
712<ol>
713 <li><tt>cd <i>where-you-want-the-front-end-to-live</i></tt></li>
John Criswelld000e1d2003-12-18 16:43:17 +0000[diff] [blame]714 <li><tt>gunzip --stdout cfrontend-<i>version</i>.<i>platform</i>.tar.gz | tar -xvf
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]715 -</tt></li>
716</ol>
717
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]718<p>Next, you will need to fix your system header files:</p>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]719
John Criswell364cec42004-03-12 20:31:37 +0000[diff] [blame]720<p><tt>cd cfrontend/<i>platform</i><br>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]721 ./fixheaders</tt></p>
722
723<p>The binary versions of the GCC front end may not suit all of your needs. For
724example, the binary distribution may include an old version of a system header
725file, not "fix" a header file that needs to be fixed for GCC, or it may be
726linked with libraries not available on your system.</p>
727
728<p>In cases like these, you may want to try <a
729href="CFEBuildInstrs.html">building the GCC front end from source.</a> This is
730not for the faint of heart, so be forewarned.</p>
731
732</div>
733
734<!-- ======================================================================= -->
735<div class="doc_subsection">
736 <a name="config">Local LLVM Configuration</a>
737</div>
738
739<div class="doc_text">
740
741<p>Once checked out from the CVS repository, the LLVM suite source code must be
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]742configured via the <tt>configure</tt> script. This script sets variables in the
743various <tt>*.in</tt> files, most notably <tt>llvm/Makefile.config</tt> and
744<tt>llvm/include/Config/config.h</tt>. It also populates <i>OBJ_ROOT</i> with
745the Makefiles needed to begin building LLVM.</p>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]746
747<p>The following environment variables are used by the <tt>configure</tt>
748script to configure the build system:</p>
749
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]750<table>
751 <tr><th>Variable</th><th>Purpose</th></tr>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]752 <tr>
753 <td>CC</td>
754 <td>Tells <tt>configure</tt> which C compiler to use. By default,
755 <tt>configure</tt> will look for the first GCC C compiler in
756 <tt>PATH</tt>. Use this variable to override
757 <tt>configure</tt>'s default behavior.</td>
758 </tr>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]759 <tr>
760 <td>CXX</td>
761 <td>Tells <tt>configure</tt> which C++ compiler to use. By default,
762 <tt>configure</tt> will look for the first GCC C++ compiler in
763 <tt>PATH</tt>. Use this variable to override
764 <tt>configure</tt>'s default behavior.</td>
765 </tr>
766</table>
767
768<p>The following options can be used to set or enable LLVM specific options:</p>
769
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]770<dl>
Reid Spencerfef93b72004-12-26 05:47:26 +0000[diff] [blame]771 <dt><i>--with-llvmgccdir</i></dt>
772 <dd>Path to the LLVM C/C++ FrontEnd to be used with this LLVM configuration.
773 The value of this option should specify the full pathname of the C/C++ Front
774 End to be used. If this option is not provided, the PATH will be searched for
775 a program named <i>llvm-gcc</i> and the C/C++ FrontEnd install directory will
776 be inferred from the path found. If the option is not given, and no llvm-gcc
777 can be found in the path then a warning will be produced by
778 <tt>configure</tt> indicating this situation. LLVM may still be built with
779 the <tt>tools-only</tt> target but attempting to build the runtime libraries
780 will fail as these libraries require llvm-gcc and llvm-g++. See
781 <a href="#installcf">Install the GCC Front End</a> for details on installing
782 the C/C++ Front End. See
783 <a href="CFEBuildInstrs.html">Bootstrapping the LLVM C/C++ Front-End</a>
784 for details on building the C/C++ Front End.</dd>
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]785 <dt><i>--with-tclinclude</i></dt>
John Criswell8bfe6a72005-05-18 19:43:33 +0000[diff] [blame]786 <dd>Path to the tcl include directory under which <tt>tclsh</tt> can be
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]787 found. Use this if you have multiple tcl installations on your machine and you
788 want to use a specific one (8.x) for LLVM. LLVM only uses tcl for running the
789 dejagnu based test suite in <tt>llvm/test</tt>. If you don't specify this
John Criswell8bfe6a72005-05-18 19:43:33 +0000[diff] [blame]790 option, the LLVM configure script will search for the tcl 8.4 and 8.3
791 releases.
John Criswell3d8ba512004-12-08 17:53:54 +0000[diff] [blame]792 <p></p>
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]793 </dd>
794 <dt><i>--enable-optimized</i></dt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]795 <dd>
796 Enables optimized compilation by default (debugging symbols are removed
797 and GCC optimization flags are enabled). The default is to use an
798 unoptimized build (also known as a debug build).
John Criswell3d8ba512004-12-08 17:53:54 +0000[diff] [blame]799 <p></p>
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]800 </dd>
Reid Spencer9d57b4d2005-12-21 03:46:45 +0000[diff] [blame]801 <dt><i>--enable-debug-runtime</i></dt>
802 <dd>
803 Enables debug symbols in the runtime libraries. The default is to strip
804 debug symbols from the runtime libraries.
805 </dd>
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]806 <dt><i>--enable-jit</i></dt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]807 <dd>
John Criswelld000e1d2003-12-18 16:43:17 +0000[diff] [blame]808 Compile the Just In Time (JIT) compiler functionality. This is not
809 available
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]810 on all platforms. The default is dependent on platform, so it is best
811 to explicitly enable it if you want it.
John Criswell3d8ba512004-12-08 17:53:54 +0000[diff] [blame]812 <p></p>
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]813 </dd>
Reid Spencer2dedcf52005-04-22 17:58:03 +0000[diff] [blame]814 <dt><i>--enable-targets=</i><tt>target-option</tt></dt>
815 <dd>Controls which targets will be built and linked into llc. The default
816 value for <tt>target_options</tt> is "all" which builds and links all
817 available targets. The value "host-only" can be specified to build only a
818 native compiler (no cross-compiler targets available). The "native" target is
819 selected as the target of the build host. You can also specify a comma
820 separated list of target names that you want available in llc. The target
John Criswell8bfe6a72005-05-18 19:43:33 +0000[diff] [blame]821 names use all lower case. The current set of targets is: <br/>
Reid Spencer2dedcf52005-04-22 17:58:03 +0000[diff] [blame]822 <tt>alpha, ia64, powerpc, skeleton, sparc, x86</tt>.
823 <p></p></dd>
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]824 <dt><i>--enable-doxygen</i></dt>
825 <dd>Look for the doxygen program and enable construction of doxygen based
826 documentation from the source code. This is disabled by default because
827 generating the documentation can take a long time and producess 100s of
828 megabytes of output.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]829</dl>
830
831<p>To configure LLVM, follow these steps:</p>
832
833<ol>
834 <li>Change directory into the object root directory:
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]835 <br>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]836 <tt>cd <i>OBJ_ROOT</i></tt>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]837 <p>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]838
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]839 <li>Run the <tt>configure</tt> script located in the LLVM source tree:
840 <br>
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]841 <tt><i>SRC_ROOT</i>/configure --prefix=/install/path [other options]</tt>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]842 <p>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]843</ol>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]844
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]845</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]846
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]847<!-- ======================================================================= -->
848<div class="doc_subsection">
849 <a name="compile">Compiling the LLVM Suite Source Code</a>
850</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]851
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]852<div class="doc_text">
John Criswell0b459202003-07-08 20:35:59 +0000[diff] [blame]853
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]854<p>Once you have configured LLVM, you can build it. There are three types of
855builds:</p>
John Criswell0b459202003-07-08 20:35:59 +0000[diff] [blame]856
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]857<dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]858 <dt>Debug Builds
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]859 <dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]860 These builds are the default when one types <tt>gmake</tt> (unless the
861 <tt>--enable-optimized</tt> option was used during configuration). The
862 build system will compile the tools and libraries with debugging
863 information.
864 <p>
865
866 <dt>Release (Optimized) Builds
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]867 <dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]868 These builds are enabled with the <tt>--enable-optimized</tt> option to
869 <tt>configure</tt> or by specifying <tt>ENABLE_OPTIMIZED=1</tt> on the
870 <tt>gmake</tt> command line. For these builds, the build system will
871 compile the tools and libraries with GCC optimizations enabled and strip
872 debugging information from the libraries and executables it generates.
873 <p>
874
875 <dt>Profile Builds
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]876 <dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]877 These builds are for use with profiling. They compile profiling
878 information into the code for use with programs like <tt>gprof</tt>.
879 Profile builds must be started by specifying <tt>ENABLE_PROFILING=1</tt>
880 on the <tt>gmake</tt> command line.
881</dl>
John Criswell7a73b802003-06-30 21:59:07 +0000[diff] [blame]882
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]883<p>Once you have LLVM configured, you can build it by entering the
884<i>OBJ_ROOT</i> directory and issuing the following command:</p>
John Criswell20d2d3e2003-10-10 14:26:14 +0000[diff] [blame]885
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]886<p><tt>gmake</tt></p>
John Criswell20d2d3e2003-10-10 14:26:14 +0000[diff] [blame]887
Chris Lattner95e92582004-07-18 22:32:22 +0000[diff] [blame]888<p>If the build fails, please <a href="#brokengcc">check here</a> to see if you
John Criswell3d8ba512004-12-08 17:53:54 +0000[diff] [blame]889are using a version of GCC that is known not to compile LLVM.</p>
Chris Lattner95e92582004-07-18 22:32:22 +0000[diff] [blame]890
891<p>
892If you have multiple processors in your machine, you may wish to use some of
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]893the parallel build options provided by GNU Make. For example, you could use the
894command:</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]895
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]896<p><tt>gmake -j2</tt></p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]897
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]898<p>There are several special targets which are useful when working with the LLVM
899source code:</p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]900
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]901<dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]902 <dt><tt>gmake clean</tt>
903 <dd>
904 Removes all files generated by the build. This includes object files,
905 generated C/C++ files, libraries, and executables.
906 <p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]907
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]908 <dt><tt>gmake dist-clean</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]909 <dd>
Misha Brukmanad38e962004-08-21 23:40:49 +0000[diff] [blame]910 Removes everything that <tt>gmake clean</tt> does, but also removes files
911 generated by <tt>configure</tt>. It attempts to return the source tree to the
912 original state in which it was shipped.
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]913 <p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]914
Misha Brukmane51c3562004-08-23 20:25:33 +0000[diff] [blame]915 <dt><tt>gmake install</tt>
916 <dd>
John Criswell3d8ba512004-12-08 17:53:54 +0000[diff] [blame]917 Installs LLVM header files, libraries, tools, and documentation in a
918 hierarchy
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]919 under $PREFIX, specified with <tt>./configure --prefix=[dir]</tt>, which
920 defaults to <tt>/usr/local</tt>.
Misha Brukmane51c3562004-08-23 20:25:33 +0000[diff] [blame]921 <p>
922
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]923 <dt><tt>gmake -C runtime install-bytecode</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]924 <dd>
Reid Spencer7863c402004-11-11 07:30:27 +0000[diff] [blame]925 Assuming you built LLVM into $OBJDIR, when this command is run, it will
926 install bytecode libraries into the GCC front end's bytecode library
927 directory. If you need to update your bytecode libraries,
Misha Brukmanad38e962004-08-21 23:40:49 +0000[diff] [blame]928 this is the target to use once you've built them.
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]929 <p>
930</dl>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]931
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]932<p>Please see the <a href="MakefileGuide.html">Makefile Guide</a> for further
933details on these <tt>make</tt> targets and descriptions of other targets
934available.</p>
935
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]936<p>It is also possible to override default values from <tt>configure</tt> by
937declaring variables on the command line. The following are some examples:</p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]938
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]939<dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]940 <dt><tt>gmake ENABLE_OPTIMIZED=1</tt>
941 <dd>
942 Perform a Release (Optimized) build.
943 <p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]944
Reid Spencer004ba032006-04-09 23:45:38 +0000[diff] [blame]945 <dt><tt>gmake ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1</tt>
Chris Lattnerd4651262006-03-21 01:10:57 +0000[diff] [blame]946 <dd>
Reid Spencer004ba032006-04-09 23:45:38 +0000[diff] [blame]947 Perform a Release (Optimized) build without assertions enabled.
Chris Lattnerd4651262006-03-21 01:10:57 +0000[diff] [blame]948 <p>
949
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]950 <dt><tt>gmake ENABLE_PROFILING=1</tt>
951 <dd>
952 Perform a Profiling build.
953 <p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]954
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]955 <dt><tt>gmake VERBOSE=1</tt>
956 <dd>
957 Print what <tt>gmake</tt> is doing on standard output.
958 <p>
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]959
960 <dt><tt>gmake TOOL_VERBOSE=1</tt></dt>
961 <dd>Ask each tool invoked by the makefiles to print out what it is doing on
John Criswell3d8ba512004-12-08 17:53:54 +0000[diff] [blame]962 the standard output. This also implies <tt>VERBOSE=1</tt>.
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]963 <p></dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]964</dl>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]965
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]966<p>Every directory in the LLVM object tree includes a <tt>Makefile</tt> to build
967it and any subdirectories that it contains. Entering any directory inside the
968LLVM object tree and typing <tt>gmake</tt> should rebuild anything in or below
969that directory that is out of date.</p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]970
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]971</div>
John Criswell20d2d3e2003-10-10 14:26:14 +0000[diff] [blame]972
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]973<!-- ======================================================================= -->
974<div class="doc_subsection">
975 <a name="objfiles">The Location of LLVM Object Files</a>
976</div>
John Criswell20d2d3e2003-10-10 14:26:14 +0000[diff] [blame]977
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]978<div class="doc_text">
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]979
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]980<p>The LLVM build system is capable of sharing a single LLVM source tree among
981several LLVM builds. Hence, it is possible to build LLVM for several different
982platforms or configurations using the same source tree.</p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]983
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]984<p>This is accomplished in the typical autoconf manner:</p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]985
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]986<ul>
987 <li><p>Change directory to where the LLVM object files should live:</p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]988
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]989 <p><tt>cd <i>OBJ_ROOT</i></tt></p></li>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]990
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]991 <li><p>Run the <tt>configure</tt> script found in the LLVM source
992 directory:</p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]993
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]994 <p><tt><i>SRC_ROOT</i>/configure</tt></p></li>
995</ul>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]996
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]997<p>The LLVM build will place files underneath <i>OBJ_ROOT</i> in directories
998named after the build type:</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]999
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1000<dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1001 <dt>Debug Builds
1002 <dd>
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1003 <dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1004 <dt>Tools
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]1005 <dd><tt><i>OBJ_ROOT</i>/Debug/bin</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1006 <dt>Libraries
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]1007 <dd><tt><i>OBJ_ROOT</i>/Debug/lib</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1008 </dl>
1009 <p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1010
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1011 <dt>Release Builds
1012 <dd>
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1013 <dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1014 <dt>Tools
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]1015 <dd><tt><i>OBJ_ROOT</i>/Release/bin</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1016 <dt>Libraries
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]1017 <dd><tt><i>OBJ_ROOT</i>/Release/lib</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1018 </dl>
1019 <p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1020
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1021 <dt>Profile Builds
1022 <dd>
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1023 <dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1024 <dt>Tools
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]1025 <dd><tt><i>OBJ_ROOT</i>/Profile/bin</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1026 <dt>Libraries
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]1027 <dd><tt><i>OBJ_ROOT</i>/Profile/lib</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1028 </dl>
1029</dl>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1030
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1031</div>
Chris Lattner7fe7f812002-07-24 19:51:14 +0000[diff] [blame]1032
Chris Lattnera553f622004-03-25 20:38:40 +0000[diff] [blame]1033<!-- ======================================================================= -->
1034<div class="doc_subsection">
1035 <a name="optionalconfig">Optional Configuration Items</a>
1036</div>
1037
1038<div class="doc_text">
1039
1040<p>
Misha Brukman9106eca2005-02-03 22:25:23 +0000[diff] [blame]1041If you're running on a Linux system that supports the "<a
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]1042 href="http://www.tat.physik.uni-tuebingen.de/~rguenth/linux/binfmt_misc.html">
1043 binfmt_misc</a>"
Chris Lattnera553f622004-03-25 20:38:40 +0000[diff] [blame]1044module, and you have root access on the system, you can set your system up to
1045execute LLVM bytecode files directly. To do this, use commands like this (the
1046first command may not be required if you are already using the module):</p>
1047
Misha Brukman9106eca2005-02-03 22:25:23 +0000[diff] [blame]1048<div class="doc_code">
Chris Lattnera553f622004-03-25 20:38:40 +0000[diff] [blame]1049<pre>
1050 $ mount -t binfmt_misc none /proc/sys/fs/binfmt_misc
Misha Brukman9106eca2005-02-03 22:25:23 +0000[diff] [blame]1051 $ echo ':llvm:M::llvm::/path/to/lli:' &gt; /proc/sys/fs/binfmt_misc/register
Chris Lattnera553f622004-03-25 20:38:40 +0000[diff] [blame]1052 $ chmod u+x hello.bc (if needed)
1053 $ ./hello.bc
1054</pre>
Misha Brukman9106eca2005-02-03 22:25:23 +0000[diff] [blame]1055</div>
Chris Lattnera553f622004-03-25 20:38:40 +0000[diff] [blame]1056
1057<p>
1058This allows you to execute LLVM bytecode files directly. Thanks to Jack
1059Cummings for pointing this out!
1060</p>
1061
1062</div>
1063
1064
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1065<!-- *********************************************************************** -->
1066<div class="doc_section">
1067 <a name="layout"><b>Program Layout</b></a>
1068</div>
1069<!-- *********************************************************************** -->
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1070
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1071<div class="doc_text">
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1072
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1073<p>One useful source of information about the LLVM source base is the LLVM <a
John Criswell364cec42004-03-12 20:31:37 +0000[diff] [blame]1074href="http://www.doxygen.org">doxygen</a> documentation available at <tt><a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1075href="http://llvm.org/doxygen/">http://llvm.org/doxygen/</a></tt>.
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1076The following is a brief introduction to code layout:</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1077
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1078</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1079
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1080<!-- ======================================================================= -->
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1081<div class="doc_subsection"><a name="cvsdir"><tt>CVS</tt> directories</a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1082<div class="doc_text">
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1083<p>Every directory checked out of CVS will contain a <tt>CVS</tt> directory; for
1084the most part these can just be ignored.</p>
Reid Spencerc4b09ba2004-12-08 16:18:26 +0000[diff] [blame]1085</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1086
Reid Spencerc4b09ba2004-12-08 16:18:26 +0000[diff] [blame]1087<!-- ======================================================================= -->
1088<div class="doc_subsection"><a name="examples"><tt>llvm/examples</tt></a></div>
1089<div class="doc_text">
1090 <p>This directory contains some simple examples of how to use the LLVM IR and
1091 JIT.</p>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1092</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1093
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1094<!-- ======================================================================= -->
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1095<div class="doc_subsection"><a name="include"><tt>llvm/include</tt></a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1096<div class="doc_text">
1097
1098<p>This directory contains public header files exported from the LLVM
1099library. The three main subdirectories of this directory are:</p>
1100
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1101<dl>
1102 <dt><tt><b>llvm/include/llvm</b></tt></dt>
1103 <dd>This directory contains all of the LLVM specific header files. This
1104 directory also has subdirectories for different portions of LLVM:
1105 <tt>Analysis</tt>, <tt>CodeGen</tt>, <tt>Target</tt>, <tt>Transforms</tt>,
1106 etc...</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1107
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1108 <dt><tt><b>llvm/include/llvm/Support</b></tt></dt>
1109 <dd>This directory contains generic support libraries that are provided with
1110 LLVM but not necessarily specific to LLVM. For example, some C++ STL utilities
1111 and a Command Line option processing library store their header files here.
1112 </dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1113
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1114 <dt><tt><b>llvm/include/llvm/Config</b></tt></dt>
1115 <dd>This directory contains header files configured by the <tt>configure</tt>
1116 script. They wrap "standard" UNIX and C header files. Source code can
1117 include these header files which automatically take care of the conditional
1118 #includes that the <tt>configure</tt> script generates.</dd>
1119</dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1120</div>
1121
1122<!-- ======================================================================= -->
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1123<div class="doc_subsection"><a name="lib"><tt>llvm/lib</tt></a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1124<div class="doc_text">
1125
1126<p>This directory contains most of the source files of the LLVM system. In LLVM,
1127almost all code exists in libraries, making it very easy to share code among the
1128different <a href="#tools">tools</a>.</p>
1129
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1130<dl>
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1131 <dt><tt><b>llvm/lib/VMCore/</b></tt></dt>
1132 <dd> This directory holds the core LLVM source files that implement core
1133 classes like Instruction and BasicBlock.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1134
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1135 <dt><tt><b>llvm/lib/AsmParser/</b></tt></dt>
1136 <dd>This directory holds the source code for the LLVM assembly language parser
1137 library.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1138
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1139 <dt><tt><b>llvm/lib/ByteCode/</b></tt></dt>
1140 <dd>This directory holds code for reading and write LLVM bytecode.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1141
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1142 <dt><tt><b>llvm/lib/Analysis/</b></tt><dd>This directory contains a variety of
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1143 different program analyses, such as Dominator Information, Call Graphs,
1144 Induction Variables, Interval Identification, Natural Loop Identification,
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1145 etc.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1146
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1147 <dt><tt><b>llvm/lib/Transforms/</b></tt></dt>
1148 <dd> This directory contains the source code for the LLVM to LLVM program
1149 transformations, such as Aggressive Dead Code Elimination, Sparse Conditional
1150 Constant Propagation, Inlining, Loop Invariant Code Motion, Dead Global
1151 Elimination, and many others.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1152
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1153 <dt><tt><b>llvm/lib/Target/</b></tt></dt>
1154 <dd> This directory contains files that describe various target architectures
1155 for code generation. For example, the <tt>llvm/lib/Target/SparcV9</tt>
1156 directory holds the Sparc machine description while
John Criswell8bfe6a72005-05-18 19:43:33 +0000[diff] [blame]1157 <tt>llvm/lib/Target/CBackend</tt> implements the LLVM-to-C converter.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1158
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1159 <dt><tt><b>llvm/lib/CodeGen/</b></tt></dt>
1160 <dd> This directory contains the major parts of the code generator: Instruction
1161 Selector, Instruction Scheduling, and Register Allocation.</dd>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1162
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1163 <dt><tt><b>llvm/lib/Debugger/</b></tt></dt>
1164 <dd> This directory contains the source level debugger library that makes
1165 it possible to instrument LLVM programs so that a debugger could identify
1166 source code locations at which the program is executing.</dd>
1167
1168 <dt><tt><b>llvm/lib/ExecutionEngine/</b></tt></dt>
1169 <dd> This directory contains libraries for executing LLVM bytecode directly
1170 at runtime in both interpreted and JIT compiled fashions.</dd>
1171
1172 <dt><tt><b>llvm/lib/Support/</b></tt></dt>
1173 <dd> This directory contains the source code that corresponds to the header
1174 files located in <tt>llvm/include/Support/</tt>.</dd>
1175
1176 <dt><tt><b>llvm/lib/System/</b></tt></dt>
1177 <dd>This directory contains the operating system abstraction layer that
1178 shields LLVM from platform-specific coding.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1179</dl>
John Criswell7a73b802003-06-30 21:59:07 +0000[diff] [blame]1180
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1181</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1182
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1183<!-- ======================================================================= -->
Reid Spencerc4b09ba2004-12-08 16:18:26 +0000[diff] [blame]1184<div class="doc_subsection"><a name="projects"><tt>llvm/projects</tt></a></div>
1185<div class="doc_text">
1186 <p>This directory contains projects that are not strictly part of LLVM but are
1187 shipped with LLVM. This is also the directory where you should create your own
1188 LLVM-based projects. See <tt>llvm/projects/sample</tt> for an example of how
1189 to set up your own project. See <tt>llvm/projects/Stacker</tt> for a fully
1190 functional example of a compiler front end.</p>
1191</div>
1192
1193<!-- ======================================================================= -->
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1194<div class="doc_subsection"><a name="runtime"><tt>llvm/runtime</tt></a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1195<div class="doc_text">
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1196
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1197<p>This directory contains libraries which are compiled into LLVM bytecode and
1198used when linking programs with the GCC front end. Most of these libraries are
1199skeleton versions of real libraries; for example, libc is a stripped down
1200version of glibc.</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1201
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1202<p>Unlike the rest of the LLVM suite, this directory needs the LLVM GCC front
1203end to compile.</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1204
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1205</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1206
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1207<!-- ======================================================================= -->
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1208<div class="doc_subsection"><a name="test"><tt>llvm/test</tt></a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1209<div class="doc_text">
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1210 <p>This directory contains feature and regression tests and other basic sanity
1211 checks on the LLVM infrastructure. These are intended to run quickly and cover
1212 a lot of territory without being exhaustive.</p>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1213</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1214
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1215<!-- ======================================================================= -->
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1216<div class="doc_subsection"><a name="llvmtest"><tt>llvm-test</tt></a></div>
1217<div class="doc_text">
John Criswell3d8ba512004-12-08 17:53:54 +0000[diff] [blame]1218 <p>This is not a directory in the normal llvm module; it is a separate CVS
Misha Brukmane12215f2004-11-15 23:20:51 +0000[diff] [blame]1219 module that must be checked out (usually to <tt>projects/llvm-test</tt>). This
John Criswell3d8ba512004-12-08 17:53:54 +0000[diff] [blame]1220 module contains a comprehensive correctness, performance, and benchmarking
1221 test
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1222 suite for LLVM. It is a separate CVS module because not every LLVM user is
John Criswell838bce52005-05-09 16:39:27 +0000[diff] [blame]1223 interested in downloading or building such a comprehensive test suite. For
1224 further details on this test suite, please see the
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1225 <a href="TestingGuide.html">Testing Guide</a> document.</p>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1226</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1227
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1228<!-- ======================================================================= -->
1229<div class="doc_subsection"><a name="tools"><tt>llvm/tools</tt></a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1230<div class="doc_text">
John Criswell20d2d3e2003-10-10 14:26:14 +0000[diff] [blame]1231
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1232<p>The <b>tools</b> directory contains the executables built out of the
1233libraries above, which form the main part of the user interface. You can
1234always get help for a tool by typing <tt>tool_name --help</tt>. The
Misha Brukmane12215f2004-11-15 23:20:51 +0000[diff] [blame]1235following is a brief introduction to the most important tools. More detailed
1236information is in the <a href="CommandGuide/index.html">Command Guide</a>.</p>
John Criswell20d2d3e2003-10-10 14:26:14 +0000[diff] [blame]1237
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1238<dl>
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1239 <dt><tt><b>analyze</b></tt></dt>
1240 <dd><tt>analyze</tt> is used to run a specific
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1241 analysis on an input LLVM bytecode file and print out the results. It is
1242 primarily useful for debugging analyses, or familiarizing yourself with
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1243 what an analysis does.</dd>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1244
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1245 <dt><tt><b>bugpoint</b></tt></dt>
1246 <dd><tt>bugpoint</tt> is used to debug
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1247 optimization passes or code generation backends by narrowing down the
1248 given test case to the minimum number of passes and/or instructions that
1249 still cause a problem, whether it is a crash or miscompilation. See <a
1250 href="HowToSubmitABug.html">HowToSubmitABug.html</a> for more information
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1251 on using <tt>bugpoint</tt>.</dd>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1252
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1253 <dt><tt><b>llvmc</b></tt></dt>
1254 <dd>The LLVM Compiler Driver. This program can
1255 be configured to utilize both LLVM and non-LLVM compilation tools to enable
1256 pre-processing, translation, optimization, assembly, and linking of programs
1257 all from one command line. <tt>llvmc</tt> also takes care of processing the
1258 dependent libraries found in bytecode. This reduces the need to get the
Reid Spencer079e9452004-12-08 18:00:30 +0000[diff] [blame]1259 traditional <tt>-l&lt;name&gt;</tt> options right on the command line. Please
John Criswell8bfe6a72005-05-18 19:43:33 +0000[diff] [blame]1260 note that this tool, while functional, is still experimental and not feature
1261 complete.</dd>
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1262
1263 <dt><tt><b>llvm-ar</b></tt></dt>
1264 <dd>The archiver produces an archive containing
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1265 the given LLVM bytecode files, optionally with an index for faster
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1266 lookup.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1267
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1268 <dt><tt><b>llvm-as</b></tt></dt>
1269 <dd>The assembler transforms the human readable LLVM assembly to LLVM
1270 bytecode.</dd>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1271
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1272 <dt><tt><b>llvm-dis</b></tt></dt>
1273 <dd>The disassembler transforms the LLVM bytecode to human readable
1274 LLVM assembly.</dd>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1275
Reid Spencer079e9452004-12-08 18:00:30 +0000[diff] [blame]1276 <dt><tt><b>llvm-ld</b></tt></dt>
1277 <dd><tt>llvm-ld</tt> is very similar to gccld and provides a general purpose
1278 and extensible linker for LLVM. This is the linker invoked by <tt>llvmc</tt>.
1279 It allows optimization modules to be loaded so that language specific
John Criswell8bfe6a72005-05-18 19:43:33 +0000[diff] [blame]1280 optimizations can be applied at link time. This tool is considered
1281 experimental.</dd>
Reid Spencer079e9452004-12-08 18:00:30 +0000[diff] [blame]1282
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1283 <dt><tt><b>llvm-link</b></tt></dt>
1284 <dd><tt>llvm-link</tt>, not surprisingly, links multiple LLVM modules into
1285 a single program.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1286
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1287 <dt><tt><b>lli</b></tt></dt>
1288 <dd><tt>lli</tt> is the LLVM interpreter, which
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1289 can directly execute LLVM bytecode (although very slowly...). In addition
1290 to a simple interpreter, <tt>lli</tt> also has a tracing mode (entered by
1291 specifying <tt>-trace</tt> on the command line). Finally, for
John Criswelld9eceee2004-12-08 18:04:14 +0000[diff] [blame]1292 architectures that support it (currently x86, Sparc, and PowerPC), by default,
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1293 <tt>lli</tt> will function as a Just-In-Time compiler (if the
1294 functionality was compiled in), and will execute the code <i>much</i>
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1295 faster than the interpreter.</dd>
Misha Brukmanef0ad412003-10-06 19:23:34 +0000[diff] [blame]1296
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1297 <dt><tt><b>llc</b></tt></dt>
1298 <dd> <tt>llc</tt> is the LLVM backend compiler, which
John Criswell8bfe6a72005-05-18 19:43:33 +0000[diff] [blame]1299 translates LLVM bytecode to a native code assembly file or to C code (with
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1300 the -march=c option).</dd>
Misha Brukmanef0ad412003-10-06 19:23:34 +0000[diff] [blame]1301
Reid Spencerd4694f92004-12-22 06:29:07 +0000[diff] [blame]1302 <dt><tt><b>llvm-gcc</b></tt></dt>
1303 <dd><tt>llvm-gcc</tt> is a GCC-based C frontend
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1304 that has been retargeted to emit LLVM code as the machine code output. It
1305 works just like any other GCC compiler, taking the typical <tt>-c, -S, -E,
1306 -o</tt> options that are typically used. The source code for the
John Criswell8bfe6a72005-05-18 19:43:33 +0000[diff] [blame]1307 <tt>llvm-gcc</tt> tool is available as a separate CVS module.
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1308 <blockquote>
1309 <dl>
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1310 <dt><tt><b>gccas</b></tt></dt>
Reid Spencerd4694f92004-12-22 06:29:07 +0000[diff] [blame]1311 <dd>This tool is invoked by the <tt>llvm-gcc</tt> frontend as the
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1312 "assembler" part of the compiler. This tool actually assembles LLVM
1313 assembly to LLVM bytecode, performs a variety of optimizations, and
1314 outputs LLVM bytecode. Thus when you invoke
Reid Spencerd4694f92004-12-22 06:29:07 +0000[diff] [blame]1315 <tt>llvm-gcc -c x.c -o x.o</tt>, you are causing <tt>gccas</tt> to be
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1316 run, which writes the <tt>x.o</tt> file (which is an LLVM bytecode file
1317 that can be disassembled or manipulated just like any other bytecode
1318 file). The command line interface to <tt>gccas</tt> is designed to be
1319 as close as possible to the <b>system</b> `<tt>as</tt>' utility so that
1320 the gcc frontend itself did not have to be modified to interface to
1321 a "weird" assembler.</dd>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1322
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1323 <dt><tt><b>gccld</b></tt></dt>
1324 <dd><tt>gccld</tt> links together several LLVM bytecode files into one
1325 bytecode file and does some optimization. It is the linker invoked by
1326 the GCC frontend when multiple .o files need to be linked together.
1327 Like <tt>gccas</tt>, the command line interface of <tt>gccld</tt> is
1328 designed to match the system linker, to aid interfacing with the GCC
1329 frontend.</dd>
1330 </dl>
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1331 </blockquote>
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1332 </dd>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1333
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1334 <dt><tt><b>opt</b></tt></dt>
1335 <dd><tt>opt</tt> reads LLVM bytecode, applies a
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1336 series of LLVM to LLVM transformations (which are specified on the command
1337 line), and then outputs the resultant bytecode. The '<tt>opt --help</tt>'
1338 command is a good way to get a list of the program transformations
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1339 available in LLVM.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1340</dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1341</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1342
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1343<!-- ======================================================================= -->
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1344<div class="doc_subsection"><a name="utils"><tt>llvm/utils</tt></a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1345<div class="doc_text">
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1346
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1347<p>This directory contains utilities for working with LLVM source code, and some
1348of the utilities are actually required as part of the build process because they
1349are code generators for parts of LLVM infrastructure.</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1350
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1351<dl>
1352 <dt><tt><b>Burg/</b></tt> <dd><tt>Burg</tt> is an instruction selector
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1353 generator -- it builds trees on which it then performs pattern-matching to
1354 select instructions according to the patterns the user has specified. Burg
1355 is currently used in the Sparc V9 backend.<p>
John Criswell0b459202003-07-08 20:35:59 +0000[diff] [blame]1356
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1357 <dt><tt><b>codegen-diff</b></tt> <dd><tt>codegen-diff</tt> is a script
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1358 that finds differences between code that LLC generates and code that LLI
1359 generates. This is a useful tool if you are debugging one of them,
1360 assuming that the other generates correct output. For the full user
1361 manual, run <tt>`perldoc codegen-diff'</tt>.<p>
Misha Brukmanc103adf2003-08-11 18:45:46 +0000[diff] [blame]1362
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1363 <dt><tt><b>cvsupdate</b></tt> <dd><tt>cvsupdate</tt> is a script that will
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1364 update your CVS tree, but produce a much cleaner and more organized output
1365 than simply running <tt>`cvs -z3 up -dP'</tt> will. For example, it will group
1366 together all the new and updated files and modified files in separate
1367 sections, so you can see at a glance what has changed. If you are at the
1368 top of your LLVM CVS tree, running <tt>utils/cvsupdate</tt> is the
1369 preferred way of updating the tree.<p>
Misha Brukmanc103adf2003-08-11 18:45:46 +0000[diff] [blame]1370
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1371 <dt><tt><b>emacs/</b></tt> <dd>The <tt>emacs</tt> directory contains
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1372 syntax-highlighting files which will work with Emacs and XEmacs editors,
1373 providing syntax highlighting support for LLVM assembly files and TableGen
1374 description files. For information on how to use the syntax files, consult
1375 the <tt>README</tt> file in that directory.<p>
Misha Brukmanc103adf2003-08-11 18:45:46 +0000[diff] [blame]1376
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1377 <dt><tt><b>getsrcs.sh</b></tt> <dd>The <tt>getsrcs.sh</tt> script finds
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1378 and outputs all non-generated source files, which is useful if one wishes
1379 to do a lot of development across directories and does not want to
1380 individually find each file. One way to use it is to run, for example:
1381 <tt>xemacs `utils/getsources.sh`</tt> from the top of your LLVM source
1382 tree.<p>
1383
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1384 <dt><tt><b>llvmgrep</b></tt></dt>
1385 <dd>This little tool performs an "egrep -H -n" on each source file in LLVM and
1386 passes to it a regular expression provided on <tt>llvmgrep</tt>'s command
1387 line. This is a very efficient way of searching the source base for a
1388 particular regular expression.</dd>
1389
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1390 <dt><tt><b>makellvm</b></tt> <dd>The <tt>makellvm</tt> script compiles all
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1391 files in the current directory and then compiles and links the tool that
1392 is the first argument. For example, assuming you are in the directory
1393 <tt>llvm/lib/Target/Sparc</tt>, if <tt>makellvm</tt> is in your path,
1394 simply running <tt>makellvm llc</tt> will make a build of the current
1395 directory, switch to directory <tt>llvm/tools/llc</tt> and build it,
1396 causing a re-linking of LLC.<p>
Misha Brukmanc103adf2003-08-11 18:45:46 +0000[diff] [blame]1397
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1398 <dt><tt><b>NightlyTest.pl</b></tt> and
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1399 <tt><b>NightlyTestTemplate.html</b></tt> <dd>These files are used in a
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1400 cron script to generate nightly status reports of the functionality of
1401 tools, and the results can be seen by following the appropriate link on
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1402 the <a href="http://llvm.org/">LLVM homepage</a>.<p>
Misha Brukmanc103adf2003-08-11 18:45:46 +0000[diff] [blame]1403
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1404 <dt><tt><b>TableGen/</b></tt> <dd>The <tt>TableGen</tt> directory contains
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1405 the tool used to generate register descriptions, instruction set
1406 descriptions, and even assemblers from common TableGen description
1407 files.<p>
Misha Brukmanc103adf2003-08-11 18:45:46 +0000[diff] [blame]1408
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1409 <dt><tt><b>vim/</b></tt> <dd>The <tt>vim</tt> directory contains
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1410 syntax-highlighting files which will work with the VIM editor, providing
1411 syntax highlighting support for LLVM assembly files and TableGen
1412 description files. For information on how to use the syntax files, consult
1413 the <tt>README</tt> file in that directory.<p>
Misha Brukmanc103adf2003-08-11 18:45:46 +0000[diff] [blame]1414
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1415</dl>
Misha Brukmanc103adf2003-08-11 18:45:46 +0000[diff] [blame]1416
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1417</div>
Misha Brukmanc103adf2003-08-11 18:45:46 +0000[diff] [blame]1418
Reid Spencerc4b09ba2004-12-08 16:18:26 +0000[diff] [blame]1419<!-- ======================================================================= -->
1420<div class="doc_subsection"><a name="win32"><tt>llvm/win32</tt></a></div>
1421<div class="doc_text">
1422 <p>This directory contains build scripts and project files for use with
1423 Visual C++. This allows developers on Windows to build LLVM without the need
John Criswell3d8ba512004-12-08 17:53:54 +0000[diff] [blame]1424 for Cygwin. The contents of this directory should be considered experimental
Reid Spencerc4b09ba2004-12-08 16:18:26 +0000[diff] [blame]1425 at this time.
1426 </p>
1427</div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1428<!-- *********************************************************************** -->
1429<div class="doc_section">
1430 <a name="tutorial">An Example Using the LLVM Tool Chain</a>
1431</div>
1432<!-- *********************************************************************** -->
Misha Brukmanc103adf2003-08-11 18:45:46 +0000[diff] [blame]1433
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1434<div class="doc_text">
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1435
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1436<ol>
1437 <li>First, create a simple C file, name it 'hello.c':
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1438 <pre>
1439 #include &lt;stdio.h&gt;
1440 int main() {
1441 printf("hello world\n");
1442 return 0;
1443 }
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1444 </pre></li>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1445
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1446 <li><p>Next, compile the C file into a LLVM bytecode file:</p>
Reid Spencerd4694f92004-12-22 06:29:07 +0000[diff] [blame]1447 <p><tt>% llvm-gcc hello.c -o hello</tt></p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1448
Misha Brukmanf089cdf2004-06-22 18:48:58 +0000[diff] [blame]1449 <p>Note that you should have already built the tools and they have to be
1450 in your path, at least <tt>gccas</tt> and <tt>gccld</tt>.</p>
1451
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1452 <p>This will create two result files: <tt>hello</tt> and
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1453 <tt>hello.bc</tt>. The <tt>hello.bc</tt> is the LLVM bytecode that
1454 corresponds the the compiled program and the library facilities that it
1455 required. <tt>hello</tt> is a simple shell script that runs the bytecode
Chris Lattnera19a3db2004-05-01 11:40:07 +0000[diff] [blame]1456 file with <tt>lli</tt>, making the result directly executable. Note that
1457 all LLVM optimizations are enabled by default, so there is no need for a
1458 "-O3" switch.</p></li>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1459
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1460 <li><p>Run the program. To make sure the program ran, execute one of the
1461 following commands:</p>
John Criswell8df90e02003-06-11 20:46:40 +0000[diff] [blame]1462
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1463 <p><tt>% ./hello</tt></p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1464
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1465 <p>or</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1466
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1467 <p><tt>% lli hello.bc</tt></p></li>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1468
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1469 <li><p>Use the <tt>llvm-dis</tt> utility to take a look at the LLVM assembly
1470 code:</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1471
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1472 <p><tt>% llvm-dis &lt; hello.bc | less</tt><p></li>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1473
Chris Lattnerb3bbcba2004-06-02 20:37:02 +0000[diff] [blame]1474 <li><p>Compile the program to native assembly using the LLC code
1475 generator:</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1476
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1477 <p><tt>% llc hello.bc -o hello.s</tt></p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1478
Chris Lattnerb3bbcba2004-06-02 20:37:02 +0000[diff] [blame]1479 <li><p>Assemble the native assembly language file into a program:</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1480
Chris Lattnerb3bbcba2004-06-02 20:37:02 +0000[diff] [blame]1481 <p><b>Solaris:</b><tt>% /opt/SUNWspro/bin/cc -xarch=v9 hello.s -o hello.native</tt></p>
1482 <p><b>Others:</b><tt>% gcc hello.s -o hello.native</tt></p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1483
Chris Lattnerb3bbcba2004-06-02 20:37:02 +0000[diff] [blame]1484 <li><p>Execute the native code program:</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1485
Chris Lattnerb3bbcba2004-06-02 20:37:02 +0000[diff] [blame]1486 <p><tt>% ./hello.native</tt></p></li>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1487
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1488</ol>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1489
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1490</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1491
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1492<!-- *********************************************************************** -->
1493<div class="doc_section">
1494 <a name="problems">Common Problems</a>
1495</div>
1496<!-- *********************************************************************** -->
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]1497
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1498<div class="doc_text">
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]1499
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1500<p>If you are having problems building or using LLVM, or if you have any other
1501general questions about LLVM, please consult the <a href="FAQ.html">Frequently
1502Asked Questions</a> page.</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1503
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1504</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1505
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1506<!-- *********************************************************************** -->
1507<div class="doc_section">
1508 <a name="links">Links</a>
1509</div>
1510<!-- *********************************************************************** -->
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1511
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1512<div class="doc_text">
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1513
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1514<p>This document is just an <b>introduction</b> to how to use LLVM to do
1515some simple things... there are many more interesting and complicated things
1516that you can do that aren't documented here (but we'll gladly accept a patch
1517if you want to write something up!). For more information about LLVM, check
1518out:</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1519
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1520<ul>
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1521 <li><a href="http://llvm.org/">LLVM homepage</a></li>
1522 <li><a href="http://llvm.org/doxygen/">LLVM doxygen tree</a></li>
1523 <li><a href="http://llvm.org/docs/Projects.html">Starting a Project
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1524 that Uses LLVM</a></li>
1525</ul>
1526
1527</div>
1528
1529<!-- *********************************************************************** -->
1530
1531<hr>
Misha Brukman142207b2003-11-22 01:30:01 +0000[diff] [blame]1532<address>
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1533 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1534 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
1535 <a href="http://validator.w3.org/check/referer"><img
1536 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
1537
Misha Brukman142207b2003-11-22 01:30:01 +0000[diff] [blame]1538 <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1539 <a href="http://llvm.x10sys.com/rspencer/">Reid Spencer</a><br>
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1540 <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1541 Last modified: $Date$
Misha Brukman142207b2003-11-22 01:30:01 +0000[diff] [blame]1542</address>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1543</body>
Guochun Shif4688a82002-07-17 23:05:56 +0000[diff] [blame]1544</html>