[PATCH] D57600: update docs of memcpy/memmove/memset re: alignment and len=0
Kristina Brooks via Phabricator via llvm-commits
llvm-commits at lists.llvm.org
Tue Feb 26 10:52:49 PST 2019
This revision was automatically updated to reflect the committed changes.
Closed by commit rL354911: Update docs of memcpy/move/set wrt. align and len (authored by kristina, committed by ).
Changed prior to commit:
https://reviews.llvm.org/D57600?vs=188333&id=188419#toc
Repository:
rL LLVM
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D57600/new/
https://reviews.llvm.org/D57600
Files:
llvm/trunk/docs/LangRef.rst
Index: llvm/trunk/docs/LangRef.rst
===================================================================
--- llvm/trunk/docs/LangRef.rst
+++ llvm/trunk/docs/LangRef.rst
@@ -1071,10 +1071,11 @@
``align <n>``
This indicates that the pointer value may be assumed by the optimizer to
- have the specified alignment.
+ have the specified alignment. If the pointer value does not have the
+ specified alignment, behavior is undefined.
Note that this attribute has additional semantics when combined with the
- ``byval`` attribute.
+ ``byval`` attribute, which are documented there.
.. _noalias:
@@ -11325,8 +11326,11 @@
The '``llvm.memcpy.*``' intrinsics copy a block of memory from the
source location to the destination location, which are not allowed to
overlap. It copies "len" bytes of memory over. If the argument is known
-to be aligned to some boundary, this can be specified as the fourth
-argument, otherwise it should be set to 0 or 1 (both meaning no alignment).
+to be aligned to some boundary, this can be specified as an attribute on
+the argument.
+
+If "len" is 0, the pointers may be NULL or dangling. However, they must still
+be appropriately aligned.
.. _int_memmove:
@@ -11380,8 +11384,11 @@
The '``llvm.memmove.*``' intrinsics copy a block of memory from the
source location to the destination location, which may overlap. It
copies "len" bytes of memory over. If the argument is known to be
-aligned to some boundary, this can be specified as the fourth argument,
-otherwise it should be set to 0 or 1 (both meaning no alignment).
+aligned to some boundary, this can be specified as an attribute on
+the argument.
+
+If "len" is 0, the pointers may be NULL or dangling. However, they must still
+be appropriately aligned.
.. _int_memset:
@@ -11431,7 +11438,12 @@
""""""""""
The '``llvm.memset.*``' intrinsics fill "len" bytes of memory starting
-at the destination location.
+at the destination location. If the argument is known to be
+aligned to some boundary, this can be specified as an attribute on
+the argument.
+
+If "len" is 0, the pointers may be NULL or dangling. However, they must still
+be appropriately aligned.
'``llvm.sqrt.*``' Intrinsic
^^^^^^^^^^^^^^^^^^^^^^^^^^^
-------------- next part --------------
A non-text attachment was scrubbed...
Name: D57600.188419.patch
Type: text/x-patch
Size: 2259 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20190226/f555aa44/attachment.bin>
More information about the llvm-commits
mailing list