perf probe: Add --quiet option to suppress output result message
[deliverable/linux.git] / tools / perf / util / evsel.h
CommitLineData
69aad6f1
ACM
1#ifndef __PERF_EVSEL_H
2#define __PERF_EVSEL_H 1
3
4#include <linux/list.h>
c52b12ed 5#include <stdbool.h>
07ac002f 6#include <stddef.h>
d2709c7c 7#include <linux/perf_event.h>
d944c4ee 8#include <linux/types.h>
69aad6f1 9#include "xyarray.h"
759ff497 10#include "symbol.h"
d944c4ee 11
c52b12ed
ACM
12struct 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};
69aad6f1 28
70db7533
ACM
29struct 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;
e4caec0d
JO
39
40 /* Holds total ID period value for PERF_SAMPLE_READ processing. */
41 u64 period;
70db7533
ACM
42};
43
f14d5707
ACM
44struct cgroup_sel;
45
f0c55bcf
SE
46/** 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.
75562573
AH
51 * @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
0db15b1e 57 * @priv: And what is in its containing unnamed union are tool specific
f0c55bcf 58 */
69aad6f1
ACM
59struct perf_evsel {
60 struct list_head node;
61 struct perf_event_attr attr;
62 char *filter;
63 struct xyarray *fd;
a91e5431
ACM
64 struct xyarray *sample_id;
65 u64 *id;
c52b12ed 66 struct perf_counts *counts;
c7a79c47 67 struct perf_counts *prev_raw_counts;
69aad6f1 68 int idx;
f4d83436 69 u32 ids;
f0c55bcf 70 char *name;
410136f5
SE
71 double scale;
72 const char *unit;
fcf65bf1 73 struct event_format *tp_format;
a91e5431
ACM
74 union {
75 void *priv;
76 off_t id_offset;
0db15b1e 77 u64 db_id;
a91e5431 78 };
023695d9 79 struct cgroup_sel *cgrp;
744a9719 80 void *handler;
7ae92e74 81 struct cpu_map *cpus;
bde09467 82 unsigned int sample_size;
75562573
AH
83 int id_pos;
84 int is_pos;
2cee77c4 85 bool supported;
0807d2d8 86 bool needs_swap;
6ff1ce76 87 bool no_aux_samples;
2afd2bcf 88 bool immediate;
bf8e8f4b 89 bool system_wide;
60b0896c 90 bool tracking;
f5b1135b
JO
91 /* parse modifier helper */
92 int exclude_GH;
97f63e4a 93 int nr_members;
3c176311 94 int sample_read;
6a4bb04c
JO
95 struct perf_evsel *leader;
96 char *group_name;
69aad6f1
ACM
97};
98
88080ce7
BP
99union u64_swap {
100 u64 val64;
101 u32 val32[2];
102};
103
86bd5e86 104struct cpu_map;
80b2210c 105struct target;
86bd5e86 106struct thread_map;
70082dd9 107struct perf_evlist;
b4006796 108struct record_opts;
86bd5e86 109
ce8ccff5
ACM
110int perf_evsel__object_config(size_t object_size,
111 int (*init)(struct perf_evsel *evsel),
112 void (*fini)(struct perf_evsel *evsel));
113
ef503831
ACM
114struct 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}
201b7334
ACM
127
128struct event_format *event_format__new(const char *sys, const char *name);
129
ef1d1af2
ACM
130void perf_evsel__init(struct perf_evsel *evsel,
131 struct perf_event_attr *attr, int idx);
132void perf_evsel__exit(struct perf_evsel *evsel);
69aad6f1
ACM
133void perf_evsel__delete(struct perf_evsel *evsel);
134
0f82ebc4 135void perf_evsel__config(struct perf_evsel *evsel,
b4006796 136 struct record_opts *opts);
0f82ebc4 137
75562573
AH
138int __perf_evsel__sample_size(u64 sample_type);
139void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
140
0b668bc9
ACM
141bool 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];
8ad7013b
ACM
149extern 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];
0b668bc9
ACM
153int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
154 char *bf, size_t size);
7289f83c 155const char *perf_evsel__name(struct perf_evsel *evsel);
410136f5 156
717e263f
NK
157const char *perf_evsel__group_name(struct perf_evsel *evsel);
158int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
c410431c 159
70db7533 160int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
c52b12ed 161int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
a7e191c3 162void perf_evsel__reset_counts(struct perf_evsel *evsel, int ncpus);
43f8e76e 163void perf_evsel__free_counts(struct perf_evsel *evsel);
c52b12ed 164void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
69aad6f1 165
7be5ebe8
ACM
166void __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
75562573
AH
177void perf_evsel__set_sample_id(struct perf_evsel *evsel,
178 bool use_sample_identifier);
7a5a5ca5 179
745cefc5
ACM
180int perf_evsel__set_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
181 const char *filter);
e2407bef 182int perf_evsel__enable(struct perf_evsel *evsel, int ncpus, int nthreads);
745cefc5 183
f08199d3 184int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
6a4bb04c 185 struct cpu_map *cpus);
f08199d3 186int perf_evsel__open_per_thread(struct perf_evsel *evsel,
6a4bb04c 187 struct thread_map *threads);
f08199d3 188int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
6a4bb04c 189 struct thread_map *threads);
727ab04e 190void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
48290609 191
5555ded4
ACM
192struct perf_sample;
193
5d2074ea 194void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
5555ded4
ACM
195 const char *name);
196u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
197 const char *name);
198
5d2074ea
ACM
199static 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
efd2b924
ACM
206struct format_field;
207
208struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
209
daec78a0
ACM
210#define perf_evsel__match(evsel, t, c) \
211 (evsel->attr.type == PERF_TYPE_##t && \
212 evsel->attr.config == PERF_COUNT_##c)
213
863e451f
JO
214static 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
4cabc3d1
AK
221#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
c52b12ed
ACM
227int __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
a3f698fe 285int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
0807d2d8 286 struct perf_sample *sample);
0c21f736
ACM
287
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}
07ac002f 292
d87fcb4a
ACM
293static 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
759ff497
NK
298/**
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 */
823254ed 305static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
07ac002f 306{
823254ed 307 return evsel->leader == evsel;
07ac002f 308}
0698aedd 309
759ff497
NK
310/**
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
6bedfab6
JO
326/**
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
0698aedd
ACM
344struct perf_attr_details {
345 bool freq;
346 bool verbose;
e35ef355 347 bool event_group;
0698aedd
ACM
348};
349
350int perf_evsel__fprintf(struct perf_evsel *evsel,
351 struct perf_attr_details *details, FILE *fp);
c0a54341
ACM
352
353bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
354 char *msg, size_t msgsize);
602ad878 355int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target,
56e52e85 356 int err, char *msg, size_t size);
97f63e4a
NK
357
358static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
359{
360 return evsel->idx - evsel->leader->idx;
361}
717e263f
NK
362
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
69aad6f1 368#endif /* __PERF_EVSEL_H */
This page took 0.149762 seconds and 5 git commands to generate.