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