[deliverable/linux.git] / tools / perf / util / hist.h

#ifndef __PERF_HIST_H
#define __PERF_HIST_H

#include <linux/types.h>
#include <pthread.h>
#include "callchain.h"
#include "evsel.h"
#include "header.h"
#include "color.h"
#include "ui/progress.h"

struct hist_entry;
struct hist_entry_ops;
struct addr_location;
struct symbol;

enum hist_filter {
	HIST_FILTER__DSO,
	HIST_FILTER__THREAD,
	HIST_FILTER__PARENT,
	HIST_FILTER__SYMBOL,
	HIST_FILTER__GUEST,
	HIST_FILTER__HOST,
	HIST_FILTER__SOCKET,
};

enum hist_column {
	HISTC_SYMBOL,
	HISTC_DSO,
	HISTC_THREAD,
	HISTC_COMM,
	HISTC_PARENT,
	HISTC_CPU,
	HISTC_SOCKET,
	HISTC_SRCLINE,
	HISTC_SRCFILE,
	HISTC_MISPREDICT,
	HISTC_IN_TX,
	HISTC_ABORT,
	HISTC_SYMBOL_FROM,
	HISTC_SYMBOL_TO,
	HISTC_DSO_FROM,
	HISTC_DSO_TO,
	HISTC_LOCAL_WEIGHT,
	HISTC_GLOBAL_WEIGHT,
	HISTC_MEM_DADDR_SYMBOL,
	HISTC_MEM_DADDR_DSO,
	HISTC_MEM_LOCKED,
	HISTC_MEM_TLB,
	HISTC_MEM_LVL,
	HISTC_MEM_SNOOP,
	HISTC_MEM_DCACHELINE,
	HISTC_MEM_IADDR_SYMBOL,
	HISTC_TRANSACTION,
	HISTC_CYCLES,
	HISTC_SRCLINE_FROM,
	HISTC_SRCLINE_TO,
	HISTC_TRACE,
	HISTC_NR_COLS, /* Last entry */
};

struct thread;
struct dso;

struct hists {
	struct rb_root		entries_in_array[2];
	struct rb_root		*entries_in;
	struct rb_root		entries;
	struct rb_root		entries_collapsed;
	u64			nr_entries;
	u64			nr_non_filtered_entries;
	u64			callchain_period;
	u64			callchain_non_filtered_period;
	struct thread		*thread_filter;
	const struct dso	*dso_filter;
	const char		*uid_filter_str;
	const char		*symbol_filter_str;
	pthread_mutex_t		lock;
	struct events_stats	stats;
	u64			event_stream;
	u16			col_len[HISTC_NR_COLS];
	int			socket_filter;
	struct perf_hpp_list	*hpp_list;
	struct list_head	hpp_formats;
	int			nr_hpp_node;
};

#define hists__has(__h, __f) (__h)->hpp_list->__f

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;
	int max_stack;

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

	const struct hist_iter_ops *ops;
	/* user-defined callback function (optional) */
	int (*add_entry_cb)(struct hist_entry_iter *iter,
			    struct addr_location *al, bool single, void *arg);
};

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

struct hist_entry *hists__add_entry(struct hists *hists,
				    struct addr_location *al,
				    struct symbol *parent,
				    struct branch_info *bi,
				    struct mem_info *mi,
				    struct perf_sample *sample,
				    bool sample_self);

struct hist_entry *hists__add_entry_ops(struct hists *hists,
					struct hist_entry_ops *ops,
					struct addr_location *al,
					struct symbol *sym_parent,
					struct branch_info *bi,
					struct mem_info *mi,
					struct perf_sample *sample,
					bool sample_self);

int hist_entry_iter__add(struct hist_entry_iter *iter, struct addr_location *al,
			 int max_stack_depth, void *arg);

struct perf_hpp;
struct perf_hpp_fmt;

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);
int hist_entry__transaction_len(void);
int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size,
			      struct hists *hists);
int hist_entry__snprintf_alignment(struct hist_entry *he, struct perf_hpp *hpp,
				   struct perf_hpp_fmt *fmt, int printed);
void hist_entry__delete(struct hist_entry *he);

typedef int (*hists__resort_cb_t)(struct hist_entry *he);

void perf_evsel__output_resort(struct perf_evsel *evsel, struct ui_progress *prog);
void hists__output_resort(struct hists *hists, struct ui_progress *prog);
void hists__output_resort_cb(struct hists *hists, struct ui_progress *prog,
			     hists__resort_cb_t cb);
int hists__collapse_resort(struct hists *hists, struct ui_progress *prog);

void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
void hists__delete_entries(struct hists *hists);
void hists__output_recalc_col_len(struct hists *hists, int max_rows);

