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