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