NVTX payload schema attributes. More...

#include <nvToolsExtPayload.h>

Data Fields
uint64_t	fieldMask
	Mask of valid fields in this struct.

const char *	name
	Name of the payload schema. (Optional)

uint64_t	type
	Payload schema type. (Mandatory).

uint64_t	flags
	Payload schema flags. (Optional)

const nvtxPayloadSchemaEntry_t *	entries
	Entries of a payload schema. (Mandatory).

size_t	numEntries
	Number of entries in the payload schema. (Mandatory)

size_t	payloadStaticSize
	The binary payload size in bytes for static payload schemas.

size_t	packAlign
	The byte alignment for packed structures.

uint64_t	schemaId
	Unique identifier for this schema.

void *	extension

Detailed Description

NVTX payload schema attributes.

Definition at line 977 of file nvToolsExtPayload.h.

Field Documentation

◆ entries

const nvtxPayloadSchemaEntry_t* nvtxPayloadSchemaAttr_t::entries

Entries of a payload schema. (Mandatory).

This field points to an array of schema entries, each describing a field in a data structure such as a C struct or union.

Definition at line 1012 of file nvToolsExtPayload.h.

◆ extension

void* nvtxPayloadSchemaAttr_t::extension

Reserved for future use.

Definition at line 1059 of file nvToolsExtPayload.h.

◆ fieldMask

uint64_t nvtxPayloadSchemaAttr_t::fieldMask

Mask of valid fields in this struct.

Use the NVTX_PAYLOAD_SCHEMA_ATTR_FIELD_* defines.

Definition at line 984 of file nvToolsExtPayload.h.

◆ flags

uint64_t nvtxPayloadSchemaAttr_t::flags

Payload schema flags. (Optional)

Flags defined by NVTX_PAYLOAD_SCHEMA_FLAG_* can be used to set additional properties of the schema.

Definition at line 1004 of file nvToolsExtPayload.h.

◆ name

const char* nvtxPayloadSchemaAttr_t::name

Name of the payload schema. (Optional)

Definition at line 989 of file nvToolsExtPayload.h.

◆ numEntries

size_t nvtxPayloadSchemaAttr_t::numEntries

Number of entries in the payload schema. (Mandatory)

Number of entries in the array of payload entries ENTRIES_FIELD.

Definition at line 1019 of file nvToolsExtPayload.h.

◆ packAlign

size_t nvtxPayloadSchemaAttr_t::packAlign

The byte alignment for packed structures.

If not specified, this field defaults to 0, which means that the fields in the data structure are not packed and natural alignment rules can be applied.

A non-zero value caps each member's effective alignment identically to C's #pragma pack(N): effectiveAlign = min(naturalAlign, packAlign). For example, packAlign = 4 means no member is aligned to more than 4 bytes, regardless of its natural alignment.

Definition at line 1044 of file nvToolsExtPayload.h.

◆ payloadStaticSize

size_t nvtxPayloadSchemaAttr_t::payloadStaticSize

The binary payload size in bytes for static payload schemas.

If PAYLOAD_TYPE_FIELD is NVTX_PAYLOAD_SCHEMA_TYPE_DYNAMIC this value is ignored. If this field is not specified for a schema of type NVTX_PAYLOAD_SCHEMA_TYPE_STATIC, the size can be automatically determined by a tool.

Definition at line 1029 of file nvToolsExtPayload.h.

◆ schemaId

uint64_t nvtxPayloadSchemaAttr_t::schemaId

Unique identifier for this schema.

A static payload schema ID must be unique within the domain, >= NVTX_PAYLOAD_SCHEMA_ID_STATIC_START and < NVTX_PAYLOAD_SCHEMA_ID_DYNAMIC_START.

Schema IDs and enum IDs share a single namespace within a domain. A given numeric ID must not be used for both a schema and an enum.

Definition at line 1056 of file nvToolsExtPayload.h.

◆ type

uint64_t nvtxPayloadSchemaAttr_t::type

Payload schema type. (Mandatory).

Use the NVTX_PAYLOAD_SCHEMA_TYPE_* defines.

Definition at line 996 of file nvToolsExtPayload.h.

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

nvToolsExtPayload.h

Data Fields