[deliverable/linux.git] / tools / perf / util / hist.h

#ifndef __PERF_HIST_H
#define __PERF_HIST_H

#include <linux/types.h>
#include <pthread.h>
#include "callchain.h"
#include "header.h"

extern struct callchain_param callchain_param;

struct hist_entry;
struct addr_location;
struct symbol;

/*
 * The kernel collects the number of events it couldn't send in a stretch and
 * when possible sends this number in a PERF_RECORD_LOST event. The number of
 * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
 * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
 * the sum of all struct lost_event.lost fields reported.
 *
 * The total_period is needed because by default auto-freq is used, so
 * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
 * the total number of low level events, it is necessary to to sum all struct
 * sample_event.period and stash the result in total_period.
 */
struct events_stats {
	u64 total_period;
	u64 total_lost;
	u64 total_invalid_chains;
	u32 nr_events[PERF_RECORD_HEADER_MAX];
	u32 nr_lost_warned;
	u32 nr_unknown_events;
	u32 nr_invalid_chains;
	u32 nr_unknown_id;
	u32 nr_unprocessable_samples;
};

enum hist_column {
	HISTC_SYMBOL,
	HISTC_DSO,
	HISTC_THREAD,
	HISTC_COMM,
	HISTC_PARENT,
	HISTC_CPU,
	HISTC_SRCLINE,
	HISTC_MISPREDICT,
	HISTC_IN_TX,
	HISTC_ABORT,
	HISTC_SYMBOL_FROM,
	HISTC_SYMBOL_TO,
	HISTC_DSO_FROM,
	HISTC_DSO_TO,
	HISTC_LOCAL_WEIGHT,
	HISTC_GLOBAL_WEIGHT,
	HISTC_MEM_DADDR_SYMBOL,
	HISTC_MEM_DADDR_DSO,
	HISTC_MEM_LOCKED,
	HISTC_MEM_TLB,
	HISTC_MEM_LVL,
	HISTC_MEM_SNOOP,
	HISTC_NR_COLS, /* Last entry */
};

struct thread;
struct dso;

struct hists {
	struct rb_root		entries_in_array[2];
	struct rb_root		*entries_in;
	struct rb_root		entries;
	struct rb_root		entries_collapsed;
	u64			nr_entries;
	const struct thread	*thread_filter;
	const struct dso	*dso_filter;
	const char		*uid_filter_str;
	const char		*symbol_filter_str;
	pthread_mutex_t		lock;
	struct events_stats	stats;
	u64			event_stream;
	u16			col_len[HISTC_NR_COLS];
};

struct hist_entry *__hists__add_entry(struct hists *self,
				      struct addr_location *al,
				      struct symbol *parent, u64 period,
				      u64 weight);
int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
int hist_entry__sort_snprintf(struct hist_entry *self, char *bf, size_t size,
			      struct hists *hists);
void hist_entry__free(struct hist_entry *);

struct hist_entry *__hists__add_branch_entry(struct hists *self,
					     struct addr_location *al,
					     struct symbol *sym_parent,
					     struct branch_info *bi,
					     u64 period,
					     u64 weight);

struct hist_entry *__hists__add_mem_entry(struct hists *self,
					  struct addr_location *al,
					  struct symbol *sym_parent,
					  struct mem_info *mi,
					  u64 period,
					  u64 weight);

void hists__output_resort(struct hists *self);
void hists__collapse_resort(struct hists *self);

void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
void hists__output_recalc_col_len(struct hists *hists, int max_rows);

void hists__inc_nr_entries(struct hists *hists, struct hist_entry *h);
void hists__inc_nr_events(struct hists *self, u32 type);
void events_stats__inc(struct events_stats *stats, u32 type);
size_t events_stats__fprintf(struct events_stats *stats, FILE *fp);

size_t hists__fprintf(struct hists *self, bool show_header, int max_rows,
		      int max_cols, float min_pcnt, FILE *fp);

int hist_entry__inc_addr_samples(struct hist_entry *self, int evidx, u64 addr);
int hist_entry__annotate(struct hist_entry *self, size_t privsize);

