This is an archive of the discontinued LLVM Phabricator instance.

Differential D48390

ASan docs: no_sanitize("address") works on globals.
ClosedPublic

Authored by eugenis on Jun 20 2018, 12:54 PM.

Details

Reviewers
alekseyshl
Commits
rG2b61d12f1ea5: ASan docs: no_sanitize("address") works on globals.
rL335193: ASan docs: no_sanitize("address") works on globals.
rC335193: ASan docs: no_sanitize("address") works on globals.
Summary

Mention that no_sanitize attribute can be used with globals.

Diff Detail

Event Timeline

eugenis created this revision.Jun 20 2018, 12:54 PM
Harbormaster completed remote builds in B19524: Diff 152136.Jun 20 2018, 12:54 PM
aaron.ballman added a subscriber: aaron.ballman.Jun 20 2018, 12:56 PM

Do you also want to update AttrDocs.td with some similar information?

eugenis updated this revision to Diff 152140.Jun 20 2018, 1:09 PM

update AttrDocs.td

Harbormaster completed remote builds in B19526: Diff 152140.Jun 20 2018, 1:09 PM
eugenis added a comment.Jun 20 2018, 1:09 PM
In D48390#1138193, @aaron.ballman wrote:

Do you also want to update AttrDocs.td with some similar information?

Done.

alekseyshl accepted this revision.Jun 20 2018, 5:19 PM
This revision is now accepted and ready to land.Jun 20 2018, 5:19 PM
Closed by commit rC335193: ASan docs: no_sanitize("address") works on globals. (authored by eugenis). · Explain WhyJun 20 2018, 5:21 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents

PathSize
clang/
docs/
14 lines

Diff 152136

clang/docs/AddressSanitizer.rst

Show First 20 Lines • Show All 191 Lines • ▼ Show 20 Lines.. code-block:: c
# if __has_feature(address_sanitizer) # if __has_feature(address_sanitizer)
// code that builds only under AddressSanitizer // code that builds only under AddressSanitizer
# endif # endif
#endif #endif
Disabling Instrumentation with ``__attribute__((no_sanitize("address")))`` Disabling Instrumentation with ``__attribute__((no_sanitize("address")))``
-------------------------------------------------------------------------- --------------------------------------------------------------------------
Some code should not be instrumented by AddressSanitizer. One may use the Some code should not be instrumented by AddressSanitizer. One may use
function attribute ``__attribute__((no_sanitize("address")))`` (which has the attribute ``__attribute__((no_sanitize("address")))`` (which has
deprecated synonyms `no_sanitize_address` and `no_address_safety_analysis`) to deprecated synonyms `no_sanitize_address` and
disable instrumentation of a particular function. This attribute may not be `no_address_safety_analysis`) to disable instrumentation of a
supported by other compilers, so we suggest to use it together with particular function. This attribute may not be supported by other
compilers, so we suggest to use it together with
``__has_feature(address_sanitizer)``. ``__has_feature(address_sanitizer)``.
The same attribute used on a global variable prevents AddressSanitizer
from adding redzones around it and detecting out of bounds accesses.
Suppressing Errors in Recompiled Code (Blacklist) Suppressing Errors in Recompiled Code (Blacklist)
------------------------------------------------- -------------------------------------------------
AddressSanitizer supports ``src`` and ``fun`` entity types in AddressSanitizer supports ``src`` and ``fun`` entity types in
:doc:`SanitizerSpecialCaseList`, that can be used to suppress error reports :doc:`SanitizerSpecialCaseList`, that can be used to suppress error reports
in the specified source files or functions. Additionally, AddressSanitizer in the specified source files or functions. Additionally, AddressSanitizer
introduces ``global`` and ``type`` entity types that can be used to introduces ``global`` and ``type`` entity types that can be used to
suppress error reports for out-of-bound access to globals with certain suppress error reports for out-of-bound access to globals with certain
▲ Show 20 Lines • Show All 75 Lines • Show Last 20 Lines