]> Git Repo - linux.git/blob - tools/perf/util/annotate.h
scsi: zfcp: Trace when request remove fails after qdio send fails
[linux.git] / tools / perf / util / annotate.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_ANNOTATE_H
3 #define __PERF_ANNOTATE_H
4
5 #include <stdbool.h>
6 #include <stdint.h>
7 #include <stdio.h>
8 #include <linux/types.h>
9 #include <linux/list.h>
10 #include <linux/rbtree.h>
11 #include <asm/bug.h>
12 #include "symbol_conf.h"
13 #include "mutex.h"
14 #include "spark.h"
15
16 struct hist_browser_timer;
17 struct hist_entry;
18 struct ins_ops;
19 struct map;
20 struct map_symbol;
21 struct addr_map_symbol;
22 struct option;
23 struct perf_sample;
24 struct evsel;
25 struct symbol;
26
27 struct ins {
28         const char     *name;
29         struct ins_ops *ops;
30 };
31
32 struct ins_operands {
33         char    *raw;
34         char    *raw_comment;
35         char    *raw_func_start;
36         struct {
37                 char    *raw;
38                 char    *name;
39                 struct symbol *sym;
40                 u64     addr;
41                 s64     offset;
42                 bool    offset_avail;
43                 bool    outside;
44         } target;
45         union {
46                 struct {
47                         char    *raw;
48                         char    *name;
49                         u64     addr;
50                 } source;
51                 struct {
52                         struct ins          ins;
53                         struct ins_operands *ops;
54                 } locked;
55         };
56 };
57
58 struct arch;
59
60 struct ins_ops {
61         void (*free)(struct ins_operands *ops);
62         int (*parse)(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms);
63         int (*scnprintf)(struct ins *ins, char *bf, size_t size,
64                          struct ins_operands *ops, int max_ins_name);
65 };
66
67 bool ins__is_jump(const struct ins *ins);
68 bool ins__is_call(const struct ins *ins);
69 bool ins__is_ret(const struct ins *ins);
70 bool ins__is_lock(const struct ins *ins);
71 int ins__scnprintf(struct ins *ins, char *bf, size_t size, struct ins_operands *ops, int max_ins_name);
72 bool ins__is_fused(struct arch *arch, const char *ins1, const char *ins2);
73
74 #define ANNOTATION__IPC_WIDTH 6
75 #define ANNOTATION__CYCLES_WIDTH 6
76 #define ANNOTATION__MINMAX_CYCLES_WIDTH 19
77 #define ANNOTATION__AVG_IPC_WIDTH 36
78 #define ANNOTATION_DUMMY_LEN    256
79
80 struct annotation_options {
81         bool hide_src_code,
82              use_offset,
83              jump_arrows,
84              print_lines,
85              full_path,
86              show_linenr,
87              show_fileloc,
88              show_nr_jumps,
89              show_minmax_cycle,
90              show_asm_raw,
91              annotate_src,
92              full_addr;
93         u8   offset_level;
94         int  min_pcnt;
95         int  max_lines;
96         int  context;
97         const char *objdump_path;
98         const char *disassembler_style;
99         const char *prefix;
100         const char *prefix_strip;
101         unsigned int percent_type;
102 };
103
104 enum {
105         ANNOTATION__OFFSET_JUMP_TARGETS = 1,
106         ANNOTATION__OFFSET_CALL,
107         ANNOTATION__MAX_OFFSET_LEVEL,
108 };
109
110 #define ANNOTATION__MIN_OFFSET_LEVEL ANNOTATION__OFFSET_JUMP_TARGETS
111
112 extern struct annotation_options annotation__default_options;
113
114 struct annotation;
115
116 struct sym_hist_entry {
117         u64             nr_samples;
118         u64             period;
119 };
120
121 enum {
122         PERCENT_HITS_LOCAL,
123         PERCENT_HITS_GLOBAL,
124         PERCENT_PERIOD_LOCAL,
125         PERCENT_PERIOD_GLOBAL,
126         PERCENT_MAX,
127 };
128
129 struct annotation_data {
130         double                   percent[PERCENT_MAX];
131         double                   percent_sum;
132         struct sym_hist_entry    he;
133 };
134
135 struct annotation_line {
136         struct list_head         node;
137         struct rb_node           rb_node;
138         s64                      offset;
139         char                    *line;
140         int                      line_nr;
141         char                    *fileloc;
142         int                      jump_sources;
143         float                    ipc;
144         u64                      cycles;
145         u64                      cycles_max;
146         u64                      cycles_min;
147         char                    *path;
148         u32                      idx;
149         int                      idx_asm;
150         int                      data_nr;
151         struct annotation_data   data[];
152 };
153
154 struct disasm_line {
155         struct ins               ins;
156         struct ins_operands      ops;
157
158         /* This needs to be at the end. */
159         struct annotation_line   al;
160 };
161
162 static inline double annotation_data__percent(struct annotation_data *data,
163                                               unsigned int which)
164 {
165         return which < PERCENT_MAX ? data->percent[which] : -1;
166 }
167
168 static inline const char *percent_type_str(unsigned int type)
169 {
170         static const char *str[PERCENT_MAX] = {
171                 "local hits",
172                 "global hits",
173                 "local period",
174                 "global period",
175         };
176
177         if (WARN_ON(type >= PERCENT_MAX))
178                 return "N/A";
179
180         return str[type];
181 }
182
183 static inline struct disasm_line *disasm_line(struct annotation_line *al)
184 {
185         return al ? container_of(al, struct disasm_line, al) : NULL;
186 }
187
188 /*
189  * Is this offset in the same function as the line it is used?
190  * asm functions jump to other functions, for instance.
191  */
192 static inline bool disasm_line__has_local_offset(const struct disasm_line *dl)
193 {
194         return dl->ops.target.offset_avail && !dl->ops.target.outside;
195 }
196
197 /*
198  * Can we draw an arrow from the jump to its target, for instance? I.e.
199  * is the jump and its target in the same function?
200  */
201 bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym);
202
203 void disasm_line__free(struct disasm_line *dl);
204 struct annotation_line *
205 annotation_line__next(struct annotation_line *pos, struct list_head *head);
206
207 struct annotation_write_ops {
208         bool first_line, current_entry, change_color;
209         int  width;
210         void *obj;
211         int  (*set_color)(void *obj, int color);
212         void (*set_percent_color)(void *obj, double percent, bool current);
213         int  (*set_jumps_percent_color)(void *obj, int nr, bool current);
214         void (*printf)(void *obj, const char *fmt, ...);
215         void (*write_graph)(void *obj, int graph);
216 };
217
218 void annotation_line__write(struct annotation_line *al, struct annotation *notes,
219                             struct annotation_write_ops *ops,
220                             struct annotation_options *opts);
221
222 int __annotation__scnprintf_samples_period(struct annotation *notes,
223                                            char *bf, size_t size,
224                                            struct evsel *evsel,
225                                            bool show_freq);
226
227 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw, int max_ins_name);
228 size_t disasm__fprintf(struct list_head *head, FILE *fp);
229 void symbol__calc_percent(struct symbol *sym, struct evsel *evsel);
230
231 struct sym_hist {
232         u64                   nr_samples;
233         u64                   period;
234         struct sym_hist_entry addr[];
235 };
236
237 struct cyc_hist {
238         u64     start;
239         u64     cycles;
240         u64     cycles_aggr;
241         u64     cycles_max;
242         u64     cycles_min;
243         s64     cycles_spark[NUM_SPARKS];
244         u32     num;
245         u32     num_aggr;
246         u8      have_start;
247         /* 1 byte padding */
248         u16     reset;
249 };
250
251 /** struct annotated_source - symbols with hits have this attached as in sannotation
252  *
253  * @histograms: Array of addr hit histograms per event being monitored
254  * nr_histograms: This may not be the same as evsel->evlist->core.nr_entries if
255  *                we have more than a group in a evlist, where we will want
256  *                to see each group separately, that is why symbol__annotate2()
257  *                sets src->nr_histograms to evsel->nr_members.
258  * @lines: If 'print_lines' is specified, per source code line percentages
259  * @source: source parsed from a disassembler like objdump -dS
260  * @cyc_hist: Average cycles per basic block
261  *
262  * lines is allocated, percentages calculated and all sorted by percentage
263  * when the annotation is about to be presented, so the percentages are for
264  * one of the entries in the histogram array, i.e. for the event/counter being
265  * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate
266  * returns.
267  */
268 struct annotated_source {
269         struct list_head   source;
270         int                nr_histograms;
271         size_t             sizeof_sym_hist;
272         struct cyc_hist    *cycles_hist;
273         struct sym_hist    *histograms;
274 };
275
276 struct annotation {
277         struct mutex lock;
278         u64                     max_coverage;
279         u64                     start;
280         u64                     hit_cycles;
281         u64                     hit_insn;
282         unsigned int            total_insn;
283         unsigned int            cover_insn;
284         struct annotation_options *options;
285         struct annotation_line  **offsets;
286         int                     nr_events;
287         int                     max_jump_sources;
288         int                     nr_entries;
289         int                     nr_asm_entries;
290         u16                     max_line_len;
291         struct {
292                 u8              addr;
293                 u8              jumps;
294                 u8              target;
295                 u8              min_addr;
296                 u8              max_addr;
297                 u8              max_ins_name;
298         } widths;
299         bool                    have_cycles;
300         struct annotated_source *src;
301 };
302
303 void annotation__init(struct annotation *notes);
304 void annotation__exit(struct annotation *notes);
305
306 static inline int annotation__cycles_width(struct annotation *notes)
307 {
308         if (notes->have_cycles && notes->options->show_minmax_cycle)
309                 return ANNOTATION__IPC_WIDTH + ANNOTATION__MINMAX_CYCLES_WIDTH;
310
311         return notes->have_cycles ? ANNOTATION__IPC_WIDTH + ANNOTATION__CYCLES_WIDTH : 0;
312 }
313
314 static inline int annotation__pcnt_width(struct annotation *notes)
315 {
316         return (symbol_conf.show_total_period ? 12 : 7) * notes->nr_events;
317 }
318
319 static inline bool annotation_line__filter(struct annotation_line *al, struct annotation *notes)
320 {
321         return notes->options->hide_src_code && al->offset == -1;
322 }
323
324 void annotation__set_offsets(struct annotation *notes, s64 size);
325 void annotation__compute_ipc(struct annotation *notes, size_t size);
326 void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym);
327 void annotation__update_column_widths(struct annotation *notes);
328 void annotation__init_column_widths(struct annotation *notes, struct symbol *sym);
329 void annotation__toggle_full_addr(struct annotation *notes, struct map_symbol *ms);
330
331 static inline struct sym_hist *annotated_source__histogram(struct annotated_source *src, int idx)
332 {
333         return ((void *)src->histograms) + (src->sizeof_sym_hist * idx);
334 }
335
336 static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
337 {
338         return annotated_source__histogram(notes->src, idx);
339 }
340
341 static inline struct annotation *symbol__annotation(struct symbol *sym)
342 {
343         return (void *)sym - symbol_conf.priv_size;
344 }
345
346 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample,
347                                  struct evsel *evsel);
348
349 int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
350                                     struct addr_map_symbol *start,
351                                     unsigned cycles);
352
353 int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample,
354                                  struct evsel *evsel, u64 addr);
355
356 struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists);
357 void symbol__annotate_zero_histograms(struct symbol *sym);
358
359 int symbol__annotate(struct map_symbol *ms,
360                      struct evsel *evsel,
361                      struct annotation_options *options,
362                      struct arch **parch);
363 int symbol__annotate2(struct map_symbol *ms,
364                       struct evsel *evsel,
365                       struct annotation_options *options,
366                       struct arch **parch);
367
368 enum symbol_disassemble_errno {
369         SYMBOL_ANNOTATE_ERRNO__SUCCESS          = 0,
370
371         /*
372          * Choose an arbitrary negative big number not to clash with standard
373          * errno since SUS requires the errno has distinct positive values.
374          * See 'Issue 6' in the link below.
375          *
376          * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
377          */
378         __SYMBOL_ANNOTATE_ERRNO__START          = -10000,
379
380         SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX       = __SYMBOL_ANNOTATE_ERRNO__START,
381         SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF,
382         SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_CPUID_PARSING,
383         SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_REGEXP,
384         SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE,
385         SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF,
386
387         __SYMBOL_ANNOTATE_ERRNO__END,
388 };
389
390 int symbol__strerror_disassemble(struct map_symbol *ms, int errnum, char *buf, size_t buflen);
391
392 int symbol__annotate_printf(struct map_symbol *ms, struct evsel *evsel,
393                             struct annotation_options *options);
394 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
395 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx);
396 void annotated_source__purge(struct annotated_source *as);
397
398 int map_symbol__annotation_dump(struct map_symbol *ms, struct evsel *evsel,
399                                 struct annotation_options *opts);
400
401 bool ui__has_annotation(void);
402
403 int symbol__tty_annotate(struct map_symbol *ms, struct evsel *evsel, struct annotation_options *opts);
404
405 int symbol__tty_annotate2(struct map_symbol *ms, struct evsel *evsel, struct annotation_options *opts);
406
407 #ifdef HAVE_SLANG_SUPPORT
408 int symbol__tui_annotate(struct map_symbol *ms, struct evsel *evsel,
409                          struct hist_browser_timer *hbt,
410                          struct annotation_options *opts);
411 #else
412 static inline int symbol__tui_annotate(struct map_symbol *ms __maybe_unused,
413                                 struct evsel *evsel  __maybe_unused,
414                                 struct hist_browser_timer *hbt __maybe_unused,
415                                 struct annotation_options *opts __maybe_unused)
416 {
417         return 0;
418 }
419 #endif
420
421 void annotation_config__init(struct annotation_options *opt);
422
423 int annotate_parse_percent_type(const struct option *opt, const char *_str,
424                                 int unset);
425
426 int annotate_check_args(struct annotation_options *args);
427
428 #endif  /* __PERF_ANNOTATE_H */
This page took 0.059572 seconds and 4 git commands to generate.