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;
41 /* Auxtrace records must have the same alignment as perf event records */
42 #define PERF_AUXTRACE_RECORD_ALIGNMENT 8
45 PERF_AUXTRACE_UNKNOWN,
46 PERF_AUXTRACE_INTEL_PT,
47 PERF_AUXTRACE_INTEL_BTS,
51 enum itrace_period_type {
52 PERF_ITRACE_PERIOD_INSTRUCTIONS,
53 PERF_ITRACE_PERIOD_TICKS,
54 PERF_ITRACE_PERIOD_NANOSECS,
58 * struct itrace_synth_opts - AUX area tracing synthesis options.
59 * @set: indicates whether or not options have been set
60 * @inject: indicates the event (not just the sample) must be fully synthesized
61 * because 'perf inject' will write it out
62 * @instructions: whether to synthesize 'instructions' events
63 * @branches: whether to synthesize 'branches' events
64 * @transactions: whether to synthesize events for transactions
65 * @ptwrites: whether to synthesize events for ptwrites
66 * @pwr_events: whether to synthesize power events
67 * @errors: whether to synthesize decoder error events
68 * @dont_decode: whether to skip decoding entirely
69 * @log: write a decoding log
70 * @calls: limit branch samples to calls (can be combined with @returns)
71 * @returns: limit branch samples to returns (can be combined with @calls)
72 * @callchain: add callchain to 'instructions' events
73 * @thread_stack: feed branches to the thread_stack
74 * @last_branch: add branch context to 'instruction' events
75 * @callchain_sz: maximum callchain size
76 * @last_branch_sz: branch context size
77 * @period: 'instructions' events period
78 * @period_type: 'instructions' events period type
79 * @initial_skip: skip N events at the beginning.
80 * @cpu_bitmap: CPUs for which to synthesize events, or NULL for all
82 struct itrace_synth_opts {
98 unsigned int callchain_sz;
99 unsigned int last_branch_sz;
100 unsigned long long period;
101 enum itrace_period_type period_type;
102 unsigned long initial_skip;
103 unsigned long *cpu_bitmap;
107 * struct auxtrace_index_entry - indexes a AUX area tracing event within a
109 * @file_offset: offset within the perf.data file
110 * @sz: size of the event
112 struct auxtrace_index_entry {
117 #define PERF_AUXTRACE_INDEX_ENTRY_COUNT 256
120 * struct auxtrace_index - index of AUX area tracing events within a perf.data
122 * @list: linking a number of arrays of entries
123 * @nr: number of entries
124 * @entries: array of entries
126 struct auxtrace_index {
127 struct list_head list;
129 struct auxtrace_index_entry entries[PERF_AUXTRACE_INDEX_ENTRY_COUNT];
133 * struct auxtrace - session callbacks to allow AUX area data decoding.
134 * @process_event: lets the decoder see all session events
135 * @flush_events: process any remaining data
136 * @free_events: free resources associated with event processing
137 * @free: free resources associated with the session
140 int (*process_event)(struct perf_session *session,
141 union perf_event *event,
142 struct perf_sample *sample,
143 struct perf_tool *tool);
144 int (*process_auxtrace_event)(struct perf_session *session,
145 union perf_event *event,
146 struct perf_tool *tool);
147 int (*flush_events)(struct perf_session *session,
148 struct perf_tool *tool);
149 void (*free_events)(struct perf_session *session);
150 void (*free)(struct perf_session *session);
154 * struct auxtrace_buffer - a buffer containing AUX area tracing data.
155 * @list: buffers are queued in a list held by struct auxtrace_queue
156 * @size: size of the buffer in bytes
157 * @pid: in per-thread mode, the pid this buffer is associated with
158 * @tid: in per-thread mode, the tid this buffer is associated with
159 * @cpu: in per-cpu mode, the cpu this buffer is associated with
160 * @data: actual buffer data (can be null if the data has not been loaded)
161 * @data_offset: file offset at which the buffer can be read
162 * @mmap_addr: mmap address at which the buffer can be read
163 * @mmap_size: size of the mmap at @mmap_addr
164 * @data_needs_freeing: @data was malloc'd so free it when it is no longer
166 * @consecutive: the original data was split up and this buffer is consecutive
167 * to the previous buffer
168 * @offset: offset as determined by aux_head / aux_tail members of struct
169 * perf_event_mmap_page
170 * @reference: an implementation-specific reference determined when the data is
172 * @buffer_nr: used to number each buffer
173 * @use_size: implementation actually only uses this number of bytes
174 * @use_data: implementation actually only uses data starting at this address
176 struct auxtrace_buffer {
177 struct list_head list;
186 bool data_needs_freeing;
196 * struct auxtrace_queue - a queue of AUX area tracing data buffers.
197 * @head: head of buffer list
198 * @tid: in per-thread mode, the tid this queue is associated with
199 * @cpu: in per-cpu mode, the cpu this queue is associated with
200 * @set: %true once this queue has been dedicated to a specific thread or cpu
201 * @priv: implementation-specific data
203 struct auxtrace_queue {
204 struct list_head head;
212 * struct auxtrace_queues - an array of AUX area tracing queues.
213 * @queue_array: array of queues
214 * @nr_queues: number of queues
215 * @new_data: set whenever new data is queued
216 * @populated: queues have been fully populated using the auxtrace_index
217 * @next_buffer_nr: used to number each buffer
219 struct auxtrace_queues {
220 struct auxtrace_queue *queue_array;
221 unsigned int nr_queues;
228 * struct auxtrace_heap_item - element of struct auxtrace_heap.
229 * @queue_nr: queue number
230 * @ordinal: value used for sorting (lowest ordinal is top of the heap) expected
233 struct auxtrace_heap_item {
234 unsigned int queue_nr;
239 * struct auxtrace_heap - a heap suitable for sorting AUX area tracing queues.
240 * @heap_array: the heap
241 * @heap_cnt: the number of elements in the heap
242 * @heap_sz: maximum number of elements (grows as needed)
244 struct auxtrace_heap {
245 struct auxtrace_heap_item *heap_array;
246 unsigned int heap_cnt;
247 unsigned int heap_sz;
251 * struct auxtrace_mmap - records an mmap of the auxtrace buffer.
252 * @base: address of mapped area
253 * @userpg: pointer to buffer's perf_event_mmap_page
254 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
255 * @len: size of mapped area
256 * @prev: previous aux_head
257 * @idx: index of this mmap
258 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
260 * @cpu: cpu number for a per-cpu mmap otherwise %-1
262 struct auxtrace_mmap {
274 * struct auxtrace_mmap_params - parameters to set up struct auxtrace_mmap.
275 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
276 * @offset: file offset of mapped area
277 * @len: size of mapped area
278 * @prot: mmap memory protection
279 * @idx: index of this mmap
280 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
282 * @cpu: cpu number for a per-cpu mmap otherwise %-1
284 struct auxtrace_mmap_params {
295 * struct auxtrace_record - callbacks for recording AUX area data.
296 * @recording_options: validate and process recording options
297 * @info_priv_size: return the size of the private data in auxtrace_info_event
298 * @info_fill: fill-in the private data in auxtrace_info_event
299 * @free: free this auxtrace record structure
300 * @snapshot_start: starting a snapshot
301 * @snapshot_finish: finishing a snapshot
302 * @find_snapshot: find data to snapshot within auxtrace mmap
303 * @parse_snapshot_options: parse snapshot options
304 * @reference: provide a 64-bit reference number for auxtrace_event
305 * @read_finish: called after reading from an auxtrace mmap
307 struct auxtrace_record {
308 int (*recording_options)(struct auxtrace_record *itr,
309 struct perf_evlist *evlist,
310 struct record_opts *opts);
311 size_t (*info_priv_size)(struct auxtrace_record *itr,
312 struct perf_evlist *evlist);
313 int (*info_fill)(struct auxtrace_record *itr,
314 struct perf_session *session,
315 struct auxtrace_info_event *auxtrace_info,
317 void (*free)(struct auxtrace_record *itr);
318 int (*snapshot_start)(struct auxtrace_record *itr);
319 int (*snapshot_finish)(struct auxtrace_record *itr);
320 int (*find_snapshot)(struct auxtrace_record *itr, int idx,
321 struct auxtrace_mmap *mm, unsigned char *data,
322 u64 *head, u64 *old);
323 int (*parse_snapshot_options)(struct auxtrace_record *itr,
324 struct record_opts *opts,
326 u64 (*reference)(struct auxtrace_record *itr);
327 int (*read_finish)(struct auxtrace_record *itr, int idx);
328 unsigned int alignment;
332 * struct addr_filter - address filter.
334 * @range: true if it is a range filter
335 * @start: true if action is 'filter' or 'start'
336 * @action: 'filter', 'start' or 'stop' ('tracestop' is accepted but converted
338 * @sym_from: symbol name for the filter address
339 * @sym_to: symbol name that determines the filter size
340 * @sym_from_idx: selects n'th from symbols with the same name (0 means global
341 * and less than 0 means symbol must be unique)
342 * @sym_to_idx: same as @sym_from_idx but for @sym_to
343 * @addr: filter address
344 * @size: filter region size (for range filters)
345 * @filename: DSO file name or NULL for the kernel
346 * @str: allocated string that contains the other string members
349 struct list_head list;
353 const char *sym_from;
359 const char *filename;
364 * struct addr_filters - list of address filters.
365 * @head: list of address filters
366 * @cnt: number of address filters
368 struct addr_filters {
369 struct list_head head;
373 #ifdef HAVE_AUXTRACE_SUPPORT
376 * In snapshot mode the mmapped page is read-only which makes using
377 * __sync_val_compare_and_swap() problematic. However, snapshot mode expects
378 * the buffer is not updated while the snapshot is made (e.g. Intel PT disables
379 * the event) so there is not a race anyway.
381 static inline u64 auxtrace_mmap__read_snapshot_head(struct auxtrace_mmap *mm)
383 struct perf_event_mmap_page *pc = mm->userpg;
384 u64 head = ACCESS_ONCE(pc->aux_head);
386 /* Ensure all reads are done after we read the head */
391 static inline u64 auxtrace_mmap__read_head(struct auxtrace_mmap *mm)
393 struct perf_event_mmap_page *pc = mm->userpg;
394 #if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
395 u64 head = ACCESS_ONCE(pc->aux_head);
397 u64 head = __sync_val_compare_and_swap(&pc->aux_head, 0, 0);
400 /* Ensure all reads are done after we read the head */
405 static inline void auxtrace_mmap__write_tail(struct auxtrace_mmap *mm, u64 tail)
407 struct perf_event_mmap_page *pc = mm->userpg;
408 #if BITS_PER_LONG != 64 && defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
412 /* Ensure all reads are done before we write the tail out */
414 #if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
418 old_tail = __sync_val_compare_and_swap(&pc->aux_tail, 0, 0);
419 } while (!__sync_bool_compare_and_swap(&pc->aux_tail, old_tail, tail));
423 int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
424 struct auxtrace_mmap_params *mp,
425 void *userpg, int fd);
426 void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
427 void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
428 off_t auxtrace_offset,
429 unsigned int auxtrace_pages,
430 bool auxtrace_overwrite);
431 void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
432 struct perf_evlist *evlist, int idx,
435 typedef int (*process_auxtrace_t)(struct perf_tool *tool,
436 union perf_event *event, void *data1,
437 size_t len1, void *data2, size_t len2);
439 int auxtrace_mmap__read(struct auxtrace_mmap *mm, struct auxtrace_record *itr,
440 struct perf_tool *tool, process_auxtrace_t fn);
442 int auxtrace_mmap__read_snapshot(struct auxtrace_mmap *mm,
443 struct auxtrace_record *itr,
444 struct perf_tool *tool, process_auxtrace_t fn,
445 size_t snapshot_size);
447 int auxtrace_queues__init(struct auxtrace_queues *queues);
448 int auxtrace_queues__add_event(struct auxtrace_queues *queues,
449 struct perf_session *session,
450 union perf_event *event, off_t data_offset,
451 struct auxtrace_buffer **buffer_ptr);
452 void auxtrace_queues__free(struct auxtrace_queues *queues);
453 int auxtrace_queues__process_index(struct auxtrace_queues *queues,
454 struct perf_session *session);
455 struct auxtrace_buffer *auxtrace_buffer__next(struct auxtrace_queue *queue,
456 struct auxtrace_buffer *buffer);
457 void *auxtrace_buffer__get_data(struct auxtrace_buffer *buffer, int fd);
458 void auxtrace_buffer__put_data(struct auxtrace_buffer *buffer);
459 void auxtrace_buffer__drop_data(struct auxtrace_buffer *buffer);
460 void auxtrace_buffer__free(struct auxtrace_buffer *buffer);
462 int auxtrace_heap__add(struct auxtrace_heap *heap, unsigned int queue_nr,
464 void auxtrace_heap__pop(struct auxtrace_heap *heap);
465 void auxtrace_heap__free(struct auxtrace_heap *heap);
467 struct auxtrace_cache_entry {
468 struct hlist_node hash;
472 struct auxtrace_cache *auxtrace_cache__new(unsigned int bits, size_t entry_size,
473 unsigned int limit_percent);
474 void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache);
475 void *auxtrace_cache__alloc_entry(struct auxtrace_cache *c);
476 void auxtrace_cache__free_entry(struct auxtrace_cache *c, void *entry);
477 int auxtrace_cache__add(struct auxtrace_cache *c, u32 key,
478 struct auxtrace_cache_entry *entry);
479 void *auxtrace_cache__lookup(struct auxtrace_cache *c, u32 key);
481 struct auxtrace_record *auxtrace_record__init(struct perf_evlist *evlist,
484 int auxtrace_parse_snapshot_options(struct auxtrace_record *itr,
485 struct record_opts *opts,
487 int auxtrace_record__options(struct auxtrace_record *itr,
488 struct perf_evlist *evlist,
489 struct record_opts *opts);
490 size_t auxtrace_record__info_priv_size(struct auxtrace_record *itr,
491 struct perf_evlist *evlist);
492 int auxtrace_record__info_fill(struct auxtrace_record *itr,
493 struct perf_session *session,
494 struct auxtrace_info_event *auxtrace_info,
496 void auxtrace_record__free(struct auxtrace_record *itr);
497 int auxtrace_record__snapshot_start(struct auxtrace_record *itr);
498 int auxtrace_record__snapshot_finish(struct auxtrace_record *itr);
499 int auxtrace_record__find_snapshot(struct auxtrace_record *itr, int idx,
500 struct auxtrace_mmap *mm,
501 unsigned char *data, u64 *head, u64 *old);
502 u64 auxtrace_record__reference(struct auxtrace_record *itr);
504 int auxtrace_index__auxtrace_event(struct list_head *head, union perf_event *event,
506 int auxtrace_index__write(int fd, struct list_head *head);
507 int auxtrace_index__process(int fd, u64 size, struct perf_session *session,
509 void auxtrace_index__free(struct list_head *head);
511 void auxtrace_synth_error(struct auxtrace_error_event *auxtrace_error, int type,
512 int code, int cpu, pid_t pid, pid_t tid, u64 ip,
515 int perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr,
516 struct perf_tool *tool,
517 struct perf_session *session,
518 perf_event__handler_t process);
519 int perf_event__process_auxtrace_info(struct perf_tool *tool,
520 union perf_event *event,
521 struct perf_session *session);
522 s64 perf_event__process_auxtrace(struct perf_tool *tool,
523 union perf_event *event,
524 struct perf_session *session);
525 int perf_event__process_auxtrace_error(struct perf_tool *tool,
526 union perf_event *event,
527 struct perf_session *session);
528 int itrace_parse_synth_opts(const struct option *opt, const char *str,
530 void itrace_synth_opts__set_default(struct itrace_synth_opts *synth_opts);
532 size_t perf_event__fprintf_auxtrace_error(union perf_event *event, FILE *fp);
533 void perf_session__auxtrace_error_inc(struct perf_session *session,
534 union perf_event *event);
535 void events_stats__auxtrace_error_warn(const struct events_stats *stats);
537 void addr_filters__init(struct addr_filters *filts);
538 void addr_filters__exit(struct addr_filters *filts);
539 int addr_filters__parse_bare_filter(struct addr_filters *filts,
541 int auxtrace_parse_filters(struct perf_evlist *evlist);
543 static inline int auxtrace__process_event(struct perf_session *session,
544 union perf_event *event,
545 struct perf_sample *sample,
546 struct perf_tool *tool)
548 if (!session->auxtrace)
551 return session->auxtrace->process_event(session, event, sample, tool);
554 static inline int auxtrace__flush_events(struct perf_session *session,
555 struct perf_tool *tool)
557 if (!session->auxtrace)
560 return session->auxtrace->flush_events(session, tool);
563 static inline void auxtrace__free_events(struct perf_session *session)
565 if (!session->auxtrace)
568 return session->auxtrace->free_events(session);
571 static inline void auxtrace__free(struct perf_session *session)
573 if (!session->auxtrace)
576 return session->auxtrace->free(session);
581 static inline struct auxtrace_record *
582 auxtrace_record__init(struct perf_evlist *evlist __maybe_unused,
590 void auxtrace_record__free(struct auxtrace_record *itr __maybe_unused)
595 perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr __maybe_unused,
596 struct perf_tool *tool __maybe_unused,
597 struct perf_session *session __maybe_unused,
598 perf_event__handler_t process __maybe_unused)
604 int auxtrace_record__options(struct auxtrace_record *itr __maybe_unused,
605 struct perf_evlist *evlist __maybe_unused,
606 struct record_opts *opts __maybe_unused)
611 #define perf_event__process_auxtrace_info 0
612 #define perf_event__process_auxtrace 0
613 #define perf_event__process_auxtrace_error 0
616 void perf_session__auxtrace_error_inc(struct perf_session *session
618 union perf_event *event
624 void events_stats__auxtrace_error_warn(const struct events_stats *stats
630 int itrace_parse_synth_opts(const struct option *opt __maybe_unused,
631 const char *str __maybe_unused,
632 int unset __maybe_unused)
634 pr_err("AUX area tracing not supported\n");
639 int auxtrace_parse_snapshot_options(struct auxtrace_record *itr __maybe_unused,
640 struct record_opts *opts __maybe_unused,
645 pr_err("AUX area tracing not supported\n");
650 int auxtrace__process_event(struct perf_session *session __maybe_unused,
651 union perf_event *event __maybe_unused,
652 struct perf_sample *sample __maybe_unused,
653 struct perf_tool *tool __maybe_unused)
659 int auxtrace__flush_events(struct perf_session *session __maybe_unused,
660 struct perf_tool *tool __maybe_unused)
666 void auxtrace__free_events(struct perf_session *session __maybe_unused)
671 void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache __maybe_unused)
676 void auxtrace__free(struct perf_session *session __maybe_unused)
681 int auxtrace_index__write(int fd __maybe_unused,
682 struct list_head *head __maybe_unused)
688 int auxtrace_index__process(int fd __maybe_unused,
689 u64 size __maybe_unused,
690 struct perf_session *session __maybe_unused,
691 bool needs_swap __maybe_unused)
697 void auxtrace_index__free(struct list_head *head __maybe_unused)
702 int auxtrace_parse_filters(struct perf_evlist *evlist __maybe_unused)
707 int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
708 struct auxtrace_mmap_params *mp,
709 void *userpg, int fd);
710 void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
711 void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
712 off_t auxtrace_offset,
713 unsigned int auxtrace_pages,
714 bool auxtrace_overwrite);
715 void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
716 struct perf_evlist *evlist, int idx,