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