Blame - llvm/docs/index.rst - toolchain/llvm-project

blob: 7f3788f95b66769aedc7719c6d205f8ee75a930f [file] [log] [blame]

Daniel Dunbar	fbb8041	2012-04-19 16:31:37 +0000	[diff] [blame]	1	Overview
				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
				9	The LLVM compiler infrastructure supports a wide range of projects, from
				10	industrial strength compilers to specialized JIT applications to small
				11	research projects.
				12
				13	Similarly, documentation is broken down into several high-level groupings
Benjamin Kramer	bde9176	2012-06-02 10:20:22 +0000	[diff] [blame]	14	targeted at different audiences:
Daniel Dunbar	fbb8041	2012-04-19 16:31:37 +0000	[diff] [blame]	15
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	16	LLVM Design & Overview
				17	======================
Daniel Dunbar	fbb8041	2012-04-19 16:31:37 +0000	[diff] [blame]	18
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	19	Several introductory papers and presentations.
Daniel Dunbar	fbb8041	2012-04-19 16:31:37 +0000	[diff] [blame]	20
				21	.. toctree::
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	22	:hidden:
Daniel Dunbar	fbb8041	2012-04-19 16:31:37 +0000	[diff] [blame]	23
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	24	LangRef
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	25
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	26	:doc:`LangRef`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	27	Defines the LLVM intermediate representation.
				28
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	29	`Introduction to the LLVM Compiler`__
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	30	Presentation providing a users introduction to LLVM.
				31
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	32	.. __: http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	33
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	34	`Intro to LLVM`__
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	35	Book chapter providing a compiler hacker's introduction to LLVM.
				36
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	37	.. __: http://www.aosabook.org/en/llvm.html
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	38
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	39
				40	`LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation`__
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	41	Design overview.
				42
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	43	.. __: http://llvm.org/pubs/2004-01-30-CGO-LLVM.html
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	44
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	45	`LLVM: An Infrastructure for Multi-Stage Optimization`__
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	46	More details (quite old now).
				47
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	48	.. __: http://llvm.org/pubs/2002-12-LattnerMSThesis.html
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	49
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	50	`Publications mentioning LLVM <http://llvm.org/pubs>`_
				51	..
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	52
				53	User Guides
				54	===========
				55
				56	For those new to the LLVM system.
				57
				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
				62	representation.
				63
				64	.. toctree::
				65	:hidden:
				66
				67	CMake
Chris Bieneman	9debb98	2016-04-29 20:34:54 +0000	[diff] [blame]	68	CMakePrimer
Chris Bieneman	ebb1dd9	2016-03-18 21:57:51 +0000	[diff] [blame]	69	AdvancedBuilds
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	70	HowToBuildOnARM
Renato Golin	d24899b	2013-09-08 20:44:48 +0000	[diff] [blame]	71	HowToCrossCompileLLVM
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	72	CommandGuide/index
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	73	GettingStarted
				74	GettingStartedVS
				75	FAQ
				76	Lexicon
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	77	HowToAddABuilder
				78	yaml2obj
				79	HowToSubmitABug
				80	SphinxQuickstartTemplate
				81	Phabricator
				82	TestingGuide
				83	tutorial/index
				84	ReleaseNotes
				85	Passes
				86	YamlIO
Sean Silva	163b5c4	2013-03-30 15:32:50 +0000	[diff] [blame]	87	GetElementPtr
Philip Reames	f8bf9dd	2015-02-27 23:14:50 +0000	[diff] [blame]	88	Frontend/PerformanceTips
Sean Silva	3f93a61	2013-09-09 19:09:00 +0000	[diff] [blame]	89	MCJITDesignAndImplementation
Chandler Carruth	3629343	2016-06-30 20:27:54 +0000	[diff] [blame]	90	CodeOfConduct
Jingyue Wu	4f2a6cb	2015-11-10 22:35:47 +0000	[diff] [blame]	91	CompileCudaWithLLVM
Chandler Carruth	3629343	2016-06-30 20:27:54 +0000	[diff] [blame]	92	ReportingGuide
Rafael Espindola	50a1739	2017-05-24 16:39:12 +0000	[diff] [blame]	93	Benchmarking
Ilya Biryukov	af351da	2017-06-30 09:46:45 +0000	[diff] [blame^]	94	Docker
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	95
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	96	:doc:`GettingStarted`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	97	Discusses how to get up and running quickly with the LLVM infrastructure.
				98	Everything from unpacking and compilation of the distribution to execution
				99	of some tools.
				100
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	101	:doc:`CMake`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	102	An addendum to the main Getting Started guide for those using the `CMake
				103	build system <http://www.cmake.org>`_.
				104
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	105	:doc:`HowToBuildOnARM`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	106	Notes on building and testing LLVM/Clang on ARM.
				107
