Enum GpuMetrics 

pub enum GpuMetrics {
    Unknown,
    V1_0(gpu_metrics_v1_0),
    V1_1(gpu_metrics_v1_1),
    V1_2(gpu_metrics_v1_2),
    V1_3(gpu_metrics_v1_3),
    V1_4(gpu_metrics_v1_4),
    V1_5(gpu_metrics_v1_5),
    V2_0(gpu_metrics_v2_0),
    V2_1(gpu_metrics_v2_1),
    V2_2(gpu_metrics_v2_2),
    V2_3(gpu_metrics_v2_3),
    V2_4(gpu_metrics_v2_4),
    V3_0(gpu_metrics_v3_0),
}

AMD GPU metrics data available from "{sysfs_path}/gpu_metrics".
Vega12 (dGPU) or later, Renoir (APU) or later supports GPU metrics.
DeviceHandle::get_gpu_metrics

Variants

Unknown

V1_0(gpu_metrics_v1_0)

V1_1(gpu_metrics_v1_1)

V1_2(gpu_metrics_v1_2)

V1_3(gpu_metrics_v1_3)

V1_4(gpu_metrics_v1_4)

V1_5(gpu_metrics_v1_5)

V2_0(gpu_metrics_v2_0)

V2_1(gpu_metrics_v2_1)

V2_2(gpu_metrics_v2_2)

V2_3(gpu_metrics_v2_3)

V2_4(gpu_metrics_v2_4)

V3_0(gpu_metrics_v3_0)

Implementations

impl GpuMetrics

pub fn get_from_sysfs_path<P: Into<PathBuf>>(sysfs_path: P) -> Result<Self>

pub fn get_raw_from_sysfs_path<P: Into<PathBuf>>( sysfs_path: P, ) -> Result<Vec<u8>>

pub fn from_raw(raw: &[u8]) -> Self

pub fn read_file_with_buffer<P: Into<PathBuf>>( buf: &mut Vec<u8>, path: P, ) -> Result<Self>

Trait Implementations

impl Clone for GpuMetrics

fn clone(&self) -> GpuMetrics

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GpuMetrics

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl MetricsInfo for GpuMetrics

fn get_header(&self) -> Option<metrics_table_header>

fn get_temperature_edge(&self) -> Option<u16>

Celsius

fn get_temperature_hotspot(&self) -> Option<u16>

Celsius

fn get_temperature_mem(&self) -> Option<u16>

Celsius

fn get_temperature_vrgfx(&self) -> Option<u16>

Celsius

fn get_temperature_vrsoc(&self) -> Option<u16>

Celsius

fn get_temperature_vrmem(&self) -> Option<u16>

Celsius

fn get_temperature_gfx(&self) -> Option<u16>

millidegrees Celsius

fn get_temperature_soc(&self) -> Option<u16>

millidegrees Celsius

fn get_temperature_core(&self) -> Option<Vec<u16>>

millidegrees Celsius,
For VanGogh APU, only the first half is a valid value.
ref: drivers/gpu/drm/amd/pm/swsmu/smu11/vangogh_ppt.c

fn get_temperature_l3(&self) -> Option<Vec<u16>>

millidegrees Celsius,
For VanGogh APU, only the first half is a valid value.
ref: drivers/gpu/drm/amd/pm/swsmu/smu11/vangogh_ppt.c

fn get_temperature_skin(&self) -> Option<u16>

SMU v14.0.0 with gpu_metrics_v3_0 supports it.

fn get_average_gfx_activity(&self) -> Option<u16>

fn get_average_umc_activity(&self) -> Option<u16>

fn get_average_mm_activity(&self) -> Option<u16>

fn get_average_ipu_activity(&self) -> Option<Vec<u16>>

time filtered IPU per-column busy % [0-100], SMU v14.0.0 with gpu_metrics_v3_0 supports it.

fn get_average_core_c0_activity(&self) -> Option<Vec<u16>>

