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

#ifndef __PERF_DSO
#define __PERF_DSO

#include <linux/atomic.h>
#include <linux/types.h>
#include <linux/rbtree.h>
#include <stdbool.h>
#include <pthread.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,
};

enum dso_load_errno {
	DSO_LOAD_ERRNO__SUCCESS		= 0,

	/*
	 * Choose an arbitrary negative big number not to clash with standard
	 * errno since SUS requires the errno has distinct positive values.
	 * See 'Issue 6' in the link below.
	 *
	 * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
	 */
	__DSO_LOAD_ERRNO__START		= -10000,

	DSO_LOAD_ERRNO__INTERNAL_ERROR	= __DSO_LOAD_ERRNO__START,

	/* for symsrc__init() */
	DSO_LOAD_ERRNO__INVALID_ELF,
	DSO_LOAD_ERRNO__CANNOT_READ_BUILDID,
	DSO_LOAD_ERRNO__MISMATCHING_BUILDID,

	/* for decompress_kmodule */
	DSO_LOAD_ERRNO__DECOMPRESSION_FAILURE,

	__DSO_LOAD_ERRNO__END,
};

#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 */
	pthread_rwlock_t lock;
};

struct auxtrace_cache;

struct dso {
	pthread_mutex_t	 lock;
	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;
	enum dso_load_errno	load_errno;
	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 */
	struct auxtrace_cache *auxtrace_cache;

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

struct dso *dso__get(struct dso *dso);
void dso__put(struct dso *dso);

static inline void __dso__zput(struct dso **dso)
{
	dso__put(*dso);
	*dso = NULL;
}

#define dso__zput(dso) __dso__zput(&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_kernel_module(const char *pathname, int cpumode);
bool decompress_to_file(const char *ext, const char *filename, int output_fd);
bool dso__needs_decompress(struct dso *dso);

struct kmod_path {
	char *name;
	char *ext;
	bool  comp;
	bool  kmod;
};

int __kmod_path__parse(struct kmod_path *m, const char *path,
		     bool alloc_name, bool alloc_ext);

#define kmod_path__parse(__m, __p)      __kmod_path__parse(__m, __p, false, false)
#define kmod_path__parse_name(__m, __p) __kmod_path__parse(__m, __p, true , false)
#define kmod_path__parse_ext(__m, __p)  __kmod_path__parse(__m, __p, false, true)

/*
 * The dso__data_* external interface provides following functions:
 *   dso__data_get_fd
 *   dso__data_put_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_get_fd(dso, machine);
 *   if (fd >= 0) {
 *       USE 'fd' SOMEHOW
 *       dso__data_put_fd(dso);
 *   }
 *
 * 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_get_fd(struct dso *dso, struct machine *machine);
void dso__data_put_fd(struct dso *dso __maybe_unused);
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 *machine__findnew_kernel(struct machine *machine, const char *name,
				    const char *short_name, int dso_type);

void __dsos__add(struct dsos *dsos, struct dso *dso);
void dsos__add(struct dsos *dsos, struct dso *dso);
struct dso *__dsos__addnew(struct dsos *dsos, const char *name);
struct dso *__dsos__find(struct dsos *dsos, const char *name, bool cmp_short);
struct dso *dsos__find(struct dsos *dsos, const char *name, bool cmp_short);
struct dso *__dsos__findnew(struct dsos *dsos, const char *name);
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);

int dso__strerror_load(struct dso *dso, char *buf, size_t buflen);

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