1#ifndef __PERF_ANNOTATE_H
2#define __PERF_ANNOTATE_H
3
4#include <stdbool.h>
5#include <stdint.h>
6#include <linux/types.h>
7#include "symbol.h"
8#include "hist.h"
9#include "sort.h"
10#include <linux/list.h>
11#include <linux/rbtree.h>
12#include <pthread.h>
13
14struct ins;
15
16struct ins_operands {
17	char	*raw;
18	struct {
19		char	*raw;
20		char	*name;
21		u64	addr;
22		u64	offset;
23	} target;
24	union {
25		struct {
26			char	*raw;
27			char	*name;
28			u64	addr;
29		} source;
30		struct {
31			struct ins *ins;
32			struct ins_operands *ops;
33		} locked;
34	};
35};
36
37struct ins_ops {
38	void (*free)(struct ins_operands *ops);
39	int (*parse)(struct ins_operands *ops);
40	int (*scnprintf)(struct ins *ins, char *bf, size_t size,
41			 struct ins_operands *ops);
42};
43
44struct ins {
45	const char     *name;
46	struct ins_ops *ops;
47};
48
49bool ins__is_jump(const struct ins *ins);
50bool ins__is_call(const struct ins *ins);
51int ins__scnprintf(struct ins *ins, char *bf, size_t size, struct ins_operands *ops);
52
53struct annotation;
54
55struct disasm_line {
56	struct list_head    node;
57	s64		    offset;
58	char		    *line;
59	char		    *name;
60	struct ins	    *ins;
61	int		    line_nr;
62	struct ins_operands ops;
63};
64
65static inline bool disasm_line__has_offset(const struct disasm_line *dl)
66{
67	return dl->ops.target.offset != UINT64_MAX;
68}
69
70void disasm_line__free(struct disasm_line *dl);
71struct disasm_line *disasm__get_next_ip_line(struct list_head *head, struct disasm_line *pos);
72int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw);
73size_t disasm__fprintf(struct list_head *head, FILE *fp);
74double disasm__calc_percent(struct annotation *notes, int evidx, s64 offset,
75			    s64 end, const char **path);
76
77struct sym_hist {
78	u64		sum;
79	u64		addr[0];
80};
81
82struct source_line_percent {
83	double		percent;
84	double		percent_sum;
85};
86
87struct source_line {
88	struct rb_node	node;
89	char		*path;
90	int		nr_pcnt;
91	struct source_line_percent p[1];
92};
93
94/** struct annotated_source - symbols with hits have this attached as in sannotation
95 *
96 * @histogram: Array of addr hit histograms per event being monitored
97 * @lines: If 'print_lines' is specified, per source code line percentages
98 * @source: source parsed from a disassembler like objdump -dS
99 *
100 * lines is allocated, percentages calculated and all sorted by percentage
101 * when the annotation is about to be presented, so the percentages are for
102 * one of the entries in the histogram array, i.e. for the event/counter being
103 * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate
104 * returns.
105 */
106struct annotated_source {
107	struct list_head   source;
108	struct source_line *lines;
109	int    		   nr_histograms;
110	int    		   sizeof_sym_hist;
111	struct sym_hist	   histograms[0];
112};
113
114struct annotation {
115	pthread_mutex_t		lock;
116	struct annotated_source *src;
117};
118
119static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
120{
121	return (((void *)&notes->src->histograms) +
122	 	(notes->src->sizeof_sym_hist * idx));
123}
124
125static inline struct annotation *symbol__annotation(struct symbol *sym)
126{
127	return (void *)sym - symbol_conf.priv_size;
128}
129
130int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, int evidx);
131
132int hist_entry__inc_addr_samples(struct hist_entry *he, int evidx, u64 addr);
133
134int symbol__alloc_hist(struct symbol *sym);
135void symbol__annotate_zero_histograms(struct symbol *sym);
136
137int symbol__annotate(struct symbol *sym, struct map *map, size_t privsize);
138
139int hist_entry__annotate(struct hist_entry *he, size_t privsize);
140
141int symbol__annotate_init(struct map *map __maybe_unused, struct symbol *sym);
142int symbol__annotate_printf(struct symbol *sym, struct map *map,
143			    struct perf_evsel *evsel, bool full_paths,
144			    int min_pcnt, int max_lines, int context);
145void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
146void symbol__annotate_decay_histogram(struct symbol *sym, int evidx);
147void disasm__purge(struct list_head *head);
148
149bool ui__has_annotation(void);
150
151int symbol__tty_annotate(struct symbol *sym, struct map *map,
152			 struct perf_evsel *evsel, bool print_lines,
153			 bool full_paths, int min_pcnt, int max_lines);
154
155#ifdef HAVE_SLANG_SUPPORT
156int symbol__tui_annotate(struct symbol *sym, struct map *map,
157			 struct perf_evsel *evsel,
158			 struct hist_browser_timer *hbt);
159#else
160static inline int symbol__tui_annotate(struct symbol *sym __maybe_unused,
161				struct map *map __maybe_unused,
162				struct perf_evsel *evsel  __maybe_unused,
163				struct hist_browser_timer *hbt
164				__maybe_unused)
165{
166	return 0;
167}
168#endif
169
170extern const char	*disassembler_style;
171
172#endif	/* __PERF_ANNOTATE_H */
173