Blame - llvm/docs/GettingStarted.html - toolchain/llvm-project

blob: dad79fdc40d3cd3a52490a6dfe3252d556b3a93d [file] [log] [blame]

Misha Brukman	560e989	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	b65a78e	2002-07-17 23:05:56 +0000	[diff] [blame]	3	<html>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	4	<head>
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	5	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Misha Brukman	560e989	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	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	10
Misha Brukman	560e989	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	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	14
Misha Brukman	560e989	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	c0bda0d	2003-02-14 04:22:13 +0000	[diff] [blame]	19	<ol>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	20	<li><a href="#hardware">Hardware</a>
				21	<li><a href="#software">Software</a>
Chris Lattner	e0050f0	2004-07-18 22:32:22 +0000	[diff] [blame]	22	<li><a href="#brokengcc">Broken versions of GCC</a>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	23	</ol></li>
John Criswell	3ef61af	2003-06-30 21:59:07 +0000	[diff] [blame]	24
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	25	<li><a href="#starting">Getting Started with LLVM</a>
John Criswell	71139f2	2003-07-08 20:35:59 +0000	[diff] [blame]	26	<ol>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	27	<li><a href="#terminology">Terminology and Notation</a>
				28	<li><a href="#environment">Setting Up Your Environment</a>
				29	<li><a href="#unpack">Unpacking the LLVM Archives</a>
				30	<li><a href="#checkout">Checkout LLVM from CVS</a>
				31	<li><a href="#installcf">Install the GCC Front End</a>
				32	<li><a href="#config">Local LLVM Configuration</a>
				33	<li><a href="#compile">Compiling the LLVM Suite Source Code</a>
Reid Spencer	734b74f	2006-07-27 06:41:31 +0000	[diff] [blame]	34	<li><a href="#cross-compile">Cross-Compiling LLVM</a>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	35	<li><a href="#objfiles">The Location of LLVM Object Files</a>
Chris Lattner	998c067	2004-03-25 20:38:40 +0000	[diff] [blame]	36	<li><a href="#optionalconfig">Optional Configuration Items</a>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	37	</ol></li>
John Criswell	71139f2	2003-07-08 20:35:59 +0000	[diff] [blame]	38
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	39	<li><a href="#layout">Program layout</a>
				40	<ol>
				41	<li><a href="#cvsdir"><tt>CVS</tt> directories</a>
Reid Spencer	5be4f04	2004-12-08 16:18:26 +0000	[diff] [blame]	42	<li><a href="#examples"><tt>llvm/examples</tt></a>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	43	<li><a href="#include"><tt>llvm/include</tt></a>
				44	<li><a href="#lib"><tt>llvm/lib</tt></a>
Reid Spencer	5be4f04	2004-12-08 16:18:26 +0000	[diff] [blame]	45	<li><a href="#projects"><tt>llvm/projects</tt></a>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	46	<li><a href="#runtime"><tt>llvm/runtime</tt></a>
				47	<li><a href="#test"><tt>llvm/test</tt></a>
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	48	<li><a href="#llvmtest"><tt>llvm-test</tt></a>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	49	<li><a href="#tools"><tt>llvm/tools</tt></a>
				50	<li><a href="#utils"><tt>llvm/utils</tt></a>
Reid Spencer	5be4f04	2004-12-08 16:18:26 +0000	[diff] [blame]	51	<li><a href="#win32"><tt>llvm/win32</tt></a>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	52	</ol></li>
John Criswell	f531f31	2003-10-27 18:18:16 +0000	[diff] [blame]	53
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	54	<li><a href="#tutorial">An Example Using the LLVM Tool Chain</a>
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	55	<ol>
				56	<li><a href="#tutorial4">Example with llvm-gcc4</a></li>
				57	<li><a href="#tutorial3">Example with llvm-gcc3</a></li>
				58	</ol>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	59	<li><a href="#problems">Common Problems</a>
				60	<li><a href="#links">Links</a>
				61	</ul>
				62
Chris Lattner	020e1fc	2004-05-23 21:07:27 +0000	[diff] [blame]	63	<div class="doc_author">
				64	<p>Written by:
				65	<a href="mailto:criswell@uiuc.edu">John Criswell</a>,
				66	<a href="mailto:sabre@nondot.org">Chris Lattner</a>,
				67	<a href="http://misha.brukman.net">Misha Brukman</a>,
				68	<a href="http://www.cs.uiuc.edu/~vadve">Vikram Adve</a>, and
				69	<a href="mailto:gshi1@uiuc.edu">Guochun Shi</a>.
				70	</p>
				71	</div>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	72
				73
				74	<!-- *********************************************************************** -->
				75	<div class="doc_section">
				76	<a name="overview"><b>Overview</b></a>
				77	</div>
				78	<!-- *********************************************************************** -->
				79
				80	<div class="doc_text">
				81
				82	<p>Welcome to LLVM! In order to get started, you first need to know some
				83	basic information.</p>
				84
				85	<p>First, LLVM comes in two pieces. The first piece is the LLVM suite. This
				86	contains all of the tools, libraries, and header files needed to use the low
				87	level virtual machine. It contains an assembler, disassembler, bytecode
Reid Spencer	80f843d	2006-08-28 00:34:19 +0000	[diff] [blame]	88	analyzer and bytecode optimizer. It also contains a test suite that can be
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	89	used to test the LLVM tools and the GCC front end.</p>
				90
				91	<p>The second piece is the GCC front end. This component provides a version of
				92	GCC that compiles C and C++ code into LLVM bytecode. Currently, the GCC front
				93	end is a modified version of GCC 3.4 (we track the GCC 3.4 development). Once
				94	compiled into LLVM bytecode, a program can be manipulated with the LLVM tools
				95	from the LLVM suite.</p>
				96
John Criswell	6ab273c	2004-12-08 17:53:54 +0000	[diff] [blame]	97	<p>
				98	There is a third, optional piece called llvm-test. It is a suite of programs
				99	with a testing harness that can be used to further test LLVM's functionality
				100	and performance.
				101	</p>
				102
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	103	</div>
				104
				105	<!-- *********************************************************************** -->
				106	<div class="doc_section">
				107	<a name="quickstart"><b>Getting Started Quickly (A Summary)</b></a>
				108	</div>
				109	<!-- *********************************************************************** -->
				110
				111	<div class="doc_text">
				112
				113	<p>Here's the short story for getting up and running quickly with LLVM:</p>
				114
				115	<ol>
Reid Spencer	3fbf26a	2004-11-08 00:29:22 +0000	[diff] [blame]	116	<li>Read the documentation.</li>
				117	<li>Read the documentation.</li>
				118	<li>Remember that you were warned twice about reading the documentation.</li>
Misha Brukman	20b8a656	2005-02-03 22:25:23 +0000	[diff] [blame]	119	<li>Install the GCC front end if you intend to compile C or C++:
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	120	<ol>
Reid Spencer	788b0fd	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>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	122	<li><tt>gunzip --stdout cfrontend.<i>platform</i>.tar.gz \| tar -xvf -</tt>
Reid Spencer	788b0fd	2004-12-22 06:29:07 +0000	[diff] [blame]	123	</li>
John Criswell	dfe6a86	2004-12-10 15:51:16 +0000	[diff] [blame]	124	<li><tt>cd cfrontend/<i>platform</i><br>
Reid Spencer	788b0fd	2004-12-22 06:29:07 +0000	[diff] [blame]	125	./fixheaders</tt></li>
John Criswell	cfdeb5c	2005-05-09 16:39:27 +0000	[diff] [blame]	126	<li>Add the cfrontend's "bin" directory to your PATH variable.</li>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	127	</ol></li>
				128
Misha Brukman	20b8a656	2005-02-03 22:25:23 +0000	[diff] [blame]	129	<li>Get the LLVM Source Code
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	130	<ul>
Misha Brukman	20b8a656	2005-02-03 22:25:23 +0000	[diff] [blame]	131	<li>With the distributed files (or use <a href="#checkout">CVS</a>):
Misha Brukman	560e989	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	64f13ab	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	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	135	</ol></li>
				136
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	137	</ul></li>
				138
Misha Brukman	20b8a656	2005-02-03 22:25:23 +0000	[diff] [blame]	139	<li><b>[Optional]</b> Get the Test Suite Source Code
John Criswell	dfe6a86	2004-12-10 15:51:16 +0000	[diff] [blame]	140	<ul>
Misha Brukman	20b8a656	2005-02-03 22:25:23 +0000	[diff] [blame]	141	<li>With the distributed files (or use <a href="#checkout">CVS</a>):
John Criswell	dfe6a86	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>
John Criswell	dfe6a86	2004-12-10 15:51:16 +0000	[diff] [blame]	146	</ol></li>
				147
John Criswell	dfe6a86	2004-12-10 15:51:16 +0000	[diff] [blame]	148	</ul></li>
				149
				150
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	151	<li>Configure the LLVM Build Environment
				152	<ol>
Misha Brukman	20b8a656	2005-02-03 22:25:23 +0000	[diff] [blame]	153	<li><tt>cd <i>where-you-want-to-build-llvm</i></tt></li>
				154	<li><tt><i>/path/to/llvm/</i>configure [options]</tt><br>
				155	Some common options:
				156
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	157	<ul>
Reid Spencer	788b0fd	2004-12-22 06:29:07 +0000	[diff] [blame]	158	<li><tt>--prefix=<i>directory</i></tt>
				159	<p>Specify for <i>directory</i> the full pathname of where you
Misha Brukman	20b8a656	2005-02-03 22:25:23 +0000	[diff] [blame]	160	want the LLVM tools and libraries to be installed (default
				161	<tt>/usr/local</tt>).</p></li>
Reid Spencer	6bfa7a4	2004-12-26 05:47:26 +0000	[diff] [blame]	162	<li><tt>--with-llvmgccdir=<i>directory</i></tt>
				163	<p>Optionally, specify for <i>directory</i> the full pathname of the
John Criswell	cfdeb5c	2005-05-09 16:39:27 +0000	[diff] [blame]	164	C/C++ front end installation to use with this LLVM configuration. If
Reid Spencer	6bfa7a4	2004-12-26 05:47:26 +0000	[diff] [blame]	165	not specified, the PATH will be searched.</p></li>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	166	<li><tt>--enable-spec2000=<i>directory</i></tt>
				167	<p>Enable the SPEC2000 benchmarks for testing. The SPEC2000
				168	benchmarks should be available in
				169	<tt><i>directory</i></tt>.</p></li>
				170	</ul>
				171	</ol></li>
				172
				173	<li>Build the LLVM Suite:
				174	<ol>
Chris Lattner	e0050f0	2004-07-18 22:32:22 +0000	[diff] [blame]	175	<li><tt>gmake -k \|& tee gnumake.out
				176	# this is csh or tcsh syntax</tt></li>
				177	<li>If you get an "internal compiler error (ICE)" see <a href="#brokengcc">below</a>.</li>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	178	</ol>
				179
				180	</ol>
				181
Chris Lattner	53e5e2a	2004-06-21 22:52:48 +0000	[diff] [blame]	182	<p>Consult the <a href="#starting">Getting Started with LLVM</a> section for
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	183	detailed information on configuring and compiling LLVM. See <a
				184	href="#environment">Setting Up Your Environment</a> for tips that simplify
				185	working with the GCC front end and LLVM tools. Go to <a href="#layout">Program
				186	Layout</a> to learn about the layout of the source code tree.</p>
				187
				188	</div>
				189
				190	<!-- *********************************************************************** -->
				191	<div class="doc_section">
				192	<a name="requirements"><b>Requirements</b></a>
				193	</div>
				194	<!-- *********************************************************************** -->
				195
				196	<div class="doc_text">
				197
				198	<p>Before you begin to use the LLVM system, review the requirements given below.
				199	This may save you some trouble by knowing ahead of time what hardware and
				200	software you will need.</p>
				201
				202	</div>
				203
				204	<!-- ======================================================================= -->
				205	<div class="doc_subsection">
				206	<a name="hardware"><b>Hardware</b></a>
				207	</div>
				208
				209	<div class="doc_text">
				210
				211	<p>LLVM is known to work on the following platforms:</p>
				212
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	213	<table cellpadding="3" summary="Known LLVM platforms">
Misha Brukman	b068167	2004-11-15 05:19:53 +0000	[diff] [blame]	214	<tr>
				215	<th>OS</th>
				216	<th>Arch</th>
Misha Brukman	1ed0fa5	2004-11-19 21:53:22 +0000	[diff] [blame]	217	<th>Compilers</th>
Misha Brukman	b068167	2004-11-15 05:19:53 +0000	[diff] [blame]	218	</tr>
				219	<tr>
				220	<td>Linux</td>
Chris Lattner	ac648f5	2005-02-09 21:15:51 +0000	[diff] [blame]	221	<td>x86<sup><a href="#pf_1">1</a></sup></td>
Misha Brukman	1ed0fa5	2004-11-19 21:53:22 +0000	[diff] [blame]	222	<td>GCC</td>
Misha Brukman	b068167	2004-11-15 05:19:53 +0000	[diff] [blame]	223	</tr>
				224	<tr>
				225	<td>Solaris</td>
				226	<td>V9 (Ultrasparc)</td>
Misha Brukman	1ed0fa5	2004-11-19 21:53:22 +0000	[diff] [blame]	227	<td>GCC</td>
Misha Brukman	b068167	2004-11-15 05:19:53 +0000	[diff] [blame]	228	</tr>
				229	<tr>
				230	<td>FreeBSD</td>
