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