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
78 SphinxQuickstartTemplate
86 MCJITDesignAndImplementation
89 Discusses how to get up and running quickly with the LLVM infrastructure.
90 Everything from unpacking and compilation of the distribution to execution
94 An addendum to the main Getting Started guide for those using the `CMake
95 build system <http://www.cmake.org>`_.
97 :doc:`HowToBuildOnARM`
98 Notes on building and testing LLVM/Clang on ARM.
100 :doc:`HowToCrossCompileLLVM`
101 Notes on cross-building and testing LLVM/Clang.
103 :doc:`GettingStartedVS`
104 An addendum to the main Getting Started guide for those using Visual Studio
107 :doc:`tutorial/index`
108 Tutorials about using LLVM. Includes a tutorial about making a custom
111 :doc:`LLVM Command Guide <CommandGuide/index>`
112 A reference manual for the LLVM command line utilities ("man" pages for LLVM
116 A list of optimizations and analyses implemented in LLVM.
119 A list of common questions and problems and their solutions.
121 :doc:`Release notes for the current release <ReleaseNotes>`
122 This describes new features, known bugs, and other limitations.
124 :doc:`HowToSubmitABug`
125 Instructions for properly submitting information about any bugs you run into
128 :doc:`SphinxQuickstartTemplate`
129 A template + tutorial for writing new Sphinx documentation. It is meant
130 to be read in source form.
132 :doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
133 A reference manual for using the LLVM testing infrastructure.
135 `How to build the C, C++, ObjC, and ObjC++ front end`__
136 Instructions for building the clang front-end from source.
138 .. __: http://clang.llvm.org/get_started.html
141 Definition of acronyms, terms and concepts used in LLVM.
143 :doc:`HowToAddABuilder`
144 Instructions for adding new builder to LLVM buildbot master.
147 A reference guide for using LLVM's YAML I/O library.
150 Answers to some very frequent questions about LLVM's most frequently
151 misunderstood instruction.
153 Programming Documentation
154 =========================
156 For developers of applications which use LLVM as a library.
166 HowToSetUpLLVMStyleRTTI
170 :doc:`LLVM Language Reference Manual <LangRef>`
171 Defines the LLVM intermediate representation and the assembly form of the
175 Information about LLVM's concurrency model.
177 :doc:`ProgrammersManual`
178 Introduction to the general layout of the LLVM sourcebase, important classes
179 and APIs, and some tips & tricks.
182 LLVM-specific extensions to tools and formats LLVM seeks compatibility with.
185 Provides information on using the command line parsing library.
187 :doc:`CodingStandards`
188 Details the LLVM coding standards and provides useful information on writing
191 :doc:`HowToSetUpLLVMStyleRTTI`
192 How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
196 Look here to see how to add instructions and intrinsics to LLVM.
198 `Doxygen generated documentation <http://llvm.org/doxygen/>`_
199 (`classes <http://llvm.org/doxygen/inherits.html>`_)
200 (`tarball <http://llvm.org/doxygen/doxygen.tar.gz>`_)
202 `Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
204 `ViewVC Repository Browser <http://llvm.org/viewvc/>`_
207 :doc:`CompilerWriterInfo`
208 A list of helpful links for compiler writers.
210 Subsystem Documentation
211 =======================
213 For API clients and LLVM developers.
220 BlockFrequencyTerminology
244 CoverageMappingFormat
249 :doc:`WritingAnLLVMPass`
250 Information on how to write LLVM transformations and analyses.
252 :doc:`WritingAnLLVMBackend`
253 Information on how to write LLVM backends for machine targets.
256 The design and implementation of the LLVM code generator. Useful if you are
257 working on retargetting LLVM to a new architecture, designing a new codegen
258 pass, or enhancing existing components.
260 :doc:`TableGen <TableGen/index>`
261 Describes the TableGen tool, which is used heavily by the LLVM code
265 Information on how to write a new alias analysis implementation or how to
266 use existing analyses.
268 :doc:`GarbageCollection`
269 The interfaces source-language compilers should use for compiling GC'd
272 :doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
273 This document describes the design and philosophy behind the LLVM
274 source-level debugger.
277 This document describes the current status of vectorization in LLVM.
279 :doc:`ExceptionHandling`
280 This document describes the design and implementation of exception handling
284 Automatic bug finder and test-case reducer description and usage
288 This describes the file format and encoding used for LLVM "bc" files.
290 :doc:`System Library <SystemLibrary>`
291 This document describes the LLVM System Library (``lib/System``) and
292 how to keep LLVM source code portable
294 :doc:`LinkTimeOptimization`
295 This document describes the interface between LLVM intermodular optimizer
296 and the linker and its design
299 How to build your programs with link-time optimization on Linux.
301 :doc:`DebuggingJITedCode`
302 How to debug JITed code with GDB.
304 :doc:`MCJITDesignAndImplementation`
305 Describes the inner workings of MCJIT execution engine.
307 :doc:`BranchWeightMetadata`
308 Provides information about Branch Prediction Information.
310 :doc:`BlockFrequencyTerminology`
311 Provides information about terminology used in the ``BlockFrequencyInfo``
314 :doc:`SegmentedStacks`
315 This document describes segmented stacks and how they are used in LLVM.
317 :doc:`MarkedUpDisassembly`
318 This document describes the optional rich disassembly output syntax.
320 :doc:`HowToUseAttributes`
321 Answers some questions about the new Attributes infrastructure.
324 This document describes using the NVPTX back-end to compile GPU kernels.
327 This document describes how to use the R600 back-end.
330 LLVM support for mapping instruction addresses to the location of
331 values and allowing code to be patched.
334 LLVM's support for generating NEON instructions on big endian ARM targets is
335 somewhat nonintuitive. This document explains the implementation and rationale.
337 :doc:`CoverageMappingFormat`
338 This describes the format and encoding used for LLVM’s code coverage mapping.
341 This describes a set of experimental extensions for garbage
344 :doc:`MergeFunctions`
345 Describes functions merging optimization.
348 Description of the ``inalloca`` argument attribute.
350 Development Process Documentation
351 =================================
353 Information about LLVM's development process.
367 :doc:`DeveloperPolicy`
368 The LLVM project's policy towards developers and their contributions.
371 How-to guide and templates for new projects that *use* the LLVM
372 infrastructure. The templates (directory organization, Makefiles, and test
373 tree) allow the project code to be located outside (or inside) the ``llvm/``
374 tree, while using LLVM header files and libraries.
377 Describes the LLVMBuild organization and files used by LLVM to specify
378 component descriptions.
381 Describes how the LLVM makefiles work and how to use them.
383 :doc:`HowToReleaseLLVM`
384 This is a guide to preparing LLVM releases. Most developers can ignore it.
386 :doc:`ReleaseProcess`
387 This is a guide to validate a new release, during the release process. Most developers can ignore it.
390 Advice on packaging LLVM into a distribution.
393 Describes how to use the Phabricator code review tool hosted on
394 http://reviews.llvm.org/ and its command line interface, Arcanist.
399 LLVM has a thriving community of friendly and helpful developers.
400 The two primary communication mechanisms in the LLVM community are mailing
406 If you can't find what you need in these docs, try consulting the mailing
409 `Developer's List (llvmdev)`__
410 This list is for people who want to be included in technical discussions of
411 LLVM. People post to this list when they have questions about writing code
412 for or using the LLVM tools. It is relatively low volume.
414 .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
416 `Commits Archive (llvm-commits)`__
417 This list contains all commit messages that are made when LLVM developers
418 commit code changes to the repository. It also serves as a forum for
419 patch review (i.e. send patches here). It is useful for those who want to
420 stay on the bleeding edge of LLVM development. This list is very high
423 .. __: http://lists.cs.uiuc.edu/pipermail/llvm-commits/
425 `Bugs & Patches Archive (llvmbugs)`__
426 This list gets emailed every time a bug is opened and closed. It is
427 higher volume than the LLVMdev list.
429 .. __: http://lists.cs.uiuc.edu/pipermail/llvmbugs/
431 `Test Results Archive (llvm-testresults)`__
432 A message is automatically sent to this list by every active nightly tester
433 when it completes. As such, this list gets email several times each day,
434 making it a high volume list.
436 .. __: http://lists.cs.uiuc.edu/pipermail/llvm-testresults/
438 `LLVM Announcements List (llvm-announce)`__
439 This is a low volume list that provides important announcements regarding
440 LLVM. It gets email about once a month.
442 .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce
447 Users and developers of the LLVM project (including subprojects such as Clang)
448 can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
450 This channel has several bots.
454 * llvmbb - Bot for the main LLVM buildbot master.
455 http://lab.llvm.org:8011/console
456 * bb-chapuni - An individually run buildbot master. http://bb.pgr.jp/console
457 * smooshlab - Apple's internal buildbot master.
459 * robot - Bugzilla linker. %bug <number>
461 * clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
462 near-trunk clang instead of gcc.