[mirror_ubuntu-eoan-kernel.git] / tools / perf / util / sort.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __PERF_SORT_H
#define __PERF_SORT_H
#include "../builtin.h"

#include <regex.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 "values.h"

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

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

struct thread;

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 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 struct sort_entry sort_srcline;
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 namespace_id {
	u64			dev;
	u64			ino;
};

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_ops {
	void	*(*new)(size_t size);
	void	(*free)(void *ptr);
};

/**
 * 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;
	struct namespace_id	cgroup_id;
	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 a 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 inline_node	*inline_node;
	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;
	struct hist_entry_ops	*ops;
	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,
	SORT_SYM_SIZE,
	SORT_CGROUP_ID,

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

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

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