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