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