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

#ifndef __PERF_SORT_H
#define __PERF_SORT_H
#include "../builtin.h"

#include "util.h"

#include "color.h"
#include <linux/list.h>
#include "cache.h"
#include <linux/rbtree.h>
#include "symbol.h"
#include "string.h"
#include "callchain.h"
#include "strlist.h"
#include "values.h"

#include "../perf.h"
#include "debug.h"
#include "header.h"

#include <subcmd/parse-options.h>
#include "parse-events.h"
#include "hist.h"
#include "thread.h"

extern regex_t parent_regex;
extern const char *sort_order;
extern const char *field_order;
extern const char default_parent_pattern[];
extern const char *parent_pattern;
extern const char default_sort_order[];
extern regex_t ignore_callees_regex;
extern int have_ignore_callees;
extern int sort__need_collapse;
extern int sort__has_dso;
extern int sort__has_parent;
extern int sort__has_sym;
extern int sort__has_socket;
extern int sort__has_thread;
extern int sort__has_comm;
extern enum sort_mode sort__mode;
extern struct sort_entry sort_comm;
extern struct sort_entry sort_dso;
extern struct sort_entry sort_sym;
extern struct sort_entry sort_parent;
extern struct sort_entry sort_dso_from;
extern struct sort_entry sort_dso_to;
extern struct sort_entry sort_sym_from;
extern struct sort_entry sort_sym_to;
extern enum sort_type sort__first_dimension;
extern const char default_mem_sort_order[];

struct he_stat {
	u64			period;
	u64			period_sys;
	u64			period_us;
	u64			period_guest_sys;
	u64			period_guest_us;
	u64			weight;
	u32			nr_events;
};

struct hist_entry_diff {
	bool	computed;
	union {
		/* PERF_HPP__DELTA */
		double	period_ratio_delta;

		/* PERF_HPP__RATIO */
		double	period_ratio;

		/* HISTC_WEIGHTED_DIFF */
		s64	wdiff;
	};
};

/**
 * struct hist_entry - histogram entry
 *
 * @row_offset - offset from the first callchain expanded to appear on screen
 * @nr_rows - rows expanded in callchain, recalculated on folding/unfolding
 */
struct hist_entry {
	struct rb_node		rb_node_in;
	struct rb_node		rb_node;
	union {
		struct list_head node;
		struct list_head head;
	} pairs;
	struct he_stat		stat;
	struct he_stat		*stat_acc;
	struct map_symbol	ms;
	struct thread		*thread;
	struct comm		*comm;
	u64			ip;
	u64			transaction;
	s32			socket;
	s32			cpu;
	u8			cpumode;
	u8			depth;

	/* We are added by hists__add_dummy_entry. */
	bool			dummy;
	bool			leaf;

	char			level;
	u8			filtered;
	union {
		/*
		 * Since perf diff only supports the stdio output, TUI
		 * fields are only accessed from perf report (or perf
		 * top).  So make it an union to reduce memory usage.
		 */
		struct hist_entry_diff	diff;
		struct /* for TUI */ {
			u16	row_offset;
			u16	nr_rows;
			bool	init_have_children;
			bool	unfolded;
			bool	has_children;
			bool	has_no_entry;
		};
	};
	char			*srcline;
	char			*srcfile;
	struct symbol		*parent;
	struct branch_info	*branch_info;
	struct hists		*hists;
	struct mem_info		*mem_info;
	void			*raw_data;
	u32			raw_size;
	void			*trace_output;
	struct perf_hpp_list	*hpp_list;
	struct hist_entry	*parent_he;
	union {
		/* this is for hierarchical entry structure */
		struct {
			struct rb_root	hroot_in;
			struct rb_root  hroot_out;
		};				/* non-leaf entries */
		struct rb_root	sorted_chain;	/* leaf entry has callchains */
	};
	struct callchain_root	callchain[0]; /* must be last member */
};

