xref: /linux/tools/perf/util/sort.h (revision e47a324d6f07c9ef252cfce1f14cfa5110cbed99)
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 "hist.h"
7 
8 struct option;
9 
10 extern regex_t parent_regex;
11 extern const char *sort_order;
12 extern const char *field_order;
13 extern const char default_parent_pattern[];
14 extern const char *parent_pattern;
15 extern const char *default_sort_order;
16 extern regex_t ignore_callees_regex;
17 extern int have_ignore_callees;
18 extern enum sort_mode sort__mode;
19 extern struct sort_entry sort_comm;
20 extern struct sort_entry sort_dso;
21 extern struct sort_entry sort_sym;
22 extern struct sort_entry sort_parent;
23 extern struct sort_entry sort_dso_from;
24 extern struct sort_entry sort_dso_to;
25 extern struct sort_entry sort_sym_from;
26 extern struct sort_entry sort_sym_to;
27 extern struct sort_entry sort_srcline;
28 extern struct sort_entry sort_type;
29 extern const char default_mem_sort_order[];
30 extern bool chk_double_cl;
31 
32 enum sort_mode {
33 	SORT_MODE__NORMAL,
34 	SORT_MODE__BRANCH,
35 	SORT_MODE__MEMORY,
36 	SORT_MODE__TOP,
37 	SORT_MODE__DIFF,
38 	SORT_MODE__TRACEPOINT,
39 };
40 
41 enum sort_type {
42 	/* common sort keys */
43 	SORT_PID,
44 	SORT_COMM,
45 	SORT_DSO,
46 	SORT_SYM,
47 	SORT_PARENT,
48 	SORT_CPU,
49 	SORT_SOCKET,
50 	SORT_SRCLINE,
51 	SORT_SRCFILE,
52 	SORT_LOCAL_WEIGHT,
53 	SORT_GLOBAL_WEIGHT,
54 	SORT_TRANSACTION,
55 	SORT_TRACE,
56 	SORT_SYM_SIZE,
57 	SORT_DSO_SIZE,
58 	SORT_CGROUP,
59 	SORT_CGROUP_ID,
60 	SORT_SYM_IPC_NULL,
61 	SORT_TIME,
62 	SORT_CODE_PAGE_SIZE,
63 	SORT_LOCAL_INS_LAT,
64 	SORT_GLOBAL_INS_LAT,
65 	SORT_LOCAL_PIPELINE_STAGE_CYC,
66 	SORT_GLOBAL_PIPELINE_STAGE_CYC,
67 	SORT_ADDR,
68 	SORT_LOCAL_RETIRE_LAT,
69 	SORT_GLOBAL_RETIRE_LAT,
70 	SORT_SIMD,
71 	SORT_ANNOTATE_DATA_TYPE,
72 	SORT_ANNOTATE_DATA_TYPE_OFFSET,
73 	SORT_SYM_OFFSET,
74 	SORT_ANNOTATE_DATA_TYPE_CACHELINE,
75 	SORT_PARALLELISM,
76 	SORT_TGID,
77 
78 	/* branch stack specific sort keys */
79 	__SORT_BRANCH_STACK,
80 	SORT_DSO_FROM = __SORT_BRANCH_STACK,
81 	SORT_DSO_TO,
82 	SORT_SYM_FROM,
83 	SORT_SYM_TO,
84 	SORT_MISPREDICT,
85 	SORT_ABORT,
86 	SORT_IN_TX,
87 	SORT_CYCLES,
88 	SORT_SRCLINE_FROM,
89 	SORT_SRCLINE_TO,
90 	SORT_SYM_IPC,
91 	SORT_ADDR_FROM,
92 	SORT_ADDR_TO,
93 	SORT_CALLCHAIN_BRANCH_PREDICTED,
94 	SORT_CALLCHAIN_BRANCH_ABORT,
95 	SORT_CALLCHAIN_BRANCH_CYCLES,
96 
97 	/* memory mode specific sort keys */
98 	__SORT_MEMORY_MODE,
99 	SORT_MEM_DADDR_SYMBOL = __SORT_MEMORY_MODE,
100 	SORT_MEM_DADDR_DSO,
101 	SORT_MEM_LOCKED,
102 	SORT_MEM_TLB,
103 	SORT_MEM_LVL,
104 	SORT_MEM_SNOOP,
105 	SORT_MEM_DCACHELINE,
106 	SORT_MEM_IADDR_SYMBOL,
107 	SORT_MEM_PHYS_DADDR,
108 	SORT_MEM_DATA_PAGE_SIZE,
109 	SORT_MEM_BLOCKED,
110 };
111 
112 /*
113  * configurable sorting bits
114  */
115 
116 struct sort_entry {
117 	const char *se_header;
118 
119 	int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
120 	int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
121 	int64_t	(*se_sort)(struct hist_entry *, struct hist_entry *);
122 	int	(*se_snprintf)(struct hist_entry *he, char *bf, size_t size,
123 			       unsigned int width);
124 	int	(*se_filter)(struct hist_entry *he, int type, const void *arg);
125 	void	(*se_init)(struct hist_entry *he);
126 	u8	se_width_idx;
127 };
128 
129 extern struct sort_entry sort_thread;
130 
131 struct evlist;
132 struct tep_handle;
133 int setup_sorting(struct evlist *evlist);
134 int setup_output_field(void);
135 void reset_output_field(void);
136 void sort__setup_elide(FILE *fp);
137 void perf_hpp__set_elide(int idx, bool elide);
138 
139 char *sort_help(const char *prefix, enum sort_mode mode);
140 
141 int report_parse_ignore_callees_opt(const struct option *opt, const char *arg, int unset);
142 
143 bool is_strict_order(const char *order);
144 
145 int hpp_dimension__add_output(unsigned col, bool implicit);
146 void reset_dimensions(void);
147 int sort_dimension__add(struct perf_hpp_list *list, const char *tok,
148 			struct evlist *evlist,
149 			int level);
150 int output_field_add(struct perf_hpp_list *list, const char *tok, int *level);
151 int64_t
152 sort__iaddr_cmp(struct hist_entry *left, struct hist_entry *right);
153 int64_t
154 sort__daddr_cmp(struct hist_entry *left, struct hist_entry *right);
155 int64_t
156 sort__dcacheline_cmp(struct hist_entry *left, struct hist_entry *right);
157 int64_t
158 _sort__sym_cmp(struct symbol *sym_l, struct symbol *sym_r);
159 char *hist_entry__srcline(struct hist_entry *he);
160 #endif	/* __PERF_SORT_H */
161