<li>Read the documentation.</li>
<li>Read the documentation.</li>
<li>Remember that you were warned twice about reading the documentation.</li>
- <li>Install the GCC front end:
+ <li>Install the GCC front end if you intend to compile C or C++:
<ol>
- <li><tt>cd <i>where-you-want-the-C-front-end-to-live</i></tt>
+ <li><tt>cd <i>where-you-want-the-C-front-end-to-live</i></tt></li>
<li><tt>gunzip --stdout cfrontend.<i>platform</i>.tar.gz | tar -xvf -</tt>
- <li><b>Sparc and MacOS X Only:</b><br>
- <tt>cd cfrontend/<i>platform</i><br>
- ./fixheaders</tt>
+ </li>
+ <li><tt>cd cfrontend/<i>platform</i><br>
+ ./fixheaders</tt></li>
+ <li>Add the cfrontend's "bin" directory to your PATH variable.</li>
</ol></li>
- <li>Get the Source Code
+ <li>Get the LLVM Source Code
<ul>
- <li>With the distributed files:
+ <li>With the distributed files (or use <a href="#checkout">CVS</a>):
<ol>
<li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
<li><tt>gunzip --stdout llvm-<i>version</i>.tar.gz | tar -xvf -</tt>
- <li><tt>cd llvm</tt>
</ol></li>
- <li>With anonymous CVS access (or use a <a href="#mirror">mirror</a>):
+ </ul></li>
+
+ <li><b>[Optional]</b> Get the Test Suite Source Code
+ <ul>
+ <li>With the distributed files (or use <a href="#checkout">CVS</a>):
<ol>
- <li><tt>cd <i>where-you-want-llvm-to-live</i></tt></li>
- <li><tt>cvs -d
- :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm login</tt></li>
- <li>Hit the return key when prompted for the password.
- <li><tt>cvs -z3 -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm
- co llvm</tt></li>
- <li><tt>cd llvm</tt></li>
- <li><tt>cvs up -P -d</tt></li>
+ <li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
+ <li><tt>cd llvm/projects</tt>
+ <li><tt>gunzip --stdout llvm-test-<i>version</i>.tar.gz | tar -xvf -</tt>
</ol></li>
+
</ul></li>
+
<li>Configure the LLVM Build Environment
<ol>
- <li>Change directory to where you want to store the LLVM object
- files and run <tt>configure</tt> to configure the Makefiles and
- header files for the default platform. Useful options include:
+ <li><tt>cd <i>where-you-want-to-build-llvm</i></tt></li>
+ <li><tt><i>/path/to/llvm/</i>configure [options]</tt><br>
+ Some common options:
+
<ul>
+ <li><tt>--prefix=<i>directory</i></tt>
+ <p>Specify for <i>directory</i> the full pathname of where you
+ want the LLVM tools and libraries to be installed (default
+ <tt>/usr/local</tt>).</p></li>
<li><tt>--with-llvmgccdir=<i>directory</i></tt>
- <p>Specify the full pathname of where the LLVM GCC frontend is
- installed.</p></li>
+ <p>Optionally, specify for <i>directory</i> the full pathname of the
+ C/C++ front end installation to use with this LLVM configuration. If
+ not specified, the PATH will be searched.</p></li>
<li><tt>--enable-spec2000=<i>directory</i></tt>
<p>Enable the SPEC2000 benchmarks for testing. The SPEC2000
benchmarks should be available in
<li>Build the LLVM Suite:
<ol>
- <li>Set your LLVM_LIB_SEARCH_PATH environment variable.</li>
<li><tt>gmake -k |& tee gnumake.out
# this is csh or tcsh syntax</tt></li>
<li>If you get an "internal compiler error (ICE)" see <a href="#brokengcc">below</a>.</li>
</tr>
<tr>
<td>Linux</td>
- <td>x86<sup>1</sup></td>
+ <td>x86<sup><a href="#pf_1">1</a></sup></td>
<td>GCC</td>
</tr>
<tr>
</tr>
<tr>
<td>FreeBSD</td>
- <td>x86<sup>1</sup></td>
+ <td>x86<sup><a href="#pf_1">1</a></sup></td>
<td>GCC</td>
</tr>
<tr>
- <td>MacOS X<sup>2</sup></td>
+ <td>MacOS X<sup><a href="#pf_2">2</a></sup></td>
<td>PowerPC</td>
<td>GCC</td>
</tr>
+<tr>
+ <td>MacOS X<sup><a href="#pf_2">2</a></sup></td>
+ <td>x86</td>
+ <td>GCC</td>
+
+</tr>
<tr>
<td>Cygwin/Win32</td>
- <td>x86<sup>1</sup></td>
+ <td>x86<sup><a href="#pf_1">1</a></sup></td>
+ <td>GCC 3.4.X, binutils 2.15</td>
+</tr>
+<tr>
+ <td>MinGW/Win32</td>
+ <td>x86<sup><a href="#pf_1">1</a>,<a href="#pf_6">6</a></sup></td>
+ <td>GCC 3.4.X, binutils 2.15</td>
+</tr>
+<tr>
+ <td>Linux</td>
+ <td>amd64<sup><a href="#pf_3">3</a></sup></td>
<td>GCC</td>
</tr>
</table>
</tr>
<tr>
<td>Windows</td>
- <td>x86<sup>1</sup></td>
- <td>Visual Studio .NET<sup>4,5</sup>, MinGW</td>
+ <td>x86<sup><a href="#pf_1">1</a></sup></td>
+ <td>Visual Studio .NET<sup><a href="#pf_4">4</a>,<a href="#pf_5">5</a></sup></td>
<tr>
- <td>AIX<sup>3,4</sup></td>
+ <td>AIX<sup><a href="#pf_3">3</a>,<a href="#pf_4">4</a></sup></td>
<td>PowerPC</td>
<td>GCC</td>
</tr>
<tr>
- <td>Linux<sup>3,5</sup></td>
+ <td>Linux<sup><a href="#pf_3">3</a>,<a href="#pf_5">5</a></sup></td>
<td>PowerPC</td>
<td>GCC</td>
</tr>
+
+<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>
+<tr>
+ <td>HP-UX<sup><a href="#pf_7">7</a></sup></td>
+ <td>Itanium (IA-64)</td>
+ <td>HP aCC</td>
+</tr>
</table>
-<p>
-Notes:<br>
-<sup>1</sup> Code generation supported for Pentium processors and up<br>
-<sup>2</sup> Code generation supported for 32-bit ABI only<br>
-<sup>3</sup> No native code generation<br>
-<sup>4</sup> Build is not complete: one or more tools don't link<br>
-<sup>5</sup> The GCC-based C/C++ frontend does not build<br>
-</p>
+<p><b>Notes:</b></p>
+
+<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>
+<li><a name="pf_4">Build is not complete: one or more tools don't link</a></li>
+<li><a name="pf_5">The GCC-based C/C++ frontend does not build</a></li>
+<li><a name="pf_6">The port is done using the MSYS shell.
+<a href="http://www.mingw.org/MinGWiki/">Download</a> and install
+bison (excl. M4.exe) and flex in that order. Build binutils-2.15 from source,
+if necessary.</li>
+<li><a name="pf_7">Native code generation exists but is not complete.</a></li>
+</ol>
+</div>
<p>Note that you will need about 1-3 GB of space for a full LLVM build in Debug
-mode, depending on the system (because of all the debug info), and the libraries
-appear in more than one of the tools that get linked, so there is some
-duplication. If you do not need many of the tools and you are space-conscious,
+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
+tools). If you do not need many of the tools and you are space-conscious,
you can disable them individually in <tt>llvm/tools/Makefile</tt>. The Release
build requires considerably less space.</p>
<tr>
<td><a href="http://gcc.gnu.org">GCC</a></td>
<td>3.4.2</td>
- <td>C/C++ compiler (<a href="#Note3">Note 3</a>)</td>
+ <td>C/C++ compiler<sup><a href="#sf1">1</a></sup></td>
+ </tr>
+
+ <tr>
+ <td><a href="http://www.gnu.org/software/texinfo">TeXinfo</a></td>
+ <td>4.5</td>
+ <td>For building the CFE</td>
</tr>
<tr>
<tr>
<td><a href="http://www.gnu.org/software/bison/bison.html">Bison</a></td>
- <td>1.35</td>
+ <td>1.28, 1.35, 1.75, 1.875d, 2.0, or 2.1<br>(not 1.85 or 1.875)</td>
<td>YACC compiler</td>
</tr>
+ <tr>
+ <td><a href="https://www.cvshome.org/downloads.html">CVS</a></td>
+ <td>≥1.11</td>
+ <td>CVS access to LLVM<sup><a href="#sf2">2</a></sup></td>
+ </tr>
+
<tr>
<td><a href="http://savannah.gnu.org/projects/dejagnu">DejaGnu</a></td>
<td>1.4.2</td>
- <td>Automated test suite (<a href="#Note2">Note 2</a>)</td>
+ <td>Automated test suite<sup><a href="#sf3">3</a></sup></td>
</tr>
<tr>
<td><a href="http://www.tcl.tk/software/tcltk/">tcl</a></td>
<td>8.3, 8.4</td>
- <td>Automated test suite (<a href="#Note2">Note 2</a>)</td>
+ <td>Automated test suite<sup><a href="#sf3">3</a></sup></td>
</tr>
<tr>
<td><a href="http://expect.nist.gov/">expect</a></td>
<td>5.38.0</td>
- <td>Automated test suite (<a href="#Note2">Note 2</a>)</td>
+ <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>
+ <td>Nightly tester, utilities</td>
</tr>
<tr>
<td><a href="http://savannah.gnu.org/projects/m4">GNU M4</a>
<td>1.4</td>
- <td>Macro processor for configuration (<a href="#Note1">Note 1</a>)</td>
+ <td>Macro processor for configuration<sup><a href="#sf4">4</a></sup></td>
</tr>
<tr>
<td><a href="http://www.gnu.org/software/autoconf">GNU Autoconf</a></td>
<td>2.59</td>
- <td>Configuration script builder (<a href="#Note1">Note 1</a>)</td>
+ <td>Configuration script builder<sup><a href="#sf4">4</a></sup></td>
</tr>
<tr>
<td><a href="http://www.gnu.org/software/automake">GNU Automake</a></td>
- <td>2.59</td>
- <td>aclocal macro generator (<a href="#Note1">Note 1</a>)</td>
- </tr>
-
- <tr>
- <td><a href="http://www.perl.com/download.csp">perl</a></td>
- <td>>5.6.0</td>
- <td>Nightly tester, utilities</td>
+ <td>1.9.2</td>
+ <td>aclocal macro generator<sup><a href="#sf4">4</a></sup></td>
</tr>
<tr>
<td><a href="http://savannah.gnu.org/projects/libtool">libtool</a></td>
<td>1.5.10</td>
- <td>Shared library manager (<a href="#Note1">Note 1</a>)</td>
- </tr>
-
- <tr>
- <td><a href="https://www.cvshome.org/downloads.html">CVS</a></td>
- <td>>1.11</td>
- <td>CVS access to LLVM (<a href="#Note4">Note 4</a>)</td>
+ <td>Shared library manager<sup><a href="#sf4">4</a></sup></td>
</tr>
</table>
- <p>Notes:</p>
+ <p><b>Notes:</b></p>
+ <div class="doc_notes">
<ol>
- <li><a name="Note1">If you want to make changes to the configure scripts,
- you will need GNU autoconf (2.59), and consequently, GNU M4 (version 1.4
- or higher). You will also need automake. We only use aclocal from that
- package.</a></li>
- <li><a name="Note2">Only needed if you want to run the automated test
- suite in the <tt>test</tt> directory.</a></li>
- </li>
- <li><a name="Note3">Only the C and C++ languages are needed so there's no
+ <li><a name="sf3">Only the C and C++ languages are needed so there's no
need to build the other languages for LLVM's purposes.</a> See
- <a href="#brokengcc">below</a> for specific version info.
- </li>
- <li><a name="Note4">You only need CVS if you intend to build from the
+ <a href="#brokengcc">below</a> for specific version info.</li>
+ <li><a name="sf2">You only need CVS if you intend to build from the
latest LLVM sources. If you're working from a release distribution, you
don't need CVS.</a></li>
+ <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,
+ you will need GNU autoconf (2.59), and consequently, GNU M4 (version 1.4
+ or higher). You will also need automake (1.9.2). We only use aclocal
+ from that package.</a></li>
</ol>
+ </div>
+
<p>Additionally, your compilation host is expected to have the usual
plethora of Unix utilities. Specifically:</p>
<ul>
<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
-to compile LLVM. We routinely use GCC 3.3.3 and GCC 3.4.0 and have had success
-with them. Other versions of GCC will probably work as well. GCC versions listed
+to compile LLVM. We routinely use GCC 3.3.3, 3.4.0, and Apple 4.0.1
+successfully with them (however, see below). Other versions of GCC will
+probably work as well. GCC versions listed
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
<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>
+
+<p><b>Cygwin GCC 3.3.3</b>: The version of GCC 3.3.3 commonly shipped with
+ Cygwin does not work. Please <a href="CFEBuildInstrs.html#cygwin">upgrade
+ to a newer version</a> if possible.</p>
+<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>
+<p><b>IA-64 GCC 4.0.0</b>: The IA-64 version of GCC 4.0.0 is known to
+ miscompile LLVM.</p>
</div>
<dt>LLVMGCCDIR
<dd>
- This is the where the LLVM GCC Front End is installed.
+ This is where the LLVM GCC Front End is installed.
<p>
For the pre-built GCC front end binaries, the LLVMGCCDIR is
<tt>cfrontend/<i>platform</i>/llvm-gcc</tt>.
<div class="doc_text">
<p>
-In order to compile and use LLVM, you will need to set some environment
-variables. There are also some shell aliases which you may find useful.
-You can set these on the command line, or better yet, set them in your
-<tt>.cshrc</tt> or <tt>.profile</tt>.
+In order to compile and use LLVM, you may need to set some environment
+variables.
<dl>
- <dt><tt>LLVM_LIB_SEARCH_PATH</tt>=<tt><i>LLVMGCCDIR</i>/bytecode-libs</tt>
- <dd>
- This environment variable helps the LLVM GCC front end find bytecode
- libraries that it will need for compilation.
- <p>
-
- <dt>alias llvmgcc <i>LLVMGCCDIR</i><tt>/bin/gcc</tt>
- <dt>alias llvmg++ <i>LLVMGCCDIR</i><tt>/bin/g++</tt>
- <dd>
- These aliases allow you to use the LLVM C and C++ front ends without putting
- them in your <tt>PATH</tt> or typing in their complete pathnames.
+ <dt><tt>LLVM_LIB_SEARCH_PATH</tt>=<tt>/path/to/your/bytecode/libs</tt></dt>
+ <dd>[Optional] This environment variable helps LLVM linking tools find the
+ locations of your bytecode libraries. It is provided only as a
+ convenience since you can specify the paths using the -L options of the
+ tools and the C/C++ front-end will automatically use the bytecode files
+ installed in its
+ <tt>lib</tt> directory.</dd>
</dl>
</div>
<p>
If you have the LLVM distribution, you will need to unpack it before you
can begin to compile it. LLVM is distributed as a set of two files: the LLVM
-suite and the LLVM GCC front end compiled for your platform. Each
-file is a TAR archive that is compressed with the gzip program.
+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.
</p>
-<p> The files are as follows:
+<p>The files are as follows, with <em>x.y</em> marking the version number:
<dl>
- <dt><tt>llvm-1.4.tar.gz</tt></dt>
- <dd>This is the source code for the LLVM libraries and tools.<br/></dd>
+ <dt><tt>llvm-x.y.tar.gz</tt></dt>
+ <dd>Source release for the LLVM libraries and tools.<br/></dd>
- <dt><tt>llvm-test-1.4.tar.gz</tt></dt>
- <dd>This is the source code for the LLVM test suite.</tt></dd>
+ <dt><tt>llvm-test-x.y.tar.gz</tt></dt>
+ <dd>Source release for the LLVM test suite.</dd>
- <dt><tt>cfrontend-1.4.source.tar.gz</tt></dt>
- <dd>This is the source release of the GCC front end.<br/></dd>
+ <dt><tt>cfrontend-x.y.source.tar.gz</tt></dt>
+ <dd>Source release of the GCC front end.<br/></dd>
- <dt><tt>cfrontend-1.4.sparc-sun-solaris2.8.tar.gz</tt></dt>
- <dd>This is the binary release of the GCC front end for Solaris/Sparc.
- <br/></dd>
+ <dt><tt>cfrontend-x.y.i686-redhat-linux-gnu.tar.gz</tt></dt>
+ <dd>Binary release of the GCC front end for Linux/x86.<br/></dd>
- <dt><tt>cfrontend-1.4.i686-redhat-linux-gnu.tar.gz</tt></dt>
- <dd>This is the binary release of the GCC front end for Linux/x86.<br/></dd>
+ <dt><tt>llvm-gcc4-x.y.source.tar.gz</tt></dt>
+ <dd>Source release of the llvm-gcc4 front end. See README.LLVM in the root
+ directory for build instructions.<br/></dd>
- <dt><tt>cfrontend-1.4.i386-unknown-freebsd5.1.tar.gz</tt></dt>
- <dd>This is the binary release of the GCC front end for FreeBSD/x86.<br/></dd>
+ <dt><tt>llvm-gcc4-x.y.powerpc-apple-darwin8.6.0.tar.gz</tt></dt>
+ <dd>Binary release of the llvm-gcc4 front end for MacOS X/PowerPC.<br/></dd>
- <dt><tt>cfrontend-1.4.powerpc-apple-darwin7.0.0.tar.gz</tt></dt>
- <dd>This is the binary release of the GCC front end for MacOS X/PPC.<br/></dd>
+ <dt><tt>llvm-gcc4-x.y.i686-apple-darwin8.6.1.tar.gz</tt></dt>
+ <dd>Binary release of the llvm-gcc4 front end for MacOS X/X86.<br/></dd>
</dl>
</div>
<p>If you want to get a specific release (as opposed to the most recent
revision), you can specify a label. The following releases have the following
-label:</p>
+labels:</p>
<ul>
+<li>Release 1.7: <b>RELEASE_17</b></li>
+<li>Release 1.6: <b>RELEASE_16</b></li>
+<li>Release 1.5: <b>RELEASE_15</b></li>
<li>Release 1.4: <b>RELEASE_14</b></li>
<li>Release 1.3: <b>RELEASE_13</b></li>
<li>Release 1.2: <b>RELEASE_12</b></li>
configured by the LLVM configure script as well as automatically updated when
you run <tt>cvs update</tt>.</p>
-<p>If you would like to get the GCC front end source code, you can also get it
-from the CVS repository:</p>
+<p>If you would like to get the GCC 3.4 front end source code, you can also get it from the CVS repository:</p>
<pre>
cvs -z3 -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm co llvm-gcc
</div>
-<!-- ======================================================================= -->
-<div class="doc_subsubsection">
- <a name="mirrors">LLVM CVS Mirrors</a>
-</div>
-
-<div class="doc_text">
-
-<p>If the main CVS server is overloaded or inaccessible, you can try one of
-these user-hosted mirrors:</p>
-
-<ul>
-<li><a href="http://llvm.x10sys.com/">Mirror hosted by eXtensible Systems
-Inc.</a></li>
-</ul>
-</div>
-
<!-- ======================================================================= -->
<div class="doc_subsection">
<a name="installcf">Install the GCC Front End</a>
-</tt></li>
</ol>
-<p>If you are using Solaris/Sparc or MacOS X/PPC, you will need to fix the
-header files:</p>
+<p>Next, you will need to fix your system header files:</p>
<p><tt>cd cfrontend/<i>platform</i><br>
./fixheaders</tt></p>
<p>The following options can be used to set or enable LLVM specific options:</p>
<dl>
- <dt><i>--with-llvmgccdir=LLVMGCCDIR</i></dt>
- <dd>
- Path to the location where the LLVM GCC front end binaries and
- associated libraries were installed. This must be specified as an
- absolute pathname.
- <p></p>
- </dd>
+ <dt><i>--with-llvmgccdir</i></dt>
+ <dd>Path to the LLVM C/C++ FrontEnd to be used with this LLVM configuration.
+ The value of this option should specify the full pathname of the C/C++ Front
+ End to be used. If this option is not provided, the PATH will be searched for
+ a program named <i>llvm-gcc</i> and the C/C++ FrontEnd install directory will
+ be inferred from the path found. If the option is not given, and no llvm-gcc
+ can be found in the path then a warning will be produced by
+ <tt>configure</tt> indicating this situation. LLVM may still be built with
+ the <tt>tools-only</tt> target but attempting to build the runtime libraries
+ will fail as these libraries require llvm-gcc and llvm-g++. See
+ <a href="#installcf">Install the GCC Front End</a> for details on installing
+ the C/C++ Front End. See
+ <a href="CFEBuildInstrs.html">Bootstrapping the LLVM C/C++ Front-End</a>
+ for details on building the C/C++ Front End.</dd>
<dt><i>--with-tclinclude</i></dt>
- <dd>Path to the tcl include directory under which the <tt>tclsh</tt> can be
+ <dd>Path to the tcl include directory under which <tt>tclsh</tt> can be
found. Use this if you have multiple tcl installations on your machine and you
want to use a specific one (8.x) for LLVM. LLVM only uses tcl for running the
dejagnu based test suite in <tt>llvm/test</tt>. If you don't specify this
- option, the LLVM configure script will search for tcl 8.4 and 8.3 releases.
+ option, the LLVM configure script will search for the tcl 8.4 and 8.3
+ releases.
<p></p>
</dd>
<dt><i>--enable-optimized</i></dt>
unoptimized build (also known as a debug build).
<p></p>
</dd>
+ <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>
<dt><i>--enable-jit</i></dt>
<dd>
Compile the Just In Time (JIT) compiler functionality. This is not
to explicitly enable it if you want it.
<p></p>
</dd>
+ <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
+ names use all lower case. The current set of targets is: <br/>
+ <tt>alpha, ia64, powerpc, skeleton, sparc, x86</tt>.
+ <p></p></dd>
<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
<p>
</ol>
-<p>In addition to running <tt>configure</tt>, you must set the
-<tt>LLVM_LIB_SEARCH_PATH</tt> environment variable in your startup shell
-scripts. This environment variable is used to locate "system" libraries like
-"<tt>-lc</tt>" and "<tt>-lm</tt>" when linking. This variable should be set to
-the absolute path of the <tt>bytecode-libs</tt> subdirectory of the GCC front
-end, or <i>LLVMGCCDIR</i>/<tt>bytecode-libs</tt>. For example, one might set
-<tt>LLVM_LIB_SEARCH_PATH</tt> to
-<tt>/home/vadve/lattner/local/x86/llvm-gcc/bytecode-libs</tt> for the x86
-version of the GCC front end on our research machines.</p>
-
</div>
<!-- ======================================================================= -->
Perform a Release (Optimized) build.
<p>
+ <dt><tt>gmake ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1</tt>
+ <dd>
+ Perform a Release (Optimized) build without assertions enabled.
+ <p>
+
<dt><tt>gmake ENABLE_PROFILING=1</tt>
<dd>
Perform a Profiling build.
<div class="doc_text">
<p>
-If you're running on a
linux system that supports the "<a
+If you're running on a
Linux system that supports the "<a
href="http://www.tat.physik.uni-tuebingen.de/~rguenth/linux/binfmt_misc.html">
binfmt_misc</a>"
module, and you have root access on the system, you can set your system up to
execute LLVM bytecode files directly. To do this, use commands like this (the
first command may not be required if you are already using the module):</p>
+<div class="doc_code">
<pre>
$ mount -t binfmt_misc none /proc/sys/fs/binfmt_misc
- $ echo ':llvm:M::llvm::/path/to/lli:' > /proc/sys/fs/binfmt_misc/register
+ $ echo ':llvm:M::llvm::/path/to/lli:' > /proc/sys/fs/binfmt_misc/register
$ chmod u+x hello.bc (if needed)
$ ./hello.bc
</pre>
+</div>
<p>
This allows you to execute LLVM bytecode files directly. Thanks to Jack
<p>One useful source of information about the LLVM source base is the LLVM <a
href="http://www.doxygen.org">doxygen</a> documentation available at <tt><a
-href="http://llvm.cs.uiuc.edu/doxygen/">http://llvm.cs.uiuc.edu/doxygen/</a></tt>.
+href="http://llvm.org/doxygen/">http://llvm.org/doxygen/</a></tt>.
The following is a brief introduction to code layout:</p>
</div>
<dt><tt><b>llvm/lib/Target/</b></tt></dt>
<dd> This directory contains files that describe various target architectures
- for code generation. For example, the <tt>llvm/lib/Target/SparcV9</tt>
- directory holds the Sparc machine description while
- <tt>llvm/lib/Target/CBackend</tt> implements the LLVM-to-C converter</dd>
+ for code generation. For example, the <tt>llvm/lib/Target/X86</tt>
+ directory holds the X86 machine description while
+ <tt>llvm/lib/Target/CBackend</tt> implements the LLVM-to-C converter.</dd>
<dt><tt><b>llvm/lib/CodeGen/</b></tt></dt>
<dd> This directory contains the major parts of the code generator: Instruction
module contains a comprehensive correctness, performance, and benchmarking
test
suite for LLVM. It is a separate CVS module because not every LLVM user is
- interested in downloading or building such a comprehensive test. For further
- details on this test suite, please see the
+ interested in downloading or building such a comprehensive test suite. For
+ further details on this test suite, please see the
<a href="TestingGuide.html">Testing Guide</a> document.</p>
</div>
all from one command line. <tt>llvmc</tt> also takes care of processing the
dependent libraries found in bytecode. This reduces the need to get the
traditional <tt>-l<name></tt> options right on the command line. Please
- note that this tool is new in 1.4 and considered experimental. It will be
- fully supported in 1.5.</dd>
+ note that this tool, while functional, is still experimental and not feature
+ complete.</dd>
<dt><tt><b>llvm-ar</b></tt></dt>
<dd>The archiver produces an archive containing
<dd><tt>llvm-ld</tt> is very similar to gccld and provides a general purpose
and extensible linker for LLVM. This is the linker invoked by <tt>llvmc</tt>.
It allows optimization modules to be loaded so that language specific
- optimizations can be applied at link time. Please note that this tool is new
- in LLVM 1.4 and still considered experimental. It will be fully supported in
- LLVM 1.5.</dd>
+ optimizations can be applied at link time. This tool is considered
+ experimental.</dd>
<dt><tt><b>llvm-link</b></tt></dt>
<dd><tt>llvm-link</tt>, not surprisingly, links multiple LLVM modules into
can directly execute LLVM bytecode (although very slowly...). In addition
to a simple interpreter, <tt>lli</tt> also has a tracing mode (entered by
specifying <tt>-trace</tt> on the command line). Finally, for
- architectures that support it (currently only x86 and Sparc), by default,
+ 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>
<dt><tt><b>llc</b></tt></dt>
<dd> <tt>llc</tt> is the LLVM backend compiler, which
- translates LLVM bytecode to a SPARC or x86 assembly file, or to C code (with
+ translates LLVM bytecode to a native code assembly file or to C code (with
the -march=c option).</dd>
- <dt><tt><b>llvmgcc</b></tt></dt>
- <dd><tt>llvmgcc</tt> is a GCC-based C frontend
+ <dt><tt><b>llvm-gcc</b></tt></dt>
+ <dd><tt>llvm-gcc</tt> is a GCC-based C frontend
that has been retargeted to emit LLVM code as the 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. The source code for the
- <tt>llvmgcc</tt> tool is currently not included in the LLVM CVS tree
- because it is quite large and not very interesting.
+ <tt>llvm-gcc</tt> tool is available as a separate CVS module.
<blockquote>
<dl>
<dt><tt><b>gccas</b></tt></dt>
- <dd>This tool is invoked by the <tt>llvmgcc</tt> frontend as the
+ <dd>This tool is invoked by the <tt>llvm-gcc</tt> frontend as the
"assembler" part of the compiler. This tool actually assembles LLVM
assembly to LLVM bytecode, performs a variety of optimizations, and
outputs LLVM bytecode. Thus when you invoke
- <tt>llvmgcc -c x.c -o x.o</tt>, you are causing <tt>gccas</tt> to be
+ <tt>llvm-gcc -c x.c -o x.o</tt>, you are causing <tt>gccas</tt> to be
run, which writes the <tt>x.o</tt> file (which is an LLVM bytecode file
that can be disassembled or manipulated just like any other bytecode
file). The command line interface to <tt>gccas</tt> is designed to be
are code generators for parts of LLVM infrastructure.</p>
<dl>
- <dt><tt><b>Burg/</b></tt> <dd><tt>Burg</tt> is an instruction selector
- generator -- it builds trees on which it then performs pattern-matching to
- select instructions according to the patterns the user has specified. Burg
- is currently used in the Sparc V9 backend.<p>
-
<dt><tt><b>codegen-diff</b></tt> <dd><tt>codegen-diff</tt> is a script
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,
<tt><b>NightlyTestTemplate.html</b></tt> <dd>These files are used in a
cron script to generate nightly status reports of the functionality of
tools, and the results can be seen by following the appropriate link on
- the <a href="http://llvm.
cs.uiuc.edu/">LLVM homepage</a>.<p>
+ the <a href="http://llvm.
org/">LLVM homepage</a>.<p>
<dt><tt><b>TableGen/</b></tt> <dd>The <tt>TableGen</tt> directory contains
the tool used to generate register descriptions, instruction set
</pre></li>
<li><p>Next, compile the C file into a LLVM bytecode file:</p>
- <p><tt>% llvmgcc hello.c -o hello</tt></p>
+ <p><tt>% llvm-gcc hello.c -o hello</tt></p>
<p>Note that you should have already built the tools and they have to be
in your path, at least <tt>gccas</tt> and <tt>gccld</tt>.</p>
out:</p>
<ul>
- <li><a href="http://llvm.cs.uiuc.edu/">LLVM homepage</a></li>
- <li><a href="http://llvm.cs.uiuc.edu/doxygen/">LLVM doxygen tree</a></li>
- <li><a href="http://llvm.cs.uiuc.edu/docs/Projects.html">Starting a Project
+ <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
that Uses LLVM</a></li>
</ul>
<a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
<a href="http://llvm.x10sys.com/rspencer/">Reid Spencer</a><br>
- <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
+ <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
Last modified: $Date$
</address>
</body>
projects / oota-llvm.git / blobdiff