blob: ef8b2c350f707dde9694e0d6944e550c709ed83e [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
Sean Silva12159ff2013-01-20 02:19:36 +000025
Sean Silva9d0eb942013-01-20 02:19:42 +000026:doc:`LangRef`
Sean Silva12159ff2013-01-20 02:19:36 +000027 Defines the LLVM intermediate representation.
28
Sean Silva9d0eb942013-01-20 02:19:42 +000029`Introduction to the LLVM Compiler`__
Sean Silva12159ff2013-01-20 02:19:36 +000030 Presentation providing a users introduction to LLVM.
31
Sean Silva9d0eb942013-01-20 02:19:42 +000032 .. __: http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html
Sean Silva12159ff2013-01-20 02:19:36 +000033
Sean Silva9d0eb942013-01-20 02:19:42 +000034`Intro to LLVM`__
Sean Silva12159ff2013-01-20 02:19:36 +000035 Book chapter providing a compiler hacker's introduction to LLVM.
36
Sean Silva9d0eb942013-01-20 02:19:42 +000037 .. __: http://www.aosabook.org/en/llvm.html
Sean Silva12159ff2013-01-20 02:19:36 +000038
Sean Silva9d0eb942013-01-20 02:19:42 +000039
40`LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation`__
Sean Silva12159ff2013-01-20 02:19:36 +000041 Design overview.
42
Sean Silva9d0eb942013-01-20 02:19:42 +000043 .. __: http://llvm.org/pubs/2004-01-30-CGO-LLVM.html
Sean Silva12159ff2013-01-20 02:19:36 +000044
Sean Silva9d0eb942013-01-20 02:19:42 +000045`LLVM: An Infrastructure for Multi-Stage Optimization`__
Sean Silva12159ff2013-01-20 02:19:36 +000046 More details (quite old now).
47
Sean Silva9d0eb942013-01-20 02:19:42 +000048 .. __: http://llvm.org/pubs/2002-12-LattnerMSThesis.html
Sean Silva12159ff2013-01-20 02:19:36 +000049
Sean Silva9d0eb942013-01-20 02:19:42 +000050`Publications mentioning LLVM <http://llvm.org/pubs>`_
51 ..
Sean Silva12159ff2013-01-20 02:19:36 +000052
53User Guides
54===========
55
56For those new to the LLVM system.
57
58NOTE: If you are a user who is only interested in using LLVM-based
59compilers, you should look into `Clang <http://clang.llvm.org>`_ or
60`DragonEgg <http://dragonegg.llvm.org>`_ instead. The documentation here is
61intended for users who have a need to work with the intermediate LLVM
62representation.
63
64.. toctree::
65 :hidden:
66
67 CMake
68 HowToBuildOnARM
69 CommandGuide/index
Sean Silva12159ff2013-01-20 02:19:36 +000070 GettingStarted
71 GettingStartedVS
72 FAQ
73 Lexicon
Sean Silva12159ff2013-01-20 02:19:36 +000074 HowToAddABuilder
75 yaml2obj
76 HowToSubmitABug
77 SphinxQuickstartTemplate
78 Phabricator
79 TestingGuide
80 tutorial/index
81 ReleaseNotes
82 Passes
83 YamlIO
Sean Silva163b5c42013-03-30 15:32:50 +000084 GetElementPtr
Sean Silva12159ff2013-01-20 02:19:36 +000085
Sean Silva9d0eb942013-01-20 02:19:42 +000086:doc:`GettingStarted`
Sean Silva12159ff2013-01-20 02:19:36 +000087 Discusses how to get up and running quickly with the LLVM infrastructure.
88 Everything from unpacking and compilation of the distribution to execution
89 of some tools.
90
Sean Silva9d0eb942013-01-20 02:19:42 +000091:doc:`CMake`
Sean Silva12159ff2013-01-20 02:19:36 +000092 An addendum to the main Getting Started guide for those using the `CMake
93 build system <http://www.cmake.org>`_.
94
Sean Silva9d0eb942013-01-20 02:19:42 +000095:doc:`HowToBuildOnARM`
Sean Silva12159ff2013-01-20 02:19:36 +000096 Notes on building and testing LLVM/Clang on ARM.
97
Sean Silva9d0eb942013-01-20 02:19:42 +000098:doc:`GettingStartedVS`
Sean Silva12159ff2013-01-20 02:19:36 +000099 An addendum to the main Getting Started guide for those using Visual Studio
100 on Windows.
101
Sean Silva9d0eb942013-01-20 02:19:42 +0000102:doc:`tutorial/index`
Sean Silva12159ff2013-01-20 02:19:36 +0000103 Tutorials about using LLVM. Includes a tutorial about making a custom
104 language with LLVM.
105
Sean Silva9d0eb942013-01-20 02:19:42 +0000106:doc:`LLVM Command Guide <CommandGuide/index>`
Sean Silva12159ff2013-01-20 02:19:36 +0000107 A reference manual for the LLVM command line utilities ("man" pages for LLVM
108 tools).
109
Sean Silva9d0eb942013-01-20 02:19:42 +0000110:doc:`Passes`
Sean Silva12159ff2013-01-20 02:19:36 +0000111 A list of optimizations and analyses implemented in LLVM.
112
Sean Silva9d0eb942013-01-20 02:19:42 +0000113:doc:`FAQ`
Sean Silva12159ff2013-01-20 02:19:36 +0000114 A list of common questions and problems and their solutions.
115
Sean Silva9d0eb942013-01-20 02:19:42 +0000116:doc:`Release notes for the current release <ReleaseNotes>`
Sean Silva12159ff2013-01-20 02:19:36 +0000117 This describes new features, known bugs, and other limitations.
118
Sean Silva9d0eb942013-01-20 02:19:42 +0000119:doc:`HowToSubmitABug`
Sean Silva12159ff2013-01-20 02:19:36 +0000120 Instructions for properly submitting information about any bugs you run into
121 in the LLVM system.
Sean Silva12159ff2013-01-20 02:19:36 +0000122
Sean Silva9d0eb942013-01-20 02:19:42 +0000123:doc:`SphinxQuickstartTemplate`
Sean Silva12159ff2013-01-20 02:19:36 +0000124 A template + tutorial for writing new Sphinx documentation. It is meant
125 to be read in source form.
126
Sean Silva9d0eb942013-01-20 02:19:42 +0000127:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
Sean Silva12159ff2013-01-20 02:19:36 +0000128 A reference manual for using the LLVM testing infrastructure.
129
Sean Silva9d0eb942013-01-20 02:19:42 +0000130`How to build the C, C++, ObjC, and ObjC++ front end`__
Sean Silva12159ff2013-01-20 02:19:36 +0000131 Instructions for building the clang front-end from source.
132
Sean Silva9d0eb942013-01-20 02:19:42 +0000133 .. __: http://clang.llvm.org/get_started.html
Sean Silva12159ff2013-01-20 02:19:36 +0000134
Sean Silva9d0eb942013-01-20 02:19:42 +0000135:doc:`Lexicon`
Sean Silva12159ff2013-01-20 02:19:36 +0000136 Definition of acronyms, terms and concepts used in LLVM.
137
Sean Silva9d0eb942013-01-20 02:19:42 +0000138:doc:`HowToAddABuilder`
Sean Silva12159ff2013-01-20 02:19:36 +0000139 Instructions for adding new builder to LLVM buildbot master.
140
Sean Silva9d0eb942013-01-20 02:19:42 +0000141:doc:`YamlIO`
Sean Silva12159ff2013-01-20 02:19:36 +0000142 A reference guide for using LLVM's YAML I/O library.
143
Sean Silva163b5c42013-03-30 15:32:50 +0000144:doc:`GetElementPtr`
145 Answers to some very frequent questions about LLVM's most frequently
146 misunderstood instruction.
147
Sean Silva12159ff2013-01-20 02:19:36 +0000148Programming Documentation
149=========================
150
151For developers of applications which use LLVM as a library.
152
153.. toctree::
154 :hidden:
155
156 Atomics
157 CodingStandards
158 CommandLine
159 CompilerWriterInfo
160 ExtendingLLVM
161 HowToSetUpLLVMStyleRTTI
162 ProgrammersManual
163
Sean Silva9d0eb942013-01-20 02:19:42 +0000164:doc:`LLVM Language Reference Manual <LangRef>`
Sean Silva12159ff2013-01-20 02:19:36 +0000165 Defines the LLVM intermediate representation and the assembly form of the
166 different nodes.
167
Sean Silva9d0eb942013-01-20 02:19:42 +0000168:doc:`Atomics`
Sean Silva12159ff2013-01-20 02:19:36 +0000169 Information about LLVM's concurrency model.
170
Sean Silva9d0eb942013-01-20 02:19:42 +0000171:doc:`ProgrammersManual`
Sean Silva12159ff2013-01-20 02:19:36 +0000172 Introduction to the general layout of the LLVM sourcebase, important classes
173 and APIs, and some tips & tricks.
174
Sean Silva9d0eb942013-01-20 02:19:42 +0000175:doc:`CommandLine`
Sean Silva12159ff2013-01-20 02:19:36 +0000176 Provides information on using the command line parsing library.
177
Sean Silva9d0eb942013-01-20 02:19:42 +0000178:doc:`CodingStandards`
Sean Silva12159ff2013-01-20 02:19:36 +0000179 Details the LLVM coding standards and provides useful information on writing
180 efficient C++ code.
181
Sean Silva9d0eb942013-01-20 02:19:42 +0000182:doc:`HowToSetUpLLVMStyleRTTI`
Sean Silva12159ff2013-01-20 02:19:36 +0000183 How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
184 class hierarchy.
185
Sean Silva9d0eb942013-01-20 02:19:42 +0000186:doc:`ExtendingLLVM`
Sean Silva12159ff2013-01-20 02:19:36 +0000187 Look here to see how to add instructions and intrinsics to LLVM.
188
Sean Silva9d0eb942013-01-20 02:19:42 +0000189`Doxygen generated documentation <http://llvm.org/doxygen/>`_
Sean Silva12159ff2013-01-20 02:19:36 +0000190 (`classes <http://llvm.org/doxygen/inherits.html>`_)
191 (`tarball <http://llvm.org/doxygen/doxygen.tar.gz>`_)
192
Sean Silva9d0eb942013-01-20 02:19:42 +0000193`ViewVC Repository Browser <http://llvm.org/viewvc/>`_
194 ..
Sean Silva12159ff2013-01-20 02:19:36 +0000195
Sean Silva9d0eb942013-01-20 02:19:42 +0000196:doc:`CompilerWriterInfo`
Sean Silva12159ff2013-01-20 02:19:36 +0000197 A list of helpful links for compiler writers.
198
199Subsystem Documentation
200=======================
201
202For API clients and LLVM developers.
203
204.. toctree::
205 :hidden:
206
207 AliasAnalysis
208 BitCodeFormat
209 BranchWeightMetadata
210 Bugpoint
211 CodeGenerator
212 ExceptionHandling
213 LinkTimeOptimization
214 SegmentedStacks
215 TableGenFundamentals
216 DebuggingJITedCode
217 GoldPlugin
218 MarkedUpDisassembly
219 SystemLibrary
220 SourceLevelDebugging
221 Vectorizers
222 WritingAnLLVMBackend
223 GarbageCollection
224 WritingAnLLVMPass
225 TableGen/LangRef
Joe Abbeyba3e9012013-02-12 11:45:22 +0000226 HowToUseAttributes
Sean Silva12159ff2013-01-20 02:19:36 +0000227
Sean Silva9d0eb942013-01-20 02:19:42 +0000228:doc:`WritingAnLLVMPass`
Sean Silva12159ff2013-01-20 02:19:36 +0000229 Information on how to write LLVM transformations and analyses.
230
Sean Silva9d0eb942013-01-20 02:19:42 +0000231:doc:`WritingAnLLVMBackend`
Sean Silva12159ff2013-01-20 02:19:36 +0000232 Information on how to write LLVM backends for machine targets.
233
Sean Silva9d0eb942013-01-20 02:19:42 +0000234:doc:`CodeGenerator`
Sean Silva12159ff2013-01-20 02:19:36 +0000235 The design and implementation of the LLVM code generator. Useful if you are
236 working on retargetting LLVM to a new architecture, designing a new codegen
237 pass, or enhancing existing components.
238
Sean Silva9d0eb942013-01-20 02:19:42 +0000239:doc:`TableGenFundamentals`
Sean Silva12159ff2013-01-20 02:19:36 +0000240 Describes the TableGen tool, which is used heavily by the LLVM code
241 generator.
242
Sean Silva9d0eb942013-01-20 02:19:42 +0000243:doc:`AliasAnalysis`
Sean Silva12159ff2013-01-20 02:19:36 +0000244 Information on how to write a new alias analysis implementation or how to
245 use existing analyses.
246
Sean Silva9d0eb942013-01-20 02:19:42 +0000247:doc:`GarbageCollection`
Sean Silva12159ff2013-01-20 02:19:36 +0000248 The interfaces source-language compilers should use for compiling GC'd
249 programs.
250
Sean Silva9d0eb942013-01-20 02:19:42 +0000251:doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
Sean Silva12159ff2013-01-20 02:19:36 +0000252 This document describes the design and philosophy behind the LLVM
253 source-level debugger.
254
Sean Silva9d0eb942013-01-20 02:19:42 +0000255:doc:`Vectorizers`
Sean Silva12159ff2013-01-20 02:19:36 +0000256 This document describes the current status of vectorization in LLVM.
257
Sean Silva9d0eb942013-01-20 02:19:42 +0000258:doc:`ExceptionHandling`
Sean Silva12159ff2013-01-20 02:19:36 +0000259 This document describes the design and implementation of exception handling
260 in LLVM.
261
Sean Silva9d0eb942013-01-20 02:19:42 +0000262:doc:`Bugpoint`
Sean Silva12159ff2013-01-20 02:19:36 +0000263 Automatic bug finder and test-case reducer description and usage
264 information.
265
Sean Silva9d0eb942013-01-20 02:19:42 +0000266:doc:`BitCodeFormat`
Sean Silva12159ff2013-01-20 02:19:36 +0000267 This describes the file format and encoding used for LLVM "bc" files.
268
Sean Silva9d0eb942013-01-20 02:19:42 +0000269:doc:`System Library <SystemLibrary>`
Sean Silva12159ff2013-01-20 02:19:36 +0000270 This document describes the LLVM System Library (``lib/System``) and
271 how to keep LLVM source code portable
272
Sean Silva9d0eb942013-01-20 02:19:42 +0000273:doc:`LinkTimeOptimization`
Sean Silva12159ff2013-01-20 02:19:36 +0000274 This document describes the interface between LLVM intermodular optimizer
275 and the linker and its design
276
Sean Silva9d0eb942013-01-20 02:19:42 +0000277:doc:`GoldPlugin`
Sean Silva12159ff2013-01-20 02:19:36 +0000278 How to build your programs with link-time optimization on Linux.
279
Sean Silva9d0eb942013-01-20 02:19:42 +0000280:doc:`DebuggingJITedCode`
Sean Silva12159ff2013-01-20 02:19:36 +0000281 How to debug JITed code with GDB.
282
Sean Silva9d0eb942013-01-20 02:19:42 +0000283:doc:`BranchWeightMetadata`
Sean Silva12159ff2013-01-20 02:19:36 +0000284 Provides information about Branch Prediction Information.
285
Sean Silva9d0eb942013-01-20 02:19:42 +0000286:doc:`SegmentedStacks`
Sean Silva12159ff2013-01-20 02:19:36 +0000287 This document describes segmented stacks and how they are used in LLVM.
288
Sean Silva9d0eb942013-01-20 02:19:42 +0000289:doc:`MarkedUpDisassembly`
Sean Silva12159ff2013-01-20 02:19:36 +0000290 This document describes the optional rich disassembly output syntax.
291
Joe Abbeyba3e9012013-02-12 11:45:22 +0000292:doc:`HowToUseAttributes`
293 Answers some questions about the new Attributes infrastructure.
Sean Silva12159ff2013-01-20 02:19:36 +0000294
295Development Process Documentation
296=================================
297
Sean Silva12159ff2013-01-20 02:19:36 +0000298Information about LLVM's development process.
299
300.. toctree::
301 :hidden:
302
Sean Silva9d205c82013-03-30 15:32:47 +0000303 DeveloperPolicy
Sean Silva12159ff2013-01-20 02:19:36 +0000304 MakefileGuide
305 Projects
306 LLVMBuild
307 HowToReleaseLLVM
Sean Silvabdb940f2013-01-28 21:28:10 +0000308 Packaging
Sean Silva12159ff2013-01-20 02:19:36 +0000309
Sean Silva9d205c82013-03-30 15:32:47 +0000310:doc:`DeveloperPolicy`
311 The LLVM project's policy towards developers and their contributions.
312
Sean Silva9d0eb942013-01-20 02:19:42 +0000313:doc:`Projects`
Sean Silva12159ff2013-01-20 02:19:36 +0000314 How-to guide and templates for new projects that *use* the LLVM
315 infrastructure. The templates (directory organization, Makefiles, and test
316 tree) allow the project code to be located outside (or inside) the ``llvm/``
317 tree, while using LLVM header files and libraries.
318
Sean Silva9d0eb942013-01-20 02:19:42 +0000319:doc:`LLVMBuild`
Sean Silva12159ff2013-01-20 02:19:36 +0000320 Describes the LLVMBuild organization and files used by LLVM to specify
321 component descriptions.
322
Sean Silva9d0eb942013-01-20 02:19:42 +0000323:doc:`MakefileGuide`
Sean Silva12159ff2013-01-20 02:19:36 +0000324 Describes how the LLVM makefiles work and how to use them.
325
Sean Silva9d0eb942013-01-20 02:19:42 +0000326:doc:`HowToReleaseLLVM`
Sean Silva12159ff2013-01-20 02:19:36 +0000327 This is a guide to preparing LLVM releases. Most developers can ignore it.
328
Sean Silvabdb940f2013-01-28 21:28:10 +0000329:doc:`Packaging`
330 Advice on packaging LLVM into a distribution.
331
Sean Silva01299242013-03-30 15:32:51 +0000332Community
333=========
334
335LLVM has a thriving community of friendly and helpful developers.
336The two primary communication mechanisms in the LLVM community are mailing
337lists and IRC.
338
Sean Silva12159ff2013-01-20 02:19:36 +0000339Mailing Lists
Sean Silva01299242013-03-30 15:32:51 +0000340-------------
Sean Silva12159ff2013-01-20 02:19:36 +0000341
342If you can't find what you need in these docs, try consulting the mailing
343lists.
344
Sean Silva9d0eb942013-01-20 02:19:42 +0000345`Developer's List`__
Sean Silva12159ff2013-01-20 02:19:36 +0000346 This list is for people who want to be included in technical discussions of
347 LLVM. People post to this list when they have questions about writing code
348 for or using the LLVM tools. It is relatively low volume.
349
Sean Silva9d0eb942013-01-20 02:19:42 +0000350 .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
Sean Silva12159ff2013-01-20 02:19:36 +0000351
Sean Silva9d0eb942013-01-20 02:19:42 +0000352`Commits Archive`__
Sean Silva12159ff2013-01-20 02:19:36 +0000353 This list contains all commit messages that are made when LLVM developers
354 commit code changes to the repository. It is useful for those who want to
355 stay on the bleeding edge of LLVM development. This list is very high volume.
356
Sean Silva9d0eb942013-01-20 02:19:42 +0000357 .. __: http://lists.cs.uiuc.edu/pipermail/llvm-commits/
Sean Silva12159ff2013-01-20 02:19:36 +0000358
Sean Silva84b296c2013-03-30 15:32:54 +0000359`Bugs & Patches Archive`__
360 This list gets emailed every time a bug is opened and closed, and when people
361 submit patches to be included in LLVM. It is higher volume than the LLVMdev
362 list.
363
364 .. __: http://lists.cs.uiuc.edu/pipermail/llvmbugs/
365
Sean Silva9d0eb942013-01-20 02:19:42 +0000366`Test Results Archive`__
Sean Silva12159ff2013-01-20 02:19:36 +0000367 A message is automatically sent to this list by every active nightly tester
368 when it completes. As such, this list gets email several times each day,
369 making it a high volume list.
370
Sean Silva9d0eb942013-01-20 02:19:42 +0000371 .. __: http://lists.cs.uiuc.edu/pipermail/llvm-testresults/
372
Sean Silva84b296c2013-03-30 15:32:54 +0000373`LLVM Announcements List`__
374 This is a low volume list that provides important announcements regarding
375 LLVM. It gets email about once a month.
376
377 .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce
378
Sean Silva01299242013-03-30 15:32:51 +0000379IRC
380---
381
382Users and developers of the LLVM project (including subprojects such as Clang)
383can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
384
385This channel has several bots.
386
387* Buildbot reporters
388
389 * llvmbb - Bot for the main LLVM buildbot master.
390 http://lab.llvm.org:8011/console
391 * bb-chapuni - An individually run buildbot master. http://bb.pgr.jp/console
392 * smooshlab - Apple's internal buildbot master.
393
394* robot - Bugzilla linker. %bug <number>
395
396* clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
397 near-trunk clang instead of gcc.
398
399
Daniel Dunbarfbb80412012-04-19 16:31:37 +0000400Indices and tables
401==================
402
403* :ref:`genindex`
404* :ref:`search`