perf/util/pmu.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 #ifndef __PMU_H
0003 #define __PMU_H
0004
0005 #include <linux/bitmap.h>
0006 #include <linux/compiler.h>
0007 #include <linux/perf_event.h>
0008 #include <linux/list.h>
0009 #include <stdbool.h>
0010 #include "parse-events.h"
0011 #include "pmu-events/pmu-events.h"
0012
0013 struct evsel_config_term;
0014 struct perf_cpu_map;
0015
0016 enum {
0017     PERF_PMU_FORMAT_VALUE_CONFIG,
0018     PERF_PMU_FORMAT_VALUE_CONFIG1,
0019     PERF_PMU_FORMAT_VALUE_CONFIG2,
0020 };
0021
0022 #define PERF_PMU_FORMAT_BITS 64
0023 #define EVENT_SOURCE_DEVICE_PATH "/bus/event_source/devices/"
0024 #define CPUS_TEMPLATE_CPU   "%s/bus/event_source/devices/%s/cpus"
0025 #define MAX_PMU_NAME_LEN 128
0026
0027 struct perf_event_attr;
0028
0029 struct perf_pmu_caps {
0030     char *name;
0031     char *value;
0032     struct list_head list;
0033 };
0034
0035 struct perf_pmu {
0036     char *name;
0037     char *alias_name;
0038     char *id;
0039     __u32 type;
0040     bool selectable;
0041     bool is_uncore;
0042     bool is_hybrid;
0043     bool auxtrace;
0044     int max_precise;
0045     struct perf_event_attr *default_config;
0046     struct perf_cpu_map *cpus;
0047     struct list_head format;  /* HEAD struct perf_pmu_format -> list */
0048     struct list_head aliases; /* HEAD struct perf_pmu_alias -> list */
0049     bool caps_initialized;
0050     u32 nr_caps;
0051     struct list_head caps;    /* HEAD struct perf_pmu_caps -> list */
0052     struct list_head list;    /* ELEM */
0053     struct list_head hybrid_list;
0054
0055     struct {
0056         bool exclude_guest;
0057     } missing_features;
0058 };
0059
0060 extern struct perf_pmu perf_pmu__fake;
0061
0062 struct perf_pmu_info {
0063     const char *unit;
0064     const char *metric_expr;
0065     const char *metric_name;
0066     double scale;
0067     bool per_pkg;
0068     bool snapshot;
0069 };
0070
0071 #define UNIT_MAX_LEN    31 /* max length for event unit name */
0072
0073 struct perf_pmu_alias {
0074     char *name;
0075     char *desc;
0076     char *long_desc;
0077     char *topic;
0078     char *str;
0079     struct list_head terms; /* HEAD struct parse_events_term -> list */
0080     struct list_head list;  /* ELEM */
0081     char unit[UNIT_MAX_LEN+1];
0082     double scale;
0083     bool per_pkg;
0084     bool snapshot;
0085     bool deprecated;
0086     char *metric_expr;
0087     char *metric_name;
0088     char *pmu_name;
0089 };
0090
0091 struct perf_pmu *perf_pmu__find(const char *name);
0092 struct perf_pmu *perf_pmu__find_by_type(unsigned int type);
0093 void pmu_add_sys_aliases(struct list_head *head, struct perf_pmu *pmu);
0094 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
0095              struct list_head *head_terms,
0096              struct parse_events_error *error);
0097 int perf_pmu__config_terms(const char *pmu_name, struct list_head *formats,
0098                struct perf_event_attr *attr,
0099                struct list_head *head_terms,
0100                bool zero, struct parse_events_error *error);
0101 __u64 perf_pmu__format_bits(struct list_head *formats, const char *name);
0102 int perf_pmu__format_type(struct list_head *formats, const char *name);
0103 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
0104               struct perf_pmu_info *info);
0105 struct list_head *perf_pmu__alias(struct perf_pmu *pmu,
0106                   struct list_head *head_terms);
0107 void perf_pmu_error(struct list_head *list, char *name, char const *msg);
0108
0109 int perf_pmu__new_format(struct list_head *list, char *name,
0110              int config, unsigned long *bits);
0111 void perf_pmu__set_format(unsigned long *bits, long from, long to);
0112 int perf_pmu__format_parse(char *dir, struct list_head *head);
0113 void perf_pmu__del_formats(struct list_head *formats);
0114
0115 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu);
0116
0117 bool is_pmu_core(const char *name);
0118 void print_pmu_events(const char *event_glob, bool name_only, bool quiet,
0119               bool long_desc, bool details_flag,
0120               bool deprecated, const char *pmu_name);
0121 bool pmu_have_event(const char *pname, const char *name);
0122
0123 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt, ...) __scanf(3, 4);
0124
0125 int perf_pmu__test(void);
0126
0127 struct perf_event_attr *perf_pmu__get_default_config(struct perf_pmu *pmu);
0128 void pmu_add_cpu_aliases_table(struct list_head *head, struct perf_pmu *pmu,
0129                    const struct pmu_events_table *table);
0130
0131 char *perf_pmu__getcpuid(struct perf_pmu *pmu);
0132 const struct pmu_events_table *pmu_events_table__find(void);
0133 bool pmu_uncore_alias_match(const char *pmu_name, const char *name);
0134 void perf_pmu_free_alias(struct perf_pmu_alias *alias);
0135
0136 int perf_pmu__convert_scale(const char *scale, char **end, double *sval);
0137
0138 int perf_pmu__caps_parse(struct perf_pmu *pmu);
0139
0140 void perf_pmu__warn_invalid_config(struct perf_pmu *pmu, __u64 config,
0141                    const char *name);
0142
0143 bool perf_pmu__has_hybrid(void);
0144 int perf_pmu__match(char *pattern, char *name, char *tok);
0145
0146 int perf_pmu__cpus_match(struct perf_pmu *pmu, struct perf_cpu_map *cpus,
0147              struct perf_cpu_map **mcpus_ptr,
0148              struct perf_cpu_map **ucpus_ptr);
0149
0150 char *pmu_find_real_name(const char *name);
0151 char *pmu_find_alias_name(const char *name);
0152 #endif /* __PMU_H */