blob: d3854c4f52e1c2fe6277732aebefe432ab2799d0 [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;
Jiri Olsae4caec02012-10-10 18:52:24 +020039
40 /* Holds total ID period value for PERF_SAMPLE_READ processing. */
41 u64 period;
Arnaldo Carvalho de Melo70db7532011-01-12 22:39:13 -020042};
43
Arnaldo Carvalho de Melof14d5702014-10-17 12:17:40 -030044struct cgroup_sel;
45
Stephane Eranianf0c55bc2011-02-16 15:10:01 +020046/** struct perf_evsel - event selector
47 *
48 * @name - Can be set to retain the original event name passed by the user,
49 * so that when showing results in tools such as 'perf stat', we
50 * show the name used, not some alias.
Adrian Hunter75562572013-08-27 11:23:09 +030051 * @id_pos: the position of the event id (PERF_SAMPLE_ID or
52 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
53 * struct sample_event
54 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
55 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
56 * is used there is an id sample appended to non-sample events
Adrian Hunter0db15b12014-10-23 13:45:13 +030057 * @priv: And what is in its containing unnamed union are tool specific
Stephane Eranianf0c55bc2011-02-16 15:10:01 +020058 */
Arnaldo Carvalho de Melo69aad6f2011-01-03 16:39:04 -020059struct perf_evsel {
60 struct list_head node;
61 struct perf_event_attr attr;
62 char *filter;
63 struct xyarray *fd;
Arnaldo Carvalho de Meloa91e5432011-03-10 11:15:54 -030064 struct xyarray *sample_id;
65 u64 *id;
Arnaldo Carvalho de Meloc52b12e2011-01-03 17:45:52 -020066 struct perf_counts *counts;
Stephane Eranianc7a79c42013-01-29 12:47:43 +010067 struct perf_counts *prev_raw_counts;
Arnaldo Carvalho de Melo69aad6f2011-01-03 16:39:04 -020068 int idx;
Robert Richterf4d83432012-08-16 21:10:17 +020069 u32 ids;
Stephane Eranianf0c55bc2011-02-16 15:10:01 +020070 char *name;
Stephane Eranian410136f2013-11-12 17:58:49 +010071 double scale;
72 const char *unit;
Arnaldo Carvalho de Melofcf65bf2012-08-07 09:58:03 -030073 struct event_format *tp_format;
Arnaldo Carvalho de Meloa91e5432011-03-10 11:15:54 -030074 union {
75 void *priv;
76 off_t id_offset;
Adrian Hunter0db15b12014-10-23 13:45:13 +030077 u64 db_id;
Arnaldo Carvalho de Meloa91e5432011-03-10 11:15:54 -030078 };
Stephane Eranian023695d2011-02-14 11:20:01 +020079 struct cgroup_sel *cgrp;
Arnaldo Carvalho de Melo744a9712013-11-06 10:17:38 -030080 void *handler;
Yan, Zheng7ae92e72012-09-10 15:53:50 +080081 struct cpu_map *cpus;
Arnaldo Carvalho de Melobde09462012-08-01 18:53:11 -030082 unsigned int sample_size;
Adrian Hunter75562572013-08-27 11:23:09 +030083 int id_pos;
84 int is_pos;
David Ahern2cee77c2011-05-30 08:55:59 -060085 bool supported;
Arnaldo Carvalho de Melo0807d2d2012-09-26 12:48:18 -030086 bool needs_swap;
Adrian Hunter6ff1ce72014-07-14 13:02:56 +030087 bool no_aux_samples;
Adrian Hunter2afd2bc2014-07-14 13:02:57 +030088 bool immediate;
Adrian Hunterbf8e8f42014-07-31 09:00:51 +030089 bool system_wide;
Adrian Hunter60b08962014-07-31 09:00:52 +030090 bool tracking;
Jiri Olsaf5b11352012-08-08 12:21:54 +020091 /* parse modifier helper */
92 int exclude_GH;
Namhyung Kim97f63e42013-01-22 18:09:29 +090093 int nr_members;
Jiri Olsa3c176312012-10-10 17:39:03 +020094 int sample_read;
Jiri Olsa6a4bb042012-08-08 12:22:36 +020095 struct perf_evsel *leader;
96 char *group_name;
Arnaldo Carvalho de Melo69aad6f2011-01-03 16:39:04 -020097};
98
Borislav Petkov88080ce2014-04-14 17:38:39 +020099union u64_swap {
100 u64 val64;
101 u32 val32[2];
102};
103
Arnaldo Carvalho de Melo86bd5e82011-01-03 23:09:46 -0200104struct cpu_map;
Arnaldo Carvalho de Melo80b22102014-10-13 10:29:50 -0300105struct target;
Arnaldo Carvalho de Melo86bd5e82011-01-03 23:09:46 -0200106struct thread_map;
Arnaldo Carvalho de Melo70082dd2011-01-12 17:03:24 -0200107struct perf_evlist;
Arnaldo Carvalho de Melob4006792013-12-19 14:43:45 -0300108struct record_opts;
Arnaldo Carvalho de Melo86bd5e82011-01-03 23:09:46 -0200109
Arnaldo Carvalho de Meloce8ccff2014-10-09 15:29:51 -0300110int perf_evsel__object_config(size_t object_size,
111 int (*init)(struct perf_evsel *evsel),
112 void (*fini)(struct perf_evsel *evsel));
113
Arnaldo Carvalho de Meloef503832013-11-07 16:41:19 -0300114struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx);
115
116static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr)
117{
118 return perf_evsel__new_idx(attr, 0);
119}
120
121struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx);
122
123static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name)
124{
125 return perf_evsel__newtp_idx(sys, name, 0);
126}
Arnaldo Carvalho de Melo201b7332012-09-26 20:24:19 -0300127
128struct event_format *event_format__new(const char *sys, const char *name);
129
Arnaldo Carvalho de Meloef1d1af2011-01-18 21:41:45 -0200130void perf_evsel__init(struct perf_evsel *evsel,
131 struct perf_event_attr *attr, int idx);
132void perf_evsel__exit(struct perf_evsel *evsel);
Arnaldo Carvalho de Melo69aad6f2011-01-03 16:39:04 -0200133void perf_evsel__delete(struct perf_evsel *evsel);
134
Arnaldo Carvalho de Melo0f82ebc2011-11-08 14:41:57 -0200135void perf_evsel__config(struct perf_evsel *evsel,
Arnaldo Carvalho de Melob4006792013-12-19 14:43:45 -0300136 struct record_opts *opts);
Arnaldo Carvalho de Melo0f82ebc2011-11-08 14:41:57 -0200137
Adrian Hunter75562572013-08-27 11:23:09 +0300138int __perf_evsel__sample_size(u64 sample_type);
139void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
140
Arnaldo Carvalho de Melo0b668bc2012-06-11 14:08:07 -0300141bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
142
143#define PERF_EVSEL__MAX_ALIASES 8
144
145extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
146 [PERF_EVSEL__MAX_ALIASES];
147extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
148 [PERF_EVSEL__MAX_ALIASES];
Arnaldo Carvalho de Melo8ad70132012-09-06 13:11:18 -0300149extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
150 [PERF_EVSEL__MAX_ALIASES];
151extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
152extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
Arnaldo Carvalho de Melo0b668bc2012-06-11 14:08:07 -0300153int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
154 char *bf, size_t size);
Arnaldo Carvalho de Melo7289f832012-06-12 12:34:58 -0300155const char *perf_evsel__name(struct perf_evsel *evsel);
Stephane Eranian410136f2013-11-12 17:58:49 +0100156
Namhyung Kim717e2632013-01-22 18:09:44 +0900157const char *perf_evsel__group_name(struct perf_evsel *evsel);
158int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
Arnaldo Carvalho de Meloc4104312012-05-25 16:38:11 -0300159
Arnaldo Carvalho de Melo70db7532011-01-12 22:39:13 -0200160int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
Arnaldo Carvalho de Meloc52b12e2011-01-03 17:45:52 -0200161int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
Frederik Deweerdta7e191c2013-03-01 13:02:27 -0500162void perf_evsel__reset_counts(struct perf_evsel *evsel, int ncpus);
Namhyung Kim43f8e762013-01-25 10:44:44 +0900163void perf_evsel__free_counts(struct perf_evsel *evsel);
Arnaldo Carvalho de Meloc52b12e2011-01-03 17:45:52 -0200164void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
Arnaldo Carvalho de Melo69aad6f2011-01-03 16:39:04 -0200165
Arnaldo Carvalho de Melo7be5ebe2012-12-10 14:53:43 -0300166void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
167 enum perf_event_sample_format bit);
168void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
169 enum perf_event_sample_format bit);
170
171#define perf_evsel__set_sample_bit(evsel, bit) \
172 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
173
174#define perf_evsel__reset_sample_bit(evsel, bit) \
175 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
176
Adrian Hunter75562572013-08-27 11:23:09 +0300177void perf_evsel__set_sample_id(struct perf_evsel *evsel,
178 bool use_sample_identifier);
Arnaldo Carvalho de Melo7a5a5ca2012-12-10 15:21:30 -0300179
Arnaldo Carvalho de Melo745cefc2012-09-26 15:07:39 -0300180int perf_evsel__set_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
181 const char *filter);
Andi Kleene2407be2013-08-02 17:41:10 -0700182int perf_evsel__enable(struct perf_evsel *evsel, int ncpus, int nthreads);
Arnaldo Carvalho de Melo745cefc2012-09-26 15:07:39 -0300183
Arnaldo Carvalho de Melof08199d2011-01-11 23:42:19 -0200184int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
Jiri Olsa6a4bb042012-08-08 12:22:36 +0200185 struct cpu_map *cpus);
Arnaldo Carvalho de Melof08199d2011-01-11 23:42:19 -0200186int perf_evsel__open_per_thread(struct perf_evsel *evsel,
Jiri Olsa6a4bb042012-08-08 12:22:36 +0200187 struct thread_map *threads);
Arnaldo Carvalho de Melof08199d2011-01-11 23:42:19 -0200188int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
Jiri Olsa6a4bb042012-08-08 12:22:36 +0200189 struct thread_map *threads);
Arnaldo Carvalho de Melo727ab042011-10-25 10:42:19 -0200190void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
Arnaldo Carvalho de Melo48290602011-01-03 17:48:12 -0200191
Arnaldo Carvalho de Melo5555ded2012-09-11 19:24:23 -0300192struct perf_sample;
193
Arnaldo Carvalho de Melo5d2074e2012-09-26 20:22:00 -0300194void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
Arnaldo Carvalho de Melo5555ded2012-09-11 19:24:23 -0300195 const char *name);
196u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
197 const char *name);
198
Arnaldo Carvalho de Melo5d2074e2012-09-26 20:22:00 -0300199static inline char *perf_evsel__strval(struct perf_evsel *evsel,
200 struct perf_sample *sample,
201 const char *name)
202{
203 return perf_evsel__rawptr(evsel, sample, name);
204}
205
Arnaldo Carvalho de Meloefd2b922012-09-18 11:21:50 -0300206struct format_field;
207
208struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
209
Arnaldo Carvalho de Melodaec78a2011-01-03 16:49:44 -0200210#define perf_evsel__match(evsel, t, c) \
211 (evsel->attr.type == PERF_TYPE_##t && \
212 evsel->attr.config == PERF_COUNT_##c)
213
Jiri Olsa863e4512012-09-06 17:46:55 +0200214static inline bool perf_evsel__match2(struct perf_evsel *e1,
215 struct perf_evsel *e2)
216{
217 return (e1->attr.type == e2->attr.type) &&
218 (e1->attr.config == e2->attr.config);
219}
220
Andi Kleen4cabc3d2013-08-21 16:47:26 -0700221#define perf_evsel__cmp(a, b) \
222 ((a) && \
223 (b) && \
224 (a)->attr.type == (b)->attr.type && \
225 (a)->attr.config == (b)->attr.config)
226
Arnaldo Carvalho de Meloc52b12e2011-01-03 17:45:52 -0200227int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
228 int cpu, int thread, bool scale);
229
230/**
231 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
232 *
233 * @evsel - event selector to read value
234 * @cpu - CPU of interest
235 * @thread - thread of interest
236 */
237static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
238 int cpu, int thread)
239{
240 return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
241}
242
243/**
244 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
245 *
246 * @evsel - event selector to read value
247 * @cpu - CPU of interest
248 * @thread - thread of interest
249 */
250static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
251 int cpu, int thread)
252{
253 return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
254}
255
256int __perf_evsel__read(struct perf_evsel *evsel, int ncpus, int nthreads,
257 bool scale);
258
259/**
260 * perf_evsel__read - Read the aggregate results on all CPUs
261 *
262 * @evsel - event selector to read value
263 * @ncpus - Number of cpus affected, from zero
264 * @nthreads - Number of threads affected, from zero
265 */
266static inline int perf_evsel__read(struct perf_evsel *evsel,
267 int ncpus, int nthreads)
268{
269 return __perf_evsel__read(evsel, ncpus, nthreads, false);
270}
271
272/**
273 * perf_evsel__read_scaled - Read the aggregate results on all CPUs, scaled
274 *
275 * @evsel - event selector to read value
276 * @ncpus - Number of cpus affected, from zero
277 * @nthreads - Number of threads affected, from zero
278 */
279static inline int perf_evsel__read_scaled(struct perf_evsel *evsel,
280 int ncpus, int nthreads)
281{
282 return __perf_evsel__read(evsel, ncpus, nthreads, true);
283}
284
Arnaldo Carvalho de Meloa3f698f2012-08-02 12:23:46 -0300285int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
Arnaldo Carvalho de Melo0807d2d2012-09-26 12:48:18 -0300286 struct perf_sample *sample);
Arnaldo Carvalho de Melo0c21f732012-08-14 16:42:15 -0300287
288static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
289{
290 return list_entry(evsel->node.next, struct perf_evsel, node);
291}
Arnaldo Carvalho de Melo07ac0022012-11-13 17:27:28 -0300292
Arnaldo Carvalho de Melod87fcb42013-11-13 15:56:40 -0300293static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel)
294{
295 return list_entry(evsel->node.prev, struct perf_evsel, node);
296}
297
Namhyung Kim759ff492013-03-05 14:53:26 +0900298/**
299 * perf_evsel__is_group_leader - Return whether given evsel is a leader event
300 *
301 * @evsel - evsel selector to be tested
302 *
303 * Return %true if @evsel is a group leader or a stand-alone event
304 */
Namhyung Kim823254e2012-11-29 15:38:30 +0900305static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
Arnaldo Carvalho de Melo07ac0022012-11-13 17:27:28 -0300306{
Namhyung Kim823254e2012-11-29 15:38:30 +0900307 return evsel->leader == evsel;
Arnaldo Carvalho de Melo07ac0022012-11-13 17:27:28 -0300308}
Arnaldo Carvalho de Melo0698aed2012-12-10 18:17:08 -0300309
Namhyung Kim759ff492013-03-05 14:53:26 +0900310/**
311 * perf_evsel__is_group_event - Return whether given evsel is a group event
312 *
313 * @evsel - evsel selector to be tested
314 *
315 * Return %true iff event group view is enabled and @evsel is a actual group
316 * leader which has other members in the group
317 */
318static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
319{
320 if (!symbol_conf.event_group)
321 return false;
322
323 return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
324}
325
Jiri Olsa6bedfab2014-03-02 16:56:40 +0100326/**
327 * perf_evsel__is_function_event - Return whether given evsel is a function
328 * trace event
329 *
330 * @evsel - evsel selector to be tested
331 *
332 * Return %true if event is function trace event
333 */
334static inline bool perf_evsel__is_function_event(struct perf_evsel *evsel)
335{
336#define FUNCTION_EVENT "ftrace:function"
337
338 return evsel->name &&
339 !strncmp(FUNCTION_EVENT, evsel->name, sizeof(FUNCTION_EVENT));
340
341#undef FUNCTION_EVENT
342}
343
Arnaldo Carvalho de Melo0698aed2012-12-10 18:17:08 -0300344struct perf_attr_details {
345 bool freq;
346 bool verbose;
Arnaldo Carvalho de Meloe35ef3552013-02-06 17:20:02 -0300347 bool event_group;
Arnaldo Carvalho de Melo0698aed2012-12-10 18:17:08 -0300348};
349
350int perf_evsel__fprintf(struct perf_evsel *evsel,
351 struct perf_attr_details *details, FILE *fp);
Arnaldo Carvalho de Meloc0a54342012-12-13 14:16:30 -0300352
353bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
354 char *msg, size_t msgsize);
Arnaldo Carvalho de Melo602ad872013-11-12 16:46:16 -0300355int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target,
Arnaldo Carvalho de Melo56e52e82012-12-13 15:10:58 -0300356 int err, char *msg, size_t size);
Namhyung Kim97f63e42013-01-22 18:09:29 +0900357
358static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
359{
360 return evsel->idx - evsel->leader->idx;
361}
Namhyung Kim717e2632013-01-22 18:09:44 +0900362
363#define for_each_group_member(_evsel, _leader) \
364for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); \
365 (_evsel) && (_evsel)->leader == (_leader); \
366 (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
367
Arnaldo Carvalho de Melo69aad6f2011-01-03 16:39:04 -0200368#endif /* __PERF_EVSEL_H */