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