1b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */
2dd68ada2SJohn Kacur #ifndef __PERF_SORT_H
3dd68ada2SJohn Kacur #define __PERF_SORT_H
41eae20c1SArnaldo Carvalho de Melo #include <regex.h>
5185bcb92SArnaldo Carvalho de Melo #include <stdbool.h>
6dd68ada2SJohn Kacur #include <linux/list.h>
7dd68ada2SJohn Kacur #include <linux/rbtree.h>
89f4e8ff2SArnaldo Carvalho de Melo #include "map_symbol.h"
99f4e8ff2SArnaldo Carvalho de Melo #include "symbol_conf.h"
10dd68ada2SJohn Kacur #include "callchain.h"
11dd68ada2SJohn Kacur #include "values.h"
1214135663SNamhyung Kim #include "hist.h"
13cebf7d51SJin Yao #include "stat.h"
14cebf7d51SJin Yao #include "spark.h"
15e7ff8920SArnaldo Carvalho de Melo
16185bcb92SArnaldo Carvalho de Melo struct option;
17e7ff8920SArnaldo Carvalho de Melo struct thread;
18dd68ada2SJohn Kacur
19dd68ada2SJohn Kacur extern regex_t parent_regex;
20edb7c60eSArnaldo Carvalho de Melo extern const char *sort_order;
21a7d945bcSNamhyung Kim extern const char *field_order;
22edb7c60eSArnaldo Carvalho de Melo extern const char default_parent_pattern[];
23edb7c60eSArnaldo Carvalho de Melo extern const char *parent_pattern;
24fa1f4565SArnaldo Carvalho de Melo extern const char *default_sort_order;
25b21484f1SGreg Price extern regex_t ignore_callees_regex;
26b21484f1SGreg Price extern int have_ignore_callees;
2755369fc1SNamhyung Kim extern enum sort_mode sort__mode;
28dd68ada2SJohn Kacur extern struct sort_entry sort_comm;
29dd68ada2SJohn Kacur extern struct sort_entry sort_dso;
30dd68ada2SJohn Kacur extern struct sort_entry sort_sym;
31dd68ada2SJohn Kacur extern struct sort_entry sort_parent;
32a68c2c58SStephane Eranian extern struct sort_entry sort_dso_from;
33a68c2c58SStephane Eranian extern struct sort_entry sort_dso_to;
34a68c2c58SStephane Eranian extern struct sort_entry sort_sym_from;
35a68c2c58SStephane Eranian extern struct sort_entry sort_sym_to;
36f666ac0dSJiri Olsa extern struct sort_entry sort_srcline;
37228f14f2SYunlong Song extern const char default_mem_sort_order[];
381470a108SFeng Tang extern bool chk_double_cl;
39dd68ada2SJohn Kacur
404968ac8fSAndi Kleen struct res_sample {
414968ac8fSAndi Kleen u64 time;
424968ac8fSAndi Kleen int cpu;
434968ac8fSAndi Kleen int tid;
444968ac8fSAndi Kleen };
454968ac8fSAndi Kleen
46b24c28f7SNamhyung Kim struct he_stat {
47b24c28f7SNamhyung Kim u64 period;
48b24c28f7SNamhyung Kim u64 period_sys;
49b24c28f7SNamhyung Kim u64 period_us;
50b24c28f7SNamhyung Kim u64 period_guest_sys;
51b24c28f7SNamhyung Kim u64 period_guest_us;
52b24c28f7SNamhyung Kim u32 nr_events;
53b24c28f7SNamhyung Kim };
54b24c28f7SNamhyung Kim
55d890a98cSHari Bathini struct namespace_id {
56d890a98cSHari Bathini u64 dev;
57d890a98cSHari Bathini u64 ino;
58d890a98cSHari Bathini };
59d890a98cSHari Bathini
6096c47f19SJiri Olsa struct hist_entry_diff {
6196c47f19SJiri Olsa bool computed;
62a0b404f4SNamhyung Kim union {
6396c47f19SJiri Olsa /* PERF_HPP__DELTA */
6496c47f19SJiri Olsa double period_ratio_delta;
6596c47f19SJiri Olsa
6696c47f19SJiri Olsa /* PERF_HPP__RATIO */
6796c47f19SJiri Olsa double period_ratio;
6881d5f958SJiri Olsa
6981d5f958SJiri Olsa /* HISTC_WEIGHTED_DIFF */
7081d5f958SJiri Olsa s64 wdiff;
7199150a1fSJin Yao
7299150a1fSJin Yao /* PERF_HPP_DIFF__CYCLES */
7399150a1fSJin Yao s64 cycles;
7496c47f19SJiri Olsa };
75cebf7d51SJin Yao struct stats stats;
76cebf7d51SJin Yao unsigned long svals[NUM_SPARKS];
77a0b404f4SNamhyung Kim };
7896c47f19SJiri Olsa
79f542e767SJiri Olsa struct hist_entry_ops {
80f542e767SJiri Olsa void *(*new)(size_t size);
81f542e767SJiri Olsa void (*free)(void *ptr);
82f542e767SJiri Olsa };
83f542e767SJiri Olsa
840f0cbf7aSArnaldo Carvalho de Melo /**
850f0cbf7aSArnaldo Carvalho de Melo * struct hist_entry - histogram entry
860f0cbf7aSArnaldo Carvalho de Melo *
870f0cbf7aSArnaldo Carvalho de Melo * @row_offset - offset from the first callchain expanded to appear on screen
880f0cbf7aSArnaldo Carvalho de Melo * @nr_rows - rows expanded in callchain, recalculated on folding/unfolding
890f0cbf7aSArnaldo Carvalho de Melo */
90dd68ada2SJohn Kacur struct hist_entry {
911980c2ebSArnaldo Carvalho de Melo struct rb_node rb_node_in;
92dd68ada2SJohn Kacur struct rb_node rb_node;
93b821c732SArnaldo Carvalho de Melo union {
94b821c732SArnaldo Carvalho de Melo struct list_head node;
95b821c732SArnaldo Carvalho de Melo struct list_head head;
96b821c732SArnaldo Carvalho de Melo } pairs;
97b24c28f7SNamhyung Kim struct he_stat stat;
98f8be1c8cSNamhyung Kim struct he_stat *stat_acc;
9959fd5306SArnaldo Carvalho de Melo struct map_symbol ms;
100a5e29acaSArnaldo Carvalho de Melo struct thread *thread;
1014dfced35SNamhyung Kim struct comm *comm;
102d890a98cSHari Bathini struct namespace_id cgroup_id;
103b629f3e9SNamhyung Kim u64 cgroup;
104dd68ada2SJohn Kacur u64 ip;
105475eeab9SAndi Kleen u64 transaction;
1060c4c4debSKan Liang s32 socket;
107f60f3593SArun Sharma s32 cpu;
1089fd74f20SStephane Eranian u64 code_page_size;
109784e8addSNamhyung Kim u64 weight;
1104d03c753SNamhyung Kim u64 ins_lat;
111db4b2840SNamhyung Kim u64 p_stage_cyc;
1127365be55SDon Zickus u8 cpumode;
113aef810ecSNamhyung Kim u8 depth;
114*ea15483eSGerman Gomez struct simd_flags simd_flags;
1150f0cbf7aSArnaldo Carvalho de Melo
116e0af43d2SJiri Olsa /* We are added by hists__add_dummy_entry. */
117e0af43d2SJiri Olsa bool dummy;
118aef810ecSNamhyung Kim bool leaf;
119e0af43d2SJiri Olsa
120dd68ada2SJohn Kacur char level;
121a5e29acaSArnaldo Carvalho de Melo u8 filtered;
12241477acfSArnaldo Carvalho de Melo
12341477acfSArnaldo Carvalho de Melo u16 callchain_size;
12429750821SNamhyung Kim union {
12529750821SNamhyung Kim /*
12629750821SNamhyung Kim * Since perf diff only supports the stdio output, TUI
12729750821SNamhyung Kim * fields are only accessed from perf report (or perf
12803440c4eSMasahiro Yamada * top). So make it a union to reduce memory usage.
12929750821SNamhyung Kim */
13029750821SNamhyung Kim struct hist_entry_diff diff;
13129750821SNamhyung Kim struct /* for TUI */ {
13229750821SNamhyung Kim u16 row_offset;
13329750821SNamhyung Kim u16 nr_rows;
134d8a0f800SNamhyung Kim bool init_have_children;
1353698dab1SNamhyung Kim bool unfolded;
1363698dab1SNamhyung Kim bool has_children;
13779dded87SNamhyung Kim bool has_no_entry;
13829750821SNamhyung Kim };
13929750821SNamhyung Kim };
140409a8be6SArnaldo Carvalho de Melo char *srcline;
14131191a85SAndi Kleen char *srcfile;
142439d473bSArnaldo Carvalho de Melo struct symbol *parent;
143b5387528SRoberto Agostino Vitillo struct branch_info *branch_info;
1443723908dSAndi Kleen long time;
145ae359f19SJiri Olsa struct hists *hists;
14698a3b32cSStephane Eranian struct mem_info *mem_info;
147fe96245cSJin Yao struct block_info *block_info;
148ebf39d29SLeo Yan struct kvm_info *kvm_info;
14972392834SNamhyung Kim void *raw_data;
15072392834SNamhyung Kim u32 raw_size;
1514968ac8fSAndi Kleen int num_res;
1524968ac8fSAndi Kleen struct res_sample *res_samples;
15360517d28SNamhyung Kim void *trace_output;
1541b2dbbf4SNamhyung Kim struct perf_hpp_list *hpp_list;
155aef810ecSNamhyung Kim struct hist_entry *parent_he;
156f542e767SJiri Olsa struct hist_entry_ops *ops;
157aef810ecSNamhyung Kim union {
158aef810ecSNamhyung Kim /* this is for hierarchical entry structure */
159aef810ecSNamhyung Kim struct {
1602eb3d689SDavidlohr Bueso struct rb_root_cached hroot_in;
1612eb3d689SDavidlohr Bueso struct rb_root_cached hroot_out;
162aef810ecSNamhyung Kim }; /* non-leaf entries */
163aef810ecSNamhyung Kim struct rb_root sorted_chain; /* leaf entry has callchains */
164aef810ecSNamhyung Kim };
16598a3b32cSStephane Eranian struct callchain_root callchain[0]; /* must be last member */
16686a9eee0SArnaldo Carvalho de Melo };
167dd68ada2SJohn Kacur
hist_entry__has_callchains(struct hist_entry * he)1680b5d6eceSArnaldo Carvalho de Melo static __pure inline bool hist_entry__has_callchains(struct hist_entry *he)
1690b5d6eceSArnaldo Carvalho de Melo {
170e5654455SArnaldo Carvalho de Melo return he->callchain_size != 0;
1710b5d6eceSArnaldo Carvalho de Melo }
1720b5d6eceSArnaldo Carvalho de Melo
173bdc633feSArnaldo Carvalho de Melo int hist_entry__sym_snprintf(struct hist_entry *he, char *bf, size_t size, unsigned int width);
174bdc633feSArnaldo Carvalho de Melo
hist_entry__has_pairs(struct hist_entry * he)175b821c732SArnaldo Carvalho de Melo static inline bool hist_entry__has_pairs(struct hist_entry *he)
176b821c732SArnaldo Carvalho de Melo {
177b821c732SArnaldo Carvalho de Melo return !list_empty(&he->pairs.node);
178b821c732SArnaldo Carvalho de Melo }
179b821c732SArnaldo Carvalho de Melo
hist_entry__next_pair(struct hist_entry * he)180b821c732SArnaldo Carvalho de Melo static inline struct hist_entry *hist_entry__next_pair(struct hist_entry *he)
181b821c732SArnaldo Carvalho de Melo {
182b821c732SArnaldo Carvalho de Melo if (hist_entry__has_pairs(he))
183b821c732SArnaldo Carvalho de Melo return list_entry(he->pairs.node.next, struct hist_entry, pairs.node);
184b821c732SArnaldo Carvalho de Melo return NULL;
185b821c732SArnaldo Carvalho de Melo }
186b821c732SArnaldo Carvalho de Melo
hist_entry__add_pair(struct hist_entry * pair,struct hist_entry * he)1874d23322aSJiri Olsa static inline void hist_entry__add_pair(struct hist_entry *pair,
1884d23322aSJiri Olsa struct hist_entry *he)
189b821c732SArnaldo Carvalho de Melo {
1904d23322aSJiri Olsa list_add_tail(&pair->pairs.node, &he->pairs.head);
191b821c732SArnaldo Carvalho de Melo }
192b821c732SArnaldo Carvalho de Melo
hist_entry__get_percent_limit(struct hist_entry * he)19314135663SNamhyung Kim static inline float hist_entry__get_percent_limit(struct hist_entry *he)
19414135663SNamhyung Kim {
19514135663SNamhyung Kim u64 period = he->stat.period;
19614135663SNamhyung Kim u64 total_period = hists__total_period(he->hists);
19714135663SNamhyung Kim
19814135663SNamhyung Kim if (unlikely(total_period == 0))
19914135663SNamhyung Kim return 0;
20014135663SNamhyung Kim
20114135663SNamhyung Kim if (symbol_conf.cumulate_callchain)
20214135663SNamhyung Kim period = he->stat_acc->period;
20314135663SNamhyung Kim
20414135663SNamhyung Kim return period * 100.0 / total_period;
20514135663SNamhyung Kim }
20614135663SNamhyung Kim
20755369fc1SNamhyung Kim enum sort_mode {
20855369fc1SNamhyung Kim SORT_MODE__NORMAL,
20955369fc1SNamhyung Kim SORT_MODE__BRANCH,
21055369fc1SNamhyung Kim SORT_MODE__MEMORY,
211512ae1bdSNamhyung Kim SORT_MODE__TOP,
212512ae1bdSNamhyung Kim SORT_MODE__DIFF,
213d49dadeaSNamhyung Kim SORT_MODE__TRACEPOINT,
21455369fc1SNamhyung Kim };
21555369fc1SNamhyung Kim
216a4fb581bSFrederic Weisbecker enum sort_type {
217fc5871edSNamhyung Kim /* common sort keys */
218a4fb581bSFrederic Weisbecker SORT_PID,
219a4fb581bSFrederic Weisbecker SORT_COMM,
220a4fb581bSFrederic Weisbecker SORT_DSO,
221a4fb581bSFrederic Weisbecker SORT_SYM,
222f60f3593SArun Sharma SORT_PARENT,
223f60f3593SArun Sharma SORT_CPU,
2242e7ea3abSKan Liang SORT_SOCKET,
225fc5871edSNamhyung Kim SORT_SRCLINE,
22631191a85SAndi Kleen SORT_SRCFILE,
227f9ea55d0SAndi Kleen SORT_LOCAL_WEIGHT,
228f9ea55d0SAndi Kleen SORT_GLOBAL_WEIGHT,
229475eeab9SAndi Kleen SORT_TRANSACTION,
230a34bb6a0SNamhyung Kim SORT_TRACE,
2317768f8daSCharles Baylis SORT_SYM_SIZE,
232b74d12d5SKim Phillips SORT_DSO_SIZE,
233b629f3e9SNamhyung Kim SORT_CGROUP,
234d890a98cSHari Bathini SORT_CGROUP_ID,
235ec6ae74fSJin Yao SORT_SYM_IPC_NULL,
2363723908dSAndi Kleen SORT_TIME,
2379fd74f20SStephane Eranian SORT_CODE_PAGE_SIZE,
238590db42dSKan Liang SORT_LOCAL_INS_LAT,
239590db42dSKan Liang SORT_GLOBAL_INS_LAT,
240e3304c21SAthira Rajeev SORT_LOCAL_PIPELINE_STAGE_CYC,
241e3304c21SAthira Rajeev SORT_GLOBAL_PIPELINE_STAGE_CYC,
242762461f1SNamhyung Kim SORT_ADDR,
243d7d213e0SKan Liang SORT_LOCAL_RETIRE_LAT,
244d7d213e0SKan Liang SORT_GLOBAL_RETIRE_LAT,
245*ea15483eSGerman Gomez SORT_SIMD,
246fc5871edSNamhyung Kim
247fc5871edSNamhyung Kim /* branch stack specific sort keys */
248fc5871edSNamhyung Kim __SORT_BRANCH_STACK,
249fc5871edSNamhyung Kim SORT_DSO_FROM = __SORT_BRANCH_STACK,
250b5387528SRoberto Agostino Vitillo SORT_DSO_TO,
251b5387528SRoberto Agostino Vitillo SORT_SYM_FROM,
252b5387528SRoberto Agostino Vitillo SORT_SYM_TO,
253b5387528SRoberto Agostino Vitillo SORT_MISPREDICT,
254f5d05bceSAndi Kleen SORT_ABORT,
255f5d05bceSAndi Kleen SORT_IN_TX,
2560e332f03SAndi Kleen SORT_CYCLES,
257508be0dfSAndi Kleen SORT_SRCLINE_FROM,
258508be0dfSAndi Kleen SORT_SRCLINE_TO,
259ec6ae74fSJin Yao SORT_SYM_IPC,
26005274770SStephane Eranian SORT_ADDR_FROM,
26105274770SStephane Eranian SORT_ADDR_TO,
262afab87b9SNamhyung Kim
263afab87b9SNamhyung Kim /* memory mode specific sort keys */
264afab87b9SNamhyung Kim __SORT_MEMORY_MODE,
265f9ea55d0SAndi Kleen SORT_MEM_DADDR_SYMBOL = __SORT_MEMORY_MODE,
266afab87b9SNamhyung Kim SORT_MEM_DADDR_DSO,
267afab87b9SNamhyung Kim SORT_MEM_LOCKED,
268afab87b9SNamhyung Kim SORT_MEM_TLB,
269afab87b9SNamhyung Kim SORT_MEM_LVL,
270afab87b9SNamhyung Kim SORT_MEM_SNOOP,
2719b32ba71SDon Zickus SORT_MEM_DCACHELINE,
27228e6db20SDon Zickus SORT_MEM_IADDR_SYMBOL,
2738780fb25SKan Liang SORT_MEM_PHYS_DADDR,
274a50d03e3SKan Liang SORT_MEM_DATA_PAGE_SIZE,
275a054c298SKan Liang SORT_MEM_BLOCKED,
276a4fb581bSFrederic Weisbecker };
277a4fb581bSFrederic Weisbecker
278dd68ada2SJohn Kacur /*
279dd68ada2SJohn Kacur * configurable sorting bits
280dd68ada2SJohn Kacur */
281dd68ada2SJohn Kacur
282dd68ada2SJohn Kacur struct sort_entry {
283fcd14984SFrederic Weisbecker const char *se_header;
284dd68ada2SJohn Kacur
285fcd14984SFrederic Weisbecker int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
286fcd14984SFrederic Weisbecker int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
287202e7a6dSNamhyung Kim int64_t (*se_sort)(struct hist_entry *, struct hist_entry *);
288316c7136SArnaldo Carvalho de Melo int (*se_snprintf)(struct hist_entry *he, char *bf, size_t size,
289a4e3b956SArnaldo Carvalho de Melo unsigned int width);
29054430101SNamhyung Kim int (*se_filter)(struct hist_entry *he, int type, const void *arg);
291cb6e92c7SNamhyung Kim void (*se_init)(struct hist_entry *he);
2928a6c5b26SArnaldo Carvalho de Melo u8 se_width_idx;
293dd68ada2SJohn Kacur };
294dd68ada2SJohn Kacur
29599150a1fSJin Yao struct block_hist {
29699150a1fSJin Yao struct hists block_hists;
29799150a1fSJin Yao struct perf_hpp_list block_list;
29899150a1fSJin Yao struct perf_hpp_fmt block_fmt;
29999150a1fSJin Yao int block_idx;
30099150a1fSJin Yao bool valid;
30199150a1fSJin Yao struct hist_entry he;
30299150a1fSJin Yao };
30399150a1fSJin Yao
304dd68ada2SJohn Kacur extern struct sort_entry sort_thread;
305dd68ada2SJohn Kacur
30663503dbaSJiri Olsa struct evlist;
307096177a8STzvetomir Stoyanov (VMware) struct tep_handle;
30863503dbaSJiri Olsa int setup_sorting(struct evlist *evlist);
309a7d945bcSNamhyung Kim int setup_output_field(void);
3101c89fe9bSNamhyung Kim void reset_output_field(void);
31108e71542SNamhyung Kim void sort__setup_elide(FILE *fp);
312f2998422SJiri Olsa void perf_hpp__set_elide(int idx, bool elide);
313dd68ada2SJohn Kacur
314a37338aaSRiccardo Mancini char *sort_help(const char *prefix);
315702fb9b4SAndi Kleen
316b21484f1SGreg Price int report_parse_ignore_callees_opt(const struct option *opt, const char *arg, int unset);
317b21484f1SGreg Price
3182f3f9bcfSJiri Olsa bool is_strict_order(const char *order);
319beeaaeb3SJiri Olsa
320beeaaeb3SJiri Olsa int hpp_dimension__add_output(unsigned col);
321bcf98740SJiri Olsa void reset_dimensions(void);
322a76490e4SJiri Olsa int sort_dimension__add(struct perf_hpp_list *list, const char *tok,
32363503dbaSJiri Olsa struct evlist *evlist,
324a76490e4SJiri Olsa int level);
325a76490e4SJiri Olsa int output_field_add(struct perf_hpp_list *list, char *tok);
3265fe7b9b4SJiri Olsa int64_t
3275fe7b9b4SJiri Olsa sort__iaddr_cmp(struct hist_entry *left, struct hist_entry *right);
3285fe7b9b4SJiri Olsa int64_t
3295fe7b9b4SJiri Olsa sort__daddr_cmp(struct hist_entry *left, struct hist_entry *right);
3305fe7b9b4SJiri Olsa int64_t
3315fe7b9b4SJiri Olsa sort__dcacheline_cmp(struct hist_entry *left, struct hist_entry *right);
33212e89e65SKan Liang int64_t
33312e89e65SKan Liang _sort__sym_cmp(struct symbol *sym_l, struct symbol *sym_r);
3346a53da05SArnaldo Carvalho de Melo char *hist_entry__srcline(struct hist_entry *he);
335dd68ada2SJohn Kacur #endif /* __PERF_SORT_H */
336