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