xref: /linux/tools/perf/util/annotate.h (revision f37130533f68711fd6bae2c79950b8e72002bad6)
1 #ifndef __PERF_ANNOTATE_H
2 #define __PERF_ANNOTATE_H
3 
4 #include <stdbool.h>
5 #include <stdint.h>
6 #include "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;
15 
16 struct 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 
37 struct 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 
44 struct ins {
45 	const char     *name;
46 	struct ins_ops *ops;
47 };
48 
49 bool ins__is_jump(const struct ins *ins);
50 bool ins__is_call(const struct ins *ins);
51 int ins__scnprintf(struct ins *ins, char *bf, size_t size, struct ins_operands *ops);
52 
53 struct disasm_line {
54 	struct list_head    node;
55 	s64		    offset;
56 	char		    *line;
57 	char		    *name;
58 	struct ins	    *ins;
59 	struct ins_operands ops;
60 };
61 
62 static inline bool disasm_line__has_offset(const struct disasm_line *dl)
63 {
64 	return dl->ops.target.offset != UINT64_MAX;
65 }
66 
67 void disasm_line__free(struct disasm_line *dl);
68 struct disasm_line *disasm__get_next_ip_line(struct list_head *head, struct disasm_line *pos);
69 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw);
70 size_t disasm__fprintf(struct list_head *head, FILE *fp);
71 
72 struct sym_hist {
73 	u64		sum;
74 	u64		addr[0];
75 };
76 
77 struct source_line {
78 	struct rb_node	node;
79 	double		percent;
80 	double		percent_sum;
81 	char		*path;
82 };
83 
84 /** struct annotated_source - symbols with hits have this attached as in sannotation
85  *
86  * @histogram: Array of addr hit histograms per event being monitored
87  * @lines: If 'print_lines' is specified, per source code line percentages
88  * @source: source parsed from a disassembler like objdump -dS
89  *
90  * lines is allocated, percentages calculated and all sorted by percentage
91  * when the annotation is about to be presented, so the percentages are for
92  * one of the entries in the histogram array, i.e. for the event/counter being
93  * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate
94  * returns.
95  */
96 struct annotated_source {
97 	struct list_head   source;
98 	struct source_line *lines;
99 	int    		   nr_histograms;
100 	int    		   sizeof_sym_hist;
101 	struct sym_hist	   histograms[0];
102 };
103 
104 struct annotation {
105 	pthread_mutex_t		lock;
106 	struct annotated_source *src;
107 };
108 
109 struct sannotation {
110 	struct annotation annotation;
111 	struct symbol	  symbol;
112 };
113 
114 static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
115 {
116 	return (((void *)&notes->src->histograms) +
117 	 	(notes->src->sizeof_sym_hist * idx));
118 }
119 
120 static inline struct annotation *symbol__annotation(struct symbol *sym)
121 {
122 	struct sannotation *a = container_of(sym, struct sannotation, symbol);
123 	return &a->annotation;
124 }
125 
126 int symbol__inc_addr_samples(struct symbol *sym, struct map *map,
127 			     int evidx, u64 addr);
128 int symbol__alloc_hist(struct symbol *sym);
129 void symbol__annotate_zero_histograms(struct symbol *sym);
130 
131 int symbol__annotate(struct symbol *sym, struct map *map, size_t privsize);
132 int symbol__annotate_init(struct map *map __maybe_unused, struct symbol *sym);
133 int symbol__annotate_printf(struct symbol *sym, struct map *map, int evidx,
134 			    bool full_paths, int min_pcnt, int max_lines,
135 			    int context);
136 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
137 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx);
138 void disasm__purge(struct list_head *head);
139 
140 int symbol__tty_annotate(struct symbol *sym, struct map *map, int evidx,
141 			 bool print_lines, bool full_paths, int min_pcnt,
142 			 int max_lines);
143 
144 #ifdef NEWT_SUPPORT
145 int symbol__tui_annotate(struct symbol *sym, struct map *map, int evidx,
146 			 struct hist_browser_timer *hbt);
147 #else
148 static inline int symbol__tui_annotate(struct symbol *sym __maybe_unused,
149 				       struct map *map __maybe_unused,
150 				       int evidx __maybe_unused,
151 				       struct hist_browser_timer *hbt
152 				       __maybe_unused)
153 {
154 	return 0;
155 }
156 #endif
157 
158 #ifdef GTK2_SUPPORT
159 int symbol__gtk_annotate(struct symbol *sym, struct map *map, int evidx,
160 			 struct hist_browser_timer *hbt);
161 
162 static inline int hist_entry__gtk_annotate(struct hist_entry *he, int evidx,
163 					   struct hist_browser_timer *hbt)
164 {
165 	return symbol__gtk_annotate(he->ms.sym, he->ms.map, evidx, hbt);
166 }
167 
168 void perf_gtk__show_annotations(void);
169 #else
170 static inline int hist_entry__gtk_annotate(struct hist_entry *he __maybe_unused,
171 					   int evidx __maybe_unused,
172 					   struct hist_browser_timer *hbt
173 					   __maybe_unused)
174 {
175 	return 0;
176 }
177 
178 static inline void perf_gtk__show_annotations(void) {}
179 #endif
180 
181 extern const char	*disassembler_style;
182 
183 #endif	/* __PERF_ANNOTATE_H */
184