static inline bool hist_entry__has_pairs(struct hist_entry *he)
{
	return !list_empty(&he->pairs.node);
}

static inline struct hist_entry *hist_entry__next_pair(struct hist_entry *he)
{
	if (hist_entry__has_pairs(he))
		return list_entry(he->pairs.node.next, struct hist_entry, pairs.node);
	return NULL;
}

static inline void hist_entry__add_pair(struct hist_entry *pair,
					struct hist_entry *he)
{
	list_add_tail(&pair->pairs.node, &he->pairs.head);
}

static inline float hist_entry__get_percent_limit(struct hist_entry *he)
{
	u64 period = he->stat.period;
	u64 total_period = hists__total_period(he->hists);

	if (unlikely(total_period == 0))
		return 0;

	if (symbol_conf.cumulate_callchain)
		period = he->stat_acc->period;

	return period * 100.0 / total_period;
}

static inline u64 cl_address(u64 address)
{
	/* return the cacheline of the address */
	return (address & ~(cacheline_size - 1));
}

static inline u64 cl_offset(u64 address)
{
	/* return the cacheline of the address */
	return (address & (cacheline_size - 1));
}

enum sort_mode {
	SORT_MODE__NORMAL,
	SORT_MODE__BRANCH,
	SORT_MODE__MEMORY,
	SORT_MODE__TOP,
	SORT_MODE__DIFF,
	SORT_MODE__TRACEPOINT,
};

enum sort_type {
	/* common sort keys */
	SORT_PID,
	SORT_COMM,
	SORT_DSO,
	SORT_SYM,
	SORT_PARENT,
	SORT_CPU,
	SORT_SOCKET,
	SORT_SRCLINE,
	SORT_SRCFILE,
	SORT_LOCAL_WEIGHT,
	SORT_GLOBAL_WEIGHT,
	SORT_TRANSACTION,
	SORT_TRACE,

	/* branch stack specific sort keys */
	__SORT_BRANCH_STACK,
	SORT_DSO_FROM = __SORT_BRANCH_STACK,
	SORT_DSO_TO,
	SORT_SYM_FROM,
	SORT_SYM_TO,
	SORT_MISPREDICT,
	SORT_ABORT,
	SORT_IN_TX,
	SORT_CYCLES,

	/* memory mode specific sort keys */
	__SORT_MEMORY_MODE,
	SORT_MEM_DADDR_SYMBOL = __SORT_MEMORY_MODE,
	SORT_MEM_DADDR_DSO,
	SORT_MEM_LOCKED,
	SORT_MEM_TLB,
	SORT_MEM_LVL,
	SORT_MEM_SNOOP,
	SORT_MEM_DCACHELINE,
	SORT_MEM_IADDR_SYMBOL,
};

/*
 * configurable sorting bits
 */

struct sort_entry {
	const char *se_header;

	int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
	int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
	int64_t	(*se_sort)(struct hist_entry *, struct hist_entry *);
	int	(*se_snprintf)(struct hist_entry *he, char *bf, size_t size,
			       unsigned int width);
	int	(*se_filter)(struct hist_entry *he, int type, const void *arg);
	u8	se_width_idx;
};

extern struct sort_entry sort_thread;
extern struct list_head hist_entry__sort_list;

struct perf_evlist;
struct pevent;
int setup_sorting(struct perf_evlist *evlist);
int setup_output_field(void);
void reset_output_field(void);
void sort__setup_elide(FILE *fp);
void perf_hpp__set_elide(int idx, bool elide);

int report_parse_ignore_callees_opt(const struct option *opt, const char *arg, int unset);

bool is_strict_order(const char *order);

