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,
48 enum itrace_period_type {
49 PERF_ITRACE_PERIOD_INSTRUCTIONS,
50 PERF_ITRACE_PERIOD_TICKS,
51 PERF_ITRACE_PERIOD_NANOSECS,
55 * struct itrace_synth_opts - AUX area tracing synthesis options.
56 * @set: indicates whether or not options have been set
57 * @inject: indicates the event (not just the sample) must be fully synthesized
58 * because 'perf inject' will write it out
59 * @instructions: whether to synthesize 'instructions' events
60 * @branches: whether to synthesize 'branches' events
61 * @transactions: whether to synthesize events for transactions
62 * @errors: whether to synthesize decoder error events
63 * @dont_decode: whether to skip decoding entirely
64 * @log: write a decoding log
65 * @calls: limit branch samples to calls (can be combined with @returns)
66 * @returns: limit branch samples to returns (can be combined with @calls)
67 * @callchain: add callchain to 'instructions' events
68 * @thread_stack: feed branches to the thread_stack
69 * @last_branch: add branch context to 'instruction' events
70 * @callchain_sz: maximum callchain size
71 * @last_branch_sz: branch context size
72 * @period: 'instructions' events period
73 * @period_type: 'instructions' events period type
74 * @initial_skip: skip N events at the beginning.
76 struct itrace_synth_opts {
90 unsigned int callchain_sz;
91 unsigned int last_branch_sz;
92 unsigned long long period;
93 enum itrace_period_type period_type;
94 unsigned long initial_skip;
98 * struct auxtrace_index_entry - indexes a AUX area tracing event within a
100 * @file_offset: offset within the perf.data file
101 * @sz: size of the event
103 struct auxtrace_index_entry {
108 #define PERF_AUXTRACE_INDEX_ENTRY_COUNT 256
111 * struct auxtrace_index - index of AUX area tracing events within a perf.data
113 * @list: linking a number of arrays of entries
114 * @nr: number of entries
115 * @entries: array of entries
117 struct auxtrace_index {
118 struct list_head list;
120 struct auxtrace_index_entry entries[PERF_AUXTRACE_INDEX_ENTRY_COUNT];
124 * struct auxtrace - session callbacks to allow AUX area data decoding.
125 * @process_event: lets the decoder see all session events
126 * @flush_events: process any remaining data
127 * @free_events: free resources associated with event processing
128 * @free: free resources associated with the session
131 int (*process_event)(struct perf_session *session,
132 union perf_event *event,
133 struct perf_sample *sample,
134 struct perf_tool *tool);
135 int (*process_auxtrace_event)(struct perf_session *session,
136 union perf_event *event,
137 struct perf_tool *tool);
138 int (*flush_events)(struct perf_session *session,
139 struct perf_tool *tool);
140 void (*free_events)(struct perf_session *session);
141 void (*free)(struct perf_session *session);
145 * struct auxtrace_buffer - a buffer containing AUX area tracing data.
146 * @list: buffers are queued in a list held by struct auxtrace_queue
147 * @size: size of the buffer in bytes
148 * @pid: in per-thread mode, the pid this buffer is associated with
149 * @tid: in per-thread mode, the tid this buffer is associated with
150 * @cpu: in per-cpu mode, the cpu this buffer is associated with
151 * @data: actual buffer data (can be null if the data has not been loaded)
152 * @data_offset: file offset at which the buffer can be read
153 * @mmap_addr: mmap address at which the buffer can be read
154 * @mmap_size: size of the mmap at @mmap_addr
155 * @data_needs_freeing: @data was malloc'd so free it when it is no longer
157 * @consecutive: the original data was split up and this buffer is consecutive
158 * to the previous buffer
159 * @offset: offset as determined by aux_head / aux_tail members of struct
160 * perf_event_mmap_page
161 * @reference: an implementation-specific reference determined when the data is
163 * @buffer_nr: used to number each buffer
164 * @use_size: implementation actually only uses this number of bytes
165 * @use_data: implementation actually only uses data starting at this address
167 struct auxtrace_buffer {
168 struct list_head list;
177 bool data_needs_freeing;
187 * struct auxtrace_queue - a queue of AUX area tracing data buffers.
188 * @head: head of buffer list
189 * @tid: in per-thread mode, the tid this queue is associated with
190 * @cpu: in per-cpu mode, the cpu this queue is associated with
191 * @set: %true once this queue has been dedicated to a specific thread or cpu
192 * @priv: implementation-specific data
194 struct auxtrace_queue {
195 struct list_head head;
203 * struct auxtrace_queues - an array of AUX area tracing queues.
204 * @queue_array: array of queues
205 * @nr_queues: number of queues
206 * @new_data: set whenever new data is queued
207 * @populated: queues have been fully populated using the auxtrace_index
208 * @next_buffer_nr: used to number each buffer
210 struct auxtrace_queues {
211 struct auxtrace_queue *queue_array;
212 unsigned int nr_queues;
219 * struct auxtrace_heap_item - element of struct auxtrace_heap.
220 * @queue_nr: queue number
221 * @ordinal: value used for sorting (lowest ordinal is top of the heap) expected
224 struct auxtrace_heap_item {
225 unsigned int queue_nr;
230 * struct auxtrace_heap - a heap suitable for sorting AUX area tracing queues.
231 * @heap_array: the heap
232 * @heap_cnt: the number of elements in the heap
233 * @heap_sz: maximum number of elements (grows as needed)
235 struct auxtrace_heap {
236 struct auxtrace_heap_item *heap_array;
237 unsigned int heap_cnt;
238 unsigned int heap_sz;
242 * struct auxtrace_mmap - records an mmap of the auxtrace buffer.
243 * @base: address of mapped area
244 * @userpg: pointer to buffer's perf_event_mmap_page
245 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
246 * @len: size of mapped area
247 * @prev: previous aux_head
248 * @idx: index of this mmap
249 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
251 * @cpu: cpu number for a per-cpu mmap otherwise %-1
253 struct auxtrace_mmap {
265 * struct auxtrace_mmap_params - parameters to set up struct auxtrace_mmap.
266 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
267 * @offset: file offset of mapped area
268 * @len: size of mapped area
269 * @prot: mmap memory protection
270 * @idx: index of this mmap
271 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
273 * @cpu: cpu number for a per-cpu mmap otherwise %-1
275 struct auxtrace_mmap_params {
286 * struct auxtrace_record - callbacks for recording AUX area data.
287 * @recording_options: validate and process recording options
288 * @info_priv_size: return the size of the private data in auxtrace_info_event
289 * @info_fill: fill-in the private data in auxtrace_info_event
290 * @free: free this auxtrace record structure
291 * @snapshot_start: starting a snapshot
292 * @snapshot_finish: finishing a snapshot
293 * @find_snapshot: find data to snapshot within auxtrace mmap
294 * @parse_snapshot_options: parse snapshot options
295 * @reference: provide a 64-bit reference number for auxtrace_event
296 * @read_finish: called after reading from an auxtrace mmap
298 struct auxtrace_record {
299 int (*recording_options)(struct auxtrace_record *itr,
300 struct perf_evlist *evlist,
301 struct record_opts *opts);
302 size_t (*info_priv_size)(struct auxtrace_record *itr,
303 struct perf_evlist *evlist);
304 int (*info_fill)(struct auxtrace_record *itr,
305 struct perf_session *session,
306 struct auxtrace_info_event *auxtrace_info,
308 void (*free)(struct auxtrace_record *itr);
309 int (*snapshot_start)(struct auxtrace_record *itr);
310 int (*snapshot_finish)(struct auxtrace_record *itr);
311 int (*find_snapshot)(struct auxtrace_record *itr, int idx,
312 struct auxtrace_mmap *mm, unsigned char *data,
313 u64 *head, u64 *old);
314 int (*parse_snapshot_options)(struct auxtrace_record *itr,
315 struct record_opts *opts,
317 u64 (*reference)(struct auxtrace_record *itr);
318 int (*read_finish)(struct auxtrace_record *itr, int idx);
319 unsigned int alignment;
323 * struct addr_filter - address filter.
325 * @range: true if it is a range filter
326 * @start: true if action is 'filter' or 'start'
327 * @action: 'filter', 'start' or 'stop' ('tracestop' is accepted but converted
329 * @sym_from: symbol name for the filter address
330 * @sym_to: symbol name that determines the filter size
331 * @sym_from_idx: selects n'th from symbols with the same name (0 means global
332 * and less than 0 means symbol must be unique)
333 * @sym_to_idx: same as @sym_from_idx but for @sym_to
334 * @addr: filter address
335 * @size: filter region size (for range filters)
336 * @filename: DSO file name or NULL for the kernel
337 * @str: allocated string that contains the other string members
340 struct list_head list;
344 const char *sym_from;
350 const char *filename;
355 * struct addr_filters - list of address filters.
356 * @head: list of address filters
357 * @cnt: number of address filters
359 struct addr_filters {
360 struct list_head head;
364 #ifdef HAVE_AUXTRACE_SUPPORT
367 * In snapshot mode the mmapped page is read-only which makes using
368 * __sync_val_compare_and_swap() problematic. However, snapshot mode expects
369 * the buffer is not updated while the snapshot is made (e.g. Intel PT disables
370 * the event) so there is not a race anyway.
372 static inline u64 auxtrace_mmap__read_snapshot_head(struct auxtrace_mmap *mm)
374 struct perf_event_mmap_page *pc = mm->userpg;
375 u64 head = ACCESS_ONCE(pc->aux_head);
377 /* Ensure all reads are done after we read the head */
382 static inline u64 auxtrace_mmap__read_head(struct auxtrace_mmap *mm)
384 struct perf_event_mmap_page *pc = mm->userpg;
385 #if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
386 u64 head = ACCESS_ONCE(pc->aux_head);
388 u64 head = __sync_val_compare_and_swap(&pc->aux_head, 0, 0);
391 /* Ensure all reads are done after we read the head */
396 static inline void auxtrace_mmap__write_tail(struct auxtrace_mmap *mm, u64 tail)
398 struct perf_event_mmap_page *pc = mm->userpg;
399 #if BITS_PER_LONG != 64 && defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
403 /* Ensure all reads are done before we write the tail out */
405 #if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
409 old_tail = __sync_val_compare_and_swap(&pc->aux_tail, 0, 0);
410 } while (!__sync_bool_compare_and_swap(&pc->aux_tail, old_tail, tail));
414 int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
415 struct auxtrace_mmap_params *mp,
416 void *userpg, int fd);
417 void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
418 void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
419 off_t auxtrace_offset,
420 unsigned int auxtrace_pages,
421 bool auxtrace_overwrite);
422 void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
423 struct perf_evlist *evlist, int idx,
426 typedef int (*process_auxtrace_t)(struct perf_tool *tool,
427 union perf_event *event, void *data1,
428 size_t len1, void *data2, size_t len2);
430 int auxtrace_mmap__read(struct auxtrace_mmap *mm, struct auxtrace_record *itr,
431 struct perf_tool *tool, process_auxtrace_t fn);
433 int auxtrace_mmap__read_snapshot(struct auxtrace_mmap *mm,
434 struct auxtrace_record *itr,
435 struct perf_tool *tool, process_auxtrace_t fn,
436 size_t snapshot_size);
438 int auxtrace_queues__init(struct auxtrace_queues *queues);
439 int auxtrace_queues__add_event(struct auxtrace_queues *queues,
440 struct perf_session *session,
441 union perf_event *event, off_t data_offset,
442 struct auxtrace_buffer **buffer_ptr);
443 void auxtrace_queues__free(struct auxtrace_queues *queues);
444 int auxtrace_queues__process_index(struct auxtrace_queues *queues,
445 struct perf_session *session);
446 struct auxtrace_buffer *auxtrace_buffer__next(struct auxtrace_queue *queue,
447 struct auxtrace_buffer *buffer);
448 void *auxtrace_buffer__get_data(struct auxtrace_buffer *buffer, int fd);
449 void auxtrace_buffer__put_data(struct auxtrace_buffer *buffer);
450 void auxtrace_buffer__drop_data(struct auxtrace_buffer *buffer);
451 void auxtrace_buffer__free(struct auxtrace_buffer *buffer);
453 int auxtrace_heap__add(struct auxtrace_heap *heap, unsigned int queue_nr,
455 void auxtrace_heap__pop(struct auxtrace_heap *heap);
456 void auxtrace_heap__free(struct auxtrace_heap *heap);
458 struct auxtrace_cache_entry {
459 struct hlist_node hash;
463 struct auxtrace_cache *auxtrace_cache__new(unsigned int bits, size_t entry_size,
464 unsigned int limit_percent);
465 void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache);
466 void *auxtrace_cache__alloc_entry(struct auxtrace_cache *c);
467 void auxtrace_cache__free_entry(struct auxtrace_cache *c, void *entry);
468 int auxtrace_cache__add(struct auxtrace_cache *c, u32 key,
469 struct auxtrace_cache_entry *entry);
470 void *auxtrace_cache__lookup(struct auxtrace_cache *c, u32 key);
472 struct auxtrace_record *auxtrace_record__init(struct perf_evlist *evlist,
475 int auxtrace_parse_snapshot_options(struct auxtrace_record *itr,
476 struct record_opts *opts,
478 int auxtrace_record__options(struct auxtrace_record *itr,
479 struct perf_evlist *evlist,
480 struct record_opts *opts);
481 size_t auxtrace_record__info_priv_size(struct auxtrace_record *itr,
482 struct perf_evlist *evlist);
483 int auxtrace_record__info_fill(struct auxtrace_record *itr,
484 struct perf_session *session,
485 struct auxtrace_info_event *auxtrace_info,
487 void auxtrace_record__free(struct auxtrace_record *itr);
488 int auxtrace_record__snapshot_start(struct auxtrace_record *itr);
489 int auxtrace_record__snapshot_finish(struct auxtrace_record *itr);
490 int auxtrace_record__find_snapshot(struct auxtrace_record *itr, int idx,
491 struct auxtrace_mmap *mm,
492 unsigned char *data, u64 *head, u64 *old);
493 u64 auxtrace_record__reference(struct auxtrace_record *itr);
495 int auxtrace_index__auxtrace_event(struct list_head *head, union perf_event *event,
497 int auxtrace_index__write(int fd, struct list_head *head);
498 int auxtrace_index__process(int fd, u64 size, struct perf_session *session,
500 void auxtrace_index__free(struct list_head *head);
502 void auxtrace_synth_error(struct auxtrace_error_event *auxtrace_error, int type,
503 int code, int cpu, pid_t pid, pid_t tid, u64 ip,
506 int perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr,
507 struct perf_tool *tool,
508 struct perf_session *session,
509 perf_event__handler_t process);
510 int perf_event__process_auxtrace_info(struct perf_tool *tool,
511 union perf_event *event,
512 struct perf_session *session);
513 s64 perf_event__process_auxtrace(struct perf_tool *tool,
514 union perf_event *event,
515 struct perf_session *session);
516 int perf_event__process_auxtrace_error(struct perf_tool *tool,
517 union perf_event *event,
518 struct perf_session *session);
519 int itrace_parse_synth_opts(const struct option *opt, const char *str,
521 void itrace_synth_opts__set_default(struct itrace_synth_opts *synth_opts);
523 size_t perf_event__fprintf_auxtrace_error(union perf_event *event, FILE *fp);
524 void perf_session__auxtrace_error_inc(struct perf_session *session,
525 union perf_event *event);
526 void events_stats__auxtrace_error_warn(const struct events_stats *stats);
528 void addr_filters__init(struct addr_filters *filts);
529 void addr_filters__exit(struct addr_filters *filts);
530 int addr_filters__parse_bare_filter(struct addr_filters *filts,
532 int auxtrace_parse_filters(struct perf_evlist *evlist);
534 static inline int auxtrace__process_event(struct perf_session *session,
535 union perf_event *event,
536 struct perf_sample *sample,
537 struct perf_tool *tool)
539 if (!session->auxtrace)
542 return session->auxtrace->process_event(session, event, sample, tool);
545 static inline int auxtrace__flush_events(struct perf_session *session,
546 struct perf_tool *tool)
548 if (!session->auxtrace)
551 return session->auxtrace->flush_events(session, tool);
554 static inline void auxtrace__free_events(struct perf_session *session)
556 if (!session->auxtrace)
559 return session->auxtrace->free_events(session);
562 static inline void auxtrace__free(struct perf_session *session)
564 if (!session->auxtrace)
567 return session->auxtrace->free(session);
572 static inline struct auxtrace_record *
573 auxtrace_record__init(struct perf_evlist *evlist __maybe_unused,
581 void auxtrace_record__free(struct auxtrace_record *itr __maybe_unused)
586 perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr __maybe_unused,
587 struct perf_tool *tool __maybe_unused,
588 struct perf_session *session __maybe_unused,
589 perf_event__handler_t process __maybe_unused)
595 int auxtrace_record__options(struct auxtrace_record *itr __maybe_unused,
596 struct perf_evlist *evlist __maybe_unused,
597 struct record_opts *opts __maybe_unused)
602 #define perf_event__process_auxtrace_info 0
603 #define perf_event__process_auxtrace 0
604 #define perf_event__process_auxtrace_error 0
607 void perf_session__auxtrace_error_inc(struct perf_session *session
609 union perf_event *event
615 void events_stats__auxtrace_error_warn(const struct events_stats *stats
621 int itrace_parse_synth_opts(const struct option *opt __maybe_unused,
622 const char *str __maybe_unused,
623 int unset __maybe_unused)
625 pr_err("AUX area tracing not supported\n");
630 int auxtrace_parse_snapshot_options(struct auxtrace_record *itr __maybe_unused,
631 struct record_opts *opts __maybe_unused,
636 pr_err("AUX area tracing not supported\n");
641 int auxtrace__process_event(struct perf_session *session __maybe_unused,
642 union perf_event *event __maybe_unused,
643 struct perf_sample *sample __maybe_unused,
644 struct perf_tool *tool __maybe_unused)
650 int auxtrace__flush_events(struct perf_session *session __maybe_unused,
651 struct perf_tool *tool __maybe_unused)
657 void auxtrace__free_events(struct perf_session *session __maybe_unused)
662 void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache __maybe_unused)
667 void auxtrace__free(struct perf_session *session __maybe_unused)
672 int auxtrace_index__write(int fd __maybe_unused,
673 struct list_head *head __maybe_unused)
679 int auxtrace_index__process(int fd __maybe_unused,
680 u64 size __maybe_unused,
681 struct perf_session *session __maybe_unused,
682 bool needs_swap __maybe_unused)
688 void auxtrace_index__free(struct list_head *head __maybe_unused)
693 int auxtrace_parse_filters(struct perf_evlist *evlist __maybe_unused)
698 int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
699 struct auxtrace_mmap_params *mp,
700 void *userpg, int fd);
701 void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
702 void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
703 off_t auxtrace_offset,
704 unsigned int auxtrace_pages,
705 bool auxtrace_overwrite);
706 void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
707 struct perf_evlist *evlist, int idx,