xref: /linux/tools/perf/util/sort.h (revision f2ee442115c9b6219083c019939a9cc0c9abb2f8)
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 char *field_sep;
35 extern struct sort_entry sort_comm;
36 extern struct sort_entry sort_dso;
37 extern struct sort_entry sort_sym;
38 extern struct sort_entry sort_parent;
39 extern enum sort_type sort__first_dimension;
40 
41 /**
42  * struct hist_entry - histogram entry
43  *
44  * @row_offset - offset from the first callchain expanded to appear on screen
45  * @nr_rows - rows expanded in callchain, recalculated on folding/unfolding
46  */
47 struct hist_entry {
48 	struct rb_node		rb_node_in;
49 	struct rb_node		rb_node;
50 	u64			period;
51 	u64			period_sys;
52 	u64			period_us;
53 	u64			period_guest_sys;
54 	u64			period_guest_us;
55 	struct map_symbol	ms;
56 	struct thread		*thread;
57 	u64			ip;
58 	s32			cpu;
59 	u32			nr_events;
60 
61 	/* XXX These two should move to some tree widget lib */
62 	u16			row_offset;
63 	u16			nr_rows;
64 
65 	bool			init_have_children;
66 	char			level;
67 	bool			used;
68 	u8			filtered;
69 	struct symbol		*parent;
70 	union {
71 		unsigned long	  position;
72 		struct hist_entry *pair;
73 		struct rb_root	  sorted_chain;
74 	};
75 	struct callchain_root	callchain[0];
76 };
77 
78 enum sort_type {
79 	SORT_PID,
80 	SORT_COMM,
81 	SORT_DSO,
82 	SORT_SYM,
83 	SORT_PARENT,
84 	SORT_CPU,
85 };
86 
87 /*
88  * configurable sorting bits
89  */
90 
91 struct sort_entry {
92 	struct list_head list;
93 
94 	const char *se_header;
95 
96 	int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
97 	int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
98 	int	(*se_snprintf)(struct hist_entry *self, char *bf, size_t size,
99 			       unsigned int width);
100 	u8	se_width_idx;
101 	bool	elide;
102 };
103 
104 extern struct sort_entry sort_thread;
105 extern struct list_head hist_entry__sort_list;
106 
107 void setup_sorting(const char * const usagestr[], const struct option *opts);
108 extern int sort_dimension__add(const char *);
109 void sort_entry__setup_elide(struct sort_entry *self, struct strlist *list,
110 			     const char *list_name, FILE *fp);
111 
112 #endif	/* __PERF_SORT_H */
113