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