blob: 792b0ea8a8b850948fe247c3b449c5d893884c48 [file] [log] [blame]
Arnaldo Carvalho de Melo69aad6f2011-01-03 16:39:04 -02001#ifndef __PERF_EVSEL_H
2#define __PERF_EVSEL_H 1
3
4#include <linux/list.h>
Arnaldo Carvalho de Meloc52b12e2011-01-03 17:45:52 -02005#include <stdbool.h>
Arnaldo Carvalho de Melo07ac0022012-11-13 17:27:28 -03006#include <stddef.h>
David Howellsd2709c72012-11-19 22:21:03 +00007#include <linux/perf_event.h>
Borislav Petkovd944c4e2014-04-25 21:31:02 +02008#include <linux/types.h>
Arnaldo Carvalho de Melo69aad6f2011-01-03 16:39:04 -02009#include "xyarray.h"
Namhyung Kim759ff492013-03-05 14:53:26 +090010#include "symbol.h"
Borislav Petkovd944c4e2014-04-25 21:31:02 +020011
Arnaldo Carvalho de Meloc52b12e2011-01-03 17:45:52 -020012struct perf_counts_values {
13 union {
14 struct {
15 u64 val;
16 u64 ena;
17 u64 run;
18 };
19 u64 values[3];
20 };
21};
22
23struct perf_counts {
24 s8 scaled;
25 struct perf_counts_values aggr;
26 struct perf_counts_values cpu[];
27};
Arnaldo Carvalho de Melo69aad6f2011-01-03 16:39:04 -020028
Arnaldo Carvalho de Melo70db7532011-01-12 22:39:13 -020029struct perf_evsel;
30
31/*
32 * Per fd, to map back from PERF_SAMPLE_ID to evsel, only used when there are
33 * more than one entry in the evlist.
34 */
35struct perf_sample_id {
36 struct hlist_node node;
37 u64 id;
38 struct perf_evsel *evsel;
Adrian Hunter3c659ee2014-10-27 15:49:22 +020039 int idx;
40 int cpu;
41 pid_t tid;
Jiri Olsae4caec02012-10-10 18:52:24 +020042
43 /* Holds total ID period value for PERF_SAMPLE_READ processing. */
44 u64 period;
Arnaldo Carvalho de Melo70db7532011-01-12 22:39:13 -020045};
46
Arnaldo Carvalho de Melof14d5702014-10-17 12:17:40 -030047struct cgroup_sel;
48
Stephane Eranianf0c55bc2011-02-16 15:10:01 +020049/** struct perf_evsel - event selector
50 *
51 * @name - Can be set to retain the original event name passed by the user,
52 * so that when showing results in tools such as 'perf stat', we
53 * show the name used, not some alias.
Adrian Hunter75562572013-08-27 11:23:09 +030054 * @id_pos: the position of the event id (PERF_SAMPLE_ID or
55 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
56 * struct sample_event
57 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
58 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
59 * is used there is an id sample appended to non-sample events
Adrian Hunter0db15b12014-10-23 13:45:13 +030060 * @priv: And what is in its containing unnamed union are tool specific
Stephane Eranianf0c55bc2011-02-16 15:10:01 +020061 */
Arnaldo Carvalho de Melo69aad6f2011-01-03 16:39:04 -020062struct perf_evsel {
63 struct list_head node;
64 struct perf_event_attr attr;
65 char *filter;
66 struct xyarray *fd;
Arnaldo Carvalho de Meloa91e5432011-03-10 11:15:54 -030067 struct xyarray *sample_id;
68 u64 *id;
Arnaldo Carvalho de Meloc52b12e2011-01-03 17:45:52 -020069 struct perf_counts *counts;
Stephane Eranianc7a79c42013-01-29 12:47:43 +010070 struct perf_counts *prev_raw_counts;
Arnaldo Carvalho de Melo69aad6f2011-01-03 16:39:04 -020071 int idx;
Robert Richterf4d83432012-08-16 21:10:17 +020072 u32 ids;
Stephane Eranianf0c55bc2011-02-16 15:10:01 +020073 char *name;
Stephane Eranian410136f2013-11-12 17:58:49 +010074 double scale;
75 const char *unit;
Arnaldo Carvalho de Melofcf65bf2012-08-07 09:58:03 -030076 struct event_format *tp_format;
Arnaldo Carvalho de Meloa91e5432011-03-10 11:15:54 -030077 union {
78 void *priv;
79 off_t id_offset;
Adrian Hunter0db15b12014-10-23 13:45:13 +030080 u64 db_id;
Arnaldo Carvalho de Meloa91e5432011-03-10 11:15:54 -030081 };
Stephane Eranian023695d2011-02-14 11:20:01 +020082 struct cgroup_sel *cgrp;
Arnaldo Carvalho de Melo744a9712013-11-06 10:17:38 -030083 void *handler;
Yan, Zheng7ae92e72012-09-10 15:53:50 +080084 struct cpu_map *cpus;
Arnaldo Carvalho de Melobde09462012-08-01 18:53:11 -030085 unsigned int sample_size;
Adrian Hunter75562572013-08-27 11:23:09 +030086 int id_pos;
87 int is_pos;
David Ahern2cee77c2011-05-30 08:55:59 -060088 bool supported;
Arnaldo Carvalho de Melo0807d2d2012-09-26 12:48:18 -030089 bool needs_swap;
Adrian Hunter6ff1ce72014-07-14 13:02:56 +030090 bool no_aux_samples;
Adrian Hunter2afd2bc2014-07-14 13:02:57 +030091 bool immediate;
Adrian Hunterbf8e8f42014-07-31 09:00:51 +030092 bool system_wide;
Adrian Hunter60b08962014-07-31 09:00:52 +030093 bool tracking;
Matt Fleming044330c2014-11-21 10:31:12 +010094 bool per_pkg;
Jiri Olsaf5b11352012-08-08 12:21:54 +020095 /* parse modifier helper */
96 int exclude_GH;
Namhyung Kim97f63e42013-01-22 18:09:29 +090097 int nr_members;
Jiri Olsa3c176312012-10-10 17:39:03 +020098 int sample_read;
Jiri Olsa6a4bb042012-08-08 12:22:36 +020099 struct perf_evsel *leader;
100 char *group_name;
Arnaldo Carvalho de Melo69aad6f2011-01-03 16:39:04 -0200101};
102
Borislav Petkov88080ce2014-04-14 17:38:39 +0200103union u64_swap {
104 u64 val64;
105 u32 val32[2];
106};
107
Arnaldo Carvalho de Melo86bd5e82011-01-03 23:09:46 -0200108struct cpu_map;
Arnaldo Carvalho de Melo80b22102014-10-13 10:29:50 -0300109struct target;
Arnaldo Carvalho de Melo86bd5e82011-01-03 23:09:46 -0200110struct thread_map;
Arnaldo Carvalho de Melo70082dd2011-01-12 17:03:24 -0200111struct perf_evlist;
Arnaldo Carvalho de Melob4006792013-12-19 14:43:45 -0300112struct record_opts;
Arnaldo Carvalho de Melo86bd5e82011-01-03 23:09:46 -0200113
Jiri Olsa13112bb2014-11-21 10:31:06 +0100114void perf_counts_values__scale(struct perf_counts_values *count,
115 bool scale, s8 *pscaled);
116
Jiri Olsa857a94a2014-11-21 10:31:05 +0100117void perf_evsel__compute_deltas(struct perf_evsel *evsel, int cpu,
118 struct perf_counts_values *count);
119
Arnaldo Carvalho de Meloce8ccff2014-10-09 15:29:51 -0300120int perf_evsel__object_config(size_t object_size,
121 int (*init)(struct perf_evsel *evsel),
122 void (*fini)(struct perf_evsel *evsel));
123
Arnaldo Carvalho de Meloef503832013-11-07 16:41:19 -0300124struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx);
125
126static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr)
127{
128 return perf_evsel__new_idx(attr, 0);
129}
130
131struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx);
132
133static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name)
134{
135 return perf_evsel__newtp_idx(sys, name, 0);
136}
Arnaldo Carvalho de Melo201b7332012-09-26 20:24:19 -0300137
138struct event_format *event_format__new(const char *sys, const char *name);
139
Arnaldo Carvalho de Meloef1d1af2011-01-18 21:41:45 -0200140void perf_evsel__init(struct perf_evsel *evsel,
141 struct perf_event_attr *attr, int idx);
142void perf_evsel__exit(struct perf_evsel *evsel);
Arnaldo Carvalho de Melo69aad6f2011-01-03 16:39:04 -0200143void perf_evsel__delete(struct perf_evsel *evsel);
144
Arnaldo Carvalho de Melo0f82ebc2011-11-08 14:41:57 -0200145void perf_evsel__config(struct perf_evsel *evsel,
Arnaldo Carvalho de Melob4006792013-12-19 14:43:45 -0300146 struct record_opts *opts);
Arnaldo Carvalho de Melo0f82ebc2011-11-08 14:41:57 -0200147
Adrian Hunter75562572013-08-27 11:23:09 +0300148int __perf_evsel__sample_size(u64 sample_type);
149void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
150
Arnaldo Carvalho de Melo0b668bc2012-06-11 14:08:07 -0300151bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
152
153#define PERF_EVSEL__MAX_ALIASES 8
154
155extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
156 [PERF_EVSEL__MAX_ALIASES];
157extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
158 [PERF_EVSEL__MAX_ALIASES];
Arnaldo Carvalho de Melo8ad70132012-09-06 13:11:18 -0300159extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
160 [PERF_EVSEL__MAX_ALIASES];
161extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
162extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
Arnaldo Carvalho de Melo0b668bc2012-06-11 14:08:07 -0300163int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
164 char *bf, size_t size);
Arnaldo Carvalho de Melo7289f832012-06-12 12:34:58 -0300165const char *perf_evsel__name(struct perf_evsel *evsel);
Stephane Eranian410136f2013-11-12 17:58:49 +0100166
Namhyung Kim717e2632013-01-22 18:09:44 +0900167const char *perf_evsel__group_name(struct perf_evsel *evsel);
168int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
Arnaldo Carvalho de Meloc4104312012-05-25 16:38:11 -0300169
Arnaldo Carvalho de Melo70db7532011-01-12 22:39:13 -0200170int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
Arnaldo Carvalho de Meloc52b12e2011-01-03 17:45:52 -0200171int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
Frederik Deweerdta7e191c2013-03-01 13:02:27 -0500172void perf_evsel__reset_counts(struct perf_evsel *evsel, int ncpus);
Namhyung Kim43f8e762013-01-25 10:44:44 +0900173void perf_evsel__free_counts(struct perf_evsel *evsel);
Arnaldo Carvalho de Meloc52b12e2011-01-03 17:45:52 -0200174void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
Arnaldo Carvalho de Melo69aad6f2011-01-03 16:39:04 -0200175
Arnaldo Carvalho de Melo7be5ebe2012-12-10 14:53:43 -0300176void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
177 enum perf_event_sample_format bit);
178void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
179 enum perf_event_sample_format bit);
180
181#define perf_evsel__set_sample_bit(evsel, bit) \
182 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
183
184#define perf_evsel__reset_sample_bit(evsel, bit) \
185 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
186
Adrian Hunter75562572013-08-27 11:23:09 +0300187void perf_evsel__set_sample_id(struct perf_evsel *evsel,
188 bool use_sample_identifier);
Arnaldo Carvalho de Melo7a5a5ca2012-12-10 15:21:30 -0300189
Arnaldo Carvalho de Melo745cefc2012-09-26 15:07:39 -0300190int perf_evsel__set_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
191 const char *filter);
Andi Kleene2407be2013-08-02 17:41:10 -0700192int perf_evsel__enable(struct perf_evsel *evsel, int ncpus, int nthreads);
Arnaldo Carvalho de Melo745cefc2012-09-26 15:07:39 -0300193
Arnaldo Carvalho de Melof08199d2011-01-11 23:42:19 -0200194int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
Jiri Olsa6a4bb042012-08-08 12:22:36 +0200195 struct cpu_map *cpus);
Arnaldo Carvalho de Melof08199d2011-01-11 23:42:19 -0200196int perf_evsel__open_per_thread(struct perf_evsel *evsel,
Jiri Olsa6a4bb042012-08-08 12:22:36 +0200197 struct thread_map *threads);
Arnaldo Carvalho de Melof08199d2011-01-11 23:42:19 -0200198int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
Jiri Olsa6a4bb042012-08-08 12:22:36 +0200199 struct thread_map *threads);
Arnaldo Carvalho de Melo727ab042011-10-25 10:42:19 -0200200void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
Arnaldo Carvalho de Melo48290602011-01-03 17:48:12 -0200201
Arnaldo Carvalho de Melo5555ded2012-09-11 19:24:23 -0300202struct perf_sample;
203
Arnaldo Carvalho de Melo5d2074e2012-09-26 20:22:00 -0300204void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
Arnaldo Carvalho de Melo5555ded2012-09-11 19:24:23 -0300205 const char *name);
206u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
207 const char *name);
208
Arnaldo Carvalho de Melo5d2074e2012-09-26 20:22:00 -0300209static inline char *perf_evsel__strval(struct perf_evsel *evsel,
210 struct perf_sample *sample,
211 const char *name)
212{
213 return perf_evsel__rawptr(evsel, sample, name);
214}
215
Arnaldo Carvalho de Meloefd2b922012-09-18 11:21:50 -0300216struct format_field;
217
218struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
219
Arnaldo Carvalho de Melodaec78a2011-01-03 16:49:44 -0200220#define perf_evsel__match(evsel, t, c) \
221 (evsel->attr.type == PERF_TYPE_##t && \
222 evsel->attr.config == PERF_COUNT_##c)
223
Jiri Olsa863e4512012-09-06 17:46:55 +0200224static inline bool perf_evsel__match2(struct perf_evsel *e1,
225 struct perf_evsel *e2)
226{
227 return (e1->attr.type == e2->attr.type) &&
228 (e1->attr.config == e2->attr.config);
229}
230
Andi Kleen4cabc3d2013-08-21 16:47:26 -0700231#define perf_evsel__cmp(a, b) \
232 ((a) && \
233 (b) && \
234 (a)->attr.type == (b)->attr.type && \
235 (a)->attr.config == (b)->attr.config)
236
Jiri Olsa011dccb2014-11-21 10:31:07 +0100237typedef int (perf_evsel__read_cb_t)(struct perf_evsel *evsel,
238 int cpu, int thread,
239 struct perf_counts_values *count);
240
241int perf_evsel__read_cb(struct perf_evsel *evsel, int cpu, int thread,
242 perf_evsel__read_cb_t cb);
243
Arnaldo Carvalho de Meloc52b12e2011-01-03 17:45:52 -0200244int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
245 int cpu, int thread, bool scale);
246
247/**
248 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
249 *
250 * @evsel - event selector to read value
251 * @cpu - CPU of interest
252 * @thread - thread of interest
253 */
254static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
255 int cpu, int thread)
256{
257 return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
258}
259
260/**
261 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
262 *
263 * @evsel - event selector to read value
264 * @cpu - CPU of interest
265 * @thread - thread of interest
266 */
267static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
268 int cpu, int thread)
269{
270 return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
271}
272
273int __perf_evsel__read(struct perf_evsel *evsel, int ncpus, int nthreads,
274 bool scale);
275
276/**
277 * perf_evsel__read - Read the aggregate results on all CPUs
278 *
279 * @evsel - event selector to read value
280 * @ncpus - Number of cpus affected, from zero
281 * @nthreads - Number of threads affected, from zero
282 */
283static inline int perf_evsel__read(struct perf_evsel *evsel,
284 int ncpus, int nthreads)
285{
286 return __perf_evsel__read(evsel, ncpus, nthreads, false);
287}
288
289/**
290 * perf_evsel__read_scaled - Read the aggregate results on all CPUs, scaled
291 *
292 * @evsel - event selector to read value
293 * @ncpus - Number of cpus affected, from zero
294 * @nthreads - Number of threads affected, from zero
295 */
296static inline int perf_evsel__read_scaled(struct perf_evsel *evsel,
297 int ncpus, int nthreads)
298{
299 return __perf_evsel__read(evsel, ncpus, nthreads, true);
300}
301
Arnaldo Carvalho de Meloa3f698f2012-08-02 12:23:46 -0300302int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
Arnaldo Carvalho de Melo0807d2d2012-09-26 12:48:18 -0300303 struct perf_sample *sample);
Arnaldo Carvalho de Melo0c21f732012-08-14 16:42:15 -0300304
305static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
306{
307 return list_entry(evsel->node.next, struct perf_evsel, node);
308}
Arnaldo Carvalho de Melo07ac0022012-11-13 17:27:28 -0300309
Arnaldo Carvalho de Melod87fcb42013-11-13 15:56:40 -0300310static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel)
311{
312 return list_entry(evsel->node.prev, struct perf_evsel, node);
313}
314
Namhyung Kim759ff492013-03-05 14:53:26 +0900315/**
316 * perf_evsel__is_group_leader - Return whether given evsel is a leader event
317 *
318 * @evsel - evsel selector to be tested
319 *
320 * Return %true if @evsel is a group leader or a stand-alone event
321 */
Namhyung Kim823254e2012-11-29 15:38:30 +0900322static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
Arnaldo Carvalho de Melo07ac0022012-11-13 17:27:28 -0300323{
Namhyung Kim823254e2012-11-29 15:38:30 +0900324 return evsel->leader == evsel;
Arnaldo Carvalho de Melo07ac0022012-11-13 17:27:28 -0300325}
Arnaldo Carvalho de Melo0698aed2012-12-10 18:17:08 -0300326
Namhyung Kim759ff492013-03-05 14:53:26 +0900327/**
328 * perf_evsel__is_group_event - Return whether given evsel is a group event
329 *
330 * @evsel - evsel selector to be tested
331 *
332 * Return %true iff event group view is enabled and @evsel is a actual group
333 * leader which has other members in the group
334 */
335static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
336{
337 if (!symbol_conf.event_group)
338 return false;
339
340 return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
341}
342
Jiri Olsa6bedfab2014-03-02 16:56:40 +0100343/**
344 * perf_evsel__is_function_event - Return whether given evsel is a function
345 * trace event
346 *
347 * @evsel - evsel selector to be tested
348 *
349 * Return %true if event is function trace event
350 */
351static inline bool perf_evsel__is_function_event(struct perf_evsel *evsel)
352{
353#define FUNCTION_EVENT "ftrace:function"
354
355 return evsel->name &&
356 !strncmp(FUNCTION_EVENT, evsel->name, sizeof(FUNCTION_EVENT));
357
358#undef FUNCTION_EVENT
359}
360
Arnaldo Carvalho de Melo0698aed2012-12-10 18:17:08 -0300361struct perf_attr_details {
362 bool freq;
363 bool verbose;
Arnaldo Carvalho de Meloe35ef3552013-02-06 17:20:02 -0300364 bool event_group;
Arnaldo Carvalho de Melo0698aed2012-12-10 18:17:08 -0300365};
366
367int perf_evsel__fprintf(struct perf_evsel *evsel,
368 struct perf_attr_details *details, FILE *fp);
Arnaldo Carvalho de Meloc0a54342012-12-13 14:16:30 -0300369
370bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
371 char *msg, size_t msgsize);
Arnaldo Carvalho de Melo602ad872013-11-12 16:46:16 -0300372int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target,
Arnaldo Carvalho de Melo56e52e82012-12-13 15:10:58 -0300373 int err, char *msg, size_t size);
Namhyung Kim97f63e42013-01-22 18:09:29 +0900374
375static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
376{
377 return evsel->idx - evsel->leader->idx;
378}
Namhyung Kim717e2632013-01-22 18:09:44 +0900379
380#define for_each_group_member(_evsel, _leader) \
381for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); \
382 (_evsel) && (_evsel)->leader == (_leader); \
383 (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
384
Arnaldo Carvalho de Melo69aad6f2011-01-03 16:39:04 -0200385#endif /* __PERF_EVSEL_H */