[linux-2.6-block.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 ref_reloc_sym;
struct map_groups;
struct machine;

struct map {
	union {
		struct rb_node	rb_node;
		struct list_head node;
	};
	u64			start;
	u64			end;
	u8 /* enum map_type */	type;
	bool			referenced;
	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;
	char		  *root_dir;
	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);

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 *self,
				  enum map_type type, int verbose, FILE *fp);
void maps__insert(struct rb_root *maps, struct map *map);
void maps__remove(struct rb_root *self, struct map *map);
struct map *maps__find(struct rb_root *maps, u64 addr);
void map_groups__init(struct map_groups *self);
void map_groups__exit(struct map_groups *self);
int map_groups__clone(struct map_groups *self,
		      struct map_groups *parent, enum map_type type);
size_t map_groups__fprintf(struct map_groups *self, int verbose, FILE *fp);
size_t map_groups__fprintf_maps(struct map_groups *self, 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);

/*
 * 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 *self, struct map *map)
{
	maps__insert(&self->maps[map->type], map);
	map->groups = self;
}

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

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

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

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

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 *self,
						 const char *name, struct map **mapp,
						 symbol_filter_t filter)
{
	return map_groups__find_symbol_by_name(self, 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 *self, struct map *map,
				   int verbose, FILE *fp);

struct map *map_groups__find_by_name(struct map_groups *self,
				     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 *self);

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