Merge tag 'locks-v3.16-2' of git://git.samba.org/jlayton/linux
[linux/fpc-iii.git] / tools / perf / util / evsel.h
bloba52e9a5bb2d0b56d0eeeb2401ff8a557fde629b4
1 #ifndef __PERF_EVSEL_H
2 #define __PERF_EVSEL_H 1
4 #include <linux/list.h>
5 #include <stdbool.h>
6 #include <stddef.h>
7 #include <linux/perf_event.h>
8 #include <linux/types.h>
9 #include "xyarray.h"
10 #include "cgroup.h"
11 #include "hist.h"
12 #include "symbol.h"
14 struct perf_counts_values {
15 union {
16 struct {
17 u64 val;
18 u64 ena;
19 u64 run;
21 u64 values[3];
25 struct perf_counts {
26 s8 scaled;
27 struct perf_counts_values aggr;
28 struct perf_counts_values cpu[];
31 struct perf_evsel;
34 * Per fd, to map back from PERF_SAMPLE_ID to evsel, only used when there are
35 * more than one entry in the evlist.
37 struct perf_sample_id {
38 struct hlist_node node;
39 u64 id;
40 struct perf_evsel *evsel;
42 /* Holds total ID period value for PERF_SAMPLE_READ processing. */
43 u64 period;
46 /** struct perf_evsel - event selector
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.
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
58 struct perf_evsel {
59 struct list_head node;
60 struct perf_event_attr attr;
61 char *filter;
62 struct xyarray *fd;
63 struct xyarray *sample_id;
64 u64 *id;
65 struct perf_counts *counts;
66 struct perf_counts *prev_raw_counts;
67 int idx;
68 u32 ids;
69 struct hists hists;
70 char *name;
71 double scale;
72 const char *unit;
73 struct event_format *tp_format;
74 union {
75 void *priv;
76 off_t id_offset;
78 struct cgroup_sel *cgrp;
79 void *handler;
80 struct cpu_map *cpus;
81 unsigned int sample_size;
82 int id_pos;
83 int is_pos;
84 bool supported;
85 bool needs_swap;
86 /* parse modifier helper */
87 int exclude_GH;
88 int nr_members;
89 int sample_read;
90 struct perf_evsel *leader;
91 char *group_name;
94 union u64_swap {
95 u64 val64;
96 u32 val32[2];
99 #define hists_to_evsel(h) container_of(h, struct perf_evsel, hists)
101 struct cpu_map;
102 struct thread_map;
103 struct perf_evlist;
104 struct record_opts;
106 struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx);
108 static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr)
110 return perf_evsel__new_idx(attr, 0);
113 struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx);
115 static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name)
117 return perf_evsel__newtp_idx(sys, name, 0);
120 struct event_format *event_format__new(const char *sys, const char *name);
122 void perf_evsel__init(struct perf_evsel *evsel,
123 struct perf_event_attr *attr, int idx);
124 void perf_evsel__exit(struct perf_evsel *evsel);
125 void perf_evsel__delete(struct perf_evsel *evsel);
127 void perf_evsel__config(struct perf_evsel *evsel,
128 struct record_opts *opts);
130 int __perf_evsel__sample_size(u64 sample_type);
131 void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
133 bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
135 #define PERF_EVSEL__MAX_ALIASES 8
137 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
138 [PERF_EVSEL__MAX_ALIASES];
139 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
140 [PERF_EVSEL__MAX_ALIASES];
141 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
142 [PERF_EVSEL__MAX_ALIASES];
143 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
144 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
145 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
146 char *bf, size_t size);
147 const char *perf_evsel__name(struct perf_evsel *evsel);
149 const char *perf_evsel__group_name(struct perf_evsel *evsel);
150 int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
152 int perf_evsel__alloc_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
153 int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
154 int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
155 void perf_evsel__reset_counts(struct perf_evsel *evsel, int ncpus);
156 void perf_evsel__free_fd(struct perf_evsel *evsel);
157 void perf_evsel__free_id(struct perf_evsel *evsel);
158 void perf_evsel__free_counts(struct perf_evsel *evsel);
159 void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
161 void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
162 enum perf_event_sample_format bit);
163 void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
164 enum perf_event_sample_format bit);
166 #define perf_evsel__set_sample_bit(evsel, bit) \
167 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
169 #define perf_evsel__reset_sample_bit(evsel, bit) \
170 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
172 void perf_evsel__set_sample_id(struct perf_evsel *evsel,
173 bool use_sample_identifier);
175 int perf_evsel__set_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
176 const char *filter);
177 int perf_evsel__enable(struct perf_evsel *evsel, int ncpus, int nthreads);
179 int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
180 struct cpu_map *cpus);
181 int perf_evsel__open_per_thread(struct perf_evsel *evsel,
182 struct thread_map *threads);
183 int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
184 struct thread_map *threads);
185 void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
187 struct perf_sample;
189 void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
190 const char *name);
191 u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
192 const char *name);
194 static inline char *perf_evsel__strval(struct perf_evsel *evsel,
195 struct perf_sample *sample,
196 const char *name)
198 return perf_evsel__rawptr(evsel, sample, name);
201 struct format_field;
203 struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
205 #define perf_evsel__match(evsel, t, c) \
206 (evsel->attr.type == PERF_TYPE_##t && \
207 evsel->attr.config == PERF_COUNT_##c)
209 static inline bool perf_evsel__match2(struct perf_evsel *e1,
210 struct perf_evsel *e2)
212 return (e1->attr.type == e2->attr.type) &&
213 (e1->attr.config == e2->attr.config);
216 #define perf_evsel__cmp(a, b) \
217 ((a) && \
218 (b) && \
219 (a)->attr.type == (b)->attr.type && \
220 (a)->attr.config == (b)->attr.config)
222 int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
223 int cpu, int thread, bool scale);
226 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
228 * @evsel - event selector to read value
229 * @cpu - CPU of interest
230 * @thread - thread of interest
232 static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
233 int cpu, int thread)
235 return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
239 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
241 * @evsel - event selector to read value
242 * @cpu - CPU of interest
243 * @thread - thread of interest
245 static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
246 int cpu, int thread)
248 return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
251 int __perf_evsel__read(struct perf_evsel *evsel, int ncpus, int nthreads,
252 bool scale);
255 * perf_evsel__read - Read the aggregate results on all CPUs
257 * @evsel - event selector to read value
258 * @ncpus - Number of cpus affected, from zero
259 * @nthreads - Number of threads affected, from zero
261 static inline int perf_evsel__read(struct perf_evsel *evsel,
262 int ncpus, int nthreads)
264 return __perf_evsel__read(evsel, ncpus, nthreads, false);
268 * perf_evsel__read_scaled - Read the aggregate results on all CPUs, scaled
270 * @evsel - event selector to read value
271 * @ncpus - Number of cpus affected, from zero
272 * @nthreads - Number of threads affected, from zero
274 static inline int perf_evsel__read_scaled(struct perf_evsel *evsel,
275 int ncpus, int nthreads)
277 return __perf_evsel__read(evsel, ncpus, nthreads, true);
280 void hists__init(struct hists *hists);
282 int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
283 struct perf_sample *sample);
285 static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
287 return list_entry(evsel->node.next, struct perf_evsel, node);
290 static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel)
292 return list_entry(evsel->node.prev, struct perf_evsel, node);
296 * perf_evsel__is_group_leader - Return whether given evsel is a leader event
298 * @evsel - evsel selector to be tested
300 * Return %true if @evsel is a group leader or a stand-alone event
302 static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
304 return evsel->leader == evsel;
308 * perf_evsel__is_group_event - Return whether given evsel is a group event
310 * @evsel - evsel selector to be tested
312 * Return %true iff event group view is enabled and @evsel is a actual group
313 * leader which has other members in the group
315 static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
317 if (!symbol_conf.event_group)
318 return false;
320 return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
324 * perf_evsel__is_function_event - Return whether given evsel is a function
325 * trace event
327 * @evsel - evsel selector to be tested
329 * Return %true if event is function trace event
331 static inline bool perf_evsel__is_function_event(struct perf_evsel *evsel)
333 #define FUNCTION_EVENT "ftrace:function"
335 return evsel->name &&
336 !strncmp(FUNCTION_EVENT, evsel->name, sizeof(FUNCTION_EVENT));
338 #undef FUNCTION_EVENT
341 struct perf_attr_details {
342 bool freq;
343 bool verbose;
344 bool event_group;
347 int perf_evsel__fprintf(struct perf_evsel *evsel,
348 struct perf_attr_details *details, FILE *fp);
350 bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
351 char *msg, size_t msgsize);
352 int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target,
353 int err, char *msg, size_t size);
355 static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
357 return evsel->idx - evsel->leader->idx;
360 #define for_each_group_member(_evsel, _leader) \
361 for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); \
362 (_evsel) && (_evsel)->leader == (_leader); \
363 (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
365 #endif /* __PERF_EVSEL_H */