void hists__filter_by_dso(struct hists *hists);
void hists__filter_by_thread(struct hists *hists);
void hists__filter_by_symbol(struct hists *hists);

u16 hists__col_len(struct hists *self, enum hist_column col);
void hists__set_col_len(struct hists *self, enum hist_column col, u16 len);
bool hists__new_col_len(struct hists *self, enum hist_column col, u16 len);
void hists__reset_col_len(struct hists *hists);
void hists__calc_col_len(struct hists *hists, struct hist_entry *he);

void hists__match(struct hists *leader, struct hists *other);
int hists__link(struct hists *leader, struct hists *other);

struct perf_hpp {
	char *buf;
	size_t size;
	const char *sep;
	void *ptr;
};

struct perf_hpp_fmt {
	int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp);
	int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp);
	int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
		     struct hist_entry *he);
	int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
		     struct hist_entry *he);

	struct list_head list;
};

extern struct list_head perf_hpp__list;

#define perf_hpp__for_each_format(format) \
	list_for_each_entry(format, &perf_hpp__list, list)

extern struct perf_hpp_fmt perf_hpp__format[];

enum {
	/* Matches perf_hpp__format array. */
	PERF_HPP__OVERHEAD,
	PERF_HPP__OVERHEAD_SYS,
	PERF_HPP__OVERHEAD_US,
	PERF_HPP__OVERHEAD_GUEST_SYS,
	PERF_HPP__OVERHEAD_GUEST_US,
	PERF_HPP__SAMPLES,
	PERF_HPP__PERIOD,

	PERF_HPP__MAX_INDEX
};

void perf_hpp__init(void);
void perf_hpp__column_register(struct perf_hpp_fmt *format);
void perf_hpp__column_enable(unsigned col);

struct perf_evlist;

struct hist_browser_timer {
	void (*timer)(void *arg);
	void *arg;
	int refresh;
};

#ifdef SLANG_SUPPORT
#include "../ui/keysyms.h"
int hist_entry__tui_annotate(struct hist_entry *he, struct perf_evsel *evsel,
			     struct hist_browser_timer *hbt);

int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
				  struct hist_browser_timer *hbt,
				  float min_pcnt,
				  struct perf_session_env *env);
int script_browse(const char *script_opt);
#else
static inline
int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
				  const char *help __maybe_unused,
				  struct hist_browser_timer *hbt __maybe_unused,
				  float min_pcnt __maybe_unused,
				  struct perf_session_env *env __maybe_unused)
{
	return 0;
}

static inline int hist_entry__tui_annotate(struct hist_entry *self
					   __maybe_unused,
					   struct perf_evsel *evsel
					   __maybe_unused,
					   struct hist_browser_timer *hbt
					   __maybe_unused)
{
	return 0;
}

static inline int script_browse(const char *script_opt __maybe_unused)
{
	return 0;
}

#define K_LEFT  -1000
#define K_RIGHT -2000
#define K_SWITCH_INPUT_DATA -3000
#endif

#ifdef GTK2_SUPPORT
int perf_evlist__gtk_browse_hists(struct perf_evlist *evlist, const char *help,
				  struct hist_browser_timer *hbt __maybe_unused,
				  float min_pcnt);
#else
static inline
int perf_evlist__gtk_browse_hists(struct perf_evlist *evlist __maybe_unused,
				  const char *help __maybe_unused,
				  struct hist_browser_timer *hbt __maybe_unused,
				  float min_pcnt __maybe_unused)
{
	return 0;
}
#endif

unsigned int hists__sort_list_width(struct hists *self);
#endif	/* __PERF_HIST_H */
Commit	Line	Data
3d1d07ec JK	1	#ifndef __PERF_HIST_H
3d1d07ec JK	2	#define __PERF_HIST_H
3d1d07ec	3
4e4f06e4	4	#include <linux/types.h>
1980c2eb	5	#include <pthread.h>
3d1d07ec	6	#include "callchain.h"
68d80758	7	#include "header.h"
3d1d07ec	8
3d1d07ec	9	extern struct callchain_param callchain_param;
3d1d07ec	10
4e4f06e4 ACM	11	struct hist_entry;
	12	struct addr_location;
	13	struct symbol;
