X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FGettingStarted.html;h=b75b1c654a69afe7e28d7bb36796f0d2a9a95692;hb=bdd57371bc8af531259bdc2820abcec5d23cd19c;hp=40f51fe2af9541a3239a00e61d9570a5eab84bda;hpb=9474d019eeea89070536024302131357dc7f88cb;p=oota-llvm.git diff --git a/docs/GettingStarted.html b/docs/GettingStarted.html index 40f51fe2af9..b75b1c654a6 100644 --- a/docs/GettingStarted.html +++ b/docs/GettingStarted.html @@ -114,13 +114,15 @@ and performance.
  • Read the documentation.
  • Read the documentation.
  • Remember that you were warned twice about reading the documentation.
  • -
  • Install the llvm-gcc4.2 front end if you intend to compile C or C++: +
  • Install the llvm-gcc-4.2 front end if you intend to compile C or C++ + (see Install the GCC Front End for details):
    1. cd where-you-want-the-C-front-end-to-live
    2. -
    3. gunzip --stdout llvm-gcc.platform.tar.gz | tar -xvf - -
    4. -
    5. Note: If the binary extension is ".bz" use bunzip2 instead of gunzip.
    6. -
    7. Add llvm-gcc's "bin" directory to your PATH variable.
    8. +
    9. gunzip --stdout llvm-gcc-4.2-version-platform.tar.gz | tar -xvf -
    10. +
    11. install-binutils-binary-from-MinGW (Windows only)
    12. +
    13. Note: If the binary extension is ".bz" use bunzip2 instead of gunzip.
    14. +
    15. Note: On Windows, use 7-Zip or a similar archiving tool.
    16. +
    17. Add llvm-gcc's "bin" directory to your PATH environment variable.
  • Get the LLVM Source Code @@ -159,7 +161,8 @@ and performance.
  • --with-llvmgccdir=directory

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

  • + not specified, the PATH will be searched. This is only needed if you + want to run the testsuite or do some special kinds of LLVM builds.

  • --enable-spec2000=directory

    Enable the SPEC2000 benchmarks for testing. The SPEC2000 benchmarks should be available in @@ -214,11 +217,21 @@ software you will need.

    Arch Compilers + + AuroraUX + x861 + GCC + Linux x861 GCC + + Linux + amd64 + GCC + Solaris V9 (Ultrasparc) @@ -238,22 +251,18 @@ software you will need.

    MacOS X2,9 x86 GCC - Cygwin/Win32 - x861,8 - GCC 3.4.X, binutils 2.15 + x861,8, + 11 + GCC 3.4.X, binutils 2.20 MinGW/Win32 - x861,6,8 - GCC 3.4.X, binutils 2.15 - - - Linux - amd64 - GCC + x861,6, + 8, 10 + GCC 3.4.X, binutils 2.20 @@ -307,32 +316,32 @@ up
  • No native code generation
  • Build is not complete: one or more tools do not link or function
  • The GCC-based C/C++ frontend does not build
  • -
  • 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.
  • +
  • The port is done using the MSYS shell.
  • Native code generation exists but is not complete.
  • -
  • 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.
  • +
  • Binutils 2.20 or later is required to build the assembler + generated by LLVM properly.
  • XCode 2.5 and gcc 4.0.1 (Apple Build 5370) will trip internal LLVM assert messages when compiled for Release at optimization levels greater than 0 (i.e., "-O1" and higher). Add OPTIMIZE_OPTION="-O0" to the build command line if compiling for LLVM Release or bootstrapping the LLVM toolchain.
  • +
  • For MSYS/MinGW on Windows, be sure to install the MSYS + version of the perl package, and be sure it appears in your path + before any Windows-based versions such as Strawberry Perl and + ActivePerl, as these have Windows-specifics that will cause the + build to fail.
  • +
  • In general, LLVM modules requiring dynamic linking can + not be built on Windows. However, you can build LLVM tools using + "make tools-only".
  • Note that you will need about 1-3 GB of space for a full LLVM build in Debug 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.

    +tools). If you do not need many of the tools and you are space-conscious, you +can pass ONLY_TOOLS="tools you need" to make. The Release build +requires considerably less space.

    The LLVM suite may compile on other platforms, but it is not guaranteed to do so. If compilation is successful, the LLVM utilities should be @@ -375,18 +384,6 @@ href="GCCFEBuildInstrs.html">try to compile it on your platform.

    For building the CFE - - Flex - 2.5.4 - LEX compiler - - - - Bison - 1.28, 1.35, 1.75, 1.875d, 2.0, or 2.1
    (not 1.85 or 1.875) - YACC compiler - - SVN ≥1.3 @@ -425,19 +422,19 @@ href="GCCFEBuildInstrs.html">try to compile it on your platform.

    GNU Autoconf - 2.59 + 2.60 Configuration script builder4 GNU Automake - 1.9.2 + 1.9.6 aclocal macro generator4 libtool - 1.5.10 + 1.5.22 Shared library manager4 @@ -455,8 +452,8 @@ href="GCCFEBuildInstrs.html">try to compile it on your platform.

  • Only needed if you want to run the automated test suite in the llvm/test directory.
  • 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 + you will need GNU autoconf (2.60), and consequently, GNU M4 (version 1.4 + or higher). You will also need automake (1.9.6). We only use aclocal from that package.
  • @@ -560,7 +557,13 @@ to miscompile parts of LLVM 2.4. One symptom is ValueSymbolTable complaining about symbols remaining in the table on destruction.

    GCC 4.1.2 20071124 (Red Hat 4.1.2-42): Suffers from the same symptoms as the previous one. It appears to work with ENABLE_OPTIMIZED=0 (the default).

    - +

    Cygwin GCC 4.3.2 20080827 (beta) 2: + Users reported various problems related + with link errors when using this GCC version.

    +

    Debian GCC 4.3.2 on X86: Crashes building some files in LLVM 2.6.

    +

    GCC 4.3.3 (Debian 4.3.3-10) on ARM: Miscompiles parts of LLVM 2.6 +when optimizations are turned on. The symptom is an infinite loop in +FoldingSetImpl::RemoveNode while running the code generator.

    GNU ld 2.16.X. Some 2.16.X versions of the ld linker will produce very long warning messages complaining that some ".gnu.linkonce.t.*" symbol was defined in a discarded section. You can safely ignore these messages as they are @@ -572,6 +575,12 @@ href="http://sourceware.org/bugzilla/show_bug.cgi?id=3111">a bug which causes huge link times (minutes instead of seconds) when building LLVM. We recommend upgrading to a newer version (2.17.50.0.4 or later).

    +

    GNU Binutils 2.19.1 Gold: This version of Gold contained +a bug +which causes intermittent failures when building LLVM with position independent +code. The symptom is an error about cyclic dependencies. We recommend +upgrading to a newer version of Gold.

    + @@ -677,12 +686,12 @@ compressed with the gzip program.
    llvm-test-x.y.tar.gz
    Source release for the LLVM test suite.
    -
    llvm-gcc4-x.y.source.tar.gz
    -
    Source release of the llvm-gcc4 front end. See README.LLVM in the root +
    llvm-gcc-4.2-x.y.source.tar.gz
    +
    Source release of the llvm-gcc-4.2 front end. See README.LLVM in the root directory for build instructions.
    -
    llvm-gcc4-x.y-platform.tar.gz
    -
    Binary release of the llvm-gcc4 front end for a specific platform.
    +
    llvm-gcc-4.2-x.y-platform.tar.gz
    +
    Binary release of the llvm-gcc-4.2 front end for a specific platform.
    @@ -696,7 +705,7 @@ compressed with the gzip program.

    If you have access to our Subversion repository, you can get a fresh copy of -the entire source code. All you need to do is check it out from Subvresion as +the entire source code. All you need to do is check it out from Subversion as follows:

    -

    It is possible to cross-compile LLVM. That is, you can create LLVM - executables and libraries for a platform different than the one one which you - are compiling. To do this, a few additional steps are - required. 1 To cross-compile LLVM, use - these instructions:

    -
      -
    1. Configure and build LLVM as a native compiler. You will need - just TableGen from that build. -
        -
      • If you have $LLVM_OBJ_ROOT=$LLVM_SRC_ROOT just execute - make -C utils/TableGen after configuring.
      • -
      • Otherwise you will need to monitor building process and terminate - it just after TableGen was built.
      • -
      -
    2. -
    3. Copy the TableGen binary to somewhere safe (out of your build tree). -
    4. -
    5. Configure LLVM to build with a cross-compiler. To do this, supply the - configure script with --build and --host options that - are different. The values of these options must be legal target triples - that your GCC compiler supports.
    6. -
    7. Put the saved TableGen executable into the - into $LLVM_OBJ_ROOT/{BUILD_TYPE}/bin directory (e.g. into - .../Release/bin for a Release build).
    8. -
    9. Build LLVM as usual.
    10. -
    -

    The result of such a build will produce executables that are not executable - on your build host (--build option) but can be executed on your compile host +

    It is possible to cross-compile LLVM itself. That is, you can create LLVM + executables and libraries to be hosted on a platform different from the + platform where they are build (a Canadian Cross build). To configure a + cross-compile, supply the configure script with --build and + --host options that are different. The values of these options must + be legal target triples that your GCC compiler supports.

    + +

    The result of such a build is executables that are not runnable on + on the build host (--build option) but can be executed on the compile host (--host option).

    -

    Notes:

    -
    -
      -
    1. Cross-compiling was tested only with Linux as - build platform and Windows as host using mingw32 cross-compiler. Other - combinations have not been tested.
    2. -
    -
    @@ -1113,13 +1137,13 @@ platforms or configurations using the same source tree.

    named after the build type:

    -
    Debug Builds +
    Debug Builds with assertions enabled (the default)
    Tools -
    OBJ_ROOT/Debug/bin +
    OBJ_ROOT/Debug+Asserts/bin
    Libraries -
    OBJ_ROOT/Debug/lib +
    OBJ_ROOT/Debug+Asserts/lib


    @@ -1162,19 +1186,24 @@ first command may not be required if you are already using the module):

     $ 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::BC::/path/to/lli:' > /proc/sys/fs/binfmt_misc/register
     $ chmod u+x hello.bc   (if needed)
     $ ./hello.bc
     

    -This allows you to execute LLVM bitcode files directly. Thanks to Jack -Cummings for pointing this out! +This allows you to execute LLVM bitcode files directly. On Debian, you +can also use this command instead of the 'echo' command above:

    +
    +
    +$ sudo update-binfmts --install llvm /path/to/lli --magic 'BC'
    +
    +
    @@ -1340,7 +1369,7 @@ end to compile.

    The tools directory contains the executables built out of the libraries above, which form the main part of the user interface. You can -always get help for a tool by typing tool_name --help. The +always get help for a tool by typing tool_name -help. The following is a brief introduction to the most important tools. More detailed information is in the Command Guide.

    @@ -1411,7 +1440,7 @@ information is in the Command Guide.

    opt
    opt reads LLVM bitcode, applies a series of LLVM to LLVM transformations (which are specified on the command line), and then outputs - the resultant bitcode. The 'opt --help' command is a good way to + the resultant bitcode. The 'opt -help' command is a good way to get a list of the program transformations available in LLVM.
    opt can also be used to run a specific analysis on an input LLVM bitcode file and print out the results. It is primarily useful for @@ -1499,7 +1528,7 @@ are code generators for parts of LLVM infrastructure.

    This section gives an example of using LLVM. llvm-gcc3 is now obsolete, -so we only include instructiosn for llvm-gcc4. +so we only include instructions for llvm-gcc4.

    Note: The gcc4 frontend's invocation is considerably different