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

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