nvtxPayloadData_t Struct Reference

Binary payload data, size and decoding information. More...

#include <nvToolsExtPayload.h>

Data Fields
uint64_t	schemaId
size_t	size
const void *	payload

Detailed Description

Binary payload data, size and decoding information.

An array of type nvtxPayloadData_t is passed to the NVTX event attached to an NVTX event via the payload.ullvalue field of NVTX event attributes.

The schemaId be a predefined schema entry type (NVTX_PAYLOAD_ENTRY_TYPE*), a schema ID (statically specified or dynamically created) or one of NVTX_PAYLOAD_TYPE_REFERENCED or NVTX_PAYLOAD_TYPE_RAW.

Setting the size of a payload to MAX_SIZE can be useful to reduce the overhead of NVTX instrumentation, when no NVTX handler is attached. However, a tool might not be able to detect the size of a payload and thus skip it. A reasonable use case is a payload that represents a null-terminated C string, where the NVTX handler can call strlen().

Definition at line 624 of file nvToolsExtPayload.h.

Field Documentation

payload

const void* nvtxPayloadData_t::payload

Pointer to the binary payload data.

Definition at line 640 of file nvToolsExtPayload.h.

schemaId

uint64_t nvtxPayloadData_t::schemaId

The schema ID, which defines the layout of the binary data.

Definition at line 629 of file nvToolsExtPayload.h.

size

size_t nvtxPayloadData_t::size

Size of the payload (blob) in bytes. SIZE_MAX (-1) indicates the tool that it should figure out the size, which might not be possible.

Definition at line 635 of file nvToolsExtPayload.h.

---

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

• nvToolsExtPayload.h