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