tools/perf/util/synthetic-events.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __PERF_SYNTHETIC_EVENTS_H
   3 #define __PERF_SYNTHETIC_EVENTS_H
   4
   5 #include <stdbool.h>
   6 #include <sys/types.h> // pid_t
   7 #include <linux/compiler.h>
   8 #include <linux/types.h>
   9
  10 struct auxtrace_record;
  11 struct dso;
  12 struct evlist;
  13 struct evsel;
  14 struct machine;
  15 struct perf_counts_values;
  16 struct perf_cpu_map;
  17 struct perf_data;
  18 struct perf_event_attr;
  19 struct perf_event_mmap_page;
  20 struct perf_sample;
  21 struct perf_session;
  22 struct perf_stat_config;
  23 struct perf_thread_map;
  24 struct perf_tool;
  25 struct record_opts;
  26 struct target;
  27
  28 union perf_event;
  29
  30 enum perf_record_synth {
  31         PERF_SYNTH_TASK         = 1 << 0,
  32         PERF_SYNTH_MMAP         = 1 << 1,
  33         PERF_SYNTH_CGROUP       = 1 << 2,
  34
  35         /* last element */
  36         PERF_SYNTH_MAX          = 1 << 3,
  37 };
  38 #define PERF_SYNTH_ALL  (PERF_SYNTH_MAX - 1)
  39
  40 int parse_synth_opt(char *str);
  41
  42 typedef int (*perf_event__handler_t)(struct perf_tool *tool, union perf_event *event,
  43                                      struct perf_sample *sample, struct machine *machine);
  44
  45 int perf_event__synthesize_attrs(struct perf_tool *tool, struct evlist *evlist, perf_event__handler_t process);
  46 int perf_event__synthesize_attr(struct perf_tool *tool, struct perf_event_attr *attr, u32 ids, u64 *id, perf_event__handler_t process);
  47 int perf_event__synthesize_build_id(struct perf_tool *tool, struct dso *pos, u16 misc, perf_event__handler_t process, struct machine *machine);
  48 int perf_event__synthesize_cpu_map(struct perf_tool *tool, struct perf_cpu_map *cpus, perf_event__handler_t process, struct machine *machine);
  49 int perf_event__synthesize_event_update_cpus(struct perf_tool *tool, struct evsel *evsel, perf_event__handler_t process);
  50 int perf_event__synthesize_event_update_name(struct perf_tool *tool, struct evsel *evsel, perf_event__handler_t process);
  51 int perf_event__synthesize_event_update_scale(struct perf_tool *tool, struct evsel *evsel, perf_event__handler_t process);
  52 int perf_event__synthesize_event_update_unit(struct perf_tool *tool, struct evsel *evsel, perf_event__handler_t process);
  53 int perf_event__synthesize_extra_attr(struct perf_tool *tool, struct evlist *evsel_list, perf_event__handler_t process, bool is_pipe);
  54 int perf_event__synthesize_extra_kmaps(struct perf_tool *tool, perf_event__handler_t process, struct machine *machine);
  55 int perf_event__synthesize_features(struct perf_tool *tool, struct perf_session *session, struct evlist *evlist, perf_event__handler_t process);
  56 int perf_event__synthesize_id_index(struct perf_tool *tool, perf_event__handler_t process, struct evlist *evlist, struct machine *machine);
  57 int perf_event__synthesize_kernel_mmap(struct perf_tool *tool, perf_event__handler_t process, struct machine *machine);
  58 int perf_event__synthesize_mmap_events(struct perf_tool *tool, union perf_event *event, pid_t pid, pid_t tgid, perf_event__handler_t process, struct machine *machine, bool mmap_data);
  59 int perf_event__synthesize_modules(struct perf_tool *tool, perf_event__handler_t process, struct machine *machine);
  60 int perf_event__synthesize_namespaces(struct perf_tool *tool, union perf_event *event, pid_t pid, pid_t tgid, perf_event__handler_t process, struct machine *machine);
  61 int perf_event__synthesize_cgroups(struct perf_tool *tool, perf_event__handler_t process, struct machine *machine);
  62 int perf_event__synthesize_sample(union perf_event *event, u64 type, u64 read_format, const struct perf_sample *sample);
  63 int perf_event__synthesize_stat_config(struct perf_tool *tool, struct perf_stat_config *config, perf_event__handler_t process, struct machine *machine);
  64 int perf_event__synthesize_stat_events(struct perf_stat_config *config, struct perf_tool *tool, struct evlist *evlist, perf_event__handler_t process, bool attrs);
  65 int perf_event__synthesize_stat_round(struct perf_tool *tool, u64 time, u64 type, perf_event__handler_t process, struct machine *machine);
  66 int perf_event__synthesize_stat(struct perf_tool *tool, u32 cpu, u32 thread, u64 id, struct perf_counts_values *count, perf_event__handler_t process, struct machine *machine);
  67 int perf_event__synthesize_thread_map2(struct perf_tool *tool, struct perf_thread_map *threads, perf_event__handler_t process, struct machine *machine);
  68 int perf_event__synthesize_thread_map(struct perf_tool *tool, struct perf_thread_map *threads, perf_event__handler_t process, struct machine *machine, bool needs_mmap, bool mmap_data);
  69 int perf_event__synthesize_threads(struct perf_tool *tool, perf_event__handler_t process, struct machine *machine, bool needs_mmap, bool mmap_data, unsigned int nr_threads_synthesize);
  70 int perf_event__synthesize_tracing_data(struct perf_tool *tool, int fd, struct evlist *evlist, perf_event__handler_t process);
  71 int perf_event__synth_time_conv(const struct perf_event_mmap_page *pc, struct perf_tool *tool, perf_event__handler_t process, struct machine *machine);
  72 pid_t perf_event__synthesize_comm(struct perf_tool *tool, union perf_event *event, pid_t pid, perf_event__handler_t process, struct machine *machine);
  73
  74 int perf_tool__process_synth_event(struct perf_tool *tool, union perf_event *event, struct machine *machine, perf_event__handler_t process);
  75
  76 size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type, u64 read_format);
  77
  78 int __machine__synthesize_threads(struct machine *machine, struct perf_tool *tool,
  79                                   struct target *target, struct perf_thread_map *threads,
  80                                   perf_event__handler_t process, bool needs_mmap, bool data_mmap,
  81                                   unsigned int nr_threads_synthesize);
  82 int machine__synthesize_threads(struct machine *machine, struct target *target,
  83                                 struct perf_thread_map *threads, bool needs_mmap, bool data_mmap,
  84                                 unsigned int nr_threads_synthesize);
  85
  86 #ifdef HAVE_AUXTRACE_SUPPORT
  87 int perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr, struct perf_tool *tool,
  88                                          struct perf_session *session, perf_event__handler_t process);
  89
  90 #else // HAVE_AUXTRACE_SUPPORT
  91
  92 #include <errno.h>
  93
  94 static inline int
  95 perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr __maybe_unused,
  96                                      struct perf_tool *tool __maybe_unused,
  97                                      struct perf_session *session __maybe_unused,
  98                                      perf_event__handler_t process __maybe_unused)
  99 {
 100         return -EINVAL;
 101 }
 102 #endif // HAVE_AUXTRACE_SUPPORT
 103
 104 #ifdef HAVE_LIBBPF_SUPPORT
 105 int perf_event__synthesize_bpf_events(struct perf_session *session, perf_event__handler_t process,
 106                                       struct machine *machine, struct record_opts *opts);
 107 #else // HAVE_LIBBPF_SUPPORT
 108 static inline int perf_event__synthesize_bpf_events(struct perf_session *session __maybe_unused,
 109                                                     perf_event__handler_t process __maybe_unused,
 110                                                     struct machine *machine __maybe_unused,
 111                                                     struct record_opts *opts __maybe_unused)
 112 {
 113         return 0;
 114 }
 115 #endif // HAVE_LIBBPF_SUPPORT
 116
 117 int perf_event__synthesize_for_pipe(struct perf_tool *tool,
 118                                     struct perf_session *session,
 119                                     struct perf_data *data,
 120                                     perf_event__handler_t process);
 121
 122 #endif // __PERF_SYNTHETIC_EVENTS_H