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

#ifndef __PERF_HIST_H
#define __PERF_HIST_H

#include <linux/types.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_unknown_events;
	u32 nr_invalid_chains;
};

enum hist_column {
	HISTC_SYMBOL,
	HISTC_DSO,
	HISTC_THREAD,
	HISTC_COMM,
	HISTC_PARENT,
	HISTC_CPU,
	HISTC_NR_COLS, /* Last entry */
};

struct hists {
	struct rb_node		rb_node;
	struct rb_root		entries;
	u64			nr_entries;
	struct events_stats	stats;
	u64			config;
	u64			event_stream;
	u32			type;
	u16			col_len[HISTC_NR_COLS];
	/* Best would be to reuse the session callchain cursor */
	struct callchain_cursor	callchain_cursor;
};

struct hist_entry *__hists__add_entry(struct hists *self,
				      struct addr_location *al,
				      struct symbol *parent, u64 period);
extern int64_t hist_entry__cmp(struct hist_entry *, struct hist_entry *);
extern int64_t hist_entry__collapse(struct hist_entry *, struct hist_entry *);
int hist_entry__fprintf(struct hist_entry *self, struct hists *hists,
			struct hists *pair_hists, bool show_displacement,
			long displacement, FILE *fp, u64 total);
int hist_entry__snprintf(struct hist_entry *self, char *bf, size_t size,
			 struct hists *hists, struct hists *pair_hists,
			 bool show_displacement, long displacement,
			 bool color, u64 total);
void hist_entry__free(struct hist_entry *);

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

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, struct hists *pair,
		      bool show_displacement, FILE *fp);

int hist_entry__inc_addr_samples(struct hist_entry *self, u64 ip);
int hist_entry__annotate(struct hist_entry *self, struct list_head *head,
			 size_t privsize);

void hists__filter_by_dso(struct hists *self, const struct dso *dso);
void hists__filter_by_thread(struct hists *self, const struct thread *thread);

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);

#ifdef NO_NEWT_SUPPORT
static inline int hists__browse(struct hists *self __used,
				const char *helpline __used,
				const char *ev_name __used)
{
	return 0;
}

static inline int hists__tui_browse_tree(struct rb_root *self __used,
					 const char *help __used)
{
	return 0;
}

static inline int hist_entry__tui_annotate(struct hist_entry *self __used)
{
	return 0;
}
#define KEY_LEFT -1
#define KEY_RIGHT -2
#else
#include <newt.h>
int hists__browse(struct hists *self, const char *helpline,
		  const char *ev_name);
int hist_entry__tui_annotate(struct hist_entry *self);

#define KEY_LEFT NEWT_KEY_LEFT
#define KEY_RIGHT NEWT_KEY_RIGHT

int hists__tui_browse_tree(struct rb_root *self, const char *help);
#endif

unsigned int hists__sort_list_width(struct hists *self);

#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 "callchain.h"
	6
	7	extern struct callchain_param callchain_param;
	8
	9	struct hist_entry;
	10	struct addr_location;
	11	struct symbol;
	12
	13	/*
	14	* The kernel collects the number of events it couldn't send in a stretch and
	15	* when possible sends this number in a PERF_RECORD_LOST event. The number of
	16	* such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
	17	* total_lost tells exactly how many events the kernel in fact lost, i.e. it is
	18	* the sum of all struct lost_event.lost fields reported.
	19	*
	20	* The total_period is needed because by default auto-freq is used, so
	21	* multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
	22	* the total number of low level events, it is necessary to to sum all struct
	23	* sample_event.period and stash the result in total_period.
	24	*/
	25	struct events_stats {
	26	u64 total_period;
	27	u64 total_lost;
	28	u64 total_invalid_chains;
	29	u32 nr_events[PERF_RECORD_HEADER_MAX];
	30	u32 nr_unknown_events;
	31	u32 nr_invalid_chains;
	32	};
	33
	34	enum hist_column {
	35	HISTC_SYMBOL,
	36	HISTC_DSO,
	37	HISTC_THREAD,
	38	HISTC_COMM,
	39	HISTC_PARENT,
	40	HISTC_CPU,
	41	HISTC_NR_COLS, /* Last entry */
	42	};
	43
	44	struct hists {
	45	struct rb_node rb_node;
	46	struct rb_root entries;
	47	u64 nr_entries;
	48	struct events_stats stats;
	49	u64 config;
	50	u64 event_stream;
	51	u32 type;
	52	u16 col_len[HISTC_NR_COLS];
	53	/* Best would be to reuse the session callchain cursor */
	54	struct callchain_cursor callchain_cursor;
	55	};
	56
	57	struct hist_entry __hists__add_entry(struct hists self,
	58	struct addr_location *al,
	59	struct symbol *parent, u64 period);
	60	extern int64_t hist_entry__cmp(struct hist_entry , struct hist_entry );
	61	extern int64_t hist_entry__collapse(struct hist_entry , struct hist_entry );
	62	int hist_entry__fprintf(struct hist_entry self, struct hists hists,
	63	struct hists *pair_hists, bool show_displacement,
	64	long displacement, FILE *fp, u64 total);
	65	int hist_entry__snprintf(struct hist_entry self, char bf, size_t size,
	66	struct hists hists, struct hists pair_hists,
	67	bool show_displacement, long displacement,
	68	bool color, u64 total);
	69	void hist_entry__free(struct hist_entry *);
	70
	71	void hists__output_resort(struct hists *self);
	72	void hists__collapse_resort(struct hists *self);
	73
	74	void hists__inc_nr_events(struct hists *self, u32 type);
	75	size_t hists__fprintf_nr_events(struct hists self, FILE fp);
	76
	77	size_t hists__fprintf(struct hists self, struct hists pair,
	78	bool show_displacement, FILE *fp);
	79
	80	int hist_entry__inc_addr_samples(struct hist_entry *self, u64 ip);
	81	int hist_entry__annotate(struct hist_entry self, struct list_head head,
	82	size_t privsize);
	83
	84	void hists__filter_by_dso(struct hists self, const struct dso dso);
	85	void hists__filter_by_thread(struct hists self, const struct thread thread);
	86
	87	u16 hists__col_len(struct hists *self, enum hist_column col);
	88	void hists__set_col_len(struct hists *self, enum hist_column col, u16 len);
	89	bool hists__new_col_len(struct hists *self, enum hist_column col, u16 len);
	90
	91	#ifdef NO_NEWT_SUPPORT
	92	static inline int hists__browse(struct hists *self __used,
	93	const char *helpline __used,
	94	const char *ev_name __used)
	95	{
	96	return 0;
	97	}
	98
	99	static inline int hists__tui_browse_tree(struct rb_root *self __used,
	100	const char *help __used)
	101	{
	102	return 0;
	103	}
	104
	105	static inline int hist_entry__tui_annotate(struct hist_entry *self __used)
	106	{
	107	return 0;
	108	}
	109	#define KEY_LEFT -1
	110	#define KEY_RIGHT -2
	111	#else
	112	#include <newt.h>
	113	int hists__browse(struct hists self, const char helpline,
	114	const char *ev_name);
	115	int hist_entry__tui_annotate(struct hist_entry *self);
	116
	117	#define KEY_LEFT NEWT_KEY_LEFT
	118	#define KEY_RIGHT NEWT_KEY_RIGHT
	119
	120	int hists__tui_browse_tree(struct rb_root self, const char help);
	121	#endif
	122
	123	unsigned int hists__sort_list_width(struct hists *self);
	124
	125	#endif /* __PERF_HIST_H */