[thirdparty/linux.git] / tools / perf / util / annotate.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __PERF_ANNOTATE_H
#define __PERF_ANNOTATE_H

#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <linux/types.h>
#include <linux/list.h>
#include <linux/rbtree.h>
#include <pthread.h>
#include <asm/bug.h>
#include "symbol_conf.h"

struct hist_browser_timer;
struct hist_entry;
struct ins_ops;
struct map;
struct map_symbol;
struct addr_map_symbol;
struct option;
struct perf_sample;
struct perf_evsel;
struct symbol;

struct ins {
	const char     *name;
	struct ins_ops *ops;
};

struct ins_operands {
	char	*raw;
	char	*raw_comment;
	struct {
		char	*raw;
		char	*name;
		struct symbol *sym;
		u64	addr;
		s64	offset;
		bool	offset_avail;
		bool	outside;
	} target;
	union {
		struct {
			char	*raw;
			char	*name;
			u64	addr;
		} source;
		struct {
			struct ins	    ins;
			struct ins_operands *ops;
		} locked;
	};
};

struct arch;

struct ins_ops {
	void (*free)(struct ins_operands *ops);
	int (*parse)(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms);
	int (*scnprintf)(struct ins *ins, char *bf, size_t size,
			 struct ins_operands *ops, int max_ins_name);
};

bool ins__is_jump(const struct ins *ins);
bool ins__is_call(const struct ins *ins);
bool ins__is_ret(const struct ins *ins);
bool ins__is_lock(const struct ins *ins);
int ins__scnprintf(struct ins *ins, char *bf, size_t size, struct ins_operands *ops, int max_ins_name);
bool ins__is_fused(struct arch *arch, const char *ins1, const char *ins2);

#define ANNOTATION__IPC_WIDTH 6
#define ANNOTATION__CYCLES_WIDTH 6
#define ANNOTATION__MINMAX_CYCLES_WIDTH 19
#define ANNOTATION__AVG_IPC_WIDTH 36

struct annotation_options {
	bool hide_src_code,
	     use_offset,
	     jump_arrows,
	     print_lines,
	     full_path,
	     show_linenr,
	     show_nr_jumps,
	     show_nr_samples,
	     show_total_period,
	     show_minmax_cycle,
	     show_asm_raw,
	     annotate_src;
	u8   offset_level;
	int  min_pcnt;
	int  max_lines;
	int  context;
	const char *objdump_path;
	const char *disassembler_style;
	unsigned int percent_type;
};

enum {
	ANNOTATION__OFFSET_JUMP_TARGETS = 1,
	ANNOTATION__OFFSET_CALL,
	ANNOTATION__MAX_OFFSET_LEVEL,
};

#define ANNOTATION__MIN_OFFSET_LEVEL ANNOTATION__OFFSET_JUMP_TARGETS

extern struct annotation_options annotation__default_options;

struct annotation;

struct sym_hist_entry {
	u64		nr_samples;
	u64		period;
};

enum {
	PERCENT_HITS_LOCAL,
	PERCENT_HITS_GLOBAL,
	PERCENT_PERIOD_LOCAL,
	PERCENT_PERIOD_GLOBAL,
	PERCENT_MAX,
};

struct annotation_data {
	double			 percent[PERCENT_MAX];
	double			 percent_sum;
	struct sym_hist_entry	 he;
};

struct annotation_line {
	struct list_head	 node;
	struct rb_node		 rb_node;
	s64			 offset;
	char			*line;
	int			 line_nr;
	int			 jump_sources;
	float			 ipc;
	u64			 cycles;
	u64			 cycles_max;
	u64			 cycles_min;
	size_t			 privsize;
	char			*path;
	u32			 idx;
	int			 idx_asm;
	int			 data_nr;
	struct annotation_data	 data[0];
};

struct disasm_line {
	struct ins		 ins;
	struct ins_operands	 ops;

	/* This needs to be at the end. */
	struct annotation_line	 al;
};

