X-Git-Url: http://plrg.eecs.uci.edu/git/?p=oota-llvm.git;a=blobdiff_plain;f=docs%2FMakefileGuide.html;h=7b4b7552c1dee99631c636d30817a6fc0842fb7f;hp=254f21c9e2e4bdce1a0719cb9c0e2c3b44cd824b;hb=422937113da28615dc16f7abca8b0381c86aa6d5;hpb=d465126f5d4c61318158876ead3e5b7309c8a0e5 diff --git a/docs/MakefileGuide.html b/docs/MakefileGuide.html index 254f21c9e2e..7b4b7552c1d 100644 --- a/docs/MakefileGuide.html +++ b/docs/MakefileGuide.html @@ -30,7 +30,8 @@
  1. Libraries
      -
    1. Bytecode Modules
      2. +
    2. Bitcode Modules
      3. +
    3. Loadable Modules
  2. Tools @@ -89,8 +90,8 @@ Make 3.79, a widely portable makefile processor. LLVM unabashedly makes heavy use of the features of GNU Make so the dependency on GNU Make is firm. If you're not familiar with make, it is recommended that you read the - GNU Makefile Manual - .

    + GNU Makefile + Manual.

    While this document is rightly part of the LLVM Programmer's Manual, it is treated separately here because of the volume of content and because it is often an @@ -237,7 +238,7 @@ LIBRARYNAME = mylib SHARED_LIBRARY = 1 ARCHIVE_LIBRARY = 1 - DONT_BUILT_RELINKED = 1 + DONT_BUILD_RELINKED = 1

    says to build a library named "mylib" with both a shared library (mylib.so) and an archive library (mylib.a) version but @@ -259,11 +260,11 @@ -

    Bytecode Modules
    +
    Bitcode Modules
    -

    In some situations, it is desireable to build a single bytecode module from - a variety of sources, instead of an archive, shared library, or bytecode - library. Bytecode modules can be specified in addition to any of the other +

    In some situations, it is desireable to build a single bitcode module from + a variety of sources, instead of an archive, shared library, or bitcode + library. Bitcode modules can be specified in addition to any of the other types of libraries by defining the MODULE_NAME variable. For example:

    
@@ -272,13 +273,47 @@
       MODULE_NAME = mymod

    will build a module named mymod.bc from the sources in the - directory. This module will be an aggregation of all the bytecode modules - derived from the sources. The example will also build a bytecode archive - containing a bytecode module for each compiled source file. The difference is + directory. This module will be an aggregation of all the bitcode modules + derived from the sources. The example will also build a bitcode archive + containing a bitcode module for each compiled source file. The difference is subtle, but important depending on how the module or library is to be linked.

    + +
    + Loadable Modules +
    +
    +

    In some situations, you need to create a loadable module. Loadable modules + can be loaded into programs like opt or llc to specify + additional passes to run or targets to support. Loadable modules are also + useful for debugging a pass or providing a pass with another package if that + pass can't be included in LLVM.

    +

    LLVM provides complete support for building such a module. All you need to + do is use the LOADABLE_MODULE variable in your Makefile. For example, to + build a loadable module named MyMod that uses the LLVM libraries + LLVMSupport.a and LLVMSystem.a, you would specify:

    + 
    
+     LIBRARYNAME := MyMod
+     LOADABLE_MODULE := 1
+     LINK_COMPONENTS := support system
+
    +

    Use of the LOADABLE_MODULE facility implies several things:

    +
      +
    1. There will be no "lib" prefix on the module. This differentiates it from + a standard shared library of the same name.
      2. +
    2. The SHARED_LIBRARY variable is turned + on.
      3. +
    3. The LINK_LIBS_IN_SHARED variable + is turned on.
      4. +
    4. The DONT_BUILD_RELINKED variable + is turned on.
      5. +
    +

    A loadable module is loaded by LLVM via the facilities of libtool's libltdl + library which is part of lib/System implementation.

    +
    +
    Tools
    @@ -288,7 +323,7 @@ 
    
       TOOLNAME = mytool
       USEDLIBS = mylib