ef7b93a1	14
cee75ac7 ACM	15	/*
	16	* The kernel collects the number of events it couldn't send in a stretch and
	17	* when possible sends this number in a PERF_RECORD_LOST event. The number of
	18	* such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
	19	* total_lost tells exactly how many events the kernel in fact lost, i.e. it is
	20	* the sum of all struct lost_event.lost fields reported.
	21	*
	22	* The total_period is needed because by default auto-freq is used, so
	23	* multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
	24	* the total number of low level events, it is necessary to to sum all struct
	25	* sample_event.period and stash the result in total_period.
	26	*/
1c02c4d2	27	struct events_stats {
cee75ac7 ACM	28	u64 total_period;
cee75ac7 ACM	29	u64 total_lost;
640c03ce	30	u64 total_invalid_chains;
c8446b9b	31	u32 nr_events[PERF_RECORD_HEADER_MAX];
7b27509f	32	u32 nr_lost_warned;
c8446b9b	33	u32 nr_unknown_events;
640c03ce	34	u32 nr_invalid_chains;
9e69c210	35	u32 nr_unknown_id;
0c095715	36	u32 nr_unprocessable_samples;
1c02c4d2 ACM	37	};
1c02c4d2 ACM	38
8a6c5b26 ACM	39	enum hist_column {
	40	HISTC_SYMBOL,
	41	HISTC_DSO,
	42	HISTC_THREAD,
	43	HISTC_COMM,
	44	HISTC_PARENT,
	45	HISTC_CPU,
dfd3b2fd	46	HISTC_SRCLINE,
b5387528	47	HISTC_MISPREDICT,
f5d05bce AK	48	HISTC_IN_TX,
f5d05bce AK	49	HISTC_ABORT,
b5387528 RAV	50	HISTC_SYMBOL_FROM,
	51	HISTC_SYMBOL_TO,
	52	HISTC_DSO_FROM,
	53	HISTC_DSO_TO,
05484298 AK	54	HISTC_LOCAL_WEIGHT,
05484298 AK	55	HISTC_GLOBAL_WEIGHT,
98a3b32c SE	56	HISTC_MEM_DADDR_SYMBOL,
	57	HISTC_MEM_DADDR_DSO,
	58	HISTC_MEM_LOCKED,
	59	HISTC_MEM_TLB,
	60	HISTC_MEM_LVL,
	61	HISTC_MEM_SNOOP,
8a6c5b26 ACM	62	HISTC_NR_COLS, /* Last entry */
	63	};
	64
d7b76f09 ACM	65	struct thread;
	66	struct dso;
	67
1c02c4d2	68	struct hists {
1980c2eb ACM	69	struct rb_root entries_in_array[2];
1980c2eb ACM	70	struct rb_root *entries_in;
1c02c4d2	71	struct rb_root entries;
1980c2eb	72	struct rb_root entries_collapsed;
fefb0b94	73	u64 nr_entries;
d7b76f09 ACM	74	const struct thread *thread_filter;
d7b76f09 ACM	75	const struct dso *dso_filter;
0d37aa34	76	const char *uid_filter_str;
e94d53eb	77	const char *symbol_filter_str;
1980c2eb	78	pthread_mutex_t lock;
1c02c4d2	79	struct events_stats stats;
1c02c4d2	80	u64 event_stream;
8a6c5b26	81	u16 col_len[HISTC_NR_COLS];
1c02c4d2 ACM	82	};
	83
	84	struct hist_entry __hists__add_entry(struct hists self,
	85	struct addr_location *al,
05484298 AK	86	struct symbol *parent, u64 period,
05484298 AK	87	u64 weight);
12c14278 ACM	88	int64_t hist_entry__cmp(struct hist_entry left, struct hist_entry right);
12c14278 ACM	89	int64_t hist_entry__collapse(struct hist_entry left, struct hist_entry right);
000078bc NK	90	int hist_entry__sort_snprintf(struct hist_entry self, char bf, size_t size,
000078bc NK	91	struct hists *hists);
4e4f06e4 ACM	92	void hist_entry__free(struct hist_entry *);
4e4f06e4 ACM	93
b5387528 RAV	94	struct hist_entry __hists__add_branch_entry(struct hists self,
	95	struct addr_location *al,
	96	struct symbol *sym_parent,
	97	struct branch_info *bi,
05484298 AK	98	u64 period,
05484298 AK	99	u64 weight);
b5387528	100
98a3b32c SE	101	struct hist_entry __hists__add_mem_entry(struct hists self,
	102	struct addr_location *al,
	103	struct symbol *sym_parent,
	104	struct mem_info *mi,
	105	u64 period,
	106	u64 weight);
	107
