[deliverable/linux.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 - symtab entry
 *
 * @ignore - resolvable but tools ignore it (e.g. idle routines)
 */
struct symbol {
	struct rb_node	rb_node;
	u64		start;
	u64		end;
	u16		namelen;
	u8		binding;
	bool		ignore;
	char		name[0];
};

void symbol__delete(struct symbol *sym);

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,
			kptr_restrict;
	const char	*vmlinux_name,
			*kallsyms_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;
	const char	*symfs;
};

extern struct symbol_conf symbol_conf;

static inline void *symbol__priv(struct symbol *sym)
{
	return ((void *)sym) - 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		 has_build_id:1;
	u8		 hit:1;
	u8		 annotate_warned:1;
	u8		 sname_alloc:1;
	u8		 lname_alloc:1;
	unsigned char	 symtab_type;
	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);
void dso__delete(struct dso *dso);

int dso__name_len(const struct dso *dso);

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

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

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

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

int dso__load(struct dso *dso, struct map *map, symbol_filter_t filter);
int dso__load_vmlinux(struct dso *dso, struct map *map,
		      const char *vmlinux, symbol_filter_t filter);
int dso__load_vmlinux_path(struct dso *dso, struct map *map,
			   symbol_filter_t filter);
int dso__load_kallsyms(struct dso *dso, const char *filename, struct map *map,
		       symbol_filter_t filter);
int machine__load_kallsyms(struct machine *machine, const char *filename,
			   enum map_type type, symbol_filter_t filter);
int machine__load_vmlinux_path(struct machine *machine, 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 *machine,
				     FILE *fp, bool with_hits);
size_t machines__fprintf_dsos(struct rb_root *machines, FILE *fp);
size_t machines__fprintf_dsos_buildid(struct rb_root *machines,
				      FILE *fp, bool with_hits);
size_t dso__fprintf_buildid(struct dso *dso, FILE *fp);
size_t dso__fprintf_symbols_by_name(struct dso *dso,
				    enum map_type type, FILE *fp);
size_t dso__fprintf(struct dso *dso, enum map_type type, FILE *fp);

enum symtab_type {
	SYMTAB__KALLSYMS = 0,
	SYMTAB__GUEST_KALLSYMS,
	SYMTAB__JAVA_JIT,
	SYMTAB__BUILD_ID_CACHE,
	SYMTAB__FEDORA_DEBUGINFO,
	SYMTAB__UBUNTU_DEBUGINFO,
	SYMTAB__BUILDID_DEBUGINFO,
	SYMTAB__SYSTEM_PATH_DSO,
	SYMTAB__GUEST_KMODULE,
	SYMTAB__SYSTEM_PATH_KMODULE,
	SYMTAB__NOT_FOUND,
};

char dso__symtab_origin(const struct dso *dso);
void dso__set_long_name(struct dso *dso, char *name);
void dso__set_build_id(struct dso *dso, void *build_id);
void dso__read_running_kernel_build_id(struct dso *dso,
				       struct machine *machine);
struct symbol *dso__find_symbol(struct dso *dso, enum map_type type,
				u64 addr);
struct symbol *dso__find_symbol_by_name(struct dso *dso, 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 *build_id, int len, char *bf);
int kallsyms__parse(const char *filename, void *arg,
		    int (*process_symbol)(void *arg, const char *name,
					  char type, u64 start, u64 end));

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

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

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 *machine, 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
171b3be9 ACM	51	/** struct symbol - symtab entry
	52	*
	53	* @ignore - resolvable but tools ignore it (e.g. idle routines)
	54	*/
a2928c42 ACM	55	struct symbol {
a2928c42 ACM	56	struct rb_node rb_node;
9cffa8d5 PM	57	u64 start;
9cffa8d5 PM	58	u64 end;
fefb0b94	59	u16 namelen;
c408fedf	60	u8 binding;
171b3be9	61	bool ignore;
a2928c42 ACM	62	char name[0];
	63	};
	64
