[PATCH] D129410: Update sanitize_* IR documentation.

[Mitch Phillips via Phabricator via llvm-commits]

hctim created this revision.
hctim added a reviewer: eugenis.
Herald added a subscriber: jdoerfert.
Herald added a project: All.
hctim requested review of this revision.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

sanitize_none was never actually committed, and should be removed.

no_sanitize_memtag is to be removed in D128950 <https://reviews.llvm.org/D128950>.

sanitize_memtag is new in D128950 <https://reviews.llvm.org/D128950>.

Also update the comments on other no_sanitize_* to indicate that they're
impacted by the sanitizer ignorelist and the global-disable attribute.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D129410

Files:
  llvm/docs/LangRef.rst


Index: llvm/docs/LangRef.rst
===================================================================
--- llvm/docs/LangRef.rst
+++ llvm/docs/LangRef.rst
@@ -746,8 +746,8 @@
                          <global | constant> <Type> [<InitializerConstant>]
                          [, section "name"] [, partition "name"]
                          [, comdat [($name)]] [, align <Alignment>]
-                         [, no_sanitize] [, no_sanitize_address]
-                         [, no_sanitize_hwaddress] [, sanitize_address_dyninit]
+                         [, no_sanitize_address] [, no_sanitize_hwaddress]
+                         [, sanitize_address_dyninit] [, sanitize_memtag]
                          (, !name !N)*
 
 For example, the following defines a global in a numbered address space
@@ -2323,19 +2323,31 @@
 Unlike :ref:`function attributes <fnattrs>`, attributes on a global variable
 are grouped into a single :ref:`attribute group <attrgrp>`.
 
-``no_sanitize``
-    This attribute indicates that the global variable should not have any
-    sanitizers applied to it, either because it was in the sanitizer ignore
-    list, or it was annotated with
-    `__attribute__((disable_sanitizer_instrumentation))`.
 ``no_sanitize_address``
     This attribute indicates that the global variable should not have
     AddressSanitizer instrumentation applied to it, because it was annotated
-    with `__attribute__((no_sanitize("address")))`.
+    with `__attribute__((no_sanitize("address")))`,
+    `__attribute__((disable_sanitizer_instrumentation))`, or included in the
+    `-fsanitize-ignorelist` file.
 ``no_sanitize_hwaddress``
     This attribute indicates that the global variable should not have
     HWAddressSanitizer instrumentation applied to it, because it was annotated
-    with `__attribute__((no_sanitize("hwaddress")))`.
+    with `__attribute__((no_sanitize("hwaddress")))`,
+    `__attribute__((disable_sanitizer_instrumentation))`, or included in the
+    `-fsanitize-ignorelist` file.
+``sanitize_memtag``
+    This attribute indicates that the global variable should have AArch64 memory
+    tags (MTE) instrumentation applied to it. This attribute causes the
+    suppression of certain optimisations, like GlobalMerge, as well as ensuring
+    extra directives are emitted in the assembly and extra bits of metadata are
+    placed in the object file so that the linker can ensure the accesses are
+    protected by MTE. This attribute is added by clang when
+    `-fsanitize=memtag-globals` is provided, as long as the attribute is not
+    marked with `__attribute__((no_sanitize("memtag")))`,
+    `__attribute__((disable_sanitizer_instrumentation))`, or included in the
+    `-fsanitize-ignorelist` file. The AArch64 Globals Tagging pass may remove
+    this attribute when it's not possible to be tagged (e.g. it's a TLS
+    variable).
 ``sanitize_address_dyninit``
     This attribute indicates that the global variable, when instrumented with
     AddressSanitizer, should be checked for ODR violations. This attribute is


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D129410.443391.patch
Type: text/x-patch
Size: 3065 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20220708/49995ebe/attachment.bin>