u64 hists__total_period(struct hists *hists);
void hists__reset_stats(struct hists *hists);
void hists__inc_stats(struct hists *hists, struct hist_entry *h);
void hists__inc_nr_events(struct hists *hists, u32 type);
void hists__inc_nr_samples(struct hists *hists, bool filtered);
void events_stats__inc(struct events_stats *stats, u32 type);
size_t events_stats__fprintf(struct events_stats *stats, FILE *fp);

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

void hists__filter_by_dso(struct hists *hists);
void hists__filter_by_thread(struct hists *hists);
void hists__filter_by_symbol(struct hists *hists);
void hists__filter_by_socket(struct hists *hists);

static inline bool hists__has_filter(struct hists *hists)
{
	return hists->thread_filter || hists->dso_filter ||
		hists->symbol_filter_str || (hists->socket_filter > -1);
}

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);
void hists__reset_col_len(struct hists *hists);
void hists__calc_col_len(struct hists *hists, struct hist_entry *he);

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

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);
int __hists__init(struct hists *hists, struct perf_hpp_list *hpp_list);

struct rb_root *hists__get_rotate_entries_in(struct hists *hists);

struct perf_hpp {
	char *buf;
	size_t size;
	const char *sep;
	void *ptr;
};

struct perf_hpp_fmt {
	const char *name;
	int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
		      struct hists *hists, int line, int *span);
	int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
		     struct hists *hists);
	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);
	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);
	bool (*equal)(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b);
	void (*free)(struct perf_hpp_fmt *fmt);

	struct list_head list;
	struct list_head sort_list;
	bool elide;
	int len;
	int user_len;
	int idx;
	int level;
};

struct perf_hpp_list {
	struct list_head fields;
	struct list_head sorts;

	int nr_header_lines;
	int need_collapse;
	int parent;
	int sym;
	int dso;
	int socket;
	int thread;
	int comm;
};

extern struct perf_hpp_list perf_hpp_list;

struct perf_hpp_list_node {
	struct list_head	list;
	struct perf_hpp_list	hpp;
	int			level;
	bool			skip;
};

void perf_hpp_list__column_register(struct perf_hpp_list *list,
				    struct perf_hpp_fmt *format);
void perf_hpp_list__register_sort_field(struct perf_hpp_list *list,
					struct perf_hpp_fmt *format);

static inline void perf_hpp__column_register(struct perf_hpp_fmt *format)
{
	perf_hpp_list__column_register(&perf_hpp_list, format);
}

static inline void perf_hpp__register_sort_field(struct perf_hpp_fmt *format)
{
	perf_hpp_list__register_sort_field(&perf_hpp_list, format);
}

#define perf_hpp_list__for_each_format(_list, format) \
	list_for_each_entry(format, &(_list)->fields, list)

#define perf_hpp_list__for_each_format_safe(_list, format, tmp)	\
	list_for_each_entry_safe(format, tmp, &(_list)->fields, list)

#define perf_hpp_list__for_each_sort_list(_list, format) \
	list_for_each_entry(format, &(_list)->sorts, sort_list)

#define perf_hpp_list__for_each_sort_list_safe(_list, format, tmp)	\
	list_for_each_entry_safe(format, tmp, &(_list)->sorts, sort_list)

#define hists__for_each_format(hists, format) \
	perf_hpp_list__for_each_format((hists)->hpp_list, fmt)

#define hists__for_each_sort_list(hists, format) \
	perf_hpp_list__for_each_sort_list((hists)->hpp_list, fmt)

extern struct perf_hpp_fmt perf_hpp__format[];

enum {
	/* Matches perf_hpp__format array. */
	PERF_HPP__OVERHEAD,
	PERF_HPP__OVERHEAD_SYS,
	PERF_HPP__OVERHEAD_US,
	PERF_HPP__OVERHEAD_GUEST_SYS,
	PERF_HPP__OVERHEAD_GUEST_US,
	PERF_HPP__OVERHEAD_ACC,
	PERF_HPP__SAMPLES,
	PERF_HPP__PERIOD,

	PERF_HPP__MAX_INDEX
};

void perf_hpp__init(void);
void perf_hpp__column_unregister(struct perf_hpp_fmt *format);
void perf_hpp__cancel_cumulate(void);
void perf_hpp__setup_output_field(struct perf_hpp_list *list);
void perf_hpp__reset_output_field(struct perf_hpp_list *list);
void perf_hpp__append_sort_keys(struct perf_hpp_list *list);
int perf_hpp__setup_hists_formats(struct perf_hpp_list *list,
				  struct perf_evlist *evlist);


bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format);
bool perf_hpp__is_dynamic_entry(struct perf_hpp_fmt *format);
bool perf_hpp__defined_dynamic_entry(struct perf_hpp_fmt *fmt, struct hists *hists);
bool perf_hpp__is_trace_entry(struct perf_hpp_fmt *fmt);
bool perf_hpp__is_srcline_entry(struct perf_hpp_fmt *fmt);
bool perf_hpp__is_srcfile_entry(struct perf_hpp_fmt *fmt);
bool perf_hpp__is_thread_entry(struct perf_hpp_fmt *fmt);
bool perf_hpp__is_comm_entry(struct perf_hpp_fmt *fmt);
bool perf_hpp__is_dso_entry(struct perf_hpp_fmt *fmt);
bool perf_hpp__is_sym_entry(struct perf_hpp_fmt *fmt);

struct perf_hpp_fmt *perf_hpp_fmt__dup(struct perf_hpp_fmt *fmt);

int hist_entry__filter(struct hist_entry *he, int type, const void *arg);

static inline bool perf_hpp__should_skip(struct perf_hpp_fmt *format,
					 struct hists *hists)
{
	if (format->elide)
		return true;

	if (perf_hpp__is_dynamic_entry(format) &&
	    !perf_hpp__defined_dynamic_entry(format, hists))
		return true;

	return false;
}

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

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

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);

static inline void advance_hpp(struct perf_hpp *hpp, int inc)
{
	hpp->buf  += inc;
	hpp->size -= inc;
}

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;
}

struct perf_evlist;

struct hist_browser_timer {
	void (*timer)(void *arg);
	void *arg;
	int refresh;
};

#ifdef HAVE_SLANG_SUPPORT
#include "../ui/keysyms.h"
int map_symbol__tui_annotate(struct map_symbol *ms, struct perf_evsel *evsel,
			     struct hist_browser_timer *hbt);

int hist_entry__tui_annotate(struct hist_entry *he, struct perf_evsel *evsel,
			     struct hist_browser_timer *hbt);

int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
				  struct hist_browser_timer *hbt,
				  float min_pcnt,
				  struct perf_env *env);
int script_browse(const char *script_opt);
#else
static inline
int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
				  const char *help __maybe_unused,
				  struct hist_browser_timer *hbt __maybe_unused,
				  float min_pcnt __maybe_unused,
				  struct perf_env *env __maybe_unused)
{
	return 0;
}
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;
}

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)
{
	return 0;
}

static inline int script_browse(const char *script_opt __maybe_unused)
{
	return 0;
}

#define K_LEFT  -1000
#define K_RIGHT -2000
#define K_SWITCH_INPUT_DATA -3000
#endif

unsigned int hists__sort_list_width(struct hists *hists);
unsigned int hists__overhead_width(struct hists *hists);

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

struct option;
int parse_filter_percentage(const struct option *opt, const char *arg, int unset);
int perf_hist_config(const char *var, const char *value);

void perf_hpp_list__init(struct perf_hpp_list *list);

enum hierarchy_move_dir {
	HMD_NORMAL,
	HMD_FORCE_SIBLING,
	HMD_FORCE_CHILD,
};

struct rb_node *rb_hierarchy_last(struct rb_node *node);
struct rb_node *__rb_hierarchy_next(struct rb_node *node,
				    enum hierarchy_move_dir hmd);
struct rb_node *rb_hierarchy_prev(struct rb_node *node);

static inline struct rb_node *rb_hierarchy_next(struct rb_node *node)
{
	return __rb_hierarchy_next(node, HMD_NORMAL);
}

#define HIERARCHY_INDENT  3

bool hist_entry__has_hierarchy_children(struct hist_entry *he, float limit);

