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