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