[mirror_ubuntu-bionic-kernel.git] / tools / perf / util / pmu.h

#ifndef __PMU_H
#define __PMU_H

#include <linux/bitmap.h>
#include <linux/compiler.h>
#include <linux/perf_event.h>
#include <stdbool.h>
#include "evsel.h"
#include "parse-events.h"

enum {
	PERF_PMU_FORMAT_VALUE_CONFIG,
	PERF_PMU_FORMAT_VALUE_CONFIG1,
	PERF_PMU_FORMAT_VALUE_CONFIG2,
};

#define PERF_PMU_FORMAT_BITS 64

struct perf_event_attr;

struct perf_pmu {
	char *name;
	__u32 type;
	bool selectable;
	struct perf_event_attr *default_config;
	struct cpu_map *cpus;
	struct list_head format;  /* HEAD struct perf_pmu_format -> list */
	struct list_head aliases; /* HEAD struct perf_pmu_alias -> list */
	struct list_head list;    /* ELEM */
	int (*set_drv_config)	(struct perf_evsel_config_term *term);
};

struct perf_pmu_info {
	const char *unit;
	const char *metric_expr;
	const char *metric_name;
	double scale;
	bool per_pkg;
	bool snapshot;
};

#define UNIT_MAX_LEN	31 /* max length for event unit name */

struct perf_pmu_alias {
	char *name;
	char *desc;
	char *long_desc;
	char *topic;
	char *str;
	struct list_head terms; /* HEAD struct parse_events_term -> list */
	struct list_head list;  /* ELEM */
	char unit[UNIT_MAX_LEN+1];
	double scale;
	bool per_pkg;
	bool snapshot;
	char *metric_expr;
	char *metric_name;
};

struct perf_pmu *perf_pmu__find(const char *name);
int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
		     struct list_head *head_terms,
		     struct parse_events_error *error);
int perf_pmu__config_terms(struct list_head *formats,
			   struct perf_event_attr *attr,
			   struct list_head *head_terms,
			   bool zero, struct parse_events_error *error);
__u64 perf_pmu__format_bits(struct list_head *formats, const char *name);
int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
			  struct perf_pmu_info *info);
struct list_head *perf_pmu__alias(struct perf_pmu *pmu,
				  struct list_head *head_terms);
int perf_pmu_wrap(void);
void perf_pmu_error(struct list_head *list, char *name, char const *msg);

int perf_pmu__new_format(struct list_head *list, char *name,
			 int config, unsigned long *bits);
void perf_pmu__set_format(unsigned long *bits, long from, long to);
int perf_pmu__format_parse(char *dir, struct list_head *head);

struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu);

void print_pmu_events(const char *event_glob, bool name_only, bool quiet,
		      bool long_desc, bool details_flag);
bool pmu_have_event(const char *pname, const char *name);

int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt, ...) __scanf(3, 4);

int perf_pmu__test(void);

struct perf_event_attr *perf_pmu__get_default_config(struct perf_pmu *pmu);

#endif /* __PMU_H */
Commit	Line	Data
cd82a32e JO	1	#ifndef __PMU_H
	2	#define __PMU_H
	3
d944c4ee	4	#include <linux/bitmap.h>
3ee350fb	5	#include <linux/compiler.h>
d2709c7c	6	#include <linux/perf_event.h>
dc098b35	7	#include <stdbool.h>
859442bd	8	#include "evsel.h"
e64b020b	9	#include "parse-events.h"
cd82a32e JO	10
	11	enum {
	12	PERF_PMU_FORMAT_VALUE_CONFIG,
	13	PERF_PMU_FORMAT_VALUE_CONFIG1,
	14	PERF_PMU_FORMAT_VALUE_CONFIG2,
	15	};
	16
	17	#define PERF_PMU_FORMAT_BITS 64
	18
