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 Frontend/PerformanceTips
87 MCJITDesignAndImplementation
90 Discusses how to get up and running quickly with the LLVM infrastructure.
91 Everything from unpacking and compilation of the distribution to execution
95 An addendum to the main Getting Started guide for those using the `CMake
96 build system <http://www.cmake.org>`_.
98 :doc:`HowToBuildOnARM`
99 Notes on building and testing LLVM/Clang on ARM.
101 :doc:`HowToCrossCompileLLVM`
102 Notes on cross-building and testing LLVM/Clang.
104 :doc:`GettingStartedVS`
105 An addendum to the main Getting Started guide for those using Visual Studio
108 :doc:`tutorial/index`
109 Tutorials about using LLVM. Includes a tutorial about making a custom
112 :doc:`LLVM Command Guide <CommandGuide/index>`
113 A reference manual for the LLVM command line utilities ("man" pages for LLVM
117 A list of optimizations and analyses implemented in LLVM.
120 A list of common questions and problems and their solutions.
122 :doc:`Release notes for the current release <ReleaseNotes>`
123 This describes new features, known bugs, and other limitations.
125 :doc:`HowToSubmitABug`
126 Instructions for properly submitting information about any bugs you run into
129 :doc:`SphinxQuickstartTemplate`
130 A template + tutorial for writing new Sphinx documentation. It is meant
131 to be read in source form.
133 :doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
134 A reference manual for using the LLVM testing infrastructure.
136 `How to build the C, C++, ObjC, and ObjC++ front end`__
137 Instructions for building the clang front-end from source.
139 .. __: http://clang.llvm.org/get_started.html
142 Definition of acronyms, terms and concepts used in LLVM.
144 :doc:`HowToAddABuilder`
145 Instructions for adding new builder to LLVM buildbot master.
148 A reference guide for using LLVM's YAML I/O library.
151 Answers to some very frequent questions about LLVM's most frequently
152 misunderstood instruction.
154 :doc:`Frontend/PerformanceTips`
155 A collection of tips for frontend authors on how to generate IR
156 which LLVM is able to effectively optimize.
159 Programming Documentation
160 =========================
162 For developers of applications which use LLVM as a library.
172 HowToSetUpLLVMStyleRTTI
176 :doc:`LLVM Language Reference Manual <LangRef>`
177 Defines the LLVM intermediate representation and the assembly form of the
181 Information about LLVM's concurrency model.
183 :doc:`ProgrammersManual`
184 Introduction to the general layout of the LLVM sourcebase, important classes
185 and APIs, and some tips & tricks.
188 LLVM-specific extensions to tools and formats LLVM seeks compatibility with.
191 Provides information on using the command line parsing library.
193 :doc:`CodingStandards`
194 Details the LLVM coding standards and provides useful information on writing
197 :doc:`HowToSetUpLLVMStyleRTTI`
198 How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
202 Look here to see how to add instructions and intrinsics to LLVM.
204 `Doxygen generated documentation <http://llvm.org/doxygen/>`_
205 (`classes <http://llvm.org/doxygen/inherits.html>`_)
206 (`tarball <http://llvm.org/doxygen/doxygen.tar.gz>`_)
208 `Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
210 `ViewVC Repository Browser <http://llvm.org/viewvc/>`_
213 :doc:`CompilerWriterInfo`
214 A list of helpful links for compiler writers.
216 Subsystem Documentation
217 =======================
219 For API clients and LLVM developers.
226 BlockFrequencyTerminology
250 CoverageMappingFormat
255 :doc:`WritingAnLLVMPass`
256 Information on how to write LLVM transformations and analyses.
258 :doc:`WritingAnLLVMBackend`
259 Information on how to write LLVM backends for machine targets.
262 The design and implementation of the LLVM code generator. Useful if you are
263 working on retargetting LLVM to a new architecture, designing a new codegen
264 pass, or enhancing existing components.
266 :doc:`TableGen <TableGen/index>`
267 Describes the TableGen tool, which is used heavily by the LLVM code
271 Information on how to write a new alias analysis implementation or how to
272 use existing analyses.
274 :doc:`GarbageCollection`
275 The interfaces source-language compilers should use for compiling GC'd
278 :doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
279 This document describes the design and philosophy behind the LLVM
280 source-level debugger.
283 This document describes the current status of vectorization in LLVM.
285 :doc:`ExceptionHandling`
286 This document describes the design and implementation of exception handling
290 Automatic bug finder and test-case reducer description and usage
294 This describes the file format and encoding used for LLVM "bc" files.
296 :doc:`System Library <SystemLibrary>`
297 This document describes the LLVM System Library (``lib/System``) and
298 how to keep LLVM source code portable
300 :doc:`LinkTimeOptimization`
301 This document describes the interface between LLVM intermodular optimizer
302 and the linker and its design
305 How to build your programs with link-time optimization on Linux.
307 :doc:`DebuggingJITedCode`
308 How to debug JITed code with GDB.
310 :doc:`MCJITDesignAndImplementation`
311 Describes the inner workings of MCJIT execution engine.
313 :doc:`BranchWeightMetadata`
314 Provides information about Branch Prediction Information.
316 :doc:`BlockFrequencyTerminology`
317 Provides information about terminology used in the ``BlockFrequencyInfo``
320 :doc:`SegmentedStacks`
321 This document describes segmented stacks and how they are used in LLVM.
323 :doc:`MarkedUpDisassembly`
324 This document describes the optional rich disassembly output syntax.
326 :doc:`HowToUseAttributes`
327 Answers some questions about the new Attributes infrastructure.
330 This document describes using the NVPTX back-end to compile GPU kernels.
333 This document describes how to use the R600 back-end.
336 LLVM support for mapping instruction addresses to the location of
337 values and allowing code to be patched.
340 LLVM's support for generating NEON instructions on big endian ARM targets is
341 somewhat nonintuitive. This document explains the implementation and rationale.
343 :doc:`CoverageMappingFormat`
344 This describes the format and encoding used for LLVM’s code coverage mapping.
347 This describes a set of experimental extensions for garbage
350 :doc:`MergeFunctions`
351 Describes functions merging optimization.
354 Description of the ``inalloca`` argument attribute.
356 Development Process Documentation
357 =================================
359 Information about LLVM's development process.
373 :doc:`DeveloperPolicy`
374 The LLVM project's policy towards developers and their contributions.
377 How-to guide and templates for new projects that *use* the LLVM
378 infrastructure. The templates (directory organization, Makefiles, and test
379 tree) allow the project code to be located outside (or inside) the ``llvm/``
380 tree, while using LLVM header files and libraries.
383 Describes the LLVMBuild organization and files used by LLVM to specify
384 component descriptions.
387 Describes how the LLVM makefiles work and how to use them.
389 :doc:`HowToReleaseLLVM`
390 This is a guide to preparing LLVM releases. Most developers can ignore it.
392 :doc:`ReleaseProcess`
393 This is a guide to validate a new release, during the release process. Most developers can ignore it.
396 Advice on packaging LLVM into a distribution.
399 Describes how to use the Phabricator code review tool hosted on
400 http://reviews.llvm.org/ and its command line interface, Arcanist.
405 LLVM has a thriving community of friendly and helpful developers.
406 The two primary communication mechanisms in the LLVM community are mailing
412 If you can't find what you need in these docs, try consulting the mailing
415 `Developer's List (llvmdev)`__
416 This list is for people who want to be included in technical discussions of
417 LLVM. People post to this list when they have questions about writing code
418 for or using the LLVM tools. It is relatively low volume.
420 .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
422 `Commits Archive (llvm-commits)`__
423 This list contains all commit messages that are made when LLVM developers
424 commit code changes to the repository. It also serves as a forum for
425 patch review (i.e. send patches here). It is useful for those who want to
426 stay on the bleeding edge of LLVM development. This list is very high
429 .. __: http://lists.cs.uiuc.edu/pipermail/llvm-commits/
431 `Bugs & Patches Archive (llvmbugs)`__
432 This list gets emailed every time a bug is opened and closed. It is
433 higher volume than the LLVMdev list.
435 .. __: http://lists.cs.uiuc.edu/pipermail/llvmbugs/
437 `Test Results Archive (llvm-testresults)`__
438 A message is automatically sent to this list by every active nightly tester
439 when it completes. As such, this list gets email several times each day,
440 making it a high volume list.
442 .. __: http://lists.cs.uiuc.edu/pipermail/llvm-testresults/
444 `LLVM Announcements List (llvm-announce)`__
445 This is a low volume list that provides important announcements regarding
446 LLVM. It gets email about once a month.
448 .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce
453 Users and developers of the LLVM project (including subprojects such as Clang)
454 can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
456 This channel has several bots.
460 * llvmbb - Bot for the main LLVM buildbot master.
461 http://lab.llvm.org:8011/console
462 * bb-chapuni - An individually run buildbot master. http://bb.pgr.jp/console
463 * smooshlab - Apple's internal buildbot master.
465 * robot - Bugzilla linker. %bug <number>
467 * clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
468 near-trunk clang instead of gcc.