xref: /linux/tools/perf/util/symbol.h (revision 8b1935e6a36b0967efc593d67ed3aebbfbc1f5b1)
1 #ifndef __PERF_SYMBOL
2 #define __PERF_SYMBOL 1
3 
4 #include <linux/types.h>
5 #include <stdbool.h>
6 #include "types.h"
7 #include <linux/list.h>
8 #include <linux/rbtree.h>
9 #include "event.h"
10 
11 #define DEBUG_CACHE_DIR ".debug"
12 
13 #ifdef HAVE_CPLUS_DEMANGLE
14 extern char *cplus_demangle(const char *, int);
15 
16 static inline char *bfd_demangle(void __used *v, const char *c, int i)
17 {
18 	return cplus_demangle(c, i);
19 }
20 #else
21 #ifdef NO_DEMANGLE
22 static inline char *bfd_demangle(void __used *v, const char __used *c,
23 				 int __used i)
24 {
25 	return NULL;
26 }
27 #else
28 #include <bfd.h>
29 #endif
30 #endif
31 
32 /*
33  * libelf 0.8.x and earlier do not support ELF_C_READ_MMAP;
34  * for newer versions we can use mmap to reduce memory usage:
35  */
36 #ifdef LIBELF_NO_MMAP
37 # define PERF_ELF_C_READ_MMAP ELF_C_READ
38 #else
39 # define PERF_ELF_C_READ_MMAP ELF_C_READ_MMAP
40 #endif
41 
42 #ifndef DMGL_PARAMS
43 #define DMGL_PARAMS      (1 << 0)       /* Include function args */
44 #define DMGL_ANSI        (1 << 1)       /* Include const, volatile, etc */
45 #endif
46 
47 struct symbol {
48 	struct rb_node	rb_node;
49 	u64		start;
50 	u64		end;
51 	char		name[0];
52 };
53 
54 void symbol__delete(struct symbol *self);
55 
56 struct strlist;
57 
58 struct symbol_conf {
59 	unsigned short	priv_size;
60 	bool		try_vmlinux_path,
61 			use_modules,
62 			sort_by_name,
63 			show_nr_samples,
64 			use_callchain,
65 			exclude_other,
66 			full_paths;
67 	const char	*vmlinux_name,
68 			*field_sep;
69 	char            *dso_list_str,
70 			*comm_list_str,
71 			*sym_list_str,
72 			*col_width_list_str;
73        struct strlist	*dso_list,
74 			*comm_list,
75 			*sym_list;
76 };
77 
78 extern struct symbol_conf symbol_conf;
79 
80 static inline void *symbol__priv(struct symbol *self)
81 {
82 	return ((void *)self) - symbol_conf.priv_size;
83 }
84 
85 struct ref_reloc_sym {
86 	const char	*name;
87 	u64		addr;
88 	u64		unrelocated_addr;
89 };
90 
91 struct addr_location {
92 	struct thread *thread;
93 	struct map    *map;
94 	struct symbol *sym;
95 	u64	      addr;
96 	char	      level;
97 	bool	      filtered;
98 };
99 
100 struct dso {
101 	struct list_head node;
102 	struct rb_root	 symbols[MAP__NR_TYPES];
103 	struct rb_root	 symbol_names[MAP__NR_TYPES];
104 	u8		 adjust_symbols:1;
105 	u8		 slen_calculated:1;
106 	u8		 has_build_id:1;
107 	u8		 kernel:1;
108 	u8		 hit:1;
109 	unsigned char	 origin;
110 	u8		 sorted_by_name;
111 	u8		 loaded;
112 	u8		 build_id[BUILD_ID_SIZE];
113 	u16		 long_name_len;
114 	const char	 *short_name;
115 	char	 	 *long_name;
116 	char		 name[0];
117 };
118 
119 struct dso *dso__new(const char *name);
120 struct dso *dso__new_kernel(const char *name);
121 void dso__delete(struct dso *self);
122 
123 bool dso__loaded(const struct dso *self, enum map_type type);
124 bool dso__sorted_by_name(const struct dso *self, enum map_type type);
125 
126 static inline void dso__set_loaded(struct dso *self, enum map_type type)
127 {
128 	self->loaded |= (1 << type);
129 }
130 
131 void dso__sort_by_name(struct dso *self, enum map_type type);
132 
133 extern struct list_head dsos__user, dsos__kernel;
134 
135 struct dso *__dsos__findnew(struct list_head *head, const char *name);
136 
137 static inline struct dso *dsos__findnew(const char *name)
138 {
139 	return __dsos__findnew(&dsos__user, name);
140 }
141 
142 int dso__load(struct dso *self, struct map *map, symbol_filter_t filter);
143 int dso__load_vmlinux_path(struct dso *self, struct map *map,
144 			   symbol_filter_t filter);
145 int dso__load_kallsyms(struct dso *self, const char *filename, struct map *map,
146 		       symbol_filter_t filter);
147 void dsos__fprintf(FILE *fp);
148 size_t dsos__fprintf_buildid(FILE *fp, bool with_hits);
149 
150 size_t dso__fprintf_buildid(struct dso *self, FILE *fp);
151 size_t dso__fprintf(struct dso *self, enum map_type type, FILE *fp);
152 char dso__symtab_origin(const struct dso *self);
153 void dso__set_long_name(struct dso *self, char *name);
154 void dso__set_build_id(struct dso *self, void *build_id);
155 void dso__read_running_kernel_build_id(struct dso *self);
156 struct symbol *dso__find_symbol(struct dso *self, enum map_type type, u64 addr);
157 struct symbol *dso__find_symbol_by_name(struct dso *self, enum map_type type,
158 					const char *name);
159 
160 int filename__read_build_id(const char *filename, void *bf, size_t size);
161 int sysfs__read_build_id(const char *filename, void *bf, size_t size);
162 bool dsos__read_build_ids(bool with_hits);
163 int build_id__sprintf(const u8 *self, int len, char *bf);
164 int kallsyms__parse(const char *filename, void *arg,
165 		    int (*process_symbol)(void *arg, const char *name,
166 					  char type, u64 start));
167 
168 int symbol__init(void);
169 bool symbol_type__is_a(char symbol_type, enum map_type map_type);
170 
171 #endif /* __PERF_SYMBOL */
172