static inline double annotation_data__percent(struct annotation_data *data,
					      unsigned int which)
{
	return which < PERCENT_MAX ? data->percent[which] : -1;
}

static inline const char *percent_type_str(unsigned int type)
{
	static const char *str[PERCENT_MAX] = {
		"local hits",
		"global hits",
		"local period",
		"global period",
	};

	if (WARN_ON(type >= PERCENT_MAX))
		return "N/A";

	return str[type];
}

static inline struct disasm_line *disasm_line(struct annotation_line *al)
{
	return al ? container_of(al, struct disasm_line, al) : NULL;
}

/*
 * Is this offset in the same function as the line it is used?
 * asm functions jump to other functions, for instance.
 */
static inline bool disasm_line__has_local_offset(const struct disasm_line *dl)
{
	return dl->ops.target.offset_avail && !dl->ops.target.outside;
}

/*
 * Can we draw an arrow from the jump to its target, for instance? I.e.
 * is the jump and its target in the same function?
 */
bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym);

void disasm_line__free(struct disasm_line *dl);
struct annotation_line *
annotation_line__next(struct annotation_line *pos, struct list_head *head);

struct annotation_write_ops {
	bool first_line, current_entry, change_color;
	int  width;
	void *obj;
	int  (*set_color)(void *obj, int color);
	void (*set_percent_color)(void *obj, double percent, bool current);
	int  (*set_jumps_percent_color)(void *obj, int nr, bool current);
	void (*printf)(void *obj, const char *fmt, ...);
	void (*write_graph)(void *obj, int graph);
};

void annotation_line__write(struct annotation_line *al, struct annotation *notes,
			    struct annotation_write_ops *ops,
			    struct annotation_options *opts);

int __annotation__scnprintf_samples_period(struct annotation *notes,
					   char *bf, size_t size,
					   struct perf_evsel *evsel,
					   bool show_freq);

int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw, int max_ins_name);
size_t disasm__fprintf(struct list_head *head, FILE *fp);
void symbol__calc_percent(struct symbol *sym, struct perf_evsel *evsel);

struct sym_hist {
	u64		      nr_samples;
	u64		      period;
	struct sym_hist_entry addr[0];
};

struct cyc_hist {
	u64	start;
	u64	cycles;
	u64	cycles_aggr;
	u64	cycles_max;
	u64	cycles_min;
	u32	num;
	u32	num_aggr;
	u8	have_start;
	/* 1 byte padding */
	u16	reset;
};

/** struct annotated_source - symbols with hits have this attached as in sannotation
 *
 * @histograms: Array of addr hit histograms per event being monitored
 * nr_histograms: This may not be the same as evsel->evlist->nr_entries if
 * 		  we have more than a group in a evlist, where we will want
 * 		  to see each group separately, that is why symbol__annotate2()
 * 		  sets src->nr_histograms to evsel->nr_members.
 * @lines: If 'print_lines' is specified, per source code line percentages
 * @source: source parsed from a disassembler like objdump -dS
 * @cyc_hist: Average cycles per basic block
 *
 * lines is allocated, percentages calculated and all sorted by percentage
 * when the annotation is about to be presented, so the percentages are for
 * one of the entries in the histogram array, i.e. for the event/counter being
 * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate
 * returns.
 */
struct annotated_source {
	struct list_head   source;
	int    		   nr_histograms;
	size_t		   sizeof_sym_hist;
	struct cyc_hist	   *cycles_hist;
	struct sym_hist	   *histograms;
};

struct annotation {
	pthread_mutex_t		lock;
	u64			max_coverage;
	u64			start;
	u64			hit_cycles;
	u64			hit_insn;
	unsigned int		total_insn;
	unsigned int		cover_insn;
	struct annotation_options *options;
	struct annotation_line	**offsets;
	int			nr_events;
	int			nr_jumps;
	int			max_jump_sources;
	int			nr_entries;
	int			nr_asm_entries;
	u16			max_line_len;
	struct {
		u8		addr;
		u8		jumps;
		u8		target;
		u8		min_addr;
		u8		max_addr;
		u8		max_ins_name;
	} widths;
	bool			have_cycles;
	struct annotated_source *src;
};

