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

#ifndef __PMU_H
#define __PMU_H

#include <linux/bitmap.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;
	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;
};

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 pmu_have_event(const char *pname, const char *name);

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