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