|
|
Data Structures
unsigned int
nvmlComputeInstanceProfileInfo_v2_t::sharedOfaCount
Shared OFA Engine count.
char nvmlComputeInstanceProfileInfo_v2_t::name
Profile name.
5.12. nvmlComputeInstanceProfileInfo_v3_t Struct
Reference
Compute instance profile information (v3).
Version 3 adds the nvmlComputeInstanceProfileInfo_v3_t::capabilities field
nvmlComputeInstanceProfileInfo_t.
412
Data Structures
unsigned int
nvmlComputeInstanceProfileInfo_v3_t::version
Structure version identifier (set to nvmlComputeInstanceProfileInfo_v3).
unsigned int nvmlComputeInstanceProfileInfo_v3_t::id
Unique profile ID within the GPU instance.
unsigned int
nvmlComputeInstanceProfileInfo_v3_t::sliceCount
GPU Slice count.
unsigned int
nvmlComputeInstanceProfileInfo_v3_t::instanceCount
Compute instance count.
unsigned int
nvmlComputeInstanceProfileInfo_v3_t::multiprocessorCount
Streaming Multiprocessor count.
unsigned int
nvmlComputeInstanceProfileInfo_v3_t::sharedCopyEngineCount
Shared Copy Engine count.
unsigned int
nvmlComputeInstanceProfileInfo_v3_t::sharedDecoderCount
Shared Decoder Engine count.
unsigned int
nvmlComputeInstanceProfileInfo_v3_t::sharedEncoderCount
Shared Encoder Engine count.
unsigned int
nvmlComputeInstanceProfileInfo_v3_t::sharedJpegCount
Shared JPEG Engine count.
413
Data Structures
unsigned int
nvmlComputeInstanceProfileInfo_v3_t::sharedOfaCount
Shared OFA Engine count.
char nvmlComputeInstanceProfileInfo_v3_t::name
Profile name.
unsigned int
nvmlComputeInstanceProfileInfo_v3_t::capabilities
Additional capabilities.
5.13. nvmlConfComputeMemSizeInfo_t Struct
Reference
Protected memory size
5.14. nvmlDeviceCapabilities_v1_t Struct
Reference
Device capabilities
unsigned int nvmlDeviceCapabilities_v1_t::version
the API version number
unsigned int nvmlDeviceCapabilities_v1_t::capMask
OUT: Bit mask of capabilities.
5.15. nvmlDeviceCurrentClockFreqs_v1_t Struct
Reference
Device current clocks string
414
Data Structures
unsigned int
nvmlDeviceCurrentClockFreqs_v1_t::version
the API version number
char nvmlDeviceCurrentClockFreqs_v1_t::str
OUT: the current clock frequency string.
5.16. nvmlDevicePerfModes_v1_t Struct Reference
Device performance modes string
unsigned int nvmlDevicePerfModes_v1_t::version
the API version number
char nvmlDevicePerfModes_v1_t::str
OUT: the performance modes string.
5.17. nvmlDramEncryptionInfo_v1_t Struct
Reference
DRAM Encryption Info
unsigned int nvmlDramEncryptionInfo_v1_t::version
IN - the API version number.
nvmlEnableState_t
nvmlDramEncryptionInfo_v1_t::encryptionState
IN/OUT - DRAM Encryption state.
5.18. nvmlEccErrorCounts_t Struct Reference
Detailed ECC error counts for a device.
Deprecated Different GPU families can have different memory error counters See
nvmlDeviceGetMemoryErrorCounter
415
Data Structures
unsigned long long nvmlEccErrorCounts_t::l1Cache
L1 cache errors.
unsigned long long nvmlEccErrorCounts_t::l2Cache
L2 cache errors.
unsigned long long
nvmlEccErrorCounts_t::deviceMemory
Device memory errors.
unsigned long long nvmlEccErrorCounts_t::registerFile
Register file errors.
5.19. nvmlEccSramErrorStatus_v1_t Struct
Reference
Structure to store SRAM uncorrectable error counters
416
Data Structures
unsigned int nvmlEccSramErrorStatus_v1_t::version
the API version number
unsigned long long
nvmlEccSramErrorStatus_v1_t::aggregateUncParity
aggregate uncorrectable parity error count
unsigned long long
nvmlEccSramErrorStatus_v1_t::aggregateUncSecDed
aggregate uncorrectable SEC-DED error count
unsigned long long
nvmlEccSramErrorStatus_v1_t::aggregateCor
aggregate correctable error count
unsigned long long
nvmlEccSramErrorStatus_v1_t::volatileUncParity
volatile uncorrectable parity error count
unsigned long long
nvmlEccSramErrorStatus_v1_t::volatileUncSecDed
volatile uncorrectable SEC-DED error count
unsigned long long
nvmlEccSramErrorStatus_v1_t::volatileCor
volatile correctable error count
unsigned long long
nvmlEccSramErrorStatus_v1_t::aggregateUncBucketL2
aggregate uncorrectable error count for L2 cache bucket
unsigned long long
nvmlEccSramErrorStatus_v1_t::aggregateUncBucketSm
aggregate uncorrectable error count for SM bucket
417
Data Structures
unsigned long long
nvmlEccSramErrorStatus_v1_t::aggregateUncBucketPcie
aggregate uncorrectable error count for PCIE bucket
unsigned long long
nvmlEccSramErrorStatus_v1_t::aggregateUncBucketMcu
aggregate uncorrectable error count for Microcontroller bucket
unsigned long long
nvmlEccSramErrorStatus_v1_t::aggregateUncBucketOther
aggregate uncorrectable error count for Other bucket
unsigned int
nvmlEccSramErrorStatus_v1_t::bThresholdExceeded
if the error threshold of field diag is exceeded
5.20. nvmlEncoderSessionInfo_t Struct Reference
Structure to hold encoder session data
418
Data Structures
unsigned int nvmlEncoderSessionInfo_t::sessionId
Unique session ID.
unsigned int nvmlEncoderSessionInfo_t::pid
Owning process ID.
nvmlVgpuInstance_t
nvmlEncoderSessionInfo_t::vgpuInstance
Owning vGPU instance ID (only valid on vGPU hosts, otherwise zero).
nvmlEncoderType_t
nvmlEncoderSessionInfo_t::codecType
Video encoder type.
unsigned int nvmlEncoderSessionInfo_t::hResolution
Current encode horizontal resolution.
unsigned int nvmlEncoderSessionInfo_t::vResolution
Current encode vertical resolution.
unsigned int nvmlEncoderSessionInfo_t::averageFps
Moving average encode frames per second.
unsigned int nvmlEncoderSessionInfo_t::averageLatency
Moving average encode latency in microseconds.
5.21. nvmlEventData_t Struct Reference
Information about occurred event
419
Data Structures
nvmlDevice_t nvmlEventData_t::device
Specific device where the event occurred.
unsigned long long nvmlEventData_t::eventType
Information about what specific event occurred.
unsigned long long nvmlEventData_t::eventData
Stores Xid error for the device in the event of nvmlEventTypeXidCriticalError,.
unsigned int nvmlEventData_t::gpuInstanceId
If MIG is enabled and nvmlEventTypeXidCriticalError event is attributable to a GPU.
unsigned int nvmlEventData_t::computeInstanceId
If MIG is enabled and nvmlEventTypeXidCriticalError event is attributable to a.
5.22. nvmlExcludedDeviceInfo_t Struct Reference
Excluded GPU device information
struct nvmlPciInfo_t nvmlExcludedDeviceInfo_t::pciInfo
The PCI information for the excluded GPU.
char nvmlExcludedDeviceInfo_t::uuid
The ASCII string UUID for the excluded GPU.
5.23. nvmlFanSpeedInfo_v1_t Struct Reference
Fan speed info.
420
Data Structures
unsigned int nvmlFanSpeedInfo_v1_t::version
the API version number
unsigned int nvmlFanSpeedInfo_v1_t::fan
the fan index
unsigned int nvmlFanSpeedInfo_v1_t::speed
OUT: the fan speed in RPM.
5.24. nvmlFBCSessionInfo_t Struct Reference
Structure to hold FBC session data
421
Data Structures
unsigned int nvmlFBCSessionInfo_t::sessionId
Unique session ID.
unsigned int nvmlFBCSessionInfo_t::pid
Owning process ID.
nvmlVgpuInstance_t
nvmlFBCSessionInfo_t::vgpuInstance
Owning vGPU instance ID (only valid on vGPU hosts, otherwise zero).
unsigned int nvmlFBCSessionInfo_t::displayOrdinal
Display identifier.
nvmlFBCSessionType_t
nvmlFBCSessionInfo_t::sessionType
Type of frame buffer capture session.
unsigned int nvmlFBCSessionInfo_t::sessionFlags
Session flags (one or more of NVML_NVFBC_SESSION_FLAG_XXX).
unsigned int nvmlFBCSessionInfo_t::hMaxResolution
Max horizontal resolution supported by the capture session.
unsigned int nvmlFBCSessionInfo_t::vMaxResolution
Max vertical resolution supported by the capture session.
unsigned int nvmlFBCSessionInfo_t::hResolution
Horizontal resolution requested by caller in capture call.
unsigned int nvmlFBCSessionInfo_t::vResolution
Vertical resolution requested by caller in capture call.
unsigned int nvmlFBCSessionInfo_t::averageFPS
Moving average new frames captured per second.
unsigned int nvmlFBCSessionInfo_t::averageLatency
Moving average new frame capture latency in microseconds.
422
Data Structures
5.25. nvmlFBCStats_t Struct Reference
Structure to hold frame buffer capture sessions stats
unsigned int nvmlFBCStats_t::sessionsCount
Total no of sessions.
unsigned int nvmlFBCStats_t::averageFPS
Moving average new frames captured per second.
unsigned int nvmlFBCStats_t::averageLatency
Moving average new frame capture latency in microseconds.
5.26. nvmlFieldValue_t Struct Reference
Information for a Field Value Sample
423
Data Structures
unsigned int nvmlFieldValue_t::fieldId
ID of the NVML field to retrieve. This must be set before any call that uses this struct.
See the constants starting with NVML_FI_ above.
unsigned int nvmlFieldValue_t::scopeId
Scope ID can represent data used by NVML depending on fieldId's context. For
example, for NVLink throughput counter data, scopeId can represent linkId.
long long nvmlFieldValue_t::timestamp
CPU Timestamp of this value in microseconds since 1970.
long long nvmlFieldValue_t::latencyUsec
How long this field value took to update (in usec) within NVML. This may be averaged
across several fields that are serviced by the same driver call.
nvmlValueType_t nvmlFieldValue_t::valueType
Type of the value stored in value.
nvmlReturn_t nvmlFieldValue_t::nvmlReturn
Return code for retrieving this value. This must be checked before looking at value, as
value is undefined if nvmlReturn != NVML_SUCCESS.
nvmlFieldValue_t::value
Value for this field. This is only valid if nvmlReturn == NVML_SUCCESS.
5.27. nvmlGpmMetric_t Struct Reference
GPM metric information.
424
Data Structures
unsigned int nvmlGpmMetric_t::metricId
IN: NVML_GPM_METRIC_? define of which metric to retrieve.
nvmlReturn_t nvmlGpmMetric_t::nvmlReturn
OUT: Status of this metric. If this is nonzero, then value is not valid.
double nvmlGpmMetric_t::value
OUT: Value of this metric. Is only valid if nvmlReturn is 0 (NVML_SUCCESS).
nvmlGpmMetric_t::@6 nvmlGpmMetric_t::metricInfo
OUT: Metric name and unit. Those can be NULL if not defined.
5.28. nvmlGpmMetricsGet_t Struct Reference
GPM buffer information.
unsigned int nvmlGpmMetricsGet_t::version
IN: Set to NVML_GPM_METRICS_GET_VERSION.
unsigned int nvmlGpmMetricsGet_t::numMetrics
IN: How many metrics to retrieve in metrics[].
nvmlGpmSample_t nvmlGpmMetricsGet_t::sample1
IN: Sample buffer.
nvmlGpmSample_t nvmlGpmMetricsGet_t::sample2
IN: Sample buffer.
struct nvmlGpmMetric_t nvmlGpmMetricsGet_t::metrics
IN/OUT: Array of metrics. Set metricId on call. See nvmlReturn and value on return.
5.29. nvmlGpmSupport_t Struct Reference
GPM device information.
425
Data Structures
unsigned int nvmlGpmSupport_t::version
IN: Set to NVML_GPM_SUPPORT_VERSION.
unsigned int nvmlGpmSupport_t::isSupportedDevice
OUT: Indicates device support.
5.30. nvmlGpuFabricInfo_t Struct Reference
Contains the device fabric information
unsigned char nvmlGpuFabricInfo_t::clusterUuid
Uuid of the cluster to which this GPU belongs.
nvmlReturn_t nvmlGpuFabricInfo_t::status
Error status, if any. Must be checked only if state returns "complete".
unsigned int nvmlGpuFabricInfo_t::cliqueId
ID of the fabric clique to which this GPU belongs.
nvmlGpuFabricState_t nvmlGpuFabricInfo_t::state
Current state of GPU registration process.
5.31. nvmlGpuFabricInfo_v2_t Struct Reference
GPU Fabric information (v2).
Version 2 adds the nvmlGpuFabricInfo_v2_t::version field to the start of the structure,
and the nvmlGpuFabricInfo_v2_t::healthMask field to the end. This structure is not
backwards-compatible with nvmlGpuFabricInfo_t.
426
Data Structures
unsigned int nvmlGpuFabricInfo_v2_t::version
Structure version identifier (set to nvmlGpuFabricInfo_v2).
unsigned char nvmlGpuFabricInfo_v2_t::clusterUuid
Uuid of the cluster to which this GPU belongs.
nvmlReturn_t nvmlGpuFabricInfo_v2_t::status
Error status, if any. Must be checked only if state returns "complete".
unsigned int nvmlGpuFabricInfo_v2_t::cliqueId
ID of the fabric clique to which this GPU belongs.
nvmlGpuFabricState_t nvmlGpuFabricInfo_v2_t::state
Current state of GPU registration process.
unsigned int nvmlGpuFabricInfo_v2_t::healthMask
GPU Fabric health Status Mask.
5.32. nvmlGpuInstanceProfileInfo_t Struct
Reference
GPU instance profile information.
427
Data Structures
unsigned int nvmlGpuInstanceProfileInfo_t::id
Unique profile ID within the device.
unsigned int
nvmlGpuInstanceProfileInfo_t::isP2pSupported
Peer-to-Peer support.
unsigned int nvmlGpuInstanceProfileInfo_t::sliceCount
GPU Slice count.
unsigned int
nvmlGpuInstanceProfileInfo_t::instanceCount
GPU instance count.
unsigned int
nvmlGpuInstanceProfileInfo_t::multiprocessorCount
Streaming Multiprocessor count.
unsigned int
nvmlGpuInstanceProfileInfo_t::copyEngineCount
Copy Engine count.
unsigned int
nvmlGpuInstanceProfileInfo_t::decoderCount
Decoder Engine count.
unsigned int
nvmlGpuInstanceProfileInfo_t::encoderCount
Encoder Engine count.
unsigned int nvmlGpuInstanceProfileInfo_t::jpegCount
JPEG Engine count.
unsigned int nvmlGpuInstanceProfileInfo_t::ofaCount
OFA Engine count.
428
Data Structures
unsigned long long
nvmlGpuInstanceProfileInfo_t::memorySizeMB
Memory size in MBytes.
5.33. nvmlGpuInstanceProfileInfo_v2_t Struct
Reference
GPU instance profile information (v2).
Version 2 adds the nvmlGpuInstanceProfileInfo_v2_t::version field to the start of
the structure, and the nvmlGpuInstanceProfileInfo_v2_t::name field to the end. This
structure is not backwards-compatible with nvmlGpuInstanceProfileInfo_t.
429
Data Structures
unsigned int nvmlGpuInstanceProfileInfo_v2_t::version
Structure version identifier (set to nvmlGpuInstanceProfileInfo_v2).
unsigned int nvmlGpuInstanceProfileInfo_v2_t::id
Unique profile ID within the device.
unsigned int
nvmlGpuInstanceProfileInfo_v2_t::isP2pSupported
Peer-to-Peer support.
unsigned int
nvmlGpuInstanceProfileInfo_v2_t::sliceCount
GPU Slice count.
unsigned int
nvmlGpuInstanceProfileInfo_v2_t::instanceCount
GPU instance count.
unsigned int
nvmlGpuInstanceProfileInfo_v2_t::multiprocessorCount
Streaming Multiprocessor count.
unsigned int
nvmlGpuInstanceProfileInfo_v2_t::copyEngineCount
Copy Engine count.
unsigned int
nvmlGpuInstanceProfileInfo_v2_t::decoderCount
Decoder Engine count.
unsigned int
nvmlGpuInstanceProfileInfo_v2_t::encoderCount
Encoder Engine count.
unsigned int
nvmlGpuInstanceProfileInfo_v2_t::jpegCount
JPEG Engine count.
430
Data Structures
unsigned int nvmlGpuInstanceProfileInfo_v2_t::ofaCount
OFA Engine count.
unsigned long long
nvmlGpuInstanceProfileInfo_v2_t::memorySizeMB
Memory size in MBytes.
char nvmlGpuInstanceProfileInfo_v2_t::name
Profile name.
5.34. nvmlGpuInstanceProfileInfo_v3_t Struct
Reference
GPU instance profile information (v3).
Version 3 removes isP2pSupported field and adds the
nvmlGpuInstanceProfileInfo_v3_t::capabilities field nvmlGpuInstanceProfileInfo_t.
431
Data Structures
unsigned int nvmlGpuInstanceProfileInfo_v3_t::version
Structure version identifier (set to nvmlGpuInstanceProfileInfo_v3).
unsigned int nvmlGpuInstanceProfileInfo_v3_t::id
Unique profile ID within the device.
unsigned int
nvmlGpuInstanceProfileInfo_v3_t::sliceCount
GPU Slice count.
unsigned int
nvmlGpuInstanceProfileInfo_v3_t::instanceCount
GPU instance count.
unsigned int
nvmlGpuInstanceProfileInfo_v3_t::multiprocessorCount
Streaming Multiprocessor count.
unsigned int
nvmlGpuInstanceProfileInfo_v3_t::copyEngineCount
Copy Engine count.
unsigned int
nvmlGpuInstanceProfileInfo_v3_t::decoderCount
Decoder Engine count.
unsigned int
nvmlGpuInstanceProfileInfo_v3_t::encoderCount
Encoder Engine count.
unsigned int
nvmlGpuInstanceProfileInfo_v3_t::jpegCount
JPEG Engine count.
unsigned int nvmlGpuInstanceProfileInfo_v3_t::ofaCount
OFA Engine count.
432
Data Structures
unsigned long long
nvmlGpuInstanceProfileInfo_v3_t::memorySizeMB
Memory size in MBytes.
char nvmlGpuInstanceProfileInfo_v3_t::name
Profile name.
unsigned int
nvmlGpuInstanceProfileInfo_v3_t::capabilities
Additional capabilities.
5.35. nvmlGpuThermalSettings_t Struct Reference
Struct to hold the thermal sensor settings
5.36. nvmlGridLicensableFeature_t Struct
Reference
Structure containing vGPU software licensable feature information
433
Data Structures
nvmlGridLicenseFeatureCode_t
nvmlGridLicensableFeature_t::featureCode
Licensed feature code.
unsigned int nvmlGridLicensableFeature_t::featureState
Non-zero if feature is currently licensed, otherwise zero.
char nvmlGridLicensableFeature_t::licenseInfo
Deprecated.
char nvmlGridLicensableFeature_t::productName
Product name of feature.
unsigned int
nvmlGridLicensableFeature_t::featureEnabled
Non-zero if feature is enabled, otherwise zero.
struct nvmlGridLicenseExpiry_t
nvmlGridLicensableFeature_t::licenseExpiry
License expiry structure containing date and time.
5.37. nvmlGridLicensableFeatures_t Struct
Reference
Structure to store vGPU software licensable features
434
Data Structures
int
nvmlGridLicensableFeatures_t::isGridLicenseSupported
Non-zero if vGPU Software Licensing is supported on the system, otherwise zero.
unsigned int
nvmlGridLicensableFeatures_t::licensableFeaturesCount
Entries returned in gridLicensableFeatures array.
struct nvmlGridLicensableFeature_t
nvmlGridLicensableFeatures_t::gridLicensableFeatures
Array of vGPU software licensable features.
5.38. nvmlGridLicenseExpiry_t Struct Reference
Structure to store license expiry date and time values
435
Data Structures
unsigned int nvmlGridLicenseExpiry_t::year
Year value of license expiry.
unsigned short nvmlGridLicenseExpiry_t::month
Month value of license expiry.
unsigned short nvmlGridLicenseExpiry_t::day
Day value of license expiry.
unsigned short nvmlGridLicenseExpiry_t::hour
Hour value of license expiry.
unsigned short nvmlGridLicenseExpiry_t::min
Minutes value of license expiry.
unsigned short nvmlGridLicenseExpiry_t::sec
Seconds value of license expiry.
unsigned char nvmlGridLicenseExpiry_t::status
License expiry status.
5.39. nvmlHwbcEntry_t Struct Reference
Description of HWBC entry
5.40. nvmlLedState_t Struct Reference
LED states for an S-class unit.
436
Data Structures
char nvmlLedState_t::cause
If amber, a text description of the cause.
nvmlLedColor_t nvmlLedState_t::color
GREEN or AMBER.
5.41. nvmlMarginTemperature_v1_t Struct
Reference
Margin temperature values
unsigned int nvmlMarginTemperature_v1_t::version
The version number of this struct.
int nvmlMarginTemperature_v1_t::marginTemperature
The margin temperature value.
5.42. nvmlMemory_t Struct Reference
Memory allocation information for a device (v1). The total amount is equal to the sum of
the amounts of free and used memory.
unsigned long long nvmlMemory_t::total
Total physical device memory (in bytes).
unsigned long long nvmlMemory_t::free
Unallocated device memory (in bytes).
unsigned long long nvmlMemory_t::used
Description
Sum of Reserved and Allocated device memory (in bytes). Note that the driver/GPU
always sets aside a small amount of memory for bookkeeping
5.43. nvmlMemory_v2_t Struct Reference
Memory allocation information for a device (v2).
437
Data Structures
Version 2 adds versioning for the struct and the amount of system-reserved memory as
an output.
unsigned int nvmlMemory_v2_t::version
Structure format version (must be 2).
unsigned long long nvmlMemory_v2_t::total
Total physical device memory (in bytes).
unsigned long long nvmlMemory_v2_t::reserved
Device memory (in bytes) reserved for system use (driver or firmware).
unsigned long long nvmlMemory_v2_t::free
Unallocated device memory (in bytes).
unsigned long long nvmlMemory_v2_t::used
Allocated device memory (in bytes).
5.44. nvmlNvLinkUtilizationControl_t Struct
Reference
Struct to define the NVLINK counter controls
5.45. nvmlPciInfo_t Struct Reference
PCI information about a GPU device.
438
Data Structures
char nvmlPciInfo_t::busIdLegacy
The legacy tuple domain:bus:device.function PCI identifier (& NULL terminator).
unsigned int nvmlPciInfo_t::domain
The PCI domain on which the device's bus resides, 0 to 0xffffffff.
unsigned int nvmlPciInfo_t::bus
The bus on which the device resides, 0 to 0xff.
unsigned int nvmlPciInfo_t::device
The device's id on the bus, 0 to 31.
unsigned int nvmlPciInfo_t::pciDeviceId
The combined 16-bit device id and 16-bit vendor id.
unsigned int nvmlPciInfo_t::pciSubSystemId
The 32-bit Sub System Device ID.
char nvmlPciInfo_t::busId
The tuple domain:bus:device.function PCI identifier (& NULL terminator).
5.46. nvmlPciInfoExt_v1_t Struct Reference
PCI information about a GPU device.
439
Data Structures
unsigned int nvmlPciInfoExt_v1_t::version
The version number of this struct.
unsigned int nvmlPciInfoExt_v1_t::domain
The PCI domain on which the device's bus resides, 0 to 0xffffffff.
unsigned int nvmlPciInfoExt_v1_t::bus
The bus on which the device resides, 0 to 0xff.
unsigned int nvmlPciInfoExt_v1_t::device
The device's id on the bus, 0 to 31.
unsigned int nvmlPciInfoExt_v1_t::pciDeviceId
The combined 16-bit device id and 16-bit vendor id.
unsigned int nvmlPciInfoExt_v1_t::pciSubSystemId
The 32-bit Sub System Device ID.
unsigned int nvmlPciInfoExt_v1_t::baseClass
The 8-bit PCI base class code.
unsigned int nvmlPciInfoExt_v1_t::subClass
The 8-bit PCI sub class code.
char nvmlPciInfoExt_v1_t::busId
The tuple domain:bus:device.function PCI identifier (& NULL terminator).
5.47. nvmlPlatformInfo_v1_t Struct Reference
Structure to store platform information
Deprecated The nvmlPlatformInfo_v1_t will be deprecated in the subsequent releases.
Use nvmlPlatformInfo_v2_t
440
Data Structures
unsigned int nvmlPlatformInfo_v1_t::version
the API version number
unsigned char nvmlPlatformInfo_v1_t::ibGuid
Infiniband GUID reported by platform (for Blackwell, ibGuid is 8 bytes so indices 8-15
are zero).
unsigned char nvmlPlatformInfo_v1_t::rackGuid
GUID of the rack containing this GPU (for Blackwell rackGuid is 13 bytes so indices
13-15 are zero).
unsigned char
nvmlPlatformInfo_v1_t::chassisPhysicalSlotNumber
The slot number in the rack containing this GPU (includes switches).
unsigned char
nvmlPlatformInfo_v1_t::computeSlotIndex
The index within the compute slots in the rack containing this GPU (does not include
switches).
unsigned char nvmlPlatformInfo_v1_t::nodeIndex
Index of the node within the slot containing this GPU.
unsigned char nvmlPlatformInfo_v1_t::peerType
Platform indicated NVLink-peer type (e.g. switch present or not).
unsigned char nvmlPlatformInfo_v1_t::moduleId
ID of this GPU within the node.
5.48. nvmlPlatformInfo_v2_t Struct Reference
Structure to store platform information (v2)
441
Data Structures
unsigned int nvmlPlatformInfo_v2_t::version
the API version number
unsigned char nvmlPlatformInfo_v2_t::ibGuid
Infiniband GUID reported by platform (for Blackwell, ibGuid is 8 bytes so indices 8-15
are zero).
unsigned char
nvmlPlatformInfo_v2_t::chassisSerialNumber
Serial number of the chassis containing this GPU (for Blackwell it is 13 bytes so indices
13-15 are zero).
unsigned char nvmlPlatformInfo_v2_t::slotNumber
The slot number in the chassis containing this GPU (includes switches).
unsigned char nvmlPlatformInfo_v2_t::trayIndex
The tray index within the compute slots in the chassis containing this GPU (does not
include switches).
unsigned char nvmlPlatformInfo_v2_t::hostId
Index of the node within the slot containing this GPU.
unsigned char nvmlPlatformInfo_v2_t::peerType
Platform indicated NVLink-peer type (e.g. switch present or not).
unsigned char nvmlPlatformInfo_v2_t::moduleId
ID of this GPU within the node.
5.49. nvmlPowerSmoothingProfile_v1_t Struct
Reference
Power Smoothing Structure for Profile information
442
Data Structures
unsigned int nvmlPowerSmoothingProfile_v1_t::version
the API version number
unsigned int nvmlPowerSmoothingProfile_v1_t::profileId
The requested profile ID.
unsigned int nvmlPowerSmoothingProfile_v1_t::paramId
The requested paramater ID.
double nvmlPowerSmoothingProfile_v1_t::value
The requested value for the given parameter.
5.50. nvmlPowerSmoothingState_v1_t Struct
Reference
Power Smoothing Structure for Feature Enablement
unsigned int nvmlPowerSmoothingState_v1_t::version
the API version number
nvmlEnableState_t
nvmlPowerSmoothingState_v1_t::state
0/Disabled or 1/Enabled
5.51. nvmlPowerValue_v2_t Struct Reference
Contains the power management limit
443
Data Structures
unsigned int nvmlPowerValue_v2_t::version
Structure format version (must be 1).
nvmlPowerScopeType_t
nvmlPowerValue_v2_t::powerScope
[in] Device type: GPU or Total Module
unsigned int nvmlPowerValue_v2_t::powerValueMw
[out] Power value to retrieve or set in milliwatts
5.52. nvmlProcessDetail_v1_t Struct Reference
Information about running process on the GPU with protected memory
unsigned int nvmlProcessDetail_v1_t::pid
Process ID.
unsigned long long
nvmlProcessDetail_v1_t::usedGpuMemory
Description
Amount of used GPU memory in bytes. Under WDDM,
NVML_VALUE_NOT_AVAILABLE is always reported because Windows KMD
manages all the memory and not the NVIDIA driver
444
Data Structures
unsigned int nvmlProcessDetail_v1_t::gpuInstanceId
If MIG is enabled, stores a valid GPU instance ID. gpuInstanceId is.
unsigned int
nvmlProcessDetail_v1_t::computeInstanceId
If MIG is enabled, stores a valid compute instance ID. computeInstanceId.
unsigned long long
nvmlProcessDetail_v1_t::usedGpuCcProtectedMemory
Amount of used GPU conf compute protected memory in bytes.
5.53. nvmlProcessDetailList_v1_t Struct Reference
Information about all running processes on the GPU for the given mode
unsigned int nvmlProcessDetailList_v1_t::version
Struct version, MUST be nvmlProcessDetailList_v1.
unsigned int nvmlProcessDetailList_v1_t::mode
Process mode(Compute/Graphics/MPSCompute).
unsigned int
nvmlProcessDetailList_v1_t::numProcArrayEntries
Number of process entries in procArray.
nvmlProcessDetail_v1_t
*nvmlProcessDetailList_v1_t::procArray
Process array.
5.54. nvmlProcessesUtilizationInfo_v1_t Struct
Reference
Structure to store utilization and process ID for each running process -- version 1
445
Data Structures
unsigned int nvmlProcessesUtilizationInfo_v1_t::version
The version number of this struct.
unsigned int
nvmlProcessesUtilizationInfo_v1_t::processSamplesCount
Caller-supplied array size, and returns number of processes running.
unsigned long long
nvmlProcessesUtilizationInfo_v1_t::lastSeenTimeStamp
Return only samples with timestamp greater than lastSeenTimeStamp.
nvmlProcessUtilizationInfo_v1_t
*nvmlProcessesUtilizationInfo_v1_t::procUtilArray
The array (allocated by caller) of the utilization of GPU SM, framebuffer, video encoder,
video decoder, JPEG, and OFA.
5.55. nvmlProcessInfo_t Struct Reference
Information about running compute processes on the GPU
unsigned int nvmlProcessInfo_t::pid
Process ID.
unsigned long long nvmlProcessInfo_t::usedGpuMemory
Description
Amount of used GPU memory in bytes. Under WDDM,
NVML_VALUE_NOT_AVAILABLE is always reported because Windows KMD
manages all the memory and not the NVIDIA driver
446
Data Structures
unsigned int nvmlProcessInfo_t::gpuInstanceId
If MIG is enabled, stores a valid GPU instance ID. gpuInstanceId is set to.
unsigned int nvmlProcessInfo_t::computeInstanceId
If MIG is enabled, stores a valid compute instance ID. computeInstanceId is set to.
5.56. nvmlProcessInfo_v1_t Struct Reference
Information about running compute processes on the GPU, legacy version for older
versions of the API.
unsigned int nvmlProcessInfo_v1_t::pid
Process ID.
unsigned long long
nvmlProcessInfo_v1_t::usedGpuMemory
Description
Amount of used GPU memory in bytes. Under WDDM,
NVML_VALUE_NOT_AVAILABLE is always reported because Windows KMD
manages all the memory and not the NVIDIA driver
5.57. nvmlProcessUtilizationInfo_v1_t Struct
Reference
Structure to store utilization value and process Id -- version 1
447
Data Structures
unsigned long long
nvmlProcessUtilizationInfo_v1_t::timeStamp
CPU Timestamp in microseconds.
unsigned int nvmlProcessUtilizationInfo_v1_t::pid
PID of process.
unsigned int nvmlProcessUtilizationInfo_v1_t::smUtil
SM (3D/Compute) Util Value.
unsigned int nvmlProcessUtilizationInfo_v1_t::memUtil
Frame Buffer Memory Util Value.
unsigned int nvmlProcessUtilizationInfo_v1_t::encUtil
Encoder Util Value.
unsigned int nvmlProcessUtilizationInfo_v1_t::decUtil
Decoder Util Value.
unsigned int nvmlProcessUtilizationInfo_v1_t::jpgUtil
Jpeg Util Value.
unsigned int nvmlProcessUtilizationInfo_v1_t::ofaUtil
Ofa Util Value.
5.58. nvmlProcessUtilizationSample_t Struct
Reference
Structure to store utilization value and process Id
448
Data Structures
unsigned int nvmlProcessUtilizationSample_t::pid
PID of process.
unsigned long long
nvmlProcessUtilizationSample_t::timeStamp
CPU Timestamp in microseconds.
unsigned int nvmlProcessUtilizationSample_t::smUtil
SM (3D/Compute) Util Value.
unsigned int nvmlProcessUtilizationSample_t::memUtil
Frame Buffer Memory Util Value.
unsigned int nvmlProcessUtilizationSample_t::encUtil
Encoder Util Value.
unsigned int nvmlProcessUtilizationSample_t::decUtil
Decoder Util Value.
5.59. nvmlPSUInfo_t Struct Reference
Power usage information for an S-class unit. The power supply state is a human
readable string that equals "Normal" or contains a combination of "Abnormal" plus one
or more of the following:
‣ High voltage
‣ Fan failure
‣ Heatsink temperature
‣ Current limit
‣ Voltage below UV alarm threshold
‣ Low-voltage
‣ SI2C remote off command
‣ MOD_DISABLE input
‣ Short pin transition
449
Data Structures
char nvmlPSUInfo_t::state
The power supply state.
unsigned int nvmlPSUInfo_t::current
PSU current (A).
unsigned int nvmlPSUInfo_t::voltage
PSU voltage (V).
unsigned int nvmlPSUInfo_t::power
PSU power draw (W).
5.60. nvmlRowRemapperHistogramValues_t Struct
Reference
Possible values that classify the remap availability for each bank. The max field will
contain the number of banks that have maximum remap availability (all reserved rows
are available). None means that there are no reserved rows available.
5.61. nvmlSample_t Struct Reference
Information for Sample
unsigned long long nvmlSample_t::timeStamp
CPU Timestamp in microseconds.
nvmlSample_t::sampleValue
Sample Value.
5.62. nvmlSystemConfComputeSettings_v1_t
Struct Reference
Confidential Compute System settings
450
Data Structures
5.63. nvmlSystemDriverBranchInfo_v1_t Struct
Reference
Structure to store Driver branch information
unsigned int nvmlSystemDriverBranchInfo_v1_t::version
The version number of this struct.
char nvmlSystemDriverBranchInfo_v1_t::branch
driver branch
5.64. nvmlSystemEventData_v1_t Struct
Reference
nvmlSystemEventData_v1_t
unsigned long long
nvmlSystemEventData_v1_t::eventType
Information about what specific system event occurred.
unsigned int nvmlSystemEventData_v1_t::gpuId
gpuId in PCI format
5.65. nvmlSystemEventSetCreateRequest_v1_t
Struct Reference
nvmlSystemEventSetCreateRequest
451
Data Structures
unsigned int
nvmlSystemEventSetCreateRequest_v1_t::version
the API version number
nvmlSystemEventSet_t
nvmlSystemEventSetCreateRequest_v1_t::set
system event set
5.66. nvmlSystemEventSetFreeRequest_v1_t
Struct Reference
nvmlSystemEventSetFreeRequest
unsigned int
nvmlSystemEventSetFreeRequest_v1_t::version
the API version number
nvmlSystemEventSet_t
nvmlSystemEventSetFreeRequest_v1_t::set
system event set
5.67. nvmlSystemEventSetWaitRequest_v1_t
Struct Reference
nvmlSystemEventSetWait
unsigned int
nvmlSystemEventSetWaitRequest_v1_t::version
input/output: the API version number
unsigned int
nvmlSystemEventSetWaitRequest_v1_t::timeoutms
Description
input: time to sleep waiting for event. If timeoutms is zero, skip waiting for event.
452
Data Structures
nvmlSystemEventSet_t
nvmlSystemEventSetWaitRequest_v1_t::set
input: system event set
nvmlSystemEventData_v1_t
*nvmlSystemEventSetWaitRequest_v1_t::data
input/output: array of event data, owned by caller
unsigned int
nvmlSystemEventSetWaitRequest_v1_t::dataSize
input: the size of data array
unsigned int
nvmlSystemEventSetWaitRequest_v1_t::numEvent
output: number of event collected.
5.68. nvmlSystemRegisterEventRequest_v1_t
Struct Reference
nvmlSystemRegisterEventRequest
unsigned int
nvmlSystemRegisterEventRequest_v1_t::version
the API version number
unsigned long long
nvmlSystemRegisterEventRequest_v1_t::eventTypes
Description
Bitmask of Event Types to record For example eventTypes = (nvmlEventTypeBind |
nvmlEventTypeUnbind) to listen to both Bind and Unbind events.
453
Data Structures
nvmlSystemEventSet_t
nvmlSystemRegisterEventRequest_v1_t::set
Set to which add new event types.
5.69. nvmlTemperature_v1_t Struct Reference
Structure used to encapsulate temperature info
5.70. nvmlUnitFanInfo_t Struct Reference
Fan speed reading for a single fan in an S-class unit.
unsigned int nvmlUnitFanInfo_t::speed
Fan speed (RPM).
nvmlFanState_t nvmlUnitFanInfo_t::state
Flag that indicates whether fan is working properly.
5.71. nvmlUnitFanSpeeds_t Struct Reference
Fan speed readings for an entire S-class unit.
struct nvmlUnitFanInfo_t nvmlUnitFanSpeeds_t::fans
Fan speed data for each fan.
unsigned int nvmlUnitFanSpeeds_t::count
Number of fans in unit.
5.72. nvmlUnitInfo_t Struct Reference
Static S-class unit info.
454
Data Structures
char nvmlUnitInfo_t::name
Product name.
char nvmlUnitInfo_t::id
Product identifier.
char nvmlUnitInfo_t::serial
Product serial number.
char nvmlUnitInfo_t::firmwareVersion
Firmware version.
5.73. nvmlUtilization_t Struct Reference
Utilization information for a device. Each sample period may be between 1 second and
1/6 second, depending on the product being queried.
unsigned int nvmlUtilization_t::gpu
Percent of time over the past sample period during which one or more kernels was
executing on the GPU.
unsigned int nvmlUtilization_t::memory
Percent of time over the past sample period during which global (device) memory was
being read or written.
5.74. nvmlUUID_v1_t Struct Reference
Struct to represent NVML UUID information
455
Data Structures
unsigned int nvmlUUID_v1_t::version
API version number.
unsigned int nvmlUUID_v1_t::type
One of nvmlUUIDType_t.
nvmlUUID_v1_t::value
One of nvmlUUIDValue_t, to be set based on the UUID format.
5.75. nvmlUUIDValue_t Union Reference
Union to represent different UUID values
char nvmlUUIDValue_t::str
ASCII format value.
unsigned char nvmlUUIDValue_t::bytes
Binary format value.
5.76. nvmlValue_t Union Reference
Union to represent different types of Value
456
Data Structures
double nvmlValue_t::dVal
If the value is double.
int nvmlValue_t::siVal
If the value is signed int.
unsigned int nvmlValue_t::uiVal
If the value is unsigned int.
unsignedlong nvmlValue_t::ulVal
If the value is unsigned long.
unsigned long long nvmlValue_t::ullVal
If the value is unsigned long long.
signed long long nvmlValue_t::sllVal
If the value is signed long long.
unsigned short nvmlValue_t::usVal
If the value is unsigned short.
5.77. nvmlVgpuCreatablePlacementInfo_v1_t
Struct Reference
Structure to store creatable vGPU placement information -- version 1
457
Data Structures
unsigned int
nvmlVgpuCreatablePlacementInfo_v1_t::version
IN: The version number of this struct.
nvmlVgpuTypeId_t
nvmlVgpuCreatablePlacementInfo_v1_t::vgpuTypeId
IN: Handle to vGPU type.
unsigned int
nvmlVgpuCreatablePlacementInfo_v1_t::count
IN/OUT: Count of the placement IDs.
unsigned int
*nvmlVgpuCreatablePlacementInfo_v1_t::placementIds
IN/OUT: Placement IDs for the vGPU type.
unsigned int
nvmlVgpuCreatablePlacementInfo_v1_t::placementSize
OUT: The number of slots occupied by the vGPU type.
5.78. nvmlVgpuHeterogeneousMode_v1_t Struct
Reference
Structure to store the vGPU heterogeneous mode of device -- version 1
unsigned int
nvmlVgpuHeterogeneousMode_v1_t::version
The version number of this struct.
unsigned int nvmlVgpuHeterogeneousMode_v1_t::mode
The vGPU heterogeneous mode.
5.79. nvmlVgpuInstancesUtilizationInfo_v1_t
Struct Reference
Structure to store recent utilization for vGPU instances running on a device -- version 1
458
Data Structures
unsigned int
nvmlVgpuInstancesUtilizationInfo_v1_t::version
The version number of this struct.
nvmlValueType_t
nvmlVgpuInstancesUtilizationInfo_v1_t::sampleValType
Hold the type of returned sample values.
unsigned int
nvmlVgpuInstancesUtilizationInfo_v1_t::vgpuInstanceCount
Hold the number of vGPU instances.
unsigned long long
nvmlVgpuInstancesUtilizationInfo_v1_t::lastSeenTimeStamp
Return only samples with timestamp greater than lastSeenTimeStamp.
nvmlVgpuInstanceUtilizationInfo_v1_t
*nvmlVgpuInstancesUtilizationInfo_v1_t::vgpuUtilArray
The array (allocated by caller) in which vGPU utilization are returned.
5.80. nvmlVgpuInstanceUtilizationInfo_v1_t Struct
Reference
Structure to store Utilization Value and vgpuInstance Info -- Version 1
459
Data Structures
unsigned long long
nvmlVgpuInstanceUtilizationInfo_v1_t::timeStamp
CPU Timestamp in microseconds.
nvmlVgpuInstance_t
nvmlVgpuInstanceUtilizationInfo_v1_t::vgpuInstance
vGPU Instance
nvmlVgpuInstanceUtilizationInfo_v1_t::smUtil
SM (3D/Compute) Util Value.
nvmlVgpuInstanceUtilizationInfo_v1_t::memUtil
Frame Buffer Memory Util Value.
nvmlVgpuInstanceUtilizationInfo_v1_t::encUtil
Encoder Util Value.
nvmlVgpuInstanceUtilizationInfo_v1_t::decUtil
Decoder Util Value.
nvmlVgpuInstanceUtilizationInfo_v1_t::jpgUtil
Jpeg Util Value.
nvmlVgpuInstanceUtilizationInfo_v1_t::ofaUtil
Ofa Util Value.
5.81. nvmlVgpuInstanceUtilizationSample_t Struct
Reference
Structure to store Utilization Value and vgpuInstance
460
Data Structures
nvmlVgpuInstance_t
nvmlVgpuInstanceUtilizationSample_t::vgpuInstance
vGPU Instance
unsigned long long
nvmlVgpuInstanceUtilizationSample_t::timeStamp
CPU Timestamp in microseconds.
nvmlVgpuInstanceUtilizationSample_t::smUtil
SM (3D/Compute) Util Value.
nvmlVgpuInstanceUtilizationSample_t::memUtil
Frame Buffer Memory Util Value.
nvmlVgpuInstanceUtilizationSample_t::encUtil
Encoder Util Value.
nvmlVgpuInstanceUtilizationSample_t::decUtil
Decoder Util Value.
5.82. nvmlVgpuLicenseExpiry_t Struct Reference
Structure to store the vGPU license expiry details
461
Data Structures
unsigned int nvmlVgpuLicenseExpiry_t::year
Year of license expiry.
unsigned short nvmlVgpuLicenseExpiry_t::month
Month of license expiry.
unsigned short nvmlVgpuLicenseExpiry_t::day
Day of license expiry.
unsigned short nvmlVgpuLicenseExpiry_t::hour
Hour of license expiry.
unsigned short nvmlVgpuLicenseExpiry_t::min
Minutes of license expiry.
unsigned short nvmlVgpuLicenseExpiry_t::sec
Seconds of license expiry.
unsigned char nvmlVgpuLicenseExpiry_t::status
License expiry status.
5.83. nvmlVgpuMetadata_t Struct Reference
vGPU metadata structure.
462
Data Structures
unsigned int nvmlVgpuMetadata_t::version
Current version of the structure.
unsigned int nvmlVgpuMetadata_t::revision
Current revision of the structure.
nvmlVgpuGuestInfoState_t
nvmlVgpuMetadata_t::guestInfoState
Current state of Guest-dependent fields.
char nvmlVgpuMetadata_t::guestDriverVersion
Version of driver installed in guest.
char nvmlVgpuMetadata_t::hostDriverVersion
Version of driver installed in host.
unsigned int nvmlVgpuMetadata_t::reserved
Reserved for internal use.
unsigned int
nvmlVgpuMetadata_t::vgpuVirtualizationCaps
vGPU virtualization capabilities bitfield
unsigned int nvmlVgpuMetadata_t::guestVgpuVersion
vGPU version of guest driver
unsigned int nvmlVgpuMetadata_t::opaqueDataSize
Size of opaque data field in bytes.
char nvmlVgpuMetadata_t::opaqueData
Opaque data.
5.84. nvmlVgpuPgpuCompatibility_t Struct
Reference
vGPU-pGPU compatibility structure
463
Data Structures
nvmlVgpuVmCompatibility_t
nvmlVgpuPgpuCompatibility_t::vgpuVmCompatibility
Compatibility of vGPU VM. See nvmlVgpuVmCompatibility_t.
nvmlVgpuPgpuCompatibilityLimitCode_t
nvmlVgpuPgpuCompatibility_t::compatibilityLimitCode
Limiting factor for vGPU-pGPU compatibility. See
nvmlVgpuPgpuCompatibilityLimitCode_t.
5.85. nvmlVgpuPgpuMetadata_t Struct Reference
Physical GPU metadata structure
464
Data Structures
unsigned int nvmlVgpuPgpuMetadata_t::version
Current version of the structure.
unsigned int nvmlVgpuPgpuMetadata_t::revision
Current revision of the structure.
char nvmlVgpuPgpuMetadata_t::hostDriverVersion
Host driver version.
unsigned int
nvmlVgpuPgpuMetadata_t::pgpuVirtualizationCaps
Pgpu virtualization capabilities bitfield.
unsigned int nvmlVgpuPgpuMetadata_t::reserved
Reserved for internal use.
struct nvmlVgpuVersion_t
nvmlVgpuPgpuMetadata_t::hostSupportedVgpuRange
vGPU version range supported by host driver
unsigned int nvmlVgpuPgpuMetadata_t::opaqueDataSize
Size of opaque data field in bytes.
char nvmlVgpuPgpuMetadata_t::opaqueData
Opaque data.
5.86. nvmlVgpuPlacementId_v1_t Struct
Reference
Structure to store the placement ID of vGPU instance -- version 1
465
Data Structures
unsigned int nvmlVgpuPlacementId_v1_t::version
The version number of this struct.
unsigned int nvmlVgpuPlacementId_v1_t::placementId
Placement ID of the active vGPU instance.
5.87. nvmlVgpuPlacementList_v1_t Struct
Reference
Structure to store the list of vGPU placements -- version 1
unsigned int nvmlVgpuPlacementList_v1_t::version
The version number of this struct.
unsigned int
nvmlVgpuPlacementList_v1_t::placementSize
The number of slots occupied by the vGPU type.
unsigned int nvmlVgpuPlacementList_v1_t::count
Count of placement IDs fetched.
unsigned int
*nvmlVgpuPlacementList_v1_t::placementIds
Placement IDs for the vGPU type.
5.88. nvmlVgpuPlacementList_v2_t Struct
Reference
Structure to store the list of vGPU placements -- version 2
466
Data Structures
unsigned int nvmlVgpuPlacementList_v2_t::version
IN: The version number of this struct.
unsigned int
nvmlVgpuPlacementList_v2_t::placementSize
OUT: The number of slots occupied by the vGPU type.
unsigned int nvmlVgpuPlacementList_v2_t::count
IN/OUT: Count of the placement IDs.
unsigned int
*nvmlVgpuPlacementList_v2_t::placementIds
IN/OUT: Placement IDs for the vGPU type.
unsigned int nvmlVgpuPlacementList_v2_t::mode
IN: The vGPU mode. Either NVML_VGPU_PGPU_HETEROGENEOUS_MODE or
NVML_VGPU_PGPU_HOMOGENEOUS_MODE.
5.89. nvmlVgpuProcessesUtilizationInfo_v1_t
Struct Reference
Structure to store recent utilization, vgpuInstance and subprocess information for
processes running on vGPU instances active on a device -- version 1
467
Data Structures
unsigned int
nvmlVgpuProcessesUtilizationInfo_v1_t::version
The version number of this struct.
unsigned int
nvmlVgpuProcessesUtilizationInfo_v1_t::vgpuProcessCount
Hold the number of processes running on vGPU instances.
unsigned long long
nvmlVgpuProcessesUtilizationInfo_v1_t::lastSeenTimeStamp
Return only samples with timestamp greater than lastSeenTimeStamp.
nvmlVgpuProcessUtilizationInfo_v1_t
*nvmlVgpuProcessesUtilizationInfo_v1_t::vgpuProcUtilArray
The array (allocated by caller) in which utilization of processes running on vGPU
instances are returned.
5.90. nvmlVgpuProcessUtilizationInfo_v1_t Struct
Reference
Structure to store Utilization Value, vgpuInstance and subprocess information for
process running on vGPU instance -- version 1
468
Data Structures
char nvmlVgpuProcessUtilizationInfo_v1_t::processName
Name of process running within the vGPU VM.
unsigned long long
nvmlVgpuProcessUtilizationInfo_v1_t::timeStamp
CPU Timestamp in microseconds.
nvmlVgpuInstance_t
nvmlVgpuProcessUtilizationInfo_v1_t::vgpuInstance
vGPU Instance
unsigned int nvmlVgpuProcessUtilizationInfo_v1_t::pid
PID of process running within the vGPU VM.
unsigned int
nvmlVgpuProcessUtilizationInfo_v1_t::smUtil
SM (3D/Compute) Util Value.
unsigned int
nvmlVgpuProcessUtilizationInfo_v1_t::memUtil
Frame Buffer Memory Util Value.
unsigned int
nvmlVgpuProcessUtilizationInfo_v1_t::encUtil
Encoder Util Value.
unsigned int
nvmlVgpuProcessUtilizationInfo_v1_t::decUtil
Decoder Util Value.
unsigned int
nvmlVgpuProcessUtilizationInfo_v1_t::jpgUtil
Jpeg Util Value.
unsigned int
nvmlVgpuProcessUtilizationInfo_v1_t::ofaUtil
Ofa Util Value.
469
Data Structures
5.91. nvmlVgpuProcessUtilizationSample_t Struct
Reference
Structure to store Utilization Value, vgpuInstance and subprocess information
470
Data Structures
nvmlVgpuInstance_t
nvmlVgpuProcessUtilizationSample_t::vgpuInstance
vGPU Instance
unsigned int nvmlVgpuProcessUtilizationSample_t::pid
PID of process running within the vGPU VM.
char nvmlVgpuProcessUtilizationSample_t::processName
Name of process running within the vGPU VM.
unsigned long long
nvmlVgpuProcessUtilizationSample_t::timeStamp
CPU Timestamp in microseconds.
unsigned int
nvmlVgpuProcessUtilizationSample_t::smUtil
SM (3D/Compute) Util Value.
unsigned int
nvmlVgpuProcessUtilizationSample_t::memUtil
Frame Buffer Memory Util Value.
unsigned int
nvmlVgpuProcessUtilizationSample_t::encUtil
Encoder Util Value.
unsigned int
nvmlVgpuProcessUtilizationSample_t::decUtil
Decoder Util Value.
5.92. nvmlVgpuRuntimeState_v1_t Struct
Reference
Structure to store the information of vGPU runtime state -- version 1
471
Data Structures
unsigned int nvmlVgpuRuntimeState_v1_t::version
IN: The version number of this struct.
unsigned long long nvmlVgpuRuntimeState_v1_t::size
OUT: The runtime state size of the vGPU instance.
5.93. nvmlVgpuSchedulerCapabilities_t Struct
Reference
Structure to store the vGPU scheduler capabilities
472
Data Structures
unsigned int
nvmlVgpuSchedulerCapabilities_t::supportedSchedulers
List the supported vGPU schedulers on the device.
unsigned int
nvmlVgpuSchedulerCapabilities_t::maxTimeslice
Maximum timeslice value in ns.
unsigned int
nvmlVgpuSchedulerCapabilities_t::minTimeslice
Minimum timeslice value in ns.
unsigned int
nvmlVgpuSchedulerCapabilities_t::isArrModeSupported
Flag to check Adaptive Round Robin mode enabled/disabled.
unsigned int
nvmlVgpuSchedulerCapabilities_t::maxFrequencyForARR
Maximum frequency for Adaptive Round Robin mode.
unsigned int
nvmlVgpuSchedulerCapabilities_t::minFrequencyForARR
Minimum frequency for Adaptive Round Robin mode.
unsigned int
nvmlVgpuSchedulerCapabilities_t::maxAvgFactorForARR
Maximum averaging factor for Adaptive Round Robin mode.
unsigned int
nvmlVgpuSchedulerCapabilities_t::minAvgFactorForARR
Minimum averaging factor for Adaptive Round Robin mode.
5.94. nvmlVgpuSchedulerGetState_t Struct
Reference
Structure to store the vGPU scheduler state
473
Data Structures
unsigned int
nvmlVgpuSchedulerGetState_t::schedulerPolicy
Scheduler policy.
unsigned int nvmlVgpuSchedulerGetState_t::arrMode
Adaptive Round Robin scheduler mode. One of the
NVML_VGPU_SCHEDULER_ARR_*.
5.95. nvmlVgpuSchedulerLog_t Struct Reference
Structure to store a vGPU software scheduler log
unsigned int nvmlVgpuSchedulerLog_t::engineId
Engine whose software runlist log entries are fetched.
unsigned int nvmlVgpuSchedulerLog_t::schedulerPolicy
Scheduler policy.
unsigned int nvmlVgpuSchedulerLog_t::arrMode
Adaptive Round Robin scheduler mode. One of the
NVML_VGPU_SCHEDULER_ARR_*.
unsigned int nvmlVgpuSchedulerLog_t::entriesCount
Count of log entries fetched.
5.96. nvmlVgpuSchedulerLogEntry_t Struct
Reference
Structure to store the state and logs of a software runlist
474
Data Structures
unsigned long long
nvmlVgpuSchedulerLogEntry_t::timestamp
Timestamp in ns when this software runlist was preeempted.
unsigned long long
nvmlVgpuSchedulerLogEntry_t::timeRunTotal
Total time in ns this software runlist has run.
unsigned long long
nvmlVgpuSchedulerLogEntry_t::timeRun
Time in ns this software runlist ran before preemption.
unsigned int nvmlVgpuSchedulerLogEntry_t::swRunlistId
Software runlist Id.
unsigned long long
nvmlVgpuSchedulerLogEntry_t::targetTimeSlice
The actual timeslice after deduction.
unsigned long long
nvmlVgpuSchedulerLogEntry_t::cumulativePreemptionTime
Preemption time in ns for this SW runlist.
5.97. nvmlVgpuSchedulerLogInfo_v1_t Struct
Reference
Structure to store vGPU scheduler log information -- Version 1
475
Data Structures
unsigned int nvmlVgpuSchedulerLogInfo_v1_t::version
IN: The version number of this struct.
unsigned int nvmlVgpuSchedulerLogInfo_v1_t::engineId
IN: Engine whose software runlist log entries are fetched. One of One of
NVML_VGPU_SCHEDULER_ENGINE_TYPE_*.
unsigned int
nvmlVgpuSchedulerLogInfo_v1_t::schedulerPolicy
OUT: Scheduler policy.
unsigned int nvmlVgpuSchedulerLogInfo_v1_t::arrMode
OUT: Adaptive Round Robin scheduler mode. One of the
NVML_VGPU_SCHEDULER_ARR_*.
nvmlVgpuSchedulerLogInfo_v1_t::schedulerParams
OUT: vGPU Scheduler Parameters.
unsigned int
nvmlVgpuSchedulerLogInfo_v1_t::entriesCount
OUT: Count of log entries fetched.
struct nvmlVgpuSchedulerLogEntry_t
nvmlVgpuSchedulerLogInfo_v1_t::logEntries
OUT: Structure to store the state and logs of a software runlist.
5.98. nvmlVgpuSchedulerParams_t Union
Reference
Union to represent the vGPU Scheduler Parameters
476
Data Structures
unsigned int nvmlVgpuSchedulerParams_t::avgFactor
Average factor in compensating the timeslice for Adaptive Round Robin mode.
unsigned int nvmlVgpuSchedulerParams_t::timeslice
The timeslice in ns for each software run list as configured, or the default value
otherwise.
5.99. nvmlVgpuSchedulerSetParams_t Union
Reference
Union to represent the vGPU Scheduler set Parameters
unsigned int nvmlVgpuSchedulerSetParams_t::avgFactor
Average factor in compensating the timeslice for Adaptive Round Robin mode.
unsigned int nvmlVgpuSchedulerSetParams_t::frequency
Frequency for Adaptive Round Robin mode.
unsigned int nvmlVgpuSchedulerSetParams_t::timeslice
The timeslice in ns(Nanoseconds) for each software run list as configured, or the default
value otherwise.
5.100. nvmlVgpuSchedulerSetState_t Struct
Reference
Structure to set the vGPU scheduler state
477
Data Structures
unsigned int
nvmlVgpuSchedulerSetState_t::schedulerPolicy
Scheduler policy.
unsigned int
nvmlVgpuSchedulerSetState_t::enableARRMode
Adaptive Round Robin scheduler.
5.101. nvmlVgpuSchedulerState_v1_t Struct
Reference
Structure to set vGPU scheduler state information -- version 1
unsigned int nvmlVgpuSchedulerState_v1_t::version
IN: The version number of this struct.
unsigned int nvmlVgpuSchedulerState_v1_t::engineId
IN: One of NVML_VGPU_SCHEDULER_ENGINE_TYPE_*.
unsigned int
nvmlVgpuSchedulerState_v1_t::schedulerPolicy
IN: Scheduler policy.
unsigned int
nvmlVgpuSchedulerState_v1_t::enableARRMode
IN: Adaptive Round Robin scheduler.
nvmlVgpuSchedulerState_v1_t::schedulerParams
IN: vGPU Scheduler Parameters.
5.102. nvmlVgpuSchedulerStateInfo_v1_t Struct
Reference
Structure to store vGPU scheduler state information -- Version 1
478
Data Structures
unsigned int nvmlVgpuSchedulerStateInfo_v1_t::version
IN: The version number of this struct.
unsigned int
nvmlVgpuSchedulerStateInfo_v1_t::engineId
IN: Engine whose software scheduler state info is fetched. One of
NVML_VGPU_SCHEDULER_ENGINE_TYPE_*.
unsigned int
nvmlVgpuSchedulerStateInfo_v1_t::schedulerPolicy
OUT: Scheduler policy.
unsigned int
nvmlVgpuSchedulerStateInfo_v1_t::arrMode
OUT: Adaptive Round Robin scheduler mode. One of the
NVML_VGPU_SCHEDULER_ARR_*.
nvmlVgpuSchedulerStateInfo_v1_t::schedulerParams
OUT: vGPU Scheduler Parameters.
5.103. nvmlVgpuTypeBar1Info_v1_t Struct
Reference
Structure to store BAR1 size information of vGPU type -- Version 1
unsigned int nvmlVgpuTypeBar1Info_v1_t::version
The version number of this struct.
unsigned long long
nvmlVgpuTypeBar1Info_v1_t::bar1Size
BAR1 size in megabytes.
5.104. nvmlVgpuTypeIdInfo_v1_t Struct Reference
Structure to store the vGPU type IDs -- version 1
479
Data Structures
unsigned int nvmlVgpuTypeIdInfo_v1_t::version
IN: The version number of this struct.
unsigned int nvmlVgpuTypeIdInfo_v1_t::vgpuCount
IN/OUT: Number of vGPU types.
nvmlVgpuTypeId_t
*nvmlVgpuTypeIdInfo_v1_t::vgpuTypeIds
OUT: List of vGPU type IDs.
5.105. nvmlVgpuTypeMaxInstance_v1_t Struct
Reference
Structure to store the maximum number of possible vGPU type IDs -- version 1
unsigned int nvmlVgpuTypeMaxInstance_v1_t::version
IN: The version number of this struct.
nvmlVgpuTypeId_t
nvmlVgpuTypeMaxInstance_v1_t::vgpuTypeId
IN: Handle to vGPU type.
unsigned int
nvmlVgpuTypeMaxInstance_v1_t::maxInstancePerGI
OUT: Maximum number of vGPU instances per GPU instance.
5.106. nvmlVgpuVersion_t Struct Reference
Structure representing range of vGPU versions.
480
Data Structures
unsigned int nvmlVgpuVersion_t::minVersion
Minimum vGPU version.
unsigned int nvmlVgpuVersion_t::maxVersion
Maximum vGPU version.
5.107. nvmlViolationTime_t Struct Reference
Struct to hold perf policy violation status data
unsigned long long nvmlViolationTime_t::referenceTime
referenceTime represents CPU timestamp in microseconds
unsigned long long nvmlViolationTime_t::violationTime
violationTime in Nanoseconds
5.108. nvmlWorkloadPowerProfileCurrentProfiles_v1_t
Struct Reference
Current Profiles
481
Data Structures
nvmlMask255_t
nvmlWorkloadPowerProfileCurrentProfiles_v1_t::perfProfilesMask
Mask bit set to true for each valid performance profile.
nvmlMask255_t
nvmlWorkloadPowerProfileCurrentProfiles_v1_t::requestedProfiles
Mask of currently requested performance profiles.
nvmlMask255_t
nvmlWorkloadPowerProfileCurrentProfiles_v1_t::enforcedProfilesM
Mask of currently enforced performance profiles post all arbitrations among the
requested profiles.
5.109. nvmlWorkloadPowerProfileInfo_v1_t Struct
Reference
Profile Metadata
482
Data Structures
unsigned int
nvmlWorkloadPowerProfileInfo_v1_t::version
the API version number
unsigned int
nvmlWorkloadPowerProfileInfo_v1_t::profileId
Performance Profile Id to provide semantic name such as compute, Memory, Max-Q...
unsigned int
nvmlWorkloadPowerProfileInfo_v1_t::priority
Priority of the profile.
nvmlMask255_t
nvmlWorkloadPowerProfileInfo_v1_t::conflictingMask
Mask of conflicting performance profiles.
5.110. nvmlWorkloadPowerProfileProfilesInfo_v1_t
Struct Reference
Profiles Info
483
Data Structures
unsigned int
nvmlWorkloadPowerProfileProfilesInfo_v1_t::version
the API version number
nvmlMask255_t
nvmlWorkloadPowerProfileProfilesInfo_v1_t::perfProfilesMask
Mask bit set to true for each valid performance profile.
struct nvmlWorkloadPowerProfileInfo_t
nvmlWorkloadPowerProfileProfilesInfo_v1_t::perfProfile
Array of performance profile info parameters.
5.111. nvmlWorkloadPowerProfileRequestedProfiles_v1_t
Struct Reference
Requested Profiles
unsigned int
nvmlWorkloadPowerProfileRequestedProfiles_v1_t::version
the API version number
nvmlMask255_t
nvmlWorkloadPowerProfileRequestedProfiles_v1_t::requestedProfi
Mask of 255 bits, each bit representing index of respective perf profile.
484
Chapter 6.
DATA FIELDS
Here is a list of all documented struct and union fields with links to the struct/union
documentation for each field:
A
aggregateCor
nvmlEccSramErrorStatus_v1_t
aggregateUncBucketL2
nvmlEccSramErrorStatus_v1_t
aggregateUncBucketMcu
nvmlEccSramErrorStatus_v1_t
aggregateUncBucketOther
nvmlEccSramErrorStatus_v1_t
aggregateUncBucketPcie
nvmlEccSramErrorStatus_v1_t
aggregateUncBucketSm
nvmlEccSramErrorStatus_v1_t
aggregateUncParity
nvmlEccSramErrorStatus_v1_t
aggregateUncSecDed
nvmlEccSramErrorStatus_v1_t
arrMode
nvmlVgpuSchedulerLog_t
nvmlVgpuSchedulerGetState_t
nvmlVgpuSchedulerStateInfo_v1_t
nvmlVgpuSchedulerLogInfo_v1_t
averageFPS
nvmlFBCStats_t
averageFps
nvmlEncoderSessionInfo_t
485
Data Fields
averageFPS
nvmlFBCSessionInfo_t
averageLatency
nvmlFBCStats_t
nvmlFBCSessionInfo_t
nvmlEncoderSessionInfo_t
avgFactor
nvmlVgpuSchedulerSetParams_t
nvmlVgpuSchedulerParams_t
B
bar1Free
nvmlBAR1Memory_t
bar1Size
nvmlVgpuTypeBar1Info_v1_t
bar1Total
nvmlBAR1Memory_t
bar1Used
nvmlBAR1Memory_t
baseClass
nvmlPciInfoExt_v1_t
bGlobalStatus
nvmlClkMonStatus_t
branch
nvmlSystemDriverBranchInfo_v1_t
bridgeChipInfo
nvmlBridgeChipHierarchy_t
bridgeCount
nvmlBridgeChipHierarchy_t
bThresholdExceeded
nvmlEccSramErrorStatus_v1_t
bus
nvmlPciInfoExt_v1_t
nvmlPciInfo_t
busId
nvmlPciInfoExt_v1_t
nvmlPciInfo_t
busIdLegacy
nvmlPciInfo_t
bytes
nvmlUUIDValue_t
486
|
||
|
|
|