tools/perf/util/machine.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __PERF_MACHINE_H
   3 #define __PERF_MACHINE_H
   4
   5 #include <sys/types.h>
   6 #include <linux/rbtree.h>
   7 #include "map.h"
   8 #include "dso.h"
   9 #include "event.h"
  10 #include "rwsem.h"
  11
  12 struct addr_location;
  13 struct branch_stack;
  14 struct perf_evsel;
  15 struct perf_sample;
  16 struct symbol;
  17 struct thread;
  18 union perf_event;
  19
  20 /* Native host kernel uses -1 as pid index in machine */
  21 #define HOST_KERNEL_ID                  (-1)
  22 #define DEFAULT_GUEST_KERNEL_ID         (0)
  23
  24 extern const char *ref_reloc_sym_names[];
  25
  26 struct vdso_info;
  27
  28 #define THREADS__TABLE_BITS     8
  29 #define THREADS__TABLE_SIZE     (1 << THREADS__TABLE_BITS)
  30
  31 struct threads {
  32         struct rb_root    entries;
  33         struct rw_semaphore lock;
  34         unsigned int      nr;
  35         struct list_head  dead;
  36         struct thread     *last_match;
  37 };
  38
  39 struct machine {
  40         struct rb_node    rb_node;
  41         pid_t             pid;
  42         u16               id_hdr_size;
  43         bool              comm_exec;
  44         bool              kptr_restrict_warned;
  45         char              *root_dir;
  46         char              *mmap_name;
  47         struct threads    threads[THREADS__TABLE_SIZE];
  48         struct vdso_info  *vdso_info;
  49         struct perf_env   *env;
  50         struct dsos       dsos;
  51         struct map_groups kmaps;
  52         struct map        *vmlinux_maps[MAP__NR_TYPES];
  53         u64               kernel_start;
  54         pid_t             *current_tid;
  55         union { /* Tool specific area */
  56                 void      *priv;
  57                 u64       db_id;
  58         };
  59 };
  60
  61 static inline struct threads *machine__threads(struct machine *machine, pid_t tid)
  62 {
  63         /* Cast it to handle tid == -1 */
  64         return &machine->threads[(unsigned int)tid % THREADS__TABLE_SIZE];
  65 }
  66
  67 static inline
  68 struct map *__machine__kernel_map(struct machine *machine, enum map_type type)
  69 {
  70         return machine->vmlinux_maps[type];
  71 }
  72
  73 /*
  74  * The main kernel (vmlinux) map
  75  */
  76 static inline
  77 struct map *machine__kernel_map(struct machine *machine)
  78 {
  79         return __machine__kernel_map(machine, MAP__FUNCTION);
  80 }
  81
  82 /*
  83  * kernel (the one returned by machine__kernel_map()) plus kernel modules maps
  84  */
  85 static inline
  86 struct maps *machine__kernel_maps(struct machine *machine)
  87 {
  88         return &machine->kmaps.maps[MAP__FUNCTION];
  89 }
  90
  91 int machine__get_kernel_start(struct machine *machine);
  92
  93 static inline u64 machine__kernel_start(struct machine *machine)
  94 {
  95         if (!machine->kernel_start)
  96                 machine__get_kernel_start(machine);
  97         return machine->kernel_start;
  98 }
  99
 100 static inline bool machine__kernel_ip(struct machine *machine, u64 ip)
 101 {
 102         u64 kernel_start = machine__kernel_start(machine);
 103
 104         return ip >= kernel_start;
 105 }
 106
 107 struct thread *machine__find_thread(struct machine *machine, pid_t pid,
 108                                     pid_t tid);
 109 struct comm *machine__thread_exec_comm(struct machine *machine,
 110                                        struct thread *thread);
 111
 112 int machine__process_comm_event(struct machine *machine, union perf_event *event,
 113                                 struct perf_sample *sample);
 114 int machine__process_exit_event(struct machine *machine, union perf_event *event,
 115                                 struct perf_sample *sample);
 116 int machine__process_fork_event(struct machine *machine, union perf_event *event,
 117                                 struct perf_sample *sample);
 118 int machine__process_lost_event(struct machine *machine, union perf_event *event,
 119                                 struct perf_sample *sample);
 120 int machine__process_lost_samples_event(struct machine *machine, union perf_event *event,
 121                                         struct perf_sample *sample);
 122 int machine__process_aux_event(struct machine *machine,
 123                                union perf_event *event);
 124 int machine__process_itrace_start_event(struct machine *machine,
 125                                         union perf_event *event);
 126 int machine__process_switch_event(struct machine *machine,
 127                                   union perf_event *event);
 128 int machine__process_namespaces_event(struct machine *machine,
 129                                       union perf_event *event,
 130                                       struct perf_sample *sample);
 131 int machine__process_mmap_event(struct machine *machine, union perf_event *event,
 132                                 struct perf_sample *sample);
 133 int machine__process_mmap2_event(struct machine *machine, union perf_event *event,
 134                                  struct perf_sample *sample);
 135 int machine__process_event(struct machine *machine, union perf_event *event,
 136                                 struct perf_sample *sample);
 137
 138 typedef void (*machine__process_t)(struct machine *machine, void *data);
 139
 140 struct machines {
 141         struct machine host;
 142         struct rb_root guests;
 143 };
 144
 145 void machines__init(struct machines *machines);
 146 void machines__exit(struct machines *machines);
 147
 148 void machines__process_guests(struct machines *machines,
 149                               machine__process_t process, void *data);
 150
 151 struct machine *machines__add(struct machines *machines, pid_t pid,
 152                               const char *root_dir);
 153 struct machine *machines__find_host(struct machines *machines);
 154 struct machine *machines__find(struct machines *machines, pid_t pid);
 155 struct machine *machines__findnew(struct machines *machines, pid_t pid);
 156
 157 void machines__set_id_hdr_size(struct machines *machines, u16 id_hdr_size);
 158 void machines__set_comm_exec(struct machines *machines, bool comm_exec);
 159
 160 struct machine *machine__new_host(void);
 161 struct machine *machine__new_kallsyms(void);
 162 int machine__init(struct machine *machine, const char *root_dir, pid_t pid);
 163 void machine__exit(struct machine *machine);
 164 void machine__delete_threads(struct machine *machine);
 165 void machine__delete(struct machine *machine);
 166 void machine__remove_thread(struct machine *machine, struct thread *th);
 167
 168 struct branch_info *sample__resolve_bstack(struct perf_sample *sample,
 169                                            struct addr_location *al);
 170 struct mem_info *sample__resolve_mem(struct perf_sample *sample,
 171                                      struct addr_location *al);
 172
 173 struct callchain_cursor;
 174
 175 int thread__resolve_callchain(struct thread *thread,
 176                               struct callchain_cursor *cursor,
 177                               struct perf_evsel *evsel,
 178                               struct perf_sample *sample,
 179                               struct symbol **parent,
 180                               struct addr_location *root_al,
 181                               int max_stack);
 182
 183 /*
 184  * Default guest kernel is defined by parameter --guestkallsyms
 185  * and --guestmodules
 186  */
 187 static inline bool machine__is_default_guest(struct machine *machine)
 188 {
 189         return machine ? machine->pid == DEFAULT_GUEST_KERNEL_ID : false;
 190 }
 191
 192 static inline bool machine__is_host(struct machine *machine)
 193 {
 194         return machine ? machine->pid == HOST_KERNEL_ID : false;
 195 }
 196
 197 struct thread *__machine__findnew_thread(struct machine *machine, pid_t pid, pid_t tid);
 198 struct thread *machine__findnew_thread(struct machine *machine, pid_t pid, pid_t tid);
 199
 200 struct dso *machine__findnew_dso(struct machine *machine, const char *filename);
 201
 202 size_t machine__fprintf(struct machine *machine, FILE *fp);
 203
 204 static inline
 205 struct symbol *machine__find_kernel_symbol(struct machine *machine,
 206                                            enum map_type type, u64 addr,
 207                                            struct map **mapp)
 208 {
 209         return map_groups__find_symbol(&machine->kmaps, type, addr, mapp);
 210 }
 211
 212 static inline
 213 struct symbol *machine__find_kernel_symbol_by_name(struct machine *machine,
 214                                                    enum map_type type, const char *name,
 215                                                    struct map **mapp)
 216 {
 217         return map_groups__find_symbol_by_name(&machine->kmaps, type, name, mapp);
 218 }
 219
 220 static inline
 221 struct symbol *machine__find_kernel_function(struct machine *machine, u64 addr,
 222                                              struct map **mapp)
 223 {
 224         return machine__find_kernel_symbol(machine, MAP__FUNCTION, addr,
 225                                            mapp);
 226 }
 227
 228 static inline
 229 struct symbol *machine__find_kernel_function_by_name(struct machine *machine,
 230                                                      const char *name,
 231                                                      struct map **mapp)
 232 {
 233         return map_groups__find_function_by_name(&machine->kmaps, name, mapp);
 234 }
 235
 236 struct map *machine__findnew_module_map(struct machine *machine, u64 start,
 237                                         const char *filename);
 238 int arch__fix_module_text_start(u64 *start, const char *name);
 239
 240 int machine__load_kallsyms(struct machine *machine, const char *filename,
 241                            enum map_type type);
 242 int machine__load_vmlinux_path(struct machine *machine, enum map_type type);
 243
 244 size_t machine__fprintf_dsos_buildid(struct machine *machine, FILE *fp,
 245                                      bool (skip)(struct dso *dso, int parm), int parm);
 246 size_t machines__fprintf_dsos(struct machines *machines, FILE *fp);
 247 size_t machines__fprintf_dsos_buildid(struct machines *machines, FILE *fp,
 248                                      bool (skip)(struct dso *dso, int parm), int parm);
 249
 250 void machine__destroy_kernel_maps(struct machine *machine);
 251 int machine__create_kernel_maps(struct machine *machine);
 252
 253 int machines__create_kernel_maps(struct machines *machines, pid_t pid);
 254 int machines__create_guest_kernel_maps(struct machines *machines);
 255 void machines__destroy_kernel_maps(struct machines *machines);
 256
 257 size_t machine__fprintf_vmlinux_path(struct machine *machine, FILE *fp);
 258
 259 int machine__for_each_thread(struct machine *machine,
 260                              int (*fn)(struct thread *thread, void *p),
 261                              void *priv);
 262 int machines__for_each_thread(struct machines *machines,
 263                               int (*fn)(struct thread *thread, void *p),
 264                               void *priv);
 265
 266 int __machine__synthesize_threads(struct machine *machine, struct perf_tool *tool,
 267                                   struct target *target, struct thread_map *threads,
 268                                   perf_event__handler_t process, bool data_mmap,
 269                                   unsigned int proc_map_timeout,
 270                                   unsigned int nr_threads_synthesize);
 271 static inline
 272 int machine__synthesize_threads(struct machine *machine, struct target *target,
 273                                 struct thread_map *threads, bool data_mmap,
 274                                 unsigned int proc_map_timeout,
 275                                 unsigned int nr_threads_synthesize)
 276 {
 277         return __machine__synthesize_threads(machine, NULL, target, threads,
 278                                              perf_event__process, data_mmap,
 279                                              proc_map_timeout,
 280                                              nr_threads_synthesize);
 281 }
 282
 283 pid_t machine__get_current_tid(struct machine *machine, int cpu);
 284 int machine__set_current_tid(struct machine *machine, int cpu, pid_t pid,
 285                              pid_t tid);
 286 /*
 287  * For use with libtraceevent's pevent_set_function_resolver()
 288  */
 289 char *machine__resolve_kernel_addr(void *vmachine, unsigned long long *addrp, char **modp);
 290
 291 #endif /* __PERF_MACHINE_H */