This page contains proposed changes for a future release of ROCm. Read the latest Linux release of ROCm documentation for your production environments.

hsa_amd_memory_pool_t Struct Reference

hsa_amd_memory_pool_t Struct Reference#

HIP Runtime API Reference: hsa_amd_memory_pool_t Struct Reference
hsa_amd_memory_pool_t Struct Reference

A memory pool encapsulates physical storage on an agent along with a memory access model. More...

#include <hsa_ext_amd.h>

Data Fields

uint64_t handle
 

Detailed Description

A memory pool encapsulates physical storage on an agent along with a memory access model.

A memory pool encapsulates a physical partition of an agent's memory system along with a memory access model. Division of a single memory system into separate pools allows querying each partition's access path properties (see hsa_amd_agent_memory_pool_get_info). Allocations from a pool are preferentially bound to that pool's physical partition. Binding to the pool's preferential physical partition may not be possible or persistent depending on the system's memory policy and/or state which is beyond the scope of HSA APIs.

For example, a multi-node NUMA memory system may be represented by multiple pool's with each pool providing size and access path information for the partition it represents. Allocations from a pool are preferentially bound to the pool's partition (which in this example is a NUMA node) while following its memory access model. The actual placement may vary or migrate due to the system's NUMA policy and state, which is beyond the scope of HSA APIs.

Field Documentation

◆ handle

uint64_t hsa_amd_memory_pool_t::handle

Opaque handle.


The documentation for this struct was generated from the following file:
  • /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hip/checkouts/ROCR-Runtime/src/inc/hsa_ext_amd.h