Register a region of memory inside of a heap. More...

#include <nvToolsExtMem.h>

Data Fields
uint16_t	extCompatID

uint16_t	structSize

uint32_t	regionType

nvtxMemHeapHandle_t	heap

size_t	regionCount

size_t	regionDescElementSize

void const *	regionDescElements

nvtxMemRegionHandle_t *	regionHandleElementsOut

Detailed Description

Register a region of memory inside of a heap.

The heap refers the the heap within which the region resides. This can be from nvtxMemHeapRegister, NVTX_MEM_HEAP_HANDLE_PROCESS_WIDE, or one provided from other extension API.

The regionType arg will define which type is used in regionDescArray. The most commonly used type is NVTX_MEM_TYPE_VIRTUAL_ADDRESS. In this case regionDescElements is an array of nvtxMemVirtualRangeDesc_t.

The regionCount arg is how many element are in regionDescArray and regionHandleArrayOut.

The regionHandleArrayOut arg points to an array where the tool will provide region handles. If a pointer is provided, it is expected to have regionCount elements. This pointer can be NULL if regionType is NVTX_MEM_TYPE_VIRTUAL_ADDRESS. In this case, the user can use the pointer to the virtual memory to reference the region in other related functions which accept nvtxMemRegionRef_t.

Definition at line 348 of file nvToolsExtMem.h.

Field Documentation

◆ extCompatID

uint16_t nvtxMemRegionsRegisterBatch_v1::extCompatID

Definition at line 350 of file nvToolsExtMem.h.

◆ heap

nvtxMemHeapHandle_t nvtxMemRegionsRegisterBatch_v1::heap

Definition at line 355 of file nvToolsExtMem.h.

◆ regionCount

size_t nvtxMemRegionsRegisterBatch_v1::regionCount

Definition at line 357 of file nvToolsExtMem.h.

◆ regionDescElements

void const* nvtxMemRegionsRegisterBatch_v1::regionDescElements

Definition at line 359 of file nvToolsExtMem.h.

◆ regionDescElementSize

size_t nvtxMemRegionsRegisterBatch_v1::regionDescElementSize

Definition at line 358 of file nvToolsExtMem.h.

◆ regionHandleElementsOut

nvtxMemRegionHandle_t* nvtxMemRegionsRegisterBatch_v1::regionHandleElementsOut

Definition at line 360 of file nvToolsExtMem.h.

◆ regionType

uint32_t nvtxMemRegionsRegisterBatch_v1::regionType

Definition at line 353 of file nvToolsExtMem.h.

◆ structSize

uint16_t nvtxMemRegionsRegisterBatch_v1::structSize

Definition at line 351 of file nvToolsExtMem.h.

The documentation for this struct was generated from the following file:

nvToolsExtMem.h

Data Fields