Chris Lattner	ac648f5	2005-02-09 21:15:51 +0000	[diff] [blame]	231	<td>x86<sup><a href="#pf_1">1</a></sup></td>
Misha Brukman	1ed0fa5	2004-11-19 21:53:22 +0000	[diff] [blame]	232	<td>GCC</td>
Misha Brukman	b068167	2004-11-15 05:19:53 +0000	[diff] [blame]	233	</tr>
				234	<tr>
Chris Lattner	ac648f5	2005-02-09 21:15:51 +0000	[diff] [blame]	235	<td>MacOS X<sup><a href="#pf_2">2</a></sup></td>
Misha Brukman	b068167	2004-11-15 05:19:53 +0000	[diff] [blame]	236	<td>PowerPC</td>
Misha Brukman	1ed0fa5	2004-11-19 21:53:22 +0000	[diff] [blame]	237	<td>GCC</td>
Misha Brukman	b068167	2004-11-15 05:19:53 +0000	[diff] [blame]	238	</tr>
				239	<tr>
Tanya Lattner	fb76291	2006-04-20 04:35:34 +0000	[diff] [blame]	240	<td>MacOS X<sup><a href="#pf_2">2</a></sup></td>
				241	<td>x86</td>
				242	<td>GCC</td>
				243
				244	</tr>
				245	<tr>
Misha Brukman	1ed0fa5	2004-11-19 21:53:22 +0000	[diff] [blame]	246	<td>Cygwin/Win32</td>
Chris Lattner	9a96426	2006-07-21 00:06:27 +0000	[diff] [blame]	247	<td>x86<sup><a href="#pf_1">1</a>,<a href="#pf_8">8</a></sup></td>
Reid Spencer	a8acd82	2004-12-23 19:39:54 +0000	[diff] [blame]	248	<td>GCC 3.4.X, binutils 2.15</td>
Misha Brukman	1ed0fa5	2004-11-19 21:53:22 +0000	[diff] [blame]	249	</tr>
Misha Brukman	5ac308f	2004-12-23 07:14:56 +0000	[diff] [blame]	250	<tr>
Chris Lattner	093ffb0	2005-02-09 20:43:48 +0000	[diff] [blame]	251	<td>MinGW/Win32</td>
Chris Lattner	9a96426	2006-07-21 00:06:27 +0000	[diff] [blame]	252	<td>x86<sup><a href="#pf_1">1</a>,<a href="#pf_6">6</a>,<a href="#pf_8">8</a></sup></td>
Chris Lattner	093ffb0	2005-02-09 20:43:48 +0000	[diff] [blame]	253	<td>GCC 3.4.X, binutils 2.15</td>
				254	</tr>
				255	<tr>
Misha Brukman	5ac308f	2004-12-23 07:14:56 +0000	[diff] [blame]	256	<td>Linux</td>
Chris Lattner	ac648f5	2005-02-09 21:15:51 +0000	[diff] [blame]	257	<td>amd64<sup><a href="#pf_3">3</a></sup></td>
Misha Brukman	5ac308f	2004-12-23 07:14:56 +0000	[diff] [blame]	258	<td>GCC</td>
				259	</tr>
Misha Brukman	1ed0fa5	2004-11-19 21:53:22 +0000	[diff] [blame]	260	</table>
				261
				262	<p>LLVM has partial support for the following platforms:</p>
				263
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	264	<table summary="LLVM partial platform support">
Misha Brukman	1ed0fa5	2004-11-19 21:53:22 +0000	[diff] [blame]	265	<tr>
				266	<th>OS</th>
				267	<th>Arch</th>
				268	<th>Compilers</th>
Misha Brukman	b068167	2004-11-15 05:19:53 +0000	[diff] [blame]	269	</tr>
Misha Brukman	dca7238	2004-11-15 21:05:08 +0000	[diff] [blame]	270	<tr>
Misha Brukman	1ed0fa5	2004-11-19 21:53:22 +0000	[diff] [blame]	271	<td>Windows</td>
Chris Lattner	ac648f5	2005-02-09 21:15:51 +0000	[diff] [blame]	272	<td>x86<sup><a href="#pf_1">1</a></sup></td>
				273	<td>Visual Studio .NET<sup><a href="#pf_4">4</a>,<a href="#pf_5">5</a></sup></td>
Misha Brukman	1ed0fa5	2004-11-19 21:53:22 +0000	[diff] [blame]	274	<tr>
Chris Lattner	ac648f5	2005-02-09 21:15:51 +0000	[diff] [blame]	275	<td>AIX<sup><a href="#pf_3">3</a>,<a href="#pf_4">4</a></sup></td>
Misha Brukman	dca7238	2004-11-15 21:05:08 +0000	[diff] [blame]	276	<td>PowerPC</td>
Misha Brukman	1ed0fa5	2004-11-19 21:53:22 +0000	[diff] [blame]	277	<td>GCC</td>
				278	</tr>
				279	<tr>
Chris Lattner	ac648f5	2005-02-09 21:15:51 +0000	[diff] [blame]	280	<td>Linux<sup><a href="#pf_3">3</a>,<a href="#pf_5">5</a></sup></td>
Misha Brukman	1ed0fa5	2004-11-19 21:53:22 +0000	[diff] [blame]	281	<td>PowerPC</td>
				282	<td>GCC</td>
Misha Brukman	dca7238	2004-11-15 21:05:08 +0000	[diff] [blame]	283	</tr>
John Criswell	05990f3	2005-05-09 16:49:59 +0000	[diff] [blame]	284
				285	<tr>
				286	<td>Linux<sup><a href="#pf_7">7</a></sup></td>
				287	<td>Alpha</td>
				288	<td>GCC</td>
				289	</tr>
				290	<tr>
				291	<td>Linux<sup><a href="#pf_7">7</a></sup></td>
				292	<td>Itanium (IA-64)</td>
				293	<td>GCC</td>
				294	</tr>
Duraid Madina	332b16a	2005-05-10 06:57:53 +0000	[diff] [blame]	295	<tr>
				296	<td>HP-UX<sup><a href="#pf_7">7</a></sup></td>
				297	<td>Itanium (IA-64)</td>
				298	<td>HP aCC</td>
				299	</tr>
Misha Brukman	b068167	2004-11-15 05:19:53 +0000	[diff] [blame]	300	</table>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	301
Misha Brukman	7772309	2005-02-09 21:01:26 +0000	[diff] [blame]	302	<p><b>Notes:</b></p>
				303
Misha Brukman	0c4b8b6	2005-02-09 22:38:47 +0000	[diff] [blame]	304	<div class="doc_notes">
				305	<ol>
				306	<li><a name="pf_1">Code generation supported for Pentium processors and
				307	up</a></li>
				308	<li><a name="pf_2">Code generation supported for 32-bit ABI only</a></li>
				309	<li><a name="pf_3">No native code generation</a></li>
				310	<li><a name="pf_4">Build is not complete: one or more tools don't link</a></li>
				311	<li><a name="pf_5">The GCC-based C/C++ frontend does not build</a></li>
Chris Lattner	5b560d9	2006-08-14 20:45:25 +0000	[diff] [blame]	312	<li><a name="pf_6">The port is done using the MSYS shell.</a>
Misha Brukman	7772309	2005-02-09 21:01:26 +0000	[diff] [blame]	313	<a href="http://www.mingw.org/MinGWiki/">Download</a> and install
Chris Lattner	9a96426	2006-07-21 00:06:27 +0000	[diff] [blame]	314	bison (excl. M4.exe) and flex in that order. Build binutils-2.15 from source,
Chris Lattner	5b560d9	2006-08-14 20:45:25 +0000	[diff] [blame]	315	if necessary. Bison & flex can be also grabbed from GNUWin32 sf.net
				316	project.</li>
John Criswell	05990f3	2005-05-09 16:49:59 +0000	[diff] [blame]	317	<li><a name="pf_7">Native code generation exists but is not complete.</a></li>
Chris Lattner	5b560d9	2006-08-14 20:45:25 +0000	[diff] [blame]	318	<li><a name="pf_8">Binutils</a> up to post-2.17 has bug in bfd/cofflink.c
Chris Lattner	9a96426	2006-07-21 00:06:27 +0000	[diff] [blame]	319	preventing LLVM from building correctly. Several workarounds have been
				320	introduced into LLVM build system, but the bug can occur anytime in the
Chris Lattner	5b560d9	2006-08-14 20:45:25 +0000	[diff] [blame]	321	future. We highly recommend that you rebuild your current binutils with the
Chris Lattner	9a96426	2006-07-21 00:06:27 +0000	[diff] [blame]	322	patch from <a href="http://sourceware.org/bugzilla/show_bug.cgi?id=2659">
Chris Lattner	5b560d9	2006-08-14 20:45:25 +0000	[diff] [blame]	323	Binutils bugzilla</a>, if it wasn't already applied.</li>
Misha Brukman	7772309	2005-02-09 21:01:26 +0000	[diff] [blame]	324	</ol>
Misha Brukman	7772309	2005-02-09 21:01:26 +0000	[diff] [blame]	325	</div>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	326
Misha Brukman	1ed0fa5	2004-11-19 21:53:22 +0000	[diff] [blame]	327	<p>Note that you will need about 1-3 GB of space for a full LLVM build in Debug
John Criswell	e1a8120	2005-05-18 19:43:33 +0000	[diff] [blame]	328	mode, depending on the system (it is so large because of all the debugging
				329	information and the fact that the libraries are statically linked into multiple
				330	tools). If you do not need many of the tools and you are space-conscious,
Misha Brukman	1ed0fa5	2004-11-19 21:53:22 +0000	[diff] [blame]	331	you can disable them individually in <tt>llvm/tools/Makefile</tt>. The Release
				332	build requires considerably less space.</p>
				333
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	334	<p>The LLVM suite <i>may</i> compile on other platforms, but it is not
				335	guaranteed to do so. If compilation is successful, the LLVM utilities should be
				336	able to assemble, disassemble, analyze, and optimize LLVM bytecode. Code
				337	generation should work as well, although the generated native code may not work
				338	on your platform.</p>
				339
				340	<p>The GCC front end is not very portable at the moment. If you want to get it
Misha Brukman	876d5f1	2004-08-09 19:57:01 +0000	[diff] [blame]	341	to work on another platform, you can download a copy of the source and <a
				342	href="CFEBuildInstrs.html">try to compile it</a> on your platform.</p>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	343
				344	</div>
				345
				346	<!-- ======================================================================= -->
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	347	<div class="doc_subsection"><a name="software"><b>Software</b></a></div>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	348	<div class="doc_text">
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	349	<p>Compiling LLVM requires that you have several software packages
				350	installed. The table below lists those required packages. The Package column
				351	is the usual name for the software package that LLVM depends on. The Version
				352	column provides "known to work" versions of the package. The Notes column
				353	describes how LLVM uses the package and provides other details.</p>
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	354	<table summary="Packages required to compile LLVM">
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	355	<tr><th>Package</th><th>Version</th><th>Notes</th></tr>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	356
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	357	<tr>
				358	<td><a href="http://savannah.gnu.org/projects/make">GNU Make</a></td>
				359	<td>3.79, 3.79.1</td>
				360	<td>Makefile/build processor</td>
				361	</tr>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	362
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	363	<tr>
				364	<td><a href="http://gcc.gnu.org">GCC</a></td>
				365	<td>3.4.2</td>
Misha Brukman	0c4b8b6	2005-02-09 22:38:47 +0000	[diff] [blame]	366	<td>C/C++ compiler<sup><a href="#sf1">1</a></sup></td>
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	367	</tr>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	368
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	369	<tr>
Chris Lattner	f1705fd	2005-09-06 04:07:15 +0000	[diff] [blame]	370	<td><a href="http://www.gnu.org/software/texinfo">TeXinfo</a></td>
				371	<td>4.5</td>
				372	<td>For building the CFE</td>
				373	</tr>
				374
				375	<tr>
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	376	<td><a href="http://www.gnu.org/software/flex">Flex</a></td>
				377	<td>2.5.4</td>
				378	<td>LEX compiler</td>
				379	</tr>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	380
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	381	<tr>
				382	<td><a href="http://www.gnu.org/software/bison/bison.html">Bison</a></td>
Jeff Cohen	7120107	2006-01-04 06:51:22 +0000	[diff] [blame]	383	<td>1.28, 1.35, 1.75, 1.875d, 2.0, or 2.1<br>(not 1.85 or 1.875)</td>
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	384	<td>YACC compiler</td>
				385	</tr>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	386
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	387	<tr>
Misha Brukman	0c4b8b6	2005-02-09 22:38:47 +0000	[diff] [blame]	388	<td><a href="https://www.cvshome.org/downloads.html">CVS</a></td>
				389	<td>≥1.11</td>
				390	<td>CVS access to LLVM<sup><a href="#sf2">2</a></sup></td>
				391	</tr>
				392
				393	<tr>
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	394	<td><a href="http://savannah.gnu.org/projects/dejagnu">DejaGnu</a></td>
				395	<td>1.4.2</td>
Misha Brukman	0c4b8b6	2005-02-09 22:38:47 +0000	[diff] [blame]	396	<td>Automated test suite<sup><a href="#sf3">3</a></sup></td>
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	397	</tr>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	398
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	399	<tr>
				400	<td><a href="http://www.tcl.tk/software/tcltk/">tcl</a></td>
				401	<td>8.3, 8.4</td>
