nvmlDeviceStructs (3)

NAME

Device Structs -

Data Structures

struct nvmlPciInfo_t

struct nvmlEccErrorCounts_t

struct nvmlUtilization_t

struct nvmlMemory_t

struct nvmlBAR1Memory_t

struct nvmlProcessInfo_t

struct nvmlNvLinkUtilizationControl_t

struct nvmlBridgeChipInfo_t

struct nvmlBridgeChipHierarchy_t

union nvmlValue_t

struct nvmlSample_t

struct nvmlViolationTime_t

Defines

#define NVML_VALUE_NOT_AVAILABLE (-1)

#define NVML_DEVICE_PCI_BUS_ID_BUFFER_SIZE 16

#define NVML_NVLINK_MAX_LINKS 4

#define NVML_MAX_PHYSICAL_BRIDGE (128)

Enumerations

enum nvmlBridgeChipType_t

enum nvmlNvLinkUtilizationCountUnits_t

enum nvmlNvLinkUtilizationCountPktTypes_t

enum nvmlNvLinkCapability_t

enum nvmlNvLinkErrorCounter_t

enum nvmlGpuTopologyLevel_t

enum nvmlSamplingType_t { NVML_TOTAL_POWER_SAMPLES = 0, NVML_GPU_UTILIZATION_SAMPLES = 1, NVML_MEMORY_UTILIZATION_SAMPLES = 2, NVML_ENC_UTILIZATION_SAMPLES = 3, NVML_DEC_UTILIZATION_SAMPLES = 4, NVML_PROCESSOR_CLK_SAMPLES = 5, NVML_MEMORY_CLK_SAMPLES = 6 }

enum nvmlPcieUtilCounter_t

enum nvmlValueType_t

enum nvmlPerfPolicyType_t

Define Documentation

#define NVML_DEVICE_PCI_BUS_ID_BUFFER_SIZE 16

Buffer size guaranteed to be large enough for pci bus id

#define NVML_MAX_PHYSICAL_BRIDGE (128)

Maximum limit on Physical Bridges per Board

#define NVML_NVLINK_MAX_LINKS 4

Maximum number of NvLink links supported

#define NVML_VALUE_NOT_AVAILABLE (-1)

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.

Enumeration Type Documentation

enum nvmlBridgeChipType_t

Enum to represent type of bridge chip

enum nvmlGpuTopologyLevel_t

Represents level relationships within a system between two GPUs The enums are spaced to allow for future relationships

enum nvmlNvLinkCapability_t

Enum to represent NvLink queryable capabilities

enum nvmlNvLinkErrorCounter_t

Enum to represent NvLink queryable error counters

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

enum nvmlNvLinkUtilizationCountUnits_t

Enum to represent the NvLink utilization counter packet units

enum nvmlPcieUtilCounter_t

Represents the queryable PCIe utilization counters

enum nvmlPerfPolicyType_t

Represents type of perf policy for which violation times can be queried

enum nvmlSamplingType_t

Represents Type of Sampling Event

Enumerator:

NVML_TOTAL_POWER_SAMPLES

To represent total power drawn by GPU.

NVML_GPU_UTILIZATION_SAMPLES

To represent percent of time during which one or more kernels was executing on the GPU.

NVML_MEMORY_UTILIZATION_SAMPLES

To represent percent of time during which global (device) memory was being read or written.

NVML_ENC_UTILIZATION_SAMPLES

To represent percent of time during which NVENC remains busy.

NVML_DEC_UTILIZATION_SAMPLES

To represent percent of time during which NVDEC remains busy.

NVML_PROCESSOR_CLK_SAMPLES

To represent processor clock samples.

NVML_MEMORY_CLK_SAMPLES

To represent memory clock samples.

enum nvmlValueType_t

Represents the type for sample value returned

Author

Generated automatically by Doxygen for NVML from the source code.