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