[deliverable/linux.git] / tools / perf / util / map.h

#ifndef __PERF_MAP_H
#define __PERF_MAP_H

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

enum map_type {
	MAP__FUNCTION = 0,
	MAP__VARIABLE,
};

#define MAP__NR_TYPES (MAP__VARIABLE + 1)

extern const char *map_type__name[MAP__NR_TYPES];

struct dso;
struct ip_callchain;
struct ref_reloc_sym;
struct map_groups;
struct machine;
struct perf_evsel;

struct map {
	union {
		struct rb_node	rb_node;
		struct list_head node;
	};
	u64			start;
	u64			end;
	u8 /* enum map_type */	type;
	bool			referenced;
	bool			erange_warned;
	u32			priv;
	u64			pgoff;

	/* ip -> dso rip */
	u64			(*map_ip)(struct map *, u64);
	/* dso rip -> ip */
	u64			(*unmap_ip)(struct map *, u64);

	struct dso		*dso;
	struct map_groups	*groups;
};

struct kmap {
	struct ref_reloc_sym	*ref_reloc_sym;
	struct map_groups	*kmaps;
};

struct map_groups {
	struct rb_root	 maps[MAP__NR_TYPES];
	struct list_head removed_maps[MAP__NR_TYPES];
	struct machine	 *machine;
};

/* Native host kernel uses -1 as pid index in machine */
#define	HOST_KERNEL_ID			(-1)
#define	DEFAULT_GUEST_KERNEL_ID		(0)

struct machine {
	struct rb_node	  rb_node;
	pid_t		  pid;
	u16		  id_hdr_size;
	char		  *root_dir;
	struct rb_root	  threads;
	struct list_head  dead_threads;
	struct thread	  *last_match;
	struct list_head  user_dsos;
	struct list_head  kernel_dsos;
	struct map_groups kmaps;
	struct map	  *vmlinux_maps[MAP__NR_TYPES];
};

static inline
struct map *machine__kernel_map(struct machine *self, enum map_type type)
{
	return self->vmlinux_maps[type];
}

static inline struct kmap *map__kmap(struct map *self)
{
	return (struct kmap *)(self + 1);
}

static inline u64 map__map_ip(struct map *map, u64 ip)
{
	return ip - map->start + map->pgoff;
}

static inline u64 map__unmap_ip(struct map *map, u64 ip)
{
	return ip + map->start - map->pgoff;
}

static inline u64 identity__map_ip(struct map *map __used, u64 ip)
{
	return ip;
}


/* rip/ip <-> addr suitable for passing to `objdump --start-address=` */
u64 map__rip_2objdump(struct map *map, u64 rip);
u64 map__objdump_2ip(struct map *map, u64 addr);

struct symbol;

typedef int (*symbol_filter_t)(struct map *map, struct symbol *sym);

void map__init(struct map *self, enum map_type type,
	       u64 start, u64 end, u64 pgoff, struct dso *dso);
struct map *map__new(struct list_head *dsos__list, u64 start, u64 len,
		     u64 pgoff, u32 pid, char *filename,
		     enum map_type type);
void map__delete(struct map *self);
struct map *map__clone(struct map *self);
int map__overlap(struct map *l, struct map *r);
size_t map__fprintf(struct map *self, FILE *fp);
size_t map__fprintf_dsoname(struct map *map, FILE *fp);

int map__load(struct map *self, symbol_filter_t filter);
struct symbol *map__find_symbol(struct map *self,
				u64 addr, symbol_filter_t filter);
struct symbol *map__find_symbol_by_name(struct map *self, const char *name,
					symbol_filter_t filter);
void map__fixup_start(struct map *self);
void map__fixup_end(struct map *self);

void map__reloc_vmlinux(struct map *self);

size_t __map_groups__fprintf_maps(struct map_groups *mg,
				  enum map_type type, int verbose, FILE *fp);
void maps__insert(struct rb_root *maps, struct map *map);
void maps__remove(struct rb_root *maps, struct map *map);
struct map *maps__find(struct rb_root *maps, u64 addr);
void map_groups__init(struct map_groups *mg);
void map_groups__exit(struct map_groups *mg);
int map_groups__clone(struct map_groups *mg,
		      struct map_groups *parent, enum map_type type);
