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