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_INHERIT
,
47 PERF_EVSEL__CONFIG_TERM_MAX_STACK
,
48 PERF_EVSEL__CONFIG_TERM_MAX
,
51 struct perf_evsel_config_term
{
52 struct list_head list
;
65 /** struct perf_evsel - event selector
67 * @evlist - evlist this evsel is in, if it is in one.
68 * @node - To insert it into evlist->entries or in other list_heads, say in
69 * the event parsing routines.
70 * @name - Can be set to retain the original event name passed by the user,
71 * so that when showing results in tools such as 'perf stat', we
72 * show the name used, not some alias.
73 * @id_pos: the position of the event id (PERF_SAMPLE_ID or
74 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
76 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
77 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
78 * is used there is an id sample appended to non-sample events
79 * @priv: And what is in its containing unnamed union are tool specific
82 struct list_head node
;
83 struct perf_evlist
*evlist
;
84 struct perf_event_attr attr
;
87 struct xyarray
*sample_id
;
89 struct perf_counts
*counts
;
90 struct perf_counts
*prev_raw_counts
;
96 struct event_format
*tp_format
;
100 struct cgroup_sel
*cgrp
;
102 struct cpu_map
*cpus
;
103 struct cpu_map
*own_cpus
;
104 struct thread_map
*threads
;
105 unsigned int sample_size
;
118 /* parse modifier helper */
122 unsigned long *per_pkg_mask
;
123 struct perf_evsel
*leader
;
125 bool cmdline_group_boundary
;
126 struct list_head config_terms
;
140 static inline struct cpu_map
*perf_evsel__cpus(struct perf_evsel
*evsel
)
145 static inline int perf_evsel__nr_cpus(struct perf_evsel
*evsel
)
147 return perf_evsel__cpus(evsel
)->nr
;
150 void perf_counts_values__scale(struct perf_counts_values
*count
,
151 bool scale
, s8
*pscaled
);
153 void perf_evsel__compute_deltas(struct perf_evsel
*evsel
, int cpu
, int thread
,
154 struct perf_counts_values
*count
);
156 int perf_evsel__object_config(size_t object_size
,
157 int (*init
)(struct perf_evsel
*evsel
),
158 void (*fini
)(struct perf_evsel
*evsel
));
160 struct perf_evsel
*perf_evsel__new_idx(struct perf_event_attr
*attr
, int idx
);
162 static inline struct perf_evsel
*perf_evsel__new(struct perf_event_attr
*attr
)
164 return perf_evsel__new_idx(attr
, 0);
167 struct perf_evsel
*perf_evsel__newtp_idx(const char *sys
, const char *name
, int idx
);
170 * Returns pointer with encoded error via <linux/err.h> interface.
172 static inline struct perf_evsel
*perf_evsel__newtp(const char *sys
, const char *name
)
174 return perf_evsel__newtp_idx(sys
, name
, 0);
177 struct event_format
*event_format__new(const char *sys
, const char *name
);
179 void perf_evsel__init(struct perf_evsel
*evsel
,
180 struct perf_event_attr
*attr
, int idx
);
181 void perf_evsel__exit(struct perf_evsel
*evsel
);
182 void perf_evsel__delete(struct perf_evsel
*evsel
);
184 struct callchain_param
;
186 void perf_evsel__config(struct perf_evsel
*evsel
,
187 struct record_opts
*opts
,
188 struct callchain_param
*callchain
);
189 void perf_evsel__config_callchain(struct perf_evsel
*evsel
,
190 struct record_opts
*opts
,
191 struct callchain_param
*callchain
);
193 int __perf_evsel__sample_size(u64 sample_type
);
194 void perf_evsel__calc_id_pos(struct perf_evsel
*evsel
);
196 bool perf_evsel__is_cache_op_valid(u8 type
, u8 op
);
198 #define PERF_EVSEL__MAX_ALIASES 8
200 extern const char *perf_evsel__hw_cache
[PERF_COUNT_HW_CACHE_MAX
]
201 [PERF_EVSEL__MAX_ALIASES
];
202 extern const char *perf_evsel__hw_cache_op
[PERF_COUNT_HW_CACHE_OP_MAX
]
203 [PERF_EVSEL__MAX_ALIASES
];
204 extern const char *perf_evsel__hw_cache_result
[PERF_COUNT_HW_CACHE_RESULT_MAX
]
205 [PERF_EVSEL__MAX_ALIASES
];
206 extern const char *perf_evsel__hw_names
[PERF_COUNT_HW_MAX
];
207 extern const char *perf_evsel__sw_names
[PERF_COUNT_SW_MAX
];
208 int __perf_evsel__hw_cache_type_op_res_name(u8 type
, u8 op
, u8 result
,
209 char *bf
, size_t size
);
210 const char *perf_evsel__name(struct perf_evsel
*evsel
);
212 const char *perf_evsel__group_name(struct perf_evsel
*evsel
);
213 int perf_evsel__group_desc(struct perf_evsel
*evsel
, char *buf
, size_t size
);
215 int perf_evsel__alloc_id(struct perf_evsel
*evsel
, int ncpus
, int nthreads
);
216 void perf_evsel__close_fd(struct perf_evsel
*evsel
, int ncpus
, int nthreads
);
218 void __perf_evsel__set_sample_bit(struct perf_evsel
*evsel
,
219 enum perf_event_sample_format bit
);
220 void __perf_evsel__reset_sample_bit(struct perf_evsel
*evsel
,
221 enum perf_event_sample_format bit
);
223 #define perf_evsel__set_sample_bit(evsel, bit) \
224 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
226 #define perf_evsel__reset_sample_bit(evsel, bit) \
227 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
229 void perf_evsel__set_sample_id(struct perf_evsel
*evsel
,
230 bool use_sample_identifier
);
232 int perf_evsel__set_filter(struct perf_evsel
*evsel
, const char *filter
);
233 int perf_evsel__append_filter(struct perf_evsel
*evsel
,
234 const char *op
, const char *filter
);
235 int perf_evsel__apply_filter(struct perf_evsel
*evsel
, int ncpus
, int nthreads
,
237 int perf_evsel__enable(struct perf_evsel
*evsel
);
238 int perf_evsel__disable(struct perf_evsel
*evsel
);
240 int perf_evsel__open_per_cpu(struct perf_evsel
*evsel
,
241 struct cpu_map
*cpus
);
242 int perf_evsel__open_per_thread(struct perf_evsel
*evsel
,
243 struct thread_map
*threads
);
244 int perf_evsel__open(struct perf_evsel
*evsel
, struct cpu_map
*cpus
,
245 struct thread_map
*threads
);
246 void perf_evsel__close(struct perf_evsel
*evsel
, int ncpus
, int nthreads
);
250 void *perf_evsel__rawptr(struct perf_evsel
*evsel
, struct perf_sample
*sample
,
252 u64
perf_evsel__intval(struct perf_evsel
*evsel
, struct perf_sample
*sample
,
255 static inline char *perf_evsel__strval(struct perf_evsel
*evsel
,
256 struct perf_sample
*sample
,
259 return perf_evsel__rawptr(evsel
, sample
, name
);
264 struct format_field
*perf_evsel__field(struct perf_evsel
*evsel
, const char *name
);
266 #define perf_evsel__match(evsel, t, c) \
267 (evsel->attr.type == PERF_TYPE_##t && \
268 evsel->attr.config == PERF_COUNT_##c)
270 static inline bool perf_evsel__match2(struct perf_evsel
*e1
,
271 struct perf_evsel
*e2
)
273 return (e1
->attr
.type
== e2
->attr
.type
) &&
274 (e1
->attr
.config
== e2
->attr
.config
);
277 #define perf_evsel__cmp(a, b) \
280 (a)->attr.type == (b)->attr.type && \
281 (a)->attr.config == (b)->attr.config)
283 int perf_evsel__read(struct perf_evsel
*evsel
, int cpu
, int thread
,
284 struct perf_counts_values
*count
);
286 int __perf_evsel__read_on_cpu(struct perf_evsel
*evsel
,
287 int cpu
, int thread
, bool scale
);
290 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
292 * @evsel - event selector to read value
293 * @cpu - CPU of interest
294 * @thread - thread of interest
296 static inline int perf_evsel__read_on_cpu(struct perf_evsel
*evsel
,
299 return __perf_evsel__read_on_cpu(evsel
, cpu
, thread
, false);
303 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
305 * @evsel - event selector to read value
306 * @cpu - CPU of interest
307 * @thread - thread of interest
309 static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel
*evsel
,
312 return __perf_evsel__read_on_cpu(evsel
, cpu
, thread
, true);
315 int perf_evsel__parse_sample(struct perf_evsel
*evsel
, union perf_event
*event
,
316 struct perf_sample
*sample
);
318 static inline struct perf_evsel
*perf_evsel__next(struct perf_evsel
*evsel
)
320 return list_entry(evsel
->node
.next
, struct perf_evsel
, node
);
323 static inline struct perf_evsel
*perf_evsel__prev(struct perf_evsel
*evsel
)
325 return list_entry(evsel
->node
.prev
, struct perf_evsel
, node
);
329 * perf_evsel__is_group_leader - Return whether given evsel is a leader event
331 * @evsel - evsel selector to be tested
333 * Return %true if @evsel is a group leader or a stand-alone event
335 static inline bool perf_evsel__is_group_leader(const struct perf_evsel
*evsel
)
337 return evsel
->leader
== evsel
;
341 * perf_evsel__is_group_event - Return whether given evsel is a group event
343 * @evsel - evsel selector to be tested
345 * Return %true iff event group view is enabled and @evsel is a actual group
346 * leader which has other members in the group
348 static inline bool perf_evsel__is_group_event(struct perf_evsel
*evsel
)
350 if (!symbol_conf
.event_group
)
353 return perf_evsel__is_group_leader(evsel
) && evsel
->nr_members
> 1;
357 * perf_evsel__is_function_event - Return whether given evsel is a function
360 * @evsel - evsel selector to be tested
362 * Return %true if event is function trace event
364 static inline bool perf_evsel__is_function_event(struct perf_evsel
*evsel
)
366 #define FUNCTION_EVENT "ftrace:function"
368 return evsel
->name
&&
369 !strncmp(FUNCTION_EVENT
, evsel
->name
, sizeof(FUNCTION_EVENT
));
371 #undef FUNCTION_EVENT
374 static inline bool perf_evsel__is_bpf_output(struct perf_evsel
*evsel
)
376 struct perf_event_attr
*attr
= &evsel
->attr
;
378 return (attr
->config
== PERF_COUNT_SW_BPF_OUTPUT
) &&
379 (attr
->type
== PERF_TYPE_SOFTWARE
);
382 struct perf_attr_details
{
390 int perf_evsel__fprintf(struct perf_evsel
*evsel
,
391 struct perf_attr_details
*details
, FILE *fp
);
393 #define EVSEL__PRINT_IP (1<<0)
394 #define EVSEL__PRINT_SYM (1<<1)
395 #define EVSEL__PRINT_DSO (1<<2)
396 #define EVSEL__PRINT_SYMOFFSET (1<<3)
397 #define EVSEL__PRINT_ONELINE (1<<4)
398 #define EVSEL__PRINT_SRCLINE (1<<5)
399 #define EVSEL__PRINT_UNKNOWN_AS_ADDR (1<<6)
401 struct callchain_cursor
;
403 int sample__fprintf_callchain(struct perf_sample
*sample
, int left_alignment
,
404 unsigned int print_opts
,
405 struct callchain_cursor
*cursor
, FILE *fp
);
407 int sample__fprintf_sym(struct perf_sample
*sample
, struct addr_location
*al
,
408 int left_alignment
, unsigned int print_opts
,
409 struct callchain_cursor
*cursor
, FILE *fp
);
411 bool perf_evsel__fallback(struct perf_evsel
*evsel
, int err
,
412 char *msg
, size_t msgsize
);
413 int perf_evsel__open_strerror(struct perf_evsel
*evsel
, struct target
*target
,
414 int err
, char *msg
, size_t size
);
416 static inline int perf_evsel__group_idx(struct perf_evsel
*evsel
)
418 return evsel
->idx
- evsel
->leader
->idx
;
421 #define for_each_group_member(_evsel, _leader) \
422 for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); \
423 (_evsel) && (_evsel)->leader == (_leader); \
424 (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
426 static inline bool perf_evsel__has_branch_callstack(const struct perf_evsel
*evsel
)
428 return evsel
->attr
.branch_sample_type
& PERF_SAMPLE_BRANCH_CALL_STACK
;
431 typedef int (*attr__fprintf_f
)(FILE *, const char *, const char *, void *);
433 int perf_event_attr__fprintf(FILE *fp
, struct perf_event_attr
*attr
,
434 attr__fprintf_f attr__fprintf
, void *priv
);
436 #endif /* __PERF_EVSEL_H */