-      LLVMLIBS = LLVMSupport.a LLVMSystem.a
+      LINK_COMPONENTS = support system

    says that we are to build a tool name mytool and that it requires three libraries: mylib, LLVMSupport.a and @@ -317,36 +352,22 @@

    JIT Tools
    -

    Many tools will want to use the JIT features of LLVM. However, getting the - right set of libraries to link with is tedious, platform specific, and error - prone. Additionally, the JIT has special linker switch options that it needs. - Consequently, to make it easier to build tools that use the JIT, you can - use a special value for the LLVMLIBS variable:

    +

    Many tools will want to use the JIT features of LLVM. To do this, you + simply specify that you want an execution 'engine', and the makefiles will + automatically link in the appropriate JIT for the host or an interpreter + if none is available:

    
       TOOLNAME = my_jit_tool
       USEDLIBS = mylib
-      LLVMLIBS = JIT
+      LINK_COMPONENTS = engine
    -

    Using a value of JIT for LLVMLIBS tells the makefile - system to construct a special value for LLVMLIBS that gives the program all - the LLVM libraries needed to run the JIT. Any additional libraries needed can - still be specified with USEDLIBS. To get a full understanding of how - this changes the linker command, it is recommended that you:

    +

    Of course, any additional libraries may be listed as other components. To + get a full understanding of how this changes the linker command, it is + recommended that you:

    
       cd examples/Fibonacci
       make VERBOSE=1
    -

    By default, using LLVMLIBS=JIT will link in enough to support JIT - code generation for the architecture on which the tool is linked. If you need - additional target architectures linked in, you may specify them on the command - line or in your Makefile. For example:

    - 
    
