xref: /linux/tools/perf/util/sort.h (revision c4ee0af3fa0dc65f690fc908f02b8355f9576ea0)
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 default_parent_pattern[];
29 extern const char *parent_pattern;
30 extern const char default_sort_order[];
31 extern regex_t ignore_callees_regex;
32 extern int have_ignore_callees;
33 extern int sort__need_collapse;
34 extern int sort__has_parent;
35 extern int sort__has_sym;
36 extern enum sort_mode sort__mode;
37 extern struct sort_entry sort_comm;
38 extern struct sort_entry sort_dso;
39 extern struct sort_entry sort_sym;
40 extern struct sort_entry sort_parent;
41 extern struct sort_entry sort_dso_from;
42 extern struct sort_entry sort_dso_to;
43 extern struct sort_entry sort_sym_from;
44 extern struct sort_entry sort_sym_to;
45 extern enum sort_type sort__first_dimension;
46 
47 struct he_stat {
48 	u64			period;
49 	u64			period_sys;
50 	u64			period_us;
51 	u64			period_guest_sys;
52 	u64			period_guest_us;
53 	u64			weight;
54 	u32			nr_events;
55 };
56 
57 struct hist_entry_diff {
58 	bool	computed;
59 
60 	/* PERF_HPP__DELTA */
61 	double	period_ratio_delta;
62 
63 	/* PERF_HPP__RATIO */
64 	double	period_ratio;
65 
66 	/* HISTC_WEIGHTED_DIFF */
67 	s64	wdiff;
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 map_symbol	ms;
85 	struct thread		*thread;
86 	struct comm		*comm;
87 	u64			ip;
88 	u64			transaction;
89 	s32			cpu;
90 
91 	struct hist_entry_diff	diff;
92 
93 	/* We are added by hists__add_dummy_entry. */
94 	bool			dummy;
95 
96 	/* XXX These two should move to some tree widget lib */
97 	u16			row_offset;
98 	u16			nr_rows;
99 
100 	bool			init_have_children;
101 	char			level;
102 	bool			used;
103 	u8			filtered;
104 	char			*srcline;
105 	struct symbol		*parent;
106 	unsigned long		position;
107 	struct rb_root		sorted_chain;
108 	struct branch_info	*branch_info;
109 	struct hists		*hists;
110 	struct mem_info		*mem_info;
111 	struct callchain_root	callchain[0]; /* must be last member */
112 };
113 
114 static inline bool hist_entry__has_pairs(struct hist_entry *he)
115 {
116 	return !list_empty(&he->pairs.node);
117 }
118 
119 static inline struct hist_entry *hist_entry__next_pair(struct hist_entry *he)
120 {
121 	if (hist_entry__has_pairs(he))
122 		return list_entry(he->pairs.node.next, struct hist_entry, pairs.node);
123 	return NULL;
124 }
125 
126 static inline void hist_entry__add_pair(struct hist_entry *pair,
127 					struct hist_entry *he)
128 {
129 	list_add_tail(&pair->pairs.node, &he->pairs.head);
130 }
131 
132 enum sort_mode {
133 	SORT_MODE__NORMAL,
134 	SORT_MODE__BRANCH,
135 	SORT_MODE__MEMORY,
136 };
137 
138 enum sort_type {
139 	/* common sort keys */
140 	SORT_PID,
141 	SORT_COMM,
142 	SORT_DSO,
143 	SORT_SYM,
144 	SORT_PARENT,
145 	SORT_CPU,
146 	SORT_SRCLINE,
147 	SORT_LOCAL_WEIGHT,
148 	SORT_GLOBAL_WEIGHT,
149 	SORT_TRANSACTION,
150 
151 	/* branch stack specific sort keys */
152 	__SORT_BRANCH_STACK,
153 	SORT_DSO_FROM = __SORT_BRANCH_STACK,
154 	SORT_DSO_TO,
155 	SORT_SYM_FROM,
156 	SORT_SYM_TO,
157 	SORT_MISPREDICT,
158 	SORT_ABORT,
159 	SORT_IN_TX,
160 
161 	/* memory mode specific sort keys */
162 	__SORT_MEMORY_MODE,
163 	SORT_MEM_DADDR_SYMBOL = __SORT_MEMORY_MODE,
164 	SORT_MEM_DADDR_DSO,
165 	SORT_MEM_LOCKED,
166 	SORT_MEM_TLB,
167 	SORT_MEM_LVL,
168 	SORT_MEM_SNOOP,
169 };
170 
171 /*
172  * configurable sorting bits
173  */
174 
175 struct sort_entry {
176 	struct list_head list;
177 
178 	const char *se_header;
179 
180 	int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
181 	int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
182 	int	(*se_snprintf)(struct hist_entry *he, char *bf, size_t size,
183 			       unsigned int width);
184 	u8	se_width_idx;
185 	bool	elide;
186 };
187 
188 extern struct sort_entry sort_thread;
189 extern struct list_head hist_entry__sort_list;
190 
191 int setup_sorting(void);
192 extern int sort_dimension__add(const char *);
193 void sort__setup_elide(FILE *fp);
194 
195 int report_parse_ignore_callees_opt(const struct option *opt, const char *arg, int unset);
196 
197 #endif	/* __PERF_SORT_H */
198