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