perf tools: Add stat event read function
[linux-2.6-block.git] / tools / perf / util / event.h
CommitLineData
cdd6c482
IM
1#ifndef __PERF_RECORD_H
2#define __PERF_RECORD_H
8b40f521 3
4a58e611 4#include <limits.h>
482ad897 5#include <stdio.h>
4a58e611 6
1fe2c106 7#include "../perf.h"
4a58e611 8#include "map.h"
4383db88 9#include "build-id.h"
0c4e774f 10#include "perf_regs.h"
1fe2c106 11
1fe2c106
FW
12struct mmap_event {
13 struct perf_event_header header;
14 u32 pid, tid;
15 u64 start;
16 u64 len;
17 u64 pgoff;
18 char filename[PATH_MAX];
19};
20
5c5e854b
SE
21struct mmap2_event {
22 struct perf_event_header header;
23 u32 pid, tid;
24 u64 start;
25 u64 len;
26 u64 pgoff;
27 u32 maj;
28 u32 min;
29 u64 ino;
30 u64 ino_generation;
7ef80703
DZ
31 u32 prot;
32 u32 flags;
5c5e854b
SE
33 char filename[PATH_MAX];
34};
35
1fe2c106
FW
36struct comm_event {
37 struct perf_event_header header;
38 u32 pid, tid;
39 char comm[16];
40};
41
42struct fork_event {
43 struct perf_event_header header;
44 u32 pid, ppid;
45 u32 tid, ptid;
393b2ad8 46 u64 time;
1fe2c106
FW
47};
48
49struct lost_event {
50 struct perf_event_header header;
51 u64 id;
52 u64 lost;
53};
54
c4937a91
KL
55struct lost_samples_event {
56 struct perf_event_header header;
57 u64 lost;
58};
59
18408ddc
PZ
60/*
61 * PERF_FORMAT_ENABLED | PERF_FORMAT_RUNNING | PERF_FORMAT_ID
62 */
1fe2c106
FW
63struct read_event {
64 struct perf_event_header header;
dc02bf71 65 u32 pid, tid;
1fe2c106
FW
66 u64 value;
67 u64 time_enabled;
68 u64 time_running;
69 u64 id;
70};
71
dd96c46b
JO
72struct throttle_event {
73 struct perf_event_header header;
74 u64 time;
75 u64 id;
76 u64 stream_id;
77};
a2854124
FW
78
79#define PERF_SAMPLE_MASK \
80 (PERF_SAMPLE_IP | PERF_SAMPLE_TID | \
81 PERF_SAMPLE_TIME | PERF_SAMPLE_ADDR | \
82 PERF_SAMPLE_ID | PERF_SAMPLE_STREAM_ID | \
75562573
AH
83 PERF_SAMPLE_CPU | PERF_SAMPLE_PERIOD | \
84 PERF_SAMPLE_IDENTIFIER)
a2854124 85
a65cb4b9
JO
86/* perf sample has 16 bits size limit */
87#define PERF_SAMPLE_MAX_SIZE (1 << 16)
88
180f95e2 89struct sample_event {
fd39e055
AV
90 struct perf_event_header header;
91 u64 array[];
92};
93
0f6a3015 94struct regs_dump {
5b95a4a3 95 u64 abi;
352ea45a 96 u64 mask;
0f6a3015 97 u64 *regs;
0c4e774f
JO
98
99 /* Cached values/mask filled by first register access. */
100 u64 cache_regs[PERF_REGS_MAX];
101 u64 cache_mask;
0f6a3015
JO
102};
103
104struct stack_dump {
105 u16 offset;
106 u64 size;
107 char *data;
108};
109
9ede473c
JO
110struct sample_read_value {
111 u64 value;
112 u64 id;
113};
114
115struct sample_read {
116 u64 time_enabled;
117 u64 time_running;
118 union {
119 struct {
120 u64 nr;
121 struct sample_read_value *values;
122 } group;
123 struct sample_read_value one;
124 };
125};
126
0776eb59
JO
127struct ip_callchain {
128 u64 nr;
129 u64 ips[0];
130};
131
132struct branch_flags {
133 u64 mispred:1;
134 u64 predicted:1;
135 u64 in_tx:1;
136 u64 abort:1;
0e332f03
AK
137 u64 cycles:16;
138 u64 reserved:44;
0776eb59
JO
139};
140
141struct branch_entry {
142 u64 from;
143 u64 to;
144 struct branch_flags flags;
145};
146
147struct branch_stack {
148 u64 nr;
149 struct branch_entry entries[0];
150};
151
00447ccd
AH
152enum {
153 PERF_IP_FLAG_BRANCH = 1ULL << 0,
154 PERF_IP_FLAG_CALL = 1ULL << 1,
155 PERF_IP_FLAG_RETURN = 1ULL << 2,
156 PERF_IP_FLAG_CONDITIONAL = 1ULL << 3,
157 PERF_IP_FLAG_SYSCALLRET = 1ULL << 4,
158 PERF_IP_FLAG_ASYNC = 1ULL << 5,
159 PERF_IP_FLAG_INTERRUPT = 1ULL << 6,
160 PERF_IP_FLAG_TX_ABORT = 1ULL << 7,
161 PERF_IP_FLAG_TRACE_BEGIN = 1ULL << 8,
162 PERF_IP_FLAG_TRACE_END = 1ULL << 9,
163 PERF_IP_FLAG_IN_TX = 1ULL << 10,
164};
165
400ea6d3
AH
166#define PERF_IP_FLAG_CHARS "bcrosyiABEx"
167
00447ccd
AH
168#define PERF_BRANCH_MASK (\
169 PERF_IP_FLAG_BRANCH |\
170 PERF_IP_FLAG_CALL |\
171 PERF_IP_FLAG_RETURN |\
172 PERF_IP_FLAG_CONDITIONAL |\
173 PERF_IP_FLAG_SYSCALLRET |\
174 PERF_IP_FLAG_ASYNC |\
175 PERF_IP_FLAG_INTERRUPT |\
176 PERF_IP_FLAG_TX_ABORT |\
177 PERF_IP_FLAG_TRACE_BEGIN |\
178 PERF_IP_FLAG_TRACE_END)
179
8d50e5b4 180struct perf_sample {
180f95e2
OH
181 u64 ip;
182 u32 pid, tid;
183 u64 time;
184 u64 addr;
185 u64 id;
186 u64 stream_id;
180f95e2 187 u64 period;
05484298 188 u64 weight;
475eeab9 189 u64 transaction;
eed05fe7 190 u32 cpu;
180f95e2 191 u32 raw_size;
98a3b32c 192 u64 data_src;
bf493902
AH
193 u32 flags;
194 u16 insn_len;
180f95e2 195 void *raw_data;
eed05fe7 196 struct ip_callchain *callchain;
b5387528 197 struct branch_stack *branch_stack;
0f6a3015 198 struct regs_dump user_regs;
6a21c0b5 199 struct regs_dump intr_regs;
0f6a3015 200 struct stack_dump user_stack;
9ede473c 201 struct sample_read read;
180f95e2
OH
202};
203
98a3b32c
SE
204#define PERF_MEM_DATA_SRC_NONE \
205 (PERF_MEM_S(OP, NA) |\
206 PERF_MEM_S(LVL, NA) |\
207 PERF_MEM_S(SNOOP, NA) |\
208 PERF_MEM_S(LOCK, NA) |\
209 PERF_MEM_S(TLB, NA))
210
8d06367f
ACM
211struct build_id_event {
212 struct perf_event_header header;
a1645ce1 213 pid_t pid;
9ac3e487 214 u8 build_id[PERF_ALIGN(BUILD_ID_SIZE, sizeof(u64))];
8d06367f
ACM
215 char filename[];
216};
fd39e055 217
98402807 218enum perf_user_event_type { /* above any possible kernel type */
9aefcab0 219 PERF_RECORD_USER_TYPE_START = 64,
2c46dbb5 220 PERF_RECORD_HEADER_ATTR = 64,
6065210d 221 PERF_RECORD_HEADER_EVENT_TYPE = 65, /* depreceated */
9215545e 222 PERF_RECORD_HEADER_TRACING_DATA = 66,
c7929e47 223 PERF_RECORD_HEADER_BUILD_ID = 67,
98402807 224 PERF_RECORD_FINISHED_ROUND = 68,
3c659eed 225 PERF_RECORD_ID_INDEX = 69,
a16ac023
AH
226 PERF_RECORD_AUXTRACE_INFO = 70,
227 PERF_RECORD_AUXTRACE = 71,
e9bf54d2 228 PERF_RECORD_AUXTRACE_ERROR = 72,
5f3339d2 229 PERF_RECORD_THREAD_MAP = 73,
6640b6c2 230 PERF_RECORD_CPU_MAP = 74,
374fb9e3 231 PERF_RECORD_STAT_CONFIG = 75,
d80518c9 232 PERF_RECORD_STAT = 76,
2c46dbb5
TZ
233 PERF_RECORD_HEADER_MAX
234};
235
85ed4729
AH
236enum auxtrace_error_type {
237 PERF_AUXTRACE_ERROR_ITRACE = 1,
238 PERF_AUXTRACE_ERROR_MAX
239};
240
4318bcb7
ACM
241/*
242 * The kernel collects the number of events it couldn't send in a stretch and
243 * when possible sends this number in a PERF_RECORD_LOST event. The number of
244 * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
245 * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
246 * the sum of all struct lost_event.lost fields reported.
247 *
c4937a91
KL
248 * The kernel discards mixed up samples and sends the number in a
249 * PERF_RECORD_LOST_SAMPLES event. The number of lost-samples events is stored
250 * in .nr_events[PERF_RECORD_LOST_SAMPLES] while total_lost_samples tells
251 * exactly how many samples the kernel in fact dropped, i.e. it is the sum of
252 * all struct lost_samples_event.lost fields reported.
253 *
4318bcb7
ACM
254 * The total_period is needed because by default auto-freq is used, so
255 * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
256 * the total number of low level events, it is necessary to to sum all struct
257 * sample_event.period and stash the result in total_period.
258 */
259struct events_stats {
260 u64 total_period;
261 u64 total_non_filtered_period;
262 u64 total_lost;
c4937a91 263 u64 total_lost_samples;
a38f48e3 264 u64 total_aux_lost;
4318bcb7
ACM
265 u64 total_invalid_chains;
266 u32 nr_events[PERF_RECORD_HEADER_MAX];
267 u32 nr_non_filtered_samples;
268 u32 nr_lost_warned;
269 u32 nr_unknown_events;
270 u32 nr_invalid_chains;
271 u32 nr_unknown_id;
272 u32 nr_unprocessable_samples;
85ed4729 273 u32 nr_auxtrace_errors[PERF_AUXTRACE_ERROR_MAX];
930e6fcd 274 u32 nr_proc_map_timeout;
4318bcb7
ACM
275};
276
6640b6c2
JO
277enum {
278 PERF_CPU_MAP__CPUS = 0,
279 PERF_CPU_MAP__MASK = 1,
280};
281
282struct cpu_map_entries {
283 u16 nr;
284 u16 cpu[];
285};
286
287struct cpu_map_mask {
288 u16 nr;
289 u16 long_size;
290 unsigned long mask[];
291};
292
293struct cpu_map_data {
294 u16 type;
295 char data[];
296};
297
298struct cpu_map_event {
299 struct perf_event_header header;
300 struct cpu_map_data data;
301};
302
2c46dbb5
TZ
303struct attr_event {
304 struct perf_event_header header;
305 struct perf_event_attr attr;
306 u64 id[];
8dc58101
TZ
307};
308
cd19a035
TZ
309#define MAX_EVENT_NAME 64
310
311struct perf_trace_event_type {
312 u64 event_id;
313 char name[MAX_EVENT_NAME];
314};
315
316struct event_type_event {
317 struct perf_event_header header;
318 struct perf_trace_event_type event_type;
319};
320
9215545e
TZ
321struct tracing_data_event {
322 struct perf_event_header header;
323 u32 size;
324};
325
3c659eed
AH
326struct id_index_entry {
327 u64 id;
328 u64 idx;
329 u64 cpu;
330 u64 tid;
331};
332
333struct id_index_event {
334 struct perf_event_header header;
335 u64 nr;
336 struct id_index_entry entries[0];
337};
338
a16ac023
AH
339struct auxtrace_info_event {
340 struct perf_event_header header;
341 u32 type;
342 u32 reserved__; /* For alignment */
343 u64 priv[];
344};
345
346struct auxtrace_event {
347 struct perf_event_header header;
348 u64 size;
349 u64 offset;
350 u64 reference;
351 u32 idx;
352 u32 tid;
353 u32 cpu;
354 u32 reserved__; /* For alignment */
355};
356
e9bf54d2
AH
357#define MAX_AUXTRACE_ERROR_MSG 64
358
359struct auxtrace_error_event {
360 struct perf_event_header header;
361 u32 type;
362 u32 code;
363 u32 cpu;
364 u32 pid;
365 u32 tid;
366 u32 reserved__; /* For alignment */
367 u64 ip;
368 char msg[MAX_AUXTRACE_ERROR_MSG];
369};
370
4a96f7a0
AH
371struct aux_event {
372 struct perf_event_header header;
373 u64 aux_offset;
374 u64 aux_size;
375 u64 flags;
376};
377
0ad21f68
AH
378struct itrace_start_event {
379 struct perf_event_header header;
380 u32 pid, tid;
381};
382
0286039f
AH
383struct context_switch_event {
384 struct perf_event_header header;
385 u32 next_prev_pid;
386 u32 next_prev_tid;
387};
388
5f3339d2
JO
389struct thread_map_event_entry {
390 u64 pid;
391 char comm[16];
392};
393
394struct thread_map_event {
395 struct perf_event_header header;
396 u64 nr;
397 struct thread_map_event_entry entries[];
398};
399
374fb9e3
JO
400enum {
401 PERF_STAT_CONFIG_TERM__AGGR_MODE = 0,
402 PERF_STAT_CONFIG_TERM__INTERVAL = 1,
403 PERF_STAT_CONFIG_TERM__SCALE = 2,
404 PERF_STAT_CONFIG_TERM__MAX = 3,
405};
406
407struct stat_config_event_entry {
408 u64 tag;
409 u64 val;
410};
411
412struct stat_config_event {
413 struct perf_event_header header;
414 u64 nr;
415 struct stat_config_event_entry data[];
416};
417
d80518c9
JO
418struct stat_event {
419 struct perf_event_header header;
420
421 u64 id;
422 u32 cpu;
423 u32 thread;
424
425 union {
426 struct {
427 u64 val;
428 u64 ena;
429 u64 run;
430 };
431 u64 values[3];
432 };
433};
434
8115d60c 435union perf_event {
1fe2c106 436 struct perf_event_header header;
1fe2c106 437 struct mmap_event mmap;
5c5e854b 438 struct mmap2_event mmap2;
1fe2c106
FW
439 struct comm_event comm;
440 struct fork_event fork;
441 struct lost_event lost;
c4937a91 442 struct lost_samples_event lost_samples;
1fe2c106 443 struct read_event read;
dd96c46b 444 struct throttle_event throttle;
fd39e055 445 struct sample_event sample;
2c46dbb5 446 struct attr_event attr;
cd19a035 447 struct event_type_event event_type;
9215545e 448 struct tracing_data_event tracing_data;
c7929e47 449 struct build_id_event build_id;
3c659eed 450 struct id_index_event id_index;
a16ac023
AH
451 struct auxtrace_info_event auxtrace_info;
452 struct auxtrace_event auxtrace;
e9bf54d2 453 struct auxtrace_error_event auxtrace_error;
4a96f7a0 454 struct aux_event aux;
0ad21f68 455 struct itrace_start_event itrace_start;
0286039f 456 struct context_switch_event context_switch;
5f3339d2 457 struct thread_map_event thread_map;
6640b6c2 458 struct cpu_map_event cpu_map;
374fb9e3 459 struct stat_config_event stat_config;
d80518c9 460 struct stat_event stat;
8115d60c 461};
66e274f3 462
8115d60c 463void perf_event__print_totals(void);
62daacb5 464
45694aa7 465struct perf_tool;
401b8e13 466struct thread_map;
6c872901 467struct cpu_map;
67424342 468struct perf_stat_config;
5796f8f0 469struct perf_counts_values;
4aa65636 470
45694aa7 471typedef int (*perf_event__handler_t)(struct perf_tool *tool,
d20deb64 472 union perf_event *event,
8115d60c 473 struct perf_sample *sample,
743eb868 474 struct machine *machine);
cf553114 475
45694aa7 476int perf_event__synthesize_thread_map(struct perf_tool *tool,
d20deb64 477 struct thread_map *threads,
7c940c18 478 perf_event__handler_t process,
9d9cad76
KL
479 struct machine *machine, bool mmap_data,
480 unsigned int proc_map_timeout);
99471c96
JO
481int perf_event__synthesize_thread_map2(struct perf_tool *tool,
482 struct thread_map *threads,
483 perf_event__handler_t process,
484 struct machine *machine);
6c872901
JO
485int perf_event__synthesize_cpu_map(struct perf_tool *tool,
486 struct cpu_map *cpus,
487 perf_event__handler_t process,
488 struct machine *machine);
45694aa7 489int perf_event__synthesize_threads(struct perf_tool *tool,
d20deb64 490 perf_event__handler_t process,
9d9cad76
KL
491 struct machine *machine, bool mmap_data,
492 unsigned int proc_map_timeout);
45694aa7 493int perf_event__synthesize_kernel_mmap(struct perf_tool *tool,
d20deb64 494 perf_event__handler_t process,
0ae617be 495 struct machine *machine);
67424342
JO
496int perf_event__synthesize_stat_config(struct perf_tool *tool,
497 struct perf_stat_config *config,
498 perf_event__handler_t process,
499 struct machine *machine);
8e381596
JO
500void perf_event__read_stat_config(struct perf_stat_config *config,
501 struct stat_config_event *event);
5796f8f0
JO
502int perf_event__synthesize_stat(struct perf_tool *tool,
503 u32 cpu, u32 thread, u64 id,
504 struct perf_counts_values *count,
505 perf_event__handler_t process,
506 struct machine *machine);
45694aa7 507int perf_event__synthesize_modules(struct perf_tool *tool,
d20deb64 508 perf_event__handler_t process,
8115d60c
ACM
509 struct machine *machine);
510
45694aa7 511int perf_event__process_comm(struct perf_tool *tool,
d20deb64
ACM
512 union perf_event *event,
513 struct perf_sample *sample,
743eb868 514 struct machine *machine);
45694aa7 515int perf_event__process_lost(struct perf_tool *tool,
d20deb64
ACM
516 union perf_event *event,
517 struct perf_sample *sample,
743eb868 518 struct machine *machine);
c4937a91
KL
519int perf_event__process_lost_samples(struct perf_tool *tool,
520 union perf_event *event,
521 struct perf_sample *sample,
522 struct machine *machine);
4a96f7a0
AH
523int perf_event__process_aux(struct perf_tool *tool,
524 union perf_event *event,
525 struct perf_sample *sample,
526 struct machine *machine);
0ad21f68
AH
527int perf_event__process_itrace_start(struct perf_tool *tool,
528 union perf_event *event,
529 struct perf_sample *sample,
530 struct machine *machine);
0286039f
AH
531int perf_event__process_switch(struct perf_tool *tool,
532 union perf_event *event,
533 struct perf_sample *sample,
534 struct machine *machine);
45694aa7 535int perf_event__process_mmap(struct perf_tool *tool,
d20deb64
ACM
536 union perf_event *event,
537 struct perf_sample *sample,
743eb868 538 struct machine *machine);
5c5e854b
SE
539int perf_event__process_mmap2(struct perf_tool *tool,
540 union perf_event *event,
541 struct perf_sample *sample,
542 struct machine *machine);
f62d3f0f
ACM
543int perf_event__process_fork(struct perf_tool *tool,
544 union perf_event *event,
545 struct perf_sample *sample,
546 struct machine *machine);
547int perf_event__process_exit(struct perf_tool *tool,
d20deb64
ACM
548 union perf_event *event,
549 struct perf_sample *sample,
743eb868 550 struct machine *machine);
45694aa7 551int perf_event__process(struct perf_tool *tool,
d20deb64
ACM
552 union perf_event *event,
553 struct perf_sample *sample,
743eb868 554 struct machine *machine);
62daacb5 555
1ed091c4 556struct addr_location;
316c7136
ACM
557
558int perf_event__preprocess_sample(const union perf_event *event,
743eb868 559 struct machine *machine,
8115d60c 560 struct addr_location *al,
e44baa3e 561 struct perf_sample *sample);
1ed091c4 562
b91fc39f
ACM
563void addr_location__put(struct addr_location *al);
564
9b0d2d87
AH
565struct thread;
566
567bool is_bts_event(struct perf_event_attr *attr);
568bool sample_addr_correlates_sym(struct perf_event_attr *attr);
569void perf_event__preprocess_sample_addr(union perf_event *event,
570 struct perf_sample *sample,
9b0d2d87
AH
571 struct thread *thread,
572 struct addr_location *al);
573
8115d60c 574const char *perf_event__name(unsigned int id);
c8446b9b 575
b1cf6f65 576size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,
352ea45a 577 u64 read_format);
74eec26f 578int perf_event__synthesize_sample(union perf_event *event, u64 type,
352ea45a 579 u64 read_format,
74eec26f
AV
580 const struct perf_sample *sample,
581 bool swapped);
d0dd74e8 582
e803cf97
NK
583pid_t perf_event__synthesize_comm(struct perf_tool *tool,
584 union perf_event *event, pid_t pid,
585 perf_event__handler_t process,
586 struct machine *machine);
587
a18382b6
JO
588int perf_event__synthesize_mmap_events(struct perf_tool *tool,
589 union perf_event *event,
590 pid_t pid, pid_t tgid,
591 perf_event__handler_t process,
592 struct machine *machine,
9d9cad76
KL
593 bool mmap_data,
594 unsigned int proc_map_timeout);
a18382b6 595
482ad897
ACM
596size_t perf_event__fprintf_comm(union perf_event *event, FILE *fp);
597size_t perf_event__fprintf_mmap(union perf_event *event, FILE *fp);
5c5e854b 598size_t perf_event__fprintf_mmap2(union perf_event *event, FILE *fp);
482ad897 599size_t perf_event__fprintf_task(union perf_event *event, FILE *fp);
4a96f7a0 600size_t perf_event__fprintf_aux(union perf_event *event, FILE *fp);
0ad21f68 601size_t perf_event__fprintf_itrace_start(union perf_event *event, FILE *fp);
0286039f 602size_t perf_event__fprintf_switch(union perf_event *event, FILE *fp);
ec7fa596 603size_t perf_event__fprintf_thread_map(union perf_event *event, FILE *fp);
eb12a1af 604size_t perf_event__fprintf_cpu_map(union perf_event *event, FILE *fp);
482ad897
ACM
605size_t perf_event__fprintf(union perf_event *event, FILE *fp);
606
29b596b5
AH
607u64 kallsyms__get_function_start(const char *kallsyms_filename,
608 const char *symbol_name);
609
6c872901
JO
610void *cpu_map_data__alloc(struct cpu_map *map, size_t *size, u16 *type, int *max);
611void cpu_map_data__synthesize(struct cpu_map_data *data, struct cpu_map *map,
612 u16 type, int max);
8b40f521 613#endif /* __PERF_RECORD_H */