static inline int annotation__cycles_width(struct annotation *notes)
{
	if (notes->have_cycles && notes->options->show_minmax_cycle)
		return ANNOTATION__IPC_WIDTH + ANNOTATION__MINMAX_CYCLES_WIDTH;

	return notes->have_cycles ? ANNOTATION__IPC_WIDTH + ANNOTATION__CYCLES_WIDTH : 0;
}

static inline int annotation__pcnt_width(struct annotation *notes)
{
	return (notes->options->show_total_period ? 12 : 7) * notes->nr_events;
}

static inline bool annotation_line__filter(struct annotation_line *al, struct annotation *notes)
{
	return notes->options->hide_src_code && al->offset == -1;
}

void annotation__set_offsets(struct annotation *notes, s64 size);
void annotation__compute_ipc(struct annotation *notes, size_t size);
void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym);
void annotation__update_column_widths(struct annotation *notes);
void annotation__init_column_widths(struct annotation *notes, struct symbol *sym);

static inline struct sym_hist *annotated_source__histogram(struct annotated_source *src, int idx)
{
	return ((void *)src->histograms) + (src->sizeof_sym_hist * idx);
}

static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
{
	return annotated_source__histogram(notes->src, idx);
}

static inline struct annotation *symbol__annotation(struct symbol *sym)
{
	return (void *)sym - symbol_conf.priv_size;
}

int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample,
				 struct perf_evsel *evsel);

int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
				    struct addr_map_symbol *start,
				    unsigned cycles);

int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample,
				 struct perf_evsel *evsel, u64 addr);

struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists);
void symbol__annotate_zero_histograms(struct symbol *sym);

int symbol__annotate(struct symbol *sym, struct map *map,
		     struct perf_evsel *evsel, size_t privsize,
		     struct annotation_options *options,
		     struct arch **parch);
int symbol__annotate2(struct symbol *sym, struct map *map,
		      struct perf_evsel *evsel,
		      struct annotation_options *options,
		      struct arch **parch);

enum symbol_disassemble_errno {
	SYMBOL_ANNOTATE_ERRNO__SUCCESS		= 0,

	/*
	 * Choose an arbitrary negative big number not to clash with standard
	 * errno since SUS requires the errno has distinct positive values.
	 * See 'Issue 6' in the link below.
	 *
	 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
	 */
	__SYMBOL_ANNOTATE_ERRNO__START		= -10000,

	SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX	= __SYMBOL_ANNOTATE_ERRNO__START,
	SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF,

	__SYMBOL_ANNOTATE_ERRNO__END,
};

int symbol__strerror_disassemble(struct symbol *sym, struct map *map,
				 int errnum, char *buf, size_t buflen);

int symbol__annotate_printf(struct symbol *sym, struct map *map,
			    struct perf_evsel *evsel,
			    struct annotation_options *options);
void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
void symbol__annotate_decay_histogram(struct symbol *sym, int evidx);
void annotated_source__purge(struct annotated_source *as);

int map_symbol__annotation_dump(struct map_symbol *ms, struct perf_evsel *evsel,
				struct annotation_options *opts);

bool ui__has_annotation(void);

int symbol__tty_annotate(struct symbol *sym, struct map *map,
			 struct perf_evsel *evsel, struct annotation_options *opts);

int symbol__tty_annotate2(struct symbol *sym, struct map *map,
			  struct perf_evsel *evsel, struct annotation_options *opts);

#ifdef HAVE_SLANG_SUPPORT
int symbol__tui_annotate(struct symbol *sym, struct map *map,
			 struct perf_evsel *evsel,
			 struct hist_browser_timer *hbt,
			 struct annotation_options *opts);
#else
static inline int symbol__tui_annotate(struct symbol *sym __maybe_unused,
				struct map *map __maybe_unused,
				struct perf_evsel *evsel  __maybe_unused,
				struct hist_browser_timer *hbt __maybe_unused,
				struct annotation_options *opts __maybe_unused)
{
	return 0;
}
#endif

