1
0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-25 20:23:11 +01:00
llvm-mirror/docs
Pablo Barrio e5fbe2c41d [ARM] Allow 64- and 128-bit types with 't' inline asm constraint
Summary:
In LLVM, 't' selects a floating-point/SIMD register and only supports
32-bit values. This is appropriately documented in the LLVM Language
Reference Manual. However, this behaviour diverges from that of GCC, where
't' selects the s0-s31 registers and its qX and dX variants depending on
additional operand modifiers (q/P).

For example, the following C code:

#include <arm_neon.h>
float32x4_t a, b, x;
asm("vadd.f32 %0, %1, %2" : "=t" (x) : "t" (a), "t" (b))

results in the following assembly if compiled with GCC:

vadd.f32 s0, s0, s1

whereas LLVM will show "error: couldn't allocate output register for
constraint 't'", since a, b, x are 128-bit variables, not 32-bit.

This patch extends the use of 't' to mean that of GCC, thus allowing
selection of the lower Q vector regs and their D/S variants. For example,
the earlier code will now compile as:

vadd.f32 q0, q0, q1

This behaviour still differs from that of GCC but I think it is actually
more correct, since LLVM picks up the right register type based on the
datatype of x, while GCC would need an extra operand modifier to achieve
the same result, as follows:

asm("vadd.f32 %q0, %q1, %q2" : "=t" (x) : "t" (a), "t" (b))

Since this is only an extension of functionality, existing code should not
be affected by this change. Note that operand modifiers q/P are already
supported by LLVM, so this patch should suffice to support inline
assembly with constraint 't' originally built for GCC.

Reviewers: grosbach, rengolin

Reviewed By: rengolin

Subscribers: rogfer01, efriedma, olista01, aemerson, javed.absar, eraman, kristof.beyls, llvm-commits

Differential Revision: https://reviews.llvm.org/D42962