int hpp_dimension__add_output(unsigned col);
#endif	/* __PERF_SORT_H */
Commit	Line	Data
dd68ada2 JK	1	#ifndef __PERF_SORT_H
	2	#define __PERF_SORT_H
	3	#include "../builtin.h"
	4
	5	#include "util.h"
	6
	7	#include "color.h"
	8	#include <linux/list.h>
	9	#include "cache.h"
	10	#include <linux/rbtree.h>
	11	#include "symbol.h"
	12	#include "string.h"
	13	#include "callchain.h"
	14	#include "strlist.h"
	15	#include "values.h"
	16
	17	#include "../perf.h"
	18	#include "debug.h"
	19	#include "header.h"
	20
4b6ab94e	21	#include <subcmd/parse-options.h>
dd68ada2	22	#include "parse-events.h"
14135663	23	#include "hist.h"
dd68ada2	24	#include "thread.h"
dd68ada2 JK	25
dd68ada2 JK	26	extern regex_t parent_regex;
edb7c60e	27	extern const char *sort_order;
a7d945bc	28	extern const char *field_order;
edb7c60e ACM	29	extern const char default_parent_pattern[];
	30	extern const char *parent_pattern;
	31	extern const char default_sort_order[];
b21484f1 GP	32	extern regex_t ignore_callees_regex;
b21484f1 GP	33	extern int have_ignore_callees;
dd68ada2	34	extern int sort__need_collapse;
b1447a54	35	extern int sort__has_dso;
dd68ada2	36	extern int sort__has_parent;
1af55640	37	extern int sort__has_sym;
2e7ea3ab	38	extern int sort__has_socket;
cfd92dad	39	extern int sort__has_thread;
078b8d4a	40	extern int sort__has_comm;
55369fc1	41	extern enum sort_mode sort__mode;
dd68ada2 JK	42	extern struct sort_entry sort_comm;
	43	extern struct sort_entry sort_dso;
	44	extern struct sort_entry sort_sym;
	45	extern struct sort_entry sort_parent;
a68c2c58 SE	46	extern struct sort_entry sort_dso_from;
	47	extern struct sort_entry sort_dso_to;
	48	extern struct sort_entry sort_sym_from;
	49	extern struct sort_entry sort_sym_to;
a4fb581b	50	extern enum sort_type sort__first_dimension;
228f14f2	51	extern const char default_mem_sort_order[];
dd68ada2	52
b24c28f7 NK	53	struct he_stat {
	54	u64 period;
	55	u64 period_sys;
	56	u64 period_us;
	57	u64 period_guest_sys;
	58	u64 period_guest_us;
05484298	59	u64 weight;
b24c28f7 NK	60	u32 nr_events;
	61	};
	62
96c47f19 JO	63	struct hist_entry_diff {
96c47f19 JO	64	bool computed;
a0b404f4 NK	65	union {
	66	/* PERF_HPP__DELTA */
	67	double period_ratio_delta;
96c47f19	68
a0b404f4 NK	69	/* PERF_HPP__RATIO */
a0b404f4 NK	70	double period_ratio;
81d5f958	71
a0b404f4 NK	72	/* HISTC_WEIGHTED_DIFF */
	73	s64 wdiff;
	74	};
96c47f19 JO	75	};
96c47f19 JO	76
0f0cbf7a ACM	77	/**
	78	* struct hist_entry - histogram entry
	79	*
	80	* @row_offset - offset from the first callchain expanded to appear on screen
	81	* @nr_rows - rows expanded in callchain, recalculated on folding/unfolding
	82	*/
