derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
46 lines
2.2 KiB
ReStructuredText
46 lines
2.2 KiB
ReStructuredText
.. meta::
|
|
:description: rocSHMEM intra-kernel networking runtime for AMD GPUs on the ROCm platform.
|
|
:keywords: rocSHMEM, API, ROCm, documentation, HIP, Networking, Communication
|
|
|
|
.. _rocshmem-introduction:
|
|
|
|
---------------------------
|
|
What is rocSHMEM?
|
|
---------------------------
|
|
|
|
The ROCm OpenSHMEM (rocSHMEM) is an intra-kernel networking library that provides GPU-centric networking through an OpenSHMEM-like interface. It simplifies application code complexity and enables finer communication and computation overlap than traditional host-driven networking. rocSHMEM uses a single symmetric heap allocated on GPU memories.
|
|
|
|
The rocSHMEM programming model
|
|
-------------------------------
|
|
|
|
Defining how OpenSHMEM applications interact with GPUs remains an
|
|
ongoing active discussion within the OpenSHMEM community, and the OpenSHMEM
|
|
specification has yet to coalesce on this topic.
|
|
rocSHMEM extends beyond the OpenSHMEM specification to add semantics that
|
|
support GPU kernel communication while maintaining close resemblance to
|
|
the original OpenSHMEM specification semantics.
|
|
|
|
Applications using :doc:`HIP <hip:index>` can interface with rocSHMEM.
|
|
Using the HIP programming model,
|
|
rocSHMEM provides ``__host__`` APIs for host code,
|
|
and ``__device__`` APIs for GPU kernels.
|
|
Device APIs without special suffixes or infixes , for example, ``_wg`` or ``_wave``,
|
|
must be called by a single thread.
|
|
GPU specific ``_wg`` and ``_wave`` APIs are designed to be called by multiple GPU threads
|
|
and will block until the calling scope completes.
|
|
These APIs can be called in divergent code paths, but this is not recommended.
|
|
|
|
Wavefront APIs
|
|
==============
|
|
Wavefront APIs are those with the ``_wave`` suffix.
|
|
The parameters in which these routines are called must be
|
|
the same for every thread in the wavefront.
|
|
The behavior is undefined if any thread calls these routines with different parameters. These APIs will block until the calling wavefront is complete.
|
|
|
|
Workgroup APIs
|
|
==============
|
|
The workgroup APIs have the ``_wg`` suffix or ``_wg_`` infix.
|
|
The parameters in which these routines are called must be
|
|
the same for every thread in the workgroup.
|
|
The behavior is undefined if any thread calls these routines with different parameters. These APIs will block until the calling workgroup is complete.
|