void annotation_config__init(void);

int annotate_parse_percent_type(const struct option *opt, const char *_str,
				int unset);
#endif	/* __PERF_ANNOTATE_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
78f7defe ACM	2	#ifndef __PERF_ANNOTATE_H
	3	#define __PERF_ANNOTATE_H
	4
	5	#include <stdbool.h>
fb29fa58	6	#include <stdint.h>
8a249c73	7	#include <stdio.h>
d944c4ee	8	#include <linux/types.h>
78f7defe ACM	9	#include <linux/list.h>
78f7defe ACM	10	#include <linux/rbtree.h>
27683dc5	11	#include <pthread.h>
3e0d7953	12	#include <asm/bug.h>
8a249c73	13	#include "symbol_conf.h"
78f7defe	14
8a249c73 ACM	15	struct hist_browser_timer;
8a249c73 ACM	16	struct hist_entry;
75b49202	17	struct ins_ops;
8a249c73 ACM	18	struct map;
	19	struct map_symbol;
	20	struct addr_map_symbol;
	21	struct option;
	22	struct perf_sample;
	23	struct perf_evsel;
	24	struct symbol;
75b49202 ACM	25
	26	struct ins {
	27	const char *name;
	28	struct ins_ops *ops;
	29	};
28548d78	30
c7e6ead7 ACM	31	struct ins_operands {
c7e6ead7 ACM	32	char *raw;
4e67b2a5	33	char *raw_comment;
44d1a3ed	34	struct {
6de783b6	35	char *raw;
44d1a3ed	36	char *name;
696703af	37	struct symbol *sym;
44d1a3ed	38	u64 addr;
e216874c RB	39	s64 offset;
e216874c RB	40	bool offset_avail;
751b1783	41	bool outside;
44d1a3ed	42	} target;
7a997fe4 ACM	43	union {
	44	struct {
	45	char *raw;
	46	char *name;
	47	u64 addr;
	48	} source;
	49	struct {
75b49202	50	struct ins ins;
7a997fe4 ACM	51	struct ins_operands *ops;
	52	} locked;
	53	};
c7e6ead7 ACM	54	};
c7e6ead7 ACM	55
786c1b51 ACM	56	struct arch;
786c1b51 ACM	57
4f9d0325	58	struct ins_ops {
c46219ac	59	void (free)(struct ins_operands ops);
85a84e4f	60	int (parse)(struct arch arch, struct ins_operands ops, struct map_symbol ms);
28548d78	61	int (scnprintf)(struct ins ins, char *bf, size_t size,
bc3bb795	62	struct ins_operands *ops, int max_ins_name);
4f9d0325 ACM	63	};
4f9d0325 ACM	64
4f9d0325	65	bool ins__is_jump(const struct ins *ins);
d86b0597	66	bool ins__is_call(const struct ins *ins);
6ef94929	67	bool ins__is_ret(const struct ins *ins);
7e63a13a	68	bool ins__is_lock(const struct ins *ins);
bc3bb795	69	int ins__scnprintf(struct ins ins, char bf, size_t size, struct ins_operands *ops, int max_ins_name);
69fb09f6	70	bool ins__is_fused(struct arch arch, const char ins1, const char *ins2);
4f9d0325	71
c426e584 ACM	72	#define ANNOTATION__IPC_WIDTH 6
c426e584 ACM	73	#define ANNOTATION__CYCLES_WIDTH 6
3e71fc03	74	#define ANNOTATION__MINMAX_CYCLES_WIDTH 19
ace4f8fa	75	#define ANNOTATION__AVG_IPC_WIDTH 36
c426e584	76
98bc80b0 ACM	77	struct annotation_options {
	78	bool hide_src_code,
	79	use_offset,
	80	jump_arrows,
982d410b ACM	81	print_lines,
982d410b ACM	82	full_path,
98bc80b0 ACM	83	show_linenr,
	84	show_nr_jumps,
	85	show_nr_samples,
3e71fc03	86	show_total_period,
1eddd9e4 ACM	87	show_minmax_cycle,
	88	show_asm_raw,
	89	annotate_src;
592c10e2	90	u8 offset_level;
982d410b ACM	91	int min_pcnt;
	92	int max_lines;
	93	int context;
f178fd2d	94	const char *objdump_path;
a47e843e	95	const char *disassembler_style;
796ca33d	96	unsigned int percent_type;
98bc80b0 ACM	97	};
98bc80b0 ACM	98
592c10e2 ACM	99	enum {
	100	ANNOTATION__OFFSET_JUMP_TARGETS = 1,
	101	ANNOTATION__OFFSET_CALL,
	102	ANNOTATION__MAX_OFFSET_LEVEL,
	103	};
	104
	105	#define ANNOTATION__MIN_OFFSET_LEVEL ANNOTATION__OFFSET_JUMP_TARGETS
	106
