Files
TheRock/rocm-systems/projects/rocshmem/docs/library_constants.rst
T
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
Flatten subprojects into a single base monorepo
2026-09-02 16:34:47 -07:00

55 lines
1.8 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-library-constants:
------------------
Library constants
------------------
.. c:macro:: ROCSHMEM_MAJOR_VERSION
An integer constant whose value is the major version of the
OpenSHMEM specification supported by this library.
Returned by ``rocshmem_info_get_version``.
.. c:macro:: ROCSHMEM_MINOR_VERSION
An integer constant whose value is the minor version of the
OpenSHMEM specification supported by this library.
Returned by ``rocshmem_info_get_version``.
.. c:macro:: ROCSHMEM_MAX_NAME_LEN
An integer constant that specifies the minimum size (in bytes) of the
buffer passed to ``rocshmem_info_get_name``. The value includes space
for the null terminator.
.. c:macro:: ROCSHMEM_VENDOR_STRING
A string constant that contains the vendor-defined name of the library.
Its length, including the null terminator, is at most
``ROCSHMEM_MAX_NAME_LEN`` bytes.
Copied into the caller's buffer by ``rocshmem_info_get_name``.
.. c:macro:: ROCSHMEM_VERSION
A string constant that contains the full version of the library
in ``"major.minor.patch"`` format (e.g. ``"3.3.0"``).
.. c:macro:: ROCSHMEM_VENDOR_MAJOR_VERSION
An integer constant whose value is the vendor major version of rocSHMEM.
Returned by ``rocshmem_vendor_get_version_info``.
.. c:macro:: ROCSHMEM_VENDOR_MINOR_VERSION
An integer constant whose value is the vendor minor version of rocSHMEM.
Returned by ``rocshmem_vendor_get_version_info``.
.. c:macro:: ROCSHMEM_VENDOR_PATCH_VERSION
An integer constant whose value is the vendor patch version of rocSHMEM.
Returned by ``rocshmem_vendor_get_version_info``.