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