Misha Brukman	0c4b8b6	2005-02-09 22:38:47 +0000	[diff] [blame]	402	<td>Automated test suite<sup><a href="#sf3">3</a></sup></td>
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	403	</tr>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	404
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	405	<tr>
				406	<td><a href="http://expect.nist.gov/">expect</a></td>
				407	<td>5.38.0</td>
Misha Brukman	0c4b8b6	2005-02-09 22:38:47 +0000	[diff] [blame]	408	<td>Automated test suite<sup><a href="#sf3">3</a></sup></td>
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	409	</tr>
				410
				411	<tr>
				412	<td><a href="http://www.perl.com/download.csp">perl</a></td>
Reid Spencer	098fce4	2004-12-09 17:55:37 +0000	[diff] [blame]	413	<td>≥5.6.0</td>
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	414	<td>Nightly tester, utilities</td>
				415	</tr>
				416
				417	<tr>
Misha Brukman	0c4b8b6	2005-02-09 22:38:47 +0000	[diff] [blame]	418	<td><a href="http://savannah.gnu.org/projects/m4">GNU M4</a>
				419	<td>1.4</td>
				420	<td>Macro processor for configuration<sup><a href="#sf4">4</a></sup></td>
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	421	</tr>
				422
				423	<tr>
Misha Brukman	0c4b8b6	2005-02-09 22:38:47 +0000	[diff] [blame]	424	<td><a href="http://www.gnu.org/software/autoconf">GNU Autoconf</a></td>
				425	<td>2.59</td>
				426	<td>Configuration script builder<sup><a href="#sf4">4</a></sup></td>
				427	</tr>
				428
				429	<tr>
				430	<td><a href="http://www.gnu.org/software/automake">GNU Automake</a></td>
				431	<td>1.9.2</td>
				432	<td>aclocal macro generator<sup><a href="#sf4">4</a></sup></td>
				433	</tr>
				434
				435	<tr>
				436	<td><a href="http://savannah.gnu.org/projects/libtool">libtool</a></td>
				437	<td>1.5.10</td>
				438	<td>Shared library manager<sup><a href="#sf4">4</a></sup></td>
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	439	</tr>
				440
				441	</table>
				442
Misha Brukman	0c4b8b6	2005-02-09 22:38:47 +0000	[diff] [blame]	443	<p><b>Notes:</b></p>
				444	<div class="doc_notes">
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	445	<ol>
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	446	<li><a name="sf1">Only the C and C++ languages are needed so there's no
Misha Brukman	0c4b8b6	2005-02-09 22:38:47 +0000	[diff] [blame]	447	need to build the other languages for LLVM's purposes.</a> See
				448	<a href="#brokengcc">below</a> for specific version info.</li>
				449	<li><a name="sf2">You only need CVS if you intend to build from the
				450	latest LLVM sources. If you're working from a release distribution, you
				451	don't need CVS.</a></li>
				452	<li><a name="sf3">Only needed if you want to run the automated test
				453	suite in the <tt>llvm/test</tt> directory.</a></li>
				454	<li><a name="sf4">If you want to make changes to the configure scripts,
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	455	you will need GNU autoconf (2.59), and consequently, GNU M4 (version 1.4
Reid Spencer	098fce4	2004-12-09 17:55:37 +0000	[diff] [blame]	456	or higher). You will also need automake (1.9.2). We only use aclocal
				457	from that package.</a></li>
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	458	</ol>
Misha Brukman	0c4b8b6	2005-02-09 22:38:47 +0000	[diff] [blame]	459	</div>
				460
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	461	<p>Additionally, your compilation host is expected to have the usual
				462	plethora of Unix utilities. Specifically:</p>
				463	<ul>
				464	<li><b>ar</b> - archive library builder</li>
				465	<li><b>bzip2*</b> - bzip2 command for distribution generation</li>
				466	<li><b>bunzip2*</b> - bunzip2 command for distribution checking</li>
				467	<li><b>chmod</b> - change permissions on a file</li>
John Criswell	33e0f06	2004-12-08 16:55:27 +0000	[diff] [blame]	468	<li><b>cat</b> - output concatenation utility</li>
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	469	<li><b>cp</b> - copy files</li>
				470	<li><b>date</b> - print the current date/time </li>
				471	<li><b>echo</b> - print to standard output</li>
				472	<li><b>egrep</b> - extended regular expression search utility</li>
				473	<li><b>etags</b> - C/C++ tag file creator for vim/emacs</li>
				474	<li><b>find</b> - find files/dirs in a file system</li>
				475	<li><b>grep</b> - regular expression search utility</li>
				476	<li><b>gzip*</b> - gzip command for distribution generation</li>
				477	<li><b>gunzip*</b> - gunzip command for distribution checking</li>
				478	<li><b>install</b> - install directories/files </li>
				479	<li><b>mkdir</b> - create a directory</li>
				480	<li><b>mv</b> - move (rename) files</li>
				481	<li><b>ranlib</b> - symbol table builder for archive libraries</li>
Misha Brukman	29d3d46	2004-11-20 01:27:40 +0000	[diff] [blame]	482	<li><b>rm</b> - remove (delete) files and directories</li>
Reid Spencer	38fcf30	2004-11-15 21:15:12 +0000	[diff] [blame]	483	<li><b>sed</b> - stream editor for transforming output</li>
				484	<li><b>sh</b> - Bourne shell for make build scripts</li>
				485	<li><b>tar</b> - tape archive for distribution generation</li>
				486	<li><b>test</b> - test things in file system</li>
				487	<li><b>unzip*</b> - unzip command for distribution checking</li>
				488	<li><b>zip*</b> - zip command for distribution generation</li>
				489	</ul>
Chris Lattner	e0050f0	2004-07-18 22:32:22 +0000	[diff] [blame]	490	</div>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	491
Chris Lattner	e0050f0	2004-07-18 22:32:22 +0000	[diff] [blame]	492	<!-- ======================================================================= -->
				493	<div class="doc_subsection">
				494	<a name="brokengcc">Broken versions of GCC</a>
				495	</div>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	496
Chris Lattner	e0050f0	2004-07-18 22:32:22 +0000	[diff] [blame]	497	<div class="doc_text">
				498
				499	<p>LLVM is very demanding of the host C++ compiler, and as such tends to expose
				500	bugs in the compiler. In particular, several versions of GCC crash when trying
Chris Lattner	29052c8	2006-06-16 17:20:33 +0000	[diff] [blame]	501	to compile LLVM. We routinely use GCC 3.3.3, 3.4.0, and Apple 4.0.1
				502	successfully with them (however, see below). Other versions of GCC will
				503	probably work as well. GCC versions listed
Chris Lattner	e0050f0	2004-07-18 22:32:22 +0000	[diff] [blame]	504	here are known to not work. If you are using one of these versions, please try
				505	to upgrade your GCC to something more recent. If you run into a problem with a
				506	version of GCC not listed here, please <a href="mailto:llvmdev@cs.uiuc.edu">let
				507	us know</a>. Please use the "<tt>gcc -v</tt>" command to find out which version
				508	of GCC you are using.
				509	</p>
				510
				511	<p><b>GCC versions prior to 3.0</b>: GCC 2.96.x and before had several
				512	problems in the STL that effectively prevent it from compiling LLVM.
				513	</p>
				514
John Criswell	fd76945	2004-11-23 22:06:24 +0000	[diff] [blame]	515	<p><b>GCC 3.2.2</b>: This version of GCC fails to compile LLVM.</p>
				516
Chris Lattner	e0050f0	2004-07-18 22:32:22 +0000	[diff] [blame]	517	<p><b>GCC 3.3.2</b>: This version of GCC suffered from a <a
				518	href="http://gcc.gnu.org/PR13392">serious bug</a> which causes it to crash in
				519	the "<tt>convert_from_eh_region_ranges_1</tt>" GCC function.</p>
Chris Lattner	e254e2f	2005-02-12 20:11:13 +0000	[diff] [blame]	520
Chris Lattner	5824762	2005-02-13 22:20:49 +0000	[diff] [blame]	521	<p><b>Cygwin GCC 3.3.3</b>: The version of GCC 3.3.3 commonly shipped with
				522	Cygwin does not work. Please <a href="CFEBuildInstrs.html#cygwin">upgrade
				523	to a newer version</a> if possible.</p>
				524	<p><b>SuSE GCC 3.3.3</b>: The version of GCC 3.3.3 shipped with SuSE 9.1 (and
				525	possibly others) does not compile LLVM correctly (it appears that exception
				526	handling is broken in some cases). Please download the FSF 3.3.3 or upgrade
				527	to a newer version of GCC.</p>
Chris Lattner	7caf6f6	2005-05-15 22:26:45 +0000	[diff] [blame]	528	<p><b>IA-64 GCC 4.0.0</b>: The IA-64 version of GCC 4.0.0 is known to
				529	miscompile LLVM.</p>
