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

#ifndef __PERF_DSO
#define __PERF_DSO

#include <linux/types.h>
#include <linux/rbtree.h>
#include <stdbool.h>
#include <linux/types.h>
#include <linux/bitops.h>
#include "map.h"
#include "build-id.h"

enum dso_binary_type {
	DSO_BINARY_TYPE__KALLSYMS = 0,
	DSO_BINARY_TYPE__GUEST_KALLSYMS,
	DSO_BINARY_TYPE__VMLINUX,
	DSO_BINARY_TYPE__GUEST_VMLINUX,
	DSO_BINARY_TYPE__JAVA_JIT,
	DSO_BINARY_TYPE__DEBUGLINK,
	DSO_BINARY_TYPE__BUILD_ID_CACHE,
	DSO_BINARY_TYPE__FEDORA_DEBUGINFO,
	DSO_BINARY_TYPE__UBUNTU_DEBUGINFO,
	DSO_BINARY_TYPE__BUILDID_DEBUGINFO,
	DSO_BINARY_TYPE__SYSTEM_PATH_DSO,
	DSO_BINARY_TYPE__GUEST_KMODULE,
	DSO_BINARY_TYPE__GUEST_KMODULE_COMP,
	DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE,
	DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP,
	DSO_BINARY_TYPE__KCORE,
	DSO_BINARY_TYPE__GUEST_KCORE,
	DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO,
	DSO_BINARY_TYPE__NOT_FOUND,
};

enum dso_kernel_type {
	DSO_TYPE_USER = 0,
	DSO_TYPE_KERNEL,
	DSO_TYPE_GUEST_KERNEL
};

enum dso_swap_type {
	DSO_SWAP__UNSET,
	DSO_SWAP__NO,
	DSO_SWAP__YES,
};

enum dso_data_status {
	DSO_DATA_STATUS_ERROR	= -1,
	DSO_DATA_STATUS_UNKNOWN	= 0,
	DSO_DATA_STATUS_OK	= 1,
};

enum dso_data_status_seen {
	DSO_DATA_STATUS_SEEN_ITRACE,
};

enum dso_type {
	DSO__TYPE_UNKNOWN,
	DSO__TYPE_64BIT,
	DSO__TYPE_32BIT,
	DSO__TYPE_X32BIT,
};

#define DSO__SWAP(dso, type, val)			\
({							\
	type ____r = val;				\
	BUG_ON(dso->needs_swap == DSO_SWAP__UNSET);	\
	if (dso->needs_swap == DSO_SWAP__YES) {		\
		switch (sizeof(____r)) {		\
		case 2:					\
			____r = bswap_16(val);		\
			break;				\
		case 4:					\
			____r = bswap_32(val);		\
			break;				\
		case 8:					\
			____r = bswap_64(val);		\
			break;				\
		default:				\
			BUG_ON(1);			\
		}					\
	}						\
	____r;						\
})

#define DSO__DATA_CACHE_SIZE 4096
#define DSO__DATA_CACHE_MASK ~(DSO__DATA_CACHE_SIZE - 1)

struct dso_cache {
	struct rb_node	rb_node;
	u64 offset;
	u64 size;
	char data[0];
};

/*
 * DSOs are put into both a list for fast iteration and rbtree for fast
 * long name lookup.
 */
struct dsos {
	struct list_head head;
	struct rb_root	 root;	/* rbtree root sorted by long name */
};

