[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"

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_MISPREDICT,
	HISTC_SYMBOL_FROM,
	HISTC_SYMBOL_TO,
	HISTC_DSO_FROM,
	HISTC_DSO_TO,
	HISTC_SRCLINE,
	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);
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);

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

void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
void hists__decay_entries_threaded(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_events(struct hists *self, u32 type);
size_t hists__fprintf_nr_events(struct hists *self, FILE *fp);

size_t hists__fprintf(struct hists *self, bool show_header, int max_rows,
		      int max_cols, 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);

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

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

extern struct perf_hpp_fmt perf_hpp__format[];

enum {
	PERF_HPP__BASELINE,
	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__PERIOD_BASELINE,
	PERF_HPP__DELTA,
	PERF_HPP__RATIO,
	PERF_HPP__WEIGHTED_DIFF,
	PERF_HPP__DISPL,
	PERF_HPP__FORMULA,

	PERF_HPP__MAX_INDEX
};

void perf_hpp__init(void);
void perf_hpp__column_enable(unsigned col, bool enable);
int hist_entry__period_snprintf(struct perf_hpp *hpp, struct hist_entry *he,
				bool color);

struct perf_evlist;

#ifdef NEWT_SUPPORT
#include "../ui/keysyms.h"
int hist_entry__tui_annotate(struct hist_entry *he, int evidx,
			     void(*timer)(void *arg), void *arg, int delay_secs);

int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
				  void(*timer)(void *arg), void *arg,
				  int refresh);
#else
static inline
int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
				  const char *help __maybe_unused,
				  void(*timer)(void *arg) __maybe_unused,
				  void *arg __maybe_unused,
				  int refresh __maybe_unused)
{
	return 0;
}

static inline int hist_entry__tui_annotate(struct hist_entry *self
					   __maybe_unused,
					   int evidx __maybe_unused,
					   void(*timer)(void *arg)
					   __maybe_unused,
					   void *arg __maybe_unused,
					   int delay_secs __maybe_unused)
{
	return 0;
}
#define K_LEFT -1
#define K_RIGHT -2
#endif

#ifdef GTK2_SUPPORT
int perf_evlist__gtk_browse_hists(struct perf_evlist *evlist, const char *help,
				  void(*timer)(void *arg), void *arg,
				  int refresh);
#else
static inline
int perf_evlist__gtk_browse_hists(struct perf_evlist *evlist __maybe_unused,
				  const char *help __maybe_unused,
				  void(*timer)(void *arg) __maybe_unused,
				  void *arg __maybe_unused,
				  int refresh __maybe_unused)
{
	return 0;
}
#endif

unsigned int hists__sort_list_width(struct hists *self);

