Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / b9e35fbc1ef10d4fd1ab8f174933e5501e952184 / . / llvm / docs / GettingStarted.html
blob: 575ec04a86f7472577ba7cc21d5d32c917d0bb20 [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
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]11<h1>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]12 Getting Started with the LLVM System
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]13</h1>
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>
Chris Lattner059a8df2007-11-01 04:20:16 +0000[diff] [blame]20 <li><a href="#hardware">Hardware</a></li>
21 <li><a href="#software">Software</a></li>
22 <li><a href="#brokengcc">Broken versions of GCC and other tools</a></li>
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>
Chris Lattner059a8df2007-11-01 04:20:16 +0000[diff] [blame]27 <li><a href="#terminology">Terminology and Notation</a></li>
28 <li><a href="#environment">Setting Up Your Environment</a></li>
29 <li><a href="#unpack">Unpacking the LLVM Archives</a></li>
30 <li><a href="#checkout">Checkout LLVM from Subversion</a></li>
Anton Korobeynikov3e956af2011-02-01 20:08:28 +0000[diff] [blame]31 <li><a href="#git_mirror">LLVM GIT mirror</a></li>
Chris Lattner059a8df2007-11-01 04:20:16 +0000[diff] [blame]32 <li><a href="#config">Local LLVM Configuration</a></li>
33 <li><a href="#compile">Compiling the LLVM Suite Source Code</a></li>
34 <li><a href="#cross-compile">Cross-Compiling LLVM</a></li>
35 <li><a href="#objfiles">The Location of LLVM Object Files</a></li>
36 <li><a href="#optionalconfig">Optional Configuration Items</a></li>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]37 </ol></li>
John Criswell71139f22003-07-08 20:35:59 +0000[diff] [blame]38
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]39 <li><a href="#layout">Program layout</a>
40 <ol>
Chris Lattner059a8df2007-11-01 04:20:16 +0000[diff] [blame]41 <li><a href="#examples"><tt>llvm/examples</tt></a></li>
42 <li><a href="#include"><tt>llvm/include</tt></a></li>
43 <li><a href="#lib"><tt>llvm/lib</tt></a></li>
44 <li><a href="#projects"><tt>llvm/projects</tt></a></li>
45 <li><a href="#runtime"><tt>llvm/runtime</tt></a></li>
46 <li><a href="#test"><tt>llvm/test</tt></a></li>
Andrew Trick68aa18e42010-09-23 20:26:44 +0000[diff] [blame]47 <li><a href="#test-suite"><tt>test-suite</tt></a></li>
Chris Lattner059a8df2007-11-01 04:20:16 +0000[diff] [blame]48 <li><a href="#tools"><tt>llvm/tools</tt></a></li>
49 <li><a href="#utils"><tt>llvm/utils</tt></a></li>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]50 </ol></li>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]51
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]52 <li><a href="#tutorial">An Example Using the LLVM Tool Chain</a>
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]53 <ol>
Chad Rosier233f1472012-02-26 21:31:25 +0000[diff] [blame]54 <li><a href="#tutorial4">Example with Clang</a></li>
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]55 </ol>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]56 <li><a href="#problems">Common Problems</a>
57 <li><a href="#links">Links</a>
58</ul>
59
Chris Lattner020e1fc2004-05-23 21:07:27 +0000[diff] [blame]60<div class="doc_author">
61 <p>Written by:
62 <a href="mailto:criswell@uiuc.edu">John Criswell</a>,
63 <a href="mailto:sabre@nondot.org">Chris Lattner</a>,
NAKAMURA Takumica46f5a2011-04-09 02:13:37 +0000[diff] [blame]64 <a href="http://misha.brukman.net/">Misha Brukman</a>,
Chris Lattner020e1fc2004-05-23 21:07:27 +0000[diff] [blame]65 <a href="http://www.cs.uiuc.edu/~vadve">Vikram Adve</a>, and
66 <a href="mailto:gshi1@uiuc.edu">Guochun Shi</a>.
67 </p>
68</div>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]69
70
71<!-- *********************************************************************** -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]72<h2>
73 <a name="overview">Overview</a>
74</h2>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]75<!-- *********************************************************************** -->
76
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]77<div>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]78
79<p>Welcome to LLVM! In order to get started, you first need to know some
80basic information.</p>
81
Andrew Trick68aa18e42010-09-23 20:26:44 +0000[diff] [blame]82<p>First, LLVM comes in three pieces. The first piece is the LLVM
83suite. This contains all of the tools, libraries, and header files
Jim Grosbach65e24652012-01-25 22:00:23 +0000[diff] [blame]84needed to use LLVM. It contains an assembler, disassembler, bitcode
85analyzer and bitcode optimizer. It also contains basic regression tests that
Chad Rosier233f1472012-02-26 21:31:25 +0000[diff] [blame]86can be used to test the LLVM tools and the Clang front end.</p>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]87
Chad Rosier690a2b02012-02-26 21:34:02 +0000[diff] [blame]88<p>The second piece is the <a href="http://clang.llvm.org/">Clang</a> front end.
89This component compiles C, C++, Objective C, and Objective C++ code into LLVM
90bitcode. Once compiled into LLVM bitcode, a program can be manipulated with the
91LLVM tools from the LLVM suite.
Chad Rosier233f1472012-02-26 21:31:25 +0000[diff] [blame]92</p>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]93
John Criswell6ab273c2004-12-08 17:53:54 +0000[diff] [blame]94<p>
Andrew Trick68aa18e42010-09-23 20:26:44 +0000[diff] [blame]95There is a third, optional piece called Test Suite. It is a suite of programs
John Criswell6ab273c2004-12-08 17:53:54 +0000[diff] [blame]96with a testing harness that can be used to further test LLVM's functionality
97and performance.
98</p>
99
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]100</div>
101
102<!-- *********************************************************************** -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]103<h2>
104 <a name="quickstart">Getting Started Quickly (A Summary)</a>
105</h2>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]106<!-- *********************************************************************** -->
107
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]108<div>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]109
Chad Rosier2270b002012-02-26 22:12:59 +0000[diff] [blame]110<p>The LLVM Getting Started documentation may be out of date. So, the Clang
111<a href="http://clang.llvm.org/get_started.html">Getting Started</a> page might
112also be a good place to start.</p>
Chad Rosier6e220d52012-02-23 21:23:24 +0000[diff] [blame]113
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]114<p>Here's the short story for getting up and running quickly with LLVM:</p>
115
116<ol>
Reid Spencer3fbf26a2004-11-08 00:29:22 +0000[diff] [blame]117 <li>Read the documentation.</li>
118 <li>Read the documentation.</li>
119 <li>Remember that you were warned twice about reading the documentation.</li>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]120
Chad Rosier2270b002012-02-26 22:12:59 +0000[diff] [blame]121 <li>Checkout LLVM:
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]122 <ul>
Chad Rosier2270b002012-02-26 22:12:59 +0000[diff] [blame]123 <li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
124 <li><tt>svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm</tt></li>
125 </ul>
126 </li>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]127
Chad Rosier2270b002012-02-26 22:12:59 +0000[diff] [blame]128 <li>Checkout Clang:
John Criswelldfe6a862004-12-10 15:51:16 +0000[diff] [blame]129 <ul>
Chad Rosier2270b002012-02-26 22:12:59 +0000[diff] [blame]130 <li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
131 <li><tt>cd llvm/tools</tt>
132 <li><tt>svn co http://llvm.org/svn/llvm-project/cfe/trunk clang</tt></li>
133 </ul>
134 </li>
John Criswelldfe6a862004-12-10 15:51:16 +0000[diff] [blame]135
Chad Rosier2270b002012-02-26 22:12:59 +0000[diff] [blame]136 <li>Checkout Compiler-RT:
137 <ul>
138 <li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
139 <li><tt>cd llvm/projects</tt>
140 <li><tt>svn co http://llvm.org/svn/llvm-project/compiler-rt/trunk
141 compiler-rt</tt></li>
142 </ul>
143 </li>
John Criswelldfe6a862004-12-10 15:51:16 +0000[diff] [blame]144
Chad Rosier2270b002012-02-26 22:12:59 +0000[diff] [blame]145 <li>Get the Test Suite Source Code <b>[Optional]</b>
146 <ul>
147 <li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
148 <li><tt>cd llvm/projects</tt>
149 <li><tt>svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite</tt></li>
150 </ul>
151 </li>
John Criswelldfe6a862004-12-10 15:51:16 +0000[diff] [blame]152
Chad Rosier2270b002012-02-26 22:12:59 +0000[diff] [blame]153 <li>Configure and build LLVM and Clang:
154 <ul>
Misha Brukman20b8a6562005-02-03 22:25:23 +0000[diff] [blame]155 <li><tt>cd <i>where-you-want-to-build-llvm</i></tt></li>
Chad Rosier2270b002012-02-26 22:12:59 +0000[diff] [blame]156 <li><tt>mkdir build</tt> (for building without polluting the source dir)</li>
157 <li><tt>cd build</tt></li>
158 <li><tt>../llvm/configure [options]</tt></li>
Misha Brukman20b8a6562005-02-03 22:25:23 +0000[diff] [blame]159 Some common options:
160
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]161 <ul>
Chad Rosier2270b002012-02-26 22:12:59 +0000[diff] [blame]162 <li><tt>--prefix=<i>directory</i></tt> -
163 Specify for <i>directory</i> the full pathname of where you
Misha Brukman20b8a6562005-02-03 22:25:23 +0000[diff] [blame]164 want the LLVM tools and libraries to be installed (default
Chad Rosier2270b002012-02-26 22:12:59 +0000[diff] [blame]165 <tt>/usr/local</tt>).</li>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]166 </ul>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]167
Chad Rosier2270b002012-02-26 22:12:59 +0000[diff] [blame]168 <ul>
169 <li><tt>--enable-optimized</tt> -
170 Compile with optimizations enabled (default is NO).</li>
171 </ul>
172
173 <ul>
174 <li><tt>--enable-assertions</tt> -
175 Compile with assertion checks enabled (default is YES).</li>
176 </ul>
177
178 <li><tt>make [-j]</tt> - The -j specifies the number of jobs (commands) to
179 run simultaneously. This builds both LLVM and Clang for Debug+Asserts mode.
180 The --enabled-optimized configure option is used to specify a Release build.</li>
181 <li><tt>make check-all</tt> -
182 This run the regression tests to ensure everything is in working order.</li>
183 <li><tt>make update</tt> -
184 This command is used to update all the svn repositories at once, rather then
185 having to <tt>cd</tt> into the individual repositories and running
186 <tt>svn update</tt>.</li>
187 <li>It is also possible to use CMake instead of the makefiles. With CMake
188 it is also possible to generate project files for several IDEs: Eclipse
189 CDT4, CodeBlocks, Qt-Creator (use the CodeBlocks generator), KDevelop3.</li>
190 <li>If you get an "internal compiler error (ICE)" or test failures, see
191 <a href="#brokengcc">below</a>.</li>
192
193 </ul>
194 </li>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]195 </ol>
196
197</ol>
198
Chris Lattner53e5e2a2004-06-21 22:52:48 +0000[diff] [blame]199<p>Consult the <a href="#starting">Getting Started with LLVM</a> section for
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]200detailed information on configuring and compiling LLVM. See <a
201href="#environment">Setting Up Your Environment</a> for tips that simplify
Chad Rosierce50eec2012-02-26 22:26:37 +0000[diff] [blame]202working with the Clang front end and LLVM tools. Go to <a href="#layout">Program
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]203Layout</a> to learn about the layout of the source code tree.</p>
204
205</div>
206
207<!-- *********************************************************************** -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]208<h2>
209 <a name="requirements">Requirements</a>
210</h2>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]211<!-- *********************************************************************** -->
212
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]213<div>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]214
215<p>Before you begin to use the LLVM system, review the requirements given below.
216This may save you some trouble by knowing ahead of time what hardware and
217software you will need.</p>
218
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]219<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]220<h3>
221 <a name="hardware">Hardware</a>
222</h3>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]223
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]224<div>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]225
226<p>LLVM is known to work on the following platforms:</p>
227
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]228<table cellpadding="3" summary="Known LLVM platforms">
Misha Brukmanb0681672004-11-15 05:19:53 +0000[diff] [blame]229<tr>
230 <th>OS</th>
231 <th>Arch</th>
Misha Brukman1ed0fa52004-11-19 21:53:22 +0000[diff] [blame]232 <th>Compilers</th>
Misha Brukmanb0681672004-11-15 05:19:53 +0000[diff] [blame]233</tr>
234<tr>
Chris Lattner6bad1372009-07-22 04:21:40 +0000[diff] [blame]235 <td>AuroraUX</td>
236 <td>x86<sup><a href="#pf_1">1</a></sup></td>
237 <td>GCC</td>
Chris Lattner3a56ae82009-07-21 22:47:03 +0000[diff] [blame]238</tr>
239<tr>
Misha Brukmanb0681672004-11-15 05:19:53 +0000[diff] [blame]240 <td>Linux</td>
Chris Lattnerac648f52005-02-09 21:15:51 +0000[diff] [blame]241 <td>x86<sup><a href="#pf_1">1</a></sup></td>
Misha Brukman1ed0fa52004-11-19 21:53:22 +0000[diff] [blame]242 <td>GCC</td>
Misha Brukmanb0681672004-11-15 05:19:53 +0000[diff] [blame]243</tr>
244<tr>
Edward O'Callaghanab8a04c2009-08-04 05:24:28 +0000[diff] [blame]245 <td>Linux</td>
246 <td>amd64</td>
247 <td>GCC</td>
248</tr>
249<tr>
Misha Brukmanb0681672004-11-15 05:19:53 +0000[diff] [blame]250 <td>Solaris</td>
251 <td>V9 (Ultrasparc)</td>
Misha Brukman1ed0fa52004-11-19 21:53:22 +0000[diff] [blame]252 <td>GCC</td>
Misha Brukmanb0681672004-11-15 05:19:53 +0000[diff] [blame]253</tr>
254<tr>
255 <td>FreeBSD</td>
Chris Lattnerac648f52005-02-09 21:15:51 +0000[diff] [blame]256 <td>x86<sup><a href="#pf_1">1</a></sup></td>
Misha Brukman1ed0fa52004-11-19 21:53:22 +0000[diff] [blame]257 <td>GCC</td>
Misha Brukmanb0681672004-11-15 05:19:53 +0000[diff] [blame]258</tr>
259<tr>
Bill Wendling5d32b702010-12-15 01:35:55 +0000[diff] [blame]260 <td>FreeBSD</td>
261 <td>amd64</td>
262 <td>GCC</td>
263</tr>
264<tr>
Chris Lattnerac648f52005-02-09 21:15:51 +0000[diff] [blame]265 <td>MacOS X<sup><a href="#pf_2">2</a></sup></td>
Misha Brukmanb0681672004-11-15 05:19:53 +0000[diff] [blame]266 <td>PowerPC</td>
Misha Brukman1ed0fa52004-11-19 21:53:22 +0000[diff] [blame]267 <td>GCC</td>
Misha Brukmanb0681672004-11-15 05:19:53 +0000[diff] [blame]268</tr>
269<tr>
Scott Michel4799ea72008-03-18 23:13:26 +0000[diff] [blame]270 <td>MacOS X<sup><a href="#pf_2">2</a>,<a href="#pf_9">9</a></sup></td>
Tanya Lattnerfb762912006-04-20 04:35:34 +0000[diff] [blame]271 <td>x86</td>
272 <td>GCC</td>
Tanya Lattnerfb762912006-04-20 04:35:34 +0000[diff] [blame]273</tr>
274<tr>
Misha Brukman1ed0fa52004-11-19 21:53:22 +0000[diff] [blame]275 <td>Cygwin/Win32</td>
Anton Korobeynikovd0a0bc32009-12-09 17:26:02 +0000[diff] [blame]276 <td>x86<sup><a href="#pf_1">1</a>,<a href="#pf_8">8</a>,
277 <a href="#pf_11">11</a></sup></td>
Anton Korobeynikov9e8baa52010-02-11 21:51:51 +0000[diff] [blame]278 <td>GCC 3.4.X, binutils 2.20</td>
Misha Brukman1ed0fa52004-11-19 21:53:22 +0000[diff] [blame]279</tr>
Misha Brukman5ac308f2004-12-23 07:14:56 +0000[diff] [blame]280<tr>
Chris Lattner093ffb02005-02-09 20:43:48 +0000[diff] [blame]281 <td>MinGW/Win32</td>
Anton Korobeynikovd4f00612009-08-06 12:54:58 +0000[diff] [blame]282 <td>x86<sup><a href="#pf_1">1</a>,<a href="#pf_6">6</a>,
NAKAMURA Takumi05c00022011-03-28 06:27:06 +0000[diff] [blame]283 <a href="#pf_8">8</a>, <a href="#pf_10">10</a>,
284 <a href="#pf_11">11</a></sup></td>
Anton Korobeynikov9e8baa52010-02-11 21:51:51 +0000[diff] [blame]285 <td>GCC 3.4.X, binutils 2.20</td>
Chris Lattner093ffb02005-02-09 20:43:48 +0000[diff] [blame]286</tr>
Misha Brukman1ed0fa52004-11-19 21:53:22 +0000[diff] [blame]287</table>
288
289<p>LLVM has partial support for the following platforms:</p>
290
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]291<table summary="LLVM partial platform support">
Misha Brukman1ed0fa52004-11-19 21:53:22 +0000[diff] [blame]292<tr>
293 <th>OS</th>
294 <th>Arch</th>
295 <th>Compilers</th>
Misha Brukmanb0681672004-11-15 05:19:53 +0000[diff] [blame]296</tr>
Misha Brukmandca72382004-11-15 21:05:08 +0000[diff] [blame]297<tr>
Misha Brukman1ed0fa52004-11-19 21:53:22 +0000[diff] [blame]298 <td>Windows</td>
Chris Lattnerac648f52005-02-09 21:15:51 +0000[diff] [blame]299 <td>x86<sup><a href="#pf_1">1</a></sup></td>
Chandler Carruthd1eafe12011-11-16 19:52:13 +0000[diff] [blame]300 <td>Visual Studio 2008 or higher<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]301<tr>
Chris Lattnerac648f52005-02-09 21:15:51 +0000[diff] [blame]302 <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]303 <td>PowerPC</td>
Misha Brukman1ed0fa52004-11-19 21:53:22 +0000[diff] [blame]304 <td>GCC</td>
305</tr>
306<tr>
Chris Lattnerac648f52005-02-09 21:15:51 +0000[diff] [blame]307 <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]308 <td>PowerPC</td>
309 <td>GCC</td>
Misha Brukmandca72382004-11-15 21:05:08 +0000[diff] [blame]310</tr>
John Criswell05990f32005-05-09 16:49:59 +0000[diff] [blame]311
312<tr>
313 <td>Linux<sup><a href="#pf_7">7</a></sup></td>
314 <td>Alpha</td>
315 <td>GCC</td>
316</tr>
317<tr>
318 <td>Linux<sup><a href="#pf_7">7</a></sup></td>
319 <td>Itanium (IA-64)</td>
320 <td>GCC</td>
321</tr>
Duraid Madina332b16a2005-05-10 06:57:53 +0000[diff] [blame]322<tr>
323 <td>HP-UX<sup><a href="#pf_7">7</a></sup></td>
324 <td>Itanium (IA-64)</td>
325 <td>HP aCC</td>
326</tr>
NAKAMURA Takumi10b96cb2011-03-28 06:27:12 +0000[diff] [blame]327<tr>
328 <td>Windows x64</td>
329 <td>x86-64</td>
330 <td>mingw-w64's GCC-4.5.x<sup><a href="#pf_12">12</a></sup></td>
331</tr>
Misha Brukmanb0681672004-11-15 05:19:53 +0000[diff] [blame]332</table>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]333
Misha Brukman77723092005-02-09 21:01:26 +0000[diff] [blame]334<p><b>Notes:</b></p>
335
Misha Brukman0c4b8b62005-02-09 22:38:47 +0000[diff] [blame]336<div class="doc_notes">
337<ol>
338<li><a name="pf_1">Code generation supported for Pentium processors and
339up</a></li>
340<li><a name="pf_2">Code generation supported for 32-bit ABI only</a></li>
341<li><a name="pf_3">No native code generation</a></li>
Nick Lewyckyd745ade2008-12-08 00:45:02 +0000[diff] [blame]342<li><a name="pf_4">Build is not complete: one or more tools do not link or function</a></li>
Misha Brukman0c4b8b62005-02-09 22:38:47 +0000[diff] [blame]343<li><a name="pf_5">The GCC-based C/C++ frontend does not build</a></li>
Chris Lattnerb7481cf2009-01-02 07:10:51 +0000[diff] [blame]344<li><a name="pf_6">The port is done using the MSYS shell.</a></li>
John Criswell05990f32005-05-09 16:49:59 +0000[diff] [blame]345<li><a name="pf_7">Native code generation exists but is not complete.</a></li>
Anton Korobeynikov9e8baa52010-02-11 21:51:51 +0000[diff] [blame]346<li><a name="pf_8">Binutils 2.20 or later is required to build the assembler
347 generated by LLVM properly.</a></li>
Chris Lattner26c74442008-11-09 17:19:14 +0000[diff] [blame]348<li><a name="pf_9">XCode 2.5 and gcc 4.0.1</a> (Apple Build 5370) will trip
Scott Michel4799ea72008-03-18 23:13:26 +0000[diff] [blame]349 internal LLVM assert messages when compiled for Release at optimization
Chris Lattner26c74442008-11-09 17:19:14 +0000[diff] [blame]350 levels greater than 0 (i.e., <i>"-O1"</i> and higher).
351 Add <i>OPTIMIZE_OPTION="-O0"</i> to the build command line
Scott Michel4799ea72008-03-18 23:13:26 +0000[diff] [blame]352 if compiling for LLVM Release or bootstrapping the LLVM toolchain.</li>
Anton Korobeynikovd4f00612009-08-06 12:54:58 +0000[diff] [blame]353<li><a name="pf_10">For MSYS/MinGW on Windows, be sure to install the MSYS
354 version of the perl package, and be sure it appears in your path
355 before any Windows-based versions such as Strawberry Perl and
356 ActivePerl, as these have Windows-specifics that will cause the
357 build to fail.</a></li>
NAKAMURA Takumi05c00022011-03-28 06:27:06 +0000[diff] [blame]358<li><a name="pf_11">To use LLVM modules on Win32-based system,
NAKAMURA Takumi6bd36d52011-04-09 09:51:57 +0000[diff] [blame]359 you may configure LLVM with <i>&quot;--enable-shared&quot;</i>.</a></li>
NAKAMURA Takumi10b96cb2011-03-28 06:27:12 +0000[diff] [blame]360<li><a name="pf_12">To compile SPU backend, you need to add
NAKAMURA Takumi6bd36d52011-04-09 09:51:57 +0000[diff] [blame]361 <tt>&quot;LDFLAGS=-Wl,--stack,16777216&quot;</tt> to configure.</a></li>
Misha Brukman77723092005-02-09 21:01:26 +0000[diff] [blame]362</ol>
Misha Brukman77723092005-02-09 21:01:26 +0000[diff] [blame]363</div>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]364
Misha Brukman1ed0fa52004-11-19 21:53:22 +0000[diff] [blame]365<p>Note that you will need about 1-3 GB of space for a full LLVM build in Debug
John Criswelle1a81202005-05-18 19:43:33 +0000[diff] [blame]366mode, depending on the system (it is so large because of all the debugging
367information and the fact that the libraries are statically linked into multiple
Chris Lattner0cb89772009-04-25 22:08:52 +0000[diff] [blame]368tools). If you do not need many of the tools and you are space-conscious, you
369can pass <tt>ONLY_TOOLS="tools you need"</tt> to make. The Release build
370requires considerably less space.</p>
Misha Brukman1ed0fa52004-11-19 21:53:22 +0000[diff] [blame]371
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]372<p>The LLVM suite <i>may</i> compile on other platforms, but it is not
373guaranteed to do so. If compilation is successful, the LLVM utilities should be
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]374able to assemble, disassemble, analyze, and optimize LLVM bitcode. Code
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]375generation should work as well, although the generated native code may not work
376on your platform.</p>
377
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]378</div>
379
380<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]381<h3>
382 <a name="software">Software</a>
383</h3>
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]384<div>
Reid Spencer38fcf302004-11-15 21:15:12 +0000[diff] [blame]385 <p>Compiling LLVM requires that you have several software packages
386 installed. The table below lists those required packages. The Package column
387 is the usual name for the software package that LLVM depends on. The Version
388 column provides "known to work" versions of the package. The Notes column
389 describes how LLVM uses the package and provides other details.</p>
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]390 <table summary="Packages required to compile LLVM">
Reid Spencer38fcf302004-11-15 21:15:12 +0000[diff] [blame]391 <tr><th>Package</th><th>Version</th><th>Notes</th></tr>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]392
Reid Spencer38fcf302004-11-15 21:15:12 +0000[diff] [blame]393 <tr>
394 <td><a href="http://savannah.gnu.org/projects/make">GNU Make</a></td>
395 <td>3.79, 3.79.1</td>
396 <td>Makefile/build processor</td>
397 </tr>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]398
Reid Spencer38fcf302004-11-15 21:15:12 +0000[diff] [blame]399 <tr>
NAKAMURA Takumica46f5a2011-04-09 02:13:37 +0000[diff] [blame]400 <td><a href="http://gcc.gnu.org/">GCC</a></td>
Reid Spencer38fcf302004-11-15 21:15:12 +0000[diff] [blame]401 <td>3.4.2</td>
Misha Brukman0c4b8b62005-02-09 22:38:47 +0000[diff] [blame]402 <td>C/C++ compiler<sup><a href="#sf1">1</a></sup></td>
Reid Spencer38fcf302004-11-15 21:15:12 +0000[diff] [blame]403 </tr>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]404
Reid Spencer38fcf302004-11-15 21:15:12 +0000[diff] [blame]405 <tr>
NAKAMURA Takumica46f5a2011-04-09 02:13:37 +0000[diff] [blame]406 <td><a href="http://www.gnu.org/software/texinfo/">TeXinfo</a></td>
Chris Lattnerf1705fd2005-09-06 04:07:15 +0000[diff] [blame]407 <td>4.5</td>
408 <td>For building the CFE</td>
409 </tr>
410
411 <tr>
John Criswell58594852007-06-29 19:12:31 +0000[diff] [blame]412 <td><a href="http://subversion.tigris.org/project_packages.html">SVN</a></td>
413 <td>&ge;1.3</td>
414 <td>Subversion access to LLVM<sup><a href="#sf2">2</a></sup></td>
Misha Brukman0c4b8b62005-02-09 22:38:47 +0000[diff] [blame]415 </tr>
416
NAKAMURA Takumif8e44c32011-04-05 08:24:15 +0000[diff] [blame]417 <!-- FIXME:
418 Do we support dg?
419 Are DejaGnu and expect obsolete?
420 Shall we mention Python? -->
421
Misha Brukman0c4b8b62005-02-09 22:38:47 +0000[diff] [blame]422 <tr>
Reid Spencer38fcf302004-11-15 21:15:12 +0000[diff] [blame]423 <td><a href="http://savannah.gnu.org/projects/dejagnu">DejaGnu</a></td>
424 <td>1.4.2</td>
Misha Brukman0c4b8b62005-02-09 22:38:47 +0000[diff] [blame]425 <td>Automated test suite<sup><a href="#sf3">3</a></sup></td>
Reid Spencer38fcf302004-11-15 21:15:12 +0000[diff] [blame]426 </tr>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]427
Reid Spencer38fcf302004-11-15 21:15:12 +0000[diff] [blame]428 <tr>
429 <td><a href="http://www.tcl.tk/software/tcltk/">tcl</a></td>
430 <td>8.3, 8.4</td>
Misha Brukman0c4b8b62005-02-09 22:38:47 +0000[diff] [blame]431 <td>Automated test suite<sup><a href="#sf3">3</a></sup></td>
Reid Spencer38fcf302004-11-15 21:15:12 +0000[diff] [blame]432 </tr>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]433
Reid Spencer38fcf302004-11-15 21:15:12 +0000[diff] [blame]434 <tr>
435 <td><a href="http://expect.nist.gov/">expect</a></td>
436 <td>5.38.0</td>
Misha Brukman0c4b8b62005-02-09 22:38:47 +0000[diff] [blame]437 <td>Automated test suite<sup><a href="#sf3">3</a></sup></td>
Reid Spencer38fcf302004-11-15 21:15:12 +0000[diff] [blame]438 </tr>
439
440 <tr>
441 <td><a href="http://www.perl.com/download.csp">perl</a></td>
Reid Spencer098fce42004-12-09 17:55:37 +0000[diff] [blame]442 <td>&ge;5.6.0</td>
Daniel Dunbar06b68122012-02-15 19:24:11 +0000[diff] [blame]443 <td>Utilities</td>
Reid Spencer38fcf302004-11-15 21:15:12 +0000[diff] [blame]444 </tr>
445
446 <tr>
Misha Brukman0c4b8b62005-02-09 22:38:47 +0000[diff] [blame]447 <td><a href="http://savannah.gnu.org/projects/m4">GNU M4</a>
448 <td>1.4</td>
449 <td>Macro processor for configuration<sup><a href="#sf4">4</a></sup></td>
Reid Spencer38fcf302004-11-15 21:15:12 +0000[diff] [blame]450 </tr>
451
452 <tr>
NAKAMURA Takumica46f5a2011-04-09 02:13:37 +0000[diff] [blame]453 <td><a href="http://www.gnu.org/software/autoconf/">GNU Autoconf</a></td>
Nick Lewyckyf32f6982009-09-27 04:56:27 +0000[diff] [blame]454 <td>2.60</td>
Misha Brukman0c4b8b62005-02-09 22:38:47 +0000[diff] [blame]455 <td>Configuration script builder<sup><a href="#sf4">4</a></sup></td>
456 </tr>
457
458 <tr>
NAKAMURA Takumica46f5a2011-04-09 02:13:37 +0000[diff] [blame]459 <td><a href="http://www.gnu.org/software/automake/">GNU Automake</a></td>
Nick Lewyckyf32f6982009-09-27 04:56:27 +0000[diff] [blame]460 <td>1.9.6</td>
Misha Brukman0c4b8b62005-02-09 22:38:47 +0000[diff] [blame]461 <td>aclocal macro generator<sup><a href="#sf4">4</a></sup></td>
462 </tr>
463
464 <tr>
465 <td><a href="http://savannah.gnu.org/projects/libtool">libtool</a></td>
Nick Lewyckyf32f6982009-09-27 04:56:27 +0000[diff] [blame]466 <td>1.5.22</td>
Misha Brukman0c4b8b62005-02-09 22:38:47 +0000[diff] [blame]467 <td>Shared library manager<sup><a href="#sf4">4</a></sup></td>
Reid Spencer38fcf302004-11-15 21:15:12 +0000[diff] [blame]468 </tr>
469
470 </table>
471
Misha Brukman0c4b8b62005-02-09 22:38:47 +0000[diff] [blame]472 <p><b>Notes:</b></p>
473 <div class="doc_notes">
Reid Spencer38fcf302004-11-15 21:15:12 +0000[diff] [blame]474 <ol>
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]475 <li><a name="sf1">Only the C and C++ languages are needed so there's no
Misha Brukman0c4b8b62005-02-09 22:38:47 +0000[diff] [blame]476 need to build the other languages for LLVM's purposes.</a> See
477 <a href="#brokengcc">below</a> for specific version info.</li>
John Criswell58594852007-06-29 19:12:31 +0000[diff] [blame]478 <li><a name="sf2">You only need Subversion if you intend to build from the
Misha Brukman0c4b8b62005-02-09 22:38:47 +0000[diff] [blame]479 latest LLVM sources. If you're working from a release distribution, you
John Criswell58594852007-06-29 19:12:31 +0000[diff] [blame]480 don't need Subversion.</a></li>
Misha Brukman0c4b8b62005-02-09 22:38:47 +0000[diff] [blame]481 <li><a name="sf3">Only needed if you want to run the automated test
482 suite in the <tt>llvm/test</tt> directory.</a></li>
483 <li><a name="sf4">If you want to make changes to the configure scripts,
Tobias Grosser4518c862010-05-19 07:00:17 +0000[diff] [blame]484 you will need GNU autoconf (2.60), and consequently, GNU M4 (version 1.4
485 or higher). You will also need automake (1.9.6). We only use aclocal
Reid Spencer098fce42004-12-09 17:55:37 +0000[diff] [blame]486 from that package.</a></li>
Reid Spencer38fcf302004-11-15 21:15:12 +0000[diff] [blame]487 </ol>
Misha Brukman0c4b8b62005-02-09 22:38:47 +0000[diff] [blame]488 </div>
489
Reid Spencer38fcf302004-11-15 21:15:12 +0000[diff] [blame]490 <p>Additionally, your compilation host is expected to have the usual
491 plethora of Unix utilities. Specifically:</p>
492 <ul>
493 <li><b>ar</b> - archive library builder</li>
494 <li><b>bzip2*</b> - bzip2 command for distribution generation</li>
495 <li><b>bunzip2*</b> - bunzip2 command for distribution checking</li>
496 <li><b>chmod</b> - change permissions on a file</li>
John Criswell33e0f062004-12-08 16:55:27 +0000[diff] [blame]497 <li><b>cat</b> - output concatenation utility</li>
Reid Spencer38fcf302004-11-15 21:15:12 +0000[diff] [blame]498 <li><b>cp</b> - copy files</li>
499 <li><b>date</b> - print the current date/time </li>
500 <li><b>echo</b> - print to standard output</li>
501 <li><b>egrep</b> - extended regular expression search utility</li>
Reid Spencer38fcf302004-11-15 21:15:12 +0000[diff] [blame]502 <li><b>find</b> - find files/dirs in a file system</li>
503 <li><b>grep</b> - regular expression search utility</li>
504 <li><b>gzip*</b> - gzip command for distribution generation</li>
505 <li><b>gunzip*</b> - gunzip command for distribution checking</li>
506 <li><b>install</b> - install directories/files </li>
507 <li><b>mkdir</b> - create a directory</li>
508 <li><b>mv</b> - move (rename) files</li>
509 <li><b>ranlib</b> - symbol table builder for archive libraries</li>
Misha Brukman29d3d462004-11-20 01:27:40 +0000[diff] [blame]510 <li><b>rm</b> - remove (delete) files and directories</li>
Reid Spencer38fcf302004-11-15 21:15:12 +0000[diff] [blame]511 <li><b>sed</b> - stream editor for transforming output</li>
512 <li><b>sh</b> - Bourne shell for make build scripts</li>
513 <li><b>tar</b> - tape archive for distribution generation</li>
514 <li><b>test</b> - test things in file system</li>
515 <li><b>unzip*</b> - unzip command for distribution checking</li>
516 <li><b>zip*</b> - zip command for distribution generation</li>
517 </ul>
Chris Lattnere0050f02004-07-18 22:32:22 +0000[diff] [blame]518</div>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]519
Chris Lattnere0050f02004-07-18 22:32:22 +0000[diff] [blame]520<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]521<h3>
Chris Lattner55514822007-06-19 05:52:36 +0000[diff] [blame]522 <a name="brokengcc">Broken versions of GCC and other tools</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]523</h3>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]524
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]525<div>
Chris Lattnere0050f02004-07-18 22:32:22 +0000[diff] [blame]526
527<p>LLVM is very demanding of the host C++ compiler, and as such tends to expose
528bugs in the compiler. In particular, several versions of GCC crash when trying
Ted Kremenekaff36402011-10-31 21:23:15 +0000[diff] [blame]529to compile LLVM. We routinely use GCC 4.2 (and higher) or Clang.
530Other versions of GCC will probably work as well. GCC versions listed
Chris Lattnere0050f02004-07-18 22:32:22 +0000[diff] [blame]531here are known to not work. If you are using one of these versions, please try
532to upgrade your GCC to something more recent. If you run into a problem with a
533version of GCC not listed here, please <a href="mailto:llvmdev@cs.uiuc.edu">let
534us know</a>. Please use the "<tt>gcc -v</tt>" command to find out which version
535of GCC you are using.
536</p>
537
538<p><b>GCC versions prior to 3.0</b>: GCC 2.96.x and before had several
539problems in the STL that effectively prevent it from compiling LLVM.
540</p>
541
Chris Lattner419df4e2008-02-13 17:50:24 +0000[diff] [blame]542<p><b>GCC 3.2.2 and 3.2.3</b>: These versions of GCC fails to compile LLVM with
543a bogus template error. This was fixed in later GCCs.</p>
John Criswellfd769452004-11-23 22:06:24 +0000[diff] [blame]544
Chris Lattnere0050f02004-07-18 22:32:22 +0000[diff] [blame]545<p><b>GCC 3.3.2</b>: This version of GCC suffered from a <a
546href="http://gcc.gnu.org/PR13392">serious bug</a> which causes it to crash in
547the "<tt>convert_from_eh_region_ranges_1</tt>" GCC function.</p>
Chris Lattnere254e2f2005-02-12 20:11:13 +0000[diff] [blame]548
Chris Lattner58247622005-02-13 22:20:49 +0000[diff] [blame]549<p><b>Cygwin GCC 3.3.3</b>: The version of GCC 3.3.3 commonly shipped with
Chad Rosierce50eec2012-02-26 22:26:37 +0000[diff] [blame]550 Cygwin does not work.</p>
Chris Lattner58247622005-02-13 22:20:49 +0000[diff] [blame]551<p><b>SuSE GCC 3.3.3</b>: The version of GCC 3.3.3 shipped with SuSE 9.1 (and
552 possibly others) does not compile LLVM correctly (it appears that exception
553 handling is broken in some cases). Please download the FSF 3.3.3 or upgrade
554 to a newer version of GCC.</p>
Bill Wendlinga5d30d52007-07-16 08:52:56 +0000[diff] [blame]555<p><b>GCC 3.4.0 on linux/x86 (32-bit)</b>: GCC miscompiles portions of the
Chris Lattner3d82dcf2007-05-10 06:42:21 +0000[diff] [blame]556 code generator, causing an infinite loop in the llvm-gcc build when built
557 with optimizations enabled (i.e. a release build).</p>
Bill Wendlinga5d30d52007-07-16 08:52:56 +0000[diff] [blame]558<p><b>GCC 3.4.2 on linux/x86 (32-bit)</b>: GCC miscompiles portions of the
Chris Lattner3d82dcf2007-05-10 06:42:21 +0000[diff] [blame]559 code generator at -O3, as with 3.4.0. However gcc 3.4.2 (unlike 3.4.0)
560 correctly compiles LLVM at -O2. A work around is to build release LLVM
561 builds with "make ENABLE_OPTIMIZED=1 OPTIMIZE_OPTION=-O2 ..."</p>
Bill Wendlinga5d30d52007-07-16 08:52:56 +0000[diff] [blame]562<p><b>GCC 3.4.x on X86-64/amd64</b>: GCC <a href="http://llvm.org/PR1056">
Chris Lattner489ad332007-04-01 20:14:46 +0000[diff] [blame]563 miscompiles portions of LLVM</a>.</p>
Chris Lattner059a8df2007-11-01 04:20:16 +0000[diff] [blame]564<p><b>GCC 3.4.4 (CodeSourcery ARM 2005q3-2)</b>: this compiler miscompiles LLVM
565 when building with optimizations enabled. It appears to work with
566 "<tt>make ENABLE_OPTIMIZED=1 OPTIMIZE_OPTION=-O1</tt>" or build a debug
567 build.</p>
Chris Lattner7caf6f62005-05-15 22:26:45 +0000[diff] [blame]568<p><b>IA-64 GCC 4.0.0</b>: The IA-64 version of GCC 4.0.0 is known to
569 miscompile LLVM.</p>
Chris Lattnerc9ede192006-06-16 19:53:39 +0000[diff] [blame]570<p><b>Apple Xcode 2.3</b>: GCC crashes when compiling LLVM at -O3 (which is the
571 default with ENABLE_OPTIMIZED=1. To work around this, build with
572 "ENABLE_OPTIMIZED=1 OPTIMIZE_OPTION=-O2".</p>
Chris Lattneraa64b942006-09-07 17:34:27 +0000[diff] [blame]573<p><b>GCC 4.1.1</b>: GCC fails to build LLVM with template concept check errors
574 compiling some files. At the time of this writing, GCC mainline (4.2)
575 did not share the problem.</p>
Chris Lattner13ce9182007-01-04 07:06:05 +0000[diff] [blame]576<p><b>GCC 4.1.1 on X86-64/amd64</b>: GCC <a href="http://llvm.org/PR1063">
577 miscompiles portions of LLVM</a> when compiling llvm itself into 64-bit
578 code. LLVM will appear to mostly work but will be buggy, e.g. failing
579 portions of its testsuite.</p>
Reid Spencera28d6622007-04-11 21:28:31 +0000[diff] [blame]580<p><b>GCC 4.1.2 on OpenSUSE</b>: Seg faults during libstdc++ build and on x86_64
581platforms compiling md5.c gets a mangled constant.</p>
Daniel Dunbar2a575452008-10-11 18:40:33 +0000[diff] [blame]582<p><b>GCC 4.1.2 (20061115 (prerelease) (Debian 4.1.1-21)) on Debian</b>: Appears
583to miscompile parts of LLVM 2.4. One symptom is ValueSymbolTable complaining
584about symbols remaining in the table on destruction.</p>
Nuno Lopes94993852008-12-10 16:11:10 +0000[diff] [blame]585<p><b>GCC 4.1.2 20071124 (Red Hat 4.1.2-42)</b>: Suffers from the same symptoms
Nuno Lopes65e877e2008-12-10 16:01:22 +0000[diff] [blame]586as the previous one. It appears to work with ENABLE_OPTIMIZED=0 (the default).</p>
Anton Korobeynikovdad58712009-05-04 10:24:46 +0000[diff] [blame]587<p><b>Cygwin GCC 4.3.2 20080827 (beta) 2</b>:
588 Users <a href="http://llvm.org/PR4145">reported</a> various problems related
589 with link errors when using this GCC version.</p>
Chris Lattnereba6c722009-09-10 16:25:02 +0000[diff] [blame]590<p><b>Debian GCC 4.3.2 on X86</b>: Crashes building some files in LLVM 2.6.</p>
Nick Lewyckyd562ab12009-07-17 06:32:10 +0000[diff] [blame]591<p><b>GCC 4.3.3 (Debian 4.3.3-10) on ARM</b>: Miscompiles parts of LLVM 2.6
592when optimizations are turned on. The symptom is an infinite loop in
Chris Lattnereba6c722009-09-10 16:25:02 +0000[diff] [blame]593FoldingSetImpl::RemoveNode while running the code generator.</p>
Nick Lewyckyabe8c132010-10-07 22:30:47 +0000[diff] [blame]594<p><b>GCC 4.3.5 and GCC 4.4.5 on ARM</b>: These can miscompile <tt>value >>
5951</tt> even at -O0. A test failure in <tt>test/Assembler/alignstack.ll</tt> is
596one symptom of the problem.
Reid Spencer6291ddc2006-11-04 00:33:42 +0000[diff] [blame]597<p><b>GNU ld 2.16.X</b>. Some 2.16.X versions of the ld linker will produce very
598long warning messages complaining that some ".gnu.linkonce.t.*" symbol was
599defined in a discarded section. You can safely ignore these messages as they are
600erroneous and the linkage is correct. These messages disappear using ld
6012.17.</p>
Chris Lattner55514822007-06-19 05:52:36 +0000[diff] [blame]602
603<p><b>GNU binutils 2.17</b>: Binutils 2.17 contains <a
604href="http://sourceware.org/bugzilla/show_bug.cgi?id=3111">a bug</a> which
605causes huge link times (minutes instead of seconds) when building LLVM. We
606recommend upgrading to a newer version (2.17.50.0.4 or later).</p>
607
Nick Lewycky79a6fe92009-03-03 05:41:16 +0000[diff] [blame]608<p><b>GNU Binutils 2.19.1 Gold</b>: This version of Gold contained
Nick Lewycky2db07612009-02-25 06:29:47 +0000[diff] [blame]609<a href="http://sourceware.org/bugzilla/show_bug.cgi?id=9836">a bug</a>
610which causes intermittent failures when building LLVM with position independent
Nick Lewycky79a6fe92009-03-03 05:41:16 +0000[diff] [blame]611code. The symptom is an error about cyclic dependencies. We recommend
612upgrading to a newer version of Gold.</p>
Nick Lewycky2db07612009-02-25 06:29:47 +0000[diff] [blame]613
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]614</div>
615
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]616</div>
Chris Lattnere0050f02004-07-18 22:32:22 +0000[diff] [blame]617
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]618<!-- *********************************************************************** -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]619<h2>
620 <a name="starting">Getting Started with LLVM</a>
621</h2>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]622<!-- *********************************************************************** -->
623
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]624<div>
Chris Lattnere0050f02004-07-18 22:32:22 +0000[diff] [blame]625
626<p>The remainder of this guide is meant to get you up and running with
627LLVM and to give you some basic information about the LLVM environment.</p>
628
629<p>The later sections of this guide describe the <a
630href="#layout">general layout</a> of the the LLVM source tree, a <a
631href="#tutorial">simple example</a> using the LLVM tool chain, and <a
632href="#links">links</a> to find more information about LLVM or to get
633help via e-mail.</p>
Chris Lattnere0050f02004-07-18 22:32:22 +0000[diff] [blame]634
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]635<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]636<h3>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]637 <a name="terminology">Terminology and Notation</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]638</h3>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]639
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]640<div>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]641
642<p>Throughout this manual, the following names are used to denote paths
643specific to the local system and working environment. <i>These are not
644environment variables you need to set but just strings used in the rest
645of this document below</i>. In any of the examples below, simply replace
646each of these names with the appropriate pathname on your local system.
647All these paths are absolute:</p>
648
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]649<dl>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]650 <dt>SRC_ROOT
651 <dd>
652 This is the top level directory of the LLVM source tree.
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]653 <br><br>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]654
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]655 <dt>OBJ_ROOT
656 <dd>
657 This is the top level directory of the LLVM object tree (i.e. the
658 tree where object files and compiled programs will be placed. It
659 can be the same as SRC_ROOT).
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]660 <br><br>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]661
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]662</dl>
663
664</div>
665
666<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]667<h3>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]668 <a name="environment">Setting Up Your Environment</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]669</h3>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]670
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]671<div>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]672
673<p>
Misha Brukmancd673252005-02-03 18:28:08 +0000[diff] [blame]674In order to compile and use LLVM, you may need to set some environment
675variables.
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]676
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]677<dl>
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]678 <dt><tt>LLVM_LIB_SEARCH_PATH</tt>=<tt>/path/to/your/bitcode/libs</tt></dt>
Misha Brukmancd673252005-02-03 18:28:08 +0000[diff] [blame]679 <dd>[Optional] This environment variable helps LLVM linking tools find the
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]680 locations of your bitcode libraries. It is provided only as a
Misha Brukmancd673252005-02-03 18:28:08 +0000[diff] [blame]681 convenience since you can specify the paths using the -L options of the
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]682 tools and the C/C++ front-end will automatically use the bitcode files
John Criswelle1a81202005-05-18 19:43:33 +0000[diff] [blame]683 installed in its
Misha Brukmancd673252005-02-03 18:28:08 +0000[diff] [blame]684 <tt>lib</tt> directory.</dd>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]685</dl>
686
687</div>
688
689<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]690<h3>
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]691 <a name="unpack">Unpacking the LLVM Archives</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]692</h3>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]693
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]694<div>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]695
696<p>
697If you have the LLVM distribution, you will need to unpack it before you
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]698can 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]699suite and the LLVM GCC front end compiled for your platform. There is an
700additional test suite that is optional. Each file is a TAR archive that is
701compressed with the gzip program.
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]702</p>
703
Misha Brukmand4528ea2005-02-02 18:01:57 +0000[diff] [blame]704<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]705<dl>
Misha Brukmand4528ea2005-02-02 18:01:57 +0000[diff] [blame]706 <dt><tt>llvm-x.y.tar.gz</tt></dt>
Misha Brukman21a63702008-12-11 18:23:24 +0000[diff] [blame]707 <dd>Source release for the LLVM libraries and tools.<br></dd>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]708
Misha Brukmand4528ea2005-02-02 18:01:57 +0000[diff] [blame]709 <dt><tt>llvm-test-x.y.tar.gz</tt></dt>
Andrew Trick68aa18e42010-09-23 20:26:44 +0000[diff] [blame]710 <dd>Source release for the LLVM test-suite.</dd>
Misha Brukmanc3184442004-11-23 19:26:24 +0000[diff] [blame]711
Misha Brukman4050d152008-12-29 19:38:58 +0000[diff] [blame]712 <dt><tt>llvm-gcc-4.2-x.y.source.tar.gz</tt></dt>
713 <dd>Source release of the llvm-gcc-4.2 front end. See README.LLVM in the root
Misha Brukman21a63702008-12-11 18:23:24 +0000[diff] [blame]714 directory for build instructions.<br></dd>
Chris Lattner499abb52006-04-20 05:08:23 +0000[diff] [blame]715
Misha Brukman4050d152008-12-29 19:38:58 +0000[diff] [blame]716 <dt><tt>llvm-gcc-4.2-x.y-platform.tar.gz</tt></dt>
717 <dd>Binary release of the llvm-gcc-4.2 front end for a specific platform.<br></dd>
Chris Lattner499abb52006-04-20 05:08:23 +0000[diff] [blame]718
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]719</dl>
720
721</div>
722
723<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]724<h3>
John Criswell58594852007-06-29 19:12:31 +0000[diff] [blame]725 <a name="checkout">Checkout LLVM from Subversion</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]726</h3>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]727
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]728<div>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]729
John Criswell58594852007-06-29 19:12:31 +0000[diff] [blame]730<p>If you have access to our Subversion repository, you can get a fresh copy of
Chris Lattner1c1595f2009-04-25 22:24:49 +0000[diff] [blame]731the entire source code. All you need to do is check it out from Subversion as
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]732follows:</p>
733
734<ul>
John Criswell58594852007-06-29 19:12:31 +0000[diff] [blame]735 <li><tt>cd <i>where-you-want-llvm-to-live</i></tt></li>
Anton Korobeynikov4c04a93332007-06-29 20:56:49 +0000[diff] [blame]736 <li>Read-Only: <tt>svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm</tt></li>
737 <li>Read-Write:<tt>svn co https://user@llvm.org/svn/llvm-project/llvm/trunk
John Criswell58594852007-06-29 19:12:31 +0000[diff] [blame]738 llvm</tt></li>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]739</ul>
740
John Criswell58594852007-06-29 19:12:31 +0000[diff] [blame]741
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]742<p>This will create an '<tt>llvm</tt>' directory in the current
743directory and fully populate it with the LLVM source code, Makefiles,
744test directories, and local copies of documentation files.</p>
745
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]746<p>If you want to get a specific release (as opposed to the most recent
Anton Korobeynikoveaa836b2007-06-29 23:13:42 +0000[diff] [blame]747revision), you can checkout it from the '<tt>tags</tt>' directory (instead of
Anton Korobeynikov09ca62d2007-06-30 00:00:57 +0000[diff] [blame]748'<tt>trunk</tt>'). The following releases are located in the following
Misha Brukman52757bf2008-12-17 16:27:23 +0000[diff] [blame]749subdirectories of the '<tt>tags</tt>' directory:</p>
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]750
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]751<ul>
Bill Wendlingdb624242011-04-04 23:42:51 +0000[diff] [blame]752<li>Release 2.9: <b>RELEASE_29/final</b></li>
Bill Wendlingc4735872010-10-06 23:50:30 +0000[diff] [blame]753<li>Release 2.8: <b>RELEASE_28</b></li>
Tanya Lattner3d7ec7b2010-10-06 05:36:01 +0000[diff] [blame]754<li>Release 2.7: <b>RELEASE_27</b></li>
Tanya Lattner9d3ba88b2009-10-23 06:20:06 +0000[diff] [blame]755<li>Release 2.6: <b>RELEASE_26</b></li>
Chris Lattner1c1595f2009-04-25 22:24:49 +0000[diff] [blame]756<li>Release 2.5: <b>RELEASE_25</b></li>
Misha Brukman52757bf2008-12-17 16:27:23 +0000[diff] [blame]757<li>Release 2.4: <b>RELEASE_24</b></li>
Tanya Lattner610e89d2008-06-09 06:02:09 +0000[diff] [blame]758<li>Release 2.3: <b>RELEASE_23</b></li>
Tanya Lattner779593c2008-02-12 02:42:55 +0000[diff] [blame]759<li>Release 2.2: <b>RELEASE_22</b></li>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]760<li>Release 2.1: <b>RELEASE_21</b></li>
Tanya Lattnere94a09e2007-05-22 06:06:22 +0000[diff] [blame]761<li>Release 2.0: <b>RELEASE_20</b></li>
Tanya Lattner84252ca2006-11-20 06:07:10 +0000[diff] [blame]762<li>Release 1.9: <b>RELEASE_19</b></li>
Tanya Lattnerda2d1e22006-11-20 06:04:46 +0000[diff] [blame]763<li>Release 1.8: <b>RELEASE_18</b></li>
Tanya Lattnerfb762912006-04-20 04:35:34 +0000[diff] [blame]764<li>Release 1.7: <b>RELEASE_17</b></li>
John Criswell3bdbd302005-11-08 21:11:33 +0000[diff] [blame]765<li>Release 1.6: <b>RELEASE_16</b></li>
John Criswell05990f32005-05-09 16:49:59 +0000[diff] [blame]766<li>Release 1.5: <b>RELEASE_15</b></li>
Reid Spencerdfcf7902004-12-08 16:51:31 +0000[diff] [blame]767<li>Release 1.4: <b>RELEASE_14</b></li>
John Criswell1e87b972004-08-16 14:51:33 +0000[diff] [blame]768<li>Release 1.3: <b>RELEASE_13</b></li>
Misha Brukmanc1aac032004-05-12 19:25:59 +0000[diff] [blame]769<li>Release 1.2: <b>RELEASE_12</b></li>
770<li>Release 1.1: <b>RELEASE_11</b></li>
771<li>Release 1.0: <b>RELEASE_1</b></li>
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]772</ul>
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]773
Reid Spencerdfcf7902004-12-08 16:51:31 +0000[diff] [blame]774<p>If you would like to get the LLVM test suite (a separate package as of 1.4),
John Criswell58594852007-06-29 19:12:31 +0000[diff] [blame]775you get it from the Subversion repository:</p>
Bill Wendlingbcb3b412007-07-16 08:44:39 +0000[diff] [blame]776
777<div class="doc_code">
Reid Spencerdfcf7902004-12-08 16:51:31 +0000[diff] [blame]778<pre>
Bill Wendlingbcb3b412007-07-16 08:44:39 +0000[diff] [blame]779% cd llvm/projects
Andrew Trick68aa18e42010-09-23 20:26:44 +0000[diff] [blame]780% svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite
Reid Spencerdfcf7902004-12-08 16:51:31 +0000[diff] [blame]781</pre>
Bill Wendlingbcb3b412007-07-16 08:44:39 +0000[diff] [blame]782</div>
783
Reid Spencerdfcf7902004-12-08 16:51:31 +0000[diff] [blame]784<p>By placing it in the <tt>llvm/projects</tt>, it will be automatically
John Criswell33e0f062004-12-08 16:55:27 +0000[diff] [blame]785configured by the LLVM configure script as well as automatically updated when
John Criswell58594852007-06-29 19:12:31 +0000[diff] [blame]786you run <tt>svn update</tt>.</p>
Reid Spencerdfcf7902004-12-08 16:51:31 +0000[diff] [blame]787
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]788</div>
789
790<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]791<h3>
Anton Korobeynikov3e956af2011-02-01 20:08:28 +0000[diff] [blame]792 <a name="git_mirror">GIT mirror</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]793</h3>
Anton Korobeynikov3e956af2011-02-01 20:08:28 +0000[diff] [blame]794
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]795<div>
Anton Korobeynikov3e956af2011-02-01 20:08:28 +0000[diff] [blame]796
797<p>GIT mirrors are available for a number of LLVM subprojects. These mirrors
798 sync automatically with each Subversion commit and contain all necessary
799 git-svn marks (so, you can recreate git-svn metadata locally). Note that right
800 now mirrors reflect only <tt>trunk</tt> for each project. You can do the
NAKAMURA Takumi6bd36d52011-04-09 09:51:57 +0000[diff] [blame]801 read-only GIT clone of LLVM via:</p>
802
NAKAMURA Takumi72c4af52011-07-20 23:37:51 +0000[diff] [blame]803<pre class="doc_code">
Jeffrey Yasskin532114e2011-07-19 00:20:54 +0000[diff] [blame]804git clone http://llvm.org/git/llvm.git
805</pre>
806
807<p>If you want to check out clang too, run:</p>
808
NAKAMURA Takumi72c4af52011-07-20 23:37:51 +0000[diff] [blame]809<pre class="doc_code">
Jeffrey Yasskin532114e2011-07-19 00:20:54 +0000[diff] [blame]810git clone http://llvm.org/git/llvm.git
811cd llvm/tools
812git clone http://llvm.org/git/clang.git
813</pre>
814
NAKAMURA Takumid92a5fe2011-08-12 07:48:01 +0000[diff] [blame]815<p>
816Since the upstream repository is in Subversion, you should use
817<tt>&quot;git pull --rebase&quot;</tt>
818instead of <tt>&quot;git pull&quot;</tt> to avoid generating a non-linear
819history in your clone.
820To configure <tt>&quot;git pull&quot;</tt> to pass <tt>--rebase</tt> by default
821on the master branch, run the following command:
822</p>
823
824<pre class="doc_code">
825git config branch.master.rebase true
826</pre>
827
NAKAMURA Takumi5dd41322011-08-12 07:48:06 +0000[diff] [blame]828<h4>Sending patches with Git</h4>
829<div>
830<p>
831Please read <a href="DeveloperPolicy.html#patches">Developer Policy</a>, too.
832</p>
833
834<p>
835Assume <tt>master</tt> points the upstream and <tt>mybranch</tt> points your
836working branch, and <tt>mybranch</tt> is rebased onto <tt>master</tt>.
837At first you may check sanity of whitespaces:
838</p>
839
840<pre class="doc_code">
841git diff --check master..mybranch
842</pre>
843
844<p>
845The easiest way to generate a patch is as below:
846</p>
847
848<pre class="doc_code">
849git diff master..mybranch &gt; /path/to/mybranch.diff
850</pre>
851
852<p>
853It is a little different from svn-generated diff. git-diff-generated diff has
854prefixes like <tt>a/</tt> and <tt>b/</tt>. Don't worry, most developers might
855know it could be accepted with <tt>patch -p1 -N</tt>.
856</p>
857
858<p>
859But you may generate patchset with git-format-patch. It generates
860by-each-commit patchset. To generate patch files to attach to your article:
861</p>
862
863<pre class="doc_code">
864git format-patch --no-attach master..mybranch -o /path/to/your/patchset
865</pre>
866
867<p>
868If you would like to send patches directly, you may use git-send-email or
869git-imap-send. Here is an example to generate the patchset in Gmail's [Drafts].
870</p>
871
872<pre class="doc_code">
873git format-patch --attach master..mybranch --stdout | git imap-send
874</pre>
875
876<p>
877Then, your .git/config should have [imap] sections.
878</p>
879
880<pre class="doc_code">
881[imap]
882 host = imaps://imap.gmail.com
883 user = <em>your.gmail.account</em>@gmail.com
884 pass = <em>himitsu!</em>
885 port = 993
886 sslverify = false
887; in English
888 folder = "[Gmail]/Drafts"
889; example for Japanese, "Modified UTF-7" encoded.
890 folder = "[Gmail]/&amp;Tgtm+DBN-"
NAKAMURA Takumia61f0cc2011-11-06 06:51:58 +0000[diff] [blame]891; example for Traditional Chinese
892 folder = "[Gmail]/&amp;g0l6Pw-"
NAKAMURA Takumi5dd41322011-08-12 07:48:06 +0000[diff] [blame]893</pre>
894
895</div>
896
NAKAMURA Takumid9b1c6e2011-08-12 07:47:55 +0000[diff] [blame]897<h4>For developers to work with git-svn</h4>
898<div>
899
Jeffrey Yasskin532114e2011-07-19 00:20:54 +0000[diff] [blame]900<p>To set up clone from which you can submit code using
901 <tt>git-svn</tt>, run:</p>
902
NAKAMURA Takumi72c4af52011-07-20 23:37:51 +0000[diff] [blame]903<pre class="doc_code">
NAKAMURA Takumi5d2a7322011-07-20 22:58:28 +0000[diff] [blame]904git clone http://llvm.org/git/llvm.git
Jeffrey Yasskin532114e2011-07-19 00:20:54 +0000[diff] [blame]905cd llvm
906git svn init https://llvm.org/svn/llvm-project/llvm/trunk --username=&lt;username>
907git config svn-remote.svn.fetch :refs/remotes/origin/master
908git svn rebase -l # -l avoids fetching ahead of the git mirror.
909
910# If you have clang too:
911cd tools
NAKAMURA Takumi5d2a7322011-07-20 22:58:28 +0000[diff] [blame]912git clone http://llvm.org/git/clang.git
Jeffrey Yasskin532114e2011-07-19 00:20:54 +0000[diff] [blame]913cd clang
914git svn init https://llvm.org/svn/llvm-project/cfe/trunk --username=&lt;username>
915git config svn-remote.svn.fetch :refs/remotes/origin/master
916git svn rebase -l
917</pre>
918
919<p>To update this clone without generating git-svn tags that conflict
920with the upstream git repo, run:</p>
921
NAKAMURA Takumi72c4af52011-07-20 23:37:51 +0000[diff] [blame]922<pre class="doc_code">
Jeffrey Yasskin532114e2011-07-19 00:20:54 +0000[diff] [blame]923git fetch && (cd tools/clang && git fetch) # Get matching revisions of both trees.
924git checkout master
925git svn rebase -l
926(cd tools/clang &&
927 git checkout master &&
928 git svn rebase -l)
929</pre>
930
931<p>This leaves your working directories on their master branches, so
932you'll need to <tt>checkout</tt> each working branch individually and
933<tt>rebase</tt> it on top of its parent branch. (Note: This script is
934intended for relative newbies to git. If you have more experience,
935you can likely improve on it.)</p>
936
937<p>The git-svn metadata can get out of sync after you mess around with
938branches and <code>dcommit</code>. When that happens, <code>git svn
939dcommit</code> stops working, complaining about files with uncommitted
940changes. The fix is to rebuild the metadata:</p>
941
NAKAMURA Takumi72c4af52011-07-20 23:37:51 +0000[diff] [blame]942<pre class="doc_code">
Jeffrey Yasskin532114e2011-07-19 00:20:54 +0000[diff] [blame]943rm -rf .git/svn
944git svn rebase -l
Anton Korobeynikov3e956af2011-02-01 20:08:28 +0000[diff] [blame]945</pre>
Anton Korobeynikov3e956af2011-02-01 20:08:28 +0000[diff] [blame]946
947</div>
948
NAKAMURA Takumid9b1c6e2011-08-12 07:47:55 +0000[diff] [blame]949</div>
950
Anton Korobeynikov3e956af2011-02-01 20:08:28 +0000[diff] [blame]951<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]952<h3>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]953 <a name="config">Local LLVM Configuration</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]954</h3>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]955
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]956<div>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]957
John Criswell58594852007-06-29 19:12:31 +0000[diff] [blame]958 <p>Once checked out from the Subversion repository, the LLVM suite source
959 code must be
Reid Spencerdfcf7902004-12-08 16:51:31 +0000[diff] [blame]960configured via the <tt>configure</tt> script. This script sets variables in the
961various <tt>*.in</tt> files, most notably <tt>llvm/Makefile.config</tt> and
962<tt>llvm/include/Config/config.h</tt>. It also populates <i>OBJ_ROOT</i> with
963the Makefiles needed to begin building LLVM.</p>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]964
965<p>The following environment variables are used by the <tt>configure</tt>
966script to configure the build system:</p>
967
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]968<table summary="LLVM configure script environment variables">
Reid Spencerc3c4c4f2004-11-01 08:19:36 +0000[diff] [blame]969 <tr><th>Variable</th><th>Purpose</th></tr>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]970 <tr>
971 <td>CC</td>
972 <td>Tells <tt>configure</tt> which C compiler to use. By default,
973 <tt>configure</tt> will look for the first GCC C compiler in
974 <tt>PATH</tt>. Use this variable to override
975 <tt>configure</tt>'s default behavior.</td>
976 </tr>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]977 <tr>
978 <td>CXX</td>
979 <td>Tells <tt>configure</tt> which C++ compiler to use. By default,
980 <tt>configure</tt> will look for the first GCC C++ compiler in
981 <tt>PATH</tt>. Use this variable to override
982 <tt>configure</tt>'s default behavior.</td>
983 </tr>
984</table>
985
986<p>The following options can be used to set or enable LLVM specific options:</p>
987
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]988<dl>
Reid Spencerdfcf7902004-12-08 16:51:31 +0000[diff] [blame]989 <dt><i>--enable-optimized</i></dt>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]990 <dd>
Chris Lattner1c1595f2009-04-25 22:24:49 +0000[diff] [blame]991 Enables optimized compilation (debugging symbols are removed
992 and GCC optimization flags are enabled). Note that this is the default
993 setting if you are using the LLVM distribution. The default behavior
994 of an Subversion checkout is to use an unoptimized build (also known as a
995 debug build).
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]996 <br><br>
Reid Spencerdfcf7902004-12-08 16:51:31 +0000[diff] [blame]997 </dd>
Reid Spencer294adbb2005-12-21 03:46:45 +0000[diff] [blame]998 <dt><i>--enable-debug-runtime</i></dt>
999 <dd>
1000 Enables debug symbols in the runtime libraries. The default is to strip
1001 debug symbols from the runtime libraries.
1002 </dd>
Reid Spencerdfcf7902004-12-08 16:51:31 +0000[diff] [blame]1003 <dt><i>--enable-jit</i></dt>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1004 <dd>
John Criswell86a3a482003-12-18 16:43:17 +0000[diff] [blame]1005 Compile the Just In Time (JIT) compiler functionality. This is not
1006 available
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1007 on all platforms. The default is dependent on platform, so it is best
1008 to explicitly enable it if you want it.
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]1009 <br><br>
Reid Spencerdfcf7902004-12-08 16:51:31 +0000[diff] [blame]1010 </dd>
Reid Spencer1e195bd2005-04-22 17:58:03 +0000[diff] [blame]1011 <dt><i>--enable-targets=</i><tt>target-option</tt></dt>
1012 <dd>Controls which targets will be built and linked into llc. The default
1013 value for <tt>target_options</tt> is "all" which builds and links all
1014 available targets. The value "host-only" can be specified to build only a
1015 native compiler (no cross-compiler targets available). The "native" target is
1016 selected as the target of the build host. You can also specify a comma
1017 separated list of target names that you want available in llc. The target
Misha Brukman21a63702008-12-11 18:23:24 +0000[diff] [blame]1018 names use all lower case. The current set of targets is: <br>
Jia Liu5b6562f2012-02-10 04:58:24 +0000[diff] [blame]1019 <tt>arm, cbe, cpp, hexagon, mblaze, mips, mipsel, msp430, powerpc, ptx, sparc, spu, x86, x86_64, xcore</tt>.
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]1020 <br><br></dd>
Reid Spencerdfcf7902004-12-08 16:51:31 +0000[diff] [blame]1021 <dt><i>--enable-doxygen</i></dt>
1022 <dd>Look for the doxygen program and enable construction of doxygen based
1023 documentation from the source code. This is disabled by default because
1024 generating the documentation can take a long time and producess 100s of
1025 megabytes of output.</dd>
Anton Korobeynikovc7f9f3d2007-01-23 12:35:46 +0000[diff] [blame]1026 <dt><i>--with-udis86</i></dt>
1027 <dd>LLVM can use external disassembler library for various purposes (now it's
1028 used only for examining code produced by JIT). This option will enable usage
1029 of <a href="http://udis86.sourceforge.net/">udis86</a> x86 (both 32 and 64
1030 bits) disassembler library.</dd>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1031</dl>
1032
1033<p>To configure LLVM, follow these steps:</p>
1034
1035<ol>
Bill Wendlingbcb3b412007-07-16 08:44:39 +0000[diff] [blame]1036 <li><p>Change directory into the object root directory:</p>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]1037
Bill Wendlingbcb3b412007-07-16 08:44:39 +0000[diff] [blame]1038 <div class="doc_code"><pre>% cd <i>OBJ_ROOT</i></pre></div></li>
1039
1040 <li><p>Run the <tt>configure</tt> script located in the LLVM source
1041 tree:</p>
1042
1043 <div class="doc_code">
1044 <pre>% <i>SRC_ROOT</i>/configure --prefix=/install/path [other options]</pre>
1045 </div></li>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1046</ol>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1047
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1048</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1049
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1050<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1051<h3>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1052 <a name="compile">Compiling the LLVM Suite Source Code</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1053</h3>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1054
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]1055<div>
John Criswell71139f22003-07-08 20:35:59 +0000[diff] [blame]1056
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1057<p>Once you have configured LLVM, you can build it. There are three types of
1058builds:</p>
John Criswell71139f22003-07-08 20:35:59 +0000[diff] [blame]1059
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1060<dl>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1061 <dt>Debug Builds
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1062 <dd>
Chris Lattner1c1595f2009-04-25 22:24:49 +0000[diff] [blame]1063 These builds are the default when one is using an Subversion checkout and
1064 types <tt>gmake</tt> (unless the <tt>--enable-optimized</tt> option was
1065 used during configuration). The build system will compile the tools and
1066 libraries with debugging information. To get a Debug Build using the
1067 LLVM distribution the <tt>--disable-optimized</tt> option must be passed
1068 to <tt>configure</tt>.
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]1069 <br><br>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1070
1071 <dt>Release (Optimized) Builds
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1072 <dd>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1073 These builds are enabled with the <tt>--enable-optimized</tt> option to
1074 <tt>configure</tt> or by specifying <tt>ENABLE_OPTIMIZED=1</tt> on the
1075 <tt>gmake</tt> command line. For these builds, the build system will
1076 compile the tools and libraries with GCC optimizations enabled and strip
1077 debugging information from the libraries and executables it generates.
Chris Lattner1c1595f2009-04-25 22:24:49 +0000[diff] [blame]1078 Note that Release Builds are default when using an LLVM distribution.
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]1079 <br><br>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1080
1081 <dt>Profile Builds
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1082 <dd>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1083 These builds are for use with profiling. They compile profiling
1084 information into the code for use with programs like <tt>gprof</tt>.
1085 Profile builds must be started by specifying <tt>ENABLE_PROFILING=1</tt>
1086 on the <tt>gmake</tt> command line.
1087</dl>
John Criswell3ef61af2003-06-30 21:59:07 +0000[diff] [blame]1088
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1089<p>Once you have LLVM configured, you can build it by entering the
1090<i>OBJ_ROOT</i> directory and issuing the following command:</p>
John Criswell38cc2b52003-10-10 14:26:14 +0000[diff] [blame]1091
Bill Wendlingbcb3b412007-07-16 08:44:39 +0000[diff] [blame]1092<div class="doc_code"><pre>% gmake</pre></div>
John Criswell38cc2b52003-10-10 14:26:14 +0000[diff] [blame]1093
Chris Lattnere0050f02004-07-18 22:32:22 +0000[diff] [blame]1094<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]1095are using a version of GCC that is known not to compile LLVM.</p>
Chris Lattnere0050f02004-07-18 22:32:22 +0000[diff] [blame]1096
1097<p>
1098If you have multiple processors in your machine, you may wish to use some of
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1099the parallel build options provided by GNU Make. For example, you could use the
1100command:</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1101
Bill Wendlingbcb3b412007-07-16 08:44:39 +0000[diff] [blame]1102<div class="doc_code"><pre>% gmake -j2</pre></div>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1103
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1104<p>There are several special targets which are useful when working with the LLVM
1105source code:</p>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1106
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1107<dl>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1108 <dt><tt>gmake clean</tt>
1109 <dd>
1110 Removes all files generated by the build. This includes object files,
1111 generated C/C++ files, libraries, and executables.
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]1112 <br><br>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1113
Reid Spencerdfcf7902004-12-08 16:51:31 +0000[diff] [blame]1114 <dt><tt>gmake dist-clean</tt>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1115 <dd>
Misha Brukman5d413912004-08-21 23:40:49 +0000[diff] [blame]1116 Removes everything that <tt>gmake clean</tt> does, but also removes files
1117 generated by <tt>configure</tt>. It attempts to return the source tree to the
1118 original state in which it was shipped.
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]1119 <br><br>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1120
Misha Brukman62a2c1f2004-08-23 20:25:33 +0000[diff] [blame]1121 <dt><tt>gmake install</tt>
1122 <dd>
John Criswell6ab273c2004-12-08 17:53:54 +0000[diff] [blame]1123 Installs LLVM header files, libraries, tools, and documentation in a
1124 hierarchy
Reid Spencerdfcf7902004-12-08 16:51:31 +0000[diff] [blame]1125 under $PREFIX, specified with <tt>./configure --prefix=[dir]</tt>, which
1126 defaults to <tt>/usr/local</tt>.
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]1127 <br><br>
1128
Reid Spencerdfcf7902004-12-08 16:51:31 +0000[diff] [blame]1129 <dt><tt>gmake -C runtime install-bytecode</tt>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1130 <dd>
Reid Spencer45dc1392004-11-11 07:30:27 +0000[diff] [blame]1131 Assuming you built LLVM into $OBJDIR, when this command is run, it will
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]1132 install bitcode libraries into the GCC front end's bitcode library
1133 directory. If you need to update your bitcode libraries,
Misha Brukman5d413912004-08-21 23:40:49 +0000[diff] [blame]1134 this is the target to use once you've built them.
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]1135 <br><br>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1136</dl>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1137
Reid Spencerdfcf7902004-12-08 16:51:31 +0000[diff] [blame]1138<p>Please see the <a href="MakefileGuide.html">Makefile Guide</a> for further
1139details on these <tt>make</tt> targets and descriptions of other targets
1140available.</p>
1141
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1142<p>It is also possible to override default values from <tt>configure</tt> by
1143declaring variables on the command line. The following are some examples:</p>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1144
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1145<dl>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1146 <dt><tt>gmake ENABLE_OPTIMIZED=1</tt>
1147 <dd>
1148 Perform a Release (Optimized) build.
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]1149 <br><br>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1150
Reid Spencer3dc3ea72006-04-09 23:45:38 +0000[diff] [blame]1151 <dt><tt>gmake ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1</tt>
Chris Lattner0f546dd2006-03-21 01:10:57 +0000[diff] [blame]1152 <dd>
Reid Spencer3dc3ea72006-04-09 23:45:38 +0000[diff] [blame]1153 Perform a Release (Optimized) build without assertions enabled.
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]1154 <br><br>
Chris Lattner1c1595f2009-04-25 22:24:49 +0000[diff] [blame]1155
1156 <dt><tt>gmake ENABLE_OPTIMIZED=0</tt>
1157 <dd>
1158 Perform a Debug build.
1159 <br><br>
Chris Lattner0f546dd2006-03-21 01:10:57 +0000[diff] [blame]1160
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1161 <dt><tt>gmake ENABLE_PROFILING=1</tt>
1162 <dd>
1163 Perform a Profiling build.
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]1164 <br><br>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1165
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1166 <dt><tt>gmake VERBOSE=1</tt>
1167 <dd>
1168 Print what <tt>gmake</tt> is doing on standard output.
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]1169 <br><br>
Reid Spencerdfcf7902004-12-08 16:51:31 +0000[diff] [blame]1170
1171 <dt><tt>gmake TOOL_VERBOSE=1</tt></dt>
1172 <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]1173 the standard output. This also implies <tt>VERBOSE=1</tt>.
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]1174 <br><br></dd>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1175</dl>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1176
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1177<p>Every directory in the LLVM object tree includes a <tt>Makefile</tt> to build
1178it and any subdirectories that it contains. Entering any directory inside the
1179LLVM object tree and typing <tt>gmake</tt> should rebuild anything in or below
1180that directory that is out of date.</p>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1181
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1182</div>
John Criswell38cc2b52003-10-10 14:26:14 +0000[diff] [blame]1183
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1184<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1185<h3>
Reid Spencer734b74f2006-07-27 06:41:31 +0000[diff] [blame]1186 <a name="cross-compile">Cross-Compiling LLVM</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1187</h3>
Reid Spencerd966b242006-07-27 05:43:30 +0000[diff] [blame]1188
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]1189<div>
Jim Grosbach7da1b902009-04-17 17:25:16 +0000[diff] [blame]1190 <p>It is possible to cross-compile LLVM itself. That is, you can create LLVM
1191 executables and libraries to be hosted on a platform different from the
1192 platform where they are build (a Canadian Cross build). To configure a
1193 cross-compile, supply the configure script with <tt>--build</tt> and
1194 <tt>--host</tt> options that are different. The values of these options must
1195 be legal target triples that your GCC compiler supports.</p>
1196
1197 <p>The result of such a build is executables that are not runnable on
1198 on the build host (--build option) but can be executed on the compile host
Reid Spencer734b74f2006-07-27 06:41:31 +0000[diff] [blame]1199 (--host option).</p>
Reid Spencerd966b242006-07-27 05:43:30 +0000[diff] [blame]1200</div>
1201
1202<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1203<h3>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1204 <a name="objfiles">The Location of LLVM Object Files</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1205</h3>
John Criswell38cc2b52003-10-10 14:26:14 +0000[diff] [blame]1206
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]1207<div>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1208
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1209<p>The LLVM build system is capable of sharing a single LLVM source tree among
1210several LLVM builds. Hence, it is possible to build LLVM for several different
1211platforms or configurations using the same source tree.</p>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1212
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1213<p>This is accomplished in the typical autoconf manner:</p>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1214
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1215<ul>
1216 <li><p>Change directory to where the LLVM object files should live:</p>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1217
Bill Wendlingbcb3b412007-07-16 08:44:39 +0000[diff] [blame]1218 <div class="doc_code"><pre>% cd <i>OBJ_ROOT</i></pre></div></li>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1219
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1220 <li><p>Run the <tt>configure</tt> script found in the LLVM source
1221 directory:</p>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1222
Bill Wendlingbcb3b412007-07-16 08:44:39 +0000[diff] [blame]1223 <div class="doc_code"><pre>% <i>SRC_ROOT</i>/configure</pre></div></li>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1224</ul>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1225
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1226<p>The LLVM build will place files underneath <i>OBJ_ROOT</i> in directories
1227named after the build type:</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1228
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1229<dl>
Duncan Sands1567f0f2010-07-08 08:27:18 +0000[diff] [blame]1230 <dt>Debug Builds with assertions enabled (the default)
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1231 <dd>
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1232 <dl>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1233 <dt>Tools
Duncan Sands1567f0f2010-07-08 08:27:18 +0000[diff] [blame]1234 <dd><tt><i>OBJ_ROOT</i>/Debug+Asserts/bin</tt>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1235 <dt>Libraries
Duncan Sands1567f0f2010-07-08 08:27:18 +0000[diff] [blame]1236 <dd><tt><i>OBJ_ROOT</i>/Debug+Asserts/lib</tt>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1237 </dl>
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]1238 <br><br>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1239
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1240 <dt>Release Builds
1241 <dd>
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1242 <dl>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1243 <dt>Tools
Reid Spencerdfcf7902004-12-08 16:51:31 +0000[diff] [blame]1244 <dd><tt><i>OBJ_ROOT</i>/Release/bin</tt>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1245 <dt>Libraries
Reid Spencerdfcf7902004-12-08 16:51:31 +0000[diff] [blame]1246 <dd><tt><i>OBJ_ROOT</i>/Release/lib</tt>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1247 </dl>
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]1248 <br><br>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1249
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1250 <dt>Profile Builds
1251 <dd>
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1252 <dl>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1253 <dt>Tools
Reid Spencerdfcf7902004-12-08 16:51:31 +0000[diff] [blame]1254 <dd><tt><i>OBJ_ROOT</i>/Profile/bin</tt>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1255 <dt>Libraries
Reid Spencerdfcf7902004-12-08 16:51:31 +0000[diff] [blame]1256 <dd><tt><i>OBJ_ROOT</i>/Profile/lib</tt>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1257 </dl>
1258</dl>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1259
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1260</div>
Chris Lattner1c1ef112002-07-24 19:51:14 +0000[diff] [blame]1261
Chris Lattner998c0672004-03-25 20:38:40 +0000[diff] [blame]1262<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1263<h3>
Chris Lattner998c0672004-03-25 20:38:40 +0000[diff] [blame]1264 <a name="optionalconfig">Optional Configuration Items</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1265</h3>
Chris Lattner998c0672004-03-25 20:38:40 +0000[diff] [blame]1266
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]1267<div>
Chris Lattner998c0672004-03-25 20:38:40 +0000[diff] [blame]1268
1269<p>
Misha Brukman20b8a6562005-02-03 22:25:23 +0000[diff] [blame]1270If you're running on a Linux system that supports the "<a
Bill Wendlingaf5b63f2007-07-16 08:46:40 +0000[diff] [blame]1271href="http://www.tat.physik.uni-tuebingen.de/~rguenth/linux/binfmt_misc.html">binfmt_misc</a>"
Chris Lattner998c0672004-03-25 20:38:40 +0000[diff] [blame]1272module, and you have root access on the system, you can set your system up to
Bill Wendlingaf5b63f2007-07-16 08:46:40 +0000[diff] [blame]1273execute LLVM bitcode files directly. To do this, use commands like this (the
Chris Lattner998c0672004-03-25 20:38:40 +0000[diff] [blame]1274first command may not be required if you are already using the module):</p>
1275
Misha Brukman20b8a6562005-02-03 22:25:23 +0000[diff] [blame]1276<div class="doc_code">
Chris Lattner998c0672004-03-25 20:38:40 +0000[diff] [blame]1277<pre>
Bill Wendlingbcb3b412007-07-16 08:44:39 +0000[diff] [blame]1278$ mount -t binfmt_misc none /proc/sys/fs/binfmt_misc
Nick Lewyckyb8c923b2009-11-04 06:15:28 +0000[diff] [blame]1279$ echo ':llvm:M::BC::/path/to/lli:' &gt; /proc/sys/fs/binfmt_misc/register
Bill Wendlingbcb3b412007-07-16 08:44:39 +0000[diff] [blame]1280$ chmod u+x hello.bc (if needed)
1281$ ./hello.bc
Chris Lattner998c0672004-03-25 20:38:40 +0000[diff] [blame]1282</pre>
Misha Brukman20b8a6562005-02-03 22:25:23 +0000[diff] [blame]1283</div>
Chris Lattner998c0672004-03-25 20:38:40 +0000[diff] [blame]1284
1285<p>
Chris Lattnerb5c11742010-02-17 18:33:13 +0000[diff] [blame]1286This allows you to execute LLVM bitcode files directly. On Debian, you
NAKAMURA Takumi6bd36d52011-04-09 09:51:57 +0000[diff] [blame]1287can also use this command instead of the 'echo' command above:
Chris Lattner998c0672004-03-25 20:38:40 +0000[diff] [blame]1288</p>
1289
Chris Lattnerb5c11742010-02-17 18:33:13 +0000[diff] [blame]1290<div class="doc_code">
1291<pre>
1292$ sudo update-binfmts --install llvm /path/to/lli --magic 'BC'
1293</pre>
1294</div>
1295
Chris Lattner998c0672004-03-25 20:38:40 +0000[diff] [blame]1296</div>
1297
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]1298</div>
1299
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1300<!-- *********************************************************************** -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1301<h2>
1302 <a name="layout">Program Layout</a>
1303</h2>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1304<!-- *********************************************************************** -->
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1305
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]1306<div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1307
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1308<p>One useful source of information about the LLVM source base is the LLVM <a
NAKAMURA Takumica46f5a2011-04-09 02:13:37 +0000[diff] [blame]1309href="http://www.doxygen.org/">doxygen</a> documentation available at <tt><a
Reid Spencerca058542006-03-14 05:39:39 +0000[diff] [blame]1310href="http://llvm.org/doxygen/">http://llvm.org/doxygen/</a></tt>.
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1311The following is a brief introduction to code layout:</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1312
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1313<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1314<h3>
1315 <a name="examples"><tt>llvm/examples</tt></a>
1316</h3>
1317
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]1318<div>
Reid Spencer5be4f042004-12-08 16:18:26 +0000[diff] [blame]1319 <p>This directory contains some simple examples of how to use the LLVM IR and
1320 JIT.</p>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1321</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1322
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1323<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1324<h3>
1325 <a name="include"><tt>llvm/include</tt></a>
1326</h3>
1327
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]1328<div>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1329
1330<p>This directory contains public header files exported from the LLVM
1331library. The three main subdirectories of this directory are:</p>
1332
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1333<dl>
1334 <dt><tt><b>llvm/include/llvm</b></tt></dt>
1335 <dd>This directory contains all of the LLVM specific header files. This
1336 directory also has subdirectories for different portions of LLVM:
1337 <tt>Analysis</tt>, <tt>CodeGen</tt>, <tt>Target</tt>, <tt>Transforms</tt>,
1338 etc...</dd>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1339
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1340 <dt><tt><b>llvm/include/llvm/Support</b></tt></dt>
1341 <dd>This directory contains generic support libraries that are provided with
1342 LLVM but not necessarily specific to LLVM. For example, some C++ STL utilities
1343 and a Command Line option processing library store their header files here.
1344 </dd>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1345
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1346 <dt><tt><b>llvm/include/llvm/Config</b></tt></dt>
1347 <dd>This directory contains header files configured by the <tt>configure</tt>
1348 script. They wrap "standard" UNIX and C header files. Source code can
1349 include these header files which automatically take care of the conditional
1350 #includes that the <tt>configure</tt> script generates.</dd>
1351</dl>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1352</div>
1353
1354<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1355<h3>
1356 <a name="lib"><tt>llvm/lib</tt></a>
1357</h3>
1358
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]1359<div>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1360
1361<p>This directory contains most of the source files of the LLVM system. In LLVM,
1362almost all code exists in libraries, making it very easy to share code among the
1363different <a href="#tools">tools</a>.</p>
1364
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1365<dl>
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1366 <dt><tt><b>llvm/lib/VMCore/</b></tt></dt>
1367 <dd> This directory holds the core LLVM source files that implement core
1368 classes like Instruction and BasicBlock.</dd>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1369
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1370 <dt><tt><b>llvm/lib/AsmParser/</b></tt></dt>
1371 <dd>This directory holds the source code for the LLVM assembly language parser
1372 library.</dd>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1373
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]1374 <dt><tt><b>llvm/lib/BitCode/</b></tt></dt>
1375 <dd>This directory holds code for reading and write LLVM bitcode.</dd>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1376
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1377 <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]1378 different program analyses, such as Dominator Information, Call Graphs,
1379 Induction Variables, Interval Identification, Natural Loop Identification,
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1380 etc.</dd>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1381
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1382 <dt><tt><b>llvm/lib/Transforms/</b></tt></dt>
1383 <dd> This directory contains the source code for the LLVM to LLVM program
1384 transformations, such as Aggressive Dead Code Elimination, Sparse Conditional
1385 Constant Propagation, Inlining, Loop Invariant Code Motion, Dead Global
1386 Elimination, and many others.</dd>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1387
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1388 <dt><tt><b>llvm/lib/Target/</b></tt></dt>
1389 <dd> This directory contains files that describe various target architectures
Chris Lattner7991e852006-04-20 17:42:23 +0000[diff] [blame]1390 for code generation. For example, the <tt>llvm/lib/Target/X86</tt>
1391 directory holds the X86 machine description while
Eric Christopher64a23232012-03-23 05:50:46 +0000[diff] [blame]1392 <tt>llvm/lib/Target/ARM</tt> implements the ARM backend.</dd>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1393
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1394 <dt><tt><b>llvm/lib/CodeGen/</b></tt></dt>
1395 <dd> This directory contains the major parts of the code generator: Instruction
1396 Selector, Instruction Scheduling, and Register Allocation.</dd>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1397
NAKAMURA Takumif8e44c32011-04-05 08:24:15 +0000[diff] [blame]1398 <dt><tt><b>llvm/lib/MC/</b></tt></dt>
1399 <dd>(FIXME: T.B.D.)</dd>
1400
1401 <!--FIXME: obsoleted -->
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1402 <dt><tt><b>llvm/lib/Debugger/</b></tt></dt>
1403 <dd> This directory contains the source level debugger library that makes
1404 it possible to instrument LLVM programs so that a debugger could identify
1405 source code locations at which the program is executing.</dd>
1406
1407 <dt><tt><b>llvm/lib/ExecutionEngine/</b></tt></dt>
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]1408 <dd> This directory contains libraries for executing LLVM bitcode directly
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1409 at runtime in both interpreted and JIT compiled fashions.</dd>
1410
1411 <dt><tt><b>llvm/lib/Support/</b></tt></dt>
Daniel Dunbar037fc932011-10-11 20:02:52 +0000[diff] [blame]1412 <dd> This directory contains the source code that corresponds to the header
1413 files located in <tt>llvm/include/ADT/</tt>
1414 and <tt>llvm/include/Support/</tt>.</dd>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1415</dl>
John Criswell3ef61af2003-06-30 21:59:07 +0000[diff] [blame]1416
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1417</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1418
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1419<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1420<h3>
1421 <a name="projects"><tt>llvm/projects</tt></a>
1422</h3>
1423
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]1424<div>
Reid Spencer5be4f042004-12-08 16:18:26 +0000[diff] [blame]1425 <p>This directory contains projects that are not strictly part of LLVM but are
1426 shipped with LLVM. This is also the directory where you should create your own
1427 LLVM-based projects. See <tt>llvm/projects/sample</tt> for an example of how
Chris Lattner7b7b6782008-08-11 06:13:31 +0000[diff] [blame]1428 to set up your own project.</p>
Reid Spencer5be4f042004-12-08 16:18:26 +0000[diff] [blame]1429</div>
1430
1431<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1432<h3>
1433 <a name="runtime"><tt>llvm/runtime</tt></a>
1434</h3>
1435
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]1436<div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1437
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]1438<p>This directory contains libraries which are compiled into LLVM bitcode and
Chad Rosierce50eec2012-02-26 22:26:37 +0000[diff] [blame]1439used when linking programs with the Clang front end. Most of these libraries are
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1440skeleton versions of real libraries; for example, libc is a stripped down
1441version of glibc.</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1442
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1443<p>Unlike the rest of the LLVM suite, this directory needs the LLVM GCC front
1444end to compile.</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1445
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1446</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1447
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1448<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1449<h3>
1450 <a name="test"><tt>llvm/test</tt></a>
1451</h3>
1452
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]1453<div>
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1454 <p>This directory contains feature and regression tests and other basic sanity
1455 checks on the LLVM infrastructure. These are intended to run quickly and cover
1456 a lot of territory without being exhaustive.</p>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1457</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1458
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1459<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1460<h3>
1461 <a name="test-suite"><tt>test-suite</tt></a>
1462</h3>
1463
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]1464<div>
John Criswell58594852007-06-29 19:12:31 +0000[diff] [blame]1465 <p>This is not a directory in the normal llvm module; it is a separate
1466 Subversion
1467 module that must be checked out (usually to <tt>projects/test-suite</tt>).
1468 This
John Criswell6ab273c2004-12-08 17:53:54 +0000[diff] [blame]1469 module contains a comprehensive correctness, performance, and benchmarking
1470 test
John Criswell58594852007-06-29 19:12:31 +0000[diff] [blame]1471 suite for LLVM. It is a separate Subversion module because not every LLVM
1472 user is
John Criswellcfdeb5c2005-05-09 16:39:27 +0000[diff] [blame]1473 interested in downloading or building such a comprehensive test suite. For
1474 further details on this test suite, please see the
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1475 <a href="TestingGuide.html">Testing Guide</a> document.</p>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1476</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1477
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1478<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1479<h3>
1480 <a name="tools"><tt>llvm/tools</tt></a>
1481</h3>
1482
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]1483<div>
John Criswell38cc2b52003-10-10 14:26:14 +0000[diff] [blame]1484
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1485<p>The <b>tools</b> directory contains the executables built out of the
1486libraries above, which form the main part of the user interface. You can
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]1487always get help for a tool by typing <tt>tool_name -help</tt>. The
Misha Brukmanb4bd8de2004-11-15 23:20:51 +0000[diff] [blame]1488following is a brief introduction to the most important tools. More detailed
1489information is in the <a href="CommandGuide/index.html">Command Guide</a>.</p>
John Criswell38cc2b52003-10-10 14:26:14 +0000[diff] [blame]1490
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1491<dl>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1492
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1493 <dt><tt><b>bugpoint</b></tt></dt>
1494 <dd><tt>bugpoint</tt> is used to debug
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1495 optimization passes or code generation backends by narrowing down the
1496 given test case to the minimum number of passes and/or instructions that
1497 still cause a problem, whether it is a crash or miscompilation. See <a
1498 href="HowToSubmitABug.html">HowToSubmitABug.html</a> for more information
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1499 on using <tt>bugpoint</tt>.</dd>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1500
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1501 <dt><tt><b>llvm-ar</b></tt></dt>
1502 <dd>The archiver produces an archive containing
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]1503 the given LLVM bitcode files, optionally with an index for faster
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1504 lookup.</dd>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1505
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1506 <dt><tt><b>llvm-as</b></tt></dt>
1507 <dd>The assembler transforms the human readable LLVM assembly to LLVM
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]1508 bitcode.</dd>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1509
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1510 <dt><tt><b>llvm-dis</b></tt></dt>
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]1511 <dd>The disassembler transforms the LLVM bitcode to human readable
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1512 LLVM assembly.</dd>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1513
Reid Spencer92815e52004-12-08 18:00:30 +0000[diff] [blame]1514 <dt><tt><b>llvm-ld</b></tt></dt>
Reid Spencera7974cc2007-02-09 15:59:08 +0000[diff] [blame]1515 <dd><tt>llvm-ld</tt> is a general purpose and extensible linker for LLVM.
Eric Christophercafab2e2011-09-20 00:42:28 +0000[diff] [blame]1516 It performs standard link time optimizations and allows optimization
1517 modules to be loaded and run so that language specific optimizations can
1518 be applied at link time.</dd>
Reid Spencer92815e52004-12-08 18:00:30 +0000[diff] [blame]1519
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1520 <dt><tt><b>llvm-link</b></tt></dt>
1521 <dd><tt>llvm-link</tt>, not surprisingly, links multiple LLVM modules into
1522 a single program.</dd>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1523
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1524 <dt><tt><b>lli</b></tt></dt>
1525 <dd><tt>lli</tt> is the LLVM interpreter, which
Nick Lewycky97467822007-12-03 01:58:01 +0000[diff] [blame]1526 can directly execute LLVM bitcode (although very slowly...). For architectures
1527 that support it (currently x86, Sparc, and PowerPC), by default, <tt>lli</tt>
1528 will function as a Just-In-Time compiler (if the functionality was compiled
1529 in), and will execute the code <i>much</i> faster than the interpreter.</dd>
Misha Brukman994d7e82003-10-06 19:23:34 +0000[diff] [blame]1530
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1531 <dt><tt><b>llc</b></tt></dt>
1532 <dd> <tt>llc</tt> is the LLVM backend compiler, which
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]1533 translates LLVM bitcode to a native code assembly file or to C code (with
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1534 the -march=c option).</dd>
Misha Brukman994d7e82003-10-06 19:23:34 +0000[diff] [blame]1535
Reid Spencer788b0fd2004-12-22 06:29:07 +0000[diff] [blame]1536 <dt><tt><b>llvm-gcc</b></tt></dt>
Reid Spencera7974cc2007-02-09 15:59:08 +0000[diff] [blame]1537 <dd><tt>llvm-gcc</tt> is a GCC-based C frontend that has been retargeted to
1538 use LLVM as its backend instead of GCC's RTL backend. It can also emit LLVM
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]1539 bitcode or assembly (with the <tt>-emit-llvm</tt> option) instead of the
Reid Spencera7974cc2007-02-09 15:59:08 +0000[diff] [blame]1540 usual machine code output. It works just like any other GCC compiler,
1541 taking the typical <tt>-c, -S, -E, -o</tt> options that are typically used.
1542 Additionally, the the source code for <tt>llvm-gcc</tt> is available as a
John Criswell58594852007-06-29 19:12:31 +0000[diff] [blame]1543 separate Subversion module.</dd>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1544
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1545 <dt><tt><b>opt</b></tt></dt>
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]1546 <dd><tt>opt</tt> reads LLVM bitcode, applies a series of LLVM to LLVM
Reid Spencer80f843d2006-08-28 00:34:19 +0000[diff] [blame]1547 transformations (which are specified on the command line), and then outputs
Duncan Sands142b9ed2010-02-18 14:08:13 +0000[diff] [blame]1548 the resultant bitcode. The '<tt>opt -help</tt>' command is a good way to
Misha Brukman21a63702008-12-11 18:23:24 +0000[diff] [blame]1549 get a list of the program transformations available in LLVM.<br>
Reid Spencer80f843d2006-08-28 00:34:19 +0000[diff] [blame]1550 <dd><tt>opt</tt> can also be used to run a specific analysis on an input
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]1551 LLVM bitcode file and print out the results. It is primarily useful for
Reid Spencer80f843d2006-08-28 00:34:19 +0000[diff] [blame]1552 debugging analyses, or familiarizing yourself with what an analysis does.</dd>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1553</dl>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1554</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1555
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1556<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1557<h3>
1558 <a name="utils"><tt>llvm/utils</tt></a>
1559</h3>
1560
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]1561<div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1562
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1563<p>This directory contains utilities for working with LLVM source code, and some
1564of the utilities are actually required as part of the build process because they
1565are code generators for parts of LLVM infrastructure.</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1566
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1567<dl>
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1568 <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]1569 that finds differences between code that LLC generates and code that LLI
1570 generates. This is a useful tool if you are debugging one of them,
1571 assuming that the other generates correct output. For the full user
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]1572 manual, run <tt>`perldoc codegen-diff'</tt>.<br><br>
Misha Brukmanefe54be2003-08-11 18:45:46 +0000[diff] [blame]1573
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1574 <dt><tt><b>emacs/</b></tt> <dd>The <tt>emacs</tt> directory contains
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1575 syntax-highlighting files which will work with Emacs and XEmacs editors,
1576 providing syntax highlighting support for LLVM assembly files and TableGen
1577 description files. For information on how to use the syntax files, consult
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]1578 the <tt>README</tt> file in that directory.<br><br>
Misha Brukmanefe54be2003-08-11 18:45:46 +0000[diff] [blame]1579
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1580 <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]1581 and outputs all non-generated source files, which is useful if one wishes
1582 to do a lot of development across directories and does not want to
1583 individually find each file. One way to use it is to run, for example:
1584 <tt>xemacs `utils/getsources.sh`</tt> from the top of your LLVM source
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]1585 tree.<br><br>
1586
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1587 <dt><tt><b>llvmgrep</b></tt></dt>
1588 <dd>This little tool performs an "egrep -H -n" on each source file in LLVM and
1589 passes to it a regular expression provided on <tt>llvmgrep</tt>'s command
1590 line. This is a very efficient way of searching the source base for a
1591 particular regular expression.</dd>
1592
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1593 <dt><tt><b>makellvm</b></tt> <dd>The <tt>makellvm</tt> script compiles all
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1594 files in the current directory and then compiles and links the tool that
1595 is the first argument. For example, assuming you are in the directory
1596 <tt>llvm/lib/Target/Sparc</tt>, if <tt>makellvm</tt> is in your path,
1597 simply running <tt>makellvm llc</tt> will make a build of the current
1598 directory, switch to directory <tt>llvm/tools/llc</tt> and build it,
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]1599 causing a re-linking of LLC.<br><br>
Misha Brukmanefe54be2003-08-11 18:45:46 +0000[diff] [blame]1600
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1601 <dt><tt><b>TableGen/</b></tt> <dd>The <tt>TableGen</tt> directory contains
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1602 the tool used to generate register descriptions, instruction set
1603 descriptions, and even assemblers from common TableGen description
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]1604 files.<br><br>
Misha Brukmanefe54be2003-08-11 18:45:46 +0000[diff] [blame]1605
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1606 <dt><tt><b>vim/</b></tt> <dd>The <tt>vim</tt> directory contains
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1607 syntax-highlighting files which will work with the VIM editor, providing
1608 syntax highlighting support for LLVM assembly files and TableGen
1609 description files. For information on how to use the syntax files, consult
Chris Lattner4d7ce8a2006-09-07 04:19:09 +0000[diff] [blame]1610 the <tt>README</tt> file in that directory.<br><br>
Misha Brukmanefe54be2003-08-11 18:45:46 +0000[diff] [blame]1611
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1612</dl>
Misha Brukmanefe54be2003-08-11 18:45:46 +0000[diff] [blame]1613
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1614</div>
Misha Brukmanefe54be2003-08-11 18:45:46 +0000[diff] [blame]1615
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]1616</div>
1617
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1618<!-- *********************************************************************** -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1619<h2>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1620 <a name="tutorial">An Example Using the LLVM Tool Chain</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1621</h2>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1622<!-- *********************************************************************** -->
Misha Brukmanefe54be2003-08-11 18:45:46 +0000[diff] [blame]1623
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]1624<div>
Chad Rosier233f1472012-02-26 21:31:25 +0000[diff] [blame]1625<p>This section gives an example of using LLVM with the Clang front end.</p>
Chris Lattner5b560d92006-08-14 20:45:25 +0000[diff] [blame]1626
1627<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1628<h3>
Chad Rosier233f1472012-02-26 21:31:25 +0000[diff] [blame]1629 <a name="tutorial4">Example with clang</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1630</h3>
Chris Lattner5b560d92006-08-14 20:45:25 +0000[diff] [blame]1631
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]1632<div>
Chris Lattner5b560d92006-08-14 20:45:25 +0000[diff] [blame]1633
1634<ol>
Bill Wendlingbcb3b412007-07-16 08:44:39 +0000[diff] [blame]1635 <li><p>First, create a simple C file, name it 'hello.c':</p>
1636
1637<div class="doc_code">
1638<pre>
1639#include &lt;stdio.h&gt;
1640
1641int main() {
1642 printf("hello world\n");
1643 return 0;
1644}
1645</pre></div></li>
Chris Lattner5b560d92006-08-14 20:45:25 +0000[diff] [blame]1646
1647 <li><p>Next, compile the C file into a native executable:</p>
1648
Chad Rosier233f1472012-02-26 21:31:25 +0000[diff] [blame]1649 <div class="doc_code"><pre>% clang hello.c -o hello</pre></div>
Chris Lattner5b560d92006-08-14 20:45:25 +0000[diff] [blame]1650
Chad Rosier233f1472012-02-26 21:31:25 +0000[diff] [blame]1651 <p>Note that clang works just like GCC by default. The standard -S and
Chris Lattner5b560d92006-08-14 20:45:25 +0000[diff] [blame]1652 -c arguments work as usual (producing a native .s or .o file,
Bill Wendlingbcb3b412007-07-16 08:44:39 +0000[diff] [blame]1653 respectively).</p></li>
Chris Lattner5b560d92006-08-14 20:45:25 +0000[diff] [blame]1654
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]1655 <li><p>Next, compile the C file into a LLVM bitcode file:</p>
Bill Wendlingbcb3b412007-07-16 08:44:39 +0000[diff] [blame]1656
1657 <div class="doc_code">
Chad Rosier233f1472012-02-26 21:31:25 +0000[diff] [blame]1658 <pre>% clang -O3 -emit-llvm hello.c -c -o hello.bc</pre></div>
Chris Lattner5b560d92006-08-14 20:45:25 +0000[diff] [blame]1659
1660 <p>The -emit-llvm option can be used with the -S or -c options to emit an
1661 LLVM ".ll" or ".bc" file (respectively) for the code. This allows you
1662 to use the <a href="CommandGuide/index.html">standard LLVM tools</a> on
Chad Rosier233f1472012-02-26 21:31:25 +0000[diff] [blame]1663 the bitcode file.</p></li>
Chris Lattner5b560d92006-08-14 20:45:25 +0000[diff] [blame]1664
1665 <li><p>Run the program in both forms. To run the program, use:</p>
1666
Bill Wendlingbcb3b412007-07-16 08:44:39 +0000[diff] [blame]1667 <div class="doc_code"><pre>% ./hello</pre></div>
Chris Lattner5b560d92006-08-14 20:45:25 +0000[diff] [blame]1668
1669 <p>and</p>
1670
Bill Wendlingbcb3b412007-07-16 08:44:39 +0000[diff] [blame]1671 <div class="doc_code"><pre>% lli hello.bc</pre></div>
Chris Lattner5b560d92006-08-14 20:45:25 +0000[diff] [blame]1672
1673 <p>The second examples shows how to invoke the LLVM JIT, <a
Chris Lattnerc7443af2006-08-14 20:51:35 +0000[diff] [blame]1674 href="CommandGuide/html/lli.html">lli</a>.</p></li>
Chris Lattner5b560d92006-08-14 20:45:25 +0000[diff] [blame]1675
1676 <li><p>Use the <tt>llvm-dis</tt> utility to take a look at the LLVM assembly
1677 code:</p>
1678
Bill Wendlingbcb3b412007-07-16 08:44:39 +0000[diff] [blame]1679<div class="doc_code">
1680<pre>llvm-dis &lt; hello.bc | less</pre>
1681</div></li>
Chris Lattner5b560d92006-08-14 20:45:25 +0000[diff] [blame]1682
1683 <li><p>Compile the program to native assembly using the LLC code
1684 generator:</p>
1685
Bill Wendlingbcb3b412007-07-16 08:44:39 +0000[diff] [blame]1686 <div class="doc_code"><pre>% llc hello.bc -o hello.s</pre></div></li>
Chris Lattner5b560d92006-08-14 20:45:25 +0000[diff] [blame]1687
1688 <li><p>Assemble the native assembly language file into a program:</p>
1689
Bill Wendlingbcb3b412007-07-16 08:44:39 +0000[diff] [blame]1690<div class="doc_code">
1691<pre>
1692<b>Solaris:</b> % /opt/SUNWspro/bin/cc -xarch=v9 hello.s -o hello.native
1693
1694<b>Others:</b> % gcc hello.s -o hello.native
1695</pre>
1696</div></li>
Chris Lattner5b560d92006-08-14 20:45:25 +0000[diff] [blame]1697
1698 <li><p>Execute the native code program:</p>
1699
Bill Wendlingbcb3b412007-07-16 08:44:39 +0000[diff] [blame]1700 <div class="doc_code"><pre>% ./hello.native</pre></div>
Chris Lattner5b560d92006-08-14 20:45:25 +0000[diff] [blame]1701
Chad Rosier233f1472012-02-26 21:31:25 +0000[diff] [blame]1702 <p>Note that using clang to compile directly to native code (i.e. when
Chris Lattner5b560d92006-08-14 20:45:25 +0000[diff] [blame]1703 the -emit-llvm option is not present) does steps 6/7/8 for you.</p>
Chris Lattnerc7443af2006-08-14 20:51:35 +0000[diff] [blame]1704 </li>
Chris Lattner5b560d92006-08-14 20:45:25 +0000[diff] [blame]1705
1706</ol>
1707
1708</div>
1709
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]1710</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1711
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1712<!-- *********************************************************************** -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1713<h2>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1714 <a name="problems">Common Problems</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1715</h2>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1716<!-- *********************************************************************** -->
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1717
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]1718<div>
John Criswellc5eb4602003-07-03 16:01:38 +0000[diff] [blame]1719
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1720<p>If you are having problems building or using LLVM, or if you have any other
1721general questions about LLVM, please consult the <a href="FAQ.html">Frequently
1722Asked Questions</a> page.</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1723
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1724</div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1725
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1726<!-- *********************************************************************** -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1727<h2>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1728 <a name="links">Links</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]1729</h2>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1730<!-- *********************************************************************** -->
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1731
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]1732<div>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1733
Bill Wendlingcb13d702008-07-22 01:10:25 +0000[diff] [blame]1734<p>This document is just an <b>introduction</b> on how to use LLVM to do
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1735some simple things... there are many more interesting and complicated things
1736that you can do that aren't documented here (but we'll gladly accept a patch
1737if you want to write something up!). For more information about LLVM, check
1738out:</p>
John Criswell72989a52003-06-12 19:34:44 +0000[diff] [blame]1739
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1740<ul>
Reid Spencerca058542006-03-14 05:39:39 +0000[diff] [blame]1741 <li><a href="http://llvm.org/">LLVM homepage</a></li>
1742 <li><a href="http://llvm.org/doxygen/">LLVM doxygen tree</a></li>
1743 <li><a href="http://llvm.org/docs/Projects.html">Starting a Project
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1744 that Uses LLVM</a></li>
1745</ul>
1746
1747</div>
1748
1749<!-- *********************************************************************** -->
1750
1751<hr>
Misha Brukman74d4df82003-11-22 01:30:01 +0000[diff] [blame]1752<address>
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1753 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman86242e12008-12-11 17:34:48 +0000[diff] [blame]1754 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1755 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman21a63702008-12-11 18:23:24 +0000[diff] [blame]1756 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Misha Brukmand3de5c62004-01-20 00:20:17 +0000[diff] [blame]1757
Misha Brukman74d4df82003-11-22 01:30:01 +0000[diff] [blame]1758 <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
Reid Spencer075de232004-09-05 20:50:22 +0000[diff] [blame]1759 <a href="http://llvm.x10sys.com/rspencer/">Reid Spencer</a><br>
NAKAMURA Takumica46f5a2011-04-09 02:13:37 +0000[diff] [blame]1760 <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1761 Last modified: $Date$
Misha Brukman74d4df82003-11-22 01:30:01 +0000[diff] [blame]1762</address>
Misha Brukman560e9892003-11-07 19:43:14 +0000[diff] [blame]1763</body>
Guochun Shib65a78e2002-07-17 23:05:56 +0000[diff] [blame]1764</html>