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