Merge git://git.kernel.org/pub/scm/linux/kernel/git/steve/gfs2-2.6-nmw
[cascardo/linux.git] / tools / perf / util / symbol.h
1 #ifndef __PERF_SYMBOL
2 #define __PERF_SYMBOL 1
3
4 #include <linux/types.h>
5 #include <stdbool.h>
6 #include <stdint.h>
7 #include "map.h"
8 #include <linux/list.h>
9 #include <linux/rbtree.h>
10 #include <stdio.h>
11
12 #ifdef HAVE_CPLUS_DEMANGLE
13 extern char *cplus_demangle(const char *, int);
14
15 static inline char *bfd_demangle(void __used *v, const char *c, int i)
16 {
17         return cplus_demangle(c, i);
18 }
19 #else
20 #ifdef NO_DEMANGLE
21 static inline char *bfd_demangle(void __used *v, const char __used *c,
22                                  int __used i)
23 {
24         return NULL;
25 }
26 #else
27 #include <bfd.h>
28 #endif
29 #endif
30
31 int hex2u64(const char *ptr, u64 *val);
32 char *strxfrchar(char *s, char from, char to);
33
34 /*
35  * libelf 0.8.x and earlier do not support ELF_C_READ_MMAP;
36  * for newer versions we can use mmap to reduce memory usage:
37  */
38 #ifdef LIBELF_NO_MMAP
39 # define PERF_ELF_C_READ_MMAP ELF_C_READ
40 #else
41 # define PERF_ELF_C_READ_MMAP ELF_C_READ_MMAP
42 #endif
43
44 #ifndef DMGL_PARAMS
45 #define DMGL_PARAMS      (1 << 0)       /* Include function args */
46 #define DMGL_ANSI        (1 << 1)       /* Include const, volatile, etc */
47 #endif
48
49 #define BUILD_ID_SIZE 20
50
51 struct symbol {
52         struct rb_node  rb_node;
53         u64             start;
54         u64             end;
55         u16             namelen;
56         u8              binding;
57         char            name[0];
58 };
59
60 void symbol__delete(struct symbol *self);
61
62 struct strlist;
63
64 struct symbol_conf {
65         unsigned short  priv_size;
66         bool            try_vmlinux_path,
67                         use_modules,
68                         sort_by_name,
69                         show_nr_samples,
70                         use_callchain,
71                         exclude_other,
72                         show_cpu_utilization,
73                         initialized;
74         const char      *vmlinux_name,
75                         *source_prefix,
76                         *field_sep;
77         const char      *default_guest_vmlinux_name,
78                         *default_guest_kallsyms,
79                         *default_guest_modules;
80         const char      *guestmount;
81         const char      *dso_list_str,
82                         *comm_list_str,
83                         *sym_list_str,
84                         *col_width_list_str;
85        struct strlist   *dso_list,
86                         *comm_list,
87                         *sym_list;
88 };
89
90 extern struct symbol_conf symbol_conf;
91
92 static inline void *symbol__priv(struct symbol *self)
93 {
94         return ((void *)self) - symbol_conf.priv_size;
95 }
96
97 struct ref_reloc_sym {
98         const char      *name;
99         u64             addr;
100         u64             unrelocated_addr;
101 };
102
103 struct map_symbol {
104         struct map    *map;
105         struct symbol *sym;
106         bool          unfolded;
107         bool          has_children;
108 };
109
110 struct addr_location {
111         struct thread *thread;
112         struct map    *map;
113         struct symbol *sym;
114         u64           addr;
115         char          level;
116         bool          filtered;
117         u8            cpumode;
118         s32           cpu;
119 };
120
121 enum dso_kernel_type {
122         DSO_TYPE_USER = 0,
123         DSO_TYPE_KERNEL,
124         DSO_TYPE_GUEST_KERNEL
125 };
126
127 struct dso {
128         struct list_head node;
129         struct rb_root   symbols[MAP__NR_TYPES];
130         struct rb_root   symbol_names[MAP__NR_TYPES];
131         enum dso_kernel_type    kernel;
132         u8               adjust_symbols:1;
133         u8               slen_calculated:1;
134         u8               has_build_id:1;
135         u8               hit:1;
136         u8               annotate_warned:1;
137         u8               sname_alloc:1;
138         u8               lname_alloc:1;
139         unsigned char    origin;
140         u8               sorted_by_name;
141         u8               loaded;
142         u8               build_id[BUILD_ID_SIZE];
143         const char       *short_name;
144         char             *long_name;
145         u16              long_name_len;
146         u16              short_name_len;
147         char             name[0];
148 };
149
150 struct dso *dso__new(const char *name);
151 struct dso *dso__new_kernel(const char *name);
152 void dso__delete(struct dso *self);
153
154 int dso__name_len(const struct dso *self);
155
156 bool dso__loaded(const struct dso *self, enum map_type type);
157 bool dso__sorted_by_name(const struct dso *self, enum map_type type);
158
159 static inline void dso__set_loaded(struct dso *self, enum map_type type)
160 {
161         self->loaded |= (1 << type);
162 }
163
164 void dso__sort_by_name(struct dso *self, enum map_type type);
165
166 struct dso *__dsos__findnew(struct list_head *head, const char *name);
167
168 int dso__load(struct dso *self, struct map *map, symbol_filter_t filter);
169 int dso__load_vmlinux(struct dso *self, struct map *map,
170                       const char *vmlinux, symbol_filter_t filter);
171 int dso__load_vmlinux_path(struct dso *self, struct map *map,
172                            symbol_filter_t filter);
173 int dso__load_kallsyms(struct dso *self, const char *filename, struct map *map,
174                        symbol_filter_t filter);
175 int machine__load_kallsyms(struct machine *self, const char *filename,
176                            enum map_type type, symbol_filter_t filter);
177 int machine__load_vmlinux_path(struct machine *self, enum map_type type,
178                                symbol_filter_t filter);
179
180 size_t __dsos__fprintf(struct list_head *head, FILE *fp);
181
182 size_t machine__fprintf_dsos_buildid(struct machine *self, FILE *fp, bool with_hits);
183 size_t machines__fprintf_dsos(struct rb_root *self, FILE *fp);
184 size_t machines__fprintf_dsos_buildid(struct rb_root *self, FILE *fp, bool with_hits);
185
186 size_t dso__fprintf_buildid(struct dso *self, FILE *fp);
187 size_t dso__fprintf_symbols_by_name(struct dso *self, enum map_type type, FILE *fp);
188 size_t dso__fprintf(struct dso *self, enum map_type type, FILE *fp);
189
190 enum dso_origin {
191         DSO__ORIG_KERNEL = 0,
192         DSO__ORIG_GUEST_KERNEL,
193         DSO__ORIG_JAVA_JIT,
194         DSO__ORIG_BUILD_ID_CACHE,
195         DSO__ORIG_FEDORA,
196         DSO__ORIG_UBUNTU,
197         DSO__ORIG_BUILDID,
198         DSO__ORIG_DSO,
199         DSO__ORIG_GUEST_KMODULE,
200         DSO__ORIG_KMODULE,
201         DSO__ORIG_NOT_FOUND,
202 };
203
204 char dso__symtab_origin(const struct dso *self);
205 void dso__set_long_name(struct dso *self, char *name);
206 void dso__set_build_id(struct dso *self, void *build_id);
207 void dso__read_running_kernel_build_id(struct dso *self, struct machine *machine);
208 struct symbol *dso__find_symbol(struct dso *self, enum map_type type, u64 addr);
209 struct symbol *dso__find_symbol_by_name(struct dso *self, enum map_type type,
210                                         const char *name);
211
212 int filename__read_build_id(const char *filename, void *bf, size_t size);
213 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
214 bool __dsos__read_build_ids(struct list_head *head, bool with_hits);
215 int build_id__sprintf(const u8 *self, int len, char *bf);
216 int kallsyms__parse(const char *filename, void *arg,
217                     int (*process_symbol)(void *arg, const char *name,
218                                           char type, u64 start));
219
220 void machine__destroy_kernel_maps(struct machine *self);
221 int __machine__create_kernel_maps(struct machine *self, struct dso *kernel);
222 int machine__create_kernel_maps(struct machine *self);
223
224 int machines__create_kernel_maps(struct rb_root *self, pid_t pid);
225 int machines__create_guest_kernel_maps(struct rb_root *self);
226 void machines__destroy_guest_kernel_maps(struct rb_root *self);
227
228 int symbol__init(void);
229 void symbol__exit(void);
230 bool symbol_type__is_a(char symbol_type, enum map_type map_type);
231
232 size_t machine__fprintf_vmlinux_path(struct machine *self, FILE *fp);
233
234 #endif /* __PERF_SYMBOL */