[mirror_ubuntu-focal-kernel.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 "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__SYSTEM_PATH_KMODULE,
	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,
};

#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];
};

struct dso {
	struct list_head node;
	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		 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;

	/* dso data file */
	struct {
		struct rb_root	 cache;
		int		 fd;
		struct list_head open_entry;
	} data;

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

int dso__data_fd(struct dso *dso, struct machine *machine);
void dso__data_close(struct dso *dso);

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

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 list_head *head, struct dso *dso);
struct dso *dsos__find(const struct list_head *head, const char *name,
		       bool cmp_short);
struct dso *__dsos__findnew(struct list_head *head, 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);

#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>
cdd059d7	8	#include "map.h"
86c98cab	9	#include "build-id.h"
cdd059d7 JO	10
	11	enum dso_binary_type {
	12	DSO_BINARY_TYPE__KALLSYMS = 0,
	13	DSO_BINARY_TYPE__GUEST_KALLSYMS,
	14	DSO_BINARY_TYPE__VMLINUX,
	15	DSO_BINARY_TYPE__GUEST_VMLINUX,
	16	DSO_BINARY_TYPE__JAVA_JIT,
	17	DSO_BINARY_TYPE__DEBUGLINK,
	18	DSO_BINARY_TYPE__BUILD_ID_CACHE,
	19	DSO_BINARY_TYPE__FEDORA_DEBUGINFO,
	20	DSO_BINARY_TYPE__UBUNTU_DEBUGINFO,
	21	DSO_BINARY_TYPE__BUILDID_DEBUGINFO,
	22	DSO_BINARY_TYPE__SYSTEM_PATH_DSO,
	23	DSO_BINARY_TYPE__GUEST_KMODULE,
	24	DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE,
8e0cf965 AH	25	DSO_BINARY_TYPE__KCORE,
8e0cf965 AH	26	DSO_BINARY_TYPE__GUEST_KCORE,
9cd00941	27	DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO,
cdd059d7 JO	28	DSO_BINARY_TYPE__NOT_FOUND,
	29	};
	30
	31	enum dso_kernel_type {
	32	DSO_TYPE_USER = 0,
	33	DSO_TYPE_KERNEL,
	34	DSO_TYPE_GUEST_KERNEL
	35	};
	36
	37	enum dso_swap_type {
	38	DSO_SWAP__UNSET,
	39	DSO_SWAP__NO,
	40	DSO_SWAP__YES,
	41	};
	42
	43	#define DSO__SWAP(dso, type, val) \
	44	({ \
	45	type ____r = val; \
	46	BUG_ON(dso->needs_swap == DSO_SWAP__UNSET); \
	47	if (dso->needs_swap == DSO_SWAP__YES) { \
	48	switch (sizeof(____r)) { \
	49	case 2: \
	50	____r = bswap_16(val); \
	51	break; \
	52	case 4: \
	53	____r = bswap_32(val); \
	54	break; \
	55	case 8: \
	56	____r = bswap_64(val); \
	57	break; \
	58	default: \
	59	BUG_ON(1); \
	60	} \
	61	} \
	62	____r; \
	63	})
	64
	65	#define DSO__DATA_CACHE_SIZE 4096
	66	#define DSO__DATA_CACHE_MASK ~(DSO__DATA_CACHE_SIZE - 1)
	67
	68	struct dso_cache {
	69	struct rb_node rb_node;
	70	u64 offset;
	71	u64 size;
	72	char data[0];
	73	};
	74
	75	struct dso {
	76	struct list_head node;
	77	struct rb_root symbols[MAP__NR_TYPES];
	78	struct rb_root symbol_names[MAP__NR_TYPES];
454ff00f	79	void *a2l;
0058aef6	80	char *symsrc_filename;
906049c8	81	unsigned int a2l_fails;
cdd059d7 JO	82	enum dso_kernel_type kernel;
	83	enum dso_swap_type needs_swap;
	84	enum dso_binary_type symtab_type;
5f70619d	85	enum dso_binary_type binary_type;
cdd059d7 JO	86	u8 adjust_symbols:1;
cdd059d7 JO	87	u8 has_build_id:1;
2cc9d0ef	88	u8 has_srcline:1;
cdd059d7 JO	89	u8 hit:1;
cdd059d7 JO	90	u8 annotate_warned:1;
c7282f2e ACM	91	u8 short_name_allocated:1;
c7282f2e ACM	92	u8 long_name_allocated:1;
cdd059d7 JO	93	u8 sorted_by_name;
cdd059d7 JO	94	u8 loaded;
0131c4ec	95	u8 rel;
cdd059d7 JO	96	u8 build_id[BUILD_ID_SIZE];
cdd059d7 JO	97	const char *short_name;
bf4414ae	98	const char *long_name;
cdd059d7 JO	99	u16 long_name_len;
cdd059d7 JO	100	u16 short_name_len;
ca40e2af JO	101
	102	/* dso data file */
	103	struct {
	104	struct rb_root cache;
53fa8eaa	105	int fd;
eba5102d	106	struct list_head open_entry;
ca40e2af JO	107	} data;
ca40e2af JO	108
cdd059d7 JO	109	char name[0];
	110	};
	111
