Blame - docs/GettingStarted.html - platform/external/llvm

blob: c4fd3a1459aa491bc68f673708cd4e88563d9e84 [file] [log] [blame]

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