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

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