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