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

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