Yiltan
f693c98fb2
* Initial ROCm-docs commit Co-authored-by: Aurélien Bouteiller <bouteill@icl.utk.edu> Co-authored-by: Alex Xu <alex.xu@amd.com> Co-authored-by: yugang-amd <yugang.wang@amd.com>
123 rindas
4.2 KiB
ReStructuredText
123 rindas
4.2 KiB
ReStructuredText
.. meta::
|
|
:description: rocSHMEM intra-kernel networking runtime for AMD dGPUs on the ROCm platform.
|
|
:keywords: rocSHMEM, API, ROCm, documentation, HIP, Networking, Communication
|
|
|
|
.. _rocshmem-api-pt2pt-sync:
|
|
|
|
-----------------------------------------
|
|
Point-to-Point Synchronization Routines
|
|
-----------------------------------------
|
|
|
|
ROCSHMEM_WAIT_UNTIL
|
|
-------------------
|
|
|
|
.. cpp:function:: __device__ void rocshmem_TYPENAME_wait_until(TYPE *ivars, int cmp, TYPE val)
|
|
|
|
:param ivars: Pointer to memory on the symmetric heap to wait for
|
|
:param cmp: Operation for the comparison
|
|
:param val: Value to compare the memory at ivars to
|
|
:returns: None
|
|
|
|
**Description:**
|
|
Block the caller until the condition ``(*ivars cmp val)`` is true.
|
|
|
|
Valid ``cmp`` values can be seen at :ref:`CMP_VALUES`.
|
|
|
|
Valid ``TYPENAME`` and ``TYPE`` values can be seen at :ref:`STANDARD_AMO_TYPES`.
|
|
|
|
ROCSHMEM_WAIT_UNTIL_ALL
|
|
-----------------------
|
|
|
|
.. cpp:function:: __device__ void rocshmem_TYPENAME_wait_until_all(TYPE *ivars, size_t nelems, const int* status, int cmp, TYPE val)
|
|
|
|
:param ivars: Pointer to memory on the symmetric heap to wait for
|
|
:param nelems: Number of elements in the ivars array
|
|
:param status: Array of length nelems that is used to exclude elements from wait
|
|
:param cmp: Operation for the comparison
|
|
:param val: Value to compare
|
|
:returns: None
|
|
|
|
**Description:**
|
|
Block the caller until the condition ``(ivars[i] cmp val)`` is true for all ivars
|
|
|
|
Valid ``cmp`` values can be seen at :ref:`CMP_VALUES`.
|
|
|
|
Valid ``TYPENAME`` and ``TYPE`` values can be seen at :ref:`STANDARD_AMO_TYPES`.
|
|
|
|
ROCSHMEM_WAIT_UNTIL_ANY
|
|
-----------------------
|
|
.. cpp:function:: __device__ size_t rocshmem_TYPENAME_wait_until_any(TYPE *ivars, size_t nelems, const int* status, int cmp, TYPE val)
|
|
|
|
:param ivars: Pointer to memory on the symmetric heap to wait for
|
|
:param nelems: Number of elements in the ivars array
|
|
:param status: Array of length nelems that is used to exclude elements from wait
|
|
:param cmp: Operation for the comparison
|
|
:param val: Value to compare
|
|
:returns: The index of an element in the ivars array that satisfies the wait condition; If the wait set is empty, this routine returns SIZE_MAX
|
|
|
|
**Description:**
|
|
Block the caller until any of the condition ``(ivars[i] cmp val)`` is true.
|
|
|
|
Valid `cmp` values can be seen at :ref:`CMP_VALUES`.
|
|
|
|
Valid ``TYPENAME`` and ``TYPE`` values can be seen at :ref:`STANDARD_AMO_TYPES`.
|
|
|
|
ROCSHMEM_WAIT_UNTIL_SOME
|
|
------------------------
|
|
|
|
.. cpp:function:: __device__ size_t rocshmem_TYPENAME_wait_until_some(TYPE *ivars, size_t nelems, size_t* indices, const int* status, int cmp, TYPE val)
|
|
|
|
:param ivars: Pointer to memory on the symmetric heap to wait for
|
|
:param nelems: Number of elements in the ivars array
|
|
:param indices: List of indices that of at least of length nelems
|
|
:param status: Array of length nelems that is used to exclude elements from wait
|
|
:param cmp: Operation for the comparison
|
|
:param val: Value to compare
|
|
:returns: The number of indices returned in the indices array; If the wait set is empty, this routine returns 0
|
|
|
|
**Description:**
|
|
Block the caller until any of the conditions ``(ivars[i] cmp val)`` is true.
|
|
|
|
Valid `cmp` values can be seen at :ref:`CMP_VALUES`.
|
|
|
|
Valid ``TYPENAME`` and ``TYPE`` values can be seen at :ref:`STANDARD_AMO_TYPES`.
|
|
|
|
ROCSHMEM_TEST
|
|
-------------
|
|
|
|
.. cpp:function:: __device__ int rocshmem_TYPENAME_test(TYPE *ivars, int cmp, TYPE val)
|
|
|
|
:param ivars: Pointer to memory on the symmetric heap to wait for
|
|
:param cmp: Operation for the comparison
|
|
:param val: Value to compare the memory at ivars to
|
|
|
|
:returnS: 1 if the evaluation is true, 0 otherwise
|
|
|
|
**Description:**
|
|
Test if the condition ``(*ivars cmp val)`` is true.
|
|
|
|
|
|
SUPPORTED COMPARISONS
|
|
---------------------
|
|
|
|
.. _CMP_VALUES:
|
|
|
|
.. list-table:: Point-to-Point Comparison Constants
|
|
:widths: 20 20
|
|
:header-rows: 1
|
|
|
|
* - Constant
|
|
- Description
|
|
* - ROCSHMEM_CMP_EQ
|
|
- Equal
|
|
* - ROCSHMEM_CMP_NE
|
|
- Not equal
|
|
* - ROCSHMEM_CMP_GT
|
|
- Greater than
|
|
* - ROCSHMEM_CMP_GE
|
|
- Greater than or equal to
|
|
* - ROCSHMEM_CMP_LT
|
|
- Less than
|
|
* - ROCSHMEM_CMP_LE
|
|
- Less than or equal to
|