Loading...
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
14struct ins_ops;
15
16struct ins {
17 const char *name;
18 struct ins_ops *ops;
19};
20
21struct 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
43struct arch;
44
45struct 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
52bool ins__is_jump(const struct ins *ins);
53bool ins__is_call(const struct ins *ins);
54bool ins__is_ret(const struct ins *ins);
55int ins__scnprintf(struct ins *ins, char *bf, size_t size, struct ins_operands *ops);
56
57struct annotation;
58
59struct 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
70static inline bool disasm_line__has_offset(const struct disasm_line *dl)
71{
72 return dl->ops.target.offset_avail;
73}
74
75void disasm_line__free(struct disasm_line *dl);
76struct disasm_line *disasm__get_next_ip_line(struct list_head *head, struct disasm_line *pos);
77int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw);
78size_t disasm__fprintf(struct list_head *head, FILE *fp);
79double disasm__calc_percent(struct annotation *notes, int evidx, s64 offset,
80 s64 end, const char **path, u64 *nr_samples);
81
82struct sym_hist {
83 u64 sum;
84 u64 addr[0];
85};
86
87struct 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
98struct source_line_samples {
99 double percent;
100 double percent_sum;
101 double nr;
102};
103
104struct 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 */
124struct 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
133struct annotation {
134 pthread_mutex_t lock;
135 u64 max_coverage;
136 struct annotated_source *src;
137};
138
139static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
140{
141 return (((void *)¬es->src->histograms) +
142 (notes->src->sizeof_sym_hist * idx));
143}
144
145static inline struct annotation *symbol__annotation(struct symbol *sym)
146{
147 return (void *)sym - symbol_conf.priv_size;
148}
149
150int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, int evidx);
151
152int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
153 struct addr_map_symbol *start,
154 unsigned cycles);
155
156int hist_entry__inc_addr_samples(struct hist_entry *he, int evidx, u64 addr);
157
158int symbol__alloc_hist(struct symbol *sym);
159void symbol__annotate_zero_histograms(struct symbol *sym);
160
161int symbol__disassemble(struct symbol *sym, struct map *map, const char *arch_name, size_t privsize);
162
163enum 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
180int symbol__strerror_disassemble(struct symbol *sym, struct map *map,
181 int errnum, char *buf, size_t buflen);
182
183int 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);
186void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
187void symbol__annotate_decay_histogram(struct symbol *sym, int evidx);
188void disasm__purge(struct list_head *head);
189
190bool ui__has_annotation(void);
191
192int 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
197int symbol__tui_annotate(struct symbol *sym, struct map *map,
198 struct perf_evsel *evsel,
199 struct hist_browser_timer *hbt);
200#else
201static 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
211extern const char *disassembler_style;
212
213#endif /* __PERF_ANNOTATE_H */
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
14struct ins;
15
16struct 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
37struct 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
44struct ins {
45 const char *name;
46 struct ins_ops *ops;
47};
48
49bool ins__is_jump(const struct ins *ins);
50bool ins__is_call(const struct ins *ins);
51int ins__scnprintf(struct ins *ins, char *bf, size_t size, struct ins_operands *ops);
52
53struct annotation;
54
55struct disasm_line {
56 struct list_head node;
57 s64 offset;
58 char *line;
59 char *name;
60 struct ins *ins;
61 struct ins_operands ops;
62};
63
64static inline bool disasm_line__has_offset(const struct disasm_line *dl)
65{
66 return dl->ops.target.offset != UINT64_MAX;
67}
68
69void disasm_line__free(struct disasm_line *dl);
70struct disasm_line *disasm__get_next_ip_line(struct list_head *head, struct disasm_line *pos);
71int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw);
72size_t disasm__fprintf(struct list_head *head, FILE *fp);
73double disasm__calc_percent(struct annotation *notes, int evidx, s64 offset,
74 s64 end, const char **path);
75
76struct sym_hist {
77 u64 sum;
78 u64 addr[0];
79};
80
81struct source_line_percent {
82 double percent;
83 double percent_sum;
84};
85
86struct source_line {
87 struct rb_node node;
88 char *path;
89 int nr_pcnt;
90 struct source_line_percent p[1];
91};
92
93/** struct annotated_source - symbols with hits have this attached as in sannotation
94 *
95 * @histogram: Array of addr hit histograms per event being monitored
96 * @lines: If 'print_lines' is specified, per source code line percentages
97 * @source: source parsed from a disassembler like objdump -dS
98 *
99 * lines is allocated, percentages calculated and all sorted by percentage
100 * when the annotation is about to be presented, so the percentages are for
101 * one of the entries in the histogram array, i.e. for the event/counter being
102 * presented. It is deallocated right after symbol__{tui,tty,etc}_annotate
103 * returns.
104 */
105struct annotated_source {
106 struct list_head source;
107 struct source_line *lines;
108 int nr_histograms;
109 int sizeof_sym_hist;
110 struct sym_hist histograms[0];
111};
112
113struct annotation {
114 pthread_mutex_t lock;
115 struct annotated_source *src;
116};
117
118struct sannotation {
119 struct annotation annotation;
120 struct symbol symbol;
121};
122
123static inline struct sym_hist *annotation__histogram(struct annotation *notes, int idx)
124{
125 return (((void *)¬es->src->histograms) +
126 (notes->src->sizeof_sym_hist * idx));
127}
128
129static inline struct annotation *symbol__annotation(struct symbol *sym)
130{
131 struct sannotation *a = container_of(sym, struct sannotation, symbol);
132 return &a->annotation;
133}
134
135int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, int evidx);
136
137int hist_entry__inc_addr_samples(struct hist_entry *he, int evidx, u64 addr);
138
139int symbol__alloc_hist(struct symbol *sym);
140void symbol__annotate_zero_histograms(struct symbol *sym);
141
142int symbol__annotate(struct symbol *sym, struct map *map, size_t privsize);
143
144int hist_entry__annotate(struct hist_entry *he, size_t privsize);
145
146int symbol__annotate_init(struct map *map __maybe_unused, struct symbol *sym);
147int symbol__annotate_printf(struct symbol *sym, struct map *map,
148 struct perf_evsel *evsel, bool full_paths,
149 int min_pcnt, int max_lines, int context);
150void symbol__annotate_zero_histogram(struct symbol *sym, int evidx);
151void symbol__annotate_decay_histogram(struct symbol *sym, int evidx);
152void disasm__purge(struct list_head *head);
153
154bool ui__has_annotation(void);
155
156int symbol__tty_annotate(struct symbol *sym, struct map *map,
157 struct perf_evsel *evsel, bool print_lines,
158 bool full_paths, int min_pcnt, int max_lines);
159
160#ifdef HAVE_SLANG_SUPPORT
161int symbol__tui_annotate(struct symbol *sym, struct map *map,
162 struct perf_evsel *evsel,
163 struct hist_browser_timer *hbt);
164#else
165static inline int symbol__tui_annotate(struct symbol *sym __maybe_unused,
166 struct map *map __maybe_unused,
167 struct perf_evsel *evsel __maybe_unused,
168 struct hist_browser_timer *hbt
169 __maybe_unused)
170{
171 return 0;
172}
173#endif
174
175extern const char *disassembler_style;
176
177#endif /* __PERF_ANNOTATE_H */