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

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