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