2003-10-21 21:58:38 +00:00
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
2003-10-23 01:48:33 +00:00
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
|
|
|
|
<link rel="stylesheet" href="llvm.css" type="text/css" media="screen" />
|
2003-10-28 21:09:29 +00:00
|
|
|
<title>Bootstrapping the LLVM C/C++ Front-End</title>
|
2003-10-23 01:48:33 +00:00
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<div class="doc_title">
|
2003-10-28 21:09:29 +00:00
|
|
|
Bootstrapping the LLVM C/C++ Front-End
|
2003-10-23 01:48:33 +00:00
|
|
|
</div>
|
2003-10-21 21:58:38 +00:00
|
|
|
|
2003-11-12 20:47:30 +00:00
|
|
|
<ol>
|
|
|
|
|
<li><a href="#cautionarynote">A Cautionary Note</a>
|
|
|
|
|
<li><a href="#instructions">Instructions</a>
|
2003-12-18 16:43:17 +00:00
|
|
|
<li><a href="#license">License Information</a>
|
2003-11-12 20:47:30 +00:00
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
<p><b>Written by Brian R. Gaeke</b></p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
<div class="doc_section">
|
|
|
|
|
<a name="cautionarynote">A Cautionary Note</a>
|
|
|
|
|
</div>
|
|
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
<p>This document is intended to explain the process of building the
|
|
|
|
|
LLVM C/C++ front-end, based on GCC 3.4, from its source code. You
|
|
|
|
|
would have to do this, for example, if you are porting LLVM to a new
|
|
|
|
|
architecture or operating system.</p>
|
2003-10-21 21:58:38 +00:00
|
|
|
|
|
|
|
|
<p><b>NOTE:</b> This is currently a somewhat fragile, error-prone
|
2003-10-28 21:09:29 +00:00
|
|
|
process, and you should <b>only</b> try to do it if:</p>
|
|
|
|
|
|
|
|
|
|
<ol>
|
|
|
|
|
<li>you really, really, really can't use the binaries we distribute</li>
|
|
|
|
|
<li>you need GCC to fix some of the header files on your system</li>
|
|
|
|
|
<li>you are an elite GCC hacker.</li>
|
|
|
|
|
</ol>
|
2003-10-21 21:58:38 +00:00
|
|
|
|
|
|
|
|
<p>We welcome patches to help make this process simpler.</p>
|
2003-11-12 20:47:30 +00:00
|
|
|
</div>
|
2003-10-21 21:58:38 +00:00
|
|
|
|
2003-10-23 01:48:33 +00:00
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
<div class="doc_section">
|
|
|
|
|
<a name="instructions">Instructions</a>
|
|
|
|
|
</div>
|
|
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
<p>
|
2003-10-21 21:58:38 +00:00
|
|
|
<ol>
|
|
|
|
|
<li><p>Configure and build the LLVM libraries and tools using:</p>
|
|
|
|
|
<pre>
|
|
|
|
|
% cd llvm
|
|
|
|
|
% ./configure [options...]
|
|
|
|
|
% gmake tools-only
|
|
|
|
|
</pre>
|
|
|
|
|
<p>The use of the non-default target "tools-only" means that the
|
|
|
|
|
LLVM tools and libraries will build, and the binaries will be
|
|
|
|
|
deposited in llvm/tools/Debug, but the runtime (bytecode)
|
2003-10-23 01:48:33 +00:00
|
|
|
libraries will not build.</p></li>
|
2003-10-21 21:58:38 +00:00
|
|
|
|
|
|
|
|
<li><p>Add the directory containing the tools to your PATH.</p>
|
|
|
|
|
<pre>
|
2003-10-23 01:48:33 +00:00
|
|
|
% set path = ( `cd llvm/tools/Debug && pwd` $path )
|
|
|
|
|
</pre></li>
|
2003-10-21 21:58:38 +00:00
|
|
|
|
2003-10-23 01:48:33 +00:00
|
|
|
<li><p>Unpack the C/C++ front-end source into cfrontend/src.</p></li>
|
2003-10-21 21:58:38 +00:00
|
|
|
|
|
|
|
|
<li><p>Edit src/configure. Change the first line (starting w/ #!) to
|
2003-10-23 01:48:33 +00:00
|
|
|
contain the correct full pathname of sh.</p></li>
|
2003-10-21 21:58:38 +00:00
|
|
|
|
|
|
|
|
<li><p>Make "build" and "install" directories as siblings of the "src"
|
|
|
|
|
tree.</p>
|
|
|
|
|
<pre>
|
|
|
|
|
% pwd
|
|
|
|
|
/usr/local/example/cfrontend/src
|
|
|
|
|
% cd ..
|
|
|
|
|
% mkdir build install
|
|
|
|
|
% set CFEINSTALL = `pwd`/install
|
2003-10-23 01:48:33 +00:00
|
|
|
</pre></li>
|
2003-10-21 21:58:38 +00:00
|
|
|
|
2003-12-10 20:04:13 +00:00
|
|
|
<li><p>Configure, build, and install the C front-end:</p>
|
2003-12-08 19:59:14 +00:00
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
<b>Linux/x86:</b>
|
|
|
|
|
</p>
|
|
|
|
|
|
2003-10-21 21:58:38 +00:00
|
|
|
<pre>
|
|
|
|
|
% cd build
|
2003-12-10 20:04:13 +00:00
|
|
|
% ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls --disable-shared \
|
2003-10-21 21:58:38 +00:00
|
|
|
--enable-languages=c,c++
|
|
|
|
|
% gmake all-gcc
|
|
|
|
|
% setenv LLVM_LIB_SEARCH_PATH `pwd`/gcc
|
|
|
|
|
% gmake all; gmake install
|
|
|
|
|
</pre>
|
|
|
|
|
|
2003-12-08 19:59:14 +00:00
|
|
|
<p>
|
2004-01-28 20:54:41 +00:00
|
|
|
<b>Solaris/SPARC:</b>
|
2003-12-08 19:59:14 +00:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>
|
2004-01-28 20:54:41 +00:00
|
|
|
For Solaris/SPARC, LLVM only supports the SPARC V9. Therefore, the
|
|
|
|
|
configure command line should specify sparcv9, as shown below. Also,
|
|
|
|
|
note that Solaris has trouble with various wide (multibyte) character
|
|
|
|
|
functions from C as referenced from C++, so we typically configure with
|
|
|
|
|
--disable-c-mbchar (cf. <a href="http://llvm.cs.uiuc.edu/PR206">Bug 206</a>).
|
2003-12-08 19:59:14 +00:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<pre>
|
|
|
|
|
% cd build
|
2004-01-28 20:54:41 +00:00
|
|
|
% ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
|
|
|
|
|
--disable-shared --enable-languages=c,c++ --host=sparcv9-sun-solaris2.8 \
|
|
|
|
|
--disable-c-mbchar
|
2003-12-08 19:59:14 +00:00
|
|
|
% gmake all-gcc
|
|
|
|
|
% setenv LLVM_LIB_SEARCH_PATH `pwd`/gcc
|
2004-01-28 20:54:41 +00:00
|
|
|
% gmake all; gmake install
|
2003-12-08 19:59:14 +00:00
|
|
|
</pre>
|
|
|
|
|
|
2003-10-23 03:55:23 +00:00
|
|
|
<p><b>Common Problem:</b> You may get error messages regarding the fact
|
2003-10-21 21:58:38 +00:00
|
|
|
that LLVM does not support inline assembly. Here are two common
|
|
|
|
|
fixes:</p>
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
<li><p><b>Fix 1:</b> If you have system header files that include
|
|
|
|
|
inline assembly, you may have to modify them to remove the inline
|
|
|
|
|
assembly, and install the modified versions in
|
2003-10-23 01:48:33 +00:00
|
|
|
<code>$CFEINSTALL/<i>target-triplet</i>/sys-include</code>.</p></li>
|
2003-10-21 21:58:38 +00:00
|
|
|
|
|
|
|
|
<li><b>Fix 2:</b> If you are building the C++ front-end on a CPU we
|
|
|
|
|
haven't tried yet, you will probably have to edit the appropriate
|
|
|
|
|
version of atomicity.h under
|
|
|
|
|
<code>src/libstdc++-v3/config/cpu/<i>name-of-cpu</i>/atomicity.h</code>
|
2003-10-23 01:48:33 +00:00
|
|
|
and apply a patch so that it does not use inline assembly.</p></li>
|
2003-10-21 21:58:38 +00:00
|
|
|
</ul>
|
|
|
|
|
|
2003-10-23 03:55:23 +00:00
|
|
|
<p><b>Porting to a new architecture:</b> If you are porting the new front-end
|
|
|
|
|
to a new architecture, or compiling in a different configuration that we have
|
|
|
|
|
previously, there are probably several changes you will have to make to the GCC
|
|
|
|
|
target to get it to work correctly. These include:<p>
|
2003-10-21 21:58:38 +00:00
|
|
|
|
|
|
|
|
<ul>
|
2003-10-23 03:55:23 +00:00
|
|
|
<li>Often targets include special or assembler linker flags which
|
|
|
|
|
<tt>gccas</tt>/<tt>gccld</tt> does not understand. In general, these can
|
|
|
|
|
just be removed.</li>
|
|
|
|
|
<li>LLVM currently does not support any floating point values other than
|
|
|
|
|
32-bit and 64-bit IEEE floating point. The primary effect of this is
|
|
|
|
|
that you may have to map "long double" onto "double".</li>
|
|
|
|
|
<li>The profiling hooks in GCC do not apply at all to the LLVM front-end.
|
|
|
|
|
These may need to be disabled.</li>
|
|
|
|
|
<li>No inline assembly for position independent code. At the LLVM level,
|
|
|
|
|
everything is position independent.</li>
|
|
|
|
|
<li>We handle <tt>.init</tt> and <tt>.fini</tt> differently.</li>
|
2003-10-24 16:02:34 +00:00
|
|
|
<li>You may have to disable multilib support in your target. Using multilib
|
|
|
|
|
support causes the GCC compiler driver to add a lot of "<tt>-L</tt>"
|
|
|
|
|
options to the link line, which do not relate to LLVM and confuse
|
|
|
|
|
<tt>gccld</tt>. To disable multilibs, delete any
|
|
|
|
|
<tt>MULTILIB_OPTIONS</tt> lines from your target files.</li>
|
2003-10-23 03:55:23 +00:00
|
|
|
<li>Did we mention that we don't support inline assembly? You'll probably
|
|
|
|
|
have to add some fixinclude hacks to disable it in the system
|
|
|
|
|
headers.</li>
|
2003-10-21 21:58:38 +00:00
|
|
|
</ul>
|
2003-10-23 01:48:33 +00:00
|
|
|
</li>
|
2003-10-21 21:58:38 +00:00
|
|
|
|
|
|
|
|
<li><p>Go back into the LLVM source tree proper. Edit Makefile.config
|
|
|
|
|
to redefine <code>LLVMGCCDIR</code> to the full pathname of the
|
|
|
|
|
<code>$CFEINSTALL</code> directory, which is the directory you just
|
|
|
|
|
installed the C front-end into. (The ./configure script is likely to
|
2003-10-23 01:48:33 +00:00
|
|
|
have set this to a directory which does not exist on your system.)</p></li>
|
2003-10-21 21:58:38 +00:00
|
|
|
|
|
|
|
|
<li><p>If you edited header files during the C/C++ front-end build as
|
|
|
|
|
described in "Fix 1" above, you must now copy those header files from
|
|
|
|
|
<code>$CFEINSTALL/<i>target-triplet</i>/sys-include</code> to
|
|
|
|
|
<code>$CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm/include</code>.
|
|
|
|
|
(This should be the "include" directory in the same directory as the
|
|
|
|
|
libgcc.a library, which you can find by running
|
2003-10-23 01:48:33 +00:00
|
|
|
<code>$CFEINSTALL/bin/gcc --print-libgcc-file-name</code>.)</p></li>
|
2003-10-21 21:58:38 +00:00
|
|
|
|
|
|
|
|
<li><p>Build and install the runtime (bytecode) libraries by running:</p>
|
|
|
|
|
<pre>
|
|
|
|
|
% gmake -C runtime
|
|
|
|
|
% mkdir $CFEINSTALL/bytecode-libs
|
|
|
|
|
% gmake -C runtime install
|
|
|
|
|
% setenv LLVM_LIB_SEARCH_PATH $CFEINSTALL/bytecode-libs
|
2003-10-23 01:48:33 +00:00
|
|
|
</pre></li>
|
2003-10-21 21:58:38 +00:00
|
|
|
|
|
|
|
|
<li><p>Test the newly-installed C frontend by one or more of the
|
|
|
|
|
following means:</p>
|
|
|
|
|
<ul>
|
2003-10-23 03:55:23 +00:00
|
|
|
<li> compiling and running a "hello, LLVM" program in C and C++.</li>
|
|
|
|
|
<li> running the tests under <tt>test/Programs</tt> using <code>gmake -C
|
2003-10-23 01:48:33 +00:00
|
|
|
test/Programs</code></li>
|
2003-10-21 21:58:38 +00:00
|
|
|
</ul>
|
2003-10-23 01:48:33 +00:00
|
|
|
</p>
|
|
|
|
|
</li>
|
2003-10-21 21:58:38 +00:00
|
|
|
</ol>
|
2003-10-23 01:48:33 +00:00
|
|
|
</div>
|
2003-10-21 21:58:38 +00:00
|
|
|
|
2003-12-18 16:43:17 +00:00
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
<div class="doc_section">
|
|
|
|
|
<a name="license">License Information</a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
<p>
|
|
|
|
|
The LLVM GCC frontend is licensed to you under the GNU General Public License
|
|
|
|
|
and the GNU Lesser General Public License. Please see the files COPYING and
|
|
|
|
|
COPYING.LIB for more details.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
The software also has the following additional copyrights:
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<pre>
|
|
|
|
|
Copyright (c) 1994
|
|
|
|
|
Hewlett-Packard Company
|
|
|
|
|
|
|
|
|
|
Permission to use, copy, modify, distribute and sell this software
|
|
|
|
|
and its documentation for any purpose is hereby granted without fee,
|
|
|
|
|
provided that the above copyright notice appear in all copies and
|
|
|
|
|
that both that copyright notice and this permission notice appear
|
|
|
|
|
in supporting documentation. Hewlett-Packard Company makes no
|
|
|
|
|
representations about the suitability of this software for any
|
|
|
|
|
purpose. It is provided "as is" without express or implied warranty.
|
|
|
|
|
|
|
|
|
|
Copyright (c) 1996, 1997, 1998, 1999
|
|
|
|
|
Silicon Graphics Computer Systems, Inc.
|
|
|
|
|
|
|
|
|
|
Permission to use, copy, modify, distribute and sell this software
|
|
|
|
|
and its documentation for any purpose is hereby granted without fee,
|
|
|
|
|
provided that the above copyright notice appear in all copies and
|
|
|
|
|
that both that copyright notice and this permission notice appear
|
|
|
|
|
in supporting documentation. Silicon Graphics makes no
|
|
|
|
|
representations about the suitability of this software for any
|
|
|
|
|
purpose. It is provided "as is" without express or implied warranty.
|
|
|
|
|
</pre>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- *********************************************************************** -->
|
2003-10-21 21:58:38 +00:00
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
|
2003-10-28 21:09:29 +00:00
|
|
|
<hr>
|
|
|
|
|
<div class="doc_footer">
|
2003-11-12 20:47:30 +00:00
|
|
|
<address>Brian Gaeke</address>
|
2003-10-28 21:09:29 +00:00
|
|
|
<a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
|
|
|
|
|
<br>
|
|
|
|
|
Last modified: $Date$
|
|
|
|
|
</div>
|
2003-10-21 21:58:38 +00:00
|
|
|
|
2003-10-23 01:48:33 +00:00
|
|
|
</body>
|
|
|
|
|
</html>
|
