[llvm] [LangRef] Spell out alias attribute/metadata violations are UB. (PR #116220)
Nuno Lopes via llvm-commits
llvm-commits at lists.llvm.org
Thu Nov 14 05:51:10 PST 2024
https://github.com/nunoplopes updated https://github.com/llvm/llvm-project/pull/116220
>From a7bd2d6b299cd46f087242d265d354ed8136ed0f Mon Sep 17 00:00:00 2001
From: Florian Hahn <flo at fhahn.com>
Date: Thu, 14 Nov 2024 12:25:08 +0000
Subject: [PATCH 1/2] [LangRef] Spell out alias attribute/metadata violations
are UB.
Update the documentation for the noalias attribute, !alias.scope and
!loop.parallel_accesses metadata to clarify they are UB on voilation the
noalias property.
---
llvm/docs/LangRef.rst | 23 +++++++++++++----------
1 file changed, 13 insertions(+), 10 deletions(-)
diff --git a/llvm/docs/LangRef.rst b/llvm/docs/LangRef.rst
index 6fb66ce231e8ab..6183f0f404f446 100644
--- a/llvm/docs/LangRef.rst
+++ b/llvm/docs/LangRef.rst
@@ -1358,13 +1358,15 @@ Currently, only the following parameter attributes are defined:
This indicates that memory locations accessed via pointer values
:ref:`based <pointeraliasing>` on the argument or return value are not also
accessed, during the execution of the function, via pointer values not
- *based* on the argument or return value. This guarantee only holds for
+ *based* on the argument or return value.This guarantee only holds for
memory locations that are *modified*, by any means, during the execution of
- the function. The attribute on a return value also has additional semantics
- described below. The caller shares the responsibility with the callee for
- ensuring that these requirements are met. For further details, please see
- the discussion of the NoAlias response in :ref:`alias analysis <Must, May,
- or No>`.
+ the function. If there are other accesses not based on the argument or
+ return value, the behavior is undefined. The attribute on a return value
+ also has additional semantics described below. The caller shares the
+ responsibility with the callee for described below. The caller shares the
+ responsibility with the callee for ensuring that these requirements are met.
+ For further details, please see the discussion of the NoAlias response in
+ :ref:`alias analysis <Must, May, or No>`.
Note that this definition of ``noalias`` is intentionally similar
to the definition of ``restrict`` in C99 for function arguments.
@@ -6936,9 +6938,9 @@ does not carry useful data and need not be preserved.
noalias memory-access sets. This means that some collection of memory access
instructions (loads, stores, memory-accessing calls, etc.) that carry
``noalias`` metadata can specifically be specified not to alias with some other
-collection of memory access instructions that carry ``alias.scope`` metadata.
-Each type of metadata specifies a list of scopes where each scope has an id and
-a domain.
+collection of memory access instructions that carry ``alias.scope`` metadata. If
+accesses from different collections alias, the behaivor is undefined. Each type
+of metadata specifies a list of scopes where each scope has an id and a domain.
When evaluating an aliasing query, if for some domain, the set
of scopes with that domain in one instruction's ``alias.scope`` list is a
@@ -7695,7 +7697,8 @@ If all memory-accessing instructions in a loop have
``llvm.access.group`` metadata that each refer to one of the access
groups of a loop's ``llvm.loop.parallel_accesses`` metadata, then the
loop has no loop carried memory dependencies and is considered to be a
-parallel loop.
+parallel loop. If there is a loop-carried dependency, the behavior is
+undefined.
Note that if not all memory access instructions belong to an access
group referred to by ``llvm.loop.parallel_accesses``, then the loop must
>From 736d9abe82790a2f0bfdb352550971fde2fda329 Mon Sep 17 00:00:00 2001
From: Nuno Lopes <nuno.lopes at tecnico.ulisboa.pt>
Date: Thu, 14 Nov 2024 13:51:01 +0000
Subject: [PATCH 2/2] WS
---
llvm/docs/LangRef.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/llvm/docs/LangRef.rst b/llvm/docs/LangRef.rst
index 6183f0f404f446..2a5dc820d347e3 100644
--- a/llvm/docs/LangRef.rst
+++ b/llvm/docs/LangRef.rst
@@ -1358,7 +1358,7 @@ Currently, only the following parameter attributes are defined:
This indicates that memory locations accessed via pointer values
:ref:`based <pointeraliasing>` on the argument or return value are not also
accessed, during the execution of the function, via pointer values not
- *based* on the argument or return value.This guarantee only holds for
+ *based* on the argument or return value. This guarantee only holds for
memory locations that are *modified*, by any means, during the execution of
the function. If there are other accesses not based on the argument or
return value, the behavior is undefined. The attribute on a return value
More information about the llvm-commits
mailing list