xref: /openbmc/linux/tools/perf/util/sort.h (revision 84d517f3)
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 
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 
48 struct he_stat {
49 	u64			period;
50 	u64			period_sys;
51 	u64			period_us;
52 	u64			period_guest_sys;
53 	u64			period_guest_us;
54 	u64			weight;
55 	u32			nr_events;
56 };
57 
58 struct hist_entry_diff {
59 	bool	computed;
60 
61 	/* PERF_HPP__DELTA */
62 	double	period_ratio_delta;
63 
64 	/* PERF_HPP__RATIO */
65 	double	period_ratio;
66 
67 	/* HISTC_WEIGHTED_DIFF */
68 	s64	wdiff;
69 };
70 
71 /**
72  * struct hist_entry - histogram entry
73  *
74  * @row_offset - offset from the first callchain expanded to appear on screen
75  * @nr_rows - rows expanded in callchain, recalculated on folding/unfolding
76  */
77 struct hist_entry {
78 	struct rb_node		rb_node_in;
79 	struct rb_node		rb_node;
80 	union {
81 		struct list_head node;
82 		struct list_head head;
83 	} pairs;
84 	struct he_stat		stat;
85 	struct map_symbol	ms;
86 	struct thread		*thread;
87 	struct comm		*comm;
88 	u64			ip;
89 	u64			transaction;
90 	s32			cpu;
91 
92 	struct hist_entry_diff	diff;
93 
94 	/* We are added by hists__add_dummy_entry. */
95 	bool			dummy;
96 
97 	/* XXX These two should move to some tree widget lib */
98 	u16			row_offset;
99 	u16			nr_rows;
100 
101 	bool			init_have_children;
102 	char			level;
103 	bool			used;
104 	u8			filtered;
105 	char			*srcline;
106 	struct symbol		*parent;
107 	unsigned long		position;
108 	struct rb_root		sorted_chain;
109 	struct branch_info	*branch_info;
110 	struct hists		*hists;
111 	struct mem_info		*mem_info;
112 	struct callchain_root	callchain[0]; /* must be last member */
113 };
114 
115 static inline bool hist_entry__has_pairs(struct hist_entry *he)
116 {
117 	return !list_empty(&he->pairs.node);
118 }
119 
120 static inline struct hist_entry *hist_entry__next_pair(struct hist_entry *he)
121 {
122 	if (hist_entry__has_pairs(he))
123 		return list_entry(he->pairs.node.next, struct hist_entry, pairs.node);
124 	return NULL;
125 }
126 
127 static inline void hist_entry__add_pair(struct hist_entry *pair,
128 					struct hist_entry *he)
129 {
130 	list_add_tail(&pair->pairs.node, &he->pairs.head);
131 }
132 
133 enum sort_mode {
134 	SORT_MODE__NORMAL,
135 	SORT_MODE__BRANCH,
136 	SORT_MODE__MEMORY,
137 	SORT_MODE__TOP,
138 	SORT_MODE__DIFF,
139 };
140 
141 enum sort_type {
142 	/* common sort keys */
143 	SORT_PID,
144 	SORT_COMM,
145 	SORT_DSO,
146 	SORT_SYM,
147 	SORT_PARENT,
148 	SORT_CPU,
149 	SORT_SRCLINE,
150 	SORT_LOCAL_WEIGHT,
151 	SORT_GLOBAL_WEIGHT,
152 	SORT_TRANSACTION,
153 
154 	/* branch stack specific sort keys */
155 	__SORT_BRANCH_STACK,
156 	SORT_DSO_FROM = __SORT_BRANCH_STACK,
157 	SORT_DSO_TO,
158 	SORT_SYM_FROM,
159 	SORT_SYM_TO,
160 	SORT_MISPREDICT,
161 	SORT_ABORT,
162 	SORT_IN_TX,
163 
164 	/* memory mode specific sort keys */
165 	__SORT_MEMORY_MODE,
166 	SORT_MEM_DADDR_SYMBOL = __SORT_MEMORY_MODE,
167 	SORT_MEM_DADDR_DSO,
168 	SORT_MEM_LOCKED,
169 	SORT_MEM_TLB,
170 	SORT_MEM_LVL,
171 	SORT_MEM_SNOOP,
172 };
173 
174 /*
175  * configurable sorting bits
176  */
177 
178 struct sort_entry {
179 	struct list_head list;
180 
181 	const char *se_header;
182 
183 	int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
184 	int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
185 	int64_t	(*se_sort)(struct hist_entry *, struct hist_entry *);
186 	int	(*se_snprintf)(struct hist_entry *he, char *bf, size_t size,
187 			       unsigned int width);
188 	u8	se_width_idx;
189 	bool	elide;
190 };
191 
192 extern struct sort_entry sort_thread;
193 extern struct list_head hist_entry__sort_list;
194 
195 int setup_sorting(void);
196 int setup_output_field(void);
197 void reset_output_field(void);
198 extern int sort_dimension__add(const char *);
199 void sort__setup_elide(FILE *fp);
200 
201 int report_parse_ignore_callees_opt(const struct option *opt, const char *arg, int unset);
202 
203 #endif	/* __PERF_SORT_H */
204