[net-next-2.6.git] / tools / perf / util / symbol.h

#ifndef __PERF_SYMBOL
#define __PERF_SYMBOL 1

#include <linux/types.h>
#include <stdbool.h>
#include <stdint.h>
#include "map.h"
#include <linux/list.h>
#include <linux/rbtree.h>
#include <stdio.h>

#ifdef HAVE_CPLUS_DEMANGLE
extern char *cplus_demangle(const char *, int);

static inline char *bfd_demangle(void __used *v, const char *c, int i)
{
	return cplus_demangle(c, i);
}
#else
#ifdef NO_DEMANGLE
static inline char *bfd_demangle(void __used *v, const char __used *c,
				 int __used i)
{
	return NULL;
}
#else
#include <bfd.h>
#endif
#endif

int hex2u64(const char *ptr, u64 *val);
char *strxfrchar(char *s, char from, char to);

/*
 * libelf 0.8.x and earlier do not support ELF_C_READ_MMAP;
 * for newer versions we can use mmap to reduce memory usage:
 */
#ifdef LIBELF_NO_MMAP
# define PERF_ELF_C_READ_MMAP ELF_C_READ
#else
# define PERF_ELF_C_READ_MMAP ELF_C_READ_MMAP
#endif

#ifndef DMGL_PARAMS
#define DMGL_PARAMS      (1 << 0)       /* Include function args */
#define DMGL_ANSI        (1 << 1)       /* Include const, volatile, etc */
#endif

#define BUILD_ID_SIZE 20

struct symbol {
	struct rb_node	rb_node;
	u64		start;
	u64		end;
	u16		namelen;
	u8		binding;
	char		name[0];
};

void symbol__delete(struct symbol *self);

struct strlist;

struct symbol_conf {
	unsigned short	priv_size;
	bool		try_vmlinux_path,
			use_modules,
			sort_by_name,
			show_nr_samples,
			use_callchain,
			exclude_other,
			show_cpu_utilization,
			initialized;
	const char	*vmlinux_name,
			*source_prefix,
			*field_sep;
	const char	*default_guest_vmlinux_name,
			*default_guest_kallsyms,
			*default_guest_modules;
	const char	*guestmount;
	const char	*dso_list_str,
			*comm_list_str,
			*sym_list_str,
			*col_width_list_str;
       struct strlist	*dso_list,
			*comm_list,
			*sym_list;
};

extern struct symbol_conf symbol_conf;

static inline void *symbol__priv(struct symbol *self)
{
	return ((void *)self) - symbol_conf.priv_size;
}

struct ref_reloc_sym {
	const char	*name;
	u64		addr;
	u64		unrelocated_addr;
};

struct map_symbol {
	struct map    *map;
	struct symbol *sym;
	bool	      unfolded;
	bool	      has_children;
};

struct addr_location {
	struct thread *thread;
	struct map    *map;
	struct symbol *sym;
	u64	      addr;
	char	      level;
	bool	      filtered;
	u8	      cpumode;
	s32	      cpu;
};

enum dso_kernel_type {
	DSO_TYPE_USER = 0,
	DSO_TYPE_KERNEL,
	DSO_TYPE_GUEST_KERNEL
};

struct dso {
	struct list_head node;
	struct rb_root	 symbols[MAP__NR_TYPES];
	struct rb_root	 symbol_names[MAP__NR_TYPES];
	enum dso_kernel_type	kernel;
	u8		 adjust_symbols:1;
	u8		 slen_calculated:1;
	u8		 has_build_id:1;
	u8		 hit:1;
	u8		 annotate_warned:1;
	u8		 sname_alloc:1;
	u8		 lname_alloc:1;
	unsigned char	 origin;
	u8		 sorted_by_name;
	u8		 loaded;
	u8		 build_id[BUILD_ID_SIZE];
	const char	 *short_name;
	char	 	 *long_name;
	u16		 long_name_len;
	u16		 short_name_len;
	char		 name[0];
};

struct dso *dso__new(const char *name);
struct dso *dso__new_kernel(const char *name);
void dso__delete(struct dso *self);

int dso__name_len(const struct dso *self);

bool dso__loaded(const struct dso *self, enum map_type type);
bool dso__sorted_by_name(const struct dso *self, enum map_type type);

static inline void dso__set_loaded(struct dso *self, enum map_type type)
{
	self->loaded |= (1 << type);
}

void dso__sort_by_name(struct dso *self, enum map_type type);

