mirror of
git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2025-08-05 16:54:27 +00:00
53cc0b351e
Add a tool PMU for hwmon events but don't enable.
The hwmon sysfs ABI is defined in
Documentation/hwmon/sysfs-interface.rst. Create a PMU that reads the
hwmon input and can be used in `perf stat` and metrics much as an
uncore PMU can.
For example, when enabled by a later patch, the following shows
reading the CPU temperature and 2 fan speeds alongside the uncore
frequency:
```
$ perf stat -e temp_cpu,fan1,hwmon_thinkpad/fan2/,tool/num_cpus_online/ -M UNCORE_FREQ -I 1000
1.001153138 52.00 'C temp_cpu
1.001153138 2,588 rpm fan1
1.001153138 2,482 rpm hwmon_thinkpad/fan2/
1.001153138 8 tool/num_cpus_online/
1.001153138 1,077,101,397 UNC_CLOCK.SOCKET # 1.08 UNCORE_FREQ
1.001153138 1,012,773,595 duration_time
...
```
The PMUs are named from /sys/class/hwmon/hwmon<num>/name and have an
alias of hwmon<num>.
Hwmon data is presented in multiple <type><number>_<item> files. The
<type><number> is used to identify the event as is the <type> followed
by the contents of the <type>_label file if it exists. The
<type><number>_input file gives the data read by perf.
When enabled by a later patch, in `perf list` the other hwmon <item>
files are used to give a richer description, for example:
```
hwmon:
temp1
[Temperature in unit acpitz named temp1. Unit: hwmon_acpitz]
in0
[Voltage in unit bat0 named in0. Unit: hwmon_bat0]
temp_core_0 OR temp2
[Temperature in unit coretemp named Core 0. crit=100'C,max=100'C crit_alarm=0'C. Unit:
hwmon_coretemp]
temp_core_1 OR temp3
[Temperature in unit coretemp named Core 1. crit=100'C,max=100'C crit_alarm=0'C. Unit:
hwmon_coretemp]
...
temp_package_id_0 OR temp1
[Temperature in unit coretemp named Package id 0. crit=100'C,max=100'C crit_alarm=0'C.
Unit: hwmon_coretemp]
temp1
[Temperature in unit iwlwifi_1 named temp1. Unit: hwmon_iwlwifi_1]
temp_composite OR temp1
[Temperature in unit nvme named Composite. alarm=0'C,crit=86.85'C,max=75.85'C,
min=-273.15'C. Unit: hwmon_nvme]
temp_sensor_1 OR temp2
[Temperature in unit nvme named Sensor 1. max=65261.8'C,min=-273.15'C. Unit: hwmon_nvme]
temp_sensor_2 OR temp3
[Temperature in unit nvme named Sensor 2. max=65261.8'C,min=-273.15'C. Unit: hwmon_nvme]
fan1
[Fan in unit thinkpad named fan1. Unit: hwmon_thinkpad]
fan2
[Fan in unit thinkpad named fan2. Unit: hwmon_thinkpad]
...
temp_cpu OR temp1
[Temperature in unit thinkpad named CPU. Unit: hwmon_thinkpad]
temp_gpu OR temp2
[Temperature in unit thinkpad named GPU. Unit: hwmon_thinkpad]
curr1
[Current in unit ucsi_source_psy_usbc000_0 named curr1. max=1.5A. Unit:
hwmon_ucsi_source_psy_usbc000_0]
in0
[Voltage in unit ucsi_source_psy_usbc000_0 named in0. max=5V,min=5V. Unit:
hwmon_ucsi_source_psy_usbc000_0]
```
As there may be multiple hwmon devices a range of PMU types are
reserved for their use and to identify the PMU as belonging to the
hwmon types.
Signed-off-by: Ian Rogers <irogers@google.com>
Cc: Ravi Bangoria <ravi.bangoria@amd.com>
Cc: Yoshihiro Furudera <fj5100bi@fujitsu.com>
Cc: Howard Chu <howardchu95@gmail.com>
Cc: Ze Gao <zegao2021@gmail.com>
Cc: Changbin Du <changbin.du@huawei.com>
Cc: Junhao He <hejunhao3@huawei.com>
Cc: Weilin Wang <weilin.wang@intel.com>
Cc: James Clark <james.clark@linaro.org>
Cc: Oliver Upton <oliver.upton@linux.dev>
Cc: Athira Jajeev <atrajeev@linux.vnet.ibm.com>
Link: https://lore.kernel.org/r/20241109003759.473460-5-irogers@google.com
Signed-off-by: Namhyung Kim <namhyung@kernel.org>
151 lines
4 KiB
C
151 lines
4 KiB
C
/* SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) */
|
|
#ifndef __HWMON_PMU_H
|
|
#define __HWMON_PMU_H
|
|
|
|
#include "pmu.h"
|
|
#include <stdbool.h>
|
|
|
|
struct list_head;
|
|
struct perf_thread_map;
|
|
|
|
/**
|
|
* enum hwmon_type:
|
|
*
|
|
* As described in Documentation/hwmon/sysfs-interface.rst hwmon events are
|
|
* defined over multiple files of the form <type><num>_<item>. This enum
|
|
* captures potential <type> values.
|
|
*
|
|
* This enum is exposed for testing.
|
|
*/
|
|
enum hwmon_type {
|
|
HWMON_TYPE_NONE,
|
|
|
|
HWMON_TYPE_CPU,
|
|
HWMON_TYPE_CURR,
|
|
HWMON_TYPE_ENERGY,
|
|
HWMON_TYPE_FAN,
|
|
HWMON_TYPE_HUMIDITY,
|
|
HWMON_TYPE_IN,
|
|
HWMON_TYPE_INTRUSION,
|
|
HWMON_TYPE_POWER,
|
|
HWMON_TYPE_PWM,
|
|
HWMON_TYPE_TEMP,
|
|
|
|
HWMON_TYPE_MAX
|
|
};
|
|
|
|
/**
|
|
* enum hwmon_item:
|
|
*
|
|
* Similar to enum hwmon_type but describes the item part of a a sysfs filename.
|
|
*
|
|
* This enum is exposed for testing.
|
|
*/
|
|
enum hwmon_item {
|
|
HWMON_ITEM_NONE,
|
|
|
|
HWMON_ITEM_ACCURACY,
|
|
HWMON_ITEM_ALARM,
|
|
HWMON_ITEM_AUTO_CHANNELS_TEMP,
|
|
HWMON_ITEM_AVERAGE,
|
|
HWMON_ITEM_AVERAGE_HIGHEST,
|
|
HWMON_ITEM_AVERAGE_INTERVAL,
|
|
HWMON_ITEM_AVERAGE_INTERVAL_MAX,
|
|
HWMON_ITEM_AVERAGE_INTERVAL_MIN,
|
|
HWMON_ITEM_AVERAGE_LOWEST,
|
|
HWMON_ITEM_AVERAGE_MAX,
|
|
HWMON_ITEM_AVERAGE_MIN,
|
|
HWMON_ITEM_BEEP,
|
|
HWMON_ITEM_CAP,
|
|
HWMON_ITEM_CAP_HYST,
|
|
HWMON_ITEM_CAP_MAX,
|
|
HWMON_ITEM_CAP_MIN,
|
|
HWMON_ITEM_CRIT,
|
|
HWMON_ITEM_CRIT_HYST,
|
|
HWMON_ITEM_DIV,
|
|
HWMON_ITEM_EMERGENCY,
|
|
HWMON_ITEM_EMERGENCY_HIST,
|
|
HWMON_ITEM_ENABLE,
|
|
HWMON_ITEM_FAULT,
|
|
HWMON_ITEM_FREQ,
|
|
HWMON_ITEM_HIGHEST,
|
|
HWMON_ITEM_INPUT,
|
|
HWMON_ITEM_LABEL,
|
|
HWMON_ITEM_LCRIT,
|
|
HWMON_ITEM_LCRIT_HYST,
|
|
HWMON_ITEM_LOWEST,
|
|
HWMON_ITEM_MAX,
|
|
HWMON_ITEM_MAX_HYST,
|
|
HWMON_ITEM_MIN,
|
|
HWMON_ITEM_MIN_HYST,
|
|
HWMON_ITEM_MOD,
|
|
HWMON_ITEM_OFFSET,
|
|
HWMON_ITEM_PULSES,
|
|
HWMON_ITEM_RATED_MAX,
|
|
HWMON_ITEM_RATED_MIN,
|
|
HWMON_ITEM_RESET_HISTORY,
|
|
HWMON_ITEM_TARGET,
|
|
HWMON_ITEM_TYPE,
|
|
HWMON_ITEM_VID,
|
|
|
|
HWMON_ITEM__MAX,
|
|
};
|
|
|
|
bool perf_pmu__is_hwmon(const struct perf_pmu *pmu);
|
|
bool evsel__is_hwmon(const struct evsel *evsel);
|
|
|
|
/**
|
|
* parse_hwmon_filename() - Parse filename into constituent parts.
|
|
*
|
|
* @filename: To be parsed, of the form <type><number>_<item>.
|
|
* @type: The type defined from the parsed file name.
|
|
* @number: The number of the type, for example there may be more than 1 fan.
|
|
* @item: A hwmon <type><number> may have multiple associated items.
|
|
* @alarm: Is the filename for an alarm value?
|
|
*
|
|
* An example of a hwmon filename is "temp1_input". The type is temp for a
|
|
* temperature value. The number is 1. The item within the file is an input
|
|
* value - the temperature itself. This file doesn't contain an alarm value.
|
|
*
|
|
* Exposed for testing.
|
|
*/
|
|
bool parse_hwmon_filename(const char *filename,
|
|
enum hwmon_type *type,
|
|
int *number,
|
|
enum hwmon_item *item,
|
|
bool *alarm);
|
|
|
|
/**
|
|
* hwmon_pmu__new() - Allocate and construct a hwmon PMU.
|
|
*
|
|
* @pmus: The list of PMUs to be added to.
|
|
* @hwmon_dir: An O_DIRECTORY file descriptor for a hwmon directory.
|
|
* @sysfs_name: Name of the hwmon sysfs directory like hwmon0.
|
|
* @name: The contents of the "name" file in the hwmon directory.
|
|
*
|
|
* Exposed for testing. Regular construction should happen via
|
|
* perf_pmus__read_hwmon_pmus.
|
|
*/
|
|
struct perf_pmu *hwmon_pmu__new(struct list_head *pmus, int hwmon_dir,
|
|
const char *sysfs_name, const char *name);
|
|
void hwmon_pmu__exit(struct perf_pmu *pmu);
|
|
|
|
int hwmon_pmu__for_each_event(struct perf_pmu *pmu, void *state, pmu_event_callback cb);
|
|
size_t hwmon_pmu__num_events(struct perf_pmu *pmu);
|
|
bool hwmon_pmu__have_event(struct perf_pmu *pmu, const char *name);
|
|
int hwmon_pmu__config_terms(const struct perf_pmu *pmu,
|
|
struct perf_event_attr *attr,
|
|
struct parse_events_terms *terms,
|
|
struct parse_events_error *err);
|
|
int hwmon_pmu__check_alias(struct parse_events_terms *terms, struct perf_pmu_info *info,
|
|
struct parse_events_error *err);
|
|
|
|
int perf_pmus__read_hwmon_pmus(struct list_head *pmus);
|
|
|
|
|
|
int evsel__hwmon_pmu_open(struct evsel *evsel,
|
|
struct perf_thread_map *threads,
|
|
int start_cpu_map_idx, int end_cpu_map_idx);
|
|
int evsel__hwmon_pmu_read(struct evsel *evsel, int cpu_map_idx, int thread);
|
|
|
|
#endif /* __HWMON_PMU_H */
|