7f0b6fde ACM	107	extern struct annotation_options annotation__default_options;
7f0b6fde ACM	108
e64aa75b NK	109	struct annotation;
e64aa75b NK	110
7e304557 JO	111	struct sym_hist_entry {
	112	u64 nr_samples;
	113	u64 period;
	114	};
	115
6d9f0c2d JO	116	enum {
6d9f0c2d JO	117	PERCENT_HITS_LOCAL,
75a8c1ff	118	PERCENT_HITS_GLOBAL,
ab371169	119	PERCENT_PERIOD_LOCAL,
e58684df	120	PERCENT_PERIOD_GLOBAL,
6d9f0c2d JO	121	PERCENT_MAX,
	122	};
	123
7e304557	124	struct annotation_data {
6d9f0c2d	125	double percent[PERCENT_MAX];
8b4c74dc	126	double percent_sum;
7e304557 JO	127	struct sym_hist_entry he;
	128	};
	129
a17c4ca0 JO	130	struct annotation_line {
a17c4ca0 JO	131	struct list_head node;
5b12adc8	132	struct rb_node rb_node;
d5490b96 JO	133	s64 offset;
	134	char *line;
	135	int line_nr;
0db45bcf	136	int jump_sources;
37236d5e JO	137	float ipc;
37236d5e JO	138	u64 cycles;
48659ebf JY	139	u64 cycles_max;
48659ebf JY	140	u64 cycles_min;
c835e191	141	size_t privsize;
8b4c74dc	142	char *path;
4850c92e ACM	143	u32 idx;
4850c92e ACM	144	int idx_asm;
c2f938ba JO	145	int data_nr;
c2f938ba JO	146	struct annotation_data data[0];
a17c4ca0 JO	147	};
a17c4ca0 JO	148
29ed6e76	149	struct disasm_line {
a17c4ca0	150	struct ins ins;
a17c4ca0	151	struct ins_operands ops;
c835e191 JO	152
	153	/* This needs to be at the end. */
	154	struct annotation_line al;
78f7defe ACM	155	};
78f7defe ACM	156
6d9f0c2d JO	157	static inline double annotation_data__percent(struct annotation_data *data,
	158	unsigned int which)
	159	{
	160	return which < PERCENT_MAX ? data->percent[which] : -1;
	161	}
	162
3e0d7953 JO	163	static inline const char *percent_type_str(unsigned int type)
	164	{
	165	static const char *str[PERCENT_MAX] = {
	166	"local hits",
	167	"global hits",
	168	"local period",
	169	"global period",
	170	};
	171
	172	if (WARN_ON(type >= PERCENT_MAX))
	173	return "N/A";
	174
	175	return str[type];
	176	}
	177
c835e191 JO	178	static inline struct disasm_line disasm_line(struct annotation_line al)
	179	{
	180	return al ? container_of(al, struct disasm_line, al) : NULL;
	181	}
	182
