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