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