dd68ada2	83	struct hist_entry {
1980c2eb	84	struct rb_node rb_node_in;
dd68ada2	85	struct rb_node rb_node;
b821c732 ACM	86	union {
	87	struct list_head node;
	88	struct list_head head;
	89	} pairs;
b24c28f7	90	struct he_stat stat;
f8be1c8c	91	struct he_stat *stat_acc;
59fd5306	92	struct map_symbol ms;
a5e29aca	93	struct thread *thread;
4dfced35	94	struct comm *comm;
dd68ada2	95	u64 ip;
475eeab9	96	u64 transaction;
0c4c4deb	97	s32 socket;
f60f3593	98	s32 cpu;
7365be55	99	u8 cpumode;
aef810ec	100	u8 depth;
0f0cbf7a	101
e0af43d2 JO	102	/* We are added by hists__add_dummy_entry. */
e0af43d2 JO	103	bool dummy;
aef810ec	104	bool leaf;
e0af43d2	105
dd68ada2	106	char level;
a5e29aca	107	u8 filtered;
29750821 NK	108	union {
	109	/*
	110	* Since perf diff only supports the stdio output, TUI
	111	* fields are only accessed from perf report (or perf
	112	* top). So make it an union to reduce memory usage.
	113	*/
	114	struct hist_entry_diff diff;
	115	struct /* for TUI */ {
	116	u16 row_offset;
	117	u16 nr_rows;
d8a0f800	118	bool init_have_children;
3698dab1 NK	119	bool unfolded;
3698dab1 NK	120	bool has_children;
79dded87	121	bool has_no_entry;
29750821 NK	122	};
29750821 NK	123	};
409a8be6	124	char *srcline;
31191a85	125	char *srcfile;
83753190	126	struct symbol *parent;
b5387528	127	struct branch_info *branch_info;
ae359f19	128	struct hists *hists;
98a3b32c	129	struct mem_info *mem_info;
72392834 NK	130	void *raw_data;
72392834 NK	131	u32 raw_size;
60517d28	132	void *trace_output;
1b2dbbf4	133	struct perf_hpp_list *hpp_list;
aef810ec NK	134	struct hist_entry *parent_he;
	135	union {
	136	/* this is for hierarchical entry structure */
	137	struct {
	138	struct rb_root hroot_in;
	139	struct rb_root hroot_out;
	140	}; /* non-leaf entries */
	141	struct rb_root sorted_chain; /* leaf entry has callchains */
	142	};
98a3b32c	143	struct callchain_root callchain[0]; /* must be last member */
dd68ada2 JK	144	};
dd68ada2 JK	145
b821c732 ACM	146	static inline bool hist_entry__has_pairs(struct hist_entry *he)
	147	{
	148	return !list_empty(&he->pairs.node);
	149	}
	150
	151	static inline struct hist_entry hist_entry__next_pair(struct hist_entry he)
	152	{
	153	if (hist_entry__has_pairs(he))
	154	return list_entry(he->pairs.node.next, struct hist_entry, pairs.node);
	155	return NULL;
	156	}
	157
4d23322a JO	158	static inline void hist_entry__add_pair(struct hist_entry *pair,
4d23322a JO	159	struct hist_entry *he)
b821c732	160	{
4d23322a	161	list_add_tail(&pair->pairs.node, &he->pairs.head);
b821c732 ACM	162	}
b821c732 ACM	163
14135663 NK	164	static inline float hist_entry__get_percent_limit(struct hist_entry *he)
	165	{
	166	u64 period = he->stat.period;
	167	u64 total_period = hists__total_period(he->hists);
	168
	169	if (unlikely(total_period == 0))
	170	return 0;
	171
	172	if (symbol_conf.cumulate_callchain)
	173	period = he->stat_acc->period;
	174
	175	return period * 100.0 / total_period;
	176	}
	177
e95cf700 JO	178	static inline u64 cl_address(u64 address)
	179	{
	180	/* return the cacheline of the address */
	181	return (address & ~(cacheline_size - 1));
	182	}
14135663	183
d3927110 JO	184	static inline u64 cl_offset(u64 address)
	185	{
	186	/* return the cacheline of the address */
	187	return (address & (cacheline_size - 1));
	188	}
	189