llvm-svn: 325244
2018-02-15 14:44:22 +00:00
..
_ocamldoc
_static
_templates
_themes/llvm-theme
CommandGuide Re-land [dsymutil] Upstream update feature 2018-02-08 10:48:54 +00:00
Frontend
HistoricalNotes
PDB Update MSF File Documentation. 2018-01-12 21:42:39 +00:00
Proposals remove unreferenced footnotes 2018-01-05 00:24:55 +00:00
TableGen Improvements to TableGen/LangIntro.rst 2017-05-02 13:47:10 +00:00
tutorial [docs] Add out-of-date warnings to the BuildingAJIT tutorial text. 2018-02-06 21:25:20 +00:00
AdvancedBuilds.rst [NFC] Remove apostrophe to use 'it' in the possessive form. 2018-01-26 18:43:57 +00:00
AliasAnalysis.rst [docs] AliasAnalysis: clarify that PartialAlias doesn't enforce 2017-07-15 09:09:24 +00:00
AMDGPUUsage.rst [AMDGPU] Change constant addr space to 4 2018-02-13 18:00:25 +00:00
ARM-BE-bitcastfail.png
ARM-BE-bitcastsuccess.png
ARM-BE-ld1.png
ARM-BE-ldr.png
Atomics.rst
Benchmarking.rst Add some tips on benchmarking. 2017-05-24 16:39:12 +00:00
BigEndianNEON.rst
BitCodeFormat.rst [NFC] fix trivial typos in documents 2018-01-16 13:19:48 +00:00
BlockFrequencyTerminology.rst
BranchWeightMetadata.rst [Doc] Document prof metadata in LangRef 2017-06-15 15:57:12 +00:00
Bugpoint.rst [docs] Mention opt -metarenamer in the bugpoint docs 2017-11-15 18:05:19 +00:00
CFIVerify.rst Introduce the llvm-cfi-verify tool (resubmission of D37937). 2017-09-20 20:38:14 +00:00
CMake.rst Fix up and document controlling ccache via CMake options. 2018-01-24 18:15:08 +00:00
CMakeLists.txt [dsymutil][doc] Improve wording in manpage and rename file. 2017-11-02 18:44:54 +00:00
CMakePrimer.rst [docs] In the CMake primer, correct the description of the ARGV/ARGN variables. 2017-08-24 05:38:39 +00:00
CodeGenerator.rst [MC] Fix -stack-size-section on ARM 2018-01-17 09:01:29 +00:00
CodeOfConduct.rst
CodingStandards.rst Coding Standards: Document library layering requirements & header isolation. 2018-02-01 21:03:35 +00:00
CommandLine.rst Remove references to response file argument in CommandLine.rst 2017-09-20 22:41:34 +00:00
CompileCudaWithLLVM.rst
CompilerWriterInfo.rst Fix broken links to the Itanium CXX ABI 2017-09-12 00:19:11 +00:00
conf.py The trunk version is now 7.0.0svn 2018-01-03 14:52:54 +00:00
Contributing.rst [Docs] Add Contributing page. 2018-01-04 17:12:21 +00:00
Coroutines.rst fix trivial typos in documents; NFC 2017-07-02 12:44:27 +00:00
CoverageMappingFormat.rst [Coverage] Use gap regions to select better line exec counts 2017-09-18 23:37:28 +00:00
DebuggingJITedCode.rst
DeveloperPolicy.rst Fixed broken links in docs. 2017-09-22 21:10:37 +00:00
Docker.rst Made a script to build docker images easier to use. 2017-07-06 12:46:51 +00:00
doxygen-mainpage.dox
doxygen.cfg.in [NFC] fix trivial typos in comments and documents 2018-01-26 08:15:29 +00:00
ExceptionHandling.rst [Doc] Guideline on adding exception handling support for a target 2018-01-24 09:53:01 +00:00
ExtendedIntegerResults.txt
ExtendingLLVM.rst
Extensions.rst docs: wordsmith some of the linker option extension 2018-01-31 00:16:23 +00:00
FAQ.rst
FaultMaps.rst Fix the docs build 2017-02-07 20:36:03 +00:00
FuzzingLLVM.rst [llvm-opt-fuzzer] Introduce llvm-opt-fuzzer for fuzzing optimization passes 2017-11-10 12:19:08 +00:00
GarbageCollection.rst
gcc-loops.png
GetElementPtr.rst [docs] Update code block for compatibility with Sphinx 1.5.1 2017-11-06 11:47:24 +00:00
GettingStarted.rst [NFC] fix trivial typos in comments and documents 2018-01-29 05:17:03 +00:00
GettingStartedVS.rst [MC] Fix regression tests on Windows when git “core.autocrlf” is set to true. 2017-11-17 21:59:43 +00:00
GlobalISel.rst [globalisel] Add very brief docs summarizing the ISel part of the LLVMDev tutorial. 2017-10-23 17:18:44 +00:00
GoldPlugin.rst [docs] As of binutils 2.21.51.0.2, ld.bfd supports plugins too, represent this in docs 2017-06-23 13:54:10 +00:00
HowToAddABuilder.rst Added more info on silent master to the doc. 2017-07-05 20:45:44 +00:00
HowToBuildOnARM.rst
HowToCrossCompileBuiltinsOnArm.rst [docs][ARM] Add HowTo for cross compiling and testing compiler-rt builtins 2017-11-07 09:40:05 +00:00
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst docs: Fix formatting in HowToReleaseLLVM 2017-09-19 03:27:26 +00:00
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst [docs] Fix mention of GCC frontend 2018-01-15 17:11:22 +00:00
HowToUseAttributes.rst Fix RST docs AttributeList heading underline 2017-03-21 17:05:00 +00:00
HowToUseInstrMappings.rst
InAlloca.rst
index.rst [Docs] Add Contributing page. 2018-01-04 17:12:21 +00:00
LangRef.rst [ARM] Allow 64- and 128-bit types with 't' inline asm constraint 2018-02-15 14:44:22 +00:00
Lexicon.rst [Lexicon] Add "GEP" 2017-08-18 15:35:53 +00:00
LibFuzzer.rst [libFuzzer] add a flag -malloc_limit_mb 2017-12-01 22:12:04 +00:00
LinkTimeOptimization.rst
linpack-pc.png
LLVMBuild.rst Fix LLVMBuild.txt typo. NFC 2017-04-03 18:21:50 +00:00
LLVMBuild.txt
make.bat
Makefile.sphinx
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
MemorySSA.rst [NFC] fix trivial typos in comments and documents 2018-01-26 08:15:29 +00:00
MergeFunctions.rst
MIRLangRef.rst [MIR] Update MIRLangRef with documentation on bundled instructions 2018-01-10 17:53:16 +00:00
NVPTXUsage.rst [CodeGen] Unify MBB reference format in both MIR and debug output 2017-12-04 17:18:51 +00:00
OptBisect.rst Remove opt-bisect support for "cases" in favor of debug counters 2017-03-11 01:41:03 +00:00
Packaging.rst
Passes.rst Another try to commit 323321 (aggressive instruction combine). 2018-01-25 12:06:32 +00:00
Phabricator.rst [docs] Tweak update to Phabricator docs about setting repository for diffs uploaded via web 2018-01-12 15:44:35 +00:00
ProgrammersManual.rst [docs] Use dbgs() instead of errs() for DEBUG() 2017-12-25 14:16:07 +00:00
Projects.rst
re_format.7
README.txt Remove test commit change. 2017-06-24 20:13:32 +00:00
ReleaseNotes.rst Add release note on change to memcpy/memmove/memset builtin signatures 2018-02-05 19:39:38 +00:00
ReleaseProcess.rst [docs] Make ReleaseProcess.rst 80 column. NFCI 2018-01-18 14:57:55 +00:00
ReportingGuide.rst
ScudoHardenedAllocator.rst [docs] Update Scudo documentation 2018-01-04 18:31:22 +00:00
SegmentedStacks.rst
SourceLevelDebugging.rst [docs] Update code block for compatibility with Sphinx 1.5.1 2017-11-06 11:47:24 +00:00
SphinxQuickstartTemplate.rst
StackMaps.rst [StackMaps] Increase the size of the "location size" field 2017-04-28 04:48:42 +00:00
Statepoints.rst [docs] change a few code-blocks to llvm from text 2017-07-26 14:11:23 +00:00
SystemLibrary.rst
TableGenFundamentals.rst
TestingGuide.rst Revert "lit.py: Add new %{shared_output(LABEL)} substitution" 2017-10-14 04:01:27 +00:00
TestSuiteMakefileGuide.rst
TypeMetadata.rst Fixed broken links in docs. 2017-09-22 21:10:37 +00:00
Vectorizers.rst docs: Remove reference to a deprecated flag 2018-01-23 20:22:37 +00:00
WritingAnLLVMBackend.rst [Docs] Fix typo in scheduler model documentation. enumemation->enumeration 2017-12-10 09:14:35 +00:00
WritingAnLLVMPass.rst Fixed dead links in WritingAnLLVMPass.rst 2017-11-06 09:51:39 +00:00
XRay.rst [XRay][compiler-rt] Reduce XRay log spam 2017-12-13 06:37:13 +00:00
XRayExample.rst [XRay][compiler-rt] Reduce XRay log spam 2017-12-13 06:37:13 +00:00
XRayFDRFormat.rst [XRay][tools] Support tail-call exits before we write them in the runtime 2017-09-18 06:08:46 +00:00
yaml2obj.rst
YamlIO.rst [YAML] Add support for non-printable characters 2017-12-18 17:38:03 +00:00

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