perf tools: Add stat round user level event
[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,
2d8f0f18 233 PERF_RECORD_STAT_ROUND = 77,
2c46dbb5
TZ
234 PERF_RECORD_HEADER_MAX
235};
236
85ed4729
AH
237enum auxtrace_error_type {
238 PERF_AUXTRACE_ERROR_ITRACE = 1,
239 PERF_AUXTRACE_ERROR_MAX
240};
241
4318bcb7
ACM
242/*
243 * The kernel collects the number of events it couldn't send in a stretch and
244 * when possible sends this number in a PERF_RECORD_LOST event. The number of
245 * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
246 * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
247 * the sum of all struct lost_event.lost fields reported.
248 *
c4937a91
KL
249 * The kernel discards mixed up samples and sends the number in a
250 * PERF_RECORD_LOST_SAMPLES event. The number of lost-samples events is stored
251 * in .nr_events[PERF_RECORD_LOST_SAMPLES] while total_lost_samples tells
252 * exactly how many samples the kernel in fact dropped, i.e. it is the sum of
253 * all struct lost_samples_event.lost fields reported.
254 *
4318bcb7
ACM
255 * The total_period is needed because by default auto-freq is used, so
256 * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
257 * the total number of low level events, it is necessary to to sum all struct
258 * sample_event.period and stash the result in total_period.
259 */
260struct events_stats {
261 u64 total_period;
262 u64 total_non_filtered_period;
263 u64 total_lost;
c4937a91 264 u64 total_lost_samples;
a38f48e3 265 u64 total_aux_lost;
4318bcb7
ACM
266 u64 total_invalid_chains;
267 u32 nr_events[PERF_RECORD_HEADER_MAX];
268 u32 nr_non_filtered_samples;
269 u32 nr_lost_warned;
270 u32 nr_unknown_events;
271 u32 nr_invalid_chains;
272 u32 nr_unknown_id;
273 u32 nr_unprocessable_samples;
85ed4729 274 u32 nr_auxtrace_errors[PERF_AUXTRACE_ERROR_MAX];
930e6fcd 275 u32 nr_proc_map_timeout;
4318bcb7
ACM
276};
277
6640b6c2
JO
278enum {
279 PERF_CPU_MAP__CPUS = 0,
280 PERF_CPU_MAP__MASK = 1,
281};
282
283struct cpu_map_entries {
284 u16 nr;
285 u16 cpu[];
286};
287
288struct cpu_map_mask {
289 u16 nr;
290 u16 long_size;
291 unsigned long mask[];
292};
293
294struct cpu_map_data {
295 u16 type;
296 char data[];
297};
298
299struct cpu_map_event {
300 struct perf_event_header header;
301 struct cpu_map_data data;
302};
303
2c46dbb5
TZ
304struct attr_event {
305 struct perf_event_header header;
306 struct perf_event_attr attr;
307 u64 id[];
8dc58101
TZ
308};
309
cd19a035
TZ
310#define MAX_EVENT_NAME 64
311
312struct perf_trace_event_type {
313 u64 event_id;
314 char name[MAX_EVENT_NAME];
315};
316
317struct event_type_event {
318 struct perf_event_header header;
319 struct perf_trace_event_type event_type;
320};
321
9215545e
TZ
322struct tracing_data_event {
323 struct perf_event_header header;
324 u32 size;
325};
326
3c659eed
AH
327struct id_index_entry {
328 u64 id;
329 u64 idx;
330 u64 cpu;
331 u64 tid;
332};
333
334struct id_index_event {
335 struct perf_event_header header;
336 u64 nr;
337 struct id_index_entry entries[0];
338};
339
a16ac023
AH
340struct auxtrace_info_event {
341 struct perf_event_header header;
342 u32 type;
343 u32 reserved__; /* For alignment */
344 u64 priv[];
345};
346
347struct auxtrace_event {
348 struct perf_event_header header;
349 u64 size;
350 u64 offset;
351 u64 reference;
352 u32 idx;
353 u32 tid;
354 u32 cpu;
355 u32 reserved__; /* For alignment */
356};
357
e9bf54d2
AH
358#define MAX_AUXTRACE_ERROR_MSG 64
359
360struct auxtrace_error_event {
361 struct perf_event_header header;
362 u32 type;
363 u32 code;
364 u32 cpu;
365 u32 pid;
366 u32 tid;
367 u32 reserved__; /* For alignment */
368 u64 ip;
369 char msg[MAX_AUXTRACE_ERROR_MSG];
370};
371
4a96f7a0
AH
372struct aux_event {
373 struct perf_event_header header;
374 u64 aux_offset;
375 u64 aux_size;
376 u64 flags;
377};
378
0ad21f68
AH
379struct itrace_start_event {
380 struct perf_event_header header;
381 u32 pid, tid;
382};
383
0286039f
AH
384struct context_switch_event {
385 struct perf_event_header header;
386 u32 next_prev_pid;
387 u32 next_prev_tid;
388};
389
5f3339d2
JO
390struct thread_map_event_entry {
391 u64 pid;
392 char comm[16];
393};
394
395struct thread_map_event {
396 struct perf_event_header header;
397 u64 nr;
398 struct thread_map_event_entry entries[];
399};
400
374fb9e3
JO
401enum {
402 PERF_STAT_CONFIG_TERM__AGGR_MODE = 0,
403 PERF_STAT_CONFIG_TERM__INTERVAL = 1,
404 PERF_STAT_CONFIG_TERM__SCALE = 2,
405 PERF_STAT_CONFIG_TERM__MAX = 3,
406};
407
408struct stat_config_event_entry {
409 u64 tag;
410 u64 val;
411};
412
413struct stat_config_event {
414 struct perf_event_header header;
415 u64 nr;
416 struct stat_config_event_entry data[];
417};
418
d80518c9
JO
419struct stat_event {
420 struct perf_event_header header;
421
422 u64 id;
423 u32 cpu;
424 u32 thread;
425
426 union {
427 struct {
428 u64 val;
429 u64 ena;
430 u64 run;
431 };
432 u64 values[3];
433 };
434};
435
2d8f0f18
JO
436enum {
437 PERF_STAT_ROUND_TYPE__INTERVAL = 0,
438 PERF_STAT_ROUND_TYPE__FINAL = 1,
439};
440
441struct stat_round_event {
442 struct perf_event_header header;
443 u64 type;
444 u64 time;
445};
446
8115d60c 447union perf_event {
1fe2c106 448 struct perf_event_header header;
1fe2c106 449 struct mmap_event mmap;
5c5e854b 450 struct mmap2_event mmap2;
1fe2c106
FW
451 struct comm_event comm;
452 struct fork_event fork;
453 struct lost_event lost;
c4937a91 454 struct lost_samples_event lost_samples;
1fe2c106 455 struct read_event read;
dd96c46b 456 struct throttle_event throttle;
fd39e055 457 struct sample_event sample;
2c46dbb5 458 struct attr_event attr;
cd19a035 459 struct event_type_event event_type;
9215545e 460 struct tracing_data_event tracing_data;
c7929e47 461 struct build_id_event build_id;
3c659eed 462 struct id_index_event id_index;
a16ac023
AH
463 struct auxtrace_info_event auxtrace_info;
464 struct auxtrace_event auxtrace;
e9bf54d2 465 struct auxtrace_error_event auxtrace_error;
4a96f7a0 466 struct aux_event aux;
0ad21f68 467 struct itrace_start_event itrace_start;
0286039f 468 struct context_switch_event context_switch;
5f3339d2 469 struct thread_map_event thread_map;
6640b6c2 470 struct cpu_map_event cpu_map;
374fb9e3 471 struct stat_config_event stat_config;
d80518c9 472 struct stat_event stat;
2d8f0f18 473 struct stat_round_event stat_round;
8115d60c 474};
66e274f3 475
8115d60c 476void perf_event__print_totals(void);
62daacb5 477
45694aa7 478struct perf_tool;
401b8e13 479struct thread_map;
6c872901 480struct cpu_map;
67424342 481struct perf_stat_config;
5796f8f0 482struct perf_counts_values;
4aa65636 483
45694aa7 484typedef int (*perf_event__handler_t)(struct perf_tool *tool,
d20deb64 485 union perf_event *event,
8115d60c 486 struct perf_sample *sample,
743eb868 487 struct machine *machine);
cf553114 488
45694aa7 489int perf_event__synthesize_thread_map(struct perf_tool *tool,
d20deb64 490 struct thread_map *threads,
7c940c18 491 perf_event__handler_t process,
9d9cad76
KL
492 struct machine *machine, bool mmap_data,
493 unsigned int proc_map_timeout);
99471c96
JO
494int perf_event__synthesize_thread_map2(struct perf_tool *tool,
495 struct thread_map *threads,
496 perf_event__handler_t process,
497 struct machine *machine);
6c872901
JO
498int perf_event__synthesize_cpu_map(struct perf_tool *tool,
499 struct cpu_map *cpus,
500 perf_event__handler_t process,
501 struct machine *machine);
45694aa7 502int perf_event__synthesize_threads(struct perf_tool *tool,
d20deb64 503 perf_event__handler_t process,
9d9cad76
KL
504 struct machine *machine, bool mmap_data,
505 unsigned int proc_map_timeout);
45694aa7 506int perf_event__synthesize_kernel_mmap(struct perf_tool *tool,
d20deb64 507 perf_event__handler_t process,
0ae617be 508 struct machine *machine);
67424342
JO
509int perf_event__synthesize_stat_config(struct perf_tool *tool,
510 struct perf_stat_config *config,
511 perf_event__handler_t process,
512 struct machine *machine);
8e381596
JO
513void perf_event__read_stat_config(struct perf_stat_config *config,
514 struct stat_config_event *event);
5796f8f0
JO
515int perf_event__synthesize_stat(struct perf_tool *tool,
516 u32 cpu, u32 thread, u64 id,
517 struct perf_counts_values *count,
518 perf_event__handler_t process,
519 struct machine *machine);
45694aa7 520int perf_event__synthesize_modules(struct perf_tool *tool,
d20deb64 521 perf_event__handler_t process,
8115d60c
ACM
522 struct machine *machine);
523
45694aa7 524int perf_event__process_comm(struct perf_tool *tool,
d20deb64
ACM
525 union perf_event *event,
526 struct perf_sample *sample,
743eb868 527 struct machine *machine);
45694aa7 528int perf_event__process_lost(struct perf_tool *tool,
d20deb64
ACM
529 union perf_event *event,
530 struct perf_sample *sample,
743eb868 531 struct machine *machine);
c4937a91
KL
532int perf_event__process_lost_samples(struct perf_tool *tool,
533 union perf_event *event,
534 struct perf_sample *sample,
535 struct machine *machine);
4a96f7a0
AH
536int perf_event__process_aux(struct perf_tool *tool,
537 union perf_event *event,
538 struct perf_sample *sample,
539 struct machine *machine);
0ad21f68
AH
540int perf_event__process_itrace_start(struct perf_tool *tool,
541 union perf_event *event,
542 struct perf_sample *sample,
543 struct machine *machine);
0286039f
AH
544int perf_event__process_switch(struct perf_tool *tool,
545 union perf_event *event,
546 struct perf_sample *sample,
547 struct machine *machine);
45694aa7 548int perf_event__process_mmap(struct perf_tool *tool,
d20deb64
ACM
549 union perf_event *event,
550 struct perf_sample *sample,
743eb868 551 struct machine *machine);
5c5e854b
SE
552int perf_event__process_mmap2(struct perf_tool *tool,
553 union perf_event *event,
554 struct perf_sample *sample,
555 struct machine *machine);
f62d3f0f
ACM
556int perf_event__process_fork(struct perf_tool *tool,
557 union perf_event *event,
558 struct perf_sample *sample,
559 struct machine *machine);
560int perf_event__process_exit(struct perf_tool *tool,
d20deb64
ACM
561 union perf_event *event,
562 struct perf_sample *sample,
743eb868 563 struct machine *machine);
45694aa7 564int perf_event__process(struct perf_tool *tool,
d20deb64
ACM
565 union perf_event *event,
566 struct perf_sample *sample,
743eb868 567 struct machine *machine);
62daacb5 568
1ed091c4 569struct addr_location;
316c7136
ACM
570
571int perf_event__preprocess_sample(const union perf_event *event,
743eb868 572 struct machine *machine,
8115d60c 573 struct addr_location *al,
e44baa3e 574 struct perf_sample *sample);
1ed091c4 575
b91fc39f
ACM
576void addr_location__put(struct addr_location *al);
577
9b0d2d87
AH
578struct thread;
579
580bool is_bts_event(struct perf_event_attr *attr);
581bool sample_addr_correlates_sym(struct perf_event_attr *attr);
582void perf_event__preprocess_sample_addr(union perf_event *event,
583 struct perf_sample *sample,
9b0d2d87
AH
584 struct thread *thread,
585 struct addr_location *al);
586
8115d60c 587const char *perf_event__name(unsigned int id);
c8446b9b 588
b1cf6f65 589size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,
352ea45a 590 u64 read_format);
74eec26f 591int perf_event__synthesize_sample(union perf_event *event, u64 type,
352ea45a 592 u64 read_format,
74eec26f
AV
593 const struct perf_sample *sample,
594 bool swapped);
d0dd74e8 595
e803cf97
NK
596pid_t perf_event__synthesize_comm(struct perf_tool *tool,
597 union perf_event *event, pid_t pid,
598 perf_event__handler_t process,
599 struct machine *machine);
600
a18382b6
JO
601int perf_event__synthesize_mmap_events(struct perf_tool *tool,
602 union perf_event *event,
603 pid_t pid, pid_t tgid,
604 perf_event__handler_t process,
605 struct machine *machine,
9d9cad76
KL
606 bool mmap_data,
607 unsigned int proc_map_timeout);
a18382b6 608
482ad897
ACM
609size_t perf_event__fprintf_comm(union perf_event *event, FILE *fp);
610size_t perf_event__fprintf_mmap(union perf_event *event, FILE *fp);
5c5e854b 611size_t perf_event__fprintf_mmap2(union perf_event *event, FILE *fp);
482ad897 612size_t perf_event__fprintf_task(union perf_event *event, FILE *fp);
4a96f7a0 613size_t perf_event__fprintf_aux(union perf_event *event, FILE *fp);
0ad21f68 614size_t perf_event__fprintf_itrace_start(union perf_event *event, FILE *fp);
0286039f 615size_t perf_event__fprintf_switch(union perf_event *event, FILE *fp);
ec7fa596 616size_t perf_event__fprintf_thread_map(union perf_event *event, FILE *fp);
eb12a1af 617size_t perf_event__fprintf_cpu_map(union perf_event *event, FILE *fp);
482ad897
ACM
618size_t perf_event__fprintf(union perf_event *event, FILE *fp);
619
29b596b5
AH
620u64 kallsyms__get_function_start(const char *kallsyms_filename,
621 const char *symbol_name);
622
6c872901
JO
623void *cpu_map_data__alloc(struct cpu_map *map, size_t *size, u16 *type, int *max);
624void cpu_map_data__synthesize(struct cpu_map_data *data, struct cpu_map *map,
625 u16 type, int max);
8b40f521 626#endif /* __PERF_RECORD_H */