perf session: Add instruction tracing options
[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
160#define PERF_BRANCH_MASK (\
161 PERF_IP_FLAG_BRANCH |\
162 PERF_IP_FLAG_CALL |\
163 PERF_IP_FLAG_RETURN |\
164 PERF_IP_FLAG_CONDITIONAL |\
165 PERF_IP_FLAG_SYSCALLRET |\
166 PERF_IP_FLAG_ASYNC |\
167 PERF_IP_FLAG_INTERRUPT |\
168 PERF_IP_FLAG_TX_ABORT |\
169 PERF_IP_FLAG_TRACE_BEGIN |\
170 PERF_IP_FLAG_TRACE_END)
171
8d50e5b4 172struct perf_sample {
180f95e2
OH
173 u64 ip;
174 u32 pid, tid;
175 u64 time;
176 u64 addr;
177 u64 id;
178 u64 stream_id;
180f95e2 179 u64 period;
05484298 180 u64 weight;
475eeab9 181 u64 transaction;
eed05fe7 182 u32 cpu;
180f95e2 183 u32 raw_size;
98a3b32c 184 u64 data_src;
bf493902
AH
185 u32 flags;
186 u16 insn_len;
180f95e2 187 void *raw_data;
eed05fe7 188 struct ip_callchain *callchain;
b5387528 189 struct branch_stack *branch_stack;
0f6a3015 190 struct regs_dump user_regs;
6a21c0b5 191 struct regs_dump intr_regs;
0f6a3015 192 struct stack_dump user_stack;
9ede473c 193 struct sample_read read;
180f95e2
OH
194};
195
98a3b32c
SE
196#define PERF_MEM_DATA_SRC_NONE \
197 (PERF_MEM_S(OP, NA) |\
198 PERF_MEM_S(LVL, NA) |\
199 PERF_MEM_S(SNOOP, NA) |\
200 PERF_MEM_S(LOCK, NA) |\
201 PERF_MEM_S(TLB, NA))
202
8d06367f
ACM
203struct build_id_event {
204 struct perf_event_header header;
a1645ce1 205 pid_t pid;
9ac3e487 206 u8 build_id[PERF_ALIGN(BUILD_ID_SIZE, sizeof(u64))];
8d06367f
ACM
207 char filename[];
208};
fd39e055 209
98402807 210enum perf_user_event_type { /* above any possible kernel type */
9aefcab0 211 PERF_RECORD_USER_TYPE_START = 64,
2c46dbb5 212 PERF_RECORD_HEADER_ATTR = 64,
6065210d 213 PERF_RECORD_HEADER_EVENT_TYPE = 65, /* depreceated */
9215545e 214 PERF_RECORD_HEADER_TRACING_DATA = 66,
c7929e47 215 PERF_RECORD_HEADER_BUILD_ID = 67,
98402807 216 PERF_RECORD_FINISHED_ROUND = 68,
3c659eed 217 PERF_RECORD_ID_INDEX = 69,
a16ac023
AH
218 PERF_RECORD_AUXTRACE_INFO = 70,
219 PERF_RECORD_AUXTRACE = 71,
e9bf54d2 220 PERF_RECORD_AUXTRACE_ERROR = 72,
2c46dbb5
TZ
221 PERF_RECORD_HEADER_MAX
222};
223
4318bcb7
ACM
224/*
225 * The kernel collects the number of events it couldn't send in a stretch and
226 * when possible sends this number in a PERF_RECORD_LOST event. The number of
227 * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
228 * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
229 * the sum of all struct lost_event.lost fields reported.
230 *
231 * The total_period is needed because by default auto-freq is used, so
232 * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
233 * the total number of low level events, it is necessary to to sum all struct
234 * sample_event.period and stash the result in total_period.
235 */
236struct events_stats {
237 u64 total_period;
238 u64 total_non_filtered_period;
239 u64 total_lost;
240 u64 total_invalid_chains;
241 u32 nr_events[PERF_RECORD_HEADER_MAX];
242 u32 nr_non_filtered_samples;
243 u32 nr_lost_warned;
244 u32 nr_unknown_events;
245 u32 nr_invalid_chains;
246 u32 nr_unknown_id;
247 u32 nr_unprocessable_samples;
248};
249
2c46dbb5
TZ
250struct attr_event {
251 struct perf_event_header header;
252 struct perf_event_attr attr;
253 u64 id[];
8dc58101
TZ
254};
255
cd19a035
TZ
256#define MAX_EVENT_NAME 64
257
258struct perf_trace_event_type {
259 u64 event_id;
260 char name[MAX_EVENT_NAME];
261};
262
263struct event_type_event {
264 struct perf_event_header header;
265 struct perf_trace_event_type event_type;
266};
267
9215545e
TZ
268struct tracing_data_event {
269 struct perf_event_header header;
270 u32 size;
271};
272
3c659eed
AH
273struct id_index_entry {
274 u64 id;
275 u64 idx;
276 u64 cpu;
277 u64 tid;
278};
279
280struct id_index_event {
281 struct perf_event_header header;
282 u64 nr;
283 struct id_index_entry entries[0];
284};
285
a16ac023
AH
286struct auxtrace_info_event {
287 struct perf_event_header header;
288 u32 type;
289 u32 reserved__; /* For alignment */
290 u64 priv[];
291};
292
293struct auxtrace_event {
294 struct perf_event_header header;
295 u64 size;
296 u64 offset;
297 u64 reference;
298 u32 idx;
299 u32 tid;
300 u32 cpu;
301 u32 reserved__; /* For alignment */
302};
303
e9bf54d2
AH
304#define MAX_AUXTRACE_ERROR_MSG 64
305
306struct auxtrace_error_event {
307 struct perf_event_header header;
308 u32 type;
309 u32 code;
310 u32 cpu;
311 u32 pid;
312 u32 tid;
313 u32 reserved__; /* For alignment */
314 u64 ip;
315 char msg[MAX_AUXTRACE_ERROR_MSG];
316};
317
8115d60c 318union perf_event {
1fe2c106 319 struct perf_event_header header;
1fe2c106 320 struct mmap_event mmap;
5c5e854b 321 struct mmap2_event mmap2;
1fe2c106
FW
322 struct comm_event comm;
323 struct fork_event fork;
324 struct lost_event lost;
325 struct read_event read;
dd96c46b 326 struct throttle_event throttle;
fd39e055 327 struct sample_event sample;
2c46dbb5 328 struct attr_event attr;
cd19a035 329 struct event_type_event event_type;
9215545e 330 struct tracing_data_event tracing_data;
c7929e47 331 struct build_id_event build_id;
3c659eed 332 struct id_index_event id_index;
a16ac023
AH
333 struct auxtrace_info_event auxtrace_info;
334 struct auxtrace_event auxtrace;
e9bf54d2 335 struct auxtrace_error_event auxtrace_error;
8115d60c 336};
66e274f3 337
8115d60c 338void perf_event__print_totals(void);
62daacb5 339
45694aa7 340struct perf_tool;
401b8e13 341struct thread_map;
4aa65636 342
45694aa7 343typedef int (*perf_event__handler_t)(struct perf_tool *tool,
d20deb64 344 union perf_event *event,
8115d60c 345 struct perf_sample *sample,
743eb868 346 struct machine *machine);
cf553114 347
45694aa7 348int perf_event__synthesize_thread_map(struct perf_tool *tool,
d20deb64 349 struct thread_map *threads,
7c940c18 350 perf_event__handler_t process,
62605dc5 351 struct machine *machine, bool mmap_data);
45694aa7 352int perf_event__synthesize_threads(struct perf_tool *tool,
d20deb64 353 perf_event__handler_t process,
62605dc5 354 struct machine *machine, bool mmap_data);
45694aa7 355int perf_event__synthesize_kernel_mmap(struct perf_tool *tool,
d20deb64 356 perf_event__handler_t process,
0ae617be 357 struct machine *machine);
8115d60c 358
45694aa7 359int perf_event__synthesize_modules(struct perf_tool *tool,
d20deb64 360 perf_event__handler_t process,
8115d60c
ACM
361 struct machine *machine);
362
45694aa7 363int perf_event__process_comm(struct perf_tool *tool,
d20deb64
ACM
364 union perf_event *event,
365 struct perf_sample *sample,
743eb868 366 struct machine *machine);
45694aa7 367int perf_event__process_lost(struct perf_tool *tool,
d20deb64
ACM
368 union perf_event *event,
369 struct perf_sample *sample,
743eb868 370 struct machine *machine);
45694aa7 371int perf_event__process_mmap(struct perf_tool *tool,
d20deb64
ACM
372 union perf_event *event,
373 struct perf_sample *sample,
743eb868 374 struct machine *machine);
5c5e854b
SE
375int perf_event__process_mmap2(struct perf_tool *tool,
376 union perf_event *event,
377 struct perf_sample *sample,
378 struct machine *machine);
f62d3f0f
ACM
379int perf_event__process_fork(struct perf_tool *tool,
380 union perf_event *event,
381 struct perf_sample *sample,
382 struct machine *machine);
383int perf_event__process_exit(struct perf_tool *tool,
d20deb64
ACM
384 union perf_event *event,
385 struct perf_sample *sample,
743eb868 386 struct machine *machine);
45694aa7 387int perf_event__process(struct perf_tool *tool,
d20deb64
ACM
388 union perf_event *event,
389 struct perf_sample *sample,
743eb868 390 struct machine *machine);
62daacb5 391
1ed091c4 392struct addr_location;
316c7136
ACM
393
394int perf_event__preprocess_sample(const union perf_event *event,
743eb868 395 struct machine *machine,
8115d60c 396 struct addr_location *al,
e44baa3e 397 struct perf_sample *sample);
1ed091c4 398
9b0d2d87
AH
399struct thread;
400
401bool is_bts_event(struct perf_event_attr *attr);
402bool sample_addr_correlates_sym(struct perf_event_attr *attr);
403void perf_event__preprocess_sample_addr(union perf_event *event,
404 struct perf_sample *sample,
9b0d2d87
AH
405 struct thread *thread,
406 struct addr_location *al);
407
8115d60c 408const char *perf_event__name(unsigned int id);
c8446b9b 409
b1cf6f65 410size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,
352ea45a 411 u64 read_format);
74eec26f 412int perf_event__synthesize_sample(union perf_event *event, u64 type,
352ea45a 413 u64 read_format,
74eec26f
AV
414 const struct perf_sample *sample,
415 bool swapped);
d0dd74e8 416
a18382b6
JO
417int perf_event__synthesize_mmap_events(struct perf_tool *tool,
418 union perf_event *event,
419 pid_t pid, pid_t tgid,
420 perf_event__handler_t process,
421 struct machine *machine,
422 bool mmap_data);
423
482ad897
ACM
424size_t perf_event__fprintf_comm(union perf_event *event, FILE *fp);
425size_t perf_event__fprintf_mmap(union perf_event *event, FILE *fp);
5c5e854b 426size_t perf_event__fprintf_mmap2(union perf_event *event, FILE *fp);
482ad897
ACM
427size_t perf_event__fprintf_task(union perf_event *event, FILE *fp);
428size_t perf_event__fprintf(union perf_event *event, FILE *fp);
429
29b596b5
AH
430u64 kallsyms__get_function_start(const char *kallsyms_filename,
431 const char *symbol_name);
432
8b40f521 433#endif /* __PERF_RECORD_H */