text: /* 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"
  #include "rwsem.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;
  
  #define THREADS__TABLE_BITS	8
  #define THREADS__TABLE_SIZE	(1 << THREADS__TABLE_BITS)
  
  struct threads {
  	struct rb_root	  entries;
  	struct rw_semaphore lock;
  	unsigned int	  nr;
  	struct list_head  dead;
  	struct thread	  *last_match;
  };
  
  struct machine {
  	struct rb_node	  rb_node;
  	pid_t		  pid;
  	u16		  id_hdr_size;
  	bool		  comm_exec;
  	bool		  kptr_restrict_warned;
  	char		  *root_dir;
  	char		  *mmap_name;
  	struct threads    threads[THREADS__TABLE_SIZE];
  	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 threads *machine__threads(struct machine *machine, pid_t tid)
  {
  	/* Cast it to handle tid == -1 */
  	return &machine->threads[(unsigned int)tid % THREADS__TABLE_SIZE];
  }
  
  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);
  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);
  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);
  
  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,
  				  unsigned int nr_threads_synthesize);
  static inline
  int machine__synthesize_threads(struct machine *machine, struct target *target,
  				struct thread_map *threads, bool data_mmap,
  				unsigned int proc_map_timeout,
  				unsigned int nr_threads_synthesize)
  {
  	return __machine__synthesize_threads(machine, NULL, target, threads,
  					     perf_event__process, data_mmap,
  					     proc_map_timeout,
  					     nr_threads_synthesize);
  }
  
  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 */
  