Bootstrapping the LLVM C/C++ Front-End

1. A Cautionary Note
   - Building under Cygwin
   - Building under AIX
2. Instructions
3. License Information

Written by Brian R. Gaeke and Chris Lattner

A Cautionary Note

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.

NOTE: This is currently a somewhat fragile, error-prone process, and you should only try to do it if:

1. you really, really, really can't use the binaries we distribute
2. you are an elite GCC hacker.

We welcome patches to help make this process simpler.

Building under Cygwin

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 `/cygdrive/c/llvm` and `/cygdrive/c/llvm-cfrontend`), not in a directory that contains a space (which includes your "home directory", because it lives under the "Documents and Settings" directory). We welcome patches to fix this issue.

It has been found that the GCC 3.3.3 compiler provided with recent Cygwin versions is incapable of compiling the LLVM CFE correctly. If your Cygwin installation includes GCC 3.3.3 we strongly recommend that you download GCC 3.4.3, build it separately, and use it for compiling LLVM CFE. This has been shown to work correctly.

Some versions of Cygwin utilize an experimental version of GNU binutils that will cause the GNU `ld` 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 "`ld --version`" responds with

    GNU ld version 2.15

not with:

    GNU ld version 2.15.91 20040725

Building under AIX

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.

Instructions

1. Configure and build the LLVM libraries and tools. There are two ways to do this: either with objdir == srcdir or not. It is recommended that srcdir not be the same as objdir:

   - With objdir != srcdir:

          % cd objdir
          % srcdir/configure --prefix=/some/path/you/can/install/to [options...]
          % gmake tools-only

   - With objdir == srcdir:

          % cd llvm
          % ./configure --prefix=/some/path/you/can/install/to [options...]
          % gmake tools-only

   This will build all of the LLVM tools and libraries. The `--prefix` 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. `--prefix=/home/user/llvm`).

2. Add the directory containing the tools to your PATH.

        % set path = ( `cd llvm/Debug/bin && pwd` $path )

3. Unpack the C/C++ front-end source into cfrontend/src.

4. Make "build" and "install" directories as siblings of the "src" tree.

        % pwd
        /usr/local/example/cfrontend/src
        % cd ..
        % mkdir build install
        % set CFEINSTALL = `pwd`/install

5. Configure, build, and install the GCC front-end:

   Linux/x86:
   MacOS X/PowerPC (requires dlcompat library):
   AIX/PowerPC:

        % cd build
        % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
          --disable-shared --enable-languages=c,c++ --program-prefix=llvm-
        % gmake all; gmake install

   Cygwin/x86:

        % cd build
        % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
          --disable-shared --enable-languages=c,c++ --disable-c-mbchar \
          --program-prefix=llvm-
        % gmake all; gmake install

   Solaris/SPARC:

   For Solaris/SPARC, LLVM only supports the SPARC V9 architecture. 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. Bug 206).

        % cd build
        % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
          --disable-shared --enable-languages=c,c++ --host=sparcv9-sun-solaris2.8 \
          --disable-c-mbchar --program-prefix=llvm-
        % gmake all; gmake install

   Common Problem: You may get error messages regarding the fact that LLVM does not support inline assembly. Here are two common fixes:

   - Fix 1: 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 `$CFEINSTALL/lib/gcc/target-triplet/3.4-llvm/include`.

   - Fix 2: 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 `src/libstdc++-v3/config/cpu/name-of-cpu/atomicity.h` and apply a patch so that it does not use inline assembly.

   Porting to a new architecture: 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 to the GCC target to get it to work correctly. These include:

   - Often targets include special assembler or linker flags which `gccas`/`gccld` does not understand. In general, these can just be removed.
   - 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".
   - The profiling hooks in GCC do not apply at all to the LLVM front-end. These may need to be disabled.
   - No inline assembly for position independent code. At the LLVM level, everything is position independent.
   - We handle `.init` and `.fini` differently.
   - You may have to disable multilib support in your target. Using multilib support causes the GCC compiler driver to add a lot of "`-L`" options to the link line, which do not relate to LLVM and confuse `gccld`. To disable multilibs, delete any `MULTILIB_OPTIONS` lines from your target files.
   - 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.

6. Put `$CFEINSTALL/bin` into your `PATH` environment variable.

   - sh: `export PATH=$CFEINSTALL/bin:$PATH`
   - csh: `setenv PATH $CFEINSTALL/bin:$PATH`

7. 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.

8. 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 GCC front-end build tree. These are the commands you need.

        % gmake
        % gmake -C runtime install-bytecode

9. Optionally, build a symbol table for the newly installed runtime 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 `llvm-ranlib` tool to do this, as follows:

        % cd $CFEINSTALL/lib
        % llvm-ranlib libiberty.a
        % llvm-ranlib libstdc++.a
        % llvm-ranlib libsupc++.a
        % cd $CFEINSTALL/lib/gcc/target-triplet/3.4-llvm
        % llvm-ranlib libgcc.a
        % llvm-ranlib libgcov.a

10. Test the newly-installed C frontend by one or more of the following means:

    - running the feature & regression tests via `make check`
    - compiling and running a "hello, LLVM" program in C and C++.
    - running the tests found in the `llvm-test` CVS module

License Information

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.

The software also has the following additional copyrights:

    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.