struct dso *__dsos__findnew(struct list_head *head, const char *name);

int dso__load(struct dso *self, struct map *map, symbol_filter_t filter);
int dso__load_vmlinux_path(struct dso *self, struct map *map,
			   symbol_filter_t filter);
int dso__load_kallsyms(struct dso *self, const char *filename, struct map *map,
		       symbol_filter_t filter);
int machine__load_kallsyms(struct machine *self, const char *filename,
			   enum map_type type, symbol_filter_t filter);
int machine__load_vmlinux_path(struct machine *self, enum map_type type,
			       symbol_filter_t filter);

size_t __dsos__fprintf(struct list_head *head, FILE *fp);

size_t machine__fprintf_dsos_buildid(struct machine *self, FILE *fp, bool with_hits);
size_t machines__fprintf_dsos(struct rb_root *self, FILE *fp);
size_t machines__fprintf_dsos_buildid(struct rb_root *self, FILE *fp, bool with_hits);

size_t dso__fprintf_buildid(struct dso *self, FILE *fp);
size_t dso__fprintf(struct dso *self, enum map_type type, FILE *fp);

enum dso_origin {
	DSO__ORIG_KERNEL = 0,
	DSO__ORIG_GUEST_KERNEL,
	DSO__ORIG_JAVA_JIT,
	DSO__ORIG_BUILD_ID_CACHE,
	DSO__ORIG_FEDORA,
	DSO__ORIG_UBUNTU,
	DSO__ORIG_BUILDID,
	DSO__ORIG_DSO,
	DSO__ORIG_GUEST_KMODULE,
	DSO__ORIG_KMODULE,
	DSO__ORIG_NOT_FOUND,
};

char dso__symtab_origin(const struct dso *self);
void dso__set_long_name(struct dso *self, char *name);
void dso__set_build_id(struct dso *self, void *build_id);
void dso__read_running_kernel_build_id(struct dso *self, struct machine *machine);
struct symbol *dso__find_symbol(struct dso *self, enum map_type type, u64 addr);
struct symbol *dso__find_symbol_by_name(struct dso *self, enum map_type type,
					const char *name);

int filename__read_build_id(const char *filename, void *bf, size_t size);
int sysfs__read_build_id(const char *filename, void *bf, size_t size);
bool __dsos__read_build_ids(struct list_head *head, bool with_hits);
int build_id__sprintf(const u8 *self, int len, char *bf);
int kallsyms__parse(const char *filename, void *arg,
		    int (*process_symbol)(void *arg, const char *name,
					  char type, u64 start));

void machine__destroy_kernel_maps(struct machine *self);
int __machine__create_kernel_maps(struct machine *self, struct dso *kernel);
int machine__create_kernel_maps(struct machine *self);

int machines__create_kernel_maps(struct rb_root *self, pid_t pid);
int machines__create_guest_kernel_maps(struct rb_root *self);
void machines__destroy_guest_kernel_maps(struct rb_root *self);

int symbol__init(void);
void symbol__exit(void);
bool symbol_type__is_a(char symbol_type, enum map_type map_type);

size_t machine__fprintf_vmlinux_path(struct machine *self, FILE *fp);

#endif /* __PERF_SYMBOL */
Commit	Line	Data
8b40f521 JK	1	#ifndef __PERF_SYMBOL
8b40f521 JK	2	#define __PERF_SYMBOL 1
a2928c42 ACM	3
a2928c42 ACM	4	#include <linux/types.h>
e4204992	5	#include <stdbool.h>
5aab621b ACM	6	#include <stdint.h>
5aab621b ACM	7	#include "map.h"
5da50258	8	#include <linux/list.h>
43cbcd8a	9	#include <linux/rbtree.h>
5aab621b	10	#include <stdio.h>
a2928c42	11
247648e3 ACM	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
5aab621b ACM	31	int hex2u64(const char ptr, u64 val);
	32	char strxfrchar(char s, char from, char to);
	33
84087126 MR	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
247648e3 ACM	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
5aab621b ACM	49	#define BUILD_ID_SIZE 20
5aab621b ACM	50
a2928c42 ACM	51	struct symbol {
a2928c42 ACM	52	struct rb_node rb_node;
9cffa8d5 PM	53	u64 start;
9cffa8d5 PM	54	u64 end;
fefb0b94	55	u16 namelen;
c408fedf	56	u8 binding;
a2928c42 ACM	57	char name[0];
	58	};
	59