Chris Lattner	c9ede19	2006-06-16 19:53:39 +0000	[diff] [blame]	530	<p><b>Apple Xcode 2.3</b>: GCC crashes when compiling LLVM at -O3 (which is the
				531	default with ENABLE_OPTIMIZED=1. To work around this, build with
				532	"ENABLE_OPTIMIZED=1 OPTIMIZE_OPTION=-O2".</p>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	533	</div>
				534
Chris Lattner	e0050f0	2004-07-18 22:32:22 +0000	[diff] [blame]	535
				536
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	537	<!-- *********************************************************************** -->
				538	<div class="doc_section">
				539	<a name="starting"><b>Getting Started with LLVM</b></a>
				540	</div>
				541	<!-- *********************************************************************** -->
				542
Chris Lattner	e0050f0	2004-07-18 22:32:22 +0000	[diff] [blame]	543	<div class="doc_text">
				544
				545	<p>The remainder of this guide is meant to get you up and running with
				546	LLVM and to give you some basic information about the LLVM environment.</p>
				547
				548	<p>The later sections of this guide describe the <a
				549	href="#layout">general layout</a> of the the LLVM source tree, a <a
				550	href="#tutorial">simple example</a> using the LLVM tool chain, and <a
				551	href="#links">links</a> to find more information about LLVM or to get
				552	help via e-mail.</p>
				553	</div>
				554
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	555	<!-- ======================================================================= -->
				556	<div class="doc_subsection">
				557	<a name="terminology">Terminology and Notation</a>
				558	</div>
				559
				560	<div class="doc_text">
				561
				562	<p>Throughout this manual, the following names are used to denote paths
				563	specific to the local system and working environment. <i>These are not
				564	environment variables you need to set but just strings used in the rest
				565	of this document below</i>. In any of the examples below, simply replace
				566	each of these names with the appropriate pathname on your local system.
				567	All these paths are absolute:</p>
				568
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	569	<dl>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	570	<dt>SRC_ROOT
				571	<dd>
				572	This is the top level directory of the LLVM source tree.
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	573	<br><br>
John Criswell	f531f31	2003-10-27 18:18:16 +0000	[diff] [blame]	574
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	575	<dt>OBJ_ROOT
				576	<dd>
				577	This is the top level directory of the LLVM object tree (i.e. the
				578	tree where object files and compiled programs will be placed. It
				579	can be the same as SRC_ROOT).
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	580	<br><br>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	581
				582	<dt>LLVMGCCDIR
				583	<dd>
Reid Spencer	6bfa7a4	2004-12-26 05:47:26 +0000	[diff] [blame]	584	This is where the LLVM GCC Front End is installed.
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	585	<p>
				586	For the pre-built GCC front end binaries, the LLVMGCCDIR is
				587	<tt>cfrontend/<i>platform</i>/llvm-gcc</tt>.
				588	</dl>
				589
				590	</div>
				591
				592	<!-- ======================================================================= -->
				593	<div class="doc_subsection">
				594	<a name="environment">Setting Up Your Environment</a>
				595	</div>
				596
				597	<div class="doc_text">
				598
				599	<p>
Misha Brukman	cd67325	2005-02-03 18:28:08 +0000	[diff] [blame]	600	In order to compile and use LLVM, you may need to set some environment
				601	variables.
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	602
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	603	<dl>
Reid Spencer	360d6b7	2004-12-15 00:14:01 +0000	[diff] [blame]	604	<dt><tt>LLVM_LIB_SEARCH_PATH</tt>=<tt>/path/to/your/bytecode/libs</tt></dt>
Misha Brukman	cd67325	2005-02-03 18:28:08 +0000	[diff] [blame]	605	<dd>[Optional] This environment variable helps LLVM linking tools find the
John Criswell	e1a8120	2005-05-18 19:43:33 +0000	[diff] [blame]	606	locations of your bytecode libraries. It is provided only as a
Misha Brukman	cd67325	2005-02-03 18:28:08 +0000	[diff] [blame]	607	convenience since you can specify the paths using the -L options of the
John Criswell	e1a8120	2005-05-18 19:43:33 +0000	[diff] [blame]	608	tools and the C/C++ front-end will automatically use the bytecode files
				609	installed in its
Misha Brukman	cd67325	2005-02-03 18:28:08 +0000	[diff] [blame]	610	<tt>lib</tt> directory.</dd>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	611	</dl>
				612
				613	</div>
				614
				615	<!-- ======================================================================= -->
				616	<div class="doc_subsection">
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	617	<a name="unpack">Unpacking the LLVM Archives</a>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	618	</div>
				619
				620	<div class="doc_text">
				621
				622	<p>
				623	If you have the LLVM distribution, you will need to unpack it before you
John Criswell	86a3a48	2003-12-18 16:43:17 +0000	[diff] [blame]	624	can begin to compile it. LLVM is distributed as a set of two files: the LLVM
John Criswell	dfe6a86	2004-12-10 15:51:16 +0000	[diff] [blame]	625	suite and the LLVM GCC front end compiled for your platform. There is an
				626	additional test suite that is optional. Each file is a TAR archive that is
				627	compressed with the gzip program.
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	628	</p>
				629
Misha Brukman	d4528ea	2005-02-02 18:01:57 +0000	[diff] [blame]	630	<p>The files are as follows, with <em>x.y</em> marking the version number:
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	631	<dl>
Misha Brukman	d4528ea	2005-02-02 18:01:57 +0000	[diff] [blame]	632	<dt><tt>llvm-x.y.tar.gz</tt></dt>
				633	<dd>Source release for the LLVM libraries and tools.<br/></dd>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	634
Misha Brukman	d4528ea	2005-02-02 18:01:57 +0000	[diff] [blame]	635	<dt><tt>llvm-test-x.y.tar.gz</tt></dt>
Chris Lattner	ac648f5	2005-02-09 21:15:51 +0000	[diff] [blame]	636	<dd>Source release for the LLVM test suite.</dd>
Misha Brukman	c318444	2004-11-23 19:26:24 +0000	[diff] [blame]	637
Misha Brukman	d4528ea	2005-02-02 18:01:57 +0000	[diff] [blame]	638	<dt><tt>cfrontend-x.y.source.tar.gz</tt></dt>
				639	<dd>Source release of the GCC front end.<br/></dd>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	640
Misha Brukman	d4528ea	2005-02-02 18:01:57 +0000	[diff] [blame]	641	<dt><tt>cfrontend-x.y.i686-redhat-linux-gnu.tar.gz</tt></dt>
				642	<dd>Binary release of the GCC front end for Linux/x86.<br/></dd>
John Criswell	86a3a48	2003-12-18 16:43:17 +0000	[diff] [blame]	643
Chris Lattner	499abb5	2006-04-20 05:08:23 +0000	[diff] [blame]	644	<dt><tt>llvm-gcc4-x.y.source.tar.gz</tt></dt>
				645	<dd>Source release of the llvm-gcc4 front end. See README.LLVM in the root
				646	directory for build instructions.<br/></dd>
				647
				648	<dt><tt>llvm-gcc4-x.y.powerpc-apple-darwin8.6.0.tar.gz</tt></dt>
				649	<dd>Binary release of the llvm-gcc4 front end for MacOS X/PowerPC.<br/></dd>
				650
				651	<dt><tt>llvm-gcc4-x.y.i686-apple-darwin8.6.1.tar.gz</tt></dt>
				652	<dd>Binary release of the llvm-gcc4 front end for MacOS X/X86.<br/></dd>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	653	</dl>
				654
Jim Laskey	b4c0347	2006-07-31 21:37:55 +0000	[diff] [blame]	655	<p>It is also possible to download the sources of the llvm-gcc4 front end from a
				656	read-only subversion mirror at
				657	svn://anonsvn.opensource.apple.com/svn/llvm/trunk. </p>
Jim Laskey	34ea26a	2006-06-16 23:20:21 +0000	[diff] [blame]	658
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	659	</div>
				660
				661	<!-- ======================================================================= -->
				662	<div class="doc_subsection">
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	663	<a name="checkout">Checkout LLVM from CVS</a>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	664	</div>
				665
				666	<div class="doc_text">
				667
				668	<p>If you have access to our CVS repository, you can get a fresh copy of
				669	the entire source code. All you need to do is check it out from CVS as
				670	follows:</p>
				671
				672	<ul>
				673	<li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
Chris Lattner	c477427	2006-08-03 22:14:43 +0000	[diff] [blame]	674	<li><tt>cvs -d :pserver:anon@llvm.org:/var/cvs/llvm login</tt>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	675	<li>Hit the return key when prompted for the password.
Chris Lattner	c477427	2006-08-03 22:14:43 +0000	[diff] [blame]	676	<li><tt>cvs -z3 -d :pserver:anon@llvm.org:/var/cvs/llvm co
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	677	llvm</tt>
				678	</ul>
				679
				680	<p>This will create an '<tt>llvm</tt>' directory in the current
				681	directory and fully populate it with the LLVM source code, Makefiles,
				682	test directories, and local copies of documentation files.</p>
				683
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	684	<p>If you want to get a specific release (as opposed to the most recent
				685	revision), you can specify a label. The following releases have the following
Misha Brukman	d4528ea	2005-02-02 18:01:57 +0000	[diff] [blame]	686	labels:</p>
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	687
John Criswell	86a3a48	2003-12-18 16:43:17 +0000	[diff] [blame]	688	<ul>
Tanya Lattner	fb76291	2006-04-20 04:35:34 +0000	[diff] [blame]	689	<li>Release 1.7: <b>RELEASE_17</b></li>
John Criswell	3bdbd30	2005-11-08 21:11:33 +0000	[diff] [blame]	690	<li>Release 1.6: <b>RELEASE_16</b></li>
John Criswell	05990f3	2005-05-09 16:49:59 +0000	[diff] [blame]	691	<li>Release 1.5: <b>RELEASE_15</b></li>
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	692	<li>Release 1.4: <b>RELEASE_14</b></li>
John Criswell	1e87b97	2004-08-16 14:51:33 +0000	[diff] [blame]	693	<li>Release 1.3: <b>RELEASE_13</b></li>
Misha Brukman	c1aac03	2004-05-12 19:25:59 +0000	[diff] [blame]	694	<li>Release 1.2: <b>RELEASE_12</b></li>
				695	<li>Release 1.1: <b>RELEASE_11</b></li>
				696	<li>Release 1.0: <b>RELEASE_1</b></li>
John Criswell	86a3a48	2003-12-18 16:43:17 +0000	[diff] [blame]	697	</ul>
John Criswell	86a3a48	2003-12-18 16:43:17 +0000	[diff] [blame]	698
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	699	<p>If you would like to get the LLVM test suite (a separate package as of 1.4),
				700	you get it from the CVS repository:</p>
				701	<pre>
				702	cd llvm/projects
Chris Lattner	c477427	2006-08-03 22:14:43 +0000	[diff] [blame]	703	cvs -z3 -d :pserver:anon@llvm.org:/var/cvs/llvm co llvm-test
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	704	</pre>
				705	<p>By placing it in the <tt>llvm/projects</tt>, it will be automatically
John Criswell	33e0f06	2004-12-08 16:55:27 +0000	[diff] [blame]	706	configured by the LLVM configure script as well as automatically updated when
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	707	you run <tt>cvs update</tt>.</p>
				708
Tanya Lattner	fb76291	2006-04-20 04:35:34 +0000	[diff] [blame]	709	<p>If you would like to get the GCC 3.4 front end source code, you can also get it from the CVS repository:</p>
Misha Brukman	c1aac03	2004-05-12 19:25:59 +0000	[diff] [blame]	710
Chris Lattner	3337c82	2004-06-28 17:14:01 +0000	[diff] [blame]	711	<pre>
Chris Lattner	c477427	2006-08-03 22:14:43 +0000	[diff] [blame]	712	cvs -z3 -d :pserver:anon@llvm.org:/var/cvs/llvm co llvm-gcc
Misha Brukman	c1aac03	2004-05-12 19:25:59 +0000	[diff] [blame]	713	</pre>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	714
Chris Lattner	3337c82	2004-06-28 17:14:01 +0000	[diff] [blame]	715	<p>Please note that you must follow <a href="CFEBuildInstrs.html">these
John Criswell	6ab273c	2004-12-08 17:53:54 +0000	[diff] [blame]	716	instructions</a> to successfully build the LLVM GCC front-end.</p>
Chris Lattner	3337c82	2004-06-28 17:14:01 +0000	[diff] [blame]	717
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	718	</div>
				719
				720	<!-- ======================================================================= -->
				721	<div class="doc_subsection">
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	722	<a name="installcf">Install the GCC Front End</a>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	723	</div>
				724
				725	<div class="doc_text">
				726
				727	<p>Before configuring and compiling the LLVM suite, you need to extract the LLVM
				728	GCC front end from the binary distribution. It is used for building the
				729	bytecode libraries later used by the GCC front end for linking programs, and its
				730	location must be specified when the LLVM suite is configured.</p>
				731
				732	<p>To install the GCC front end, do the following:</p>
				733
				734	<ol>
				735	<li><tt>cd <i>where-you-want-the-front-end-to-live</i></tt></li>
John Criswell	86a3a48	2003-12-18 16:43:17 +0000	[diff] [blame]	736	<li><tt>gunzip --stdout cfrontend-<i>version</i>.<i>platform</i>.tar.gz \| tar -xvf
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	737	-</tt></li>
				738	</ol>
				739
John Criswell	dfe6a86	2004-12-10 15:51:16 +0000	[diff] [blame]	740	<p>Next, you will need to fix your system header files:</p>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	741
John Criswell	64f13ab	2004-03-12 20:31:37 +0000	[diff] [blame]	742	<p><tt>cd cfrontend/<i>platform</i><br>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	743	./fixheaders</tt></p>
				744
				745	<p>The binary versions of the GCC front end may not suit all of your needs. For
				746	example, the binary distribution may include an old version of a system header
				747	file, not "fix" a header file that needs to be fixed for GCC, or it may be
				748	linked with libraries not available on your system.</p>
				749
				750	<p>In cases like these, you may want to try <a
				751	href="CFEBuildInstrs.html">building the GCC front end from source.</a> This is
				752	not for the faint of heart, so be forewarned.</p>
				753
				754	</div>
				755
				756	<!-- ======================================================================= -->
				757	<div class="doc_subsection">
				758	<a name="config">Local LLVM Configuration</a>
				759	</div>
				760
				761	<div class="doc_text">
				762
				763	<p>Once checked out from the CVS repository, the LLVM suite source code must be
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	764	configured via the <tt>configure</tt> script. This script sets variables in the
				765	various <tt>*.in</tt> files, most notably <tt>llvm/Makefile.config</tt> and
				766	<tt>llvm/include/Config/config.h</tt>. It also populates <i>OBJ_ROOT</i> with
				767	the Makefiles needed to begin building LLVM.</p>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	768
				769	<p>The following environment variables are used by the <tt>configure</tt>
				770	script to configure the build system:</p>
				771
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	772	<table summary="LLVM configure script environment variables">
Reid Spencer	c3c4c4f	2004-11-01 08:19:36 +0000	[diff] [blame]	773	<tr><th>Variable</th><th>Purpose</th></tr>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	774	<tr>
				775	<td>CC</td>
				776	<td>Tells <tt>configure</tt> which C compiler to use. By default,
				777	<tt>configure</tt> will look for the first GCC C compiler in
				778	<tt>PATH</tt>. Use this variable to override
				779	<tt>configure</tt>'s default behavior.</td>
				780	</tr>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	781	<tr>
				782	<td>CXX</td>
				783	<td>Tells <tt>configure</tt> which C++ compiler to use. By default,
				784	<tt>configure</tt> will look for the first GCC C++ compiler in
				785	<tt>PATH</tt>. Use this variable to override
				786	<tt>configure</tt>'s default behavior.</td>
				787	</tr>
				788	</table>
				789
				790	<p>The following options can be used to set or enable LLVM specific options:</p>
				791
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	792	<dl>
Reid Spencer	6bfa7a4	2004-12-26 05:47:26 +0000	[diff] [blame]	793	<dt><i>--with-llvmgccdir</i></dt>
				794	<dd>Path to the LLVM C/C++ FrontEnd to be used with this LLVM configuration.
				795	The value of this option should specify the full pathname of the C/C++ Front
				796	End to be used. If this option is not provided, the PATH will be searched for
				797	a program named <i>llvm-gcc</i> and the C/C++ FrontEnd install directory will
				798	be inferred from the path found. If the option is not given, and no llvm-gcc
				799	can be found in the path then a warning will be produced by
				800	<tt>configure</tt> indicating this situation. LLVM may still be built with
				801	the <tt>tools-only</tt> target but attempting to build the runtime libraries
				802	will fail as these libraries require llvm-gcc and llvm-g++. See
				803	<a href="#installcf">Install the GCC Front End</a> for details on installing
				804	the C/C++ Front End. See
				805	<a href="CFEBuildInstrs.html">Bootstrapping the LLVM C/C++ Front-End</a>
				806	for details on building the C/C++ Front End.</dd>
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	807	<dt><i>--with-tclinclude</i></dt>
John Criswell	e1a8120	2005-05-18 19:43:33 +0000	[diff] [blame]	808	<dd>Path to the tcl include directory under which <tt>tclsh</tt> can be
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	809	found. Use this if you have multiple tcl installations on your machine and you
				810	want to use a specific one (8.x) for LLVM. LLVM only uses tcl for running the
				811	dejagnu based test suite in <tt>llvm/test</tt>. If you don't specify this
John Criswell	e1a8120	2005-05-18 19:43:33 +0000	[diff] [blame]	812	option, the LLVM configure script will search for the tcl 8.4 and 8.3
				813	releases.
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	814	<br><br>
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	815	</dd>
				816	<dt><i>--enable-optimized</i></dt>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	817	<dd>
				818	Enables optimized compilation by default (debugging symbols are removed
				819	and GCC optimization flags are enabled). The default is to use an
				820	unoptimized build (also known as a debug build).
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	821	<br><br>
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	822	</dd>
Reid Spencer	294adbb	2005-12-21 03:46:45 +0000	[diff] [blame]	823	<dt><i>--enable-debug-runtime</i></dt>
				824	<dd>
				825	Enables debug symbols in the runtime libraries. The default is to strip
				826	debug symbols from the runtime libraries.
				827	</dd>
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	828	<dt><i>--enable-jit</i></dt>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	829	<dd>
John Criswell	86a3a48	2003-12-18 16:43:17 +0000	[diff] [blame]	830	Compile the Just In Time (JIT) compiler functionality. This is not
				831	available
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	832	on all platforms. The default is dependent on platform, so it is best
				833	to explicitly enable it if you want it.
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	834	<br><br>
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	835	</dd>
Reid Spencer	1e195bd	2005-04-22 17:58:03 +0000	[diff] [blame]	836	<dt><i>--enable-targets=</i><tt>target-option</tt></dt>
				837	<dd>Controls which targets will be built and linked into llc. The default
				838	value for <tt>target_options</tt> is "all" which builds and links all
				839	available targets. The value "host-only" can be specified to build only a
				840	native compiler (no cross-compiler targets available). The "native" target is
				841	selected as the target of the build host. You can also specify a comma
				842	separated list of target names that you want available in llc. The target
John Criswell	e1a8120	2005-05-18 19:43:33 +0000	[diff] [blame]	843	names use all lower case. The current set of targets is: <br/>
Reid Spencer	1e195bd	2005-04-22 17:58:03 +0000	[diff] [blame]	844	<tt>alpha, ia64, powerpc, skeleton, sparc, x86</tt>.
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	845	<br><br></dd>
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	846	<dt><i>--enable-doxygen</i></dt>
				847	<dd>Look for the doxygen program and enable construction of doxygen based
				848	documentation from the source code. This is disabled by default because
				849	generating the documentation can take a long time and producess 100s of
				850	megabytes of output.</dd>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	851	</dl>
				852
				853	<p>To configure LLVM, follow these steps:</p>
				854
				855	<ol>
				856	<li>Change directory into the object root directory:
John Criswell	f531f31	2003-10-27 18:18:16 +0000	[diff] [blame]	857	<br>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	858	<tt>cd <i>OBJ_ROOT</i></tt>
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	859	<br><br>
John Criswell	f531f31	2003-10-27 18:18:16 +0000	[diff] [blame]	860
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	861	<li>Run the <tt>configure</tt> script located in the LLVM source tree:
				862	<br>
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	863	<tt><i>SRC_ROOT</i>/configure --prefix=/install/path [other options]</tt>
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	864	<br><br>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	865	</ol>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	866
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	867	</div>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	868
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	869	<!-- ======================================================================= -->
				870	<div class="doc_subsection">
				871	<a name="compile">Compiling the LLVM Suite Source Code</a>
				872	</div>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	873
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	874	<div class="doc_text">
John Criswell	71139f2	2003-07-08 20:35:59 +0000	[diff] [blame]	875
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	876	<p>Once you have configured LLVM, you can build it. There are three types of
				877	builds:</p>
John Criswell	71139f2	2003-07-08 20:35:59 +0000	[diff] [blame]	878
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	879	<dl>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	880	<dt>Debug Builds
John Criswell	c5eb460	2003-07-03 16:01:38 +0000	[diff] [blame]	881	<dd>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	882	These builds are the default when one types <tt>gmake</tt> (unless the
				883	<tt>--enable-optimized</tt> option was used during configuration). The
				884	build system will compile the tools and libraries with debugging
				885	information.
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	886	<br><br>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	887
				888	<dt>Release (Optimized) Builds
John Criswell	c5eb460	2003-07-03 16:01:38 +0000	[diff] [blame]	889	<dd>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	890	These builds are enabled with the <tt>--enable-optimized</tt> option to
				891	<tt>configure</tt> or by specifying <tt>ENABLE_OPTIMIZED=1</tt> on the
				892	<tt>gmake</tt> command line. For these builds, the build system will
				893	compile the tools and libraries with GCC optimizations enabled and strip
				894	debugging information from the libraries and executables it generates.
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	895	<br><br>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	896
				897	<dt>Profile Builds
John Criswell	c5eb460	2003-07-03 16:01:38 +0000	[diff] [blame]	898	<dd>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	899	These builds are for use with profiling. They compile profiling
				900	information into the code for use with programs like <tt>gprof</tt>.
				901	Profile builds must be started by specifying <tt>ENABLE_PROFILING=1</tt>
				902	on the <tt>gmake</tt> command line.
				903	</dl>
John Criswell	3ef61af	2003-06-30 21:59:07 +0000	[diff] [blame]	904
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	905	<p>Once you have LLVM configured, you can build it by entering the
				906	<i>OBJ_ROOT</i> directory and issuing the following command:</p>
John Criswell	38cc2b5	2003-10-10 14:26:14 +0000	[diff] [blame]	907
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	908	<p><tt>gmake</tt></p>
John Criswell	38cc2b5	2003-10-10 14:26:14 +0000	[diff] [blame]	909
Chris Lattner	e0050f0	2004-07-18 22:32:22 +0000	[diff] [blame]	910	<p>If the build fails, please <a href="#brokengcc">check here</a> to see if you
John Criswell	6ab273c	2004-12-08 17:53:54 +0000	[diff] [blame]	911	are using a version of GCC that is known not to compile LLVM.</p>
Chris Lattner	e0050f0	2004-07-18 22:32:22 +0000	[diff] [blame]	912
				913	<p>
				914	If you have multiple processors in your machine, you may wish to use some of
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	915	the parallel build options provided by GNU Make. For example, you could use the
				916	command:</p>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	917
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	918	<p><tt>gmake -j2</tt></p>
John Criswell	c5eb460	2003-07-03 16:01:38 +0000	[diff] [blame]	919
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	920	<p>There are several special targets which are useful when working with the LLVM
				921	source code:</p>
John Criswell	c5eb460	2003-07-03 16:01:38 +0000	[diff] [blame]	922
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	923	<dl>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	924	<dt><tt>gmake clean</tt>
				925	<dd>
				926	Removes all files generated by the build. This includes object files,
				927	generated C/C++ files, libraries, and executables.
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	928	<br><br>
John Criswell	c5eb460	2003-07-03 16:01:38 +0000	[diff] [blame]	929
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	930	<dt><tt>gmake dist-clean</tt>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	931	<dd>
Misha Brukman	5d41391	2004-08-21 23:40:49 +0000	[diff] [blame]	932	Removes everything that <tt>gmake clean</tt> does, but also removes files
				933	generated by <tt>configure</tt>. It attempts to return the source tree to the
				934	original state in which it was shipped.
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	935	<br><br>
John Criswell	c5eb460	2003-07-03 16:01:38 +0000	[diff] [blame]	936
Misha Brukman	62a2c1f	2004-08-23 20:25:33 +0000	[diff] [blame]	937	<dt><tt>gmake install</tt>
				938	<dd>
John Criswell	6ab273c	2004-12-08 17:53:54 +0000	[diff] [blame]	939	Installs LLVM header files, libraries, tools, and documentation in a
				940	hierarchy
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	941	under $PREFIX, specified with <tt>./configure --prefix=[dir]</tt>, which
				942	defaults to <tt>/usr/local</tt>.
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	943	<br><br>
				944
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	945	<dt><tt>gmake -C runtime install-bytecode</tt>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	946	<dd>
Reid Spencer	45dc139	2004-11-11 07:30:27 +0000	[diff] [blame]	947	Assuming you built LLVM into $OBJDIR, when this command is run, it will
				948	install bytecode libraries into the GCC front end's bytecode library
				949	directory. If you need to update your bytecode libraries,
Misha Brukman	5d41391	2004-08-21 23:40:49 +0000	[diff] [blame]	950	this is the target to use once you've built them.
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	951	<br><br>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	952	</dl>
John Criswell	c5eb460	2003-07-03 16:01:38 +0000	[diff] [blame]	953
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	954	<p>Please see the <a href="MakefileGuide.html">Makefile Guide</a> for further
				955	details on these <tt>make</tt> targets and descriptions of other targets
				956	available.</p>
				957
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	958	<p>It is also possible to override default values from <tt>configure</tt> by
				959	declaring variables on the command line. The following are some examples:</p>
John Criswell	c5eb460	2003-07-03 16:01:38 +0000	[diff] [blame]	960
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	961	<dl>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	962	<dt><tt>gmake ENABLE_OPTIMIZED=1</tt>
				963	<dd>
				964	Perform a Release (Optimized) build.
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	965	<br><br>
John Criswell	c5eb460	2003-07-03 16:01:38 +0000	[diff] [blame]	966
Reid Spencer	3dc3ea7	2006-04-09 23:45:38 +0000	[diff] [blame]	967	<dt><tt>gmake ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1</tt>
Chris Lattner	0f546dd	2006-03-21 01:10:57 +0000	[diff] [blame]	968	<dd>
Reid Spencer	3dc3ea7	2006-04-09 23:45:38 +0000	[diff] [blame]	969	Perform a Release (Optimized) build without assertions enabled.
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	970	<br><br>
Chris Lattner	0f546dd	2006-03-21 01:10:57 +0000	[diff] [blame]	971
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	972	<dt><tt>gmake ENABLE_PROFILING=1</tt>
				973	<dd>
				974	Perform a Profiling build.
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	975	<br><br>
John Criswell	c5eb460	2003-07-03 16:01:38 +0000	[diff] [blame]	976
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	977	<dt><tt>gmake VERBOSE=1</tt>
				978	<dd>
				979	Print what <tt>gmake</tt> is doing on standard output.
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	980	<br><br>
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	981
				982	<dt><tt>gmake TOOL_VERBOSE=1</tt></dt>
				983	<dd>Ask each tool invoked by the makefiles to print out what it is doing on
John Criswell	6ab273c	2004-12-08 17:53:54 +0000	[diff] [blame]	984	the standard output. This also implies <tt>VERBOSE=1</tt>.
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	985	<br><br></dd>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	986	</dl>
John Criswell	c5eb460	2003-07-03 16:01:38 +0000	[diff] [blame]	987
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	988	<p>Every directory in the LLVM object tree includes a <tt>Makefile</tt> to build
				989	it and any subdirectories that it contains. Entering any directory inside the
				990	LLVM object tree and typing <tt>gmake</tt> should rebuild anything in or below
				991	that directory that is out of date.</p>
John Criswell	c5eb460	2003-07-03 16:01:38 +0000	[diff] [blame]	992
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	993	</div>
John Criswell	38cc2b5	2003-10-10 14:26:14 +0000	[diff] [blame]	994
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	995	<!-- ======================================================================= -->
				996	<div class="doc_subsection">
Reid Spencer	734b74f	2006-07-27 06:41:31 +0000	[diff] [blame]	997	<a name="cross-compile">Cross-Compiling LLVM</a>
Reid Spencer	d966b24	2006-07-27 05:43:30 +0000	[diff] [blame]	998	</div>
				999
				1000	<div class="doc_text">
Reid Spencer	734b74f	2006-07-27 06:41:31 +0000	[diff] [blame]	1001	<p>It is possible to cross-compile LLVM. That is, you can create LLVM
				1002	executables and libraries for a platform different than the one one which you
				1003	are compiling. To do this, a few additional steps are
				1004	required. <sup><a href="#ccn_1">1</a></sup> To cross-compile LLVM, use
Reid Spencer	d966b24	2006-07-27 05:43:30 +0000	[diff] [blame]	1005	these instructions:</p>
				1006	<ol>
Reid Spencer	734b74f	2006-07-27 06:41:31 +0000	[diff] [blame]	1007	<li>Configure and build LLVM as a native compiler. You will need
Reid Spencer	d966b24	2006-07-27 05:43:30 +0000	[diff] [blame]	1008	just <tt>TableGen</tt> from that build.
				1009	<ul>
				1010	<li>If you have <tt>$LLVM_OBJ_ROOT=$LLVM_SRC_ROOT</tt> just execute
				1011	<tt>make -C utils/TableGen</tt> after configuring.</li>
				1012	<li>Otherwise you will need to monitor building process and terminate
				1013	it just after <tt>TableGen</tt> was built.</li>
				1014	</ul>
				1015	</li>
				1016	<li>Copy the TableGen binary to somewhere safe (out of your build tree).
				1017	</li>
Reid Spencer	734b74f	2006-07-27 06:41:31 +0000	[diff] [blame]	1018	<li>Configure LLVM to build with a cross-compiler. To do this, supply the
Reid Spencer	d966b24	2006-07-27 05:43:30 +0000	[diff] [blame]	1019	configure script with <tt>--build</tt> and <tt>--host</tt> options that
Reid Spencer	734b74f	2006-07-27 06:41:31 +0000	[diff] [blame]	1020	are different. The values of these options must be legal target triples
				1021	that your GCC compiler supports.</li>
Reid Spencer	d966b24	2006-07-27 05:43:30 +0000	[diff] [blame]	1022	<li>Put the saved <tt>TableGen</tt> executable into the
				1023	into <tt>$LLVM_OBJ_ROOT/{BUILD_TYPE}/bin</tt> directory (e.g. into
				1024	<tt>.../Release/bin</tt> for a Release build).</li>
				1025	<li>Build LLVM as usual.</li>
				1026	</ol>
Reid Spencer	734b74f	2006-07-27 06:41:31 +0000	[diff] [blame]	1027	<p>The result of such a build will produce executables that are not executable
				1028	on your build host (--build option) but can be executed on your compile host
				1029	(--host option).</p>
Reid Spencer	d966b24	2006-07-27 05:43:30 +0000	[diff] [blame]	1030	<p><b>Notes:</b></p>
				1031	<div class="doc_notes">
				1032	<ol>
				1033	<li><a name="ccn_1">Cross-compiling</a> was tested only with Linux as
				1034	build platform and Windows as host using mingw32 cross-compiler. Other
				1035	combinations have not been tested.</li>
				1036	</ol>
				1037	</div>
				1038	</div>
				1039
				1040	<!-- ======================================================================= -->
				1041	<div class="doc_subsection">
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1042	<a name="objfiles">The Location of LLVM Object Files</a>
				1043	</div>
John Criswell	38cc2b5	2003-10-10 14:26:14 +0000	[diff] [blame]	1044
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1045	<div class="doc_text">
John Criswell	c5eb460	2003-07-03 16:01:38 +0000	[diff] [blame]	1046
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1047	<p>The LLVM build system is capable of sharing a single LLVM source tree among
				1048	several LLVM builds. Hence, it is possible to build LLVM for several different
				1049	platforms or configurations using the same source tree.</p>
John Criswell	c5eb460	2003-07-03 16:01:38 +0000	[diff] [blame]	1050
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1051	<p>This is accomplished in the typical autoconf manner:</p>
John Criswell	c5eb460	2003-07-03 16:01:38 +0000	[diff] [blame]	1052
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1053	<ul>
				1054	<li><p>Change directory to where the LLVM object files should live:</p>
John Criswell	c5eb460	2003-07-03 16:01:38 +0000	[diff] [blame]	1055
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1056	<p><tt>cd <i>OBJ_ROOT</i></tt></p></li>
John Criswell	c5eb460	2003-07-03 16:01:38 +0000	[diff] [blame]	1057
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1058	<li><p>Run the <tt>configure</tt> script found in the LLVM source
				1059	directory:</p>
John Criswell	c5eb460	2003-07-03 16:01:38 +0000	[diff] [blame]	1060
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1061	<p><tt><i>SRC_ROOT</i>/configure</tt></p></li>
				1062	</ul>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1063
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1064	<p>The LLVM build will place files underneath <i>OBJ_ROOT</i> in directories
				1065	named after the build type:</p>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1066
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	1067	<dl>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1068	<dt>Debug Builds
				1069	<dd>
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	1070	<dl>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1071	<dt>Tools
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	1072	<dd><tt><i>OBJ_ROOT</i>/Debug/bin</tt>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1073	<dt>Libraries
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	1074	<dd><tt><i>OBJ_ROOT</i>/Debug/lib</tt>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1075	</dl>
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	1076	<br><br>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1077
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1078	<dt>Release Builds
				1079	<dd>
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	1080	<dl>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1081	<dt>Tools
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	1082	<dd><tt><i>OBJ_ROOT</i>/Release/bin</tt>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1083	<dt>Libraries
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	1084	<dd><tt><i>OBJ_ROOT</i>/Release/lib</tt>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1085	</dl>
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	1086	<br><br>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1087
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1088	<dt>Profile Builds
				1089	<dd>
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	1090	<dl>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1091	<dt>Tools
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	1092	<dd><tt><i>OBJ_ROOT</i>/Profile/bin</tt>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1093	<dt>Libraries
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	1094	<dd><tt><i>OBJ_ROOT</i>/Profile/lib</tt>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1095	</dl>
				1096	</dl>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1097
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1098	</div>
Chris Lattner	1c1ef11	2002-07-24 19:51:14 +0000	[diff] [blame]	1099
Chris Lattner	998c067	2004-03-25 20:38:40 +0000	[diff] [blame]	1100	<!-- ======================================================================= -->
				1101	<div class="doc_subsection">
				1102	<a name="optionalconfig">Optional Configuration Items</a>
				1103	</div>
				1104
				1105	<div class="doc_text">
				1106
				1107	<p>
Misha Brukman	20b8a656	2005-02-03 22:25:23 +0000	[diff] [blame]	1108	If you're running on a Linux system that supports the "<a
Reid Spencer	dfcf790	2004-12-08 16:51:31 +0000	[diff] [blame]	1109	href="http://www.tat.physik.uni-tuebingen.de/~rguenth/linux/binfmt_misc.html">
				1110	binfmt_misc</a>"
Chris Lattner	998c067	2004-03-25 20:38:40 +0000	[diff] [blame]	1111	module, and you have root access on the system, you can set your system up to
				1112	execute LLVM bytecode files directly. To do this, use commands like this (the
				1113	first command may not be required if you are already using the module):</p>
				1114
Misha Brukman	20b8a656	2005-02-03 22:25:23 +0000	[diff] [blame]	1115	<div class="doc_code">
Chris Lattner	998c067	2004-03-25 20:38:40 +0000	[diff] [blame]	1116	<pre>
				1117	$ mount -t binfmt_misc none /proc/sys/fs/binfmt_misc
Misha Brukman	20b8a656	2005-02-03 22:25:23 +0000	[diff] [blame]	1118	$ echo ':llvm:M::llvm::/path/to/lli:' > /proc/sys/fs/binfmt_misc/register
Chris Lattner	998c067	2004-03-25 20:38:40 +0000	[diff] [blame]	1119	$ chmod u+x hello.bc (if needed)
				1120	$ ./hello.bc
				1121	</pre>
Misha Brukman	20b8a656	2005-02-03 22:25:23 +0000	[diff] [blame]	1122	</div>
Chris Lattner	998c067	2004-03-25 20:38:40 +0000	[diff] [blame]	1123
				1124	<p>
				1125	This allows you to execute LLVM bytecode files directly. Thanks to Jack
				1126	Cummings for pointing this out!
				1127	</p>
				1128
				1129	</div>
				1130
				1131
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1132	<!-- *********************************************************************** -->
				1133	<div class="doc_section">
				1134	<a name="layout"><b>Program Layout</b></a>
				1135	</div>
				1136	<!-- *********************************************************************** -->
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1137
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1138	<div class="doc_text">
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1139
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1140	<p>One useful source of information about the LLVM source base is the LLVM <a
John Criswell	64f13ab	2004-03-12 20:31:37 +0000	[diff] [blame]	1141	href="http://www.doxygen.org">doxygen</a> documentation available at <tt><a
Reid Spencer	ca05854	2006-03-14 05:39:39 +0000	[diff] [blame]	1142	href="http://llvm.org/doxygen/">http://llvm.org/doxygen/</a></tt>.
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1143	The following is a brief introduction to code layout:</p>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1144
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1145	</div>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1146
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1147	<!-- ======================================================================= -->
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1148	<div class="doc_subsection"><a name="cvsdir"><tt>CVS</tt> directories</a></div>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1149	<div class="doc_text">
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1150	<p>Every directory checked out of CVS will contain a <tt>CVS</tt> directory; for
				1151	the most part these can just be ignored.</p>
Reid Spencer	5be4f04	2004-12-08 16:18:26 +0000	[diff] [blame]	1152	</div>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1153
Reid Spencer	5be4f04	2004-12-08 16:18:26 +0000	[diff] [blame]	1154	<!-- ======================================================================= -->
				1155	<div class="doc_subsection"><a name="examples"><tt>llvm/examples</tt></a></div>
				1156	<div class="doc_text">
				1157	<p>This directory contains some simple examples of how to use the LLVM IR and
				1158	JIT.</p>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1159	</div>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1160
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1161	<!-- ======================================================================= -->
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1162	<div class="doc_subsection"><a name="include"><tt>llvm/include</tt></a></div>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1163	<div class="doc_text">
				1164
				1165	<p>This directory contains public header files exported from the LLVM
				1166	library. The three main subdirectories of this directory are:</p>
				1167
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1168	<dl>
				1169	<dt><tt><b>llvm/include/llvm</b></tt></dt>
				1170	<dd>This directory contains all of the LLVM specific header files. This
				1171	directory also has subdirectories for different portions of LLVM:
				1172	<tt>Analysis</tt>, <tt>CodeGen</tt>, <tt>Target</tt>, <tt>Transforms</tt>,
				1173	etc...</dd>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1174
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1175	<dt><tt><b>llvm/include/llvm/Support</b></tt></dt>
				1176	<dd>This directory contains generic support libraries that are provided with
				1177	LLVM but not necessarily specific to LLVM. For example, some C++ STL utilities
				1178	and a Command Line option processing library store their header files here.
				1179	</dd>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1180
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1181	<dt><tt><b>llvm/include/llvm/Config</b></tt></dt>
				1182	<dd>This directory contains header files configured by the <tt>configure</tt>
				1183	script. They wrap "standard" UNIX and C header files. Source code can
				1184	include these header files which automatically take care of the conditional
				1185	#includes that the <tt>configure</tt> script generates.</dd>
				1186	</dl>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1187	</div>
				1188
				1189	<!-- ======================================================================= -->
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1190	<div class="doc_subsection"><a name="lib"><tt>llvm/lib</tt></a></div>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1191	<div class="doc_text">
				1192
				1193	<p>This directory contains most of the source files of the LLVM system. In LLVM,
				1194	almost all code exists in libraries, making it very easy to share code among the
				1195	different <a href="#tools">tools</a>.</p>
				1196
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	1197	<dl>
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1198	<dt><tt><b>llvm/lib/VMCore/</b></tt></dt>
				1199	<dd> This directory holds the core LLVM source files that implement core
				1200	classes like Instruction and BasicBlock.</dd>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1201
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1202	<dt><tt><b>llvm/lib/AsmParser/</b></tt></dt>
				1203	<dd>This directory holds the source code for the LLVM assembly language parser
				1204	library.</dd>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1205
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1206	<dt><tt><b>llvm/lib/ByteCode/</b></tt></dt>
				1207	<dd>This directory holds code for reading and write LLVM bytecode.</dd>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1208
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1209	<dt><tt><b>llvm/lib/Analysis/</b></tt><dd>This directory contains a variety of
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1210	different program analyses, such as Dominator Information, Call Graphs,
				1211	Induction Variables, Interval Identification, Natural Loop Identification,
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1212	etc.</dd>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1213
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1214	<dt><tt><b>llvm/lib/Transforms/</b></tt></dt>
				1215	<dd> This directory contains the source code for the LLVM to LLVM program
				1216	transformations, such as Aggressive Dead Code Elimination, Sparse Conditional
				1217	Constant Propagation, Inlining, Loop Invariant Code Motion, Dead Global
				1218	Elimination, and many others.</dd>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1219
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1220	<dt><tt><b>llvm/lib/Target/</b></tt></dt>
				1221	<dd> This directory contains files that describe various target architectures
Chris Lattner	7991e85	2006-04-20 17:42:23 +0000	[diff] [blame]	1222	for code generation. For example, the <tt>llvm/lib/Target/X86</tt>
				1223	directory holds the X86 machine description while
John Criswell	e1a8120	2005-05-18 19:43:33 +0000	[diff] [blame]	1224	<tt>llvm/lib/Target/CBackend</tt> implements the LLVM-to-C converter.</dd>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1225
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1226	<dt><tt><b>llvm/lib/CodeGen/</b></tt></dt>
				1227	<dd> This directory contains the major parts of the code generator: Instruction
				1228	Selector, Instruction Scheduling, and Register Allocation.</dd>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1229
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1230	<dt><tt><b>llvm/lib/Debugger/</b></tt></dt>
				1231	<dd> This directory contains the source level debugger library that makes
				1232	it possible to instrument LLVM programs so that a debugger could identify
				1233	source code locations at which the program is executing.</dd>
				1234
				1235	<dt><tt><b>llvm/lib/ExecutionEngine/</b></tt></dt>
				1236	<dd> This directory contains libraries for executing LLVM bytecode directly
				1237	at runtime in both interpreted and JIT compiled fashions.</dd>
				1238
				1239	<dt><tt><b>llvm/lib/Support/</b></tt></dt>
				1240	<dd> This directory contains the source code that corresponds to the header
				1241	files located in <tt>llvm/include/Support/</tt>.</dd>
				1242
				1243	<dt><tt><b>llvm/lib/System/</b></tt></dt>
				1244	<dd>This directory contains the operating system abstraction layer that
				1245	shields LLVM from platform-specific coding.</dd>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1246	</dl>
John Criswell	3ef61af	2003-06-30 21:59:07 +0000	[diff] [blame]	1247
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1248	</div>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1249
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1250	<!-- ======================================================================= -->
Reid Spencer	5be4f04	2004-12-08 16:18:26 +0000	[diff] [blame]	1251	<div class="doc_subsection"><a name="projects"><tt>llvm/projects</tt></a></div>
				1252	<div class="doc_text">
				1253	<p>This directory contains projects that are not strictly part of LLVM but are
				1254	shipped with LLVM. This is also the directory where you should create your own
				1255	LLVM-based projects. See <tt>llvm/projects/sample</tt> for an example of how
				1256	to set up your own project. See <tt>llvm/projects/Stacker</tt> for a fully
				1257	functional example of a compiler front end.</p>
				1258	</div>
				1259
				1260	<!-- ======================================================================= -->
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1261	<div class="doc_subsection"><a name="runtime"><tt>llvm/runtime</tt></a></div>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1262	<div class="doc_text">
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1263
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1264	<p>This directory contains libraries which are compiled into LLVM bytecode and
				1265	used when linking programs with the GCC front end. Most of these libraries are
				1266	skeleton versions of real libraries; for example, libc is a stripped down
				1267	version of glibc.</p>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1268
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1269	<p>Unlike the rest of the LLVM suite, this directory needs the LLVM GCC front
				1270	end to compile.</p>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1271
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1272	</div>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1273
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1274	<!-- ======================================================================= -->
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1275	<div class="doc_subsection"><a name="test"><tt>llvm/test</tt></a></div>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1276	<div class="doc_text">
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1277	<p>This directory contains feature and regression tests and other basic sanity
				1278	checks on the LLVM infrastructure. These are intended to run quickly and cover
				1279	a lot of territory without being exhaustive.</p>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1280	</div>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1281
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1282	<!-- ======================================================================= -->
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1283	<div class="doc_subsection"><a name="llvmtest"><tt>llvm-test</tt></a></div>
				1284	<div class="doc_text">
John Criswell	6ab273c	2004-12-08 17:53:54 +0000	[diff] [blame]	1285	<p>This is not a directory in the normal llvm module; it is a separate CVS
Misha Brukman	b4bd8de	2004-11-15 23:20:51 +0000	[diff] [blame]	1286	module that must be checked out (usually to <tt>projects/llvm-test</tt>). This
John Criswell	6ab273c	2004-12-08 17:53:54 +0000	[diff] [blame]	1287	module contains a comprehensive correctness, performance, and benchmarking
				1288	test
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1289	suite for LLVM. It is a separate CVS module because not every LLVM user is
John Criswell	cfdeb5c	2005-05-09 16:39:27 +0000	[diff] [blame]	1290	interested in downloading or building such a comprehensive test suite. For
				1291	further details on this test suite, please see the
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1292	<a href="TestingGuide.html">Testing Guide</a> document.</p>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1293	</div>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1294
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1295	<!-- ======================================================================= -->
				1296	<div class="doc_subsection"><a name="tools"><tt>llvm/tools</tt></a></div>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1297	<div class="doc_text">
John Criswell	38cc2b5	2003-10-10 14:26:14 +0000	[diff] [blame]	1298
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1299	<p>The <b>tools</b> directory contains the executables built out of the
				1300	libraries above, which form the main part of the user interface. You can
				1301	always get help for a tool by typing <tt>tool_name --help</tt>. The
Misha Brukman	b4bd8de	2004-11-15 23:20:51 +0000	[diff] [blame]	1302	following is a brief introduction to the most important tools. More detailed
				1303	information is in the <a href="CommandGuide/index.html">Command Guide</a>.</p>
John Criswell	38cc2b5	2003-10-10 14:26:14 +0000	[diff] [blame]	1304
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	1305	<dl>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1306
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1307	<dt><tt><b>bugpoint</b></tt></dt>
				1308	<dd><tt>bugpoint</tt> is used to debug
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1309	optimization passes or code generation backends by narrowing down the
				1310	given test case to the minimum number of passes and/or instructions that
				1311	still cause a problem, whether it is a crash or miscompilation. See <a
				1312	href="HowToSubmitABug.html">HowToSubmitABug.html</a> for more information
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1313	on using <tt>bugpoint</tt>.</dd>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1314
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1315	<dt><tt><b>llvmc</b></tt></dt>
				1316	<dd>The LLVM Compiler Driver. This program can
				1317	be configured to utilize both LLVM and non-LLVM compilation tools to enable
				1318	pre-processing, translation, optimization, assembly, and linking of programs
				1319	all from one command line. <tt>llvmc</tt> also takes care of processing the
				1320	dependent libraries found in bytecode. This reduces the need to get the
Reid Spencer	92815e5	2004-12-08 18:00:30 +0000	[diff] [blame]	1321	traditional <tt>-l<name></tt> options right on the command line. Please
John Criswell	e1a8120	2005-05-18 19:43:33 +0000	[diff] [blame]	1322	note that this tool, while functional, is still experimental and not feature
				1323	complete.</dd>
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1324
				1325	<dt><tt><b>llvm-ar</b></tt></dt>
				1326	<dd>The archiver produces an archive containing
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1327	the given LLVM bytecode files, optionally with an index for faster
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1328	lookup.</dd>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1329
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1330	<dt><tt><b>llvm-as</b></tt></dt>
				1331	<dd>The assembler transforms the human readable LLVM assembly to LLVM
				1332	bytecode.</dd>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1333
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1334	<dt><tt><b>llvm-dis</b></tt></dt>
				1335	<dd>The disassembler transforms the LLVM bytecode to human readable
				1336	LLVM assembly.</dd>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1337
Reid Spencer	92815e5	2004-12-08 18:00:30 +0000	[diff] [blame]	1338	<dt><tt><b>llvm-ld</b></tt></dt>
				1339	<dd><tt>llvm-ld</tt> is very similar to gccld and provides a general purpose
				1340	and extensible linker for LLVM. This is the linker invoked by <tt>llvmc</tt>.
				1341	It allows optimization modules to be loaded so that language specific
John Criswell	e1a8120	2005-05-18 19:43:33 +0000	[diff] [blame]	1342	optimizations can be applied at link time. This tool is considered
				1343	experimental.</dd>
Reid Spencer	92815e5	2004-12-08 18:00:30 +0000	[diff] [blame]	1344
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1345	<dt><tt><b>llvm-link</b></tt></dt>
				1346	<dd><tt>llvm-link</tt>, not surprisingly, links multiple LLVM modules into
				1347	a single program.</dd>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1348
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1349	<dt><tt><b>lli</b></tt></dt>
				1350	<dd><tt>lli</tt> is the LLVM interpreter, which
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1351	can directly execute LLVM bytecode (although very slowly...). In addition
				1352	to a simple interpreter, <tt>lli</tt> also has a tracing mode (entered by
				1353	specifying <tt>-trace</tt> on the command line). Finally, for
John Criswell	945f802	2004-12-08 18:04:14 +0000	[diff] [blame]	1354	architectures that support it (currently x86, Sparc, and PowerPC), by default,
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1355	<tt>lli</tt> will function as a Just-In-Time compiler (if the
				1356	functionality was compiled in), and will execute the code <i>much</i>
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1357	faster than the interpreter.</dd>
Misha Brukman	994d7e8	2003-10-06 19:23:34 +0000	[diff] [blame]	1358
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1359	<dt><tt><b>llc</b></tt></dt>
				1360	<dd> <tt>llc</tt> is the LLVM backend compiler, which
John Criswell	e1a8120	2005-05-18 19:43:33 +0000	[diff] [blame]	1361	translates LLVM bytecode to a native code assembly file or to C code (with
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1362	the -march=c option).</dd>
Misha Brukman	994d7e8	2003-10-06 19:23:34 +0000	[diff] [blame]	1363
Reid Spencer	788b0fd	2004-12-22 06:29:07 +0000	[diff] [blame]	1364	<dt><tt><b>llvm-gcc</b></tt></dt>
				1365	<dd><tt>llvm-gcc</tt> is a GCC-based C frontend
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1366	that has been retargeted to emit LLVM code as the machine code output. It
				1367	works just like any other GCC compiler, taking the typical <tt>-c, -S, -E,
				1368	-o</tt> options that are typically used. The source code for the
John Criswell	e1a8120	2005-05-18 19:43:33 +0000	[diff] [blame]	1369	<tt>llvm-gcc</tt> tool is available as a separate CVS module.
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	1370	<blockquote>
				1371	<dl>
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1372	<dt><tt><b>gccas</b></tt></dt>
Reid Spencer	788b0fd	2004-12-22 06:29:07 +0000	[diff] [blame]	1373	<dd>This tool is invoked by the <tt>llvm-gcc</tt> frontend as the
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1374	"assembler" part of the compiler. This tool actually assembles LLVM
				1375	assembly to LLVM bytecode, performs a variety of optimizations, and
				1376	outputs LLVM bytecode. Thus when you invoke
Reid Spencer	788b0fd	2004-12-22 06:29:07 +0000	[diff] [blame]	1377	<tt>llvm-gcc -c x.c -o x.o</tt>, you are causing <tt>gccas</tt> to be
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1378	run, which writes the <tt>x.o</tt> file (which is an LLVM bytecode file
				1379	that can be disassembled or manipulated just like any other bytecode
				1380	file). The command line interface to <tt>gccas</tt> is designed to be
				1381	as close as possible to the <b>system</b> `<tt>as</tt>' utility so that
				1382	the gcc frontend itself did not have to be modified to interface to
				1383	a "weird" assembler.</dd>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1384
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1385	<dt><tt><b>gccld</b></tt></dt>
				1386	<dd><tt>gccld</tt> links together several LLVM bytecode files into one
				1387	bytecode file and does some optimization. It is the linker invoked by
				1388	the GCC frontend when multiple .o files need to be linked together.
				1389	Like <tt>gccas</tt>, the command line interface of <tt>gccld</tt> is
				1390	designed to match the system linker, to aid interfacing with the GCC
				1391	frontend.</dd>
				1392	</dl>
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	1393	</blockquote>
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1394	</dd>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1395
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1396	<dt><tt><b>opt</b></tt></dt>
Reid Spencer	80f843d	2006-08-28 00:34:19 +0000	[diff] [blame]	1397	<dd><tt>opt</tt> reads LLVM bytecode, applies a series of LLVM to LLVM
				1398	transformations (which are specified on the command line), and then outputs
				1399	the resultant bytecode. The '<tt>opt --help</tt>' command is a good way to
				1400	get a list of the program transformations available in LLVM.<br/>
				1401	<dd><tt>opt</tt> can also be used to run a specific analysis on an input
				1402	LLVM bytecode file and print out the results. It is primarily useful for
				1403	debugging analyses, or familiarizing yourself with what an analysis does.</dd>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1404	</dl>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1405	</div>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1406
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1407	<!-- ======================================================================= -->
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1408	<div class="doc_subsection"><a name="utils"><tt>llvm/utils</tt></a></div>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1409	<div class="doc_text">
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1410
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1411	<p>This directory contains utilities for working with LLVM source code, and some
				1412	of the utilities are actually required as part of the build process because they
				1413	are code generators for parts of LLVM infrastructure.</p>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1414
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	1415	<dl>
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	1416	<dt><tt><b>codegen-diff</b></tt> <dd><tt>codegen-diff</tt> is a script
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1417	that finds differences between code that LLC generates and code that LLI
				1418	generates. This is a useful tool if you are debugging one of them,
				1419	assuming that the other generates correct output. For the full user
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	1420	manual, run <tt>`perldoc codegen-diff'</tt>.<br><br>
Misha Brukman	efe54be	2003-08-11 18:45:46 +0000	[diff] [blame]	1421
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	1422	<dt><tt><b>cvsupdate</b></tt> <dd><tt>cvsupdate</tt> is a script that will
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1423	update your CVS tree, but produce a much cleaner and more organized output
				1424	than simply running <tt>`cvs -z3 up -dP'</tt> will. For example, it will group
				1425	together all the new and updated files and modified files in separate
				1426	sections, so you can see at a glance what has changed. If you are at the
				1427	top of your LLVM CVS tree, running <tt>utils/cvsupdate</tt> is the
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	1428	preferred way of updating the tree.<br><br>
Misha Brukman	efe54be	2003-08-11 18:45:46 +0000	[diff] [blame]	1429
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	1430	<dt><tt><b>emacs/</b></tt> <dd>The <tt>emacs</tt> directory contains
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1431	syntax-highlighting files which will work with Emacs and XEmacs editors,
				1432	providing syntax highlighting support for LLVM assembly files and TableGen
				1433	description files. For information on how to use the syntax files, consult
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	1434	the <tt>README</tt> file in that directory.<br><br>
Misha Brukman	efe54be	2003-08-11 18:45:46 +0000	[diff] [blame]	1435
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	1436	<dt><tt><b>getsrcs.sh</b></tt> <dd>The <tt>getsrcs.sh</tt> script finds
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1437	and outputs all non-generated source files, which is useful if one wishes
				1438	to do a lot of development across directories and does not want to
				1439	individually find each file. One way to use it is to run, for example:
				1440	<tt>xemacs `utils/getsources.sh`</tt> from the top of your LLVM source
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	1441	tree.<br><br>
				1442
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1443	<dt><tt><b>llvmgrep</b></tt></dt>
				1444	<dd>This little tool performs an "egrep -H -n" on each source file in LLVM and
				1445	passes to it a regular expression provided on <tt>llvmgrep</tt>'s command
				1446	line. This is a very efficient way of searching the source base for a
				1447	particular regular expression.</dd>
				1448
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	1449	<dt><tt><b>makellvm</b></tt> <dd>The <tt>makellvm</tt> script compiles all
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1450	files in the current directory and then compiles and links the tool that
				1451	is the first argument. For example, assuming you are in the directory
				1452	<tt>llvm/lib/Target/Sparc</tt>, if <tt>makellvm</tt> is in your path,
				1453	simply running <tt>makellvm llc</tt> will make a build of the current
				1454	directory, switch to directory <tt>llvm/tools/llc</tt> and build it,
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	1455	causing a re-linking of LLC.<br><br>
Misha Brukman	efe54be	2003-08-11 18:45:46 +0000	[diff] [blame]	1456
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1457	<dt><tt><b>NightlyTest.pl</b></tt> and
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	1458	<tt><b>NightlyTestTemplate.html</b></tt> <dd>These files are used in a
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1459	cron script to generate nightly status reports of the functionality of
				1460	tools, and the results can be seen by following the appropriate link on
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	1461	the <a href="http://llvm.org/">LLVM homepage</a>.<br><br>
Misha Brukman	efe54be	2003-08-11 18:45:46 +0000	[diff] [blame]	1462
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	1463	<dt><tt><b>TableGen/</b></tt> <dd>The <tt>TableGen</tt> directory contains
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1464	the tool used to generate register descriptions, instruction set
				1465	descriptions, and even assemblers from common TableGen description
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	1466	files.<br><br>
Misha Brukman	efe54be	2003-08-11 18:45:46 +0000	[diff] [blame]	1467
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	1468	<dt><tt><b>vim/</b></tt> <dd>The <tt>vim</tt> directory contains
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1469	syntax-highlighting files which will work with the VIM editor, providing
				1470	syntax highlighting support for LLVM assembly files and TableGen
				1471	description files. For information on how to use the syntax files, consult
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	1472	the <tt>README</tt> file in that directory.<br><br>
Misha Brukman	efe54be	2003-08-11 18:45:46 +0000	[diff] [blame]	1473
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1474	</dl>
Misha Brukman	efe54be	2003-08-11 18:45:46 +0000	[diff] [blame]	1475
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1476	</div>
Misha Brukman	efe54be	2003-08-11 18:45:46 +0000	[diff] [blame]	1477
Reid Spencer	5be4f04	2004-12-08 16:18:26 +0000	[diff] [blame]	1478	<!-- ======================================================================= -->
				1479	<div class="doc_subsection"><a name="win32"><tt>llvm/win32</tt></a></div>
				1480	<div class="doc_text">
				1481	<p>This directory contains build scripts and project files for use with
				1482	Visual C++. This allows developers on Windows to build LLVM without the need
John Criswell	6ab273c	2004-12-08 17:53:54 +0000	[diff] [blame]	1483	for Cygwin. The contents of this directory should be considered experimental
Reid Spencer	5be4f04	2004-12-08 16:18:26 +0000	[diff] [blame]	1484	at this time.
				1485	</p>
				1486	</div>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1487	<!-- *********************************************************************** -->
				1488	<div class="doc_section">
				1489	<a name="tutorial">An Example Using the LLVM Tool Chain</a>
				1490	</div>
				1491	<!-- *********************************************************************** -->
Misha Brukman	efe54be	2003-08-11 18:45:46 +0000	[diff] [blame]	1492
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1493	<div class="doc_text">
Chris Lattner	5b560d9	2006-08-14 20:45:25 +0000	[diff] [blame]	1494	<p>This section gives an example of using LLVM. Since we are currently
				1495	transitioning from llvm-gcc3 to llvm-gcc4, we include examples for both.
				1496	</p>
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	1497
				1498	<p><b>Note:</b> The <i>gcc4</i> frontend's invocation is <b><i>considerably different</i></b>
				1499	from the previous <i>gcc3</i> frontend. In particular, the <i>gcc4</i> frontend <b><i>does not</i></b>
				1500	create bytecode by default: <i>gcc4</i> produces native code. As the example below illustrates,
				1501	the '--emit-llvm' flag is needed to produce LLVM bytecode output. For <i>makefiles</i> and
				1502	<i>configure</i> scripts, the CFLAGS variable needs '--emit-llvm' to produce bytecode
				1503	output.</p>
Chris Lattner	5b560d9	2006-08-14 20:45:25 +0000	[diff] [blame]	1504	</div>
				1505
				1506	<!-- ======================================================================= -->
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	1507	<div class="doc_subsection"><a name="tutorial4">Example with llvm-gcc4</a></div>
Chris Lattner	5b560d9	2006-08-14 20:45:25 +0000	[diff] [blame]	1508
				1509	<div class="doc_text">
				1510
				1511	<ol>
				1512	<li>First, create a simple C file, name it 'hello.c':
				1513	<pre>
				1514	#include <stdio.h>
				1515	int main() {
				1516	printf("hello world\n");
				1517	return 0;
				1518	}
				1519	</pre></li>
				1520
				1521	<li><p>Next, compile the C file into a native executable:</p>
				1522
				1523	<p><tt>% llvm-gcc hello.c -o hello</tt></p>
				1524
				1525	<p>Note that llvm-gcc works just like GCC by default. The standard -S and
				1526	-c arguments work as usual (producing a native .s or .o file,
				1527	respectively). </p>
				1528
				1529	<li><p>Next, compile the C file into a LLVM bytecode file:</p>
				1530	<p><tt>% llvm-gcc -O3 -emit-llvm hello.c -c -o hello.bc</tt></p>
				1531
				1532	<p>The -emit-llvm option can be used with the -S or -c options to emit an
				1533	LLVM ".ll" or ".bc" file (respectively) for the code. This allows you
				1534	to use the <a href="CommandGuide/index.html">standard LLVM tools</a> on
				1535	the bytecode file.</p>
				1536
				1537	<p>Unlike llvm-gcc3, llvm-gcc4 correctly responds to -O[0123] arguments.
				1538	</p></li>
				1539
				1540	<li><p>Run the program in both forms. To run the program, use:</p>
				1541
				1542	<p><tt>% ./hello</tt></p>
				1543
				1544	<p>and</p>
				1545
Chris Lattner	c7443af	2006-08-14 20:51:35 +0000	[diff] [blame]	1546	<p><tt>% lli hello.bc</tt></p>
Chris Lattner	5b560d9	2006-08-14 20:45:25 +0000	[diff] [blame]	1547
				1548	<p>The second examples shows how to invoke the LLVM JIT, <a
Chris Lattner	c7443af	2006-08-14 20:51:35 +0000	[diff] [blame]	1549	href="CommandGuide/html/lli.html">lli</a>.</p></li>
Chris Lattner	5b560d9	2006-08-14 20:45:25 +0000	[diff] [blame]	1550
				1551	<li><p>Use the <tt>llvm-dis</tt> utility to take a look at the LLVM assembly
				1552	code:</p>
				1553
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	1554	<p><tt>% llvm-dis < hello.bc \| less</tt><br><br></li>
Chris Lattner	5b560d9	2006-08-14 20:45:25 +0000	[diff] [blame]	1555
				1556	<li><p>Compile the program to native assembly using the LLC code
				1557	generator:</p>
				1558
				1559	<p><tt>% llc hello.bc -o hello.s</tt></p>
				1560
				1561	<li><p>Assemble the native assembly language file into a program:</p>
				1562
				1563	<p><b>Solaris:</b><tt>% /opt/SUNWspro/bin/cc -xarch=v9 hello.s -o hello.native</tt></p>
				1564	<p><b>Others:</b><tt>% gcc hello.s -o hello.native</tt></p>
				1565
				1566	<li><p>Execute the native code program:</p>
				1567
Chris Lattner	c7443af	2006-08-14 20:51:35 +0000	[diff] [blame]	1568	<p><tt>% ./hello.native</tt></p>
Chris Lattner	5b560d9	2006-08-14 20:45:25 +0000	[diff] [blame]	1569
				1570	<p>Note that using llvm-gcc to compile directly to native code (i.e. when
				1571	the -emit-llvm option is not present) does steps 6/7/8 for you.</p>
Chris Lattner	c7443af	2006-08-14 20:51:35 +0000	[diff] [blame]	1572	</li>
Chris Lattner	5b560d9	2006-08-14 20:45:25 +0000	[diff] [blame]	1573
				1574	</ol>
				1575
				1576	</div>
				1577
				1578	<!-- ======================================================================= -->
				1579	<div class="doc_subsection"><a name="tutorial3">Example with llvm-gcc3</a></div>
				1580
				1581	<div class="doc_text">
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1582
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1583	<ol>
				1584	<li>First, create a simple C file, name it 'hello.c':
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1585	<pre>
				1586	#include <stdio.h>
				1587	int main() {
				1588	printf("hello world\n");
				1589	return 0;
				1590	}
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1591	</pre></li>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1592
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1593	<li><p>Next, compile the C file into a LLVM bytecode file:</p>
Reid Spencer	788b0fd	2004-12-22 06:29:07 +0000	[diff] [blame]	1594	<p><tt>% llvm-gcc hello.c -o hello</tt></p>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1595
Misha Brukman	6c2cf08	2004-06-22 18:48:58 +0000	[diff] [blame]	1596	<p>Note that you should have already built the tools and they have to be
				1597	in your path, at least <tt>gccas</tt> and <tt>gccld</tt>.</p>
				1598
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1599	<p>This will create two result files: <tt>hello</tt> and
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1600	<tt>hello.bc</tt>. The <tt>hello.bc</tt> is the LLVM bytecode that
				1601	corresponds the the compiled program and the library facilities that it
				1602	required. <tt>hello</tt> is a simple shell script that runs the bytecode
Chris Lattner	15a041c	2004-05-01 11:40:07 +0000	[diff] [blame]	1603	file with <tt>lli</tt>, making the result directly executable. Note that
				1604	all LLVM optimizations are enabled by default, so there is no need for a
				1605	"-O3" switch.</p></li>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1606
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1607	<li><p>Run the program. To make sure the program ran, execute one of the
				1608	following commands:</p>
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	1609
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1610	<p><tt>% ./hello</tt></p>
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	1611
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1612	<p>or</p>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1613
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1614	<p><tt>% lli hello.bc</tt></p></li>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1615
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1616	<li><p>Use the <tt>llvm-dis</tt> utility to take a look at the LLVM assembly
				1617	code:</p>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1618
Chris Lattner	4d7ce8a	2006-09-07 04:19:09 +0000	[diff] [blame^]	1619	<p><tt>% llvm-dis < hello.bc \| less</tt><br><br></li>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1620
Chris Lattner	0379351	2004-06-02 20:37:02 +0000	[diff] [blame]	1621	<li><p>Compile the program to native assembly using the LLC code
				1622	generator:</p>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1623
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1624	<p><tt>% llc hello.bc -o hello.s</tt></p>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1625
Chris Lattner	0379351	2004-06-02 20:37:02 +0000	[diff] [blame]	1626	<li><p>Assemble the native assembly language file into a program:</p>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1627
Chris Lattner	0379351	2004-06-02 20:37:02 +0000	[diff] [blame]	1628	<p><b>Solaris:</b><tt>% /opt/SUNWspro/bin/cc -xarch=v9 hello.s -o hello.native</tt></p>
				1629	<p><b>Others:</b><tt>% gcc hello.s -o hello.native</tt></p>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1630
Chris Lattner	0379351	2004-06-02 20:37:02 +0000	[diff] [blame]	1631	<li><p>Execute the native code program:</p>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1632
Chris Lattner	0379351	2004-06-02 20:37:02 +0000	[diff] [blame]	1633	<p><tt>% ./hello.native</tt></p></li>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1634
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1635	</ol>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1636
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1637	</div>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1638
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1639	<!-- *********************************************************************** -->
				1640	<div class="doc_section">
				1641	<a name="problems">Common Problems</a>
				1642	</div>
				1643	<!-- *********************************************************************** -->
John Criswell	c5eb460	2003-07-03 16:01:38 +0000	[diff] [blame]	1644
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1645	<div class="doc_text">
John Criswell	c5eb460	2003-07-03 16:01:38 +0000	[diff] [blame]	1646
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1647	<p>If you are having problems building or using LLVM, or if you have any other
				1648	general questions about LLVM, please consult the <a href="FAQ.html">Frequently
				1649	Asked Questions</a> page.</p>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1650
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1651	</div>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1652
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1653	<!-- *********************************************************************** -->
				1654	<div class="doc_section">
				1655	<a name="links">Links</a>
				1656	</div>
				1657	<!-- *********************************************************************** -->
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1658
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1659	<div class="doc_text">
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1660
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1661	<p>This document is just an <b>introduction</b> to how to use LLVM to do
				1662	some simple things... there are many more interesting and complicated things
				1663	that you can do that aren't documented here (but we'll gladly accept a patch
				1664	if you want to write something up!). For more information about LLVM, check
				1665	out:</p>
John Criswell	72989a5	2003-06-12 19:34:44 +0000	[diff] [blame]	1666
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1667	<ul>
Reid Spencer	ca05854	2006-03-14 05:39:39 +0000	[diff] [blame]	1668	<li><a href="http://llvm.org/">LLVM homepage</a></li>
				1669	<li><a href="http://llvm.org/doxygen/">LLVM doxygen tree</a></li>
				1670	<li><a href="http://llvm.org/docs/Projects.html">Starting a Project
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1671	that Uses LLVM</a></li>
				1672	</ul>
				1673
				1674	</div>
				1675
				1676	<!-- *********************************************************************** -->
				1677
				1678	<hr>
Misha Brukman	74d4df8	2003-11-22 01:30:01 +0000	[diff] [blame]	1679	<address>
Misha Brukman	d3de5c6	2004-01-20 00:20:17 +0000	[diff] [blame]	1680	<a href="http://jigsaw.w3.org/css-validator/check/referer"><img
				1681	src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
				1682	<a href="http://validator.w3.org/check/referer"><img
				1683	src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
				1684
Misha Brukman	74d4df8	2003-11-22 01:30:01 +0000	[diff] [blame]	1685	<a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
Reid Spencer	075de23	2004-09-05 20:50:22 +0000	[diff] [blame]	1686	<a href="http://llvm.x10sys.com/rspencer/">Reid Spencer</a><br>
Reid Spencer	ca05854	2006-03-14 05:39:39 +0000	[diff] [blame]	1687	<a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1688	Last modified: $Date$
Misha Brukman	74d4df8	2003-11-22 01:30:01 +0000	[diff] [blame]	1689	</address>
Misha Brukman	560e989	2003-11-07 19:43:14 +0000	[diff] [blame]	1690	</body>
Guochun Shi	b65a78e	2002-07-17 23:05:56 +0000	[diff] [blame]	1691	</html>