blob: 6f4eeec825607f049537d8bf63ec1154b8f46016 [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
Hans Wennborg05bff5a2019-02-19 17:00:29 +000058NOTE: If you are a user who is only interested in using an LLVM-based compiler,
59you should look into `Clang <http://clang.llvm.org>`_ instead. The
60documentation here is intended for users who have a need to work with the
61intermediate LLVM representation.
Sean Silva12159ff2013-01-20 02:19:36 +000062
63.. toctree::
64 :hidden:
65
66 CMake
Chris Bieneman9debb982016-04-29 20:34:54 +000067 CMakePrimer
Chris Bienemanebb1dd92016-03-18 21:57:51 +000068 AdvancedBuilds
Sean Silva12159ff2013-01-20 02:19:36 +000069 HowToBuildOnARM
George Burgess IVcf477f42018-10-26 20:56:03 +000070 HowToBuildWithPGO
Peter Smith7411da52017-11-07 09:40:05 +000071 HowToCrossCompileBuiltinsOnArm
Renato Golind24899b2013-09-08 20:44:48 +000072 HowToCrossCompileLLVM
Sean Silva12159ff2013-01-20 02:19:36 +000073 CommandGuide/index
Sean Silva12159ff2013-01-20 02:19:36 +000074 GettingStarted
75 GettingStartedVS
76 FAQ
77 Lexicon
Sean Silva12159ff2013-01-20 02:19:36 +000078 HowToAddABuilder
79 yaml2obj
80 HowToSubmitABug
81 SphinxQuickstartTemplate
Chandler Carruth1230d222018-08-06 00:38:31 +000082 MarkdownQuickstartTemplate
Sean Silva12159ff2013-01-20 02:19:36 +000083 Phabricator
84 TestingGuide
85 tutorial/index
86 ReleaseNotes
87 Passes
88 YamlIO
Sean Silva163b5c42013-03-30 15:32:50 +000089 GetElementPtr
Philip Reamesf8bf9dd2015-02-27 23:14:50 +000090 Frontend/PerformanceTips
Sean Silva3f93a612013-09-09 19:09:00 +000091 MCJITDesignAndImplementation
Lang Hames5f36a282019-05-18 03:08:49 +000092 ORCv2DesignAndImplementation
Chandler Carruth36293432016-06-30 20:27:54 +000093 CodeOfConduct
Jingyue Wu4f2a6cb2015-11-10 22:35:47 +000094 CompileCudaWithLLVM
Chandler Carruth36293432016-06-30 20:27:54 +000095 ReportingGuide
Rafael Espindola50a17392017-05-24 16:39:12 +000096 Benchmarking
Ilya Biryukovaf351da2017-06-30 09:46:45 +000097 Docker
Chris Bienemanda60a162019-05-21 16:29:31 +000098 BuildingADistribution
Sean Silva12159ff2013-01-20 02:19:36 +000099
Sean Silva9d0eb942013-01-20 02:19:42 +0000100:doc:`GettingStarted`
Sean Silva12159ff2013-01-20 02:19:36 +0000101 Discusses how to get up and running quickly with the LLVM infrastructure.
102 Everything from unpacking and compilation of the distribution to execution
103 of some tools.
104
Sean Silva9d0eb942013-01-20 02:19:42 +0000105:doc:`CMake`
Sean Silva12159ff2013-01-20 02:19:36 +0000106 An addendum to the main Getting Started guide for those using the `CMake
107 build system <http://www.cmake.org>`_.
108
Sean Silva9d0eb942013-01-20 02:19:42 +0000109:doc:`HowToBuildOnARM`
Sean Silva12159ff2013-01-20 02:19:36 +0000110 Notes on building and testing LLVM/Clang on ARM.
111
George Burgess IVcf477f42018-10-26 20:56:03 +0000112:doc:`HowToBuildWithPGO`
113 Notes on building LLVM/Clang with PGO.
114
Peter Smith7411da52017-11-07 09:40:05 +0000115:doc:`HowToCrossCompileBuiltinsOnArm`
116 Notes on cross-building and testing the compiler-rt builtins for Arm.
117
Renato Golind24899b2013-09-08 20:44:48 +0000118:doc:`HowToCrossCompileLLVM`
119 Notes on cross-building and testing LLVM/Clang.
120
Sean Silva9d0eb942013-01-20 02:19:42 +0000121:doc:`GettingStartedVS`
Sean Silva12159ff2013-01-20 02:19:36 +0000122 An addendum to the main Getting Started guide for those using Visual Studio
123 on Windows.
124
Sean Silva9d0eb942013-01-20 02:19:42 +0000125:doc:`tutorial/index`
Sean Silva12159ff2013-01-20 02:19:36 +0000126 Tutorials about using LLVM. Includes a tutorial about making a custom
127 language with LLVM.
128
Sean Silva9d0eb942013-01-20 02:19:42 +0000129:doc:`LLVM Command Guide <CommandGuide/index>`
Sean Silva12159ff2013-01-20 02:19:36 +0000130 A reference manual for the LLVM command line utilities ("man" pages for LLVM
131 tools).
132
Sean Silva9d0eb942013-01-20 02:19:42 +0000133:doc:`Passes`
Sean Silva12159ff2013-01-20 02:19:36 +0000134 A list of optimizations and analyses implemented in LLVM.
135
Sean Silva9d0eb942013-01-20 02:19:42 +0000136:doc:`FAQ`
Sean Silva12159ff2013-01-20 02:19:36 +0000137 A list of common questions and problems and their solutions.
138
Sean Silva9d0eb942013-01-20 02:19:42 +0000139:doc:`Release notes for the current release <ReleaseNotes>`
Sean Silva12159ff2013-01-20 02:19:36 +0000140 This describes new features, known bugs, and other limitations.
141
Sean Silva9d0eb942013-01-20 02:19:42 +0000142:doc:`HowToSubmitABug`
Sean Silva12159ff2013-01-20 02:19:36 +0000143 Instructions for properly submitting information about any bugs you run into
144 in the LLVM system.
Sean Silva12159ff2013-01-20 02:19:36 +0000145
Sean Silva9d0eb942013-01-20 02:19:42 +0000146:doc:`SphinxQuickstartTemplate`
Sean Silva12159ff2013-01-20 02:19:36 +0000147 A template + tutorial for writing new Sphinx documentation. It is meant
148 to be read in source form.
149
Sean Silva9d0eb942013-01-20 02:19:42 +0000150:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
Sean Silva12159ff2013-01-20 02:19:36 +0000151 A reference manual for using the LLVM testing infrastructure.
152
Matthias Braun4f340e92018-08-31 21:47:01 +0000153:doc:`TestSuiteGuide`
154 Describes how to compile and run the test-suite benchmarks.
155
Sean Silva9d0eb942013-01-20 02:19:42 +0000156`How to build the C, C++, ObjC, and ObjC++ front end`__
Sean Silva12159ff2013-01-20 02:19:36 +0000157 Instructions for building the clang front-end from source.
158
Sean Silva9d0eb942013-01-20 02:19:42 +0000159 .. __: http://clang.llvm.org/get_started.html
Sean Silva12159ff2013-01-20 02:19:36 +0000160
Sean Silva9d0eb942013-01-20 02:19:42 +0000161:doc:`Lexicon`
Sean Silva12159ff2013-01-20 02:19:36 +0000162 Definition of acronyms, terms and concepts used in LLVM.
163
Sean Silva9d0eb942013-01-20 02:19:42 +0000164:doc:`HowToAddABuilder`
Sean Silva12159ff2013-01-20 02:19:36 +0000165 Instructions for adding new builder to LLVM buildbot master.
166
Sean Silva9d0eb942013-01-20 02:19:42 +0000167:doc:`YamlIO`
Sean Silva12159ff2013-01-20 02:19:36 +0000168 A reference guide for using LLVM's YAML I/O library.
169
Sean Silva163b5c42013-03-30 15:32:50 +0000170:doc:`GetElementPtr`
171 Answers to some very frequent questions about LLVM's most frequently
172 misunderstood instruction.
173
Philip Reamesf8bf9dd2015-02-27 23:14:50 +0000174:doc:`Frontend/PerformanceTips`
Vlad Tsyrklevich31b45312017-09-20 20:38:14 +0000175 A collection of tips for frontend authors on how to generate IR
Philip Reamesf8bf9dd2015-02-27 23:14:50 +0000176 which LLVM is able to effectively optimize.
177
Ilya Biryukovaf351da2017-06-30 09:46:45 +0000178:doc:`Docker`
179 A reference for using Dockerfiles provided with LLVM.
180
Chris Bienemanda60a162019-05-21 16:29:31 +0000181:doc:`BuildingADistribution`
182 A best-practices guide for using LLVM's CMake build system to package and
183 distribute LLVM-based tools.
184
Philip Reamesf8bf9dd2015-02-27 23:14:50 +0000185
Sean Silva12159ff2013-01-20 02:19:36 +0000186Programming Documentation
187=========================
188
189For developers of applications which use LLVM as a library.
190
191.. toctree::
192 :hidden:
193
194 Atomics
195 CodingStandards
196 CommandLine
197 CompilerWriterInfo
198 ExtendingLLVM
199 HowToSetUpLLVMStyleRTTI
200 ProgrammersManual
Nico Rieck1da45292013-04-10 23:28:17 +0000201 Extensions
Kostya Serebryany35ce8632015-03-30 23:05:30 +0000202 LibFuzzer
Justin Bognerfd5b2a02017-10-12 01:44:24 +0000203 FuzzingLLVM
Kostya Serebryany9a293ca2016-06-07 23:13:54 +0000204 ScudoHardenedAllocator
Andrew Kaylor3aeda4f2016-08-26 23:11:48 +0000205 OptBisect
Sean Silva12159ff2013-01-20 02:19:36 +0000206
Sean Silva9d0eb942013-01-20 02:19:42 +0000207:doc:`LLVM Language Reference Manual <LangRef>`
Sean Silva12159ff2013-01-20 02:19:36 +0000208 Defines the LLVM intermediate representation and the assembly form of the
209 different nodes.
210
Sean Silva9d0eb942013-01-20 02:19:42 +0000211:doc:`Atomics`
Sean Silva12159ff2013-01-20 02:19:36 +0000212 Information about LLVM's concurrency model.
213
Sean Silva9d0eb942013-01-20 02:19:42 +0000214:doc:`ProgrammersManual`
Sean Silva12159ff2013-01-20 02:19:36 +0000215 Introduction to the general layout of the LLVM sourcebase, important classes
216 and APIs, and some tips & tricks.
217
Nico Rieck1da45292013-04-10 23:28:17 +0000218:doc:`Extensions`
219 LLVM-specific extensions to tools and formats LLVM seeks compatibility with.
220
Sean Silva9d0eb942013-01-20 02:19:42 +0000221:doc:`CommandLine`
Sean Silva12159ff2013-01-20 02:19:36 +0000222 Provides information on using the command line parsing library.
223
Sean Silva9d0eb942013-01-20 02:19:42 +0000224:doc:`CodingStandards`
Sean Silva12159ff2013-01-20 02:19:36 +0000225 Details the LLVM coding standards and provides useful information on writing
226 efficient C++ code.
227
Sean Silva9d0eb942013-01-20 02:19:42 +0000228:doc:`HowToSetUpLLVMStyleRTTI`
Sean Silva12159ff2013-01-20 02:19:36 +0000229 How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
230 class hierarchy.
231
Sean Silva9d0eb942013-01-20 02:19:42 +0000232:doc:`ExtendingLLVM`
Sean Silva12159ff2013-01-20 02:19:36 +0000233 Look here to see how to add instructions and intrinsics to LLVM.
234
Sean Silva9d0eb942013-01-20 02:19:42 +0000235`Doxygen generated documentation <http://llvm.org/doxygen/>`_
Sean Silva12159ff2013-01-20 02:19:36 +0000236 (`classes <http://llvm.org/doxygen/inherits.html>`_)
Sean Silva12159ff2013-01-20 02:19:36 +0000237
Peter Collingbourne943d2702015-01-13 18:49:42 +0000238`Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
239
James Y Knight78655882019-01-14 22:27:32 +0000240`Github Source Repository Browser <http://github.com/llvm/llvm-project//>`_
Sean Silva9d0eb942013-01-20 02:19:42 +0000241 ..
Sean Silva12159ff2013-01-20 02:19:36 +0000242
Sean Silva9d0eb942013-01-20 02:19:42 +0000243:doc:`CompilerWriterInfo`
Sean Silva12159ff2013-01-20 02:19:36 +0000244 A list of helpful links for compiler writers.
245
Kostya Serebryany35ce8632015-03-30 23:05:30 +0000246:doc:`LibFuzzer`
247 A library for writing in-process guided fuzzers.
248
Justin Bognerfd5b2a02017-10-12 01:44:24 +0000249:doc:`FuzzingLLVM`
250 Information on writing and using Fuzzers to find bugs in LLVM.
251
Kostya Serebryany9a293ca2016-06-07 23:13:54 +0000252:doc:`ScudoHardenedAllocator`
253 A library that implements a security-hardened `malloc()`.
254
Andrew Kaylor3aeda4f2016-08-26 23:11:48 +0000255:doc:`OptBisect`
256 A command line option for debugging optimization-induced failures.
257
Florian Hahn57edaa42018-01-04 17:12:21 +0000258.. _index-subsystem-docs:
259
Sean Silva12159ff2013-01-20 02:19:36 +0000260Subsystem Documentation
261=======================
262
263For API clients and LLVM developers.
264
265.. toctree::
266 :hidden:
267
268 AliasAnalysis
George Burgess IV3bbeb732016-08-17 00:17:29 +0000269 MemorySSA
Sean Silva12159ff2013-01-20 02:19:36 +0000270 BitCodeFormat
Duncan P. N. Exon Smith6e40cec2014-04-11 23:21:07 +0000271 BlockFrequencyTerminology
Sean Silva12159ff2013-01-20 02:19:36 +0000272 BranchWeightMetadata
273 Bugpoint
274 CodeGenerator
275 ExceptionHandling
Kevin P. Neal339594e2019-04-11 17:16:03 +0000276 AddingConstrainedIntrinsics
Sean Silva12159ff2013-01-20 02:19:36 +0000277 LinkTimeOptimization
278 SegmentedStacks
279 TableGenFundamentals
Renato Golinca105642014-03-20 16:08:34 +0000280 TableGen/index
Sean Silva12159ff2013-01-20 02:19:36 +0000281 DebuggingJITedCode
282 GoldPlugin
283 MarkedUpDisassembly
284 SystemLibrary
Kristina Brooksab834fd2018-09-18 18:05:38 +0000285 SupportLibrary
Sean Silva12159ff2013-01-20 02:19:36 +0000286 SourceLevelDebugging
287 Vectorizers
288 WritingAnLLVMBackend
289 GarbageCollection
290 WritingAnLLVMPass
Joe Abbeyba3e9012013-02-12 11:45:22 +0000291 HowToUseAttributes
Justin Holewinski45df8822013-03-30 16:41:14 +0000292 NVPTXUsage
Tom Stellard45bb48e2015-06-13 03:28:10 +0000293 AMDGPUUsage
Andrew Trick5e029ce2013-12-24 02:57:25 +0000294 StackMaps
Sean Silva216f1ee2014-03-02 00:21:42 +0000295 InAlloca
James Molloy3f7878a2014-05-12 15:13:39 +0000296 BigEndianNEON
Alex Lorenz6a128332014-08-19 17:05:58 +0000297 CoverageMappingFormat
Matt Arsenault03f0e832014-12-03 18:35:11 +0000298 Statepoints
Stepan Dyatkovskiyf0c3a342014-12-10 17:42:01 +0000299 MergeFunctions
Peter Collingbourne7efd7502016-06-24 21:21:32 +0000300 TypeMetadata
Michael Kruse72448522018-12-12 17:32:52 +0000301 TransformMetadata
Sanjoy Das5553bc82015-06-15 19:38:15 +0000302 FaultMaps
Alex Lorenz3d311772015-08-06 22:55:19 +0000303 MIRLangRef
David Majnemera6539272016-07-23 04:05:08 +0000304 Coroutines
Ahmed Bougacha29d9da12016-11-04 17:57:34 +0000305 GlobalISel
Dean Michael Berrisf3da16b2016-11-09 00:24:58 +0000306 XRay
Dean Michael Berris46979b42017-03-31 02:51:19 +0000307 XRayExample
Keith Wyss3d0bc9e2017-08-02 21:47:27 +0000308 XRayFDRFormat
Zachary Turner218ce832016-11-10 19:24:21 +0000309 PDB/index
Vlad Tsyrklevich31b45312017-09-20 20:38:14 +0000310 CFIVerify
Chandler Carruth1230d222018-08-06 00:38:31 +0000311 SpeculativeLoadHardening
Vitaly Bukad3130522018-11-26 23:16:07 +0000312 StackSafetyAnalysis
Sean Silva12159ff2013-01-20 02:19:36 +0000313
Sean Silva9d0eb942013-01-20 02:19:42 +0000314:doc:`WritingAnLLVMPass`
Sean Silva12159ff2013-01-20 02:19:36 +0000315 Information on how to write LLVM transformations and analyses.
316
Sean Silva9d0eb942013-01-20 02:19:42 +0000317:doc:`WritingAnLLVMBackend`
Sean Silva12159ff2013-01-20 02:19:36 +0000318 Information on how to write LLVM backends for machine targets.
319
Sean Silva9d0eb942013-01-20 02:19:42 +0000320:doc:`CodeGenerator`
Sean Silva12159ff2013-01-20 02:19:36 +0000321 The design and implementation of the LLVM code generator. Useful if you are
322 working on retargetting LLVM to a new architecture, designing a new codegen
323 pass, or enhancing existing components.
324
Alex Lorenz3d311772015-08-06 22:55:19 +0000325:doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`
326 A reference manual for the MIR serialization format, which is used to test
327 LLVM's code generation passes.
328
Sean Silva0b4df9b2014-04-07 22:42:53 +0000329:doc:`TableGen <TableGen/index>`
Sean Silva12159ff2013-01-20 02:19:36 +0000330 Describes the TableGen tool, which is used heavily by the LLVM code
331 generator.
332
Sean Silva9d0eb942013-01-20 02:19:42 +0000333:doc:`AliasAnalysis`
Sean Silva12159ff2013-01-20 02:19:36 +0000334 Information on how to write a new alias analysis implementation or how to
335 use existing analyses.
336
George Burgess IV3bbeb732016-08-17 00:17:29 +0000337:doc:`MemorySSA`
338 Information about the MemorySSA utility in LLVM, as well as how to use it.
339
Sean Silva9d0eb942013-01-20 02:19:42 +0000340:doc:`GarbageCollection`
Sean Silva12159ff2013-01-20 02:19:36 +0000341 The interfaces source-language compilers should use for compiling GC'd
342 programs.
343
Sean Silva9d0eb942013-01-20 02:19:42 +0000344:doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
Sean Silva12159ff2013-01-20 02:19:36 +0000345 This document describes the design and philosophy behind the LLVM
346 source-level debugger.
347
Sean Silva9d0eb942013-01-20 02:19:42 +0000348:doc:`Vectorizers`
Sean Silva12159ff2013-01-20 02:19:36 +0000349 This document describes the current status of vectorization in LLVM.
350
Sean Silva9d0eb942013-01-20 02:19:42 +0000351:doc:`ExceptionHandling`
Sean Silva12159ff2013-01-20 02:19:36 +0000352 This document describes the design and implementation of exception handling
353 in LLVM.
354
Kevin P. Neal339594e2019-04-11 17:16:03 +0000355:doc:`AddingConstrainedIntrinsics`
356 Gives the steps necessary when adding a new constrained math intrinsic
357 to LLVM.
358
Sean Silva9d0eb942013-01-20 02:19:42 +0000359:doc:`Bugpoint`
Sean Silva12159ff2013-01-20 02:19:36 +0000360 Automatic bug finder and test-case reducer description and usage
361 information.
362
Sean Silva9d0eb942013-01-20 02:19:42 +0000363:doc:`BitCodeFormat`
Sean Silva12159ff2013-01-20 02:19:36 +0000364 This describes the file format and encoding used for LLVM "bc" files.
365
Kristina Brooksab834fd2018-09-18 18:05:38 +0000366:doc:`Support Library <SupportLibrary>`
367 This document describes the LLVM Support Library (``lib/Support``) and
Sean Silva12159ff2013-01-20 02:19:36 +0000368 how to keep LLVM source code portable
369
Sean Silva9d0eb942013-01-20 02:19:42 +0000370:doc:`LinkTimeOptimization`
Sean Silva12159ff2013-01-20 02:19:36 +0000371 This document describes the interface between LLVM intermodular optimizer
372 and the linker and its design
373
Sean Silva9d0eb942013-01-20 02:19:42 +0000374:doc:`GoldPlugin`
Sean Silva12159ff2013-01-20 02:19:36 +0000375 How to build your programs with link-time optimization on Linux.
376
Sean Silva9d0eb942013-01-20 02:19:42 +0000377:doc:`DebuggingJITedCode`
Sean Silva12159ff2013-01-20 02:19:36 +0000378 How to debug JITed code with GDB.
379
Andrew Kaylor27299c32013-08-21 22:15:09 +0000380:doc:`MCJITDesignAndImplementation`
381 Describes the inner workings of MCJIT execution engine.
382
Lang Hames5f36a282019-05-18 03:08:49 +0000383:doc:`ORCv2DesignAndImplementation`
384 Describes the design and implementation of the ORC APIs, including some
385 usage examples.
386
Sean Silva9d0eb942013-01-20 02:19:42 +0000387:doc:`BranchWeightMetadata`
Sean Silva12159ff2013-01-20 02:19:36 +0000388 Provides information about Branch Prediction Information.
389
Duncan P. N. Exon Smith6e40cec2014-04-11 23:21:07 +0000390:doc:`BlockFrequencyTerminology`
391 Provides information about terminology used in the ``BlockFrequencyInfo``
392 analysis pass.
393
Sean Silva9d0eb942013-01-20 02:19:42 +0000394:doc:`SegmentedStacks`
Sean Silva12159ff2013-01-20 02:19:36 +0000395 This document describes segmented stacks and how they are used in LLVM.
396
Sean Silva9d0eb942013-01-20 02:19:42 +0000397:doc:`MarkedUpDisassembly`
Sean Silva12159ff2013-01-20 02:19:36 +0000398 This document describes the optional rich disassembly output syntax.
399
Joe Abbeyba3e9012013-02-12 11:45:22 +0000400:doc:`HowToUseAttributes`
401 Answers some questions about the new Attributes infrastructure.
Sean Silva12159ff2013-01-20 02:19:36 +0000402
Justin Holewinski45df8822013-03-30 16:41:14 +0000403:doc:`NVPTXUsage`
Tony Tyef16a45e2017-06-06 20:31:59 +0000404 This document describes using the NVPTX backend to compile GPU kernels.
Justin Holewinski45df8822013-03-30 16:41:14 +0000405
Tom Stellard45bb48e2015-06-13 03:28:10 +0000406:doc:`AMDGPUUsage`
Tony Tyef16a45e2017-06-06 20:31:59 +0000407 This document describes using the AMDGPU backend to compile GPU kernels.
Tom Stellard9d7ddd52014-11-14 14:08:00 +0000408
Andrew Trick5e029ce2013-12-24 02:57:25 +0000409:doc:`StackMaps`
410 LLVM support for mapping instruction addresses to the location of
411 values and allowing code to be patched.
Justin Holewinski45df8822013-03-30 16:41:14 +0000412
James Molloy3f7878a2014-05-12 15:13:39 +0000413:doc:`BigEndianNEON`
414 LLVM's support for generating NEON instructions on big endian ARM targets is
415 somewhat nonintuitive. This document explains the implementation and rationale.
416
Alex Lorenz6a128332014-08-19 17:05:58 +0000417:doc:`CoverageMappingFormat`
418 This describes the format and encoding used for LLVM’s code coverage mapping.
James Molloy3f7878a2014-05-12 15:13:39 +0000419
Matt Arsenault03f0e832014-12-03 18:35:11 +0000420:doc:`Statepoints`
421 This describes a set of experimental extensions for garbage
422 collection support.
423
Stepan Dyatkovskiyf0c3a342014-12-10 17:42:01 +0000424:doc:`MergeFunctions`
425 Describes functions merging optimization.
426
Sean Silvab6472fe2015-02-04 20:51:19 +0000427:doc:`InAlloca`
428 Description of the ``inalloca`` argument attribute.
429
Sanjoy Das5553bc82015-06-15 19:38:15 +0000430:doc:`FaultMaps`
431 LLVM support for folding control flow into faulting machine instructions.
432
Jingyue Wu4f2a6cb2015-11-10 22:35:47 +0000433:doc:`CompileCudaWithLLVM`
434 LLVM support for CUDA.
435
David Majnemera6539272016-07-23 04:05:08 +0000436:doc:`Coroutines`
437 LLVM support for coroutines.
438
Ahmed Bougacha29d9da12016-11-04 17:57:34 +0000439:doc:`GlobalISel`
440 This describes the prototype instruction selection replacement, GlobalISel.
441
Dean Michael Berrisf3da16b2016-11-09 00:24:58 +0000442:doc:`XRay`
443 High-level documentation of how to use XRay in LLVM.
444
Dean Michael Berris38daca62017-03-30 23:46:36 +0000445:doc:`XRayExample`
446 An example of how to debug an application with XRay.
447
Zachary Turner218ce832016-11-10 19:24:21 +0000448:doc:`The Microsoft PDB File Format <PDB/index>`
449 A detailed description of the Microsoft PDB (Program Database) file format.
450
Vlad Tsyrklevich31b45312017-09-20 20:38:14 +0000451:doc:`CFIVerify`
452 A description of the verification tool for Control Flow Integrity.
453
Chandler Carruth1230d222018-08-06 00:38:31 +0000454:doc:`SpeculativeLoadHardening`
455 A description of the Speculative Load Hardening mitigation for Spectre v1.
456
Vitaly Bukad3130522018-11-26 23:16:07 +0000457:doc:`StackSafetyAnalysis`
458 This document describes the design of the stack safety analysis of local
459 variables.
460
Sean Silva12159ff2013-01-20 02:19:36 +0000461Development Process Documentation
462=================================
463
Sean Silva12159ff2013-01-20 02:19:36 +0000464Information about LLVM's development process.
465
466.. toctree::
467 :hidden:
468
Florian Hahn57edaa42018-01-04 17:12:21 +0000469 Contributing
Sean Silva9d205c82013-03-30 15:32:47 +0000470 DeveloperPolicy
Sean Silva12159ff2013-01-20 02:19:36 +0000471 Projects
472 LLVMBuild
473 HowToReleaseLLVM
Sean Silvabdb940f2013-01-28 21:28:10 +0000474 Packaging
Sean Silva3f93a612013-09-09 19:09:00 +0000475 ReleaseProcess
Adrian Prantladc41ca2014-10-03 20:17:32 +0000476 Phabricator
Kristof Beylsa8ffa522018-11-07 08:49:36 +0000477 BugLifeCycle
Sean Silva12159ff2013-01-20 02:19:36 +0000478
Florian Hahn57edaa42018-01-04 17:12:21 +0000479:doc:`Contributing`
480 An overview on how to contribute to LLVM.
481
Sean Silva9d205c82013-03-30 15:32:47 +0000482:doc:`DeveloperPolicy`
483 The LLVM project's policy towards developers and their contributions.
484
Sean Silva9d0eb942013-01-20 02:19:42 +0000485:doc:`Projects`
Sean Silva12159ff2013-01-20 02:19:36 +0000486 How-to guide and templates for new projects that *use* the LLVM
487 infrastructure. The templates (directory organization, Makefiles, and test
488 tree) allow the project code to be located outside (or inside) the ``llvm/``
489 tree, while using LLVM header files and libraries.
490
Sean Silva9d0eb942013-01-20 02:19:42 +0000491:doc:`LLVMBuild`
Sean Silva12159ff2013-01-20 02:19:36 +0000492 Describes the LLVMBuild organization and files used by LLVM to specify
493 component descriptions.
494
Sean Silva9d0eb942013-01-20 02:19:42 +0000495:doc:`HowToReleaseLLVM`
Sean Silva12159ff2013-01-20 02:19:36 +0000496 This is a guide to preparing LLVM releases. Most developers can ignore it.
497
Renato Golinc08f2182013-05-28 10:32:55 +0000498:doc:`ReleaseProcess`
Jyoti Allur223602d2014-09-26 06:59:15 +0000499 This is a guide to validate a new release, during the release process. Most developers can ignore it.
Renato Golinc08f2182013-05-28 10:32:55 +0000500
Sean Silvabdb940f2013-01-28 21:28:10 +0000501:doc:`Packaging`
502 Advice on packaging LLVM into a distribution.
503
Adrian Prantladc41ca2014-10-03 20:17:32 +0000504:doc:`Phabricator`
505 Describes how to use the Phabricator code review tool hosted on
506 http://reviews.llvm.org/ and its command line interface, Arcanist.
507
Kristof Beylsa8ffa522018-11-07 08:49:36 +0000508:doc:`BugLifeCycle`
509 Describes how bugs are reported, triaged and closed.
510
Sean Silva01299242013-03-30 15:32:51 +0000511Community
512=========
513
514LLVM has a thriving community of friendly and helpful developers.
515The two primary communication mechanisms in the LLVM community are mailing
516lists and IRC.
517
Sean Silva12159ff2013-01-20 02:19:36 +0000518Mailing Lists
Sean Silva01299242013-03-30 15:32:51 +0000519-------------
Sean Silva12159ff2013-01-20 02:19:36 +0000520
521If you can't find what you need in these docs, try consulting the mailing
522lists.
523
Tanya Lattner0d28f802015-08-05 03:51:17 +0000524`Developer's List (llvm-dev)`__
Sean Silva12159ff2013-01-20 02:19:36 +0000525 This list is for people who want to be included in technical discussions of
526 LLVM. People post to this list when they have questions about writing code
527 for or using the LLVM tools. It is relatively low volume.
528
Tanya Lattner0d28f802015-08-05 03:51:17 +0000529 .. __: http://lists.llvm.org/mailman/listinfo/llvm-dev
Sean Silva12159ff2013-01-20 02:19:36 +0000530
Sean Silvaab4997d2013-03-30 15:33:01 +0000531`Commits Archive (llvm-commits)`__
Sean Silva12159ff2013-01-20 02:19:36 +0000532 This list contains all commit messages that are made when LLVM developers
Sean Silva2a746992013-03-30 15:33:02 +0000533 commit code changes to the repository. It also serves as a forum for
534 patch review (i.e. send patches here). It is useful for those who want to
535 stay on the bleeding edge of LLVM development. This list is very high
536 volume.
Sean Silva12159ff2013-01-20 02:19:36 +0000537
Tanya Lattner0d28f802015-08-05 03:51:17 +0000538 .. __: http://lists.llvm.org/pipermail/llvm-commits/
Sean Silva12159ff2013-01-20 02:19:36 +0000539
Tanya Lattner0d28f802015-08-05 03:51:17 +0000540`Bugs & Patches Archive (llvm-bugs)`__
Sean Silva2a746992013-03-30 15:33:02 +0000541 This list gets emailed every time a bug is opened and closed. It is
Tanya Lattner0d28f802015-08-05 03:51:17 +0000542 higher volume than the LLVM-dev list.
Sean Silva84b296c2013-03-30 15:32:54 +0000543
Tanya Lattner0d28f802015-08-05 03:51:17 +0000544 .. __: http://lists.llvm.org/pipermail/llvm-bugs/
Sean Silva84b296c2013-03-30 15:32:54 +0000545
Sean Silvaab4997d2013-03-30 15:33:01 +0000546`Test Results Archive (llvm-testresults)`__
Sean Silva12159ff2013-01-20 02:19:36 +0000547 A message is automatically sent to this list by every active nightly tester
548 when it completes. As such, this list gets email several times each day,
549 making it a high volume list.
550
Tanya Lattner0d28f802015-08-05 03:51:17 +0000551 .. __: http://lists.llvm.org/pipermail/llvm-testresults/
Sean Silva9d0eb942013-01-20 02:19:42 +0000552
Sean Silvaab4997d2013-03-30 15:33:01 +0000553`LLVM Announcements List (llvm-announce)`__
Sean Silva84b296c2013-03-30 15:32:54 +0000554 This is a low volume list that provides important announcements regarding
555 LLVM. It gets email about once a month.
556
Tanya Lattner0d28f802015-08-05 03:51:17 +0000557 .. __: http://lists.llvm.org/mailman/listinfo/llvm-announce
Sean Silva84b296c2013-03-30 15:32:54 +0000558
Sean Silva01299242013-03-30 15:32:51 +0000559IRC
560---
561
562Users and developers of the LLVM project (including subprojects such as Clang)
563can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
564
565This channel has several bots.
566
567* Buildbot reporters
568
569 * llvmbb - Bot for the main LLVM buildbot master.
570 http://lab.llvm.org:8011/console
Sean Silva01299242013-03-30 15:32:51 +0000571 * smooshlab - Apple's internal buildbot master.
572
573* robot - Bugzilla linker. %bug <number>
574
575* clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
576 near-trunk clang instead of gcc.
577
Alex Denisovc5c9ca02019-05-14 07:20:58 +0000578Meetups and social events
579-------------------------
580
581.. toctree::
582 :hidden:
583
584 MeetupGuidelines
585
586Besides developer `meetings and conferences <https://llvm.org/devmtg/>`_,
587there are several user groups called
588`LLVM Socials <https://www.meetup.com/pro/llvm/>`_. We greatly encourage you to
589join one in your city. Or start a new one if there is none:
590
591:doc:`MeetupGuidelines`
592
Renato Goline433cf72016-07-20 09:38:04 +0000593Community wide proposals
594------------------------
595
596Proposals for massive changes in how the community behaves and how the work flow
597can be better.
598
599.. toctree::
600 :hidden:
601
602 CodeOfConduct
Mehdi Amini647deb82016-10-12 23:02:02 +0000603 Proposals/GitHubMove
Michael Kruse53c722d2018-10-23 19:46:29 +0000604 Proposals/TestSuite
Michael Platings7aecb642019-03-28 14:42:21 +0000605 Proposals/VariableNames
Ayal Zaks4c4baf52017-05-29 15:36:23 +0000606 Proposals/VectorizationPlan
Renato Goline433cf72016-07-20 09:38:04 +0000607
608:doc:`CodeOfConduct`
609 Proposal to adopt a code of conduct on the LLVM social spaces (lists, events,
610 IRC, etc).
611
Mehdi Amini647deb82016-10-12 23:02:02 +0000612:doc:`Proposals/GitHubMove`
Renato Goline433cf72016-07-20 09:38:04 +0000613 Proposal to move from SVN/Git to GitHub.
614
Michael Kruse53c722d2018-10-23 19:46:29 +0000615:doc:`Proposals/TestSuite`
616 Proposals for additional benchmarks/programs for llvm's test-suite.
617
Michael Platings7aecb642019-03-28 14:42:21 +0000618:doc:`Proposals/VariableNames`
619 Proposal to change the variable names coding standard.
620
Ayal Zaks4c4baf52017-05-29 15:36:23 +0000621:doc:`Proposals/VectorizationPlan`
622 Proposal to model the process and upgrade the infrastructure of LLVM's Loop Vectorizer.
Sean Silva01299242013-03-30 15:32:51 +0000623
Daniel Dunbarfbb80412012-04-19 16:31:37 +0000624Indices and tables
625==================
626
627* :ref:`genindex`
628* :ref:`search`