mstxMemHeapRegister

domain

Input

Either globalDomain or the handle returned by mstxDomainCreateA.

Data type: const char *.

desc

Input

typedef enum mstxMemHeapUsageType {
    /* @brief This heap memory is used as a memory pool
     * Heap memory registered using this usage type must be accessed after secondary allocation registration
     */
    MSTX_MEM_HEAP_USAGE_TYPE_SUB_ALLOCATOR = 0,
} mstxMemHeapUsageType;

/** @brief Heap memory type

 * The "type" here refers to the method used to describe the heap memory pointer. Currently, only linearly arranged memory is supported.
 * memory, but the capability to support more memory types in the future is reserved here. For example, some APIs return
 * multiple handles to describe a memory range, or some high-dimensional memory requires stride, tiling, or
 * interlace for description.
 */
typedef enum mstxMemType {
    /** @brief Standard linearly laid out virtual memory
      * In this case, mstxMemHeapRegister receives a description of the mstxMemVirtualRangeDesc_t type.
      */
    MSTX_MEM_TYPE_VIRTUAL_ADDRESS = 0,
} mstxMemType;

typedef struct mstxMemVirtualRangeDesc_t {
    uint32_t deviceId;  // Device ID corresponding to the memory region
    void const *ptr;  // Start address of the memory region
    uint64_t size;  // Length of the memory region
} mstxMemVirtualRangeDesc_t;

typedef struct mstxMemHeapDesc_t {
    mstxMemHeapUsageType usage;  // Usage mode of the heap memory
    mstxMemType type;  // Type of the heap memory
    void const *typeSpecificDesc;  // Description information of the heap memory under the specified memory type
} mstxMemHeapDesc_t;