aeafcbaf	65	void symbol__delete(struct symbol *sym);
628ada0c	66
655000e7 ACM	67	struct strlist;
655000e7 ACM	68
b32d133a ACM	69	struct symbol_conf {
	70	unsigned short priv_size;
	71	bool try_vmlinux_path,
79406cd7	72	use_modules,
d599db3f ACM	73	sort_by_name,
	74	show_nr_samples,
	75	use_callchain,
f7d87444	76	exclude_other,
85e00b55	77	show_cpu_utilization,
ec80fde7 ACM	78	initialized,
ec80fde7 ACM	79	kptr_restrict;
c410a338	80	const char *vmlinux_name,
b226a5a7	81	*kallsyms_name,
9ed7e1b8	82	*source_prefix,
c410a338	83	*field_sep;
a1645ce1 ZY	84	const char *default_guest_vmlinux_name,
	85	*default_guest_kallsyms,
	86	*default_guest_modules;
	87	const char *guestmount;
edb7c60e	88	const char *dso_list_str,
655000e7 ACM	89	*comm_list_str,
	90	*sym_list_str,
	91	*col_width_list_str;
	92	struct strlist *dso_list,
	93	*comm_list,
	94	*sym_list;
ec5761ea	95	const char *symfs;
b32d133a ACM	96	};
b32d133a ACM	97
75be6cf4	98	extern struct symbol_conf symbol_conf;
00a192b3	99
aeafcbaf	100	static inline void symbol__priv(struct symbol sym)
00a192b3	101	{
aeafcbaf	102	return ((void *)sym) - symbol_conf.priv_size;
00a192b3 ACM	103	}
00a192b3 ACM	104
9de89fe7 ACM	105	struct ref_reloc_sym {
	106	const char *name;
	107	u64 addr;
	108	u64 unrelocated_addr;
	109	};
	110
59fd5306 ACM	111	struct map_symbol {
	112	struct map *map;
	113	struct symbol *sym;
0f0cbf7a ACM	114	bool unfolded;
0f0cbf7a ACM	115	bool has_children;
59fd5306 ACM	116	};
59fd5306 ACM	117
1ed091c4 ACM	118	struct addr_location {
	119	struct thread *thread;
	120	struct map *map;
	121	struct symbol *sym;
	122	u64 addr;
	123	char level;
c410a338	124	bool filtered;
f60f3593 AS	125	u8 cpumode;
f60f3593 AS	126	s32 cpu;
a1645ce1 ZY	127	};
	128
	129	enum dso_kernel_type {
	130	DSO_TYPE_USER = 0,
	131	DSO_TYPE_KERNEL,
	132	DSO_TYPE_GUEST_KERNEL
1ed091c4 ACM	133	};
1ed091c4 ACM	134
a2928c42 ACM	135	struct dso {
a2928c42 ACM	136	struct list_head node;
6a4694a4	137	struct rb_root symbols[MAP__NR_TYPES];
79406cd7	138	struct rb_root symbol_names[MAP__NR_TYPES];
6e406257	139	enum dso_kernel_type kernel;
8d06367f	140	u8 adjust_symbols:1;
8d06367f	141	u8 has_build_id:1;
88d3d9b7	142	u8 hit:1;
d06d92b7	143	u8 annotate_warned:1;
6e406257 ACM	144	u8 sname_alloc:1;
6e406257 ACM	145	u8 lname_alloc:1;
878b439d	146	unsigned char symtab_type;
79406cd7	147	u8 sorted_by_name;
3610583c	148	u8 loaded;
8d06367f	149	u8 build_id[BUILD_ID_SIZE];
439d473b ACM	150	const char *short_name;
439d473b ACM	151	char *long_name;
b63be8d7 ACM	152	u16 long_name_len;
b63be8d7 ACM	153	u16 short_name_len;
a2928c42 ACM	154	char name[0];
	155	};
	156
