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