size_t map_groups__fprintf(struct map_groups *mg, int verbose, FILE *fp);
size_t map_groups__fprintf_maps(struct map_groups *mg, int verbose, FILE *fp);

typedef void (*machine__process_t)(struct machine *self, void *data);

void machines__process(struct rb_root *self, machine__process_t process, void *data);
struct machine *machines__add(struct rb_root *self, pid_t pid,
			      const char *root_dir);
struct machine *machines__find_host(struct rb_root *self);
struct machine *machines__find(struct rb_root *self, pid_t pid);
struct machine *machines__findnew(struct rb_root *self, pid_t pid);
char *machine__mmap_name(struct machine *self, char *bf, size_t size);
int machine__init(struct machine *self, const char *root_dir, pid_t pid);
void machine__exit(struct machine *self);
void machine__delete(struct machine *self);

int machine__resolve_callchain(struct machine *machine,
			       struct perf_evsel *evsel, struct thread *thread,
			       struct ip_callchain *chain,
			       struct symbol **parent);
int maps__set_kallsyms_ref_reloc_sym(struct map **maps, const char *symbol_name,
				     u64 addr);

/*
 * Default guest kernel is defined by parameter --guestkallsyms
 * and --guestmodules
 */
static inline bool machine__is_default_guest(struct machine *self)
{
	return self ? self->pid == DEFAULT_GUEST_KERNEL_ID : false;
}

static inline bool machine__is_host(struct machine *self)
{
	return self ? self->pid == HOST_KERNEL_ID : false;
}

static inline void map_groups__insert(struct map_groups *mg, struct map *map)
{
	maps__insert(&mg->maps[map->type], map);
	map->groups = mg;
}

static inline void map_groups__remove(struct map_groups *mg, struct map *map)
{
	maps__remove(&mg->maps[map->type], map);
}

static inline struct map *map_groups__find(struct map_groups *mg,
					   enum map_type type, u64 addr)
{
	return maps__find(&mg->maps[type], addr);
}

struct symbol *map_groups__find_symbol(struct map_groups *mg,
				       enum map_type type, u64 addr,
				       struct map **mapp,
				       symbol_filter_t filter);

struct symbol *map_groups__find_symbol_by_name(struct map_groups *mg,
					       enum map_type type,
					       const char *name,
					       struct map **mapp,
					       symbol_filter_t filter);


struct thread *machine__findnew_thread(struct machine *machine, pid_t pid);
void machine__remove_thread(struct machine *machine, struct thread *th);

size_t machine__fprintf(struct machine *machine, FILE *fp);

static inline
struct symbol *machine__find_kernel_symbol(struct machine *self,
					   enum map_type type, u64 addr,
					   struct map **mapp,
					   symbol_filter_t filter)
{
	return map_groups__find_symbol(&self->kmaps, type, addr, mapp, filter);
}

static inline
struct symbol *machine__find_kernel_function(struct machine *self, u64 addr,
					     struct map **mapp,
					     symbol_filter_t filter)
{
	return machine__find_kernel_symbol(self, MAP__FUNCTION, addr, mapp, filter);
}

static inline
struct symbol *map_groups__find_function_by_name(struct map_groups *mg,
						 const char *name, struct map **mapp,
						 symbol_filter_t filter)
{
	return map_groups__find_symbol_by_name(mg, MAP__FUNCTION, name, mapp, filter);
}

static inline
struct symbol *machine__find_kernel_function_by_name(struct machine *self,
						     const char *name,
						     struct map **mapp,
						     symbol_filter_t filter)
{
	return map_groups__find_function_by_name(&self->kmaps, name, mapp,
						 filter);
}

int map_groups__fixup_overlappings(struct map_groups *mg, struct map *map,
				   int verbose, FILE *fp);

struct map *map_groups__find_by_name(struct map_groups *mg,
				     enum map_type type, const char *name);
struct map *machine__new_module(struct machine *self, u64 start, const char *filename);

void map_groups__flush(struct map_groups *mg);

