docs/subsystems.rst

   1 Subsystem Documentation
   2 =======================
   3
   4 .. toctree::
   5    :hidden:
   6
   7    AliasAnalysis
   8    BitCodeFormat
   9    BranchWeightMetadata
  10    Bugpoint
  11    CodeGenerator
  12    ExceptionHandling
  13    LinkTimeOptimization
  14    SegmentedStacks
  15    TableGenFundamentals
  16    DebuggingJITedCode
  17    GoldPlugin
  18    MarkedUpDisassembly
  19    SystemLibrary
  20    SourceLevelDebugging
  21    Vectorizers
  22    WritingAnLLVMBackend
  23    GarbageCollection
  24    WritingAnLLVMPass
  25    TableGen/LangRef
  26
  27 * :doc:`WritingAnLLVMPass`
  28
  29    Information on how to write LLVM transformations and analyses.
  30
  31 * :doc:`WritingAnLLVMBackend`
  32
  33    Information on how to write LLVM backends for machine targets.
  34
  35 * :doc:`CodeGenerator`
  36
  37    The design and implementation of the LLVM code generator.  Useful if you are
  38    working on retargetting LLVM to a new architecture, designing a new codegen
  39    pass, or enhancing existing components.
  40
  41 * :doc:`TableGenFundamentals`
  42
  43    Describes the TableGen tool, which is used heavily by the LLVM code
  44    generator.
  45
  46 * :doc:`AliasAnalysis`
  47
  48    Information on how to write a new alias analysis implementation or how to
  49    use existing analyses.
  50
  51 * :doc:`GarbageCollection`
  52
  53    The interfaces source-language compilers should use for compiling GC'd
  54    programs.
  55
  56 * :doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
  57
  58    This document describes the design and philosophy behind the LLVM
  59    source-level debugger.
  60
  61 * :doc:`Vectorizers`
  62
  63    This document describes the current status of vectorization in LLVM.
  64
  65 * :doc:`ExceptionHandling`
  66
  67    This document describes the design and implementation of exception handling
  68    in LLVM.
  69
  70 * :doc:`Bugpoint`
  71
  72    Automatic bug finder and test-case reducer description and usage
  73    information.
  74
  75 * :doc:`BitCodeFormat`
  76
  77    This describes the file format and encoding used for LLVM "bc" files.
  78
  79 * :doc:`System Library <SystemLibrary>`
  80
  81    This document describes the LLVM System Library (``lib/System``) and
  82    how to keep LLVM source code portable
  83
  84 * :doc:`LinkTimeOptimization`
  85
  86    This document describes the interface between LLVM intermodular optimizer
  87    and the linker and its design
  88
  89 * :doc:`GoldPlugin`
  90
  91    How to build your programs with link-time optimization on Linux.
  92
  93 * :doc:`DebuggingJITedCode`
  94
  95    How to debug JITed code with GDB.
  96
  97 * :doc:`BranchWeightMetadata`
  98
  99    Provides information about Branch Prediction Information.
 100
 101 * :doc:`SegmentedStacks`
 102
 103    This document describes segmented stacks and how they are used in LLVM.
 104
 105 * :doc:`MarkedUpDisassembly`
 106
 107    This document describes the optional rich disassembly output syntax.
 108