X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FGettingStarted.html;h=0e871336deb83ca2aa1345113c8439ded797076a;hb=1d33bb310865528f5b1a303e33891366457bc0ef;hp=c502e75df48b4bd270f5d4e7caf78eb677b56928;hpb=fef93b7119f8cda251329e98b613892f2e255bc3;p=oota-llvm.git diff --git a/docs/GettingStarted.html b/docs/GettingStarted.html index c502e75df48..0e871336deb 100644 --- a/docs/GettingStarted.html +++ b/docs/GettingStarted.html @@ -31,6 +31,7 @@
  • Install the GCC Front End
  • Local LLVM Configuration
  • Compiling the LLVM Suite Source Code +
  • Cross-Compiling LLVM
  • The Location of LLVM Object Files
  • Optional Configuration Items
  • @@ -51,6 +52,9 @@
  • An Example Using the LLVM Tool Chain +
      +
    1. Example with llvm-gcc4
    2. +
  • Common Problems
  • Links @@ -80,12 +84,12 @@ basic information.

    First, LLVM comes in two pieces. The first piece is the LLVM suite. This contains all of the tools, libraries, and header files needed to use the low level virtual machine. It contains an assembler, disassembler, bytecode -analyzer, and bytecode optimizer. It also contains a test suite that can be +analyzer and bytecode optimizer. It also contains a test suite that can be used to test the LLVM tools and the GCC front end.

    The second piece is the GCC front end. This component provides a version of GCC that compiles C and C++ code into LLVM bytecode. Currently, the GCC front -end is a modified version of GCC 3.4 (we track the GCC 3.4 development). Once +end uses the GCC parser to convert code to LLVM. Once compiled into LLVM bytecode, a program can be manipulated with the LLVM tools from the LLVM suite.

    @@ -111,76 +115,52 @@ and performance.
  • Read the documentation.
  • Read the documentation.
  • Remember that you were warned twice about reading the documentation.
  • -
  • Install the GCC front end: +
  • Install the GCC front end if you intend to compile C or C++:
    1. cd where-you-want-the-C-front-end-to-live
    2. -
    3. gunzip --stdout cfrontend.platform.tar.gz | tar -xvf - +
    4. gunzip --stdout llvm-gcc.platform.tar.gz | tar -xvf -
    5. -
    6. cd cfrontend/platform
      +
    7. cd llvm-gcc3.4/platform (llvm-gcc3.4 only)
      ./fixheaders
    8. -
    9. Add the cfrontend's "bin" directory to your PATH variable
    10. +
    11. Add llvm-gcc's "bin" directory to your PATH variable.
  • -
  • Get the Source Code +
  • Get the LLVM Source Code
  • -
  • Get the Test Suite Source Code (optional) +
  • [Optional] Get the Test Suite Source Code
  • Configure the LLVM Build Environment
      -
    1. Change directory to where you want to store the LLVM object - files and run configure to configure the Makefiles and - header files for the default platform. Useful options include: +
    2. cd where-you-want-to-build-llvm
    3. +
    4. /path/to/llvm/configure [options]
      + Some common options: +
      • --prefix=directory

        Specify for directory the full pathname of where you - want the LLVM tools and libraries to be installed.

      • + want the LLVM tools and libraries to be installed (default + /usr/local).

      • --with-llvmgccdir=directory

        Optionally, specify for directory the full pathname of the - C/C++ FrontEnd installation to use with this LLVM configuration. If + C/C++ front end installation to use with this LLVM configuration. If not specified, the PATH will be searched.

      • --enable-spec2000=directory

        Enable the SPEC2000 benchmarks for testing. The SPEC2000 @@ -193,7 +173,8 @@ and performance.

        1. gmake -k |& tee gnumake.out    # this is csh or tcsh syntax
        2. -
        3. If you get an "internal compiler error (ICE)" see below.
        4. +
        5. If you get an "internal compiler error (ICE)" or test failures, see + below.
    @@ -229,7 +210,7 @@ software you will need.

    LLVM is known to work on the following platforms:

    - +
    @@ -237,7 +218,7 @@ software you will need.

    - + @@ -247,29 +228,40 @@ software you will need.

    - + - + + + + + + + - + + + + + + - +
    OS Arch
    Linuxx861x861 GCC
    FreeBSDx861x861 GCC
    MacOS X2MacOS X2 PowerPC GCC
    MacOS X2x86GCC
    Cygwin/Win32x861x861,8GCC 3.4.X, binutils 2.15
    MinGW/Win32x861,6,8 GCC 3.4.X, binutils 2.15
    Linuxamd643amd643 GCC

    LLVM has partial support for the following platforms:

    - +
    @@ -277,33 +269,65 @@ software you will need.

    - - + + - + - + + + + + + + + + + + + + + + + +
    OS Arch
    Windowsx861Visual Studio .NET4,5, MinGWx861Visual Studio .NET4,5
    AIX3,4AIX3,4 PowerPC GCC
    Linux3,5Linux3,5 PowerPC GCC
    Linux7AlphaGCC
    Linux7Itanium (IA-64)GCC
    HP-UX7Itanium (IA-64)HP aCC
    -

    -Notes:
    -1 Code generation supported for Pentium processors and up
    -2 Code generation supported for 32-bit ABI only
    -3 No native code generation
    -4 Build is not complete: one or more tools don't link
    -5 The GCC-based C/C++ frontend does not build
    -

    +

    Notes:

    + +
    +
      +
    1. Code generation supported for Pentium processors and +up
    2. +
    3. Code generation supported for 32-bit ABI only
    4. +
    5. No native code generation
    6. +
    7. Build is not complete: one or more tools don't link
    8. +
    9. The GCC-based C/C++ frontend does not build
    10. +
    11. The port is done using the MSYS shell. +Download and install +bison (excl. M4.exe) and flex in that order. Build binutils-2.15 from source, +if necessary. Bison & flex can be also grabbed from GNUWin32 sf.net +project.
    12. +
    13. Native code generation exists but is not complete.
    14. +
    15. Binutils up to post-2.17 has bug in bfd/cofflink.c + preventing LLVM from building correctly. Several workarounds have been + introduced into LLVM build system, but the bug can occur anytime in the + future. We highly recommend that you rebuild your current binutils with the + patch from + Binutils bugzilla, if it wasn't already applied.
    16. +
    +

    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 llvm/tools/Makefile. The Release build requires considerably less space.

    @@ -327,7 +351,7 @@ href="CFEBuildInstrs.html">try to compile it on your platform.

    is the usual name for the software package that LLVM depends on. The Version column provides "known to work" versions of the package. The Notes column describes how LLVM uses the package and provides other details.

    - +
    @@ -339,7 +363,13 @@ href="CFEBuildInstrs.html">try to compile it on your platform.

    - + + + + + + + @@ -350,83 +380,84 @@ href="CFEBuildInstrs.html">try to compile it on your platform.

    - + + + + + + + - + - + - + + + + + + + - + - + - - - - - - - + - - - - - - - +
    PackageVersionNotes
    GCC 3.4.2C/C++ compiler (Note 3)C/C++ compiler1
    TeXinfo4.5For building the CFE
    Bison1.351.28, 1.35, 1.75, 1.875d, 2.0, or 2.1
    (not 1.85 or 1.875)
    YACC compiler
    CVS≥1.11CVS access to LLVM2
    DejaGnu 1.4.2Automated test suite (Note 2)Automated test suite3
    tcl 8.3, 8.4Automated test suite (Note 2)Automated test suite3
    expect 5.38.0Automated test suite (Note 2)Automated test suite3
    perl≥5.6.0Nightly tester, utilities
    GNU M4 1.4Macro processor for configuration (Note 1)Macro processor for configuration4
    GNU Autoconf 2.59Configuration script builder (Note 1)Configuration script builder4
    GNU Automake 1.9.2aclocal macro generator (Note 1)
    perl≥5.6.0Nightly tester, utilitiesaclocal macro generator4
    libtool 1.5.10Shared library manager (Note 1)
    CVS≥1.11CVS access to LLVM (Note 4)Shared library manager4
    -

    Notes:

    +

    Notes:

    + +

    Additionally, your compilation host is expected to have the usual plethora of Unix utilities. Specifically: