[mirror_ubuntu-bionic-kernel.git] / tools / perf / util / machine.h

#ifndef __PERF_MACHINE_H
#define __PERF_MACHINE_H

#include <sys/types.h>
#include <linux/rbtree.h>
#include "map.h"
#include "dso.h"
#include "event.h"

struct addr_location;
struct branch_stack;
struct perf_evsel;
struct perf_sample;
struct symbol;
struct thread;
union perf_event;

/* Native host kernel uses -1 as pid index in machine */
#define	HOST_KERNEL_ID			(-1)
#define	DEFAULT_GUEST_KERNEL_ID		(0)

extern const char *ref_reloc_sym_names[];

struct vdso_info;

struct machine {
	struct rb_node	  rb_node;
	pid_t		  pid;
	u16		  id_hdr_size;
	bool		  comm_exec;
	bool		  kptr_restrict_warned;
	char		  *root_dir;
	struct rb_root	  threads;
	pthread_rwlock_t  threads_lock;
	unsigned int	  nr_threads;
	struct list_head  dead_threads;
	struct thread	  *last_match;
	struct vdso_info  *vdso_info;
	struct perf_env   *env;
	struct dsos	  dsos;
	struct map_groups kmaps;
	struct map	  *vmlinux_maps[MAP__NR_TYPES];
	u64		  kernel_start;
	pid_t		  *current_tid;
	union { /* Tool specific area */
		void	  *priv;
		u64	  db_id;
	};
};

static inline
struct map *__machine__kernel_map(struct machine *machine, enum map_type type)
{
	return machine->vmlinux_maps[type];
}

static inline
struct map *machine__kernel_map(struct machine *machine)
{
	return __machine__kernel_map(machine, MAP__FUNCTION);
}

int machine__get_kernel_start(struct machine *machine);

static inline u64 machine__kernel_start(struct machine *machine)
{
	if (!machine->kernel_start)
		machine__get_kernel_start(machine);
	return machine->kernel_start;
}

static inline bool machine__kernel_ip(struct machine *machine, u64 ip)
{
	u64 kernel_start = machine__kernel_start(machine);

	return ip >= kernel_start;
}

struct thread *machine__find_thread(struct machine *machine, pid_t pid,
				    pid_t tid);
struct comm *machine__thread_exec_comm(struct machine *machine,
				       struct thread *thread);

int machine__process_comm_event(struct machine *machine, union perf_event *event,
				struct perf_sample *sample);
int machine__process_exit_event(struct machine *machine, union perf_event *event,
				struct perf_sample *sample);
int machine__process_fork_event(struct machine *machine, union perf_event *event,
				struct perf_sample *sample);
int machine__process_lost_event(struct machine *machine, union perf_event *event,
				struct perf_sample *sample);
int machine__process_lost_samples_event(struct machine *machine, union perf_event *event,
					struct perf_sample *sample);
int machine__process_aux_event(struct machine *machine,
			       union perf_event *event);
int machine__process_itrace_start_event(struct machine *machine,
					union perf_event *event);
int machine__process_switch_event(struct machine *machine,
				  union perf_event *event);
int machine__process_mmap_event(struct machine *machine, union perf_event *event,
				struct perf_sample *sample);
int machine__process_mmap2_event(struct machine *machine, union perf_event *event,
				 struct perf_sample *sample);
int machine__process_event(struct machine *machine, union perf_event *event,
				struct perf_sample *sample);

typedef void (*machine__process_t)(struct machine *machine, void *data);

struct machines {
	struct machine host;
	struct rb_root guests;
};

void machines__init(struct machines *machines);
void machines__exit(struct machines *machines);

void machines__process_guests(struct machines *machines,
			      machine__process_t process, void *data);

struct machine *machines__add(struct machines *machines, pid_t pid,
			      const char *root_dir);
struct machine *machines__find_host(struct machines *machines);
struct machine *machines__find(struct machines *machines, pid_t pid);
struct machine *machines__findnew(struct machines *machines, pid_t pid);

void machines__set_id_hdr_size(struct machines *machines, u16 id_hdr_size);
char *machine__mmap_name(struct machine *machine, char *bf, size_t size);

void machines__set_comm_exec(struct machines *machines, bool comm_exec);

struct machine *machine__new_host(void);
int machine__init(struct machine *machine, const char *root_dir, pid_t pid);
void machine__exit(struct machine *machine);
void machine__delete_threads(struct machine *machine);
void machine__delete(struct machine *machine);
void machine__remove_thread(struct machine *machine, struct thread *th);

struct branch_info *sample__resolve_bstack(struct perf_sample *sample,
					   struct addr_location *al);
struct mem_info *sample__resolve_mem(struct perf_sample *sample,
				     struct addr_location *al);

struct callchain_cursor;

int thread__resolve_callchain(struct thread *thread,
			      struct callchain_cursor *cursor,
			      struct perf_evsel *evsel,
			      struct perf_sample *sample,
			      struct symbol **parent,
			      struct addr_location *root_al,
			      int max_stack);

/*
 * Default guest kernel is defined by parameter --guestkallsyms
 * and --guestmodules
 */
static inline bool machine__is_default_guest(struct machine *machine)
{
	return machine ? machine->pid == DEFAULT_GUEST_KERNEL_ID : false;
}

static inline bool machine__is_host(struct machine *machine)
{
	return machine ? machine->pid == HOST_KERNEL_ID : false;
}

struct thread *__machine__findnew_thread(struct machine *machine, pid_t pid, pid_t tid);
struct thread *machine__findnew_thread(struct machine *machine, pid_t pid, pid_t tid);

struct dso *machine__findnew_dso(struct machine *machine, const char *filename);

size_t machine__fprintf(struct machine *machine, FILE *fp);

static inline
struct symbol *machine__find_kernel_symbol(struct machine *machine,
					   enum map_type type, u64 addr,
					   struct map **mapp,
					   symbol_filter_t filter)
{
	return map_groups__find_symbol(&machine->kmaps, type, addr,
				       mapp, filter);
}

static inline
struct symbol *machine__find_kernel_symbol_by_name(struct machine *machine,
						   enum map_type type, const char *name,
						   struct map **mapp,
						   symbol_filter_t filter)
{
	return map_groups__find_symbol_by_name(&machine->kmaps, type, name,
					       mapp, filter);
}

static inline
struct symbol *machine__find_kernel_function(struct machine *machine, u64 addr,
					     struct map **mapp,
					     symbol_filter_t filter)
{
	return machine__find_kernel_symbol(machine, MAP__FUNCTION, addr,
					   mapp, filter);
}

static inline
struct symbol *machine__find_kernel_function_by_name(struct machine *machine,
						     const char *name,
						     struct map **mapp,
						     symbol_filter_t filter)
{
	return map_groups__find_function_by_name(&machine->kmaps, name, mapp,
						 filter);
}

struct map *machine__findnew_module_map(struct machine *machine, u64 start,
					const char *filename);
int arch__fix_module_text_start(u64 *start, const char *name);

int __machine__load_kallsyms(struct machine *machine, const char *filename,
			     enum map_type type, bool no_kcore, symbol_filter_t filter);
int machine__load_kallsyms(struct machine *machine, const char *filename,
			   enum map_type type, symbol_filter_t filter);
int machine__load_vmlinux_path(struct machine *machine, enum map_type type,
			       symbol_filter_t filter);

size_t machine__fprintf_dsos_buildid(struct machine *machine, FILE *fp,
				     bool (skip)(struct dso *dso, int parm), int parm);
size_t machines__fprintf_dsos(struct machines *machines, FILE *fp);
size_t machines__fprintf_dsos_buildid(struct machines *machines, FILE *fp,
				     bool (skip)(struct dso *dso, int parm), int parm);

void machine__destroy_kernel_maps(struct machine *machine);
int __machine__create_kernel_maps(struct machine *machine, struct dso *kernel);
int machine__create_kernel_maps(struct machine *machine);

int machines__create_kernel_maps(struct machines *machines, pid_t pid);
int machines__create_guest_kernel_maps(struct machines *machines);
void machines__destroy_kernel_maps(struct machines *machines);

size_t machine__fprintf_vmlinux_path(struct machine *machine, FILE *fp);

int machine__for_each_thread(struct machine *machine,
			     int (*fn)(struct thread *thread, void *p),
			     void *priv);
int machines__for_each_thread(struct machines *machines,
			      int (*fn)(struct thread *thread, void *p),
			      void *priv);

int __machine__synthesize_threads(struct machine *machine, struct perf_tool *tool,
				  struct target *target, struct thread_map *threads,
				  perf_event__handler_t process, bool data_mmap,
				  unsigned int proc_map_timeout);
static inline
int machine__synthesize_threads(struct machine *machine, struct target *target,
				struct thread_map *threads, bool data_mmap,
				unsigned int proc_map_timeout)
{
	return __machine__synthesize_threads(machine, NULL, target, threads,
					     perf_event__process, data_mmap,
					     proc_map_timeout);
}

pid_t machine__get_current_tid(struct machine *machine, int cpu);
int machine__set_current_tid(struct machine *machine, int cpu, pid_t pid,
			     pid_t tid);
/*
 * For use with libtraceevent's pevent_set_function_resolver()
 */
char *machine__resolve_kernel_addr(void *vmachine, unsigned long long *addrp, char **modp);

#endif /* __PERF_MACHINE_H */
Commit	Line	Data
9d2f8e22 ACM	1	#ifndef __PERF_MACHINE_H
	2	#define __PERF_MACHINE_H
	3
	4	#include <sys/types.h>
69d2591a ACM	5	#include <linux/rbtree.h>
69d2591a ACM	6	#include "map.h"
8fa7d87f	7	#include "dso.h"
58d925dc	8	#include "event.h"
9d2f8e22	9
b21484f1	10	struct addr_location;
69d2591a ACM	11	struct branch_stack;
	12	struct perf_evsel;
	13	struct perf_sample;
	14	struct symbol;
9d2f8e22	15	struct thread;
b0a7d1a0	16	union perf_event;
9d2f8e22	17
69d2591a ACM	18	/* Native host kernel uses -1 as pid index in machine */
	19	#define HOST_KERNEL_ID (-1)
	20	#define DEFAULT_GUEST_KERNEL_ID (0)
	21
5512cf24 AH	22	extern const char *ref_reloc_sym_names[];
5512cf24 AH	23
d027b640 AH	24	struct vdso_info;
d027b640 AH	25
69d2591a ACM	26	struct machine {
	27	struct rb_node rb_node;
	28	pid_t pid;
	29	u16 id_hdr_size;
cfe1c414	30	bool comm_exec;
caf8a0d0	31	bool kptr_restrict_warned;
69d2591a ACM	32	char *root_dir;
69d2591a ACM	33	struct rb_root threads;
b91fc39f	34	pthread_rwlock_t threads_lock;
d2c11034	35	unsigned int nr_threads;
69d2591a ACM	36	struct list_head dead_threads;
69d2591a ACM	37	struct thread *last_match;
d027b640	38	struct vdso_info *vdso_info;
4cde998d	39	struct perf_env *env;
3d39ac53	40	struct dsos dsos;
69d2591a ACM	41	struct map_groups kmaps;
69d2591a ACM	42	struct map *vmlinux_maps[MAP__NR_TYPES];
fbe2af45	43	u64 kernel_start;
b9d266ba	44	pid_t *current_tid;
0db15b1e AH	45	union { /* Tool specific area */
	46	void *priv;
	47	u64 db_id;
	48	};
69d2591a ACM	49	};
	50
	51	static inline
a5e813c6	52	struct map __machine__kernel_map(struct machine machine, enum map_type type)
69d2591a ACM	53	{
	54	return machine->vmlinux_maps[type];
	55	}
	56
a5e813c6 ACM	57	static inline
	58	struct map machine__kernel_map(struct machine machine)
	59	{
	60	return __machine__kernel_map(machine, MAP__FUNCTION);
	61	}
	62
fbe2af45 AH	63	int machine__get_kernel_start(struct machine *machine);
	64
	65	static inline u64 machine__kernel_start(struct machine *machine)
	66	{
	67	if (!machine->kernel_start)
	68	machine__get_kernel_start(machine);
	69	return machine->kernel_start;
	70	}
	71
	72	static inline bool machine__kernel_ip(struct machine *machine, u64 ip)
	73	{
	74	u64 kernel_start = machine__kernel_start(machine);
	75
	76	return ip >= kernel_start;
	77	}
	78
d75e6097 JO	79	struct thread machine__find_thread(struct machine machine, pid_t pid,
d75e6097 JO	80	pid_t tid);
cfe1c414 AH	81	struct comm machine__thread_exec_comm(struct machine machine,
cfe1c414 AH	82	struct thread *thread);
9d2f8e22	83
162f0bef FW	84	int machine__process_comm_event(struct machine machine, union perf_event event,
	85	struct perf_sample *sample);
	86	int machine__process_exit_event(struct machine machine, union perf_event event,
	87	struct perf_sample *sample);
	88	int machine__process_fork_event(struct machine machine, union perf_event event,
	89	struct perf_sample *sample);
	90	int machine__process_lost_event(struct machine machine, union perf_event event,
	91	struct perf_sample *sample);
