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>
36 lines
1.0 KiB
ReStructuredText
36 lines
1.0 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-memory-management:
|
|
|
|
|
|
---------------------------
|
|
Memory Management Routines
|
|
---------------------------
|
|
|
|
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
|
|
|
|
**Description:**
|
|
Allocate memory of ``size`` bytes from the symmetric heap.
|
|
This is a collective operation and must be called by all PEs.
|
|
|
|
ROCSHMEM_FREE
|
|
-------------
|
|
|
|
.. cpp:function:: __host__ void rocshmem_free(void *ptr)
|
|
|
|
:param ptr: 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.
|