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

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