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