#endif	/* __PERF_HIST_H */
Commit	Line	Data
3d1d07ec JK	1	#ifndef __PERF_HIST_H
3d1d07ec JK	2	#define __PERF_HIST_H
3d1d07ec	3
4e4f06e4	4	#include <linux/types.h>
1980c2eb	5	#include <pthread.h>
3d1d07ec	6	#include "callchain.h"
a635fc51	7	#include "evsel.h"
68d80758	8	#include "header.h"
9754c4f9	9	#include "color.h"
c1fb5651	10	#include "ui/progress.h"
3d1d07ec	11
4e4f06e4	12	struct hist_entry;
a5051979	13	struct hist_entry_ops;
4e4f06e4 ACM	14	struct addr_location;
4e4f06e4 ACM	15	struct symbol;
ef7b93a1	16
b3cef7f6 NK	17	enum hist_filter {
	18	HIST_FILTER__DSO,
	19	HIST_FILTER__THREAD,
	20	HIST_FILTER__PARENT,
	21	HIST_FILTER__SYMBOL,
	22	HIST_FILTER__GUEST,
	23	HIST_FILTER__HOST,
21394d94	24	HIST_FILTER__SOCKET,
b3cef7f6 NK	25	};
b3cef7f6 NK	26
8a6c5b26 ACM	27	enum hist_column {
	28	HISTC_SYMBOL,
	29	HISTC_DSO,
	30	HISTC_THREAD,
	31	HISTC_COMM,
	32	HISTC_PARENT,
	33	HISTC_CPU,
2e7ea3ab	34	HISTC_SOCKET,
dfd3b2fd	35	HISTC_SRCLINE,
31191a85	36	HISTC_SRCFILE,
b5387528	37	HISTC_MISPREDICT,
f5d05bce AK	38	HISTC_IN_TX,
f5d05bce AK	39	HISTC_ABORT,
b5387528 RAV	40	HISTC_SYMBOL_FROM,
	41	HISTC_SYMBOL_TO,
	42	HISTC_DSO_FROM,
	43	HISTC_DSO_TO,
05484298 AK	44	HISTC_LOCAL_WEIGHT,
05484298 AK	45	HISTC_GLOBAL_WEIGHT,
98a3b32c SE	46	HISTC_MEM_DADDR_SYMBOL,
	47	HISTC_MEM_DADDR_DSO,
	48	HISTC_MEM_LOCKED,
	49	HISTC_MEM_TLB,
	50	HISTC_MEM_LVL,
	51	HISTC_MEM_SNOOP,
9b32ba71	52	HISTC_MEM_DCACHELINE,
28e6db20	53	HISTC_MEM_IADDR_SYMBOL,
475eeab9	54	HISTC_TRANSACTION,
0e332f03	55	HISTC_CYCLES,
508be0df AK	56	HISTC_SRCLINE_FROM,
508be0df AK	57	HISTC_SRCLINE_TO,
a34bb6a0	58	HISTC_TRACE,
8a6c5b26 ACM	59	HISTC_NR_COLS, /* Last entry */
	60	};
	61
d7b76f09 ACM	62	struct thread;
	63	struct dso;
	64
1c02c4d2	65	struct hists {
1980c2eb ACM	66	struct rb_root entries_in_array[2];
1980c2eb ACM	67	struct rb_root *entries_in;
1c02c4d2	68	struct rb_root entries;
1980c2eb	69	struct rb_root entries_collapsed;
fefb0b94	70	u64 nr_entries;
1ab1fa5d	71	u64 nr_non_filtered_entries;
467ef10c NK	72	u64 callchain_period;
467ef10c NK	73	u64 callchain_non_filtered_period;
f3b623b8	74	struct thread *thread_filter;
d7b76f09	75	const struct dso *dso_filter;
0d37aa34	76	const char *uid_filter_str;
e94d53eb	77	const char *symbol_filter_str;
1980c2eb	78	pthread_mutex_t lock;
1c02c4d2	79	struct events_stats stats;
1c02c4d2	80	u64 event_stream;
8a6c5b26	81	u16 col_len[HISTC_NR_COLS];
21394d94	82	int socket_filter;
5b65855e	83	struct perf_hpp_list *hpp_list;
c3bc0c43	84	struct list_head hpp_formats;
2dbbe9f2	85	int nr_hpp_node;
1c02c4d2 ACM	86	};
1c02c4d2 ACM	87
52225036 JO	88	#define hists__has(__h, __f) (__h)->hpp_list->__f
52225036 JO	89
69bcb019 NK	90	struct hist_entry_iter;
	91
	92	struct hist_iter_ops {
	93	int (prepare_entry)(struct hist_entry_iter , struct addr_location *);
	94	int (add_single_entry)(struct hist_entry_iter , struct addr_location *);
	95	int (next_entry)(struct hist_entry_iter , struct addr_location *);
	96	int (add_next_entry)(struct hist_entry_iter , struct addr_location *);
	97	int (finish_entry)(struct hist_entry_iter , struct addr_location *);
	98	};
	99
	100	struct hist_entry_iter {
	101	int total;
	102	int curr;
	103
	104	bool hide_unresolved;
96b40f3c	105	int max_stack;
69bcb019 NK	106
	107	struct perf_evsel *evsel;
	108	struct perf_sample *sample;
	109	struct hist_entry *he;
	110	struct symbol *parent;
	111	void *priv;
	112
	113	const struct hist_iter_ops *ops;
9d3c02d7 NK	114	/* user-defined callback function (optional) */
	115	int (add_entry_cb)(struct hist_entry_iter iter,
	116	struct addr_location al, bool single, void arg);
69bcb019 NK	117	};
	118
	119	extern const struct hist_iter_ops hist_iter_normal;
	120	extern const struct hist_iter_ops hist_iter_branch;
	121	extern const struct hist_iter_ops hist_iter_mem;
