hist.h 9.5 KB
Newer Older
1 2 3
#ifndef __PERF_HIST_H
#define __PERF_HIST_H

4
#include <linux/types.h>
5
#include <pthread.h>
6
#include "callchain.h"
7
#include "header.h"
8
#include "color.h"
9
#include "ui/progress.h"
10

11 12 13
struct hist_entry;
struct addr_location;
struct symbol;
14

15 16 17 18 19 20 21 22 23
enum hist_filter {
	HIST_FILTER__DSO,
	HIST_FILTER__THREAD,
	HIST_FILTER__PARENT,
	HIST_FILTER__SYMBOL,
	HIST_FILTER__GUEST,
	HIST_FILTER__HOST,
};

24 25 26 27 28 29 30
enum hist_column {
	HISTC_SYMBOL,
	HISTC_DSO,
	HISTC_THREAD,
	HISTC_COMM,
	HISTC_PARENT,
	HISTC_CPU,
31
	HISTC_SRCLINE,
32
	HISTC_MISPREDICT,
33 34
	HISTC_IN_TX,
	HISTC_ABORT,
35 36 37 38
	HISTC_SYMBOL_FROM,
	HISTC_SYMBOL_TO,
	HISTC_DSO_FROM,
	HISTC_DSO_TO,
39 40
	HISTC_LOCAL_WEIGHT,
	HISTC_GLOBAL_WEIGHT,
41 42 43 44 45 46
	HISTC_MEM_DADDR_SYMBOL,
	HISTC_MEM_DADDR_DSO,
	HISTC_MEM_LOCKED,
	HISTC_MEM_TLB,
	HISTC_MEM_LVL,
	HISTC_MEM_SNOOP,
D
Don Zickus 已提交
47
	HISTC_MEM_DCACHELINE,
48
	HISTC_TRANSACTION,
49 50 51
	HISTC_NR_COLS, /* Last entry */
};

52 53 54
struct thread;
struct dso;

55
struct hists {
56 57
	struct rb_root		entries_in_array[2];
	struct rb_root		*entries_in;
58
	struct rb_root		entries;
59
	struct rb_root		entries_collapsed;
60
	u64			nr_entries;
61
	u64			nr_non_filtered_entries;
62 63
	const struct thread	*thread_filter;
	const struct dso	*dso_filter;
64
	const char		*uid_filter_str;
65
	const char		*symbol_filter_str;
66
	pthread_mutex_t		lock;
67 68
	struct events_stats	stats;
	u64			event_stream;
69
	u16			col_len[HISTC_NR_COLS];
70 71
};

72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
struct hist_entry_iter;

struct hist_iter_ops {
	int (*prepare_entry)(struct hist_entry_iter *, struct addr_location *);
	int (*add_single_entry)(struct hist_entry_iter *, struct addr_location *);
	int (*next_entry)(struct hist_entry_iter *, struct addr_location *);
	int (*add_next_entry)(struct hist_entry_iter *, struct addr_location *);
	int (*finish_entry)(struct hist_entry_iter *, struct addr_location *);
};

struct hist_entry_iter {
	int total;
	int curr;

	bool hide_unresolved;

	struct perf_evsel *evsel;
	struct perf_sample *sample;
	struct hist_entry *he;
	struct symbol *parent;
	void *priv;

	const struct hist_iter_ops *ops;
95 96 97
	/* user-defined callback function (optional) */
	int (*add_entry_cb)(struct hist_entry_iter *iter,
			    struct addr_location *al, bool single, void *arg);
98 99 100 101 102
};

extern const struct hist_iter_ops hist_iter_normal;
extern const struct hist_iter_ops hist_iter_branch;
extern const struct hist_iter_ops hist_iter_mem;
103
extern const struct hist_iter_ops hist_iter_cumulative;
104

105
struct hist_entry *__hists__add_entry(struct hists *hists,
106
				      struct addr_location *al,
107 108 109
				      struct symbol *parent,
				      struct branch_info *bi,
				      struct mem_info *mi, u64 period,
110 111
				      u64 weight, u64 transaction,
				      bool sample_self);
