hist.h 10.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 "evsel.h"
8
#include "header.h"
9
#include "color.h"
10
#include "ui/progress.h"
11

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

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

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

55 56 57
struct thread;
struct dso;

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

75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
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;
98 99 100
	/* user-defined callback function (optional) */
	int (*add_entry_cb)(struct hist_entry_iter *iter,
			    struct addr_location *al, bool single, void *arg);
101 102 103 104 105
};

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;
106
extern const struct hist_iter_ops hist_iter_cumulative;
107

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

118 119
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);
120
int hist_entry__transaction_len(void);
121
int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size,
122
			      struct hists *hists);
123
void hist_entry__delete(struct hist_entry *he);
124

125
void hists__output_resort(struct hists *hists, struct ui_progress *prog);
126
void hists__collapse_resort(struct hists *hists, struct ui_progress *prog);
127

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

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

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

144 145
void hists__filter_by_dso(struct hists *hists);
void hists__filter_by_thread(struct hists *hists);
146
void hists__filter_by_symbol(struct hists *hists);
147

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

154 155 156
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);
157 158
void hists__reset_col_len(struct hists *hists);
void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
159

160
void hists__match(struct hists *leader, struct hists *other);
161
int hists__link(struct hists *leader, struct hists *other);
162

163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
struct hists_evsel {
	struct perf_evsel evsel;
	struct hists	  hists;
};

static inline struct perf_evsel *hists_to_evsel(struct hists *hists)
{
	struct hists_evsel *hevsel = container_of(hists, struct hists_evsel, hists);
	return &hevsel->evsel;
}

static inline struct hists *evsel__hists(struct perf_evsel *evsel)
{
	struct hists_evsel *hevsel = (struct hists_evsel *)evsel;
	return &hevsel->hists;
}

int hists__init(void);

182 183 184 185 186 187 188 189
struct perf_hpp {
	char *buf;
	size_t size;
	const char *sep;
	void *ptr;
};

struct perf_hpp_fmt {
190
	const char *name;
191 192 193 194
	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);
195 196 197 198
	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);
199 200 201 202 203 204
	int64_t (*cmp)(struct perf_hpp_fmt *fmt,
		       struct hist_entry *a, struct hist_entry *b);
	int64_t (*collapse)(struct perf_hpp_fmt *fmt,
			    struct hist_entry *a, struct hist_entry *b);
	int64_t (*sort)(struct perf_hpp_fmt *fmt,
			struct hist_entry *a, struct hist_entry *b);
205 206

	struct list_head list;
207
	struct list_head sort_list;
208
	bool elide;
209
	int len;
210
	int user_len;
211 212
};

213
extern struct list_head perf_hpp__list;
214
extern struct list_head perf_hpp__sort_list;
215 216 217 218

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

219 220 221
#define perf_hpp__for_each_format_safe(format, tmp)	\
	list_for_each_entry_safe(format, tmp, &perf_hpp__list, list)

222 223 224
#define perf_hpp__for_each_sort_list(format) \
	list_for_each_entry(format, &perf_hpp__sort_list, sort_list)

225 226 227
#define perf_hpp__for_each_sort_list_safe(format, tmp)	\
	list_for_each_entry_safe(format, tmp, &perf_hpp__sort_list, sort_list)

228 229 230
extern struct perf_hpp_fmt perf_hpp__format[];

enum {
231
	/* Matches perf_hpp__format array. */
232 233 234 235 236
	PERF_HPP__OVERHEAD,
	PERF_HPP__OVERHEAD_SYS,
	PERF_HPP__OVERHEAD_US,
	PERF_HPP__OVERHEAD_GUEST_SYS,
	PERF_HPP__OVERHEAD_GUEST_US,
237
	PERF_HPP__OVERHEAD_ACC,
238 239 240 241 242 243
	PERF_HPP__SAMPLES,
	PERF_HPP__PERIOD,

	PERF_HPP__MAX_INDEX
};

244
void perf_hpp__init(void);
245
void perf_hpp__column_register(struct perf_hpp_fmt *format);
246
void perf_hpp__column_unregister(struct perf_hpp_fmt *format);
247
void perf_hpp__column_enable(unsigned col);
248 249 250
void perf_hpp__column_disable(unsigned col);
void perf_hpp__cancel_cumulate(void);

251
void perf_hpp__register_sort_field(struct perf_hpp_fmt *format);
252
void perf_hpp__setup_output_field(void);
253
void perf_hpp__reset_output_field(void);
254 255 256 257
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);
258 259 260 261 262 263

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

264
void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists);
265
void perf_hpp__reset_sort_width(struct perf_hpp_fmt *fmt, struct hists *hists);
266
void perf_hpp__set_user_width(const char *width_list_str);
267

268 269
typedef u64 (*hpp_field_fn)(struct hist_entry *he);
typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front);
270
typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...);
271

272 273 274 275 276 277
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);
278

279 280 281 282 283 284
static inline void advance_hpp(struct perf_hpp *hpp, int inc)
{
	hpp->buf  += inc;
	hpp->size -= inc;
}

285 286 287 288 289 290 291 292 293 294 295 296
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;
}

297 298
struct perf_evlist;

299 300 301 302 303 304
struct hist_browser_timer {
	void (*timer)(void *arg);
	void *arg;
	int refresh;
};

305
#ifdef HAVE_SLANG_SUPPORT
N
Namhyung Kim 已提交
306
#include "../ui/keysyms.h"
307 308 309
int map_symbol__tui_annotate(struct map_symbol *ms, struct perf_evsel *evsel,
			     struct hist_browser_timer *hbt);

310
int hist_entry__tui_annotate(struct hist_entry *he, struct perf_evsel *evsel,
311
			     struct hist_browser_timer *hbt);
N
Namhyung Kim 已提交
312 313

int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
314
				  struct hist_browser_timer *hbt,
315
				  float min_pcnt,
316
				  struct perf_env *env);
317
int script_browse(const char *script_opt);
N
Namhyung Kim 已提交
318
#else
319
static inline
320 321
int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
				  const char *help __maybe_unused,
322
				  struct hist_browser_timer *hbt __maybe_unused,
323
				  float min_pcnt __maybe_unused,
324
				  struct perf_env *env __maybe_unused)
325 326 327
{
	return 0;
}
328 329 330 331 332 333
static inline int map_symbol__tui_annotate(struct map_symbol *ms __maybe_unused,
					   struct perf_evsel *evsel __maybe_unused,
					   struct hist_browser_timer *hbt __maybe_unused)
{
	return 0;
}
334

335 336 337
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)
338 339 340
{
	return 0;
}
341

342
static inline int script_browse(const char *script_opt __maybe_unused)
343 344 345 346
{
	return 0;
}

347 348
#define K_LEFT  -1000
#define K_RIGHT -2000
349
#define K_SWITCH_INPUT_DATA -3000
350
#endif
351

352
unsigned int hists__sort_list_width(struct hists *hists);
N
Namhyung Kim 已提交
353

354 355 356
void hist__account_cycles(struct branch_stack *bs, struct addr_location *al,
			  struct perf_sample *sample, bool nonany_branch_mode);

N
Namhyung Kim 已提交
357 358 359
struct option;
int parse_filter_percentage(const struct option *opt __maybe_unused,
			    const char *arg, int unset __maybe_unused);
360
int perf_hist_config(const char *var, const char *value);
N
Namhyung Kim 已提交
361

362
#endif	/* __PERF_HIST_H */