7a13aa28	122	extern const struct hist_iter_ops hist_iter_cumulative;
69bcb019	123
0102ef3e JO	124	struct hist_entry hists__add_entry(struct hists hists,
	125	struct addr_location *al,
	126	struct symbol *parent,
	127	struct branch_info *bi,
	128	struct mem_info *mi,
	129	struct perf_sample *sample,
	130	bool sample_self);
a5051979 JO	131
	132	struct hist_entry hists__add_entry_ops(struct hists hists,
	133	struct hist_entry_ops *ops,
	134	struct addr_location *al,
	135	struct symbol *sym_parent,
	136	struct branch_info *bi,
	137	struct mem_info *mi,
	138	struct perf_sample *sample,
	139	bool sample_self);
	140
69bcb019	141	int hist_entry_iter__add(struct hist_entry_iter iter, struct addr_location al,
9d3c02d7	142	int max_stack_depth, void *arg);
69bcb019	143
89fee709 ACM	144	struct perf_hpp;
	145	struct perf_hpp_fmt;
	146
12c14278 ACM	147	int64_t hist_entry__cmp(struct hist_entry left, struct hist_entry right);
12c14278 ACM	148	int64_t hist_entry__collapse(struct hist_entry left, struct hist_entry right);
475eeab9	149	int hist_entry__transaction_len(void);
316c7136	150	int hist_entry__sort_snprintf(struct hist_entry he, char bf, size_t size,
000078bc	151	struct hists *hists);
89fee709 ACM	152	int hist_entry__snprintf_alignment(struct hist_entry he, struct perf_hpp hpp,
89fee709 ACM	153	struct perf_hpp_fmt *fmt, int printed);
6733d1bf	154	void hist_entry__delete(struct hist_entry *he);
4e4f06e4	155
52c5cc36 JO	156	typedef int (hists__resort_cb_t)(struct hist_entry he);
52c5cc36 JO	157
452ce03b	158	void perf_evsel__output_resort(struct perf_evsel evsel, struct ui_progress prog);
740b97f9	159	void hists__output_resort(struct hists hists, struct ui_progress prog);
52c5cc36 JO	160	void hists__output_resort_cb(struct hists hists, struct ui_progress prog,
52c5cc36 JO	161	hists__resort_cb_t cb);
bba58cdf	162	int hists__collapse_resort(struct hists hists, struct ui_progress prog);
c8446b9b	163
b079d4e9	164	void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
701937bd	165	void hists__delete_entries(struct hists *hists);
ab81f3fd ACM	166	void hists__output_recalc_col_len(struct hists *hists, int max_rows);
ab81f3fd ACM	167
f2148330	168	u64 hists__total_period(struct hists *hists);
9283ba9b	169	void hists__reset_stats(struct hists *hists);
6263835a	170	void hists__inc_stats(struct hists hists, struct hist_entry h);
316c7136	171	void hists__inc_nr_events(struct hists *hists, u32 type);
1844dbcb	172	void hists__inc_nr_samples(struct hists *hists, bool filtered);
28a6b6aa	173	void events_stats__inc(struct events_stats *stats, u32 type);
52168eea	174	size_t events_stats__fprintf(struct events_stats stats, FILE fp);
c8446b9b	175
316c7136	176	size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
d05e3aae JO	177	int max_cols, float min_pcnt, FILE *fp,
d05e3aae JO	178	bool use_callchain);
2a1731fb	179	size_t perf_evlist__fprintf_nr_events(struct perf_evlist evlist, FILE fp);
b09e0190	180
d7b76f09 ACM	181	void hists__filter_by_dso(struct hists *hists);
d7b76f09 ACM	182	void hists__filter_by_thread(struct hists *hists);
e94d53eb	183	void hists__filter_by_symbol(struct hists *hists);
84734b06	184	void hists__filter_by_socket(struct hists *hists);
b09e0190	185
268397cb NK	186	static inline bool hists__has_filter(struct hists *hists)
	187	{
	188	return hists->thread_filter \|\| hists->dso_filter \|\|
21394d94	189	hists->symbol_filter_str \|\| (hists->socket_filter > -1);
268397cb NK	190	}
268397cb NK	191
316c7136 ACM	192	u16 hists__col_len(struct hists *hists, enum hist_column col);
	193	void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len);
	194	bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len);
7ccf4f90 NK	195	void hists__reset_col_len(struct hists *hists);
7ccf4f90 NK	196	void hists__calc_col_len(struct hists hists, struct hist_entry he);
8a6c5b26	197
95529be4	198	void hists__match(struct hists leader, struct hists other);
494d70a1	199	int hists__link(struct hists leader, struct hists other);
95529be4	200
a635fc51 ACM	201	struct hists_evsel {
	202	struct perf_evsel evsel;
	203	struct hists hists;
	204	};
	205
	206	static inline struct perf_evsel hists_to_evsel(struct hists hists)
	207	{
	208	struct hists_evsel *hevsel = container_of(hists, struct hists_evsel, hists);
	209	return &hevsel->evsel;
	210	}
	211
	212	static inline struct hists evsel__hists(struct perf_evsel evsel)
	213	{
	214	struct hists_evsel hevsel = (struct hists_evsel )evsel;
	215	return &hevsel->hists;
	216	}
	217
	218	int hists__init(void);
