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

#include <nvToolsExtMem.h>

Data Fields
uint16_t	extCompatID

uint16_t	structSize

uint32_t	refType

size_t	refCount

size_t	refElementSize

nvtxMemRegionRef_t const *	refElements

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.

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 if 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 a nvtxMemRegionRef_t.

Definition at line 433 of file nvToolsExtMem.h.

Field Documentation

◆ extCompatID

uint16_t nvtxMemRegionsUnregisterBatch_v1::extCompatID

Definition at line 435 of file nvToolsExtMem.h.

◆ refCount

size_t nvtxMemRegionsUnregisterBatch_v1::refCount

Definition at line 440 of file nvToolsExtMem.h.

◆ refElements

nvtxMemRegionRef_t const* nvtxMemRegionsUnregisterBatch_v1::refElements

Definition at line 442 of file nvToolsExtMem.h.

◆ refElementSize

size_t nvtxMemRegionsUnregisterBatch_v1::refElementSize

Definition at line 441 of file nvToolsExtMem.h.

◆ refType

uint32_t nvtxMemRegionsUnregisterBatch_v1::refType

Definition at line 438 of file nvToolsExtMem.h.

◆ structSize

uint16_t nvtxMemRegionsUnregisterBatch_v1::structSize

Definition at line 436 of file nvToolsExtMem.h.

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

nvToolsExtMem.h

Data Fields