AI/rocm-systems
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Style edits (#122)

Browse Source 
[ROCm/rocshmem commit: 67bff9ca30]
This commit is contained in:
yugang-amd
2025-05-13 16:26:28 -04:00
committed by GitHub
parent 2f82ed9bf0
commit 17cde51fb7
16 changed files with 477 additions and 495 deletions
Download Patch File Download Diff File Expand all files Collapse all files
projects/rocshmem/docs/api/memory_management.rst
+9 -9
View File
@@ -6,7 +6,7 @@
---------------------------
Memory Management Routines
Memory management routines
---------------------------
ROCSHMEM_MALLOC
@@ -14,12 +14,12 @@ ROCSHMEM_MALLOC
.. cpp:function:: __host__ void *rocshmem_malloc(size_t size)
:param size: Memory allocation size in bytes
:returns: A pointer to the allocated memory on the symmetric heap;
If a valid allocation cannot be made, it returns NULL
:param size: Memory allocation size in bytes.
:returns: A pointer to the allocated memory on the symmetric heap.
If a valid allocation cannot be made, it returns ``NULL``.
**Description:**
Allocate memory of ``size`` bytes from the symmetric heap.
This routine allocates memory of ``size`` bytes from the symmetric heap.
This is a collective operation and must be called by all PEs.
ROCSHMEM_FREE
@@ -27,9 +27,9 @@ ROCSHMEM_FREE
.. cpp:function:: __host__ void rocshmem_free(void *ptr)
:param ptr: Pointer to previously allocated memory on the symmetric heap
:returns: None
:param ptr: A pointer to previously allocated memory on the symmetric heap.
:returns: None.
**Description:**
Free a memory allocation from the symmetric heap.
This is a collective operation and must be called by all PEs.
This routine frees a memory allocation from the symmetric heap.
It is a collective operation and must be called by all PEs.