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