Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 1 | .. _subsystems: |
| 2 | |
| 3 | Subsystem Documentation |
| 4 | ======================= |
| 5 | |
Bill Wendling | 430c3bb | 2012-06-20 09:49:57 +0000 | [diff] [blame] | 6 | .. toctree:: |
| 7 | :hidden: |
| 8 | |
| 9 | AliasAnalysis |
Bill Wendling | 0ca9927 | 2012-06-28 08:43:12 +0000 | [diff] [blame] | 10 | BitCodeFormat |
Bill Wendling | 707f2fd | 2012-06-20 10:17:46 +0000 | [diff] [blame] | 11 | BranchWeightMetadata |
Bill Wendling | d372ee2 | 2012-06-26 11:37:00 +0000 | [diff] [blame] | 12 | Bugpoint |
Bill Wendling | 7d85f87 | 2012-06-27 07:20:57 +0000 | [diff] [blame] | 13 | ExceptionHandling |
Bill Wendling | a3a2eb0 | 2012-06-20 10:08:02 +0000 | [diff] [blame] | 14 | LinkTimeOptimization |
Bill Wendling | 47997e8 | 2012-06-20 12:05:05 +0000 | [diff] [blame] | 15 | SegmentedStacks |
Bill Wendling | bd96e0d | 2012-06-21 06:58:24 +0000 | [diff] [blame] | 16 | TableGenFundamentals |
Bill Wendling | 430c3bb | 2012-06-20 09:49:57 +0000 | [diff] [blame] | 17 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 18 | * `Writing an LLVM Pass <WritingAnLLVMPass.html>`_ |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 19 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 20 | Information on how to write LLVM transformations and analyses. |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 21 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 22 | * `Writing an LLVM Backend <WritingAnLLVMBackend.html>`_ |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 23 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 24 | Information on how to write LLVM backends for machine targets. |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 25 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 26 | * `The LLVM Target-Independent Code Generator <CodeGenerator.html>`_ |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 27 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 28 | The design and implementation of the LLVM code generator. Useful if you are |
| 29 | working on retargetting LLVM to a new architecture, designing a new codegen |
| 30 | pass, or enhancing existing components. |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 31 | |
Bill Wendling | bd96e0d | 2012-06-21 06:58:24 +0000 | [diff] [blame] | 32 | * :ref:`tablegen` |
| 33 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 34 | Describes the TableGen tool, which is used heavily by the LLVM code |
| 35 | generator. |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 36 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 37 | * :ref:`alias_analysis` |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 38 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 39 | Information on how to write a new alias analysis implementation or how to |
| 40 | use existing analyses. |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 41 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 42 | * `Accurate Garbage Collection with LLVM <GarbageCollection.html>`_ |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 43 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 44 | The interfaces source-language compilers should use for compiling GC'd |
| 45 | programs. |
Bill Wendling | 47997e8 | 2012-06-20 12:05:05 +0000 | [diff] [blame] | 46 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 47 | * `Source Level Debugging with LLVM <SourceLevelDebugging.html>`_ |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 48 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 49 | This document describes the design and philosophy behind the LLVM |
| 50 | source-level debugger. |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 51 | |
Bill Wendling | 7d85f87 | 2012-06-27 07:20:57 +0000 | [diff] [blame] | 52 | * :ref:`exception_handling` |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 53 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 54 | This document describes the design and implementation of exception handling |
| 55 | in LLVM. |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 56 | |
Bill Wendling | d372ee2 | 2012-06-26 11:37:00 +0000 | [diff] [blame] | 57 | * :ref:`bugpoint` |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 58 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 59 | Automatic bug finder and test-case reducer description and usage |
| 60 | information. |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 61 | |
Bill Wendling | 0ca9927 | 2012-06-28 08:43:12 +0000 | [diff] [blame] | 62 | * :ref:`bitcode_format` |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 63 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 64 | This describes the file format and encoding used for LLVM "bc" files. |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 65 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 66 | * `System Library <SystemLibrary.html>`_ |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 67 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 68 | This document describes the LLVM System Library (<tt>lib/System</tt>) and |
| 69 | how to keep LLVM source code portable |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 70 | |
Bill Wendling | a3a2eb0 | 2012-06-20 10:08:02 +0000 | [diff] [blame] | 71 | * :ref:`lto` |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 72 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 73 | This document describes the interface between LLVM intermodular optimizer |
| 74 | and the linker and its design |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 75 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 76 | * `The LLVM gold plugin <GoldPlugin.html>`_ |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 77 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 78 | How to build your programs with link-time optimization on Linux. |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 79 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 80 | * `The GDB JIT interface <DebuggingJITedCode.html>`_ |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 81 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 82 | How to debug JITed code with GDB. |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 83 | |
Bill Wendling | 707f2fd | 2012-06-20 10:17:46 +0000 | [diff] [blame] | 84 | * :ref:`branch_weight` |
Daniel Dunbar | 21e993c | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 85 | |
Bill Wendling | df870f5 | 2012-06-20 09:50:45 +0000 | [diff] [blame] | 86 | Provides information about Branch Prediction Information. |
Bill Wendling | 47997e8 | 2012-06-20 12:05:05 +0000 | [diff] [blame] | 87 | |
| 88 | * :ref:`segmented_stacks` |
| 89 | |
| 90 | This document describes segmented stacks and how they are used in LLVM. |