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

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