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