struct dso {
	struct list_head node;
	struct rb_node	 rb_node;	/* rbtree node sorted by long name */
	struct rb_root	 symbols[MAP__NR_TYPES];
	struct rb_root	 symbol_names[MAP__NR_TYPES];
	void		 *a2l;
	char		 *symsrc_filename;
	unsigned int	 a2l_fails;
	enum dso_kernel_type	kernel;
	enum dso_swap_type	needs_swap;
	enum dso_binary_type	symtab_type;
	enum dso_binary_type	binary_type;
	u8		 adjust_symbols:1;
	u8		 has_build_id:1;
	u8		 has_srcline:1;
	u8		 hit:1;
	u8		 annotate_warned:1;
	u8		 short_name_allocated:1;
	u8		 long_name_allocated:1;
	u8		 is_64_bit:1;
	u8		 sorted_by_name;
	u8		 loaded;
	u8		 rel;
	u8		 build_id[BUILD_ID_SIZE];
	const char	 *short_name;
	const char	 *long_name;
	u16		 long_name_len;
	u16		 short_name_len;
	void		*dwfl;			/* DWARF debug info */

	/* dso data file */
	struct {
		struct rb_root	 cache;
		int		 fd;
		int		 status;
		u32		 status_seen;
		size_t		 file_size;
		struct list_head open_entry;
		u64		 debug_frame_offset;
		u64		 eh_frame_hdr_offset;
	} data;

	union { /* Tool specific area */
		void	 *priv;
		u64	 db_id;
	};

	char		 name[0];
};

/* dso__for_each_symbol - iterate over the symbols of given type
 *
 * @dso: the 'struct dso *' in which symbols itereated
 * @pos: the 'struct symbol *' to use as a loop cursor
 * @n: the 'struct rb_node *' to use as a temporary storage
 * @type: the 'enum map_type' type of symbols
 */
#define dso__for_each_symbol(dso, pos, n, type)	\
	symbols__for_each_entry(&(dso)->symbols[(type)], pos, n)

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

struct dso *dso__new(const char *name);
void dso__delete(struct dso *dso);

void dso__set_short_name(struct dso *dso, const char *name, bool name_allocated);
void dso__set_long_name(struct dso *dso, const char *name, bool name_allocated);

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);
void dso__set_sorted_by_name(struct dso *dso, enum map_type type);
void dso__sort_by_name(struct dso *dso, enum map_type type);

void dso__set_build_id(struct dso *dso, void *build_id);
bool dso__build_id_equal(const struct dso *dso, u8 *build_id);
void dso__read_running_kernel_build_id(struct dso *dso,
				       struct machine *machine);
int dso__kernel_module_get_build_id(struct dso *dso, const char *root_dir);

char dso__symtab_origin(const struct dso *dso);
int dso__read_binary_type_filename(const struct dso *dso, enum dso_binary_type type,
				   char *root_dir, char *filename, size_t size);
bool is_supported_compression(const char *ext);
bool is_kmodule_extension(const char *ext);
bool is_kernel_module(const char *pathname, bool *compressed);
bool decompress_to_file(const char *ext, const char *filename, int output_fd);
bool dso__needs_decompress(struct dso *dso);

/*
 * The dso__data_* external interface provides following functions:
 *   dso__data_fd
 *   dso__data_close
 *   dso__data_size
 *   dso__data_read_offset
 *   dso__data_read_addr
 *
 * Please refer to the dso.c object code for each function and
 * arguments documentation. Following text tries to explain the
 * dso file descriptor caching.
 *
 * The dso__data* interface allows caching of opened file descriptors
 * to speed up the dso data accesses. The idea is to leave the file
 * descriptor opened ideally for the whole life of the dso object.
 *
 * The current usage of the dso__data_* interface is as follows:
 *
 * Get DSO's fd:
 *   int fd = dso__data_fd(dso, machine);
 *   USE 'fd' SOMEHOW
 *
 * Read DSO's data:
 *   n = dso__data_read_offset(dso_0, &machine, 0, buf, BUFSIZE);
 *   n = dso__data_read_addr(dso_0, &machine, 0, buf, BUFSIZE);
 *
 * Eventually close DSO's fd:
 *   dso__data_close(dso);
 *
 * It is not necessary to close the DSO object data file. Each time new
 * DSO data file is opened, the limit (RLIMIT_NOFILE/2) is checked. Once
 * it is crossed, the oldest opened DSO object is closed.
 *
 * The dso__delete function calls close_dso function to ensure the
 * data file descriptor gets closed/unmapped before the dso object
 * is freed.
 *
 * TODO
*/
int dso__data_fd(struct dso *dso, struct machine *machine);
void dso__data_close(struct dso *dso);

