[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 "parse-options.h"
#include "parse-events.h"

#include "thread.h"
#include "sort.h"

extern regex_t parent_regex;
extern const char *sort_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_parent;
extern int sort__has_sym;
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;

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;

	/* 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 map_symbol	ms;
	struct thread		*thread;
	u64			ip;
	s32			cpu;

	struct hist_entry_diff	diff;

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

	/* XXX These two should move to some tree widget lib */
	u16			row_offset;
	u16			nr_rows;

	bool			init_have_children;
	char			level;
	bool			used;
	u8			filtered;
	char			*srcline;
	struct symbol		*parent;
	unsigned long		position;
	struct rb_root		sorted_chain;
	struct branch_info	*branch_info;
	struct hists		*hists;
	struct mem_info		*mem_info;
	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);
}

enum sort_mode {
	SORT_MODE__NORMAL,
	SORT_MODE__BRANCH,
	SORT_MODE__MEMORY,
};

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

	/* 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,

	/* 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,
};

/*
 * configurable sorting bits
 */

struct sort_entry {
	struct list_head list;

	const char *se_header;

	int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
	int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
	int	(*se_snprintf)(struct hist_entry *self, char *bf, size_t size,
			       unsigned int width);
	u8	se_width_idx;
	bool	elide;
};

extern struct sort_entry sort_thread;
extern struct list_head hist_entry__sort_list;

int setup_sorting(void);
extern int sort_dimension__add(const char *);
void sort__setup_elide(FILE *fp);

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

#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
	21	#include "parse-options.h"
	22	#include "parse-events.h"
	23
	24	#include "thread.h"
	25	#include "sort.h"
	26
	27	extern regex_t parent_regex;
edb7c60e ACM	28	extern const char *sort_order;
	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 JK	34	extern int sort__need_collapse;
dd68ada2 JK	35	extern int sort__has_parent;
1af55640	36	extern int sort__has_sym;
55369fc1	37	extern enum sort_mode sort__mode;
dd68ada2 JK	38	extern struct sort_entry sort_comm;
	39	extern struct sort_entry sort_dso;
	40	extern struct sort_entry sort_sym;
	41	extern struct sort_entry sort_parent;
a68c2c58 SE	42	extern struct sort_entry sort_dso_from;
	43	extern struct sort_entry sort_dso_to;
	44	extern struct sort_entry sort_sym_from;
	45	extern struct sort_entry sort_sym_to;
a4fb581b	46	extern enum sort_type sort__first_dimension;
dd68ada2	47
b24c28f7 NK	48	struct he_stat {
	49	u64 period;
	50	u64 period_sys;
	51	u64 period_us;
	52	u64 period_guest_sys;
	53	u64 period_guest_us;
05484298	54	u64 weight;
b24c28f7 NK	55	u32 nr_events;
	56	};
	57
96c47f19 JO	58	struct hist_entry_diff {
	59	bool computed;
	60
96c47f19 JO	61	/* PERF_HPP__DELTA */
	62	double period_ratio_delta;
	63
	64	/* PERF_HPP__RATIO */
	65	double period_ratio;
81d5f958 JO	66
	67	/* HISTC_WEIGHTED_DIFF */
	68	s64 wdiff;
96c47f19 JO	69	};
96c47f19 JO	70
0f0cbf7a ACM	71	/**
	72	* struct hist_entry - histogram entry
	73	*
	74	* @row_offset - offset from the first callchain expanded to appear on screen
	75	* @nr_rows - rows expanded in callchain, recalculated on folding/unfolding
	76	*/
