This is an archive of the discontinued LLVM Phabricator instance.

Differential D12847

Nit cleanup in LangRef about dereferenceable metadata
ClosedPublic

Authored by apilipenko on Sep 14 2015, 9:51 AM.

Details

Reviewers
None
Commits
rG253d71efeb62: Nit cleanup in LangRef about dereferenceable metadata
rL247982: Nit cleanup in LangRef about dereferenceable metadata

Diff Detail

Repository
rL LLVM

Event Timeline

apilipenko updated this revision to Diff 34692.Sep 14 2015, 9:51 AM
apilipenko retitled this revision from to Nit cleanup in LangRef about dereferenceable metadata.
apilipenko updated this object.
apilipenko added a subscriber: llvm-commits.
vsk added a subscriber: vsk.Sep 16 2015, 11:13 PM

LGTM, thanks.

Closed by commit rL247982: Nit cleanup in LangRef about dereferenceable metadata (authored by apilipenko). · Explain WhySep 18 2015, 5:08 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents

PathSize
llvm/
trunk/
docs/
11 lines

Diff 35073

llvm/trunk/docs/LangRef.rst

  • This file is larger than 256 KB, so syntax highlighting is disabled by default.
Show First 20 Lines • Show All 6,806 Lines • ▼ Show 20 Lines
'``load``' Instruction '``load``' Instruction
^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^
Syntax: Syntax:
""""""" """""""
:: ::
<result> = load [volatile] <ty>, <ty>* <pointer>[, align <alignment>][, !nontemporal !<index>][, !invariant.load !<index>][, !invariant.group !<index>][, !nonnull !<index>][, !dereferenceable !<index>][, !dereferenceable_or_null !<index>] <result> = load [volatile] <ty>, <ty>* <pointer>[, align <alignment>][, !nontemporal !<index>][, !invariant.load !<index>][, !invariant.group !<index>][, !nonnull !<index>][, !dereferenceable !<deref_bytes_node>][, !dereferenceable_or_null !<deref_bytes_node>]
<result> = load atomic [volatile] <ty>* <pointer> [singlethread] <ordering>, align <alignment> [, !invariant.group !<index>] <result> = load atomic [volatile] <ty>* <pointer> [singlethread] <ordering>, align <alignment> [, !invariant.group !<index>]
!<index> = !{ i32 1 } !<index> = !{ i32 1 }
!<deref_bytes_node> = !{i64 <dereferenceable_bytes>}
Overview: Overview:
""""""""" """""""""
The '``load``' instruction is used to read from memory. The '``load``' instruction is used to read from memory.
Arguments: Arguments:
"""""""""" """"""""""
▲ Show 20 Lines • Show All 49 Lines • ▼ Show 20 Lines
The optional ``!nonnull`` metadata must reference a single The optional ``!nonnull`` metadata must reference a single
metadata name ``<index>`` corresponding to a metadata node with no metadata name ``<index>`` corresponding to a metadata node with no
entries. The existence of the ``!nonnull`` metadata on the entries. The existence of the ``!nonnull`` metadata on the
instruction tells the optimizer that the value loaded is known to instruction tells the optimizer that the value loaded is known to
never be null. This is analogous to the ``nonnull`` attribute never be null. This is analogous to the ``nonnull`` attribute
on parameters and return values. This metadata can only be applied on parameters and return values. This metadata can only be applied
to loads of a pointer type. to loads of a pointer type.
The optional ``!dereferenceable`` metadata must reference a single The optional ``!dereferenceable`` metadata must reference a single metadata
metadata name ``<index>`` corresponding to a metadata node with one ``i64`` name ``<deref_bytes_node>`` corresponding to a metadata node with one ``i64``
entry. The existence of the ``!dereferenceable`` metadata on the instruction entry. The existence of the ``!dereferenceable`` metadata on the instruction
tells the optimizer that the value loaded is known to be dereferenceable. tells the optimizer that the value loaded is known to be dereferenceable.
The number of bytes known to be dereferenceable is specified by the integer The number of bytes known to be dereferenceable is specified by the integer
value in the metadata node. This is analogous to the ''dereferenceable'' value in the metadata node. This is analogous to the ''dereferenceable''
attribute on parameters and return values. This metadata can only be applied attribute on parameters and return values. This metadata can only be applied
to loads of a pointer type. to loads of a pointer type.
The optional ``!dereferenceable_or_null`` metadata must reference a single The optional ``!dereferenceable_or_null`` metadata must reference a single
metadata name ``<index>`` corresponding to a metadata node with one ``i64`` metadata name ``<deref_bytes_node>`` corresponding to a metadata node with one
entry. The existence of the ``!dereferenceable_or_null`` metadata on the ``i64`` entry. The existence of the ``!dereferenceable_or_null`` metadata on the
instruction tells the optimizer that the value loaded is known to be either instruction tells the optimizer that the value loaded is known to be either
dereferenceable or null. dereferenceable or null.
The number of bytes known to be dereferenceable is specified by the integer The number of bytes known to be dereferenceable is specified by the integer
value in the metadata node. This is analogous to the ''dereferenceable_or_null'' value in the metadata node. This is analogous to the ''dereferenceable_or_null''
attribute on parameters and return values. This metadata can only be applied attribute on parameters and return values. This metadata can only be applied
to loads of a pointer type. to loads of a pointer type.
Semantics: Semantics:
▲ Show 20 Lines • Show All 5,059 Lines • Show Last 20 Lines