c4937a91 KL	92	int machine__process_lost_samples_event(struct machine machine, union perf_event event,
c4937a91 KL	93	struct perf_sample *sample);
4a96f7a0 AH	94	int machine__process_aux_event(struct machine *machine,
4a96f7a0 AH	95	union perf_event *event);
0ad21f68 AH	96	int machine__process_itrace_start_event(struct machine *machine,
0ad21f68 AH	97	union perf_event *event);
b8f8eb84	98	int machine__process_switch_event(struct machine *machine,
0286039f	99	union perf_event *event);
162f0bef FW	100	int machine__process_mmap_event(struct machine machine, union perf_event event,
	101	struct perf_sample *sample);
	102	int machine__process_mmap2_event(struct machine machine, union perf_event event,
	103	struct perf_sample *sample);
	104	int machine__process_event(struct machine machine, union perf_event event,
	105	struct perf_sample *sample);
b0a7d1a0	106
69d2591a ACM	107	typedef void (machine__process_t)(struct machine machine, void *data);
69d2591a ACM	108
876650e6 ACM	109	struct machines {
	110	struct machine host;
	111	struct rb_root guests;
	112	};
	113
	114	void machines__init(struct machines *machines);
	115	void machines__exit(struct machines *machines);
	116
	117	void machines__process_guests(struct machines *machines,
	118	machine__process_t process, void *data);
69d2591a	119
876650e6	120	struct machine machines__add(struct machines machines, pid_t pid,
69d2591a	121	const char *root_dir);
876650e6 ACM	122	struct machine machines__find_host(struct machines machines);
	123	struct machine machines__find(struct machines machines, pid_t pid);
	124	struct machine machines__findnew(struct machines machines, pid_t pid);
69d2591a	125
876650e6	126	void machines__set_id_hdr_size(struct machines *machines, u16 id_hdr_size);
69d2591a ACM	127	char machine__mmap_name(struct machine machine, char *bf, size_t size);
69d2591a ACM	128
cfe1c414	129	void machines__set_comm_exec(struct machines *machines, bool comm_exec);
611a5ce8	130
8fb598e5	131	struct machine *machine__new_host(void);
69d2591a ACM	132	int machine__init(struct machine machine, const char root_dir, pid_t pid);
69d2591a ACM	133	void machine__exit(struct machine *machine);
3f067dca	134	void machine__delete_threads(struct machine *machine);
69d2591a	135	void machine__delete(struct machine *machine);
5e78c69b	136	void machine__remove_thread(struct machine machine, struct thread th);
69d2591a	137
644f2df2 ACM	138	struct branch_info sample__resolve_bstack(struct perf_sample sample,
644f2df2 ACM	139	struct addr_location *al);
e80faac0 ACM	140	struct mem_info sample__resolve_mem(struct perf_sample sample,
e80faac0 ACM	141	struct addr_location *al);
91d7b2de ACM	142
	143	struct callchain_cursor;
	144
cc8b7c2b	145	int thread__resolve_callchain(struct thread *thread,
91d7b2de	146	struct callchain_cursor *cursor,
cc8b7c2b ACM	147	struct perf_evsel *evsel,
	148	struct perf_sample *sample,
	149	struct symbol **parent,
	150	struct addr_location *root_al,
	151	int max_stack);
69d2591a ACM	152
	153	/*
	154	* Default guest kernel is defined by parameter --guestkallsyms
	155	* and --guestmodules
	156	*/
	157	static inline bool machine__is_default_guest(struct machine *machine)
	158	{
	159	return machine ? machine->pid == DEFAULT_GUEST_KERNEL_ID : false;
	160	}
	161
	162	static inline bool machine__is_host(struct machine *machine)
	163	{
	164	return machine ? machine->pid == HOST_KERNEL_ID : false;
	165	}
	166
b91fc39f ACM	167	struct thread __machine__findnew_thread(struct machine machine, pid_t pid, pid_t tid);
b91fc39f ACM	168	struct thread machine__findnew_thread(struct machine machine, pid_t pid, pid_t tid);
69d2591a	169
aa7cc2ae ACM	170	struct dso machine__findnew_dso(struct machine machine, const char *filename);
aa7cc2ae ACM	171
69d2591a ACM	172	size_t machine__fprintf(struct machine machine, FILE fp);
	173
	174	static inline
	175	struct symbol machine__find_kernel_symbol(struct machine machine,
	176	enum map_type type, u64 addr,
	177	struct map **mapp,
	178	symbol_filter_t filter)
	179	{
	180	return map_groups__find_symbol(&machine->kmaps, type, addr,
	181	mapp, filter);
	182	}
	183