Renato Golin	d24899b	2013-09-08 20:44:48 +0000	[diff] [blame]	108	:doc:`HowToCrossCompileLLVM`
				109	Notes on cross-building and testing LLVM/Clang.
				110
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	111	:doc:`GettingStartedVS`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	112	An addendum to the main Getting Started guide for those using Visual Studio
				113	on Windows.
				114
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	115	:doc:`tutorial/index`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	116	Tutorials about using LLVM. Includes a tutorial about making a custom
				117	language with LLVM.
				118
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	119	:doc:`LLVM Command Guide <CommandGuide/index>`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	120	A reference manual for the LLVM command line utilities ("man" pages for LLVM
				121	tools).
				122
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	123	:doc:`Passes`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	124	A list of optimizations and analyses implemented in LLVM.
				125
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	126	:doc:`FAQ`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	127	A list of common questions and problems and their solutions.
				128
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	129	:doc:`Release notes for the current release <ReleaseNotes>`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	130	This describes new features, known bugs, and other limitations.
				131
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	132	:doc:`HowToSubmitABug`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	133	Instructions for properly submitting information about any bugs you run into
				134	in the LLVM system.
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	135
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	136	:doc:`SphinxQuickstartTemplate`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	137	A template + tutorial for writing new Sphinx documentation. It is meant
				138	to be read in source form.
				139
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	140	:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	141	A reference manual for using the LLVM testing infrastructure.
				142
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	143	`How to build the C, C++, ObjC, and ObjC++ front end`__
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	144	Instructions for building the clang front-end from source.
				145
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	146	.. __: http://clang.llvm.org/get_started.html
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	147
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	148	:doc:`Lexicon`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	149	Definition of acronyms, terms and concepts used in LLVM.
				150
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	151	:doc:`HowToAddABuilder`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	152	Instructions for adding new builder to LLVM buildbot master.
				153
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	154	:doc:`YamlIO`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	155	A reference guide for using LLVM's YAML I/O library.
				156
Sean Silva	163b5c4	2013-03-30 15:32:50 +0000	[diff] [blame]	157	:doc:`GetElementPtr`
				158	Answers to some very frequent questions about LLVM's most frequently
				159	misunderstood instruction.
				160
Philip Reames	f8bf9dd	2015-02-27 23:14:50 +0000	[diff] [blame]	161	:doc:`Frontend/PerformanceTips`
				162	A collection of tips for frontend authors on how to generate IR
				163	which LLVM is able to effectively optimize.
				164
Ilya Biryukov	af351da	2017-06-30 09:46:45 +0000	[diff] [blame^]	165	:doc:`Docker`
				166	A reference for using Dockerfiles provided with LLVM.
				167
Philip Reames	f8bf9dd	2015-02-27 23:14:50 +0000	[diff] [blame]	168
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	169	Programming Documentation
				170	=========================
				171
				172	For developers of applications which use LLVM as a library.
				173
				174	.. toctree::
				175	:hidden:
				176
				177	Atomics
				178	CodingStandards
				179	CommandLine
				180	CompilerWriterInfo
				181	ExtendingLLVM
				182	HowToSetUpLLVMStyleRTTI
				183	ProgrammersManual
Nico Rieck	1da4529	2013-04-10 23:28:17 +0000	[diff] [blame]	184	Extensions
Kostya Serebryany	35ce863	2015-03-30 23:05:30 +0000	[diff] [blame]	185	LibFuzzer
Kostya Serebryany	9a293ca	2016-06-07 23:13:54 +0000	[diff] [blame]	186	ScudoHardenedAllocator
Andrew Kaylor	3aeda4f	2016-08-26 23:11:48 +0000	[diff] [blame]	187	OptBisect
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	188
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	189	:doc:`LLVM Language Reference Manual <LangRef>`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	190	Defines the LLVM intermediate representation and the assembly form of the
				191	different nodes.
				192
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	193	:doc:`Atomics`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	194	Information about LLVM's concurrency model.
				195
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	196	:doc:`ProgrammersManual`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	197	Introduction to the general layout of the LLVM sourcebase, important classes
				198	and APIs, and some tips & tricks.
				199
