X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FGettingStarted.html;h=890d8f8422dcf6faa3bee3319fdd676f48635956;hb=f0390dfbc4748448700c6eaf533aef5a2993753e;hp=bcf36c38c77af2c1fe226c896f4730cb7134f87d;hpb=64270d5d4638dbda271d7ccb945ebbb34e9ab572;p=oota-llvm.git diff --git a/docs/GettingStarted.html b/docs/GettingStarted.html index bcf36c38c77..890d8f8422d 100644 --- a/docs/GettingStarted.html +++ b/docs/GettingStarted.html @@ -114,13 +114,12 @@ and performance.
  • Read the documentation.
  • Read the documentation.
  • Remember that you were warned twice about reading the documentation.
    • -
  • Install the llvm-gcc4.0 (or 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++:
    1. cd where-you-want-the-C-front-end-to-live
      2. -
    2. gunzip --stdout llvm-gcc.platform.tar.gz | tar -xvf - +
    3. gunzip --stdout llvm-gcc-4.2-version-platform.tar.gz | tar -xvf -
      4. - +
    4. Note: If the binary extension is ".bz" use bunzip2 instead of gunzip.
    5. Add llvm-gcc's "bin" directory to your PATH variable.
    • @@ -160,7 +159,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 @@ -215,11 +215,21 @@ software you will need.

    Arch Compilers + + AuroraUX + x861 + GCC + Linux x861 GCC + + Linux + amd64 + GCC + Solaris V9 (Ultrasparc) @@ -236,10 +246,9 @@ software you will need.

    GCC - MacOS X2 + MacOS X2,9 x86 GCC - Cygwin/Win32 @@ -248,14 +257,10 @@ software you will need.

    MinGW/Win32 - x861,6,8 + x861,6, + 8, 10 GCC 3.4.X, binutils 2.15 - - Linux - amd643 - GCC -

    LLVM has partial support for the following platforms:

    @@ -269,7 +274,7 @@ software you will need.

    Windows x861 - Visual Studio .NET4,5 + Visual Studio 2005 SP1 or higher4,5 AIX3,4 PowerPC @@ -306,13 +311,9 @@ software you will need.

    up
  • Code generation supported for 32-bit ABI only
  • No native code generation
    • -
  • Build is not complete: one or more tools don't link
    • +
  • 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 @@ -320,15 +321,25 @@ project.
    • future. We highly recommend that you rebuild your current binutils with the patch from Binutils bugzilla, if it wasn't already applied. +
  • 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.

    • 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 @@ -338,7 +349,7 @@ on your platform.

    The GCC front end is not very portable at the moment. If you want to get it to work on another platform, you can download a copy of the source and try to compile it on your platform.

    +href="GCCFEBuildInstrs.html">try to compile it on your platform.

    @@ -371,18 +382,6 @@ href="CFEBuildInstrs.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 @@ -421,19 +420,19 @@ href="CFEBuildInstrs.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 @@ -510,14 +509,15 @@ of GCC you are using. problems in the STL that effectively prevent it from compiling LLVM.

    -

    GCC 3.2.2: This version of GCC fails to compile LLVM.

    +

    GCC 3.2.2 and 3.2.3: These versions of GCC fails to compile LLVM with +a bogus template error. This was fixed in later GCCs.

    GCC 3.3.2: This version of GCC suffered from a serious bug which causes it to crash in the "convert_from_eh_region_ranges_1" GCC function.

    Cygwin GCC 3.3.3: The version of GCC 3.3.3 commonly shipped with - Cygwin does not work. Please upgrade + Cygwin does not work. Please upgrade to a newer version if possible.

    SuSE GCC 3.3.3: The version of GCC 3.3.3 shipped with SuSE 9.1 (and possibly others) does not compile LLVM correctly (it appears that exception @@ -550,6 +550,18 @@ the "convert_from_eh_region_ranges_1" GCC function.

    portions of its testsuite.

    GCC 4.1.2 on OpenSUSE: Seg faults during libstdc++ build and on x86_64 platforms compiling md5.c gets a mangled constant.

    +

    GCC 4.1.2 (20061115 (prerelease) (Debian 4.1.1-21)) on Debian: Appears +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 @@ -561,6 +573,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.

    + @@ -661,24 +679,20 @@ compressed with the gzip program.

    The files are as follows, with x.y marking the version number:

    llvm-x.y.tar.gz
    -
    Source release for the LLVM libraries and tools.
    +
    Source release for the LLVM libraries and tools.
    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 - directory for build instructions.
    +
    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.
    -

    It is also possible to download the sources of the llvm-gcc4 front end from a -read-only subversion mirror at -svn://anonsvn.opensource.apple.com/svn/llvm/trunk.

    - @@ -689,7 +703,7 @@ svn://anonsvn.opensource.apple.com/svn/llvm/trunk.

    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:

    @@ -754,14 +772,14 @@ instructions to successfully get and build the LLVM GCC front-end.

    Before configuring and compiling the LLVM suite, you can optionally extract the LLVM GCC front end from the binary distribution. It is used for running the llvm-test testsuite and for compiling C/C++ programs. Note that you can optionally -build llvm-gcc yourself after building the +build llvm-gcc yourself after building the main LLVM repository.

    To install the GCC front end, do the following:

    1. cd where-you-want-the-front-end-to-live
      2. -
    2. gunzip --stdout llvmgcc-version.platform.tar.gz | tar -xvf +
    3. gunzip --stdout llvm-gcc-4.2-version-platform.tar.gz | tar -xvf -
    @@ -779,7 +797,7 @@ file, not "fix" a header file that needs to be fixed for GCC, or it may be linked with libraries not available on your system.

    In cases like these, you may want to try building the GCC front end from source. This is +href="GCCFEBuildInstrs.html">building the GCC front end from source. This is much easier now than it was in the past.

    @@ -834,7 +852,7 @@ script to configure the build system:

    will fail as these libraries require llvm-gcc and llvm-g++. See Install the GCC Front End for details on installing the C/C++ Front End. See - Bootstrapping the LLVM C/C++ Front-End + Bootstrapping the LLVM C/C++ Front-End for details on building the C/C++ Front End.
    --with-tclinclude
    Path to the tcl include directory under which tclsh can be @@ -847,9 +865,11 @@ script to configure the build system:

    --enable-optimized
    - Enables optimized compilation by default (debugging symbols are removed - and GCC optimization flags are enabled). The default is to use an - unoptimized build (also known as a debug build). + Enables optimized compilation (debugging symbols are removed + and GCC optimization flags are enabled). Note that this is the default + setting if you are using the LLVM distribution. The default behavior + of an Subversion checkout is to use an unoptimized build (also known as a + debug build).

    --enable-debug-runtime
    @@ -872,7 +892,7 @@ script to configure the build system:

    native compiler (no cross-compiler targets available). The "native" target is selected as the target of the build host. You can also specify a comma separated list of target names that you want available in llc. The target - names use all lower case. The current set of targets is:
    + names use all lower case. The current set of targets is:
    alpha, ia64, powerpc, skeleton, sparc, x86.

    --enable-doxygen
    @@ -917,10 +937,12 @@ builds:

    Debug Builds
    - These builds are the default when one types gmake (unless the - --enable-optimized option was used during configuration). The - build system will compile the tools and libraries with debugging - information. + These builds are the default when one is using an Subversion checkout and + types gmake (unless the --enable-optimized option was + used during configuration). The build system will compile the tools and + libraries with debugging information. To get a Debug Build using the + LLVM distribution the --disable-optimized option must be passed + to configure.

    Release (Optimized) Builds @@ -930,6 +952,7 @@ builds:

    gmake command line. For these builds, the build system will compile the tools and libraries with GCC optimizations enabled and strip debugging information from the libraries and executables it generates. + Note that Release Builds are default when using an LLVM distribution.

    Profile Builds @@ -1006,6 +1029,11 @@ declaring variables on the command line. The following are some examples:

    Perform a Release (Optimized) build without assertions enabled.

    + +
    gmake ENABLE_OPTIMIZED=0 +
    + Perform a Debug build. +

    gmake ENABLE_PROFILING=1
    @@ -1036,43 +1064,16 @@ that directory that is out of date.

    -

    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. -
    2. Copy the TableGen binary to somewhere safe (out of your build tree). -
      3. -
    3. 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.
      4. -
    4. Put the saved TableGen executable into the - into $LLVM_OBJ_ROOT/{BUILD_TYPE}/bin directory (e.g. into - .../Release/bin for a Release build).
      5. -
    5. Build LLVM as usual.
      6. -
    -

    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. -
    -
    @@ -1283,8 +1284,7 @@ different tools.

    This directory contains projects that are not strictly part of LLVM but are shipped with LLVM. This is also the directory where you should create your own LLVM-based projects. See llvm/projects/sample for an example of how - to set up your own project. See llvm/projects/Stacker for a fully - functional example of a compiler front end.

    + to set up your own project.

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

    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 - get a list of the program transformations available in LLVM.
    + 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 debugging analyses, or familiarizing yourself with what an analysis does.
    @@ -1490,7 +1490,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 @@ -1608,7 +1608,7 @@ Asked Questions page.

    -

    This document is just an introduction to how to use LLVM to do +

    This document is just an introduction on how to use LLVM to do some simple things... there are many more interesting and complicated things that you can do that aren't documented here (but we'll gladly accept a patch if you want to write something up!). For more information about LLVM, check @@ -1628,9 +1628,9 @@ out:

    Valid CSS! + src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"> Valid HTML 4.01! + src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"> Chris Lattner
    Reid Spencer