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