-      ENABLE_X86_JIT=1
-      ENABLE_SPARCV9_JIT=1
-      ENALBE_PPC_JIT=1
-
    -

    will cause the tool to be able to generate code for all three platforms. -

    @@ -605,7 +626,7 @@ files. These sources will be built before any other target processing to ensure they are present.
    BYTECODE_LIBRARY
    -
    If set to any value, causes a bytecode library (.bc) to be built.
    +
    If set to any value, causes a bitcode library (.bc) to be built.
    CONFIG_FILES
    Specifies a set of configuration files to be installed.
    DIRS
    @@ -632,10 +653,11 @@ to the compilers and linkers to ensure that profile data can be collected from the tools built. Use the gprof tool to analyze the output from the profiled tools (gmon.out). -
    ENABLE_ASSERTIONS
    -
    If set to any value, causes the build to enable assertions, even if - building a release or profile build. This is slower than a release build but - far faster than a debug build.
    +
    DISABLE_ASSERTIONS
    +
    If set to any value, causes the build to disable assertions, even if + building a release or profile build. This will exclude all assertion check + code from the build. LLVM will execute faster, but with little help when + things go wrong.
    EXPERIMENTAL_DIRS
    Specify a set of directories that should be built, but if they fail, it should not cause the build to fail. Note that this should only be used @@ -647,7 +669,7 @@
    Specifies a set of symbols to be exported by the linker.
    EXTRA_DIST
    Specifies additional files that should be distributed with LLVM. All - source files, all built sources, all Makefiles, and most documentation files + source files, all built sources, all Makefiles, and most documentation files will be automatically distributed. Use this variable to distribute any files that are not automatically distributed.
    KEEP_SYMBOLS
    @@ -661,6 +683,22 @@
    LIBRARYNAME
    Specify the name of the library to be built. (Required For Libraries)
    +
    LINK_COMPONENTS
    +
    When specified for building a tool, the value of this variable will be + passed to the llvm-config tool to generate a link line for the + tool. Unlike USEDLIBS and LLVMLIBS, not all libraries need + to be specified. The llvm-config tool will figure out the library + dependencies and add any libraries that are needed. The USEDLIBS + variable can still be used in conjunction with LINK_COMPONENTS so + that additional project-specific libraries can be linked with the LLVM + libraries specified by LINK_COMPONENTS
    +
    LINK_LIBS_IN_SHARED
    +
    By default, shared library linking will ignore any libraries specified + with the LLVMLIBS or USEDLIBS. + This prevents shared libs from including things that will be in the LLVM + tool the shared library will be loaded into. However, sometimes it is useful + to link certain libraries into your shared library and this option enables + that feature.
    LLVMLIBS
    Specifies the set of libraries from the LLVM $(ObjDir) that will be linked into the tool or library.
    @@ -671,10 +709,16 @@ setting this variable without also setting SHARED_LIBRARY will have no effect.
    MODULE_NAME
    -
    Specifies the name of a bytecode module to be created. A bytecode +
    Specifies the name of a bitcode module to be created. A bitcode module can be specified in conjunction with other kinds of library builds - or by itself. It constructs from the sources a single linked bytecode + or by itself. It constructs from the sources a single linked bitcode file.
    +
    NO_INSTALL
    +
    Specifies that the build products of the directory should not be + installed but should be built even if the install target is given. + This is handy for directories that build libraries or tools that are only + used as part of the build process, such as code generators (e.g. + tblgen).
    OPTIONAL_DIRS
    Specify a set of directories that may be built, if they exist, but its not an error for them not to exist.
    @@ -746,8 +790,6 @@ not.
    PROJ_SRC_DIR
    The directory which contains the source files to be built.
    -
    BURG
    -
    Specifies the path to the burg tool.
    BZIP2(configured)
    The path to the bzip2 tool.
    CC(configured)
    @@ -766,18 +808,12 @@ isn't one.
    ECHO(configured)
    Specifies the path to the echo tool for printing output.
    -
    ETAGS(configured)
    -
    Specifies the path to the etags tool.
    -
    ETAGSFLAGS(configured)
    -
    Provides flags to be passed to the etags tool.
    EXEEXT(configured)
    Provides the extension to be used on executables built by the makefiles. The value may be empty on platforms that do not use file extensions for executables (e.g. Unix).
    FLEX(configured)
    Specifies the path to the flex tool.
    -
    GCCLD(defaulted)
    -
    Specifies the path to the gccld tool.
    INSTALL(configured)
    Specifies the path to the install tool.
    LDFLAGS(configured)
    @@ -793,12 +829,17 @@
    Specifies the path to the LLVM version of the GCC 'C' Compiler
    LLVMGXX(defaulted)
    Specifies the path to the LLVM version of the GCC C++ Compiler
    -
    LLVM_OBJ_ROOT(configured)
    +
    LLVMLD(defaulted)
    +
    Specifies the path to the LLVM bitcode linker tool
    +
    LLVM_OBJ_ROOT(configured) +
    Specifies the top directory into which the output of the build is placed.
    -
    LLVM_SRC_ROOT(configured)
    +
    LLVM_SRC_ROOT(configured) +
    Specifies the top directory in which the sources are found.
    -
    LLVM_TARBALL_NAME(configured)
    +
    LLVM_TARBALL_NAME + (configured)
    Specifies the name of the distribution tarball to create. This is configured from the name of the project and its version number.
    MKDIR(defaulted)
    @@ -838,9 +879,9 @@
    BuildMode
    The name of the type of build being performed: Debug, Release, or Profile
    -
    bytecode_libdir
    -
    The directory into which bytecode libraries will ultimately be installed. - This value is derived from the --prefix option given to +
    bytecode_libdir
    +
    The directory into which bitcode libraries will ultimately be + installed. This value is derived from the --prefix option given to configure.
    ConfigureScriptFLAGS
    Additional flags given to the configure script when @@ -908,7 +949,6 @@ BCCompile.C BCCompile.CXX BCLinkLib - Burg C.Flags Compile.C CompileCommonOpts @@ -920,7 +960,7 @@ CXX.Flags DependFiles DestArchiveLib - DestBytecodeLib + DestBitcodeLib DestModule DestRelinkedLib DestSharedLib @@ -997,6 +1037,5 @@ The LLVM Compiler Infrastructure
    Last modified: $Date$ -