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