Device Structs#
Macros#
- NVML_DEVICE_MEMORY_LIMIT_MAX
Value for "maximum" memory limit.
- NVML_DEVICE_PCI_BUS_ID_BUFFER_SIZE
Buffer size guaranteed to be large enough for pci bus id.
- NVML_DEVICE_PCI_BUS_ID_BUFFER_V2_SIZE
Buffer size guaranteed to be large enough for pci bus id for
busIdLegacy.- NVML_DEVICE_PCI_BUS_ID_FMT
PCI format string for
busId.- NVML_DEVICE_PCI_BUS_ID_FMT_ARGS
Utility macro for filling the pci bus id format from a nvmlPciInfo_t .
- NVML_DEVICE_PCI_BUS_ID_LEGACY_FMT
PCI format string for
busIdLegacy.- NVML_DEVICE_UUID_ASCII_LEN
UUID length in ASCII format.
- NVML_DEVICE_UUID_BINARY_LEN
UUID length in binary format.
- NVML_MAX_PHYSICAL_BRIDGE
Maximum limit on Physical Bridges per Board.
- NVML_MAX_THERMAL_SENSORS_PER_GPU
Maximum number of thermal sensors per GPU.
- NVML_NVLINK_MAX_LINKS
Maximum number of NvLink links supported.
- NVML_PERF_CF_PM_SENSOR_MAX_SIGNALS
Maximum number of BA PM sensor signals.
- NVML_PERF_METRICS_CONTROLLER_DLPPC_2X_PWR_POLICY_RELATIONSHIP_SET_LIMITS_MAX
Maximum number of power policy relationship set limits for DLPPC 2x controller.
- NVML_PERF_METRICS_CONTROLLER_SAMPLE_CONTROLLER_MAX_NUM
Maximum number of controllers that can be sampled.
- NVML_PERF_METRICS_CONTROLLER_STATUS_DLPPC_2X_DRAMCLK_NUM
Number of DRAMCLK frequencies tracked by DLPPC 2x controller status.
- NVML_PERF_METRICS_CONTROLLER_TYPE_DLPPC_2X
Controller type identifier for DLPPC 2x.
- NVML_PERF_METRICS_CONTROLLER_TYPE_PFPP_1X
Controller type identifier for PFPP 1x.
- NVML_PERF_METRICS_NNE_DESC_INFERENCE_LOOPS_MAX
Maximum number of NNE descriptor inference loops.
- NVML_PERF_METRICS_PWR_MODEL_DLPPM_1X_MAX_CORE_RAILS
Maximum number of core rails for DLPPM 1x power model.
- NVML_PERF_METRICS_PWR_MODEL_METRICS_DLPPM_1X_OBESRVED_INTIAL_DRAMCLK_ESTIMATES_MAX
Maximum number of initial DRAMCLK estimates for DLPPM 1x observed metrics.
- NVML_PERF_METRICS_PWR_MODEL_SCALE_LOOPS_MAX_PFPP_1X
Maximum number of power model scale loops for PFPP 1x.
- NVML_PERF_METRICS_PWR_MODEL_SCALE_METRICS_INPUT_MAX
Maximum number of power model scale metrics inputs.
- NVML_PERF_METRICS_PWR_MODEL_SCALE_METRICS_PFPP_1X_GPCCLK_IDX
Index for GPCCLK frequency in PFPP 1x scale metrics.
- NVML_PERF_METRICS_SAMPLE_COUNT
Total number of performance metrics samples that can be collected.
- NVML_TOPOLOGY_CPU
Topology level for node.
- NVML_VALUE_NOT_AVAILABLE
Special constant that some fields take when they are not available.
- nvmlC2cModeInfo_v1
Version macro for nvmlC2cModeInfo_v1_t .
- nvmlCoolerInfo_v1
Version macro for nvmlCoolerInfo_v1_t .
- nvmlDeviceAddressingMode_v1
Version macro for nvmlDeviceAddressingMode_v1_t .
- nvmlMemory_v2
Version macro for nvmlMemory_v2_t .
- nvmlPciInfoExt_v1
Version macro for nvmlPciInfoExt_v1_t .
- nvmlPdi_v1
Version macro for nvmlPdi_v1_t .
- nvmlProcessDetailList_v1
nvmlProcessDetailList version
- nvmlRepairStatus_v1
Version macro for nvmlRepairStatus_v1_t .
- nvmlUUID_v1
Version macro for nvmlUUID_v1_t .
Enumerations#
- nvmlBridgeChipType_t
Enum to represent type of bridge chip.
- nvmlCoolerControl_t
Cooler control type.
- nvmlCoolerTarget_t
Cooler's target.
- nvmlDeviceAddressingModeType_t
Enum to represent device addressing mode values.
- nvmlGpuP2PCapsIndex_t
- nvmlGpuP2PStatus_t
- nvmlGpuTopologyLevel_t
Represents level relationships within a system between two GPUs The enums are spaced to allow for future relationships.
- nvmlIntNvLinkDeviceType_t
Enum to represent NvLink's remote device type.
- nvmlNvLinkCapability_t
Enum to represent NvLink queryable capabilities.
- nvmlNvLinkErrorCounter_t
Enum to represent NvLink queryable error counters.
- nvmlNvLinkUtilizationCountPktTypes_t
Enum to represent the NvLink utilization counter packet types to count ** this is ONLY applicable with the units as packets or bytes ** as specified in nvmlNvLinkUtilizationCountUnits_t ** all packet filter descriptions are target GPU centric ** these can be "OR'd" together.
- nvmlNvLinkUtilizationCountUnits_t
Enum to represent the NvLink utilization counter packet units.
- nvmlPcieUtilCounter_t
Represents the queryable PCIe utilization counters.
- nvmlPerfPolicyType_t
Represents type of perf policy for which violation times can be queried.
- nvmlProcessMode_t
Enum to represent process mode.
- nvmlSamplingType_t
Represents Type of Sampling Event.
- nvmlThermalController_t
Represents the thermal sensor controllers.
- nvmlThermalTarget_t
Represents the thermal sensor targets.
- nvmlUUIDType_t
Enum to represent different UUID types.
- nvmlValueType_t
Represents the type for sample value returned.
Structs#
- nvmlBAR1Memory_t
BAR1 Memory allocation Information for a device.
- nvmlBBXTimeData_v1_t
BBX Time Data.
- nvmlBridgeChipHierarchy_t
This structure stores the complete Hierarchy of the Bridge Chip within the board.
- nvmlBridgeChipInfo_t
Information about the Bridge Chip Firmware.
- nvmlC2cModeInfo_v1_t
C2C Mode information for a device.
- nvmlCoolerInfo_v1_t
- nvmlCoreRailMetrics_t
Metrics for all core rails in the system.
- nvmlDeviceAddressingMode_v1_t
Struct to represent device addressing mode information.
- nvmlDeviceAttributes_t
- nvmlEccErrorCounts_t
Detailed ECC error counts for a device.
- nvmlGetMemoryLimits_v1_t
Describes the current memory limits that are set for the device.
- nvmlGpuThermalSettings_t
Struct to hold the thermal sensor settings.
- nvmlMemory_t
Memory allocation information for a device (v1).
- nvmlMemory_v2_t
Memory allocation information for a device (v2).
- nvmlNvLinkUtilizationControl_t
Struct to define the NVLINK counter controls.
- nvmlObservedMetrics_t
Observed metrics from the power model, including initial DRAMCLK estimates and current measurements.
- nvmlPciInfoExt_v1_t
PCI information about a GPU device.
- nvmlPciInfo_t
PCI information about a GPU device.
- nvmlPdi_v1_t
Struct to represent the NVML PDI information.
- nvmlPerfMetricControllerSample_t
Performance metrics sample from a controller, which can be either DLPPC 2x or PFPP 1x.
- nvmlPerfMetricsDlppc2xSample_t
Performance metrics sample for DLPPC 2x controller.
- nvmlPerfMetricsPfpp1xSample_t
Performance metrics sample for PFPP 1x controller.
- nvmlPerfMetricsSample_t
Single performance metrics sample containing data from one or more controllers.
- nvmlPerfMetricsSamples_v1_t
Collection of performance metrics samples (version 1).
- nvmlPmgrPwrTuple_t
Power tuple containing power consumption in milliwatts.
- nvmlProcessDetailList_v1_t
Information about all running processes on the GPU for the given mode.
- nvmlProcessDetail_v1_t
Information about running process on the GPU with protected memory.
- nvmlProcessInfo_t
Information about running compute processes on the GPU.
- nvmlProcessInfo_v1_t
Information about running compute processes on the GPU, legacy version for older versions of the API.
- nvmlPwrModelMetricsDlppm1xDramclkEstimates_t
DRAMCLK estimates containing multiple estimated metrics for different DRAMCLK frequencies.
- nvmlPwrModelMetricsDlppm1xPerf_t
Performance metrics for DLPPM 1x power model.
- nvmlPwrModelMetricsDlppm1x_t
Complete power model metrics for DLPPM 1x, including rail metrics and TGP power.
- nvmlPwrModelMetricsPfpp1x_t
Complete power model metrics for PFPP 1x, including estimated metrics and key operating points.
- nvmlPwrModelMetricsSamplePfpp1x_t
Power model metrics sample for PFPP 1x, containing frequency inputs and estimated TGP.
- nvmlPwrModelOperatingPointPfpp1x_t
Operating point for PFPP 1x power model, defining a frequency-power pair.
- nvmlRailMetrics_t
Metrics for a single power rail, including frequency and utilization.
- nvmlRepairStatus_v1_t
Struct to represent the NVML repair status.
- nvmlRowRemapperHistogramValues_t
Possible values that classify the remap availability for each bank.
- nvmlSample_t
Information for Sample.
- nvmlSetMemoryLimits_v1_t
Describes the memory limits that can be set for the device.
- nvmlUUID_v1_t
Struct to represent NVML UUID information.
- nvmlUnrepairableMemoryStatus_v1_t
Struct to represent the NVML unrepairable memory status.
- nvmlUtilization_t
Utilization information for a device.
- nvmlViolationTime_t
Struct to hold perf policy violation status data.
Typedefs#
Unions#
- nvmlUUIDValue_t
Union to represent different UUID values.
- nvmlValue_t
Union to represent different types of Value.
Macros#
-
NVML_DEVICE_MEMORY_LIMIT_MAX#
Value for “maximum” memory limit.
-
NVML_DEVICE_PCI_BUS_ID_BUFFER_SIZE#
Buffer size guaranteed to be large enough for pci bus id.
Buffer size for PCI bus ID.
-
NVML_DEVICE_PCI_BUS_ID_BUFFER_V2_SIZE#
Buffer size guaranteed to be large enough for pci bus id for
busIdLegacy.Buffer size for legacy PCI bus ID.
-
NVML_DEVICE_PCI_BUS_ID_FMT#
PCI format string for
busId.PCI bus ID format.
-
NVML_DEVICE_PCI_BUS_ID_FMT_ARGS(pciInfo)#
Utility macro for filling the pci bus id format from a nvmlPciInfo_t.
Macro for formatting PCI bus ID arguments.
-
NVML_DEVICE_PCI_BUS_ID_LEGACY_FMT#
PCI format string for
busIdLegacy.Legacy PCI bus ID format.
-
NVML_DEVICE_UUID_ASCII_LEN#
UUID length in ASCII format.
Length of UUID in ASCII format.
-
NVML_DEVICE_UUID_BINARY_LEN#
UUID length in binary format.
Length of UUID in binary format.
-
NVML_MAX_PHYSICAL_BRIDGE#
Maximum limit on Physical Bridges per Board.
Maximum number of physical bridges.
-
NVML_MAX_THERMAL_SENSORS_PER_GPU#
Maximum number of thermal sensors per GPU.
-
NVML_NVLINK_MAX_LINKS#
Maximum number of NvLink links supported.
Maximum number of NVLink links supported.
-
NVML_PERF_CF_PM_SENSOR_MAX_SIGNALS#
Maximum number of BA PM sensor signals.
-
NVML_PERF_METRICS_CONTROLLER_DLPPC_2X_PWR_POLICY_RELATIONSHIP_SET_LIMITS_MAX#
Maximum number of power policy relationship set limits for DLPPC 2x controller.
-
NVML_PERF_METRICS_CONTROLLER_SAMPLE_CONTROLLER_MAX_NUM#
Maximum number of controllers that can be sampled.
-
NVML_PERF_METRICS_CONTROLLER_STATUS_DLPPC_2X_DRAMCLK_NUM#
Number of DRAMCLK frequencies tracked by DLPPC 2x controller status.
-
NVML_PERF_METRICS_CONTROLLER_TYPE_DLPPC_2X#
Controller type identifier for DLPPC 2x.
-
NVML_PERF_METRICS_CONTROLLER_TYPE_PFPP_1X#
Controller type identifier for PFPP 1x.
-
NVML_PERF_METRICS_NNE_DESC_INFERENCE_LOOPS_MAX#
Maximum number of NNE descriptor inference loops.
-
NVML_PERF_METRICS_PWR_MODEL_DLPPM_1X_MAX_CORE_RAILS#
Maximum number of core rails for DLPPM 1x power model.
-
NVML_PERF_METRICS_PWR_MODEL_METRICS_DLPPM_1X_OBESRVED_INTIAL_DRAMCLK_ESTIMATES_MAX#
Maximum number of initial DRAMCLK estimates for DLPPM 1x observed metrics.
-
NVML_PERF_METRICS_PWR_MODEL_SCALE_LOOPS_MAX_PFPP_1X#
Maximum number of power model scale loops for PFPP 1x.
-
NVML_PERF_METRICS_PWR_MODEL_SCALE_METRICS_INPUT_MAX#
Maximum number of power model scale metrics inputs.
-
NVML_PERF_METRICS_PWR_MODEL_SCALE_METRICS_PFPP_1X_GPCCLK_IDX#
Index for GPCCLK frequency in PFPP 1x scale metrics.
-
NVML_PERF_METRICS_SAMPLE_COUNT#
Total number of performance metrics samples that can be collected.
-
NVML_TOPOLOGY_CPU#
Topology level for node.
-
NVML_VALUE_NOT_AVAILABLE#
Special constant that some fields take when they are not available.
Used when only part of the struct is not available.
Each structure explicitly states when to check for this value. Macro for unavailable values.
-
nvmlC2cModeInfo_v1#
Version macro for nvmlC2cModeInfo_v1_t.
-
nvmlCoolerInfo_v1#
Version macro for nvmlCoolerInfo_v1_t.
-
nvmlDeviceAddressingMode_v1#
Version macro for nvmlDeviceAddressingMode_v1_t.
-
nvmlMemory_v2#
Version macro for nvmlMemory_v2_t.
-
nvmlPciInfoExt_v1#
Version macro for nvmlPciInfoExt_v1_t.
-
nvmlPdi_v1#
Version macro for nvmlPdi_v1_t.
-
nvmlProcessDetailList_v1#
nvmlProcessDetailList version
Version macro for nvmlProcessDetailList_v1_t
-
nvmlRepairStatus_v1#
Version macro for nvmlRepairStatus_v1_t.
-
nvmlUUID_v1#
Version macro for nvmlUUID_v1_t.
Enumerations#
-
enum nvmlBridgeChipType_t#
Enum to represent type of bridge chip.
Values:
-
enumerator NVML_BRIDGE_CHIP_PLX#
-
enumerator NVML_BRIDGE_CHIP_BRO4#
-
enumerator NVML_BRIDGE_CHIP_PLX#
-
enum nvmlCoolerControl_t#
Cooler control type.
Values:
-
enumerator NVML_THERMAL_COOLER_SIGNAL_NONE#
This cooler has no control signal.
-
enumerator NVML_THERMAL_COOLER_SIGNAL_TOGGLE#
This cooler can only be toggled either ON or OFF (eg a switch).
-
enumerator NVML_THERMAL_COOLER_SIGNAL_VARIABLE#
This cooler’s level can be adjusted from some minimum to some maximum (eg a knob).
-
enumerator NVML_THERMAL_COOLER_SIGNAL_COUNT#
-
enumerator NVML_THERMAL_COOLER_SIGNAL_NONE#
-
enum nvmlCoolerTarget_t#
Cooler’s target.
Values:
-
enumerator NVML_THERMAL_COOLER_TARGET_NONE#
This cooler cools nothing.
-
enumerator NVML_THERMAL_COOLER_TARGET_GPU#
This cooler can cool the GPU.
-
enumerator NVML_THERMAL_COOLER_TARGET_MEMORY#
This cooler can cool the memory.
-
enumerator NVML_THERMAL_COOLER_TARGET_POWER_SUPPLY#
This cooler can cool the power supply.
-
enumerator NVML_THERMAL_COOLER_TARGET_GPU_RELATED#
This cooler cools all of the components related to its target gpu. GPU_RELATED = GPU | MEMORY | POWER_SUPPLY.
-
enumerator NVML_THERMAL_COOLER_TARGET_NONE#
-
enum nvmlDeviceAddressingModeType_t#
Enum to represent device addressing mode values.
Values:
-
enumerator NVML_DEVICE_ADDRESSING_MODE_NONE#
No active mode.
-
enumerator NVML_DEVICE_ADDRESSING_MODE_HMM#
Heterogeneous Memory Management mode.
-
enumerator NVML_DEVICE_ADDRESSING_MODE_ATS#
Address Translation Services mode.
-
enumerator NVML_DEVICE_ADDRESSING_MODE_NONE#
-
enum nvmlGpuP2PCapsIndex_t#
Values:
-
enumerator NVML_P2P_CAPS_INDEX_READ#
-
enumerator NVML_P2P_CAPS_INDEX_WRITE#
-
enumerator NVML_P2P_CAPS_INDEX_NVLINK#
-
enumerator NVML_P2P_CAPS_INDEX_ATOMICS#
-
enumerator NVML_P2P_CAPS_INDEX_PCI#
-
enumerator NVML_P2P_CAPS_INDEX_PROP#
-
enumerator NVML_P2P_CAPS_INDEX_UNKNOWN#
-
enumerator NVML_P2P_CAPS_INDEX_READ#
-
enum nvmlGpuP2PStatus_t#
Values:
-
enumerator NVML_P2P_STATUS_OK#
-
enumerator NVML_P2P_STATUS_CHIPSET_NOT_SUPPORED#
-
enumerator NVML_P2P_STATUS_CHIPSET_NOT_SUPPORTED#
-
enumerator NVML_P2P_STATUS_GPU_NOT_SUPPORTED#
-
enumerator NVML_P2P_STATUS_IOH_TOPOLOGY_NOT_SUPPORTED#
-
enumerator NVML_P2P_STATUS_DISABLED_BY_REGKEY#
-
enumerator NVML_P2P_STATUS_NOT_SUPPORTED#
-
enumerator NVML_P2P_STATUS_UNKNOWN#
-
enumerator NVML_P2P_STATUS_OK#
-
enum nvmlGpuTopologyLevel_t#
Represents level relationships within a system between two GPUs The enums are spaced to allow for future relationships.
Values:
-
enumerator NVML_TOPOLOGY_INTERNAL#
-
enumerator NVML_TOPOLOGY_SINGLE#
-
enumerator NVML_TOPOLOGY_MULTIPLE#
-
enumerator NVML_TOPOLOGY_HOSTBRIDGE#
-
enumerator NVML_TOPOLOGY_NODE#
-
enumerator NVML_TOPOLOGY_SYSTEM#
-
enumerator NVML_TOPOLOGY_INTERNAL#
-
enum nvmlIntNvLinkDeviceType_t#
Enum to represent NvLink’s remote device type.
Values:
-
enumerator NVML_NVLINK_DEVICE_TYPE_GPU#
-
enumerator NVML_NVLINK_DEVICE_TYPE_IBMNPU#
-
enumerator NVML_NVLINK_DEVICE_TYPE_SWITCH#
-
enumerator NVML_NVLINK_DEVICE_TYPE_UNKNOWN#
-
enumerator NVML_NVLINK_DEVICE_TYPE_GPU#
-
enum nvmlNvLinkCapability_t#
Enum to represent NvLink queryable capabilities.
Values:
-
enumerator NVML_NVLINK_CAP_P2P_SUPPORTED#
-
enumerator NVML_NVLINK_CAP_SYSMEM_ACCESS#
-
enumerator NVML_NVLINK_CAP_P2P_ATOMICS#
-
enumerator NVML_NVLINK_CAP_SYSMEM_ATOMICS#
-
enumerator NVML_NVLINK_CAP_SLI_BRIDGE#
-
enumerator NVML_NVLINK_CAP_VALID#
-
enumerator NVML_NVLINK_CAP_COUNT#
-
enumerator NVML_NVLINK_CAP_P2P_SUPPORTED#
-
enum nvmlNvLinkErrorCounter_t#
Enum to represent NvLink queryable error counters.
Values:
-
enumerator NVML_NVLINK_ERROR_DL_REPLAY#
-
enumerator NVML_NVLINK_ERROR_DL_RECOVERY#
-
enumerator NVML_NVLINK_ERROR_DL_CRC_FLIT#
-
enumerator NVML_NVLINK_ERROR_DL_CRC_DATA#
-
enumerator NVML_NVLINK_ERROR_DL_ECC_DATA#
-
enumerator NVML_NVLINK_ERROR_COUNT#
-
enumerator NVML_NVLINK_ERROR_DL_REPLAY#
-
enum nvmlNvLinkUtilizationCountPktTypes_t#
Enum to represent the NvLink utilization counter packet types to count ** this is ONLY applicable with the units as packets or bytes ** as specified in nvmlNvLinkUtilizationCountUnits_t ** all packet filter descriptions are target GPU centric ** these can be “OR’d” together.
Values:
-
enumerator NVML_NVLINK_COUNTER_PKTFILTER_NOP#
-
enumerator NVML_NVLINK_COUNTER_PKTFILTER_READ#
-
enumerator NVML_NVLINK_COUNTER_PKTFILTER_WRITE#
-
enumerator NVML_NVLINK_COUNTER_PKTFILTER_RATOM#
-
enumerator NVML_NVLINK_COUNTER_PKTFILTER_NRATOM#
-
enumerator NVML_NVLINK_COUNTER_PKTFILTER_FLUSH#
-
enumerator NVML_NVLINK_COUNTER_PKTFILTER_RESPDATA#
-
enumerator NVML_NVLINK_COUNTER_PKTFILTER_RESPNODATA#
-
enumerator NVML_NVLINK_COUNTER_PKTFILTER_ALL#
-
enumerator NVML_NVLINK_COUNTER_PKTFILTER_NOP#
-
enum nvmlNvLinkUtilizationCountUnits_t#
Enum to represent the NvLink utilization counter packet units.
Values:
-
enumerator NVML_NVLINK_COUNTER_UNIT_CYCLES#
-
enumerator NVML_NVLINK_COUNTER_UNIT_PACKETS#
-
enumerator NVML_NVLINK_COUNTER_UNIT_BYTES#
-
enumerator NVML_NVLINK_COUNTER_UNIT_RESERVED#
-
enumerator NVML_NVLINK_COUNTER_UNIT_COUNT#
-
enumerator NVML_NVLINK_COUNTER_UNIT_CYCLES#
-
enum nvmlPcieUtilCounter_t#
Represents the queryable PCIe utilization counters.
Values:
-
enumerator NVML_PCIE_UTIL_TX_BYTES#
-
enumerator NVML_PCIE_UTIL_RX_BYTES#
-
enumerator NVML_PCIE_UTIL_COUNT#
-
enumerator NVML_PCIE_UTIL_TX_BYTES#
-
enum nvmlPerfPolicyType_t#
Represents type of perf policy for which violation times can be queried.
Values:
-
enumerator NVML_PERF_POLICY_POWER#
How long did power violations cause the GPU to be below application clocks.
-
enumerator NVML_PERF_POLICY_THERMAL#
How long did thermal violations cause the GPU to be below application clocks.
-
enumerator NVML_PERF_POLICY_SYNC_BOOST#
How long did sync boost cause the GPU to be below application clocks.
-
enumerator NVML_PERF_POLICY_BOARD_LIMIT#
How long did the board limit cause the GPU to be below application clocks.
-
enumerator NVML_PERF_POLICY_LOW_UTILIZATION#
How long did low utilization cause the GPU to be below application clocks.
-
enumerator NVML_PERF_POLICY_RELIABILITY#
How long did the board reliability limit cause the GPU to be below application clocks.
-
enumerator NVML_PERF_POLICY_TOTAL_APP_CLOCKS#
Total time the GPU was held below application clocks by any limiter (0 - 5 above)
-
enumerator NVML_PERF_POLICY_TOTAL_BASE_CLOCKS#
Total time the GPU was held below base clocks.
-
enumerator NVML_PERF_POLICY_COUNT#
-
enumerator NVML_PERF_POLICY_POWER#
-
enum nvmlProcessMode_t#
Enum to represent process mode.
Values:
-
enumerator NVML_PROCESS_MODE_COMPUTE#
Processes with a compute context.
-
enumerator NVML_PROCESS_MODE_GRAPHICS#
Processes with a graphics context.
-
enumerator NVML_PROCESS_MODE_MPS#
Processes with a MPS (Multi-Process Service) compute context.
-
enumerator NVML_PROCESS_MODE_ALL#
All processes running on the GPU (compute, graphics, MPS, and other types)
-
enumerator NVML_PROCESS_MODE_MAX#
Maximum value for bounds checking.
-
enumerator NVML_PROCESS_MODE_COMPUTE#
-
enum nvmlSamplingType_t#
Represents Type of Sampling Event.
Values:
-
enumerator NVML_TOTAL_POWER_SAMPLES#
To represent total power drawn by GPU.
-
enumerator NVML_GPU_UTILIZATION_SAMPLES#
To represent percent of time during which one or more kernels was executing on the GPU.
-
enumerator NVML_MEMORY_UTILIZATION_SAMPLES#
To represent percent of time during which global (device) memory was being read or written.
-
enumerator NVML_ENC_UTILIZATION_SAMPLES#
To represent percent of time during which NVENC remains busy.
-
enumerator NVML_DEC_UTILIZATION_SAMPLES#
To represent percent of time during which NVDEC remains busy.
-
enumerator NVML_PROCESSOR_CLK_SAMPLES#
To represent processor clock samples.
-
enumerator NVML_MEMORY_CLK_SAMPLES#
To represent memory clock samples.
-
enumerator NVML_MODULE_POWER_SAMPLES#
To represent module power samples for total module starting Grace Hopper.
-
enumerator NVML_JPG_UTILIZATION_SAMPLES#
To represent percent of time during which NVJPG remains busy.
-
enumerator NVML_OFA_UTILIZATION_SAMPLES#
To represent percent of time during which NVOFA remains busy.
-
enumerator NVML_SAMPLINGTYPE_COUNT#
-
enumerator NVML_TOTAL_POWER_SAMPLES#
-
enum nvmlThermalController_t#
Represents the thermal sensor controllers.
Values:
-
enumerator NVML_THERMAL_CONTROLLER_NONE#
-
enumerator NVML_THERMAL_CONTROLLER_GPU_INTERNAL#
-
enumerator NVML_THERMAL_CONTROLLER_ADM1032#
-
enumerator NVML_THERMAL_CONTROLLER_ADT7461#
-
enumerator NVML_THERMAL_CONTROLLER_MAX6649#
-
enumerator NVML_THERMAL_CONTROLLER_MAX1617#
-
enumerator NVML_THERMAL_CONTROLLER_LM99#
-
enumerator NVML_THERMAL_CONTROLLER_LM89#
-
enumerator NVML_THERMAL_CONTROLLER_LM64#
-
enumerator NVML_THERMAL_CONTROLLER_G781#
-
enumerator NVML_THERMAL_CONTROLLER_ADT7473#
-
enumerator NVML_THERMAL_CONTROLLER_SBMAX6649#
-
enumerator NVML_THERMAL_CONTROLLER_VBIOSEVT#
-
enumerator NVML_THERMAL_CONTROLLER_OS#
-
enumerator NVML_THERMAL_CONTROLLER_NVSYSCON_CANOAS#
-
enumerator NVML_THERMAL_CONTROLLER_NVSYSCON_E551#
-
enumerator NVML_THERMAL_CONTROLLER_MAX6649R#
-
enumerator NVML_THERMAL_CONTROLLER_ADT7473S#
-
enumerator NVML_THERMAL_CONTROLLER_UNKNOWN#
-
enumerator NVML_THERMAL_CONTROLLER_NONE#
-
enum nvmlThermalTarget_t#
Represents the thermal sensor targets.
Values:
-
enumerator NVML_THERMAL_TARGET_NONE#
-
enumerator NVML_THERMAL_TARGET_GPU#
GPU core temperature requires NvPhysicalGpuHandle.
-
enumerator NVML_THERMAL_TARGET_MEMORY#
GPU memory temperature requires NvPhysicalGpuHandle.
-
enumerator NVML_THERMAL_TARGET_POWER_SUPPLY#
GPU power supply temperature requires NvPhysicalGpuHandle.
-
enumerator NVML_THERMAL_TARGET_BOARD#
GPU board ambient temperature requires NvPhysicalGpuHandle.
-
enumerator NVML_THERMAL_TARGET_VCD_BOARD#
Visual Computing Device Board temperature requires NvVisualComputingDeviceHandle.
-
enumerator NVML_THERMAL_TARGET_VCD_INLET#
Visual Computing Device Inlet temperature requires NvVisualComputingDeviceHandle.
-
enumerator NVML_THERMAL_TARGET_VCD_OUTLET#
Visual Computing Device Outlet temperature requires NvVisualComputingDeviceHandle.
-
enumerator NVML_THERMAL_TARGET_ALL#
-
enumerator NVML_THERMAL_TARGET_UNKNOWN#
-
enumerator NVML_THERMAL_TARGET_NONE#
-
enum nvmlUUIDType_t#
Enum to represent different UUID types.
Values:
-
enumerator NVML_UUID_TYPE_NONE#
Undefined type.
-
enumerator NVML_UUID_TYPE_ASCII#
ASCII format type.
-
enumerator NVML_UUID_TYPE_BINARY#
Binary format type.
-
enumerator NVML_UUID_TYPE_NONE#
-
enum nvmlValueType_t#
Represents the type for sample value returned.
Values:
-
enumerator NVML_VALUE_TYPE_DOUBLE#
-
enumerator NVML_VALUE_TYPE_UNSIGNED_INT#
-
enumerator NVML_VALUE_TYPE_UNSIGNED_LONG#
-
enumerator NVML_VALUE_TYPE_UNSIGNED_LONG_LONG#
-
enumerator NVML_VALUE_TYPE_SIGNED_LONG_LONG#
-
enumerator NVML_VALUE_TYPE_SIGNED_INT#
-
enumerator NVML_VALUE_TYPE_UNSIGNED_SHORT#
-
enumerator NVML_VALUE_TYPE_COUNT#
-
enumerator NVML_VALUE_TYPE_DOUBLE#
Typedefs#
-
typedef nvmlCoolerInfo_v1_t nvmlCoolerInfo_t#
-
typedef nvmlDeviceAddressingMode_v1_t nvmlDeviceAddressingMode_t#
-
typedef struct nvmlDevice_st *nvmlDevice_t#
-
typedef struct nvmlGpuInstance_st *nvmlGpuInstance_t#
-
typedef nvmlPciInfoExt_v1_t nvmlPciInfoExt_t#
-
typedef nvmlPdi_v1_t nvmlPdi_t#
-
typedef nvmlProcessDetailList_v1_t nvmlProcessDetailList_t#
-
typedef nvmlRepairStatus_v1_t nvmlRepairStatus_t#
-
typedef nvmlUUID_v1_t nvmlUUID_t#