55369fc1 NK	190	enum sort_mode {
	191	SORT_MODE__NORMAL,
	192	SORT_MODE__BRANCH,
	193	SORT_MODE__MEMORY,
512ae1bd NK	194	SORT_MODE__TOP,
512ae1bd NK	195	SORT_MODE__DIFF,
d49dadea	196	SORT_MODE__TRACEPOINT,
55369fc1 NK	197	};
55369fc1 NK	198
a4fb581b	199	enum sort_type {
fc5871ed	200	/* common sort keys */
a4fb581b FW	201	SORT_PID,
	202	SORT_COMM,
	203	SORT_DSO,
	204	SORT_SYM,
f60f3593 AS	205	SORT_PARENT,
f60f3593 AS	206	SORT_CPU,
2e7ea3ab	207	SORT_SOCKET,
fc5871ed	208	SORT_SRCLINE,
31191a85	209	SORT_SRCFILE,
f9ea55d0 AK	210	SORT_LOCAL_WEIGHT,
f9ea55d0 AK	211	SORT_GLOBAL_WEIGHT,
475eeab9	212	SORT_TRANSACTION,
a34bb6a0	213	SORT_TRACE,
fc5871ed NK	214
	215	/* branch stack specific sort keys */
	216	__SORT_BRANCH_STACK,
	217	SORT_DSO_FROM = __SORT_BRANCH_STACK,
b5387528 RAV	218	SORT_DSO_TO,
	219	SORT_SYM_FROM,
	220	SORT_SYM_TO,
	221	SORT_MISPREDICT,
f5d05bce AK	222	SORT_ABORT,
f5d05bce AK	223	SORT_IN_TX,
0e332f03	224	SORT_CYCLES,
afab87b9 NK	225
	226	/* memory mode specific sort keys */
	227	__SORT_MEMORY_MODE,
f9ea55d0	228	SORT_MEM_DADDR_SYMBOL = __SORT_MEMORY_MODE,
afab87b9 NK	229	SORT_MEM_DADDR_DSO,
	230	SORT_MEM_LOCKED,
	231	SORT_MEM_TLB,
	232	SORT_MEM_LVL,
	233	SORT_MEM_SNOOP,
9b32ba71	234	SORT_MEM_DCACHELINE,
28e6db20	235	SORT_MEM_IADDR_SYMBOL,
a4fb581b FW	236	};
a4fb581b FW	237
dd68ada2 JK	238	/*
	239	* configurable sorting bits
	240	*/
	241
	242	struct sort_entry {
fcd14984	243	const char *se_header;
dd68ada2	244
fcd14984 FW	245	int64_t (se_cmp)(struct hist_entry , struct hist_entry *);
fcd14984 FW	246	int64_t (se_collapse)(struct hist_entry , struct hist_entry *);
202e7a6d	247	int64_t (se_sort)(struct hist_entry , struct hist_entry *);
316c7136	248	int (se_snprintf)(struct hist_entry he, char *bf, size_t size,
fcd14984	249	unsigned int width);
54430101	250	int (se_filter)(struct hist_entry he, int type, const void *arg);
8a6c5b26	251	u8 se_width_idx;
dd68ada2 JK	252	};
	253
	254	extern struct sort_entry sort_thread;
	255	extern struct list_head hist_entry__sort_list;
	256
40184c46 NK	257	struct perf_evlist;
	258	struct pevent;
	259	int setup_sorting(struct perf_evlist *evlist);
a7d945bc	260	int setup_output_field(void);
1c89fe9b	261	void reset_output_field(void);
08e71542	262	void sort__setup_elide(FILE *fp);
f2998422	263	void perf_hpp__set_elide(int idx, bool elide);
dd68ada2	264
b21484f1 GP	265	int report_parse_ignore_callees_opt(const struct option opt, const char arg, int unset);
b21484f1 GP	266
2f3f9bcf	267	bool is_strict_order(const char *order);
beeaaeb3 JO	268
beeaaeb3 JO	269	int hpp_dimension__add_output(unsigned col);
dd68ada2	270	#endif /* __PERF_SORT_H */