xref: /linux/tools/perf/util/sort.h (revision ab58a2f319de945f631150a190653a90e307df8e)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_SORT_H
3 #define __PERF_SORT_H
4 #include <regex.h>
5 #include <stdbool.h>
6 #include <linux/list.h>
7 #include <linux/rbtree.h>
8 #include "map_symbol.h"
9 #include "symbol_conf.h"
10 #include "callchain.h"
11 #include "values.h"
12 #include "hist.h"
13 #include "stat.h"
14 #include "spark.h"
15 
16 struct option;
17 struct thread;
18 struct annotated_data_type;
19 
20 extern regex_t parent_regex;
21 extern const char *sort_order;
22 extern const char *field_order;
23 extern const char default_parent_pattern[];
24 extern const char *parent_pattern;
25 extern const char *default_sort_order;
26 extern regex_t ignore_callees_regex;
27 extern int have_ignore_callees;
28 extern enum sort_mode sort__mode;
29 extern struct sort_entry sort_comm;
30 extern struct sort_entry sort_dso;
31 extern struct sort_entry sort_sym;
32 extern struct sort_entry sort_parent;
33 extern struct sort_entry sort_dso_from;
34 extern struct sort_entry sort_dso_to;
35 extern struct sort_entry sort_sym_from;
36 extern struct sort_entry sort_sym_to;
37 extern struct sort_entry sort_srcline;
38 extern struct sort_entry sort_type;
39 extern const char default_mem_sort_order[];
40 extern bool chk_double_cl;
41 
42 struct res_sample {
43 	u64 time;
44 	int cpu;
45 	int tid;
46 };
47 
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;
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 		/* PERF_HPP_DIFF__CYCLES */
75 		s64	cycles;
76 	};
77 	struct stats	stats;
78 	unsigned long	svals[NUM_SPARKS];
79 };
80 
81 struct hist_entry_ops {
82 	void	*(*new)(size_t size);
83 	void	(*free)(void *ptr);
84 };
85 
86 /**
87  * struct hist_entry - histogram entry
88  *
89  * @row_offset - offset from the first callchain expanded to appear on screen
90  * @nr_rows - rows expanded in callchain, recalculated on folding/unfolding
91  */
92 struct hist_entry {
93 	struct rb_node		rb_node_in;
94 	struct rb_node		rb_node;
95 	union {
96 		struct list_head node;
97 		struct list_head head;
98 	} pairs;
99 	struct he_stat		stat;
100 	struct he_stat		*stat_acc;
101 	struct map_symbol	ms;
102 	struct thread		*thread;
103 	struct comm		*comm;
104 	struct namespace_id	cgroup_id;
105 	u64			cgroup;
106 	u64			ip;
107 	u64			transaction;
108 	s32			socket;
109 	s32			cpu;
110 	u64			code_page_size;
111 	u64			weight;
112 	u64			ins_lat;
113 	u64			p_stage_cyc;
114 	u8			cpumode;
115 	u8			depth;
116 	int			mem_type_off;
117 	struct simd_flags	simd_flags;
118 
119 	/* We are added by hists__add_dummy_entry. */
120 	bool			dummy;
121 	bool			leaf;
122 
123 	char			level;
124 	u8			filtered;
125 
126 	u16			callchain_size;
127 	union {
128 		/*
129 		 * Since perf diff only supports the stdio output, TUI
130 		 * fields are only accessed from perf report (or perf
131 		 * top).  So make it a union to reduce memory usage.
132 		 */
133 		struct hist_entry_diff	diff;
134 		struct /* for TUI */ {
135 			u16	row_offset;
136 			u16	nr_rows;
137 			bool	init_have_children;
138 			bool	unfolded;
139 			bool	has_children;
140 			bool	has_no_entry;
141 		};
142 	};
143 	char			*srcline;
144 	char			*srcfile;
145 	struct symbol		*parent;
146 	struct branch_info	*branch_info;
147 	long			time;
148 	struct hists		*hists;
149 	struct mem_info		*mem_info;
150 	struct block_info	*block_info;
151 	struct kvm_info		*kvm_info;
152 	void			*raw_data;
153 	u32			raw_size;
154 	int			num_res;
155 	struct res_sample	*res_samples;
156 	void			*trace_output;
157 	struct perf_hpp_list	*hpp_list;
158 	struct hist_entry	*parent_he;
159 	struct hist_entry_ops	*ops;
160 	struct annotated_data_type *mem_type;
161 	union {
162 		/* this is for hierarchical entry structure */
163 		struct {
164 			struct rb_root_cached	hroot_in;
165 			struct rb_root_cached   hroot_out;
166 		};				/* non-leaf entries */
167 		struct rb_root	sorted_chain;	/* leaf entry has callchains */
168 	};
169 	struct callchain_root	callchain[0]; /* must be last member */
170 };
171 
172 static __pure inline bool hist_entry__has_callchains(struct hist_entry *he)
173 {
174 	return he->callchain_size != 0;
175 }
176 
177 int hist_entry__sym_snprintf(struct hist_entry *he, char *bf, size_t size, unsigned int width);
178 
179 static inline bool hist_entry__has_pairs(struct hist_entry *he)
180 {
181 	return !list_empty(&he->pairs.node);
182 }
183 
184 static inline struct hist_entry *hist_entry__next_pair(struct hist_entry *he)
185 {
186 	if (hist_entry__has_pairs(he))
187 		return list_entry(he->pairs.node.next, struct hist_entry, pairs.node);
188 	return NULL;
189 }
190 
191 static inline void hist_entry__add_pair(struct hist_entry *pair,
192 					struct hist_entry *he)
193 {
194 	list_add_tail(&pair->pairs.node, &he->pairs.head);
195 }
196 
197 static inline float hist_entry__get_percent_limit(struct hist_entry *he)
198 {
199 	u64 period = he->stat.period;
200 	u64 total_period = hists__total_period(he->hists);
201 
202 	if (unlikely(total_period == 0))
203 		return 0;
204 
205 	if (symbol_conf.cumulate_callchain)
206 		period = he->stat_acc->period;
207 
208 	return period * 100.0 / total_period;
209 }
210 
211 enum sort_mode {
212 	SORT_MODE__NORMAL,
213 	SORT_MODE__BRANCH,
214 	SORT_MODE__MEMORY,
215 	SORT_MODE__TOP,
216 	SORT_MODE__DIFF,
217 	SORT_MODE__TRACEPOINT,
218 };
219 
220 enum sort_type {
221 	/* common sort keys */
222 	SORT_PID,
223 	SORT_COMM,
224 	SORT_DSO,
225 	SORT_SYM,
226 	SORT_PARENT,
227 	SORT_CPU,
228 	SORT_SOCKET,
229 	SORT_SRCLINE,
230 	SORT_SRCFILE,
231 	SORT_LOCAL_WEIGHT,
232 	SORT_GLOBAL_WEIGHT,
233 	SORT_TRANSACTION,
234 	SORT_TRACE,
235 	SORT_SYM_SIZE,
236 	SORT_DSO_SIZE,
237 	SORT_CGROUP,
238 	SORT_CGROUP_ID,
239 	SORT_SYM_IPC_NULL,
240 	SORT_TIME,
241 	SORT_CODE_PAGE_SIZE,
242 	SORT_LOCAL_INS_LAT,
243 	SORT_GLOBAL_INS_LAT,
244 	SORT_LOCAL_PIPELINE_STAGE_CYC,
245 	SORT_GLOBAL_PIPELINE_STAGE_CYC,
246 	SORT_ADDR,
247 	SORT_LOCAL_RETIRE_LAT,
248 	SORT_GLOBAL_RETIRE_LAT,
249 	SORT_SIMD,
250 	SORT_ANNOTATE_DATA_TYPE,
251 	SORT_ANNOTATE_DATA_TYPE_OFFSET,
252 	SORT_SYM_OFFSET,
253 
254 	/* branch stack specific sort keys */
255 	__SORT_BRANCH_STACK,
256 	SORT_DSO_FROM = __SORT_BRANCH_STACK,
257 	SORT_DSO_TO,
258 	SORT_SYM_FROM,
259 	SORT_SYM_TO,
260 	SORT_MISPREDICT,
261 	SORT_ABORT,
262 	SORT_IN_TX,
263 	SORT_CYCLES,
264 	SORT_SRCLINE_FROM,
265 	SORT_SRCLINE_TO,
266 	SORT_SYM_IPC,
267 	SORT_ADDR_FROM,
268 	SORT_ADDR_TO,
269 
270 	/* memory mode specific sort keys */
271 	__SORT_MEMORY_MODE,
272 	SORT_MEM_DADDR_SYMBOL = __SORT_MEMORY_MODE,
273 	SORT_MEM_DADDR_DSO,
274 	SORT_MEM_LOCKED,
275 	SORT_MEM_TLB,
276 	SORT_MEM_LVL,
277 	SORT_MEM_SNOOP,
278 	SORT_MEM_DCACHELINE,
279 	SORT_MEM_IADDR_SYMBOL,
280 	SORT_MEM_PHYS_DADDR,
281 	SORT_MEM_DATA_PAGE_SIZE,
282 	SORT_MEM_BLOCKED,
283 };
284 
285 /*
286  * configurable sorting bits
287  */
288 
289 struct sort_entry {
290 	const char *se_header;
291 
292 	int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
293 	int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
294 	int64_t	(*se_sort)(struct hist_entry *, struct hist_entry *);
295 	int	(*se_snprintf)(struct hist_entry *he, char *bf, size_t size,
296 			       unsigned int width);
297 	int	(*se_filter)(struct hist_entry *he, int type, const void *arg);
298 	void	(*se_init)(struct hist_entry *he);
299 	u8	se_width_idx;
300 };
301 
302 struct block_hist {
303 	struct hists		block_hists;
304 	struct perf_hpp_list	block_list;
305 	struct perf_hpp_fmt	block_fmt;
306 	int			block_idx;
307 	bool			valid;
308 	struct hist_entry	he;
309 };
310 
311 extern struct sort_entry sort_thread;
312 
313 struct evlist;
314 struct tep_handle;
315 int setup_sorting(struct evlist *evlist);
316 int setup_output_field(void);
317 void reset_output_field(void);
318 void sort__setup_elide(FILE *fp);
319 void perf_hpp__set_elide(int idx, bool elide);
320 
321 char *sort_help(const char *prefix);
322 
323 int report_parse_ignore_callees_opt(const struct option *opt, const char *arg, int unset);
324 
325 bool is_strict_order(const char *order);
326 
327 int hpp_dimension__add_output(unsigned col);
328 void reset_dimensions(void);
329 int sort_dimension__add(struct perf_hpp_list *list, const char *tok,
330 			struct evlist *evlist,
331 			int level);
332 int output_field_add(struct perf_hpp_list *list, char *tok);
333 int64_t
334 sort__iaddr_cmp(struct hist_entry *left, struct hist_entry *right);
335 int64_t
336 sort__daddr_cmp(struct hist_entry *left, struct hist_entry *right);
337 int64_t
338 sort__dcacheline_cmp(struct hist_entry *left, struct hist_entry *right);
339 int64_t
340 _sort__sym_cmp(struct symbol *sym_l, struct symbol *sym_r);
341 char *hist_entry__srcline(struct hist_entry *he);
342 #endif	/* __PERF_SORT_H */
343