8acd3da0 ACM	184	static inline
	185	struct symbol machine__find_kernel_symbol_by_name(struct machine machine,
	186	enum map_type type, const char *name,
	187	struct map **mapp,
	188	symbol_filter_t filter)
	189	{
	190	return map_groups__find_symbol_by_name(&machine->kmaps, type, name,
	191	mapp, filter);
	192	}
	193
69d2591a ACM	194	static inline
	195	struct symbol machine__find_kernel_function(struct machine machine, u64 addr,
	196	struct map **mapp,
	197	symbol_filter_t filter)
	198	{
	199	return machine__find_kernel_symbol(machine, MAP__FUNCTION, addr,
	200	mapp, filter);
	201	}
	202
	203	static inline
	204	struct symbol machine__find_kernel_function_by_name(struct machine machine,
	205	const char *name,
	206	struct map **mapp,
	207	symbol_filter_t filter)
	208	{
	209	return map_groups__find_function_by_name(&machine->kmaps, name, mapp,
	210	filter);
	211	}
	212
9f2de315 ACM	213	struct map machine__findnew_module_map(struct machine machine, u64 start,
9f2de315 ACM	214	const char *filename);
203d8a4a	215	int arch__fix_module_text_start(u64 start, const char name);
69d2591a	216
e02092b9 ACM	217	int __machine__load_kallsyms(struct machine machine, const char filename,
e02092b9 ACM	218	enum map_type type, bool no_kcore, symbol_filter_t filter);
69d2591a ACM	219	int machine__load_kallsyms(struct machine machine, const char filename,
	220	enum map_type type, symbol_filter_t filter);
	221	int machine__load_vmlinux_path(struct machine *machine, enum map_type type,
	222	symbol_filter_t filter);
	223
417c2ff6 ACM	224	size_t machine__fprintf_dsos_buildid(struct machine machine, FILE fp,
417c2ff6 ACM	225	bool (skip)(struct dso *dso, int parm), int parm);
876650e6 ACM	226	size_t machines__fprintf_dsos(struct machines machines, FILE fp);
876650e6 ACM	227	size_t machines__fprintf_dsos_buildid(struct machines machines, FILE fp,
417c2ff6	228	bool (skip)(struct dso *dso, int parm), int parm);
69d2591a ACM	229
	230	void machine__destroy_kernel_maps(struct machine *machine);
	231	int __machine__create_kernel_maps(struct machine machine, struct dso kernel);
	232	int machine__create_kernel_maps(struct machine *machine);
	233
876650e6 ACM	234	int machines__create_kernel_maps(struct machines *machines, pid_t pid);
	235	int machines__create_guest_kernel_maps(struct machines *machines);
	236	void machines__destroy_kernel_maps(struct machines *machines);
69d2591a ACM	237
	238	size_t machine__fprintf_vmlinux_path(struct machine machine, FILE fp);
	239
35feee19 DA	240	int machine__for_each_thread(struct machine *machine,
	241	int (fn)(struct thread thread, void *p),
	242	void *priv);
a5499b37 AH	243	int machines__for_each_thread(struct machines *machines,
	244	int (fn)(struct thread thread, void *p),
	245	void *priv);
35feee19	246
a33fbd56	247	int __machine__synthesize_threads(struct machine machine, struct perf_tool tool,
602ad878	248	struct target target, struct thread_map threads,
9d9cad76 KL	249	perf_event__handler_t process, bool data_mmap,
9d9cad76 KL	250	unsigned int proc_map_timeout);
a33fbd56	251	static inline
602ad878	252	int machine__synthesize_threads(struct machine machine, struct target target,
9d9cad76 KL	253	struct thread_map *threads, bool data_mmap,
9d9cad76 KL	254	unsigned int proc_map_timeout)
a33fbd56 ACM	255	{
a33fbd56 ACM	256	return __machine__synthesize_threads(machine, NULL, target, threads,
9d9cad76 KL	257	perf_event__process, data_mmap,
9d9cad76 KL	258	proc_map_timeout);
a33fbd56 ACM	259	}
a33fbd56 ACM	260
b9d266ba AH	261	pid_t machine__get_current_tid(struct machine *machine, int cpu);
	262	int machine__set_current_tid(struct machine *machine, int cpu, pid_t pid,
	263	pid_t tid);
c3168b0d ACM	264	/*
	265	* For use with libtraceevent's pevent_set_function_resolver()
	266	*/
	267	char machine__resolve_kernel_addr(void vmachine, unsigned long long addrp, char *modp);
b9d266ba	268
9d2f8e22	269	#endif /* __PERF_MACHINE_H */