Nico Rieck	1da4529	2013-04-10 23:28:17 +0000	[diff] [blame]	200	:doc:`Extensions`
				201	LLVM-specific extensions to tools and formats LLVM seeks compatibility with.
				202
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	203	:doc:`CommandLine`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	204	Provides information on using the command line parsing library.
				205
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	206	:doc:`CodingStandards`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	207	Details the LLVM coding standards and provides useful information on writing
				208	efficient C++ code.
				209
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	210	:doc:`HowToSetUpLLVMStyleRTTI`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	211	How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
				212	class hierarchy.
				213
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	214	:doc:`ExtendingLLVM`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	215	Look here to see how to add instructions and intrinsics to LLVM.
				216
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	217	`Doxygen generated documentation <http://llvm.org/doxygen/>`_
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	218	(`classes <http://llvm.org/doxygen/inherits.html>`_)
				219	(`tarball <http://llvm.org/doxygen/doxygen.tar.gz>`_)
				220
Peter Collingbourne	943d270	2015-01-13 18:49:42 +0000	[diff] [blame]	221	`Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
				222
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	223	`ViewVC Repository Browser <http://llvm.org/viewvc/>`_
				224	..
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	225
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	226	:doc:`CompilerWriterInfo`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	227	A list of helpful links for compiler writers.
				228
Kostya Serebryany	35ce863	2015-03-30 23:05:30 +0000	[diff] [blame]	229	:doc:`LibFuzzer`
				230	A library for writing in-process guided fuzzers.
				231
Kostya Serebryany	9a293ca	2016-06-07 23:13:54 +0000	[diff] [blame]	232	:doc:`ScudoHardenedAllocator`
				233	A library that implements a security-hardened `malloc()`.
				234
Andrew Kaylor	3aeda4f	2016-08-26 23:11:48 +0000	[diff] [blame]	235	:doc:`OptBisect`
				236	A command line option for debugging optimization-induced failures.
				237
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	238	Subsystem Documentation
				239	=======================
				240
				241	For API clients and LLVM developers.
				242
				243	.. toctree::
				244	:hidden:
				245
				246	AliasAnalysis
George Burgess IV	3bbeb73	2016-08-17 00:17:29 +0000	[diff] [blame]	247	MemorySSA
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	248	BitCodeFormat
Duncan P. N. Exon Smith	6e40cec	2014-04-11 23:21:07 +0000	[diff] [blame]	249	BlockFrequencyTerminology
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	250	BranchWeightMetadata
				251	Bugpoint
				252	CodeGenerator
				253	ExceptionHandling
				254	LinkTimeOptimization
				255	SegmentedStacks
				256	TableGenFundamentals
Renato Golin	ca10564	2014-03-20 16:08:34 +0000	[diff] [blame]	257	TableGen/index
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	258	DebuggingJITedCode
				259	GoldPlugin
				260	MarkedUpDisassembly
				261	SystemLibrary
				262	SourceLevelDebugging
				263	Vectorizers
				264	WritingAnLLVMBackend
				265	GarbageCollection
				266	WritingAnLLVMPass
