blob: 1f9bd7d6ed6477e7f6cf3ffd24399da3c4a69257 [file] [log] [blame]
Daniel Dunbar21e993c2012-04-19 16:31:37 +00001.. _subsystems:
2
3Subsystem Documentation
4=======================
5
Bill Wendling430c3bb2012-06-20 09:49:57 +00006.. toctree::
7 :hidden:
8
9 AliasAnalysis
Bill Wendling707f2fd2012-06-20 10:17:46 +000010 BranchWeightMetadata
Bill Wendlinga3a2eb02012-06-20 10:08:02 +000011 LinkTimeOptimization
Bill Wendling430c3bb2012-06-20 09:49:57 +000012
Bill Wendlingdf870f52012-06-20 09:50:45 +000013* `Writing an LLVM Pass <WritingAnLLVMPass.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000014
Bill Wendlingdf870f52012-06-20 09:50:45 +000015 Information on how to write LLVM transformations and analyses.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000016
Bill Wendlingdf870f52012-06-20 09:50:45 +000017* `Writing an LLVM Backend <WritingAnLLVMBackend.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000018
Bill Wendlingdf870f52012-06-20 09:50:45 +000019 Information on how to write LLVM backends for machine targets.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000020
Bill Wendlingdf870f52012-06-20 09:50:45 +000021* `The LLVM Target-Independent Code Generator <CodeGenerator.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000022
Bill Wendlingdf870f52012-06-20 09:50:45 +000023 The design and implementation of the LLVM code generator. Useful if you are
24 working on retargetting LLVM to a new architecture, designing a new codegen
25 pass, or enhancing existing components.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000026
Bill Wendlingdf870f52012-06-20 09:50:45 +000027* `TableGen Fundamentals <TableGenFundamentals.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000028
Bill Wendlingdf870f52012-06-20 09:50:45 +000029 Describes the TableGen tool, which is used heavily by the LLVM code
30 generator.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000031
Bill Wendlingdf870f52012-06-20 09:50:45 +000032* :ref:`alias_analysis`
Daniel Dunbar21e993c2012-04-19 16:31:37 +000033
Bill Wendlingdf870f52012-06-20 09:50:45 +000034 Information on how to write a new alias analysis implementation or how to
35 use existing analyses.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000036
Bill Wendlingdf870f52012-06-20 09:50:45 +000037* `Accurate Garbage Collection with LLVM <GarbageCollection.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000038
Bill Wendlingdf870f52012-06-20 09:50:45 +000039 The interfaces source-language compilers should use for compiling GC'd
40 programs.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000041
Bill Wendlingdf870f52012-06-20 09:50:45 +000042* `Source Level Debugging with LLVM <SourceLevelDebugging.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000043
Bill Wendlingdf870f52012-06-20 09:50:45 +000044 This document describes the design and philosophy behind the LLVM
45 source-level debugger.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000046
Bill Wendlingdf870f52012-06-20 09:50:45 +000047* `Zero Cost Exception handling in LLVM <ExceptionHandling.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000048
Bill Wendlingdf870f52012-06-20 09:50:45 +000049 This document describes the design and implementation of exception handling
50 in LLVM.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000051
Bill Wendlingdf870f52012-06-20 09:50:45 +000052* `Bugpoint <Bugpoint.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000053
Bill Wendlingdf870f52012-06-20 09:50:45 +000054 Automatic bug finder and test-case reducer description and usage
55 information.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000056
Bill Wendlingdf870f52012-06-20 09:50:45 +000057* `LLVM Bitcode File Format <BitCodeFormat.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000058
Bill Wendlingdf870f52012-06-20 09:50:45 +000059 This describes the file format and encoding used for LLVM "bc" files.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000060
Bill Wendlingdf870f52012-06-20 09:50:45 +000061* `System Library <SystemLibrary.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000062
Bill Wendlingdf870f52012-06-20 09:50:45 +000063 This document describes the LLVM System Library (<tt>lib/System</tt>) and
64 how to keep LLVM source code portable
Daniel Dunbar21e993c2012-04-19 16:31:37 +000065
Bill Wendlinga3a2eb02012-06-20 10:08:02 +000066* :ref:`lto`
Daniel Dunbar21e993c2012-04-19 16:31:37 +000067
Bill Wendlingdf870f52012-06-20 09:50:45 +000068 This document describes the interface between LLVM intermodular optimizer
69 and the linker and its design
Daniel Dunbar21e993c2012-04-19 16:31:37 +000070
Bill Wendlingdf870f52012-06-20 09:50:45 +000071* `The LLVM gold plugin <GoldPlugin.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000072
Bill Wendlingdf870f52012-06-20 09:50:45 +000073 How to build your programs with link-time optimization on Linux.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000074
Bill Wendlingdf870f52012-06-20 09:50:45 +000075* `The GDB JIT interface <DebuggingJITedCode.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000076
Bill Wendlingdf870f52012-06-20 09:50:45 +000077 How to debug JITed code with GDB.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000078
Bill Wendling707f2fd2012-06-20 10:17:46 +000079* :ref:`branch_weight`
Daniel Dunbar21e993c2012-04-19 16:31:37 +000080
Bill Wendlingdf870f52012-06-20 09:50:45 +000081 Provides information about Branch Prediction Information.