5b65855e	219	int __hists__init(struct hists hists, struct perf_hpp_list hpp_list);
fc284be9 NK	220
fc284be9 NK	221	struct rb_root hists__get_rotate_entries_in(struct hists hists);
a635fc51	222
ea251d51 NK	223	struct perf_hpp {
	224	char *buf;
	225	size_t size;
ea251d51	226	const char *sep;
ea251d51 NK	227	void *ptr;
	228	};
	229
	230	struct perf_hpp_fmt {
1ecd4453	231	const char *name;
94a0793d	232	int (header)(struct perf_hpp_fmt fmt, struct perf_hpp *hpp,
29659ab4	233	struct hists hists, int line, int span);
94a0793d	234	int (width)(struct perf_hpp_fmt fmt, struct perf_hpp *hpp,
da1b0407	235	struct hists *hists);
2c5d4b4a JO	236	int (color)(struct perf_hpp_fmt fmt, struct perf_hpp *hpp,
	237	struct hist_entry *he);
	238	int (entry)(struct perf_hpp_fmt fmt, struct perf_hpp *hpp,
	239	struct hist_entry *he);
87bbdf76 NK	240	int64_t (cmp)(struct perf_hpp_fmt fmt,
	241	struct hist_entry a, struct hist_entry b);
	242	int64_t (collapse)(struct perf_hpp_fmt fmt,
	243	struct hist_entry a, struct hist_entry b);
	244	int64_t (sort)(struct perf_hpp_fmt fmt,
	245	struct hist_entry a, struct hist_entry b);
97358084	246	bool (equal)(struct perf_hpp_fmt a, struct perf_hpp_fmt *b);
564132f3	247	void (free)(struct perf_hpp_fmt fmt);
1240005e JO	248
1240005e JO	249	struct list_head list;
8b536999	250	struct list_head sort_list;
f2998422	251	bool elide;
e0d66c74	252	int len;
5b591669	253	int user_len;
b21a763e	254	int idx;
4b633eba	255	int level;
ea251d51 NK	256	};
ea251d51 NK	257
7c31e102 JO	258	struct perf_hpp_list {
	259	struct list_head fields;
	260	struct list_head sorts;
52225036	261
f8e6710d	262	int nr_header_lines;
52225036	263	int need_collapse;
de7e6a7c	264	int parent;
2e0453af	265	int sym;
69849fc5	266	int dso;
35a634f7	267	int socket;
fa82911a	268	int thread;
7cecb7fe	269	int comm;
7c31e102 JO	270	};
	271
	272	extern struct perf_hpp_list perf_hpp_list;
1240005e	273
c3bc0c43 NK	274	struct perf_hpp_list_node {
	275	struct list_head list;
	276	struct perf_hpp_list hpp;
	277	int level;
1b2dbbf4	278	bool skip;
c3bc0c43 NK	279	};
c3bc0c43 NK	280
ebdd98e0 JO	281	void perf_hpp_list__column_register(struct perf_hpp_list *list,
	282	struct perf_hpp_fmt *format);
	283	void perf_hpp_list__register_sort_field(struct perf_hpp_list *list,
	284	struct perf_hpp_fmt *format);
	285
	286	static inline void perf_hpp__column_register(struct perf_hpp_fmt *format)
	287	{
	288	perf_hpp_list__column_register(&perf_hpp_list, format);
	289	}
	290
	291	static inline void perf_hpp__register_sort_field(struct perf_hpp_fmt *format)
	292	{
	293	perf_hpp_list__register_sort_field(&perf_hpp_list, format);
	294	}
	295
cf094045 JO	296	#define perf_hpp_list__for_each_format(_list, format) \
cf094045 JO	297	list_for_each_entry(format, &(_list)->fields, list)
1240005e	298
7a1799e0 JO	299	#define perf_hpp_list__for_each_format_safe(_list, format, tmp) \
7a1799e0 JO	300	list_for_each_entry_safe(format, tmp, &(_list)->fields, list)
1c89fe9b	301
d29a4970 JO	302	#define perf_hpp_list__for_each_sort_list(_list, format) \
d29a4970 JO	303	list_for_each_entry(format, &(_list)->sorts, sort_list)
8b536999	304
1a8ebd24 JO	305	#define perf_hpp_list__for_each_sort_list_safe(_list, format, tmp) \
1a8ebd24 JO	306	list_for_each_entry_safe(format, tmp, &(_list)->sorts, sort_list)
1c89fe9b	307
f0786af5 JO	308	#define hists__for_each_format(hists, format) \
	309	perf_hpp_list__for_each_format((hists)->hpp_list, fmt)
	310
