docs/subsystems.rst

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