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