[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;
struct rb_root;

struct objdump_line {
	struct list_head node;
	s64		 offset;
	char		 *line;
};

void objdump_line__free(struct objdump_line *self);
struct objdump_line *objdump__get_next_ip_line(struct list_head *head,
					       struct objdump_line *pos);

struct sym_hist {
	u64		sum;
	u64		ip[0];
};

struct sym_ext {
	struct rb_node	node;
	double		percent;
	char		*path;
};

struct sym_priv {
	struct sym_hist	*hist;
	struct sym_ext	*ext;
};

/*
 * 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;
	u32 nr_events[PERF_RECORD_HEADER_MAX];
	u32 nr_unknown_events;
};

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;
	u32			max_sym_namelen;
};

struct hist_entry *__hists__add_entry(struct hists *self,
				      struct addr_location *al,
				      struct symbol *parent, u64 count);
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 *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 *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);

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

#ifdef NO_NEWT_SUPPORT
static inline int hists__browse(struct hists *self __used,
				const char *helpline __used,
				const char *input_name __used)
{
	return 0;
}
#else
int hists__browse(struct hists *self, const char *helpline,
		  const char *input_name);
#endif
#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>
3d1d07ec	5	#include "callchain.h"
3d1d07ec	6
3d1d07ec	7	extern struct callchain_param callchain_param;
3d1d07ec	8
4e4f06e4 ACM	9	struct hist_entry;
	10	struct addr_location;
	11	struct symbol;
d403d0ac	12	struct rb_root;
4e4f06e4	13
ef7b93a1 ACM	14	struct objdump_line {
	15	struct list_head node;
	16	s64 offset;
	17	char *line;
	18	};
	19
	20	void objdump_line__free(struct objdump_line *self);
	21	struct objdump_line objdump__get_next_ip_line(struct list_head head,
	22	struct objdump_line *pos);
	23
	24	struct sym_hist {
	25	u64 sum;
	26	u64 ip[0];
	27	};
	28
	29	struct sym_ext {
	30	struct rb_node node;
	31	double percent;
	32	char *path;
	33	};
	34
	35	struct sym_priv {
	36	struct sym_hist *hist;
	37	struct sym_ext *ext;
	38	};
	39
cee75ac7 ACM	40	/*
	41	* The kernel collects the number of events it couldn't send in a stretch and
	42	* when possible sends this number in a PERF_RECORD_LOST event. The number of
	43	* such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
	44	* total_lost tells exactly how many events the kernel in fact lost, i.e. it is
	45	* the sum of all struct lost_event.lost fields reported.
	46	*
	47	* The total_period is needed because by default auto-freq is used, so
	48	* multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
	49	* the total number of low level events, it is necessary to to sum all struct
	50	* sample_event.period and stash the result in total_period.
	51	*/
1c02c4d2	52	struct events_stats {
cee75ac7 ACM	53	u64 total_period;
cee75ac7 ACM	54	u64 total_lost;
c8446b9b ACM	55	u32 nr_events[PERF_RECORD_HEADER_MAX];
c8446b9b ACM	56	u32 nr_unknown_events;
1c02c4d2 ACM	57	};
	58
	59	struct hists {
	60	struct rb_node rb_node;
	61	struct rb_root entries;
fefb0b94	62	u64 nr_entries;
1c02c4d2 ACM	63	struct events_stats stats;
	64	u64 config;
	65	u64 event_stream;
	66	u32 type;
fefb0b94	67	u32 max_sym_namelen;
1c02c4d2 ACM	68	};
	69
	70	struct hist_entry __hists__add_entry(struct hists self,
	71	struct addr_location *al,
	72	struct symbol *parent, u64 count);
3d1d07ec JK	73	extern int64_t hist_entry__cmp(struct hist_entry , struct hist_entry );
3d1d07ec JK	74	extern int64_t hist_entry__collapse(struct hist_entry , struct hist_entry );
1c02c4d2 ACM	75	int hist_entry__fprintf(struct hist_entry self, struct hists pair_hists,
	76	bool show_displacement, long displacement, FILE *fp,
	77	u64 total);
	78	int hist_entry__snprintf(struct hist_entry self, char bf, size_t size,
	79	struct hists *pair_hists, bool show_displacement,
	80	long displacement, bool color, u64 total);
4e4f06e4 ACM	81	void hist_entry__free(struct hist_entry *);
4e4f06e4 ACM	82
fefb0b94	83	void hists__output_resort(struct hists *self);
1c02c4d2	84	void hists__collapse_resort(struct hists *self);
c8446b9b ACM	85
	86	void hists__inc_nr_events(struct hists *self, u32 type);
	87	size_t hists__fprintf_nr_events(struct hists self, FILE fp);
	88
1c02c4d2 ACM	89	size_t hists__fprintf(struct hists self, struct hists pair,
1c02c4d2 ACM	90	bool show_displacement, FILE *fp);
b09e0190	91
ef7b93a1 ACM	92	int hist_entry__inc_addr_samples(struct hist_entry *self, u64 ip);
	93	int hist_entry__annotate(struct hist_entry self, struct list_head head);
	94
b09e0190 ACM	95	void hists__filter_by_dso(struct hists self, const struct dso dso);
	96	void hists__filter_by_thread(struct hists self, const struct thread thread);
	97
	98	#ifdef NO_NEWT_SUPPORT
8769e1c7	99	static inline int hists__browse(struct hists *self __used,
b09e0190 ACM	100	const char *helpline __used,
	101	const char *input_name __used)
	102	{
	103	return 0;
	104	}
	105	#else
	106	int hists__browse(struct hists self, const char helpline,
	107	const char *input_name);
	108	#endif
3d1d07ec	109	#endif /* __PERF_HIST_H */