2 * auxtrace.h: AUX area trace support
3 * Copyright (c) 2013-2015, Intel Corporation.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 #ifndef __PERF_AUXTRACE_H
17 #define __PERF_AUXTRACE_H
19 #include <sys/types.h>
23 #include <linux/list.h>
24 #include <linux/perf_event.h>
25 #include <linux/types.h>
38 struct auxtrace_info_event
;
42 PERF_AUXTRACE_UNKNOWN
,
43 PERF_AUXTRACE_INTEL_PT
,
44 PERF_AUXTRACE_INTEL_BTS
,
46 PERF_AUXTRACE_ARM_SPE
,
49 enum itrace_period_type
{
50 PERF_ITRACE_PERIOD_INSTRUCTIONS
,
51 PERF_ITRACE_PERIOD_TICKS
,
52 PERF_ITRACE_PERIOD_NANOSECS
,
56 * struct itrace_synth_opts - AUX area tracing synthesis options.
57 * @set: indicates whether or not options have been set
58 * @inject: indicates the event (not just the sample) must be fully synthesized
59 * because 'perf inject' will write it out
60 * @instructions: whether to synthesize 'instructions' events
61 * @branches: whether to synthesize 'branches' events
62 * @transactions: whether to synthesize events for transactions
63 * @ptwrites: whether to synthesize events for ptwrites
64 * @pwr_events: whether to synthesize power events
65 * @errors: whether to synthesize decoder error events
66 * @dont_decode: whether to skip decoding entirely
67 * @log: write a decoding log
68 * @calls: limit branch samples to calls (can be combined with @returns)
69 * @returns: limit branch samples to returns (can be combined with @calls)
70 * @callchain: add callchain to 'instructions' events
71 * @thread_stack: feed branches to the thread_stack
72 * @last_branch: add branch context to 'instruction' events
73 * @callchain_sz: maximum callchain size
74 * @last_branch_sz: branch context size
75 * @period: 'instructions' events period
76 * @period_type: 'instructions' events period type
77 * @initial_skip: skip N events at the beginning.
78 * @cpu_bitmap: CPUs for which to synthesize events, or NULL for all
80 struct itrace_synth_opts
{
96 unsigned int callchain_sz
;
97 unsigned int last_branch_sz
;
98 unsigned long long period
;
99 enum itrace_period_type period_type
;
100 unsigned long initial_skip
;
101 unsigned long *cpu_bitmap
;
105 * struct auxtrace_index_entry - indexes a AUX area tracing event within a
107 * @file_offset: offset within the perf.data file
108 * @sz: size of the event
110 struct auxtrace_index_entry
{
115 #define PERF_AUXTRACE_INDEX_ENTRY_COUNT 256
118 * struct auxtrace_index - index of AUX area tracing events within a perf.data
120 * @list: linking a number of arrays of entries
121 * @nr: number of entries
122 * @entries: array of entries
124 struct auxtrace_index
{
125 struct list_head list
;
127 struct auxtrace_index_entry entries
[PERF_AUXTRACE_INDEX_ENTRY_COUNT
];
131 * struct auxtrace - session callbacks to allow AUX area data decoding.
132 * @process_event: lets the decoder see all session events
133 * @flush_events: process any remaining data
134 * @free_events: free resources associated with event processing
135 * @free: free resources associated with the session
138 int (*process_event
)(struct perf_session
*session
,
139 union perf_event
*event
,
140 struct perf_sample
*sample
,
141 struct perf_tool
*tool
);
142 int (*process_auxtrace_event
)(struct perf_session
*session
,
143 union perf_event
*event
,
144 struct perf_tool
*tool
);
145 int (*flush_events
)(struct perf_session
*session
,
146 struct perf_tool
*tool
);
147 void (*free_events
)(struct perf_session
*session
);
148 void (*free
)(struct perf_session
*session
);
152 * struct auxtrace_buffer - a buffer containing AUX area tracing data.
153 * @list: buffers are queued in a list held by struct auxtrace_queue
154 * @size: size of the buffer in bytes
155 * @pid: in per-thread mode, the pid this buffer is associated with
156 * @tid: in per-thread mode, the tid this buffer is associated with
157 * @cpu: in per-cpu mode, the cpu this buffer is associated with
158 * @data: actual buffer data (can be null if the data has not been loaded)
159 * @data_offset: file offset at which the buffer can be read
160 * @mmap_addr: mmap address at which the buffer can be read
161 * @mmap_size: size of the mmap at @mmap_addr
162 * @data_needs_freeing: @data was malloc'd so free it when it is no longer
164 * @consecutive: the original data was split up and this buffer is consecutive
165 * to the previous buffer
166 * @offset: offset as determined by aux_head / aux_tail members of struct
167 * perf_event_mmap_page
168 * @reference: an implementation-specific reference determined when the data is
170 * @buffer_nr: used to number each buffer
171 * @use_size: implementation actually only uses this number of bytes
172 * @use_data: implementation actually only uses data starting at this address
174 struct auxtrace_buffer
{
175 struct list_head list
;
184 bool data_needs_freeing
;
194 * struct auxtrace_queue - a queue of AUX area tracing data buffers.
195 * @head: head of buffer list
196 * @tid: in per-thread mode, the tid this queue is associated with
197 * @cpu: in per-cpu mode, the cpu this queue is associated with
198 * @set: %true once this queue has been dedicated to a specific thread or cpu
199 * @priv: implementation-specific data
201 struct auxtrace_queue
{
202 struct list_head head
;
210 * struct auxtrace_queues - an array of AUX area tracing queues.
211 * @queue_array: array of queues
212 * @nr_queues: number of queues
213 * @new_data: set whenever new data is queued
214 * @populated: queues have been fully populated using the auxtrace_index
215 * @next_buffer_nr: used to number each buffer
217 struct auxtrace_queues
{
218 struct auxtrace_queue
*queue_array
;
219 unsigned int nr_queues
;
226 * struct auxtrace_heap_item - element of struct auxtrace_heap.
227 * @queue_nr: queue number
228 * @ordinal: value used for sorting (lowest ordinal is top of the heap) expected
231 struct auxtrace_heap_item
{
232 unsigned int queue_nr
;
237 * struct auxtrace_heap - a heap suitable for sorting AUX area tracing queues.
238 * @heap_array: the heap
239 * @heap_cnt: the number of elements in the heap
240 * @heap_sz: maximum number of elements (grows as needed)
242 struct auxtrace_heap
{
243 struct auxtrace_heap_item
*heap_array
;
244 unsigned int heap_cnt
;
245 unsigned int heap_sz
;
249 * struct auxtrace_mmap - records an mmap of the auxtrace buffer.
250 * @base: address of mapped area
251 * @userpg: pointer to buffer's perf_event_mmap_page
252 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
253 * @len: size of mapped area
254 * @prev: previous aux_head
255 * @idx: index of this mmap
256 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
258 * @cpu: cpu number for a per-cpu mmap otherwise %-1
260 struct auxtrace_mmap
{
272 * struct auxtrace_mmap_params - parameters to set up struct auxtrace_mmap.
273 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
274 * @offset: file offset of mapped area
275 * @len: size of mapped area
276 * @prot: mmap memory protection
277 * @idx: index of this mmap
278 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
280 * @cpu: cpu number for a per-cpu mmap otherwise %-1
282 struct auxtrace_mmap_params
{
293 * struct auxtrace_record - callbacks for recording AUX area data.
294 * @recording_options: validate and process recording options
295 * @info_priv_size: return the size of the private data in auxtrace_info_event
296 * @info_fill: fill-in the private data in auxtrace_info_event
297 * @free: free this auxtrace record structure
298 * @snapshot_start: starting a snapshot
299 * @snapshot_finish: finishing a snapshot
300 * @find_snapshot: find data to snapshot within auxtrace mmap
301 * @parse_snapshot_options: parse snapshot options
302 * @reference: provide a 64-bit reference number for auxtrace_event
303 * @read_finish: called after reading from an auxtrace mmap
305 struct auxtrace_record
{
306 int (*recording_options
)(struct auxtrace_record
*itr
,
307 struct perf_evlist
*evlist
,
308 struct record_opts
*opts
);
309 size_t (*info_priv_size
)(struct auxtrace_record
*itr
,
310 struct perf_evlist
*evlist
);
311 int (*info_fill
)(struct auxtrace_record
*itr
,
312 struct perf_session
*session
,
313 struct auxtrace_info_event
*auxtrace_info
,
315 void (*free
)(struct auxtrace_record
*itr
);
316 int (*snapshot_start
)(struct auxtrace_record
*itr
);
317 int (*snapshot_finish
)(struct auxtrace_record
*itr
);
318 int (*find_snapshot
)(struct auxtrace_record
*itr
, int idx
,
319 struct auxtrace_mmap
*mm
, unsigned char *data
,
320 u64
*head
, u64
*old
);
321 int (*parse_snapshot_options
)(struct auxtrace_record
*itr
,
322 struct record_opts
*opts
,
324 u64 (*reference
)(struct auxtrace_record
*itr
);
325 int (*read_finish
)(struct auxtrace_record
*itr
, int idx
);
326 unsigned int alignment
;
330 * struct addr_filter - address filter.
332 * @range: true if it is a range filter
333 * @start: true if action is 'filter' or 'start'
334 * @action: 'filter', 'start' or 'stop' ('tracestop' is accepted but converted
336 * @sym_from: symbol name for the filter address
337 * @sym_to: symbol name that determines the filter size
338 * @sym_from_idx: selects n'th from symbols with the same name (0 means global
339 * and less than 0 means symbol must be unique)
340 * @sym_to_idx: same as @sym_from_idx but for @sym_to
341 * @addr: filter address
342 * @size: filter region size (for range filters)
343 * @filename: DSO file name or NULL for the kernel
344 * @str: allocated string that contains the other string members
347 struct list_head list
;
351 const char *sym_from
;
357 const char *filename
;
362 * struct addr_filters - list of address filters.
363 * @head: list of address filters
364 * @cnt: number of address filters
366 struct addr_filters
{
367 struct list_head head
;
371 #ifdef HAVE_AUXTRACE_SUPPORT
374 * In snapshot mode the mmapped page is read-only which makes using
375 * __sync_val_compare_and_swap() problematic. However, snapshot mode expects
376 * the buffer is not updated while the snapshot is made (e.g. Intel PT disables
377 * the event) so there is not a race anyway.
379 static inline u64
auxtrace_mmap__read_snapshot_head(struct auxtrace_mmap
*mm
)
381 struct perf_event_mmap_page
*pc
= mm
->userpg
;
382 u64 head
= READ_ONCE(pc
->aux_head
);
384 /* Ensure all reads are done after we read the head */
389 static inline u64
auxtrace_mmap__read_head(struct auxtrace_mmap
*mm
)
391 struct perf_event_mmap_page
*pc
= mm
->userpg
;
392 #if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
393 u64 head
= READ_ONCE(pc
->aux_head
);
395 u64 head
= __sync_val_compare_and_swap(&pc
->aux_head
, 0, 0);
398 /* Ensure all reads are done after we read the head */
403 static inline void auxtrace_mmap__write_tail(struct auxtrace_mmap
*mm
, u64 tail
)
405 struct perf_event_mmap_page
*pc
= mm
->userpg
;
406 #if BITS_PER_LONG != 64 && defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
410 /* Ensure all reads are done before we write the tail out */
412 #if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
416 old_tail
= __sync_val_compare_and_swap(&pc
->aux_tail
, 0, 0);
417 } while (!__sync_bool_compare_and_swap(&pc
->aux_tail
, old_tail
, tail
));
421 int auxtrace_mmap__mmap(struct auxtrace_mmap
*mm
,
422 struct auxtrace_mmap_params
*mp
,
423 void *userpg
, int fd
);
424 void auxtrace_mmap__munmap(struct auxtrace_mmap
*mm
);
425 void auxtrace_mmap_params__init(struct auxtrace_mmap_params
*mp
,
426 off_t auxtrace_offset
,
427 unsigned int auxtrace_pages
,
428 bool auxtrace_overwrite
);
429 void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params
*mp
,
430 struct perf_evlist
*evlist
, int idx
,
433 typedef int (*process_auxtrace_t
)(struct perf_tool
*tool
,
434 union perf_event
*event
, void *data1
,
435 size_t len1
, void *data2
, size_t len2
);
437 int auxtrace_mmap__read(struct auxtrace_mmap
*mm
, struct auxtrace_record
*itr
,
438 struct perf_tool
*tool
, process_auxtrace_t fn
);
440 int auxtrace_mmap__read_snapshot(struct auxtrace_mmap
*mm
,
441 struct auxtrace_record
*itr
,
442 struct perf_tool
*tool
, process_auxtrace_t fn
,
443 size_t snapshot_size
);
445 int auxtrace_queues__init(struct auxtrace_queues
*queues
);
446 int auxtrace_queues__add_event(struct auxtrace_queues
*queues
,
447 struct perf_session
*session
,
448 union perf_event
*event
, off_t data_offset
,
449 struct auxtrace_buffer
**buffer_ptr
);
450 void auxtrace_queues__free(struct auxtrace_queues
*queues
);
451 int auxtrace_queues__process_index(struct auxtrace_queues
*queues
,
452 struct perf_session
*session
);
453 struct auxtrace_buffer
*auxtrace_buffer__next(struct auxtrace_queue
*queue
,
454 struct auxtrace_buffer
*buffer
);
455 void *auxtrace_buffer__get_data(struct auxtrace_buffer
*buffer
, int fd
);
456 void auxtrace_buffer__put_data(struct auxtrace_buffer
*buffer
);
457 void auxtrace_buffer__drop_data(struct auxtrace_buffer
*buffer
);
458 void auxtrace_buffer__free(struct auxtrace_buffer
*buffer
);
460 int auxtrace_heap__add(struct auxtrace_heap
*heap
, unsigned int queue_nr
,
462 void auxtrace_heap__pop(struct auxtrace_heap
*heap
);
463 void auxtrace_heap__free(struct auxtrace_heap
*heap
);
465 struct auxtrace_cache_entry
{
466 struct hlist_node hash
;
470 struct auxtrace_cache
*auxtrace_cache__new(unsigned int bits
, size_t entry_size
,
471 unsigned int limit_percent
);
472 void auxtrace_cache__free(struct auxtrace_cache
*auxtrace_cache
);
473 void *auxtrace_cache__alloc_entry(struct auxtrace_cache
*c
);
474 void auxtrace_cache__free_entry(struct auxtrace_cache
*c
, void *entry
);
475 int auxtrace_cache__add(struct auxtrace_cache
*c
, u32 key
,
476 struct auxtrace_cache_entry
*entry
);
477 void *auxtrace_cache__lookup(struct auxtrace_cache
*c
, u32 key
);
479 struct auxtrace_record
*auxtrace_record__init(struct perf_evlist
*evlist
,
482 int auxtrace_parse_snapshot_options(struct auxtrace_record
*itr
,
483 struct record_opts
*opts
,
485 int auxtrace_record__options(struct auxtrace_record
*itr
,
486 struct perf_evlist
*evlist
,
487 struct record_opts
*opts
);
488 size_t auxtrace_record__info_priv_size(struct auxtrace_record
*itr
,
489 struct perf_evlist
*evlist
);
490 int auxtrace_record__info_fill(struct auxtrace_record
*itr
,
491 struct perf_session
*session
,
492 struct auxtrace_info_event
*auxtrace_info
,
494 void auxtrace_record__free(struct auxtrace_record
*itr
);
495 int auxtrace_record__snapshot_start(struct auxtrace_record
*itr
);
496 int auxtrace_record__snapshot_finish(struct auxtrace_record
*itr
);
497 int auxtrace_record__find_snapshot(struct auxtrace_record
*itr
, int idx
,
498 struct auxtrace_mmap
*mm
,
499 unsigned char *data
, u64
*head
, u64
*old
);
500 u64
auxtrace_record__reference(struct auxtrace_record
*itr
);
502 int auxtrace_index__auxtrace_event(struct list_head
*head
, union perf_event
*event
,
504 int auxtrace_index__write(int fd
, struct list_head
*head
);
505 int auxtrace_index__process(int fd
, u64 size
, struct perf_session
*session
,
507 void auxtrace_index__free(struct list_head
*head
);
509 void auxtrace_synth_error(struct auxtrace_error_event
*auxtrace_error
, int type
,
510 int code
, int cpu
, pid_t pid
, pid_t tid
, u64 ip
,
513 int perf_event__synthesize_auxtrace_info(struct auxtrace_record
*itr
,
514 struct perf_tool
*tool
,
515 struct perf_session
*session
,
516 perf_event__handler_t process
);
517 int perf_event__process_auxtrace_info(struct perf_tool
*tool
,
518 union perf_event
*event
,
519 struct perf_session
*session
);
520 s64
perf_event__process_auxtrace(struct perf_tool
*tool
,
521 union perf_event
*event
,
522 struct perf_session
*session
);
523 int perf_event__process_auxtrace_error(struct perf_tool
*tool
,
524 union perf_event
*event
,
525 struct perf_session
*session
);
526 int itrace_parse_synth_opts(const struct option
*opt
, const char *str
,
528 void itrace_synth_opts__set_default(struct itrace_synth_opts
*synth_opts
);
530 size_t perf_event__fprintf_auxtrace_error(union perf_event
*event
, FILE *fp
);
531 void perf_session__auxtrace_error_inc(struct perf_session
*session
,
532 union perf_event
*event
);
533 void events_stats__auxtrace_error_warn(const struct events_stats
*stats
);
535 void addr_filters__init(struct addr_filters
*filts
);
536 void addr_filters__exit(struct addr_filters
*filts
);
537 int addr_filters__parse_bare_filter(struct addr_filters
*filts
,
539 int auxtrace_parse_filters(struct perf_evlist
*evlist
);
541 static inline int auxtrace__process_event(struct perf_session
*session
,
542 union perf_event
*event
,
543 struct perf_sample
*sample
,
544 struct perf_tool
*tool
)
546 if (!session
->auxtrace
)
549 return session
->auxtrace
->process_event(session
, event
, sample
, tool
);
552 static inline int auxtrace__flush_events(struct perf_session
*session
,
553 struct perf_tool
*tool
)
555 if (!session
->auxtrace
)
558 return session
->auxtrace
->flush_events(session
, tool
);
561 static inline void auxtrace__free_events(struct perf_session
*session
)
563 if (!session
->auxtrace
)
566 return session
->auxtrace
->free_events(session
);
569 static inline void auxtrace__free(struct perf_session
*session
)
571 if (!session
->auxtrace
)
574 return session
->auxtrace
->free(session
);
579 static inline struct auxtrace_record
*
580 auxtrace_record__init(struct perf_evlist
*evlist __maybe_unused
,
588 void auxtrace_record__free(struct auxtrace_record
*itr __maybe_unused
)
593 perf_event__synthesize_auxtrace_info(struct auxtrace_record
*itr __maybe_unused
,
594 struct perf_tool
*tool __maybe_unused
,
595 struct perf_session
*session __maybe_unused
,
596 perf_event__handler_t process __maybe_unused
)
602 int auxtrace_record__options(struct auxtrace_record
*itr __maybe_unused
,
603 struct perf_evlist
*evlist __maybe_unused
,
604 struct record_opts
*opts __maybe_unused
)
609 #define perf_event__process_auxtrace_info 0
610 #define perf_event__process_auxtrace 0
611 #define perf_event__process_auxtrace_error 0
614 void perf_session__auxtrace_error_inc(struct perf_session
*session
616 union perf_event
*event
622 void events_stats__auxtrace_error_warn(const struct events_stats
*stats
628 int itrace_parse_synth_opts(const struct option
*opt __maybe_unused
,
629 const char *str __maybe_unused
,
630 int unset __maybe_unused
)
632 pr_err("AUX area tracing not supported\n");
637 int auxtrace_parse_snapshot_options(struct auxtrace_record
*itr __maybe_unused
,
638 struct record_opts
*opts __maybe_unused
,
643 pr_err("AUX area tracing not supported\n");
648 int auxtrace__process_event(struct perf_session
*session __maybe_unused
,
649 union perf_event
*event __maybe_unused
,
650 struct perf_sample
*sample __maybe_unused
,
651 struct perf_tool
*tool __maybe_unused
)
657 int auxtrace__flush_events(struct perf_session
*session __maybe_unused
,
658 struct perf_tool
*tool __maybe_unused
)
664 void auxtrace__free_events(struct perf_session
*session __maybe_unused
)
669 void auxtrace_cache__free(struct auxtrace_cache
*auxtrace_cache __maybe_unused
)
674 void auxtrace__free(struct perf_session
*session __maybe_unused
)
679 int auxtrace_index__write(int fd __maybe_unused
,
680 struct list_head
*head __maybe_unused
)
686 int auxtrace_index__process(int fd __maybe_unused
,
687 u64 size __maybe_unused
,
688 struct perf_session
*session __maybe_unused
,
689 bool needs_swap __maybe_unused
)
695 void auxtrace_index__free(struct list_head
*head __maybe_unused
)
700 int auxtrace_parse_filters(struct perf_evlist
*evlist __maybe_unused
)
705 int auxtrace_mmap__mmap(struct auxtrace_mmap
*mm
,
706 struct auxtrace_mmap_params
*mp
,
707 void *userpg
, int fd
);
708 void auxtrace_mmap__munmap(struct auxtrace_mmap
*mm
);
709 void auxtrace_mmap_params__init(struct auxtrace_mmap_params
*mp
,
710 off_t auxtrace_offset
,
711 unsigned int auxtrace_pages
,
712 bool auxtrace_overwrite
);
713 void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params
*mp
,
714 struct perf_evlist
*evlist
, int idx
,