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
14struct option;
15struct thread;
16
17extern regex_t parent_regex;
18extern const char *sort_order;
19extern const char *field_order;
20extern const char default_parent_pattern[];
21extern const char *parent_pattern;
22extern const char *default_sort_order;
23extern regex_t ignore_callees_regex;
24extern int have_ignore_callees;
25extern enum sort_mode sort__mode;
26extern struct sort_entry sort_comm;
27extern struct sort_entry sort_dso;
28extern struct sort_entry sort_sym;
29extern struct sort_entry sort_parent;
30extern struct sort_entry sort_dso_from;
31extern struct sort_entry sort_dso_to;
32extern struct sort_entry sort_sym_from;
33extern struct sort_entry sort_sym_to;
34extern struct sort_entry sort_srcline;
35extern enum sort_type sort__first_dimension;
36extern const char default_mem_sort_order[];
37
38struct res_sample {
39 u64 time;
40 int cpu;
41 int tid;
42};
43
44struct 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
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};
75
76struct 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 */
87struct 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
158static __pure inline bool hist_entry__has_callchains(struct hist_entry *he)
159{
160 return he->callchain_size != 0;
161}
162
163static inline bool hist_entry__has_pairs(struct hist_entry *he)
164{
165 return !list_empty(&he->pairs.node);
166}
167
168static 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
175static 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
181static 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
195enum 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
204enum 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
256struct 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
268struct 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
277extern struct sort_entry sort_thread;
278extern struct list_head hist_entry__sort_list;
279
280struct evlist;
281struct tep_handle;
282int setup_sorting(struct evlist *evlist);
283int setup_output_field(void);
284void reset_output_field(void);
285void sort__setup_elide(FILE *fp);
286void perf_hpp__set_elide(int idx, bool elide);
287
288const char *sort_help(const char *prefix);
289
290int report_parse_ignore_callees_opt(const struct option *opt, const char *arg, int unset);
291
292bool is_strict_order(const char *order);
293
294int hpp_dimension__add_output(unsigned col);
295void reset_dimensions(void);
296int sort_dimension__add(struct perf_hpp_list *list, const char *tok,
297 struct evlist *evlist,
298 int level);
299int output_field_add(struct perf_hpp_list *list, char *tok);
300int64_t
301sort__iaddr_cmp(struct hist_entry *left, struct hist_entry *right);
302int64_t
303sort__daddr_cmp(struct hist_entry *left, struct hist_entry *right);
304int64_t
305sort__dcacheline_cmp(struct hist_entry *left, struct hist_entry *right);
306char *hist_entry__srcline(struct hist_entry *he);
307#endif /* __PERF_SORT_H */
1#ifndef __PERF_SORT_H
2#define __PERF_SORT_H
3#include "../builtin.h"
4
5#include "util.h"
6
7#include "color.h"
8#include <linux/list.h>
9#include "cache.h"
10#include <linux/rbtree.h>
11#include "symbol.h"
12#include "string.h"
13#include "callchain.h"
14#include "strlist.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 "thread.h"
25
26extern regex_t parent_regex;
27extern const char *sort_order;
28extern const char *field_order;
29extern const char default_parent_pattern[];
30extern const char *parent_pattern;
31extern const char *default_sort_order;
32extern regex_t ignore_callees_regex;
33extern int have_ignore_callees;
34extern enum sort_mode sort__mode;
35extern struct sort_entry sort_comm;
36extern struct sort_entry sort_dso;
37extern struct sort_entry sort_sym;
38extern struct sort_entry sort_parent;
39extern struct sort_entry sort_dso_from;
40extern struct sort_entry sort_dso_to;
41extern struct sort_entry sort_sym_from;
42extern struct sort_entry sort_sym_to;
43extern struct sort_entry sort_srcline;
44extern enum sort_type sort__first_dimension;
45extern const char default_mem_sort_order[];
46
47struct he_stat {
48 u64 period;
49 u64 period_sys;
50 u64 period_us;
51 u64 period_guest_sys;
52 u64 period_guest_us;
53 u64 weight;
54 u32 nr_events;
55};
56
57struct hist_entry_diff {
58 bool computed;
59 union {
60 /* PERF_HPP__DELTA */
61 double period_ratio_delta;
62
63 /* PERF_HPP__RATIO */
64 double period_ratio;
65
66 /* HISTC_WEIGHTED_DIFF */
67 s64 wdiff;
68 };
69};
70
71struct hist_entry_ops {
72 void *(*new)(size_t size);
73 void (*free)(void *ptr);
74};
75
76/**
77 * struct hist_entry - histogram entry
78 *
79 * @row_offset - offset from the first callchain expanded to appear on screen
80 * @nr_rows - rows expanded in callchain, recalculated on folding/unfolding
81 */
82struct hist_entry {
83 struct rb_node rb_node_in;
84 struct rb_node rb_node;
85 union {
86 struct list_head node;
87 struct list_head head;
88 } pairs;
89 struct he_stat stat;
90 struct he_stat *stat_acc;
91 struct map_symbol ms;
92 struct thread *thread;
93 struct comm *comm;
94 u64 ip;
95 u64 transaction;
96 s32 socket;
97 s32 cpu;
98 u8 cpumode;
99 u8 depth;
100
101 /* We are added by hists__add_dummy_entry. */
102 bool dummy;
103 bool leaf;
104
105 char level;
106 u8 filtered;
107 union {
108 /*
109 * Since perf diff only supports the stdio output, TUI
110 * fields are only accessed from perf report (or perf
111 * top). So make it an union to reduce memory usage.
112 */
113 struct hist_entry_diff diff;
114 struct /* for TUI */ {
115 u16 row_offset;
116 u16 nr_rows;
117 bool init_have_children;
118 bool unfolded;
119 bool has_children;
120 bool has_no_entry;
121 };
122 };
123 char *srcline;
124 char *srcfile;
125 struct symbol *parent;
126 struct branch_info *branch_info;
127 struct hists *hists;
128 struct mem_info *mem_info;
129 void *raw_data;
130 u32 raw_size;
131 void *trace_output;
132 struct perf_hpp_list *hpp_list;
133 struct hist_entry *parent_he;
134 struct hist_entry_ops *ops;
135 union {
136 /* this is for hierarchical entry structure */
137 struct {
138 struct rb_root hroot_in;
139 struct rb_root hroot_out;
140 }; /* non-leaf entries */
141 struct rb_root sorted_chain; /* leaf entry has callchains */
142 };
143 struct callchain_root callchain[0]; /* must be last member */
144};
145
146static inline bool hist_entry__has_pairs(struct hist_entry *he)
147{
148 return !list_empty(&he->pairs.node);
149}
150
151static inline struct hist_entry *hist_entry__next_pair(struct hist_entry *he)
152{
153 if (hist_entry__has_pairs(he))
154 return list_entry(he->pairs.node.next, struct hist_entry, pairs.node);
155 return NULL;
156}
157
158static inline void hist_entry__add_pair(struct hist_entry *pair,
159 struct hist_entry *he)
160{
161 list_add_tail(&pair->pairs.node, &he->pairs.head);
162}
163
164static inline float hist_entry__get_percent_limit(struct hist_entry *he)
165{
166 u64 period = he->stat.period;
167 u64 total_period = hists__total_period(he->hists);
168
169 if (unlikely(total_period == 0))
170 return 0;
171
172 if (symbol_conf.cumulate_callchain)
173 period = he->stat_acc->period;
174
175 return period * 100.0 / total_period;
176}
177
178static inline u64 cl_address(u64 address)
179{
180 /* return the cacheline of the address */
181 return (address & ~(cacheline_size - 1));
182}
183
184static inline u64 cl_offset(u64 address)
185{
186 /* return the cacheline of the address */
187 return (address & (cacheline_size - 1));
188}
189
190enum sort_mode {
191 SORT_MODE__NORMAL,
192 SORT_MODE__BRANCH,
193 SORT_MODE__MEMORY,
194 SORT_MODE__TOP,
195 SORT_MODE__DIFF,
196 SORT_MODE__TRACEPOINT,
197};
198
199enum sort_type {
200 /* common sort keys */
201 SORT_PID,
202 SORT_COMM,
203 SORT_DSO,
204 SORT_SYM,
205 SORT_PARENT,
206 SORT_CPU,
207 SORT_SOCKET,
208 SORT_SRCLINE,
209 SORT_SRCFILE,
210 SORT_LOCAL_WEIGHT,
211 SORT_GLOBAL_WEIGHT,
212 SORT_TRANSACTION,
213 SORT_TRACE,
214
215 /* branch stack specific sort keys */
216 __SORT_BRANCH_STACK,
217 SORT_DSO_FROM = __SORT_BRANCH_STACK,
218 SORT_DSO_TO,
219 SORT_SYM_FROM,
220 SORT_SYM_TO,
221 SORT_MISPREDICT,
222 SORT_ABORT,
223 SORT_IN_TX,
224 SORT_CYCLES,
225 SORT_SRCLINE_FROM,
226 SORT_SRCLINE_TO,
227
228 /* memory mode specific sort keys */
229 __SORT_MEMORY_MODE,
230 SORT_MEM_DADDR_SYMBOL = __SORT_MEMORY_MODE,
231 SORT_MEM_DADDR_DSO,
232 SORT_MEM_LOCKED,
233 SORT_MEM_TLB,
234 SORT_MEM_LVL,
235 SORT_MEM_SNOOP,
236 SORT_MEM_DCACHELINE,
237 SORT_MEM_IADDR_SYMBOL,
238};
239
240/*
241 * configurable sorting bits
242 */
243
244struct sort_entry {
245 const char *se_header;
246
247 int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
248 int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
249 int64_t (*se_sort)(struct hist_entry *, struct hist_entry *);
250 int (*se_snprintf)(struct hist_entry *he, char *bf, size_t size,
251 unsigned int width);
252 int (*se_filter)(struct hist_entry *he, int type, const void *arg);
253 u8 se_width_idx;
254};
255
256extern struct sort_entry sort_thread;
257extern struct list_head hist_entry__sort_list;
258
259struct perf_evlist;
260struct pevent;
261int setup_sorting(struct perf_evlist *evlist);
262int setup_output_field(void);
263void reset_output_field(void);
264void sort__setup_elide(FILE *fp);
265void perf_hpp__set_elide(int idx, bool elide);
266
267int report_parse_ignore_callees_opt(const struct option *opt, const char *arg, int unset);
268
269bool is_strict_order(const char *order);
270
271int hpp_dimension__add_output(unsigned col);
272void reset_dimensions(void);
273int sort_dimension__add(struct perf_hpp_list *list, const char *tok,
274 struct perf_evlist *evlist,
275 int level);
276int output_field_add(struct perf_hpp_list *list, char *tok);
277int64_t
278sort__iaddr_cmp(struct hist_entry *left, struct hist_entry *right);
279int64_t
280sort__daddr_cmp(struct hist_entry *left, struct hist_entry *right);
281int64_t
282sort__dcacheline_cmp(struct hist_entry *left, struct hist_entry *right);
283char *hist_entry__get_srcline(struct hist_entry *he);
284#endif /* __PERF_SORT_H */