| DeForest Richards | e3e6624 | 2019-09-05 17:30:52 +0000 | [diff] [blame] | 1 | User Guides
|
| 2 | ===========
|
| 3 |
|
| DeForest Richards | e3e6624 | 2019-09-05 17:30:52 +0000 | [diff] [blame] | 4 | NOTE: If you are a user who is only interested in using an LLVM-based compiler,
|
| 5 | you should look into `Clang <http://clang.llvm.org>`_ instead. The
|
| 6 | documentation here is intended for users who have a need to work with the
|
| 7 | intermediate LLVM representation.
|
| 8 |
|
| DeForest Richards | 6d19651 | 2019-10-06 15:36:37 +0000 | [diff] [blame] | 9 | .. contents::
|
| 10 | :local:
|
| 11 |
|
| DeForest Richards | e3e6624 | 2019-09-05 17:30:52 +0000 | [diff] [blame] | 12 | .. toctree::
|
| 13 | :hidden:
|
| 14 |
|
| 15 | CMake
|
| 16 | CMakePrimer
|
| 17 | AdvancedBuilds
|
| 18 | HowToBuildOnARM
|
| 19 | HowToBuildWithPGO
|
| 20 | HowToCrossCompileBuiltinsOnArm
|
| 21 | HowToCrossCompileLLVM
|
| DeForest Richards | e3e6624 | 2019-09-05 17:30:52 +0000 | [diff] [blame] | 22 | yaml2obj
|
| DeForest Richards | e3e6624 | 2019-09-05 17:30:52 +0000 | [diff] [blame] | 23 | MarkdownQuickstartTemplate
|
| 24 | Phabricator
|
| DeForest Richards | e3e6624 | 2019-09-05 17:30:52 +0000 | [diff] [blame] | 25 | Passes
|
| DeForest Richards | e3e6624 | 2019-09-05 17:30:52 +0000 | [diff] [blame] | 26 | MCJITDesignAndImplementation
|
| 27 | ORCv2
|
| 28 | CodeOfConduct
|
| 29 | CompileCudaWithLLVM
|
| 30 | ReportingGuide
|
| 31 | Benchmarking
|
| 32 | Docker
|
| 33 | BuildingADistribution
|
| 34 | Remarks
|
| DeForest Richards | 6d19651 | 2019-10-06 15:36:37 +0000 | [diff] [blame] | 35 | WritingAnLLVMPass
|
| 36 | WritingAnLLVMBackend
|
| 37 | TableGen/index
|
| 38 | NVPTXUsage
|
| 39 | AMDGPUUsage
|
| DeForest Richards | de0e3aa | 2019-10-06 16:10:11 +0000 | [diff] [blame^] | 40 | ExtendingLLVM
|
| 41 | CommandLine
|
| DeForest Richards | e3e6624 | 2019-09-05 17:30:52 +0000 | [diff] [blame] | 42 |
|
| DeForest Richards | 2605f8c | 2019-09-27 19:12:00 +0000 | [diff] [blame] | 43 | Clang
|
| DeForest Richards | 6d19651 | 2019-10-06 15:36:37 +0000 | [diff] [blame] | 44 | -----
|
| DeForest Richards | 2605f8c | 2019-09-27 19:12:00 +0000 | [diff] [blame] | 45 |
|
| DeForest Richards | e3e6624 | 2019-09-05 17:30:52 +0000 | [diff] [blame] | 46 | :doc:`HowToBuildOnARM`
|
| 47 | Notes on building and testing LLVM/Clang on ARM.
|
| 48 |
|
| 49 | :doc:`HowToBuildWithPGO`
|
| 50 | Notes on building LLVM/Clang with PGO.
|
| 51 |
|
| DeForest Richards | e3e6624 | 2019-09-05 17:30:52 +0000 | [diff] [blame] | 52 | :doc:`HowToCrossCompileLLVM`
|
| 53 | Notes on cross-building and testing LLVM/Clang.
|
| 54 |
|
| DeForest Richards | 2605f8c | 2019-09-27 19:12:00 +0000 | [diff] [blame] | 55 | `How to build the C, C++, ObjC, and ObjC++ front end`__
|
| 56 | Instructions for building the clang front-end from source.
|
| 57 |
|
| 58 | .. __: http://clang.llvm.org/get_started.html
|
| 59 |
|
| DeForest Richards | 6d19651 | 2019-10-06 15:36:37 +0000 | [diff] [blame] | 60 | LLVM Builds and Distributions
|
| 61 | -----------------------------
|
| 62 |
|
| 63 | :doc:`BuildingADistribution`
|
| 64 | A best-practices guide for using LLVM's CMake build system to package and
|
| 65 | distribute LLVM-based tools.
|
| 66 |
|
| 67 | :doc:`CMake`
|
| 68 | An addendum to the main Getting Started guide for those using the `CMake
|
| 69 | build system <http://www.cmake.org>`_.
|
| DeForest Richards | 2605f8c | 2019-09-27 19:12:00 +0000 | [diff] [blame] | 70 |
|
| 71 | :doc:`Docker`
|
| 72 | A reference for using Dockerfiles provided with LLVM.
|
| 73 |
|
| DeForest Richards | 6d19651 | 2019-10-06 15:36:37 +0000 | [diff] [blame] | 74 | Optimizations
|
| 75 | -------------
|
| DeForest Richards | 2605f8c | 2019-09-27 19:12:00 +0000 | [diff] [blame] | 76 |
|
| DeForest Richards | 6d19651 | 2019-10-06 15:36:37 +0000 | [diff] [blame] | 77 | :doc:`WritingAnLLVMPass`
|
| 78 | Information on how to write LLVM transformations and analyses.
|
| DeForest Richards | 2605f8c | 2019-09-27 19:12:00 +0000 | [diff] [blame] | 79 |
|
| DeForest Richards | e3e6624 | 2019-09-05 17:30:52 +0000 | [diff] [blame] | 80 | :doc:`Passes`
|
| 81 | A list of optimizations and analyses implemented in LLVM.
|
| 82 |
|
| DeForest Richards | 6d19651 | 2019-10-06 15:36:37 +0000 | [diff] [blame] | 83 | :doc:`LoopTerminology`
|
| 84 | A document describing Loops and associated terms as used in LLVM.
|
| DeForest Richards | e3e6624 | 2019-09-05 17:30:52 +0000 | [diff] [blame] | 85 |
|
| DeForest Richards | e3e6624 | 2019-09-05 17:30:52 +0000 | [diff] [blame] | 86 | :doc:`Remarks`
|
| DeForest Richards | 6d19651 | 2019-10-06 15:36:37 +0000 | [diff] [blame] | 87 | A reference on the implementation of remarks in LLVM.
|
| 88 |
|
| 89 | Code Generation
|
| 90 | ---------------
|
| 91 |
|
| 92 | :doc:`WritingAnLLVMBackend`
|
| 93 | Information on how to write LLVM backends for machine targets.
|
| 94 |
|
| 95 | :doc:`CodeGenerator`
|
| 96 | The design and implementation of the LLVM code generator. Useful if you are
|
| 97 | working on retargetting LLVM to a new architecture, designing a new codegen
|
| 98 | pass, or enhancing existing components.
|
| 99 |
|
| 100 | :doc:`TableGen <TableGen/index>`
|
| 101 | Describes the TableGen tool, which is used heavily by the LLVM code
|
| 102 | generator.
|
| 103 |
|
| 104 | Additional Topics
|
| 105 | -----------------
|
| 106 |
|
| DeForest Richards | de0e3aa | 2019-10-06 16:10:11 +0000 | [diff] [blame^] | 107 | :doc:`CommandLine`
|
| 108 | Provides information on using the command line parsing library.
|
| 109 |
|
| 110 | :doc:`ExtendingLLVM`
|
| 111 | Look here to see how to add instructions and intrinsics to LLVM.
|
| 112 |
|
| DeForest Richards | 6d19651 | 2019-10-06 15:36:37 +0000 | [diff] [blame] | 113 | :doc:`HowToCrossCompileBuiltinsOnArm`
|
| 114 | Notes on cross-building and testing the compiler-rt builtins for Arm.
|
| 115 |
|
| 116 | :doc:`NVPTXUsage`
|
| 117 | This document describes using the NVPTX backend to compile GPU kernels.
|
| 118 |
|
| 119 | :doc:`AMDGPUUsage`
|
| 120 | This document describes using the AMDGPU backend to compile GPU kernels. |