off_t dso__data_size(struct dso *dso, struct machine *machine);
ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine,
			      u64 offset, u8 *data, ssize_t size);
ssize_t dso__data_read_addr(struct dso *dso, struct map *map,
			    struct machine *machine, u64 addr,
			    u8 *data, ssize_t size);
bool dso__data_status_seen(struct dso *dso, enum dso_data_status_seen by);

struct map *dso__new_map(const char *name);
struct dso *dso__kernel_findnew(struct machine *machine, const char *name,
				const char *short_name, int dso_type);

void dsos__add(struct dsos *dsos, struct dso *dso);
struct dso *dsos__find(const struct dsos *dsos, const char *name,
		       bool cmp_short);
struct dso *__dsos__findnew(struct dsos *dsos, const char *name);
bool __dsos__read_build_ids(struct list_head *head, bool with_hits);

size_t __dsos__fprintf_buildid(struct list_head *head, FILE *fp,
			       bool (skip)(struct dso *dso, int parm), int parm);
size_t __dsos__fprintf(struct list_head *head, FILE *fp);

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);

static inline bool dso__is_vmlinux(struct dso *dso)
{
	return dso->binary_type == DSO_BINARY_TYPE__VMLINUX ||
	       dso->binary_type == DSO_BINARY_TYPE__GUEST_VMLINUX;
}

static inline bool dso__is_kcore(struct dso *dso)
{
	return dso->binary_type == DSO_BINARY_TYPE__KCORE ||
	       dso->binary_type == DSO_BINARY_TYPE__GUEST_KCORE;
}

void dso__free_a2l(struct dso *dso);

enum dso_type dso__type(struct dso *dso, struct machine *machine);

#endif /* __PERF_DSO */
Commit	Line	Data
cdd059d7 JO	1	#ifndef __PERF_DSO
	2	#define __PERF_DSO
	3
	4	#include <linux/types.h>
	5	#include <linux/rbtree.h>
39b12f78	6	#include <stdbool.h>
d944c4ee	7	#include <linux/types.h>
2b5b8bb2	8	#include <linux/bitops.h>
cdd059d7	9	#include "map.h"
86c98cab	10	#include "build-id.h"
cdd059d7 JO	11
	12	enum dso_binary_type {
	13	DSO_BINARY_TYPE__KALLSYMS = 0,
	14	DSO_BINARY_TYPE__GUEST_KALLSYMS,
	15	DSO_BINARY_TYPE__VMLINUX,
	16	DSO_BINARY_TYPE__GUEST_VMLINUX,
	17	DSO_BINARY_TYPE__JAVA_JIT,
	18	DSO_BINARY_TYPE__DEBUGLINK,
	19	DSO_BINARY_TYPE__BUILD_ID_CACHE,
	20	DSO_BINARY_TYPE__FEDORA_DEBUGINFO,
	21	DSO_BINARY_TYPE__UBUNTU_DEBUGINFO,
	22	DSO_BINARY_TYPE__BUILDID_DEBUGINFO,
	23	DSO_BINARY_TYPE__SYSTEM_PATH_DSO,
	24	DSO_BINARY_TYPE__GUEST_KMODULE,
c00c48fc	25	DSO_BINARY_TYPE__GUEST_KMODULE_COMP,
cdd059d7	26	DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE,
c00c48fc	27	DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP,
8e0cf965 AH	28	DSO_BINARY_TYPE__KCORE,
8e0cf965 AH	29	DSO_BINARY_TYPE__GUEST_KCORE,
9cd00941	30	DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO,
cdd059d7 JO	31	DSO_BINARY_TYPE__NOT_FOUND,
	32	};
	33
	34	enum dso_kernel_type {
	35	DSO_TYPE_USER = 0,
	36	DSO_TYPE_KERNEL,
	37	DSO_TYPE_GUEST_KERNEL
	38	};
	39
	40	enum dso_swap_type {
	41	DSO_SWAP__UNSET,
	42	DSO_SWAP__NO,
	43	DSO_SWAP__YES,
	44	};
	45