#endif /* __PERF_MAP_H */
Commit	Line	Data
4a58e611 ACM	1	#ifndef __PERF_MAP_H
	2	#define __PERF_MAP_H
	3
	4	#include <linux/compiler.h>
	5	#include <linux/list.h>
	6	#include <linux/rbtree.h>
4b8cf846	7	#include <stdio.h>
23346f21	8	#include <stdbool.h>
4b8cf846	9	#include "types.h"
4a58e611 ACM	10
	11	enum map_type {
	12	MAP__FUNCTION = 0,
	13	MAP__VARIABLE,
	14	};
	15
	16	#define MAP__NR_TYPES (MAP__VARIABLE + 1)
	17
3846df2e ACM	18	extern const char *map_type__name[MAP__NR_TYPES];
3846df2e ACM	19
4a58e611	20	struct dso;
743eb868	21	struct ip_callchain;
9de89fe7 ACM	22	struct ref_reloc_sym;
9de89fe7 ACM	23	struct map_groups;
23346f21	24	struct machine;
743eb868	25	struct perf_evsel;
4a58e611 ACM	26
	27	struct map {
	28	union {
	29	struct rb_node rb_node;
	30	struct list_head node;
	31	};
	32	u64 start;
	33	u64 end;
0a1eae39 ACM	34	u8 /* enum map_type */ type;
0a1eae39 ACM	35	bool referenced;
31d68e7b	36	bool erange_warned;
5c0541d5	37	u32 priv;
4a58e611	38	u64 pgoff;
7a2b6209 KS	39
7a2b6209 KS	40	/* ip -> dso rip */
4a58e611	41	u64 (map_ip)(struct map , u64);
7a2b6209	42	/* dso rip -> ip */
4a58e611	43	u64 (unmap_ip)(struct map , u64);
7a2b6209	44
4a58e611	45	struct dso *dso;
a1645ce1	46	struct map_groups *groups;
4a58e611 ACM	47	};
4a58e611 ACM	48
9de89fe7 ACM	49	struct kmap {
	50	struct ref_reloc_sym *ref_reloc_sym;
	51	struct map_groups *kmaps;
	52	};
	53
a1645ce1	54	struct map_groups {
23346f21 ACM	55	struct rb_root maps[MAP__NR_TYPES];
	56	struct list_head removed_maps[MAP__NR_TYPES];
	57	struct machine *machine;
a1645ce1 ZY	58	};
a1645ce1 ZY	59
23346f21	60	/* Native host kernel uses -1 as pid index in machine */
a1645ce1 ZY	61	#define HOST_KERNEL_ID (-1)
	62	#define DEFAULT_GUEST_KERNEL_ID (0)
	63
23346f21 ACM	64	struct machine {
	65	struct rb_node rb_node;
	66	pid_t pid;
743eb868	67	u16 id_hdr_size;
23346f21	68	char *root_dir;
b424eba2 ACM	69	struct rb_root threads;
	70	struct list_head dead_threads;
	71	struct thread *last_match;
23346f21 ACM	72	struct list_head user_dsos;
23346f21 ACM	73	struct list_head kernel_dsos;
a1645ce1	74	struct map_groups kmaps;
23346f21	75	struct map *vmlinux_maps[MAP__NR_TYPES];
a1645ce1 ZY	76	};
a1645ce1 ZY	77
5c0541d5 ACM	78	static inline
	79	struct map machine__kernel_map(struct machine self, enum map_type type)
	80	{
	81	return self->vmlinux_maps[type];
	82	}
	83
9de89fe7 ACM	84	static inline struct kmap map__kmap(struct map self)
	85	{
	86	return (struct kmap *)(self + 1);
	87	}
	88
4a58e611 ACM	89	static inline u64 map__map_ip(struct map *map, u64 ip)
	90	{
	91	return ip - map->start + map->pgoff;
	92	}
	93
	94	static inline u64 map__unmap_ip(struct map *map, u64 ip)
	95	{
	96	return ip + map->start - map->pgoff;
	97	}
	98
	99	static inline u64 identity__map_ip(struct map *map __used, u64 ip)
	100	{
	101	return ip;
	102	}
	103
