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    HowToUseInstrMappings
  22    SystemLibrary
  23    SourceLevelDebugging
  24    WritingAnLLVMBackend
  25
  26 .. FIXME: once LangRef is Sphinxified, HowToUseInstrMappings should be put
  27    under LangRef's toctree instead of this page's toctree.
  28
  29 * `Writing an LLVM Pass <WritingAnLLVMPass.html>`_
  30
  31    Information on how to write LLVM transformations and analyses.
  32
  33 * :doc:`WritingAnLLVMBackend`
  34
  35    Information on how to write LLVM backends for machine targets.
  36
  37 * :ref:`code_generator`
  38
  39    The design and implementation of the LLVM code generator.  Useful if you are
  40    working on retargetting LLVM to a new architecture, designing a new codegen
  41    pass, or enhancing existing components.
  42
  43 * :ref:`tablegen`
  44
  45    Describes the TableGen tool, which is used heavily by the LLVM code
  46    generator.
  47
  48 * :ref:`alias_analysis`
  49
  50    Information on how to write a new alias analysis implementation or how to
  51    use existing analyses.
  52
  53 * `Accurate Garbage Collection with LLVM <GarbageCollection.html>`_
  54
  55    The interfaces source-language compilers should use for compiling GC'd
  56    programs.
  57
  58 * :doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
  59
  60    This document describes the design and philosophy behind the LLVM
  61    source-level debugger.
  62
  63 * :ref:`exception_handling`
  64
  65    This document describes the design and implementation of exception handling
  66    in LLVM.
  67
  68 * :ref:`bugpoint`
  69
  70    Automatic bug finder and test-case reducer description and usage
  71    information.
  72
  73 * :ref:`bitcode_format`
  74
  75    This describes the file format and encoding used for LLVM "bc" files.
  76
  77 * :doc:`System Library <SystemLibrary>`
  78
  79    This document describes the LLVM System Library (``lib/System``) and
  80    how to keep LLVM source code portable
  81
  82 * :ref:`lto`
  83
  84    This document describes the interface between LLVM intermodular optimizer
  85    and the linker and its design
  86
  87 * :ref:`gold-plugin`
  88
  89    How to build your programs with link-time optimization on Linux.
  90
  91 * :ref:`debugging-jited-code`
  92
  93    How to debug JITed code with GDB.
  94
  95 * :ref:`branch_weight`
  96
  97    Provides information about Branch Prediction Information.
  98
  99 * :ref:`segmented_stacks`
 100
 101    This document describes segmented stacks and how they are used in LLVM.
 102
 103 * `Howto: Implementing LLVM Integrated Assembler`_
 104
 105    A simple guide for how to implement an LLVM integrated assembler for an
 106    architecture.
 107
 108 .. _`Howto: Implementing LLVM Integrated Assembler`: http://www.embecosm.com/download/ean10.html
 109
 110 * :ref:`marked_up_disassembly`
 111
 112    This document describes the optional rich disassembly output syntax.
 113