Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / 876d5f1bad040ef439477eb4459ba60f6868aeaa / . / llvm / docs / GettingStarted.html
blob: 2716495a25a260a60a4cb3a81fc522cf3f0fd5d9 [file] [log] [blame]
Misha Brukman560e9892003-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 Shib65a78e2002-07-17 23:05:56 +0000[diff] [blame]3<html>
Misha Brukman560e9892003-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 Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]9
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]10<div class="doc_title">
11 Getting Started with the LLVM System
12</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]13
Misha Brukman560e9892003-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 Lattnerc0bda0d2003-02-14 04:22:13 +0000[diff] [blame]18 <ol>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]19 <li><a href="#hardware">Hardware</a>
20 <li><a href="#software">Software</a>
Chris Lattnere0050f02004-07-18 22:32:22 +0000[diff] [blame]21 <li><a href="#brokengcc">Broken versions of GCC</a>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]22 </ol></li>
John Criswell3ef61af2003-06-30 21:59:07 +0000[diff] [blame]23
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]24 <li><a href="#starting">Getting Started with LLVM</a>
John Criswell71139f22003-07-08 20:35:59 +0000[diff] [blame]25 <ol>
Misha Brukman560e9892003-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 Lattner998c0672004-03-25 20:38:40 +0000[diff] [blame]34 <li><a href="#optionalconfig">Optional Configuration Items</a>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]35 </ol></li>
John Criswell71139f22003-07-08 20:35:59 +0000[diff] [blame]36
Misha Brukman560e9892003-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>
44 <li><a href="#tools"><tt>llvm/tools</tt></a>
45 <li><a href="#utils"><tt>llvm/utils</tt></a>
46 </ol></li>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]47
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]48 <li><a href="#tutorial">An Example Using the LLVM Tool Chain</a>
49 <li><a href="#problems">Common Problems</a>
50 <li><a href="#links">Links</a>
51</ul>
52
Chris Lattner020e1fc2004-05-23 21:07:27 +0000[diff] [blame]53<div class="doc_author">
54 <p>Written by:
55 <a href="mailto:criswell@uiuc.edu">John Criswell</a>,
56 <a href="mailto:sabre@nondot.org">Chris Lattner</a>,
57 <a href="http://misha.brukman.net">Misha Brukman</a>,
58 <a href="http://www.cs.uiuc.edu/~vadve">Vikram Adve</a>, and
59 <a href="mailto:gshi1@uiuc.edu">Guochun Shi</a>.
60 </p>
61</div>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]62
63
64<!-- *********************************************************************** -->
65<div class="doc_section">
66 <a name="overview"><b>Overview</b></a>
67</div>
68<!-- *********************************************************************** -->
69
70<div class="doc_text">
71
72<p>Welcome to LLVM! In order to get started, you first need to know some
73basic information.</p>
74
75<p>First, LLVM comes in two pieces. The first piece is the LLVM suite. This
76contains all of the tools, libraries, and header files needed to use the low
77level virtual machine. It contains an assembler, disassembler, bytecode
78analyzer, and bytecode optimizer. It also contains a test suite that can be
79used to test the LLVM tools and the GCC front end.</p>
80
81<p>The second piece is the GCC front end. This component provides a version of
82GCC that compiles C and C++ code into LLVM bytecode. Currently, the GCC front
83end is a modified version of GCC 3.4 (we track the GCC 3.4 development). Once
84compiled into LLVM bytecode, a program can be manipulated with the LLVM tools
85from the LLVM suite.</p>
86
87</div>
88
89<!-- *********************************************************************** -->
90<div class="doc_section">
91 <a name="quickstart"><b>Getting Started Quickly (A Summary)</b></a>
92</div>
93<!-- *********************************************************************** -->
94
95<div class="doc_text">
96
97<p>Here's the short story for getting up and running quickly with LLVM:</p>
98
99<ol>
100 <li>Install the GCC front end:
101 <ol>
102 <li><tt>cd <i>where-you-want-the-C-front-end-to-live</i></tt>
103 <li><tt>gunzip --stdout cfrontend.<i>platform</i>.tar.gz | tar -xvf -</tt>
John Criswell64f13ab2004-03-12 20:31:37 +0000[diff] [blame]104 <li><b>Sparc and MacOS X Only:</b><br>
105 <tt>cd cfrontend/<i>platform</i><br>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]106 ./fixheaders</tt>
107 </ol></li>
108
109 <li>Get the Source Code
110 <ul>
111 <li>With the distributed files:
112 <ol>
113 <li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
John Criswell64f13ab2004-03-12 20:31:37 +0000[diff] [blame]114 <li><tt>gunzip --stdout llvm-<i>version</i>.tar.gz | tar -xvf -</tt>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]115 <li><tt>cd llvm</tt>
116 </ol></li>
117
Misha Brukman0bca6992004-06-18 20:18:31 +0000[diff] [blame]118 <li>With anonymous CVS access (or use a <a href="#mirror">mirror</a>):
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]119 <ol>
120 <li><tt>cd <i>where-you-want-llvm-to-live</i></tt></li>
121 <li><tt>cvs -d
122 :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm login</tt></li>
123 <li>Hit the return key when prompted for the password.
124 <li><tt>cvs -z3 -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm
125 co llvm</tt></li>
126 <li><tt>cd llvm</tt></li>
127 </ol></li>
128 </ul></li>
129
130 <li>Configure the LLVM Build Environment
131 <ol>
132 <li>Change directory to where you want to store the LLVM object
133 files and run <tt>configure</tt> to configure the Makefiles and
134 header files for the default platform. Useful options include:
135 <ul>
136 <li><tt>--with-llvmgccdir=<i>directory</i></tt>
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]137 <p>Specify the full pathname of where the LLVM GCC frontend is
138 installed.</p></li>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]139 <li><tt>--enable-spec2000=<i>directory</i></tt>
140 <p>Enable the SPEC2000 benchmarks for testing. The SPEC2000
141 benchmarks should be available in
142 <tt><i>directory</i></tt>.</p></li>
143 </ul>
144 </ol></li>
145
146 <li>Build the LLVM Suite:
147 <ol>
Chris Lattnere0050f02004-07-18 22:32:22 +0000[diff] [blame]148 <li>Set your LLVM_LIB_SEARCH_PATH environment variable.</li>
149 <li><tt>gmake -k |&amp; tee gnumake.out
150 &nbsp;&nbsp;&nbsp;# this is csh or tcsh syntax</tt></li>
151 <li>If you get an "internal compiler error (ICE)" see <a href="#brokengcc">below</a>.</li>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]152 </ol>
153
154</ol>
155
Chris Lattner53e5e2a2004-06-21 22:52:48 +0000[diff] [blame]156<p>Consult the <a href="#starting">Getting Started with LLVM</a> section for
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]157detailed information on configuring and compiling LLVM. See <a
158href="#environment">Setting Up Your Environment</a> for tips that simplify
159working with the GCC front end and LLVM tools. Go to <a href="#layout">Program
160Layout</a> to learn about the layout of the source code tree.</p>
161
162</div>
163
164<!-- *********************************************************************** -->
165<div class="doc_section">
166 <a name="requirements"><b>Requirements</b></a>
167</div>
168<!-- *********************************************************************** -->
169
170<div class="doc_text">
171
172<p>Before you begin to use the LLVM system, review the requirements given below.
173This may save you some trouble by knowing ahead of time what hardware and
174software you will need.</p>
175
176</div>
177
178<!-- ======================================================================= -->
179<div class="doc_subsection">
180 <a name="hardware"><b>Hardware</b></a>
181</div>
182
183<div class="doc_text">
184
185<p>LLVM is known to work on the following platforms:</p>
186
187<ul>
188
189 <li>Linux on x86 (Pentium and above)
190 <ul>
John Criswellfa2f3682004-03-29 20:23:11 +0000[diff] [blame]191 <li>Approximately 1.02 GB of Free Disk Space
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]192 <ul>
John Criswellfa2f3682004-03-29 20:23:11 +0000[diff] [blame]193 <li>Source code: 45 MB</li>
194 <li>Object code: 956 MB</li>
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]195 <li>GCC front end: 40 MB</li>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]196 </ul></li>
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]197 </ul>
198 </li>
199
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]200 <li>Solaris on SparcV9 (Ultrasparc)
201 <ul>
John Criswellfa2f3682004-03-29 20:23:11 +0000[diff] [blame]202 <li>Approximately 1.75 GB of Free Disk Space
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]203 <ul>
John Criswellfa2f3682004-03-29 20:23:11 +0000[diff] [blame]204 <li>Source code: 45 MB</li>
Misha Brukman876d5f12004-08-09 19:57:01 +0000[diff] [blame^]205 <li>Object code: 1.7 GB</li>
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]206 <li>GCC front end: 50 MB</li>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]207 </ul></li>
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]208 </ul>
209 </li>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]210
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]211 <li>FreeBSD on x86 (Pentium and above)
212 <ul>
John Criswellfa2f3682004-03-29 20:23:11 +0000[diff] [blame]213 <li>Approximately 935 MB of Free Disk Space
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]214 <ul>
John Criswellfa2f3682004-03-29 20:23:11 +0000[diff] [blame]215 <li>Source code: 45 MB</li>
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]216 <li>Object code: 850 MB</li>
217 <li>GCC front end: 40 MB</li>
218 </ul></li>
219 </ul>
220 </li>
221
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]222 <li>MacOS X on PowerPC
223 <ul>
John Criswellfa2f3682004-03-29 20:23:11 +0000[diff] [blame]224 <li>Approximately 1.25 GB of Free Disk Space
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]225 <ul>
John Criswellfa2f3682004-03-29 20:23:11 +0000[diff] [blame]226 <li>Source code: 45 MB</li>
Misha Brukman876d5f12004-08-09 19:57:01 +0000[diff] [blame^]227 <li>Object code: 1.2 GB</li>
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]228 <li>GCC front end: 40 MB</li>
229 </ul></li>
230 </ul>
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]231 </li>
Misha Brukman876d5f12004-08-09 19:57:01 +0000[diff] [blame^]232
233 <li>AIX on PowerPC
234 <ul>
235 <li><div class="doc_warning">No native code generation</div>
236 <li>Approximately 2 GB of Free Disk Space
237 <ul>
238 <li>Source code: 92 MB</li>
239 <li>Object code: 2.8 GB</li>
240 <li>GCC front end: 123 MB</li>
241 </ul></li>
242 </ul>
243 </li>
244
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]245</ul>
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 Brukman876d5f12004-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 Brukman560e9892003-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 Lattnere0050f02004-07-18 22:32:22 +0000[diff] [blame]271 support</a> (See <a href="#brokengcc">below</a> for specific version info)</li>
Misha Brukman560e9892003-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 Gaeke8613f13c2004-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 Brukman560e9892003-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 Gaeke8613f13c2004-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 Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]293
John Criswellfa2f3682004-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 Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]295 <li><A href="http://www.python.org">Python</A>
296
John Criswellfa2f3682004-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 Brukmanc1aac032004-05-12 19:25:59 +0000[diff] [blame]301 commands:</p>
John Criswellfa2f3682004-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 Brukmanc1aac032004-05-12 19:25:59 +0000[diff] [blame]310 </li>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]311
312</ul>
Chris Lattnere0050f02004-07-18 22:32:22 +0000[diff] [blame]313</div>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]314
Chris Lattnere0050f02004-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 Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]319
Chris Lattnere0050f02004-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 Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]340
341</div>
342
Chris Lattnere0050f02004-07-18 22:32:22 +0000[diff] [blame]343
344
Misha Brukman560e9892003-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 Lattnere0050f02004-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 Brukman560e9892003-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 Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]377<dl>
Misha Brukman560e9892003-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 Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]381 <p>
382
Misha Brukman560e9892003-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 Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]413<dl>
Misha Brukman560e9892003-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 Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]431 <a name="unpack">Unpacking the LLVM Archives</a>
Misha Brukman560e9892003-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 Criswell86a3a482003-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 Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]440file is a TAR archive that is compressed with the gzip program.
441</p>
442
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]443<p> The files are as follows:
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]444<dl>
John Criswell64f13ab2004-03-12 20:31:37 +0000[diff] [blame]445 <dt>llvm-1.2.tar.gz
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]446 <dd>This is the source code to the LLVM suite.
447 <p>
448
John Criswell64f13ab2004-03-12 20:31:37 +0000[diff] [blame]449 <dt>cfrontend-1.2.sparc-sun-solaris2.8.tar.gz
Misha Brukman560e9892003-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 Criswell64f13ab2004-03-12 20:31:37 +0000[diff] [blame]453 <dt>cfrontend-1.2.i686-redhat-linux-gnu.tar.gz
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]454 <dd>This is the binary release of the GCC front end for Linux/x86.
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]455 <p>
456
John Criswell64f13ab2004-03-12 20:31:37 +0000[diff] [blame]457 <dt>cfrontend-1.2.i386-unknown-freebsd5.1.tar.gz
John Criswell86a3a482003-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 Criswell64f13ab2004-03-12 20:31:37 +0000[diff] [blame]461 <dt>cfrontend-1.2.powerpc-apple-darwin7.0.0.tar.gz
John Criswell86a3a482003-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 Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]463</dl>
464
465</div>
466
467<!-- ======================================================================= -->
468<div class="doc_subsection">
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]469 <a name="checkout">Checkout LLVM from CVS</a>
Misha Brukman560e9892003-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 Brukmand3de5c62004-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 Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]494<ul>
Misha Brukmanc1aac032004-05-12 19:25:59 +0000[diff] [blame]495<li>Release 1.2: <b>RELEASE_12</b></li>
496<li>Release 1.1: <b>RELEASE_11</b></li>
497<li>Release 1.0: <b>RELEASE_1</b></li>
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]498</ul>
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]499
Misha Brukmanc1aac032004-05-12 19:25:59 +0000[diff] [blame]500<p>If you would like to get the GCC front end source code, you can also get it
501from the CVS repository:</p>
502
Chris Lattner3337c822004-06-28 17:14:01 +0000[diff] [blame]503<pre>
504 cvs -z3 -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm co llvm-gcc
Misha Brukmanc1aac032004-05-12 19:25:59 +0000[diff] [blame]505</pre>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]506
Chris Lattner3337c822004-06-28 17:14:01 +0000[diff] [blame]507<p>Please note that you must follow <a href="CFEBuildInstrs.html">these
508instructions</a> to successfully build the LLVM C front-end.</p>
509
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]510</div>
511
512<!-- ======================================================================= -->
Chris Lattner8c470182004-06-18 20:15:58 +0000[diff] [blame]513<div class="doc_subsubsection">
514 <a name="mirrors">LLVM CVS Mirrors</a>
515</div>
516
517<div class="doc_text">
518
519<p>If the main CVS server is overloaded or inaccessible, you can try one of
520these user-hosted mirrors:</p>
521
522<ul>
Misha Brukman0bca6992004-06-18 20:18:31 +0000[diff] [blame]523<li><a href="http://llvm.x10sys.com/">Mirror hosted by eXtensible Systems
524Inc.</a></li>
Chris Lattner8c470182004-06-18 20:15:58 +0000[diff] [blame]525</ul>
526</div>
527
528<!-- ======================================================================= -->
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]529<div class="doc_subsection">
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]530 <a name="installcf">Install the GCC Front End</a>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]531</div>
532
533<div class="doc_text">
534
535<p>Before configuring and compiling the LLVM suite, you need to extract the LLVM
536GCC front end from the binary distribution. It is used for building the
537bytecode libraries later used by the GCC front end for linking programs, and its
538location must be specified when the LLVM suite is configured.</p>
539
540<p>To install the GCC front end, do the following:</p>
541
542<ol>
543 <li><tt>cd <i>where-you-want-the-front-end-to-live</i></tt></li>
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]544 <li><tt>gunzip --stdout cfrontend-<i>version</i>.<i>platform</i>.tar.gz | tar -xvf
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]545 -</tt></li>
546</ol>
547
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]548<p>If you are using Solaris/Sparc or MacOS X/PPC, you will need to fix the
549header files:</p>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]550
John Criswell64f13ab2004-03-12 20:31:37 +0000[diff] [blame]551<p><tt>cd cfrontend/<i>platform</i><br>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]552 ./fixheaders</tt></p>
553
554<p>The binary versions of the GCC front end may not suit all of your needs. For
555example, the binary distribution may include an old version of a system header
556file, not "fix" a header file that needs to be fixed for GCC, or it may be
557linked with libraries not available on your system.</p>
558
559<p>In cases like these, you may want to try <a
560href="CFEBuildInstrs.html">building the GCC front end from source.</a> This is
561not for the faint of heart, so be forewarned.</p>
562
563</div>
564
565<!-- ======================================================================= -->
566<div class="doc_subsection">
567 <a name="config">Local LLVM Configuration</a>
568</div>
569
570<div class="doc_text">
571
572<p>Once checked out from the CVS repository, the LLVM suite source code must be
573configured via the <tt>configure</tt> script. This script sets variables in
574<tt>llvm/Makefile.config</tt> and <tt>llvm/include/Config/config.h</tt>. It
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]575also populates <i>OBJ_ROOT</i> with the Makefiles needed to begin building
576LLVM.</p>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]577
578<p>The following environment variables are used by the <tt>configure</tt>
579script to configure the build system:</p>
580
581<table border=1>
582 <tr>
583 <th>Variable</th>
584 <th>Purpose</th>
585 </tr>
586
587 <tr>
588 <td>CC</td>
589 <td>Tells <tt>configure</tt> which C compiler to use. By default,
590 <tt>configure</tt> will look for the first GCC C compiler in
591 <tt>PATH</tt>. Use this variable to override
592 <tt>configure</tt>'s default behavior.</td>
593 </tr>
594
595 <tr>
596 <td>CXX</td>
597 <td>Tells <tt>configure</tt> which C++ compiler to use. By default,
598 <tt>configure</tt> will look for the first GCC C++ compiler in
599 <tt>PATH</tt>. Use this variable to override
600 <tt>configure</tt>'s default behavior.</td>
601 </tr>
602</table>
603
604<p>The following options can be used to set or enable LLVM specific options:</p>
605
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]606<dl>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]607 <dt><i>--with-llvmgccdir=LLVMGCCDIR</i>
608 <dd>
John Criswell64f13ab2004-03-12 20:31:37 +0000[diff] [blame]609 Path to the location where the LLVM GCC front end binaries and
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]610 associated libraries were installed. This must be specified as an
611 absolute pathname.
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]612 <p>
613 <dt><i>--enable-optimized</i>
614 <dd>
615 Enables optimized compilation by default (debugging symbols are removed
616 and GCC optimization flags are enabled). The default is to use an
617 unoptimized build (also known as a debug build).
618 <p>
619 <dt><i>--enable-jit</i>
620 <dd>
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]621 Compile the Just In Time (JIT) compiler functionality. This is not
622 available
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]623 on all platforms. The default is dependent on platform, so it is best
624 to explicitly enable it if you want it.
625 <p>
626 <dt><i>--enable-spec2000</i>
627 <dt><i>--enable-spec2000=&lt;<tt>directory</tt>&gt;</i>
628 <dd>
629 Enable the use of SPEC2000 when testing LLVM. This is disabled by default
630 (unless <tt>configure</tt> finds SPEC2000 installed). By specifying
631 <tt>directory</tt>, you can tell configure where to find the SPEC2000
632 benchmarks. If <tt>directory</tt> is left unspecified, <tt>configure</tt>
633 uses the default value
634 <tt>/home/vadve/shared/benchmarks/speccpu2000/benchspec</tt>.
John Criswell64f13ab2004-03-12 20:31:37 +0000[diff] [blame]635 <p>
636 <dt><i>--enable-spec95</i>
637 <dt><i>--enable-spec95=&lt;<tt>directory</tt>&gt;</i>
638 <dd>
639 Enable the use of SPEC95 when testing LLVM. It is similar to the
640 <i>--enable-spec2000</i> option.
641 <p>
642 <dt><i>--enable-povray</i>
643 <dt><i>--enable-povray=&lt;<tt>directory</tt>&gt;</i>
644 <dd>
645 Enable the use of Povray as an external test. Versions of Povray written
646 in C should work. This option is similar to the <i>--enable-spec2000</i>
647 option.
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]648</dl>
649
650<p>To configure LLVM, follow these steps:</p>
651
652<ol>
653 <li>Change directory into the object root directory:
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]654 <br>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]655 <tt>cd <i>OBJ_ROOT</i></tt>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]656 <p>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]657
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]658 <li>Run the <tt>configure</tt> script located in the LLVM source tree:
659 <br>
660 <tt><i>SRC_ROOT</i>/configure</tt>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]661 <p>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]662</ol>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]663
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]664<p>In addition to running <tt>configure</tt>, you must set the
665<tt>LLVM_LIB_SEARCH_PATH</tt> environment variable in your startup scripts.
666This environment variable is used to locate "system" libraries like
667"<tt>-lc</tt>" and "<tt>-lm</tt>" when linking. This variable should be set to
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]668the absolute path of the <tt>bytecode-libs</tt> subdirectory of the GCC front
669end, or <i>LLVMGCCDIR</i>/<tt>bytecode-libs</tt>. For example, one might set
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]670<tt>LLVM_LIB_SEARCH_PATH</tt> to
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]671<tt>/home/vadve/lattner/local/x86/llvm-gcc/bytecode-libs</tt> for the x86
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]672version of the GCC front end on our research machines.</p>
John Criswell3ef61af2003-06-30 21:59:07 +0000[diff] [blame]673
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]674</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]675
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]676<!-- ======================================================================= -->
677<div class="doc_subsection">
678 <a name="compile">Compiling the LLVM Suite Source Code</a>
679</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]680
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]681<div class="doc_text">
John Criswell71139f22003-07-08 20:35:59 +0000[diff] [blame]682
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]683<p>Once you have configured LLVM, you can build it. There are three types of
684builds:</p>
John Criswell71139f22003-07-08 20:35:59 +0000[diff] [blame]685
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]686<dl>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]687 <dt>Debug Builds
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]688 <dd>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]689 These builds are the default when one types <tt>gmake</tt> (unless the
690 <tt>--enable-optimized</tt> option was used during configuration). The
691 build system will compile the tools and libraries with debugging
692 information.
693 <p>
694
695 <dt>Release (Optimized) Builds
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]696 <dd>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]697 These builds are enabled with the <tt>--enable-optimized</tt> option to
698 <tt>configure</tt> or by specifying <tt>ENABLE_OPTIMIZED=1</tt> on the
699 <tt>gmake</tt> command line. For these builds, the build system will
700 compile the tools and libraries with GCC optimizations enabled and strip
701 debugging information from the libraries and executables it generates.
702 <p>
703
704 <dt>Profile Builds
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]705 <dd>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]706 These builds are for use with profiling. They compile profiling
707 information into the code for use with programs like <tt>gprof</tt>.
708 Profile builds must be started by specifying <tt>ENABLE_PROFILING=1</tt>
709 on the <tt>gmake</tt> command line.
710</dl>
John Criswell3ef61af2003-06-30 21:59:07 +0000[diff] [blame]711
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]712<p>Once you have LLVM configured, you can build it by entering the
713<i>OBJ_ROOT</i> directory and issuing the following command:</p>
John Criswell38cc2b52003-10-10 14:26:14 +0000[diff] [blame]714
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]715<p><tt>gmake</tt></p>
John Criswell38cc2b52003-10-10 14:26:14 +0000[diff] [blame]716
Chris Lattnere0050f02004-07-18 22:32:22 +0000[diff] [blame]717<p>If the build fails, please <a href="#brokengcc">check here</a> to see if you
718are using a known broken version of GCC to compile LLVM with.</p>
719
720<p>
721If you have multiple processors in your machine, you may wish to use some of
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]722the parallel build options provided by GNU Make. For example, you could use the
723command:</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]724
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]725<p><tt>gmake -j2</tt></p>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]726
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]727<p>There are several special targets which are useful when working with the LLVM
728source code:</p>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]729
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]730<dl>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]731 <dt><tt>gmake clean</tt>
732 <dd>
733 Removes all files generated by the build. This includes object files,
734 generated C/C++ files, libraries, and executables.
735 <p>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]736
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]737 <dt><tt>gmake distclean</tt>
738 <dd>
739 Removes everything that <tt>gmake clean</tt> does, but also removes
740 files generated by <tt>configure</tt>. It attempts to return the
741 source tree to the original state in which it was shipped.
742 <p>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]743
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]744 <dt><tt>gmake install</tt>
745 <dd>
746 Installs LLVM files into the proper location. For the most part,
747 this does nothing, but it does install bytecode libraries into the
748 GCC front end's bytecode library directory. If you need to update
749 your bytecode libraries, this is the target to use once you've built
750 them.
751 <p>
752</dl>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]753
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]754<p>It is also possible to override default values from <tt>configure</tt> by
755declaring variables on the command line. The following are some examples:</p>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]756
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]757<dl>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]758 <dt><tt>gmake ENABLE_OPTIMIZED=1</tt>
759 <dd>
760 Perform a Release (Optimized) build.
761 <p>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]762
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]763 <dt><tt>gmake ENABLE_PROFILING=1</tt>
764 <dd>
765 Perform a Profiling build.
766 <p>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]767
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]768 <dt><tt>gmake VERBOSE=1</tt>
769 <dd>
770 Print what <tt>gmake</tt> is doing on standard output.
771 <p>
772</dl>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]773
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]774<p>Every directory in the LLVM object tree includes a <tt>Makefile</tt> to build
775it and any subdirectories that it contains. Entering any directory inside the
776LLVM object tree and typing <tt>gmake</tt> should rebuild anything in or below
777that directory that is out of date.</p>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]778
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]779</div>
John Criswell38cc2b52003-10-10 14:26:14 +0000[diff] [blame]780
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]781<!-- ======================================================================= -->
782<div class="doc_subsection">
783 <a name="objfiles">The Location of LLVM Object Files</a>
784</div>
John Criswell38cc2b52003-10-10 14:26:14 +0000[diff] [blame]785
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]786<div class="doc_text">
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]787
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]788<p>The LLVM build system is capable of sharing a single LLVM source tree among
789several LLVM builds. Hence, it is possible to build LLVM for several different
790platforms or configurations using the same source tree.</p>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]791
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]792<p>This is accomplished in the typical autoconf manner:</p>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]793
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]794<ul>
795 <li><p>Change directory to where the LLVM object files should live:</p>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]796
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]797 <p><tt>cd <i>OBJ_ROOT</i></tt></p></li>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]798
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]799 <li><p>Run the <tt>configure</tt> script found in the LLVM source
800 directory:</p>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]801
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]802 <p><tt><i>SRC_ROOT</i>/configure</tt></p></li>
803</ul>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]804
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]805<p>The LLVM build will place files underneath <i>OBJ_ROOT</i> in directories
806named after the build type:</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]807
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]808<dl>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]809 <dt>Debug Builds
810 <dd>
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]811 <dl>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]812 <dt>Tools
813 <dd><tt><i>OBJ_ROOT</i>/tools/Debug</tt>
814 <dt>Libraries
815 <dd><tt><i>OBJ_ROOT</i>/lib/Debug</tt>
816 </dl>
817 <p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]818
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]819 <dt>Release Builds
820 <dd>
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]821 <dl>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]822 <dt>Tools
823 <dd><tt><i>OBJ_ROOT</i>/tools/Release</tt>
824 <dt>Libraries
825 <dd><tt><i>OBJ_ROOT</i>/lib/Release</tt>
826 </dl>
827 <p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]828
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]829 <dt>Profile Builds
830 <dd>
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]831 <dl>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]832 <dt>Tools
833 <dd><tt><i>OBJ_ROOT</i>/tools/Profile</tt>
834 <dt>Libraries
835 <dd><tt><i>OBJ_ROOT</i>/lib/Profile</tt>
836 </dl>
837</dl>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]838
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]839</div>
Chris Lattner1c1ef112002-07-24 19:51:14 +0000[diff] [blame]840
Chris Lattner998c0672004-03-25 20:38:40 +0000[diff] [blame]841<!-- ======================================================================= -->
842<div class="doc_subsection">
843 <a name="optionalconfig">Optional Configuration Items</a>
844</div>
845
846<div class="doc_text">
847
848<p>
849If you're running on a linux system that supports the "<a
850href="http://www.tat.physik.uni-tuebingen.de/~rguenth/linux/binfmt_misc.html">binfmt_misc</a>"
851module, and you have root access on the system, you can set your system up to
852execute LLVM bytecode files directly. To do this, use commands like this (the
853first command may not be required if you are already using the module):</p>
854
855<pre>
856 $ mount -t binfmt_misc none /proc/sys/fs/binfmt_misc
857 $ echo ':llvm:M::llvm::/path/to/lli:' > /proc/sys/fs/binfmt_misc/register
858 $ chmod u+x hello.bc (if needed)
859 $ ./hello.bc
860</pre>
861
862<p>
863This allows you to execute LLVM bytecode files directly. Thanks to Jack
864Cummings for pointing this out!
865</p>
866
867</div>
868
869
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]870<!-- *********************************************************************** -->
871<div class="doc_section">
872 <a name="layout"><b>Program Layout</b></a>
873</div>
874<!-- *********************************************************************** -->
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]875
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]876<div class="doc_text">
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]877
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]878<p>One useful source of information about the LLVM source base is the LLVM <a
John Criswell64f13ab2004-03-12 20:31:37 +0000[diff] [blame]879href="http://www.doxygen.org">doxygen</a> documentation available at <tt><a
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]880href="http://llvm.cs.uiuc.edu/doxygen/">http://llvm.cs.uiuc.edu/doxygen/</a></tt>.
881The following is a brief introduction to code layout:</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]882
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]883</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]884
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]885<!-- ======================================================================= -->
886<div class="doc_subsection">
887 <a name="cvsdir"><tt>CVS</tt> directories</a>
888</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]889
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]890<div class="doc_text">
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]891
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]892<p>Every directory checked out of CVS will contain a <tt>CVS</tt> directory; for
893the most part these can just be ignored.</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]894
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]895</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]896
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]897<!-- ======================================================================= -->
898<div class="doc_subsection">
899 <a name="include"><tt>llvm/include</tt></a>
900</div>
901
902<div class="doc_text">
903
904<p>This directory contains public header files exported from the LLVM
905library. The three main subdirectories of this directory are:</p>
906
907<ol>
908 <li><tt>llvm/include/llvm</tt> - This directory contains all of the LLVM
909 specific header files. This directory also has subdirectories for
910 different portions of LLVM: <tt>Analysis</tt>, <tt>CodeGen</tt>,
911 <tt>Target</tt>, <tt>Transforms</tt>, etc...</li>
912
913 <li><tt>llvm/include/Support</tt> - This directory contains generic
914 support libraries that are independent of LLVM, but are used by LLVM.
915 For example, some C++ STL utilities and a Command Line option processing
916 library store their header files here.</li>
917
918 <li><tt>llvm/include/Config</tt> - This directory contains header files
919 configured by the <tt>configure</tt> script. They wrap "standard" UNIX
920 and C header files. Source code can include these header files which
921 automatically take care of the conditional #includes that the
922 <tt>configure</tt> script generates.</li>
923</ol>
924
925</div>
926
927<!-- ======================================================================= -->
928<div class="doc_subsection">
929 <a name="lib"><tt>llvm/lib</tt></a>
930</div>
931
932<div class="doc_text">
933
934<p>This directory contains most of the source files of the LLVM system. In LLVM,
935almost all code exists in libraries, making it very easy to share code among the
936different <a href="#tools">tools</a>.</p>
937
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]938<dl>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]939 <dt><tt>llvm/lib/VMCore/</tt><dd> This directory holds the core LLVM
940 source files that implement core classes like Instruction and BasicBlock.
941
942 <dt><tt>llvm/lib/AsmParser/</tt><dd> This directory holds the source code
943 for the LLVM assembly language parser library.
944
945 <dt><tt>llvm/lib/ByteCode/</tt><dd> This directory holds code for reading
946 and write LLVM bytecode.
947
948 <dt><tt>llvm/lib/CWriter/</tt><dd> This directory implements the LLVM to C
949 converter.
950
951 <dt><tt>llvm/lib/Analysis/</tt><dd> This directory contains a variety of
952 different program analyses, such as Dominator Information, Call Graphs,
953 Induction Variables, Interval Identification, Natural Loop Identification,
954 etc...
955
956 <dt><tt>llvm/lib/Transforms/</tt><dd> This directory contains the source
957 code for the LLVM to LLVM program transformations, such as Aggressive Dead
958 Code Elimination, Sparse Conditional Constant Propagation, Inlining, Loop
959 Invariant Code Motion, Dead Global Elimination, and many others...
960
961 <dt><tt>llvm/lib/Target/</tt><dd> This directory contains files that
962 describe various target architectures for code generation. For example,
John Criswellfa2f3682004-03-29 20:23:11 +0000[diff] [blame]963 the llvm/lib/Target/SparcV9 directory holds the Sparc machine
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]964 description.<br>
965
966 <dt><tt>llvm/lib/CodeGen/</tt><dd> This directory contains the major parts
967 of the code generator: Instruction Selector, Instruction Scheduling, and
968 Register Allocation.
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]969
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]970 <dt><tt>llvm/lib/Support/</tt><dd> This directory contains the source code
971 that corresponds to the header files located in
972 <tt>llvm/include/Support/</tt>.
973</dl>
John Criswell3ef61af2003-06-30 21:59:07 +0000[diff] [blame]974
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]975</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]976
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]977<!-- ======================================================================= -->
978<div class="doc_subsection">
979 <a name="runtime"><tt>llvm/runtime</tt></a>
980</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]981
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]982<div class="doc_text">
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]983
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]984<p>This directory contains libraries which are compiled into LLVM bytecode and
985used when linking programs with the GCC front end. Most of these libraries are
986skeleton versions of real libraries; for example, libc is a stripped down
987version of glibc.</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]988
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]989<p>Unlike the rest of the LLVM suite, this directory needs the LLVM GCC front
990end to compile.</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]991
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]992</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]993
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]994<!-- ======================================================================= -->
995<div class="doc_subsection">
996 <a name="test"><tt>llvm/test</tt></a>
997</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]998
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]999<div class="doc_text">
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1000
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1001<p>This directory contains regression tests and source code that is used to test
1002the LLVM infrastructure.</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1003
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1004</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1005
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1006<!-- ======================================================================= -->
1007<div class="doc_subsection">
1008 <a name="tools"><tt>llvm/tools</tt></a>
1009</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1010
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1011<div class="doc_text">
John Criswell38cc2b52003-10-10 14:26:14 +0000[diff] [blame]1012
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1013<p>The <b>tools</b> directory contains the executables built out of the
1014libraries above, which form the main part of the user interface. You can
1015always get help for a tool by typing <tt>tool_name --help</tt>. The
John Criswell64f13ab2004-03-12 20:31:37 +0000[diff] [blame]1016following is a brief introduction to the most important tools:</p>
John Criswell38cc2b52003-10-10 14:26:14 +0000[diff] [blame]1017
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1018<dl>
1019 <dt><tt><b>analyze</b></tt> <dd><tt>analyze</tt> is used to run a specific
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1020 analysis on an input LLVM bytecode file and print out the results. It is
1021 primarily useful for debugging analyses, or familiarizing yourself with
1022 what an analysis does.<p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1023
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1024 <dt><tt><b>bugpoint</b></tt> <dd><tt>bugpoint</tt> is used to debug
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1025 optimization passes or code generation backends by narrowing down the
1026 given test case to the minimum number of passes and/or instructions that
1027 still cause a problem, whether it is a crash or miscompilation. See <a
1028 href="HowToSubmitABug.html">HowToSubmitABug.html</a> for more information
1029 on using <tt>bugpoint</tt>.<p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1030
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1031 <dt><tt><b>llvm-ar</b></tt> <dd>The archiver produces an archive containing
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1032 the given LLVM bytecode files, optionally with an index for faster
1033 lookup.<p>
1034
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1035 <dt><tt><b>llvm-as</b></tt> <dd>The assembler transforms the human readable
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1036 LLVM assembly to LLVM bytecode.<p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1037
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1038 <dt><tt><b>llvm-dis</b></tt><dd>The disassembler transforms the LLVM
Chris Lattnera9c61b32004-02-14 01:07:17 +0000[diff] [blame]1039 bytecode to human readable LLVM assembly.<p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1040
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1041 <dt><tt><b>llvm-link</b></tt><dd> <tt>llvm-link</tt>, not surprisingly,
1042 links multiple LLVM modules into a single program.<p>
1043
1044 <dt><tt><b>lli</b></tt><dd> <tt>lli</tt> is the LLVM interpreter, which
1045 can directly execute LLVM bytecode (although very slowly...). In addition
1046 to a simple interpreter, <tt>lli</tt> also has a tracing mode (entered by
1047 specifying <tt>-trace</tt> on the command line). Finally, for
1048 architectures that support it (currently only x86 and Sparc), by default,
1049 <tt>lli</tt> will function as a Just-In-Time compiler (if the
1050 functionality was compiled in), and will execute the code <i>much</i>
1051 faster than the interpreter.<p>
Misha Brukman994d7e82003-10-06 19:23:34 +0000[diff] [blame]1052
Chris Lattnera9c61b32004-02-14 01:07:17 +0000[diff] [blame]1053 <dt><tt><b>llc</b></tt><dd> <tt>llc</tt> is the LLVM backend compiler, which
1054 translates LLVM bytecode to a SPARC or x86 assembly file, or to C code (with
1055 the -march=c option).<p>
Misha Brukman994d7e82003-10-06 19:23:34 +0000[diff] [blame]1056
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1057 <dt><tt><b>llvmgcc</b></tt><dd> <tt>llvmgcc</tt> is a GCC-based C frontend
1058 that has been retargeted to emit LLVM code as the machine code output. It
1059 works just like any other GCC compiler, taking the typical <tt>-c, -S, -E,
1060 -o</tt> options that are typically used. The source code for the
1061 <tt>llvmgcc</tt> tool is currently not included in the LLVM CVS tree
1062 because it is quite large and not very interesting.<p>
Misha Brukman994d7e82003-10-06 19:23:34 +0000[diff] [blame]1063
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1064 <blockquote>
1065 <dl>
1066 <dt><tt><b>gccas</b></tt> <dd>This tool is invoked by the
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1067 <tt>llvmgcc</tt> frontend as the "assembler" part of the compiler. This
1068 tool actually assembles LLVM assembly to LLVM bytecode,
1069 performs a variety of optimizations, and outputs LLVM bytecode. Thus
1070 when you invoke <tt>llvmgcc -c x.c -o x.o</tt>, you are causing
1071 <tt>gccas</tt> to be run, which writes the <tt>x.o</tt> file (which is
1072 an LLVM bytecode file that can be disassembled or manipulated just like
1073 any other bytecode file). The command line interface to <tt>gccas</tt>
1074 is designed to be as close as possible to the <b>system</b>
1075 `<tt>as</tt>' utility so that the gcc frontend itself did not have to be
1076 modified to interface to a "weird" assembler.<p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1077
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1078 <dt><tt><b>gccld</b></tt> <dd><tt>gccld</tt> links together several LLVM
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1079 bytecode files into one bytecode file and does some optimization. It is
1080 the linker invoked by the GCC frontend when multiple .o files need to be
1081 linked together. Like <tt>gccas</tt>, the command line interface of
1082 <tt>gccld</tt> is designed to match the system linker, to aid
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1083 interfacing with the GCC frontend.</dl><p>
1084 </blockquote>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1085
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1086 <dt><tt><b>opt</b></tt><dd> <tt>opt</tt> reads LLVM bytecode, applies a
1087 series of LLVM to LLVM transformations (which are specified on the command
1088 line), and then outputs the resultant bytecode. The '<tt>opt --help</tt>'
1089 command is a good way to get a list of the program transformations
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1090 available in LLVM.
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1091
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1092</dl>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1093
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1094</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1095
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1096<!-- ======================================================================= -->
1097<div class="doc_subsection">
1098 <a name="utils"><tt>llvm/utils</tt></a>
1099</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1100
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1101<div class="doc_text">
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1102
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1103<p>This directory contains utilities for working with LLVM source code, and some
1104of the utilities are actually required as part of the build process because they
1105are code generators for parts of LLVM infrastructure.</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1106
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1107<dl>
1108 <dt><tt><b>Burg/</b></tt> <dd><tt>Burg</tt> is an instruction selector
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1109 generator -- it builds trees on which it then performs pattern-matching to
1110 select instructions according to the patterns the user has specified. Burg
1111 is currently used in the Sparc V9 backend.<p>
John Criswell71139f22003-07-08 20:35:59 +0000[diff] [blame]1112
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1113 <dt><tt><b>codegen-diff</b></tt> <dd><tt>codegen-diff</tt> is a script
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1114 that finds differences between code that LLC generates and code that LLI
1115 generates. This is a useful tool if you are debugging one of them,
1116 assuming that the other generates correct output. For the full user
1117 manual, run <tt>`perldoc codegen-diff'</tt>.<p>
Misha Brukmanefe54be2003-08-11 18:45:46 +0000[diff] [blame]1118
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1119 <dt><tt><b>cvsupdate</b></tt> <dd><tt>cvsupdate</tt> is a script that will
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1120 update your CVS tree, but produce a much cleaner and more organized output
1121 than simply running <tt>`cvs -z3 up -dP'</tt> will. For example, it will group
1122 together all the new and updated files and modified files in separate
1123 sections, so you can see at a glance what has changed. If you are at the
1124 top of your LLVM CVS tree, running <tt>utils/cvsupdate</tt> is the
1125 preferred way of updating the tree.<p>
Misha Brukmanefe54be2003-08-11 18:45:46 +0000[diff] [blame]1126
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1127 <dt><tt><b>emacs/</b></tt> <dd>The <tt>emacs</tt> directory contains
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1128 syntax-highlighting files which will work with Emacs and XEmacs editors,
1129 providing syntax highlighting support for LLVM assembly files and TableGen
1130 description files. For information on how to use the syntax files, consult
1131 the <tt>README</tt> file in that directory.<p>
Misha Brukmanefe54be2003-08-11 18:45:46 +0000[diff] [blame]1132
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1133 <dt><tt><b>getsrcs.sh</b></tt> <dd>The <tt>getsrcs.sh</tt> script finds
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1134 and outputs all non-generated source files, which is useful if one wishes
1135 to do a lot of development across directories and does not want to
1136 individually find each file. One way to use it is to run, for example:
1137 <tt>xemacs `utils/getsources.sh`</tt> from the top of your LLVM source
1138 tree.<p>
1139
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1140 <dt><tt><b>makellvm</b></tt> <dd>The <tt>makellvm</tt> script compiles all
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1141 files in the current directory and then compiles and links the tool that
1142 is the first argument. For example, assuming you are in the directory
1143 <tt>llvm/lib/Target/Sparc</tt>, if <tt>makellvm</tt> is in your path,
1144 simply running <tt>makellvm llc</tt> will make a build of the current
1145 directory, switch to directory <tt>llvm/tools/llc</tt> and build it,
1146 causing a re-linking of LLC.<p>
Misha Brukmanefe54be2003-08-11 18:45:46 +0000[diff] [blame]1147
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1148 <dt><tt><b>NightlyTest.pl</b></tt> and
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1149 <tt><b>NightlyTestTemplate.html</b></tt> <dd>These files are used in a
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1150 cron script to generate nightly status reports of the functionality of
1151 tools, and the results can be seen by following the appropriate link on
1152 the <a href="http://llvm.cs.uiuc.edu/">LLVM homepage</a>.<p>
Misha Brukmanefe54be2003-08-11 18:45:46 +0000[diff] [blame]1153
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1154 <dt><tt><b>TableGen/</b></tt> <dd>The <tt>TableGen</tt> directory contains
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1155 the tool used to generate register descriptions, instruction set
1156 descriptions, and even assemblers from common TableGen description
1157 files.<p>
Misha Brukmanefe54be2003-08-11 18:45:46 +0000[diff] [blame]1158
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1159 <dt><tt><b>vim/</b></tt> <dd>The <tt>vim</tt> directory contains
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1160 syntax-highlighting files which will work with the VIM editor, providing
1161 syntax highlighting support for LLVM assembly files and TableGen
1162 description files. For information on how to use the syntax files, consult
1163 the <tt>README</tt> file in that directory.<p>
Misha Brukmanefe54be2003-08-11 18:45:46 +0000[diff] [blame]1164
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1165</dl>
Misha Brukmanefe54be2003-08-11 18:45:46 +0000[diff] [blame]1166
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1167</div>
Misha Brukmanefe54be2003-08-11 18:45:46 +0000[diff] [blame]1168
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1169<!-- *********************************************************************** -->
1170<div class="doc_section">
1171 <a name="tutorial">An Example Using the LLVM Tool Chain</a>
1172</div>
1173<!-- *********************************************************************** -->
Misha Brukmanefe54be2003-08-11 18:45:46 +0000[diff] [blame]1174
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1175<div class="doc_text">
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1176
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1177<ol>
1178 <li>First, create a simple C file, name it 'hello.c':
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1179 <pre>
1180 #include &lt;stdio.h&gt;
1181 int main() {
1182 printf("hello world\n");
1183 return 0;
1184 }
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1185 </pre></li>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1186
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1187 <li><p>Next, compile the C file into a LLVM bytecode file:</p>
1188 <p><tt>% llvmgcc hello.c -o hello</tt></p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1189
Misha Brukman6c2cf082004-06-22 18:48:58 +0000[diff] [blame]1190 <p>Note that you should have already built the tools and they have to be
1191 in your path, at least <tt>gccas</tt> and <tt>gccld</tt>.</p>
1192
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1193 <p>This will create two result files: <tt>hello</tt> and
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1194 <tt>hello.bc</tt>. The <tt>hello.bc</tt> is the LLVM bytecode that
1195 corresponds the the compiled program and the library facilities that it
1196 required. <tt>hello</tt> is a simple shell script that runs the bytecode
Chris Lattner15a041c2004-05-01 11:40:07 +0000[diff] [blame]1197 file with <tt>lli</tt>, making the result directly executable. Note that
1198 all LLVM optimizations are enabled by default, so there is no need for a
1199 "-O3" switch.</p></li>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1200
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1201 <li><p>Run the program. To make sure the program ran, execute one of the
1202 following commands:</p>
John Criswell0c951c62003-06-11 20:46:40 +0000[diff] [blame]1203
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1204 <p><tt>% ./hello</tt></p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1205
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1206 <p>or</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1207
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1208 <p><tt>% lli hello.bc</tt></p></li>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1209
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1210 <li><p>Use the <tt>llvm-dis</tt> utility to take a look at the LLVM assembly
1211 code:</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1212
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1213 <p><tt>% llvm-dis &lt; hello.bc | less</tt><p></li>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1214
Chris Lattner03793512004-06-02 20:37:02 +0000[diff] [blame]1215 <li><p>Compile the program to native assembly using the LLC code
1216 generator:</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1217
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1218 <p><tt>% llc hello.bc -o hello.s</tt></p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1219
Chris Lattner03793512004-06-02 20:37:02 +0000[diff] [blame]1220 <li><p>Assemble the native assembly language file into a program:</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1221
Chris Lattner03793512004-06-02 20:37:02 +0000[diff] [blame]1222 <p><b>Solaris:</b><tt>% /opt/SUNWspro/bin/cc -xarch=v9 hello.s -o hello.native</tt></p>
1223 <p><b>Others:</b><tt>% gcc hello.s -o hello.native</tt></p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1224
Chris Lattner03793512004-06-02 20:37:02 +0000[diff] [blame]1225 <li><p>Execute the native code program:</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1226
Chris Lattner03793512004-06-02 20:37:02 +0000[diff] [blame]1227 <p><tt>% ./hello.native</tt></p></li>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1228
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1229</ol>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1230
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1231</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1232
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1233<!-- *********************************************************************** -->
1234<div class="doc_section">
1235 <a name="problems">Common Problems</a>
1236</div>
1237<!-- *********************************************************************** -->
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1238
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1239<div class="doc_text">
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1240
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1241<p>If you are having problems building or using LLVM, or if you have any other
1242general questions about LLVM, please consult the <a href="FAQ.html">Frequently
1243Asked Questions</a> page.</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1244
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1245</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1246
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1247<!-- *********************************************************************** -->
1248<div class="doc_section">
1249 <a name="links">Links</a>
1250</div>
1251<!-- *********************************************************************** -->
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1252
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1253<div class="doc_text">
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1254
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1255<p>This document is just an <b>introduction</b> to how to use LLVM to do
1256some simple things... there are many more interesting and complicated things
1257that you can do that aren't documented here (but we'll gladly accept a patch
1258if you want to write something up!). For more information about LLVM, check
1259out:</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1260
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1261<ul>
1262 <li><a href="http://llvm.cs.uiuc.edu/">LLVM homepage</a></li>
1263 <li><a href="http://llvm.cs.uiuc.edu/doxygen/">LLVM doxygen tree</a></li>
1264 <li><a href="http://llvm.cs.uiuc.edu/docs/Projects.html">Starting a Project
1265 that Uses LLVM</a></li>
1266</ul>
1267
1268</div>
1269
1270<!-- *********************************************************************** -->
1271
1272<hr>
Misha Brukman74d4df82003-11-22 01:30:01 +0000[diff] [blame]1273<address>
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1274 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1275 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
1276 <a href="http://validator.w3.org/check/referer"><img
1277 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
1278
Misha Brukman74d4df82003-11-22 01:30:01 +0000[diff] [blame]1279 <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
1280 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1281 Last modified: $Date$
Misha Brukman74d4df82003-11-22 01:30:01 +0000[diff] [blame]1282</address>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1283
1284</body>
Guochun Shib65a78e2002-07-17 23:05:56 +0000[diff] [blame]1285</html>