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