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