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