diff options
| author | Shivam Gupta <shivam98.tkg@gmail.com> | 2023-01-28 10:31:33 +0530 |
|---|---|---|
| committer | Shivam Gupta <shivam98.tkg@gmail.com> | 2023-01-28 10:31:33 +0530 |
| commit | 6cfebf39103e6f46dfb3ed50930b81cb674384e5 (patch) | |
| tree | 30d1ad1b7aa9b3bc58f6e7006c75f81d74da833e | |
| parent | c17ccced4b0ba2152a05e7a137c392dbd14181ad (diff) | |
| download | llvm-6cfebf39103e6f46dfb3ed50930b81cb674384e5.zip llvm-6cfebf39103e6f46dfb3ed50930b81cb674384e5.tar.gz llvm-6cfebf39103e6f46dfb3ed50930b81cb674384e5.tar.bz2 | |
[Docs] Fix a statement wrt instruction alignment of 0
| -rw-r--r-- | llvm/docs/LangRef.rst | 22 |
1 files changed, 10 insertions, 12 deletions
diff --git a/llvm/docs/LangRef.rst b/llvm/docs/LangRef.rst index badae01..061a4a8 100644 --- a/llvm/docs/LangRef.rst +++ b/llvm/docs/LangRef.rst @@ -10164,18 +10164,16 @@ alignment is not set to a value which is at least the size in bytes of the pointee. ``!nontemporal`` does not have any defined semantics for atomic loads. The optional constant ``align`` argument specifies the alignment of the -operation (that is, the alignment of the memory address). A value of 0 -or an omitted ``align`` argument means that the operation has the ABI -alignment for the target. It is the responsibility of the code emitter -to ensure that the alignment information is correct. Overestimating the -alignment results in undefined behavior. Underestimating the alignment -may produce less efficient code. An alignment of 1 is always safe. The -maximum possible alignment is ``1 << 32``. An alignment value higher -than the size of the loaded type implies memory up to the alignment -value bytes can be safely loaded without trapping in the default -address space. Access of the high bytes can interfere with debugging -tools, so should not be accessed if the function has the -``sanitize_thread`` or ``sanitize_address`` attributes. +operation (that is, the alignment of the memory address). An omitted ``align`` +argument means that the operation has the ABI alignment for the target. It is +the responsibility of the code emitter to ensure that the alignment information +is correct. Overestimating the alignment results in undefined behavior. +Underestimating the alignment may produce less efficient code. An alignment of 1 is +always safe. The maximum possible alignment is ``1 << 32``. An alignment value higher +than the size of the loaded type implies memory up to the alignment value bytes can +be safely loaded without trapping in the default address space. Access of the high +bytes can interfere with debugging tools, so should not be accessed if the function +has the ``sanitize_thread`` or ``sanitize_address`` attributes. The optional ``!nontemporal`` metadata must reference a single metadata name ``<nontemp_node>`` corresponding to a metadata node with one |