906be20011d93ce7aeeea9d02c9026a3bf2db359
[linux-2.6.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         char            name[0];
57 };
58
59 void symbol__delete(struct symbol *self);
60
61 struct strlist;
62
63 struct symbol_conf {
64         unsigned short  priv_size;
65         bool            try_vmlinux_path,
66                         use_modules,
67                         sort_by_name,
68                         show_nr_samples,
69                         use_callchain,
70                         exclude_other,
71                         show_cpu_utilization;
72         const char      *vmlinux_name,
73                         *source_prefix,
74                         *field_sep;
75         const char      *default_guest_vmlinux_name,
76                         *default_guest_kallsyms,
77                         *default_guest_modules;
78         const char      *guestmount;
79         const char      *dso_list_str,
80                         *comm_list_str,
81                         *sym_list_str,
82                         *col_width_list_str;
83        struct strlist   *dso_list,
84                         *comm_list,
85                         *sym_list;
86 };
87
88 extern struct symbol_conf symbol_conf;
89
90 static inline void *symbol__priv(struct symbol *self)
91 {
92         return ((void *)self) - symbol_conf.priv_size;
93 }
94
95 struct ref_reloc_sym {
96         const char      *name;
97         u64             addr;
98         u64             unrelocated_addr;
99 };
100
101 struct map_symbol {
102         struct map    *map;
103         struct symbol *sym;
104         bool          unfolded;
105         bool          has_children;
106 };
107
108 struct addr_location {
109         struct thread *thread;
110         struct map    *map;
111         struct symbol *sym;
112         u64           addr;
113         char          level;
114         bool          filtered;
115         u8            cpumode;
116         s32           cpu;
117 };
118
119 enum dso_kernel_type {
120         DSO_TYPE_USER = 0,
121         DSO_TYPE_KERNEL,
122         DSO_TYPE_GUEST_KERNEL
123 };
124
125 struct dso {
126         struct list_head node;
127         struct rb_root   symbols[MAP__NR_TYPES];
128         struct rb_root   symbol_names[MAP__NR_TYPES];
129         enum dso_kernel_type    kernel;
130         u8               adjust_symbols:1;
131         u8               slen_calculated:1;
132         u8               has_build_id:1;
133         u8               hit:1;
134         u8               annotate_warned:1;
135         u8               sname_alloc:1;
136         u8               lname_alloc:1;
137         unsigned char    origin;
138         u8               sorted_by_name;
139         u8               loaded;
140         u8               build_id[BUILD_ID_SIZE];
141         const char       *short_name;
142         char             *long_name;
143         u16              long_name_len;
144         u16              short_name_len;
145         char             name[0];
146 };
147
148 struct dso *dso__new(const char *name);
149 struct dso *dso__new_kernel(const char *name);
150 void dso__delete(struct dso *self);
151
152 int dso__name_len(const struct dso *self);
153
154 bool dso__loaded(const struct dso *self, enum map_type type);
155 bool dso__sorted_by_name(const struct dso *self, enum map_type type);
156
157 static inline void dso__set_loaded(struct dso *self, enum map_type type)
158 {
159         self->loaded |= (1 << type);
160 }
161
162 void dso__sort_by_name(struct dso *self, enum map_type type);
163
164 struct dso *__dsos__findnew(struct list_head *head, const char *name);
165
166 int dso__load(struct dso *self, struct map *map, symbol_filter_t filter);
167 int dso__load_vmlinux_path(struct dso *self, struct map *map,
168                            symbol_filter_t filter);
169 int dso__load_kallsyms(struct dso *self, const char *filename, struct map *map,
170                        symbol_filter_t filter);
171 int machine__load_kallsyms(struct machine *self, const char *filename,
172                            enum map_type type, symbol_filter_t filter);
173 int machine__load_vmlinux_path(struct machine *self, enum map_type type,
174                                symbol_filter_t filter);
175
176 size_t __dsos__fprintf(struct list_head *head, FILE *fp);
177
178 size_t machine__fprintf_dsos_buildid(struct machine *self, FILE *fp, bool with_hits);
179 size_t machines__fprintf_dsos(struct rb_root *self, FILE *fp);
180 size_t machines__fprintf_dsos_buildid(struct rb_root *self, FILE *fp, bool with_hits);
181
182 size_t dso__fprintf_buildid(struct dso *self, FILE *fp);
183 size_t dso__fprintf(struct dso *self, enum map_type type, FILE *fp);
184
185 enum dso_origin {
186         DSO__ORIG_KERNEL = 0,
187         DSO__ORIG_GUEST_KERNEL,
188         DSO__ORIG_JAVA_JIT,
189         DSO__ORIG_BUILD_ID_CACHE,
190         DSO__ORIG_FEDORA,
191         DSO__ORIG_UBUNTU,
192         DSO__ORIG_BUILDID,
193         DSO__ORIG_DSO,
194         DSO__ORIG_GUEST_KMODULE,
195         DSO__ORIG_KMODULE,
196         DSO__ORIG_NOT_FOUND,
197 };
198
199 char dso__symtab_origin(const struct dso *self);
200 void dso__set_long_name(struct dso *self, char *name);
201 void dso__set_build_id(struct dso *self, void *build_id);
202 void dso__read_running_kernel_build_id(struct dso *self, struct machine *machine);
203 struct symbol *dso__find_symbol(struct dso *self, enum map_type type, u64 addr);
204 struct symbol *dso__find_symbol_by_name(struct dso *self, enum map_type type,
205                                         const char *name);
206
207 int filename__read_build_id(const char *filename, void *bf, size_t size);
208 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
209 bool __dsos__read_build_ids(struct list_head *head, bool with_hits);
210 int build_id__sprintf(const u8 *self, int len, char *bf);
211 int kallsyms__parse(const char *filename, void *arg,
212                     int (*process_symbol)(void *arg, const char *name,
213                                           char type, u64 start));
214
215 void machine__destroy_kernel_maps(struct machine *self);
216 int __machine__create_kernel_maps(struct machine *self, struct dso *kernel);
217 int machine__create_kernel_maps(struct machine *self);
218
219 int machines__create_kernel_maps(struct rb_root *self, pid_t pid);
220 int machines__create_guest_kernel_maps(struct rb_root *self);
221 void machines__destroy_guest_kernel_maps(struct rb_root *self);
222
223 int symbol__init(void);
224 void symbol__exit(void);
225 bool symbol_type__is_a(char symbol_type, enum map_type map_type);
226
227 size_t machine__fprintf_vmlinux_path(struct machine *self, FILE *fp);
228
229 #endif /* __PERF_SYMBOL */