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