mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-26 04:32:44 +01:00
b835b9cf36
We really ought to support no_sanitize("coverage") in line with other
sanitizers. This came up again in discussions on the Linux-kernel
mailing lists, because we currently do workarounds using objtool to
remove coverage instrumentation. Since that support is only on x86, to
continue support coverage instrumentation on other architectures, we
must support selectively disabling coverage instrumentation via function
attributes.
Unfortunately, for SanitizeCoverage, it has not been implemented as a
sanitizer via fsanitize= and associated options in Sanitizers.def, but
rolls its own option fsanitize-coverage. This meant that we never got
"automatic" no_sanitize attribute support.
Implement no_sanitize attribute support by special-casing the string
"coverage" in the NoSanitizeAttr implementation. To keep the feature as
unintrusive to existing IR generation as possible, define a new negative
function attribute NoSanitizeCoverage to propagate the information
through to the instrumentation pass.
Fixes: https://bugs.llvm.org/show_bug.cgi?id=49035
Reviewed By: vitalybuka, morehouse
Differential Revision: https://reviews.llvm.org/D102772
|
||
|---|---|---|
| .. | ||
| _ocamldoc | ||
| _static | ||
| _templates | ||
| _themes/llvm-theme | ||
| AMDGPU | ||
| CommandGuide | ||
| DependenceGraphs | ||
| Frontend | ||
| GlobalISel | ||
| HistoricalNotes | ||
| PDB | ||
| Proposals | ||
| TableGen | ||
| tutorial | ||
| AddingConstrainedIntrinsics.rst | ||
| AdvancedBuilds.rst | ||
| AliasAnalysis.rst | ||
| AMDGPUDwarfExtensionsForHeterogeneousDebugging.rst | ||
| AMDGPUInstructionNotation.rst | ||
| AMDGPUInstructionSyntax.rst | ||
| AMDGPUModifierSyntax.rst | ||
| AMDGPUOperandSyntax.rst | ||
| AMDGPUUsage.rst | ||
| ARM-BE-bitcastfail.png | ||
| ARM-BE-bitcastsuccess.png | ||
| ARM-BE-ld1.png | ||
| ARM-BE-ldr.png | ||
| Atomics.rst | ||
| Benchmarking.rst | ||
| BigEndianNEON.rst | ||
| BitCodeFormat.rst | ||
| BlockFrequencyTerminology.rst | ||
| BranchWeightMetadata.rst | ||
| BugLifeCycle.rst | ||
| Bugpoint.rst | ||
| BugpointRedesign.md | ||
| buildbot_worker_contact.png | ||
| BuildingADistribution.rst | ||
| CFIVerify.rst | ||
| CMake.rst | ||
| CMakeLists.txt | ||
| CMakePrimer.rst | ||
| CodeGenerator.rst | ||
| CodeOfConduct.rst | ||
| CodeReview.rst | ||
| CodingStandards.rst | ||
| CommandLine.rst | ||
| CompileCudaWithLLVM.rst | ||
| CompilerWriterInfo.rst | ||
| conf.py | ||
| Contributing.rst | ||
| Coroutines.rst | ||
| CoverageMappingFormat.rst | ||
| DebuggingJITedCode.rst | ||
| DeveloperPolicy.rst | ||
| Docker.rst | ||
| doxygen-mainpage.dox | ||
| doxygen.cfg.in | ||
| epilogue-vectorization-cfg.png | ||
| ExceptionHandling.rst | ||
| ExtendedIntegerResults.txt | ||
| ExtendingLLVM.rst | ||
| Extensions.rst | ||
| FAQ.rst | ||
| FaultMaps.rst | ||
| FuzzingLLVM.rst | ||
| GarbageCollection.rst | ||
| gcc-loops.png | ||
| GetElementPtr.rst | ||
| GettingInvolved.rst | ||
| GettingStarted.rst | ||
| GettingStartedTutorials.rst | ||
| GettingStartedVS.rst | ||
| GitBisecting.rst | ||
| GoldPlugin.rst | ||
| GwpAsan.rst | ||
| HowToAddABuilder.rst | ||
| HowToBuildOnARM.rst | ||
| HowToBuildWindowsItaniumPrograms.rst | ||
| HowToBuildWithPGO.rst | ||
| HowToCrossCompileBuiltinsOnArm.rst | ||
| HowToCrossCompileLLVM.rst | ||
| HowToReleaseLLVM.rst | ||
| HowToSetUpLLVMStyleRTTI.rst | ||
| HowToSubmitABug.rst | ||
| HowToUpdateDebugInfo.rst | ||
| HowToUseAttributes.rst | ||
| HowToUseInstrMappings.rst | ||
| InAlloca.rst | ||
| index.rst | ||
| JITLink.rst | ||
| LangRef.rst | ||
| Lexicon.rst | ||
| LibFuzzer.rst | ||
| LinkTimeOptimization.rst | ||
| linpack-pc.png | ||
| llvm-objdump.1 | ||
| loop-guard.svg | ||
| loop-irreducible.svg | ||
| loop-merge.svg | ||
| loop-nested.svg | ||
| loop-nonmaximal.svg | ||
| loop-separate.svg | ||
| loop-single.svg | ||
| loop-terminology-guarded-loop.png | ||
| loop-terminology-initial-loop.png | ||
| loop-terminology-rotated-loop.png | ||
| loop-terminology.svg | ||
| LoopTerminology.rst | ||
| 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 | ||
| MemorySSA.rst | ||
| MemTagSanitizer.rst | ||
| MergeFunctions.rst | ||
| MIRLangRef.rst | ||
| NewPassManager.rst | ||
| NVPTXUsage.rst | ||
| OpaquePointers.rst | ||
| OptBisect.rst | ||
| ORCv2.rst | ||
| Packaging.rst | ||
| Passes.rst | ||
| Phabricator_premerge_results.png | ||
| Phabricator_premerge_unit_tests.png | ||
| Phabricator.rst | ||
| ProgrammersManual.rst | ||
| Projects.rst | ||
| re_format.7 | ||
| README.txt | ||
| Reference.rst | ||
| ReleaseNotes.rst | ||
| ReleaseProcess.rst | ||
| Remarks.rst | ||
| ReportingGuide.rst | ||
| ScudoHardenedAllocator.rst | ||
| Security.rst | ||
| SegmentedStacks.rst | ||
| SourceLevelDebugging.rst | ||
| speculative_load_hardening_microbenchmarks.png | ||
| SpeculativeLoadHardening.md | ||
| SphinxQuickstartTemplate.rst | ||
| StackMaps.rst | ||
| StackSafetyAnalysis.rst | ||
| Statepoints.rst | ||
| SupportLibrary.rst | ||
| SupportPolicy.rst | ||
| SystemLibrary.rst | ||
| TableGenFundamentals.rst | ||
| TestingGuide.rst | ||
| TestSuiteGuide.md | ||
| TestSuiteMakefileGuide.rst | ||
| TransformMetadata.rst | ||
| TypeMetadata.rst | ||
| UserGuides.rst | ||
| Vectorizers.rst | ||
| WritingAnLLVMBackend.rst | ||
| WritingAnLLVMNewPMPass.rst | ||
| WritingAnLLVMPass.rst | ||
| XRay.rst | ||
| XRayExample.rst | ||
| 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 <https://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` <-> `https://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.
`https://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