c27697d6 AH	46	enum dso_data_status {
	47	DSO_DATA_STATUS_ERROR = -1,
	48	DSO_DATA_STATUS_UNKNOWN = 0,
	49	DSO_DATA_STATUS_OK = 1,
	50	};
	51
288be943 AH	52	enum dso_data_status_seen {
	53	DSO_DATA_STATUS_SEEN_ITRACE,
	54	};
	55
2b5b8bb2 AH	56	enum dso_type {
	57	DSO__TYPE_UNKNOWN,
	58	DSO__TYPE_64BIT,
	59	DSO__TYPE_32BIT,
	60	DSO__TYPE_X32BIT,
	61	};
	62
cdd059d7 JO	63	#define DSO__SWAP(dso, type, val) \
	64	({ \
	65	type ____r = val; \
	66	BUG_ON(dso->needs_swap == DSO_SWAP__UNSET); \
	67	if (dso->needs_swap == DSO_SWAP__YES) { \
	68	switch (sizeof(____r)) { \
	69	case 2: \
	70	____r = bswap_16(val); \
	71	break; \
	72	case 4: \
	73	____r = bswap_32(val); \
	74	break; \
	75	case 8: \
	76	____r = bswap_64(val); \
	77	break; \
	78	default: \
	79	BUG_ON(1); \
	80	} \
	81	} \
	82	____r; \
	83	})
	84
	85	#define DSO__DATA_CACHE_SIZE 4096
	86	#define DSO__DATA_CACHE_MASK ~(DSO__DATA_CACHE_SIZE - 1)
	87
	88	struct dso_cache {
	89	struct rb_node rb_node;
	90	u64 offset;
	91	u64 size;
	92	char data[0];
	93	};
	94
8fa7d87f	95	/*
4598a0a6 WL	96	* DSOs are put into both a list for fast iteration and rbtree for fast
4598a0a6 WL	97	* long name lookup.
8fa7d87f WL	98	*/
	99	struct dsos {
	100	struct list_head head;
4598a0a6	101	struct rb_root root; /* rbtree root sorted by long name */
8fa7d87f WL	102	};
8fa7d87f WL	103
cdd059d7 JO	104	struct dso {
cdd059d7 JO	105	struct list_head node;
4598a0a6	106	struct rb_node rb_node; /* rbtree node sorted by long name */
cdd059d7 JO	107	struct rb_root symbols[MAP__NR_TYPES];
cdd059d7 JO	108	struct rb_root symbol_names[MAP__NR_TYPES];
454ff00f	109	void *a2l;
0058aef6	110	char *symsrc_filename;
906049c8	111	unsigned int a2l_fails;
cdd059d7 JO	112	enum dso_kernel_type kernel;
	113	enum dso_swap_type needs_swap;
	114	enum dso_binary_type symtab_type;
5f70619d	115	enum dso_binary_type binary_type;
cdd059d7 JO	116	u8 adjust_symbols:1;
cdd059d7 JO	117	u8 has_build_id:1;
2cc9d0ef	118	u8 has_srcline:1;
cdd059d7 JO	119	u8 hit:1;
cdd059d7 JO	120	u8 annotate_warned:1;
c7282f2e ACM	121	u8 short_name_allocated:1;
c7282f2e ACM	122	u8 long_name_allocated:1;
c6d8f2a4	123	u8 is_64_bit:1;
cdd059d7 JO	124	u8 sorted_by_name;
cdd059d7 JO	125	u8 loaded;
0131c4ec	126	u8 rel;
cdd059d7 JO	127	u8 build_id[BUILD_ID_SIZE];
cdd059d7 JO	128	const char *short_name;
bf4414ae	129	const char *long_name;
cdd059d7 JO	130	u16 long_name_len;
cdd059d7 JO	131	u16 short_name_len;
7d073b33	132	void dwfl; / DWARF debug info */
ca40e2af JO	133
	134	/* dso data file */
	135	struct {
	136	struct rb_root cache;
53fa8eaa	137	int fd;
c27697d6	138	int status;
288be943	139	u32 status_seen;
c3fbd2a6	140	size_t file_size;
eba5102d	141	struct list_head open_entry;
303cb89a WN	142	u64 debug_frame_offset;
303cb89a WN	143	u64 eh_frame_hdr_offset;
ca40e2af JO	144	} data;
ca40e2af JO	145
0db15b1e AH	146	union { /* Tool specific area */
	147	void *priv;
	148	u64 db_id;
	149	};
	150
cdd059d7 JO	151	char name[0];
	152	};
	153