dc0a6202 AH	19	struct perf_event_attr;
dc0a6202 AH	20
cd82a32e JO	21	struct perf_pmu {
	22	char *name;
	23	__u32 type;
42634bc7	24	bool selectable;
dc0a6202	25	struct perf_event_attr *default_config;
7ae92e74	26	struct cpu_map *cpus;
885b5930 CS	27	struct list_head format; /* HEAD struct perf_pmu_format -> list */
	28	struct list_head aliases; /* HEAD struct perf_pmu_alias -> list */
	29	struct list_head list; /* ELEM */
859442bd	30	int (set_drv_config) (struct perf_evsel_config_term term);
cd82a32e JO	31	};
cd82a32e JO	32
46441bdc MF	33	struct perf_pmu_info {
46441bdc MF	34	const char *unit;
37932c18	35	const char *metric_expr;
96284814	36	const char *metric_name;
46441bdc	37	double scale;
044330c1	38	bool per_pkg;
1d9e446b	39	bool snapshot;
46441bdc MF	40	};
46441bdc MF	41
dcb4e102 KL	42	#define UNIT_MAX_LEN 31 /* max length for event unit name */
	43
	44	struct perf_pmu_alias {
	45	char *name;
08e60ed1	46	char *desc;
c8d6828a	47	char *long_desc;
dd5f1036	48	char *topic;
f2361024	49	char *str;
dcb4e102 KL	50	struct list_head terms; /* HEAD struct parse_events_term -> list */
	51	struct list_head list; /* ELEM */
	52	char unit[UNIT_MAX_LEN+1];
	53	double scale;
044330c1	54	bool per_pkg;
1d9e446b	55	bool snapshot;
00636c3b	56	char *metric_expr;
96284814	57	char *metric_name;
dcb4e102 KL	58	};
dcb4e102 KL	59
b6b96fb4	60	struct perf_pmu perf_pmu__find(const char name);
cd82a32e	61	int perf_pmu__config(struct perf_pmu pmu, struct perf_event_attr attr,
e64b020b JO	62	struct list_head *head_terms,
e64b020b JO	63	struct parse_events_error *error);
cff7f956 JO	64	int perf_pmu__config_terms(struct list_head *formats,
cff7f956 JO	65	struct perf_event_attr *attr,
dc0a6202	66	struct list_head *head_terms,
e64b020b	67	bool zero, struct parse_events_error *error);
09ff6071	68	__u64 perf_pmu__format_bits(struct list_head formats, const char name);
410136f5	69	int perf_pmu__check_alias(struct perf_pmu pmu, struct list_head head_terms,
46441bdc	70	struct perf_pmu_info *info);
a6146d50	71	struct list_head perf_pmu__alias(struct perf_pmu pmu,
5c6ccc37	72	struct list_head *head_terms);
cd82a32e JO	73	int perf_pmu_wrap(void);
	74	void perf_pmu_error(struct list_head list, char name, char const *msg);
	75
	76	int perf_pmu__new_format(struct list_head list, char name,
	77	int config, unsigned long *bits);
	78	void perf_pmu__set_format(unsigned long *bits, long from, long to);
cff7f956	79	int perf_pmu__format_parse(char dir, struct list_head head);
cd82a32e	80
50a9667c RR	81	struct perf_pmu perf_pmu__scan(struct perf_pmu pmu);
50a9667c RR	82
c8d6828a	83	void print_pmu_events(const char *event_glob, bool name_only, bool quiet,
bf874fcf	84	bool long_desc, bool details_flag);
4cabc3d1	85	bool pmu_have_event(const char pname, const char name);
dc098b35	86
3ee350fb	87	int perf_pmu__scan_file(struct perf_pmu pmu, const char name, const char *fmt, ...) __scanf(3, 4);
7d4bdab5	88
cd82a32e	89	int perf_pmu__test(void);
dc0a6202 AH	90
	91	struct perf_event_attr perf_pmu__get_default_config(struct perf_pmu pmu);
	92
cd82a32e	93	#endif /* __PMU_H */