Helper struct to submit a batch of events (marks or ranges). More...

#include <nvToolsExtPayload.h>

Data Fields
uint64_t	eventSchemaId

size_t	size

const void *	events
	Pointer to the array of deferred events.

uint64_t	scope

uint64_t	flags

const void *	flexData
	Flexible data blob referenced by events in the batch.

size_t	flexDataSize

size_t	flexDataOffset

Detailed Description

Helper struct to submit a batch of events (marks or ranges).

By default, events are assumed to be chronologically sorted by the first timestamp in the event (start time in a range). If the events are not sorted, the flags field must be set accordingly (see NVTX_BATCH_FLAG_*).

Definition at line 1250 of file nvToolsExtPayload.h.

Field Documentation

◆ events

const void* nvtxEventBatch_t::events

Pointer to the array of deferred events.

For static schemas, the stride is the fixed payload size. For dynamic schemas, there is no fixed stride. The buffer is read event by event, advancing the pointer by the size of the event.

Definition at line 1269 of file nvToolsExtPayload.h.

◆ eventSchemaId

uint64_t nvtxEventBatch_t::eventSchemaId

Identifier of the data layout of a deferred event in the array of events. The time domain of event timestamps is provided via time semantics in the schema registration.

Definition at line 1257 of file nvToolsExtPayload.h.

◆ flags

uint64_t nvtxEventBatch_t::flags

Timestamp ordering (sorted, partially sorted, unsorted), etc.

Definition at line 1285 of file nvToolsExtPayload.h.

◆ flexData

const void* nvtxEventBatch_t::flexData

Flexible data blob referenced by events in the batch.

Events may contain pointer or offset entries that reference data in this blob (e.g. variable-length strings or arrays). The usable region starts at byte offset flexDataOffset and extends for flexDataSize bytes. A tool resolves event-internal offsets relative to flexData.

Definition at line 1295 of file nvToolsExtPayload.h.

◆ flexDataOffset

size_t nvtxEventBatch_t::flexDataOffset

Byte offset from flexData to the start of the usable region. Allows the caller to prepend metadata or align the usable area.

Definition at line 1304 of file nvToolsExtPayload.h.

◆ flexDataSize

size_t nvtxEventBatch_t::flexDataSize

Size of the usable flexible data region (in bytes).

Definition at line 1298 of file nvToolsExtPayload.h.

◆ scope

uint64_t nvtxEventBatch_t::scope

Default scope of events or counters in the batch.

A scope from a payload entry or purpose-specific scope semantics takes precedence. If no such scope is specified, the batch scope takes precedence over general scope semantics from the schema.

Use NVTX_SCOPE_NONE when the original execution scope is unknown or intentionally unspecified. Deferred events with NVTX_SCOPE_NONE should not be attributed to the thread or process that submits the batch.

Definition at line 1282 of file nvToolsExtPayload.h.

◆ size

size_t nvtxEventBatch_t::size

Size of the array of deferred events (in bytes).

Definition at line 1260 of file nvToolsExtPayload.h.

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

nvToolsExtPayload.h

Data Fields