blob: 8f22ef2a774c44750e941ad7c10414cd03544c9d [file] [log] [blame]
Daniel Dunbarfbb80412012-04-19 16:31:37 +00001Overview
2========
3
4.. warning::
5
6 If you are using a released version of LLVM, see `the download page
7 <http://llvm.org/releases/>`_ to find your documentation.
8
9The LLVM compiler infrastructure supports a wide range of projects, from
10industrial strength compilers to specialized JIT applications to small
11research projects.
12
13Similarly, documentation is broken down into several high-level groupings
Benjamin Kramerbde91762012-06-02 10:20:22 +000014targeted at different audiences:
Daniel Dunbarfbb80412012-04-19 16:31:37 +000015
Sean Silva12159ff2013-01-20 02:19:36 +000016LLVM Design & Overview
17======================
Daniel Dunbarfbb80412012-04-19 16:31:37 +000018
Sean Silva12159ff2013-01-20 02:19:36 +000019Several introductory papers and presentations.
Daniel Dunbarfbb80412012-04-19 16:31:37 +000020
21.. toctree::
Sean Silva12159ff2013-01-20 02:19:36 +000022 :hidden:
Daniel Dunbarfbb80412012-04-19 16:31:37 +000023
Sean Silva12159ff2013-01-20 02:19:36 +000024 LangRef
25 GetElementPtr
26
Sean Silva9d0eb942013-01-20 02:19:42 +000027:doc:`LangRef`
Sean Silva12159ff2013-01-20 02:19:36 +000028 Defines the LLVM intermediate representation.
29
Sean Silva9d0eb942013-01-20 02:19:42 +000030`Introduction to the LLVM Compiler`__
Sean Silva12159ff2013-01-20 02:19:36 +000031 Presentation providing a users introduction to LLVM.
32
Sean Silva9d0eb942013-01-20 02:19:42 +000033 .. __: http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html
Sean Silva12159ff2013-01-20 02:19:36 +000034
Sean Silva9d0eb942013-01-20 02:19:42 +000035`Intro to LLVM`__
Sean Silva12159ff2013-01-20 02:19:36 +000036 Book chapter providing a compiler hacker's introduction to LLVM.
37
Sean Silva9d0eb942013-01-20 02:19:42 +000038 .. __: http://www.aosabook.org/en/llvm.html
Sean Silva12159ff2013-01-20 02:19:36 +000039
Sean Silva9d0eb942013-01-20 02:19:42 +000040
41`LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation`__
Sean Silva12159ff2013-01-20 02:19:36 +000042 Design overview.
43
Sean Silva9d0eb942013-01-20 02:19:42 +000044 .. __: http://llvm.org/pubs/2004-01-30-CGO-LLVM.html
Sean Silva12159ff2013-01-20 02:19:36 +000045
Sean Silva9d0eb942013-01-20 02:19:42 +000046`LLVM: An Infrastructure for Multi-Stage Optimization`__
Sean Silva12159ff2013-01-20 02:19:36 +000047 More details (quite old now).
48
Sean Silva9d0eb942013-01-20 02:19:42 +000049 .. __: http://llvm.org/pubs/2002-12-LattnerMSThesis.html
Sean Silva12159ff2013-01-20 02:19:36 +000050
Sean Silva9d0eb942013-01-20 02:19:42 +000051:doc:`GetElementPtr`
Sean Silva12159ff2013-01-20 02:19:36 +000052 Answers to some very frequent questions about LLVM's most frequently
53 misunderstood instruction.
54
Sean Silva9d0eb942013-01-20 02:19:42 +000055`Publications mentioning LLVM <http://llvm.org/pubs>`_
56 ..
Sean Silva12159ff2013-01-20 02:19:36 +000057
58User Guides
59===========
60
61For those new to the LLVM system.
62
63NOTE: If you are a user who is only interested in using LLVM-based
64compilers, you should look into `Clang <http://clang.llvm.org>`_ or
65`DragonEgg <http://dragonegg.llvm.org>`_ instead. The documentation here is
66intended for users who have a need to work with the intermediate LLVM
67representation.
68
69.. toctree::
70 :hidden:
71
72 CMake
73 HowToBuildOnARM
74 CommandGuide/index
75 DeveloperPolicy
76 GettingStarted
77 GettingStartedVS
78 FAQ
79 Lexicon
Sean Silva12159ff2013-01-20 02:19:36 +000080 HowToAddABuilder
81 yaml2obj
82 HowToSubmitABug
83 SphinxQuickstartTemplate
84 Phabricator
85 TestingGuide
86 tutorial/index
87 ReleaseNotes
88 Passes
89 YamlIO
90
Sean Silva9d0eb942013-01-20 02:19:42 +000091:doc:`GettingStarted`
Sean Silva12159ff2013-01-20 02:19:36 +000092 Discusses how to get up and running quickly with the LLVM infrastructure.
93 Everything from unpacking and compilation of the distribution to execution
94 of some tools.
95
Sean Silva9d0eb942013-01-20 02:19:42 +000096:doc:`CMake`
Sean Silva12159ff2013-01-20 02:19:36 +000097 An addendum to the main Getting Started guide for those using the `CMake
98 build system <http://www.cmake.org>`_.
99
Sean Silva9d0eb942013-01-20 02:19:42 +0000100:doc:`HowToBuildOnARM`
Sean Silva12159ff2013-01-20 02:19:36 +0000101 Notes on building and testing LLVM/Clang on ARM.
102
Sean Silva9d0eb942013-01-20 02:19:42 +0000103:doc:`GettingStartedVS`
Sean Silva12159ff2013-01-20 02:19:36 +0000104 An addendum to the main Getting Started guide for those using Visual Studio
105 on Windows.
106
Sean Silva9d0eb942013-01-20 02:19:42 +0000107:doc:`tutorial/index`
Sean Silva12159ff2013-01-20 02:19:36 +0000108 Tutorials about using LLVM. Includes a tutorial about making a custom
109 language with LLVM.
110
Sean Silva9d0eb942013-01-20 02:19:42 +0000111:doc:`DeveloperPolicy`
Sean Silva12159ff2013-01-20 02:19:36 +0000112 The LLVM project's policy towards developers and their contributions.
113
Sean Silva9d0eb942013-01-20 02:19:42 +0000114:doc:`LLVM Command Guide <CommandGuide/index>`
Sean Silva12159ff2013-01-20 02:19:36 +0000115 A reference manual for the LLVM command line utilities ("man" pages for LLVM
116 tools).
117
Sean Silva9d0eb942013-01-20 02:19:42 +0000118:doc:`Passes`
Sean Silva12159ff2013-01-20 02:19:36 +0000119 A list of optimizations and analyses implemented in LLVM.
120
Sean Silva9d0eb942013-01-20 02:19:42 +0000121:doc:`FAQ`
Sean Silva12159ff2013-01-20 02:19:36 +0000122 A list of common questions and problems and their solutions.
123
Sean Silva9d0eb942013-01-20 02:19:42 +0000124:doc:`Release notes for the current release <ReleaseNotes>`
Sean Silva12159ff2013-01-20 02:19:36 +0000125 This describes new features, known bugs, and other limitations.
126
Sean Silva9d0eb942013-01-20 02:19:42 +0000127:doc:`HowToSubmitABug`
Sean Silva12159ff2013-01-20 02:19:36 +0000128 Instructions for properly submitting information about any bugs you run into
129 in the LLVM system.
Sean Silva12159ff2013-01-20 02:19:36 +0000130
Sean Silva9d0eb942013-01-20 02:19:42 +0000131:doc:`SphinxQuickstartTemplate`
Sean Silva12159ff2013-01-20 02:19:36 +0000132 A template + tutorial for writing new Sphinx documentation. It is meant
133 to be read in source form.
134
Sean Silva9d0eb942013-01-20 02:19:42 +0000135:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
Sean Silva12159ff2013-01-20 02:19:36 +0000136 A reference manual for using the LLVM testing infrastructure.
137
Sean Silva9d0eb942013-01-20 02:19:42 +0000138`How to build the C, C++, ObjC, and ObjC++ front end`__
Sean Silva12159ff2013-01-20 02:19:36 +0000139 Instructions for building the clang front-end from source.
140
Sean Silva9d0eb942013-01-20 02:19:42 +0000141 .. __: http://clang.llvm.org/get_started.html
Sean Silva12159ff2013-01-20 02:19:36 +0000142
Sean Silva9d0eb942013-01-20 02:19:42 +0000143:doc:`Lexicon`
Sean Silva12159ff2013-01-20 02:19:36 +0000144 Definition of acronyms, terms and concepts used in LLVM.
145
Sean Silva9d0eb942013-01-20 02:19:42 +0000146:doc:`HowToAddABuilder`
Sean Silva12159ff2013-01-20 02:19:36 +0000147 Instructions for adding new builder to LLVM buildbot master.
148
Sean Silva9d0eb942013-01-20 02:19:42 +0000149:doc:`YamlIO`
Sean Silva12159ff2013-01-20 02:19:36 +0000150 A reference guide for using LLVM's YAML I/O library.
151
152IRC
153===
154
Michael J. Spencer0ad0f5e2013-01-20 09:38:14 +0000155Users and developers of the LLVM project (including subprojects such as Clang)
156can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
Sean Silva12159ff2013-01-20 02:19:36 +0000157
Michael J. Spencer0ad0f5e2013-01-20 09:38:14 +0000158This channel has several bots.
159
160* Buildbot reporters
161
162 * llvmbb - Bot for the main LLVM buildbot master.
163 http://lab.llvm.org:8011/console
164 * bb-chapuni - An individually run buildbot master. http://bb.pgr.jp/console
165 * smooshlab - Apple's internal buildbot master.
166
167* robot - Bugzilla linker. %bug <number>
168
169* clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
170 near-trunk clang instead of gcc.
Sean Silva12159ff2013-01-20 02:19:36 +0000171
172Programming Documentation
173=========================
174
175For developers of applications which use LLVM as a library.
176
177.. toctree::
178 :hidden:
179
180 Atomics
181 CodingStandards
182 CommandLine
183 CompilerWriterInfo
184 ExtendingLLVM
185 HowToSetUpLLVMStyleRTTI
186 ProgrammersManual
187
Sean Silva9d0eb942013-01-20 02:19:42 +0000188:doc:`LLVM Language Reference Manual <LangRef>`
Sean Silva12159ff2013-01-20 02:19:36 +0000189 Defines the LLVM intermediate representation and the assembly form of the
190 different nodes.
191
Sean Silva9d0eb942013-01-20 02:19:42 +0000192:doc:`Atomics`
Sean Silva12159ff2013-01-20 02:19:36 +0000193 Information about LLVM's concurrency model.
194
Sean Silva9d0eb942013-01-20 02:19:42 +0000195:doc:`ProgrammersManual`
Sean Silva12159ff2013-01-20 02:19:36 +0000196 Introduction to the general layout of the LLVM sourcebase, important classes
197 and APIs, and some tips & tricks.
198
Sean Silva9d0eb942013-01-20 02:19:42 +0000199:doc:`CommandLine`
Sean Silva12159ff2013-01-20 02:19:36 +0000200 Provides information on using the command line parsing library.
201
Sean Silva9d0eb942013-01-20 02:19:42 +0000202:doc:`CodingStandards`
Sean Silva12159ff2013-01-20 02:19:36 +0000203 Details the LLVM coding standards and provides useful information on writing
204 efficient C++ code.
205
Sean Silva9d0eb942013-01-20 02:19:42 +0000206:doc:`HowToSetUpLLVMStyleRTTI`
Sean Silva12159ff2013-01-20 02:19:36 +0000207 How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
208 class hierarchy.
209
Sean Silva9d0eb942013-01-20 02:19:42 +0000210:doc:`ExtendingLLVM`
Sean Silva12159ff2013-01-20 02:19:36 +0000211 Look here to see how to add instructions and intrinsics to LLVM.
212
Sean Silva9d0eb942013-01-20 02:19:42 +0000213`Doxygen generated documentation <http://llvm.org/doxygen/>`_
Sean Silva12159ff2013-01-20 02:19:36 +0000214 (`classes <http://llvm.org/doxygen/inherits.html>`_)
215 (`tarball <http://llvm.org/doxygen/doxygen.tar.gz>`_)
216
Sean Silva9d0eb942013-01-20 02:19:42 +0000217`ViewVC Repository Browser <http://llvm.org/viewvc/>`_
218 ..
Sean Silva12159ff2013-01-20 02:19:36 +0000219
Sean Silva9d0eb942013-01-20 02:19:42 +0000220:doc:`CompilerWriterInfo`
Sean Silva12159ff2013-01-20 02:19:36 +0000221 A list of helpful links for compiler writers.
222
223Subsystem Documentation
224=======================
225
226For API clients and LLVM developers.
227
228.. toctree::
229 :hidden:
230
231 AliasAnalysis
232 BitCodeFormat
233 BranchWeightMetadata
234 Bugpoint
235 CodeGenerator
236 ExceptionHandling
237 LinkTimeOptimization
238 SegmentedStacks
239 TableGenFundamentals
240 DebuggingJITedCode
241 GoldPlugin
242 MarkedUpDisassembly
243 SystemLibrary
244 SourceLevelDebugging
245 Vectorizers
246 WritingAnLLVMBackend
247 GarbageCollection
248 WritingAnLLVMPass
249 TableGen/LangRef
Joe Abbeyba3e9012013-02-12 11:45:22 +0000250 HowToUseAttributes
Sean Silva12159ff2013-01-20 02:19:36 +0000251
Sean Silva9d0eb942013-01-20 02:19:42 +0000252:doc:`WritingAnLLVMPass`
Sean Silva12159ff2013-01-20 02:19:36 +0000253 Information on how to write LLVM transformations and analyses.
254
Sean Silva9d0eb942013-01-20 02:19:42 +0000255:doc:`WritingAnLLVMBackend`
Sean Silva12159ff2013-01-20 02:19:36 +0000256 Information on how to write LLVM backends for machine targets.
257
Sean Silva9d0eb942013-01-20 02:19:42 +0000258:doc:`CodeGenerator`
Sean Silva12159ff2013-01-20 02:19:36 +0000259 The design and implementation of the LLVM code generator. Useful if you are
260 working on retargetting LLVM to a new architecture, designing a new codegen
261 pass, or enhancing existing components.
262
Sean Silva9d0eb942013-01-20 02:19:42 +0000263:doc:`TableGenFundamentals`
Sean Silva12159ff2013-01-20 02:19:36 +0000264 Describes the TableGen tool, which is used heavily by the LLVM code
265 generator.
266
Sean Silva9d0eb942013-01-20 02:19:42 +0000267:doc:`AliasAnalysis`
Sean Silva12159ff2013-01-20 02:19:36 +0000268 Information on how to write a new alias analysis implementation or how to
269 use existing analyses.
270
Sean Silva9d0eb942013-01-20 02:19:42 +0000271:doc:`GarbageCollection`
Sean Silva12159ff2013-01-20 02:19:36 +0000272 The interfaces source-language compilers should use for compiling GC'd
273 programs.
274
Sean Silva9d0eb942013-01-20 02:19:42 +0000275:doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
Sean Silva12159ff2013-01-20 02:19:36 +0000276 This document describes the design and philosophy behind the LLVM
277 source-level debugger.
278
Sean Silva9d0eb942013-01-20 02:19:42 +0000279:doc:`Vectorizers`
Sean Silva12159ff2013-01-20 02:19:36 +0000280 This document describes the current status of vectorization in LLVM.
281
Sean Silva9d0eb942013-01-20 02:19:42 +0000282:doc:`ExceptionHandling`
Sean Silva12159ff2013-01-20 02:19:36 +0000283 This document describes the design and implementation of exception handling
284 in LLVM.
285
Sean Silva9d0eb942013-01-20 02:19:42 +0000286:doc:`Bugpoint`
Sean Silva12159ff2013-01-20 02:19:36 +0000287 Automatic bug finder and test-case reducer description and usage
288 information.
289
Sean Silva9d0eb942013-01-20 02:19:42 +0000290:doc:`BitCodeFormat`
Sean Silva12159ff2013-01-20 02:19:36 +0000291 This describes the file format and encoding used for LLVM "bc" files.
292
Sean Silva9d0eb942013-01-20 02:19:42 +0000293:doc:`System Library <SystemLibrary>`
Sean Silva12159ff2013-01-20 02:19:36 +0000294 This document describes the LLVM System Library (``lib/System``) and
295 how to keep LLVM source code portable
296
Sean Silva9d0eb942013-01-20 02:19:42 +0000297:doc:`LinkTimeOptimization`
Sean Silva12159ff2013-01-20 02:19:36 +0000298 This document describes the interface between LLVM intermodular optimizer
299 and the linker and its design
300
Sean Silva9d0eb942013-01-20 02:19:42 +0000301:doc:`GoldPlugin`
Sean Silva12159ff2013-01-20 02:19:36 +0000302 How to build your programs with link-time optimization on Linux.
303
Sean Silva9d0eb942013-01-20 02:19:42 +0000304:doc:`DebuggingJITedCode`
Sean Silva12159ff2013-01-20 02:19:36 +0000305 How to debug JITed code with GDB.
306
Sean Silva9d0eb942013-01-20 02:19:42 +0000307:doc:`BranchWeightMetadata`
Sean Silva12159ff2013-01-20 02:19:36 +0000308 Provides information about Branch Prediction Information.
309
Sean Silva9d0eb942013-01-20 02:19:42 +0000310:doc:`SegmentedStacks`
Sean Silva12159ff2013-01-20 02:19:36 +0000311 This document describes segmented stacks and how they are used in LLVM.
312
Sean Silva9d0eb942013-01-20 02:19:42 +0000313:doc:`MarkedUpDisassembly`
Sean Silva12159ff2013-01-20 02:19:36 +0000314 This document describes the optional rich disassembly output syntax.
315
Joe Abbeyba3e9012013-02-12 11:45:22 +0000316:doc:`HowToUseAttributes`
317 Answers some questions about the new Attributes infrastructure.
Sean Silva12159ff2013-01-20 02:19:36 +0000318
319Development Process Documentation
320=================================
321
Sean Silva12159ff2013-01-20 02:19:36 +0000322Information about LLVM's development process.
323
324.. toctree::
325 :hidden:
326
327 MakefileGuide
328 Projects
329 LLVMBuild
330 HowToReleaseLLVM
Sean Silvabdb940f2013-01-28 21:28:10 +0000331 Packaging
Sean Silva12159ff2013-01-20 02:19:36 +0000332
Sean Silva9d0eb942013-01-20 02:19:42 +0000333:doc:`Projects`
Sean Silva12159ff2013-01-20 02:19:36 +0000334 How-to guide and templates for new projects that *use* the LLVM
335 infrastructure. The templates (directory organization, Makefiles, and test
336 tree) allow the project code to be located outside (or inside) the ``llvm/``
337 tree, while using LLVM header files and libraries.
338
Sean Silva9d0eb942013-01-20 02:19:42 +0000339:doc:`LLVMBuild`
Sean Silva12159ff2013-01-20 02:19:36 +0000340 Describes the LLVMBuild organization and files used by LLVM to specify
341 component descriptions.
342
Sean Silva9d0eb942013-01-20 02:19:42 +0000343:doc:`MakefileGuide`
Sean Silva12159ff2013-01-20 02:19:36 +0000344 Describes how the LLVM makefiles work and how to use them.
345
Sean Silva9d0eb942013-01-20 02:19:42 +0000346:doc:`HowToReleaseLLVM`
Sean Silva12159ff2013-01-20 02:19:36 +0000347 This is a guide to preparing LLVM releases. Most developers can ignore it.
348
Sean Silvabdb940f2013-01-28 21:28:10 +0000349:doc:`Packaging`
350 Advice on packaging LLVM into a distribution.
351
Sean Silva12159ff2013-01-20 02:19:36 +0000352Mailing Lists
353=============
354
355If you can't find what you need in these docs, try consulting the mailing
356lists.
357
Sean Silva9d0eb942013-01-20 02:19:42 +0000358`LLVM Announcements List`__
Sean Silva12159ff2013-01-20 02:19:36 +0000359 This is a low volume list that provides important announcements regarding
360 LLVM. It gets email about once a month.
361
Sean Silva9d0eb942013-01-20 02:19:42 +0000362 .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce
Sean Silva12159ff2013-01-20 02:19:36 +0000363
Sean Silva9d0eb942013-01-20 02:19:42 +0000364`Developer's List`__
Sean Silva12159ff2013-01-20 02:19:36 +0000365 This list is for people who want to be included in technical discussions of
366 LLVM. People post to this list when they have questions about writing code
367 for or using the LLVM tools. It is relatively low volume.
368
Sean Silva9d0eb942013-01-20 02:19:42 +0000369 .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
Sean Silva12159ff2013-01-20 02:19:36 +0000370
Sean Silva9d0eb942013-01-20 02:19:42 +0000371`Bugs & Patches Archive`__
Sean Silva12159ff2013-01-20 02:19:36 +0000372 This list gets emailed every time a bug is opened and closed, and when people
373 submit patches to be included in LLVM. It is higher volume than the LLVMdev
374 list.
375
Sean Silva9d0eb942013-01-20 02:19:42 +0000376 .. __: http://lists.cs.uiuc.edu/pipermail/llvmbugs/
Sean Silva12159ff2013-01-20 02:19:36 +0000377
Sean Silva9d0eb942013-01-20 02:19:42 +0000378`Commits Archive`__
Sean Silva12159ff2013-01-20 02:19:36 +0000379 This list contains all commit messages that are made when LLVM developers
380 commit code changes to the repository. It is useful for those who want to
381 stay on the bleeding edge of LLVM development. This list is very high volume.
382
Sean Silva9d0eb942013-01-20 02:19:42 +0000383 .. __: http://lists.cs.uiuc.edu/pipermail/llvm-commits/
Sean Silva12159ff2013-01-20 02:19:36 +0000384
Sean Silva9d0eb942013-01-20 02:19:42 +0000385`Test Results Archive`__
Sean Silva12159ff2013-01-20 02:19:36 +0000386 A message is automatically sent to this list by every active nightly tester
387 when it completes. As such, this list gets email several times each day,
388 making it a high volume list.
389
Sean Silva9d0eb942013-01-20 02:19:42 +0000390 .. __: http://lists.cs.uiuc.edu/pipermail/llvm-testresults/
391
Daniel Dunbarfbb80412012-04-19 16:31:37 +0000392Indices and tables
393==================
394
395* :ref:`genindex`
396* :ref:`search`