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

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