eb948e50 MH	154	/* dso__for_each_symbol - iterate over the symbols of given type
	155	*
	156	* @dso: the 'struct dso *' in which symbols itereated
	157	* @pos: the 'struct symbol *' to use as a loop cursor
	158	* @n: the 'struct rb_node *' to use as a temporary storage
	159	* @type: the 'enum map_type' type of symbols
	160	*/
	161	#define dso__for_each_symbol(dso, pos, n, type) \
	162	symbols__for_each_entry(&(dso)->symbols[(type)], pos, n)
	163
cdd059d7 JO	164	static inline void dso__set_loaded(struct dso *dso, enum map_type type)
	165	{
	166	dso->loaded \|= (1 << type);
	167	}
	168
	169	struct dso dso__new(const char name);
	170	void dso__delete(struct dso *dso);
	171
58a98c9c	172	void dso__set_short_name(struct dso dso, const char name, bool name_allocated);
bf4414ae	173	void dso__set_long_name(struct dso dso, const char name, bool name_allocated);
cdd059d7 JO	174
	175	int dso__name_len(const struct dso *dso);
	176
	177	bool dso__loaded(const struct dso *dso, enum map_type type);
	178
	179	bool dso__sorted_by_name(const struct dso *dso, enum map_type type);
	180	void dso__set_sorted_by_name(struct dso *dso, enum map_type type);
	181	void dso__sort_by_name(struct dso *dso, enum map_type type);
	182
	183	void dso__set_build_id(struct dso dso, void build_id);
	184	bool dso__build_id_equal(const struct dso dso, u8 build_id);
	185	void dso__read_running_kernel_build_id(struct dso *dso,
	186	struct machine *machine);
	187	int dso__kernel_module_get_build_id(struct dso dso, const char root_dir);
	188
	189	char dso__symtab_origin(const struct dso *dso);
ee4e9625 ACM	190	int dso__read_binary_type_filename(const struct dso *dso, enum dso_binary_type type,
ee4e9625 ACM	191	char root_dir, char filename, size_t size);
c00c48fc NK	192	bool is_supported_compression(const char *ext);
	193	bool is_kmodule_extension(const char *ext);
	194	bool is_kernel_module(const char pathname, bool compressed);
	195	bool decompress_to_file(const char ext, const char filename, int output_fd);
	196	bool dso__needs_decompress(struct dso *dso);
