[linux-2.6-block.git] / tools / perf / util / machine.h

/* SPDX-License-Identifier: GPL-2.0 */
#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_namespaces_event(struct machine *machine,
				      union perf_event *event,
				      struct perf_sample *sample);
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);
struct machine *machine__new_kallsyms(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)
{
	return map_groups__find_symbol(&machine->kmaps, type, addr, mapp);
}

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

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

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

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);
int machine__load_kallsyms(struct machine *machine, const char *filename,
			   enum map_type type);
int machine__load_vmlinux_path(struct machine *machine, enum map_type type);

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