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