perf tools: Allow handling a NULL cpu_map as meaning "all cpus"
[linux-2.6-block.git] / tools / perf / util / evsel.h
1 #ifndef __PERF_EVSEL_H
2 #define __PERF_EVSEL_H 1
3
4 #include <linux/list.h>
5 #include <stdbool.h>
6 #include "../../../include/linux/perf_event.h"
7 #include "types.h"
8 #include "xyarray.h"
9 #include "cgroup.h"
10 #include "hist.h"
11  
12 struct perf_counts_values {
13         union {
14                 struct {
15                         u64 val;
16                         u64 ena;
17                         u64 run;
18                 };
19                 u64 values[3];
20         };
21 };
22
23 struct perf_counts {
24         s8                        scaled;
25         struct perf_counts_values aggr;
26         struct perf_counts_values cpu[];
27 };
28
29 struct 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  */
35 struct perf_sample_id {
36         struct hlist_node       node;
37         u64                     id;
38         struct perf_evsel       *evsel;
39 };
40
41 /** struct perf_evsel - event selector
42  *
43  * @name - Can be set to retain the original event name passed by the user,
44  *         so that when showing results in tools such as 'perf stat', we
45  *         show the name used, not some alias.
46  */
47 struct perf_evsel {
48         struct list_head        node;
49         struct perf_event_attr  attr;
50         char                    *filter;
51         struct xyarray          *fd;
52         struct xyarray          *sample_id;
53         u64                     *id;
54         struct perf_counts      *counts;
55         int                     idx;
56         u32                     ids;
57         struct hists            hists;
58         char                    *name;
59         struct event_format     *tp_format;
60         union {
61                 void            *priv;
62                 off_t           id_offset;
63         };
64         struct cgroup_sel       *cgrp;
65         struct {
66                 void            *func;
67                 void            *data;
68         } handler;
69         struct cpu_map          *cpus;
70         unsigned int            sample_size;
71         bool                    supported;
72         /* parse modifier helper */
73         int                     exclude_GH;
74         struct perf_evsel       *leader;
75         char                    *group_name;
76 };
77
78 struct cpu_map;
79 struct thread_map;
80 struct perf_evlist;
81 struct perf_record_opts;
82
83 struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr, int idx);
84 struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name, int idx);
85 void perf_evsel__init(struct perf_evsel *evsel,
86                       struct perf_event_attr *attr, int idx);
87 void perf_evsel__exit(struct perf_evsel *evsel);
88 void perf_evsel__delete(struct perf_evsel *evsel);
89
90 void perf_evsel__config(struct perf_evsel *evsel,
91                         struct perf_record_opts *opts,
92                         struct perf_evsel *first);
93
94 bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
95
96 #define PERF_EVSEL__MAX_ALIASES 8
97
98 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
99                                        [PERF_EVSEL__MAX_ALIASES];
100 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
101                                           [PERF_EVSEL__MAX_ALIASES];
102 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
103                                               [PERF_EVSEL__MAX_ALIASES];
104 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
105 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
106 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
107                                             char *bf, size_t size);
108 const char *perf_evsel__name(struct perf_evsel *evsel);
109
110 int perf_evsel__alloc_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
111 int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
112 int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
113 void perf_evsel__free_fd(struct perf_evsel *evsel);
114 void perf_evsel__free_id(struct perf_evsel *evsel);
115 void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
116
117 int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
118                              struct cpu_map *cpus);
119 int perf_evsel__open_per_thread(struct perf_evsel *evsel,
120                                 struct thread_map *threads);
121 int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
122                      struct thread_map *threads);
123 void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
124
125 struct perf_sample;
126
127 char *perf_evsel__strval(struct perf_evsel *evsel, struct perf_sample *sample,
128                          const char *name);
129 u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
130                        const char *name);
131
132 struct format_field;
133
134 struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
135
136 #define perf_evsel__match(evsel, t, c)          \
137         (evsel->attr.type == PERF_TYPE_##t &&   \
138          evsel->attr.config == PERF_COUNT_##c)
139
140 static inline bool perf_evsel__match2(struct perf_evsel *e1,
141                                       struct perf_evsel *e2)
142 {
143         return (e1->attr.type == e2->attr.type) &&
144                (e1->attr.config == e2->attr.config);
145 }
146
147 int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
148                               int cpu, int thread, bool scale);
149
150 /**
151  * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
152  *
153  * @evsel - event selector to read value
154  * @cpu - CPU of interest
155  * @thread - thread of interest
156  */
157 static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
158                                           int cpu, int thread)
159 {
160         return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
161 }
162
163 /**
164  * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
165  *
166  * @evsel - event selector to read value
167  * @cpu - CPU of interest
168  * @thread - thread of interest
169  */
170 static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
171                                                  int cpu, int thread)
172 {
173         return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
174 }
175
176 int __perf_evsel__read(struct perf_evsel *evsel, int ncpus, int nthreads,
177                        bool scale);
178
179 /**
180  * perf_evsel__read - Read the aggregate results on all CPUs
181  *
182  * @evsel - event selector to read value
183  * @ncpus - Number of cpus affected, from zero
184  * @nthreads - Number of threads affected, from zero
185  */
186 static inline int perf_evsel__read(struct perf_evsel *evsel,
187                                     int ncpus, int nthreads)
188 {
189         return __perf_evsel__read(evsel, ncpus, nthreads, false);
190 }
191
192 /**
193  * perf_evsel__read_scaled - Read the aggregate results on all CPUs, scaled
194  *
195  * @evsel - event selector to read value
196  * @ncpus - Number of cpus affected, from zero
197  * @nthreads - Number of threads affected, from zero
198  */
199 static inline int perf_evsel__read_scaled(struct perf_evsel *evsel,
200                                           int ncpus, int nthreads)
201 {
202         return __perf_evsel__read(evsel, ncpus, nthreads, true);
203 }
204
205 void hists__init(struct hists *hists);
206
207 int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
208                              struct perf_sample *sample, bool swapped);
209
210 static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
211 {
212         return list_entry(evsel->node.next, struct perf_evsel, node);
213 }
214 #endif /* __PERF_EVSEL_H */