<li><a href="#aix">Building under AIX</a></li>
</ul>
</li>
- <li><a href="#instructions">Instructions</a></li>
+ <li><a href="#instructions">llvm-gcc4 Instructions</a></li>
+ <li><a href="#llvm-gcc3-instructions">llvm-gcc3 Instructions</a></li>
<li><a href="#license">License Information</a></li>
</ol>
<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>
+LLVM C/C++ front-end from its source code. You have to do this, for example, if
+you are porting LLVM to a new architecture or operating system, if you are
+working from Top-Of-Tree CVS/SVN, or if there is no precompiled snapshot
+available.</p>
<p><b>NOTE:</b> This is currently a somewhat fragile, error-prone
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>
+ <li>you want to use the latest bits from CVS.</li>
</ol>
<p>We welcome patches to help make this process simpler.</p>
<!--=========================================================================-->
<div class="doc_text">
-<p>If you are building LLVM and the C front-end under Cygwin, please note that
+<p>If you are building LLVM and the GCC front-end under Cygwin, please note that
the LLVM and GCC makefiles do not correctly handle spaces in paths. To deal
with this issue, make sure that your LLVM and GCC source and build trees are
located in a top-level directory (like <tt>/cygdrive/c/llvm</tt> and
(which includes your "home directory", because it lives under the "Documents
and Settings" directory). We welcome patches to fix this issue.
</p>
+<p>It has been found that the GCC 3.3.3 compiler provided with recent Cygwin
+versions is incapable of compiling the LLVM GCC front-end correctly. If your
+Cygwin
+installation includes GCC 3.3.3, we <i>strongly</i> recommend that you download
+GCC 3.4.3, build it separately, and use it for compiling the LLVM GCC front-end.
+ This has been
+shown to work correctly.</p>
+<p>Some versions of Cygwin utilize an experimental version of GNU binutils that
+will cause the GNU <tt>ld</tt> linker to fail an assertion when linking
+components of the libstdc++. It is recommended that you replace the entire
+binutils package with version 2.15 such that "<tt>ld --version</tt>" responds
+with</p>
+<pre>GNU ld version 2.15</pre>
+not with:<br/>
+<pre>GNU ld version 2.15.91 20040725</pre>
</div>
<!--=========================================================================-->
-<div class="doc_subsection">
- <a name="aix">Building under AIX</a>
-</div>
-<!--=========================================================================-->
-
+<div class="doc_subsection"><a name="aix">Building under AIX</a></div>
<div class="doc_text">
-<p>If you are building LLVM and the C front-end under AIX, do NOT use GNU
+<p>If you are building LLVM and the GCC front-end under AIX, do NOT use GNU
Binutils. They are not stable under AIX and may produce incorrect and/or
invalid code. Instead, use the system assembler and linker.
</p>
<!-- *********************************************************************** -->
<div class="doc_section">
- <a name="instructions">Instructions</a>
+ <a name="instructions">llvm-gcc4 Instructions</a>
</div>
<!-- *********************************************************************** -->
<div class="doc_text">
-<p>
+
+<p>This section describes how to aquire and build llvm-gcc4, which is based on
+the GCC 4.0.1 front-end. This front-end supports C, C++, Objective-C, and
+Objective-C++. Note that the instructions for building this front-end are
+completely different than those for building llvm-gcc3.
+</p>
+
<ol>
-<li><p>Configure and build the LLVM libraries and tools using:</p>
-<pre>
+<li>
+<p>Retrieve the appropriate llvm-gcc4-x.y.source.tar.gz archive from the llvm
+web site.</p>
+<p>It is also possible to download the sources of the llvm-gcc4 front end from
+a read-only mirror using subversion. To check out the code the first time use:
+</p>
+
+<tt>svn co svn://anonsvn.opensource.apple.com/svn/llvm <i>dst-directory</i></tt>
+
+<p>After that, the code can be be updated in the destination directory using;
+</p>
+
+<tt>svn update</tt>
+
+<p>The mirror is brought up to date every evening.</p>
+</li>
+
+<li>Follow the directions in the top-level README.LLVM file for up-to-date
+ instructions on how to build llvm-gcc4.</li>
+</ol>
+</div>
+
+<!-- *********************************************************************** -->
+<div class="doc_section">
+ <a name="llvm-gcc3-instructions">llvm-gcc3 Instructions</a>
+</div>
+<!-- *********************************************************************** -->
+
+<div class="doc_text">
+<ol>
+<li>Aquire llvm-gcc3 from <a href="GettingStarted.html#checkout">LLVM CVS</a> or
+from a <a href="http://llvm.org/releases/">release tarball</a>.</li>
+
+<li><p>Configure and build the LLVM libraries and tools. There are two ways to
+do this: either with <i>objdir</i> == <i>srcdir</i> or
+<i>objdir</i> != <i>srcdir</i>. It is recommended
+that <i>srcdir</i> be the same as <i>objdir</i> for your LLVM tree (but note
+that you should always use <i>srcdir</i> != <i>objdir</i> for llvm-gcc):</p>
+<ul>
+ <li>With <i>objdir</i> != <i>srcdir</i>:<pre>
+ % cd <i>objdir</i>
+ % <i>srcdir</i>/configure --prefix=/some/path/you/can/install/to [options...]
+ % gmake tools-only
+ </pre></li>
+ <li>With <i>objdir</i> == <i>srcdir</i>:<pre>
% cd llvm
- % ./configure [options...]
+ % ./configure --prefix=/some/path/you/can/install/to [options...]
% gmake tools-only
-</pre>
- <p>This will build all of the LLVM tools and libraries.</p></li>
+ </pre></li>
+</ul>
+<p>This will build all of the LLVM tools and libraries. The <tt>--prefix</tt>
+option defaults to /usr/local (per configure standards) but unless you are a
+system administrator, you probably won't be able to install LLVM there because
+of permissions. Specify a path into which LLVM can be installed (e.g.
+<tt>--prefix=/home/user/llvm</tt>).</p>
+</li>
<li><p>Add the directory containing the tools to your PATH.</p>
<pre>
- % set path = ( `cd llvm/tools/Debug && pwd` $path )
+ % set path = ( `cd llvm/Debug/bin && pwd` $path )
</pre></li>
-<li><p>Unpack the C/C++ front-end source into cfrontend/src.</p></li>
+<li><p>Unpack the C/C++ front-end source into cfrontend/src, either by
+ untar'ing a cfrontend.source.tar.gz file or checking out CVS into this
+ directory.</p></li>
-<li><p>Make "build" and "install" directories as siblings of the "src" tree.</p>
+<li><p>Make "build" and "install" directories as siblings of the "src" tree:</p>
<pre>
% pwd
/usr/local/example/cfrontend/src
</pre></li>
-<li><p>Configure, build, and install the C front-end:</p>
+<li><p>Configure, build, and install the GCC front-end:</p>
<p>
<b>Linux/x86:</b><br>
+<b>Linux/IA-64:</b><br>
<b>MacOS X/PowerPC</b> (requires dlcompat library):<br>
<b>AIX/PowerPC:</b>
</p>
<pre>
% cd build
% ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
- --disable-shared --enable-languages=c,c++
- % gmake
- % setenv LLVM_LIB_SEARCH_PATH `pwd`/gcc
+ --disable-shared --enable-languages=c,c++ --program-prefix=llvm-
% gmake all; gmake install
</pre>
<pre>
% cd build
% ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
- --disable-shared --enable-languages=c,c++ --disable-c-mbchar
- % gmake
- % setenv LLVM_LIB_SEARCH_PATH `pwd`/gcc
+ --disable-shared --enable-languages=c,c++ --disable-c-mbchar \
+ --program-prefix=llvm-
% gmake all; gmake install
</pre>
<p><b>Solaris/SPARC:</b></p>
<p>
-For Solaris/SPARC, LLVM only supports the SPARC V9. Therefore, the
-configure command line should specify sparcv9, as shown below. Also,
+The GCC front-end can be configured for either SPARC V8 (32 bit) or SPARC V9 (64
+bit). This changes, among other things, the sizes of integer types and the
+macros defined for conditional compilation.
+</p>
+
+<p>
+The SPARC V8 ABI support is more robust than the V9 ABI support and can generate
+SPARC V9 code. It is highly recommended that you use the V8 ABI with LLVM, 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>).
+--disable-c-mbchar (cf. <a href="http://llvm.org/PR206">Bug 206</a>).
</p>
<pre>
% cd build
% ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
- --disable-shared --enable-languages=c,c++ --host=sparcv9-sun-solaris2.8 \
- --disable-c-mbchar
- % gmake
- % setenv LLVM_LIB_SEARCH_PATH `pwd`/gcc
+ --disable-shared --enable-languages=c,c++ --host=sparc-sun-solaris2.8 \
+ --disable-c-mbchar --program-prefix=llvm-
% gmake all; gmake install
</pre>
<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
+ assembly and install the modified versions in
<code>$CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm/include</code>.</li>
<li><b>Fix 2:</b> If you are building the C++ front-end on a CPU we
and apply a patch so that it does not use inline assembly.</li>
</ul>
- <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>
+ <p><b>Porting to a new architecture:</b> If you are porting the front-end
+ to a new architecture or compiling in a configuration that we have
+ not tried previously, there are probably several changes you will have to make
+ t
o the GCC target to get it to work correctly. These include:<p>
<ul>
- <li>Often targets include special or assembler linker flags which
+ <li>Often targets include special assembler or 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
</ul>
</li>
-<li><p>Go back into the LLVM source tree proper. Rerun configure, using
-the <code>--with-llvmgccdir=$CFEINSTALL</code> option to specify the path
-to the newly built C front-end.</p></li>
+<li><p>Put <tt>$CFEINSTALL/bin</tt> into your <tt>PATH</tt> environment
+variable.</p>
+ <ul>
+ <li>sh: <tt>export PATH=$CFEINSTALL/bin:$PATH</tt></li>
+ <li>csh: <tt>setenv PATH $CFEINSTALL/bin:$PATH</tt></li>
+ </ul>
+</li>
-<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
-<code>$CFEINSTALL/bin/gcc --print-libgcc-file-name</code>.)</p></li>
+<li><p>Go back into the LLVM source tree proper. Rerun configure, using
+the same options as the last time. This will cause the configuration to now find
+the newly built llvm-gcc and llvm-g++ executables. </p></li>
<li><p>Rebuild your CVS tree. This shouldn't cause the whole thing to be
rebuilt, but it should build the runtime libraries. After the tree is
- built, install the runtime libraries into your C front-end build tree.
- These are the commands you need.</p>
+ built, install the runtime libraries into your GCC front-end build tree.
+ These are the commands you need:</p>
<pre>
% gmake
- % mkdir $CFEINSTALL/bytecode-libs
- % gmake -C runtime install
- % setenv LLVM_LIB_SEARCH_PATH $CFEINSTALL/bytecode-libs
+ % gmake -C runtime install-bytecode
</pre></li>
<li><p>Optionally, build a symbol table for the newly installed runtime
-libraries. Although this step is optional, you are encouraged to do this as the
-symbol tables will make a significant difference in your link times. Use
-the <tt>llvm-ranlib</tt> tool to do this, as follows:</p>
+libraries. Although this step is optional, you are strongly encouraged to
+do this as the symbol tables will make a significant difference in your
+link times. Use the <tt>llvm-ranlib</tt> tool to do this, as follows:</p>
<pre>
% cd $CFEINSTALL/lib
% llvm-ranlib libiberty.a
% llvm-ranlib libstdc++.a
- % llvm-ranlib libsubc++.a
- % cd $CFEINSTALL/lib/<i>target-triplet</i>/3.4-llvm
+ % llvm-ranlib libsupc++.a
+ % cd $CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm
% llvm-ranlib libgcc.a
% llvm-ranlib libgcov.a
</pre>
<li><p>Test the newly-installed C frontend by one or more of the
following means:</p>
<ul>
+ <li> running the feature & regression tests via <tt>make check</tt></li>
<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
- test/Programs</code></li>
+ <li> running the tests found in the <tt>llvm-test</tt> CVS module</li>
</ul></li>
</ol>
</div>
</p>
<p>
-The software also has the following additional copyrights:
+More information is <a href="FAQ.html#license">available in the FAQ</a>.
</p>
-
-<pre>
-
-Copyright (c) 2003, 2004 University of Illinois at Urbana-Champaign.
-All rights reserved.
-
-Developed by:
-
- LLVM Team
-
- University of Illinois at Urbana-Champaign
-
- http://llvm.cs.uiuc.edu
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE
-SOFTWARE.
-
-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>
src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
Brian Gaeke<br>
- <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
+ <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
Last modified: $Date$
</address>
projects / oota-llvm.git / blobdiff