2 #define __PERF_EVSEL_H 1
4 #include <linux/list.h>
7 #include <linux/perf_event.h>
8 #include <linux/types.h>
17 * Per fd, to map back from PERF_SAMPLE_ID to evsel, only used when there are
18 * more than one entry in the evlist.
20 struct perf_sample_id {
21 struct hlist_node node;
23 struct perf_evsel *evsel;
28 /* Holds total ID period value for PERF_SAMPLE_READ processing. */
35 * The 'struct perf_evsel_config_term' is used to pass event
36 * specific configuration data to perf_evsel__config routine.
37 * It is allocated within event parsing and attached to
38 * perf_evsel::config_terms list head.
41 PERF_EVSEL__CONFIG_TERM_PERIOD,
42 PERF_EVSEL__CONFIG_TERM_FREQ,
43 PERF_EVSEL__CONFIG_TERM_TIME,
44 PERF_EVSEL__CONFIG_TERM_CALLGRAPH,
45 PERF_EVSEL__CONFIG_TERM_STACK_USER,
46 PERF_EVSEL__CONFIG_TERM_MAX,
49 struct perf_evsel_config_term {
50 struct list_head list;
61 /** struct perf_evsel - event selector
63 * @evlist - evlist this evsel is in, if it is in one.
64 * @node - To insert it into evlist->entries or in other list_heads, say in
65 * the event parsing routines.
66 * @name - Can be set to retain the original event name passed by the user,
67 * so that when showing results in tools such as 'perf stat', we
68 * show the name used, not some alias.
69 * @id_pos: the position of the event id (PERF_SAMPLE_ID or
70 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
72 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
73 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
74 * is used there is an id sample appended to non-sample events
75 * @priv: And what is in its containing unnamed union are tool specific
78 struct list_head node;
79 struct perf_evlist *evlist;
80 struct perf_event_attr attr;
83 struct xyarray *sample_id;
85 struct perf_counts *counts;
86 struct perf_counts *prev_raw_counts;
92 struct event_format *tp_format;
98 struct cgroup_sel *cgrp;
100 struct cpu_map *cpus;
101 struct cpu_map *own_cpus;
102 struct thread_map *threads;
103 unsigned int sample_size;
114 /* parse modifier helper */
118 unsigned long *per_pkg_mask;
119 struct perf_evsel *leader;
121 bool cmdline_group_boundary;
122 struct list_head config_terms;
135 static inline struct cpu_map *perf_evsel__cpus(struct perf_evsel *evsel)
140 static inline int perf_evsel__nr_cpus(struct perf_evsel *evsel)
142 return perf_evsel__cpus(evsel)->nr;
145 void perf_counts_values__scale(struct perf_counts_values *count,
146 bool scale, s8 *pscaled);
148 void perf_evsel__compute_deltas(struct perf_evsel *evsel, int cpu, int thread,
149 struct perf_counts_values *count);
151 int perf_evsel__object_config(size_t object_size,
152 int (*init)(struct perf_evsel *evsel),
153 void (*fini)(struct perf_evsel *evsel));
155 struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx);
157 static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr)
159 return perf_evsel__new_idx(attr, 0);
162 struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx);
165 * Returns pointer with encoded error via <linux/err.h> interface.
167 static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name)
169 return perf_evsel__newtp_idx(sys, name, 0);
172 struct event_format *event_format__new(const char *sys, const char *name);
174 void perf_evsel__init(struct perf_evsel *evsel,
175 struct perf_event_attr *attr, int idx);
176 void perf_evsel__exit(struct perf_evsel *evsel);
177 void perf_evsel__delete(struct perf_evsel *evsel);
179 void perf_evsel__config(struct perf_evsel *evsel,
180 struct record_opts *opts);
182 int __perf_evsel__sample_size(u64 sample_type);
183 void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
185 bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
187 #define PERF_EVSEL__MAX_ALIASES 8
189 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
190 [PERF_EVSEL__MAX_ALIASES];
191 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
192 [PERF_EVSEL__MAX_ALIASES];
193 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
194 [PERF_EVSEL__MAX_ALIASES];
195 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
196 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
197 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
198 char *bf, size_t size);
199 const char *perf_evsel__name(struct perf_evsel *evsel);
201 const char *perf_evsel__group_name(struct perf_evsel *evsel);
202 int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
204 int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
205 void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
207 void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
208 enum perf_event_sample_format bit);
209 void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
210 enum perf_event_sample_format bit);
212 #define perf_evsel__set_sample_bit(evsel, bit) \
213 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
215 #define perf_evsel__reset_sample_bit(evsel, bit) \
216 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
218 void perf_evsel__set_sample_id(struct perf_evsel *evsel,
219 bool use_sample_identifier);
221 int perf_evsel__set_filter(struct perf_evsel *evsel, const char *filter);
222 int perf_evsel__append_filter(struct perf_evsel *evsel,
223 const char *op, const char *filter);
224 int perf_evsel__apply_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
226 int perf_evsel__enable(struct perf_evsel *evsel, int ncpus, int nthreads);
228 int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
229 struct cpu_map *cpus);
230 int perf_evsel__open_per_thread(struct perf_evsel *evsel,
231 struct thread_map *threads);
232 int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
233 struct thread_map *threads);
234 void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
238 void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
240 u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
243 static inline char *perf_evsel__strval(struct perf_evsel *evsel,
244 struct perf_sample *sample,
247 return perf_evsel__rawptr(evsel, sample, name);
252 struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
254 #define perf_evsel__match(evsel, t, c) \
255 (evsel->attr.type == PERF_TYPE_##t && \
256 evsel->attr.config == PERF_COUNT_##c)
258 static inline bool perf_evsel__match2(struct perf_evsel *e1,
259 struct perf_evsel *e2)
261 return (e1->attr.type == e2->attr.type) &&
262 (e1->attr.config == e2->attr.config);
265 #define perf_evsel__cmp(a, b) \
268 (a)->attr.type == (b)->attr.type && \
269 (a)->attr.config == (b)->attr.config)
271 int perf_evsel__read(struct perf_evsel *evsel, int cpu, int thread,
272 struct perf_counts_values *count);
274 int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
275 int cpu, int thread, bool scale);
278 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
280 * @evsel - event selector to read value
281 * @cpu - CPU of interest
282 * @thread - thread of interest
284 static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
287 return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
291 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
293 * @evsel - event selector to read value
294 * @cpu - CPU of interest
295 * @thread - thread of interest
297 static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
300 return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
303 int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
304 struct perf_sample *sample);
306 static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
308 return list_entry(evsel->node.next, struct perf_evsel, node);
311 static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel)
313 return list_entry(evsel->node.prev, struct perf_evsel, node);
317 * perf_evsel__is_group_leader - Return whether given evsel is a leader event
319 * @evsel - evsel selector to be tested
321 * Return %true if @evsel is a group leader or a stand-alone event
323 static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
325 return evsel->leader == evsel;
329 * perf_evsel__is_group_event - Return whether given evsel is a group event
331 * @evsel - evsel selector to be tested
333 * Return %true iff event group view is enabled and @evsel is a actual group
334 * leader which has other members in the group
336 static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
338 if (!symbol_conf.event_group)
341 return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
345 * perf_evsel__is_function_event - Return whether given evsel is a function
348 * @evsel - evsel selector to be tested
350 * Return %true if event is function trace event
352 static inline bool perf_evsel__is_function_event(struct perf_evsel *evsel)
354 #define FUNCTION_EVENT "ftrace:function"
356 return evsel->name &&
357 !strncmp(FUNCTION_EVENT, evsel->name, sizeof(FUNCTION_EVENT));
359 #undef FUNCTION_EVENT
362 struct perf_attr_details {
369 int perf_evsel__fprintf(struct perf_evsel *evsel,
370 struct perf_attr_details *details, FILE *fp);
372 bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
373 char *msg, size_t msgsize);
374 int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target,
375 int err, char *msg, size_t size);
377 static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
379 return evsel->idx - evsel->leader->idx;
382 #define for_each_group_member(_evsel, _leader) \
383 for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); \
384 (_evsel) && (_evsel)->leader == (_leader); \
385 (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
387 static inline bool has_branch_callstack(struct perf_evsel *evsel)
389 return evsel->attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;
392 typedef int (*attr__fprintf_f)(FILE *, const char *, const char *, void *);
394 int perf_event_attr__fprintf(FILE *fp, struct perf_event_attr *attr,
395 attr__fprintf_f attr__fprintf, void *priv);
397 #endif /* __PERF_EVSEL_H */