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