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