112 113
int hist_entry_iter__add(struct hist_entry_iter *iter, struct addr_location *al,
			 struct perf_evsel *evsel, struct perf_sample *sample,
114
			 int max_stack_depth, void *arg);
115

116 117
int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
118
int hist_entry__transaction_len(void);
119
int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size,
120
			      struct hists *hists);
121 122
void hist_entry__free(struct hist_entry *);

123 124
void hists__output_resort(struct hists *hists);
void hists__collapse_resort(struct hists *hists, struct ui_progress *prog);
125

126
void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
N
Namhyung Kim 已提交
127
void hists__delete_entries(struct hists *hists);
128 129
void hists__output_recalc_col_len(struct hists *hists, int max_rows);

130
u64 hists__total_period(struct hists *hists);
131
void hists__reset_stats(struct hists *hists);
132
void hists__inc_stats(struct hists *hists, struct hist_entry *h);
133
void hists__inc_nr_events(struct hists *hists, u32 type);
134
void hists__inc_nr_samples(struct hists *hists, bool filtered);
135
void events_stats__inc(struct events_stats *stats, u32 type);
136
size_t events_stats__fprintf(struct events_stats *stats, FILE *fp);
137

138
size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
139
		      int max_cols, float min_pcnt, FILE *fp);
140
size_t perf_evlist__fprintf_nr_events(struct perf_evlist *evlist, FILE *fp);
141

142 143
void hists__filter_by_dso(struct hists *hists);
void hists__filter_by_thread(struct hists *hists);
144
void hists__filter_by_symbol(struct hists *hists);
145

146 147 148 149 150 151
static inline bool hists__has_filter(struct hists *hists)
{
	return hists->thread_filter || hists->dso_filter ||
		hists->symbol_filter_str;
}

152 153 154
u16 hists__col_len(struct hists *hists, enum hist_column col);
void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len);
bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len);
155 156
void hists__reset_col_len(struct hists *hists);
void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
157

158
void hists__match(struct hists *leader, struct hists *other);
159
int hists__link(struct hists *leader, struct hists *other);
160

161 162 163 164 165 166 167 168
struct perf_hpp {
	char *buf;
	size_t size;
	const char *sep;
	void *ptr;
};

struct perf_hpp_fmt {
169
	const char *name;
170 171 172 173
	int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
		      struct perf_evsel *evsel);
	int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
		     struct perf_evsel *evsel);
174 175 176 177
	int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
		     struct hist_entry *he);
	int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
		     struct hist_entry *he);
178 179 180
	int64_t (*cmp)(struct hist_entry *a, struct hist_entry *b);
	int64_t (*collapse)(struct hist_entry *a, struct hist_entry *b);
	int64_t (*sort)(struct hist_entry *a, struct hist_entry *b);
181 182

	struct list_head list;
183
	struct list_head sort_list;
184
	bool elide;
185
	int len;
186
	int user_len;
187 188
};

189
extern struct list_head perf_hpp__list;
190
extern struct list_head perf_hpp__sort_list;
191 192 193 194

#define perf_hpp__for_each_format(format) \
	list_for_each_entry(format, &perf_hpp__list, list)

195 196 197
#define perf_hpp__for_each_format_safe(format, tmp)	\
	list_for_each_entry_safe(format, tmp, &perf_hpp__list, list)

198 199 200
#define perf_hpp__for_each_sort_list(format) \
	list_for_each_entry(format, &perf_hpp__sort_list, sort_list)

201 202 203
#define perf_hpp__for_each_sort_list_safe(format, tmp)	\
	list_for_each_entry_safe(format, tmp, &perf_hpp__sort_list, sort_list)

204 205 206
extern struct perf_hpp_fmt perf_hpp__format[];

enum {
207
	/* Matches perf_hpp__format array. */
208 209 210 211 212
	PERF_HPP__OVERHEAD,
	PERF_HPP__OVERHEAD_SYS,
	PERF_HPP__OVERHEAD_US,
	PERF_HPP__OVERHEAD_GUEST_SYS,
	PERF_HPP__OVERHEAD_GUEST_US,
213
	PERF_HPP__OVERHEAD_ACC,
214 215 216 217 218 219
	PERF_HPP__SAMPLES,
	PERF_HPP__PERIOD,