7a2b6209	104
ee11b90b	105	/* rip/ip <-> addr suitable for passing to `objdump --start-address=` */
7a2b6209	106	u64 map__rip_2objdump(struct map *map, u64 rip);
ee11b90b	107	u64 map__objdump_2ip(struct map *map, u64 addr);
7a2b6209	108
4a58e611	109	struct symbol;
4a58e611 ACM	110
	111	typedef int (symbol_filter_t)(struct map map, struct symbol *sym);
	112
	113	void map__init(struct map *self, enum map_type type,
	114	u64 start, u64 end, u64 pgoff, struct dso *dso);
a1645ce1 ZY	115	struct map map__new(struct list_head dsos__list, u64 start, u64 len,
a1645ce1 ZY	116	u64 pgoff, u32 pid, char *filename,
361d1346	117	enum map_type type);
4a58e611 ACM	118	void map__delete(struct map *self);
	119	struct map map__clone(struct map self);
	120	int map__overlap(struct map l, struct map r);
	121	size_t map__fprintf(struct map self, FILE fp);
547a92e0	122	size_t map__fprintf_dsoname(struct map map, FILE fp);
4a58e611	123
9de89fe7 ACM	124	int map__load(struct map *self, symbol_filter_t filter);
9de89fe7 ACM	125	struct symbol map__find_symbol(struct map self,
4a58e611 ACM	126	u64 addr, symbol_filter_t filter);
4a58e611 ACM	127	struct symbol map__find_symbol_by_name(struct map self, const char *name,
4a58e611 ACM	128	symbol_filter_t filter);
	129	void map__fixup_start(struct map *self);
	130	void map__fixup_end(struct map *self);
	131
9de89fe7 ACM	132	void map__reloc_vmlinux(struct map *self);
9de89fe7 ACM	133
98dfd55d	134	size_t __map_groups__fprintf_maps(struct map_groups *mg,
c6e718ff	135	enum map_type type, int verbose, FILE *fp);
4b8cf846	136	void maps__insert(struct rb_root maps, struct map map);
98dfd55d	137	void maps__remove(struct rb_root maps, struct map map);
4b8cf846	138	struct map maps__find(struct rb_root maps, u64 addr);
98dfd55d ACM	139	void map_groups__init(struct map_groups *mg);
	140	void map_groups__exit(struct map_groups *mg);
	141	int map_groups__clone(struct map_groups *mg,
c6e718ff	142	struct map_groups *parent, enum map_type type);
98dfd55d ACM	143	size_t map_groups__fprintf(struct map_groups mg, int verbose, FILE fp);
98dfd55d ACM	144	size_t map_groups__fprintf_maps(struct map_groups mg, int verbose, FILE fp);
4b8cf846	145
23346f21 ACM	146	typedef void (machine__process_t)(struct machine self, void *data);
	147
	148	void machines__process(struct rb_root self, machine__process_t process, void data);
	149	struct machine machines__add(struct rb_root self, pid_t pid,
	150	const char *root_dir);
	151	struct machine machines__find_host(struct rb_root self);
	152	struct machine machines__find(struct rb_root self, pid_t pid);
	153	struct machine machines__findnew(struct rb_root self, pid_t pid);
48ea8f54	154	char machine__mmap_name(struct machine self, char *bf, size_t size);
d28c6223	155	int machine__init(struct machine self, const char root_dir, pid_t pid);
d65a458b	156	void machine__exit(struct machine *self);
076c6e45	157	void machine__delete(struct machine *self);
a1645ce1	158
743eb868 ACM	159	int machine__resolve_callchain(struct machine *machine,
	160	struct perf_evsel evsel, struct thread thread,
	161	struct ip_callchain *chain,
	162	struct symbol **parent);
	163	int maps__set_kallsyms_ref_reloc_sym(struct map *maps, const char symbol_name,
	164	u64 addr);
	165
a1645ce1 ZY	166	/*
	167	* Default guest kernel is defined by parameter --guestkallsyms
	168	* and --guestmodules
	169	*/
