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 #include "threads.h"
  11
  12 struct addr_location;
  13 struct branch_stack;
  14 struct dso;
  15 struct dso_id;
  16 struct evsel;
  17 struct perf_sample;
  18 struct symbol;
  19 struct target;
  20 struct thread;
  21 union perf_event;
  22 struct machines;
  23
  24 /* Native host kernel uses -1 as pid index in machine */
  25 #define HOST_KERNEL_ID                  (-1)
  26 #define DEFAULT_GUEST_KERNEL_ID         (0)
  27
  28 extern const char *ref_reloc_sym_names[];
  29
  30 struct vdso_info;
  31
  32 struct machine {
  33         struct rb_node    rb_node;
  34         pid_t             pid;
  35         u16               id_hdr_size;
  36         bool              comm_exec;
  37         bool              kptr_restrict_warned;
  38         bool              single_address_space;
  39         char              *root_dir;
  40         char              *mmap_name;
  41         char              *kallsyms_filename;
  42         struct threads    threads;
  43         struct vdso_info  *vdso_info;
  44         struct perf_env   *env;
  45         struct dsos       dsos;
  46         struct maps       *kmaps;
  47         struct map        *vmlinux_map;
  48         u64               kernel_start;
  49         struct {
  50                 u64       text_start;
  51                 u64       text_end;
  52         } sched, lock, traceiter, trace;
  53         /*
  54          * The current parallelism level (number of threads that run on CPUs).
  55          * This value can be less than 1, or larger than the total number
  56          * of CPUs, if events are poorly ordered.
  57          */
  58         int               parallelism;
  59         pid_t             *current_tid;
  60         size_t            current_tid_sz;
  61         union { /* Tool specific area */
  62                 void      *priv;
  63                 u64       db_id;
  64         };
  65         struct machines   *machines;
  66         bool              trampolines_mapped;
  67 };
  68
  69 /*
  70  * The main kernel (vmlinux) map
  71  */
  72 static inline
  73 struct map *machine__kernel_map(struct machine *machine)
  74 {
  75         return machine->vmlinux_map;
  76 }
  77
  78 /*
  79  * kernel (the one returned by machine__kernel_map()) plus kernel modules maps
  80  */
  81 static inline
  82 struct maps *machine__kernel_maps(struct machine *machine)
  83 {
  84         return machine->kmaps;
  85 }
  86
  87 int machine__get_kernel_start(struct machine *machine);
  88
  89 static inline u64 machine__kernel_start(struct machine *machine)
  90 {
  91         if (!machine->kernel_start)
  92                 machine__get_kernel_start(machine);
  93         return machine->kernel_start;
  94 }
  95
  96 static inline bool machine__kernel_ip(struct machine *machine, u64 ip)
  97 {
  98         u64 kernel_start = machine__kernel_start(machine);
  99
 100         return ip >= kernel_start;
 101 }
 102
 103 u8 machine__addr_cpumode(struct machine *machine, u8 cpumode, u64 addr);
 104
 105 struct thread *machine__find_thread(struct machine *machine, pid_t pid,
 106                                     pid_t tid);
 107 struct thread *machine__idle_thread(struct machine *machine);
 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_aux_output_hw_id_event(struct machine *machine,
 126                                             union perf_event *event);
 127 int machine__process_switch_event(struct machine *machine,
 128                                   union perf_event *event);
 129 int machine__process_namespaces_event(struct machine *machine,
 130                                       union perf_event *event,
 131                                       struct perf_sample *sample);
 132 int machine__process_cgroup_event(struct machine *machine,
 133                                   union perf_event *event,
 134                                   struct perf_sample *sample);
 135 int machine__process_mmap_event(struct machine *machine, union perf_event *event,
 136                                 struct perf_sample *sample);
 137 int machine__process_mmap2_event(struct machine *machine, union perf_event *event,
 138                                  struct perf_sample *sample);
 139 int machine__process_ksymbol(struct machine *machine,
 140                              union perf_event *event,
 141                              struct perf_sample *sample);
 142 int machine__process_text_poke(struct machine *machine,
 143                                union perf_event *event,
 144                                struct perf_sample *sample);
 145 int machine__process_event(struct machine *machine, union perf_event *event,
 146                                 struct perf_sample *sample);
 147
 148 typedef void (*machine__process_t)(struct machine *machine, void *data);
 149
 150 struct machines {
 151         struct machine host;
 152         struct rb_root_cached guests;
 153 };
 154
 155 void machines__init(struct machines *machines);
 156 void machines__exit(struct machines *machines);
 157
 158 void machines__process_guests(struct machines *machines,
 159                               machine__process_t process, void *data);
 160
 161 struct machine *machines__add(struct machines *machines, pid_t pid,
 162                               const char *root_dir);
 163 struct machine *machines__find(struct machines *machines, pid_t pid);
 164 struct machine *machines__findnew(struct machines *machines, pid_t pid);
 165 struct machine *machines__find_guest(struct machines *machines, pid_t pid);
 166 struct thread *machines__findnew_guest_code(struct machines *machines, pid_t pid);
 167 struct thread *machine__findnew_guest_code(struct machine *machine, pid_t pid);
 168
 169 void machines__set_id_hdr_size(struct machines *machines, u16 id_hdr_size);
 170 void machines__set_comm_exec(struct machines *machines, bool comm_exec);
 171
 172 struct machine *machine__new_host(void);
 173 struct machine *machine__new_kallsyms(void);
 174 struct machine *machine__new_live(bool kernel_maps, pid_t pid);
 175 int machine__init(struct machine *machine, const char *root_dir, pid_t pid);
 176 void machine__exit(struct machine *machine);
 177 void machine__delete_threads(struct machine *machine);
 178 void machine__delete(struct machine *machine);
 179 void machine__remove_thread(struct machine *machine, struct thread *th);
 180
 181 struct branch_info *sample__resolve_bstack(struct perf_sample *sample,
 182                                            struct addr_location *al);
 183 struct mem_info *sample__resolve_mem(struct perf_sample *sample,
 184                                      struct addr_location *al);
 185
 186 struct callchain_cursor;
 187
 188 int __thread__resolve_callchain(struct thread *thread,
 189                                 struct callchain_cursor *cursor,
 190                                 struct evsel *evsel,
 191                                 struct perf_sample *sample,
 192                                 struct symbol **parent,
 193                                 struct addr_location *root_al,
 194                                 int max_stack,
 195                                 bool symbols);
 196
 197 static inline int thread__resolve_callchain(struct thread *thread,
 198                                             struct callchain_cursor *cursor,
 199                                             struct evsel *evsel,
 200                                             struct perf_sample *sample,
 201                                             struct symbol **parent,
 202                                             struct addr_location *root_al,
 203                                             int max_stack)
 204 {
 205         return __thread__resolve_callchain(thread,
 206                                            cursor,
 207                                            evsel,
 208                                            sample,
 209                                            parent,
 210                                            root_al,
 211                                            max_stack,
 212                                            /*symbols=*/true);
 213 }
 214
 215 /*
 216  * Default guest kernel is defined by parameter --guestkallsyms
 217  * and --guestmodules
 218  */
 219 static inline bool machine__is_default_guest(struct machine *machine)
 220 {
 221         return machine ? machine->pid == DEFAULT_GUEST_KERNEL_ID : false;
 222 }
 223
 224 static inline bool machine__is_host(struct machine *machine)
 225 {
 226         return machine ? machine->pid == HOST_KERNEL_ID : false;
 227 }
 228
 229 bool machine__is_lock_function(struct machine *machine, u64 addr);
 230 bool machine__is(struct machine *machine, const char *arch);
 231 bool machine__normalized_is(struct machine *machine, const char *arch);
 232 int machine__nr_cpus_avail(struct machine *machine);
 233
 234 struct thread *machine__findnew_thread(struct machine *machine, pid_t pid, pid_t tid);
 235
 236 struct dso *machine__findnew_dso_id(struct machine *machine, const char *filename,
 237                                     const struct dso_id *id);
 238 struct dso *machine__findnew_dso(struct machine *machine, const char *filename);
 239
 240 size_t machine__fprintf(struct machine *machine, FILE *fp);
 241
 242 static inline
 243 struct symbol *machine__find_kernel_symbol(struct machine *machine, u64 addr,
 244                                            struct map **mapp)
 245 {
 246         return maps__find_symbol(machine->kmaps, addr, mapp);
 247 }
 248
 249 static inline
 250 struct symbol *machine__find_kernel_symbol_by_name(struct machine *machine,
 251                                                    const char *name,
 252                                                    struct map **mapp)
 253 {
 254         return maps__find_symbol_by_name(machine->kmaps, name, mapp);
 255 }
 256
 257 int arch__fix_module_text_start(u64 *start, u64 *size, const char *name);
 258
 259 int machine__load_kallsyms(struct machine *machine, const char *filename);
 260
 261 int machine__load_vmlinux_path(struct machine *machine);
 262
 263 size_t machine__fprintf_dsos_buildid(struct machine *machine, FILE *fp,
 264                                      bool (skip)(struct dso *dso, int parm), int parm);
 265 size_t machines__fprintf_dsos(struct machines *machines, FILE *fp);
 266 size_t machines__fprintf_dsos_buildid(struct machines *machines, FILE *fp,
 267                                      bool (skip)(struct dso *dso, int parm), int parm);
 268
 269 void machine__destroy_kernel_maps(struct machine *machine);
 270 int machine__create_kernel_maps(struct machine *machine);
 271
 272 int machines__create_kernel_maps(struct machines *machines, pid_t pid);
 273 int machines__create_guest_kernel_maps(struct machines *machines);
 274 void machines__destroy_kernel_maps(struct machines *machines);
 275
 276 typedef int (*machine__dso_t)(struct dso *dso, struct machine *machine, void *priv);
 277
 278 int machine__for_each_dso(struct machine *machine, machine__dso_t fn,
 279                           void *priv);
 280
 281 typedef int (*machine__map_t)(struct map *map, void *priv);
 282 int machine__for_each_kernel_map(struct machine *machine, machine__map_t fn,
 283                                  void *priv);
 284
 285 int machine__for_each_thread(struct machine *machine,
 286                              int (*fn)(struct thread *thread, void *p),
 287                              void *priv);
 288 int machines__for_each_thread(struct machines *machines,
 289                               int (*fn)(struct thread *thread, void *p),
 290                               void *priv);
 291
 292 struct thread_list {
 293         struct list_head         list;
 294         struct thread           *thread;
 295 };
 296
 297 /* Make a list of struct thread_list based on threads in the machine. */
 298 int machine__thread_list(struct machine *machine, struct list_head *list);
 299 /* Free up the nodes within the thread_list list. */
 300 void thread_list__delete(struct list_head *list);
 301
 302 pid_t machine__get_current_tid(struct machine *machine, int cpu);
 303 int machine__set_current_tid(struct machine *machine, int cpu, pid_t pid,
 304                              pid_t tid);
 305 /*
 306  * For use with libtraceevent's tep_set_function_resolver()
 307  */
 308 char *machine__resolve_kernel_addr(void *vmachine, unsigned long long *addrp, char **modp);
 309
 310 void machine__get_kallsyms_filename(struct machine *machine, char *buf,
 311                                     size_t bufsz);
 312
 313 int machine__create_extra_kernel_maps(struct machine *machine,
 314                                       struct dso *kernel);
 315
 316 /* Kernel-space maps for symbols that are outside the main kernel map and module maps */
 317 struct extra_kernel_map {
 318         u64 start;
 319         u64 end;
 320         u64 pgoff;
 321         char name[KMAP_NAME_LEN];
 322 };
 323
 324 int machine__create_extra_kernel_map(struct machine *machine,
 325                                      struct dso *kernel,
 326                                      struct extra_kernel_map *xm);
 327
 328 int machine__map_x86_64_entry_trampolines(struct machine *machine,
 329                                           struct dso *kernel);
 330
 331 int machine__resolve(struct machine *machine, struct addr_location *al,
 332                      struct perf_sample *sample);
 333
 334 int machine__hit_all_dsos(struct machine *machine);
 335
 336 #endif /* __PERF_MACHINE_H */