X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FUsingLibraries.html;h=af57907ef66a730bbc6977265999d2afb5a862fe;hb=17bcde9f9b18e1076a9f20d1dcd3b4a8e9985352;hp=d41b146836446377f98c8f37cf0e4e83fd38f21e;hpb=4148266c9dda70ee08cdfe5043e250a8019f97f6;p=oota-llvm.git diff --git a/docs/UsingLibraries.html b/docs/UsingLibraries.html index d41b1468364..af57907ef66 100644 --- a/docs/UsingLibraries.html +++ b/docs/UsingLibraries.html @@ -1,5 +1,4 @@ - + Using The LLVM Libraries @@ -11,6 +10,7 @@
  • Abstract
  • Introduction
  • Library Descriptions
    • +
  • Library Dependencies
  • Linkage Rules Of Thumb
    1. Always link LLVMCore, LLVMSupport, LLVMSystem @@ -23,6 +23,8 @@

      Written by Reid Spencer

      +

      Warning: This document is out of date, please see llvm-config for more information.

      +
      Abstract
      @@ -31,8 +33,10 @@ tools. In addition to the LLVM tool set, the functionality of LLVM is available through a set of libraries. To use LLVM as a toolkit for constructing tools, a developer needs to understand what is contained in the - various libraries, what they depend on, and how to use them. This document - describes the contents of the libraries and how and when to use them. + various libraries, what they depend on, and how to use them. Fortunately, + there is a tool, llvm-config to aid with this. This document + describes the contents of the libraries and how to use llvm-config + to generate command line options.

      @@ -42,20 +46,20 @@

      If you're writing a compiler, virtual machine, or any other utility based on LLVM, you'll need to figure out which of the many libraries files you will need to link with to be successful. An understanding of the contents of these - files and their inter-relationships will be useful in coming up with an optimal - specification for the libraries to link with. The purpose of this document is - to reduce some of the trial and error that the author experienced in using - LLVM.

      + libraries will be useful in coming up with an optimal specification for the + libraries to link with. The purpose of this document is to reduce some of + the trial and error that the author experienced in using LLVM.

      LLVM produces two types of libraries: archives (ending in .a) and objects (ending in .o). However, both are libraries. Libraries ending in .o are known as re-linked libraries because they contain all the compilation units of the library linked together as a single .o file. - Furthermore, many of the libraries have both forms of library. The + Furthermore, several of the libraries have both forms of library. The re-linked libraries are used whenever you want to include all symbols from the library. The archive libraries are used whenever you want to only resolve outstanding symbols at that point in the link without including everything in the library.

      -

      When linking your tools, you will use the LLVMLIBS make variable. +

      If you're using the LLVM Makefile system to link your tools,you will use + the LLVMLIBS make variable. (see the Makefile Guide for details). This variable specifies which LLVM libraries to link into your tool and the order in which they will be linked. You specify re-linked libraries by @@ -71,84 +75,337 @@

      The table below categorizes each library - - - - - - - - - - + + + + + + + + + + + + + + + + - - - - + + + + - - + + - + - + - - + + - + - + - - - - - - + + - + + + - + + + + + + + - - - - - - - - - - - - - - - - + + + + - + - + - + - + - -
      LibraryFormsDescription
      Core Libraries
      LLVMAsmParser.oLLVM Assembly Parsing
      LLVMBCReader.oLLVM Bytecode Reading
      LLVMBCWriter.oLLVM Bytecode Writing
      LLVMDebugger.oSource Level Debugging Support
      LLVMSupport.a .o
      Core Libraries
      LLVMArchive.aLLVM archive reading and writing
      LLVMAsmParser.aLLVM assembly parsing
      LLVMBCReader.aLLVM bitcode reading
      LLVMBCWriter.aLLVM bitcode writing
      LLVMCore.aLLVM core intermediate representation
      LLVMDebugger.aSource level debugging support
      LLVMLinker.aBitcode and archive linking interface
      LLVMSupport.a General support utilities
      LLVMSystem.a .oOperating system abstraction
      LLVMCore.oLLVM Core IR
      LLVMSystem.aOperating system abstraction layer
      LLVMbzip2.aBZip2 compression library
      Analysis Libraries
      LLVMAnalysis.a .o
      Analysis Libraries
      LLVMAnalysis.a Various analysis passes.
      LLVMDataStructure.a .o
      LLVMDataStructure.o Data structure analysis passes.
      LLVMipa.a .o
      LLVMipa.a Inter-procedural analysis passes.
      Transformation Libraries
      LLVMInstrumentation.a .o
      Transformation Libraries
      LLVMInstrumentation.a Instrumentation passes.
      LLVMipo.a .o
      LLVMipo.a All inter-procedural optimization passes.
      LLVMScalarOpts.a .o
      LLVMScalarOpts.a All scalar optimization passes.
      LLVMTransforms.a .oUncategorized transformation passes.
      LLVMTransformUtils.a .oTransformation utilities.
      LLVMProfilePaths.oProfile paths for instrumentation.
      LLVMTransformUtils.aTransformation utilities used by many passes.
      Code Generation Libraries
      Code Generation Libraries
      LLVMCodeGen.o Native code generation infrastructure
      LLVMSelectionDAG.oAggressive instruction selector for directed acyclic graphs
      Target Libraries
      Target Libraries
      LLVMAlpha.oCode generation for Alpha architecture
      LLVMARM.oCode generation for ARM architecture
      LLVMCBackend.o 'C' language code generator.
      LLVMIA64.oCode generation for IA64 architecture
      LLVMPowerPC.oPowerPC code generation backend
      LLVMSelectionDAG.oAggressive instruction selector for Directed Acyclic Graphs.
      LLVMSkeleton.a .oSkeleton for a code generation backend.
      LLVMSparcV9.oCode generation for SparcV9.
      LLVMSparcV9RegAlloc.a .oGraph-coloring register allocator for SparcV9.
      LLVMSparcV9InstrSched.oInstruction scheduling for SparcV9.
      LLVMSparcV9LiveVar.oLive variable analysis SparcV9.
      LLVMSparcV9ModuloSched.oModulo scheduling for SparcV9.
      LLVMTarget.a .oCode generation for PowerPC architecture
      LLVMSparc.oCode generation for Sparc architecture
      LLVMTarget.a Generic code generation utilities.
      LLVMX86.oIntel x86 code generation backend
      Code generation for Intel x86 architecture
      Runtime Libraries
      Runtime Libraries
      LLVMInterpreter.oBytecode Interpreter
      Bitcode Interpreter
      LLVMJIT.oBytecode JIT Compiler
      Bitcode JIT Compiler
      LLVMExecutionEngine.o Virtual machine engine
      LLVMexecve.oexecve(2) replacement for llee
      + +

      Using llvm-config
      +
      +

      The llvm-config tool is a perl script that produces on its output + various kinds of information. For example, the source or object directories + used to build LLVM can be accessed by passing options to llvm-config. + For complete details on this tool, please see the + manual page.

      +

      To understand the relationships between libraries, the llvm-config + can be very useful. If all you know is that you want certain libraries to + be available, you can generate the complete set of libraries to link with + using one of four options, as below:

      +
        +
      1. --ldflags. This generates the command line options necessary to + be passed to the ld tool in order to link with LLVM. Most notably, + the -L option is provided to specify a library search directory + that contains the LLVM libraries.
        2. +
      2. --libs. This generates command line options suitable for + use with a gcc-style linker. That is, libraries are given with a -l option + and object files are given with a full path.
        3. +
      3. --libnames. This generates a list of just the library file + names. If you know the directory in which these files reside (see --ldflags) + then you can find the libraries there.
        4. +
      4. --libfiles. This generates the full path names of the + LLVM library files.
        5. +
      +

      If you wish to delve further into how llvm-config generates the + correct order (based on library dependencies), please see the tool named + GenLibDeps.pl in the utils source directory of LLVM.

      + + + + + + + +

      Dependency Relationships Of Libraries

      +

      This graph shows the dependency of archive libraries on other archive + libraries or objects. Where a library has both archive and object forms, only + the archive form is shown.

      + Library Dependencies +

      Dependency Relationships Of Object Files

      +

      This graph shows the dependency of object files on archive libraries or + other objects. Where a library has both object and archive forms, only the + dependency to the archive form is shown.

      + Object File Dependencies +

      The following list shows the dependency relationships between libraries in + textual form. The information is the same as shown on the graphs but arranged + alphabetically.

      +
      +
      libLLVMAnalysis.a
        +
      • libLLVMCore.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      • libLLVMTarget.a
        • +
      +
      libLLVMArchive.a
        +
      • libLLVMBCReader.a
        • +
      • libLLVMCore.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      +
      libLLVMAsmParser.a
        +
      • libLLVMCore.a
        • +
      • libLLVMSystem.a
        • +
      +
      libLLVMBCReader.a
        +
      • libLLVMCore.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      +
      libLLVMBCWriter.a
        +
      • libLLVMCore.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      +
      libLLVMCodeGen.a
        +
      • libLLVMAnalysis.a
        • +
      • libLLVMCore.a
        • +
      • libLLVMScalarOpts.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      • libLLVMTarget.a
        • +
      • libLLVMTransformUtils.a
        • +
      +
      libLLVMCore.a
        +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      +
      libLLVMDebugger.a
        +
      • libLLVMBCReader.a
        • +
      • libLLVMCore.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      +
      libLLVMInstrumentation.a
        +
      • libLLVMCore.a
        • +
      • libLLVMScalarOpts.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMTransformUtils.a
        • +
      +
      libLLVMLinker.a
        +
      • libLLVMArchive.a
        • +
      • libLLVMBCReader.a
        • +
      • libLLVMCore.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      +
      libLLVMScalarOpts.a
        +
      • libLLVMAnalysis.a
        • +
      • libLLVMCore.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      • libLLVMTarget.a
        • +
      • libLLVMTransformUtils.a
        • +
      +
      libLLVMSelectionDAG.a
        +
      • libLLVMAnalysis.a
        • +
      • libLLVMCodeGen.a
        • +
      • libLLVMCore.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      • libLLVMTarget.a
        • +
      • libLLVMTransformUtils.a
        • +
      +
      libLLVMSupport.a
        +
      • libLLVMSystem.a
        • +
      • libLLVMbzip2.a
        • +
      +
      libLLVMSystem.a
        +
      +
      libLLVMTarget.a
        +
      • libLLVMCore.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      +
      libLLVMTransformUtils.a
        +
      • libLLVMAnalysis.a
        • +
      • libLLVMCore.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      • libLLVMTarget.a
        • +
      • libLLVMipa.a
        • +
      +
      libLLVMbzip2.a
        +
      +
      libLLVMipa.a
        +
      • libLLVMAnalysis.a
        • +
      • libLLVMCore.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      +
      libLLVMipo.a
        +
      • libLLVMAnalysis.a
        • +
      • libLLVMCore.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      • libLLVMTarget.a
        • +
      • libLLVMTransformUtils.a
        • +
      • libLLVMipa.a
        • +
      +
      libLLVMlto.a
        +
      • libLLVMAnalysis.a
        • +
      • libLLVMBCReader.a
        • +
      • libLLVMBCWriter.a
        • +
      • libLLVMCore.a
        • +
      • libLLVMLinker.a
        • +
      • libLLVMScalarOpts.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      • libLLVMTarget.a
        • +
      • libLLVMipa.a
        • +
      • libLLVMipo.a
        • +
      +
      LLVMARM.o
        +
      • libLLVMCodeGen.a
        • +
      • libLLVMCore.a
        • +
      • libLLVMSelectionDAG.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      • libLLVMTarget.a
        • +
      +
      LLVMAlpha.o
        +
      • libLLVMCodeGen.a
        • +
      • libLLVMCore.a
        • +
      • libLLVMSelectionDAG.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      • libLLVMTarget.a
        • +
      +
      LLVMCBackend.o
        +
      • libLLVMAnalysis.a
        • +
      • libLLVMCodeGen.a
        • +
      • libLLVMCore.a
        • +
      • libLLVMScalarOpts.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      • libLLVMTarget.a
        • +
      • libLLVMTransformUtils.a
        • +
      • libLLVMipa.a
        • +
      +
      LLVMExecutionEngine.o
        +
      • libLLVMCore.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      • libLLVMTarget.a
        • +
      +
      LLVMIA64.o
        +
      • libLLVMCodeGen.a
        • +
      • libLLVMCore.a
        • +
      • libLLVMSelectionDAG.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      • libLLVMTarget.a
        • +
      +
      LLVMInterpreter.o
        +
      • LLVMExecutionEngine.o
        • +
      • libLLVMCodeGen.a
        • +
      • libLLVMCore.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      • libLLVMTarget.a
        • +
      +
      LLVMJIT.o
        +
      • LLVMExecutionEngine.o
        • +
      • libLLVMCore.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      • libLLVMTarget.a
        • +
      +
      LLVMPowerPC.o
        +
      • libLLVMCodeGen.a
        • +
      • libLLVMCore.a
        • +
      • libLLVMSelectionDAG.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      • libLLVMTarget.a
        • +
      +
      LLVMSparc.o
        +
      • libLLVMCodeGen.a
        • +
      • libLLVMCore.a
        • +
      • libLLVMSelectionDAG.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      • libLLVMTarget.a
        • +
      +
      LLVMX86.o
        +
      • libLLVMCodeGen.a
        • +
      • libLLVMCore.a
        • +
      • libLLVMSelectionDAG.a
        • +
      • libLLVMSupport.a
        • +
      • libLLVMSystem.a
        • +
      • libLLVMTarget.a
        • +
      +
      +
      +
      Linkage Rules Of Thumb
      @@ -156,11 +413,13 @@ should link into your programs.

      -
      Always Link LLVMCore LLVMSupport - LLVMSystem
      +
      Always Link LLVMCore, LLVMSupport, + and LLVMSystem
      -

      No matter what you do with LLVM, the last three entries in your linke line - should always be: LLVMCore LLVMSupport.a LLVMSystem.a.

      +

      No matter what you do with LLVM, the last three entries in the value of + your LLVMLIBS make variable should always be: + LLVMCore LLVMSupport.a LLVMSystem.a. There are no LLVM + programs that don't depend on these three.

      Never link both archive and @@ -169,14 +428,20 @@

      There is never any point to linking both the re-linked (.o) and the archive (.a) versions of a library. Since the re-linked version includes the entire library, the archive version will not resolve any symbols. - You could even end up with link error is you place the archive version before + You could even end up with link error if you place the archive version before the re-linked version on the linker's command line.

      -
      Reid Spencer
      -The LLVM Compiler Infrastructure +
      + Valid CSS! + Valid HTML 4.01! + Reid Spencer +
      +The LLVM Compiler Infrastructure
      Last modified: $Date$