2eff0611 ACM	183	/*
	184	* Is this offset in the same function as the line it is used?
	185	* asm functions jump to other functions, for instance.
	186	*/
	187	static inline bool disasm_line__has_local_offset(const struct disasm_line *dl)
fb29fa58	188	{
2eff0611	189	return dl->ops.target.offset_avail && !dl->ops.target.outside;
fb29fa58 ACM	190	}
fb29fa58 ACM	191
2eff0611 ACM	192	/*
	193	* Can we draw an arrow from the jump to its target, for instance? I.e.
	194	* is the jump and its target in the same function?
	195	*/
	196	bool disasm_line__is_valid_local_jump(struct disasm_line dl, struct symbol sym);
0db45bcf	197
29ed6e76	198	void disasm_line__free(struct disasm_line *dl);
c4c72436 JO	199	struct annotation_line *
c4c72436 JO	200	annotation_line__next(struct annotation_line pos, struct list_head head);
2f025ea0	201
c298304b ACM	202	struct annotation_write_ops {
	203	bool first_line, current_entry, change_color;
	204	int width;
	205	void *obj;
	206	int (set_color)(void obj, int color);
	207	void (set_percent_color)(void obj, double percent, bool current);
	208	int (set_jumps_percent_color)(void obj, int nr, bool current);
	209	void (printf)(void obj, const char *fmt, ...);
	210	void (write_graph)(void obj, int graph);
	211	};
	212
a1e9b74c	213	void annotation_line__write(struct annotation_line al, struct annotation notes,
4c650ddc JO	214	struct annotation_write_ops *ops,
4c650ddc JO	215	struct annotation_options *opts);
2f025ea0	216
b213eac2 ACM	217	int __annotation__scnprintf_samples_period(struct annotation *notes,
	218	char *bf, size_t size,
	219	struct perf_evsel *evsel,
	220	bool show_freq);
	221
bc3bb795	222	int disasm_line__scnprintf(struct disasm_line dl, char bf, size_t size, bool raw, int max_ins_name);
5145418b	223	size_t disasm__fprintf(struct list_head head, FILE fp);
9e4e0a9d	224	void symbol__calc_percent(struct symbol sym, struct perf_evsel evsel);
78f7defe ACM	225
78f7defe ACM	226	struct sym_hist {
8158683d	227	u64 nr_samples;
461c17f0	228	u64 period;
896bccd3	229	struct sym_hist_entry addr[0];
78f7defe ACM	230	};
78f7defe ACM	231
d4957633 AK	232	struct cyc_hist {
	233	u64 start;
	234	u64 cycles;
	235	u64 cycles_aggr;
48659ebf JY	236	u64 cycles_max;
48659ebf JY	237	u64 cycles_min;
d4957633 AK	238	u32 num;
	239	u32 num_aggr;
	240	u8 have_start;
	241	/* 1 byte padding */
	242	u16 reset;
	243	};
	244
ce6f4fab	245	/** struct annotated_source - symbols with hits have this attached as in sannotation
2f525d01	246	*
116c626b	247	* @histograms: Array of addr hit histograms per event being monitored
9132d3d9 ACM	248	* nr_histograms: This may not be the same as evsel->evlist->nr_entries if
	249	* we have more than a group in a evlist, where we will want
	250	* to see each group separately, that is why symbol__annotate2()
	251	* sets src->nr_histograms to evsel->nr_members.
ce6f4fab	252	* @lines: If 'print_lines' is specified, per source code line percentages
29ed6e76	253	* @source: source parsed from a disassembler like objdump -dS
d4957633	254	* @cyc_hist: Average cycles per basic block
2f525d01	255	*
ce6f4fab	256	* lines is allocated, percentages calculated and all sorted by percentage
2f525d01 ACM	257	* when the annotation is about to be presented, so the percentages are for
	258	* one of the entries in the histogram array, i.e. for the event/counter being
	259	* presented. It is deallocated right after symbol__{tui,tty,etc}_annotate
	260	* returns.
	261	*/
