6 If you are using a released version of LLVM, see `the download page
7 <http://llvm.org/releases/>`_ to find your documentation.
9 The LLVM compiler infrastructure supports a wide range of projects, from
10 industrial strength compilers to specialized JIT applications to small
13 Similarly, documentation is broken down into several high-level groupings
14 targeted at different audiences:
16 LLVM Design & Overview
17 ======================
19 Several introductory papers and presentations.
27 Defines the LLVM intermediate representation.
29 `Introduction to the LLVM Compiler`__
30 Presentation providing a users introduction to LLVM.
32 .. __: http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html
35 Book chapter providing a compiler hacker's introduction to LLVM.
37 .. __: http://www.aosabook.org/en/llvm.html
40 `LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation`__
43 .. __: http://llvm.org/pubs/2004-01-30-CGO-LLVM.html
45 `LLVM: An Infrastructure for Multi-Stage Optimization`__
46 More details (quite old now).
48 .. __: http://llvm.org/pubs/2002-12-LattnerMSThesis.html
50 `Publications mentioning LLVM <http://llvm.org/pubs>`_
56 For those new to the LLVM system.
58 NOTE: If you are a user who is only interested in using LLVM-based
59 compilers, you should look into `Clang <http://clang.llvm.org>`_ or
60 `DragonEgg <http://dragonegg.llvm.org>`_ instead. The documentation here is
61 intended for users who have a need to work with the intermediate LLVM
80 SphinxQuickstartTemplate
88 Frontend/PerformanceTips
89 MCJITDesignAndImplementation
93 Discusses how to get up and running quickly with the LLVM infrastructure.
94 Everything from unpacking and compilation of the distribution to execution
98 An addendum to the main Getting Started guide for those using the `CMake
99 build system <http://www.cmake.org>`_.
101 :doc:`HowToBuildOnARM`
102 Notes on building and testing LLVM/Clang on ARM.
104 :doc:`HowToCrossCompileLLVM`
105 Notes on cross-building and testing LLVM/Clang.
107 :doc:`GettingStartedVS`
108 An addendum to the main Getting Started guide for those using Visual Studio
111 :doc:`tutorial/index`
112 Tutorials about using LLVM. Includes a tutorial about making a custom
115 :doc:`LLVM Command Guide <CommandGuide/index>`
116 A reference manual for the LLVM command line utilities ("man" pages for LLVM
120 A list of optimizations and analyses implemented in LLVM.
123 A list of common questions and problems and their solutions.
125 :doc:`Release notes for the current release <ReleaseNotes>`
126 This describes new features, known bugs, and other limitations.
128 :doc:`HowToSubmitABug`
129 Instructions for properly submitting information about any bugs you run into
132 :doc:`SphinxQuickstartTemplate`
133 A template + tutorial for writing new Sphinx documentation. It is meant
134 to be read in source form.
136 :doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
137 A reference manual for using the LLVM testing infrastructure.
139 `How to build the C, C++, ObjC, and ObjC++ front end`__
140 Instructions for building the clang front-end from source.
142 .. __: http://clang.llvm.org/get_started.html
145 Definition of acronyms, terms and concepts used in LLVM.
147 :doc:`HowToAddABuilder`
148 Instructions for adding new builder to LLVM buildbot master.
151 A reference guide for using LLVM's YAML I/O library.
154 Answers to some very frequent questions about LLVM's most frequently
155 misunderstood instruction.
157 :doc:`Frontend/PerformanceTips`
158 A collection of tips for frontend authors on how to generate IR
159 which LLVM is able to effectively optimize.
162 Programming Documentation
163 =========================
165 For developers of applications which use LLVM as a library.
175 HowToSetUpLLVMStyleRTTI
180 :doc:`LLVM Language Reference Manual <LangRef>`
181 Defines the LLVM intermediate representation and the assembly form of the
185 Information about LLVM's concurrency model.
187 :doc:`ProgrammersManual`
188 Introduction to the general layout of the LLVM sourcebase, important classes
189 and APIs, and some tips & tricks.
192 LLVM-specific extensions to tools and formats LLVM seeks compatibility with.
195 Provides information on using the command line parsing library.
197 :doc:`CodingStandards`
198 Details the LLVM coding standards and provides useful information on writing
201 :doc:`HowToSetUpLLVMStyleRTTI`
202 How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
206 Look here to see how to add instructions and intrinsics to LLVM.
208 `Doxygen generated documentation <http://llvm.org/doxygen/>`_
209 (`classes <http://llvm.org/doxygen/inherits.html>`_)
210 (`tarball <http://llvm.org/doxygen/doxygen.tar.gz>`_)
212 `Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
214 `ViewVC Repository Browser <http://llvm.org/viewvc/>`_
217 :doc:`CompilerWriterInfo`
218 A list of helpful links for compiler writers.
221 A library for writing in-process guided fuzzers.
223 Subsystem Documentation
224 =======================
226 For API clients and LLVM developers.
233 BlockFrequencyTerminology
257 CoverageMappingFormat
264 :doc:`WritingAnLLVMPass`
265 Information on how to write LLVM transformations and analyses.
267 :doc:`WritingAnLLVMBackend`
268 Information on how to write LLVM backends for machine targets.
271 The design and implementation of the LLVM code generator. Useful if you are
272 working on retargetting LLVM to a new architecture, designing a new codegen
273 pass, or enhancing existing components.
275 :doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`
276 A reference manual for the MIR serialization format, which is used to test
277 LLVM's code generation passes.
279 :doc:`TableGen <TableGen/index>`
280 Describes the TableGen tool, which is used heavily by the LLVM code
284 Information on how to write a new alias analysis implementation or how to
285 use existing analyses.
287 :doc:`GarbageCollection`
288 The interfaces source-language compilers should use for compiling GC'd
291 :doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
292 This document describes the design and philosophy behind the LLVM
293 source-level debugger.
296 This document describes the current status of vectorization in LLVM.
298 :doc:`ExceptionHandling`
299 This document describes the design and implementation of exception handling
303 Automatic bug finder and test-case reducer description and usage
307 This describes the file format and encoding used for LLVM "bc" files.
309 :doc:`System Library <SystemLibrary>`
310 This document describes the LLVM System Library (``lib/System``) and
311 how to keep LLVM source code portable
313 :doc:`LinkTimeOptimization`
314 This document describes the interface between LLVM intermodular optimizer
315 and the linker and its design
318 How to build your programs with link-time optimization on Linux.
320 :doc:`DebuggingJITedCode`
321 How to debug JITed code with GDB.
323 :doc:`MCJITDesignAndImplementation`
324 Describes the inner workings of MCJIT execution engine.
326 :doc:`BranchWeightMetadata`
327 Provides information about Branch Prediction Information.
329 :doc:`BlockFrequencyTerminology`
330 Provides information about terminology used in the ``BlockFrequencyInfo``
333 :doc:`SegmentedStacks`
334 This document describes segmented stacks and how they are used in LLVM.
336 :doc:`MarkedUpDisassembly`
337 This document describes the optional rich disassembly output syntax.
339 :doc:`HowToUseAttributes`
340 Answers some questions about the new Attributes infrastructure.
343 This document describes using the NVPTX back-end to compile GPU kernels.
346 This document describes how to use the AMDGPU back-end.
349 LLVM support for mapping instruction addresses to the location of
350 values and allowing code to be patched.
353 LLVM's support for generating NEON instructions on big endian ARM targets is
354 somewhat nonintuitive. This document explains the implementation and rationale.
356 :doc:`CoverageMappingFormat`
357 This describes the format and encoding used for LLVM’s code coverage mapping.
360 This describes a set of experimental extensions for garbage
363 :doc:`MergeFunctions`
364 Describes functions merging optimization.
367 Description of the ``inalloca`` argument attribute.
370 LLVM support for folding control flow into faulting machine instructions.
372 :doc:`CompileCudaWithLLVM`
373 LLVM support for CUDA.
375 Development Process Documentation
376 =================================
378 Information about LLVM's development process.
391 :doc:`DeveloperPolicy`
392 The LLVM project's policy towards developers and their contributions.
395 How-to guide and templates for new projects that *use* the LLVM
396 infrastructure. The templates (directory organization, Makefiles, and test
397 tree) allow the project code to be located outside (or inside) the ``llvm/``
398 tree, while using LLVM header files and libraries.
401 Describes the LLVMBuild organization and files used by LLVM to specify
402 component descriptions.
404 :doc:`HowToReleaseLLVM`
405 This is a guide to preparing LLVM releases. Most developers can ignore it.
407 :doc:`ReleaseProcess`
408 This is a guide to validate a new release, during the release process. Most developers can ignore it.
411 Advice on packaging LLVM into a distribution.
414 Describes how to use the Phabricator code review tool hosted on
415 http://reviews.llvm.org/ and its command line interface, Arcanist.
420 LLVM has a thriving community of friendly and helpful developers.
421 The two primary communication mechanisms in the LLVM community are mailing
427 If you can't find what you need in these docs, try consulting the mailing
430 `Developer's List (llvm-dev)`__
431 This list is for people who want to be included in technical discussions of
432 LLVM. People post to this list when they have questions about writing code
433 for or using the LLVM tools. It is relatively low volume.
435 .. __: http://lists.llvm.org/mailman/listinfo/llvm-dev
437 `Commits Archive (llvm-commits)`__
438 This list contains all commit messages that are made when LLVM developers
439 commit code changes to the repository. It also serves as a forum for
440 patch review (i.e. send patches here). It is useful for those who want to
441 stay on the bleeding edge of LLVM development. This list is very high
444 .. __: http://lists.llvm.org/pipermail/llvm-commits/
446 `Bugs & Patches Archive (llvm-bugs)`__
447 This list gets emailed every time a bug is opened and closed. It is
448 higher volume than the LLVM-dev list.
450 .. __: http://lists.llvm.org/pipermail/llvm-bugs/
452 `Test Results Archive (llvm-testresults)`__
453 A message is automatically sent to this list by every active nightly tester
454 when it completes. As such, this list gets email several times each day,
455 making it a high volume list.
457 .. __: http://lists.llvm.org/pipermail/llvm-testresults/
459 `LLVM Announcements List (llvm-announce)`__
460 This is a low volume list that provides important announcements regarding
461 LLVM. It gets email about once a month.
463 .. __: http://lists.llvm.org/mailman/listinfo/llvm-announce
468 Users and developers of the LLVM project (including subprojects such as Clang)
469 can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
471 This channel has several bots.
475 * llvmbb - Bot for the main LLVM buildbot master.
476 http://lab.llvm.org:8011/console
477 * bb-chapuni - An individually run buildbot master. http://bb.pgr.jp/console
478 * smooshlab - Apple's internal buildbot master.
480 * robot - Bugzilla linker. %bug <number>
482 * clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
483 near-trunk clang instead of gcc.