Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 54edc840005074e6119fa4ca3c2c020ec02a6627 / . / docs / GettingStarted.html
blob: ac0c2d16094cf56e4d10f33163fdf9a8fa60787b [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
Chris Lattner6557f182006-06-16 17:20:33 +0000[diff] [blame]489to compile LLVM. We routinely use GCC 3.3.3, 3.4.0, and Apple 4.0.1
490successfully with them (however, see below). Other versions of GCC will
491probably work 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>
Chris Lattnerdd197912006-06-16 19:53:39 +0000[diff] [blame]518<p><b>Apple Xcode 2.3</b>: GCC crashes when compiling LLVM at -O3 (which is the
519 default with ENABLE_OPTIMIZED=1. To work around this, build with
520 "ENABLE_OPTIMIZED=1 OPTIMIZE_OPTION=-O2".</p>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]521</div>
522
Chris Lattner95e92582004-07-18 22:32:22 +0000[diff] [blame]523
524
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]525<!-- *********************************************************************** -->
526<div class="doc_section">
527 <a name="starting"><b>Getting Started with LLVM</b></a>
528</div>
529<!-- *********************************************************************** -->
530
Chris Lattner95e92582004-07-18 22:32:22 +0000[diff] [blame]531<div class="doc_text">
532
533<p>The remainder of this guide is meant to get you up and running with
534LLVM and to give you some basic information about the LLVM environment.</p>
535
536<p>The later sections of this guide describe the <a
537href="#layout">general layout</a> of the the LLVM source tree, a <a
538href="#tutorial">simple example</a> using the LLVM tool chain, and <a
539href="#links">links</a> to find more information about LLVM or to get
540help via e-mail.</p>
541</div>
542
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]543<!-- ======================================================================= -->
544<div class="doc_subsection">
545 <a name="terminology">Terminology and Notation</a>
546</div>
547
548<div class="doc_text">
549
550<p>Throughout this manual, the following names are used to denote paths
551specific to the local system and working environment. <i>These are not
552environment variables you need to set but just strings used in the rest
553of this document below</i>. In any of the examples below, simply replace
554each of these names with the appropriate pathname on your local system.
555All these paths are absolute:</p>
556
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]557<dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]558 <dt>SRC_ROOT
559 <dd>
560 This is the top level directory of the LLVM source tree.
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]561 <p>
562
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]563 <dt>OBJ_ROOT
564 <dd>
565 This is the top level directory of the LLVM object tree (i.e. the
566 tree where object files and compiled programs will be placed. It
567 can be the same as SRC_ROOT).
568 <p>
569
570 <dt>LLVMGCCDIR
571 <dd>
Reid Spencerfef93b72004-12-26 05:47:26 +0000[diff] [blame]572 This is where the LLVM GCC Front End is installed.
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]573 <p>
574 For the pre-built GCC front end binaries, the LLVMGCCDIR is
575 <tt>cfrontend/<i>platform</i>/llvm-gcc</tt>.
576</dl>
577
578</div>
579
580<!-- ======================================================================= -->
581<div class="doc_subsection">
582 <a name="environment">Setting Up Your Environment</a>
583</div>
584
585<div class="doc_text">
586
587<p>
Misha Brukman8f0cad12005-02-03 18:28:08 +0000[diff] [blame]588In order to compile and use LLVM, you may need to set some environment
589variables.
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]590
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]591<dl>
Reid Spencerf96eb572004-12-15 00:14:01 +0000[diff] [blame]592 <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]593 <dd>[Optional] This environment variable helps LLVM linking tools find the
John Criswell8bfe6a72005-05-18 19:43:33 +0000[diff] [blame]594 locations of your bytecode libraries. It is provided only as a
Misha Brukman8f0cad12005-02-03 18:28:08 +0000[diff] [blame]595 convenience since you can specify the paths using the -L options of the
John Criswell8bfe6a72005-05-18 19:43:33 +0000[diff] [blame]596 tools and the C/C++ front-end will automatically use the bytecode files
597 installed in its
Misha Brukman8f0cad12005-02-03 18:28:08 +0000[diff] [blame]598 <tt>lib</tt> directory.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]599</dl>
600
601</div>
602
603<!-- ======================================================================= -->
604<div class="doc_subsection">
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]605 <a name="unpack">Unpacking the LLVM Archives</a>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]606</div>
607
608<div class="doc_text">
609
610<p>
611If you have the LLVM distribution, you will need to unpack it before you
John Criswelld000e1d2003-12-18 16:43:17 +0000[diff] [blame]612can 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]613suite and the LLVM GCC front end compiled for your platform. There is an
614additional test suite that is optional. Each file is a TAR archive that is
615compressed with the gzip program.
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]616</p>
617
Misha Brukman3ce11032005-02-02 18:01:57 +0000[diff] [blame]618<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]619<dl>
Misha Brukman3ce11032005-02-02 18:01:57 +0000[diff] [blame]620 <dt><tt>llvm-x.y.tar.gz</tt></dt>
621 <dd>Source release for the LLVM libraries and tools.<br/></dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]622
Misha Brukman3ce11032005-02-02 18:01:57 +0000[diff] [blame]623 <dt><tt>llvm-test-x.y.tar.gz</tt></dt>
Chris Lattner7db3f522005-02-09 21:15:51 +0000[diff] [blame]624 <dd>Source release for the LLVM test suite.</dd>
Misha Brukman8f9e6d62004-11-23 19:26:24 +0000[diff] [blame]625
Misha Brukman3ce11032005-02-02 18:01:57 +0000[diff] [blame]626 <dt><tt>cfrontend-x.y.source.tar.gz</tt></dt>
627 <dd>Source release of the GCC front end.<br/></dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]628
Misha Brukman3ce11032005-02-02 18:01:57 +0000[diff] [blame]629 <dt><tt>cfrontend-x.y.i686-redhat-linux-gnu.tar.gz</tt></dt>
630 <dd>Binary release of the GCC front end for Linux/x86.<br/></dd>
John Criswelld000e1d2003-12-18 16:43:17 +0000[diff] [blame]631
Chris Lattner1ef81af2006-04-20 05:08:23 +0000[diff] [blame]632 <dt><tt>llvm-gcc4-x.y.source.tar.gz</tt></dt>
633 <dd>Source release of the llvm-gcc4 front end. See README.LLVM in the root
634 directory for build instructions.<br/></dd>
635
636 <dt><tt>llvm-gcc4-x.y.powerpc-apple-darwin8.6.0.tar.gz</tt></dt>
637 <dd>Binary release of the llvm-gcc4 front end for MacOS X/PowerPC.<br/></dd>
638
639 <dt><tt>llvm-gcc4-x.y.i686-apple-darwin8.6.1.tar.gz</tt></dt>
640 <dd>Binary release of the llvm-gcc4 front end for MacOS X/X86.<br/></dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]641</dl>
642
643</div>
644
645<!-- ======================================================================= -->
646<div class="doc_subsection">
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]647 <a name="checkout">Checkout LLVM from CVS</a>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]648</div>
649
650<div class="doc_text">
651
652<p>If you have access to our CVS repository, you can get a fresh copy of
653the entire source code. All you need to do is check it out from CVS as
654follows:</p>
655
656<ul>
657<li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
658 <li><tt>cvs -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm login</tt>
659 <li>Hit the return key when prompted for the password.
660 <li><tt>cvs -z3 -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm co
661 llvm</tt>
662</ul>
663
664<p>This will create an '<tt>llvm</tt>' directory in the current
665directory and fully populate it with the LLVM source code, Makefiles,
666test directories, and local copies of documentation files.</p>
667
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]668<p>If you want to get a specific release (as opposed to the most recent
669revision), you can specify a label. The following releases have the following
Misha Brukman3ce11032005-02-02 18:01:57 +0000[diff] [blame]670labels:</p>
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]671
John Criswelld000e1d2003-12-18 16:43:17 +0000[diff] [blame]672<ul>
Tanya Lattner993b9802006-04-20 04:35:34 +0000[diff] [blame]673<li>Release 1.7: <b>RELEASE_17</b></li>
John Criswellc0c186d2005-11-08 21:11:33 +0000[diff] [blame]674<li>Release 1.6: <b>RELEASE_16</b></li>
John Criswell75162552005-05-09 16:49:59 +0000[diff] [blame]675<li>Release 1.5: <b>RELEASE_15</b></li>
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]676<li>Release 1.4: <b>RELEASE_14</b></li>
John Criswell18b74642004-08-16 14:51:33 +0000[diff] [blame]677<li>Release 1.3: <b>RELEASE_13</b></li>
Misha Brukmanb9be2bf2004-05-12 19:25:59 +0000[diff] [blame]678<li>Release 1.2: <b>RELEASE_12</b></li>
679<li>Release 1.1: <b>RELEASE_11</b></li>
680<li>Release 1.0: <b>RELEASE_1</b></li>
John Criswelld000e1d2003-12-18 16:43:17 +0000[diff] [blame]681</ul>
John Criswelld000e1d2003-12-18 16:43:17 +0000[diff] [blame]682
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]683<p>If you would like to get the LLVM test suite (a separate package as of 1.4),
684you get it from the CVS repository:</p>
685<pre>
686 cd llvm/projects
687 cvs -z3 -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm co llvm-test
688</pre>
689<p>By placing it in the <tt>llvm/projects</tt>, it will be automatically
John Criswellc4ef3f22004-12-08 16:55:27 +0000[diff] [blame]690configured by the LLVM configure script as well as automatically updated when
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]691you run <tt>cvs update</tt>.</p>
692
Tanya Lattner993b9802006-04-20 04:35:34 +0000[diff] [blame]693<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]694
Chris Lattner604fdc12004-06-28 17:14:01 +0000[diff] [blame]695<pre>
696 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]697</pre>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]698
Chris Lattner604fdc12004-06-28 17:14:01 +0000[diff] [blame]699<p>Please note that you must follow <a href="CFEBuildInstrs.html">these
John Criswell3d8ba512004-12-08 17:53:54 +0000[diff] [blame]700instructions</a> to successfully build the LLVM GCC front-end.</p>
Chris Lattner604fdc12004-06-28 17:14:01 +0000[diff] [blame]701
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]702</div>
703
704<!-- ======================================================================= -->
705<div class="doc_subsection">
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]706 <a name="installcf">Install the GCC Front End</a>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]707</div>
708
709<div class="doc_text">
710
711<p>Before configuring and compiling the LLVM suite, you need to extract the LLVM
712GCC front end from the binary distribution. It is used for building the
713bytecode libraries later used by the GCC front end for linking programs, and its
714location must be specified when the LLVM suite is configured.</p>
715
716<p>To install the GCC front end, do the following:</p>
717
718<ol>
719 <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]720 <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]721 -</tt></li>
722</ol>
723
John Criswell9e2485c2004-12-10 15:51:16 +0000[diff] [blame]724<p>Next, you will need to fix your system header files:</p>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]725
John Criswell364cec42004-03-12 20:31:37 +0000[diff] [blame]726<p><tt>cd cfrontend/<i>platform</i><br>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]727 ./fixheaders</tt></p>
728
729<p>The binary versions of the GCC front end may not suit all of your needs. For
730example, the binary distribution may include an old version of a system header
731file, not "fix" a header file that needs to be fixed for GCC, or it may be
732linked with libraries not available on your system.</p>
733
734<p>In cases like these, you may want to try <a
735href="CFEBuildInstrs.html">building the GCC front end from source.</a> This is
736not for the faint of heart, so be forewarned.</p>
737
738</div>
739
740<!-- ======================================================================= -->
741<div class="doc_subsection">
742 <a name="config">Local LLVM Configuration</a>
743</div>
744
745<div class="doc_text">
746
747<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]748configured via the <tt>configure</tt> script. This script sets variables in the
749various <tt>*.in</tt> files, most notably <tt>llvm/Makefile.config</tt> and
750<tt>llvm/include/Config/config.h</tt>. It also populates <i>OBJ_ROOT</i> with
751the Makefiles needed to begin building LLVM.</p>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]752
753<p>The following environment variables are used by the <tt>configure</tt>
754script to configure the build system:</p>
755
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]756<table>
757 <tr><th>Variable</th><th>Purpose</th></tr>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]758 <tr>
759 <td>CC</td>
760 <td>Tells <tt>configure</tt> which C compiler to use. By default,
761 <tt>configure</tt> will look for the first GCC C compiler in
762 <tt>PATH</tt>. Use this variable to override
763 <tt>configure</tt>'s default behavior.</td>
764 </tr>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]765 <tr>
766 <td>CXX</td>
767 <td>Tells <tt>configure</tt> which C++ compiler to use. By default,
768 <tt>configure</tt> will look for the first GCC C++ compiler in
769 <tt>PATH</tt>. Use this variable to override
770 <tt>configure</tt>'s default behavior.</td>
771 </tr>
772</table>
773
774<p>The following options can be used to set or enable LLVM specific options:</p>
775
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]776<dl>
Reid Spencerfef93b72004-12-26 05:47:26 +0000[diff] [blame]777 <dt><i>--with-llvmgccdir</i></dt>
778 <dd>Path to the LLVM C/C++ FrontEnd to be used with this LLVM configuration.
779 The value of this option should specify the full pathname of the C/C++ Front
780 End to be used. If this option is not provided, the PATH will be searched for
781 a program named <i>llvm-gcc</i> and the C/C++ FrontEnd install directory will
782 be inferred from the path found. If the option is not given, and no llvm-gcc
783 can be found in the path then a warning will be produced by
784 <tt>configure</tt> indicating this situation. LLVM may still be built with
785 the <tt>tools-only</tt> target but attempting to build the runtime libraries
786 will fail as these libraries require llvm-gcc and llvm-g++. See
787 <a href="#installcf">Install the GCC Front End</a> for details on installing
788 the C/C++ Front End. See
789 <a href="CFEBuildInstrs.html">Bootstrapping the LLVM C/C++ Front-End</a>
790 for details on building the C/C++ Front End.</dd>
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]791 <dt><i>--with-tclinclude</i></dt>
John Criswell8bfe6a72005-05-18 19:43:33 +0000[diff] [blame]792 <dd>Path to the tcl include directory under which <tt>tclsh</tt> can be
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]793 found. Use this if you have multiple tcl installations on your machine and you
794 want to use a specific one (8.x) for LLVM. LLVM only uses tcl for running the
795 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]796 option, the LLVM configure script will search for the tcl 8.4 and 8.3
797 releases.
John Criswell3d8ba512004-12-08 17:53:54 +0000[diff] [blame]798 <p></p>
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]799 </dd>
800 <dt><i>--enable-optimized</i></dt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]801 <dd>
802 Enables optimized compilation by default (debugging symbols are removed
803 and GCC optimization flags are enabled). The default is to use an
804 unoptimized build (also known as a debug build).
John Criswell3d8ba512004-12-08 17:53:54 +0000[diff] [blame]805 <p></p>
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]806 </dd>
Reid Spencer9d57b4d2005-12-21 03:46:45 +0000[diff] [blame]807 <dt><i>--enable-debug-runtime</i></dt>
808 <dd>
809 Enables debug symbols in the runtime libraries. The default is to strip
810 debug symbols from the runtime libraries.
811 </dd>
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]812 <dt><i>--enable-jit</i></dt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]813 <dd>
John Criswelld000e1d2003-12-18 16:43:17 +0000[diff] [blame]814 Compile the Just In Time (JIT) compiler functionality. This is not
815 available
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]816 on all platforms. The default is dependent on platform, so it is best
817 to explicitly enable it if you want it.
John Criswell3d8ba512004-12-08 17:53:54 +0000[diff] [blame]818 <p></p>
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]819 </dd>
Reid Spencer2dedcf52005-04-22 17:58:03 +0000[diff] [blame]820 <dt><i>--enable-targets=</i><tt>target-option</tt></dt>
821 <dd>Controls which targets will be built and linked into llc. The default
822 value for <tt>target_options</tt> is "all" which builds and links all
823 available targets. The value "host-only" can be specified to build only a
824 native compiler (no cross-compiler targets available). The "native" target is
825 selected as the target of the build host. You can also specify a comma
826 separated list of target names that you want available in llc. The target
John Criswell8bfe6a72005-05-18 19:43:33 +0000[diff] [blame]827 names use all lower case. The current set of targets is: <br/>
Reid Spencer2dedcf52005-04-22 17:58:03 +0000[diff] [blame]828 <tt>alpha, ia64, powerpc, skeleton, sparc, x86</tt>.
829 <p></p></dd>
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]830 <dt><i>--enable-doxygen</i></dt>
831 <dd>Look for the doxygen program and enable construction of doxygen based
832 documentation from the source code. This is disabled by default because
833 generating the documentation can take a long time and producess 100s of
834 megabytes of output.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]835</dl>
836
837<p>To configure LLVM, follow these steps:</p>
838
839<ol>
840 <li>Change directory into the object root directory:
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]841 <br>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]842 <tt>cd <i>OBJ_ROOT</i></tt>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]843 <p>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]844
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]845 <li>Run the <tt>configure</tt> script located in the LLVM source tree:
846 <br>
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]847 <tt><i>SRC_ROOT</i>/configure --prefix=/install/path [other options]</tt>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]848 <p>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]849</ol>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]850
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]851</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]852
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]853<!-- ======================================================================= -->
854<div class="doc_subsection">
855 <a name="compile">Compiling the LLVM Suite Source Code</a>
856</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]857
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]858<div class="doc_text">
John Criswell0b459202003-07-08 20:35:59 +0000[diff] [blame]859
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]860<p>Once you have configured LLVM, you can build it. There are three types of
861builds:</p>
John Criswell0b459202003-07-08 20:35:59 +0000[diff] [blame]862
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]863<dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]864 <dt>Debug Builds
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]865 <dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]866 These builds are the default when one types <tt>gmake</tt> (unless the
867 <tt>--enable-optimized</tt> option was used during configuration). The
868 build system will compile the tools and libraries with debugging
869 information.
870 <p>
871
872 <dt>Release (Optimized) Builds
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]873 <dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]874 These builds are enabled with the <tt>--enable-optimized</tt> option to
875 <tt>configure</tt> or by specifying <tt>ENABLE_OPTIMIZED=1</tt> on the
876 <tt>gmake</tt> command line. For these builds, the build system will
877 compile the tools and libraries with GCC optimizations enabled and strip
878 debugging information from the libraries and executables it generates.
879 <p>
880
881 <dt>Profile Builds
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]882 <dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]883 These builds are for use with profiling. They compile profiling
884 information into the code for use with programs like <tt>gprof</tt>.
885 Profile builds must be started by specifying <tt>ENABLE_PROFILING=1</tt>
886 on the <tt>gmake</tt> command line.
887</dl>
John Criswell7a73b802003-06-30 21:59:07 +0000[diff] [blame]888
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]889<p>Once you have LLVM configured, you can build it by entering the
890<i>OBJ_ROOT</i> directory and issuing the following command:</p>
John Criswell20d2d3e2003-10-10 14:26:14 +0000[diff] [blame]891
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]892<p><tt>gmake</tt></p>
John Criswell20d2d3e2003-10-10 14:26:14 +0000[diff] [blame]893
Chris Lattner95e92582004-07-18 22:32:22 +0000[diff] [blame]894<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]895are using a version of GCC that is known not to compile LLVM.</p>
Chris Lattner95e92582004-07-18 22:32:22 +0000[diff] [blame]896
897<p>
898If you have multiple processors in your machine, you may wish to use some of
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]899the parallel build options provided by GNU Make. For example, you could use the
900command:</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]901
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]902<p><tt>gmake -j2</tt></p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]903
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]904<p>There are several special targets which are useful when working with the LLVM
905source code:</p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]906
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]907<dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]908 <dt><tt>gmake clean</tt>
909 <dd>
910 Removes all files generated by the build. This includes object files,
911 generated C/C++ files, libraries, and executables.
912 <p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]913
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]914 <dt><tt>gmake dist-clean</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]915 <dd>
Misha Brukmanad38e962004-08-21 23:40:49 +0000[diff] [blame]916 Removes everything that <tt>gmake clean</tt> does, but also removes files
917 generated by <tt>configure</tt>. It attempts to return the source tree to the
918 original state in which it was shipped.
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]919 <p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]920
Misha Brukmane51c3562004-08-23 20:25:33 +0000[diff] [blame]921 <dt><tt>gmake install</tt>
922 <dd>
John Criswell3d8ba512004-12-08 17:53:54 +0000[diff] [blame]923 Installs LLVM header files, libraries, tools, and documentation in a
924 hierarchy
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]925 under $PREFIX, specified with <tt>./configure --prefix=[dir]</tt>, which
926 defaults to <tt>/usr/local</tt>.
Misha Brukmane51c3562004-08-23 20:25:33 +0000[diff] [blame]927 <p>
928
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]929 <dt><tt>gmake -C runtime install-bytecode</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]930 <dd>
Reid Spencer7863c402004-11-11 07:30:27 +0000[diff] [blame]931 Assuming you built LLVM into $OBJDIR, when this command is run, it will
932 install bytecode libraries into the GCC front end's bytecode library
933 directory. If you need to update your bytecode libraries,
Misha Brukmanad38e962004-08-21 23:40:49 +0000[diff] [blame]934 this is the target to use once you've built them.
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]935 <p>
936</dl>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]937
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]938<p>Please see the <a href="MakefileGuide.html">Makefile Guide</a> for further
939details on these <tt>make</tt> targets and descriptions of other targets
940available.</p>
941
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]942<p>It is also possible to override default values from <tt>configure</tt> by
943declaring variables on the command line. The following are some examples:</p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]944
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]945<dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]946 <dt><tt>gmake ENABLE_OPTIMIZED=1</tt>
947 <dd>
948 Perform a Release (Optimized) build.
949 <p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]950
Reid Spencer004ba032006-04-09 23:45:38 +0000[diff] [blame]951 <dt><tt>gmake ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1</tt>
Chris Lattnerd4651262006-03-21 01:10:57 +0000[diff] [blame]952 <dd>
Reid Spencer004ba032006-04-09 23:45:38 +0000[diff] [blame]953 Perform a Release (Optimized) build without assertions enabled.
Chris Lattnerd4651262006-03-21 01:10:57 +0000[diff] [blame]954 <p>
955
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]956 <dt><tt>gmake ENABLE_PROFILING=1</tt>
957 <dd>
958 Perform a Profiling build.
959 <p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]960
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]961 <dt><tt>gmake VERBOSE=1</tt>
962 <dd>
963 Print what <tt>gmake</tt> is doing on standard output.
964 <p>
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]965
966 <dt><tt>gmake TOOL_VERBOSE=1</tt></dt>
967 <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]968 the standard output. This also implies <tt>VERBOSE=1</tt>.
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]969 <p></dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]970</dl>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]971
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]972<p>Every directory in the LLVM object tree includes a <tt>Makefile</tt> to build
973it and any subdirectories that it contains. Entering any directory inside the
974LLVM object tree and typing <tt>gmake</tt> should rebuild anything in or below
975that directory that is out of date.</p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]976
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]977</div>
John Criswell20d2d3e2003-10-10 14:26:14 +0000[diff] [blame]978
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]979<!-- ======================================================================= -->
980<div class="doc_subsection">
981 <a name="objfiles">The Location of LLVM Object Files</a>
982</div>
John Criswell20d2d3e2003-10-10 14:26:14 +0000[diff] [blame]983
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]984<div class="doc_text">
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]985
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]986<p>The LLVM build system is capable of sharing a single LLVM source tree among
987several LLVM builds. Hence, it is possible to build LLVM for several different
988platforms or configurations using the same source tree.</p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]989
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]990<p>This is accomplished in the typical autoconf manner:</p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]991
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]992<ul>
993 <li><p>Change directory to where the LLVM object files should live:</p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]994
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]995 <p><tt>cd <i>OBJ_ROOT</i></tt></p></li>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]996
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]997 <li><p>Run the <tt>configure</tt> script found in the LLVM source
998 directory:</p>
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]999
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1000 <p><tt><i>SRC_ROOT</i>/configure</tt></p></li>
1001</ul>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1002
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1003<p>The LLVM build will place files underneath <i>OBJ_ROOT</i> in directories
1004named after the build type:</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1005
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1006<dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1007 <dt>Debug Builds
1008 <dd>
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1009 <dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1010 <dt>Tools
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]1011 <dd><tt><i>OBJ_ROOT</i>/Debug/bin</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1012 <dt>Libraries
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]1013 <dd><tt><i>OBJ_ROOT</i>/Debug/lib</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1014 </dl>
1015 <p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1016
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1017 <dt>Release Builds
1018 <dd>
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1019 <dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1020 <dt>Tools
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]1021 <dd><tt><i>OBJ_ROOT</i>/Release/bin</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1022 <dt>Libraries
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]1023 <dd><tt><i>OBJ_ROOT</i>/Release/lib</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1024 </dl>
1025 <p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1026
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1027 <dt>Profile Builds
1028 <dd>
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1029 <dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1030 <dt>Tools
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]1031 <dd><tt><i>OBJ_ROOT</i>/Profile/bin</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1032 <dt>Libraries
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]1033 <dd><tt><i>OBJ_ROOT</i>/Profile/lib</tt>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1034 </dl>
1035</dl>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1036
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1037</div>
Chris Lattner7fe7f812002-07-24 19:51:14 +0000[diff] [blame]1038
Chris Lattnera553f622004-03-25 20:38:40 +0000[diff] [blame]1039<!-- ======================================================================= -->
1040<div class="doc_subsection">
1041 <a name="optionalconfig">Optional Configuration Items</a>
1042</div>
1043
1044<div class="doc_text">
1045
1046<p>
Misha Brukman9106eca2005-02-03 22:25:23 +0000[diff] [blame]1047If you're running on a Linux system that supports the "<a
Reid Spencer66db92e2004-12-08 16:51:31 +0000[diff] [blame]1048 href="http://www.tat.physik.uni-tuebingen.de/~rguenth/linux/binfmt_misc.html">
1049 binfmt_misc</a>"
Chris Lattnera553f622004-03-25 20:38:40 +0000[diff] [blame]1050module, and you have root access on the system, you can set your system up to
1051execute LLVM bytecode files directly. To do this, use commands like this (the
1052first command may not be required if you are already using the module):</p>
1053
Misha Brukman9106eca2005-02-03 22:25:23 +0000[diff] [blame]1054<div class="doc_code">
Chris Lattnera553f622004-03-25 20:38:40 +0000[diff] [blame]1055<pre>
1056 $ mount -t binfmt_misc none /proc/sys/fs/binfmt_misc
Misha Brukman9106eca2005-02-03 22:25:23 +0000[diff] [blame]1057 $ echo ':llvm:M::llvm::/path/to/lli:' &gt; /proc/sys/fs/binfmt_misc/register
Chris Lattnera553f622004-03-25 20:38:40 +0000[diff] [blame]1058 $ chmod u+x hello.bc (if needed)
1059 $ ./hello.bc
1060</pre>
Misha Brukman9106eca2005-02-03 22:25:23 +0000[diff] [blame]1061</div>
Chris Lattnera553f622004-03-25 20:38:40 +0000[diff] [blame]1062
1063<p>
1064This allows you to execute LLVM bytecode files directly. Thanks to Jack
1065Cummings for pointing this out!
1066</p>
1067
1068</div>
1069
1070
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1071<!-- *********************************************************************** -->
1072<div class="doc_section">
1073 <a name="layout"><b>Program Layout</b></a>
1074</div>
1075<!-- *********************************************************************** -->
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1076
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1077<div class="doc_text">
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1078
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1079<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]1080href="http://www.doxygen.org">doxygen</a> documentation available at <tt><a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1081href="http://llvm.org/doxygen/">http://llvm.org/doxygen/</a></tt>.
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1082The following is a brief introduction to code layout:</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1083
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1084</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1085
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1086<!-- ======================================================================= -->
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1087<div class="doc_subsection"><a name="cvsdir"><tt>CVS</tt> directories</a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1088<div class="doc_text">
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1089<p>Every directory checked out of CVS will contain a <tt>CVS</tt> directory; for
1090the most part these can just be ignored.</p>
Reid Spencerc4b09ba2004-12-08 16:18:26 +0000[diff] [blame]1091</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1092
Reid Spencerc4b09ba2004-12-08 16:18:26 +0000[diff] [blame]1093<!-- ======================================================================= -->
1094<div class="doc_subsection"><a name="examples"><tt>llvm/examples</tt></a></div>
1095<div class="doc_text">
1096 <p>This directory contains some simple examples of how to use the LLVM IR and
1097 JIT.</p>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1098</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1099
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1100<!-- ======================================================================= -->
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1101<div class="doc_subsection"><a name="include"><tt>llvm/include</tt></a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1102<div class="doc_text">
1103
1104<p>This directory contains public header files exported from the LLVM
1105library. The three main subdirectories of this directory are:</p>
1106
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1107<dl>
1108 <dt><tt><b>llvm/include/llvm</b></tt></dt>
1109 <dd>This directory contains all of the LLVM specific header files. This
1110 directory also has subdirectories for different portions of LLVM:
1111 <tt>Analysis</tt>, <tt>CodeGen</tt>, <tt>Target</tt>, <tt>Transforms</tt>,
1112 etc...</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/Support</b></tt></dt>
1115 <dd>This directory contains generic support libraries that are provided with
1116 LLVM but not necessarily specific to LLVM. For example, some C++ STL utilities
1117 and a Command Line option processing library store their header files here.
1118 </dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1119
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1120 <dt><tt><b>llvm/include/llvm/Config</b></tt></dt>
1121 <dd>This directory contains header files configured by the <tt>configure</tt>
1122 script. They wrap "standard" UNIX and C header files. Source code can
1123 include these header files which automatically take care of the conditional
1124 #includes that the <tt>configure</tt> script generates.</dd>
1125</dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1126</div>
1127
1128<!-- ======================================================================= -->
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1129<div class="doc_subsection"><a name="lib"><tt>llvm/lib</tt></a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1130<div class="doc_text">
1131
1132<p>This directory contains most of the source files of the LLVM system. In LLVM,
1133almost all code exists in libraries, making it very easy to share code among the
1134different <a href="#tools">tools</a>.</p>
1135
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1136<dl>
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1137 <dt><tt><b>llvm/lib/VMCore/</b></tt></dt>
1138 <dd> This directory holds the core LLVM source files that implement core
1139 classes like Instruction and BasicBlock.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1140
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1141 <dt><tt><b>llvm/lib/AsmParser/</b></tt></dt>
1142 <dd>This directory holds the source code for the LLVM assembly language parser
1143 library.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1144
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1145 <dt><tt><b>llvm/lib/ByteCode/</b></tt></dt>
1146 <dd>This directory holds code for reading and write LLVM bytecode.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1147
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1148 <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]1149 different program analyses, such as Dominator Information, Call Graphs,
1150 Induction Variables, Interval Identification, Natural Loop Identification,
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1151 etc.</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/Transforms/</b></tt></dt>
1154 <dd> This directory contains the source code for the LLVM to LLVM program
1155 transformations, such as Aggressive Dead Code Elimination, Sparse Conditional
1156 Constant Propagation, Inlining, Loop Invariant Code Motion, Dead Global
1157 Elimination, and many others.</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/Target/</b></tt></dt>
1160 <dd> This directory contains files that describe various target architectures
Chris Lattner2a607032006-04-20 17:42:23 +0000[diff] [blame]1161 for code generation. For example, the <tt>llvm/lib/Target/X86</tt>
1162 directory holds the X86 machine description while
John Criswell8bfe6a72005-05-18 19:43:33 +0000[diff] [blame]1163 <tt>llvm/lib/Target/CBackend</tt> implements the LLVM-to-C converter.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1164
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1165 <dt><tt><b>llvm/lib/CodeGen/</b></tt></dt>
1166 <dd> This directory contains the major parts of the code generator: Instruction
1167 Selector, Instruction Scheduling, and Register Allocation.</dd>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1168
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1169 <dt><tt><b>llvm/lib/Debugger/</b></tt></dt>
1170 <dd> This directory contains the source level debugger library that makes
1171 it possible to instrument LLVM programs so that a debugger could identify
1172 source code locations at which the program is executing.</dd>
1173
1174 <dt><tt><b>llvm/lib/ExecutionEngine/</b></tt></dt>
1175 <dd> This directory contains libraries for executing LLVM bytecode directly
1176 at runtime in both interpreted and JIT compiled fashions.</dd>
1177
1178 <dt><tt><b>llvm/lib/Support/</b></tt></dt>
1179 <dd> This directory contains the source code that corresponds to the header
1180 files located in <tt>llvm/include/Support/</tt>.</dd>
1181
1182 <dt><tt><b>llvm/lib/System/</b></tt></dt>
1183 <dd>This directory contains the operating system abstraction layer that
1184 shields LLVM from platform-specific coding.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1185</dl>
John Criswell7a73b802003-06-30 21:59:07 +0000[diff] [blame]1186
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1187</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1188
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1189<!-- ======================================================================= -->
Reid Spencerc4b09ba2004-12-08 16:18:26 +0000[diff] [blame]1190<div class="doc_subsection"><a name="projects"><tt>llvm/projects</tt></a></div>
1191<div class="doc_text">
1192 <p>This directory contains projects that are not strictly part of LLVM but are
1193 shipped with LLVM. This is also the directory where you should create your own
1194 LLVM-based projects. See <tt>llvm/projects/sample</tt> for an example of how
1195 to set up your own project. See <tt>llvm/projects/Stacker</tt> for a fully
1196 functional example of a compiler front end.</p>
1197</div>
1198
1199<!-- ======================================================================= -->
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1200<div class="doc_subsection"><a name="runtime"><tt>llvm/runtime</tt></a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1201<div class="doc_text">
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1202
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1203<p>This directory contains libraries which are compiled into LLVM bytecode and
1204used when linking programs with the GCC front end. Most of these libraries are
1205skeleton versions of real libraries; for example, libc is a stripped down
1206version of glibc.</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1207
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1208<p>Unlike the rest of the LLVM suite, this directory needs the LLVM GCC front
1209end to compile.</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1210
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1211</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1212
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1213<!-- ======================================================================= -->
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1214<div class="doc_subsection"><a name="test"><tt>llvm/test</tt></a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1215<div class="doc_text">
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1216 <p>This directory contains feature and regression tests and other basic sanity
1217 checks on the LLVM infrastructure. These are intended to run quickly and cover
1218 a lot of territory without being exhaustive.</p>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1219</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1220
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1221<!-- ======================================================================= -->
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1222<div class="doc_subsection"><a name="llvmtest"><tt>llvm-test</tt></a></div>
1223<div class="doc_text">
John Criswell3d8ba512004-12-08 17:53:54 +0000[diff] [blame]1224 <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]1225 module that must be checked out (usually to <tt>projects/llvm-test</tt>). This
John Criswell3d8ba512004-12-08 17:53:54 +0000[diff] [blame]1226 module contains a comprehensive correctness, performance, and benchmarking
1227 test
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1228 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]1229 interested in downloading or building such a comprehensive test suite. For
1230 further details on this test suite, please see the
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1231 <a href="TestingGuide.html">Testing Guide</a> document.</p>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1232</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1233
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1234<!-- ======================================================================= -->
1235<div class="doc_subsection"><a name="tools"><tt>llvm/tools</tt></a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1236<div class="doc_text">
John Criswell20d2d3e2003-10-10 14:26:14 +0000[diff] [blame]1237
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1238<p>The <b>tools</b> directory contains the executables built out of the
1239libraries above, which form the main part of the user interface. You can
1240always get help for a tool by typing <tt>tool_name --help</tt>. The
Misha Brukmane12215f2004-11-15 23:20:51 +0000[diff] [blame]1241following is a brief introduction to the most important tools. More detailed
1242information is in the <a href="CommandGuide/index.html">Command Guide</a>.</p>
John Criswell20d2d3e2003-10-10 14:26:14 +0000[diff] [blame]1243
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1244<dl>
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1245 <dt><tt><b>analyze</b></tt></dt>
1246 <dd><tt>analyze</tt> is used to run a specific
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1247 analysis on an input LLVM bytecode file and print out the results. It is
1248 primarily useful for debugging analyses, or familiarizing yourself with
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1249 what an analysis does.</dd>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1250
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1251 <dt><tt><b>bugpoint</b></tt></dt>
1252 <dd><tt>bugpoint</tt> is used to debug
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1253 optimization passes or code generation backends by narrowing down the
1254 given test case to the minimum number of passes and/or instructions that
1255 still cause a problem, whether it is a crash or miscompilation. See <a
1256 href="HowToSubmitABug.html">HowToSubmitABug.html</a> for more information
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1257 on using <tt>bugpoint</tt>.</dd>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1258
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1259 <dt><tt><b>llvmc</b></tt></dt>
1260 <dd>The LLVM Compiler Driver. This program can
1261 be configured to utilize both LLVM and non-LLVM compilation tools to enable
1262 pre-processing, translation, optimization, assembly, and linking of programs
1263 all from one command line. <tt>llvmc</tt> also takes care of processing the
1264 dependent libraries found in bytecode. This reduces the need to get the
Reid Spencer079e9452004-12-08 18:00:30 +0000[diff] [blame]1265 traditional <tt>-l&lt;name&gt;</tt> options right on the command line. Please
John Criswell8bfe6a72005-05-18 19:43:33 +0000[diff] [blame]1266 note that this tool, while functional, is still experimental and not feature
1267 complete.</dd>
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1268
1269 <dt><tt><b>llvm-ar</b></tt></dt>
1270 <dd>The archiver produces an archive containing
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1271 the given LLVM bytecode files, optionally with an index for faster
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1272 lookup.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1273
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1274 <dt><tt><b>llvm-as</b></tt></dt>
1275 <dd>The assembler transforms the human readable LLVM assembly to LLVM
1276 bytecode.</dd>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1277
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1278 <dt><tt><b>llvm-dis</b></tt></dt>
1279 <dd>The disassembler transforms the LLVM bytecode to human readable
1280 LLVM assembly.</dd>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1281
Reid Spencer079e9452004-12-08 18:00:30 +0000[diff] [blame]1282 <dt><tt><b>llvm-ld</b></tt></dt>
1283 <dd><tt>llvm-ld</tt> is very similar to gccld and provides a general purpose
1284 and extensible linker for LLVM. This is the linker invoked by <tt>llvmc</tt>.
1285 It allows optimization modules to be loaded so that language specific
John Criswell8bfe6a72005-05-18 19:43:33 +0000[diff] [blame]1286 optimizations can be applied at link time. This tool is considered
1287 experimental.</dd>
Reid Spencer079e9452004-12-08 18:00:30 +0000[diff] [blame]1288
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1289 <dt><tt><b>llvm-link</b></tt></dt>
1290 <dd><tt>llvm-link</tt>, not surprisingly, links multiple LLVM modules into
1291 a single program.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1292
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1293 <dt><tt><b>lli</b></tt></dt>
1294 <dd><tt>lli</tt> is the LLVM interpreter, which
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1295 can directly execute LLVM bytecode (although very slowly...). In addition
1296 to a simple interpreter, <tt>lli</tt> also has a tracing mode (entered by
1297 specifying <tt>-trace</tt> on the command line). Finally, for
John Criswelld9eceee2004-12-08 18:04:14 +0000[diff] [blame]1298 architectures that support it (currently x86, Sparc, and PowerPC), by default,
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1299 <tt>lli</tt> will function as a Just-In-Time compiler (if the
1300 functionality was compiled in), and will execute the code <i>much</i>
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1301 faster than the interpreter.</dd>
Misha Brukmanef0ad412003-10-06 19:23:34 +0000[diff] [blame]1302
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1303 <dt><tt><b>llc</b></tt></dt>
1304 <dd> <tt>llc</tt> is the LLVM backend compiler, which
John Criswell8bfe6a72005-05-18 19:43:33 +0000[diff] [blame]1305 translates LLVM bytecode to a native code assembly file or to C code (with
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1306 the -march=c option).</dd>
Misha Brukmanef0ad412003-10-06 19:23:34 +0000[diff] [blame]1307
Reid Spencerd4694f92004-12-22 06:29:07 +0000[diff] [blame]1308 <dt><tt><b>llvm-gcc</b></tt></dt>
1309 <dd><tt>llvm-gcc</tt> is a GCC-based C frontend
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1310 that has been retargeted to emit LLVM code as the machine code output. It
1311 works just like any other GCC compiler, taking the typical <tt>-c, -S, -E,
1312 -o</tt> options that are typically used. The source code for the
John Criswell8bfe6a72005-05-18 19:43:33 +0000[diff] [blame]1313 <tt>llvm-gcc</tt> tool is available as a separate CVS module.
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1314 <blockquote>
1315 <dl>
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1316 <dt><tt><b>gccas</b></tt></dt>
Reid Spencerd4694f92004-12-22 06:29:07 +0000[diff] [blame]1317 <dd>This tool is invoked by the <tt>llvm-gcc</tt> frontend as the
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1318 "assembler" part of the compiler. This tool actually assembles LLVM
1319 assembly to LLVM bytecode, performs a variety of optimizations, and
1320 outputs LLVM bytecode. Thus when you invoke
Reid Spencerd4694f92004-12-22 06:29:07 +0000[diff] [blame]1321 <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]1322 run, which writes the <tt>x.o</tt> file (which is an LLVM bytecode file
1323 that can be disassembled or manipulated just like any other bytecode
1324 file). The command line interface to <tt>gccas</tt> is designed to be
1325 as close as possible to the <b>system</b> `<tt>as</tt>' utility so that
1326 the gcc frontend itself did not have to be modified to interface to
1327 a "weird" assembler.</dd>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1328
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1329 <dt><tt><b>gccld</b></tt></dt>
1330 <dd><tt>gccld</tt> links together several LLVM bytecode files into one
1331 bytecode file and does some optimization. It is the linker invoked by
1332 the GCC frontend when multiple .o files need to be linked together.
1333 Like <tt>gccas</tt>, the command line interface of <tt>gccld</tt> is
1334 designed to match the system linker, to aid interfacing with the GCC
1335 frontend.</dd>
1336 </dl>
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1337 </blockquote>
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1338 </dd>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1339
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1340 <dt><tt><b>opt</b></tt></dt>
1341 <dd><tt>opt</tt> reads LLVM bytecode, applies a
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1342 series of LLVM to LLVM transformations (which are specified on the command
1343 line), and then outputs the resultant bytecode. The '<tt>opt --help</tt>'
1344 command is a good way to get a list of the program transformations
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1345 available in LLVM.</dd>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1346</dl>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1347</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1348
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1349<!-- ======================================================================= -->
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1350<div class="doc_subsection"><a name="utils"><tt>llvm/utils</tt></a></div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1351<div class="doc_text">
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1352
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1353<p>This directory contains utilities for working with LLVM source code, and some
1354of the utilities are actually required as part of the build process because they
1355are code generators for parts of LLVM infrastructure.</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1356
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1357<dl>
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1358 <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]1359 that finds differences between code that LLC generates and code that LLI
1360 generates. This is a useful tool if you are debugging one of them,
1361 assuming that the other generates correct output. For the full user
1362 manual, run <tt>`perldoc codegen-diff'</tt>.<p>
Misha Brukmanc103adf2003-08-11 18:45:46 +0000[diff] [blame]1363
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1364 <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]1365 update your CVS tree, but produce a much cleaner and more organized output
1366 than simply running <tt>`cvs -z3 up -dP'</tt> will. For example, it will group
1367 together all the new and updated files and modified files in separate
1368 sections, so you can see at a glance what has changed. If you are at the
1369 top of your LLVM CVS tree, running <tt>utils/cvsupdate</tt> is the
1370 preferred way of updating the tree.<p>
Misha Brukmanc103adf2003-08-11 18:45:46 +0000[diff] [blame]1371
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1372 <dt><tt><b>emacs/</b></tt> <dd>The <tt>emacs</tt> directory contains
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1373 syntax-highlighting files which will work with Emacs and XEmacs editors,
1374 providing syntax highlighting support for LLVM assembly files and TableGen
1375 description files. For information on how to use the syntax files, consult
1376 the <tt>README</tt> file in that directory.<p>
Misha Brukmanc103adf2003-08-11 18:45:46 +0000[diff] [blame]1377
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1378 <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]1379 and outputs all non-generated source files, which is useful if one wishes
1380 to do a lot of development across directories and does not want to
1381 individually find each file. One way to use it is to run, for example:
1382 <tt>xemacs `utils/getsources.sh`</tt> from the top of your LLVM source
1383 tree.<p>
1384
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1385 <dt><tt><b>llvmgrep</b></tt></dt>
1386 <dd>This little tool performs an "egrep -H -n" on each source file in LLVM and
1387 passes to it a regular expression provided on <tt>llvmgrep</tt>'s command
1388 line. This is a very efficient way of searching the source base for a
1389 particular regular expression.</dd>
1390
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1391 <dt><tt><b>makellvm</b></tt> <dd>The <tt>makellvm</tt> script compiles all
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1392 files in the current directory and then compiles and links the tool that
1393 is the first argument. For example, assuming you are in the directory
1394 <tt>llvm/lib/Target/Sparc</tt>, if <tt>makellvm</tt> is in your path,
1395 simply running <tt>makellvm llc</tt> will make a build of the current
1396 directory, switch to directory <tt>llvm/tools/llc</tt> and build it,
1397 causing a re-linking of LLC.<p>
Misha Brukmanc103adf2003-08-11 18:45:46 +0000[diff] [blame]1398
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1399 <dt><tt><b>NightlyTest.pl</b></tt> and
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1400 <tt><b>NightlyTestTemplate.html</b></tt> <dd>These files are used in a
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1401 cron script to generate nightly status reports of the functionality of
1402 tools, and the results can be seen by following the appropriate link on
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1403 the <a href="http://llvm.org/">LLVM homepage</a>.<p>
Misha Brukmanc103adf2003-08-11 18:45:46 +0000[diff] [blame]1404
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1405 <dt><tt><b>TableGen/</b></tt> <dd>The <tt>TableGen</tt> directory contains
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1406 the tool used to generate register descriptions, instruction set
1407 descriptions, and even assemblers from common TableGen description
1408 files.<p>
Misha Brukmanc103adf2003-08-11 18:45:46 +0000[diff] [blame]1409
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1410 <dt><tt><b>vim/</b></tt> <dd>The <tt>vim</tt> directory contains
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1411 syntax-highlighting files which will work with the VIM editor, providing
1412 syntax highlighting support for LLVM assembly files and TableGen
1413 description files. For information on how to use the syntax files, consult
1414 the <tt>README</tt> file in that directory.<p>
Misha Brukmanc103adf2003-08-11 18:45:46 +0000[diff] [blame]1415
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1416</dl>
Misha Brukmanc103adf2003-08-11 18:45:46 +0000[diff] [blame]1417
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1418</div>
Misha Brukmanc103adf2003-08-11 18:45:46 +0000[diff] [blame]1419
Reid Spencerc4b09ba2004-12-08 16:18:26 +0000[diff] [blame]1420<!-- ======================================================================= -->
1421<div class="doc_subsection"><a name="win32"><tt>llvm/win32</tt></a></div>
1422<div class="doc_text">
1423 <p>This directory contains build scripts and project files for use with
1424 Visual C++. This allows developers on Windows to build LLVM without the need
John Criswell3d8ba512004-12-08 17:53:54 +0000[diff] [blame]1425 for Cygwin. The contents of this directory should be considered experimental
Reid Spencerc4b09ba2004-12-08 16:18:26 +0000[diff] [blame]1426 at this time.
1427 </p>
1428</div>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1429<!-- *********************************************************************** -->
1430<div class="doc_section">
1431 <a name="tutorial">An Example Using the LLVM Tool Chain</a>
1432</div>
1433<!-- *********************************************************************** -->
Misha Brukmanc103adf2003-08-11 18:45:46 +0000[diff] [blame]1434
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1435<div class="doc_text">
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1436
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1437<ol>
1438 <li>First, create a simple C file, name it 'hello.c':
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1439 <pre>
1440 #include &lt;stdio.h&gt;
1441 int main() {
1442 printf("hello world\n");
1443 return 0;
1444 }
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1445 </pre></li>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1446
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1447 <li><p>Next, compile the C file into a LLVM bytecode file:</p>
Reid Spencerd4694f92004-12-22 06:29:07 +0000[diff] [blame]1448 <p><tt>% llvm-gcc hello.c -o hello</tt></p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1449
Misha Brukmanf089cdf2004-06-22 18:48:58 +0000[diff] [blame]1450 <p>Note that you should have already built the tools and they have to be
1451 in your path, at least <tt>gccas</tt> and <tt>gccld</tt>.</p>
1452
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1453 <p>This will create two result files: <tt>hello</tt> and
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1454 <tt>hello.bc</tt>. The <tt>hello.bc</tt> is the LLVM bytecode that
1455 corresponds the the compiled program and the library facilities that it
1456 required. <tt>hello</tt> is a simple shell script that runs the bytecode
Chris Lattnera19a3db2004-05-01 11:40:07 +0000[diff] [blame]1457 file with <tt>lli</tt>, making the result directly executable. Note that
1458 all LLVM optimizations are enabled by default, so there is no need for a
1459 "-O3" switch.</p></li>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1460
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1461 <li><p>Run the program. To make sure the program ran, execute one of the
1462 following commands:</p>
John Criswell8df90e02003-06-11 20:46:40 +0000[diff] [blame]1463
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1464 <p><tt>% ./hello</tt></p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1465
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1466 <p>or</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1467
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1468 <p><tt>% lli hello.bc</tt></p></li>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1469
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1470 <li><p>Use the <tt>llvm-dis</tt> utility to take a look at the LLVM assembly
1471 code:</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1472
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1473 <p><tt>% llvm-dis &lt; hello.bc | less</tt><p></li>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1474
Chris Lattnerb3bbcba2004-06-02 20:37:02 +0000[diff] [blame]1475 <li><p>Compile the program to native assembly using the LLC code
1476 generator:</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1477
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1478 <p><tt>% llc hello.bc -o hello.s</tt></p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1479
Chris Lattnerb3bbcba2004-06-02 20:37:02 +0000[diff] [blame]1480 <li><p>Assemble the native assembly language file into a program:</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1481
Chris Lattnerb3bbcba2004-06-02 20:37:02 +0000[diff] [blame]1482 <p><b>Solaris:</b><tt>% /opt/SUNWspro/bin/cc -xarch=v9 hello.s -o hello.native</tt></p>
1483 <p><b>Others:</b><tt>% gcc hello.s -o hello.native</tt></p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1484
Chris Lattnerb3bbcba2004-06-02 20:37:02 +0000[diff] [blame]1485 <li><p>Execute the native code program:</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1486
Chris Lattnerb3bbcba2004-06-02 20:37:02 +0000[diff] [blame]1487 <p><tt>% ./hello.native</tt></p></li>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1488
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1489</ol>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1490
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1491</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1492
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1493<!-- *********************************************************************** -->
1494<div class="doc_section">
1495 <a name="problems">Common Problems</a>
1496</div>
1497<!-- *********************************************************************** -->
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]1498
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1499<div class="doc_text">
John Criswellce760f62003-07-03 16:01:38 +0000[diff] [blame]1500
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1501<p>If you are having problems building or using LLVM, or if you have any other
1502general questions about LLVM, please consult the <a href="FAQ.html">Frequently
1503Asked Questions</a> page.</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1504
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1505</div>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1506
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1507<!-- *********************************************************************** -->
1508<div class="doc_section">
1509 <a name="links">Links</a>
1510</div>
1511<!-- *********************************************************************** -->
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1512
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1513<div class="doc_text">
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1514
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1515<p>This document is just an <b>introduction</b> to how to use LLVM to do
1516some simple things... there are many more interesting and complicated things
1517that you can do that aren't documented here (but we'll gladly accept a patch
1518if you want to write something up!). For more information about LLVM, check
1519out:</p>
John Criswell85ed3612003-06-12 19:34:44 +0000[diff] [blame]1520
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1521<ul>
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1522 <li><a href="http://llvm.org/">LLVM homepage</a></li>
1523 <li><a href="http://llvm.org/doxygen/">LLVM doxygen tree</a></li>
1524 <li><a href="http://llvm.org/docs/Projects.html">Starting a Project
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1525 that Uses LLVM</a></li>
1526</ul>
1527
1528</div>
1529
1530<!-- *********************************************************************** -->
1531
1532<hr>
Misha Brukman142207b2003-11-22 01:30:01 +0000[diff] [blame]1533<address>
Misha Brukman54111c42004-01-20 00:20:17 +0000[diff] [blame]1534 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1535 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
1536 <a href="http://validator.w3.org/check/referer"><img
1537 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
1538
Misha Brukman142207b2003-11-22 01:30:01 +0000[diff] [blame]1539 <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
Reid Spencer77d90192004-09-05 20:50:22 +0000[diff] [blame]1540 <a href="http://llvm.x10sys.com/rspencer/">Reid Spencer</a><br>
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1541 <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1542 Last modified: $Date$
Misha Brukman142207b2003-11-22 01:30:01 +0000[diff] [blame]1543</address>
Misha Brukman00c73d22003-11-07 19:43:14 +0000[diff] [blame]1544</body>
Guochun Shif4688a82002-07-17 23:05:56 +0000[diff] [blame]1545</html>