Joe Abbey	ba3e901	2013-02-12 11:45:22 +0000	[diff] [blame]	267	HowToUseAttributes
Justin Holewinski	45df882	2013-03-30 16:41:14 +0000	[diff] [blame]	268	NVPTXUsage
Tom Stellard	45bb48e	2015-06-13 03:28:10 +0000	[diff] [blame]	269	AMDGPUUsage
Andrew Trick	5e029ce	2013-12-24 02:57:25 +0000	[diff] [blame]	270	StackMaps
Sean Silva	216f1ee	2014-03-02 00:21:42 +0000	[diff] [blame]	271	InAlloca
James Molloy	3f7878a	2014-05-12 15:13:39 +0000	[diff] [blame]	272	BigEndianNEON
Alex Lorenz	6a12833	2014-08-19 17:05:58 +0000	[diff] [blame]	273	CoverageMappingFormat
Matt Arsenault	03f0e83	2014-12-03 18:35:11 +0000	[diff] [blame]	274	Statepoints
Stepan Dyatkovskiy	f0c3a34	2014-12-10 17:42:01 +0000	[diff] [blame]	275	MergeFunctions
Peter Collingbourne	7efd750	2016-06-24 21:21:32 +0000	[diff] [blame]	276	TypeMetadata
Sanjoy Das	5553bc8	2015-06-15 19:38:15 +0000	[diff] [blame]	277	FaultMaps
Alex Lorenz	3d31177	2015-08-06 22:55:19 +0000	[diff] [blame]	278	MIRLangRef
David Majnemer	a653927	2016-07-23 04:05:08 +0000	[diff] [blame]	279	Coroutines
Ahmed Bougacha	29d9da1	2016-11-04 17:57:34 +0000	[diff] [blame]	280	GlobalISel
Dean Michael Berris	f3da16b	2016-11-09 00:24:58 +0000	[diff] [blame]	281	XRay
Dean Michael Berris	46979b4	2017-03-31 02:51:19 +0000	[diff] [blame]	282	XRayExample
Zachary Turner	218ce83	2016-11-10 19:24:21 +0000	[diff] [blame]	283	PDB/index
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	284
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	285	:doc:`WritingAnLLVMPass`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	286	Information on how to write LLVM transformations and analyses.
				287
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	288	:doc:`WritingAnLLVMBackend`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	289	Information on how to write LLVM backends for machine targets.
				290
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	291	:doc:`CodeGenerator`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	292	The design and implementation of the LLVM code generator. Useful if you are
				293	working on retargetting LLVM to a new architecture, designing a new codegen
				294	pass, or enhancing existing components.
				295
