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
72 struct itrace_synth_opts
{
85 unsigned int callchain_sz
;
86 unsigned int last_branch_sz
;
87 unsigned long long period
;
88 enum itrace_period_type period_type
;
92 * struct auxtrace_index_entry - indexes a AUX area tracing event within a
94 * @file_offset: offset within the perf.data file
95 * @sz: size of the event
97 struct auxtrace_index_entry
{
102 #define PERF_AUXTRACE_INDEX_ENTRY_COUNT 256
105 * struct auxtrace_index - index of AUX area tracing events within a perf.data
107 * @list: linking a number of arrays of entries
108 * @nr: number of entries
109 * @entries: array of entries
111 struct auxtrace_index
{
112 struct list_head list
;
114 struct auxtrace_index_entry entries
[PERF_AUXTRACE_INDEX_ENTRY_COUNT
];
118 * struct auxtrace - session callbacks to allow AUX area data decoding.
119 * @process_event: lets the decoder see all session events
120 * @flush_events: process any remaining data
121 * @free_events: free resources associated with event processing
122 * @free: free resources associated with the session
125 int (*process_event
)(struct perf_session
*session
,
126 union perf_event
*event
,
127 struct perf_sample
*sample
,
128 struct perf_tool
*tool
);
129 int (*process_auxtrace_event
)(struct perf_session
*session
,
130 union perf_event
*event
,
131 struct perf_tool
*tool
);
132 int (*flush_events
)(struct perf_session
*session
,
133 struct perf_tool
*tool
);
134 void (*free_events
)(struct perf_session
*session
);
135 void (*free
)(struct perf_session
*session
);
139 * struct auxtrace_buffer - a buffer containing AUX area tracing data.
140 * @list: buffers are queued in a list held by struct auxtrace_queue
141 * @size: size of the buffer in bytes
142 * @pid: in per-thread mode, the pid this buffer is associated with
143 * @tid: in per-thread mode, the tid this buffer is associated with
144 * @cpu: in per-cpu mode, the cpu this buffer is associated with
145 * @data: actual buffer data (can be null if the data has not been loaded)
146 * @data_offset: file offset at which the buffer can be read
147 * @mmap_addr: mmap address at which the buffer can be read
148 * @mmap_size: size of the mmap at @mmap_addr
149 * @data_needs_freeing: @data was malloc'd so free it when it is no longer
151 * @consecutive: the original data was split up and this buffer is consecutive
152 * to the previous buffer
153 * @offset: offset as determined by aux_head / aux_tail members of struct
154 * perf_event_mmap_page
155 * @reference: an implementation-specific reference determined when the data is
157 * @buffer_nr: used to number each buffer
158 * @use_size: implementation actually only uses this number of bytes
159 * @use_data: implementation actually only uses data starting at this address
161 struct auxtrace_buffer
{
162 struct list_head list
;
171 bool data_needs_freeing
;
181 * struct auxtrace_queue - a queue of AUX area tracing data buffers.
182 * @head: head of buffer list
183 * @tid: in per-thread mode, the tid this queue is associated with
184 * @cpu: in per-cpu mode, the cpu this queue is associated with
185 * @set: %true once this queue has been dedicated to a specific thread or cpu
186 * @priv: implementation-specific data
188 struct auxtrace_queue
{
189 struct list_head head
;
197 * struct auxtrace_queues - an array of AUX area tracing queues.
198 * @queue_array: array of queues
199 * @nr_queues: number of queues
200 * @new_data: set whenever new data is queued
201 * @populated: queues have been fully populated using the auxtrace_index
202 * @next_buffer_nr: used to number each buffer
204 struct auxtrace_queues
{
205 struct auxtrace_queue
*queue_array
;
206 unsigned int nr_queues
;
213 * struct auxtrace_heap_item - element of struct auxtrace_heap.
214 * @queue_nr: queue number
215 * @ordinal: value used for sorting (lowest ordinal is top of the heap) expected
218 struct auxtrace_heap_item
{
219 unsigned int queue_nr
;
224 * struct auxtrace_heap - a heap suitable for sorting AUX area tracing queues.
225 * @heap_array: the heap
226 * @heap_cnt: the number of elements in the heap
227 * @heap_sz: maximum number of elements (grows as needed)
229 struct auxtrace_heap
{
230 struct auxtrace_heap_item
*heap_array
;
231 unsigned int heap_cnt
;
232 unsigned int heap_sz
;
236 * struct auxtrace_mmap - records an mmap of the auxtrace buffer.
237 * @base: address of mapped area
238 * @userpg: pointer to buffer's perf_event_mmap_page
239 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
240 * @len: size of mapped area
241 * @prev: previous aux_head
242 * @idx: index of this mmap
243 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
245 * @cpu: cpu number for a per-cpu mmap otherwise %-1
247 struct auxtrace_mmap
{
259 * struct auxtrace_mmap_params - parameters to set up struct auxtrace_mmap.
260 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
261 * @offset: file offset of mapped area
262 * @len: size of mapped area
263 * @prot: mmap memory protection
264 * @idx: index of this mmap
265 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
267 * @cpu: cpu number for a per-cpu mmap otherwise %-1
269 struct auxtrace_mmap_params
{
280 * struct auxtrace_record - callbacks for recording AUX area data.
281 * @recording_options: validate and process recording options
282 * @info_priv_size: return the size of the private data in auxtrace_info_event
283 * @info_fill: fill-in the private data in auxtrace_info_event
284 * @free: free this auxtrace record structure
285 * @snapshot_start: starting a snapshot
286 * @snapshot_finish: finishing a snapshot
287 * @find_snapshot: find data to snapshot within auxtrace mmap
288 * @parse_snapshot_options: parse snapshot options
289 * @reference: provide a 64-bit reference number for auxtrace_event
290 * @read_finish: called after reading from an auxtrace mmap
292 struct auxtrace_record
{
293 int (*recording_options
)(struct auxtrace_record
*itr
,
294 struct perf_evlist
*evlist
,
295 struct record_opts
*opts
);
296 size_t (*info_priv_size
)(struct auxtrace_record
*itr
);
297 int (*info_fill
)(struct auxtrace_record
*itr
,
298 struct perf_session
*session
,
299 struct auxtrace_info_event
*auxtrace_info
,
301 void (*free
)(struct auxtrace_record
*itr
);
302 int (*snapshot_start
)(struct auxtrace_record
*itr
);
303 int (*snapshot_finish
)(struct auxtrace_record
*itr
);
304 int (*find_snapshot
)(struct auxtrace_record
*itr
, int idx
,
305 struct auxtrace_mmap
*mm
, unsigned char *data
,
306 u64
*head
, u64
*old
);
307 int (*parse_snapshot_options
)(struct auxtrace_record
*itr
,
308 struct record_opts
*opts
,
310 u64 (*reference
)(struct auxtrace_record
*itr
);
311 int (*read_finish
)(struct auxtrace_record
*itr
, int idx
);
312 unsigned int alignment
;
315 #ifdef HAVE_AUXTRACE_SUPPORT
318 * In snapshot mode the mmapped page is read-only which makes using
319 * __sync_val_compare_and_swap() problematic. However, snapshot mode expects
320 * the buffer is not updated while the snapshot is made (e.g. Intel PT disables
321 * the event) so there is not a race anyway.
323 static inline u64
auxtrace_mmap__read_snapshot_head(struct auxtrace_mmap
*mm
)
325 struct perf_event_mmap_page
*pc
= mm
->userpg
;
326 u64 head
= ACCESS_ONCE(pc
->aux_head
);
328 /* Ensure all reads are done after we read the head */
333 static inline u64
auxtrace_mmap__read_head(struct auxtrace_mmap
*mm
)
335 struct perf_event_mmap_page
*pc
= mm
->userpg
;
336 #if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
337 u64 head
= ACCESS_ONCE(pc
->aux_head
);
339 u64 head
= __sync_val_compare_and_swap(&pc
->aux_head
, 0, 0);
342 /* Ensure all reads are done after we read the head */
347 static inline void auxtrace_mmap__write_tail(struct auxtrace_mmap
*mm
, u64 tail
)
349 struct perf_event_mmap_page
*pc
= mm
->userpg
;
350 #if BITS_PER_LONG != 64 && defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
354 /* Ensure all reads are done before we write the tail out */
356 #if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
360 old_tail
= __sync_val_compare_and_swap(&pc
->aux_tail
, 0, 0);
361 } while (!__sync_bool_compare_and_swap(&pc
->aux_tail
, old_tail
, tail
));
365 int auxtrace_mmap__mmap(struct auxtrace_mmap
*mm
,
366 struct auxtrace_mmap_params
*mp
,
367 void *userpg
, int fd
);
368 void auxtrace_mmap__munmap(struct auxtrace_mmap
*mm
);
369 void auxtrace_mmap_params__init(struct auxtrace_mmap_params
*mp
,
370 off_t auxtrace_offset
,
371 unsigned int auxtrace_pages
,
372 bool auxtrace_overwrite
);
373 void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params
*mp
,
374 struct perf_evlist
*evlist
, int idx
,
377 typedef int (*process_auxtrace_t
)(struct perf_tool
*tool
,
378 union perf_event
*event
, void *data1
,
379 size_t len1
, void *data2
, size_t len2
);
381 int auxtrace_mmap__read(struct auxtrace_mmap
*mm
, struct auxtrace_record
*itr
,
382 struct perf_tool
*tool
, process_auxtrace_t fn
);
384 int auxtrace_mmap__read_snapshot(struct auxtrace_mmap
*mm
,
385 struct auxtrace_record
*itr
,
386 struct perf_tool
*tool
, process_auxtrace_t fn
,
387 size_t snapshot_size
);
389 int auxtrace_queues__init(struct auxtrace_queues
*queues
);
390 int auxtrace_queues__add_event(struct auxtrace_queues
*queues
,
391 struct perf_session
*session
,
392 union perf_event
*event
, off_t data_offset
,
393 struct auxtrace_buffer
**buffer_ptr
);
394 void auxtrace_queues__free(struct auxtrace_queues
*queues
);
395 int auxtrace_queues__process_index(struct auxtrace_queues
*queues
,
396 struct perf_session
*session
);
397 struct auxtrace_buffer
*auxtrace_buffer__next(struct auxtrace_queue
*queue
,
398 struct auxtrace_buffer
*buffer
);
399 void *auxtrace_buffer__get_data(struct auxtrace_buffer
*buffer
, int fd
);
400 void auxtrace_buffer__put_data(struct auxtrace_buffer
*buffer
);
401 void auxtrace_buffer__drop_data(struct auxtrace_buffer
*buffer
);
402 void auxtrace_buffer__free(struct auxtrace_buffer
*buffer
);
404 int auxtrace_heap__add(struct auxtrace_heap
*heap
, unsigned int queue_nr
,
406 void auxtrace_heap__pop(struct auxtrace_heap
*heap
);
407 void auxtrace_heap__free(struct auxtrace_heap
*heap
);
409 struct auxtrace_cache_entry
{
410 struct hlist_node hash
;
414 struct auxtrace_cache
*auxtrace_cache__new(unsigned int bits
, size_t entry_size
,
415 unsigned int limit_percent
);
416 void auxtrace_cache__free(struct auxtrace_cache
*auxtrace_cache
);
417 void *auxtrace_cache__alloc_entry(struct auxtrace_cache
*c
);
418 void auxtrace_cache__free_entry(struct auxtrace_cache
*c
, void *entry
);
419 int auxtrace_cache__add(struct auxtrace_cache
*c
, u32 key
,
420 struct auxtrace_cache_entry
*entry
);
421 void *auxtrace_cache__lookup(struct auxtrace_cache
*c
, u32 key
);
423 struct auxtrace_record
*auxtrace_record__init(struct perf_evlist
*evlist
,
426 int auxtrace_parse_snapshot_options(struct auxtrace_record
*itr
,
427 struct record_opts
*opts
,
429 int auxtrace_record__options(struct auxtrace_record
*itr
,
430 struct perf_evlist
*evlist
,
431 struct record_opts
*opts
);
432 size_t auxtrace_record__info_priv_size(struct auxtrace_record
*itr
);
433 int auxtrace_record__info_fill(struct auxtrace_record
*itr
,
434 struct perf_session
*session
,
435 struct auxtrace_info_event
*auxtrace_info
,
437 void auxtrace_record__free(struct auxtrace_record
*itr
);
438 int auxtrace_record__snapshot_start(struct auxtrace_record
*itr
);
439 int auxtrace_record__snapshot_finish(struct auxtrace_record
*itr
);
440 int auxtrace_record__find_snapshot(struct auxtrace_record
*itr
, int idx
,
441 struct auxtrace_mmap
*mm
,
442 unsigned char *data
, u64
*head
, u64
*old
);
443 u64
auxtrace_record__reference(struct auxtrace_record
*itr
);
445 int auxtrace_index__auxtrace_event(struct list_head
*head
, union perf_event
*event
,
447 int auxtrace_index__write(int fd
, struct list_head
*head
);
448 int auxtrace_index__process(int fd
, u64 size
, struct perf_session
*session
,
450 void auxtrace_index__free(struct list_head
*head
);
452 void auxtrace_synth_error(struct auxtrace_error_event
*auxtrace_error
, int type
,
453 int code
, int cpu
, pid_t pid
, pid_t tid
, u64 ip
,
456 int perf_event__synthesize_auxtrace_info(struct auxtrace_record
*itr
,
457 struct perf_tool
*tool
,
458 struct perf_session
*session
,
459 perf_event__handler_t process
);
460 int perf_event__process_auxtrace_info(struct perf_tool
*tool
,
461 union perf_event
*event
,
462 struct perf_session
*session
);
463 s64
perf_event__process_auxtrace(struct perf_tool
*tool
,
464 union perf_event
*event
,
465 struct perf_session
*session
);
466 int perf_event__process_auxtrace_error(struct perf_tool
*tool
,
467 union perf_event
*event
,
468 struct perf_session
*session
);
469 int itrace_parse_synth_opts(const struct option
*opt
, const char *str
,
471 void itrace_synth_opts__set_default(struct itrace_synth_opts
*synth_opts
);
473 size_t perf_event__fprintf_auxtrace_error(union perf_event
*event
, FILE *fp
);
474 void perf_session__auxtrace_error_inc(struct perf_session
*session
,
475 union perf_event
*event
);
476 void events_stats__auxtrace_error_warn(const struct events_stats
*stats
);
478 static inline int auxtrace__process_event(struct perf_session
*session
,
479 union perf_event
*event
,
480 struct perf_sample
*sample
,
481 struct perf_tool
*tool
)
483 if (!session
->auxtrace
)
486 return session
->auxtrace
->process_event(session
, event
, sample
, tool
);
489 static inline int auxtrace__flush_events(struct perf_session
*session
,
490 struct perf_tool
*tool
)
492 if (!session
->auxtrace
)
495 return session
->auxtrace
->flush_events(session
, tool
);
498 static inline void auxtrace__free_events(struct perf_session
*session
)
500 if (!session
->auxtrace
)
503 return session
->auxtrace
->free_events(session
);
506 static inline void auxtrace__free(struct perf_session
*session
)
508 if (!session
->auxtrace
)
511 return session
->auxtrace
->free(session
);
516 static inline struct auxtrace_record
*
517 auxtrace_record__init(struct perf_evlist
*evlist __maybe_unused
,
518 int *err __maybe_unused
)
525 void auxtrace_record__free(struct auxtrace_record
*itr __maybe_unused
)
530 perf_event__synthesize_auxtrace_info(struct auxtrace_record
*itr __maybe_unused
,
531 struct perf_tool
*tool __maybe_unused
,
532 struct perf_session
*session __maybe_unused
,
533 perf_event__handler_t process __maybe_unused
)
539 int auxtrace_record__options(struct auxtrace_record
*itr __maybe_unused
,
540 struct perf_evlist
*evlist __maybe_unused
,
541 struct record_opts
*opts __maybe_unused
)
546 #define perf_event__process_auxtrace_info 0
547 #define perf_event__process_auxtrace 0
548 #define perf_event__process_auxtrace_error 0
551 void perf_session__auxtrace_error_inc(struct perf_session
*session
553 union perf_event
*event
559 void events_stats__auxtrace_error_warn(const struct events_stats
*stats
565 int itrace_parse_synth_opts(const struct option
*opt __maybe_unused
,
566 const char *str __maybe_unused
,
567 int unset __maybe_unused
)
569 pr_err("AUX area tracing not supported\n");
574 int auxtrace_parse_snapshot_options(struct auxtrace_record
*itr __maybe_unused
,
575 struct record_opts
*opts __maybe_unused
,
580 pr_err("AUX area tracing not supported\n");
585 int auxtrace__process_event(struct perf_session
*session __maybe_unused
,
586 union perf_event
*event __maybe_unused
,
587 struct perf_sample
*sample __maybe_unused
,
588 struct perf_tool
*tool __maybe_unused
)
594 int auxtrace__flush_events(struct perf_session
*session __maybe_unused
,
595 struct perf_tool
*tool __maybe_unused
)
601 void auxtrace__free_events(struct perf_session
*session __maybe_unused
)
606 void auxtrace_cache__free(struct auxtrace_cache
*auxtrace_cache __maybe_unused
)
611 void auxtrace__free(struct perf_session
*session __maybe_unused
)
616 int auxtrace_index__write(int fd __maybe_unused
,
617 struct list_head
*head __maybe_unused
)
623 int auxtrace_index__process(int fd __maybe_unused
,
624 u64 size __maybe_unused
,
625 struct perf_session
*session __maybe_unused
,
626 bool needs_swap __maybe_unused
)
632 void auxtrace_index__free(struct list_head
*head __maybe_unused
)
636 int auxtrace_mmap__mmap(struct auxtrace_mmap
*mm
,
637 struct auxtrace_mmap_params
*mp
,
638 void *userpg
, int fd
);
639 void auxtrace_mmap__munmap(struct auxtrace_mmap
*mm
);
640 void auxtrace_mmap_params__init(struct auxtrace_mmap_params
*mp
,
641 off_t auxtrace_offset
,
642 unsigned int auxtrace_pages
,
643 bool auxtrace_overwrite
);
644 void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params
*mp
,
645 struct perf_evlist
*evlist
, int idx
,