1
0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-24 03:33:20 +01:00
llvm-mirror/docs
Florian Hahn 1643768c5c [Matrix] Add first set of matrix intrinsics and initial lowering pass.
This is the first patch adding an initial set of matrix intrinsics and a
corresponding lowering pass. This has been discussed on llvm-dev:
http://lists.llvm.org/pipermail/llvm-dev/2019-October/136240.html

The first patch introduces four new intrinsics (transpose, multiply,
columnwise load and store) and a LowerMatrixIntrinsics pass, that
lowers those intrinsics to vector operations.

Matrixes are embedded in a 'flat' vector (e.g. a 4 x 4 float matrix
embedded in a <16 x float> vector) and the intrinsics take the dimension
information as parameters. Those parameters need to be ConstantInt.
For the memory layout, we initially assume column-major, but in the RFC
we also described how to extend the intrinsics to support row-major as
well.

For the initial lowering, we split the input of the intrinsics into a
set of column vectors, transform those column vectors and concatenate
the result columns to a flat result vector.

This allows us to lower the intrinsics without any shape propagation, as
mentioned in the RFC. In follow-up patches, we plan to submit the
following improvements:
 * Shape propagation to eliminate the embedding/splitting for each
   intrinsic.
 * Fused & tiled lowering of multiply and other operations.
 * Optimization remarks highlighting matrix expressions and costs.
 * Generate loops for operations on large matrixes.
 * More general block processing for operation on large vectors,
   exploiting shape information.

We would like to add dedicated transpose, columnwise load and store
intrinsics, even though they are not strictly necessary. For example, we
could instead emit a large shufflevector instruction instead of the
transpose. But we expect that to
  (1) become unwieldy for larger matrixes (even for 16x16 matrixes,
      the resulting shufflevector masks would be huge),
  (2) risk instcombine making small changes, causing us to fail to
      detect the transpose, preventing better lowerings

For the load/store, we are additionally planning on exploiting the
intrinsics for better alias analysis.

Reviewers: anemet, Gerolf, reames, hfinkel, andrew.w.kaylor, efriedma, rengolin

Reviewed By: anemet

