maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/llvm/docs/Reference.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

218 lines
5.4 KiB
ReStructuredText
Raw Normal View History

[Docs] Moves Reference docs to new page Moves Reference docs to new page. Also adds a table of contents to Getting Involved page. llvm-svn: 372796
2019-09-25 08:49:02 +08:00
Reference
=========
LLVM and API reference documentation.
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
.. contents::
:local:
[Docs] Moves Reference docs to new page Moves Reference docs to new page. Also adds a table of contents to Getting Involved page. llvm-svn: 372796
2019-09-25 08:49:02 +08:00
.. toctree::
:hidden:
[Docs] Removes Programming Documentation page Removes Programming Documentation page. Also moves existing topics on Programming Documentation page to User Guides and Reference pages. llvm-svn: 373856
2019-10-07 00:10:11 +08:00
Atomics
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
BitCodeFormat
BlockFrequencyTerminology
BranchWeightMetadata
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
Bugpoint
CommandGuide/index
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
Coroutines
DependenceGraphs/index
ExceptionHandling
[Docs] Removes Programming Documentation page Removes Programming Documentation page. Also moves existing topics on Programming Documentation page to User Guides and Reference pages. llvm-svn: 373856
2019-10-07 00:10:11 +08:00
Extensions
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
FaultMaps
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
FuzzingLLVM
GarbageCollection
GetElementPtr
[globalisel] Restructure the GlobalISel documentation There's a couple minor deletions amongst this but 99% of it is just moving the documentation around to prepare the way for more meaningful changes.
2019-10-26 06:50:36 +08:00
GlobalISel/index
[Docs] Removes Programming Documentation page Removes Programming Documentation page. Also moves existing topics on Programming Documentation page to User Guides and Reference pages. llvm-svn: 373856
2019-10-07 00:10:11 +08:00
GwpAsan
HowToSetUpLLVMStyleRTTI
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
HowToUseAttributes
InAlloca
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
LangRef
LibFuzzer
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
MarkedUpDisassembly
[Docs] Moves Reference docs to new page Moves Reference docs to new page. Also adds a table of contents to Getting Involved page. llvm-svn: 372796
2019-09-25 08:49:02 +08:00
MIRLangRef
[Docs] Removes Programming Documentation page Removes Programming Documentation page. Also moves existing topics on Programming Documentation page to User Guides and Reference pages. llvm-svn: 373856
2019-10-07 00:10:11 +08:00
OptBisect
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
PDB/index
[IR] Define ptrauth intrinsics. This defines the new `@llvm.ptrauth.` pointer authentication intrinsics: sign, auth, strip, blend, and sign_generic, documented in PointerAuth.md. Pointer Authentication is a mechanism by which certain pointers are signed. When a pointer gets signed, a cryptographic hash of its value and other values (pepper and salt) is stored in unused bits of that pointer. Before the pointer is used, it needs to be authenticated, i.e., have its signature checked. This prevents pointer values of unknown origin from being used to replace the signed pointer value. sign and auth provide the core operations. strip removes the ptrauth bits from a signed pointer without checking them. sign_generic allows signing non-pointer values. Finally, blend combines salt values ("discriminators") to derive more targeted and less reusable ones. In later patches, we implement primary backend support for these intrinsics using the AArch64 PAuth feature, and build on that to implement the arm64e Darwin ABI and ELF PAuth ABI Extension in clang. For more details, see the docs page, as well as our llvm-dev RFC: http://lists.llvm.org/pipermail/llvm-dev/2019-October/136091.html or our 2019 Developers' Meeting talk. Differential Revision: https://reviews.llvm.org/D90868
2021-09-27 23:00:00 +08:00
PointerAuth
[Docs] Removes Programming Documentation page Removes Programming Documentation page. Also moves existing topics on Programming Documentation page to User Guides and Reference pages. llvm-svn: 373856
2019-10-07 00:10:11 +08:00
ScudoHardenedAllocator
Add MemTagSanitizer documentation. Summary: A lot of this is work in progress... Reviewers: kcc, pcc Subscribers: cryptoad, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D69289
2019-10-19 03:32:21 +08:00
MemTagSanitizer
[docs] LLVM Security Group and Process Summary: See the corresponding RFC on llvm-dev for a discussion of this proposal. http://lists.llvm.org/pipermail/llvm-dev/2019-November/136839.html Subscribers: jkorous, dexonsmith, arphaman, ributzka, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D70326
2019-11-16 02:54:39 +08:00
Security
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
SegmentedStacks
StackMaps
SpeculativeLoadHardening
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
Statepoints
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
SystemLibrary
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
TestingGuide
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
TransformMetadata
TypeMetadata
XRay
XRayExample
XRayFDRFormat
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
YamlIO
API Reference
-------------
Doc: Links should use https
2020-03-23 05:42:03 +08:00
`Doxygen generated documentation <https://llvm.org/doxygen/>`_
(`classes <https://llvm.org/doxygen/inherits.html>`_)
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
[Docs] Adds section for Additional Topics on Reference page Adds a new section for Additional Topics on the Reference documentation page. Also moves Support Library topic to User Guides page. llvm-svn: 374230
2019-10-10 05:09:09 +08:00
:doc:`HowToUseAttributes`
Answers some questions about the new Attributes infrastructure.
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
`Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
[Docs] Moves article links to new pages Moves existing article links on the Programming, Subsystem, and Reference documentation pages to new locations. Also moves Github Repository and Publications links to the sidebar. llvm-svn: 373169
2019-09-29 23:31:52 +08:00
LLVM Reference
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
--------------
[Docs] Moves Reference docs to new page Moves Reference docs to new page. Also adds a table of contents to Getting Involved page. llvm-svn: 372796
2019-09-25 08:49:02 +08:00
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
======================
Command Line Utilities
======================
[Docs] Moves article links to new pages Moves existing article links on the Programming, Subsystem, and Reference documentation pages to new locations. Also moves Github Repository and Publications links to the sidebar. llvm-svn: 373169
2019-09-29 23:31:52 +08:00
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
:doc:`LLVM Command Guide <CommandGuide/index>`
A reference manual for the LLVM command line utilities ("man" pages for LLVM
tools).
[Docs] Moves Reference docs to new page Moves Reference docs to new page. Also adds a table of contents to Getting Involved page. llvm-svn: 372796
2019-09-25 08:49:02 +08:00
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
:doc:`Bugpoint`
Automatic bug finder and test-case reducer description and usage
information.
[Docs] Removes Programming Documentation page Removes Programming Documentation page. Also moves existing topics on Programming Documentation page to User Guides and Reference pages. llvm-svn: 373856
2019-10-07 00:10:11 +08:00
:doc:`OptBisect`
A command line option for debugging optimization-induced failures.
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
:doc:`The Microsoft PDB File Format <PDB/index>`
A detailed description of the Microsoft PDB (Program Database) file format.
==================
Garbage Collection
==================
:doc:`GarbageCollection`
The interfaces source-language compilers should use for compiling GC'd
programs.
:doc:`Statepoints`
This describes a set of experimental extensions for garbage
collection support.
=========
LibFuzzer
=========
:doc:`LibFuzzer`
A library for writing in-process guided fuzzers.
:doc:`FuzzingLLVM`
Information on writing and using Fuzzers to find bugs in LLVM.
[Docs] Adds Documentation links to sidebar Adds links to Getting Started/Tutorials, User Guides, and Reference documentation pages to sidebar. Also adds a new section for LLVM IR on the Reference documentation page. llvm-svn: 374214
2019-10-10 04:26:13 +08:00
========
LLVM IR
========
:doc:`LLVM Language Reference Manual <LangRef>`
Defines the LLVM intermediate representation and the assembly form of the
different nodes.
:doc:`InAlloca`
Description of the ``inalloca`` argument attribute.
:doc:`BitCodeFormat`
This describes the file format and encoding used for LLVM "bc" files.
:doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`
A reference manual for the MIR serialization format, which is used to test
LLVM's code generation passes.
[globalisel] Restructure the GlobalISel documentation There's a couple minor deletions amongst this but 99% of it is just moving the documentation around to prepare the way for more meaningful changes.
2019-10-26 06:50:36 +08:00
:doc:`GlobalISel/index`
[Docs] Adds Documentation links to sidebar Adds links to Getting Started/Tutorials, User Guides, and Reference documentation pages to sidebar. Also adds a new section for LLVM IR on the Reference documentation page. llvm-svn: 374214
2019-10-10 04:26:13 +08:00
This describes the prototype instruction selection replacement, GlobalISel.
[Docs] Moves Control Flow Document to User Guides Moves Control Flow document from Reference docs page to User guides page. llvm-svn: 374733
2019-10-14 04:05:22 +08:00
=====================
Testing and Debugging
=====================
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
A reference manual for using the LLVM testing infrastructure.
:doc:`TestSuiteGuide`
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
Describes how to compile and run the test-suite benchmarks.
[Docs] Moves Control Flow Document to User Guides Moves Control Flow document from Reference docs page to User guides page. llvm-svn: 374733
2019-10-14 04:05:22 +08:00
:doc:`GwpAsan`
A sampled heap memory error detection toolkit designed for production use.
[Docs] Removes Subsystem Documentation page Removes Subsystem Documentation page. Also moves existing topics on Subsystem Documentation page to User Guides and Reference pages. llvm-svn: 373872
2019-10-07 06:49:22 +08:00
====
XRay
====
:doc:`XRay`
High-level documentation of how to use XRay in LLVM.
:doc:`XRayExample`
[Docs] Adds section for Additional Topics on Reference page Adds a new section for Additional Topics on the Reference documentation page. Also moves Support Library topic to User Guides page. llvm-svn: 374230
2019-10-10 05:09:09 +08:00
An example of how to debug an application with XRay.
=================
Additional Topics
=================
:doc:`FaultMaps`
LLVM support for folding control flow into faulting machine instructions.
:doc:`Atomics`
Information about LLVM's concurrency model.
:doc:`ExceptionHandling`
This document describes the design and implementation of exception handling
in LLVM.
:doc:`Extensions`
LLVM-specific extensions to tools and formats LLVM seeks compatibility with.
:doc:`HowToSetUpLLVMStyleRTTI`
How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
class hierarchy.
:doc:`BlockFrequencyTerminology`
Provides information about terminology used in the ``BlockFrequencyInfo``
analysis pass.
:doc:`BranchWeightMetadata`
Provides information about Branch Prediction Information.
:doc:`GetElementPtr`
Answers to some very frequent questions about LLVM's most frequently
misunderstood instruction.
:doc:`ScudoHardenedAllocator`
A library that implements a security-hardened `malloc()`.
Add MemTagSanitizer documentation. Summary: A lot of this is work in progress... Reviewers: kcc, pcc Subscribers: cryptoad, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D69289
2019-10-19 03:32:21 +08:00
:doc:`MemTagSanitizer`
Security hardening for production code aiming to mitigate memory
Fix MemTagSanitizer docs to point at Armv8.5-A MTE The Memory Tagging Extension was introduced in Armv8.5-A.
2020-03-06 00:27:25 +08:00
related vulnerabilities. Based on the Armv8.5-A Memory Tagging Extension.
Add MemTagSanitizer documentation. Summary: A lot of this is work in progress... Reviewers: kcc, pcc Subscribers: cryptoad, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D69289
2019-10-19 03:32:21 +08:00
[Docs] Adds section for Additional Topics on Reference page Adds a new section for Additional Topics on the Reference documentation page. Also moves Support Library topic to User Guides page. llvm-svn: 374230
2019-10-10 05:09:09 +08:00
:doc:`Dependence Graphs <DependenceGraphs/index>`
A description of the design of the various dependence graphs such as
the DDG (Data Dependence Graph).
:doc:`SpeculativeLoadHardening`
A description of the Speculative Load Hardening mitigation for Spectre v1.
:doc:`SegmentedStacks`
This document describes segmented stacks and how they are used in LLVM.
:doc:`MarkedUpDisassembly`
This document describes the optional rich disassembly output syntax.
:doc:`StackMaps`
LLVM support for mapping instruction addresses to the location of
values and allowing code to be patched.
:doc:`Coroutines`
LLVM support for coroutines.
[IR] Define ptrauth intrinsics. This defines the new `@llvm.ptrauth.` pointer authentication intrinsics: sign, auth, strip, blend, and sign_generic, documented in PointerAuth.md. Pointer Authentication is a mechanism by which certain pointers are signed. When a pointer gets signed, a cryptographic hash of its value and other values (pepper and salt) is stored in unused bits of that pointer. Before the pointer is used, it needs to be authenticated, i.e., have its signature checked. This prevents pointer values of unknown origin from being used to replace the signed pointer value. sign and auth provide the core operations. strip removes the ptrauth bits from a signed pointer without checking them. sign_generic allows signing non-pointer values. Finally, blend combines salt values ("discriminators") to derive more targeted and less reusable ones. In later patches, we implement primary backend support for these intrinsics using the AArch64 PAuth feature, and build on that to implement the arm64e Darwin ABI and ELF PAuth ABI Extension in clang. For more details, see the docs page, as well as our llvm-dev RFC: http://lists.llvm.org/pipermail/llvm-dev/2019-October/136091.html or our 2019 Developers' Meeting talk. Differential Revision: https://reviews.llvm.org/D90868
2021-09-27 23:00:00 +08:00
:doc:`PointerAuth`
A description of pointer authentication, its LLVM IR representation, and its
support in the backend.
[Docs] Adds section for Additional Topics on Reference page Adds a new section for Additional Topics on the Reference documentation page. Also moves Support Library topic to User Guides page. llvm-svn: 374230
2019-10-10 05:09:09 +08:00
:doc:`YamlIO`
[globalisel] Restructure the GlobalISel documentation There's a couple minor deletions amongst this but 99% of it is just moving the documentation around to prepare the way for more meaningful changes.
2019-10-26 06:50:36 +08:00
A reference guide for using LLVM's YAML I/O library.