summaryrefslogtreecommitdiffstats
path: root/clang/docs/SanitizerCoverage.rst
diff options
context:
space:
mode:
authorMax Moroz <mmoroz@chromium.org>2019-02-01 17:12:35 +0000
committerMax Moroz <mmoroz@chromium.org>2019-02-01 17:12:35 +0000
commit123883807dfe583d85c4493d58f39275cc1ab6ba (patch)
tree7ea0297e2b5fb3f299b3d775e892d3cc88b8f958 /clang/docs/SanitizerCoverage.rst
parent58513b7761a92da26be08daa77329c5bc5b1a675 (diff)
downloadbcm5719-llvm-123883807dfe583d85c4493d58f39275cc1ab6ba.tar.gz
bcm5719-llvm-123883807dfe583d85c4493d58f39275cc1ab6ba.zip
Update SanitizerCoverage doc regarding the issue with pc-table and gc-sections.
Summary: There is a bug for this: https://bugs.llvm.org/show_bug.cgi?id=34636 But it would be also helpful to leave a note in the docs to prevent users from running into issues, e.g. https://crbug.com/926588. Reviewers: morehouse Reviewed By: morehouse Subscribers: cfe-commits, llvm-commits, kcc Tags: #clang Differential Revision: https://reviews.llvm.org/D57474 llvm-svn: 352890
Diffstat (limited to 'clang/docs/SanitizerCoverage.rst')
-rw-r--r--clang/docs/SanitizerCoverage.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/clang/docs/SanitizerCoverage.rst b/clang/docs/SanitizerCoverage.rst
index c5c50a5dd96..c7cd853dd66 100644
--- a/clang/docs/SanitizerCoverage.rst
+++ b/clang/docs/SanitizerCoverage.rst
@@ -144,6 +144,11 @@ PC-Table
**Experimental, may change or disappear in future**
+**Note:** this instrumentation might be incompatible with dead code stripping
+(``-Wl,-gc-sections``) for linkers other than LLD, thus resulting in a
+significant binary size overhead. For more information, see
+`Bug 34636 <https://bugs.llvm.org/show_bug.cgi?id=34636>`_.
+
With ``-fsanitize-coverage=pc-table`` the compiler will create a table of
instrumented PCs. Requires either ``-fsanitize-coverage=inline-8bit-counters`` or
``-fsanitize-coverage=trace-pc-guard``.
OpenPOWER on IntegriCloud