/* 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"#include "spark.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 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#define ANNOTATION_DUMMY_LEN	256 struct annotation_options {	bool hide_src_code,	     use_offset,	     jump_arrows,	     print_lines,	     full_path,	     show_linenr,	     show_nr_jumps,	     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;	const char *prefix;	const char *prefix_strip;	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;	char			*path;	u32			 idx;	int			 idx_asm;	int			 data_nr;	struct annotation_data	 data[];}; 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 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 evsel *evsel); struct sym_hist {	u64		      nr_samples;	u64		      period;	struct sym_hist_entry addr[];}; struct cyc_hist {	u64	start;	u64	cycles;	u64	cycles_aggr;	u64	cycles_max;	u64	cycles_min;	s64	cycles_spark[NUM_SPARKS];	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->core.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			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 (symbol_conf.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 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 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 map_symbol *ms,		     struct evsel *evsel,		     struct annotation_options *options,		     struct arch **parch);int symbol__annotate2(struct map_symbol *ms,		      struct 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__ARCH_INIT_CPUID_PARSING,	SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_REGEXP,	SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE,	SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF, 	__SYMBOL_ANNOTATE_ERRNO__END,}; int symbol__strerror_disassemble(struct map_symbol *ms, int errnum, char *buf, size_t buflen); int symbol__annotate_printf(struct map_symbol *ms, struct 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 evsel *evsel,				struct annotation_options *opts); bool ui__has_annotation(void); int symbol__tty_annotate(struct map_symbol *ms, struct evsel *evsel, struct annotation_options *opts); int symbol__tty_annotate2(struct map_symbol *ms, struct evsel *evsel, struct annotation_options *opts); #ifdef HAVE_SLANG_SUPPORTint symbol__tui_annotate(struct map_symbol *ms, struct evsel *evsel,			 struct hist_browser_timer *hbt,			 struct annotation_options *opts);#elsestatic inline int symbol__tui_annotate(struct map_symbol *ms __maybe_unused,				struct evsel *evsel  __maybe_unused,				struct hist_browser_timer *hbt __maybe_unused,				struct annotation_options *opts __maybe_unused){	return 0;}#endif void annotation_config__init(struct annotation_options *opt); int annotate_parse_percent_type(const struct option *opt, const char *_str,				int unset); int annotate_check_args(struct annotation_options *args); #endif	/* __PERF_ANNOTATE_H */