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