ce6f4fab ACM	262	struct annotated_source {
ce6f4fab ACM	263	struct list_head source;
36532461	264	int nr_histograms;
5ec4502d	265	size_t sizeof_sym_hist;
d4957633	266	struct cyc_hist *cycles_hist;
116c626b	267	struct sym_hist *histograms;
ce6f4fab ACM	268	};
	269
	270	struct annotation {
	271	pthread_mutex_t lock;
70fbe057	272	u64 max_coverage;
0ca693b3	273	u64 start;
ace4f8fa JY	274	u64 hit_cycles;
	275	u64 hit_insn;
	276	unsigned int total_insn;
	277	unsigned int cover_insn;
16932d77	278	struct annotation_options *options;
9d6bb41d	279	struct annotation_line **offsets;
0553e83d	280	int nr_events;
6dcd57e8	281	int nr_jumps;
bc1c0f3d	282	int max_jump_sources;
1cf5f98a ACM	283	int nr_entries;
1cf5f98a ACM	284	int nr_asm_entries;
5bc49f61	285	u16 max_line_len;
9761e86e ACM	286	struct {
	287	u8 addr;
	288	u8 jumps;
	289	u8 target;
	290	u8 min_addr;
	291	u8 max_addr;
bc3bb795	292	u8 max_ins_name;
9761e86e	293	} widths;
0e83a7e9	294	bool have_cycles;
ce6f4fab	295	struct annotated_source *src;
78f7defe ACM	296	};
78f7defe ACM	297
0e83a7e9 ACM	298	static inline int annotation__cycles_width(struct annotation *notes)
0e83a7e9 ACM	299	{
3e71fc03 JY	300	if (notes->have_cycles && notes->options->show_minmax_cycle)
	301	return ANNOTATION__IPC_WIDTH + ANNOTATION__MINMAX_CYCLES_WIDTH;
	302
0e83a7e9 ACM	303	return notes->have_cycles ? ANNOTATION__IPC_WIDTH + ANNOTATION__CYCLES_WIDTH : 0;
	304	}
	305
6af612d2 ACM	306	static inline int annotation__pcnt_width(struct annotation *notes)
	307	{
	308	return (notes->options->show_total_period ? 12 : 7) * notes->nr_events;
	309	}
	310
9b80d1f9 ACM	311	static inline bool annotation_line__filter(struct annotation_line al, struct annotation notes)
	312	{
	313	return notes->options->hide_src_code && al->offset == -1;
	314	}
5bc49f61 ACM	315
5bc49f61 ACM	316	void annotation__set_offsets(struct annotation *notes, s64 size);
f56c083b	317	void annotation__compute_ipc(struct annotation *notes, size_t size);
0db45bcf	318	void annotation__mark_jump_targets(struct annotation notes, struct symbol sym);
7232bf7a	319	void annotation__update_column_widths(struct annotation *notes);
b8b0d819	320	void annotation__init_column_widths(struct annotation notes, struct symbol sym);
f56c083b	321
e1a91a83 ACM	322	static inline struct sym_hist annotated_source__histogram(struct annotated_source src, int idx)
	323	{
	324	return ((void )src->histograms) + (src->sizeof_sym_hist idx);
	325	}
	326
2f525d01 ACM	327	static inline struct sym_hist annotation__histogram(struct annotation notes, int idx)
2f525d01 ACM	328	{
e1a91a83	329	return annotated_source__histogram(notes->src, idx);
2f525d01 ACM	330	}
2f525d01 ACM	331
78f7defe ACM	332	static inline struct annotation symbol__annotation(struct symbol sym)
78f7defe ACM	333	{
813ccd15	334	return (void *)sym - symbol_conf.priv_size;
78f7defe ACM	335	}
78f7defe ACM	336
bab89f6a	337	int addr_map_symbol__inc_samples(struct addr_map_symbol ams, struct perf_sample sample,
e345f3bd	338	struct perf_evsel *evsel);
0f4e7a24	339
d4957633 AK	340	int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
	341	struct addr_map_symbol *start,
	342	unsigned cycles);
	343
