xref: /openbmc/linux/tools/perf/util/sort.h (revision 39b6f3aa)
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 int sort__need_collapse;
33 extern int sort__has_parent;
34 extern int sort__has_sym;
35 extern int sort__branch_mode;
36 extern struct sort_entry sort_comm;
37 extern struct sort_entry sort_dso;
38 extern struct sort_entry sort_sym;
39 extern struct sort_entry sort_parent;
40 extern struct sort_entry sort_dso_from;
41 extern struct sort_entry sort_dso_to;
42 extern struct sort_entry sort_sym_from;
43 extern struct sort_entry sort_sym_to;
44 extern enum sort_type sort__first_dimension;
45 
46 struct he_stat {
47 	u64			period;
48 	u64			period_sys;
49 	u64			period_us;
50 	u64			period_guest_sys;
51 	u64			period_guest_us;
52 	u64			weight;
53 	u32			nr_events;
54 };
55 
56 struct hist_entry_diff {
57 	bool	computed;
58 
59 	/* PERF_HPP__DELTA */
60 	double	period_ratio_delta;
61 
62 	/* PERF_HPP__RATIO */
63 	double	period_ratio;
64 
65 	/* HISTC_WEIGHTED_DIFF */
66 	s64	wdiff;
67 };
68 
69 /**
70  * struct hist_entry - histogram entry
71  *
72  * @row_offset - offset from the first callchain expanded to appear on screen
73  * @nr_rows - rows expanded in callchain, recalculated on folding/unfolding
74  */
75 struct hist_entry {
76 	struct rb_node		rb_node_in;
77 	struct rb_node		rb_node;
78 	union {
79 		struct list_head node;
80 		struct list_head head;
81 	} pairs;
82 	struct he_stat		stat;
83 	struct map_symbol	ms;
84 	struct thread		*thread;
85 	u64			ip;
86 	s32			cpu;
87 
88 	struct hist_entry_diff	diff;
89 
90 	/* XXX These two should move to some tree widget lib */
91 	u16			row_offset;
92 	u16			nr_rows;
93 
94 	bool			init_have_children;
95 	char			level;
96 	bool			used;
97 	u8			filtered;
98 	char			*srcline;
99 	struct symbol		*parent;
100 	unsigned long		position;
101 	struct rb_root		sorted_chain;
102 	struct branch_info	*branch_info;
103 	struct hists		*hists;
104 	struct mem_info		*mem_info;
105 	struct callchain_root	callchain[0]; /* must be last member */
106 };
107 
108 static inline bool hist_entry__has_pairs(struct hist_entry *he)
109 {
110 	return !list_empty(&he->pairs.node);
111 }
112 
113 static inline struct hist_entry *hist_entry__next_pair(struct hist_entry *he)
114 {
115 	if (hist_entry__has_pairs(he))
116 		return list_entry(he->pairs.node.next, struct hist_entry, pairs.node);
117 	return NULL;
118 }
119 
120 static inline void hist_entry__add_pair(struct hist_entry *he,
121 					struct hist_entry *pair)
122 {
123 	list_add_tail(&he->pairs.head, &pair->pairs.node);
124 }
125 
126 enum sort_type {
127 	/* common sort keys */
128 	SORT_PID,
129 	SORT_COMM,
130 	SORT_DSO,
131 	SORT_SYM,
132 	SORT_PARENT,
133 	SORT_CPU,
134 	SORT_SRCLINE,
135 	SORT_LOCAL_WEIGHT,
136 	SORT_GLOBAL_WEIGHT,
137 	SORT_MEM_DADDR_SYMBOL,
138 	SORT_MEM_DADDR_DSO,
139 	SORT_MEM_LOCKED,
140 	SORT_MEM_TLB,
141 	SORT_MEM_LVL,
142 	SORT_MEM_SNOOP,
143 
144 	/* branch stack specific sort keys */
145 	__SORT_BRANCH_STACK,
146 	SORT_DSO_FROM = __SORT_BRANCH_STACK,
147 	SORT_DSO_TO,
148 	SORT_SYM_FROM,
149 	SORT_SYM_TO,
150 	SORT_MISPREDICT,
151 };
152 
153 /*
154  * configurable sorting bits
155  */
156 
157 struct sort_entry {
158 	struct list_head list;
159 
160 	const char *se_header;
161 
162 	int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
163 	int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
164 	int	(*se_snprintf)(struct hist_entry *self, char *bf, size_t size,
165 			       unsigned int width);
166 	u8	se_width_idx;
167 	bool	elide;
168 };
169 
170 extern struct sort_entry sort_thread;
171 extern struct list_head hist_entry__sort_list;
172 
173 int setup_sorting(void);
174 extern int sort_dimension__add(const char *);
175 void sort_entry__setup_elide(struct sort_entry *self, struct strlist *list,
176 			     const char *list_name, FILE *fp);
177 
178 #endif	/* __PERF_SORT_H */
179