Differential Revision: https://reviews.llvm.org/D70456
2019-12-12 15:42:18 +00:00
..
_ocamldoc
_static
_templates [www] More HTTPS and outdated link fixes. 2019-11-08 14:41:27 -08:00
_themes/llvm-theme [Docs] Updates sidebar links and sets max-width property for div.body 2019-10-15 21:27:20 +00:00
AMDGPU [AMDGPU][MC][DOC] Updated AMD GPU assembler description. 2019-09-25 12:38:35 +00:00
CommandGuide [llvm-readobj] - Implement --dependent-libraries flag. 2019-12-06 14:28:29 +03:00
DependenceGraphs Data Dependence Graph Basics 2019-09-18 17:43:45 +00:00
Frontend [docs] Remove training whitespaces. NFC 2019-09-20 15:02:32 +00:00
GlobalISel Try to fix sphinx "Could not lex literal_block as "llvm"" warning. 2019-11-09 22:15:26 +00:00
HistoricalNotes
PDB Fix a few spellos in docs. 2019-09-13 14:58:24 +00:00
Proposals Fix the spelling of my name. 2019-10-07 22:55:42 +00:00
TableGen [TableGen] Add bang-operators !getop and !setop. 2019-12-11 12:05:22 +00:00
tutorial [docs] Fix broken links in Kaleidoscope chapter 3 2019-11-17 21:35:02 -05:00
AddingConstrainedIntrinsics.rst [FEnv] Fix AddingConstrainedIntrinsics.rst after llvmorg-10-init-10282-g0c50c0b0552 2019-11-19 23:09:13 -08:00
AdvancedBuilds.rst
AliasAnalysis.rst
AMDGPUInstructionNotation.rst
AMDGPUInstructionSyntax.rst [AMDGPU][MC][DOC] Updated AMD GPU assembler syntax description. 2019-07-08 16:50:11 +00:00
AMDGPUModifierSyntax.rst [AMDGPU][MC][DOC] Updated AMD GPU assembler description. 2019-09-25 12:38:35 +00:00
AMDGPUOperandSyntax.rst [AMDGPU][MC][DOC] Updated AMD GPU assembler description. 2019-09-25 12:38:35 +00:00
AMDGPUUsage.rst Fix a few doc typos, to cycle bots. 2019-12-08 18:51:48 -05:00
ARM-BE-bitcastfail.png
ARM-BE-bitcastsuccess.png
ARM-BE-ld1.png
ARM-BE-ldr.png
Atomics.rst [NFC] Test commit, deleting some whitespace 2019-09-20 09:43:31 +00:00
Benchmarking.rst
BigEndianNEON.rst
BitCodeFormat.rst [X86] Add new calling convention that guarantees tail call optimization 2019-10-07 22:28:58 +00:00
BlockFrequencyTerminology.rst
BranchWeightMetadata.rst
BugLifeCycle.rst
Bugpoint.rst Reland "[docs][Bugpoint]Add notes about multiple crashes" 2019-09-17 21:09:41 +00:00
BugpointRedesign.md [Bugpoint redesign] Fix nonlocal URI link in doc 2019-08-09 21:48:47 +00:00
BuildingADistribution.rst [cmake] Remove LLVM_{BUILD,LINK}_LLVM_DYLIB options on Windows 2019-11-08 10:37:16 -08:00
CFIVerify.rst
CMake.rst [cmake] Remove LLVM_{BUILD,LINK}_LLVM_DYLIB options on Windows 2019-11-08 10:37:16 -08:00
CMakeLists.txt
CMakePrimer.rst
CodeGenerator.rst [docs] Update Mips feature table in CodeGenerator.rst 2019-10-25 12:17:34 +03:00
CodeOfConduct.rst [Conduct] Refine what "rare cases" means wrt violations outside our spaces. 2016-07-06 19:32:41 +00:00
CodingStandards.rst Make coding standards document more inclusive 2019-11-21 13:37:17 +01:00
CommandLine.rst [CommandLine] Add callbacks to Options 2019-12-06 15:16:45 -08:00
CompileCudaWithLLVM.rst Adjust documentation for git migration. 2019-01-29 16:37:27 +00:00
CompilerWriterInfo.rst [docs] Update link to the MIPS 64-bit ELF object file specification 2019-10-24 15:56:30 +03:00
conf.py [Docs] Add a custom sidebar to doc pages 2019-09-20 22:16:39 +00:00
Contributing.rst Add discussion of git-format-patch to Phabricator.html 2019-12-03 18:54:46 -05:00
Coroutines.rst Extend coroutines to support a "returned continuation" lowering. 2019-08-14 03:53:17 +00:00
CoverageMappingFormat.rst Revert "[Coverage] Revise format to reduce binary size" 2019-12-04 10:35:14 -08:00
DebuggingJITedCode.rst [docs] Fix references to a renamed flag. 2019-11-06 14:42:57 -08:00
DeveloperPolicy.rst docs: Update instructions for requesting commit access 2019-10-24 20:42:02 -07:00
Docker.rst [build] Rename clang-headers to clang-resource-headers 2019-03-04 21:19:53 +00:00
doxygen-mainpage.dox
doxygen.cfg.in [NFC] Remove LLVM_ALIGNAS 2019-07-31 03:22:08 +00:00
ExceptionHandling.rst
ExtendedIntegerResults.txt
ExtendingLLVM.rst Note ImmArg in documentation for adding intrinsics 2019-03-14 13:46:17 +00:00
Extensions.rst Add IR support, ELF section and user documentation for partitioning feature. 2019-05-29 03:29:01 +00:00
FAQ.rst [docs] Tiny rewording in the portability FAQ entry 2019-11-20 16:40:30 -08:00
FaultMaps.rst
FuzzingLLVM.rst [globalisel] Restructure the GlobalISel documentation 2019-10-25 15:51:09 -07:00
GarbageCollection.rst
gcc-loops.png
GetElementPtr.rst [DOC] Fix load instructions' syntax, function definition. 2019-06-12 11:24:22 +00:00
GettingInvolved.rst [Docs] Moves Reference docs to new page 2019-09-25 00:49:02 +00:00
GettingStarted.rst [cmake] Remove LLVM_{BUILD,LINK}_LLVM_DYLIB options on Windows 2019-11-08 10:37:16 -08:00
GettingStartedTutorials.rst [Docs] Adds Documentation links to sidebar 2019-10-09 20:26:13 +00:00
GettingStartedVS.rst Retire VS2015 Support 2019-07-09 10:10:48 +00:00
GoldPlugin.rst
GwpAsan.rst [docs] Add GwpAsan to toctree. 2019-08-21 18:31:03 +00:00
HowToAddABuilder.rst wrap an rst file to 80 cols, to cycle bots 2019-12-06 17:28:02 -05:00
HowToBuildOnARM.rst
HowToBuildWithPGO.rst
HowToCrossCompileBuiltinsOnArm.rst
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst Remove some autoconf references from docs and comments 2019-07-03 09:57:59 +00:00
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst [docs] Prevent O0 optnone for opt input 2019-01-29 22:17:51 +00:00
HowToUseAttributes.rst
HowToUseInstrMappings.rst
InAlloca.rst
index.rst Make coding standards document more inclusive 2019-11-21 13:37:17 +01:00
LangRef.rst [Matrix] Add first set of matrix intrinsics and initial lowering pass. 2019-12-12 15:42:18 +00:00
Lexicon.rst
LibFuzzer.rst [libFuzzer] docs: update note to include REDUCE event. 2019-10-24 12:04:12 +02:00
LinkTimeOptimization.rst
linpack-pc.png
llvm-objdump.1
LLVMBuild.rst
LLVMBuild.txt
LoopTerminology.rst [docs] Fix sphinx doc generation errors 2019-08-14 22:18:01 +00:00
make.bat
Makefile.sphinx
MarkdownQuickstartTemplate.md
MarkedUpDisassembly.rst
MCJIT-creation.png
MCJIT-dyld-load.png
MCJIT-engine-builder.png
MCJIT-load-object.png
MCJIT-load.png
MCJIT-resolve-relocations.png
MCJITDesignAndImplementation.rst
MeetupGuidelines.rst Add guidelines/recommendations for organizers of LLVM Socials 2019-05-14 07:20:58 +00:00
MemorySSA.rst
MemTagSanitizer.rst Add MemTagSanitizer documentation. 2019-11-01 10:46:04 -07:00
MergeFunctions.rst
MIRLangRef.rst [globalisel][docs] Rework GMIR documentation and add an early GenericOpcode reference 2019-11-05 15:16:43 -08:00
NVPTXUsage.rst
OptBisect.rst [LegacyPassManager] Delete BasicBlockPass/Manager. 2019-10-30 11:40:16 -07:00
ORCv2.rst Fix a few spellos in docs. 2019-09-13 14:58:24 +00:00
Packaging.rst
Passes.rst
Phabricator.rst Add discussion of git-format-patch to Phabricator.html 2019-12-03 18:54:46 -05:00
ProgrammersManual.rst Fix typo in programmer's manual cantFile -> cantFail 2019-07-18 05:24:22 +00:00
Projects.rst
re_format.7
README.txt [NFC] Test commit, whitespace change 2019-06-06 22:07:14 +00:00
Reference.rst Add MemTagSanitizer documentation. 2019-11-01 10:46:04 -07:00
ReleaseNotes.rst [CommandLine] Add callbacks to Options 2019-12-06 15:16:45 -08:00
ReleaseProcess.rst [ReleaseProcess] Document requirement to set MACOSX_DEPLOYMENT_TARGET 2019-10-01 17:10:45 +00:00
Remarks.rst [Remarks] Remove references to ELF support 2019-10-28 12:50:46 -07:00
ReportingGuide.rst
ScudoHardenedAllocator.rst [docs] Scudo: document error messages & their potential cause 2019-01-22 16:43:45 +00:00
SegmentedStacks.rst
SourceLevelDebugging.rst Fix a few typos in SourceLevelDebugging.rst 2019-10-31 16:03:44 -07:00
speculative_load_hardening_microbenchmarks.png
SpeculativeLoadHardening.md Fix a few spellos in docs. 2019-09-13 14:58:24 +00:00
SphinxQuickstartTemplate.rst Docs: Updates Sphinx Quickstart template for new contributors 2019-11-10 09:27:32 -07:00
StackMaps.rst
StackSafetyAnalysis.rst
Statepoints.rst
SupportLibrary.rst
SystemLibrary.rst
TableGenFundamentals.rst
TestingGuide.rst [FileCheck] Make FILECHECK_OPTS useful for its test suite 2019-11-21 18:01:12 -05:00
TestSuiteGuide.md Adjust documentation for git migration. 2019-01-29 16:37:27 +00:00
TestSuiteMakefileGuide.rst Adjust documentation for git migration. 2019-01-29 16:37:27 +00:00
TransformMetadata.rst
TypeMetadata.rst Reland: Dead Virtual Function Elimination 2019-10-17 09:58:57 +00:00
UserGuides.rst [Docs] Moves Control Flow Document to User Guides 2019-10-13 20:05:22 +00:00
Vectorizers.rst [Docs] Improve SLP code snippet 2019-12-10 09:32:40 -05:00
WritingAnLLVMBackend.rst [clang][llvm] Obsolete Exynos M1 and M2 2019-10-30 15:02:59 -05:00
WritingAnLLVMPass.rst [LegacyPassManager] Delete BasicBlockPass/Manager. 2019-10-30 11:40:16 -07:00
XRay.rst
XRayExample.rst [XRay][docs] Fix option name 2019-03-12 13:44:42 +00:00
XRayFDRFormat.rst
yaml2obj.rst
YamlIO.rst

