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 `ViewVC Repository Browser <http://llvm.org/viewvc/>`_
205 :doc:`CompilerWriterInfo`
206 A list of helpful links for compiler writers.
208 Subsystem Documentation
209 =======================
211 For API clients and LLVM developers.
218 BlockFrequencyTerminology
241 CoverageMappingFormat
243 :doc:`WritingAnLLVMPass`
244 Information on how to write LLVM transformations and analyses.
246 :doc:`WritingAnLLVMBackend`
247 Information on how to write LLVM backends for machine targets.
250 The design and implementation of the LLVM code generator. Useful if you are
251 working on retargetting LLVM to a new architecture, designing a new codegen
252 pass, or enhancing existing components.
254 :doc:`TableGen <TableGen/index>`
255 Describes the TableGen tool, which is used heavily by the LLVM code
259 Information on how to write a new alias analysis implementation or how to
260 use existing analyses.
262 :doc:`GarbageCollection`
263 The interfaces source-language compilers should use for compiling GC'd
266 :doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
267 This document describes the design and philosophy behind the LLVM
268 source-level debugger.
271 This document describes the current status of vectorization in LLVM.
273 :doc:`ExceptionHandling`
274 This document describes the design and implementation of exception handling
278 Automatic bug finder and test-case reducer description and usage
282 This describes the file format and encoding used for LLVM "bc" files.
284 :doc:`System Library <SystemLibrary>`
285 This document describes the LLVM System Library (``lib/System``) and
286 how to keep LLVM source code portable
288 :doc:`LinkTimeOptimization`
289 This document describes the interface between LLVM intermodular optimizer
290 and the linker and its design
293 How to build your programs with link-time optimization on Linux.
295 :doc:`DebuggingJITedCode`
296 How to debug JITed code with GDB.
298 :doc:`MCJITDesignAndImplementation`
299 Describes the inner workings of MCJIT execution engine.
301 :doc:`BranchWeightMetadata`
302 Provides information about Branch Prediction Information.
304 :doc:`BlockFrequencyTerminology`
305 Provides information about terminology used in the ``BlockFrequencyInfo``
308 :doc:`SegmentedStacks`
309 This document describes segmented stacks and how they are used in LLVM.
311 :doc:`MarkedUpDisassembly`
312 This document describes the optional rich disassembly output syntax.
314 :doc:`HowToUseAttributes`
315 Answers some questions about the new Attributes infrastructure.
318 This document describes using the NVPTX back-end to compile GPU kernels.
321 LLVM support for mapping instruction addresses to the location of
322 values and allowing code to be patched.
325 LLVM's support for generating NEON instructions on big endian ARM targets is
326 somewhat nonintuitive. This document explains the implementation and rationale.
328 :doc:`CoverageMappingFormat`
329 This describes the format and encoding used for LLVM’s code coverage mapping.
331 Development Process Documentation
332 =================================
334 Information about LLVM's development process.
347 :doc:`DeveloperPolicy`
348 The LLVM project's policy towards developers and their contributions.
351 How-to guide and templates for new projects that *use* the LLVM
352 infrastructure. The templates (directory organization, Makefiles, and test
353 tree) allow the project code to be located outside (or inside) the ``llvm/``
354 tree, while using LLVM header files and libraries.
357 Describes the LLVMBuild organization and files used by LLVM to specify
358 component descriptions.
361 Describes how the LLVM makefiles work and how to use them.
363 :doc:`HowToReleaseLLVM`
364 This is a guide to preparing LLVM releases. Most developers can ignore it.
366 :doc:`ReleaseProcess`
367 This is a validate a new release, during the release process. Most developers can ignore it.
370 Advice on packaging LLVM into a distribution.
375 LLVM has a thriving community of friendly and helpful developers.
376 The two primary communication mechanisms in the LLVM community are mailing
382 If you can't find what you need in these docs, try consulting the mailing
385 `Developer's List (llvmdev)`__
386 This list is for people who want to be included in technical discussions of
387 LLVM. People post to this list when they have questions about writing code
388 for or using the LLVM tools. It is relatively low volume.
390 .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
392 `Commits Archive (llvm-commits)`__
393 This list contains all commit messages that are made when LLVM developers
394 commit code changes to the repository. It also serves as a forum for
395 patch review (i.e. send patches here). It is useful for those who want to
396 stay on the bleeding edge of LLVM development. This list is very high
399 .. __: http://lists.cs.uiuc.edu/pipermail/llvm-commits/
401 `Bugs & Patches Archive (llvmbugs)`__
402 This list gets emailed every time a bug is opened and closed. It is
403 higher volume than the LLVMdev list.
405 .. __: http://lists.cs.uiuc.edu/pipermail/llvmbugs/
407 `Test Results Archive (llvm-testresults)`__
408 A message is automatically sent to this list by every active nightly tester
409 when it completes. As such, this list gets email several times each day,
410 making it a high volume list.
412 .. __: http://lists.cs.uiuc.edu/pipermail/llvm-testresults/
414 `LLVM Announcements List (llvm-announce)`__
415 This is a low volume list that provides important announcements regarding
416 LLVM. It gets email about once a month.
418 .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce
423 Users and developers of the LLVM project (including subprojects such as Clang)
424 can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
426 This channel has several bots.
430 * llvmbb - Bot for the main LLVM buildbot master.
431 http://lab.llvm.org:8011/console
432 * bb-chapuni - An individually run buildbot master. http://bb.pgr.jp/console
433 * smooshlab - Apple's internal buildbot master.
435 * robot - Bugzilla linker. %bug <number>
437 * clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
438 near-trunk clang instead of gcc.