fefb0b94	108	void hists__output_resort(struct hists *self);
1c02c4d2	109	void hists__collapse_resort(struct hists *self);
c8446b9b	110
b079d4e9	111	void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
ab81f3fd ACM	112	void hists__output_recalc_col_len(struct hists *hists, int max_rows);
ab81f3fd ACM	113
66f97ed3	114	void hists__inc_nr_entries(struct hists hists, struct hist_entry h);
c8446b9b	115	void hists__inc_nr_events(struct hists *self, u32 type);
28a6b6aa	116	void events_stats__inc(struct events_stats *stats, u32 type);
52168eea	117	size_t events_stats__fprintf(struct events_stats stats, FILE fp);
c8446b9b	118
41724e4c	119	size_t hists__fprintf(struct hists *self, bool show_header, int max_rows,
064f1981	120	int max_cols, float min_pcnt, FILE *fp);
b09e0190	121
2f525d01	122	int hist_entry__inc_addr_samples(struct hist_entry *self, int evidx, u64 addr);
ce6f4fab	123	int hist_entry__annotate(struct hist_entry *self, size_t privsize);
ef7b93a1	124
d7b76f09 ACM	125	void hists__filter_by_dso(struct hists *hists);
d7b76f09 ACM	126	void hists__filter_by_thread(struct hists *hists);
e94d53eb	127	void hists__filter_by_symbol(struct hists *hists);
b09e0190	128
8a6c5b26 ACM	129	u16 hists__col_len(struct hists *self, enum hist_column col);
	130	void hists__set_col_len(struct hists *self, enum hist_column col, u16 len);
	131	bool hists__new_col_len(struct hists *self, enum hist_column col, u16 len);
7ccf4f90 NK	132	void hists__reset_col_len(struct hists *hists);
7ccf4f90 NK	133	void hists__calc_col_len(struct hists hists, struct hist_entry he);
8a6c5b26	134
95529be4	135	void hists__match(struct hists leader, struct hists other);
494d70a1	136	int hists__link(struct hists leader, struct hists other);
95529be4	137
ea251d51 NK	138	struct perf_hpp {
	139	char *buf;
	140	size_t size;
ea251d51	141	const char *sep;
ea251d51 NK	142	void *ptr;
	143	};
	144
	145	struct perf_hpp_fmt {
2c5d4b4a JO	146	int (header)(struct perf_hpp_fmt fmt, struct perf_hpp *hpp);
	147	int (width)(struct perf_hpp_fmt fmt, struct perf_hpp *hpp);
	148	int (color)(struct perf_hpp_fmt fmt, struct perf_hpp *hpp,
	149	struct hist_entry *he);
	150	int (entry)(struct perf_hpp_fmt fmt, struct perf_hpp *hpp,
	151	struct hist_entry *he);
1240005e JO	152
1240005e JO	153	struct list_head list;
ea251d51 NK	154	};
ea251d51 NK	155
1240005e JO	156	extern struct list_head perf_hpp__list;
	157
	158	#define perf_hpp__for_each_format(format) \
	159	list_for_each_entry(format, &perf_hpp__list, list)
	160
