blob: 68f851e6c685f71889720f9ee9f1c218a1cfe6ca [file] [log] [blame]
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -02001#ifndef __PERF_ANNOTATE_H
2#define __PERF_ANNOTATE_H
3
4#include <stdbool.h>
Arnaldo Carvalho de Melofb29fa52012-04-25 14:16:03 -03005#include <stdint.h>
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -02006#include "types.h"
7#include "symbol.h"
Namhyung Kim9783adf2012-11-02 14:50:05 +09008#include "hist.h"
Namhyung Kim2b676bf2013-02-07 18:02:08 +09009#include "sort.h"
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -020010#include <linux/list.h>
11#include <linux/rbtree.h>
Irina Tirdea27683dc2012-09-08 03:43:19 +030012#include <pthread.h>
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -020013
Arnaldo Carvalho de Melo28548d72012-04-19 10:16:27 -030014struct ins;
15
Arnaldo Carvalho de Meloc7e6ead2012-04-20 14:38:46 -030016struct ins_operands {
17 char *raw;
Arnaldo Carvalho de Melo44d1a3e2012-04-25 08:00:23 -030018 struct {
Arnaldo Carvalho de Melo6de783b2012-05-11 16:48:49 -030019 char *raw;
Arnaldo Carvalho de Melo44d1a3e2012-04-25 08:00:23 -030020 char *name;
Arnaldo Carvalho de Melo44d1a3e2012-04-25 08:00:23 -030021 u64 addr;
Arnaldo Carvalho de Melo6de783b2012-05-11 16:48:49 -030022 u64 offset;
Arnaldo Carvalho de Melo44d1a3e2012-04-25 08:00:23 -030023 } target;
Arnaldo Carvalho de Melo7a997fe2012-05-12 13:15:34 -030024 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 };
Arnaldo Carvalho de Meloc7e6ead2012-04-20 14:38:46 -030035};
36
Arnaldo Carvalho de Melo4f9d0322012-04-18 13:58:34 -030037struct ins_ops {
Arnaldo Carvalho de Meloc46219ac2012-05-12 13:26:20 -030038 void (*free)(struct ins_operands *ops);
Arnaldo Carvalho de Meloc7e6ead2012-04-20 14:38:46 -030039 int (*parse)(struct ins_operands *ops);
Arnaldo Carvalho de Melo28548d72012-04-19 10:16:27 -030040 int (*scnprintf)(struct ins *ins, char *bf, size_t size,
Arnaldo Carvalho de Melo54170722012-05-07 18:54:16 -030041 struct ins_operands *ops);
Arnaldo Carvalho de Melo4f9d0322012-04-18 13:58:34 -030042};
43
44struct ins {
45 const char *name;
46 struct ins_ops *ops;
47};
48
49bool ins__is_jump(const struct ins *ins);
Arnaldo Carvalho de Melod86b0592012-04-18 16:07:38 -030050bool ins__is_call(const struct ins *ins);
Arnaldo Carvalho de Melo54170722012-05-07 18:54:16 -030051int ins__scnprintf(struct ins *ins, char *bf, size_t size, struct ins_operands *ops);
Arnaldo Carvalho de Melo4f9d0322012-04-18 13:58:34 -030052
Arnaldo Carvalho de Melo29ed6e72012-04-15 15:24:39 -030053struct disasm_line {
Arnaldo Carvalho de Meloc7e6ead2012-04-20 14:38:46 -030054 struct list_head node;
55 s64 offset;
56 char *line;
57 char *name;
58 struct ins *ins;
59 struct ins_operands ops;
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -020060};
61
Arnaldo Carvalho de Melofb29fa52012-04-25 14:16:03 -030062static inline bool disasm_line__has_offset(const struct disasm_line *dl)
63{
64 return dl->ops.target.offset != UINT64_MAX;
65}
66
Arnaldo Carvalho de Melo29ed6e72012-04-15 15:24:39 -030067void disasm_line__free(struct disasm_line *dl);
68struct disasm_line *disasm__get_next_ip_line(struct list_head *head, struct disasm_line *pos);
Arnaldo Carvalho de Melo54170722012-05-07 18:54:16 -030069int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw);
Arnaldo Carvalho de Melo51454182012-04-15 15:52:18 -030070size_t disasm__fprintf(struct list_head *head, FILE *fp);
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -020071
72struct sym_hist {
73 u64 sum;
74 u64 addr[0];
75};
76
Namhyung Kimc5a83682013-03-05 14:53:27 +090077struct source_line_percent {
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -020078 double percent;
Namhyung Kim41127962012-11-09 14:58:49 +090079 double percent_sum;
Namhyung Kimc5a83682013-03-05 14:53:27 +090080};
81
82struct source_line {
83 struct rb_node node;
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -020084 char *path;
Namhyung Kim1491c222013-03-05 14:53:28 +090085 int nr_pcnt;
Namhyung Kimc5a83682013-03-05 14:53:27 +090086 struct source_line_percent p[1];
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -020087};
88
Arnaldo Carvalho de Meloce6f4fa2011-02-08 13:27:39 -020089/** struct annotated_source - symbols with hits have this attached as in sannotation
Arnaldo Carvalho de Melo2f525d02011-02-04 13:43:24 -020090 *
91 * @histogram: Array of addr hit histograms per event being monitored
Arnaldo Carvalho de Meloce6f4fa2011-02-08 13:27:39 -020092 * @lines: If 'print_lines' is specified, per source code line percentages
Arnaldo Carvalho de Melo29ed6e72012-04-15 15:24:39 -030093 * @source: source parsed from a disassembler like objdump -dS
Arnaldo Carvalho de Melo2f525d02011-02-04 13:43:24 -020094 *
Arnaldo Carvalho de Meloce6f4fa2011-02-08 13:27:39 -020095 * lines is allocated, percentages calculated and all sorted by percentage
Arnaldo Carvalho de Melo2f525d02011-02-04 13:43:24 -020096 * when the annotation is about to be presented, so the percentages are for
97 * one of the entries in the histogram array, i.e. for the event/counter being
98 * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate
99 * returns.
100 */
Arnaldo Carvalho de Meloce6f4fa2011-02-08 13:27:39 -0200101struct annotated_source {
102 struct list_head source;
103 struct source_line *lines;
Arnaldo Carvalho de Melo36532462011-02-06 14:54:44 -0200104 int nr_histograms;
Arnaldo Carvalho de Melo2f525d02011-02-04 13:43:24 -0200105 int sizeof_sym_hist;
Arnaldo Carvalho de Meloce6f4fa2011-02-08 13:27:39 -0200106 struct sym_hist histograms[0];
107};
108
109struct annotation {
110 pthread_mutex_t lock;
111 struct annotated_source *src;
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -0200112};
113
114struct sannotation {
115 struct annotation annotation;
116 struct symbol symbol;
117};
118
Arnaldo Carvalho de Melo2f525d02011-02-04 13:43:24 -0200119static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
120{
Arnaldo Carvalho de Meloce6f4fa2011-02-08 13:27:39 -0200121 return (((void *)&notes->src->histograms) +
122 (notes->src->sizeof_sym_hist * idx));
Arnaldo Carvalho de Melo2f525d02011-02-04 13:43:24 -0200123}
124
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -0200125static inline struct annotation *symbol__annotation(struct symbol *sym)
126{
127 struct sannotation *a = container_of(sym, struct sannotation, symbol);
128 return &a->annotation;
129}
130
Arnaldo Carvalho de Melo2f525d02011-02-04 13:43:24 -0200131int symbol__inc_addr_samples(struct symbol *sym, struct map *map,
132 int evidx, u64 addr);
Arnaldo Carvalho de Melod04b35f2011-11-11 22:17:32 -0200133int symbol__alloc_hist(struct symbol *sym);
Arnaldo Carvalho de Melo36532462011-02-06 14:54:44 -0200134void symbol__annotate_zero_histograms(struct symbol *sym);
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -0200135
Arnaldo Carvalho de Meloce6f4fa2011-02-08 13:27:39 -0200136int symbol__annotate(struct symbol *sym, struct map *map, size_t privsize);
Irina Tirdea1d037ca2012-09-11 01:15:03 +0300137int symbol__annotate_init(struct map *map __maybe_unused, struct symbol *sym);
Namhyung Kimdb8fd072013-03-05 14:53:21 +0900138int symbol__annotate_printf(struct symbol *sym, struct map *map,
139 struct perf_evsel *evsel, bool full_paths,
140 int min_pcnt, int max_lines, int context);
Arnaldo Carvalho de Melo36532462011-02-06 14:54:44 -0200141void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
Arnaldo Carvalho de Meloce6f4fa2011-02-08 13:27:39 -0200142void symbol__annotate_decay_histogram(struct symbol *sym, int evidx);
Arnaldo Carvalho de Melo29ed6e72012-04-15 15:24:39 -0300143void disasm__purge(struct list_head *head);
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -0200144
Namhyung Kimdb8fd072013-03-05 14:53:21 +0900145int symbol__tty_annotate(struct symbol *sym, struct map *map,
146 struct perf_evsel *evsel, bool print_lines,
147 bool full_paths, int min_pcnt, int max_lines);
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -0200148
Namhyung Kim1254b51e2012-09-28 18:32:02 +0900149#ifdef NEWT_SUPPORT
Namhyung Kimdb8fd072013-03-05 14:53:21 +0900150int symbol__tui_annotate(struct symbol *sym, struct map *map,
151 struct perf_evsel *evsel,
Namhyung Kim9783adf2012-11-02 14:50:05 +0900152 struct hist_browser_timer *hbt);
Namhyung Kim1254b51e2012-09-28 18:32:02 +0900153#else
Irina Tirdea1d037ca2012-09-11 01:15:03 +0300154static inline int symbol__tui_annotate(struct symbol *sym __maybe_unused,
Namhyung Kimdb8fd072013-03-05 14:53:21 +0900155 struct map *map __maybe_unused,
156 struct perf_evsel *evsel __maybe_unused,
157 struct hist_browser_timer *hbt
158 __maybe_unused)
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -0200159{
160 return 0;
161}
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -0200162#endif
163
Namhyung Kim2b676bf2013-02-07 18:02:08 +0900164#ifdef GTK2_SUPPORT
Namhyung Kimdb8fd072013-03-05 14:53:21 +0900165int symbol__gtk_annotate(struct symbol *sym, struct map *map,
166 struct perf_evsel *evsel,
Namhyung Kim2b676bf2013-02-07 18:02:08 +0900167 struct hist_browser_timer *hbt);
168
Namhyung Kimdb8fd072013-03-05 14:53:21 +0900169static inline int hist_entry__gtk_annotate(struct hist_entry *he,
170 struct perf_evsel *evsel,
Namhyung Kim2b676bf2013-02-07 18:02:08 +0900171 struct hist_browser_timer *hbt)
172{
Namhyung Kimdb8fd072013-03-05 14:53:21 +0900173 return symbol__gtk_annotate(he->ms.sym, he->ms.map, evsel, hbt);
Namhyung Kim2b676bf2013-02-07 18:02:08 +0900174}
Namhyung Kim7a60ba92013-02-07 18:02:09 +0900175
176void perf_gtk__show_annotations(void);
Namhyung Kim2b676bf2013-02-07 18:02:08 +0900177#else
178static inline int hist_entry__gtk_annotate(struct hist_entry *he __maybe_unused,
Namhyung Kimdb8fd072013-03-05 14:53:21 +0900179 struct perf_evsel *evsel __maybe_unused,
180 struct hist_browser_timer *hbt __maybe_unused)
Namhyung Kim2b676bf2013-02-07 18:02:08 +0900181{
182 return 0;
183}
Namhyung Kim7a60ba92013-02-07 18:02:09 +0900184
185static inline void perf_gtk__show_annotations(void) {}
Namhyung Kim2b676bf2013-02-07 18:02:08 +0900186#endif
187
Andi Kleenf69b64f2011-09-15 14:31:41 -0700188extern const char *disassembler_style;
189
Arnaldo Carvalho de Melo78f7def2011-02-04 09:45:46 -0200190#endif /* __PERF_ANNOTATE_H */