xref: /linux/tools/perf/util/synthetic-events.h (revision a6021aa24f6417416d93318bbfa022ab229c33c8)
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 #include <perf/cpumap.h>
10 
11 struct auxtrace_record;
12 struct build_id;
13 struct dso;
14 struct evlist;
15 struct evsel;
16 struct machine;
17 struct perf_counts_values;
18 struct perf_cpu_map;
19 struct perf_data;
20 struct perf_event_attr;
21 struct perf_event_mmap_page;
22 struct perf_sample;
23 struct perf_session;
24 struct perf_stat_config;
25 struct perf_thread_map;
26 struct perf_tool;
27 struct record_opts;
28 struct target;
29 
30 union perf_event;
31 
32 enum perf_record_synth {
33 	PERF_SYNTH_TASK		= 1 << 0,
34 	PERF_SYNTH_MMAP		= 1 << 1,
35 	PERF_SYNTH_CGROUP	= 1 << 2,
36 
37 	/* last element */
38 	PERF_SYNTH_MAX		= 1 << 3,
39 };
40 #define PERF_SYNTH_ALL  (PERF_SYNTH_MAX - 1)
41 
42 int parse_synth_opt(char *str);
43 
44 typedef int (*perf_event__handler_t)(const struct perf_tool *tool, union perf_event *event,
45 				     struct perf_sample *sample, struct machine *machine);
46 
47 int perf_event__synthesize_attrs(const struct perf_tool *tool, struct evlist *evlist, perf_event__handler_t process);
48 int perf_event__synthesize_attr(const struct perf_tool *tool, struct perf_event_attr *attr, u32 ids, u64 *id, perf_event__handler_t process);
49 int perf_event__synthesize_build_id(const struct perf_tool *tool,
50 				    struct perf_sample *sample,
51 				    struct machine *machine,
52 				    perf_event__handler_t process,
53 				    const struct evsel *evsel,
54 				    __u16 misc,
55 				    const struct build_id *bid,
56 				    const char *filename);
57 int perf_event__synthesize_mmap2_build_id(const struct perf_tool *tool,
58 					  struct perf_sample *sample,
59 					  struct machine *machine,
60 					  perf_event__handler_t process,
61 					  const struct evsel *evsel,
62 					  __u16 misc,
63 					  __u32 pid, __u32 tid,
64 					  __u64 start, __u64 len, __u64 pgoff,
65 					  const struct build_id *bid,
66 					  __u32 prot, __u32 flags,
67 					  const char *filename);
68 int perf_event__synthesize_cpu_map(const struct perf_tool *tool, const struct perf_cpu_map *cpus, perf_event__handler_t process, struct machine *machine);
69 int perf_event__synthesize_event_update_cpus(const struct perf_tool *tool, struct evsel *evsel, perf_event__handler_t process);
70 int perf_event__synthesize_event_update_name(const struct perf_tool *tool, struct evsel *evsel, perf_event__handler_t process);
71 int perf_event__synthesize_event_update_scale(const struct perf_tool *tool, struct evsel *evsel, perf_event__handler_t process);
72 int perf_event__synthesize_event_update_unit(const struct perf_tool *tool, struct evsel *evsel, perf_event__handler_t process);
73 int perf_event__synthesize_extra_attr(const struct perf_tool *tool, struct evlist *evsel_list, perf_event__handler_t process, bool is_pipe);
74 int perf_event__synthesize_extra_kmaps(const struct perf_tool *tool, perf_event__handler_t process, struct machine *machine);
75 int perf_event__synthesize_features(const struct perf_tool *tool, struct perf_session *session, struct evlist *evlist, perf_event__handler_t process);
76 int perf_event__synthesize_id_index(const struct perf_tool *tool, perf_event__handler_t process, struct evlist *evlist, struct machine *machine);
77 int __perf_event__synthesize_id_index(const struct perf_tool *tool, perf_event__handler_t process, struct evlist *evlist, struct machine *machine, size_t from);
78 int perf_event__synthesize_id_sample(__u64 *array, u64 type, const struct perf_sample *sample);
79 int perf_event__synthesize_kernel_mmap(const struct perf_tool *tool, perf_event__handler_t process, struct machine *machine);
80 int perf_event__synthesize_mmap_events(const 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);
81 int perf_event__synthesize_modules(const struct perf_tool *tool, perf_event__handler_t process, struct machine *machine);
82 int perf_event__synthesize_namespaces(const struct perf_tool *tool, union perf_event *event, pid_t pid, pid_t tgid, perf_event__handler_t process, struct machine *machine);
83 int perf_event__synthesize_cgroups(const struct perf_tool *tool, perf_event__handler_t process, struct machine *machine);
84 int perf_event__synthesize_sample(union perf_event *event, u64 type, u64 read_format, const struct perf_sample *sample);
85 int perf_event__synthesize_stat_config(const struct perf_tool *tool, struct perf_stat_config *config, perf_event__handler_t process, struct machine *machine);
86 int perf_event__synthesize_stat_events(struct perf_stat_config *config, const struct perf_tool *tool, struct evlist *evlist, perf_event__handler_t process, bool attrs);
87 int perf_event__synthesize_stat_round(const struct perf_tool *tool, u64 time, u64 type, perf_event__handler_t process, struct machine *machine);
88 int perf_event__synthesize_stat(const struct perf_tool *tool, struct perf_cpu cpu, u32 thread, u64 id, struct perf_counts_values *count, perf_event__handler_t process, struct machine *machine);
89 int perf_event__synthesize_thread_map2(const struct perf_tool *tool, struct perf_thread_map *threads, perf_event__handler_t process, struct machine *machine);
90 int perf_event__synthesize_thread_map(const struct perf_tool *tool, struct perf_thread_map *threads, perf_event__handler_t process, struct machine *machine, bool needs_mmap, bool mmap_data);
91 int perf_event__synthesize_threads(const struct perf_tool *tool, perf_event__handler_t process, struct machine *machine, bool needs_mmap, bool mmap_data, unsigned int nr_threads_synthesize);
92 int perf_event__synthesize_tracing_data(const struct perf_tool *tool, int fd, struct evlist *evlist, perf_event__handler_t process);
93 int perf_event__synth_time_conv(const struct perf_event_mmap_page *pc, const struct perf_tool *tool, perf_event__handler_t process, struct machine *machine);
94 pid_t perf_event__synthesize_comm(const struct perf_tool *tool, union perf_event *event, pid_t pid, perf_event__handler_t process, struct machine *machine);
95 
96 int perf_tool__process_synth_event(const struct perf_tool *tool, union perf_event *event, struct machine *machine, perf_event__handler_t process);
97 
98 size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type, u64 read_format);
99 
100 int __machine__synthesize_threads(struct machine *machine, const struct perf_tool *tool,
101 				  struct target *target, struct perf_thread_map *threads,
102 				  perf_event__handler_t process, bool needs_mmap, bool data_mmap,
103 				  unsigned int nr_threads_synthesize);
104 int machine__synthesize_threads(struct machine *machine, struct target *target,
105 				struct perf_thread_map *threads, bool needs_mmap, bool data_mmap,
106 				unsigned int nr_threads_synthesize);
107 
108 #ifdef HAVE_AUXTRACE_SUPPORT
109 int perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr, const struct perf_tool *tool,
110 					 struct perf_session *session, perf_event__handler_t process);
111 
112 #else // HAVE_AUXTRACE_SUPPORT
113 
114 #include <errno.h>
115 
116 static inline int
117 perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr __maybe_unused,
118 				     const struct perf_tool *tool __maybe_unused,
119 				     struct perf_session *session __maybe_unused,
120 				     perf_event__handler_t process __maybe_unused)
121 {
122 	return -EINVAL;
123 }
124 #endif // HAVE_AUXTRACE_SUPPORT
125 
126 #ifdef HAVE_LIBBPF_SUPPORT
127 int perf_event__synthesize_bpf_events(struct perf_session *session, perf_event__handler_t process,
128 				      struct machine *machine, struct record_opts *opts);
129 #else // HAVE_LIBBPF_SUPPORT
130 static inline int perf_event__synthesize_bpf_events(struct perf_session *session __maybe_unused,
131 						    perf_event__handler_t process __maybe_unused,
132 						    struct machine *machine __maybe_unused,
133 						    struct record_opts *opts __maybe_unused)
134 {
135 	return 0;
136 }
137 #endif // HAVE_LIBBPF_SUPPORT
138 
139 int perf_event__synthesize_for_pipe(const struct perf_tool *tool,
140 				    struct perf_session *session,
141 				    struct perf_data *data,
142 				    perf_event__handler_t process);
143 
144 #endif // __PERF_SYNTHETIC_EVENTS_H
145