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