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