00a192b3	157	struct dso dso__new(const char name);
aeafcbaf	158	void dso__delete(struct dso *dso);
a2928c42	159
aeafcbaf	160	int dso__name_len(const struct dso *dso);
8a6c5b26	161
aeafcbaf ACM	162	bool dso__loaded(const struct dso *dso, enum map_type type);
aeafcbaf ACM	163	bool dso__sorted_by_name(const struct dso *dso, enum map_type type);
79406cd7	164
aeafcbaf	165	static inline void dso__set_loaded(struct dso *dso, enum map_type type)
8d92c02a	166	{
aeafcbaf	167	dso->loaded \|= (1 << type);
8d92c02a ACM	168	}
8d92c02a ACM	169
aeafcbaf	170	void dso__sort_by_name(struct dso *dso, enum map_type type);
3610583c	171
a89e5abe ACM	172	struct dso __dsos__findnew(struct list_head head, const char *name);
a89e5abe ACM	173
aeafcbaf ACM	174	int dso__load(struct dso dso, struct map map, symbol_filter_t filter);
aeafcbaf ACM	175	int dso__load_vmlinux(struct dso dso, struct map map,
fd930ff9	176	const char *vmlinux, symbol_filter_t filter);
aeafcbaf	177	int dso__load_vmlinux_path(struct dso dso, struct map map,
9de89fe7	178	symbol_filter_t filter);
aeafcbaf	179	int dso__load_kallsyms(struct dso dso, const char filename, struct map *map,
9de89fe7	180	symbol_filter_t filter);
aeafcbaf	181	int machine__load_kallsyms(struct machine machine, const char filename,
5c0541d5	182	enum map_type type, symbol_filter_t filter);
aeafcbaf	183	int machine__load_vmlinux_path(struct machine *machine, enum map_type type,
5c0541d5 ACM	184	symbol_filter_t filter);
5c0541d5 ACM	185
1f626bc3 ACM	186	size_t __dsos__fprintf(struct list_head head, FILE fp);
1f626bc3 ACM	187
aeafcbaf ACM	188	size_t machine__fprintf_dsos_buildid(struct machine *machine,
	189	FILE *fp, bool with_hits);
	190	size_t machines__fprintf_dsos(struct rb_root machines, FILE fp);
	191	size_t machines__fprintf_dsos_buildid(struct rb_root *machines,
	192	FILE *fp, bool with_hits);
	193	size_t dso__fprintf_buildid(struct dso dso, FILE fp);
	194	size_t dso__fprintf_symbols_by_name(struct dso *dso,
	195	enum map_type type, FILE *fp);
	196	size_t dso__fprintf(struct dso dso, enum map_type type, FILE fp);
b0a9ab62	197
878b439d ACM	198	enum symtab_type {
	199	SYMTAB__KALLSYMS = 0,
	200	SYMTAB__GUEST_KALLSYMS,
	201	SYMTAB__JAVA_JIT,
	202	SYMTAB__BUILD_ID_CACHE,
	203	SYMTAB__FEDORA_DEBUGINFO,
	204	SYMTAB__UBUNTU_DEBUGINFO,
	205	SYMTAB__BUILDID_DEBUGINFO,
	206	SYMTAB__SYSTEM_PATH_DSO,
	207	SYMTAB__GUEST_KMODULE,
	208	SYMTAB__SYSTEM_PATH_KMODULE,
	209	SYMTAB__NOT_FOUND,
b0a9ab62 ACM	210	};
b0a9ab62 ACM	211
aeafcbaf ACM	212	char dso__symtab_origin(const struct dso *dso);
	213	void dso__set_long_name(struct dso dso, char name);
	214	void dso__set_build_id(struct dso dso, void build_id);
	215	void dso__read_running_kernel_build_id(struct dso *dso,
	216	struct machine *machine);
	217	struct symbol dso__find_symbol(struct dso dso, enum map_type type,
	218	u64 addr);
	219	struct symbol dso__find_symbol_by_name(struct dso dso, enum map_type type,
79406cd7	220	const char *name);
a2928c42	221
2643ce11	222	int filename__read_build_id(const char filename, void bf, size_t size);
f1617b40	223	int sysfs__read_build_id(const char filename, void bf, size_t size);
a1645ce1	224	bool __dsos__read_build_ids(struct list_head *head, bool with_hits);
aeafcbaf	225	int build_id__sprintf(const u8 build_id, int len, char bf);
9e201442 ACM	226	int kallsyms__parse(const char filename, void arg,
9e201442 ACM	227	int (process_symbol)(void arg, const char *name,
3b01a413	228	char type, u64 start, u64 end));
2643ce11	229
aeafcbaf ACM	230	void machine__destroy_kernel_maps(struct machine *machine);
	231	int __machine__create_kernel_maps(struct machine machine, struct dso kernel);
	232	int machine__create_kernel_maps(struct machine *machine);
5c0541d5	233
aeafcbaf ACM	234	int machines__create_kernel_maps(struct rb_root *machines, pid_t pid);
	235	int machines__create_guest_kernel_maps(struct rb_root *machines);
	236	void machines__destroy_guest_kernel_maps(struct rb_root *machines);
a1645ce1	237
75be6cf4	238	int symbol__init(void);
d65a458b	239	void symbol__exit(void);
36a3e646 ACM	240	bool symbol_type__is_a(char symbol_type, enum map_type map_type);
36a3e646 ACM	241
aeafcbaf	242	size_t machine__fprintf_vmlinux_path(struct machine machine, FILE fp);
b0a9ab62	243
8b40f521	244	#endif /* __PERF_SYMBOL */