xref: /openbmc/linux/tools/perf/util/sort.h (revision 110e6f26)
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 
26 extern regex_t parent_regex;
27 extern const char *sort_order;
28 extern const char *field_order;
29 extern const char default_parent_pattern[];
30 extern const char *parent_pattern;
31 extern const char default_sort_order[];
32 extern regex_t ignore_callees_regex;
33 extern int have_ignore_callees;
34 extern int sort__need_collapse;
35 extern int sort__has_dso;
36 extern int sort__has_parent;
37 extern int sort__has_sym;
38 extern int sort__has_socket;
39 extern int sort__has_thread;
40 extern int sort__has_comm;
41 extern enum sort_mode sort__mode;
42 extern struct sort_entry sort_comm;
43 extern struct sort_entry sort_dso;
44 extern struct sort_entry sort_sym;
45 extern struct sort_entry sort_parent;
46 extern struct sort_entry sort_dso_from;
47 extern struct sort_entry sort_dso_to;
48 extern struct sort_entry sort_sym_from;
49 extern struct sort_entry sort_sym_to;
50 extern enum sort_type sort__first_dimension;
51 extern const char default_mem_sort_order[];
52 
53 struct he_stat {
54 	u64			period;
55 	u64			period_sys;
56 	u64			period_us;
57 	u64			period_guest_sys;
58 	u64			period_guest_us;
59 	u64			weight;
60 	u32			nr_events;
61 };
62 
63 struct hist_entry_diff {
64 	bool	computed;
65 	union {
66 		/* PERF_HPP__DELTA */
67 		double	period_ratio_delta;
68 
69 		/* PERF_HPP__RATIO */
70 		double	period_ratio;
71 
72 		/* HISTC_WEIGHTED_DIFF */
73 		s64	wdiff;
74 	};
75 };
76 
77 /**
78  * struct hist_entry - histogram entry
79  *
80  * @row_offset - offset from the first callchain expanded to appear on screen
81  * @nr_rows - rows expanded in callchain, recalculated on folding/unfolding
82  */
83 struct hist_entry {
84 	struct rb_node		rb_node_in;
85 	struct rb_node		rb_node;
86 	union {
87 		struct list_head node;
88 		struct list_head head;
89 	} pairs;
90 	struct he_stat		stat;
91 	struct he_stat		*stat_acc;
92 	struct map_symbol	ms;
93 	struct thread		*thread;
94 	struct comm		*comm;
95 	u64			ip;
96 	u64			transaction;
97 	s32			socket;
98 	s32			cpu;
99 	u8			cpumode;
100 	u8			depth;
101 
102 	/* We are added by hists__add_dummy_entry. */
103 	bool			dummy;
104 	bool			leaf;
105 
106 	char			level;
107 	u8			filtered;
108 	union {
109 		/*
110 		 * Since perf diff only supports the stdio output, TUI
111 		 * fields are only accessed from perf report (or perf
112 		 * top).  So make it an union to reduce memory usage.
113 		 */
114 		struct hist_entry_diff	diff;
115 		struct /* for TUI */ {
116 			u16	row_offset;
117 			u16	nr_rows;
118 			bool	init_have_children;
119 			bool	unfolded;
120 			bool	has_children;
121 			bool	has_no_entry;
122 		};
123 	};
124 	char			*srcline;
125 	char			*srcfile;
126 	struct symbol		*parent;
127 	struct branch_info	*branch_info;
128 	struct hists		*hists;
129 	struct mem_info		*mem_info;
130 	void			*raw_data;
131 	u32			raw_size;
132 	void			*trace_output;
133 	struct perf_hpp_list	*hpp_list;
134 	struct hist_entry	*parent_he;
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 
146 static inline bool hist_entry__has_pairs(struct hist_entry *he)
147 {
148 	return !list_empty(&he->pairs.node);
149 }
150 
151 static 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 
158 static 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 
164 static 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 
178 static inline u64 cl_address(u64 address)
179 {
180 	/* return the cacheline of the address */
181 	return (address & ~(cacheline_size - 1));
182 }
183 
184 static inline u64 cl_offset(u64 address)
185 {
186 	/* return the cacheline of the address */
187 	return (address & (cacheline_size - 1));
188 }
189 
190 enum 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 
199 enum 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 
226 	/* memory mode specific sort keys */
227 	__SORT_MEMORY_MODE,
228 	SORT_MEM_DADDR_SYMBOL = __SORT_MEMORY_MODE,
229 	SORT_MEM_DADDR_DSO,
230 	SORT_MEM_LOCKED,
231 	SORT_MEM_TLB,
232 	SORT_MEM_LVL,
233 	SORT_MEM_SNOOP,
234 	SORT_MEM_DCACHELINE,
235 	SORT_MEM_IADDR_SYMBOL,
236 };
237 
238 /*
239  * configurable sorting bits
240  */
241 
242 struct sort_entry {
243 	const char *se_header;
244 
245 	int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
246 	int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
247 	int64_t	(*se_sort)(struct hist_entry *, struct hist_entry *);
248 	int	(*se_snprintf)(struct hist_entry *he, char *bf, size_t size,
249 			       unsigned int width);
250 	int	(*se_filter)(struct hist_entry *he, int type, const void *arg);
251 	u8	se_width_idx;
252 };
253 
254 extern struct sort_entry sort_thread;
255 extern struct list_head hist_entry__sort_list;
256 
257 struct perf_evlist;
258 struct pevent;
259 int setup_sorting(struct perf_evlist *evlist);
260 int setup_output_field(void);
261 void reset_output_field(void);
262 void sort__setup_elide(FILE *fp);
263 void perf_hpp__set_elide(int idx, bool elide);
264 
265 int report_parse_ignore_callees_opt(const struct option *opt, const char *arg, int unset);
266 
267 bool is_strict_order(const char *order);
268 
269 int hpp_dimension__add_output(unsigned col);
270 #endif	/* __PERF_SORT_H */
271