cdd059d7	197
c1f9aa0a JO	198	/*
	199	* The dso__data_* external interface provides following functions:
	200	* dso__data_fd
	201	* dso__data_close
6d363459	202	* dso__data_size
c1f9aa0a JO	203	* dso__data_read_offset
	204	* dso__data_read_addr
	205	*
	206	* Please refer to the dso.c object code for each function and
	207	* arguments documentation. Following text tries to explain the
	208	* dso file descriptor caching.
	209	*
	210	* The dso__data* interface allows caching of opened file descriptors
	211	* to speed up the dso data accesses. The idea is to leave the file
	212	* descriptor opened ideally for the whole life of the dso object.
	213	*
	214	* The current usage of the dso__data_* interface is as follows:
	215	*
	216	* Get DSO's fd:
	217	* int fd = dso__data_fd(dso, machine);
	218	* USE 'fd' SOMEHOW
	219	*
	220	* Read DSO's data:
	221	* n = dso__data_read_offset(dso_0, &machine, 0, buf, BUFSIZE);
	222	* n = dso__data_read_addr(dso_0, &machine, 0, buf, BUFSIZE);
	223	*
	224	* Eventually close DSO's fd:
	225	* dso__data_close(dso);
	226	*
	227	* It is not necessary to close the DSO object data file. Each time new
	228	* DSO data file is opened, the limit (RLIMIT_NOFILE/2) is checked. Once
	229	* it is crossed, the oldest opened DSO object is closed.
	230	*
	231	* The dso__delete function calls close_dso function to ensure the
	232	* data file descriptor gets closed/unmapped before the dso object
	233	* is freed.
	234	*
	235	* TODO
	236	*/
cdd059d7	237	int dso__data_fd(struct dso dso, struct machine machine);
53fa8eaa JO	238	void dso__data_close(struct dso *dso);
53fa8eaa JO	239
6d363459	240	off_t dso__data_size(struct dso dso, struct machine machine);
cdd059d7 JO	241	ssize_t dso__data_read_offset(struct dso dso, struct machine machine,
	242	u64 offset, u8 *data, ssize_t size);
	243	ssize_t dso__data_read_addr(struct dso dso, struct map map,
	244	struct machine *machine, u64 addr,
	245	u8 *data, ssize_t size);
288be943	246	bool dso__data_status_seen(struct dso *dso, enum dso_data_status_seen by);
cdd059d7 JO	247
	248	struct map dso__new_map(const char name);
	249	struct dso dso__kernel_findnew(struct machine machine, const char *name,
	250	const char *short_name, int dso_type);
	251
8fa7d87f WL	252	void dsos__add(struct dsos dsos, struct dso dso);
8fa7d87f WL	253	struct dso dsos__find(const struct dsos dsos, const char *name,
f9ceffb6	254	bool cmp_short);
8fa7d87f	255	struct dso __dsos__findnew(struct dsos dsos, const char *name);
cdd059d7 JO	256	bool __dsos__read_build_ids(struct list_head *head, bool with_hits);
	257
	258	size_t __dsos__fprintf_buildid(struct list_head head, FILE fp,
417c2ff6	259	bool (skip)(struct dso *dso, int parm), int parm);
cdd059d7 JO	260	size_t __dsos__fprintf(struct list_head head, FILE fp);
	261
	262	size_t dso__fprintf_buildid(struct dso dso, FILE fp);
	263	size_t dso__fprintf_symbols_by_name(struct dso *dso,
	264	enum map_type type, FILE *fp);
	265	size_t dso__fprintf(struct dso dso, enum map_type type, FILE fp);
39b12f78 AH	266
	267	static inline bool dso__is_vmlinux(struct dso *dso)
	268	{
5f70619d ACM	269	return dso->binary_type == DSO_BINARY_TYPE__VMLINUX \|\|
5f70619d ACM	270	dso->binary_type == DSO_BINARY_TYPE__GUEST_VMLINUX;
39b12f78 AH	271	}
39b12f78 AH	272
8e0cf965 AH	273	static inline bool dso__is_kcore(struct dso *dso)
8e0cf965 AH	274	{
5f70619d ACM	275	return dso->binary_type == DSO_BINARY_TYPE__KCORE \|\|
5f70619d ACM	276	dso->binary_type == DSO_BINARY_TYPE__GUEST_KCORE;
8e0cf965 AH	277	}
8e0cf965 AH	278
454ff00f AH	279	void dso__free_a2l(struct dso *dso);
454ff00f AH	280
2b5b8bb2 AH	281	enum dso_type dso__type(struct dso dso, struct machine machine);
2b5b8bb2 AH	282
cdd059d7	283	#endif /* __PERF_DSO */