xref: /openbmc/linux/tools/perf/util/sort.h (revision 6cc23ed2)
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 
14 struct option;
15 struct thread;
16 
17 extern regex_t parent_regex;
18 extern const char *sort_order;
19 extern const char *field_order;
20 extern const char default_parent_pattern[];
21 extern const char *parent_pattern;
22 extern const char *default_sort_order;
23 extern regex_t ignore_callees_regex;
24 extern int have_ignore_callees;
25 extern enum sort_mode sort__mode;
26 extern struct sort_entry sort_comm;
27 extern struct sort_entry sort_dso;
28 extern struct sort_entry sort_sym;
29 extern struct sort_entry sort_parent;
30 extern struct sort_entry sort_dso_from;
31 extern struct sort_entry sort_dso_to;
32 extern struct sort_entry sort_sym_from;
33 extern struct sort_entry sort_sym_to;
34 extern struct sort_entry sort_srcline;
35 extern enum sort_type sort__first_dimension;
36 extern const char default_mem_sort_order[];
37 
38 struct res_sample {
39 	u64 time;
40 	int cpu;
41 	int tid;
42 };
43 
44 struct he_stat {
45 	u64			period;
46 	u64			period_sys;
47 	u64			period_us;
48 	u64			period_guest_sys;
49 	u64			period_guest_us;
50 	u64			weight;
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 };
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 
114 	u16			callchain_size;
115 	union {
116 		/*
117 		 * Since perf diff only supports the stdio output, TUI
118 		 * fields are only accessed from perf report (or perf
119 		 * top).  So make it a union to reduce memory usage.
120 		 */
121 		struct hist_entry_diff	diff;
122 		struct /* for TUI */ {
123 			u16	row_offset;
124 			u16	nr_rows;
125 			bool	init_have_children;
126 			bool	unfolded;
127 			bool	has_children;
128 			bool	has_no_entry;
129 		};
130 	};
131 	char			*srcline;
132 	char			*srcfile;
133 	struct symbol		*parent;
134 	struct branch_info	*branch_info;
135 	long			time;
136 	struct hists		*hists;
137 	struct mem_info		*mem_info;
138 	struct block_info	*block_info;
139 	void			*raw_data;
140 	u32			raw_size;
141 	int			num_res;
142 	struct res_sample	*res_samples;
143 	void			*trace_output;
144 	struct perf_hpp_list	*hpp_list;
145 	struct hist_entry	*parent_he;
146 	struct hist_entry_ops	*ops;
147 	union {
148 		/* this is for hierarchical entry structure */
149 		struct {
150 			struct rb_root_cached	hroot_in;
151 			struct rb_root_cached   hroot_out;
152 		};				/* non-leaf entries */
153 		struct rb_root	sorted_chain;	/* leaf entry has callchains */
154 	};
155 	struct callchain_root	callchain[0]; /* must be last member */
156 };
157 
158 static __pure inline bool hist_entry__has_callchains(struct hist_entry *he)
159 {
160 	return he->callchain_size != 0;
161 }
162 
163 static inline bool hist_entry__has_pairs(struct hist_entry *he)
164 {
165 	return !list_empty(&he->pairs.node);
166 }
167 
168 static inline struct hist_entry *hist_entry__next_pair(struct hist_entry *he)
169 {
170 	if (hist_entry__has_pairs(he))
171 		return list_entry(he->pairs.node.next, struct hist_entry, pairs.node);
172 	return NULL;
173 }
174 
175 static inline void hist_entry__add_pair(struct hist_entry *pair,
176 					struct hist_entry *he)
177 {
178 	list_add_tail(&pair->pairs.node, &he->pairs.head);
179 }
180 
181 static inline float hist_entry__get_percent_limit(struct hist_entry *he)
182 {
183 	u64 period = he->stat.period;
184 	u64 total_period = hists__total_period(he->hists);
185 
186 	if (unlikely(total_period == 0))
187 		return 0;
188 
189 	if (symbol_conf.cumulate_callchain)
190 		period = he->stat_acc->period;
191 
192 	return period * 100.0 / total_period;
193 }
194 
195 enum sort_mode {
196 	SORT_MODE__NORMAL,
197 	SORT_MODE__BRANCH,
198 	SORT_MODE__MEMORY,
199 	SORT_MODE__TOP,
200 	SORT_MODE__DIFF,
201 	SORT_MODE__TRACEPOINT,
202 };
203 
204 enum sort_type {
205 	/* common sort keys */
206 	SORT_PID,
207 	SORT_COMM,
208 	SORT_DSO,
209 	SORT_SYM,
210 	SORT_PARENT,
211 	SORT_CPU,
212 	SORT_SOCKET,
213 	SORT_SRCLINE,
214 	SORT_SRCFILE,
215 	SORT_LOCAL_WEIGHT,
216 	SORT_GLOBAL_WEIGHT,
217 	SORT_TRANSACTION,
218 	SORT_TRACE,
219 	SORT_SYM_SIZE,
220 	SORT_DSO_SIZE,
221 	SORT_CGROUP_ID,
222 	SORT_SYM_IPC_NULL,
223 	SORT_TIME,
224 
225 	/* branch stack specific sort keys */
226 	__SORT_BRANCH_STACK,
227 	SORT_DSO_FROM = __SORT_BRANCH_STACK,
228 	SORT_DSO_TO,
229 	SORT_SYM_FROM,
230 	SORT_SYM_TO,
231 	SORT_MISPREDICT,
232 	SORT_ABORT,
233 	SORT_IN_TX,
234 	SORT_CYCLES,
235 	SORT_SRCLINE_FROM,
236 	SORT_SRCLINE_TO,
237 	SORT_SYM_IPC,
238 
239 	/* memory mode specific sort keys */
240 	__SORT_MEMORY_MODE,
241 	SORT_MEM_DADDR_SYMBOL = __SORT_MEMORY_MODE,
242 	SORT_MEM_DADDR_DSO,
243 	SORT_MEM_LOCKED,
244 	SORT_MEM_TLB,
245 	SORT_MEM_LVL,
246 	SORT_MEM_SNOOP,
247 	SORT_MEM_DCACHELINE,
248 	SORT_MEM_IADDR_SYMBOL,
249 	SORT_MEM_PHYS_DADDR,
250 };
251 
252 /*
253  * configurable sorting bits
254  */
255 
256 struct sort_entry {
257 	const char *se_header;
258 
259 	int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
260 	int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
261 	int64_t	(*se_sort)(struct hist_entry *, struct hist_entry *);
262 	int	(*se_snprintf)(struct hist_entry *he, char *bf, size_t size,
263 			       unsigned int width);
264 	int	(*se_filter)(struct hist_entry *he, int type, const void *arg);
265 	u8	se_width_idx;
266 };
267 
268 struct block_hist {
269 	struct hists		block_hists;
270 	struct perf_hpp_list	block_list;
271 	struct perf_hpp_fmt	block_fmt;
272 	int			block_idx;
273 	bool			valid;
274 	struct hist_entry	he;
275 };
276 
277 extern struct sort_entry sort_thread;
278 extern struct list_head hist_entry__sort_list;
279 
280 struct evlist;
281 struct tep_handle;
282 int setup_sorting(struct evlist *evlist);
283 int setup_output_field(void);
284 void reset_output_field(void);
285 void sort__setup_elide(FILE *fp);
286 void perf_hpp__set_elide(int idx, bool elide);
287 
288 const char *sort_help(const char *prefix);
289 
290 int report_parse_ignore_callees_opt(const struct option *opt, const char *arg, int unset);
291 
292 bool is_strict_order(const char *order);
293 
294 int hpp_dimension__add_output(unsigned col);
295 void reset_dimensions(void);
296 int sort_dimension__add(struct perf_hpp_list *list, const char *tok,
297 			struct evlist *evlist,
298 			int level);
299 int output_field_add(struct perf_hpp_list *list, char *tok);
300 int64_t
301 sort__iaddr_cmp(struct hist_entry *left, struct hist_entry *right);
302 int64_t
303 sort__daddr_cmp(struct hist_entry *left, struct hist_entry *right);
304 int64_t
305 sort__dcacheline_cmp(struct hist_entry *left, struct hist_entry *right);
306 char *hist_entry__srcline(struct hist_entry *he);
307 #endif	/* __PERF_SORT_H */
308