bab89f6a	344	int hist_entry__inc_addr_samples(struct hist_entry he, struct perf_sample sample,
e345f3bd	345	struct perf_evsel *evsel, u64 addr);
f626adff	346
14c8dde1	347	struct annotated_source symbol__hists(struct symbol sym, int nr_hists);
36532461	348	void symbol__annotate_zero_histograms(struct symbol *sym);
78f7defe	349
c34df25b	350	int symbol__annotate(struct symbol sym, struct map map,
d03a686e	351	struct perf_evsel *evsel, size_t privsize,
380195e2	352	struct annotation_options *options,
5449f13c	353	struct arch **parch);
ecda45bd ACM	354	int symbol__annotate2(struct symbol sym, struct map map,
	355	struct perf_evsel *evsel,
	356	struct annotation_options *options,
	357	struct arch **parch);
f626adff	358
ee51d851 ACM	359	enum symbol_disassemble_errno {
	360	SYMBOL_ANNOTATE_ERRNO__SUCCESS = 0,
	361
	362	/*
	363	* Choose an arbitrary negative big number not to clash with standard
	364	* errno since SUS requires the errno has distinct positive values.
	365	* See 'Issue 6' in the link below.
	366	*
	367	* http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
	368	*/
	369	__SYMBOL_ANNOTATE_ERRNO__START = -10000,
	370
	371	SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX = __SYMBOL_ANNOTATE_ERRNO__START,
6987561c	372	SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF,
ee51d851 ACM	373
	374	__SYMBOL_ANNOTATE_ERRNO__END,
	375	};
	376
	377	int symbol__strerror_disassemble(struct symbol sym, struct map map,
	378	int errnum, char *buf, size_t buflen);
	379
db8fd07a	380	int symbol__annotate_printf(struct symbol sym, struct map map,
982d410b ACM	381	struct perf_evsel *evsel,
982d410b ACM	382	struct annotation_options *options);
36532461	383	void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
ce6f4fab	384	void symbol__annotate_decay_histogram(struct symbol *sym, int evidx);
f8eb37bd	385	void annotated_source__purge(struct annotated_source *as);
78f7defe	386
4c650ddc JO	387	int map_symbol__annotation_dump(struct map_symbol ms, struct perf_evsel evsel,
4c650ddc JO	388	struct annotation_options *opts);
d9bd7665	389
48c65bda NK	390	bool ui__has_annotation(void);
48c65bda NK	391
db8fd07a	392	int symbol__tty_annotate(struct symbol sym, struct map map,
982d410b	393	struct perf_evsel evsel, struct annotation_options opts);
78f7defe	394
befd2a38	395	int symbol__tty_annotate2(struct symbol sym, struct map map,
982d410b	396	struct perf_evsel evsel, struct annotation_options opts);
befd2a38	397
89fe808a	398	#ifdef HAVE_SLANG_SUPPORT
db8fd07a NK	399	int symbol__tui_annotate(struct symbol sym, struct map map,
db8fd07a NK	400	struct perf_evsel *evsel,
cd0cccba ACM	401	struct hist_browser_timer *hbt,
cd0cccba ACM	402	struct annotation_options *opts);
1254b51e	403	#else
1d037ca1	404	static inline int symbol__tui_annotate(struct symbol *sym __maybe_unused,
db8fd07a NK	405	struct map *map __maybe_unused,
db8fd07a NK	406	struct perf_evsel *evsel __maybe_unused,
cd0cccba ACM	407	struct hist_browser_timer *hbt __maybe_unused,
cd0cccba ACM	408	struct annotation_options *opts __maybe_unused)
78f7defe ACM	409	{
	410	return 0;
	411	}
78f7defe ACM	412	#endif
78f7defe ACM	413
7f0b6fde ACM	414	void annotation_config__init(void);
7f0b6fde ACM	415
88c21190 JO	416	int annotate_parse_percent_type(const struct option opt, const char _str,
88c21190 JO	417	int unset);
78f7defe	418	#endif /* __PERF_ANNOTATE_H */