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