2003-11-07 19:43:14 +00:00
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
|
|
|
|
|
"http://www.w3.org/TR/html4/strict.dtd">
|
2002-07-17 23:05:56 +00:00
|
|
|
<html>
|
2003-11-07 19:43:14 +00:00
|
|
|
<head>
|
2004-11-15 21:15:12 +00:00
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
2003-11-07 19:43:14 +00:00
|
|
|
<title>Getting Started with LLVM System</title>
|
2012-04-19 20:20:34 +00:00
|
|
|
<link rel="stylesheet" href="_static/llvm.css" type="text/css">
|
2003-11-07 19:43:14 +00:00
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
|
2011-04-18 23:59:50 +00:00
|
|
|
<h1>
|
2003-11-07 19:43:14 +00:00
|
|
|
Getting Started with the LLVM System
|
2011-04-18 23:59:50 +00:00
|
|
|
</h1>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="#overview">Overview</a>
|
|
|
|
|
<li><a href="#quickstart">Getting Started Quickly (A Summary)</a>
|
|
|
|
|
<li><a href="#requirements">Requirements</a>
|
|
|
|
|
<ol>
|
2007-11-01 04:20:16 +00:00
|
|
|
<li><a href="#hardware">Hardware</a></li>
|
|
|
|
|
<li><a href="#software">Software</a></li>
|
|
|
|
|
<li><a href="#brokengcc">Broken versions of GCC and other tools</a></li>
|
2003-11-07 19:43:14 +00:00
|
|
|
</ol></li>
|
2003-06-12 19:34:44 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<li><a href="#starting">Getting Started with LLVM</a>
|
2003-06-11 20:46:40 +00:00
|
|
|
<ol>
|
2007-11-01 04:20:16 +00:00
|
|
|
<li><a href="#terminology">Terminology and Notation</a></li>
|
|
|
|
|
<li><a href="#environment">Setting Up Your Environment</a></li>
|
|
|
|
|
<li><a href="#unpack">Unpacking the LLVM Archives</a></li>
|
|
|
|
|
<li><a href="#checkout">Checkout LLVM from Subversion</a></li>
|
2011-02-01 20:08:28 +00:00
|
|
|
<li><a href="#git_mirror">LLVM GIT mirror</a></li>
|
2007-11-01 04:20:16 +00:00
|
|
|
<li><a href="#config">Local LLVM Configuration</a></li>
|
|
|
|
|
<li><a href="#compile">Compiling the LLVM Suite Source Code</a></li>
|
|
|
|
|
<li><a href="#cross-compile">Cross-Compiling LLVM</a></li>
|
|
|
|
|
<li><a href="#objfiles">The Location of LLVM Object Files</a></li>
|
|
|
|
|
<li><a href="#optionalconfig">Optional Configuration Items</a></li>
|
2003-11-07 19:43:14 +00:00
|
|
|
</ol></li>
|
|
|
|
|
|
|
|
|
|
<li><a href="#layout">Program layout</a>
|
|
|
|
|
<ol>
|
2007-11-01 04:20:16 +00:00
|
|
|
<li><a href="#examples"><tt>llvm/examples</tt></a></li>
|
|
|
|
|
<li><a href="#include"><tt>llvm/include</tt></a></li>
|
|
|
|
|
<li><a href="#lib"><tt>llvm/lib</tt></a></li>
|
|
|
|
|
<li><a href="#projects"><tt>llvm/projects</tt></a></li>
|
|
|
|
|
<li><a href="#runtime"><tt>llvm/runtime</tt></a></li>
|
|
|
|
|
<li><a href="#test"><tt>llvm/test</tt></a></li>
|
2010-09-23 20:26:44 +00:00
|
|
|
<li><a href="#test-suite"><tt>test-suite</tt></a></li>
|
2007-11-01 04:20:16 +00:00
|
|
|
<li><a href="#tools"><tt>llvm/tools</tt></a></li>
|
|
|
|
|
<li><a href="#utils"><tt>llvm/utils</tt></a></li>
|
2003-11-07 19:43:14 +00:00
|
|
|
</ol></li>
|
|
|
|
|
|
|
|
|
|
<li><a href="#tutorial">An Example Using the LLVM Tool Chain</a>
|
2006-09-07 04:19:09 +00:00
|
|
|
<ol>
|
2012-02-26 21:31:25 +00:00
|
|
|
<li><a href="#tutorial4">Example with Clang</a></li>
|
2006-09-07 04:19:09 +00:00
|
|
|
</ol>
|
2003-11-07 19:43:14 +00:00
|
|
|
<li><a href="#problems">Common Problems</a>
|
|
|
|
|
<li><a href="#links">Links</a>
|
|
|
|
|
</ul>
|
|
|
|
|
|
2004-05-23 21:07:27 +00:00
|
|
|
<div class="doc_author">
|
|
|
|
|
<p>Written by:
|
|
|
|
|
<a href="mailto:criswell@uiuc.edu">John Criswell</a>,
|
|
|
|
|
<a href="mailto:sabre@nondot.org">Chris Lattner</a>,
|
2011-04-09 02:13:37 +00:00
|
|
|
<a href="http://misha.brukman.net/">Misha Brukman</a>,
|
2004-05-23 21:07:27 +00:00
|
|
|
<a href="http://www.cs.uiuc.edu/~vadve">Vikram Adve</a>, and
|
|
|
|
|
<a href="mailto:gshi1@uiuc.edu">Guochun Shi</a>.
|
|
|
|
|
</p>
|
|
|
|
|
</div>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- *********************************************************************** -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h2>
|
|
|
|
|
<a name="overview">Overview</a>
|
|
|
|
|
</h2>
|
2003-11-07 19:43:14 +00:00
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
|
|
|
|
<p>Welcome to LLVM! In order to get started, you first need to know some
|
|
|
|
|
basic information.</p>
|
|
|
|
|
|
2010-09-23 20:26:44 +00:00
|
|
|
<p>First, LLVM comes in three pieces. The first piece is the LLVM
|
|
|
|
|
suite. This contains all of the tools, libraries, and header files
|
2012-01-25 22:00:23 +00:00
|
|
|
needed to use LLVM. It contains an assembler, disassembler, bitcode
|
|
|
|
|
analyzer and bitcode optimizer. It also contains basic regression tests that
|
2012-02-26 21:31:25 +00:00
|
|
|
can be used to test the LLVM tools and the Clang front end.</p>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2012-02-26 21:34:02 +00:00
|
|
|
<p>The second piece is the <a href="http://clang.llvm.org/">Clang</a> front end.
|
|
|
|
|
This component compiles C, C++, Objective C, and Objective C++ code into LLVM
|
|
|
|
|
bitcode. Once compiled into LLVM bitcode, a program can be manipulated with the
|
|
|
|
|
LLVM tools from the LLVM suite.
|
2012-02-26 21:31:25 +00:00
|
|
|
</p>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2004-12-08 17:53:54 +00:00
|
|
|
<p>
|
2010-09-23 20:26:44 +00:00
|
|
|
There is a third, optional piece called Test Suite. It is a suite of programs
|
2004-12-08 17:53:54 +00:00
|
|
|
with a testing harness that can be used to further test LLVM's functionality
|
|
|
|
|
and performance.
|
|
|
|
|
</p>
|
|
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- *********************************************************************** -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h2>
|
|
|
|
|
<a name="quickstart">Getting Started Quickly (A Summary)</a>
|
|
|
|
|
</h2>
|
2003-11-07 19:43:14 +00:00
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2012-02-26 22:12:59 +00:00
|
|
|
<p>The LLVM Getting Started documentation may be out of date. So, the Clang
|
|
|
|
|
<a href="http://clang.llvm.org/get_started.html">Getting Started</a> page might
|
|
|
|
|
also be a good place to start.</p>
|
2012-02-23 21:23:24 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<p>Here's the short story for getting up and running quickly with LLVM:</p>
|
|
|
|
|
|
|
|
|
|
<ol>
|
2004-11-08 00:29:22 +00:00
|
|
|
<li>Read the documentation.</li>
|
|
|
|
|
<li>Read the documentation.</li>
|
|
|
|
|
<li>Remember that you were warned twice about reading the documentation.</li>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2012-02-26 22:12:59 +00:00
|
|
|
<li>Checkout LLVM:
|
2003-11-07 19:43:14 +00:00
|
|
|
<ul>
|
2012-02-26 22:12:59 +00:00
|
|
|
<li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
|
|
|
|
|
<li><tt>svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm</tt></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2012-02-26 22:12:59 +00:00
|
|
|
<li>Checkout Clang:
|
2004-12-10 15:51:16 +00:00
|
|
|
<ul>
|
2012-02-26 22:12:59 +00:00
|
|
|
<li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
|
|
|
|
|
<li><tt>cd llvm/tools</tt>
|
|
|
|
|
<li><tt>svn co http://llvm.org/svn/llvm-project/cfe/trunk clang</tt></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
2004-12-10 15:51:16 +00:00
|
|
|
|
2012-02-26 22:12:59 +00:00
|
|
|
<li>Checkout Compiler-RT:
|
|
|
|
|
<ul>
|
|
|
|
|
<li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
|
|
|
|
|
<li><tt>cd llvm/projects</tt>
|
|
|
|
|
<li><tt>svn co http://llvm.org/svn/llvm-project/compiler-rt/trunk
|
|
|
|
|
compiler-rt</tt></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>Get the Test Suite Source Code <b>[Optional]</b>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
|
|
|
|
|
<li><tt>cd llvm/projects</tt>
|
|
|
|
|
<li><tt>svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite</tt></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
2004-12-10 15:51:16 +00:00
|
|
|
|
2012-02-26 22:12:59 +00:00
|
|
|
<li>Configure and build LLVM and Clang:
|
|
|
|
|
<ul>
|
2005-02-03 22:25:23 +00:00
|
|
|
<li><tt>cd <i>where-you-want-to-build-llvm</i></tt></li>
|
2012-02-26 22:12:59 +00:00
|
|
|
<li><tt>mkdir build</tt> (for building without polluting the source dir)</li>
|
|
|
|
|
<li><tt>cd build</tt></li>
|
2012-03-27 11:25:16 +00:00
|
|
|
<li><tt>../llvm/configure [options]</tt>
|
|
|
|
|
<br>Some common options:
|
2005-02-03 22:25:23 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<ul>
|
2012-02-26 22:12:59 +00:00
|
|
|
<li><tt>--prefix=<i>directory</i></tt> -
|
|
|
|
|
Specify for <i>directory</i> the full pathname of where you
|
2005-02-03 22:25:23 +00:00
|
|
|
want the LLVM tools and libraries to be installed (default
|
2012-02-26 22:12:59 +00:00
|
|
|
<tt>/usr/local</tt>).</li>
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
<li><tt>--enable-optimized</tt> -
|
|
|
|
|
Compile with optimizations enabled (default is NO).</li>
|
2003-11-07 19:43:14 +00:00
|
|
|
</ul>
|
2012-02-26 22:12:59 +00:00
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
<li><tt>--enable-assertions</tt> -
|
|
|
|
|
Compile with assertion checks enabled (default is YES).</li>
|
|
|
|
|
</ul>
|
2012-03-27 11:25:16 +00:00
|
|
|
</li>
|
2012-02-26 22:12:59 +00:00
|
|
|
<li><tt>make [-j]</tt> - The -j specifies the number of jobs (commands) to
|
|
|
|
|
run simultaneously. This builds both LLVM and Clang for Debug+Asserts mode.
|
|
|
|
|
The --enabled-optimized configure option is used to specify a Release build.</li>
|
|
|
|
|
<li><tt>make check-all</tt> -
|
|
|
|
|
This run the regression tests to ensure everything is in working order.</li>
|
|
|
|
|
<li><tt>make update</tt> -
|
|
|
|
|
This command is used to update all the svn repositories at once, rather then
|
|
|
|
|
having to <tt>cd</tt> into the individual repositories and running
|
|
|
|
|
<tt>svn update</tt>.</li>
|
|
|
|
|
<li>It is also possible to use CMake instead of the makefiles. With CMake
|
|
|
|
|
it is also possible to generate project files for several IDEs: Eclipse
|
|
|
|
|
CDT4, CodeBlocks, Qt-Creator (use the CodeBlocks generator), KDevelop3.</li>
|
|
|
|
|
<li>If you get an "internal compiler error (ICE)" or test failures, see
|
|
|
|
|
<a href="#brokengcc">below</a>.</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
|
|
|
|
</ol>
|
|
|
|
|
|
2004-06-21 22:52:48 +00:00
|
|
|
<p>Consult the <a href="#starting">Getting Started with LLVM</a> section for
|
2003-11-07 19:43:14 +00:00
|
|
|
detailed information on configuring and compiling LLVM. See <a
|
|
|
|
|
href="#environment">Setting Up Your Environment</a> for tips that simplify
|
2012-02-26 22:26:37 +00:00
|
|
|
working with the Clang front end and LLVM tools. Go to <a href="#layout">Program
|
2003-11-07 19:43:14 +00:00
|
|
|
Layout</a> to learn about the layout of the source code tree.</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- *********************************************************************** -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h2>
|
|
|
|
|
<a name="requirements">Requirements</a>
|
|
|
|
|
</h2>
|
2003-11-07 19:43:14 +00:00
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
|
|
|
|
<p>Before you begin to use the LLVM system, review the requirements given below.
|
|
|
|
|
This may save you some trouble by knowing ahead of time what hardware and
|
|
|
|
|
software you will need.</p>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
|
|
|
|
<a name="hardware">Hardware</a>
|
|
|
|
|
</h3>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
|
|
|
|
<p>LLVM is known to work on the following platforms:</p>
|
|
|
|
|
|
2006-09-07 04:19:09 +00:00
|
|
|
<table cellpadding="3" summary="Known LLVM platforms">
|
2004-11-15 05:19:53 +00:00
|
|
|
<tr>
|
|
|
|
|
<th>OS</th>
|
|
|
|
|
<th>Arch</th>
|
2004-11-19 21:53:22 +00:00
|
|
|
<th>Compilers</th>
|
2004-11-15 05:19:53 +00:00
|
|
|
</tr>
|
2009-07-21 22:47:03 +00:00
|
|
|
<tr>
|
2009-07-22 04:21:40 +00:00
|
|
|
<td>AuroraUX</td>
|
|
|
|
|
<td>x86<sup><a href="#pf_1">1</a></sup></td>
|
|
|
|
|
<td>GCC</td>
|
2009-07-21 22:47:03 +00:00
|
|
|
</tr>
|
2004-11-15 05:19:53 +00:00
|
|
|
<tr>
|
|
|
|
|
<td>Linux</td>
|
2005-02-09 21:15:51 +00:00
|
|
|
<td>x86<sup><a href="#pf_1">1</a></sup></td>
|
2004-11-19 21:53:22 +00:00
|
|
|
<td>GCC</td>
|
2004-11-15 05:19:53 +00:00
|
|
|
</tr>
|
2009-08-04 05:24:28 +00:00
|
|
|
<tr>
|
|
|
|
|
<td>Linux</td>
|
|
|
|
|
<td>amd64</td>
|
|
|
|
|
<td>GCC</td>
|
|
|
|
|
</tr>
|
2004-11-15 05:19:53 +00:00
|
|
|
<tr>
|
|
|
|
|
<td>Solaris</td>
|
|
|
|
|
<td>V9 (Ultrasparc)</td>
|
2004-11-19 21:53:22 +00:00
|
|
|
<td>GCC</td>
|
2004-11-15 05:19:53 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>FreeBSD</td>
|
2005-02-09 21:15:51 +00:00
|
|
|
<td>x86<sup><a href="#pf_1">1</a></sup></td>
|
2004-11-19 21:53:22 +00:00
|
|
|
<td>GCC</td>
|
2004-11-15 05:19:53 +00:00
|
|
|
</tr>
|
2010-12-15 01:35:55 +00:00
|
|
|
<tr>
|
|
|
|
|
<td>FreeBSD</td>
|
|
|
|
|
<td>amd64</td>
|
|
|
|
|
<td>GCC</td>
|
|
|
|
|
</tr>
|
2004-11-15 05:19:53 +00:00
|
|
|
<tr>
|
2005-02-09 21:15:51 +00:00
|
|
|
<td>MacOS X<sup><a href="#pf_2">2</a></sup></td>
|
2004-11-15 05:19:53 +00:00
|
|
|
<td>PowerPC</td>
|
2004-11-19 21:53:22 +00:00
|
|
|
<td>GCC</td>
|
2004-11-15 05:19:53 +00:00
|
|
|
</tr>
|
2006-04-20 04:35:34 +00:00
|
|
|
<tr>
|
2008-03-18 23:13:26 +00:00
|
|
|
<td>MacOS X<sup><a href="#pf_2">2</a>,<a href="#pf_9">9</a></sup></td>
|
2006-04-20 04:35:34 +00:00
|
|
|
<td>x86</td>
|
|
|
|
|
<td>GCC</td>
|
|
|
|
|
</tr>
|
2004-11-15 05:19:53 +00:00
|
|
|
<tr>
|
2004-11-19 21:53:22 +00:00
|
|
|
<td>Cygwin/Win32</td>
|
2009-12-09 17:26:02 +00:00
|
|
|
<td>x86<sup><a href="#pf_1">1</a>,<a href="#pf_8">8</a>,
|
|
|
|
|
<a href="#pf_11">11</a></sup></td>
|
2010-02-11 21:51:51 +00:00
|
|
|
<td>GCC 3.4.X, binutils 2.20</td>
|
2004-11-19 21:53:22 +00:00
|
|
|
</tr>
|
2005-02-09 20:43:48 +00:00
|
|
|
<tr>
|
|
|
|
|
<td>MinGW/Win32</td>
|
2009-08-06 12:54:58 +00:00
|
|
|
<td>x86<sup><a href="#pf_1">1</a>,<a href="#pf_6">6</a>,
|
2011-03-28 06:27:06 +00:00
|
|
|
<a href="#pf_8">8</a>, <a href="#pf_10">10</a>,
|
|
|
|
|
<a href="#pf_11">11</a></sup></td>
|
2010-02-11 21:51:51 +00:00
|
|
|
<td>GCC 3.4.X, binutils 2.20</td>
|
2005-02-09 20:43:48 +00:00
|
|
|
</tr>
|
2004-11-19 21:53:22 +00:00
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<p>LLVM has partial support for the following platforms:</p>
|
|
|
|
|
|
2006-09-07 04:19:09 +00:00
|
|
|
<table summary="LLVM partial platform support">
|
2004-11-19 21:53:22 +00:00
|
|
|
<tr>
|
|
|
|
|
<th>OS</th>
|
|
|
|
|
<th>Arch</th>
|
|
|
|
|
<th>Compilers</th>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>Windows</td>
|
2005-02-09 21:15:51 +00:00
|
|
|
<td>x86<sup><a href="#pf_1">1</a></sup></td>
|
2011-11-16 19:52:13 +00:00
|
|
|
<td>Visual Studio 2008 or higher<sup><a href="#pf_4">4</a>,<a href="#pf_5">5</a></sup></td>
|
2004-11-19 21:53:22 +00:00
|
|
|
<tr>
|
2005-02-09 21:15:51 +00:00
|
|
|
<td>AIX<sup><a href="#pf_3">3</a>,<a href="#pf_4">4</a></sup></td>
|
2004-11-15 05:19:53 +00:00
|
|
|
<td>PowerPC</td>
|
2004-11-19 21:53:22 +00:00
|
|
|
<td>GCC</td>
|
2004-11-15 05:19:53 +00:00
|
|
|
</tr>
|
2004-11-15 21:05:08 +00:00
|
|
|
<tr>
|
2005-02-09 21:15:51 +00:00
|
|
|
<td>Linux<sup><a href="#pf_3">3</a>,<a href="#pf_5">5</a></sup></td>
|
2004-11-15 21:05:08 +00:00
|
|
|
<td>PowerPC</td>
|
2004-11-19 21:53:22 +00:00
|
|
|
<td>GCC</td>
|
2004-11-15 21:05:08 +00:00
|
|
|
</tr>
|
2005-05-09 16:49:59 +00:00
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
|
<td>Linux<sup><a href="#pf_7">7</a></sup></td>
|
|
|
|
|
<td>Alpha</td>
|
|
|
|
|
<td>GCC</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>Linux<sup><a href="#pf_7">7</a></sup></td>
|
|
|
|
|
<td>Itanium (IA-64)</td>
|
|
|
|
|
<td>GCC</td>
|
|
|
|
|
</tr>
|
2005-05-10 06:57:53 +00:00
|
|
|
<tr>
|
|
|
|
|
<td>HP-UX<sup><a href="#pf_7">7</a></sup></td>
|
|
|
|
|
<td>Itanium (IA-64)</td>
|
|
|
|
|
<td>HP aCC</td>
|
|
|
|
|
</tr>
|
2011-03-28 06:27:12 +00:00
|
|
|
<tr>
|
|
|
|
|
<td>Windows x64</td>
|
|
|
|
|
<td>x86-64</td>
|
|
|
|
|
<td>mingw-w64's GCC-4.5.x<sup><a href="#pf_12">12</a></sup></td>
|
|
|
|
|
</tr>
|
2004-11-15 05:19:53 +00:00
|
|
|
</table>
|
|
|
|
|
|
2005-02-09 21:01:26 +00:00
|
|
|
<p><b>Notes:</b></p>
|
|
|
|
|
|
2005-02-09 22:38:47 +00:00
|
|
|
<div class="doc_notes">
|
|
|
|
|
<ol>
|
|
|
|
|
<li><a name="pf_1">Code generation supported for Pentium processors and
|
|
|
|
|
up</a></li>
|
|
|
|
|
<li><a name="pf_2">Code generation supported for 32-bit ABI only</a></li>
|
|
|
|
|
<li><a name="pf_3">No native code generation</a></li>
|
2008-12-08 00:45:02 +00:00
|
|
|
<li><a name="pf_4">Build is not complete: one or more tools do not link or function</a></li>
|
2005-02-09 22:38:47 +00:00
|
|
|
<li><a name="pf_5">The GCC-based C/C++ frontend does not build</a></li>
|
2009-01-02 07:10:51 +00:00
|
|
|
<li><a name="pf_6">The port is done using the MSYS shell.</a></li>
|
2005-05-09 16:49:59 +00:00
|
|
|
<li><a name="pf_7">Native code generation exists but is not complete.</a></li>
|
2010-02-11 21:51:51 +00:00
|
|
|
<li><a name="pf_8">Binutils 2.20 or later is required to build the assembler
|
|
|
|
|
generated by LLVM properly.</a></li>
|
2012-05-13 14:36:15 +00:00
|
|
|
<li><a name="pf_9">Xcode 2.5 and gcc 4.0.1</a> (Apple Build 5370) will trip
|
2008-03-18 23:13:26 +00:00
|
|
|
internal LLVM assert messages when compiled for Release at optimization
|
2008-11-09 17:19:14 +00:00
|
|
|
levels greater than 0 (i.e., <i>"-O1"</i> and higher).
|
|
|
|
|
Add <i>OPTIMIZE_OPTION="-O0"</i> to the build command line
|
2008-03-18 23:13:26 +00:00
|
|
|
if compiling for LLVM Release or bootstrapping the LLVM toolchain.</li>
|
2009-08-06 12:54:58 +00:00
|
|
|
<li><a name="pf_10">For MSYS/MinGW on Windows, be sure to install the MSYS
|
|
|
|
|
version of the perl package, and be sure it appears in your path
|
|
|
|
|
before any Windows-based versions such as Strawberry Perl and
|
|
|
|
|
ActivePerl, as these have Windows-specifics that will cause the
|
|
|
|
|
build to fail.</a></li>
|
2011-03-28 06:27:06 +00:00
|
|
|
<li><a name="pf_11">To use LLVM modules on Win32-based system,
|
2011-04-09 09:51:57 +00:00
|
|
|
you may configure LLVM with <i>"--enable-shared"</i>.</a></li>
|
2011-03-28 06:27:12 +00:00
|
|
|
<li><a name="pf_12">To compile SPU backend, you need to add
|
2011-04-09 09:51:57 +00:00
|
|
|
<tt>"LDFLAGS=-Wl,--stack,16777216"</tt> to configure.</a></li>
|
2005-02-09 21:01:26 +00:00
|
|
|
</ol>
|
|
|
|
|
</div>
|
2003-10-20 16:39:52 +00:00
|
|
|
|
2004-11-19 21:53:22 +00:00
|
|
|
<p>Note that you will need about 1-3 GB of space for a full LLVM build in Debug
|
2005-05-18 19:43:33 +00:00
|
|
|
mode, depending on the system (it is so large because of all the debugging
|
|
|
|
|
information and the fact that the libraries are statically linked into multiple
|
2009-04-25 22:08:52 +00:00
|
|
|
tools). If you do not need many of the tools and you are space-conscious, you
|
|
|
|
|
can pass <tt>ONLY_TOOLS="tools you need"</tt> to make. The Release build
|
|
|
|
|
requires considerably less space.</p>
|
2004-11-19 21:53:22 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<p>The LLVM suite <i>may</i> compile on other platforms, but it is not
|
|
|
|
|
guaranteed to do so. If compilation is successful, the LLVM utilities should be
|
2007-07-06 22:07:22 +00:00
|
|
|
able to assemble, disassemble, analyze, and optimize LLVM bitcode. Code
|
2003-11-07 19:43:14 +00:00
|
|
|
generation should work as well, although the generated native code may not work
|
|
|
|
|
on your platform.</p>
|
2003-10-20 16:39:52 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
</div>
|
2003-10-20 16:39:52 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
|
|
|
|
<a name="software">Software</a>
|
|
|
|
|
</h3>
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2004-11-15 21:15:12 +00:00
|
|
|
<p>Compiling LLVM requires that you have several software packages
|
|
|
|
|
installed. The table below lists those required packages. The Package column
|
|
|
|
|
is the usual name for the software package that LLVM depends on. The Version
|
|
|
|
|
column provides "known to work" versions of the package. The Notes column
|
|
|
|
|
describes how LLVM uses the package and provides other details.</p>
|
2006-09-07 04:19:09 +00:00
|
|
|
<table summary="Packages required to compile LLVM">
|
2004-11-15 21:15:12 +00:00
|
|
|
<tr><th>Package</th><th>Version</th><th>Notes</th></tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
|
<td><a href="http://savannah.gnu.org/projects/make">GNU Make</a></td>
|
|
|
|
|
<td>3.79, 3.79.1</td>
|
|
|
|
|
<td>Makefile/build processor</td>
|
|
|
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
2011-04-09 02:13:37 +00:00
|
|
|
<td><a href="http://gcc.gnu.org/">GCC</a></td>
|
2004-11-15 21:15:12 +00:00
|
|
|
<td>3.4.2</td>
|
2005-02-09 22:38:47 +00:00
|
|
|
<td>C/C++ compiler<sup><a href="#sf1">1</a></sup></td>
|
2004-11-15 21:15:12 +00:00
|
|
|
</tr>
|
|
|
|
|
|
2005-09-06 04:07:15 +00:00
|
|
|
<tr>
|
2011-04-09 02:13:37 +00:00
|
|
|
<td><a href="http://www.gnu.org/software/texinfo/">TeXinfo</a></td>
|
2005-09-06 04:07:15 +00:00
|
|
|
<td>4.5</td>
|
|
|
|
|
<td>For building the CFE</td>
|
|
|
|
|
</tr>
|
|
|
|
|
|
2005-02-09 22:38:47 +00:00
|
|
|
<tr>
|
2007-06-29 19:12:31 +00:00
|
|
|
<td><a href="http://subversion.tigris.org/project_packages.html">SVN</a></td>
|
|
|
|
|
<td>≥1.3</td>
|
|
|
|
|
<td>Subversion access to LLVM<sup><a href="#sf2">2</a></sup></td>
|
2005-02-09 22:38:47 +00:00
|
|
|
</tr>
|
|
|
|
|
|
2011-04-05 08:24:15 +00:00
|
|
|
<!-- FIXME:
|
|
|
|
|
Do we support dg?
|
|
|
|
|
Are DejaGnu and expect obsolete?
|
|
|
|
|
Shall we mention Python? -->
|
|
|
|
|
|
2004-11-15 21:15:12 +00:00
|
|
|
<tr>
|
|
|
|
|
<td><a href="http://savannah.gnu.org/projects/dejagnu">DejaGnu</a></td>
|
|
|
|
|
<td>1.4.2</td>
|
2005-02-09 22:38:47 +00:00
|
|
|
<td>Automated test suite<sup><a href="#sf3">3</a></sup></td>
|
2004-11-15 21:15:12 +00:00
|
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
|
<td><a href="http://www.tcl.tk/software/tcltk/">tcl</a></td>
|
|
|
|
|
<td>8.3, 8.4</td>
|
2005-02-09 22:38:47 +00:00
|
|
|
<td>Automated test suite<sup><a href="#sf3">3</a></sup></td>
|
2004-11-15 21:15:12 +00:00
|
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
|
<td><a href="http://expect.nist.gov/">expect</a></td>
|
|
|
|
|
<td>5.38.0</td>
|
2005-02-09 22:38:47 +00:00
|
|
|
<td>Automated test suite<sup><a href="#sf3">3</a></sup></td>
|
|
|
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
|
<td><a href="http://www.perl.com/download.csp">perl</a></td>
|
|
|
|
|
<td>≥5.6.0</td>
|
2012-02-15 19:24:11 +00:00
|
|
|
<td>Utilities</td>
|
2004-11-15 21:15:12 +00:00
|
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
|
<td><a href="http://savannah.gnu.org/projects/m4">GNU M4</a>
|
|
|
|
|
<td>1.4</td>
|
2005-02-09 22:38:47 +00:00
|
|
|
<td>Macro processor for configuration<sup><a href="#sf4">4</a></sup></td>
|
2004-11-15 21:15:12 +00:00
|
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
2011-04-09 02:13:37 +00:00
|
|
|
<td><a href="http://www.gnu.org/software/autoconf/">GNU Autoconf</a></td>
|
2009-09-27 04:56:27 +00:00
|
|
|
<td>2.60</td>
|
2005-02-09 22:38:47 +00:00
|
|
|
<td>Configuration script builder<sup><a href="#sf4">4</a></sup></td>
|
2004-11-15 21:15:12 +00:00
|
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
2011-04-09 02:13:37 +00:00
|
|
|
<td><a href="http://www.gnu.org/software/automake/">GNU Automake</a></td>
|
2009-09-27 04:56:27 +00:00
|
|
|
<td>1.9.6</td>
|
2005-02-09 22:38:47 +00:00
|
|
|
<td>aclocal macro generator<sup><a href="#sf4">4</a></sup></td>
|
2004-11-15 21:15:12 +00:00
|
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
|
|
|
<td><a href="http://savannah.gnu.org/projects/libtool">libtool</a></td>
|
2009-09-27 04:56:27 +00:00
|
|
|
<td>1.5.22</td>
|
2005-02-09 22:38:47 +00:00
|
|
|
<td>Shared library manager<sup><a href="#sf4">4</a></sup></td>
|
2004-11-15 21:15:12 +00:00
|
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
</table>
|
|
|
|
|
|
2005-02-09 22:38:47 +00:00
|
|
|
<p><b>Notes:</b></p>
|
|
|
|
|
<div class="doc_notes">
|
2004-11-15 21:15:12 +00:00
|
|
|
<ol>
|
2006-09-07 04:19:09 +00:00
|
|
|
<li><a name="sf1">Only the C and C++ languages are needed so there's no
|
2004-11-22 17:16:26 +00:00
|
|
|
need to build the other languages for LLVM's purposes.</a> See
|
2005-02-09 22:38:47 +00:00
|
|
|
<a href="#brokengcc">below</a> for specific version info.</li>
|
2007-06-29 19:12:31 +00:00
|
|
|
<li><a name="sf2">You only need Subversion if you intend to build from the
|
2004-11-15 21:15:12 +00:00
|
|
|
latest LLVM sources. If you're working from a release distribution, you
|
2007-06-29 19:12:31 +00:00
|
|
|
don't need Subversion.</a></li>
|
2005-02-09 22:38:47 +00:00
|
|
|
<li><a name="sf3">Only needed if you want to run the automated test
|
|
|
|
|
suite in the <tt>llvm/test</tt> directory.</a></li>
|
|
|
|
|
<li><a name="sf4">If you want to make changes to the configure scripts,
|
2010-05-19 07:00:17 +00:00
|
|
|
you will need GNU autoconf (2.60), and consequently, GNU M4 (version 1.4
|
|
|
|
|
or higher). You will also need automake (1.9.6). We only use aclocal
|
2005-02-09 22:38:47 +00:00
|
|
|
from that package.</a></li>
|
2004-11-15 21:15:12 +00:00
|
|
|
</ol>
|
2005-02-09 22:38:47 +00:00
|
|
|
</div>
|
|
|
|
|
|
2004-11-15 21:15:12 +00:00
|
|
|
<p>Additionally, your compilation host is expected to have the usual
|
|
|
|
|
plethora of Unix utilities. Specifically:</p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><b>ar</b> - archive library builder</li>
|
|
|
|
|
<li><b>bzip2*</b> - bzip2 command for distribution generation</li>
|
|
|
|
|
<li><b>bunzip2*</b> - bunzip2 command for distribution checking</li>
|
|
|
|
|
<li><b>chmod</b> - change permissions on a file</li>
|
2004-12-08 16:55:27 +00:00
|
|
|
<li><b>cat</b> - output concatenation utility</li>
|
2004-11-15 21:15:12 +00:00
|
|
|
<li><b>cp</b> - copy files</li>
|
|
|
|
|
<li><b>date</b> - print the current date/time </li>
|
|
|
|
|
<li><b>echo</b> - print to standard output</li>
|
|
|
|
|
<li><b>egrep</b> - extended regular expression search utility</li>
|
|
|
|
|
<li><b>find</b> - find files/dirs in a file system</li>
|
|
|
|
|
<li><b>grep</b> - regular expression search utility</li>
|
|
|
|
|
<li><b>gzip*</b> - gzip command for distribution generation</li>
|
|
|
|
|
<li><b>gunzip*</b> - gunzip command for distribution checking</li>
|
|
|
|
|
<li><b>install</b> - install directories/files </li>
|
|
|
|
|
<li><b>mkdir</b> - create a directory</li>
|
|
|
|
|
<li><b>mv</b> - move (rename) files</li>
|
|
|
|
|
<li><b>ranlib</b> - symbol table builder for archive libraries</li>
|
2004-11-20 01:27:40 +00:00
|
|
|
<li><b>rm</b> - remove (delete) files and directories</li>
|
2004-11-15 21:15:12 +00:00
|
|
|
<li><b>sed</b> - stream editor for transforming output</li>
|
|
|
|
|
<li><b>sh</b> - Bourne shell for make build scripts</li>
|
|
|
|
|
<li><b>tar</b> - tape archive for distribution generation</li>
|
|
|
|
|
<li><b>test</b> - test things in file system</li>
|
|
|
|
|
<li><b>unzip*</b> - unzip command for distribution checking</li>
|
|
|
|
|
<li><b>zip*</b> - zip command for distribution generation</li>
|
|
|
|
|
</ul>
|
2004-07-18 22:32:22 +00:00
|
|
|
</div>
|
2003-10-27 18:18:16 +00:00
|
|
|
|
2004-07-18 22:32:22 +00:00
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
2007-06-19 05:52:36 +00:00
|
|
|
<a name="brokengcc">Broken versions of GCC and other tools</a>
|
2011-04-18 23:59:50 +00:00
|
|
|
</h3>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2004-07-18 22:32:22 +00:00
|
|
|
|
|
|
|
|
<p>LLVM is very demanding of the host C++ compiler, and as such tends to expose
|
|
|
|
|
bugs in the compiler. In particular, several versions of GCC crash when trying
|
2011-10-31 21:23:15 +00:00
|
|
|
to compile LLVM. We routinely use GCC 4.2 (and higher) or Clang.
|
|
|
|
|
Other versions of GCC will probably work as well. GCC versions listed
|
2004-07-18 22:32:22 +00:00
|
|
|
here are known to not work. If you are using one of these versions, please try
|
|
|
|
|
to upgrade your GCC to something more recent. If you run into a problem with a
|
|
|
|
|
version of GCC not listed here, please <a href="mailto:llvmdev@cs.uiuc.edu">let
|
|
|
|
|
us know</a>. Please use the "<tt>gcc -v</tt>" command to find out which version
|
|
|
|
|
of GCC you are using.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p><b>GCC versions prior to 3.0</b>: GCC 2.96.x and before had several
|
|
|
|
|
problems in the STL that effectively prevent it from compiling LLVM.
|
|
|
|
|
</p>
|
|
|
|
|
|
2008-02-13 17:50:24 +00:00
|
|
|
<p><b>GCC 3.2.2 and 3.2.3</b>: These versions of GCC fails to compile LLVM with
|
|
|
|
|
a bogus template error. This was fixed in later GCCs.</p>
|
2004-11-23 22:06:24 +00:00
|
|
|
|
2004-07-18 22:32:22 +00:00
|
|
|
<p><b>GCC 3.3.2</b>: This version of GCC suffered from a <a
|
|
|
|
|
href="http://gcc.gnu.org/PR13392">serious bug</a> which causes it to crash in
|
|
|
|
|
the "<tt>convert_from_eh_region_ranges_1</tt>" GCC function.</p>
|
2005-02-12 20:11:13 +00:00
|
|
|
|
2005-02-13 22:20:49 +00:00
|
|
|
<p><b>Cygwin GCC 3.3.3</b>: The version of GCC 3.3.3 commonly shipped with
|
2012-02-26 22:26:37 +00:00
|
|
|
Cygwin does not work.</p>
|
2005-02-13 22:20:49 +00:00
|
|
|
<p><b>SuSE GCC 3.3.3</b>: The version of GCC 3.3.3 shipped with SuSE 9.1 (and
|
|
|
|
|
possibly others) does not compile LLVM correctly (it appears that exception
|
|
|
|
|
handling is broken in some cases). Please download the FSF 3.3.3 or upgrade
|
|
|
|
|
to a newer version of GCC.</p>
|
2007-07-16 08:52:56 +00:00
|
|
|
<p><b>GCC 3.4.0 on linux/x86 (32-bit)</b>: GCC miscompiles portions of the
|
2007-05-10 06:42:21 +00:00
|
|
|
code generator, causing an infinite loop in the llvm-gcc build when built
|
|
|
|
|
with optimizations enabled (i.e. a release build).</p>
|
2007-07-16 08:52:56 +00:00
|
|
|
<p><b>GCC 3.4.2 on linux/x86 (32-bit)</b>: GCC miscompiles portions of the
|
2007-05-10 06:42:21 +00:00
|
|
|
code generator at -O3, as with 3.4.0. However gcc 3.4.2 (unlike 3.4.0)
|
|
|
|
|
correctly compiles LLVM at -O2. A work around is to build release LLVM
|
|
|
|
|
builds with "make ENABLE_OPTIMIZED=1 OPTIMIZE_OPTION=-O2 ..."</p>
|
2007-07-16 08:52:56 +00:00
|
|
|
<p><b>GCC 3.4.x on X86-64/amd64</b>: GCC <a href="http://llvm.org/PR1056">
|
2007-04-01 20:14:46 +00:00
|
|
|
miscompiles portions of LLVM</a>.</p>
|
2007-11-01 04:20:16 +00:00
|
|
|
<p><b>GCC 3.4.4 (CodeSourcery ARM 2005q3-2)</b>: this compiler miscompiles LLVM
|
|
|
|
|
when building with optimizations enabled. It appears to work with
|
|
|
|
|
"<tt>make ENABLE_OPTIMIZED=1 OPTIMIZE_OPTION=-O1</tt>" or build a debug
|
|
|
|
|
build.</p>
|
2005-05-15 22:26:45 +00:00
|
|
|
<p><b>IA-64 GCC 4.0.0</b>: The IA-64 version of GCC 4.0.0 is known to
|
|
|
|
|
miscompile LLVM.</p>
|
2006-06-16 19:53:39 +00:00
|
|
|
<p><b>Apple Xcode 2.3</b>: GCC crashes when compiling LLVM at -O3 (which is the
|
|
|
|
|
default with ENABLE_OPTIMIZED=1. To work around this, build with
|
|
|
|
|
"ENABLE_OPTIMIZED=1 OPTIMIZE_OPTION=-O2".</p>
|
2006-09-07 17:34:27 +00:00
|
|
|
<p><b>GCC 4.1.1</b>: GCC fails to build LLVM with template concept check errors
|
|
|
|
|
compiling some files. At the time of this writing, GCC mainline (4.2)
|
|
|
|
|
did not share the problem.</p>
|
2007-01-04 07:06:05 +00:00
|
|
|
<p><b>GCC 4.1.1 on X86-64/amd64</b>: GCC <a href="http://llvm.org/PR1063">
|
|
|
|
|
miscompiles portions of LLVM</a> when compiling llvm itself into 64-bit
|
|
|
|
|
code. LLVM will appear to mostly work but will be buggy, e.g. failing
|
|
|
|
|
portions of its testsuite.</p>
|
2007-04-11 21:28:31 +00:00
|
|
|
<p><b>GCC 4.1.2 on OpenSUSE</b>: Seg faults during libstdc++ build and on x86_64
|
|
|
|
|
platforms compiling md5.c gets a mangled constant.</p>
|
2008-10-11 18:40:33 +00:00
|
|
|
<p><b>GCC 4.1.2 (20061115 (prerelease) (Debian 4.1.1-21)) on Debian</b>: Appears
|
|
|
|
|
to miscompile parts of LLVM 2.4. One symptom is ValueSymbolTable complaining
|
|
|
|
|
about symbols remaining in the table on destruction.</p>
|
2008-12-10 16:11:10 +00:00
|
|
|
<p><b>GCC 4.1.2 20071124 (Red Hat 4.1.2-42)</b>: Suffers from the same symptoms
|
2008-12-10 16:01:22 +00:00
|
|
|
as the previous one. It appears to work with ENABLE_OPTIMIZED=0 (the default).</p>
|
2009-05-04 18:40:41 +00:00
|
|
|
<p><b>Cygwin GCC 4.3.2 20080827 (beta) 2</b>:
|
|
|
|
|
Users <a href="http://llvm.org/PR4145">reported</a> various problems related
|
|
|
|
|
with link errors when using this GCC version.</p>
|
2009-09-10 16:25:02 +00:00
|
|
|
<p><b>Debian GCC 4.3.2 on X86</b>: Crashes building some files in LLVM 2.6.</p>
|
2009-07-17 06:32:10 +00:00
|
|
|
<p><b>GCC 4.3.3 (Debian 4.3.3-10) on ARM</b>: Miscompiles parts of LLVM 2.6
|
|
|
|
|
when optimizations are turned on. The symptom is an infinite loop in
|
2009-09-10 16:25:02 +00:00
|
|
|
FoldingSetImpl::RemoveNode while running the code generator.</p>
|
2010-10-07 22:30:47 +00:00
|
|
|
<p><b>GCC 4.3.5 and GCC 4.4.5 on ARM</b>: These can miscompile <tt>value >>
|
|
|
|
|
1</tt> even at -O0. A test failure in <tt>test/Assembler/alignstack.ll</tt> is
|
|
|
|
|
one symptom of the problem.
|
2006-11-04 00:33:42 +00:00
|
|
|
<p><b>GNU ld 2.16.X</b>. Some 2.16.X versions of the ld linker will produce very
|
|
|
|
|
long warning messages complaining that some ".gnu.linkonce.t.*" symbol was
|
|
|
|
|
defined in a discarded section. You can safely ignore these messages as they are
|
|
|
|
|
erroneous and the linkage is correct. These messages disappear using ld
|
|
|
|
|
2.17.</p>
|
2007-06-19 05:52:36 +00:00
|
|
|
|
|
|
|
|
<p><b>GNU binutils 2.17</b>: Binutils 2.17 contains <a
|
|
|
|
|
href="http://sourceware.org/bugzilla/show_bug.cgi?id=3111">a bug</a> which
|
|
|
|
|
causes huge link times (minutes instead of seconds) when building LLVM. We
|
|
|
|
|
recommend upgrading to a newer version (2.17.50.0.4 or later).</p>
|
|
|
|
|
|
2009-03-03 05:41:16 +00:00
|
|
|
<p><b>GNU Binutils 2.19.1 Gold</b>: This version of Gold contained
|
2009-02-25 06:29:47 +00:00
|
|
|
<a href="http://sourceware.org/bugzilla/show_bug.cgi?id=9836">a bug</a>
|
|
|
|
|
which causes intermittent failures when building LLVM with position independent
|
2009-03-03 05:41:16 +00:00
|
|
|
code. The symptom is an error about cyclic dependencies. We recommend
|
|
|
|
|
upgrading to a newer version of Gold.</p>
|
2009-02-25 06:29:47 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
</div>
|
|
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
</div>
|
2004-07-18 22:32:22 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<!-- *********************************************************************** -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h2>
|
|
|
|
|
<a name="starting">Getting Started with LLVM</a>
|
|
|
|
|
</h2>
|
2003-11-07 19:43:14 +00:00
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2004-07-18 22:32:22 +00:00
|
|
|
|
|
|
|
|
<p>The remainder of this guide is meant to get you up and running with
|
|
|
|
|
LLVM and to give you some basic information about the LLVM environment.</p>
|
|
|
|
|
|
|
|
|
|
<p>The later sections of this guide describe the <a
|
|
|
|
|
href="#layout">general layout</a> of the the LLVM source tree, a <a
|
|
|
|
|
href="#tutorial">simple example</a> using the LLVM tool chain, and <a
|
|
|
|
|
href="#links">links</a> to find more information about LLVM or to get
|
|
|
|
|
help via e-mail.</p>
|
|
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
2003-11-07 19:43:14 +00:00
|
|
|
<a name="terminology">Terminology and Notation</a>
|
2011-04-18 23:59:50 +00:00
|
|
|
</h3>
|
2003-06-30 21:59:07 +00:00
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
|
|
|
|
<p>Throughout this manual, the following names are used to denote paths
|
|
|
|
|
specific to the local system and working environment. <i>These are not
|
|
|
|
|
environment variables you need to set but just strings used in the rest
|
|
|
|
|
of this document below</i>. In any of the examples below, simply replace
|
|
|
|
|
each of these names with the appropriate pathname on your local system.
|
|
|
|
|
All these paths are absolute:</p>
|
|
|
|
|
|
2004-01-20 00:20:17 +00:00
|
|
|
<dl>
|
2003-11-07 19:43:14 +00:00
|
|
|
<dt>SRC_ROOT
|
|
|
|
|
<dd>
|
|
|
|
|
This is the top level directory of the LLVM source tree.
|
2006-09-07 04:19:09 +00:00
|
|
|
<br><br>
|
2003-06-12 19:34:44 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<dt>OBJ_ROOT
|
2003-07-03 16:01:38 +00:00
|
|
|
<dd>
|
2003-11-07 19:43:14 +00:00
|
|
|
This is the top level directory of the LLVM object tree (i.e. the
|
|
|
|
|
tree where object files and compiled programs will be placed. It
|
|
|
|
|
can be the same as SRC_ROOT).
|
2006-09-07 04:19:09 +00:00
|
|
|
<br><br>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
2003-11-07 19:43:14 +00:00
|
|
|
<a name="environment">Setting Up Your Environment</a>
|
2011-04-18 23:59:50 +00:00
|
|
|
</h3>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
|
|
|
|
<p>
|
2005-02-03 18:28:08 +00:00
|
|
|
In order to compile and use LLVM, you may need to set some environment
|
|
|
|
|
variables.
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2004-01-20 00:20:17 +00:00
|
|
|
<dl>
|
2007-07-06 22:07:22 +00:00
|
|
|
<dt><tt>LLVM_LIB_SEARCH_PATH</tt>=<tt>/path/to/your/bitcode/libs</tt></dt>
|
2005-02-03 18:28:08 +00:00
|
|
|
<dd>[Optional] This environment variable helps LLVM linking tools find the
|
2007-07-06 22:07:22 +00:00
|
|
|
locations of your bitcode libraries. It is provided only as a
|
2005-02-03 18:28:08 +00:00
|
|
|
convenience since you can specify the paths using the -L options of the
|
2007-07-06 22:07:22 +00:00
|
|
|
tools and the C/C++ front-end will automatically use the bitcode files
|
2005-05-18 19:43:33 +00:00
|
|
|
installed in its
|
2005-02-03 18:28:08 +00:00
|
|
|
<tt>lib</tt> directory.</dd>
|
2003-11-07 19:43:14 +00:00
|
|
|
</dl>
|
2003-06-12 19:34:44 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
</div>
|
2003-07-03 16:01:38 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
2004-01-20 00:20:17 +00:00
|
|
|
<a name="unpack">Unpacking the LLVM Archives</a>
|
2011-04-18 23:59:50 +00:00
|
|
|
</h3>
|
2003-07-03 16:01:38 +00:00
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2003-07-03 16:01:38 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<p>
|
|
|
|
|
If you have the LLVM distribution, you will need to unpack it before you
|
2003-12-18 16:43:17 +00:00
|
|
|
can begin to compile it. LLVM is distributed as a set of two files: the LLVM
|
2004-12-10 15:51:16 +00:00
|
|
|
suite and the LLVM GCC front end compiled for your platform. There is an
|
|
|
|
|
additional test suite that is optional. Each file is a TAR archive that is
|
|
|
|
|
compressed with the gzip program.
|
2003-11-07 19:43:14 +00:00
|
|
|
</p>
|
2003-06-12 19:34:44 +00:00
|
|
|
|
2005-02-02 18:01:57 +00:00
|
|
|
<p>The files are as follows, with <em>x.y</em> marking the version number:
|
2004-01-20 00:20:17 +00:00
|
|
|
<dl>
|
2005-02-02 18:01:57 +00:00
|
|
|
<dt><tt>llvm-x.y.tar.gz</tt></dt>
|
2008-12-11 18:23:24 +00:00
|
|
|
<dd>Source release for the LLVM libraries and tools.<br></dd>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2005-02-02 18:01:57 +00:00
|
|
|
<dt><tt>llvm-test-x.y.tar.gz</tt></dt>
|
2010-09-23 20:26:44 +00:00
|
|
|
<dd>Source release for the LLVM test-suite.</dd>
|
2004-11-23 19:26:24 +00:00
|
|
|
|
2008-12-29 19:38:58 +00:00
|
|
|
<dt><tt>llvm-gcc-4.2-x.y.source.tar.gz</tt></dt>
|
|
|
|
|
<dd>Source release of the llvm-gcc-4.2 front end. See README.LLVM in the root
|
2008-12-11 18:23:24 +00:00
|
|
|
directory for build instructions.<br></dd>
|
2006-04-20 05:08:23 +00:00
|
|
|
|
2008-12-29 19:38:58 +00:00
|
|
|
<dt><tt>llvm-gcc-4.2-x.y-platform.tar.gz</tt></dt>
|
|
|
|
|
<dd>Binary release of the llvm-gcc-4.2 front end for a specific platform.<br></dd>
|
2006-04-20 05:08:23 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
</dl>
|
2003-06-12 19:34:44 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
2007-06-29 19:12:31 +00:00
|
|
|
<a name="checkout">Checkout LLVM from Subversion</a>
|
2011-04-18 23:59:50 +00:00
|
|
|
</h3>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2003-06-12 19:34:44 +00:00
|
|
|
|
2007-06-29 19:12:31 +00:00
|
|
|
<p>If you have access to our Subversion repository, you can get a fresh copy of
|
2009-04-25 22:24:49 +00:00
|
|
|
the entire source code. All you need to do is check it out from Subversion as
|
2003-11-07 19:43:14 +00:00
|
|
|
follows:</p>
|
|
|
|
|
|
|
|
|
|
<ul>
|
2007-06-29 19:12:31 +00:00
|
|
|
<li><tt>cd <i>where-you-want-llvm-to-live</i></tt></li>
|
2007-06-29 20:56:49 +00:00
|
|
|
<li>Read-Only: <tt>svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm</tt></li>
|
|
|
|
|
<li>Read-Write:<tt>svn co https://user@llvm.org/svn/llvm-project/llvm/trunk
|
2007-06-29 19:12:31 +00:00
|
|
|
llvm</tt></li>
|
2003-11-07 19:43:14 +00:00
|
|
|
</ul>
|
|
|
|
|
|
2007-06-29 19:12:31 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<p>This will create an '<tt>llvm</tt>' directory in the current
|
|
|
|
|
directory and fully populate it with the LLVM source code, Makefiles,
|
|
|
|
|
test directories, and local copies of documentation files.</p>
|
|
|
|
|
|
2004-01-20 00:20:17 +00:00
|
|
|
<p>If you want to get a specific release (as opposed to the most recent
|
2007-06-29 23:13:42 +00:00
|
|
|
revision), you can checkout it from the '<tt>tags</tt>' directory (instead of
|
2007-06-30 00:00:57 +00:00
|
|
|
'<tt>trunk</tt>'). The following releases are located in the following
|
2008-12-17 16:27:23 +00:00
|
|
|
subdirectories of the '<tt>tags</tt>' directory:</p>
|
2004-01-20 00:20:17 +00:00
|
|
|
|
2003-12-18 16:43:17 +00:00
|
|
|
<ul>
|
2011-04-04 23:42:51 +00:00
|
|
|
<li>Release 2.9: <b>RELEASE_29/final</b></li>
|
2010-10-06 23:50:30 +00:00
|
|
|
<li>Release 2.8: <b>RELEASE_28</b></li>
|
2010-10-06 05:36:01 +00:00
|
|
|
<li>Release 2.7: <b>RELEASE_27</b></li>
|
2009-10-23 06:20:06 +00:00
|
|
|
<li>Release 2.6: <b>RELEASE_26</b></li>
|
2009-04-25 22:24:49 +00:00
|
|
|
<li>Release 2.5: <b>RELEASE_25</b></li>
|
2008-12-17 16:27:23 +00:00
|
|
|
<li>Release 2.4: <b>RELEASE_24</b></li>
|
2008-06-09 06:02:09 +00:00
|
|
|
<li>Release 2.3: <b>RELEASE_23</b></li>
|
2008-02-12 02:42:55 +00:00
|
|
|
<li>Release 2.2: <b>RELEASE_22</b></li>
|
2007-09-28 22:50:54 +00:00
|
|
|
<li>Release 2.1: <b>RELEASE_21</b></li>
|
2007-05-22 06:06:22 +00:00
|
|
|
<li>Release 2.0: <b>RELEASE_20</b></li>
|
2006-11-20 06:07:10 +00:00
|
|
|
<li>Release 1.9: <b>RELEASE_19</b></li>
|
2006-11-20 06:04:46 +00:00
|
|
|
<li>Release 1.8: <b>RELEASE_18</b></li>
|
2006-04-20 04:35:34 +00:00
|
|
|
<li>Release 1.7: <b>RELEASE_17</b></li>
|
2005-11-08 21:11:33 +00:00
|
|
|
<li>Release 1.6: <b>RELEASE_16</b></li>
|
2005-05-09 16:49:59 +00:00
|
|
|
<li>Release 1.5: <b>RELEASE_15</b></li>
|
2004-12-08 16:51:31 +00:00
|
|
|
<li>Release 1.4: <b>RELEASE_14</b></li>
|
2004-08-16 14:51:33 +00:00
|
|
|
<li>Release 1.3: <b>RELEASE_13</b></li>
|
2004-05-12 19:25:59 +00:00
|
|
|
<li>Release 1.2: <b>RELEASE_12</b></li>
|
|
|
|
|
<li>Release 1.1: <b>RELEASE_11</b></li>
|
|
|
|
|
<li>Release 1.0: <b>RELEASE_1</b></li>
|
2003-12-18 16:43:17 +00:00
|
|
|
</ul>
|
|
|
|
|
|
2004-12-08 16:51:31 +00:00
|
|
|
<p>If you would like to get the LLVM test suite (a separate package as of 1.4),
|
2007-06-29 19:12:31 +00:00
|
|
|
you get it from the Subversion repository:</p>
|
2007-07-16 08:44:39 +00:00
|
|
|
|
|
|
|
|
<div class="doc_code">
|
2004-12-08 16:51:31 +00:00
|
|
|
<pre>
|
2007-07-16 08:44:39 +00:00
|
|
|
% cd llvm/projects
|
2010-09-23 20:26:44 +00:00
|
|
|
% svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite
|
2004-12-08 16:51:31 +00:00
|
|
|
</pre>
|
2007-07-16 08:44:39 +00:00
|
|
|
</div>
|
|
|
|
|
|
2004-12-08 16:51:31 +00:00
|
|
|
<p>By placing it in the <tt>llvm/projects</tt>, it will be automatically
|
2004-12-08 16:55:27 +00:00
|
|
|
configured by the LLVM configure script as well as automatically updated when
|
2007-06-29 19:12:31 +00:00
|
|
|
you run <tt>svn update</tt>.</p>
|
2004-12-08 16:51:31 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
</div>
|
|
|
|
|
|
2011-02-01 20:08:28 +00:00
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
2011-02-01 20:08:28 +00:00
|
|
|
<a name="git_mirror">GIT mirror</a>
|
2011-04-18 23:59:50 +00:00
|
|
|
</h3>
|
2011-02-01 20:08:28 +00:00
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2011-02-01 20:08:28 +00:00
|
|
|
|
|
|
|
|
<p>GIT mirrors are available for a number of LLVM subprojects. These mirrors
|
|
|
|
|
sync automatically with each Subversion commit and contain all necessary
|
|
|
|
|
git-svn marks (so, you can recreate git-svn metadata locally). Note that right
|
|
|
|
|
now mirrors reflect only <tt>trunk</tt> for each project. You can do the
|
2011-04-09 09:51:57 +00:00
|
|
|
read-only GIT clone of LLVM via:</p>
|
|
|
|
|
|
2011-07-20 23:37:51 +00:00
|
|
|
<pre class="doc_code">
|
2011-07-19 00:20:54 +00:00
|
|
|
git clone http://llvm.org/git/llvm.git
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<p>If you want to check out clang too, run:</p>
|
|
|
|
|
|
2011-07-20 23:37:51 +00:00
|
|
|
<pre class="doc_code">
|
2011-07-19 00:20:54 +00:00
|
|
|
git clone http://llvm.org/git/llvm.git
|
|
|
|
|
cd llvm/tools
|
|
|
|
|
git clone http://llvm.org/git/clang.git
|
|
|
|
|
</pre>
|
|
|
|
|
|
2011-08-12 07:48:01 +00:00
|
|
|
<p>
|
|
|
|
|
Since the upstream repository is in Subversion, you should use
|
|
|
|
|
<tt>"git pull --rebase"</tt>
|
|
|
|
|
instead of <tt>"git pull"</tt> to avoid generating a non-linear
|
|
|
|
|
history in your clone.
|
|
|
|
|
To configure <tt>"git pull"</tt> to pass <tt>--rebase</tt> by default
|
|
|
|
|
on the master branch, run the following command:
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<pre class="doc_code">
|
|
|
|
|
git config branch.master.rebase true
|
|
|
|
|
</pre>
|
|
|
|
|
|
2011-08-12 07:48:06 +00:00
|
|
|
<h4>Sending patches with Git</h4>
|
|
|
|
|
<div>
|
|
|
|
|
<p>
|
|
|
|
|
Please read <a href="DeveloperPolicy.html#patches">Developer Policy</a>, too.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
Assume <tt>master</tt> points the upstream and <tt>mybranch</tt> points your
|
|
|
|
|
working branch, and <tt>mybranch</tt> is rebased onto <tt>master</tt>.
|
|
|
|
|
At first you may check sanity of whitespaces:
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<pre class="doc_code">
|
|
|
|
|
git diff --check master..mybranch
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
The easiest way to generate a patch is as below:
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<pre class="doc_code">
|
|
|
|
|
git diff master..mybranch > /path/to/mybranch.diff
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
It is a little different from svn-generated diff. git-diff-generated diff has
|
|
|
|
|
prefixes like <tt>a/</tt> and <tt>b/</tt>. Don't worry, most developers might
|
|
|
|
|
know it could be accepted with <tt>patch -p1 -N</tt>.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
But you may generate patchset with git-format-patch. It generates
|
|
|
|
|
by-each-commit patchset. To generate patch files to attach to your article:
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<pre class="doc_code">
|
|
|
|
|
git format-patch --no-attach master..mybranch -o /path/to/your/patchset
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
If you would like to send patches directly, you may use git-send-email or
|
|
|
|
|
git-imap-send. Here is an example to generate the patchset in Gmail's [Drafts].
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<pre class="doc_code">
|
|
|
|
|
git format-patch --attach master..mybranch --stdout | git imap-send
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
Then, your .git/config should have [imap] sections.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<pre class="doc_code">
|
|
|
|
|
[imap]
|
|
|
|
|
host = imaps://imap.gmail.com
|
|
|
|
|
user = <em>your.gmail.account</em>@gmail.com
|
|
|
|
|
pass = <em>himitsu!</em>
|
|
|
|
|
port = 993
|
|
|
|
|
sslverify = false
|
|
|
|
|
; in English
|
|
|
|
|
folder = "[Gmail]/Drafts"
|
|
|
|
|
; example for Japanese, "Modified UTF-7" encoded.
|
|
|
|
|
folder = "[Gmail]/&Tgtm+DBN-"
|
2011-11-06 06:51:58 +00:00
|
|
|
; example for Traditional Chinese
|
|
|
|
|
folder = "[Gmail]/&g0l6Pw-"
|
2011-08-12 07:48:06 +00:00
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2011-08-12 07:47:55 +00:00
|
|
|
<h4>For developers to work with git-svn</h4>
|
|
|
|
|
<div>
|
|
|
|
|
|
2011-07-19 00:20:54 +00:00
|
|
|
<p>To set up clone from which you can submit code using
|
|
|
|
|
<tt>git-svn</tt>, run:</p>
|
|
|
|
|
|
2011-07-20 23:37:51 +00:00
|
|
|
<pre class="doc_code">
|
2011-07-20 22:58:28 +00:00
|
|
|
git clone http://llvm.org/git/llvm.git
|
2011-07-19 00:20:54 +00:00
|
|
|
cd llvm
|
|
|
|
|
git svn init https://llvm.org/svn/llvm-project/llvm/trunk --username=<username>
|
|
|
|
|
git config svn-remote.svn.fetch :refs/remotes/origin/master
|
|
|
|
|
git svn rebase -l # -l avoids fetching ahead of the git mirror.
|
|
|
|
|
|
|
|
|
|
# If you have clang too:
|
|
|
|
|
cd tools
|
2011-07-20 22:58:28 +00:00
|
|
|
git clone http://llvm.org/git/clang.git
|
2011-07-19 00:20:54 +00:00
|
|
|
cd clang
|
|
|
|
|
git svn init https://llvm.org/svn/llvm-project/cfe/trunk --username=<username>
|
|
|
|
|
git config svn-remote.svn.fetch :refs/remotes/origin/master
|
|
|
|
|
git svn rebase -l
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<p>To update this clone without generating git-svn tags that conflict
|
|
|
|
|
with the upstream git repo, run:</p>
|
|
|
|
|
|
2011-07-20 23:37:51 +00:00
|
|
|
<pre class="doc_code">
|
2011-07-19 00:20:54 +00:00
|
|
|
git fetch && (cd tools/clang && git fetch) # Get matching revisions of both trees.
|
|
|
|
|
git checkout master
|
|
|
|
|
git svn rebase -l
|
|
|
|
|
(cd tools/clang &&
|
|
|
|
|
git checkout master &&
|
|
|
|
|
git svn rebase -l)
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<p>This leaves your working directories on their master branches, so
|
|
|
|
|
you'll need to <tt>checkout</tt> each working branch individually and
|
|
|
|
|
<tt>rebase</tt> it on top of its parent branch. (Note: This script is
|
|
|
|
|
intended for relative newbies to git. If you have more experience,
|
|
|
|
|
you can likely improve on it.)</p>
|
|
|
|
|
|
|
|
|
|
<p>The git-svn metadata can get out of sync after you mess around with
|
|
|
|
|
branches and <code>dcommit</code>. When that happens, <code>git svn
|
|
|
|
|
dcommit</code> stops working, complaining about files with uncommitted
|
|
|
|
|
changes. The fix is to rebuild the metadata:</p>
|
|
|
|
|
|
2011-07-20 23:37:51 +00:00
|
|
|
<pre class="doc_code">
|
2011-07-19 00:20:54 +00:00
|
|
|
rm -rf .git/svn
|
|
|
|
|
git svn rebase -l
|
2011-02-01 20:08:28 +00:00
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2011-08-12 07:47:55 +00:00
|
|
|
</div>
|
|
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
2003-11-07 19:43:14 +00:00
|
|
|
<a name="config">Local LLVM Configuration</a>
|
2011-04-18 23:59:50 +00:00
|
|
|
</h3>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2007-06-29 19:12:31 +00:00
|
|
|
<p>Once checked out from the Subversion repository, the LLVM suite source
|
|
|
|
|
code must be
|
2004-12-08 16:51:31 +00:00
|
|
|
configured via the <tt>configure</tt> script. This script sets variables in the
|
|
|
|
|
various <tt>*.in</tt> files, most notably <tt>llvm/Makefile.config</tt> and
|
|
|
|
|
<tt>llvm/include/Config/config.h</tt>. It also populates <i>OBJ_ROOT</i> with
|
|
|
|
|
the Makefiles needed to begin building LLVM.</p>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
|
|
|
|
<p>The following environment variables are used by the <tt>configure</tt>
|
|
|
|
|
script to configure the build system:</p>
|
|
|
|
|
|
2006-09-07 04:19:09 +00:00
|
|
|
<table summary="LLVM configure script environment variables">
|
2004-11-01 08:19:36 +00:00
|
|
|
<tr><th>Variable</th><th>Purpose</th></tr>
|
2003-11-07 19:43:14 +00:00
|
|
|
<tr>
|
|
|
|
|
<td>CC</td>
|
|
|
|
|
<td>Tells <tt>configure</tt> which C compiler to use. By default,
|
|
|
|
|
<tt>configure</tt> will look for the first GCC C compiler in
|
|
|
|
|
<tt>PATH</tt>. Use this variable to override
|
|
|
|
|
<tt>configure</tt>'s default behavior.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>CXX</td>
|
|
|
|
|
<td>Tells <tt>configure</tt> which C++ compiler to use. By default,
|
|
|
|
|
<tt>configure</tt> will look for the first GCC C++ compiler in
|
|
|
|
|
<tt>PATH</tt>. Use this variable to override
|
|
|
|
|
<tt>configure</tt>'s default behavior.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<p>The following options can be used to set or enable LLVM specific options:</p>
|
|
|
|
|
|
2004-01-20 00:20:17 +00:00
|
|
|
<dl>
|
2004-12-08 16:51:31 +00:00
|
|
|
<dt><i>--enable-optimized</i></dt>
|
2003-11-07 19:43:14 +00:00
|
|
|
<dd>
|
2009-04-25 22:24:49 +00:00
|
|
|
Enables optimized compilation (debugging symbols are removed
|
|
|
|
|
and GCC optimization flags are enabled). Note that this is the default
|
|
|
|
|
setting if you are using the LLVM distribution. The default behavior
|
|
|
|
|
of an Subversion checkout is to use an unoptimized build (also known as a
|
|
|
|
|
debug build).
|
2006-09-07 04:19:09 +00:00
|
|
|
<br><br>
|
2004-12-08 16:51:31 +00:00
|
|
|
</dd>
|
2005-12-21 03:46:45 +00:00
|
|
|
<dt><i>--enable-debug-runtime</i></dt>
|
|
|
|
|
<dd>
|
|
|
|
|
Enables debug symbols in the runtime libraries. The default is to strip
|
|
|
|
|
debug symbols from the runtime libraries.
|
|
|
|
|
</dd>
|
2004-12-08 16:51:31 +00:00
|
|
|
<dt><i>--enable-jit</i></dt>
|
2003-11-07 19:43:14 +00:00
|
|
|
<dd>
|
2003-12-18 16:43:17 +00:00
|
|
|
Compile the Just In Time (JIT) compiler functionality. This is not
|
|
|
|
|
available
|
2003-11-07 19:43:14 +00:00
|
|
|
on all platforms. The default is dependent on platform, so it is best
|
|
|
|
|
to explicitly enable it if you want it.
|
2006-09-07 04:19:09 +00:00
|
|
|
<br><br>
|
2004-12-08 16:51:31 +00:00
|
|
|
</dd>
|
2005-04-22 17:58:03 +00:00
|
|
|
<dt><i>--enable-targets=</i><tt>target-option</tt></dt>
|
|
|
|
|
<dd>Controls which targets will be built and linked into llc. The default
|
|
|
|
|
value for <tt>target_options</tt> is "all" which builds and links all
|
|
|
|
|
available targets. The value "host-only" can be specified to build only a
|
|
|
|
|
native compiler (no cross-compiler targets available). The "native" target is
|
|
|
|
|
selected as the target of the build host. You can also specify a comma
|
|
|
|
|
separated list of target names that you want available in llc. The target
|
2008-12-11 18:23:24 +00:00
|
|
|
names use all lower case. The current set of targets is: <br>
|
2012-04-27 16:29:22 +00:00
|
|
|
<tt>arm, cpp, hexagon, mblaze, mips, mipsel, msp430, powerpc, ptx, sparc, spu, x86, x86_64, xcore</tt>.
|
2006-09-07 04:19:09 +00:00
|
|
|
<br><br></dd>
|
2004-12-08 16:51:31 +00:00
|
|
|
<dt><i>--enable-doxygen</i></dt>
|
|
|
|
|
<dd>Look for the doxygen program and enable construction of doxygen based
|
|
|
|
|
documentation from the source code. This is disabled by default because
|
|
|
|
|
generating the documentation can take a long time and producess 100s of
|
|
|
|
|
megabytes of output.</dd>
|
2007-01-23 12:35:46 +00:00
|
|
|
<dt><i>--with-udis86</i></dt>
|
|
|
|
|
<dd>LLVM can use external disassembler library for various purposes (now it's
|
|
|
|
|
used only for examining code produced by JIT). This option will enable usage
|
|
|
|
|
of <a href="http://udis86.sourceforge.net/">udis86</a> x86 (both 32 and 64
|
|
|
|
|
bits) disassembler library.</dd>
|
2003-11-07 19:43:14 +00:00
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<p>To configure LLVM, follow these steps:</p>
|
|
|
|
|
|
|
|
|
|
<ol>
|
2007-07-16 08:44:39 +00:00
|
|
|
<li><p>Change directory into the object root directory:</p>
|
2003-06-12 19:34:44 +00:00
|
|
|
|
2007-07-16 08:44:39 +00:00
|
|
|
<div class="doc_code"><pre>% cd <i>OBJ_ROOT</i></pre></div></li>
|
|
|
|
|
|
|
|
|
|
<li><p>Run the <tt>configure</tt> script located in the LLVM source
|
|
|
|
|
tree:</p>
|
|
|
|
|
|
|
|
|
|
<div class="doc_code">
|
|
|
|
|
<pre>% <i>SRC_ROOT</i>/configure --prefix=/install/path [other options]</pre>
|
|
|
|
|
</div></li>
|
2003-11-07 19:43:14 +00:00
|
|
|
</ol>
|
2003-06-12 19:34:44 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
</div>
|
2003-06-12 19:34:44 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
2003-11-07 19:43:14 +00:00
|
|
|
<a name="compile">Compiling the LLVM Suite Source Code</a>
|
2011-04-18 23:59:50 +00:00
|
|
|
</h3>
|
2003-06-12 19:34:44 +00:00
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2003-06-12 19:34:44 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<p>Once you have configured LLVM, you can build it. There are three types of
|
|
|
|
|
builds:</p>
|
2003-10-10 14:26:14 +00:00
|
|
|
|
2004-01-20 00:20:17 +00:00
|
|
|
<dl>
|
2003-11-07 19:43:14 +00:00
|
|
|
<dt>Debug Builds
|
|
|
|
|
<dd>
|
2009-04-25 22:24:49 +00:00
|
|
|
These builds are the default when one is using an Subversion checkout and
|
|
|
|
|
types <tt>gmake</tt> (unless the <tt>--enable-optimized</tt> option was
|
|
|
|
|
used during configuration). The build system will compile the tools and
|
|
|
|
|
libraries with debugging information. To get a Debug Build using the
|
|
|
|
|
LLVM distribution the <tt>--disable-optimized</tt> option must be passed
|
|
|
|
|
to <tt>configure</tt>.
|
2006-09-07 04:19:09 +00:00
|
|
|
<br><br>
|
2003-10-10 14:26:14 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<dt>Release (Optimized) Builds
|
|
|
|
|
<dd>
|
|
|
|
|
These builds are enabled with the <tt>--enable-optimized</tt> option to
|
|
|
|
|
<tt>configure</tt> or by specifying <tt>ENABLE_OPTIMIZED=1</tt> on the
|
|
|
|
|
<tt>gmake</tt> command line. For these builds, the build system will
|
|
|
|
|
compile the tools and libraries with GCC optimizations enabled and strip
|
|
|
|
|
debugging information from the libraries and executables it generates.
|
2009-04-25 22:24:49 +00:00
|
|
|
Note that Release Builds are default when using an LLVM distribution.
|
2006-09-07 04:19:09 +00:00
|
|
|
<br><br>
|
2003-06-12 19:34:44 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<dt>Profile Builds
|
|
|
|
|
<dd>
|
|
|
|
|
These builds are for use with profiling. They compile profiling
|
|
|
|
|
information into the code for use with programs like <tt>gprof</tt>.
|
|
|
|
|
Profile builds must be started by specifying <tt>ENABLE_PROFILING=1</tt>
|
|
|
|
|
on the <tt>gmake</tt> command line.
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<p>Once you have LLVM configured, you can build it by entering the
|
|
|
|
|
<i>OBJ_ROOT</i> directory and issuing the following command:</p>
|
|
|
|
|
|
2007-07-16 08:44:39 +00:00
|
|
|
<div class="doc_code"><pre>% gmake</pre></div>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2004-07-18 22:32:22 +00:00
|
|
|
<p>If the build fails, please <a href="#brokengcc">check here</a> to see if you
|
2004-12-08 17:53:54 +00:00
|
|
|
are using a version of GCC that is known not to compile LLVM.</p>
|
2004-07-18 22:32:22 +00:00
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
If you have multiple processors in your machine, you may wish to use some of
|
2003-11-07 19:43:14 +00:00
|
|
|
the parallel build options provided by GNU Make. For example, you could use the
|
|
|
|
|
command:</p>
|
|
|
|
|
|
2007-07-16 08:44:39 +00:00
|
|
|
<div class="doc_code"><pre>% gmake -j2</pre></div>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
|
|
|
|
<p>There are several special targets which are useful when working with the LLVM
|
|
|
|
|
source code:</p>
|
|
|
|
|
|
2004-01-20 00:20:17 +00:00
|
|
|
<dl>
|
2003-11-07 19:43:14 +00:00
|
|
|
<dt><tt>gmake clean</tt>
|
|
|
|
|
<dd>
|
|
|
|
|
Removes all files generated by the build. This includes object files,
|
|
|
|
|
generated C/C++ files, libraries, and executables.
|
2006-09-07 04:19:09 +00:00
|
|
|
<br><br>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2004-12-08 16:51:31 +00:00
|
|
|
<dt><tt>gmake dist-clean</tt>
|
2003-11-07 19:43:14 +00:00
|
|
|
<dd>
|
2004-08-21 23:40:49 +00:00
|
|
|
Removes everything that <tt>gmake clean</tt> does, but also removes files
|
|
|
|
|
generated by <tt>configure</tt>. It attempts to return the source tree to the
|
|
|
|
|
original state in which it was shipped.
|
2006-09-07 04:19:09 +00:00
|
|
|
<br><br>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2004-08-23 20:25:33 +00:00
|
|
|
<dt><tt>gmake install</tt>
|
|
|
|
|
<dd>
|
2004-12-08 17:53:54 +00:00
|
|
|
Installs LLVM header files, libraries, tools, and documentation in a
|
|
|
|
|
hierarchy
|
2004-12-08 16:51:31 +00:00
|
|
|
under $PREFIX, specified with <tt>./configure --prefix=[dir]</tt>, which
|
|
|
|
|
defaults to <tt>/usr/local</tt>.
|
2006-09-07 04:19:09 +00:00
|
|
|
<br><br>
|
|
|
|
|
|
2004-12-08 16:51:31 +00:00
|
|
|
<dt><tt>gmake -C runtime install-bytecode</tt>
|
2003-11-07 19:43:14 +00:00
|
|
|
<dd>
|
2004-11-11 07:30:27 +00:00
|
|
|
Assuming you built LLVM into $OBJDIR, when this command is run, it will
|
2007-07-06 22:07:22 +00:00
|
|
|
install bitcode libraries into the GCC front end's bitcode library
|
|
|
|
|
directory. If you need to update your bitcode libraries,
|
2004-08-21 23:40:49 +00:00
|
|
|
this is the target to use once you've built them.
|
2006-09-07 04:19:09 +00:00
|
|
|
<br><br>
|
2003-11-07 19:43:14 +00:00
|
|
|
</dl>
|
|
|
|
|
|
2004-12-08 16:51:31 +00:00
|
|
|
<p>Please see the <a href="MakefileGuide.html">Makefile Guide</a> for further
|
|
|
|
|
details on these <tt>make</tt> targets and descriptions of other targets
|
|
|
|
|
available.</p>
|
|
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<p>It is also possible to override default values from <tt>configure</tt> by
|
|
|
|
|
declaring variables on the command line. The following are some examples:</p>
|
|
|
|
|
|
2004-01-20 00:20:17 +00:00
|
|
|
<dl>
|
2003-11-07 19:43:14 +00:00
|
|
|
<dt><tt>gmake ENABLE_OPTIMIZED=1</tt>
|
|
|
|
|
<dd>
|
|
|
|
|
Perform a Release (Optimized) build.
|
2006-09-07 04:19:09 +00:00
|
|
|
<br><br>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2006-04-09 23:45:38 +00:00
|
|
|
<dt><tt>gmake ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1</tt>
|
2006-03-21 01:10:57 +00:00
|
|
|
<dd>
|
2006-04-09 23:45:38 +00:00
|
|
|
Perform a Release (Optimized) build without assertions enabled.
|
2006-09-07 04:19:09 +00:00
|
|
|
<br><br>
|
2009-04-25 22:24:49 +00:00
|
|
|
|
|
|
|
|
<dt><tt>gmake ENABLE_OPTIMIZED=0</tt>
|
|
|
|
|
<dd>
|
|
|
|
|
Perform a Debug build.
|
|
|
|
|
<br><br>
|
2006-03-21 01:10:57 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<dt><tt>gmake ENABLE_PROFILING=1</tt>
|
|
|
|
|
<dd>
|
|
|
|
|
Perform a Profiling build.
|
2006-09-07 04:19:09 +00:00
|
|
|
<br><br>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
|
|
|
|
<dt><tt>gmake VERBOSE=1</tt>
|
|
|
|
|
<dd>
|
|
|
|
|
Print what <tt>gmake</tt> is doing on standard output.
|
2006-09-07 04:19:09 +00:00
|
|
|
<br><br>
|
2004-12-08 16:51:31 +00:00
|
|
|
|
|
|
|
|
<dt><tt>gmake TOOL_VERBOSE=1</tt></dt>
|
|
|
|
|
<dd>Ask each tool invoked by the makefiles to print out what it is doing on
|
2004-12-08 17:53:54 +00:00
|
|
|
the standard output. This also implies <tt>VERBOSE=1</tt>.
|
2006-09-07 04:19:09 +00:00
|
|
|
<br><br></dd>
|
2003-11-07 19:43:14 +00:00
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<p>Every directory in the LLVM object tree includes a <tt>Makefile</tt> to build
|
|
|
|
|
it and any subdirectories that it contains. Entering any directory inside the
|
|
|
|
|
LLVM object tree and typing <tt>gmake</tt> should rebuild anything in or below
|
|
|
|
|
that directory that is out of date.</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2006-07-27 05:43:30 +00:00
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
2006-07-27 06:41:31 +00:00
|
|
|
<a name="cross-compile">Cross-Compiling LLVM</a>
|
2011-04-18 23:59:50 +00:00
|
|
|
</h3>
|
2006-07-27 05:43:30 +00:00
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2009-04-17 17:25:16 +00:00
|
|
|
<p>It is possible to cross-compile LLVM itself. That is, you can create LLVM
|
|
|
|
|
executables and libraries to be hosted on a platform different from the
|
|
|
|
|
platform where they are build (a Canadian Cross build). To configure a
|
|
|
|
|
cross-compile, supply the configure script with <tt>--build</tt> and
|
|
|
|
|
<tt>--host</tt> options that are different. The values of these options must
|
|
|
|
|
be legal target triples that your GCC compiler supports.</p>
|
|
|
|
|
|
|
|
|
|
<p>The result of such a build is executables that are not runnable on
|
|
|
|
|
on the build host (--build option) but can be executed on the compile host
|
2006-07-27 06:41:31 +00:00
|
|
|
(--host option).</p>
|
2006-07-27 05:43:30 +00:00
|
|
|
</div>
|
|
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
2003-11-07 19:43:14 +00:00
|
|
|
<a name="objfiles">The Location of LLVM Object Files</a>
|
2011-04-18 23:59:50 +00:00
|
|
|
</h3>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
|
|
|
|
<p>The LLVM build system is capable of sharing a single LLVM source tree among
|
|
|
|
|
several LLVM builds. Hence, it is possible to build LLVM for several different
|
|
|
|
|
platforms or configurations using the same source tree.</p>
|
|
|
|
|
|
|
|
|
|
<p>This is accomplished in the typical autoconf manner:</p>
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
<li><p>Change directory to where the LLVM object files should live:</p>
|
|
|
|
|
|
2007-07-16 08:44:39 +00:00
|
|
|
<div class="doc_code"><pre>% cd <i>OBJ_ROOT</i></pre></div></li>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
|
|
|
|
<li><p>Run the <tt>configure</tt> script found in the LLVM source
|
|
|
|
|
directory:</p>
|
|
|
|
|
|
2007-07-16 08:44:39 +00:00
|
|
|
<div class="doc_code"><pre>% <i>SRC_ROOT</i>/configure</pre></div></li>
|
2003-11-07 19:43:14 +00:00
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<p>The LLVM build will place files underneath <i>OBJ_ROOT</i> in directories
|
|
|
|
|
named after the build type:</p>
|
|
|
|
|
|
2004-01-20 00:20:17 +00:00
|
|
|
<dl>
|
2010-07-08 08:27:18 +00:00
|
|
|
<dt>Debug Builds with assertions enabled (the default)
|
2003-11-07 19:43:14 +00:00
|
|
|
<dd>
|
2004-01-20 00:20:17 +00:00
|
|
|
<dl>
|
2003-11-07 19:43:14 +00:00
|
|
|
<dt>Tools
|
2010-07-08 08:27:18 +00:00
|
|
|
<dd><tt><i>OBJ_ROOT</i>/Debug+Asserts/bin</tt>
|
2003-11-07 19:43:14 +00:00
|
|
|
<dt>Libraries
|
2010-07-08 08:27:18 +00:00
|
|
|
<dd><tt><i>OBJ_ROOT</i>/Debug+Asserts/lib</tt>
|
2003-11-07 19:43:14 +00:00
|
|
|
</dl>
|
2006-09-07 04:19:09 +00:00
|
|
|
<br><br>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
|
|
|
|
<dt>Release Builds
|
|
|
|
|
<dd>
|
2004-01-20 00:20:17 +00:00
|
|
|
<dl>
|
2003-11-07 19:43:14 +00:00
|
|
|
<dt>Tools
|
2004-12-08 16:51:31 +00:00
|
|
|
<dd><tt><i>OBJ_ROOT</i>/Release/bin</tt>
|
2003-11-07 19:43:14 +00:00
|
|
|
<dt>Libraries
|
2004-12-08 16:51:31 +00:00
|
|
|
<dd><tt><i>OBJ_ROOT</i>/Release/lib</tt>
|
2003-11-07 19:43:14 +00:00
|
|
|
</dl>
|
2006-09-07 04:19:09 +00:00
|
|
|
<br><br>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
|
|
|
|
<dt>Profile Builds
|
|
|
|
|
<dd>
|
2004-01-20 00:20:17 +00:00
|
|
|
<dl>
|
2003-11-07 19:43:14 +00:00
|
|
|
<dt>Tools
|
2004-12-08 16:51:31 +00:00
|
|
|
<dd><tt><i>OBJ_ROOT</i>/Profile/bin</tt>
|
2003-11-07 19:43:14 +00:00
|
|
|
<dt>Libraries
|
2004-12-08 16:51:31 +00:00
|
|
|
<dd><tt><i>OBJ_ROOT</i>/Profile/lib</tt>
|
2003-11-07 19:43:14 +00:00
|
|
|
</dl>
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2004-03-25 20:38:40 +00:00
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
2004-03-25 20:38:40 +00:00
|
|
|
<a name="optionalconfig">Optional Configuration Items</a>
|
2011-04-18 23:59:50 +00:00
|
|
|
</h3>
|
2004-03-25 20:38:40 +00:00
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2004-03-25 20:38:40 +00:00
|
|
|
|
|
|
|
|
<p>
|
2005-02-03 22:25:23 +00:00
|
|
|
If you're running on a Linux system that supports the "<a
|
2007-07-16 08:46:40 +00:00
|
|
|
href="http://www.tat.physik.uni-tuebingen.de/~rguenth/linux/binfmt_misc.html">binfmt_misc</a>"
|
2004-03-25 20:38:40 +00:00
|
|
|
module, and you have root access on the system, you can set your system up to
|
2007-07-16 08:46:40 +00:00
|
|
|
execute LLVM bitcode files directly. To do this, use commands like this (the
|
2004-03-25 20:38:40 +00:00
|
|
|
first command may not be required if you are already using the module):</p>
|
|
|
|
|
|
2005-02-03 22:25:23 +00:00
|
|
|
<div class="doc_code">
|
2004-03-25 20:38:40 +00:00
|
|
|
<pre>
|
2007-07-16 08:44:39 +00:00
|
|
|
$ mount -t binfmt_misc none /proc/sys/fs/binfmt_misc
|
2009-11-04 06:15:28 +00:00
|
|
|
$ echo ':llvm:M::BC::/path/to/lli:' > /proc/sys/fs/binfmt_misc/register
|
2007-07-16 08:44:39 +00:00
|
|
|
$ chmod u+x hello.bc (if needed)
|
|
|
|
|
$ ./hello.bc
|
2004-03-25 20:38:40 +00:00
|
|
|
</pre>
|
2005-02-03 22:25:23 +00:00
|
|
|
</div>
|
2004-03-25 20:38:40 +00:00
|
|
|
|
|
|
|
|
<p>
|
2010-02-17 18:33:13 +00:00
|
|
|
This allows you to execute LLVM bitcode files directly. On Debian, you
|
2011-04-09 09:51:57 +00:00
|
|
|
can also use this command instead of the 'echo' command above:
|
2004-03-25 20:38:40 +00:00
|
|
|
</p>
|
|
|
|
|
|
2010-02-17 18:33:13 +00:00
|
|
|
<div class="doc_code">
|
|
|
|
|
<pre>
|
|
|
|
|
$ sudo update-binfmts --install llvm /path/to/lli --magic 'BC'
|
|
|
|
|
</pre>
|
|
|
|
|
</div>
|
|
|
|
|
|
2004-03-25 20:38:40 +00:00
|
|
|
</div>
|
|
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
</div>
|
|
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<!-- *********************************************************************** -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h2>
|
|
|
|
|
<a name="layout">Program Layout</a>
|
|
|
|
|
</h2>
|
2003-11-07 19:43:14 +00:00
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
|
|
|
|
<p>One useful source of information about the LLVM source base is the LLVM <a
|
2011-04-09 02:13:37 +00:00
|
|
|
href="http://www.doxygen.org/">doxygen</a> documentation available at <tt><a
|
2006-03-14 05:39:39 +00:00
|
|
|
href="http://llvm.org/doxygen/">http://llvm.org/doxygen/</a></tt>.
|
2003-11-07 19:43:14 +00:00
|
|
|
The following is a brief introduction to code layout:</p>
|
|
|
|
|
|
2004-12-08 16:18:26 +00:00
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
|
|
|
|
<a name="examples"><tt>llvm/examples</tt></a>
|
|
|
|
|
</h3>
|
|
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2004-12-08 16:18:26 +00:00
|
|
|
<p>This directory contains some simple examples of how to use the LLVM IR and
|
|
|
|
|
JIT.</p>
|
2003-11-07 19:43:14 +00:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
|
|
|
|
<a name="include"><tt>llvm/include</tt></a>
|
|
|
|
|
</h3>
|
|
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2003-08-11 18:45:46 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<p>This directory contains public header files exported from the LLVM
|
|
|
|
|
library. The three main subdirectories of this directory are:</p>
|
2003-06-12 19:34:44 +00:00
|
|
|
|
2004-09-05 20:50:22 +00:00
|
|
|
<dl>
|
|
|
|
|
<dt><tt><b>llvm/include/llvm</b></tt></dt>
|
|
|
|
|
<dd>This directory contains all of the LLVM specific header files. This
|
|
|
|
|
directory also has subdirectories for different portions of LLVM:
|
|
|
|
|
<tt>Analysis</tt>, <tt>CodeGen</tt>, <tt>Target</tt>, <tt>Transforms</tt>,
|
|
|
|
|
etc...</dd>
|
|
|
|
|
|
|
|
|
|
<dt><tt><b>llvm/include/llvm/Support</b></tt></dt>
|
|
|
|
|
<dd>This directory contains generic support libraries that are provided with
|
|
|
|
|
LLVM but not necessarily specific to LLVM. For example, some C++ STL utilities
|
|
|
|
|
and a Command Line option processing library store their header files here.
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt><tt><b>llvm/include/llvm/Config</b></tt></dt>
|
|
|
|
|
<dd>This directory contains header files configured by the <tt>configure</tt>
|
|
|
|
|
script. They wrap "standard" UNIX and C header files. Source code can
|
|
|
|
|
include these header files which automatically take care of the conditional
|
|
|
|
|
#includes that the <tt>configure</tt> script generates.</dd>
|
|
|
|
|
</dl>
|
2003-11-07 19:43:14 +00:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
|
|
|
|
<a name="lib"><tt>llvm/lib</tt></a>
|
|
|
|
|
</h3>
|
|
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
|
|
|
|
<p>This directory contains most of the source files of the LLVM system. In LLVM,
|
|
|
|
|
almost all code exists in libraries, making it very easy to share code among the
|
|
|
|
|
different <a href="#tools">tools</a>.</p>
|
|
|
|
|
|
2004-01-20 00:20:17 +00:00
|
|
|
<dl>
|
2004-09-05 20:50:22 +00:00
|
|
|
<dt><tt><b>llvm/lib/VMCore/</b></tt></dt>
|
|
|
|
|
<dd> This directory holds the core LLVM source files that implement core
|
|
|
|
|
classes like Instruction and BasicBlock.</dd>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2004-09-05 20:50:22 +00:00
|
|
|
<dt><tt><b>llvm/lib/AsmParser/</b></tt></dt>
|
|
|
|
|
<dd>This directory holds the source code for the LLVM assembly language parser
|
|
|
|
|
library.</dd>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2007-07-06 22:07:22 +00:00
|
|
|
<dt><tt><b>llvm/lib/BitCode/</b></tt></dt>
|
|
|
|
|
<dd>This directory holds code for reading and write LLVM bitcode.</dd>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2004-09-05 20:50:22 +00:00
|
|
|
<dt><tt><b>llvm/lib/Analysis/</b></tt><dd>This directory contains a variety of
|
2003-11-07 19:43:14 +00:00
|
|
|
different program analyses, such as Dominator Information, Call Graphs,
|
|
|
|
|
Induction Variables, Interval Identification, Natural Loop Identification,
|
2004-09-05 20:50:22 +00:00
|
|
|
etc.</dd>
|
|
|
|
|
|
|
|
|
|
<dt><tt><b>llvm/lib/Transforms/</b></tt></dt>
|
|
|
|
|
<dd> This directory contains the source code for the LLVM to LLVM program
|
|
|
|
|
transformations, such as Aggressive Dead Code Elimination, Sparse Conditional
|
|
|
|
|
Constant Propagation, Inlining, Loop Invariant Code Motion, Dead Global
|
|
|
|
|
Elimination, and many others.</dd>
|
|
|
|
|
|
|
|
|
|
<dt><tt><b>llvm/lib/Target/</b></tt></dt>
|
|
|
|
|
<dd> This directory contains files that describe various target architectures
|
2006-04-20 17:42:23 +00:00
|
|
|
for code generation. For example, the <tt>llvm/lib/Target/X86</tt>
|
|
|
|
|
directory holds the X86 machine description while
|
2012-03-23 05:50:46 +00:00
|
|
|
<tt>llvm/lib/Target/ARM</tt> implements the ARM backend.</dd>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2004-09-05 20:50:22 +00:00
|
|
|
<dt><tt><b>llvm/lib/CodeGen/</b></tt></dt>
|
|
|
|
|
<dd> This directory contains the major parts of the code generator: Instruction
|
|
|
|
|
Selector, Instruction Scheduling, and Register Allocation.</dd>
|
|
|
|
|
|
2011-04-05 08:24:15 +00:00
|
|
|
<dt><tt><b>llvm/lib/MC/</b></tt></dt>
|
|
|
|
|
<dd>(FIXME: T.B.D.)</dd>
|
|
|
|
|
|
|
|
|
|
<!--FIXME: obsoleted -->
|
2004-09-05 20:50:22 +00:00
|
|
|
<dt><tt><b>llvm/lib/Debugger/</b></tt></dt>
|
|
|
|
|
<dd> This directory contains the source level debugger library that makes
|
|
|
|
|
it possible to instrument LLVM programs so that a debugger could identify
|
|
|
|
|
source code locations at which the program is executing.</dd>
|
|
|
|
|
|
|
|
|
|
<dt><tt><b>llvm/lib/ExecutionEngine/</b></tt></dt>
|
2007-07-06 22:07:22 +00:00
|
|
|
<dd> This directory contains libraries for executing LLVM bitcode directly
|
2004-09-05 20:50:22 +00:00
|
|
|
at runtime in both interpreted and JIT compiled fashions.</dd>
|
|
|
|
|
|
|
|
|
|
<dt><tt><b>llvm/lib/Support/</b></tt></dt>
|
2011-10-11 20:02:52 +00:00
|
|
|
<dd> This directory contains the source code that corresponds to the header
|
|
|
|
|
files located in <tt>llvm/include/ADT/</tt>
|
|
|
|
|
and <tt>llvm/include/Support/</tt>.</dd>
|
2003-11-07 19:43:14 +00:00
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2004-12-08 16:18:26 +00:00
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
|
|
|
|
<a name="projects"><tt>llvm/projects</tt></a>
|
|
|
|
|
</h3>
|
|
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2004-12-08 16:18:26 +00:00
|
|
|
<p>This directory contains projects that are not strictly part of LLVM but are
|
|
|
|
|
shipped with LLVM. This is also the directory where you should create your own
|
|
|
|
|
LLVM-based projects. See <tt>llvm/projects/sample</tt> for an example of how
|
2008-08-11 06:13:31 +00:00
|
|
|
to set up your own project.</p>
|
2004-12-08 16:18:26 +00:00
|
|
|
</div>
|
|
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
|
|
|
|
<a name="runtime"><tt>llvm/runtime</tt></a>
|
|
|
|
|
</h3>
|
|
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2007-07-06 22:07:22 +00:00
|
|
|
<p>This directory contains libraries which are compiled into LLVM bitcode and
|
2012-02-26 22:26:37 +00:00
|
|
|
used when linking programs with the Clang front end. Most of these libraries are
|
2003-11-07 19:43:14 +00:00
|
|
|
skeleton versions of real libraries; for example, libc is a stripped down
|
|
|
|
|
version of glibc.</p>
|
|
|
|
|
|
|
|
|
|
<p>Unlike the rest of the LLVM suite, this directory needs the LLVM GCC front
|
|
|
|
|
end to compile.</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
|
|
|
|
<a name="test"><tt>llvm/test</tt></a>
|
|
|
|
|
</h3>
|
|
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2004-09-05 20:50:22 +00:00
|
|
|
<p>This directory contains feature and regression tests and other basic sanity
|
|
|
|
|
checks on the LLVM infrastructure. These are intended to run quickly and cover
|
|
|
|
|
a lot of territory without being exhaustive.</p>
|
2003-11-07 19:43:14 +00:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
|
|
|
|
<a name="test-suite"><tt>test-suite</tt></a>
|
|
|
|
|
</h3>
|
|
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2007-06-29 19:12:31 +00:00
|
|
|
<p>This is not a directory in the normal llvm module; it is a separate
|
|
|
|
|
Subversion
|
|
|
|
|
module that must be checked out (usually to <tt>projects/test-suite</tt>).
|
|
|
|
|
This
|
2004-12-08 17:53:54 +00:00
|
|
|
module contains a comprehensive correctness, performance, and benchmarking
|
|
|
|
|
test
|
2007-06-29 19:12:31 +00:00
|
|
|
suite for LLVM. It is a separate Subversion module because not every LLVM
|
|
|
|
|
user is
|
2005-05-09 16:39:27 +00:00
|
|
|
interested in downloading or building such a comprehensive test suite. For
|
|
|
|
|
further details on this test suite, please see the
|
2004-09-05 20:50:22 +00:00
|
|
|
<a href="TestingGuide.html">Testing Guide</a> document.</p>
|
2003-11-07 19:43:14 +00:00
|
|
|
</div>
|
|
|
|
|
|
2004-09-05 20:50:22 +00:00
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
|
|
|
|
<a name="tools"><tt>llvm/tools</tt></a>
|
|
|
|
|
</h3>
|
|
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
|
|
|
|
<p>The <b>tools</b> directory contains the executables built out of the
|
|
|
|
|
libraries above, which form the main part of the user interface. You can
|
2010-02-18 14:08:13 +00:00
|
|
|
always get help for a tool by typing <tt>tool_name -help</tt>. The
|
2004-11-15 23:20:51 +00:00
|
|
|
following is a brief introduction to the most important tools. More detailed
|
|
|
|
|
information is in the <a href="CommandGuide/index.html">Command Guide</a>.</p>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2004-01-20 00:20:17 +00:00
|
|
|
<dl>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2004-09-05 20:50:22 +00:00
|
|
|
<dt><tt><b>bugpoint</b></tt></dt>
|
|
|
|
|
<dd><tt>bugpoint</tt> is used to debug
|
2003-11-07 19:43:14 +00:00
|
|
|
optimization passes or code generation backends by narrowing down the
|
|
|
|
|
given test case to the minimum number of passes and/or instructions that
|
|
|
|
|
still cause a problem, whether it is a crash or miscompilation. See <a
|
|
|
|
|
href="HowToSubmitABug.html">HowToSubmitABug.html</a> for more information
|
2004-09-05 20:50:22 +00:00
|
|
|
on using <tt>bugpoint</tt>.</dd>
|
|
|
|
|
|
|
|
|
|
<dt><tt><b>llvm-ar</b></tt></dt>
|
|
|
|
|
<dd>The archiver produces an archive containing
|
2007-07-06 22:07:22 +00:00
|
|
|
the given LLVM bitcode files, optionally with an index for faster
|
2004-09-05 20:50:22 +00:00
|
|
|
lookup.</dd>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2004-09-05 20:50:22 +00:00
|
|
|
<dt><tt><b>llvm-as</b></tt></dt>
|
|
|
|
|
<dd>The assembler transforms the human readable LLVM assembly to LLVM
|
2007-07-06 22:07:22 +00:00
|
|
|
bitcode.</dd>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2004-09-05 20:50:22 +00:00
|
|
|
<dt><tt><b>llvm-dis</b></tt></dt>
|
2007-07-06 22:07:22 +00:00
|
|
|
<dd>The disassembler transforms the LLVM bitcode to human readable
|
2004-09-05 20:50:22 +00:00
|
|
|
LLVM assembly.</dd>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2004-09-05 20:50:22 +00:00
|
|
|
<dt><tt><b>llvm-link</b></tt></dt>
|
|
|
|
|
<dd><tt>llvm-link</tt>, not surprisingly, links multiple LLVM modules into
|
|
|
|
|
a single program.</dd>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2004-09-05 20:50:22 +00:00
|
|
|
<dt><tt><b>lli</b></tt></dt>
|
|
|
|
|
<dd><tt>lli</tt> is the LLVM interpreter, which
|
2007-12-03 01:58:01 +00:00
|
|
|
can directly execute LLVM bitcode (although very slowly...). For architectures
|
|
|
|
|
that support it (currently x86, Sparc, and PowerPC), by default, <tt>lli</tt>
|
|
|
|
|
will function as a Just-In-Time compiler (if the functionality was compiled
|
|
|
|
|
in), and will execute the code <i>much</i> faster than the interpreter.</dd>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2004-09-05 20:50:22 +00:00
|
|
|
<dt><tt><b>llc</b></tt></dt>
|
|
|
|
|
<dd> <tt>llc</tt> is the LLVM backend compiler, which
|
2007-07-06 22:07:22 +00:00
|
|
|
translates LLVM bitcode to a native code assembly file or to C code (with
|
2004-09-05 20:50:22 +00:00
|
|
|
the -march=c option).</dd>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2004-12-22 06:29:07 +00:00
|
|
|
<dt><tt><b>llvm-gcc</b></tt></dt>
|
2007-02-09 15:59:08 +00:00
|
|
|
<dd><tt>llvm-gcc</tt> is a GCC-based C frontend that has been retargeted to
|
|
|
|
|
use LLVM as its backend instead of GCC's RTL backend. It can also emit LLVM
|
2007-07-06 22:07:22 +00:00
|
|
|
bitcode or assembly (with the <tt>-emit-llvm</tt> option) instead of the
|
2007-02-09 15:59:08 +00:00
|
|
|
usual machine code output. It works just like any other GCC compiler,
|
|
|
|
|
taking the typical <tt>-c, -S, -E, -o</tt> options that are typically used.
|
|
|
|
|
Additionally, the the source code for <tt>llvm-gcc</tt> is available as a
|
2007-06-29 19:12:31 +00:00
|
|
|
separate Subversion module.</dd>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2004-09-05 20:50:22 +00:00
|
|
|
<dt><tt><b>opt</b></tt></dt>
|
2007-07-06 22:07:22 +00:00
|
|
|
<dd><tt>opt</tt> reads LLVM bitcode, applies a series of LLVM to LLVM
|
2006-08-28 00:34:19 +00:00
|
|
|
transformations (which are specified on the command line), and then outputs
|
2010-02-18 14:08:13 +00:00
|
|
|
the resultant bitcode. The '<tt>opt -help</tt>' command is a good way to
|
2008-12-11 18:23:24 +00:00
|
|
|
get a list of the program transformations available in LLVM.<br>
|
2006-08-28 00:34:19 +00:00
|
|
|
<dd><tt>opt</tt> can also be used to run a specific analysis on an input
|
2007-07-06 22:07:22 +00:00
|
|
|
LLVM bitcode file and print out the results. It is primarily useful for
|
2006-08-28 00:34:19 +00:00
|
|
|
debugging analyses, or familiarizing yourself with what an analysis does.</dd>
|
2003-11-07 19:43:14 +00:00
|
|
|
</dl>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
|
|
|
|
<a name="utils"><tt>llvm/utils</tt></a>
|
|
|
|
|
</h3>
|
|
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
|
|
|
|
<p>This directory contains utilities for working with LLVM source code, and some
|
|
|
|
|
of the utilities are actually required as part of the build process because they
|
|
|
|
|
are code generators for parts of LLVM infrastructure.</p>
|
|
|
|
|
|
2004-01-20 00:20:17 +00:00
|
|
|
<dl>
|
|
|
|
|
<dt><tt><b>codegen-diff</b></tt> <dd><tt>codegen-diff</tt> is a script
|
2003-11-07 19:43:14 +00:00
|
|
|
that finds differences between code that LLC generates and code that LLI
|
|
|
|
|
generates. This is a useful tool if you are debugging one of them,
|
|
|
|
|
assuming that the other generates correct output. For the full user
|
2006-09-07 04:19:09 +00:00
|
|
|
manual, run <tt>`perldoc codegen-diff'</tt>.<br><br>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2004-01-20 00:20:17 +00:00
|
|
|
<dt><tt><b>emacs/</b></tt> <dd>The <tt>emacs</tt> directory contains
|
2003-11-07 19:43:14 +00:00
|
|
|
syntax-highlighting files which will work with Emacs and XEmacs editors,
|
|
|
|
|
providing syntax highlighting support for LLVM assembly files and TableGen
|
|
|
|
|
description files. For information on how to use the syntax files, consult
|
2006-09-07 04:19:09 +00:00
|
|
|
the <tt>README</tt> file in that directory.<br><br>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2004-01-20 00:20:17 +00:00
|
|
|
<dt><tt><b>getsrcs.sh</b></tt> <dd>The <tt>getsrcs.sh</tt> script finds
|
2003-11-07 19:43:14 +00:00
|
|
|
and outputs all non-generated source files, which is useful if one wishes
|
|
|
|
|
to do a lot of development across directories and does not want to
|
|
|
|
|
individually find each file. One way to use it is to run, for example:
|
|
|
|
|
<tt>xemacs `utils/getsources.sh`</tt> from the top of your LLVM source
|
2006-09-07 04:19:09 +00:00
|
|
|
tree.<br><br>
|
|
|
|
|
|
2004-09-05 20:50:22 +00:00
|
|
|
<dt><tt><b>llvmgrep</b></tt></dt>
|
|
|
|
|
<dd>This little tool performs an "egrep -H -n" on each source file in LLVM and
|
|
|
|
|
passes to it a regular expression provided on <tt>llvmgrep</tt>'s command
|
|
|
|
|
line. This is a very efficient way of searching the source base for a
|
|
|
|
|
particular regular expression.</dd>
|
|
|
|
|
|
2004-01-20 00:20:17 +00:00
|
|
|
<dt><tt><b>makellvm</b></tt> <dd>The <tt>makellvm</tt> script compiles all
|
2003-11-07 19:43:14 +00:00
|
|
|
files in the current directory and then compiles and links the tool that
|
|
|
|
|
is the first argument. For example, assuming you are in the directory
|
|
|
|
|
<tt>llvm/lib/Target/Sparc</tt>, if <tt>makellvm</tt> is in your path,
|
|
|
|
|
simply running <tt>makellvm llc</tt> will make a build of the current
|
|
|
|
|
directory, switch to directory <tt>llvm/tools/llc</tt> and build it,
|
2006-09-07 04:19:09 +00:00
|
|
|
causing a re-linking of LLC.<br><br>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2004-01-20 00:20:17 +00:00
|
|
|
<dt><tt><b>TableGen/</b></tt> <dd>The <tt>TableGen</tt> directory contains
|
2003-11-07 19:43:14 +00:00
|
|
|
the tool used to generate register descriptions, instruction set
|
|
|
|
|
descriptions, and even assemblers from common TableGen description
|
2006-09-07 04:19:09 +00:00
|
|
|
files.<br><br>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
2004-01-20 00:20:17 +00:00
|
|
|
<dt><tt><b>vim/</b></tt> <dd>The <tt>vim</tt> directory contains
|
2003-11-07 19:43:14 +00:00
|
|
|
syntax-highlighting files which will work with the VIM editor, providing
|
|
|
|
|
syntax highlighting support for LLVM assembly files and TableGen
|
|
|
|
|
description files. For information on how to use the syntax files, consult
|
2006-09-07 04:19:09 +00:00
|
|
|
the <tt>README</tt> file in that directory.<br><br>
|
2003-11-07 19:43:14 +00:00
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
</div>
|
|
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<!-- *********************************************************************** -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h2>
|
2003-11-07 19:43:14 +00:00
|
|
|
<a name="tutorial">An Example Using the LLVM Tool Chain</a>
|
2011-04-18 23:59:50 +00:00
|
|
|
</h2>
|
2003-11-07 19:43:14 +00:00
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2012-02-26 21:31:25 +00:00
|
|
|
<p>This section gives an example of using LLVM with the Clang front end.</p>
|
2006-08-14 20:45:25 +00:00
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h3>
|
2012-02-26 21:31:25 +00:00
|
|
|
<a name="tutorial4">Example with clang</a>
|
2011-04-18 23:59:50 +00:00
|
|
|
</h3>
|
2006-08-14 20:45:25 +00:00
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2006-08-14 20:45:25 +00:00
|
|
|
|
|
|
|
|
<ol>
|
2007-07-16 08:44:39 +00:00
|
|
|
<li><p>First, create a simple C file, name it 'hello.c':</p>
|
|
|
|
|
|
|
|
|
|
<div class="doc_code">
|
|
|
|
|
<pre>
|
|
|
|
|
#include <stdio.h>
|
|
|
|
|
|
|
|
|
|
int main() {
|
|
|
|
|
printf("hello world\n");
|
|
|
|
|
return 0;
|
|
|
|
|
}
|
|
|
|
|
</pre></div></li>
|
2006-08-14 20:45:25 +00:00
|
|
|
|
|
|
|
|
<li><p>Next, compile the C file into a native executable:</p>
|
|
|
|
|
|
2012-02-26 21:31:25 +00:00
|
|
|
<div class="doc_code"><pre>% clang hello.c -o hello</pre></div>
|
2006-08-14 20:45:25 +00:00
|
|
|
|
2012-02-26 21:31:25 +00:00
|
|
|
<p>Note that clang works just like GCC by default. The standard -S and
|
2006-08-14 20:45:25 +00:00
|
|
|
-c arguments work as usual (producing a native .s or .o file,
|
2007-07-16 08:44:39 +00:00
|
|
|
respectively).</p></li>
|
2006-08-14 20:45:25 +00:00
|
|
|
|
2007-07-06 22:07:22 +00:00
|
|
|
<li><p>Next, compile the C file into a LLVM bitcode file:</p>
|
2007-07-16 08:44:39 +00:00
|
|
|
|
|
|
|
|
<div class="doc_code">
|
2012-02-26 21:31:25 +00:00
|
|
|
<pre>% clang -O3 -emit-llvm hello.c -c -o hello.bc</pre></div>
|
2006-08-14 20:45:25 +00:00
|
|
|
|
|
|
|
|
<p>The -emit-llvm option can be used with the -S or -c options to emit an
|
|
|
|
|
LLVM ".ll" or ".bc" file (respectively) for the code. This allows you
|
|
|
|
|
to use the <a href="CommandGuide/index.html">standard LLVM tools</a> on
|
2012-02-26 21:31:25 +00:00
|
|
|
the bitcode file.</p></li>
|
2006-08-14 20:45:25 +00:00
|
|
|
|
|
|
|
|
<li><p>Run the program in both forms. To run the program, use:</p>
|
|
|
|
|
|
2007-07-16 08:44:39 +00:00
|
|
|
<div class="doc_code"><pre>% ./hello</pre></div>
|
2006-08-14 20:45:25 +00:00
|
|
|
|
|
|
|
|
<p>and</p>
|
|
|
|
|
|
2007-07-16 08:44:39 +00:00
|
|
|
<div class="doc_code"><pre>% lli hello.bc</pre></div>
|
2006-08-14 20:45:25 +00:00
|
|
|
|
|
|
|
|
<p>The second examples shows how to invoke the LLVM JIT, <a
|
2006-08-14 20:51:35 +00:00
|
|
|
href="CommandGuide/html/lli.html">lli</a>.</p></li>
|
2006-08-14 20:45:25 +00:00
|
|
|
|
|
|
|
|
<li><p>Use the <tt>llvm-dis</tt> utility to take a look at the LLVM assembly
|
|
|
|
|
code:</p>
|
|
|
|
|
|
2007-07-16 08:44:39 +00:00
|
|
|
<div class="doc_code">
|
|
|
|
|
<pre>llvm-dis < hello.bc | less</pre>
|
|
|
|
|
</div></li>
|
2006-08-14 20:45:25 +00:00
|
|
|
|
|
|
|
|
<li><p>Compile the program to native assembly using the LLC code
|
|
|
|
|
generator:</p>
|
|
|
|
|
|
2007-07-16 08:44:39 +00:00
|
|
|
<div class="doc_code"><pre>% llc hello.bc -o hello.s</pre></div></li>
|
2006-08-14 20:45:25 +00:00
|
|
|
|
|
|
|
|
<li><p>Assemble the native assembly language file into a program:</p>
|
|
|
|
|
|
2007-07-16 08:44:39 +00:00
|
|
|
<div class="doc_code">
|
|
|
|
|
<pre>
|
|
|
|
|
<b>Solaris:</b> % /opt/SUNWspro/bin/cc -xarch=v9 hello.s -o hello.native
|
|
|
|
|
|
|
|
|
|
<b>Others:</b> % gcc hello.s -o hello.native
|
|
|
|
|
</pre>
|
|
|
|
|
</div></li>
|
2006-08-14 20:45:25 +00:00
|
|
|
|
|
|
|
|
<li><p>Execute the native code program:</p>
|
|
|
|
|
|
2007-07-16 08:44:39 +00:00
|
|
|
<div class="doc_code"><pre>% ./hello.native</pre></div>
|
2006-08-14 20:45:25 +00:00
|
|
|
|
2012-02-26 21:31:25 +00:00
|
|
|
<p>Note that using clang to compile directly to native code (i.e. when
|
2006-08-14 20:45:25 +00:00
|
|
|
the -emit-llvm option is not present) does steps 6/7/8 for you.</p>
|
2006-08-14 20:51:35 +00:00
|
|
|
</li>
|
2006-08-14 20:45:25 +00:00
|
|
|
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
</div>
|
2003-06-12 19:34:44 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<!-- *********************************************************************** -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h2>
|
2003-11-07 19:43:14 +00:00
|
|
|
<a name="problems">Common Problems</a>
|
2011-04-18 23:59:50 +00:00
|
|
|
</h2>
|
2003-11-07 19:43:14 +00:00
|
|
|
<!-- *********************************************************************** -->
|
2003-07-03 16:01:38 +00:00
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2003-07-03 16:01:38 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<p>If you are having problems building or using LLVM, or if you have any other
|
|
|
|
|
general questions about LLVM, please consult the <a href="FAQ.html">Frequently
|
|
|
|
|
Asked Questions</a> page.</p>
|
2003-06-12 19:34:44 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
</div>
|
2003-06-12 19:34:44 +00:00
|
|
|
|
2003-11-07 19:43:14 +00:00
|
|
|
<!-- *********************************************************************** -->
|
2011-04-18 23:59:50 +00:00
|
|
|
<h2>
|
2003-11-07 19:43:14 +00:00
|
|
|
<a name="links">Links</a>
|
2011-04-18 23:59:50 +00:00
|
|
|
</h2>
|
2003-11-07 19:43:14 +00:00
|
|
|
<!-- *********************************************************************** -->
|
2003-06-12 19:34:44 +00:00
|
|
|
|
2011-04-23 00:30:22 +00:00
|
|
|
<div>
|
2003-06-12 19:34:44 +00:00
|
|
|
|
2008-07-22 01:10:25 +00:00
|
|
|
<p>This document is just an <b>introduction</b> on how to use LLVM to do
|
2003-11-07 19:43:14 +00:00
|
|
|
some simple things... there are many more interesting and complicated things
|
|
|
|
|
that you can do that aren't documented here (but we'll gladly accept a patch
|
|
|
|
|
if you want to write something up!). For more information about LLVM, check
|
|
|
|
|
out:</p>
|
|
|
|
|
|
|
|
|
|
<ul>
|
2006-03-14 05:39:39 +00:00
|
|
|
<li><a href="http://llvm.org/">LLVM homepage</a></li>
|
|
|
|
|
<li><a href="http://llvm.org/doxygen/">LLVM doxygen tree</a></li>
|
|
|
|
|
<li><a href="http://llvm.org/docs/Projects.html">Starting a Project
|
2003-11-07 19:43:14 +00:00
|
|
|
that Uses LLVM</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
|
|
|
|
|
<hr>
|
2003-11-22 01:30:01 +00:00
|
|
|
<address>
|
2004-01-20 00:20:17 +00:00
|
|
|
<a href="http://jigsaw.w3.org/css-validator/check/referer"><img
|
2008-12-11 17:34:48 +00:00
|
|
|
src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
|
2004-01-20 00:20:17 +00:00
|
|
|
<a href="http://validator.w3.org/check/referer"><img
|
2008-12-11 18:23:24 +00:00
|
|
|
src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
|
2004-01-20 00:20:17 +00:00
|
|
|
|
2003-11-22 01:30:01 +00:00
|
|
|
<a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
|
2004-09-05 20:50:22 +00:00
|
|
|
<a href="http://llvm.x10sys.com/rspencer/">Reid Spencer</a><br>
|
2011-04-09 02:13:37 +00:00
|
|
|
<a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br>
|
2003-11-07 19:43:14 +00:00
|
|
|
Last modified: $Date$
|
2003-11-22 01:30:01 +00:00
|
|
|
</address>
|
2003-11-07 19:43:14 +00:00
|
|
|
</body>
|
2002-07-17 23:05:56 +00:00
|
|
|
</html>
|