aa6f50af JO	311	#define hists__for_each_sort_list(hists, format) \
	312	perf_hpp_list__for_each_sort_list((hists)->hpp_list, fmt)
	313
ea251d51 NK	314	extern struct perf_hpp_fmt perf_hpp__format[];
	315
	316	enum {
345dc0b4	317	/* Matches perf_hpp__format array. */
ea251d51 NK	318	PERF_HPP__OVERHEAD,
	319	PERF_HPP__OVERHEAD_SYS,
	320	PERF_HPP__OVERHEAD_US,
	321	PERF_HPP__OVERHEAD_GUEST_SYS,
	322	PERF_HPP__OVERHEAD_GUEST_US,
594dcbf3	323	PERF_HPP__OVERHEAD_ACC,
ea251d51 NK	324	PERF_HPP__SAMPLES,
ea251d51 NK	325	PERF_HPP__PERIOD,
ea251d51 NK	326
	327	PERF_HPP__MAX_INDEX
	328	};
	329
1d77822e	330	void perf_hpp__init(void);
77284de3	331	void perf_hpp__column_unregister(struct perf_hpp_fmt *format);
77284de3	332	void perf_hpp__cancel_cumulate(void);
43e0a68f JO	333	void perf_hpp__setup_output_field(struct perf_hpp_list *list);
	334	void perf_hpp__reset_output_field(struct perf_hpp_list *list);
	335	void perf_hpp__append_sort_keys(struct perf_hpp_list *list);
c3bc0c43 NK	336	int perf_hpp__setup_hists_formats(struct perf_hpp_list *list,
c3bc0c43 NK	337	struct perf_evlist *evlist);
43e0a68f	338
a7d945bc NK	339
a7d945bc NK	340	bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format);
361459f1 NK	341	bool perf_hpp__is_dynamic_entry(struct perf_hpp_fmt *format);
361459f1 NK	342	bool perf_hpp__defined_dynamic_entry(struct perf_hpp_fmt fmt, struct hists hists);
a9c6e46c NK	343	bool perf_hpp__is_trace_entry(struct perf_hpp_fmt *fmt);
	344	bool perf_hpp__is_srcline_entry(struct perf_hpp_fmt *fmt);
	345	bool perf_hpp__is_srcfile_entry(struct perf_hpp_fmt *fmt);
4945cf2a NK	346	bool perf_hpp__is_thread_entry(struct perf_hpp_fmt *fmt);
	347	bool perf_hpp__is_comm_entry(struct perf_hpp_fmt *fmt);
	348	bool perf_hpp__is_dso_entry(struct perf_hpp_fmt *fmt);
	349	bool perf_hpp__is_sym_entry(struct perf_hpp_fmt *fmt);
