Is this page helpful?

nvmlEventSetWait_v3_t#

struct nvmlEventSetWait_v3_t#

Parameters for waiting on an event set with nvmlEventSetWait_v3.

This structure supplies the wait timeout and returns either NVML event-bit or structured event data. For NVML event-bit data, dataType is NVML_EVENT_DATA_TYPE_NVML_EVENT, eventType contains the NVML event bit, fields such as eventData, gpuInstanceId, and computeInstanceId preserve existing semantics, and structured-only fields are set to 0 or empty values. For structured GPU Operational Events, dataType is NVML_EVENT_DATA_TYPE_GPU_OPERATIONAL_EVENT, eventType is set to nvmlEventTypeNone, and the structured metadata fields are populated.

Clients that subscribe to both NVML event-bit and structured formats on the same event set should branch on dataType to determine which format was returned. During the transition period, the same underlying incident may generate both an NVML event-bit notification and a structured notification.

Public Members

unsigned int timeoutMs#

[in] Maximum amount of time to wait, in milliseconds.

unsigned int dataType#

[out] nvmlEventDataType_t value indicating which event-data format is populated.

char uuid[96]#

[out] UUID for the GPU where the event occurred. Empty if unavailable.

char sourceModule[16]#

[out] Source module signature for structured events. Not guaranteed to be NULL-terminated. Empty for NVML event-bit events.

unsigned long long eventType#

[out] NVML event bit for NVML_EVENT_DATA_TYPE_NVML_EVENT events; nvmlEventTypeNone for structured events.

unsigned long long eventData#

[out] Xid code for nvmlEventTypeXidCriticalError, or 0 when not applicable.

unsigned long long groupCursor#

[out] Structured event group identifier. 0 for NVML event-bit events.

unsigned long long instanceId#

[out] Structured event sequence identifier. 0 for NVML event-bit events.

unsigned long long timestampUsec#

[out] Event timestamp in microseconds. 0 if unavailable.

unsigned long long traceId#

[out] Structured event trace identifier. 0 for NVML event-bit events.

unsigned int gpuInstanceId#

[out] MIG GPU instance ID for NVML event-bit data, or NVML_GPU_INSTANCE_ID_ANY when not applicable.

unsigned int computeInstanceId#

[out] MIG compute instance ID for NVML event-bit data, or NVML_COMPUTE_INSTANCE_ID_ANY when not applicable.

unsigned int severity#

[out] nvmlOperationalEventSeverity_t value for structured events. May contain newer severity values not named in this header. NVML_OPERATIONAL_EVENT_SEVERITY_ALL for NVML event-bit events.

unsigned int categoryId#

[out] Source-defined structured event category identifier. 0 for NVML event-bit events.

unsigned int moduleEventCode#

[out] Source-module-defined event code. Interpret with sourceModule. 0 for NVML event-bit events.

unsigned int scope#

[out] Structured event scope identifier. 0 for NVML event-bit events.

unsigned int originator#

[out] Structured event originator identifier. 0 for NVML event-bit events.

unsigned int moduleInstance#

[out] Structured event module instance identifier. 0 for NVML event-bit events.

unsigned int chipletId#

[out] Structured event chiplet identifier. 0 for NVML event-bit events.

unsigned int logLevel#

[out] nvmlGpuOperationalEventLogLevel_t value for structured GPU Operational Events. May contain newer log-level values not named in this header. NVML_GPU_OPERATIONAL_EVENT_LOG_LEVEL_ALL for NVML event-bit events.

unsigned int attributes#

[out] Bitmask of NVML_OPERATIONAL_EVENT_ATTR_* values for structured events. May contain newer bits not named in this header. 0 for NVML event-bit events. May include NVML_OPERATIONAL_EVENT_ATTR_OVERFLOW if events or associated payloads were dropped.

unsigned int groupCperSize#

[out] Associated CPER record size in bytes. 0 when unavailable.

unsigned int groupAttributes#

[out] Bitmask of NVML_OPERATIONAL_EVENT_GROUP_ATTR_* values for structured events. May contain newer bits not named in this header. 0 for NVML event-bit events.

unsigned char groupSize#

[out] Total number of events in the structured event group. 0 for NVML event-bit events.

unsigned char groupIndex#

[out] Zero-based index within the structured event group. 0 for NVML event-bit events.