time filtered per-core C0 residency % [0-100], SMU v14.0.0 with gpu_metrics_v3_0 supports it.

fn get_average_dram_reads(&self) -> Option<u16>

time filtered DRAM read bandwidth [MB/sec], SMU v14.0.0 with gpu_metrics_v3_0 supports it.

fn get_average_dram_writes(&self) -> Option<u16>

time filtered DRAM write bandwidth [MB/sec], SMU v14.0.0 with gpu_metrics_v3_0 supports it.

fn get_average_ipu_reads(&self) -> Option<u16>

time filtered IPU read bandwidth [MB/sec], SMU v14.0.0 with gpu_metrics_v3_0 supports it.

fn get_average_ipu_writes(&self) -> Option<u16>

time filtered IPU write bandwidth [MB/sec], SMU v14.0.0 with gpu_metrics_v3_0 supports it.

fn get_system_clock_counter(&self) -> Option<u64>

fn get_average_socket_power(&self) -> Option<u32>

Watts

fn get_average_cpu_power(&self) -> Option<u16>

Watts

fn get_average_soc_power(&self) -> Option<u16>

Watts

fn get_average_gfx_power(&self) -> Option<u16>

Watts

fn get_average_gfx_power_u32(&self) -> Option<u32>

Watts

fn get_average_core_power(&self) -> Option<Vec<u16>>

Watts,
For VanGogh APU, only the first half is a valid value.
ref: drivers/gpu/drm/amd/pm/swsmu/smu11/vangogh_ppt.c

fn get_average_ipu_power(&self) -> Option<u16>

time filtered IPU power [mW], SMU v14.0.0 with gpu_metrics_v3_0 supports it.

fn get_average_apu_power(&self) -> Option<u32>

time filtered APU power [mW], SMU v14.0.0 with gpu_metrics_v3_0 supports it.

fn get_average_dgpu_power(&self) -> Option<u32>

time filtered dGPU power [mW], SMU v14.0.0 with gpu_metrics_v3_0 supports it.

fn get_average_all_core_power(&self) -> Option<u32>

time filtered sum of core power across all cores in the socket [mW], SMU v14.0.0 with gpu_metrics_v3_0 supports it.

fn get_average_sys_power(&self) -> Option<u16>

time filtered total system power [mW], SMU v14.0.0 with gpu_metrics_v3_0 supports it.

fn get_stapm_power_limit(&self) -> Option<u16>

maximum IRM defined STAPM power limit [mW], SMU v14.0.0 with gpu_metrics_v3_0 supports it.

fn get_current_stapm_power_limit(&self) -> Option<u16>

time filtered STAPM power limit [mW], SMU v14.0.0 with gpu_metrics_v3_0 supports it.

fn get_average_gfxclk_frequency(&self) -> Option<u16>

MHz

fn get_average_socclk_frequency(&self) -> Option<u16>

MHz

fn get_average_uclk_frequency(&self) -> Option<u16>

UMC Clock, MHz

fn get_average_fclk_frequency(&self) -> Option<u16>

Fabric Clock, MHz

fn get_average_vclk_frequency(&self) -> Option<u16>

Video Clock, MHz

fn get_average_dclk_frequency(&self) -> Option<u16>

Display Clock, MHz

fn get_average_vclk1_frequency(&self) -> Option<u16>

Video Clock, MHz

fn get_average_dclk1_frequency(&self) -> Option<u16>

Display Clock, MHz

fn get_average_vpeclk_frequency(&self) -> Option<u16>

time filtered clocks [MHz], SMU v14.0.0 with gpu_metrics_v3_0 supports it.

fn get_average_ipuclk_frequency(&self) -> Option<u16>

time filtered clocks [MHz], SMU v14.0.0 with gpu_metrics_v3_0 supports it.

fn get_average_mpipu_frequency(&self) -> Option<u16>

time filtered clocks [MHz], SMU v14.0.0 with gpu_metrics_v3_0 supports it.

fn get_current_gfxclk(&self) -> Option<u16>

MHz