Alex Lorenz	3d31177	2015-08-06 22:55:19 +0000	[diff] [blame]	296	:doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`
				297	A reference manual for the MIR serialization format, which is used to test
				298	LLVM's code generation passes.
				299
Sean Silva	0b4df9b	2014-04-07 22:42:53 +0000	[diff] [blame]	300	:doc:`TableGen <TableGen/index>`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	301	Describes the TableGen tool, which is used heavily by the LLVM code
				302	generator.
				303
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	304	:doc:`AliasAnalysis`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	305	Information on how to write a new alias analysis implementation or how to
				306	use existing analyses.
				307
George Burgess IV	3bbeb73	2016-08-17 00:17:29 +0000	[diff] [blame]	308	:doc:`MemorySSA`
				309	Information about the MemorySSA utility in LLVM, as well as how to use it.
				310
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	311	:doc:`GarbageCollection`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	312	The interfaces source-language compilers should use for compiling GC'd
				313	programs.
				314
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	315	:doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	316	This document describes the design and philosophy behind the LLVM
				317	source-level debugger.
				318
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	319	:doc:`Vectorizers`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	320	This document describes the current status of vectorization in LLVM.
				321
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	322	:doc:`ExceptionHandling`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	323	This document describes the design and implementation of exception handling
				324	in LLVM.
				325
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	326	:doc:`Bugpoint`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	327	Automatic bug finder and test-case reducer description and usage
				328	information.
				329
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	330	:doc:`BitCodeFormat`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	331	This describes the file format and encoding used for LLVM "bc" files.
				332
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	333	:doc:`System Library <SystemLibrary>`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	334	This document describes the LLVM System Library (``lib/System``) and
				335	how to keep LLVM source code portable
				336
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	337	:doc:`LinkTimeOptimization`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	338	This document describes the interface between LLVM intermodular optimizer
				339	and the linker and its design
				340
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	341	:doc:`GoldPlugin`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	342	How to build your programs with link-time optimization on Linux.
				343
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	344	:doc:`DebuggingJITedCode`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	345	How to debug JITed code with GDB.
				346
Andrew Kaylor	27299c3	2013-08-21 22:15:09 +0000	[diff] [blame]	347	:doc:`MCJITDesignAndImplementation`
				348	Describes the inner workings of MCJIT execution engine.
				349
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	350	:doc:`BranchWeightMetadata`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	351	Provides information about Branch Prediction Information.
				352
Duncan P. N. Exon Smith	6e40cec	2014-04-11 23:21:07 +0000	[diff] [blame]	353	:doc:`BlockFrequencyTerminology`
				354	Provides information about terminology used in the ``BlockFrequencyInfo``
				355	analysis pass.
				356
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	357	:doc:`SegmentedStacks`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	358	This document describes segmented stacks and how they are used in LLVM.
				359
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	360	:doc:`MarkedUpDisassembly`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	361	This document describes the optional rich disassembly output syntax.
				362
Joe Abbey	ba3e901	2013-02-12 11:45:22 +0000	[diff] [blame]	363	:doc:`HowToUseAttributes`
				364	Answers some questions about the new Attributes infrastructure.
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	365
Justin Holewinski	45df882	2013-03-30 16:41:14 +0000	[diff] [blame]	366	:doc:`NVPTXUsage`
Tony Tye	f16a45e	2017-06-06 20:31:59 +0000	[diff] [blame]	367	This document describes using the NVPTX backend to compile GPU kernels.
Justin Holewinski	45df882	2013-03-30 16:41:14 +0000	[diff] [blame]	368
Tom Stellard	45bb48e	2015-06-13 03:28:10 +0000	[diff] [blame]	369	:doc:`AMDGPUUsage`
Tony Tye	f16a45e	2017-06-06 20:31:59 +0000	[diff] [blame]	370	This document describes using the AMDGPU backend to compile GPU kernels.
Tom Stellard	9d7ddd5	2014-11-14 14:08:00 +0000	[diff] [blame]	371
Andrew Trick	5e029ce	2013-12-24 02:57:25 +0000	[diff] [blame]	372	:doc:`StackMaps`
				373	LLVM support for mapping instruction addresses to the location of
				374	values and allowing code to be patched.
Justin Holewinski	45df882	2013-03-30 16:41:14 +0000	[diff] [blame]	375
James Molloy	3f7878a	2014-05-12 15:13:39 +0000	[diff] [blame]	376	:doc:`BigEndianNEON`
				377	LLVM's support for generating NEON instructions on big endian ARM targets is
				378	somewhat nonintuitive. This document explains the implementation and rationale.
				379
Alex Lorenz	6a12833	2014-08-19 17:05:58 +0000	[diff] [blame]	380	:doc:`CoverageMappingFormat`
				381	This describes the format and encoding used for LLVM’s code coverage mapping.
James Molloy	3f7878a	2014-05-12 15:13:39 +0000	[diff] [blame]	382
Matt Arsenault	03f0e83	2014-12-03 18:35:11 +0000	[diff] [blame]	383	:doc:`Statepoints`
				384	This describes a set of experimental extensions for garbage
				385	collection support.
				386
Stepan Dyatkovskiy	f0c3a34	2014-12-10 17:42:01 +0000	[diff] [blame]	387	:doc:`MergeFunctions`
				388	Describes functions merging optimization.
				389
Sean Silva	b6472fe	2015-02-04 20:51:19 +0000	[diff] [blame]	390	:doc:`InAlloca`
				391	Description of the ``inalloca`` argument attribute.
				392
Sanjoy Das	5553bc8	2015-06-15 19:38:15 +0000	[diff] [blame]	393	:doc:`FaultMaps`
				394	LLVM support for folding control flow into faulting machine instructions.
				395
Jingyue Wu	4f2a6cb	2015-11-10 22:35:47 +0000	[diff] [blame]	396	:doc:`CompileCudaWithLLVM`
				397	LLVM support for CUDA.
				398
David Majnemer	a653927	2016-07-23 04:05:08 +0000	[diff] [blame]	399	:doc:`Coroutines`
				400	LLVM support for coroutines.
				401
Ahmed Bougacha	29d9da1	2016-11-04 17:57:34 +0000	[diff] [blame]	402	:doc:`GlobalISel`
				403	This describes the prototype instruction selection replacement, GlobalISel.
				404
Dean Michael Berris	f3da16b	2016-11-09 00:24:58 +0000	[diff] [blame]	405	:doc:`XRay`
				406	High-level documentation of how to use XRay in LLVM.
				407
Dean Michael Berris	38daca6	2017-03-30 23:46:36 +0000	[diff] [blame]	408	:doc:`XRayExample`
				409	An example of how to debug an application with XRay.
				410
Zachary Turner	218ce83	2016-11-10 19:24:21 +0000	[diff] [blame]	411	:doc:`The Microsoft PDB File Format <PDB/index>`
				412	A detailed description of the Microsoft PDB (Program Database) file format.
				413
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	414	Development Process Documentation
				415	=================================
				416
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	417	Information about LLVM's development process.
				418
				419	.. toctree::
				420	:hidden:
				421
Sean Silva	9d205c8	2013-03-30 15:32:47 +0000	[diff] [blame]	422	DeveloperPolicy
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	423	Projects
				424	LLVMBuild
				425	HowToReleaseLLVM
Sean Silva	bdb940f	2013-01-28 21:28:10 +0000	[diff] [blame]	426	Packaging
Sean Silva	3f93a61	2013-09-09 19:09:00 +0000	[diff] [blame]	427	ReleaseProcess
Adrian Prantl	adc41ca	2014-10-03 20:17:32 +0000	[diff] [blame]	428	Phabricator
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	429
Sean Silva	9d205c8	2013-03-30 15:32:47 +0000	[diff] [blame]	430	:doc:`DeveloperPolicy`
				431	The LLVM project's policy towards developers and their contributions.
				432
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	433	:doc:`Projects`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	434	How-to guide and templates for new projects that use the LLVM
				435	infrastructure. The templates (directory organization, Makefiles, and test
				436	tree) allow the project code to be located outside (or inside) the ``llvm/``
				437	tree, while using LLVM header files and libraries.
				438
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	439	:doc:`LLVMBuild`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	440	Describes the LLVMBuild organization and files used by LLVM to specify
				441	component descriptions.
				442
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	443	:doc:`HowToReleaseLLVM`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	444	This is a guide to preparing LLVM releases. Most developers can ignore it.
				445
Renato Golin	c08f218	2013-05-28 10:32:55 +0000	[diff] [blame]	446	:doc:`ReleaseProcess`
Jyoti Allur	223602d	2014-09-26 06:59:15 +0000	[diff] [blame]	447	This is a guide to validate a new release, during the release process. Most developers can ignore it.
Renato Golin	c08f218	2013-05-28 10:32:55 +0000	[diff] [blame]	448
Sean Silva	bdb940f	2013-01-28 21:28:10 +0000	[diff] [blame]	449	:doc:`Packaging`
				450	Advice on packaging LLVM into a distribution.
				451
Adrian Prantl	adc41ca	2014-10-03 20:17:32 +0000	[diff] [blame]	452	:doc:`Phabricator`
				453	Describes how to use the Phabricator code review tool hosted on
				454	http://reviews.llvm.org/ and its command line interface, Arcanist.
				455
Sean Silva	0129924	2013-03-30 15:32:51 +0000	[diff] [blame]	456	Community
				457	=========
				458
				459	LLVM has a thriving community of friendly and helpful developers.
				460	The two primary communication mechanisms in the LLVM community are mailing
				461	lists and IRC.
				462
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	463	Mailing Lists
Sean Silva	0129924	2013-03-30 15:32:51 +0000	[diff] [blame]	464	-------------
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	465
				466	If you can't find what you need in these docs, try consulting the mailing
				467	lists.
				468
Tanya Lattner	0d28f80	2015-08-05 03:51:17 +0000	[diff] [blame]	469	`Developer's List (llvm-dev)`__
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	470	This list is for people who want to be included in technical discussions of
				471	LLVM. People post to this list when they have questions about writing code
				472	for or using the LLVM tools. It is relatively low volume.
				473
