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