fn get_current_socclk(&self) -> Option<u16>

MHz

fn get_current_uclk(&self) -> Option<u16>

UMC Clock, MHz

fn get_current_fclk(&self) -> Option<u16>

Fablic Clock, MHz

fn get_current_vclk(&self) -> Option<u16>

Video Clock, MHz

fn get_current_dclk(&self) -> Option<u16>

Display Clock, MHz

fn get_current_vclk1(&self) -> Option<u16>

Video Clock, MHz

fn get_current_dclk1(&self) -> Option<u16>

Display Clock, MHz

fn get_current_coreclk(&self) -> Option<Vec<u16>>

MHz,
For VanGogh APU, only the first half is a valid value.
ref: drivers/gpu/drm/amd/pm/swsmu/smu11/vangogh_ppt.c

fn get_current_l3clk(&self) -> Option<Vec<u16>>

MHz,
For VanGogh APU, only the first half is a valid value.
ref: drivers/gpu/drm/amd/pm/swsmu/smu11/vangogh_ppt.c

fn get_current_core_maxfreq(&self) -> Option<u16>

CCLK frequency limit enforced on classic cores [MHz], SMU v14.0.0 with gpu_metrics_v3_0 supports it.

fn get_current_gfx_maxfreq(&self) -> Option<u16>

GFXCLK frequency limit enforced on GFX [MHz], SMU v14.0.0 with gpu_metrics_v3_0 supports it.

fn get_throttle_status(&self) -> Option<u32>

fn get_indep_throttle_status(&self) -> Option<u64>

This method returns None if indep_throttle_status is u64::MAX, and implements a workaround for RDNA 3 dGPUs and RDNA 4 dGPUs. ref: https://gitlab.freedesktop.org/drm/amd/-/issues/3251

fn get_indep_throttle_status_without_check(&self) -> Option<u64>

This method returns indep_throttle_status without any checks or workarounds.

fn get_throttle_status_info(&self) -> Option<ThrottleStatus>

fn get_current_fan_speed(&self) -> Option<u16>

fn get_fan_pwm(&self) -> Option<u16>

fn get_pcie_link_width(&self) -> Option<u16>

Clock Lock Status. Each bit corresponds to clock instance

fn get_pcie_link_speed(&self) -> Option<u16>

Clock Lock Status. Each bit corresponds to clock instance

fn get_pcie_bandwidth_acc(&self) -> Option<u64>

PCIE accumulated bandwidth (GB/sec), only MI300 with gpu_metrics_v1_4 or gpu_metrics_v1_5 supports it.

fn get_pcie_bandwidth_inst(&self) -> Option<u64>

PCIE instantaneous bandwidth (GB/sec) only MI300 with gpu_metrics_v1_4 or gpu_metrics_v1_5 supports it.

fn get_xgmi_link_width(&self) -> Option<u16>

XGMI bus width and bitrate (in Gbps) only MI300 with gpu_metrics_v1_4 or gpu_metrics_v1_5 supports it.

fn get_xgmi_link_speed(&self) -> Option<u16>

XGMI bus width and bitrate (in Gbps) only MI300 with gpu_metrics_v1_4 or gpu_metrics_v1_5 supports it.

fn get_xgmi_read_data_acc(&self) -> Option<[u64; 8]>

XGMI accumulated data transfer size(KiloBytes), only MI300 with gpu_metrics_v1_4 or gpu_metrics_v1_5 supports it.

fn get_xgmi_write_data_acc(&self) -> Option<[u64; 8]>

XGMI accumulated data transfer size(KiloBytes), only MI300 with gpu_metrics_v1_4 or gpu_metrics_v1_5 supports it.

fn get_gfx_activity_acc(&self) -> Option<u32>

fn get_mem_activity_acc(&self) -> Option<u32>

fn get_temperature_hbm(&self) -> Option<[u16; 4]>

Only Aldebaran (MI200) supports it.

fn get_voltage_soc(&self) -> Option<u16>

mV