Tanya Lattner	0d28f80	2015-08-05 03:51:17 +0000	[diff] [blame]	474	.. __: http://lists.llvm.org/mailman/listinfo/llvm-dev
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	475
Sean Silva	ab4997d	2013-03-30 15:33:01 +0000	[diff] [blame]	476	`Commits Archive (llvm-commits)`__
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	477	This list contains all commit messages that are made when LLVM developers
Sean Silva	2a74699	2013-03-30 15:33:02 +0000	[diff] [blame]	478	commit code changes to the repository. It also serves as a forum for
				479	patch review (i.e. send patches here). It is useful for those who want to
				480	stay on the bleeding edge of LLVM development. This list is very high
				481	volume.
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	482
Tanya Lattner	0d28f80	2015-08-05 03:51:17 +0000	[diff] [blame]	483	.. __: http://lists.llvm.org/pipermail/llvm-commits/
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	484
Tanya Lattner	0d28f80	2015-08-05 03:51:17 +0000	[diff] [blame]	485	`Bugs & Patches Archive (llvm-bugs)`__
Sean Silva	2a74699	2013-03-30 15:33:02 +0000	[diff] [blame]	486	This list gets emailed every time a bug is opened and closed. It is
Tanya Lattner	0d28f80	2015-08-05 03:51:17 +0000	[diff] [blame]	487	higher volume than the LLVM-dev list.
Sean Silva	84b296c	2013-03-30 15:32:54 +0000	[diff] [blame]	488
Tanya Lattner	0d28f80	2015-08-05 03:51:17 +0000	[diff] [blame]	489	.. __: http://lists.llvm.org/pipermail/llvm-bugs/
Sean Silva	84b296c	2013-03-30 15:32:54 +0000	[diff] [blame]	490
Sean Silva	ab4997d	2013-03-30 15:33:01 +0000	[diff] [blame]	491	`Test Results Archive (llvm-testresults)`__
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	492	A message is automatically sent to this list by every active nightly tester
				493	when it completes. As such, this list gets email several times each day,
				494	making it a high volume list.
				495
