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#include "hist.h"
24#include "thread.h"
25
26extern regex_t parent_regex;
27extern const char *sort_order;
28extern const char *field_order;
29extern const char default_parent_pattern[];
30extern const char *parent_pattern;
31extern const char default_sort_order[];
32extern regex_t ignore_callees_regex;
33extern int have_ignore_callees;
34extern int sort__need_collapse;
35extern int sort__has_parent;
36extern int sort__has_sym;
37extern enum sort_mode sort__mode;
38extern struct sort_entry sort_comm;
39extern struct sort_entry sort_dso;
40extern struct sort_entry sort_sym;
41extern struct sort_entry sort_parent;
42extern struct sort_entry sort_dso_from;
43extern struct sort_entry sort_dso_to;
44extern struct sort_entry sort_sym_from;
45extern struct sort_entry sort_sym_to;
46extern enum sort_type sort__first_dimension;
47extern const char default_mem_sort_order[];
48
49struct he_stat {
50	u64			period;
51	u64			period_sys;
52	u64			period_us;
53	u64			period_guest_sys;
54	u64			period_guest_us;
55	u64			weight;
56	u32			nr_events;
57};
58
59struct hist_entry_diff {
60	bool	computed;
61
62	/* PERF_HPP__DELTA */
63	double	period_ratio_delta;
64
65	/* PERF_HPP__RATIO */
66	double	period_ratio;
67
68	/* HISTC_WEIGHTED_DIFF */
69	s64	wdiff;
70};
71
72/**
73 * struct hist_entry - histogram entry
74 *
75 * @row_offset - offset from the first callchain expanded to appear on screen
76 * @nr_rows - rows expanded in callchain, recalculated on folding/unfolding
77 */
78struct hist_entry {
79	struct rb_node		rb_node_in;
80	struct rb_node		rb_node;
81	union {
82		struct list_head node;
83		struct list_head head;
84	} pairs;
85	struct he_stat		stat;
86	struct he_stat		*stat_acc;
87	struct map_symbol	ms;
88	struct thread		*thread;
89	struct comm		*comm;
90	u64			ip;
91	u64			transaction;
92	s32			cpu;
93	u8			cpumode;
94
95	struct hist_entry_diff	diff;
96
97	/* We are added by hists__add_dummy_entry. */
98	bool			dummy;
99
100	/* XXX These two should move to some tree widget lib */
101	u16			row_offset;
102	u16			nr_rows;
103
104	bool			init_have_children;
105	char			level;
106	u8			filtered;
107	char			*srcline;
108	struct symbol		*parent;
109	unsigned long		position;
110	struct rb_root		sorted_chain;
111	struct branch_info	*branch_info;
112	struct hists		*hists;
113	struct mem_info		*mem_info;
114	struct callchain_root	callchain[0]; /* must be last member */
115};
116
117static inline bool hist_entry__has_pairs(struct hist_entry *he)
118{
119	return !list_empty(&he->pairs.node);
120}
121
122static inline struct hist_entry *hist_entry__next_pair(struct hist_entry *he)
123{
124	if (hist_entry__has_pairs(he))
125		return list_entry(he->pairs.node.next, struct hist_entry, pairs.node);
126	return NULL;
127}
128
129static inline void hist_entry__add_pair(struct hist_entry *pair,
130					struct hist_entry *he)
131{
132	list_add_tail(&pair->pairs.node, &he->pairs.head);
133}
134
135static inline float hist_entry__get_percent_limit(struct hist_entry *he)
136{
137	u64 period = he->stat.period;
138	u64 total_period = hists__total_period(he->hists);
139
140	if (unlikely(total_period == 0))
141		return 0;
142
143	if (symbol_conf.cumulate_callchain)
144		period = he->stat_acc->period;
145
146	return period * 100.0 / total_period;
147}
148
149
150enum sort_mode {
151	SORT_MODE__NORMAL,
152	SORT_MODE__BRANCH,
153	SORT_MODE__MEMORY,
154	SORT_MODE__TOP,
155	SORT_MODE__DIFF,
156};
157
158enum sort_type {
159	/* common sort keys */
160	SORT_PID,
161	SORT_COMM,
162	SORT_DSO,
163	SORT_SYM,
164	SORT_PARENT,
165	SORT_CPU,
166	SORT_SRCLINE,
167	SORT_LOCAL_WEIGHT,
168	SORT_GLOBAL_WEIGHT,
169	SORT_TRANSACTION,
170
171	/* branch stack specific sort keys */
172	__SORT_BRANCH_STACK,
173	SORT_DSO_FROM = __SORT_BRANCH_STACK,
174	SORT_DSO_TO,
175	SORT_SYM_FROM,
176	SORT_SYM_TO,
177	SORT_MISPREDICT,
178	SORT_ABORT,
179	SORT_IN_TX,
180
181	/* memory mode specific sort keys */
182	__SORT_MEMORY_MODE,
183	SORT_MEM_DADDR_SYMBOL = __SORT_MEMORY_MODE,
184	SORT_MEM_DADDR_DSO,
185	SORT_MEM_LOCKED,
186	SORT_MEM_TLB,
187	SORT_MEM_LVL,
188	SORT_MEM_SNOOP,
189	SORT_MEM_DCACHELINE,
190};
191
192/*
193 * configurable sorting bits
194 */
195
196struct sort_entry {
197	struct list_head list;
198
199	const char *se_header;
200
201	int64_t (*se_cmp)(struct hist_entry *, struct hist_entry *);
202	int64_t (*se_collapse)(struct hist_entry *, struct hist_entry *);
203	int64_t	(*se_sort)(struct hist_entry *, struct hist_entry *);
204	int	(*se_snprintf)(struct hist_entry *he, char *bf, size_t size,
205			       unsigned int width);
206	u8	se_width_idx;
207};
208
209extern struct sort_entry sort_thread;
210extern struct list_head hist_entry__sort_list;
211
212int setup_sorting(void);
213int setup_output_field(void);
214void reset_output_field(void);
215extern int sort_dimension__add(const char *);
216void sort__setup_elide(FILE *fp);
217void perf_hpp__set_elide(int idx, bool elide);
218
219int report_parse_ignore_callees_opt(const struct option *opt, const char *arg, int unset);
220
221bool is_strict_order(const char *order);
222#endif	/* __PERF_SORT_H */
223