dd68ada2	77	struct hist_entry {
1980c2eb	78	struct rb_node rb_node_in;
dd68ada2	79	struct rb_node rb_node;
b821c732 ACM	80	union {
	81	struct list_head node;
	82	struct list_head head;
	83	} pairs;
b24c28f7	84	struct he_stat stat;
59fd5306	85	struct map_symbol ms;
a5e29aca	86	struct thread *thread;
dd68ada2	87	u64 ip;
f60f3593	88	s32 cpu;
0f0cbf7a	89
96c47f19 JO	90	struct hist_entry_diff diff;
96c47f19 JO	91
e0af43d2 JO	92	/* We are added by hists__add_dummy_entry. */
	93	bool dummy;
	94
0f0cbf7a ACM	95	/* XXX These two should move to some tree widget lib */
	96	u16 row_offset;
	97	u16 nr_rows;
	98
	99	bool init_have_children;
dd68ada2	100	char level;
df71d95f	101	bool used;
a5e29aca	102	u8 filtered;
409a8be6	103	char *srcline;
83753190	104	struct symbol *parent;
dd464345	105	unsigned long position;
b821c732	106	struct rb_root sorted_chain;
b5387528	107	struct branch_info *branch_info;
ae359f19	108	struct hists *hists;
98a3b32c SE	109	struct mem_info *mem_info;
98a3b32c SE	110	struct callchain_root callchain[0]; /* must be last member */
dd68ada2 JK	111	};
dd68ada2 JK	112
b821c732 ACM	113	static inline bool hist_entry__has_pairs(struct hist_entry *he)
	114	{
	115	return !list_empty(&he->pairs.node);
	116	}
	117
	118	static inline struct hist_entry hist_entry__next_pair(struct hist_entry he)
	119	{
	120	if (hist_entry__has_pairs(he))
	121	return list_entry(he->pairs.node.next, struct hist_entry, pairs.node);
	122	return NULL;
	123	}
	124
4d23322a JO	125	static inline void hist_entry__add_pair(struct hist_entry *pair,
4d23322a JO	126	struct hist_entry *he)
b821c732	127	{
4d23322a	128	list_add_tail(&pair->pairs.node, &he->pairs.head);
b821c732 ACM	129	}
b821c732 ACM	130
55369fc1 NK	131	enum sort_mode {
	132	SORT_MODE__NORMAL,
	133	SORT_MODE__BRANCH,
	134	SORT_MODE__MEMORY,
	135	};
	136
a4fb581b	137	enum sort_type {
fc5871ed	138	/* common sort keys */
a4fb581b FW	139	SORT_PID,
	140	SORT_COMM,
	141	SORT_DSO,
	142	SORT_SYM,
f60f3593 AS	143	SORT_PARENT,
f60f3593 AS	144	SORT_CPU,
fc5871ed	145	SORT_SRCLINE,
f9ea55d0 AK	146	SORT_LOCAL_WEIGHT,
f9ea55d0 AK	147	SORT_GLOBAL_WEIGHT,
fc5871ed NK	148
	149	/* branch stack specific sort keys */
	150	__SORT_BRANCH_STACK,
	151	SORT_DSO_FROM = __SORT_BRANCH_STACK,
b5387528 RAV	152	SORT_DSO_TO,
	153	SORT_SYM_FROM,
	154	SORT_SYM_TO,
	155	SORT_MISPREDICT,
f5d05bce AK	156	SORT_ABORT,
f5d05bce AK	157	SORT_IN_TX,
afab87b9 NK	158
	159	/* memory mode specific sort keys */
	160	__SORT_MEMORY_MODE,
f9ea55d0	161	SORT_MEM_DADDR_SYMBOL = __SORT_MEMORY_MODE,
afab87b9 NK	162	SORT_MEM_DADDR_DSO,
	163	SORT_MEM_LOCKED,
	164	SORT_MEM_TLB,
	165	SORT_MEM_LVL,
	166	SORT_MEM_SNOOP,
a4fb581b FW	167	};
a4fb581b FW	168
dd68ada2 JK	169	/*
	170	* configurable sorting bits
	171	*/
	172
	173	struct sort_entry {
	174	struct list_head list;
	175
fcd14984	176	const char *se_header;
dd68ada2	177
fcd14984 FW	178	int64_t (se_cmp)(struct hist_entry , struct hist_entry *);
	179	int64_t (se_collapse)(struct hist_entry , struct hist_entry *);
	180	int (se_snprintf)(struct hist_entry self, char *bf, size_t size,
	181	unsigned int width);
8a6c5b26	182	u8 se_width_idx;
dd68ada2 JK	183	bool elide;
	184	};
	185
	186	extern struct sort_entry sort_thread;
	187	extern struct list_head hist_entry__sort_list;
	188
55309985	189	int setup_sorting(void);
dd68ada2	190	extern int sort_dimension__add(const char *);
08e71542	191	void sort__setup_elide(FILE *fp);
dd68ada2	192
b21484f1 GP	193	int report_parse_ignore_callees_opt(const struct option opt, const char arg, int unset);
b21484f1 GP	194
dd68ada2	195	#endif /* __PERF_SORT_H */