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