Updated docs for ROCm 7.x.x (#239)
Co-authored-by: Aurelien Bouteiller <aurelien.bouteiller@amd.com> Co-authored-by: yugang-amd <yugang.wang@amd.com>
Этот коммит содержится в:
+17
-2
@@ -13,11 +13,11 @@ ROCSHMEM_CTX_CREATE
|
||||
|
||||
.. cpp:function:: __device__ int rocshmem_wg_ctx_create(int64_t options, rocshmem_ctx_t *ctx)
|
||||
.. cpp:function:: __device__ int rocshmem_wg_team_create_ctx(rocshmem_team_t team, long options, rocshmem_ctx_t *ctx)
|
||||
|
||||
|
||||
:param team: Team handle to derive the context from.
|
||||
:param options: Options for context creation. Ignored in current design; use the value ``0``.
|
||||
:param ctx: Context handle.
|
||||
|
||||
|
||||
:returns: All threads returns ``0`` if the context was created successfully.
|
||||
If any thread returns non-zero value, the operation fails and a higher number of
|
||||
``ROCSHMEM_MAX_NUM_CONTEXTS`` is required.
|
||||
@@ -38,3 +38,18 @@ ROCSHMEM_CTX_DESTROY
|
||||
**Description:**
|
||||
This routine destroys an rocSHMEM context.
|
||||
It must be called collectively by all threads in the work-group.
|
||||
|
||||
ROCSHMEM_GET_DEVICE_CTX
|
||||
-----------------------
|
||||
|
||||
.. cpp:function:: __host__ void * rocshmem_get_device_ctx()
|
||||
|
||||
:param: None.
|
||||
|
||||
:returns: Returns ``ROCSHMEM_CTX_DEFAULT`` device pointer that users.
|
||||
can query from one instance of rocSHMEM host library and
|
||||
use later for dynamic module initialization in
|
||||
kernel bitcode device library in the same application.
|
||||
|
||||
**Description:**
|
||||
This routine queries rocSHMEM default device context from host API.
|
||||
|
||||
@@ -143,3 +143,19 @@ It can be called before ``rocshmem_init``.
|
||||
**Description:**
|
||||
This routine queries the PE ID of the caller.
|
||||
It can be called per thread with no performance penalty.
|
||||
|
||||
ROCSHMEM_PTR
|
||||
--------------
|
||||
|
||||
.. cpp:function:: __host__ void* rocshmem_ptr(const void *dest, int pe);
|
||||
.. cpp:function:: __device__ void* rocshmem_ptr(const void *dest, int pe);
|
||||
|
||||
:param dest: Local symmetric heap allocation pointer for current PE.
|
||||
:param pe: Remote PE.
|
||||
:returns: Returns remote symmetric heap device pointer from host-side API.
|
||||
``NULL`` is returned if a valid device pointer cannot be provided.
|
||||
This pointer can be used to issue load/store from custom kernels
|
||||
instead of using rocshmem device side get/put APIs for RMA operations.
|
||||
|
||||
**Description:**
|
||||
This routine queries rocSHMEM remote symmetric heap pointer.
|
||||
|
||||
Ссылка в новой задаче
Block a user