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