xref: /openbmc/linux/tools/perf/util/sort.h (revision cd5d5810)
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 #include "sort.h"
26 
27 extern regex_t parent_regex;
28 extern const char *sort_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 	u64			ip;
88 	s32			cpu;
89 
90 	struct hist_entry_diff	diff;
91 
92 	/* We are added by hists__add_dummy_entry. */
93 	bool			dummy;
94 
95 	/* XXX These two should move to some tree widget lib */
96 	u16			row_offset;
97 	u16			nr_rows;
98 
99 	bool			init_have_children;
100 	char			level;
101 	bool			used;
102 	u8			filtered;
103 	char			*srcline;
104 	struct symbol		*parent;
105 	unsigned long		position;
106 	struct rb_root		sorted_chain;
107 	struct branch_info	*branch_info;
108 	struct hists		*hists;
109 	struct mem_info		*mem_info;
110 	struct callchain_root	callchain[0]; /* must be last member */
111 };
112 
113 static inline bool hist_entry__has_pairs(struct hist_entry *he)
114 {
115 	return !list_empty(&he->pairs.node);
116 }
117 
118 static inline struct hist_entry *hist_entry__next_pair(struct hist_entry *he)
119 {
120 	if (hist_entry__has_pairs(he))
121 		return list_entry(he->pairs.node.next, struct hist_entry, pairs.node);
122 	return NULL;
123 }
124 
125 static inline void hist_entry__add_pair(struct hist_entry *pair,
126 					struct hist_entry *he)
127 {
128 	list_add_tail(&pair->pairs.node, &he->pairs.head);
129 }
130 
131 enum sort_mode {
132 	SORT_MODE__NORMAL,
133 	SORT_MODE__BRANCH,
134 	SORT_MODE__MEMORY,
135 };
136 
137 enum sort_type {
138 	/* common sort keys */
139 	SORT_PID,
140 	SORT_COMM,
141 	SORT_DSO,
142 	SORT_SYM,
143 	SORT_PARENT,
144 	SORT_CPU,
145 	SORT_SRCLINE,
146 	SORT_LOCAL_WEIGHT,
147 	SORT_GLOBAL_WEIGHT,
148 
149 	/* branch stack specific sort keys */
150 	__SORT_BRANCH_STACK,
151 	SORT_DSO_FROM = __SORT_BRANCH_STACK,
152 	SORT_DSO_TO,
153 	SORT_SYM_FROM,
154 	SORT_SYM_TO,
155 	SORT_MISPREDICT,
156 
157 	/* memory mode specific sort keys */
158 	__SORT_MEMORY_MODE,
159 	SORT_MEM_DADDR_SYMBOL = __SORT_MEMORY_MODE,
160 	SORT_MEM_DADDR_DSO,
161 	SORT_MEM_LOCKED,
162 	SORT_MEM_TLB,
163 	SORT_MEM_LVL,
164 	SORT_MEM_SNOOP,
165 };
166 
167 /*
168  * configurable sorting bits
169  */
170 
171 struct sort_entry {
172 	struct list_head list;
173 
174 	const char *se_header;
175 
176 	int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
177 	int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
178 	int	(*se_snprintf)(struct hist_entry *self, char *bf, size_t size,
179 			       unsigned int width);
180 	u8	se_width_idx;
181 	bool	elide;
182 };
183 
184 extern struct sort_entry sort_thread;
185 extern struct list_head hist_entry__sort_list;
186 
187 int setup_sorting(void);
188 extern int sort_dimension__add(const char *);
189 void sort__setup_elide(FILE *fp);
190 
191 int report_parse_ignore_callees_opt(const struct option *opt, const char *arg, int unset);
192 
193 #endif	/* __PERF_SORT_H */
194