perf tools: Add support for PERF_RECORD_AUX
[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
18408ddc
PZ
55/*
56 * PERF_FORMAT_ENABLED | PERF_FORMAT_RUNNING | PERF_FORMAT_ID
57 */
1fe2c106
FW
58struct read_event {
59 struct perf_event_header header;
dc02bf71 60 u32 pid, tid;
1fe2c106
FW
61 u64 value;
62 u64 time_enabled;
63 u64 time_running;
64 u64 id;
65};
66
dd96c46b
JO
67struct throttle_event {
68 struct perf_event_header header;
69 u64 time;
70 u64 id;
71 u64 stream_id;
72};
a2854124
FW
73
74#define PERF_SAMPLE_MASK \
75 (PERF_SAMPLE_IP | PERF_SAMPLE_TID | \
76 PERF_SAMPLE_TIME | PERF_SAMPLE_ADDR | \
77 PERF_SAMPLE_ID | PERF_SAMPLE_STREAM_ID | \
75562573
AH
78 PERF_SAMPLE_CPU | PERF_SAMPLE_PERIOD | \
79 PERF_SAMPLE_IDENTIFIER)
a2854124 80
a65cb4b9
JO
81/* perf sample has 16 bits size limit */
82#define PERF_SAMPLE_MAX_SIZE (1 << 16)
83
180f95e2 84struct sample_event {
fd39e055
AV
85 struct perf_event_header header;
86 u64 array[];
87};
88
0f6a3015 89struct regs_dump {
5b95a4a3 90 u64 abi;
352ea45a 91 u64 mask;
0f6a3015 92 u64 *regs;
0c4e774f
JO
93
94 /* Cached values/mask filled by first register access. */
95 u64 cache_regs[PERF_REGS_MAX];
96 u64 cache_mask;
0f6a3015
JO
97};
98
99struct stack_dump {
100 u16 offset;
101 u64 size;
102 char *data;
103};
104
9ede473c
JO
105struct sample_read_value {
106 u64 value;
107 u64 id;
108};
109
110struct sample_read {
111 u64 time_enabled;
112 u64 time_running;
113 union {
114 struct {
115 u64 nr;
116 struct sample_read_value *values;
117 } group;
118 struct sample_read_value one;
119 };
120};
121
0776eb59
JO
122struct ip_callchain {
123 u64 nr;
124 u64 ips[0];
125};
126
127struct branch_flags {
128 u64 mispred:1;
129 u64 predicted:1;
130 u64 in_tx:1;
131 u64 abort:1;
132 u64 reserved:60;
133};
134
135struct branch_entry {
136 u64 from;
137 u64 to;
138 struct branch_flags flags;
139};
140
141struct branch_stack {
142 u64 nr;
143 struct branch_entry entries[0];
144};
145
00447ccd
AH
146enum {
147 PERF_IP_FLAG_BRANCH = 1ULL << 0,
148 PERF_IP_FLAG_CALL = 1ULL << 1,
149 PERF_IP_FLAG_RETURN = 1ULL << 2,
150 PERF_IP_FLAG_CONDITIONAL = 1ULL << 3,
151 PERF_IP_FLAG_SYSCALLRET = 1ULL << 4,
152 PERF_IP_FLAG_ASYNC = 1ULL << 5,
153 PERF_IP_FLAG_INTERRUPT = 1ULL << 6,
154 PERF_IP_FLAG_TX_ABORT = 1ULL << 7,
155 PERF_IP_FLAG_TRACE_BEGIN = 1ULL << 8,
156 PERF_IP_FLAG_TRACE_END = 1ULL << 9,
157 PERF_IP_FLAG_IN_TX = 1ULL << 10,
158};
159
400ea6d3
AH
160#define PERF_IP_FLAG_CHARS "bcrosyiABEx"
161
00447ccd
AH
162#define PERF_BRANCH_MASK (\
163 PERF_IP_FLAG_BRANCH |\
164 PERF_IP_FLAG_CALL |\
165 PERF_IP_FLAG_RETURN |\
166 PERF_IP_FLAG_CONDITIONAL |\
167 PERF_IP_FLAG_SYSCALLRET |\
168 PERF_IP_FLAG_ASYNC |\
169 PERF_IP_FLAG_INTERRUPT |\
170 PERF_IP_FLAG_TX_ABORT |\
171 PERF_IP_FLAG_TRACE_BEGIN |\
172 PERF_IP_FLAG_TRACE_END)
173
8d50e5b4 174struct perf_sample {
180f95e2
OH
175 u64 ip;
176 u32 pid, tid;
177 u64 time;
178 u64 addr;
179 u64 id;
180 u64 stream_id;
180f95e2 181 u64 period;
05484298 182 u64 weight;
475eeab9 183 u64 transaction;
eed05fe7 184 u32 cpu;
180f95e2 185 u32 raw_size;
98a3b32c 186 u64 data_src;
bf493902
AH
187 u32 flags;
188 u16 insn_len;
180f95e2 189 void *raw_data;
eed05fe7 190 struct ip_callchain *callchain;
b5387528 191 struct branch_stack *branch_stack;
0f6a3015 192 struct regs_dump user_regs;
6a21c0b5 193 struct regs_dump intr_regs;
0f6a3015 194 struct stack_dump user_stack;
9ede473c 195 struct sample_read read;
180f95e2
OH
196};
197
98a3b32c
SE
198#define PERF_MEM_DATA_SRC_NONE \
199 (PERF_MEM_S(OP, NA) |\
200 PERF_MEM_S(LVL, NA) |\
201 PERF_MEM_S(SNOOP, NA) |\
202 PERF_MEM_S(LOCK, NA) |\
203 PERF_MEM_S(TLB, NA))
204
8d06367f
ACM
205struct build_id_event {
206 struct perf_event_header header;
a1645ce1 207 pid_t pid;
9ac3e487 208 u8 build_id[PERF_ALIGN(BUILD_ID_SIZE, sizeof(u64))];
8d06367f
ACM
209 char filename[];
210};
fd39e055 211
98402807 212enum perf_user_event_type { /* above any possible kernel type */
9aefcab0 213 PERF_RECORD_USER_TYPE_START = 64,
2c46dbb5 214 PERF_RECORD_HEADER_ATTR = 64,
6065210d 215 PERF_RECORD_HEADER_EVENT_TYPE = 65, /* depreceated */
9215545e 216 PERF_RECORD_HEADER_TRACING_DATA = 66,
c7929e47 217 PERF_RECORD_HEADER_BUILD_ID = 67,
98402807 218 PERF_RECORD_FINISHED_ROUND = 68,
3c659eed 219 PERF_RECORD_ID_INDEX = 69,
a16ac023
AH
220 PERF_RECORD_AUXTRACE_INFO = 70,
221 PERF_RECORD_AUXTRACE = 71,
e9bf54d2 222 PERF_RECORD_AUXTRACE_ERROR = 72,
2c46dbb5
TZ
223 PERF_RECORD_HEADER_MAX
224};
225
85ed4729
AH
226enum auxtrace_error_type {
227 PERF_AUXTRACE_ERROR_ITRACE = 1,
228 PERF_AUXTRACE_ERROR_MAX
229};
230
4318bcb7
ACM
231/*
232 * The kernel collects the number of events it couldn't send in a stretch and
233 * when possible sends this number in a PERF_RECORD_LOST event. The number of
234 * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
235 * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
236 * the sum of all struct lost_event.lost fields reported.
237 *
238 * The total_period is needed because by default auto-freq is used, so
239 * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
240 * the total number of low level events, it is necessary to to sum all struct
241 * sample_event.period and stash the result in total_period.
242 */
243struct events_stats {
244 u64 total_period;
245 u64 total_non_filtered_period;
246 u64 total_lost;
247 u64 total_invalid_chains;
248 u32 nr_events[PERF_RECORD_HEADER_MAX];
249 u32 nr_non_filtered_samples;
250 u32 nr_lost_warned;
251 u32 nr_unknown_events;
252 u32 nr_invalid_chains;
253 u32 nr_unknown_id;
254 u32 nr_unprocessable_samples;
85ed4729 255 u32 nr_auxtrace_errors[PERF_AUXTRACE_ERROR_MAX];
4318bcb7
ACM
256};
257
2c46dbb5
TZ
258struct attr_event {
259 struct perf_event_header header;
260 struct perf_event_attr attr;
261 u64 id[];
8dc58101
TZ
262};
263
cd19a035
TZ
264#define MAX_EVENT_NAME 64
265
266struct perf_trace_event_type {
267 u64 event_id;
268 char name[MAX_EVENT_NAME];
269};
270
271struct event_type_event {
272 struct perf_event_header header;
273 struct perf_trace_event_type event_type;
274};
275
9215545e
TZ
276struct tracing_data_event {
277 struct perf_event_header header;
278 u32 size;
279};
280
3c659eed
AH
281struct id_index_entry {
282 u64 id;
283 u64 idx;
284 u64 cpu;
285 u64 tid;
286};
287
288struct id_index_event {
289 struct perf_event_header header;
290 u64 nr;
291 struct id_index_entry entries[0];
292};
293
a16ac023
AH
294struct auxtrace_info_event {
295 struct perf_event_header header;
296 u32 type;
297 u32 reserved__; /* For alignment */
298 u64 priv[];
299};
300
301struct auxtrace_event {
302 struct perf_event_header header;
303 u64 size;
304 u64 offset;
305 u64 reference;
306 u32 idx;
307 u32 tid;
308 u32 cpu;
309 u32 reserved__; /* For alignment */
310};
311
e9bf54d2
AH
312#define MAX_AUXTRACE_ERROR_MSG 64
313
314struct auxtrace_error_event {
315 struct perf_event_header header;
316 u32 type;
317 u32 code;
318 u32 cpu;
319 u32 pid;
320 u32 tid;
321 u32 reserved__; /* For alignment */
322 u64 ip;
323 char msg[MAX_AUXTRACE_ERROR_MSG];
324};
325
4a96f7a0
AH
326struct aux_event {
327 struct perf_event_header header;
328 u64 aux_offset;
329 u64 aux_size;
330 u64 flags;
331};
332
8115d60c 333union perf_event {
1fe2c106 334 struct perf_event_header header;
1fe2c106 335 struct mmap_event mmap;
5c5e854b 336 struct mmap2_event mmap2;
1fe2c106
FW
337 struct comm_event comm;
338 struct fork_event fork;
339 struct lost_event lost;
340 struct read_event read;
dd96c46b 341 struct throttle_event throttle;
fd39e055 342 struct sample_event sample;
2c46dbb5 343 struct attr_event attr;
cd19a035 344 struct event_type_event event_type;
9215545e 345 struct tracing_data_event tracing_data;
c7929e47 346 struct build_id_event build_id;
3c659eed 347 struct id_index_event id_index;
a16ac023
AH
348 struct auxtrace_info_event auxtrace_info;
349 struct auxtrace_event auxtrace;
e9bf54d2 350 struct auxtrace_error_event auxtrace_error;
4a96f7a0 351 struct aux_event aux;
8115d60c 352};
66e274f3 353
8115d60c 354void perf_event__print_totals(void);
62daacb5 355
45694aa7 356struct perf_tool;
401b8e13 357struct thread_map;
4aa65636 358
45694aa7 359typedef int (*perf_event__handler_t)(struct perf_tool *tool,
d20deb64 360 union perf_event *event,
8115d60c 361 struct perf_sample *sample,
743eb868 362 struct machine *machine);
cf553114 363
45694aa7 364int perf_event__synthesize_thread_map(struct perf_tool *tool,
d20deb64 365 struct thread_map *threads,
7c940c18 366 perf_event__handler_t process,
62605dc5 367 struct machine *machine, bool mmap_data);
45694aa7 368int perf_event__synthesize_threads(struct perf_tool *tool,
d20deb64 369 perf_event__handler_t process,
62605dc5 370 struct machine *machine, bool mmap_data);
45694aa7 371int perf_event__synthesize_kernel_mmap(struct perf_tool *tool,
d20deb64 372 perf_event__handler_t process,
0ae617be 373 struct machine *machine);
8115d60c 374
45694aa7 375int perf_event__synthesize_modules(struct perf_tool *tool,
d20deb64 376 perf_event__handler_t process,
8115d60c
ACM
377 struct machine *machine);
378
45694aa7 379int perf_event__process_comm(struct perf_tool *tool,
d20deb64
ACM
380 union perf_event *event,
381 struct perf_sample *sample,
743eb868 382 struct machine *machine);
45694aa7 383int perf_event__process_lost(struct perf_tool *tool,
d20deb64
ACM
384 union perf_event *event,
385 struct perf_sample *sample,
743eb868 386 struct machine *machine);
4a96f7a0
AH
387int perf_event__process_aux(struct perf_tool *tool,
388 union perf_event *event,
389 struct perf_sample *sample,
390 struct machine *machine);
45694aa7 391int perf_event__process_mmap(struct perf_tool *tool,
d20deb64
ACM
392 union perf_event *event,
393 struct perf_sample *sample,
743eb868 394 struct machine *machine);
5c5e854b
SE
395int perf_event__process_mmap2(struct perf_tool *tool,
396 union perf_event *event,
397 struct perf_sample *sample,
398 struct machine *machine);
f62d3f0f
ACM
399int perf_event__process_fork(struct perf_tool *tool,
400 union perf_event *event,
401 struct perf_sample *sample,
402 struct machine *machine);
403int perf_event__process_exit(struct perf_tool *tool,
d20deb64
ACM
404 union perf_event *event,
405 struct perf_sample *sample,
743eb868 406 struct machine *machine);
45694aa7 407int perf_event__process(struct perf_tool *tool,
d20deb64
ACM
408 union perf_event *event,
409 struct perf_sample *sample,
743eb868 410 struct machine *machine);
62daacb5 411
1ed091c4 412struct addr_location;
316c7136
ACM
413
414int perf_event__preprocess_sample(const union perf_event *event,
743eb868 415 struct machine *machine,
8115d60c 416 struct addr_location *al,
e44baa3e 417 struct perf_sample *sample);
1ed091c4 418
9b0d2d87
AH
419struct thread;
420
421bool is_bts_event(struct perf_event_attr *attr);
422bool sample_addr_correlates_sym(struct perf_event_attr *attr);
423void perf_event__preprocess_sample_addr(union perf_event *event,
424 struct perf_sample *sample,
9b0d2d87
AH
425 struct thread *thread,
426 struct addr_location *al);
427
8115d60c 428const char *perf_event__name(unsigned int id);
c8446b9b 429
b1cf6f65 430size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,
352ea45a 431 u64 read_format);
74eec26f 432int perf_event__synthesize_sample(union perf_event *event, u64 type,
352ea45a 433 u64 read_format,
74eec26f
AV
434 const struct perf_sample *sample,
435 bool swapped);
d0dd74e8 436
a18382b6
JO
437int perf_event__synthesize_mmap_events(struct perf_tool *tool,
438 union perf_event *event,
439 pid_t pid, pid_t tgid,
440 perf_event__handler_t process,
441 struct machine *machine,
442 bool mmap_data);
443
482ad897
ACM
444size_t perf_event__fprintf_comm(union perf_event *event, FILE *fp);
445size_t perf_event__fprintf_mmap(union perf_event *event, FILE *fp);
5c5e854b 446size_t perf_event__fprintf_mmap2(union perf_event *event, FILE *fp);
482ad897 447size_t perf_event__fprintf_task(union perf_event *event, FILE *fp);
4a96f7a0 448size_t perf_event__fprintf_aux(union perf_event *event, FILE *fp);
482ad897
ACM
449size_t perf_event__fprintf(union perf_event *event, FILE *fp);
450
29b596b5
AH
451u64 kallsyms__get_function_start(const char *kallsyms_filename,
452 const char *symbol_name);
453
8b40f521 454#endif /* __PERF_RECORD_H */