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,
49 PERF_AUXTRACE_ARM_SPE,
50 PERF_AUXTRACE_S390_CPUMSF,
53 enum itrace_period_type {
54 PERF_ITRACE_PERIOD_INSTRUCTIONS,
55 PERF_ITRACE_PERIOD_TICKS,
56 PERF_ITRACE_PERIOD_NANOSECS,
60 * struct itrace_synth_opts - AUX area tracing synthesis options.
61 * @set: indicates whether or not options have been set
62 * @inject: indicates the event (not just the sample) must be fully synthesized
63 * because 'perf inject' will write it out
64 * @instructions: whether to synthesize 'instructions' events
65 * @branches: whether to synthesize 'branches' events
66 * @transactions: whether to synthesize events for transactions
67 * @ptwrites: whether to synthesize events for ptwrites
68 * @pwr_events: whether to synthesize power events
69 * @errors: whether to synthesize decoder error events
70 * @dont_decode: whether to skip decoding entirely
71 * @log: write a decoding log
72 * @calls: limit branch samples to calls (can be combined with @returns)
73 * @returns: limit branch samples to returns (can be combined with @calls)
74 * @callchain: add callchain to 'instructions' events
75 * @thread_stack: feed branches to the thread_stack
76 * @last_branch: add branch context to 'instruction' events
77 * @callchain_sz: maximum callchain size
78 * @last_branch_sz: branch context size
79 * @period: 'instructions' events period
80 * @period_type: 'instructions' events period type
81 * @initial_skip: skip N events at the beginning.
82 * @cpu_bitmap: CPUs for which to synthesize events, or NULL for all
84 struct itrace_synth_opts {
100 unsigned int callchain_sz;
101 unsigned int last_branch_sz;
102 unsigned long long period;
103 enum itrace_period_type period_type;
104 unsigned long initial_skip;
105 unsigned long *cpu_bitmap;
109 * struct auxtrace_index_entry - indexes a AUX area tracing event within a
111 * @file_offset: offset within the perf.data file
112 * @sz: size of the event
114 struct auxtrace_index_entry {
119 #define PERF_AUXTRACE_INDEX_ENTRY_COUNT 256
122 * struct auxtrace_index - index of AUX area tracing events within a perf.data
124 * @list: linking a number of arrays of entries
125 * @nr: number of entries
126 * @entries: array of entries
128 struct auxtrace_index {
129 struct list_head list;
131 struct auxtrace_index_entry entries[PERF_AUXTRACE_INDEX_ENTRY_COUNT];
135 * struct auxtrace - session callbacks to allow AUX area data decoding.
136 * @process_event: lets the decoder see all session events
137 * @process_auxtrace_event: process a PERF_RECORD_AUXTRACE event
138 * @flush_events: process any remaining data
139 * @free_events: free resources associated with event processing
140 * @free: free resources associated with the session
143 int (*process_event)(struct perf_session *session,
144 union perf_event *event,
145 struct perf_sample *sample,
146 struct perf_tool *tool);
147 int (*process_auxtrace_event)(struct perf_session *session,
148 union perf_event *event,
149 struct perf_tool *tool);
150 int (*flush_events)(struct perf_session *session,
151 struct perf_tool *tool);
152 void (*free_events)(struct perf_session *session);
153 void (*free)(struct perf_session *session);
157 * struct auxtrace_buffer - a buffer containing AUX area tracing data.
158 * @list: buffers are queued in a list held by struct auxtrace_queue
159 * @size: size of the buffer in bytes
160 * @pid: in per-thread mode, the pid this buffer is associated with
161 * @tid: in per-thread mode, the tid this buffer is associated with
162 * @cpu: in per-cpu mode, the cpu this buffer is associated with
163 * @data: actual buffer data (can be null if the data has not been loaded)
164 * @data_offset: file offset at which the buffer can be read
165 * @mmap_addr: mmap address at which the buffer can be read
166 * @mmap_size: size of the mmap at @mmap_addr
167 * @data_needs_freeing: @data was malloc'd so free it when it is no longer
169 * @consecutive: the original data was split up and this buffer is consecutive
170 * to the previous buffer
171 * @offset: offset as determined by aux_head / aux_tail members of struct
172 * perf_event_mmap_page
173 * @reference: an implementation-specific reference determined when the data is
175 * @buffer_nr: used to number each buffer
176 * @use_size: implementation actually only uses this number of bytes
177 * @use_data: implementation actually only uses data starting at this address
179 struct auxtrace_buffer {
180 struct list_head list;
189 bool data_needs_freeing;
199 * struct auxtrace_queue - a queue of AUX area tracing data buffers.
200 * @head: head of buffer list
201 * @tid: in per-thread mode, the tid this queue is associated with
202 * @cpu: in per-cpu mode, the cpu this queue is associated with
203 * @set: %true once this queue has been dedicated to a specific thread or cpu
204 * @priv: implementation-specific data
206 struct auxtrace_queue {
207 struct list_head head;
215 * struct auxtrace_queues - an array of AUX area tracing queues.
216 * @queue_array: array of queues
217 * @nr_queues: number of queues
218 * @new_data: set whenever new data is queued
219 * @populated: queues have been fully populated using the auxtrace_index
220 * @next_buffer_nr: used to number each buffer
222 struct auxtrace_queues {
223 struct auxtrace_queue *queue_array;
224 unsigned int nr_queues;
231 * struct auxtrace_heap_item - element of struct auxtrace_heap.
232 * @queue_nr: queue number
233 * @ordinal: value used for sorting (lowest ordinal is top of the heap) expected
236 struct auxtrace_heap_item {
237 unsigned int queue_nr;
242 * struct auxtrace_heap - a heap suitable for sorting AUX area tracing queues.
243 * @heap_array: the heap
244 * @heap_cnt: the number of elements in the heap
245 * @heap_sz: maximum number of elements (grows as needed)
247 struct auxtrace_heap {
248 struct auxtrace_heap_item *heap_array;
249 unsigned int heap_cnt;
250 unsigned int heap_sz;
254 * struct auxtrace_mmap - records an mmap of the auxtrace buffer.
255 * @base: address of mapped area
256 * @userpg: pointer to buffer's perf_event_mmap_page
257 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
258 * @len: size of mapped area
259 * @prev: previous aux_head
260 * @idx: index of this mmap
261 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
263 * @cpu: cpu number for a per-cpu mmap otherwise %-1
265 struct auxtrace_mmap {
277 * struct auxtrace_mmap_params - parameters to set up struct auxtrace_mmap.
278 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
279 * @offset: file offset of mapped area
280 * @len: size of mapped area
281 * @prot: mmap memory protection
282 * @idx: index of this mmap
283 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
285 * @cpu: cpu number for a per-cpu mmap otherwise %-1
287 struct auxtrace_mmap_params {
298 * struct auxtrace_record - callbacks for recording AUX area data.
299 * @recording_options: validate and process recording options
300 * @info_priv_size: return the size of the private data in auxtrace_info_event
301 * @info_fill: fill-in the private data in auxtrace_info_event
302 * @free: free this auxtrace record structure
303 * @snapshot_start: starting a snapshot
304 * @snapshot_finish: finishing a snapshot
305 * @find_snapshot: find data to snapshot within auxtrace mmap
306 * @parse_snapshot_options: parse snapshot options
307 * @reference: provide a 64-bit reference number for auxtrace_event
308 * @read_finish: called after reading from an auxtrace mmap
309 * @alignment: alignment (if any) for AUX area data
311 struct auxtrace_record {
312 int (*recording_options)(struct auxtrace_record *itr,
313 struct perf_evlist *evlist,
314 struct record_opts *opts);
315 size_t (*info_priv_size)(struct auxtrace_record *itr,
316 struct perf_evlist *evlist);
317 int (*info_fill)(struct auxtrace_record *itr,
318 struct perf_session *session,
319 struct auxtrace_info_event *auxtrace_info,
321 void (*free)(struct auxtrace_record *itr);
322 int (*snapshot_start)(struct auxtrace_record *itr);
323 int (*snapshot_finish)(struct auxtrace_record *itr);
324 int (*find_snapshot)(struct auxtrace_record *itr, int idx,
325 struct auxtrace_mmap *mm, unsigned char *data,
326 u64 *head, u64 *old);
327 int (*parse_snapshot_options)(struct auxtrace_record *itr,
328 struct record_opts *opts,
330 u64 (*reference)(struct auxtrace_record *itr);
331 int (*read_finish)(struct auxtrace_record *itr, int idx);
332 unsigned int alignment;
336 * struct addr_filter - address filter.
338 * @range: true if it is a range filter
339 * @start: true if action is 'filter' or 'start'
340 * @action: 'filter', 'start' or 'stop' ('tracestop' is accepted but converted
342 * @sym_from: symbol name for the filter address
343 * @sym_to: symbol name that determines the filter size
344 * @sym_from_idx: selects n'th from symbols with the same name (0 means global
345 * and less than 0 means symbol must be unique)
346 * @sym_to_idx: same as @sym_from_idx but for @sym_to
347 * @addr: filter address
348 * @size: filter region size (for range filters)
349 * @filename: DSO file name or NULL for the kernel
350 * @str: allocated string that contains the other string members
353 struct list_head list;
357 const char *sym_from;
363 const char *filename;
368 * struct addr_filters - list of address filters.
369 * @head: list of address filters
370 * @cnt: number of address filters
372 struct addr_filters {
373 struct list_head head;
377 #ifdef HAVE_AUXTRACE_SUPPORT
380 * In snapshot mode the mmapped page is read-only which makes using
381 * __sync_val_compare_and_swap() problematic. However, snapshot mode expects
382 * the buffer is not updated while the snapshot is made (e.g. Intel PT disables
383 * the event) so there is not a race anyway.
385 static inline u64 auxtrace_mmap__read_snapshot_head(struct auxtrace_mmap *mm)
387 struct perf_event_mmap_page *pc = mm->userpg;
388 u64 head = READ_ONCE(pc->aux_head);
390 /* Ensure all reads are done after we read the head */
395 static inline u64 auxtrace_mmap__read_head(struct auxtrace_mmap *mm)
397 struct perf_event_mmap_page *pc = mm->userpg;
398 #if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
399 u64 head = READ_ONCE(pc->aux_head);
401 u64 head = __sync_val_compare_and_swap(&pc->aux_head, 0, 0);
404 /* Ensure all reads are done after we read the head */
409 static inline void auxtrace_mmap__write_tail(struct auxtrace_mmap *mm, u64 tail)
411 struct perf_event_mmap_page *pc = mm->userpg;
412 #if BITS_PER_LONG != 64 && defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
416 /* Ensure all reads are done before we write the tail out */
418 #if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
422 old_tail = __sync_val_compare_and_swap(&pc->aux_tail, 0, 0);
423 } while (!__sync_bool_compare_and_swap(&pc->aux_tail, old_tail, tail));
427 int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
428 struct auxtrace_mmap_params *mp,
429 void *userpg, int fd);
430 void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
431 void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
432 off_t auxtrace_offset,
433 unsigned int auxtrace_pages,
434 bool auxtrace_overwrite);
435 void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
436 struct perf_evlist *evlist, int idx,
439 typedef int (*process_auxtrace_t)(struct perf_tool *tool,
440 union perf_event *event, void *data1,
441 size_t len1, void *data2, size_t len2);
443 int auxtrace_mmap__read(struct auxtrace_mmap *mm, struct auxtrace_record *itr,
444 struct perf_tool *tool, process_auxtrace_t fn);
446 int auxtrace_mmap__read_snapshot(struct auxtrace_mmap *mm,
447 struct auxtrace_record *itr,
448 struct perf_tool *tool, process_auxtrace_t fn,
449 size_t snapshot_size);
451 int auxtrace_queues__init(struct auxtrace_queues *queues);
452 int auxtrace_queues__add_event(struct auxtrace_queues *queues,
453 struct perf_session *session,
454 union perf_event *event, off_t data_offset,
455 struct auxtrace_buffer **buffer_ptr);
456 void auxtrace_queues__free(struct auxtrace_queues *queues);
457 int auxtrace_queues__process_index(struct auxtrace_queues *queues,
458 struct perf_session *session);
459 struct auxtrace_buffer *auxtrace_buffer__next(struct auxtrace_queue *queue,
460 struct auxtrace_buffer *buffer);
461 void *auxtrace_buffer__get_data(struct auxtrace_buffer *buffer, int fd);
462 void auxtrace_buffer__put_data(struct auxtrace_buffer *buffer);
463 void auxtrace_buffer__drop_data(struct auxtrace_buffer *buffer);
464 void auxtrace_buffer__free(struct auxtrace_buffer *buffer);
466 int auxtrace_heap__add(struct auxtrace_heap *heap, unsigned int queue_nr,
468 void auxtrace_heap__pop(struct auxtrace_heap *heap);
469 void auxtrace_heap__free(struct auxtrace_heap *heap);
471 struct auxtrace_cache_entry {
472 struct hlist_node hash;
476 struct auxtrace_cache *auxtrace_cache__new(unsigned int bits, size_t entry_size,
477 unsigned int limit_percent);
478 void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache);
479 void *auxtrace_cache__alloc_entry(struct auxtrace_cache *c);
480 void auxtrace_cache__free_entry(struct auxtrace_cache *c, void *entry);
481 int auxtrace_cache__add(struct auxtrace_cache *c, u32 key,
482 struct auxtrace_cache_entry *entry);
483 void *auxtrace_cache__lookup(struct auxtrace_cache *c, u32 key);
485 struct auxtrace_record *auxtrace_record__init(struct perf_evlist *evlist,
488 int auxtrace_parse_snapshot_options(struct auxtrace_record *itr,
489 struct record_opts *opts,
491 int auxtrace_record__options(struct auxtrace_record *itr,
492 struct perf_evlist *evlist,
493 struct record_opts *opts);
494 size_t auxtrace_record__info_priv_size(struct auxtrace_record *itr,
495 struct perf_evlist *evlist);
496 int auxtrace_record__info_fill(struct auxtrace_record *itr,
497 struct perf_session *session,
498 struct auxtrace_info_event *auxtrace_info,
500 void auxtrace_record__free(struct auxtrace_record *itr);
501 int auxtrace_record__snapshot_start(struct auxtrace_record *itr);
502 int auxtrace_record__snapshot_finish(struct auxtrace_record *itr);
503 int auxtrace_record__find_snapshot(struct auxtrace_record *itr, int idx,
504 struct auxtrace_mmap *mm,
505 unsigned char *data, u64 *head, u64 *old);
506 u64 auxtrace_record__reference(struct auxtrace_record *itr);
508 int auxtrace_index__auxtrace_event(struct list_head *head, union perf_event *event,
510 int auxtrace_index__write(int fd, struct list_head *head);
511 int auxtrace_index__process(int fd, u64 size, struct perf_session *session,
513 void auxtrace_index__free(struct list_head *head);
515 void auxtrace_synth_error(struct auxtrace_error_event *auxtrace_error, int type,
516 int code, int cpu, pid_t pid, pid_t tid, u64 ip,
519 int perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr,
520 struct perf_tool *tool,
521 struct perf_session *session,
522 perf_event__handler_t process);
523 int perf_event__process_auxtrace_info(struct perf_tool *tool,
524 union perf_event *event,
525 struct perf_session *session);
526 s64 perf_event__process_auxtrace(struct perf_tool *tool,
527 union perf_event *event,
528 struct perf_session *session);
529 int perf_event__process_auxtrace_error(struct perf_tool *tool,
530 union perf_event *event,
531 struct perf_session *session);
532 int itrace_parse_synth_opts(const struct option *opt, const char *str,
534 void itrace_synth_opts__set_default(struct itrace_synth_opts *synth_opts);
536 size_t perf_event__fprintf_auxtrace_error(union perf_event *event, FILE *fp);
537 void perf_session__auxtrace_error_inc(struct perf_session *session,
538 union perf_event *event);
539 void events_stats__auxtrace_error_warn(const struct events_stats *stats);
541 void addr_filters__init(struct addr_filters *filts);
542 void addr_filters__exit(struct addr_filters *filts);
543 int addr_filters__parse_bare_filter(struct addr_filters *filts,
545 int auxtrace_parse_filters(struct perf_evlist *evlist);
547 static inline int auxtrace__process_event(struct perf_session *session,
548 union perf_event *event,
549 struct perf_sample *sample,
550 struct perf_tool *tool)
552 if (!session->auxtrace)
555 return session->auxtrace->process_event(session, event, sample, tool);
558 static inline int auxtrace__flush_events(struct perf_session *session,
559 struct perf_tool *tool)
561 if (!session->auxtrace)
564 return session->auxtrace->flush_events(session, tool);
567 static inline void auxtrace__free_events(struct perf_session *session)
569 if (!session->auxtrace)
572 return session->auxtrace->free_events(session);
575 static inline void auxtrace__free(struct perf_session *session)
577 if (!session->auxtrace)
580 return session->auxtrace->free(session);
585 static inline struct auxtrace_record *
586 auxtrace_record__init(struct perf_evlist *evlist __maybe_unused,
594 void auxtrace_record__free(struct auxtrace_record *itr __maybe_unused)
599 perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr __maybe_unused,
600 struct perf_tool *tool __maybe_unused,
601 struct perf_session *session __maybe_unused,
602 perf_event__handler_t process __maybe_unused)
608 int auxtrace_record__options(struct auxtrace_record *itr __maybe_unused,
609 struct perf_evlist *evlist __maybe_unused,
610 struct record_opts *opts __maybe_unused)
615 #define perf_event__process_auxtrace_info 0
616 #define perf_event__process_auxtrace 0
617 #define perf_event__process_auxtrace_error 0
620 void perf_session__auxtrace_error_inc(struct perf_session *session
622 union perf_event *event
628 void events_stats__auxtrace_error_warn(const struct events_stats *stats
634 int itrace_parse_synth_opts(const struct option *opt __maybe_unused,
635 const char *str __maybe_unused,
636 int unset __maybe_unused)
638 pr_err("AUX area tracing not supported\n");
643 int auxtrace_parse_snapshot_options(struct auxtrace_record *itr __maybe_unused,
644 struct record_opts *opts __maybe_unused,
649 pr_err("AUX area tracing not supported\n");
654 int auxtrace__process_event(struct perf_session *session __maybe_unused,
655 union perf_event *event __maybe_unused,
656 struct perf_sample *sample __maybe_unused,
657 struct perf_tool *tool __maybe_unused)
663 int auxtrace__flush_events(struct perf_session *session __maybe_unused,
664 struct perf_tool *tool __maybe_unused)
670 void auxtrace__free_events(struct perf_session *session __maybe_unused)
675 void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache __maybe_unused)
680 void auxtrace__free(struct perf_session *session __maybe_unused)
685 int auxtrace_index__write(int fd __maybe_unused,
686 struct list_head *head __maybe_unused)
692 int auxtrace_index__process(int fd __maybe_unused,
693 u64 size __maybe_unused,
694 struct perf_session *session __maybe_unused,
695 bool needs_swap __maybe_unused)
701 void auxtrace_index__free(struct list_head *head __maybe_unused)
706 int auxtrace_parse_filters(struct perf_evlist *evlist __maybe_unused)
711 int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
712 struct auxtrace_mmap_params *mp,
713 void *userpg, int fd);
714 void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
715 void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
716 off_t auxtrace_offset,
717 unsigned int auxtrace_pages,
718 bool auxtrace_overwrite);
719 void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
720 struct perf_evlist *evlist, int idx,