Blame - docs/index.rst - platform_external_llvm

blob: 49bd327f47dec2b1e5d82cb9feab0e98fcf74fe1 [file] [log] [blame]

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