1 #ifndef __PERF_RECORD_H
2 #define __PERF_RECORD_H
10 #include "perf_regs.h"
13 struct perf_event_header header;
18 char filename[PATH_MAX];
22 struct perf_event_header header;
33 char filename[PATH_MAX];
37 struct perf_event_header header;
43 struct perf_event_header header;
50 struct perf_event_header header;
55 struct lost_samples_event {
56 struct perf_event_header header;
61 * PERF_FORMAT_ENABLED | PERF_FORMAT_RUNNING | PERF_FORMAT_ID
64 struct perf_event_header header;
72 struct throttle_event {
73 struct perf_event_header header;
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 | \
83 PERF_SAMPLE_CPU | PERF_SAMPLE_PERIOD | \
84 PERF_SAMPLE_IDENTIFIER)
86 /* perf sample has 16 bits size limit */
87 #define PERF_SAMPLE_MAX_SIZE (1 << 16)
90 struct perf_event_header header;
99 /* Cached values/mask filled by first register access. */
100 u64 cache_regs[PERF_REGS_MAX];
110 struct sample_read_value {
121 struct sample_read_value *values;
123 struct sample_read_value one;
127 struct ip_callchain {
132 struct branch_flags {
141 struct branch_entry {
144 struct branch_flags flags;
147 struct branch_stack {
149 struct branch_entry entries[0];
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,
166 #define PERF_IP_FLAG_CHARS "bcrosyiABEx"
168 #define PERF_BRANCH_MASK (\
169 PERF_IP_FLAG_BRANCH |\
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)
196 struct ip_callchain *callchain;
197 struct branch_stack *branch_stack;
198 struct regs_dump user_regs;
199 struct regs_dump intr_regs;
200 struct stack_dump user_stack;
201 struct sample_read read;
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) |\
211 struct build_id_event {
212 struct perf_event_header header;
214 u8 build_id[PERF_ALIGN(BUILD_ID_SIZE, sizeof(u64))];
218 enum perf_user_event_type { /* above any possible kernel type */
219 PERF_RECORD_USER_TYPE_START = 64,
220 PERF_RECORD_HEADER_ATTR = 64,
221 PERF_RECORD_HEADER_EVENT_TYPE = 65, /* depreceated */
222 PERF_RECORD_HEADER_TRACING_DATA = 66,
223 PERF_RECORD_HEADER_BUILD_ID = 67,
224 PERF_RECORD_FINISHED_ROUND = 68,
225 PERF_RECORD_ID_INDEX = 69,
226 PERF_RECORD_AUXTRACE_INFO = 70,
227 PERF_RECORD_AUXTRACE = 71,
228 PERF_RECORD_AUXTRACE_ERROR = 72,
229 PERF_RECORD_HEADER_MAX
232 enum auxtrace_error_type {
233 PERF_AUXTRACE_ERROR_ITRACE = 1,
234 PERF_AUXTRACE_ERROR_MAX
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.
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.
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.
255 struct events_stats {
257 u64 total_non_filtered_period;
259 u64 total_lost_samples;
260 u64 total_invalid_chains;
261 u32 nr_events[PERF_RECORD_HEADER_MAX];
262 u32 nr_non_filtered_samples;
264 u32 nr_unknown_events;
265 u32 nr_invalid_chains;
267 u32 nr_unprocessable_samples;
268 u32 nr_auxtrace_errors[PERF_AUXTRACE_ERROR_MAX];
269 u32 nr_proc_map_timeout;
273 struct perf_event_header header;
274 struct perf_event_attr attr;
278 #define MAX_EVENT_NAME 64
280 struct perf_trace_event_type {
282 char name[MAX_EVENT_NAME];
285 struct event_type_event {
286 struct perf_event_header header;
287 struct perf_trace_event_type event_type;
290 struct tracing_data_event {
291 struct perf_event_header header;
295 struct id_index_entry {
302 struct id_index_event {
303 struct perf_event_header header;
305 struct id_index_entry entries[0];
308 struct auxtrace_info_event {
309 struct perf_event_header header;
311 u32 reserved__; /* For alignment */
315 struct auxtrace_event {
316 struct perf_event_header header;
323 u32 reserved__; /* For alignment */
326 #define MAX_AUXTRACE_ERROR_MSG 64
328 struct auxtrace_error_event {
329 struct perf_event_header header;
335 u32 reserved__; /* For alignment */
337 char msg[MAX_AUXTRACE_ERROR_MSG];
341 struct perf_event_header header;
347 struct itrace_start_event {
348 struct perf_event_header header;
352 struct context_switch_event {
353 struct perf_event_header header;
359 struct perf_event_header header;
360 struct mmap_event mmap;
361 struct mmap2_event mmap2;
362 struct comm_event comm;
363 struct fork_event fork;
364 struct lost_event lost;
365 struct lost_samples_event lost_samples;
366 struct read_event read;
367 struct throttle_event throttle;
368 struct sample_event sample;
369 struct attr_event attr;
370 struct event_type_event event_type;
371 struct tracing_data_event tracing_data;
372 struct build_id_event build_id;
373 struct id_index_event id_index;
374 struct auxtrace_info_event auxtrace_info;
375 struct auxtrace_event auxtrace;
376 struct auxtrace_error_event auxtrace_error;
377 struct aux_event aux;
378 struct itrace_start_event itrace_start;
379 struct context_switch_event context_switch;
382 void perf_event__print_totals(void);
387 typedef int (*perf_event__handler_t)(struct perf_tool *tool,
388 union perf_event *event,
389 struct perf_sample *sample,
390 struct machine *machine);
392 int perf_event__synthesize_thread_map(struct perf_tool *tool,
393 struct thread_map *threads,
394 perf_event__handler_t process,
395 struct machine *machine, bool mmap_data,
396 unsigned int proc_map_timeout);
397 int perf_event__synthesize_threads(struct perf_tool *tool,
398 perf_event__handler_t process,
399 struct machine *machine, bool mmap_data,
400 unsigned int proc_map_timeout);
401 int perf_event__synthesize_kernel_mmap(struct perf_tool *tool,
402 perf_event__handler_t process,
403 struct machine *machine);
405 int perf_event__synthesize_modules(struct perf_tool *tool,
406 perf_event__handler_t process,
407 struct machine *machine);
409 int perf_event__process_comm(struct perf_tool *tool,
410 union perf_event *event,
411 struct perf_sample *sample,
412 struct machine *machine);
413 int perf_event__process_lost(struct perf_tool *tool,
414 union perf_event *event,
415 struct perf_sample *sample,
416 struct machine *machine);
417 int perf_event__process_lost_samples(struct perf_tool *tool,
418 union perf_event *event,
419 struct perf_sample *sample,
420 struct machine *machine);
421 int perf_event__process_aux(struct perf_tool *tool,
422 union perf_event *event,
423 struct perf_sample *sample,
424 struct machine *machine);
425 int perf_event__process_itrace_start(struct perf_tool *tool,
426 union perf_event *event,
427 struct perf_sample *sample,
428 struct machine *machine);
429 int perf_event__process_switch(struct perf_tool *tool,
430 union perf_event *event,
431 struct perf_sample *sample,
432 struct machine *machine);
433 int perf_event__process_mmap(struct perf_tool *tool,
434 union perf_event *event,
435 struct perf_sample *sample,
436 struct machine *machine);
437 int perf_event__process_mmap2(struct perf_tool *tool,
438 union perf_event *event,
439 struct perf_sample *sample,
440 struct machine *machine);
441 int perf_event__process_fork(struct perf_tool *tool,
442 union perf_event *event,
443 struct perf_sample *sample,
444 struct machine *machine);
445 int perf_event__process_exit(struct perf_tool *tool,
446 union perf_event *event,
447 struct perf_sample *sample,
448 struct machine *machine);
449 int perf_event__process(struct perf_tool *tool,
450 union perf_event *event,
451 struct perf_sample *sample,
452 struct machine *machine);
454 struct addr_location;
456 int perf_event__preprocess_sample(const union perf_event *event,
457 struct machine *machine,
458 struct addr_location *al,
459 struct perf_sample *sample);
461 void addr_location__put(struct addr_location *al);
465 bool is_bts_event(struct perf_event_attr *attr);
466 bool sample_addr_correlates_sym(struct perf_event_attr *attr);
467 void perf_event__preprocess_sample_addr(union perf_event *event,
468 struct perf_sample *sample,
469 struct thread *thread,
470 struct addr_location *al);
472 const char *perf_event__name(unsigned int id);
474 size_t perf_event__sample_event_size(const struct perf_sample *sample, u64 type,
476 int perf_event__synthesize_sample(union perf_event *event, u64 type,
478 const struct perf_sample *sample,
481 int perf_event__synthesize_mmap_events(struct perf_tool *tool,
482 union perf_event *event,
483 pid_t pid, pid_t tgid,
484 perf_event__handler_t process,
485 struct machine *machine,
487 unsigned int proc_map_timeout);
489 size_t perf_event__fprintf_comm(union perf_event *event, FILE *fp);
490 size_t perf_event__fprintf_mmap(union perf_event *event, FILE *fp);
491 size_t perf_event__fprintf_mmap2(union perf_event *event, FILE *fp);
492 size_t perf_event__fprintf_task(union perf_event *event, FILE *fp);
493 size_t perf_event__fprintf_aux(union perf_event *event, FILE *fp);
494 size_t perf_event__fprintf_itrace_start(union perf_event *event, FILE *fp);
495 size_t perf_event__fprintf_switch(union perf_event *event, FILE *fp);
496 size_t perf_event__fprintf(union perf_event *event, FILE *fp);
498 u64 kallsyms__get_function_start(const char *kallsyms_filename,
499 const char *symbol_name);
501 #endif /* __PERF_RECORD_H */