Tanya Lattner	0d28f80	2015-08-05 03:51:17 +0000	[diff] [blame]	496	.. __: http://lists.llvm.org/pipermail/llvm-testresults/
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	497
Sean Silva	ab4997d	2013-03-30 15:33:01 +0000	[diff] [blame]	498	`LLVM Announcements List (llvm-announce)`__
Sean Silva	84b296c	2013-03-30 15:32:54 +0000	[diff] [blame]	499	This is a low volume list that provides important announcements regarding
				500	LLVM. It gets email about once a month.
				501
Tanya Lattner	0d28f80	2015-08-05 03:51:17 +0000	[diff] [blame]	502	.. __: http://lists.llvm.org/mailman/listinfo/llvm-announce
Sean Silva	84b296c	2013-03-30 15:32:54 +0000	[diff] [blame]	503
Sean Silva	0129924	2013-03-30 15:32:51 +0000	[diff] [blame]	504	IRC
				505	---
				506
				507	Users and developers of the LLVM project (including subprojects such as Clang)
				508	can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
				509
				510	This channel has several bots.
				511
				512	* Buildbot reporters
				513
				514	* llvmbb - Bot for the main LLVM buildbot master.
				515	http://lab.llvm.org:8011/console
				516	* bb-chapuni - An individually run buildbot master. http://bb.pgr.jp/console
				517	* smooshlab - Apple's internal buildbot master.
				518
				519	* robot - Bugzilla linker. %bug <number>
				520
				521	* clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
				522	near-trunk clang instead of gcc.
				523
Renato Golin	e433cf7	2016-07-20 09:38:04 +0000	[diff] [blame]	524	Community wide proposals
				525	------------------------
				526
				527	Proposals for massive changes in how the community behaves and how the work flow
				528	can be better.
				529
				530	.. toctree::
				531	:hidden:
				532
				533	CodeOfConduct
Mehdi Amini	647deb8	2016-10-12 23:02:02 +0000	[diff] [blame]	534	Proposals/GitHubMove
Ayal Zaks	4c4baf5	2017-05-29 15:36:23 +0000	[diff] [blame]	535	Proposals/VectorizationPlan
Renato Golin	e433cf7	2016-07-20 09:38:04 +0000	[diff] [blame]	536
				537	:doc:`CodeOfConduct`
				538	Proposal to adopt a code of conduct on the LLVM social spaces (lists, events,
				539	IRC, etc).
				540
Mehdi Amini	647deb8	2016-10-12 23:02:02 +0000	[diff] [blame]	541	:doc:`Proposals/GitHubMove`
Renato Golin	e433cf7	2016-07-20 09:38:04 +0000	[diff] [blame]	542	Proposal to move from SVN/Git to GitHub.
				543
Ayal Zaks	4c4baf5	2017-05-29 15:36:23 +0000	[diff] [blame]	544	:doc:`Proposals/VectorizationPlan`
				545	Proposal to model the process and upgrade the infrastructure of LLVM's Loop Vectorizer.
Sean Silva	0129924	2013-03-30 15:32:51 +0000	[diff] [blame]	546
Daniel Dunbar	fbb8041	2012-04-19 16:31:37 +0000	[diff] [blame]	547	Indices and tables
				548	==================
				549
				550	* :ref:`genindex`
				551	* :ref:`search`