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