amdsmi_gpu_metrics_t Struct Reference#
Structure holds the gpu metrics values for a device. More...
#include <amdsmi.h>
Data Fields | |
| amd_metrics_table_header_t | common_header |
| uint16_t | temperature_edge |
| v1.0 Base | |
| uint16_t | temperature_hotspot |
| uint16_t | temperature_mem |
| uint16_t | temperature_vrgfx |
| uint16_t | temperature_vrsoc |
| uint16_t | temperature_vrmem |
| uint16_t | average_gfx_activity |
| Average Utilization (in %) | |
| uint16_t | average_umc_activity |
| memory controller | |
| uint16_t | average_mm_activity |
| UVD or VCN. | |
| uint16_t | average_socket_power |
| Power (W) /Energy (15.259uJ per 1ns) | |
| uint64_t | energy_accumulator |
| v1 mod. (32->64) | |
| uint64_t | system_clock_counter |
| Driver attached timestamp (in ns) | |
| uint16_t | average_gfxclk_frequency |
| Average clocks (MHz) | |
| uint16_t | average_socclk_frequency |
| uint16_t | average_uclk_frequency |
| uint16_t | average_vclk0_frequency |
| uint16_t | average_dclk0_frequency |
| uint16_t | average_vclk1_frequency |
| uint16_t | average_dclk1_frequency |
| uint16_t | current_gfxclk |
| Current clocks (MHz) | |
| uint16_t | current_socclk |
| uint16_t | current_uclk |
| uint16_t | current_vclk0 |
| uint16_t | current_dclk0 |
| uint16_t | current_vclk1 |
| uint16_t | current_dclk1 |
| uint32_t | throttle_status |
| Throttle status. | |
| uint16_t | current_fan_speed |
| Fans (RPM) | |
| uint16_t | pcie_link_width |
| Link width (number of lanes) /speed (0.1 GT/s) | |
| uint16_t | pcie_link_speed |
| in 0.1 GT/s; v1 mod. (8->16) | |
| uint32_t | gfx_activity_acc |
| new in v1 | |
| uint32_t | mem_activity_acc |
| new in v1 | |
| uint16_t | temperature_hbm [AMDSMI_NUM_HBM_INSTANCES] |
| new in v1 | |
| uint64_t | firmware_timestamp |
| PMFW attached timestamp (10ns resolution) | |
| uint16_t | voltage_soc |
| In mV. | |
| uint16_t | voltage_gfx |
| In mV. | |
| uint16_t | voltage_mem |
| In mV. | |
| uint64_t | indep_throttle_status |
| Throttle status. | |
| uint16_t | current_socket_power |
| In Watts. | |
| uint16_t | vcn_activity [AMDSMI_MAX_NUM_VCN] |
| Utilization (%) | |
| uint32_t | gfxclk_lock_status |
| Clock Lock Status. Each bit corresponds to clock instance. | |
| uint16_t | xgmi_link_width |
| XGMI bus width in GB/s. | |
| uint16_t | xgmi_link_speed |
| XGMI bus bitrate in GB/s. | |
| uint64_t | pcie_bandwidth_acc |
| PCIE accumulated bandwidth (GB/sec) | |
| uint64_t | pcie_bandwidth_inst |
| PCIE instantaneous bandwidth (GB/sec) | |
| uint64_t | pcie_l0_to_recov_count_acc |
| PCIE L0 to recovery state transition accumulated count. | |
| uint64_t | pcie_replay_count_acc |
| PCIE replay accumulated count. | |
| uint64_t | pcie_replay_rover_count_acc |
| PCIE replay rollover accumulated count. | |
| uint64_t | xgmi_read_data_acc [AMDSMI_MAX_NUM_XGMI_LINKS] |
| XGMI accumulated data transfer size(KiloBytes) | |
| uint64_t | xgmi_write_data_acc [AMDSMI_MAX_NUM_XGMI_LINKS] |
| In KB. | |
| uint16_t | current_gfxclks [AMDSMI_MAX_NUM_GFX_CLKS] |
| XGMI current data transfer size(KiloBytes) | |
| uint16_t | current_socclks [AMDSMI_MAX_NUM_CLKS] |
| In KB. | |
| uint16_t | current_vclk0s [AMDSMI_MAX_NUM_CLKS] |
| In KB. | |
| uint16_t | current_dclk0s [AMDSMI_MAX_NUM_CLKS] |
| In KB. | |
| uint16_t | jpeg_activity [AMDSMI_MAX_NUM_JPEG] |
| v1.5 additions | |
| uint32_t | pcie_nak_sent_count_acc |
| PCIE NAK sent accumulated count. | |
| uint32_t | pcie_nak_rcvd_count_acc |
| PCIE NAK received accumulated count. | |
| uint64_t | accumulation_counter |
| v1.6 additions | |
| uint64_t | prochot_residency_acc |
| Accumulated throttler residencies. | |
| uint64_t | ppt_residency_acc |
| Accumulated throttler residencies. | |
| uint64_t | socket_thm_residency_acc |
| Accumulated throttler residencies. | |
| uint64_t | vr_thm_residency_acc |
| uint64_t | hbm_thm_residency_acc |
| uint16_t | num_partition |
| Number of current partition. | |
| amdsmi_gpu_xcp_metrics_t | xcp_stats [AMDSMI_MAX_NUM_XCP] |
| uint32_t | pcie_lc_perf_other_end_recovery |
| PCIE other end recovery counter. | |
| uint64_t | vram_max_bandwidth |
| v1.7 additions | |
| uint16_t | xgmi_link_status [AMDSMI_MAX_NUM_XGMI_LINKS] |
| XGMI link status(up/down) | |
| uint16_t | temperature_hbm_stacks [AMDSMI_MAX_NUM_HBM_STACKS] |
| v1.9 additions | |
| uint16_t | temperature_mid [AMDSMI_MAX_NUM_MID] |
| temperature of the MID in C | |
| uint16_t | temperature_aid [AMDSMI_MAX_NUM_AID] |
| temperature of the AID in C | |
| uint16_t | current_uclk_aid [AMDSMI_MAX_NUM_CLKS_PER_AID] |
| In MHz. | |
| uint16_t | current_socclks_mid [AMDSMI_MAX_NUM_CLKS_PER_MID] |
| In MHz. | |
| amdsmi_apu_metrics_t * | apu_metrics |
| APU metrics auxiliary data. | |
Detailed Description
Structure holds the gpu metrics values for a device.
This structure is extended to fit the needs of different GPU metric versions when exposing data through the structure. Depending on the version, some data members will hold data, and some will not. A good example is the set of 'current clocks': current_gfxclk, current_socclk, current_vclk0, current_dclk0. These are single-valued data members, up to version 1.3. For version 1.4 and up these are multi-valued data members (arrays) and their counterparts; current_gfxclks[], current_socclks[], current_vclk0s[], current_dclk0s[], will hold the data
Field Documentation
◆ common_header
| amd_metrics_table_header_t amdsmi_gpu_metrics_t::common_header |
◆ temperature_edge
| uint16_t amdsmi_gpu_metrics_t::temperature_edge |
◆ temperature_hotspot
◆ temperature_mem
◆ temperature_vrgfx
◆ temperature_vrsoc
◆ temperature_vrmem
◆ average_gfx_activity
| uint16_t amdsmi_gpu_metrics_t::average_gfx_activity |
◆ average_umc_activity
| uint16_t amdsmi_gpu_metrics_t::average_umc_activity |
◆ average_mm_activity
| uint16_t amdsmi_gpu_metrics_t::average_mm_activity |
◆ average_socket_power
| uint16_t amdsmi_gpu_metrics_t::average_socket_power |
◆ energy_accumulator
| uint64_t amdsmi_gpu_metrics_t::energy_accumulator |
◆ system_clock_counter
| uint64_t amdsmi_gpu_metrics_t::system_clock_counter |
◆ average_gfxclk_frequency
| uint16_t amdsmi_gpu_metrics_t::average_gfxclk_frequency |
◆ average_socclk_frequency
◆ average_uclk_frequency
◆ average_vclk0_frequency
◆ average_dclk0_frequency
◆ average_vclk1_frequency
◆ average_dclk1_frequency
◆ current_gfxclk
| uint16_t amdsmi_gpu_metrics_t::current_gfxclk |
◆ current_socclk
◆ current_uclk
◆ current_vclk0
◆ current_dclk0
◆ current_vclk1
◆ current_dclk1
◆ throttle_status
| uint32_t amdsmi_gpu_metrics_t::throttle_status |
◆ current_fan_speed
| uint16_t amdsmi_gpu_metrics_t::current_fan_speed |
◆ pcie_link_width
| uint16_t amdsmi_gpu_metrics_t::pcie_link_width |
◆ pcie_link_speed
| uint16_t amdsmi_gpu_metrics_t::pcie_link_speed |
◆ gfx_activity_acc
◆ mem_activity_acc
◆ temperature_hbm
| uint16_t amdsmi_gpu_metrics_t::temperature_hbm[AMDSMI_NUM_HBM_INSTANCES] |
◆ firmware_timestamp
| uint64_t amdsmi_gpu_metrics_t::firmware_timestamp |
◆ voltage_soc
◆ voltage_gfx
◆ voltage_mem
◆ indep_throttle_status
| uint64_t amdsmi_gpu_metrics_t::indep_throttle_status |
◆ current_socket_power
| uint16_t amdsmi_gpu_metrics_t::current_socket_power |
◆ vcn_activity
| uint16_t amdsmi_gpu_metrics_t::vcn_activity[AMDSMI_MAX_NUM_VCN] |
◆ gfxclk_lock_status
| uint32_t amdsmi_gpu_metrics_t::gfxclk_lock_status |
◆ xgmi_link_width
| uint16_t amdsmi_gpu_metrics_t::xgmi_link_width |
◆ xgmi_link_speed
| uint16_t amdsmi_gpu_metrics_t::xgmi_link_speed |
◆ pcie_bandwidth_acc
| uint64_t amdsmi_gpu_metrics_t::pcie_bandwidth_acc |
◆ pcie_bandwidth_inst
| uint64_t amdsmi_gpu_metrics_t::pcie_bandwidth_inst |
◆ pcie_l0_to_recov_count_acc
| uint64_t amdsmi_gpu_metrics_t::pcie_l0_to_recov_count_acc |
◆ pcie_replay_count_acc
| uint64_t amdsmi_gpu_metrics_t::pcie_replay_count_acc |
◆ pcie_replay_rover_count_acc
| uint64_t amdsmi_gpu_metrics_t::pcie_replay_rover_count_acc |
◆ xgmi_read_data_acc
| uint64_t amdsmi_gpu_metrics_t::xgmi_read_data_acc[AMDSMI_MAX_NUM_XGMI_LINKS] |
◆ xgmi_write_data_acc
| uint64_t amdsmi_gpu_metrics_t::xgmi_write_data_acc[AMDSMI_MAX_NUM_XGMI_LINKS] |
◆ current_gfxclks
| uint16_t amdsmi_gpu_metrics_t::current_gfxclks[AMDSMI_MAX_NUM_GFX_CLKS] |
◆ current_socclks
| uint16_t amdsmi_gpu_metrics_t::current_socclks[AMDSMI_MAX_NUM_CLKS] |
◆ current_vclk0s
| uint16_t amdsmi_gpu_metrics_t::current_vclk0s[AMDSMI_MAX_NUM_CLKS] |
◆ current_dclk0s
| uint16_t amdsmi_gpu_metrics_t::current_dclk0s[AMDSMI_MAX_NUM_CLKS] |
◆ jpeg_activity
| uint16_t amdsmi_gpu_metrics_t::jpeg_activity[AMDSMI_MAX_NUM_JPEG] |
◆ pcie_nak_sent_count_acc
| uint32_t amdsmi_gpu_metrics_t::pcie_nak_sent_count_acc |
◆ pcie_nak_rcvd_count_acc
| uint32_t amdsmi_gpu_metrics_t::pcie_nak_rcvd_count_acc |
◆ accumulation_counter
| uint64_t amdsmi_gpu_metrics_t::accumulation_counter |
◆ prochot_residency_acc
| uint64_t amdsmi_gpu_metrics_t::prochot_residency_acc |
◆ ppt_residency_acc
| uint64_t amdsmi_gpu_metrics_t::ppt_residency_acc |
Accumulated throttler residencies.
Prochot (thermal) - PPT (power) Package Power Tracking (PPT) violation % (greater than 0% is a violation); aka PVIOL
Ex. PVIOL/TVIOL calculations Where A and B are measurements recorded at prior points in time. Typically A is the earlier measured value and B is the latest measured value.
PVIOL % = (PptResidencyAcc (B) - PptResidencyAcc (A)) * 100/ (AccumulationCounter (B) - AccumulationCounter (A)) TVIOL % = (SocketThmResidencyAcc (B) - SocketThmResidencyAcc (A)) * 100 / (AccumulationCounter (B) - AccumulationCounter (A))
◆ socket_thm_residency_acc
| uint64_t amdsmi_gpu_metrics_t::socket_thm_residency_acc |
Accumulated throttler residencies.
Socket (thermal) - Socket thermal violation % (greater than 0% is a violation); aka TVIOL
Ex. PVIOL/TVIOL calculations Where A and B are measurements recorded at prior points in time. Typically A is the earlier measured value and B is the latest measured value.
PVIOL % = (PptResidencyAcc (B) - PptResidencyAcc (A)) * 100/ (AccumulationCounter (B) - AccumulationCounter (A)) TVIOL % = (SocketThmResidencyAcc (B) - SocketThmResidencyAcc (A)) * 100 / (AccumulationCounter (B) - AccumulationCounter (A))
◆ vr_thm_residency_acc
◆ hbm_thm_residency_acc
◆ num_partition
| uint16_t amdsmi_gpu_metrics_t::num_partition |
◆ xcp_stats
| amdsmi_gpu_xcp_metrics_t amdsmi_gpu_metrics_t::xcp_stats[AMDSMI_MAX_NUM_XCP] |
◆ pcie_lc_perf_other_end_recovery
| uint32_t amdsmi_gpu_metrics_t::pcie_lc_perf_other_end_recovery |
◆ vram_max_bandwidth
| uint64_t amdsmi_gpu_metrics_t::vram_max_bandwidth |
◆ xgmi_link_status
| uint16_t amdsmi_gpu_metrics_t::xgmi_link_status[AMDSMI_MAX_NUM_XGMI_LINKS] |
◆ temperature_hbm_stacks
| uint16_t amdsmi_gpu_metrics_t::temperature_hbm_stacks[AMDSMI_MAX_NUM_HBM_STACKS] |
◆ temperature_mid
| uint16_t amdsmi_gpu_metrics_t::temperature_mid[AMDSMI_MAX_NUM_MID] |
◆ temperature_aid
| uint16_t amdsmi_gpu_metrics_t::temperature_aid[AMDSMI_MAX_NUM_AID] |
◆ current_uclk_aid
| uint16_t amdsmi_gpu_metrics_t::current_uclk_aid[AMDSMI_MAX_NUM_CLKS_PER_AID] |
◆ current_socclks_mid
| uint16_t amdsmi_gpu_metrics_t::current_socclks_mid[AMDSMI_MAX_NUM_CLKS_PER_MID] |
◆ apu_metrics
| amdsmi_apu_metrics_t* amdsmi_gpu_metrics_t::apu_metrics |
APU metrics auxiliary data.
This pointer is non-null only when the queried device reports APU-specific metrics (currently APU metrics table versions 2.4 or 3.0). Callers must validate it before dereferencing. For GPU (discrete) devices, this pointer will be nullptr.
Thread Safety and Lifetime: The pointed-to storage uses thread-local storage and is invalidated by ANY subsequent call to amdsmi_get_gpu_metrics_info() or amdsmi_get_gpu_partition_metrics_info() made on the same thread, regardless of which device is queried. This means:
- Querying device B invalidates the apu_metrics pointer from device A on the same thread
- Callers that need to retain APU metrics data across multiple queries MUST copy the entire amdsmi_apu_metrics_t structure contents immediately after the query
Version Detection: Use ::common_header.format_revision and ::common_header.content_revision to determine which APU metrics version is active:
- v2.4: format_revision == 2 && content_revision == 4
- v3.0: format_revision == 3 && content_revision == 0
Field Validity: Not all fields are valid for all versions. Fields contain sentinel value 0xFFFF (65535) when not populated for the current version. Refer to inline comments in amdsmi_apu_metrics_t for per-field version availability.
The documentation for this struct was generated from the following file: