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
73 BuildingLLVMWithAutotools
79 SphinxQuickstartTemplate
87 Frontend/PerformanceTips
88 MCJITDesignAndImplementation
92 Discusses how to get up and running quickly with the LLVM infrastructure.
93 Everything from unpacking and compilation of the distribution to execution
97 An addendum to the main Getting Started guide for those using the `CMake
98 build system <http://www.cmake.org>`_.
100 :doc:`HowToBuildOnARM`
101 Notes on building and testing LLVM/Clang on ARM.
103 :doc:`HowToCrossCompileLLVM`
104 Notes on cross-building and testing LLVM/Clang.
106 :doc:`GettingStartedVS`
107 An addendum to the main Getting Started guide for those using Visual Studio
110 :doc:`BuildingLLVMWithAutotools`
111 An addendum to the Getting Started guide with instructions for building LLVM
112 with the Autotools build system.
114 :doc:`tutorial/index`
115 Tutorials about using LLVM. Includes a tutorial about making a custom
118 :doc:`LLVM Command Guide <CommandGuide/index>`
119 A reference manual for the LLVM command line utilities ("man" pages for LLVM
123 A list of optimizations and analyses implemented in LLVM.
126 A list of common questions and problems and their solutions.
128 :doc:`Release notes for the current release <ReleaseNotes>`
129 This describes new features, known bugs, and other limitations.
131 :doc:`HowToSubmitABug`
132 Instructions for properly submitting information about any bugs you run into
135 :doc:`SphinxQuickstartTemplate`
136 A template + tutorial for writing new Sphinx documentation. It is meant
137 to be read in source form.
139 :doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
140 A reference manual for using the LLVM testing infrastructure.
142 `How to build the C, C++, ObjC, and ObjC++ front end`__
143 Instructions for building the clang front-end from source.
145 .. __: http://clang.llvm.org/get_started.html
148 Definition of acronyms, terms and concepts used in LLVM.
150 :doc:`HowToAddABuilder`
151 Instructions for adding new builder to LLVM buildbot master.
154 A reference guide for using LLVM's YAML I/O library.
157 Answers to some very frequent questions about LLVM's most frequently
158 misunderstood instruction.
160 :doc:`Frontend/PerformanceTips`
161 A collection of tips for frontend authors on how to generate IR
162 which LLVM is able to effectively optimize.
165 Programming Documentation
166 =========================
168 For developers of applications which use LLVM as a library.
178 HowToSetUpLLVMStyleRTTI
183 :doc:`LLVM Language Reference Manual <LangRef>`
184 Defines the LLVM intermediate representation and the assembly form of the
188 Information about LLVM's concurrency model.
190 :doc:`ProgrammersManual`
191 Introduction to the general layout of the LLVM sourcebase, important classes
192 and APIs, and some tips & tricks.
195 LLVM-specific extensions to tools and formats LLVM seeks compatibility with.
198 Provides information on using the command line parsing library.
200 :doc:`CodingStandards`
201 Details the LLVM coding standards and provides useful information on writing
204 :doc:`HowToSetUpLLVMStyleRTTI`
205 How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
209 Look here to see how to add instructions and intrinsics to LLVM.
211 `Doxygen generated documentation <http://llvm.org/doxygen/>`_
212 (`classes <http://llvm.org/doxygen/inherits.html>`_)
213 (`tarball <http://llvm.org/doxygen/doxygen.tar.gz>`_)
215 `Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
217 `ViewVC Repository Browser <http://llvm.org/viewvc/>`_
220 :doc:`CompilerWriterInfo`
221 A list of helpful links for compiler writers.
224 A library for writing in-process guided fuzzers.
226 Subsystem Documentation
227 =======================
229 For API clients and LLVM developers.
236 BlockFrequencyTerminology
260 CoverageMappingFormat
267 :doc:`WritingAnLLVMPass`
268 Information on how to write LLVM transformations and analyses.
270 :doc:`WritingAnLLVMBackend`
271 Information on how to write LLVM backends for machine targets.
274 The design and implementation of the LLVM code generator. Useful if you are
275 working on retargetting LLVM to a new architecture, designing a new codegen
276 pass, or enhancing existing components.
278 :doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`
279 A reference manual for the MIR serialization format, which is used to test
280 LLVM's code generation passes.
282 :doc:`TableGen <TableGen/index>`
283 Describes the TableGen tool, which is used heavily by the LLVM code
287 Information on how to write a new alias analysis implementation or how to
288 use existing analyses.
290 :doc:`GarbageCollection`
291 The interfaces source-language compilers should use for compiling GC'd
294 :doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
295 This document describes the design and philosophy behind the LLVM
296 source-level debugger.
299 This document describes the current status of vectorization in LLVM.
301 :doc:`ExceptionHandling`
302 This document describes the design and implementation of exception handling
306 Automatic bug finder and test-case reducer description and usage
310 This describes the file format and encoding used for LLVM "bc" files.
312 :doc:`System Library <SystemLibrary>`
313 This document describes the LLVM System Library (``lib/System``) and
314 how to keep LLVM source code portable
316 :doc:`LinkTimeOptimization`
317 This document describes the interface between LLVM intermodular optimizer
318 and the linker and its design
321 How to build your programs with link-time optimization on Linux.
323 :doc:`DebuggingJITedCode`
324 How to debug JITed code with GDB.
326 :doc:`MCJITDesignAndImplementation`
327 Describes the inner workings of MCJIT execution engine.
329 :doc:`BranchWeightMetadata`
330 Provides information about Branch Prediction Information.
332 :doc:`BlockFrequencyTerminology`
333 Provides information about terminology used in the ``BlockFrequencyInfo``
336 :doc:`SegmentedStacks`
337 This document describes segmented stacks and how they are used in LLVM.
339 :doc:`MarkedUpDisassembly`
340 This document describes the optional rich disassembly output syntax.
342 :doc:`HowToUseAttributes`
343 Answers some questions about the new Attributes infrastructure.
346 This document describes using the NVPTX back-end to compile GPU kernels.
349 This document describes how to use the AMDGPU back-end.
352 LLVM support for mapping instruction addresses to the location of
353 values and allowing code to be patched.
356 LLVM's support for generating NEON instructions on big endian ARM targets is
357 somewhat nonintuitive. This document explains the implementation and rationale.
359 :doc:`CoverageMappingFormat`
360 This describes the format and encoding used for LLVM’s code coverage mapping.
363 This describes a set of experimental extensions for garbage
366 :doc:`MergeFunctions`
367 Describes functions merging optimization.
370 Description of the ``inalloca`` argument attribute.
373 LLVM support for folding control flow into faulting machine instructions.
375 :doc:`CompileCudaWithLLVM`
376 LLVM support for CUDA.
378 Development Process Documentation
379 =================================
381 Information about LLVM's development process.
395 :doc:`DeveloperPolicy`
396 The LLVM project's policy towards developers and their contributions.
399 How-to guide and templates for new projects that *use* the LLVM
400 infrastructure. The templates (directory organization, Makefiles, and test
401 tree) allow the project code to be located outside (or inside) the ``llvm/``
402 tree, while using LLVM header files and libraries.
405 Describes the LLVMBuild organization and files used by LLVM to specify
406 component descriptions.
409 Describes how the LLVM makefiles work and how to use them.
411 :doc:`HowToReleaseLLVM`
412 This is a guide to preparing LLVM releases. Most developers can ignore it.
414 :doc:`ReleaseProcess`
415 This is a guide to validate a new release, during the release process. Most developers can ignore it.
418 Advice on packaging LLVM into a distribution.
421 Describes how to use the Phabricator code review tool hosted on
422 http://reviews.llvm.org/ and its command line interface, Arcanist.
427 LLVM has a thriving community of friendly and helpful developers.
428 The two primary communication mechanisms in the LLVM community are mailing
434 If you can't find what you need in these docs, try consulting the mailing
437 `Developer's List (llvm-dev)`__
438 This list is for people who want to be included in technical discussions of
439 LLVM. People post to this list when they have questions about writing code
440 for or using the LLVM tools. It is relatively low volume.
442 .. __: http://lists.llvm.org/mailman/listinfo/llvm-dev
444 `Commits Archive (llvm-commits)`__
445 This list contains all commit messages that are made when LLVM developers
446 commit code changes to the repository. It also serves as a forum for
447 patch review (i.e. send patches here). It is useful for those who want to
448 stay on the bleeding edge of LLVM development. This list is very high
451 .. __: http://lists.llvm.org/pipermail/llvm-commits/
453 `Bugs & Patches Archive (llvm-bugs)`__
454 This list gets emailed every time a bug is opened and closed. It is
455 higher volume than the LLVM-dev list.
457 .. __: http://lists.llvm.org/pipermail/llvm-bugs/
459 `Test Results Archive (llvm-testresults)`__
460 A message is automatically sent to this list by every active nightly tester
461 when it completes. As such, this list gets email several times each day,
462 making it a high volume list.
464 .. __: http://lists.llvm.org/pipermail/llvm-testresults/
466 `LLVM Announcements List (llvm-announce)`__
467 This is a low volume list that provides important announcements regarding
468 LLVM. It gets email about once a month.
470 .. __: http://lists.llvm.org/mailman/listinfo/llvm-announce
475 Users and developers of the LLVM project (including subprojects such as Clang)
476 can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
478 This channel has several bots.
482 * llvmbb - Bot for the main LLVM buildbot master.
483 http://lab.llvm.org:8011/console
484 * bb-chapuni - An individually run buildbot master. http://bb.pgr.jp/console
485 * smooshlab - Apple's internal buildbot master.
487 * robot - Bugzilla linker. %bug <number>
489 * clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
490 near-trunk clang instead of gcc.