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