eb948e50 MH	112	/* dso__for_each_symbol - iterate over the symbols of given type
	113	*
	114	* @dso: the 'struct dso *' in which symbols itereated
	115	* @pos: the 'struct symbol *' to use as a loop cursor
	116	* @n: the 'struct rb_node *' to use as a temporary storage
	117	* @type: the 'enum map_type' type of symbols
	118	*/
	119	#define dso__for_each_symbol(dso, pos, n, type) \
	120	symbols__for_each_entry(&(dso)->symbols[(type)], pos, n)
	121
cdd059d7 JO	122	static inline void dso__set_loaded(struct dso *dso, enum map_type type)
	123	{
	124	dso->loaded \|= (1 << type);
	125	}
	126
	127	struct dso dso__new(const char name);
	128	void dso__delete(struct dso *dso);
	129
58a98c9c	130	void dso__set_short_name(struct dso dso, const char name, bool name_allocated);
bf4414ae	131	void dso__set_long_name(struct dso dso, const char name, bool name_allocated);
cdd059d7 JO	132
	133	int dso__name_len(const struct dso *dso);
	134
	135	bool dso__loaded(const struct dso *dso, enum map_type type);
	136
	137	bool dso__sorted_by_name(const struct dso *dso, enum map_type type);
	138	void dso__set_sorted_by_name(struct dso *dso, enum map_type type);
	139	void dso__sort_by_name(struct dso *dso, enum map_type type);
	140
	141	void dso__set_build_id(struct dso dso, void build_id);
	142	bool dso__build_id_equal(const struct dso dso, u8 build_id);
	143	void dso__read_running_kernel_build_id(struct dso *dso,
	144	struct machine *machine);
	145	int dso__kernel_module_get_build_id(struct dso dso, const char root_dir);
	146
	147	char dso__symtab_origin(const struct dso *dso);
ee4e9625 ACM	148	int dso__read_binary_type_filename(const struct dso *dso, enum dso_binary_type type,
ee4e9625 ACM	149	char root_dir, char filename, size_t size);
cdd059d7 JO	150
cdd059d7 JO	151	int dso__data_fd(struct dso dso, struct machine machine);
53fa8eaa JO	152	void dso__data_close(struct dso *dso);
53fa8eaa JO	153
cdd059d7 JO	154	ssize_t dso__data_read_offset(struct dso dso, struct machine machine,
	155	u64 offset, u8 *data, ssize_t size);
	156	ssize_t dso__data_read_addr(struct dso dso, struct map map,
	157	struct machine *machine, u64 addr,
	158	u8 *data, ssize_t size);
	159
	160	struct map dso__new_map(const char name);
	161	struct dso dso__kernel_findnew(struct machine machine, const char *name,
	162	const char *short_name, int dso_type);
	163
	164	void dsos__add(struct list_head head, struct dso dso);
3344996e	165	struct dso dsos__find(const struct list_head head, const char *name,
f9ceffb6	166	bool cmp_short);
cdd059d7 JO	167	struct dso __dsos__findnew(struct list_head head, const char *name);
	168	bool __dsos__read_build_ids(struct list_head *head, bool with_hits);
	169
	170	size_t __dsos__fprintf_buildid(struct list_head head, FILE fp,
417c2ff6	171	bool (skip)(struct dso *dso, int parm), int parm);
cdd059d7 JO	172	size_t __dsos__fprintf(struct list_head head, FILE fp);
	173
	174	size_t dso__fprintf_buildid(struct dso dso, FILE fp);
	175	size_t dso__fprintf_symbols_by_name(struct dso *dso,
	176	enum map_type type, FILE *fp);
	177	size_t dso__fprintf(struct dso dso, enum map_type type, FILE fp);
39b12f78 AH	178
	179	static inline bool dso__is_vmlinux(struct dso *dso)
	180	{
5f70619d ACM	181	return dso->binary_type == DSO_BINARY_TYPE__VMLINUX \|\|
5f70619d ACM	182	dso->binary_type == DSO_BINARY_TYPE__GUEST_VMLINUX;
39b12f78 AH	183	}
39b12f78 AH	184
8e0cf965 AH	185	static inline bool dso__is_kcore(struct dso *dso)
8e0cf965 AH	186	{
5f70619d ACM	187	return dso->binary_type == DSO_BINARY_TYPE__KCORE \|\|
5f70619d ACM	188	dso->binary_type == DSO_BINARY_TYPE__GUEST_KCORE;
8e0cf965 AH	189	}
8e0cf965 AH	190
454ff00f AH	191	void dso__free_a2l(struct dso *dso);
454ff00f AH	192
cdd059d7	193	#endif /* __PERF_DSO */