|
NVTX C API Reference v3
NVIDIA Tools Extension Library
|
structure to describe a heap in process virtual memory. More...
#include <nvToolsExtMem.h>
Data Fields | |
| uint16_t | extCompatID |
| uint16_t | structSize |
| uint32_t | reserved0 |
| uint32_t | usage |
| Usage characteristics of the heap. | |
| uint32_t | type |
| Memory type characteristics of the heap. | |
| size_t | typeSpecificDescSize |
| size of the heap memory descriptor pointed to by typeSpecificDesc | |
| void const * | typeSpecificDesc |
| Pointer to the heap memory descriptor. | |
| uint32_t | category |
| ID of the category the event is assigned to. | |
| uint32_t | messageType |
| Message type specified in this attribute structure. | |
| nvtxMessageValue_t | message |
| Message assigned to this attribute structure.. | |
structure to describe a heap in process virtual memory.
Definition at line 224 of file nvToolsExtMem.h.
| uint32_t nvtxMemHeapDesc_v1::category |
ID of the category the event is assigned to.
A category is a user-controlled ID that can be used to group events. The tool may use category IDs to improve filtering or enable grouping of events in the same category. The functions nvtxNameCategoryA or nvtxNameCategoryW can be used to name a category.
Default Value is 0.
Definition at line 287 of file nvToolsExtMem.h.
| uint16_t nvtxMemHeapDesc_v1::extCompatID |
Definition at line 226 of file nvToolsExtMem.h.
| nvtxMessageValue_t nvtxMemHeapDesc_v1::message |
Message assigned to this attribute structure..
The text message that is attached to an event.
Definition at line 302 of file nvToolsExtMem.h.
| uint32_t nvtxMemHeapDesc_v1::messageType |
Message type specified in this attribute structure.
Defines the message format of the attribute structure's message field.
Default Value is NVTX_MESSAGE_UNKNOWN.
Definition at line 296 of file nvToolsExtMem.h.
| uint32_t nvtxMemHeapDesc_v1::reserved0 |
Definition at line 228 of file nvToolsExtMem.h.
| uint16_t nvtxMemHeapDesc_v1::structSize |
Definition at line 227 of file nvToolsExtMem.h.
| uint32_t nvtxMemHeapDesc_v1::type |
Memory type characteristics of the heap.
The 'type' indicates how to interpret the ptr field of the heapDesc. This is intended to support many additional types of memory, beyond standard process virtual memory, such as API specific memory only addressed by handles or multi-dimensional memory requiring more complex descriptions to handle features like strides, tiling, or interlace.
The values conforms to NVTX_MEM_TYPE_*
The value in the field 'type' identifies the descriptor type that will be in the field 'typeSpecificDesc'. 'typeSpecificDesc' is void* because it is extensible. Example usage is if type is NVTX_MEM_TYPE_VIRTUAL_ADDRESS, then typeSpecificDesc points to a nvtxMemVirtualRangeDesc_t.
Default Value is 0, which is invalid.
Definition at line 258 of file nvToolsExtMem.h.
| void const* nvtxMemHeapDesc_v1::typeSpecificDesc |
Pointer to the heap memory descriptor.
The value in the field 'type' identifies the descriptor type that will be in the field 'typeSpecificDesc'. 'typeSpecificDesc' is void* because it is extensible. Example usage is if type is NVTX_MEM_TYPE_VIRTUAL_ADDRESS, then typeSpecificDesc points to a nvtxMemVirtualRangeDesc_t.
Default Value is 0, which is invalid.
Definition at line 275 of file nvToolsExtMem.h.
| size_t nvtxMemHeapDesc_v1::typeSpecificDescSize |
size of the heap memory descriptor pointed to by typeSpecificDesc
Default Value is 0 which is invalid.
Definition at line 264 of file nvToolsExtMem.h.
| uint32_t nvtxMemHeapDesc_v1::usage |
Usage characteristics of the heap.
Usage characteristics help tools like memcheckers, sanitizers, as well as other debugging and profiling tools to determine some special behaviors they should apply to the heap and its regions. The value follows the convention NVTX_MEM_HEAP_USAGE_*
Default Value is 0, which is invalid.
Definition at line 239 of file nvToolsExtMem.h.
1.9.8