628ada0c ACM	60	void symbol__delete(struct symbol *self);
628ada0c ACM	61
655000e7 ACM	62	struct strlist;
655000e7 ACM	63
b32d133a ACM	64	struct symbol_conf {
	65	unsigned short priv_size;
	66	bool try_vmlinux_path,
79406cd7	67	use_modules,
d599db3f ACM	68	sort_by_name,
	69	show_nr_samples,
	70	use_callchain,
f7d87444	71	exclude_other,
85e00b55 JZ	72	show_cpu_utilization,
85e00b55 JZ	73	initialized;
c410a338	74	const char *vmlinux_name,
9ed7e1b8	75	*source_prefix,
c410a338	76	*field_sep;
a1645ce1 ZY	77	const char *default_guest_vmlinux_name,
	78	*default_guest_kallsyms,
	79	*default_guest_modules;
	80	const char *guestmount;
edb7c60e	81	const char *dso_list_str,
655000e7 ACM	82	*comm_list_str,
	83	*sym_list_str,
	84	*col_width_list_str;
	85	struct strlist *dso_list,
	86	*comm_list,
	87	*sym_list;
b32d133a ACM	88	};
b32d133a ACM	89
75be6cf4	90	extern struct symbol_conf symbol_conf;
00a192b3 ACM	91
	92	static inline void symbol__priv(struct symbol self)
	93	{
75be6cf4	94	return ((void *)self) - symbol_conf.priv_size;
00a192b3 ACM	95	}
00a192b3 ACM	96
9de89fe7 ACM	97	struct ref_reloc_sym {
	98	const char *name;
	99	u64 addr;
	100	u64 unrelocated_addr;
	101	};
	102
59fd5306 ACM	103	struct map_symbol {
	104	struct map *map;
	105	struct symbol *sym;
0f0cbf7a ACM	106	bool unfolded;
0f0cbf7a ACM	107	bool has_children;
59fd5306 ACM	108	};
59fd5306 ACM	109
1ed091c4 ACM	110	struct addr_location {
	111	struct thread *thread;
	112	struct map *map;
	113	struct symbol *sym;
	114	u64 addr;
	115	char level;
c410a338	116	bool filtered;
f60f3593 AS	117	u8 cpumode;
f60f3593 AS	118	s32 cpu;
a1645ce1 ZY	119	};
	120
	121	enum dso_kernel_type {
	122	DSO_TYPE_USER = 0,
	123	DSO_TYPE_KERNEL,
	124	DSO_TYPE_GUEST_KERNEL
1ed091c4 ACM	125	};
1ed091c4 ACM	126
a2928c42 ACM	127	struct dso {
a2928c42 ACM	128	struct list_head node;
6a4694a4	129	struct rb_root symbols[MAP__NR_TYPES];
79406cd7	130	struct rb_root symbol_names[MAP__NR_TYPES];
6e406257	131	enum dso_kernel_type kernel;
8d06367f ACM	132	u8 adjust_symbols:1;
8d06367f ACM	133	u8 slen_calculated:1;
8d06367f	134	u8 has_build_id:1;
88d3d9b7	135	u8 hit:1;
d06d92b7	136	u8 annotate_warned:1;
6e406257 ACM	137	u8 sname_alloc:1;
6e406257 ACM	138	u8 lname_alloc:1;
94cb9e38	139	unsigned char origin;
79406cd7	140	u8 sorted_by_name;
3610583c	141	u8 loaded;
8d06367f	142	u8 build_id[BUILD_ID_SIZE];
439d473b ACM	143	const char *short_name;
439d473b ACM	144	char *long_name;
b63be8d7 ACM	145	u16 long_name_len;
b63be8d7 ACM	146	u16 short_name_len;
a2928c42 ACM	147	char name[0];
	148	};
	149
00a192b3	150	struct dso dso__new(const char name);
fd1d908c	151	struct dso dso__new_kernel(const char name);
a2928c42 ACM	152	void dso__delete(struct dso *self);
a2928c42 ACM	153
8a6c5b26 ACM	154	int dso__name_len(const struct dso *self);
8a6c5b26 ACM	155
3610583c	156	bool dso__loaded(const struct dso *self, enum map_type type);
79406cd7 ACM	157	bool dso__sorted_by_name(const struct dso *self, enum map_type type);
79406cd7 ACM	158
8d92c02a ACM	159	static inline void dso__set_loaded(struct dso *self, enum map_type type)
	160	{
	161	self->loaded \|= (1 << type);
	162	}
	163
