NVML API Reference Guide (PDF) - vR590 (older) - Last updated December 04, 2025 - Send Feedback

5.20.1. Event Types

[Event Handling Methods]

Event Types which user can be notified about. See description of particular functions for details.

See nvmlDeviceRegisterEvents and nvmlDeviceGetSupportedEventTypes to check which devices support each event.

Types can be combined with bitwise or operator '|' when passed to nvmlDeviceRegisterEvents

Defines

#define nvmlEventMigConfigChange 0x0000000000000100LL
Event about MIG configuration changes.
#define nvmlEventTypeAll
Mask of all events.
#define nvmlEventTypeClock 0x0000000000000010LL
Event about clock changes.
#define nvmlEventTypeDoubleBitEccError 0x0000000000000002LL
Event about double bit ECC errors.
#define nvmlEventTypeDramRetirementEvent 0x0000000000000400LL
Event about DRAM retirement event.
#define nvmlEventTypeDramRetirementFailure 0x0000000000000800LL
Event about DRAM retirement failure.
#define nvmlEventTypeFatalPoisonError 0x0000000000002000LL
Event for Fatal Poison.
#define nvmlEventTypeGpuRecoveryAction 0x0000000000008000LL
Event for GPU Recovery Action.
#define nvmlEventTypeGpuUnavailableError 0x0000000000004000LL
Event for GPU Unavailable.
#define nvmlEventTypeNonFatalPoisonError 0x0000000000001000LL
Event for Non Fatal Poison.
#define nvmlEventTypeNone 0x0000000000000000LL
Mask with no events.
#define nvmlEventTypePState 0x0000000000000004LL
Event about PState changes.
#define nvmlEventTypePowerSourceChange 0x0000000000000080LL
Event about AC/Battery power source changes.
#define nvmlEventTypeSingleBitEccError 0x0000000000000001LL
Event about single bit ECC errors.
#define nvmlEventTypeSingleBitEccErrorStorm 0x0000000000000200LL
Event about single bit ECC error storm.
#define nvmlEventTypeXidCriticalError 0x0000000000000008LL
Event that Xid critical error occurred.

Defines

#define nvmlEventMigConfigChange 0x0000000000000100LL

MIG configuration change event.

#define nvmlEventTypeAll

Mask of all event types.

Value

(nvmlEventTypeNone \ | nvmlEventTypeSingleBitEccError \ | nvmlEventTypeDoubleBitEccError \ | nvmlEventTypePState \ | nvmlEventTypeClock \ | nvmlEventTypeXidCriticalError \ | nvmlEventTypePowerSourceChange \ | nvmlEventMigConfigChange \ | nvmlEventTypeSingleBitEccErrorStorm \ | nvmlEventTypeDramRetirementEvent \ | nvmlEventTypeDramRetirementFailure \ | nvmlEventTypeNonFatalPoisonError \ | nvmlEventTypeFatalPoisonError \ | nvmlEventTypeGpuUnavailableError \ | nvmlEventTypeGpuRecoveryAction)

#define nvmlEventTypeClock 0x0000000000000010LL

Kepler only Clock change event.

#define nvmlEventTypeDoubleBitEccError 0x0000000000000002LL

Note:

An uncorrected texture memory error is not an ECC error, so it does not generate a double bit event Double bit ECC error event.

#define nvmlEventTypeDramRetirementEvent 0x0000000000000400LL

DRAM retirement event.

#define nvmlEventTypeDramRetirementFailure 0x0000000000000800LL

DRAM retirement failure event.

#define nvmlEventTypeFatalPoisonError 0x0000000000002000LL

Fatal poison error event.

#define nvmlEventTypeGpuRecoveryAction 0x0000000000008000LL

GPU recovery action event.

#define nvmlEventTypeGpuUnavailableError 0x0000000000004000LL

GPU unavailable error event.

#define nvmlEventTypeNonFatalPoisonError 0x0000000000001000LL

Non-fatal poison error event.

#define nvmlEventTypeNone 0x0000000000000000LL

No event.

#define nvmlEventTypePState 0x0000000000000004LL

Note:

On Fermi architecture PState changes are also an indicator that GPU is throttling down due to no work being executed on the GPU, power capping or thermal capping. In a typical situation, Fermi-based GPU should stay in P0 for the duration of the execution of the compute process. PState change event.

#define nvmlEventTypePowerSourceChange 0x0000000000000080LL

Power source change event.

#define nvmlEventTypeSingleBitEccError 0x0000000000000001LL

Note:

A corrected texture memory error is not an ECC error, so it does not generate a single bit event Single bit ECC error event.

#define nvmlEventTypeSingleBitEccErrorStorm 0x0000000000000200LL

Single bit ECC error storm event.

#define nvmlEventTypeXidCriticalError 0x0000000000000008LL

XID critical error event.


NVML API Reference Guide (PDF) - vR590 (older) - Last updated December 04, 2025 - Send Feedback