23346f21	170	static inline bool machine__is_default_guest(struct machine *self)
a1645ce1	171	{
23346f21	172	return self ? self->pid == DEFAULT_GUEST_KERNEL_ID : false;
a1645ce1 ZY	173	}
a1645ce1 ZY	174
23346f21	175	static inline bool machine__is_host(struct machine *self)
a1645ce1	176	{
23346f21	177	return self ? self->pid == HOST_KERNEL_ID : false;
a1645ce1 ZY	178	}
a1645ce1 ZY	179
98dfd55d	180	static inline void map_groups__insert(struct map_groups mg, struct map map)
4b8cf846	181	{
98dfd55d ACM	182	maps__insert(&mg->maps[map->type], map);
98dfd55d ACM	183	map->groups = mg;
4b8cf846 ACM	184	}
4b8cf846 ACM	185
98dfd55d	186	static inline void map_groups__remove(struct map_groups mg, struct map map)
076c6e45	187	{
98dfd55d	188	maps__remove(&mg->maps[map->type], map);
076c6e45 ACM	189	}
076c6e45 ACM	190
98dfd55d	191	static inline struct map map_groups__find(struct map_groups mg,
4b8cf846 ACM	192	enum map_type type, u64 addr)
4b8cf846 ACM	193	{
98dfd55d	194	return maps__find(&mg->maps[type], addr);
4b8cf846 ACM	195	}
4b8cf846 ACM	196
98dfd55d	197	struct symbol map_groups__find_symbol(struct map_groups mg,
4b8cf846	198	enum map_type type, u64 addr,
7e5e1b14	199	struct map **mapp,
4b8cf846 ACM	200	symbol_filter_t filter);
4b8cf846 ACM	201
98dfd55d	202	struct symbol map_groups__find_symbol_by_name(struct map_groups mg,
7e5e1b14 ACM	203	enum map_type type,
	204	const char *name,
	205	struct map **mapp,
	206	symbol_filter_t filter);
	207
b424eba2 ACM	208
	209	struct thread machine__findnew_thread(struct machine machine, pid_t pid);
	210	void machine__remove_thread(struct machine machine, struct thread th);
	211
	212	size_t machine__fprintf(struct machine machine, FILE fp);
	213
5c0541d5 ACM	214	static inline
	215	struct symbol machine__find_kernel_symbol(struct machine self,
	216	enum map_type type, u64 addr,
	217	struct map **mapp,
	218	symbol_filter_t filter)
	219	{
	220	return map_groups__find_symbol(&self->kmaps, type, addr, mapp, filter);
	221	}
	222
	223	static inline
	224	struct symbol machine__find_kernel_function(struct machine self, u64 addr,
	225	struct map **mapp,
	226	symbol_filter_t filter)
7e5e1b14	227	{
5c0541d5	228	return machine__find_kernel_symbol(self, MAP__FUNCTION, addr, mapp, filter);
7e5e1b14 ACM	229	}
	230
	231	static inline
98dfd55d	232	struct symbol map_groups__find_function_by_name(struct map_groups mg,
7e5e1b14 ACM	233	const char name, struct map *mapp,
7e5e1b14 ACM	234	symbol_filter_t filter)
4b8cf846	235	{
98dfd55d	236	return map_groups__find_symbol_by_name(mg, MAP__FUNCTION, name, mapp, filter);
4b8cf846 ACM	237	}
4b8cf846 ACM	238
469b9b88 MH	239	static inline
	240	struct symbol machine__find_kernel_function_by_name(struct machine self,
	241	const char *name,
	242	struct map **mapp,
	243	symbol_filter_t filter)
	244	{
	245	return map_groups__find_function_by_name(&self->kmaps, name, mapp,
	246	filter);
	247	}
	248
98dfd55d	249	int map_groups__fixup_overlappings(struct map_groups mg, struct map map,
c6e718ff ACM	250	int verbose, FILE *fp);
c6e718ff ACM	251
98dfd55d	252	struct map map_groups__find_by_name(struct map_groups mg,
4b8cf846	253	enum map_type type, const char *name);
d28c6223	254	struct map machine__new_module(struct machine self, u64 start, const char *filename);
a1645ce1	255
98dfd55d	256	void map_groups__flush(struct map_groups *mg);
4b8cf846	257
4a58e611	258	#endif /* __PERF_MAP_H */