perf script: Allow time to be displayed in nanoseconds
[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,
2c46dbb5
TZ
229 PERF_RECORD_HEADER_MAX
230};
231
85ed4729
AH
232enum auxtrace_error_type {
233 PERF_AUXTRACE_ERROR_ITRACE = 1,
234 PERF_AUXTRACE_ERROR_MAX
235};
236
4318bcb7
ACM
237/*
238 * The kernel collects the number of events it couldn't send in a stretch and
239 * when possible sends this number in a PERF_RECORD_LOST event. The number of
240 * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
241 * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
242 * the sum of all struct lost_event.lost fields reported.
243 *
c4937a91
KL
244 * The kernel discards mixed up samples and sends the number in a
245 * PERF_RECORD_LOST_SAMPLES event. The number of lost-samples events is stored
246 * in .nr_events[PERF_RECORD_LOST_SAMPLES] while total_lost_samples tells
247 * exactly how many samples the kernel in fact dropped, i.e. it is the sum of
248 * all struct lost_samples_event.lost fields reported.
249 *
4318bcb7
ACM
250 * The total_period is needed because by default auto-freq is used, so
251 * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
252 * the total number of low level events, it is necessary to to sum all struct
253 * sample_event.period and stash the result in total_period.
254 */
255struct events_stats {
256 u64 total_period;
257 u64 total_non_filtered_period;
258 u64 total_lost;
c4937a91 259 u64 total_lost_samples;
4318bcb7
ACM
260 u64 total_invalid_chains;
261 u32 nr_events[PERF_RECORD_HEADER_MAX];
262 u32 nr_non_filtered_samples;
263 u32 nr_lost_warned;
264 u32 nr_unknown_events;
265 u32 nr_invalid_chains;
266 u32 nr_unknown_id;
267 u32 nr_unprocessable_samples;
85ed4729 268 u32 nr_auxtrace_errors[PERF_AUXTRACE_ERROR_MAX];
930e6fcd 269 u32 nr_proc_map_timeout;
4318bcb7
ACM
270};
271
2c46dbb5
TZ
272struct attr_event {
273 struct perf_event_header header;
274 struct perf_event_attr attr;
275 u64 id[];
8dc58101
TZ
276};
277
cd19a035
TZ
278#define MAX_EVENT_NAME 64
279
280struct perf_trace_event_type {
281 u64 event_id;
282 char name[MAX_EVENT_NAME];
283};
284
285struct event_type_event {
286 struct perf_event_header header;
287 struct perf_trace_event_type event_type;
288};
289
9215545e
TZ
290struct tracing_data_event {
291 struct perf_event_header header;
292 u32 size;
293};
294
3c659eed
AH
295struct id_index_entry {
296 u64 id;
297 u64 idx;
298 u64 cpu;
299 u64 tid;
300};
301
302struct id_index_event {
303 struct perf_event_header header;
304 u64 nr;
305 struct id_index_entry entries[0];
306};
307
a16ac023
AH
308struct auxtrace_info_event {
309 struct perf_event_header header;
310 u32 type;
311 u32 reserved__; /* For alignment */
312 u64 priv[];
313};
314
315struct auxtrace_event {
316 struct perf_event_header header;
317 u64 size;
318 u64 offset;
319 u64 reference;
320 u32 idx;
321 u32 tid;
322 u32 cpu;
323 u32 reserved__; /* For alignment */
324};
325
e9bf54d2
AH
326#define MAX_AUXTRACE_ERROR_MSG 64
327
328struct auxtrace_error_event {
329 struct perf_event_header header;
330 u32 type;
331 u32 code;
332 u32 cpu;
333 u32 pid;
334 u32 tid;
335 u32 reserved__; /* For alignment */
336 u64 ip;
337 char msg[MAX_AUXTRACE_ERROR_MSG];
338};
339
4a96f7a0
AH
340struct aux_event {
341 struct perf_event_header header;
342 u64 aux_offset;
343 u64 aux_size;
344 u64 flags;
345};
346
0ad21f68
AH
347struct itrace_start_event {
348 struct perf_event_header header;
349 u32 pid, tid;
350};
351
0286039f
AH
352struct context_switch_event {
353 struct perf_event_header header;
354 u32 next_prev_pid;
355 u32 next_prev_tid;
356};
357
8115d60c 358union perf_event {
1fe2c106 359 struct perf_event_header header;
1fe2c106 360 struct mmap_event mmap;
5c5e854b 361 struct mmap2_event mmap2;
1fe2c106
FW
362 struct comm_event comm;
363 struct fork_event fork;
364 struct lost_event lost;
c4937a91 365 struct lost_samples_event lost_samples;
1fe2c106 366 struct read_event read;
dd96c46b 367 struct throttle_event throttle;
fd39e055 368 struct sample_event sample;
2c46dbb5 369 struct attr_event attr;
cd19a035 370 struct event_type_event event_type;
9215545e 371 struct tracing_data_event tracing_data;
c7929e47 372 struct build_id_event build_id;
3c659eed 373 struct id_index_event id_index;
a16ac023
AH
374 struct auxtrace_info_event auxtrace_info;
375 struct auxtrace_event auxtrace;
e9bf54d2 376 struct auxtrace_error_event auxtrace_error;
4a96f7a0 377 struct aux_event aux;
0ad21f68 378 struct itrace_start_event itrace_start;
0286039f 379 struct context_switch_event context_switch;
8115d60c 380};
66e274f3 381
8115d60c 382void perf_event__print_totals(void);
62daacb5 383
45694aa7 384struct perf_tool;
401b8e13 385struct thread_map;
4aa65636 386
45694aa7 387typedef int (*perf_event__handler_t)(struct perf_tool *tool,
d20deb64 388 union perf_event *event,
8115d60c 389 struct perf_sample *sample,
743eb868 390 struct machine *machine);
cf553114 391
45694aa7 392int perf_event__synthesize_thread_map(struct perf_tool *tool,
d20deb64 393 struct thread_map *threads,
7c940c18 394 perf_event__handler_t process,
9d9cad76
KL
395 struct machine *machine, bool mmap_data,
396 unsigned int proc_map_timeout);
45694aa7 397int perf_event__synthesize_threads(struct perf_tool *tool,
d20deb64 398 perf_event__handler_t process,
9d9cad76
KL
399 struct machine *machine, bool mmap_data,
400 unsigned int proc_map_timeout);
45694aa7 401int perf_event__synthesize_kernel_mmap(struct perf_tool *tool,
d20deb64 402 perf_event__handler_t process,
0ae617be 403 struct machine *machine);
8115d60c 404
45694aa7 405int perf_event__synthesize_modules(struct perf_tool *tool,
d20deb64 406 perf_event__handler_t process,
8115d60c
ACM
407 struct machine *machine);
408
45694aa7 409int perf_event__process_comm(struct perf_tool *tool,
d20deb64
ACM
410 union perf_event *event,
411 struct perf_sample *sample,
743eb868 412 struct machine *machine);
45694aa7 413int perf_event__process_lost(struct perf_tool *tool,
d20deb64
ACM
414 union perf_event *event,
415 struct perf_sample *sample,
743eb868 416 struct machine *machine);
c4937a91
KL
417int perf_event__process_lost_samples(struct perf_tool *tool,
418 union perf_event *event,
419 struct perf_sample *sample,
420 struct machine *machine);
4a96f7a0
AH
421int perf_event__process_aux(struct perf_tool *tool,
422 union perf_event *event,
423 struct perf_sample *sample,
424 struct machine *machine);
0ad21f68
AH
425int perf_event__process_itrace_start(struct perf_tool *tool,
426 union perf_event *event,
427 struct perf_sample *sample,
428 struct machine *machine);
0286039f
AH
429int perf_event__process_switch(struct perf_tool *tool,
430 union perf_event *event,
431 struct perf_sample *sample,
432 struct machine *machine);
45694aa7 433int perf_event__process_mmap(struct perf_tool *tool,
d20deb64
ACM
434 union perf_event *event,
435 struct perf_sample *sample,
743eb868 436 struct machine *machine);
5c5e854b
SE
437int perf_event__process_mmap2(struct perf_tool *tool,
438 union perf_event *event,
439 struct perf_sample *sample,
440 struct machine *machine);
f62d3f0f
ACM
441int perf_event__process_fork(struct perf_tool *tool,
442 union perf_event *event,
443 struct perf_sample *sample,
444 struct machine *machine);
445int perf_event__process_exit(struct perf_tool *tool,
d20deb64
ACM
446 union perf_event *event,
447 struct perf_sample *sample,
743eb868 448 struct machine *machine);
45694aa7 449int perf_event__process(struct perf_tool *tool,
d20deb64
ACM
450 union perf_event *event,
451 struct perf_sample *sample,
743eb868 452 struct machine *machine);
62daacb5 453
1ed091c4 454struct addr_location;
316c7136
ACM
455
456int perf_event__preprocess_sample(const union perf_event *event,
743eb868 457 struct machine *machine,
8115d60c 458 struct addr_location *al,
e44baa3e 459 struct perf_sample *sample);
1ed091c4 460
b91fc39f
ACM
461void addr_location__put(struct addr_location *al);
462
9b0d2d87
AH
463struct thread;
464
465bool is_bts_event(struct perf_event_attr *attr);
466bool sample_addr_correlates_sym(struct perf_event_attr *attr);
467void perf_event__preprocess_sample_addr(union perf_event *event,
468 struct perf_sample *sample,
9b0d2d87
AH
469 struct thread *thread,
470 struct addr_location *al);
471
8115d60c 472const char *perf_event__name(unsigned int id);
c8446b9b 473
b1cf6f65 474size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,
352ea45a 475 u64 read_format);
74eec26f 476int perf_event__synthesize_sample(union perf_event *event, u64 type,
352ea45a 477 u64 read_format,
74eec26f
AV
478 const struct perf_sample *sample,
479 bool swapped);
d0dd74e8 480
e803cf97
NK
481pid_t perf_event__synthesize_comm(struct perf_tool *tool,
482 union perf_event *event, pid_t pid,
483 perf_event__handler_t process,
484 struct machine *machine);
485
a18382b6
JO
486int perf_event__synthesize_mmap_events(struct perf_tool *tool,
487 union perf_event *event,
488 pid_t pid, pid_t tgid,
489 perf_event__handler_t process,
490 struct machine *machine,
9d9cad76
KL
491 bool mmap_data,
492 unsigned int proc_map_timeout);
a18382b6 493
482ad897
ACM
494size_t perf_event__fprintf_comm(union perf_event *event, FILE *fp);
495size_t perf_event__fprintf_mmap(union perf_event *event, FILE *fp);
5c5e854b 496size_t perf_event__fprintf_mmap2(union perf_event *event, FILE *fp);
482ad897 497size_t perf_event__fprintf_task(union perf_event *event, FILE *fp);
4a96f7a0 498size_t perf_event__fprintf_aux(union perf_event *event, FILE *fp);
0ad21f68 499size_t perf_event__fprintf_itrace_start(union perf_event *event, FILE *fp);
0286039f 500size_t perf_event__fprintf_switch(union perf_event *event, FILE *fp);
482ad897
ACM
501size_t perf_event__fprintf(union perf_event *event, FILE *fp);
502
29b596b5
AH
503u64 kallsyms__get_function_start(const char *kallsyms_filename,
504 const char *symbol_name);
505
8b40f521 506#endif /* __PERF_RECORD_H */