<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>
<li><tt>cd cfrontend/<i>platform</i><br>
- ./fixheaders</tt>
+ ./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></li>
</ol></li>
- <li>With anonymous CVS access (or use a <a href="#mirror">mirror</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>
- </ol></li>
</ul></li>
- <li>Get the Test Suite Source Code (<em>optional</em>)
+ <li><b>[Optional]</b> Get the Test Suite 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>cd llvm/projects</tt>
<li><tt>gunzip --stdout llvm-test-<i>version</i>.tar.gz | tar -xvf -</tt>
- <li><tt>cd ..</tt></li>
</ol></li>
- <li>With anonymous CVS access (or use a <a href="#mirror">mirror</a>):
- <ol>
- <li><tt>cd <i>where-you-want-llvm-to-live</i></tt></li>
- <li><tt>cd llvm/projects</tt>
- <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-test</tt></li>
- <li><tt>cd llvm-test</tt></li>
- <li><tt>cvs up -P -d</tt></li>
- <li><tt>cd ..</tt></li>
- </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++ FrontEnd 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>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>
</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>
+</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
<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>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>1.9.2</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>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 (1.9.2). 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
+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>
</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 a
+ convenience since you can specify the paths using the -L options of the
+ tools and the C/C++ front-end will use the bytecode files installed in its
+ <tt>lib</tt> directory.</dd>
</dl>
</div>
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.
+ <dt><tt>cfrontend-x.y.sparc-sun-solaris2.8.tar.gz</tt></dt>
+ <dd>Binary release of the GCC front end for Solaris/Sparc.
<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>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.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>cfrontend-x.y.i386-unknown-freebsd5.1.tar.gz</tt></dt>
+ <dd>Binary release of the GCC front end for FreeBSD/x86.<br/></dd>
- <dt><tt>cfrontend-1.4.powerpc-apple-darwin7.6.0.tar.gz</tt></dt>
- <dd>This is the binary release of the GCC front end for MacOS X/PPC.<br/></dd>
+ <dt><tt>cfrontend-x.y.powerpc-apple-darwin7.6.0.tar.gz</tt></dt>
+ <dd>Binary release of the GCC front end for MacOS X/PPC.<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.4: <b>RELEASE_14</b></li>
<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
found. Use this if you have multiple tcl installations on your machine and you
<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>
<!-- ======================================================================= -->
<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
translates LLVM bytecode to a SPARC or x86 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
+ <tt>llvm-gcc</tt> tool is currently not included in the LLVM CVS tree
because it is quite large and not very interesting.
<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
</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>