Commit 813ccd15452ed34e97aa526ffc70d6d8e6c466c5

Authored by Namhyung Kim
Committed by Arnaldo Carvalho de Melo
1 parent b93b096782

perf tools: Fix segfault for symbol annotation on TUI

Currently the symbol structure is allocated with symbol_conf.priv_size
to carry sideband information like annotation, map browser on TUI and
sort-by-name tree node.  So retrieving these information from symbol
needs to care about the details of such placement.

However the annotation code just assumes that the symbol is placed after
the struct annotation.  But actually there's other info between them.
So accessing those struct will lead to an undefined behavior (usually a
crash) after they write their info to the same location.

To reproduce the problem, please follow the steps below:

  1. run perf report (TUI of course) with -v option
  2. open map browser (by pressing right arrow key for any entry)
  3. search any function (by pressing '/' key and input whatever..)
  4. return to the hist browser (by pressing 'q' or left arrow key)
  5. open annotation window for the same entry (by pressing 'a' key)

Signed-off-by: Namhyung Kim <namhyung@kernel.org>
Cc: David Ahern <dsahern@gmail.com>
Cc: Ingo Molnar <mingo@kernel.org>
Cc: Jiri Olsa <jolsa@redhat.com>
Cc: Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
Link: http://lkml.kernel.org/r/1421234288-22758-1-git-send-email-namhyung@kernel.org
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>

Showing 1 changed file with 1 additions and 7 deletions Inline Diff

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