double perf_diff__compute_delta(struct hist_entry *he);
double perf_diff__compute_ratio(struct hist_entry *he);
s64 perf_diff__compute_wdiff(struct hist_entry *he);
int perf_diff__formula(char *buf, size_t size, struct hist_entry *he);
#endif	/* __PERF_HIST_H */
Commit	Line	Data
	1	#ifndef __PERF_HIST_H
	2	#define __PERF_HIST_H
	3
	4	#include <linux/types.h>
	5	#include <pthread.h>
	6	#include "callchain.h"
	7
	8	extern struct callchain_param callchain_param;
	9
	10	struct hist_entry;
	11	struct addr_location;
	12	struct symbol;
	13
	14	/*
	15	* The kernel collects the number of events it couldn't send in a stretch and
	16	* when possible sends this number in a PERF_RECORD_LOST event. The number of
	17	* such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
	18	* total_lost tells exactly how many events the kernel in fact lost, i.e. it is
	19	* the sum of all struct lost_event.lost fields reported.
	20	*
	21	* The total_period is needed because by default auto-freq is used, so
	22	* multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
	23	* the total number of low level events, it is necessary to to sum all struct
	24	* sample_event.period and stash the result in total_period.
	25	*/
	26	struct events_stats {
	27	u64 total_period;
	28	u64 total_lost;
	29	u64 total_invalid_chains;
	30	u32 nr_events[PERF_RECORD_HEADER_MAX];
	31	u32 nr_lost_warned;
	32	u32 nr_unknown_events;
	33	u32 nr_invalid_chains;
	34	u32 nr_unknown_id;
	35	u32 nr_unprocessable_samples;
	36	};
	37
	38	enum hist_column {
	39	HISTC_SYMBOL,
	40	HISTC_DSO,
	41	HISTC_THREAD,
	42	HISTC_COMM,
	43	HISTC_PARENT,
	44	HISTC_CPU,
	45	HISTC_MISPREDICT,
	46	HISTC_SYMBOL_FROM,
	47	HISTC_SYMBOL_TO,
	48	HISTC_DSO_FROM,
	49	HISTC_DSO_TO,
	50	HISTC_SRCLINE,
	51	HISTC_NR_COLS, /* Last entry */
	52	};
	53
	54	struct thread;
	55	struct dso;
	56
	57	struct hists {
	58	struct rb_root entries_in_array[2];
	59	struct rb_root *entries_in;
	60	struct rb_root entries;
	61	struct rb_root entries_collapsed;
	62	u64 nr_entries;
	63	const struct thread *thread_filter;
	64	const struct dso *dso_filter;
	65	const char *uid_filter_str;
	66	const char *symbol_filter_str;
	67	pthread_mutex_t lock;
	68	struct events_stats stats;
	69	u64 event_stream;
	70	u16 col_len[HISTC_NR_COLS];
	71	};
	72
	73	struct hist_entry __hists__add_entry(struct hists self,
	74	struct addr_location *al,
	75	struct symbol *parent, u64 period);
	76	int64_t hist_entry__cmp(struct hist_entry left, struct hist_entry right);
	77	int64_t hist_entry__collapse(struct hist_entry left, struct hist_entry right);
	78	int hist_entry__sort_snprintf(struct hist_entry self, char bf, size_t size,
	79	struct hists *hists);
	80	void hist_entry__free(struct hist_entry *);
	81
	82	struct hist_entry __hists__add_branch_entry(struct hists self,
	83	struct addr_location *al,
	84	struct symbol *sym_parent,
	85	struct branch_info *bi,
	86	u64 period);
	87
	88	void hists__output_resort(struct hists *self);
	89	void hists__output_resort_threaded(struct hists *hists);
	90	void hists__collapse_resort(struct hists *self);
	91	void hists__collapse_resort_threaded(struct hists *hists);
	92
	93	void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
	94	void hists__decay_entries_threaded(struct hists *hists, bool zap_user,
	95	bool zap_kernel);
	96	void hists__output_recalc_col_len(struct hists *hists, int max_rows);
	97
	98	void hists__inc_nr_events(struct hists *self, u32 type);
	99	size_t hists__fprintf_nr_events(struct hists self, FILE fp);
	100
	101	size_t hists__fprintf(struct hists *self, bool show_header, int max_rows,
	102	int max_cols, FILE *fp);
	103
	104	int hist_entry__inc_addr_samples(struct hist_entry *self, int evidx, u64 addr);
	105	int hist_entry__annotate(struct hist_entry *self, size_t privsize);
	106
	107	void hists__filter_by_dso(struct hists *hists);
	108	void hists__filter_by_thread(struct hists *hists);
	109	void hists__filter_by_symbol(struct hists *hists);
	110
	111	u16 hists__col_len(struct hists *self, enum hist_column col);
	112	void hists__set_col_len(struct hists *self, enum hist_column col, u16 len);
	113	bool hists__new_col_len(struct hists *self, enum hist_column col, u16 len);
	114	void hists__reset_col_len(struct hists *hists);
	115	void hists__calc_col_len(struct hists hists, struct hist_entry he);
	116
	117	struct perf_hpp {
	118	char *buf;
	119	size_t size;
	120	const char *sep;
	121	void *ptr;
	122	};
	123
	124	struct perf_hpp_fmt {
	125	bool cond;
	126	int (header)(struct perf_hpp hpp);
	127	int (width)(struct perf_hpp hpp);
	128	int (color)(struct perf_hpp hpp, struct hist_entry *he);
	129	int (entry)(struct perf_hpp hpp, struct hist_entry *he);
	130	};
	131
	132	extern struct perf_hpp_fmt perf_hpp__format[];
	133
	134	enum {
	135	PERF_HPP__BASELINE,
	136	PERF_HPP__OVERHEAD,
	137	PERF_HPP__OVERHEAD_SYS,
	138	PERF_HPP__OVERHEAD_US,
	139	PERF_HPP__OVERHEAD_GUEST_SYS,
	140	PERF_HPP__OVERHEAD_GUEST_US,
	141	PERF_HPP__SAMPLES,
	142	PERF_HPP__PERIOD,
	143	PERF_HPP__PERIOD_BASELINE,
	144	PERF_HPP__DELTA,
	145	PERF_HPP__RATIO,
	146	PERF_HPP__WEIGHTED_DIFF,
	147	PERF_HPP__DISPL,
	148	PERF_HPP__FORMULA,
	149
	150	PERF_HPP__MAX_INDEX
	151	};
	152
	153	void perf_hpp__init(void);
	154	void perf_hpp__column_enable(unsigned col, bool enable);
	155	int hist_entry__period_snprintf(struct perf_hpp hpp, struct hist_entry he,
	156	bool color);
	157
	158	struct perf_evlist;
	159
	160	#ifdef NEWT_SUPPORT
	161	#include "../ui/keysyms.h"
	162	int hist_entry__tui_annotate(struct hist_entry *he, int evidx,
	163	void(timer)(void arg), void *arg, int delay_secs);
	164
	165	int perf_evlist__tui_browse_hists(struct perf_evlist evlist, const char help,
	166	void(timer)(void arg), void *arg,
	167	int refresh);
	168	#else
	169	static inline
	170	int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
	171	const char *help __maybe_unused,
	172	void(timer)(void arg) __maybe_unused,
	173	void *arg __maybe_unused,
	174	int refresh __maybe_unused)
	175	{
	176	return 0;
	177	}
	178
	179	static inline int hist_entry__tui_annotate(struct hist_entry *self
	180	__maybe_unused,
	181	int evidx __maybe_unused,
	182	void(timer)(void arg)
	183	__maybe_unused,
	184	void *arg __maybe_unused,
	185	int delay_secs __maybe_unused)
	186	{
	187	return 0;
	188	}
	189	#define K_LEFT -1
	190	#define K_RIGHT -2
	191	#endif
	192
	193	#ifdef GTK2_SUPPORT
	194	int perf_evlist__gtk_browse_hists(struct perf_evlist evlist, const char help,
	195	void(timer)(void arg), void *arg,
	196	int refresh);
	197	#else
	198	static inline
	199	int perf_evlist__gtk_browse_hists(struct perf_evlist *evlist __maybe_unused,
	200	const char *help __maybe_unused,
	201	void(timer)(void arg) __maybe_unused,
	202	void *arg __maybe_unused,
	203	int refresh __maybe_unused)
	204	{
	205	return 0;
	206	}
	207	#endif
	208
	209	unsigned int hists__sort_list_width(struct hists *self);
	210
	211	double perf_diff__compute_delta(struct hist_entry *he);
	212	double perf_diff__compute_ratio(struct hist_entry *he);
	213	s64 perf_diff__compute_wdiff(struct hist_entry *he);
	214	int perf_diff__formula(char buf, size_t size, struct hist_entry he);
	215	#endif /* __PERF_HIST_H */