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>
22 #include <linux/list.h>
23 #include <linux/perf_event.h>
24 #include <linux/types.h>
37 struct auxtrace_info_event
;
41 PERF_AUXTRACE_UNKNOWN
,
42 PERF_AUXTRACE_INTEL_PT
,
43 PERF_AUXTRACE_INTEL_BTS
,
46 enum itrace_period_type
{
47 PERF_ITRACE_PERIOD_INSTRUCTIONS
,
48 PERF_ITRACE_PERIOD_TICKS
,
49 PERF_ITRACE_PERIOD_NANOSECS
,
53 * struct itrace_synth_opts - AUX area tracing synthesis options.
54 * @set: indicates whether or not options have been set
55 * @inject: indicates the event (not just the sample) must be fully synthesized
56 * because 'perf inject' will write it out
57 * @instructions: whether to synthesize 'instructions' events
58 * @branches: whether to synthesize 'branches' events
59 * @transactions: whether to synthesize events for transactions
60 * @errors: whether to synthesize decoder error events
61 * @dont_decode: whether to skip decoding entirely
62 * @log: write a decoding log
63 * @calls: limit branch samples to calls (can be combined with @returns)
64 * @returns: limit branch samples to returns (can be combined with @calls)
65 * @callchain: add callchain to 'instructions' events
66 * @last_branch: add branch context to 'instruction' events
67 * @callchain_sz: maximum callchain size
68 * @last_branch_sz: branch context size
69 * @period: 'instructions' events period
70 * @period_type: 'instructions' events period type
71 * @initial_skip: skip N events at the beginning.
73 struct itrace_synth_opts
{
86 unsigned int callchain_sz
;
87 unsigned int last_branch_sz
;
88 unsigned long long period
;
89 enum itrace_period_type period_type
;
90 unsigned long initial_skip
;
94 * struct auxtrace_index_entry - indexes a AUX area tracing event within a
96 * @file_offset: offset within the perf.data file
97 * @sz: size of the event
99 struct auxtrace_index_entry
{
104 #define PERF_AUXTRACE_INDEX_ENTRY_COUNT 256
107 * struct auxtrace_index - index of AUX area tracing events within a perf.data
109 * @list: linking a number of arrays of entries
110 * @nr: number of entries
111 * @entries: array of entries
113 struct auxtrace_index
{
114 struct list_head list
;
116 struct auxtrace_index_entry entries
[PERF_AUXTRACE_INDEX_ENTRY_COUNT
];
120 * struct auxtrace - session callbacks to allow AUX area data decoding.
121 * @process_event: lets the decoder see all session events
122 * @flush_events: process any remaining data
123 * @free_events: free resources associated with event processing
124 * @free: free resources associated with the session
127 int (*process_event
)(struct perf_session
*session
,
128 union perf_event
*event
,
129 struct perf_sample
*sample
,
130 struct perf_tool
*tool
);
131 int (*process_auxtrace_event
)(struct perf_session
*session
,
132 union perf_event
*event
,
133 struct perf_tool
*tool
);
134 int (*flush_events
)(struct perf_session
*session
,
135 struct perf_tool
*tool
);
136 void (*free_events
)(struct perf_session
*session
);
137 void (*free
)(struct perf_session
*session
);
141 * struct auxtrace_buffer - a buffer containing AUX area tracing data.
142 * @list: buffers are queued in a list held by struct auxtrace_queue
143 * @size: size of the buffer in bytes
144 * @pid: in per-thread mode, the pid this buffer is associated with
145 * @tid: in per-thread mode, the tid this buffer is associated with
146 * @cpu: in per-cpu mode, the cpu this buffer is associated with
147 * @data: actual buffer data (can be null if the data has not been loaded)
148 * @data_offset: file offset at which the buffer can be read
149 * @mmap_addr: mmap address at which the buffer can be read
150 * @mmap_size: size of the mmap at @mmap_addr
151 * @data_needs_freeing: @data was malloc'd so free it when it is no longer
153 * @consecutive: the original data was split up and this buffer is consecutive
154 * to the previous buffer
155 * @offset: offset as determined by aux_head / aux_tail members of struct
156 * perf_event_mmap_page
157 * @reference: an implementation-specific reference determined when the data is
159 * @buffer_nr: used to number each buffer
160 * @use_size: implementation actually only uses this number of bytes
161 * @use_data: implementation actually only uses data starting at this address
163 struct auxtrace_buffer
{
164 struct list_head list
;
173 bool data_needs_freeing
;
183 * struct auxtrace_queue - a queue of AUX area tracing data buffers.
184 * @head: head of buffer list
185 * @tid: in per-thread mode, the tid this queue is associated with
186 * @cpu: in per-cpu mode, the cpu this queue is associated with
187 * @set: %true once this queue has been dedicated to a specific thread or cpu
188 * @priv: implementation-specific data
190 struct auxtrace_queue
{
191 struct list_head head
;
199 * struct auxtrace_queues - an array of AUX area tracing queues.
200 * @queue_array: array of queues
201 * @nr_queues: number of queues
202 * @new_data: set whenever new data is queued
203 * @populated: queues have been fully populated using the auxtrace_index
204 * @next_buffer_nr: used to number each buffer
206 struct auxtrace_queues
{
207 struct auxtrace_queue
*queue_array
;
208 unsigned int nr_queues
;
215 * struct auxtrace_heap_item - element of struct auxtrace_heap.
216 * @queue_nr: queue number
217 * @ordinal: value used for sorting (lowest ordinal is top of the heap) expected
220 struct auxtrace_heap_item
{
221 unsigned int queue_nr
;
226 * struct auxtrace_heap - a heap suitable for sorting AUX area tracing queues.
227 * @heap_array: the heap
228 * @heap_cnt: the number of elements in the heap
229 * @heap_sz: maximum number of elements (grows as needed)
231 struct auxtrace_heap
{
232 struct auxtrace_heap_item
*heap_array
;
233 unsigned int heap_cnt
;
234 unsigned int heap_sz
;
238 * struct auxtrace_mmap - records an mmap of the auxtrace buffer.
239 * @base: address of mapped area
240 * @userpg: pointer to buffer's perf_event_mmap_page
241 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
242 * @len: size of mapped area
243 * @prev: previous aux_head
244 * @idx: index of this mmap
245 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
247 * @cpu: cpu number for a per-cpu mmap otherwise %-1
249 struct auxtrace_mmap
{
261 * struct auxtrace_mmap_params - parameters to set up struct auxtrace_mmap.
262 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
263 * @offset: file offset of mapped area
264 * @len: size of mapped area
265 * @prot: mmap memory protection
266 * @idx: index of this mmap
267 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
269 * @cpu: cpu number for a per-cpu mmap otherwise %-1
271 struct auxtrace_mmap_params
{
282 * struct auxtrace_record - callbacks for recording AUX area data.
283 * @recording_options: validate and process recording options
284 * @info_priv_size: return the size of the private data in auxtrace_info_event
285 * @info_fill: fill-in the private data in auxtrace_info_event
286 * @free: free this auxtrace record structure
287 * @snapshot_start: starting a snapshot
288 * @snapshot_finish: finishing a snapshot
289 * @find_snapshot: find data to snapshot within auxtrace mmap
290 * @parse_snapshot_options: parse snapshot options
291 * @reference: provide a 64-bit reference number for auxtrace_event
292 * @read_finish: called after reading from an auxtrace mmap
294 struct auxtrace_record
{
295 int (*recording_options
)(struct auxtrace_record
*itr
,
296 struct perf_evlist
*evlist
,
297 struct record_opts
*opts
);
298 size_t (*info_priv_size
)(struct auxtrace_record
*itr
,
299 struct perf_evlist
*evlist
);
300 int (*info_fill
)(struct auxtrace_record
*itr
,
301 struct perf_session
*session
,
302 struct auxtrace_info_event
*auxtrace_info
,
304 void (*free
)(struct auxtrace_record
*itr
);
305 int (*snapshot_start
)(struct auxtrace_record
*itr
);
306 int (*snapshot_finish
)(struct auxtrace_record
*itr
);
307 int (*find_snapshot
)(struct auxtrace_record
*itr
, int idx
,
308 struct auxtrace_mmap
*mm
, unsigned char *data
,
309 u64
*head
, u64
*old
);
310 int (*parse_snapshot_options
)(struct auxtrace_record
*itr
,
311 struct record_opts
*opts
,
313 u64 (*reference
)(struct auxtrace_record
*itr
);
314 int (*read_finish
)(struct auxtrace_record
*itr
, int idx
);
315 unsigned int alignment
;
318 #ifdef HAVE_AUXTRACE_SUPPORT
321 * In snapshot mode the mmapped page is read-only which makes using
322 * __sync_val_compare_and_swap() problematic. However, snapshot mode expects
323 * the buffer is not updated while the snapshot is made (e.g. Intel PT disables
324 * the event) so there is not a race anyway.
326 static inline u64
auxtrace_mmap__read_snapshot_head(struct auxtrace_mmap
*mm
)
328 struct perf_event_mmap_page
*pc
= mm
->userpg
;
329 u64 head
= ACCESS_ONCE(pc
->aux_head
);
331 /* Ensure all reads are done after we read the head */
336 static inline u64
auxtrace_mmap__read_head(struct auxtrace_mmap
*mm
)
338 struct perf_event_mmap_page
*pc
= mm
->userpg
;
339 #if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
340 u64 head
= ACCESS_ONCE(pc
->aux_head
);
342 u64 head
= __sync_val_compare_and_swap(&pc
->aux_head
, 0, 0);
345 /* Ensure all reads are done after we read the head */
350 static inline void auxtrace_mmap__write_tail(struct auxtrace_mmap
*mm
, u64 tail
)
352 struct perf_event_mmap_page
*pc
= mm
->userpg
;
353 #if BITS_PER_LONG != 64 && defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
357 /* Ensure all reads are done before we write the tail out */
359 #if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
363 old_tail
= __sync_val_compare_and_swap(&pc
->aux_tail
, 0, 0);
364 } while (!__sync_bool_compare_and_swap(&pc
->aux_tail
, old_tail
, tail
));
368 int auxtrace_mmap__mmap(struct auxtrace_mmap
*mm
,
369 struct auxtrace_mmap_params
*mp
,
370 void *userpg
, int fd
);
371 void auxtrace_mmap__munmap(struct auxtrace_mmap
*mm
);
372 void auxtrace_mmap_params__init(struct auxtrace_mmap_params
*mp
,
373 off_t auxtrace_offset
,
374 unsigned int auxtrace_pages
,
375 bool auxtrace_overwrite
);
376 void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params
*mp
,
377 struct perf_evlist
*evlist
, int idx
,
380 typedef int (*process_auxtrace_t
)(struct perf_tool
*tool
,
381 union perf_event
*event
, void *data1
,
382 size_t len1
, void *data2
, size_t len2
);
384 int auxtrace_mmap__read(struct auxtrace_mmap
*mm
, struct auxtrace_record
*itr
,
385 struct perf_tool
*tool
, process_auxtrace_t fn
);
387 int auxtrace_mmap__read_snapshot(struct auxtrace_mmap
*mm
,
388 struct auxtrace_record
*itr
,
389 struct perf_tool
*tool
, process_auxtrace_t fn
,
390 size_t snapshot_size
);
392 int auxtrace_queues__init(struct auxtrace_queues
*queues
);
393 int auxtrace_queues__add_event(struct auxtrace_queues
*queues
,
394 struct perf_session
*session
,
395 union perf_event
*event
, off_t data_offset
,
396 struct auxtrace_buffer
**buffer_ptr
);
397 void auxtrace_queues__free(struct auxtrace_queues
*queues
);
398 int auxtrace_queues__process_index(struct auxtrace_queues
*queues
,
399 struct perf_session
*session
);
400 struct auxtrace_buffer
*auxtrace_buffer__next(struct auxtrace_queue
*queue
,
401 struct auxtrace_buffer
*buffer
);
402 void *auxtrace_buffer__get_data(struct auxtrace_buffer
*buffer
, int fd
);
403 void auxtrace_buffer__put_data(struct auxtrace_buffer
*buffer
);
404 void auxtrace_buffer__drop_data(struct auxtrace_buffer
*buffer
);
405 void auxtrace_buffer__free(struct auxtrace_buffer
*buffer
);
407 int auxtrace_heap__add(struct auxtrace_heap
*heap
, unsigned int queue_nr
,
409 void auxtrace_heap__pop(struct auxtrace_heap
*heap
);
410 void auxtrace_heap__free(struct auxtrace_heap
*heap
);
412 struct auxtrace_cache_entry
{
413 struct hlist_node hash
;
417 struct auxtrace_cache
*auxtrace_cache__new(unsigned int bits
, size_t entry_size
,
418 unsigned int limit_percent
);
419 void auxtrace_cache__free(struct auxtrace_cache
*auxtrace_cache
);
420 void *auxtrace_cache__alloc_entry(struct auxtrace_cache
*c
);
421 void auxtrace_cache__free_entry(struct auxtrace_cache
*c
, void *entry
);
422 int auxtrace_cache__add(struct auxtrace_cache
*c
, u32 key
,
423 struct auxtrace_cache_entry
*entry
);
424 void *auxtrace_cache__lookup(struct auxtrace_cache
*c
, u32 key
);
426 struct auxtrace_record
*auxtrace_record__init(struct perf_evlist
*evlist
,
429 int auxtrace_parse_snapshot_options(struct auxtrace_record
*itr
,
430 struct record_opts
*opts
,
432 int auxtrace_record__options(struct auxtrace_record
*itr
,
433 struct perf_evlist
*evlist
,
434 struct record_opts
*opts
);
435 size_t auxtrace_record__info_priv_size(struct auxtrace_record
*itr
,
436 struct perf_evlist
*evlist
);
437 int auxtrace_record__info_fill(struct auxtrace_record
*itr
,
438 struct perf_session
*session
,
439 struct auxtrace_info_event
*auxtrace_info
,
441 void auxtrace_record__free(struct auxtrace_record
*itr
);
442 int auxtrace_record__snapshot_start(struct auxtrace_record
*itr
);
443 int auxtrace_record__snapshot_finish(struct auxtrace_record
*itr
);
444 int auxtrace_record__find_snapshot(struct auxtrace_record
*itr
, int idx
,
445 struct auxtrace_mmap
*mm
,
446 unsigned char *data
, u64
*head
, u64
*old
);
447 u64
auxtrace_record__reference(struct auxtrace_record
*itr
);
449 int auxtrace_index__auxtrace_event(struct list_head
*head
, union perf_event
*event
,
451 int auxtrace_index__write(int fd
, struct list_head
*head
);
452 int auxtrace_index__process(int fd
, u64 size
, struct perf_session
*session
,
454 void auxtrace_index__free(struct list_head
*head
);
456 void auxtrace_synth_error(struct auxtrace_error_event
*auxtrace_error
, int type
,
457 int code
, int cpu
, pid_t pid
, pid_t tid
, u64 ip
,
460 int perf_event__synthesize_auxtrace_info(struct auxtrace_record
*itr
,
461 struct perf_tool
*tool
,
462 struct perf_session
*session
,
463 perf_event__handler_t process
);
464 int perf_event__process_auxtrace_info(struct perf_tool
*tool
,
465 union perf_event
*event
,
466 struct perf_session
*session
);
467 s64
perf_event__process_auxtrace(struct perf_tool
*tool
,
468 union perf_event
*event
,
469 struct perf_session
*session
);
470 int perf_event__process_auxtrace_error(struct perf_tool
*tool
,
471 union perf_event
*event
,
472 struct perf_session
*session
);
473 int itrace_parse_synth_opts(const struct option
*opt
, const char *str
,
475 void itrace_synth_opts__set_default(struct itrace_synth_opts
*synth_opts
);
477 size_t perf_event__fprintf_auxtrace_error(union perf_event
*event
, FILE *fp
);
478 void perf_session__auxtrace_error_inc(struct perf_session
*session
,
479 union perf_event
*event
);
480 void events_stats__auxtrace_error_warn(const struct events_stats
*stats
);
482 static inline int auxtrace__process_event(struct perf_session
*session
,
483 union perf_event
*event
,
484 struct perf_sample
*sample
,
485 struct perf_tool
*tool
)
487 if (!session
->auxtrace
)
490 return session
->auxtrace
->process_event(session
, event
, sample
, tool
);
493 static inline int auxtrace__flush_events(struct perf_session
*session
,
494 struct perf_tool
*tool
)
496 if (!session
->auxtrace
)
499 return session
->auxtrace
->flush_events(session
, tool
);
502 static inline void auxtrace__free_events(struct perf_session
*session
)
504 if (!session
->auxtrace
)
507 return session
->auxtrace
->free_events(session
);
510 static inline void auxtrace__free(struct perf_session
*session
)
512 if (!session
->auxtrace
)
515 return session
->auxtrace
->free(session
);
520 static inline struct auxtrace_record
*
521 auxtrace_record__init(struct perf_evlist
*evlist __maybe_unused
,
529 void auxtrace_record__free(struct auxtrace_record
*itr __maybe_unused
)
534 perf_event__synthesize_auxtrace_info(struct auxtrace_record
*itr __maybe_unused
,
535 struct perf_tool
*tool __maybe_unused
,
536 struct perf_session
*session __maybe_unused
,
537 perf_event__handler_t process __maybe_unused
)
543 int auxtrace_record__options(struct auxtrace_record
*itr __maybe_unused
,
544 struct perf_evlist
*evlist __maybe_unused
,
545 struct record_opts
*opts __maybe_unused
)
550 #define perf_event__process_auxtrace_info 0
551 #define perf_event__process_auxtrace 0
552 #define perf_event__process_auxtrace_error 0
555 void perf_session__auxtrace_error_inc(struct perf_session
*session
557 union perf_event
*event
563 void events_stats__auxtrace_error_warn(const struct events_stats
*stats
569 int itrace_parse_synth_opts(const struct option
*opt __maybe_unused
,
570 const char *str __maybe_unused
,
571 int unset __maybe_unused
)
573 pr_err("AUX area tracing not supported\n");
578 int auxtrace_parse_snapshot_options(struct auxtrace_record
*itr __maybe_unused
,
579 struct record_opts
*opts __maybe_unused
,
584 pr_err("AUX area tracing not supported\n");
589 int auxtrace__process_event(struct perf_session
*session __maybe_unused
,
590 union perf_event
*event __maybe_unused
,
591 struct perf_sample
*sample __maybe_unused
,
592 struct perf_tool
*tool __maybe_unused
)
598 int auxtrace__flush_events(struct perf_session
*session __maybe_unused
,
599 struct perf_tool
*tool __maybe_unused
)
605 void auxtrace__free_events(struct perf_session
*session __maybe_unused
)
610 void auxtrace_cache__free(struct auxtrace_cache
*auxtrace_cache __maybe_unused
)
615 void auxtrace__free(struct perf_session
*session __maybe_unused
)
620 int auxtrace_index__write(int fd __maybe_unused
,
621 struct list_head
*head __maybe_unused
)
627 int auxtrace_index__process(int fd __maybe_unused
,
628 u64 size __maybe_unused
,
629 struct perf_session
*session __maybe_unused
,
630 bool needs_swap __maybe_unused
)
636 void auxtrace_index__free(struct list_head
*head __maybe_unused
)
640 int auxtrace_mmap__mmap(struct auxtrace_mmap
*mm
,
641 struct auxtrace_mmap_params
*mp
,
642 void *userpg
, int fd
);
643 void auxtrace_mmap__munmap(struct auxtrace_mmap
*mm
);
644 void auxtrace_mmap_params__init(struct auxtrace_mmap_params
*mp
,
645 off_t auxtrace_offset
,
646 unsigned int auxtrace_pages
,
647 bool auxtrace_overwrite
);
648 void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params
*mp
,
649 struct perf_evlist
*evlist
, int idx
,