blob: e643e7d4f3108e1134376d0b3cb23ce30c569d5b [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 Wendling47997e82012-06-20 12:05:05 +000012 SegmentedStacks
Bill Wendlingbd96e0d2012-06-21 06:58:24 +000013 TableGenFundamentals
Bill Wendling430c3bb2012-06-20 09:49:57 +000014
Bill Wendlingdf870f52012-06-20 09:50:45 +000015* `Writing an LLVM Pass <WritingAnLLVMPass.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000016
Bill Wendlingdf870f52012-06-20 09:50:45 +000017 Information on how to write LLVM transformations and analyses.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000018
Bill Wendlingdf870f52012-06-20 09:50:45 +000019* `Writing an LLVM Backend <WritingAnLLVMBackend.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000020
Bill Wendlingdf870f52012-06-20 09:50:45 +000021 Information on how to write LLVM backends for machine targets.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000022
Bill Wendlingdf870f52012-06-20 09:50:45 +000023* `The LLVM Target-Independent Code Generator <CodeGenerator.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000024
Bill Wendlingdf870f52012-06-20 09:50:45 +000025 The design and implementation of the LLVM code generator. Useful if you are
26 working on retargetting LLVM to a new architecture, designing a new codegen
27 pass, or enhancing existing components.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000028
Bill Wendlingbd96e0d2012-06-21 06:58:24 +000029* :ref:`tablegen`
30
Bill Wendlingdf870f52012-06-20 09:50:45 +000031 Describes the TableGen tool, which is used heavily by the LLVM code
32 generator.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000033
Bill Wendlingdf870f52012-06-20 09:50:45 +000034* :ref:`alias_analysis`
Daniel Dunbar21e993c2012-04-19 16:31:37 +000035
Bill Wendlingdf870f52012-06-20 09:50:45 +000036 Information on how to write a new alias analysis implementation or how to
37 use existing analyses.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000038
Bill Wendlingdf870f52012-06-20 09:50:45 +000039* `Accurate Garbage Collection with LLVM <GarbageCollection.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000040
Bill Wendlingdf870f52012-06-20 09:50:45 +000041 The interfaces source-language compilers should use for compiling GC'd
42 programs.
Bill Wendling47997e82012-06-20 12:05:05 +000043
Bill Wendlingdf870f52012-06-20 09:50:45 +000044* `Source Level Debugging with LLVM <SourceLevelDebugging.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000045
Bill Wendlingdf870f52012-06-20 09:50:45 +000046 This document describes the design and philosophy behind the LLVM
47 source-level debugger.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000048
Bill Wendlingdf870f52012-06-20 09:50:45 +000049* `Zero Cost Exception handling in LLVM <ExceptionHandling.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000050
Bill Wendlingdf870f52012-06-20 09:50:45 +000051 This document describes the design and implementation of exception handling
52 in LLVM.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000053
Bill Wendlingdf870f52012-06-20 09:50:45 +000054* `Bugpoint <Bugpoint.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000055
Bill Wendlingdf870f52012-06-20 09:50:45 +000056 Automatic bug finder and test-case reducer description and usage
57 information.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000058
Bill Wendlingdf870f52012-06-20 09:50:45 +000059* `LLVM Bitcode File Format <BitCodeFormat.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000060
Bill Wendlingdf870f52012-06-20 09:50:45 +000061 This describes the file format and encoding used for LLVM "bc" files.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000062
Bill Wendlingdf870f52012-06-20 09:50:45 +000063* `System Library <SystemLibrary.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000064
Bill Wendlingdf870f52012-06-20 09:50:45 +000065 This document describes the LLVM System Library (<tt>lib/System</tt>) and
66 how to keep LLVM source code portable
Daniel Dunbar21e993c2012-04-19 16:31:37 +000067
Bill Wendlinga3a2eb02012-06-20 10:08:02 +000068* :ref:`lto`
Daniel Dunbar21e993c2012-04-19 16:31:37 +000069
Bill Wendlingdf870f52012-06-20 09:50:45 +000070 This document describes the interface between LLVM intermodular optimizer
71 and the linker and its design
Daniel Dunbar21e993c2012-04-19 16:31:37 +000072
Bill Wendlingdf870f52012-06-20 09:50:45 +000073* `The LLVM gold plugin <GoldPlugin.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000074
Bill Wendlingdf870f52012-06-20 09:50:45 +000075 How to build your programs with link-time optimization on Linux.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000076
Bill Wendlingdf870f52012-06-20 09:50:45 +000077* `The GDB JIT interface <DebuggingJITedCode.html>`_
Daniel Dunbar21e993c2012-04-19 16:31:37 +000078
Bill Wendlingdf870f52012-06-20 09:50:45 +000079 How to debug JITed code with GDB.
Daniel Dunbar21e993c2012-04-19 16:31:37 +000080
Bill Wendling707f2fd2012-06-20 10:17:46 +000081* :ref:`branch_weight`
Daniel Dunbar21e993c2012-04-19 16:31:37 +000082
Bill Wendlingdf870f52012-06-20 09:50:45 +000083 Provides information about Branch Prediction Information.
Bill Wendling47997e82012-06-20 12:05:05 +000084
85* :ref:`segmented_stacks`
86
87 This document describes segmented stacks and how they are used in LLVM.