xref: /openbmc/linux/tools/perf/util/sort.h (revision bf5bbed1)
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__DISPL */
59 	int	displacement;
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 	/* XXX These two should move to some tree widget lib */
93 	u16			row_offset;
94 	u16			nr_rows;
95 
96 	bool			init_have_children;
97 	char			level;
98 	bool			used;
99 	u8			filtered;
100 	char			*srcline;
101 	struct symbol		*parent;
102 	unsigned long		position;
103 	struct rb_root		sorted_chain;
104 	struct branch_info	*branch_info;
105 	struct hists		*hists;
106 	struct callchain_root	callchain[0];
107 };
108 
109 static inline bool hist_entry__has_pairs(struct hist_entry *he)
110 {
111 	return !list_empty(&he->pairs.node);
112 }
113 
114 static inline struct hist_entry *hist_entry__next_pair(struct hist_entry *he)
115 {
116 	if (hist_entry__has_pairs(he))
117 		return list_entry(he->pairs.node.next, struct hist_entry, pairs.node);
118 	return NULL;
119 }
120 
121 static inline void hist__entry_add_pair(struct hist_entry *he,
122 					struct hist_entry *pair)
123 {
124 	list_add_tail(&he->pairs.head, &pair->pairs.node);
125 }
126 
127 enum sort_type {
128 	SORT_PID,
129 	SORT_COMM,
130 	SORT_DSO,
131 	SORT_SYM,
132 	SORT_PARENT,
133 	SORT_CPU,
134 	SORT_DSO_FROM,
135 	SORT_DSO_TO,
136 	SORT_SYM_FROM,
137 	SORT_SYM_TO,
138 	SORT_MISPREDICT,
139 	SORT_SRCLINE,
140 };
141 
142 /*
143  * configurable sorting bits
144  */
145 
146 struct sort_entry {
147 	struct list_head list;
148 
149 	const char *se_header;
150 
151 	int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
152 	int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
153 	int	(*se_snprintf)(struct hist_entry *self, char *bf, size_t size,
154 			       unsigned int width);
155 	u8	se_width_idx;
156 	bool	elide;
157 };
158 
159 extern struct sort_entry sort_thread;
160 extern struct list_head hist_entry__sort_list;
161 
162 void setup_sorting(const char * const usagestr[], const struct option *opts);
163 extern int sort_dimension__add(const char *);
164 void sort_entry__setup_elide(struct sort_entry *self, struct strlist *list,
165 			     const char *list_name, FILE *fp);
166 
167 #endif	/* __PERF_SORT_H */
168