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