GNU Linux-libre 4.19.211-gnu1
[releases.git] / tools / perf / util / sort.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_SORT_H
3 #define __PERF_SORT_H
4 #include "../builtin.h"
5
6 #include <regex.h>
7
8 #include "color.h"
9 #include <linux/list.h>
10 #include "cache.h"
11 #include <linux/rbtree.h>
12 #include "symbol.h"
13 #include "string.h"
14 #include "callchain.h"
15 #include "values.h"
16
17 #include "../perf.h"
18 #include "debug.h"
19 #include "header.h"
20
21 #include <subcmd/parse-options.h>
22 #include "parse-events.h"
23 #include "hist.h"
24 #include "srcline.h"
25
26 struct thread;
27
28 extern regex_t parent_regex;
29 extern const char *sort_order;
30 extern const char *field_order;
31 extern const char default_parent_pattern[];
32 extern const char *parent_pattern;
33 extern const char *default_sort_order;
34 extern regex_t ignore_callees_regex;
35 extern int have_ignore_callees;
36 extern enum sort_mode sort__mode;
37 extern struct sort_entry sort_comm;
38 extern struct sort_entry sort_dso;
39 extern struct sort_entry sort_sym;
40 extern struct sort_entry sort_parent;
41 extern struct sort_entry sort_dso_from;
42 extern struct sort_entry sort_dso_to;
43 extern struct sort_entry sort_sym_from;
44 extern struct sort_entry sort_sym_to;
45 extern struct sort_entry sort_srcline;
46 extern enum sort_type sort__first_dimension;
47 extern const char default_mem_sort_order[];
48
49 struct he_stat {
50         u64                     period;
51         u64                     period_sys;
52         u64                     period_us;
53         u64                     period_guest_sys;
54         u64                     period_guest_us;
55         u64                     weight;
56         u32                     nr_events;
57 };
58
59 struct namespace_id {
60         u64                     dev;
61         u64                     ino;
62 };
63
64 struct hist_entry_diff {
65         bool    computed;
66         union {
67                 /* PERF_HPP__DELTA */
68                 double  period_ratio_delta;
69
70                 /* PERF_HPP__RATIO */
71                 double  period_ratio;
72
73                 /* HISTC_WEIGHTED_DIFF */
74                 s64     wdiff;
75         };
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                     ip;
103         u64                     transaction;
104         s32                     socket;
105         s32                     cpu;
106         u8                      cpumode;
107         u8                      depth;
108
109         /* We are added by hists__add_dummy_entry. */
110         bool                    dummy;
111         bool                    leaf;
112
113         char                    level;
114         u8                      filtered;
115
116         u16                     callchain_size;
117         union {
118                 /*
119                  * Since perf diff only supports the stdio output, TUI
120                  * fields are only accessed from perf report (or perf
121                  * top).  So make it a union to reduce memory usage.
122                  */
123                 struct hist_entry_diff  diff;
124                 struct /* for TUI */ {
125                         u16     row_offset;
126                         u16     nr_rows;
127                         bool    init_have_children;
128                         bool    unfolded;
129                         bool    has_children;
130                         bool    has_no_entry;
131                 };
132         };
133         char                    *srcline;
134         char                    *srcfile;
135         struct symbol           *parent;
136         struct branch_info      *branch_info;
137         struct hists            *hists;
138         struct mem_info         *mem_info;
139         void                    *raw_data;
140         u32                     raw_size;
141         void                    *trace_output;
142         struct perf_hpp_list    *hpp_list;
143         struct hist_entry       *parent_he;
144         struct hist_entry_ops   *ops;
145         union {
146                 /* this is for hierarchical entry structure */
147                 struct {
148                         struct rb_root  hroot_in;
149                         struct rb_root  hroot_out;
150                 };                              /* non-leaf entries */
151                 struct rb_root  sorted_chain;   /* leaf entry has callchains */
152         };
153         struct callchain_root   callchain[0]; /* must be last member */
154 };
155
156 static __pure inline bool hist_entry__has_callchains(struct hist_entry *he)
157 {
158         return he->callchain_size != 0;
159 }
160
161 static inline bool hist_entry__has_pairs(struct hist_entry *he)
162 {
163         return !list_empty(&he->pairs.node);
164 }
165
166 static inline struct hist_entry *hist_entry__next_pair(struct hist_entry *he)
167 {
168         if (hist_entry__has_pairs(he))
169                 return list_entry(he->pairs.node.next, struct hist_entry, pairs.node);
170         return NULL;
171 }
172
173 static inline void hist_entry__add_pair(struct hist_entry *pair,
174                                         struct hist_entry *he)
175 {
176         list_add_tail(&pair->pairs.node, &he->pairs.head);
177 }
178
179 static inline float hist_entry__get_percent_limit(struct hist_entry *he)
180 {
181         u64 period = he->stat.period;
182         u64 total_period = hists__total_period(he->hists);
183
184         if (unlikely(total_period == 0))
185                 return 0;
186
187         if (symbol_conf.cumulate_callchain)
188                 period = he->stat_acc->period;
189
190         return period * 100.0 / total_period;
191 }
192
193 static inline u64 cl_address(u64 address)
194 {
195         /* return the cacheline of the address */
196         return (address & ~(cacheline_size() - 1));
197 }
198
199 static inline u64 cl_offset(u64 address)
200 {
201         /* return the cacheline of the address */
202         return (address & (cacheline_size() - 1));
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_ID,
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
246         /* memory mode specific sort keys */
247         __SORT_MEMORY_MODE,
248         SORT_MEM_DADDR_SYMBOL = __SORT_MEMORY_MODE,
249         SORT_MEM_DADDR_DSO,
250         SORT_MEM_LOCKED,
251         SORT_MEM_TLB,
252         SORT_MEM_LVL,
253         SORT_MEM_SNOOP,
254         SORT_MEM_DCACHELINE,
255         SORT_MEM_IADDR_SYMBOL,
256         SORT_MEM_PHYS_DADDR,
257 };
258
259 /*
260  * configurable sorting bits
261  */
262
263 struct sort_entry {
264         const char *se_header;
265
266         int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
267         int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
268         int64_t (*se_sort)(struct hist_entry *, struct hist_entry *);
269         int     (*se_snprintf)(struct hist_entry *he, char *bf, size_t size,
270                                unsigned int width);
271         int     (*se_filter)(struct hist_entry *he, int type, const void *arg);
272         u8      se_width_idx;
273 };
274
275 extern struct sort_entry sort_thread;
276 extern struct list_head hist_entry__sort_list;
277
278 struct perf_evlist;
279 struct tep_handle;
280 int setup_sorting(struct perf_evlist *evlist);
281 int setup_output_field(void);
282 void reset_output_field(void);
283 void sort__setup_elide(FILE *fp);
284 void perf_hpp__set_elide(int idx, bool elide);
285
286 int report_parse_ignore_callees_opt(const struct option *opt, const char *arg, int unset);
287
288 bool is_strict_order(const char *order);
289
290 int hpp_dimension__add_output(unsigned col);
291 void reset_dimensions(void);
292 int sort_dimension__add(struct perf_hpp_list *list, const char *tok,
293                         struct perf_evlist *evlist,
294                         int level);
295 int output_field_add(struct perf_hpp_list *list, char *tok);
296 int64_t
297 sort__iaddr_cmp(struct hist_entry *left, struct hist_entry *right);
298 int64_t
299 sort__daddr_cmp(struct hist_entry *left, struct hist_entry *right);
300 int64_t
301 sort__dcacheline_cmp(struct hist_entry *left, struct hist_entry *right);
302 char *hist_entry__srcline(struct hist_entry *he);
303 #endif  /* __PERF_SORT_H */