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