[mirror_ubuntu-disco-kernel.git] / tools / perf / util / hist.h

/* SPDX-License-Identifier: GPL-2.0 */
#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,
	HIST_FILTER__C2C,
};

enum hist_column {
	HISTC_SYMBOL,
	HISTC_DSO,
	HISTC_THREAD,
	HISTC_COMM,
	HISTC_CGROUP_ID,
	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_PHYS_DADDR,
	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_SYM_SIZE,
	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);
void perf_hpp_list__prepend_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);
}

static inline void perf_hpp__prepend_sort_field(struct perf_hpp_fmt *format)
{
	perf_hpp_list__prepend_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);
void hists__reset_column_width(struct hists *hists);

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);
int hpp_color_scnprintf(struct perf_hpp *hpp, const char *fmt, ...);
int __hpp__slsmg_color_printf(struct perf_hpp *hpp, const char *fmt, ...);
int __hist_entry__snprintf(struct hist_entry *he, struct perf_hpp *hpp,
			   struct perf_hpp_list *hpp_list);
int hists__fprintf_headers(struct hists *hists, FILE *fp);

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