[mirror_ubuntu-artful-kernel.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;
	enum map_type		type;
	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);
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);

/*
 * 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 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);
}

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