LLVM Documentation
==================

LLVM's documentation is written in reStructuredText, a lightweight
plaintext markup language (file extension `.rst`). While the
reStructuredText documentation should be quite readable in source form, it
is mostly meant to be processed by the Sphinx documentation generation
system to create HTML pages which are hosted on <http://llvm.org/docs/> and
updated after every commit. Manpage output is also supported, see below.

If you instead would like to generate and view the HTML locally, install
Sphinx <http://sphinx-doc.org/> and then do:

    cd <build-dir>
    cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true <src-dir>
    make -j3 docs-llvm-html
    $BROWSER <build-dir>/docs//html/index.html

The mapping between reStructuredText files and generated documentation is
`docs/Foo.rst` <-> `<build-dir>/docs//html/Foo.html` <-> `http://llvm.org/docs/Foo.html`.

If you are interested in writing new documentation, you will want to read
`SphinxQuickstartTemplate.rst` which will get you writing documentation
very fast and includes examples of the most important reStructuredText
markup syntax.

Manpage Output
===============

Building the manpages is similar to building the HTML documentation. The
primary difference is to use the `man` makefile target, instead of the
default (which is `html`). Sphinx then produces the man pages in the
directory `<build-dir>/docs/man/`.

    cd <build-dir>
    cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_MAN=true <src-dir>
    make -j3 docs-llvm-man
    man -l >build-dir>/docs/man/FileCheck.1

The correspondence between .rst files and man pages is
`docs/CommandGuide/Foo.rst` <-> `<build-dir>/docs//man/Foo.1`.
These .rst files are also included during HTML generation so they are also
viewable online (as noted above) at e.g.
`http://llvm.org/docs/CommandGuide/Foo.html`.

Checking links
==============

The reachability of external links in the documentation can be checked by
running:

    cd docs/
    make -f Makefile.sphinx linkcheck

Doxygen page Output
==============

Install doxygen <http://www.stack.nl/~dimitri/doxygen/download.html> and dot2tex <https://dot2tex.readthedocs.io/en/latest>.

    cd <build-dir>
    cmake -DLLVM_ENABLE_DOXYGEN=On <llvm-top-src-dir>
    make doxygen-llvm # for LLVM docs
    make doxygen-clang # for clang docs

It will generate html in

    <build-dir>/docs/doxygen/html # for LLVM docs
    <build-dir>/tools/clang/docs/doxygen/html # for clang docs