79406cd7	164	void dso__sort_by_name(struct dso *self, enum map_type type);
3610583c	165
a89e5abe ACM	166	struct dso __dsos__findnew(struct list_head head, const char *name);
a89e5abe ACM	167
9de89fe7	168	int dso__load(struct dso self, struct map map, symbol_filter_t filter);
a19afe46	169	int dso__load_vmlinux_path(struct dso self, struct map map,
9de89fe7 ACM	170	symbol_filter_t filter);
	171	int dso__load_kallsyms(struct dso self, const char filename, struct map *map,
	172	symbol_filter_t filter);
5c0541d5 ACM	173	int machine__load_kallsyms(struct machine self, const char filename,
	174	enum map_type type, symbol_filter_t filter);
	175	int machine__load_vmlinux_path(struct machine *self, enum map_type type,
	176	symbol_filter_t filter);
	177
1f626bc3 ACM	178	size_t __dsos__fprintf(struct list_head head, FILE fp);
1f626bc3 ACM	179
f869097e	180	size_t machine__fprintf_dsos_buildid(struct machine self, FILE fp, bool with_hits);
cbf69680 ACM	181	size_t machines__fprintf_dsos(struct rb_root self, FILE fp);
cbf69680 ACM	182	size_t machines__fprintf_dsos_buildid(struct rb_root self, FILE fp, bool with_hits);
a2928c42	183
9e03eb2d	184	size_t dso__fprintf_buildid(struct dso self, FILE fp);
95011c60	185	size_t dso__fprintf(struct dso self, enum map_type type, FILE fp);
b0a9ab62 ACM	186
	187	enum dso_origin {
	188	DSO__ORIG_KERNEL = 0,
a1645ce1	189	DSO__ORIG_GUEST_KERNEL,
b0a9ab62 ACM	190	DSO__ORIG_JAVA_JIT,
	191	DSO__ORIG_BUILD_ID_CACHE,
	192	DSO__ORIG_FEDORA,
	193	DSO__ORIG_UBUNTU,
	194	DSO__ORIG_BUILDID,
	195	DSO__ORIG_DSO,
a1645ce1	196	DSO__ORIG_GUEST_KMODULE,
b0a9ab62 ACM	197	DSO__ORIG_KMODULE,
	198	DSO__ORIG_NOT_FOUND,
	199	};
	200
94cb9e38	201	char dso__symtab_origin(const struct dso *self);
b7cece76	202	void dso__set_long_name(struct dso self, char name);
8d06367f	203	void dso__set_build_id(struct dso self, void build_id);
23346f21	204	void dso__read_running_kernel_build_id(struct dso self, struct machine machine);
ea08d8cb	205	struct symbol dso__find_symbol(struct dso self, enum map_type type, u64 addr);
79406cd7 ACM	206	struct symbol dso__find_symbol_by_name(struct dso self, enum map_type type,
79406cd7 ACM	207	const char *name);
a2928c42	208
2643ce11	209	int filename__read_build_id(const char filename, void bf, size_t size);
f1617b40	210	int sysfs__read_build_id(const char filename, void bf, size_t size);
a1645ce1	211	bool __dsos__read_build_ids(struct list_head *head, bool with_hits);
ef12a141	212	int build_id__sprintf(const u8 self, int len, char bf);
9e201442 ACM	213	int kallsyms__parse(const char filename, void arg,
	214	int (process_symbol)(void arg, const char *name,
	215	char type, u64 start));
2643ce11	216
076c6e45	217	void machine__destroy_kernel_maps(struct machine *self);
d28c6223	218	int __machine__create_kernel_maps(struct machine self, struct dso kernel);
5c0541d5 ACM	219	int machine__create_kernel_maps(struct machine *self);
5c0541d5 ACM	220
d28c6223 ACM	221	int machines__create_kernel_maps(struct rb_root *self, pid_t pid);
d28c6223 ACM	222	int machines__create_guest_kernel_maps(struct rb_root *self);
076c6e45	223	void machines__destroy_guest_kernel_maps(struct rb_root *self);
a1645ce1	224
75be6cf4	225	int symbol__init(void);
d65a458b	226	void symbol__exit(void);
36a3e646 ACM	227	bool symbol_type__is_a(char symbol_type, enum map_type map_type);
36a3e646 ACM	228
5ad90e4e	229	size_t machine__fprintf_vmlinux_path(struct machine self, FILE fp);
b0a9ab62	230
8b40f521	231	#endif /* __PERF_SYMBOL */