fn get_voltage_gfx(&self) -> Option<u16>

mV

fn get_voltage_mem(&self) -> Option<u16>

mV

fn get_average_temperature_gfx(&self) -> Option<u16>

Average Temperature (unit: centi-Celsius)

fn get_average_temperature_soc(&self) -> Option<u16>

Average Temperature (unit: centi-Celsius)

fn get_average_temperature_core(&self) -> Option<Vec<u16>>

Average Temperature (unit: centi-Celsius)

fn get_average_temperature_l3(&self) -> Option<Vec<u16>>

Average Temperature (unit: centi-Celsius)

fn get_average_cpu_voltage(&self) -> Option<u16>

Power/Voltage (unit: mV) only Vangogh with gpu_metrics_v2_4 supports it.

fn get_average_soc_voltage(&self) -> Option<u16>

Power/Voltage (unit: mV) only Vangogh with gpu_metrics_v2_4 supports it.

fn get_average_gfx_voltage(&self) -> Option<u16>

Power/Voltage (unit: mV) only Vangogh with gpu_metrics_v2_4 supports it.

fn get_average_cpu_current(&self) -> Option<u16>

Power/Current (unit: mA), only Vangogh with gpu_metrics_v2_4 supports it.

fn get_average_soc_current(&self) -> Option<u16>

Power/Voltage (unit: mV) only Vangogh with gpu_metrics_v2_4 supports it.

fn get_average_gfx_current(&self) -> Option<u16>

Power/Voltage (unit: mV) only Vangogh with gpu_metrics_v2_4 supports it.

fn get_gfxclk_lock_status(&self) -> Option<u32>

Clock Lock Status. Each bit corresponds to clock instance, only MI300 with gpu_metrics_v1_4 or gpu_metrics_v1_5 supports it.

fn get_current_socket_power(&self) -> Option<u16>

Only MI300 with gpu_metrics_v1_4 or gpu_metrics_v1_5 supports it.

fn get_all_instances_current_gfxclk(&self) -> Option<[u16; 8]>

All instances (XCC) current gfx clock, only MI300 with gpu_metrics_v1_4 or gpu_metrics_v1_5 supports it.

fn get_all_instances_current_socclk(&self) -> Option<[u16; 4]>

All instances current soc clock, only MI300 with gpu_metrics_v1_4 or gpu_metrics_v1_5 supports it.

fn get_all_instances_current_vclk0(&self) -> Option<[u16; 4]>

Only MI300 with gpu_metrics_v1_4 or gpu_metrics_v1_5 supports it.

fn get_all_instances_current_dclk0(&self) -> Option<[u16; 4]>

Only MI300 with gpu_metrics_v1_4 or gpu_metrics_v1_5 supports it.

fn get_all_vcn_activity(&self) -> Option<[u16; 4]>

Utilization (%), only MI300 with gpu_metrics_v1_4 or gpu_metrics_v1_5 supports it.

fn get_all_jpeg_activity(&self) -> Option<[u16; 32]>

Utilization (%), only MI300 with gpu_metrics_v1_5 supports it.

fn get_throttle_residency_prochot(&self) -> Option<u32>

Strix Point, Krackan Point and Strix Halo supports it.

fn get_throttle_residency_spl(&self) -> Option<u32>

Strix Point, Krackan Point and Strix Halo supports it.

fn get_throttle_residency_fppt(&self) -> Option<u32>

Strix Point, Krackan Point and Strix Halo supports it.

fn get_throttle_residency_sppt(&self) -> Option<u32>

Strix Point, Krackan Point and Strix Halo supports it.

fn get_throttle_residency_thm_core(&self) -> Option<u32>

Strix Point, Krackan Point and Strix Halo supports it.

fn get_throttle_residency_thm_gfx(&self) -> Option<u32>

Strix Point, Krackan Point and Strix Halo supports it.

fn get_throttle_residency_thm_soc(&self) -> Option<u32>

Strix Point, Krackan Point and Strix Halo supports it.