ea251d51 NK	161	extern struct perf_hpp_fmt perf_hpp__format[];
	162
	163	enum {
345dc0b4	164	/* Matches perf_hpp__format array. */
ea251d51 NK	165	PERF_HPP__OVERHEAD,
	166	PERF_HPP__OVERHEAD_SYS,
	167	PERF_HPP__OVERHEAD_US,
	168	PERF_HPP__OVERHEAD_GUEST_SYS,
	169	PERF_HPP__OVERHEAD_GUEST_US,
	170	PERF_HPP__SAMPLES,
	171	PERF_HPP__PERIOD,
ea251d51 NK	172
	173	PERF_HPP__MAX_INDEX
	174	};
	175
1d77822e	176	void perf_hpp__init(void);
1240005e JO	177	void perf_hpp__column_register(struct perf_hpp_fmt *format);
1240005e JO	178	void perf_hpp__column_enable(unsigned col);
ea251d51	179
e248de33 ACM	180	struct perf_evlist;
e248de33 ACM	181
9783adf7 NK	182	struct hist_browser_timer {
	183	void (timer)(void arg);
	184	void *arg;
	185	int refresh;
	186	};
	187
6692c262	188	#ifdef SLANG_SUPPORT
1254b51e	189	#include "../ui/keysyms.h"
db8fd07a	190	int hist_entry__tui_annotate(struct hist_entry he, struct perf_evsel evsel,
9783adf7	191	struct hist_browser_timer *hbt);
1254b51e NK	192
1254b51e NK	193	int perf_evlist__tui_browse_hists(struct perf_evlist evlist, const char help,
68d80758	194	struct hist_browser_timer *hbt,
064f1981	195	float min_pcnt,
68d80758	196	struct perf_session_env *env);
66517826	197	int script_browse(const char *script_opt);
1254b51e	198	#else
7f0030b2	199	static inline
1d037ca1 IT	200	int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
1d037ca1 IT	201	const char *help __maybe_unused,
68d80758	202	struct hist_browser_timer *hbt __maybe_unused,
064f1981	203	float min_pcnt __maybe_unused,
68d80758	204	struct perf_session_env *env __maybe_unused)
d67f088e ACM	205	{
	206	return 0;
	207	}
	208
1d037ca1 IT	209	static inline int hist_entry__tui_annotate(struct hist_entry *self
1d037ca1 IT	210	__maybe_unused,
db8fd07a NK	211	struct perf_evsel *evsel
db8fd07a NK	212	__maybe_unused,
9783adf7 NK	213	struct hist_browser_timer *hbt
9783adf7 NK	214	__maybe_unused)
46e3e055 ACM	215	{
	216	return 0;
	217	}
66517826	218
4f746c95	219	static inline int script_browse(const char *script_opt __maybe_unused)
66517826 FT	220	{
	221	return 0;
	222	}
	223
1e825efb ME	224	#define K_LEFT -1000
1e825efb ME	225	#define K_RIGHT -2000
5f7439e0	226	#define K_SWITCH_INPUT_DATA -3000
b09e0190	227	#endif
06daaaba	228
f9f526ec NK	229	#ifdef GTK2_SUPPORT
f9f526ec NK	230	int perf_evlist__gtk_browse_hists(struct perf_evlist evlist, const char help,
064f1981 NK	231	struct hist_browser_timer *hbt __maybe_unused,
064f1981 NK	232	float min_pcnt);
f9f526ec	233	#else
c31a9457	234	static inline
1d037ca1 IT	235	int perf_evlist__gtk_browse_hists(struct perf_evlist *evlist __maybe_unused,
1d037ca1 IT	236	const char *help __maybe_unused,
064f1981 NK	237	struct hist_browser_timer *hbt __maybe_unused,
064f1981 NK	238	float min_pcnt __maybe_unused)
c31a9457 PE	239	{
	240	return 0;
	241	}
c31a9457 PE	242	#endif
c31a9457 PE	243
06daaaba	244	unsigned int hists__sort_list_width(struct hists *self);
3d1d07ec	245	#endif /* __PERF_HIST_H */