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