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