xref: /linux/tools/perf/util/annotate.h (revision 69fb09f6ccdb2f070557fd1f4c56c4d646694c8e)
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 
14 struct ins_ops;
15 
16 struct ins {
17 	const char     *name;
18 	struct ins_ops *ops;
19 };
20 
21 struct ins_operands {
22 	char	*raw;
23 	struct {
24 		char	*raw;
25 		char	*name;
26 		u64	addr;
27 		s64	offset;
28 		bool	offset_avail;
29 	} target;
30 	union {
31 		struct {
32 			char	*raw;
33 			char	*name;
34 			u64	addr;
35 		} source;
36 		struct {
37 			struct ins	    ins;
38 			struct ins_operands *ops;
39 		} locked;
40 	};
41 };
42 
43 struct arch;
44 
45 struct ins_ops {
46 	void (*free)(struct ins_operands *ops);
47 	int (*parse)(struct arch *arch, struct ins_operands *ops, struct map *map);
48 	int (*scnprintf)(struct ins *ins, char *bf, size_t size,
49 			 struct ins_operands *ops);
50 };
51 
52 bool ins__is_jump(const struct ins *ins);
53 bool ins__is_call(const struct ins *ins);
54 bool ins__is_ret(const struct ins *ins);
55 int ins__scnprintf(struct ins *ins, char *bf, size_t size, struct ins_operands *ops);
56 bool ins__is_fused(struct arch *arch, const char *ins1, const char *ins2);
57 
58 struct annotation;
59 
60 struct disasm_line {
61 	struct list_head    node;
62 	s64		    offset;
63 	char		    *line;
64 	struct ins	    ins;
65 	int		    line_nr;
66 	float		    ipc;
67 	u64		    cycles;
68 	struct ins_operands ops;
69 };
70 
71 static inline bool disasm_line__has_offset(const struct disasm_line *dl)
72 {
73 	return dl->ops.target.offset_avail;
74 }
75 
76 void disasm_line__free(struct disasm_line *dl);
77 struct disasm_line *disasm__get_next_ip_line(struct list_head *head, struct disasm_line *pos);
78 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw);
79 size_t disasm__fprintf(struct list_head *head, FILE *fp);
80 double disasm__calc_percent(struct annotation *notes, int evidx, s64 offset,
81 			    s64 end, const char **path, u64 *nr_samples);
82 
83 struct sym_hist {
84 	u64		sum;
85 	u64		addr[0];
86 };
87 
88 struct cyc_hist {
89 	u64	start;
90 	u64	cycles;
91 	u64	cycles_aggr;
92 	u32	num;
93 	u32	num_aggr;
94 	u8	have_start;
95 	/* 1 byte padding */
96 	u16	reset;
97 };
98 
99 struct source_line_samples {
100 	double		percent;
101 	double		percent_sum;
102 	u64		nr;
103 };
104 
105 struct source_line {
106 	struct rb_node	node;
107 	char		*path;
108 	int		nr_pcnt;
109 	struct source_line_samples samples[1];
110 };
111 
112 /** struct annotated_source - symbols with hits have this attached as in sannotation
113  *
114  * @histogram: Array of addr hit histograms per event being monitored
115  * @lines: If 'print_lines' is specified, per source code line percentages
116  * @source: source parsed from a disassembler like objdump -dS
117  * @cyc_hist: Average cycles per basic block
118  *
119  * lines is allocated, percentages calculated and all sorted by percentage
120  * when the annotation is about to be presented, so the percentages are for
121  * one of the entries in the histogram array, i.e. for the event/counter being
122  * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate
123  * returns.
124  */
125 struct annotated_source {
126 	struct list_head   source;
127 	struct source_line *lines;
128 	int    		   nr_histograms;
129 	size_t		   sizeof_sym_hist;
130 	struct cyc_hist	   *cycles_hist;
131 	struct sym_hist	   histograms[0];
132 };
133 
134 struct annotation {
135 	pthread_mutex_t		lock;
136 	u64			max_coverage;
137 	struct annotated_source *src;
138 };
139 
140 static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
141 {
142 	return (((void *)&notes->src->histograms) +
143 	 	(notes->src->sizeof_sym_hist * idx));
144 }
145 
146 static inline struct annotation *symbol__annotation(struct symbol *sym)
147 {
148 	return (void *)sym - symbol_conf.priv_size;
149 }
150 
151 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, int evidx);
152 
153 int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
154 				    struct addr_map_symbol *start,
155 				    unsigned cycles);
156 
157 int hist_entry__inc_addr_samples(struct hist_entry *he, int evidx, u64 addr);
158 
159 int symbol__alloc_hist(struct symbol *sym);
160 void symbol__annotate_zero_histograms(struct symbol *sym);
161 
162 int symbol__disassemble(struct symbol *sym, struct map *map,
163 			const char *arch_name, size_t privsize,
164 			struct arch **parch, char *cpuid);
165 
166 enum symbol_disassemble_errno {
167 	SYMBOL_ANNOTATE_ERRNO__SUCCESS		= 0,
168 
169 	/*
170 	 * Choose an arbitrary negative big number not to clash with standard
171 	 * errno since SUS requires the errno has distinct positive values.
172 	 * See 'Issue 6' in the link below.
173 	 *
174 	 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
175 	 */
176 	__SYMBOL_ANNOTATE_ERRNO__START		= -10000,
177 
178 	SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX	= __SYMBOL_ANNOTATE_ERRNO__START,
179 
180 	__SYMBOL_ANNOTATE_ERRNO__END,
181 };
182 
183 int symbol__strerror_disassemble(struct symbol *sym, struct map *map,
184 				 int errnum, char *buf, size_t buflen);
185 
186 int symbol__annotate_printf(struct symbol *sym, struct map *map,
187 			    struct perf_evsel *evsel, bool full_paths,
188 			    int min_pcnt, int max_lines, int context);
189 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
190 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx);
191 void disasm__purge(struct list_head *head);
192 
193 bool ui__has_annotation(void);
194 
195 int symbol__tty_annotate(struct symbol *sym, struct map *map,
196 			 struct perf_evsel *evsel, bool print_lines,
197 			 bool full_paths, int min_pcnt, int max_lines);
198 
199 #ifdef HAVE_SLANG_SUPPORT
200 int symbol__tui_annotate(struct symbol *sym, struct map *map,
201 			 struct perf_evsel *evsel,
202 			 struct hist_browser_timer *hbt);
203 #else
204 static inline int symbol__tui_annotate(struct symbol *sym __maybe_unused,
205 				struct map *map __maybe_unused,
206 				struct perf_evsel *evsel  __maybe_unused,
207 				struct hist_browser_timer *hbt
208 				__maybe_unused)
209 {
210 	return 0;
211 }
212 #endif
213 
214 extern const char	*disassembler_style;
215 
216 #endif	/* __PERF_ANNOTATE_H */
217