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