f2998422	350
c3bc0c43 NK	351	struct perf_hpp_fmt perf_hpp_fmt__dup(struct perf_hpp_fmt fmt);
c3bc0c43 NK	352
54430101 NK	353	int hist_entry__filter(struct hist_entry he, int type, const void arg);
54430101 NK	354
361459f1 NK	355	static inline bool perf_hpp__should_skip(struct perf_hpp_fmt *format,
361459f1 NK	356	struct hists *hists)
f2998422	357	{
361459f1 NK	358	if (format->elide)
	359	return true;
	360
	361	if (perf_hpp__is_dynamic_entry(format) &&
	362	!perf_hpp__defined_dynamic_entry(format, hists))
	363	return true;
	364
	365	return false;
f2998422 JO	366	}
f2998422 JO	367
678a500d	368	void perf_hpp__reset_width(struct perf_hpp_fmt fmt, struct hists hists);
e0d66c74	369	void perf_hpp__reset_sort_width(struct perf_hpp_fmt fmt, struct hists hists);
5b591669	370	void perf_hpp__set_user_width(const char *width_list_str);
ea251d51	371
2f6d9009 NK	372	typedef u64 (hpp_field_fn)(struct hist_entry he);
2f6d9009 NK	373	typedef int (hpp_callback_fn)(struct perf_hpp hpp, bool front);
a0088adc	374	typedef int (hpp_snprint_fn)(struct perf_hpp hpp, const char *fmt, ...);
4a62109f	375
5b591669 NK	376	int hpp__fmt(struct perf_hpp_fmt fmt, struct perf_hpp hpp,
	377	struct hist_entry *he, hpp_field_fn get_field,
	378	const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
	379	int hpp__fmt_acc(struct perf_hpp_fmt fmt, struct perf_hpp hpp,
	380	struct hist_entry *he, hpp_field_fn get_field,
	381	const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
4a62109f	382
a0088adc NK	383	static inline void advance_hpp(struct perf_hpp *hpp, int inc)
	384	{
	385	hpp->buf += inc;
	386	hpp->size -= inc;
	387	}
	388
9754c4f9 JO	389	static inline size_t perf_hpp__use_color(void)
	390	{
	391	return !symbol_conf.field_sep;
	392	}
	393
	394	static inline size_t perf_hpp__color_overhead(void)
	395	{
	396	return perf_hpp__use_color() ?
	397	(COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX
	398	: 0;
	399	}
	400
e248de33 ACM	401	struct perf_evlist;
e248de33 ACM	402
9783adf7 NK	403	struct hist_browser_timer {
	404	void (timer)(void arg);
	405	void *arg;
	406	int refresh;
	407	};
	408
89fe808a	409	#ifdef HAVE_SLANG_SUPPORT
1254b51e	410	#include "../ui/keysyms.h"
d5dbc518 ACM	411	int map_symbol__tui_annotate(struct map_symbol ms, struct perf_evsel evsel,
	412	struct hist_browser_timer *hbt);
	413
db8fd07a	414	int hist_entry__tui_annotate(struct hist_entry he, struct perf_evsel evsel,
9783adf7	415	struct hist_browser_timer *hbt);
1254b51e NK	416
1254b51e NK	417	int perf_evlist__tui_browse_hists(struct perf_evlist evlist, const char help,
68d80758	418	struct hist_browser_timer *hbt,
064f1981	419	float min_pcnt,
ce80d3be	420	struct perf_env *env);
66517826	421	int script_browse(const char *script_opt);
1254b51e	422	#else
7f0030b2	423	static inline
1d037ca1 IT	424	int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
1d037ca1 IT	425	const char *help __maybe_unused,
68d80758	426	struct hist_browser_timer *hbt __maybe_unused,
064f1981	427	float min_pcnt __maybe_unused,
ce80d3be	428	struct perf_env *env __maybe_unused)
d67f088e ACM	429	{
	430	return 0;
	431	}
d5dbc518 ACM	432	static inline int map_symbol__tui_annotate(struct map_symbol *ms __maybe_unused,
	433	struct perf_evsel *evsel __maybe_unused,
	434	struct hist_browser_timer *hbt __maybe_unused)
	435	{
	436	return 0;
	437	}
d67f088e	438
316c7136 ACM	439	static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused,
	440	struct perf_evsel *evsel __maybe_unused,
	441	struct hist_browser_timer *hbt __maybe_unused)
46e3e055 ACM	442	{
	443	return 0;
	444	}
66517826	445
4f746c95	446	static inline int script_browse(const char *script_opt __maybe_unused)
66517826 FT	447	{
	448	return 0;
	449	}
	450
1e825efb ME	451	#define K_LEFT -1000
1e825efb ME	452	#define K_RIGHT -2000
5f7439e0	453	#define K_SWITCH_INPUT_DATA -3000
b09e0190	454	#endif
06daaaba	455
316c7136	456	unsigned int hists__sort_list_width(struct hists *hists);
a7b5895b	457	unsigned int hists__overhead_width(struct hists *hists);
33db4568	458
57849998 AK	459	void hist__account_cycles(struct branch_stack bs, struct addr_location al,
	460	struct perf_sample *sample, bool nonany_branch_mode);
	461
33db4568	462	struct option;
b8f8eb84	463	int parse_filter_percentage(const struct option opt, const char arg, int unset);
0b93da17	464	int perf_hist_config(const char var, const char value);
33db4568	465
94b3dc38 JO	466	void perf_hpp_list__init(struct perf_hpp_list *list);
94b3dc38 JO	467
8c01872f NK	468	enum hierarchy_move_dir {
	469	HMD_NORMAL,
	470	HMD_FORCE_SIBLING,
	471	HMD_FORCE_CHILD,
	472	};
	473
	474	struct rb_node rb_hierarchy_last(struct rb_node node);
	475	struct rb_node __rb_hierarchy_next(struct rb_node node,
	476	enum hierarchy_move_dir hmd);
	477	struct rb_node rb_hierarchy_prev(struct rb_node node);
	478
	479	static inline struct rb_node rb_hierarchy_next(struct rb_node node)
	480	{
	481	return __rb_hierarchy_next(node, HMD_NORMAL);
	482	}
	483
ef86d68a NK	484	#define HIERARCHY_INDENT 3
ef86d68a NK	485
a7b5895b NK	486	bool hist_entry__has_hierarchy_children(struct hist_entry *he, float limit);
a7b5895b NK	487
3d1d07ec	488	#endif /* __PERF_HIST_H */