xref: /openbmc/linux/tools/perf/util/sort.h (revision 78700c0a)
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 enum sort_mode sort__mode;
35 extern struct sort_entry sort_comm;
36 extern struct sort_entry sort_dso;
37 extern struct sort_entry sort_sym;
38 extern struct sort_entry sort_parent;
39 extern struct sort_entry sort_dso_from;
40 extern struct sort_entry sort_dso_to;
41 extern struct sort_entry sort_sym_from;
42 extern struct sort_entry sort_sym_to;
43 extern enum sort_type sort__first_dimension;
44 extern const char default_mem_sort_order[];
45 
46 struct 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 
56 struct hist_entry_diff {
57 	bool	computed;
58 	union {
59 		/* PERF_HPP__DELTA */
60 		double	period_ratio_delta;
61 
62 		/* PERF_HPP__RATIO */
63 		double	period_ratio;
64 
65 		/* HISTC_WEIGHTED_DIFF */
66 		s64	wdiff;
67 	};
68 };
69 
70 /**
71  * struct hist_entry - histogram entry
72  *
73  * @row_offset - offset from the first callchain expanded to appear on screen
74  * @nr_rows - rows expanded in callchain, recalculated on folding/unfolding
75  */
76 struct hist_entry {
77 	struct rb_node		rb_node_in;
78 	struct rb_node		rb_node;
79 	union {
80 		struct list_head node;
81 		struct list_head head;
82 	} pairs;
83 	struct he_stat		stat;
84 	struct he_stat		*stat_acc;
85 	struct map_symbol	ms;
86 	struct thread		*thread;
87 	struct comm		*comm;
88 	u64			ip;
89 	u64			transaction;
90 	s32			socket;
91 	s32			cpu;
92 	u8			cpumode;
93 	u8			depth;
94 
95 	/* We are added by hists__add_dummy_entry. */
96 	bool			dummy;
97 	bool			leaf;
98 
99 	char			level;
100 	u8			filtered;
101 	union {
102 		/*
103 		 * Since perf diff only supports the stdio output, TUI
104 		 * fields are only accessed from perf report (or perf
105 		 * top).  So make it an union to reduce memory usage.
106 		 */
107 		struct hist_entry_diff	diff;
108 		struct /* for TUI */ {
109 			u16	row_offset;
110 			u16	nr_rows;
111 			bool	init_have_children;
112 			bool	unfolded;
113 			bool	has_children;
114 			bool	has_no_entry;
115 		};
116 	};
117 	char			*srcline;
118 	char			*srcfile;
119 	struct symbol		*parent;
120 	struct branch_info	*branch_info;
121 	struct hists		*hists;
122 	struct mem_info		*mem_info;
123 	void			*raw_data;
124 	u32			raw_size;
125 	void			*trace_output;
126 	struct perf_hpp_list	*hpp_list;
127 	struct hist_entry	*parent_he;
128 	union {
129 		/* this is for hierarchical entry structure */
130 		struct {
131 			struct rb_root	hroot_in;
132 			struct rb_root  hroot_out;
133 		};				/* non-leaf entries */
134 		struct rb_root	sorted_chain;	/* leaf entry has callchains */
135 	};
136 	struct callchain_root	callchain[0]; /* must be last member */
137 };
138 
139 static inline bool hist_entry__has_pairs(struct hist_entry *he)
140 {
141 	return !list_empty(&he->pairs.node);
142 }
143 
144 static inline struct hist_entry *hist_entry__next_pair(struct hist_entry *he)
145 {
146 	if (hist_entry__has_pairs(he))
147 		return list_entry(he->pairs.node.next, struct hist_entry, pairs.node);
148 	return NULL;
149 }
150 
151 static inline void hist_entry__add_pair(struct hist_entry *pair,
152 					struct hist_entry *he)
153 {
154 	list_add_tail(&pair->pairs.node, &he->pairs.head);
155 }
156 
157 static inline float hist_entry__get_percent_limit(struct hist_entry *he)
158 {
159 	u64 period = he->stat.period;
160 	u64 total_period = hists__total_period(he->hists);
161 
162 	if (unlikely(total_period == 0))
163 		return 0;
164 
165 	if (symbol_conf.cumulate_callchain)
166 		period = he->stat_acc->period;
167 
168 	return period * 100.0 / total_period;
169 }
170 
171 static inline u64 cl_address(u64 address)
172 {
173 	/* return the cacheline of the address */
174 	return (address & ~(cacheline_size - 1));
175 }
176 
177 static inline u64 cl_offset(u64 address)
178 {
179 	/* return the cacheline of the address */
180 	return (address & (cacheline_size - 1));
181 }
182 
183 enum sort_mode {
184 	SORT_MODE__NORMAL,
185 	SORT_MODE__BRANCH,
186 	SORT_MODE__MEMORY,
187 	SORT_MODE__TOP,
188 	SORT_MODE__DIFF,
189 	SORT_MODE__TRACEPOINT,
190 };
191 
192 enum sort_type {
193 	/* common sort keys */
194 	SORT_PID,
195 	SORT_COMM,
196 	SORT_DSO,
197 	SORT_SYM,
198 	SORT_PARENT,
199 	SORT_CPU,
200 	SORT_SOCKET,
201 	SORT_SRCLINE,
202 	SORT_SRCFILE,
203 	SORT_LOCAL_WEIGHT,
204 	SORT_GLOBAL_WEIGHT,
205 	SORT_TRANSACTION,
206 	SORT_TRACE,
207 
208 	/* branch stack specific sort keys */
209 	__SORT_BRANCH_STACK,
210 	SORT_DSO_FROM = __SORT_BRANCH_STACK,
211 	SORT_DSO_TO,
212 	SORT_SYM_FROM,
213 	SORT_SYM_TO,
214 	SORT_MISPREDICT,
215 	SORT_ABORT,
216 	SORT_IN_TX,
217 	SORT_CYCLES,
218 	SORT_SRCLINE_FROM,
219 	SORT_SRCLINE_TO,
220 
221 	/* memory mode specific sort keys */
222 	__SORT_MEMORY_MODE,
223 	SORT_MEM_DADDR_SYMBOL = __SORT_MEMORY_MODE,
224 	SORT_MEM_DADDR_DSO,
225 	SORT_MEM_LOCKED,
226 	SORT_MEM_TLB,
227 	SORT_MEM_LVL,
228 	SORT_MEM_SNOOP,
229 	SORT_MEM_DCACHELINE,
230 	SORT_MEM_IADDR_SYMBOL,
231 };
232 
233 /*
234  * configurable sorting bits
235  */
236 
237 struct sort_entry {
238 	const char *se_header;
239 
240 	int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
241 	int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
242 	int64_t	(*se_sort)(struct hist_entry *, struct hist_entry *);
243 	int	(*se_snprintf)(struct hist_entry *he, char *bf, size_t size,
244 			       unsigned int width);
245 	int	(*se_filter)(struct hist_entry *he, int type, const void *arg);
246 	u8	se_width_idx;
247 };
248 
249 extern struct sort_entry sort_thread;
250 extern struct list_head hist_entry__sort_list;
251 
252 struct perf_evlist;
253 struct pevent;
254 int setup_sorting(struct perf_evlist *evlist);
255 int setup_output_field(void);
256 void reset_output_field(void);
257 void sort__setup_elide(FILE *fp);
258 void perf_hpp__set_elide(int idx, bool elide);
259 
260 int report_parse_ignore_callees_opt(const struct option *opt, const char *arg, int unset);
261 
262 bool is_strict_order(const char *order);
263 
264 int hpp_dimension__add_output(unsigned col);
265 #endif	/* __PERF_SORT_H */
266