	PERF_HPP__MAX_INDEX
};

220
void perf_hpp__init(void);
221
void perf_hpp__column_register(struct perf_hpp_fmt *format);
222
void perf_hpp__column_unregister(struct perf_hpp_fmt *format);
223
void perf_hpp__column_enable(unsigned col);
224 225 226
void perf_hpp__column_disable(unsigned col);
void perf_hpp__cancel_cumulate(void);

227
void perf_hpp__register_sort_field(struct perf_hpp_fmt *format);
228
void perf_hpp__setup_output_field(void);
229
void perf_hpp__reset_output_field(void);
230 231 232 233
void perf_hpp__append_sort_keys(void);

bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format);
bool perf_hpp__same_sort_entry(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b);
234 235 236 237 238 239

static inline bool perf_hpp__should_skip(struct perf_hpp_fmt *format)
{
	return format->elide;
}

240
void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists);
241
void perf_hpp__reset_sort_width(struct perf_hpp_fmt *fmt, struct hists *hists);
242
void perf_hpp__set_user_width(const char *width_list_str);
243

244 245
typedef u64 (*hpp_field_fn)(struct hist_entry *he);
typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front);
246
typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...);
247

248 249 250 251 252 253
int hpp__fmt(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
	     struct hist_entry *he, hpp_field_fn get_field,
	     const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
int hpp__fmt_acc(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
		 struct hist_entry *he, hpp_field_fn get_field,
		 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
254

255 256 257 258 259 260
static inline void advance_hpp(struct perf_hpp *hpp, int inc)
{
	hpp->buf  += inc;
	hpp->size -= inc;
}

261 262 263 264 265 266 267 268 269 270 271 272
static inline size_t perf_hpp__use_color(void)
{
	return !symbol_conf.field_sep;
}

static inline size_t perf_hpp__color_overhead(void)
{
	return perf_hpp__use_color() ?
	       (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX
	       : 0;
}

273 274
struct perf_evlist;

275 276 277 278 279 280
struct hist_browser_timer {
	void (*timer)(void *arg);
	void *arg;
	int refresh;
};

281
#ifdef HAVE_SLANG_SUPPORT
N
Namhyung Kim 已提交
282
#include "../ui/keysyms.h"
283
int hist_entry__tui_annotate(struct hist_entry *he, struct perf_evsel *evsel,
284
			     struct hist_browser_timer *hbt);
N
Namhyung Kim 已提交
285 286

int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
287
				  struct hist_browser_timer *hbt,
288
				  float min_pcnt,
289
				  struct perf_session_env *env);
290
int script_browse(const char *script_opt);
N
Namhyung Kim 已提交
291
#else
292
static inline
293 294
int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
				  const char *help __maybe_unused,
295
				  struct hist_browser_timer *hbt __maybe_unused,
296
				  float min_pcnt __maybe_unused,
297
				  struct perf_session_env *env __maybe_unused)
298 299 300 301
{
	return 0;
}

302 303 304
static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused,
					   struct perf_evsel *evsel __maybe_unused,
					   struct hist_browser_timer *hbt __maybe_unused)
305 306 307
{
	return 0;
}
308

309
static inline int script_browse(const char *script_opt __maybe_unused)
310 311 312 313
{
	return 0;
}

314 315
#define K_LEFT  -1000
#define K_RIGHT -2000
316
#define K_SWITCH_INPUT_DATA -3000
317
#endif
318

319
unsigned int hists__sort_list_width(struct hists *hists);
N
Namhyung Kim 已提交
320 321 322 323

struct option;
int parse_filter_percentage(const struct option *opt __maybe_unused,
			    const char *arg, int unset __maybe_unused);
324
int perf_hist_config(const char *var, const char *value);
N
Namhyung Kim 已提交
325

326
#endif	/* __PERF_HIST_H */