xref: /linux/tools/perf/util/sort.h (revision 877a7a11050ee4d465364c57f8fbf78f6b1a2559)
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 <subcmd/parse-options.h>
22 #include "parse-events.h"
23 #include "hist.h"
24 #include "thread.h"
25 
26 extern regex_t parent_regex;
27 extern const char *sort_order;
28 extern const char *field_order;
29 extern const char default_parent_pattern[];
30 extern const char *parent_pattern;
31 extern const char *default_sort_order;
32 extern regex_t ignore_callees_regex;
33 extern int have_ignore_callees;
34 extern enum sort_mode sort__mode;
35 extern struct sort_entry sort_comm;
36 extern struct sort_entry sort_dso;
37 extern struct sort_entry sort_sym;
38 extern struct sort_entry sort_parent;
39 extern struct sort_entry sort_dso_from;
40 extern struct sort_entry sort_dso_to;
41 extern struct sort_entry sort_sym_from;
42 extern struct sort_entry sort_sym_to;
43 extern struct sort_entry sort_srcline;
44 extern enum sort_type sort__first_dimension;
45 extern const char default_mem_sort_order[];
46 
47 struct he_stat {
48 	u64			period;
49 	u64			period_sys;
50 	u64			period_us;
51 	u64			period_guest_sys;
52 	u64			period_guest_us;
53 	u64			weight;
54 	u32			nr_events;
55 };
56 
57 struct namespace_id {
58 	u64			dev;
59 	u64			ino;
60 };
61 
62 struct hist_entry_diff {
63 	bool	computed;
64 	union {
65 		/* PERF_HPP__DELTA */
66 		double	period_ratio_delta;
67 
68 		/* PERF_HPP__RATIO */
69 		double	period_ratio;
70 
71 		/* HISTC_WEIGHTED_DIFF */
72 		s64	wdiff;
73 	};
74 };
75 
76 struct hist_entry_ops {
77 	void	*(*new)(size_t size);
78 	void	(*free)(void *ptr);
79 };
80 
81 /**
82  * struct hist_entry - histogram entry
83  *
84  * @row_offset - offset from the first callchain expanded to appear on screen
85  * @nr_rows - rows expanded in callchain, recalculated on folding/unfolding
86  */
87 struct hist_entry {
88 	struct rb_node		rb_node_in;
89 	struct rb_node		rb_node;
90 	union {
91 		struct list_head node;
92 		struct list_head head;
93 	} pairs;
94 	struct he_stat		stat;
95 	struct he_stat		*stat_acc;
96 	struct map_symbol	ms;
97 	struct thread		*thread;
98 	struct comm		*comm;
99 	struct namespace_id	cgroup_id;
100 	u64			ip;
101 	u64			transaction;
102 	s32			socket;
103 	s32			cpu;
104 	u8			cpumode;
105 	u8			depth;
106 
107 	/* We are added by hists__add_dummy_entry. */
108 	bool			dummy;
109 	bool			leaf;
110 
111 	char			level;
112 	u8			filtered;
113 	union {
114 		/*
115 		 * Since perf diff only supports the stdio output, TUI
116 		 * fields are only accessed from perf report (or perf
117 		 * top).  So make it a union to reduce memory usage.
118 		 */
119 		struct hist_entry_diff	diff;
120 		struct /* for TUI */ {
121 			u16	row_offset;
122 			u16	nr_rows;
123 			bool	init_have_children;
124 			bool	unfolded;
125 			bool	has_children;
126 			bool	has_no_entry;
127 		};
128 	};
129 	char			*srcline;
130 	char			*srcfile;
131 	struct inline_node	*inline_node;
132 	struct symbol		*parent;
133 	struct branch_info	*branch_info;
134 	struct hists		*hists;
135 	struct mem_info		*mem_info;
136 	void			*raw_data;
137 	u32			raw_size;
138 	void			*trace_output;
139 	struct perf_hpp_list	*hpp_list;
140 	struct hist_entry	*parent_he;
141 	struct hist_entry_ops	*ops;
142 	union {
143 		/* this is for hierarchical entry structure */
144 		struct {
145 			struct rb_root	hroot_in;
146 			struct rb_root  hroot_out;
147 		};				/* non-leaf entries */
148 		struct rb_root	sorted_chain;	/* leaf entry has callchains */
149 	};
150 	struct callchain_root	callchain[0]; /* must be last member */
151 };
152 
153 static inline bool hist_entry__has_pairs(struct hist_entry *he)
154 {
155 	return !list_empty(&he->pairs.node);
156 }
157 
158 static inline struct hist_entry *hist_entry__next_pair(struct hist_entry *he)
159 {
160 	if (hist_entry__has_pairs(he))
161 		return list_entry(he->pairs.node.next, struct hist_entry, pairs.node);
162 	return NULL;
163 }
164 
165 static inline void hist_entry__add_pair(struct hist_entry *pair,
166 					struct hist_entry *he)
167 {
168 	list_add_tail(&pair->pairs.node, &he->pairs.head);
169 }
170 
171 static inline float hist_entry__get_percent_limit(struct hist_entry *he)
172 {
173 	u64 period = he->stat.period;
174 	u64 total_period = hists__total_period(he->hists);
175 
176 	if (unlikely(total_period == 0))
177 		return 0;
178 
179 	if (symbol_conf.cumulate_callchain)
180 		period = he->stat_acc->period;
181 
182 	return period * 100.0 / total_period;
183 }
184 
185 static inline u64 cl_address(u64 address)
186 {
187 	/* return the cacheline of the address */
188 	return (address & ~(cacheline_size - 1));
189 }
190 
191 static inline u64 cl_offset(u64 address)
192 {
193 	/* return the cacheline of the address */
194 	return (address & (cacheline_size - 1));
195 }
196 
197 enum sort_mode {
198 	SORT_MODE__NORMAL,
199 	SORT_MODE__BRANCH,
200 	SORT_MODE__MEMORY,
201 	SORT_MODE__TOP,
202 	SORT_MODE__DIFF,
203 	SORT_MODE__TRACEPOINT,
204 };
205 
206 enum sort_type {
207 	/* common sort keys */
208 	SORT_PID,
209 	SORT_COMM,
210 	SORT_DSO,
211 	SORT_SYM,
212 	SORT_PARENT,
213 	SORT_CPU,
214 	SORT_SOCKET,
215 	SORT_SRCLINE,
216 	SORT_SRCFILE,
217 	SORT_LOCAL_WEIGHT,
218 	SORT_GLOBAL_WEIGHT,
219 	SORT_TRANSACTION,
220 	SORT_TRACE,
221 	SORT_SYM_SIZE,
222 	SORT_CGROUP_ID,
223 
224 	/* branch stack specific sort keys */
225 	__SORT_BRANCH_STACK,
226 	SORT_DSO_FROM = __SORT_BRANCH_STACK,
227 	SORT_DSO_TO,
228 	SORT_SYM_FROM,
229 	SORT_SYM_TO,
230 	SORT_MISPREDICT,
231 	SORT_ABORT,
232 	SORT_IN_TX,
233 	SORT_CYCLES,
234 	SORT_SRCLINE_FROM,
235 	SORT_SRCLINE_TO,
236 
237 	/* memory mode specific sort keys */
238 	__SORT_MEMORY_MODE,
239 	SORT_MEM_DADDR_SYMBOL = __SORT_MEMORY_MODE,
240 	SORT_MEM_DADDR_DSO,
241 	SORT_MEM_LOCKED,
242 	SORT_MEM_TLB,
243 	SORT_MEM_LVL,
244 	SORT_MEM_SNOOP,
245 	SORT_MEM_DCACHELINE,
246 	SORT_MEM_IADDR_SYMBOL,
247 };
248 
249 /*
250  * configurable sorting bits
251  */
252 
253 struct sort_entry {
254 	const char *se_header;
255 
256 	int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
257 	int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
258 	int64_t	(*se_sort)(struct hist_entry *, struct hist_entry *);
259 	int	(*se_snprintf)(struct hist_entry *he, char *bf, size_t size,
260 			       unsigned int width);
261 	int	(*se_filter)(struct hist_entry *he, int type, const void *arg);
262 	u8	se_width_idx;
263 };
264 
265 extern struct sort_entry sort_thread;
266 extern struct list_head hist_entry__sort_list;
267 
268 struct perf_evlist;
269 struct pevent;
270 int setup_sorting(struct perf_evlist *evlist);
271 int setup_output_field(void);
272 void reset_output_field(void);
273 void sort__setup_elide(FILE *fp);
274 void perf_hpp__set_elide(int idx, bool elide);
275 
276 int report_parse_ignore_callees_opt(const struct option *opt, const char *arg, int unset);
277 
278 bool is_strict_order(const char *order);
279 
280 int hpp_dimension__add_output(unsigned col);
281 void reset_dimensions(void);
282 int sort_dimension__add(struct perf_hpp_list *list, const char *tok,
283 			struct perf_evlist *evlist,
284 			int level);
285 int output_field_add(struct perf_hpp_list *list, char *tok);
286 int64_t
287 sort__iaddr_cmp(struct hist_entry *left, struct hist_entry *right);
288 int64_t
289 sort__daddr_cmp(struct hist_entry *left, struct hist_entry *right);
290 int64_t
291 sort__dcacheline_cmp(struct hist_entry *left, struct hist_entry *right);
292 char *hist_entry__get_srcline(struct hist_entry *he);
293 #endif	/* __PERF_SORT_H */
294