Loading...
1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * auxtrace.h: AUX area trace support
4 * Copyright (c) 2013-2015, Intel Corporation.
5 */
6
7#ifndef __PERF_AUXTRACE_H
8#define __PERF_AUXTRACE_H
9
10#include <sys/types.h>
11#include <errno.h>
12#include <stdbool.h>
13#include <stddef.h>
14#include <stdio.h> // FILE
15#include <linux/list.h>
16#include <linux/perf_event.h>
17#include <linux/types.h>
18#include <asm/bitsperlong.h>
19#include <asm/barrier.h>
20
21union perf_event;
22struct perf_session;
23struct evlist;
24struct perf_tool;
25struct mmap;
26struct perf_sample;
27struct option;
28struct record_opts;
29struct perf_record_auxtrace_error;
30struct perf_record_auxtrace_info;
31struct events_stats;
32
33enum auxtrace_error_type {
34 PERF_AUXTRACE_ERROR_ITRACE = 1,
35 PERF_AUXTRACE_ERROR_MAX
36};
37
38/* Auxtrace records must have the same alignment as perf event records */
39#define PERF_AUXTRACE_RECORD_ALIGNMENT 8
40
41enum auxtrace_type {
42 PERF_AUXTRACE_UNKNOWN,
43 PERF_AUXTRACE_INTEL_PT,
44 PERF_AUXTRACE_INTEL_BTS,
45 PERF_AUXTRACE_CS_ETM,
46 PERF_AUXTRACE_ARM_SPE,
47 PERF_AUXTRACE_S390_CPUMSF,
48};
49
50enum itrace_period_type {
51 PERF_ITRACE_PERIOD_INSTRUCTIONS,
52 PERF_ITRACE_PERIOD_TICKS,
53 PERF_ITRACE_PERIOD_NANOSECS,
54};
55
56/**
57 * struct itrace_synth_opts - AUX area tracing synthesis options.
58 * @set: indicates whether or not options have been set
59 * @default_no_sample: Default to no sampling.
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 * @other_events: whether to synthesize other events recorded due to the use of
68 * aux_output
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
83 * @ptime_range: time intervals to trace or NULL
84 * @range_num: number of time intervals to trace
85 */
86struct itrace_synth_opts {
87 bool set;
88 bool default_no_sample;
89 bool inject;
90 bool instructions;
91 bool branches;
92 bool transactions;
93 bool ptwrites;
94 bool pwr_events;
95 bool other_events;
96 bool errors;
97 bool dont_decode;
98 bool log;
99 bool calls;
100 bool returns;
101 bool callchain;
102 bool thread_stack;
103 bool last_branch;
104 unsigned int callchain_sz;
105 unsigned int last_branch_sz;
106 unsigned long long period;
107 enum itrace_period_type period_type;
108 unsigned long initial_skip;
109 unsigned long *cpu_bitmap;
110 struct perf_time_interval *ptime_range;
111 int range_num;
112};
113
114/**
115 * struct auxtrace_index_entry - indexes a AUX area tracing event within a
116 * perf.data file.
117 * @file_offset: offset within the perf.data file
118 * @sz: size of the event
119 */
120struct auxtrace_index_entry {
121 u64 file_offset;
122 u64 sz;
123};
124
125#define PERF_AUXTRACE_INDEX_ENTRY_COUNT 256
126
127/**
128 * struct auxtrace_index - index of AUX area tracing events within a perf.data
129 * file.
130 * @list: linking a number of arrays of entries
131 * @nr: number of entries
132 * @entries: array of entries
133 */
134struct auxtrace_index {
135 struct list_head list;
136 size_t nr;
137 struct auxtrace_index_entry entries[PERF_AUXTRACE_INDEX_ENTRY_COUNT];
138};
139
140/**
141 * struct auxtrace - session callbacks to allow AUX area data decoding.
142 * @process_event: lets the decoder see all session events
143 * @process_auxtrace_event: process a PERF_RECORD_AUXTRACE event
144 * @flush_events: process any remaining data
145 * @free_events: free resources associated with event processing
146 * @free: free resources associated with the session
147 */
148struct auxtrace {
149 int (*process_event)(struct perf_session *session,
150 union perf_event *event,
151 struct perf_sample *sample,
152 struct perf_tool *tool);
153 int (*process_auxtrace_event)(struct perf_session *session,
154 union perf_event *event,
155 struct perf_tool *tool);
156 int (*flush_events)(struct perf_session *session,
157 struct perf_tool *tool);
158 void (*free_events)(struct perf_session *session);
159 void (*free)(struct perf_session *session);
160};
161
162/**
163 * struct auxtrace_buffer - a buffer containing AUX area tracing data.
164 * @list: buffers are queued in a list held by struct auxtrace_queue
165 * @size: size of the buffer in bytes
166 * @pid: in per-thread mode, the pid this buffer is associated with
167 * @tid: in per-thread mode, the tid this buffer is associated with
168 * @cpu: in per-cpu mode, the cpu this buffer is associated with
169 * @data: actual buffer data (can be null if the data has not been loaded)
170 * @data_offset: file offset at which the buffer can be read
171 * @mmap_addr: mmap address at which the buffer can be read
172 * @mmap_size: size of the mmap at @mmap_addr
173 * @data_needs_freeing: @data was malloc'd so free it when it is no longer
174 * needed
175 * @consecutive: the original data was split up and this buffer is consecutive
176 * to the previous buffer
177 * @offset: offset as determined by aux_head / aux_tail members of struct
178 * perf_event_mmap_page
179 * @reference: an implementation-specific reference determined when the data is
180 * recorded
181 * @buffer_nr: used to number each buffer
182 * @use_size: implementation actually only uses this number of bytes
183 * @use_data: implementation actually only uses data starting at this address
184 */
185struct auxtrace_buffer {
186 struct list_head list;
187 size_t size;
188 pid_t pid;
189 pid_t tid;
190 int cpu;
191 void *data;
192 off_t data_offset;
193 void *mmap_addr;
194 size_t mmap_size;
195 bool data_needs_freeing;
196 bool consecutive;
197 u64 offset;
198 u64 reference;
199 u64 buffer_nr;
200 size_t use_size;
201 void *use_data;
202};
203
204/**
205 * struct auxtrace_queue - a queue of AUX area tracing data buffers.
206 * @head: head of buffer list
207 * @tid: in per-thread mode, the tid this queue is associated with
208 * @cpu: in per-cpu mode, the cpu this queue is associated with
209 * @set: %true once this queue has been dedicated to a specific thread or cpu
210 * @priv: implementation-specific data
211 */
212struct auxtrace_queue {
213 struct list_head head;
214 pid_t tid;
215 int cpu;
216 bool set;
217 void *priv;
218};
219
220/**
221 * struct auxtrace_queues - an array of AUX area tracing queues.
222 * @queue_array: array of queues
223 * @nr_queues: number of queues
224 * @new_data: set whenever new data is queued
225 * @populated: queues have been fully populated using the auxtrace_index
226 * @next_buffer_nr: used to number each buffer
227 */
228struct auxtrace_queues {
229 struct auxtrace_queue *queue_array;
230 unsigned int nr_queues;
231 bool new_data;
232 bool populated;
233 u64 next_buffer_nr;
234};
235
236/**
237 * struct auxtrace_heap_item - element of struct auxtrace_heap.
238 * @queue_nr: queue number
239 * @ordinal: value used for sorting (lowest ordinal is top of the heap) expected
240 * to be a timestamp
241 */
242struct auxtrace_heap_item {
243 unsigned int queue_nr;
244 u64 ordinal;
245};
246
247/**
248 * struct auxtrace_heap - a heap suitable for sorting AUX area tracing queues.
249 * @heap_array: the heap
250 * @heap_cnt: the number of elements in the heap
251 * @heap_sz: maximum number of elements (grows as needed)
252 */
253struct auxtrace_heap {
254 struct auxtrace_heap_item *heap_array;
255 unsigned int heap_cnt;
256 unsigned int heap_sz;
257};
258
259/**
260 * struct auxtrace_mmap - records an mmap of the auxtrace buffer.
261 * @base: address of mapped area
262 * @userpg: pointer to buffer's perf_event_mmap_page
263 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
264 * @len: size of mapped area
265 * @prev: previous aux_head
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
268 * mmap) otherwise %0
269 * @cpu: cpu number for a per-cpu mmap otherwise %-1
270 */
271struct auxtrace_mmap {
272 void *base;
273 void *userpg;
274 size_t mask;
275 size_t len;
276 u64 prev;
277 int idx;
278 pid_t tid;
279 int cpu;
280};
281
282/**
283 * struct auxtrace_mmap_params - parameters to set up struct auxtrace_mmap.
284 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
285 * @offset: file offset of mapped area
286 * @len: size of mapped area
287 * @prot: mmap memory protection
288 * @idx: index of this mmap
289 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
290 * mmap) otherwise %0
291 * @cpu: cpu number for a per-cpu mmap otherwise %-1
292 */
293struct auxtrace_mmap_params {
294 size_t mask;
295 off_t offset;
296 size_t len;
297 int prot;
298 int idx;
299 pid_t tid;
300 int cpu;
301};
302
303/**
304 * struct auxtrace_record - callbacks for recording AUX area data.
305 * @recording_options: validate and process recording options
306 * @info_priv_size: return the size of the private data in auxtrace_info_event
307 * @info_fill: fill-in the private data in auxtrace_info_event
308 * @free: free this auxtrace record structure
309 * @snapshot_start: starting a snapshot
310 * @snapshot_finish: finishing a snapshot
311 * @find_snapshot: find data to snapshot within auxtrace mmap
312 * @parse_snapshot_options: parse snapshot options
313 * @reference: provide a 64-bit reference number for auxtrace_event
314 * @read_finish: called after reading from an auxtrace mmap
315 * @alignment: alignment (if any) for AUX area data
316 */
317struct auxtrace_record {
318 int (*recording_options)(struct auxtrace_record *itr,
319 struct evlist *evlist,
320 struct record_opts *opts);
321 size_t (*info_priv_size)(struct auxtrace_record *itr,
322 struct evlist *evlist);
323 int (*info_fill)(struct auxtrace_record *itr,
324 struct perf_session *session,
325 struct perf_record_auxtrace_info *auxtrace_info,
326 size_t priv_size);
327 void (*free)(struct auxtrace_record *itr);
328 int (*snapshot_start)(struct auxtrace_record *itr);
329 int (*snapshot_finish)(struct auxtrace_record *itr);
330 int (*find_snapshot)(struct auxtrace_record *itr, int idx,
331 struct auxtrace_mmap *mm, unsigned char *data,
332 u64 *head, u64 *old);
333 int (*parse_snapshot_options)(struct auxtrace_record *itr,
334 struct record_opts *opts,
335 const char *str);
336 u64 (*reference)(struct auxtrace_record *itr);
337 int (*read_finish)(struct auxtrace_record *itr, int idx);
338 unsigned int alignment;
339};
340
341/**
342 * struct addr_filter - address filter.
343 * @list: list node
344 * @range: true if it is a range filter
345 * @start: true if action is 'filter' or 'start'
346 * @action: 'filter', 'start' or 'stop' ('tracestop' is accepted but converted
347 * to 'stop')
348 * @sym_from: symbol name for the filter address
349 * @sym_to: symbol name that determines the filter size
350 * @sym_from_idx: selects n'th from symbols with the same name (0 means global
351 * and less than 0 means symbol must be unique)
352 * @sym_to_idx: same as @sym_from_idx but for @sym_to
353 * @addr: filter address
354 * @size: filter region size (for range filters)
355 * @filename: DSO file name or NULL for the kernel
356 * @str: allocated string that contains the other string members
357 */
358struct addr_filter {
359 struct list_head list;
360 bool range;
361 bool start;
362 const char *action;
363 const char *sym_from;
364 const char *sym_to;
365 int sym_from_idx;
366 int sym_to_idx;
367 u64 addr;
368 u64 size;
369 const char *filename;
370 char *str;
371};
372
373/**
374 * struct addr_filters - list of address filters.
375 * @head: list of address filters
376 * @cnt: number of address filters
377 */
378struct addr_filters {
379 struct list_head head;
380 int cnt;
381};
382
383struct auxtrace_cache;
384
385#ifdef HAVE_AUXTRACE_SUPPORT
386
387/*
388 * In snapshot mode the mmapped page is read-only which makes using
389 * __sync_val_compare_and_swap() problematic. However, snapshot mode expects
390 * the buffer is not updated while the snapshot is made (e.g. Intel PT disables
391 * the event) so there is not a race anyway.
392 */
393static inline u64 auxtrace_mmap__read_snapshot_head(struct auxtrace_mmap *mm)
394{
395 struct perf_event_mmap_page *pc = mm->userpg;
396 u64 head = READ_ONCE(pc->aux_head);
397
398 /* Ensure all reads are done after we read the head */
399 rmb();
400 return head;
401}
402
403static inline u64 auxtrace_mmap__read_head(struct auxtrace_mmap *mm)
404{
405 struct perf_event_mmap_page *pc = mm->userpg;
406#if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
407 u64 head = READ_ONCE(pc->aux_head);
408#else
409 u64 head = __sync_val_compare_and_swap(&pc->aux_head, 0, 0);
410#endif
411
412 /* Ensure all reads are done after we read the head */
413 rmb();
414 return head;
415}
416
417static inline void auxtrace_mmap__write_tail(struct auxtrace_mmap *mm, u64 tail)
418{
419 struct perf_event_mmap_page *pc = mm->userpg;
420#if BITS_PER_LONG != 64 && defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
421 u64 old_tail;
422#endif
423
424 /* Ensure all reads are done before we write the tail out */
425 mb();
426#if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
427 pc->aux_tail = tail;
428#else
429 do {
430 old_tail = __sync_val_compare_and_swap(&pc->aux_tail, 0, 0);
431 } while (!__sync_bool_compare_and_swap(&pc->aux_tail, old_tail, tail));
432#endif
433}
434
435int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
436 struct auxtrace_mmap_params *mp,
437 void *userpg, int fd);
438void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
439void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
440 off_t auxtrace_offset,
441 unsigned int auxtrace_pages,
442 bool auxtrace_overwrite);
443void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
444 struct evlist *evlist, int idx,
445 bool per_cpu);
446
447typedef int (*process_auxtrace_t)(struct perf_tool *tool,
448 struct mmap *map,
449 union perf_event *event, void *data1,
450 size_t len1, void *data2, size_t len2);
451
452int auxtrace_mmap__read(struct mmap *map, struct auxtrace_record *itr,
453 struct perf_tool *tool, process_auxtrace_t fn);
454
455int auxtrace_mmap__read_snapshot(struct mmap *map,
456 struct auxtrace_record *itr,
457 struct perf_tool *tool, process_auxtrace_t fn,
458 size_t snapshot_size);
459
460int auxtrace_queues__init(struct auxtrace_queues *queues);
461int auxtrace_queues__add_event(struct auxtrace_queues *queues,
462 struct perf_session *session,
463 union perf_event *event, off_t data_offset,
464 struct auxtrace_buffer **buffer_ptr);
465void auxtrace_queues__free(struct auxtrace_queues *queues);
466int auxtrace_queues__process_index(struct auxtrace_queues *queues,
467 struct perf_session *session);
468struct auxtrace_buffer *auxtrace_buffer__next(struct auxtrace_queue *queue,
469 struct auxtrace_buffer *buffer);
470void *auxtrace_buffer__get_data(struct auxtrace_buffer *buffer, int fd);
471void auxtrace_buffer__put_data(struct auxtrace_buffer *buffer);
472void auxtrace_buffer__drop_data(struct auxtrace_buffer *buffer);
473void auxtrace_buffer__free(struct auxtrace_buffer *buffer);
474
475int auxtrace_heap__add(struct auxtrace_heap *heap, unsigned int queue_nr,
476 u64 ordinal);
477void auxtrace_heap__pop(struct auxtrace_heap *heap);
478void auxtrace_heap__free(struct auxtrace_heap *heap);
479
480struct auxtrace_cache_entry {
481 struct hlist_node hash;
482 u32 key;
483};
484
485struct auxtrace_cache *auxtrace_cache__new(unsigned int bits, size_t entry_size,
486 unsigned int limit_percent);
487void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache);
488void *auxtrace_cache__alloc_entry(struct auxtrace_cache *c);
489void auxtrace_cache__free_entry(struct auxtrace_cache *c, void *entry);
490int auxtrace_cache__add(struct auxtrace_cache *c, u32 key,
491 struct auxtrace_cache_entry *entry);
492void *auxtrace_cache__lookup(struct auxtrace_cache *c, u32 key);
493
494struct auxtrace_record *auxtrace_record__init(struct evlist *evlist,
495 int *err);
496
497int auxtrace_parse_snapshot_options(struct auxtrace_record *itr,
498 struct record_opts *opts,
499 const char *str);
500int auxtrace_record__options(struct auxtrace_record *itr,
501 struct evlist *evlist,
502 struct record_opts *opts);
503size_t auxtrace_record__info_priv_size(struct auxtrace_record *itr,
504 struct evlist *evlist);
505int auxtrace_record__info_fill(struct auxtrace_record *itr,
506 struct perf_session *session,
507 struct perf_record_auxtrace_info *auxtrace_info,
508 size_t priv_size);
509void auxtrace_record__free(struct auxtrace_record *itr);
510int auxtrace_record__snapshot_start(struct auxtrace_record *itr);
511int auxtrace_record__snapshot_finish(struct auxtrace_record *itr, bool on_exit);
512int auxtrace_record__find_snapshot(struct auxtrace_record *itr, int idx,
513 struct auxtrace_mmap *mm,
514 unsigned char *data, u64 *head, u64 *old);
515u64 auxtrace_record__reference(struct auxtrace_record *itr);
516
517int auxtrace_index__auxtrace_event(struct list_head *head, union perf_event *event,
518 off_t file_offset);
519int auxtrace_index__write(int fd, struct list_head *head);
520int auxtrace_index__process(int fd, u64 size, struct perf_session *session,
521 bool needs_swap);
522void auxtrace_index__free(struct list_head *head);
523
524void auxtrace_synth_error(struct perf_record_auxtrace_error *auxtrace_error, int type,
525 int code, int cpu, pid_t pid, pid_t tid, u64 ip,
526 const char *msg, u64 timestamp);
527
528int perf_event__process_auxtrace_info(struct perf_session *session,
529 union perf_event *event);
530s64 perf_event__process_auxtrace(struct perf_session *session,
531 union perf_event *event);
532int perf_event__process_auxtrace_error(struct perf_session *session,
533 union perf_event *event);
534int itrace_parse_synth_opts(const struct option *opt, const char *str,
535 int unset);
536void itrace_synth_opts__set_default(struct itrace_synth_opts *synth_opts,
537 bool no_sample);
538
539size_t perf_event__fprintf_auxtrace_error(union perf_event *event, FILE *fp);
540void perf_session__auxtrace_error_inc(struct perf_session *session,
541 union perf_event *event);
542void events_stats__auxtrace_error_warn(const struct events_stats *stats);
543
544void addr_filters__init(struct addr_filters *filts);
545void addr_filters__exit(struct addr_filters *filts);
546int addr_filters__parse_bare_filter(struct addr_filters *filts,
547 const char *filter);
548int auxtrace_parse_filters(struct evlist *evlist);
549
550int auxtrace__process_event(struct perf_session *session, union perf_event *event,
551 struct perf_sample *sample, struct perf_tool *tool);
552int auxtrace__flush_events(struct perf_session *session, struct perf_tool *tool);
553void auxtrace__free_events(struct perf_session *session);
554void auxtrace__free(struct perf_session *session);
555
556#define ITRACE_HELP \
557" i: synthesize instructions events\n" \
558" b: synthesize branches events\n" \
559" c: synthesize branches events (calls only)\n" \
560" r: synthesize branches events (returns only)\n" \
561" x: synthesize transactions events\n" \
562" w: synthesize ptwrite events\n" \
563" p: synthesize power events\n" \
564" e: synthesize error events\n" \
565" d: create a debug log\n" \
566" g[len]: synthesize a call chain (use with i or x)\n" \
567" l[len]: synthesize last branch entries (use with i or x)\n" \
568" sNUMBER: skip initial number of events\n" \
569" PERIOD[ns|us|ms|i|t]: specify period to sample stream\n" \
570" concatenate multiple options. Default is ibxwpe or cewp\n"
571
572static inline
573void itrace_synth_opts__set_time_range(struct itrace_synth_opts *opts,
574 struct perf_time_interval *ptime_range,
575 int range_num)
576{
577 opts->ptime_range = ptime_range;
578 opts->range_num = range_num;
579}
580
581static inline
582void itrace_synth_opts__clear_time_range(struct itrace_synth_opts *opts)
583{
584 opts->ptime_range = NULL;
585 opts->range_num = 0;
586}
587
588#else
589#include "debug.h"
590
591static inline struct auxtrace_record *
592auxtrace_record__init(struct evlist *evlist __maybe_unused,
593 int *err)
594{
595 *err = 0;
596 return NULL;
597}
598
599static inline
600void auxtrace_record__free(struct auxtrace_record *itr __maybe_unused)
601{
602}
603
604static inline
605int auxtrace_record__options(struct auxtrace_record *itr __maybe_unused,
606 struct evlist *evlist __maybe_unused,
607 struct record_opts *opts __maybe_unused)
608{
609 return 0;
610}
611
612#define perf_event__process_auxtrace_info 0
613#define perf_event__process_auxtrace 0
614#define perf_event__process_auxtrace_error 0
615
616static inline
617void perf_session__auxtrace_error_inc(struct perf_session *session
618 __maybe_unused,
619 union perf_event *event
620 __maybe_unused)
621{
622}
623
624static inline
625void events_stats__auxtrace_error_warn(const struct events_stats *stats
626 __maybe_unused)
627{
628}
629
630static inline
631int itrace_parse_synth_opts(const struct option *opt __maybe_unused,
632 const char *str __maybe_unused,
633 int unset __maybe_unused)
634{
635 pr_err("AUX area tracing not supported\n");
636 return -EINVAL;
637}
638
639static inline
640int auxtrace_parse_snapshot_options(struct auxtrace_record *itr __maybe_unused,
641 struct record_opts *opts __maybe_unused,
642 const char *str)
643{
644 if (!str)
645 return 0;
646 pr_err("AUX area tracing not supported\n");
647 return -EINVAL;
648}
649
650static inline
651int auxtrace__process_event(struct perf_session *session __maybe_unused,
652 union perf_event *event __maybe_unused,
653 struct perf_sample *sample __maybe_unused,
654 struct perf_tool *tool __maybe_unused)
655{
656 return 0;
657}
658
659static inline
660int auxtrace__flush_events(struct perf_session *session __maybe_unused,
661 struct perf_tool *tool __maybe_unused)
662{
663 return 0;
664}
665
666static inline
667void auxtrace__free_events(struct perf_session *session __maybe_unused)
668{
669}
670
671static inline
672void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache __maybe_unused)
673{
674}
675
676static inline
677void auxtrace__free(struct perf_session *session __maybe_unused)
678{
679}
680
681static inline
682int auxtrace_index__write(int fd __maybe_unused,
683 struct list_head *head __maybe_unused)
684{
685 return -EINVAL;
686}
687
688static inline
689int auxtrace_index__process(int fd __maybe_unused,
690 u64 size __maybe_unused,
691 struct perf_session *session __maybe_unused,
692 bool needs_swap __maybe_unused)
693{
694 return -EINVAL;
695}
696
697static inline
698void auxtrace_index__free(struct list_head *head __maybe_unused)
699{
700}
701
702static inline
703int auxtrace_parse_filters(struct evlist *evlist __maybe_unused)
704{
705 return 0;
706}
707
708int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
709 struct auxtrace_mmap_params *mp,
710 void *userpg, int fd);
711void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
712void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
713 off_t auxtrace_offset,
714 unsigned int auxtrace_pages,
715 bool auxtrace_overwrite);
716void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
717 struct evlist *evlist, int idx,
718 bool per_cpu);
719
720#define ITRACE_HELP ""
721
722static inline
723void itrace_synth_opts__set_time_range(struct itrace_synth_opts *opts
724 __maybe_unused,
725 struct perf_time_interval *ptime_range
726 __maybe_unused,
727 int range_num __maybe_unused)
728{
729}
730
731static inline
732void itrace_synth_opts__clear_time_range(struct itrace_synth_opts *opts
733 __maybe_unused)
734{
735}
736
737#endif
738
739#endif
1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * auxtrace.h: AUX area trace support
4 * Copyright (c) 2013-2015, Intel Corporation.
5 */
6
7#ifndef __PERF_AUXTRACE_H
8#define __PERF_AUXTRACE_H
9
10#include <sys/types.h>
11#include <errno.h>
12#include <stdbool.h>
13#include <stddef.h>
14#include <stdio.h> // FILE
15#include <linux/list.h>
16#include <linux/perf_event.h>
17#include <linux/types.h>
18#include <perf/cpumap.h>
19#include <asm/bitsperlong.h>
20#include <asm/barrier.h>
21
22union perf_event;
23struct perf_session;
24struct evlist;
25struct evsel;
26struct perf_tool;
27struct mmap;
28struct perf_sample;
29struct option;
30struct record_opts;
31struct perf_record_auxtrace_error;
32struct perf_record_auxtrace_info;
33struct events_stats;
34struct perf_pmu;
35
36enum auxtrace_error_type {
37 PERF_AUXTRACE_ERROR_ITRACE = 1,
38 PERF_AUXTRACE_ERROR_MAX
39};
40
41/* Auxtrace records must have the same alignment as perf event records */
42#define PERF_AUXTRACE_RECORD_ALIGNMENT 8
43
44enum auxtrace_type {
45 PERF_AUXTRACE_UNKNOWN,
46 PERF_AUXTRACE_INTEL_PT,
47 PERF_AUXTRACE_INTEL_BTS,
48 PERF_AUXTRACE_CS_ETM,
49 PERF_AUXTRACE_ARM_SPE,
50 PERF_AUXTRACE_S390_CPUMSF,
51 PERF_AUXTRACE_HISI_PTT,
52};
53
54enum itrace_period_type {
55 PERF_ITRACE_PERIOD_INSTRUCTIONS,
56 PERF_ITRACE_PERIOD_TICKS,
57 PERF_ITRACE_PERIOD_NANOSECS,
58};
59
60#define AUXTRACE_ERR_FLG_OVERFLOW (1 << ('o' - 'a'))
61#define AUXTRACE_ERR_FLG_DATA_LOST (1 << ('l' - 'a'))
62
63#define AUXTRACE_LOG_FLG_ALL_PERF_EVTS (1 << ('a' - 'a'))
64#define AUXTRACE_LOG_FLG_ON_ERROR (1 << ('e' - 'a'))
65#define AUXTRACE_LOG_FLG_USE_STDOUT (1 << ('o' - 'a'))
66
67/**
68 * struct itrace_synth_opts - AUX area tracing synthesis options.
69 * @set: indicates whether or not options have been set
70 * @default_no_sample: Default to no sampling.
71 * @inject: indicates the event (not just the sample) must be fully synthesized
72 * because 'perf inject' will write it out
73 * @instructions: whether to synthesize 'instructions' events
74 * @cycles: whether to synthesize 'cycles' events
75 * (not fully accurate, since CYC packets are only emitted
76 * together with other events, such as branches)
77 * @branches: whether to synthesize 'branches' events
78 * @transactions: whether to synthesize events for transactions
79 * @ptwrites: whether to synthesize events for ptwrites
80 * @pwr_events: whether to synthesize power events
81 * @other_events: whether to synthesize other events recorded due to the use of
82 * aux_output
83 * @intr_events: whether to synthesize interrupt events
84 * @errors: whether to synthesize decoder error events
85 * @dont_decode: whether to skip decoding entirely
86 * @log: write a decoding log
87 * @calls: limit branch samples to calls (can be combined with @returns)
88 * @returns: limit branch samples to returns (can be combined with @calls)
89 * @callchain: add callchain to 'instructions' events
90 * @add_callchain: add callchain to existing event records
91 * @thread_stack: feed branches to the thread_stack
92 * @last_branch: add branch context to 'instruction' events
93 * @add_last_branch: add branch context to existing event records
94 * @approx_ipc: approximate IPC
95 * @flc: whether to synthesize first level cache events
96 * @llc: whether to synthesize last level cache events
97 * @tlb: whether to synthesize TLB events
98 * @remote_access: whether to synthesize remote access events
99 * @mem: whether to synthesize memory events
100 * @timeless_decoding: prefer "timeless" decoding i.e. ignore timestamps
101 * @use_timestamp: use the timestamp trace as kernel time
102 * @vm_time_correlation: perform VM Time Correlation
103 * @vm_tm_corr_dry_run: VM Time Correlation dry-run
104 * @vm_tm_corr_args: VM Time Correlation implementation-specific arguments
105 * @callchain_sz: maximum callchain size
106 * @last_branch_sz: branch context size
107 * @period: 'instructions' events period
108 * @period_type: 'instructions' events period type
109 * @initial_skip: skip N events at the beginning.
110 * @cpu_bitmap: CPUs for which to synthesize events, or NULL for all
111 * @ptime_range: time intervals to trace or NULL
112 * @range_num: number of time intervals to trace
113 * @error_plus_flags: flags to affect what errors are reported
114 * @error_minus_flags: flags to affect what errors are reported
115 * @log_plus_flags: flags to affect what is logged
116 * @log_minus_flags: flags to affect what is logged
117 * @quick: quicker (less detailed) decoding
118 * @log_on_error_size: size of log to keep for outputting log only on errors
119 */
120struct itrace_synth_opts {
121 bool set;
122 bool default_no_sample;
123 bool inject;
124 bool instructions;
125 bool cycles;
126 bool branches;
127 bool transactions;
128 bool ptwrites;
129 bool pwr_events;
130 bool other_events;
131 bool intr_events;
132 bool errors;
133 bool dont_decode;
134 bool log;
135 bool calls;
136 bool returns;
137 bool callchain;
138 bool add_callchain;
139 bool thread_stack;
140 bool last_branch;
141 bool add_last_branch;
142 bool approx_ipc;
143 bool flc;
144 bool llc;
145 bool tlb;
146 bool remote_access;
147 bool mem;
148 bool timeless_decoding;
149 bool use_timestamp;
150 bool vm_time_correlation;
151 bool vm_tm_corr_dry_run;
152 char *vm_tm_corr_args;
153 unsigned int callchain_sz;
154 unsigned int last_branch_sz;
155 unsigned long long period;
156 enum itrace_period_type period_type;
157 unsigned long initial_skip;
158 unsigned long *cpu_bitmap;
159 struct perf_time_interval *ptime_range;
160 int range_num;
161 unsigned int error_plus_flags;
162 unsigned int error_minus_flags;
163 unsigned int log_plus_flags;
164 unsigned int log_minus_flags;
165 unsigned int quick;
166 unsigned int log_on_error_size;
167};
168
169/**
170 * struct auxtrace_index_entry - indexes a AUX area tracing event within a
171 * perf.data file.
172 * @file_offset: offset within the perf.data file
173 * @sz: size of the event
174 */
175struct auxtrace_index_entry {
176 u64 file_offset;
177 u64 sz;
178};
179
180#define PERF_AUXTRACE_INDEX_ENTRY_COUNT 256
181
182/**
183 * struct auxtrace_index - index of AUX area tracing events within a perf.data
184 * file.
185 * @list: linking a number of arrays of entries
186 * @nr: number of entries
187 * @entries: array of entries
188 */
189struct auxtrace_index {
190 struct list_head list;
191 size_t nr;
192 struct auxtrace_index_entry entries[PERF_AUXTRACE_INDEX_ENTRY_COUNT];
193};
194
195/**
196 * struct auxtrace - session callbacks to allow AUX area data decoding.
197 * @process_event: lets the decoder see all session events
198 * @process_auxtrace_event: process a PERF_RECORD_AUXTRACE event
199 * @queue_data: queue an AUX sample or PERF_RECORD_AUXTRACE event for later
200 * processing
201 * @dump_auxtrace_sample: dump AUX area sample data
202 * @flush_events: process any remaining data
203 * @free_events: free resources associated with event processing
204 * @free: free resources associated with the session
205 */
206struct auxtrace {
207 int (*process_event)(struct perf_session *session,
208 union perf_event *event,
209 struct perf_sample *sample,
210 const struct perf_tool *tool);
211 int (*process_auxtrace_event)(struct perf_session *session,
212 union perf_event *event,
213 const struct perf_tool *tool);
214 int (*queue_data)(struct perf_session *session,
215 struct perf_sample *sample, union perf_event *event,
216 u64 data_offset);
217 void (*dump_auxtrace_sample)(struct perf_session *session,
218 struct perf_sample *sample);
219 int (*flush_events)(struct perf_session *session,
220 const struct perf_tool *tool);
221 void (*free_events)(struct perf_session *session);
222 void (*free)(struct perf_session *session);
223 bool (*evsel_is_auxtrace)(struct perf_session *session,
224 struct evsel *evsel);
225};
226
227/**
228 * struct auxtrace_buffer - a buffer containing AUX area tracing data.
229 * @list: buffers are queued in a list held by struct auxtrace_queue
230 * @size: size of the buffer in bytes
231 * @pid: in per-thread mode, the pid this buffer is associated with
232 * @tid: in per-thread mode, the tid this buffer is associated with
233 * @cpu: in per-cpu mode, the cpu this buffer is associated with
234 * @data: actual buffer data (can be null if the data has not been loaded)
235 * @data_offset: file offset at which the buffer can be read
236 * @mmap_addr: mmap address at which the buffer can be read
237 * @mmap_size: size of the mmap at @mmap_addr
238 * @data_needs_freeing: @data was malloc'd so free it when it is no longer
239 * needed
240 * @consecutive: the original data was split up and this buffer is consecutive
241 * to the previous buffer
242 * @offset: offset as determined by aux_head / aux_tail members of struct
243 * perf_event_mmap_page
244 * @reference: an implementation-specific reference determined when the data is
245 * recorded
246 * @buffer_nr: used to number each buffer
247 * @use_size: implementation actually only uses this number of bytes
248 * @use_data: implementation actually only uses data starting at this address
249 */
250struct auxtrace_buffer {
251 struct list_head list;
252 size_t size;
253 pid_t pid;
254 pid_t tid;
255 struct perf_cpu cpu;
256 void *data;
257 off_t data_offset;
258 void *mmap_addr;
259 size_t mmap_size;
260 bool data_needs_freeing;
261 bool consecutive;
262 u64 offset;
263 u64 reference;
264 u64 buffer_nr;
265 size_t use_size;
266 void *use_data;
267};
268
269/**
270 * struct auxtrace_queue - a queue of AUX area tracing data buffers.
271 * @head: head of buffer list
272 * @tid: in per-thread mode, the tid this queue is associated with
273 * @cpu: in per-cpu mode, the cpu this queue is associated with
274 * @set: %true once this queue has been dedicated to a specific thread or cpu
275 * @priv: implementation-specific data
276 */
277struct auxtrace_queue {
278 struct list_head head;
279 pid_t tid;
280 int cpu;
281 bool set;
282 void *priv;
283};
284
285/**
286 * struct auxtrace_queues - an array of AUX area tracing queues.
287 * @queue_array: array of queues
288 * @nr_queues: number of queues
289 * @new_data: set whenever new data is queued
290 * @populated: queues have been fully populated using the auxtrace_index
291 * @next_buffer_nr: used to number each buffer
292 */
293struct auxtrace_queues {
294 struct auxtrace_queue *queue_array;
295 unsigned int nr_queues;
296 bool new_data;
297 bool populated;
298 u64 next_buffer_nr;
299};
300
301/**
302 * struct auxtrace_heap_item - element of struct auxtrace_heap.
303 * @queue_nr: queue number
304 * @ordinal: value used for sorting (lowest ordinal is top of the heap) expected
305 * to be a timestamp
306 */
307struct auxtrace_heap_item {
308 unsigned int queue_nr;
309 u64 ordinal;
310};
311
312/**
313 * struct auxtrace_heap - a heap suitable for sorting AUX area tracing queues.
314 * @heap_array: the heap
315 * @heap_cnt: the number of elements in the heap
316 * @heap_sz: maximum number of elements (grows as needed)
317 */
318struct auxtrace_heap {
319 struct auxtrace_heap_item *heap_array;
320 unsigned int heap_cnt;
321 unsigned int heap_sz;
322};
323
324/**
325 * struct auxtrace_mmap - records an mmap of the auxtrace buffer.
326 * @base: address of mapped area
327 * @userpg: pointer to buffer's perf_event_mmap_page
328 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
329 * @len: size of mapped area
330 * @prev: previous aux_head
331 * @idx: index of this mmap
332 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
333 * mmap) otherwise %0
334 * @cpu: cpu number for a per-cpu mmap otherwise %-1
335 */
336struct auxtrace_mmap {
337 void *base;
338 void *userpg;
339 size_t mask;
340 size_t len;
341 u64 prev;
342 int idx;
343 pid_t tid;
344 int cpu;
345};
346
347/**
348 * struct auxtrace_mmap_params - parameters to set up struct auxtrace_mmap.
349 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
350 * @offset: file offset of mapped area
351 * @len: size of mapped area
352 * @prot: mmap memory protection
353 * @idx: index of this mmap
354 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
355 * mmap) otherwise %0
356 * @mmap_needed: set to %false for non-auxtrace events. This is needed because
357 * auxtrace mmapping is done in the same code path as non-auxtrace
358 * mmapping but not every evsel that needs non-auxtrace mmapping
359 * also needs auxtrace mmapping.
360 * @cpu: cpu number for a per-cpu mmap otherwise %-1
361 */
362struct auxtrace_mmap_params {
363 size_t mask;
364 off_t offset;
365 size_t len;
366 int prot;
367 int idx;
368 pid_t tid;
369 bool mmap_needed;
370 struct perf_cpu cpu;
371};
372
373/**
374 * struct auxtrace_record - callbacks for recording AUX area data.
375 * @recording_options: validate and process recording options
376 * @info_priv_size: return the size of the private data in auxtrace_info_event
377 * @info_fill: fill-in the private data in auxtrace_info_event
378 * @free: free this auxtrace record structure
379 * @snapshot_start: starting a snapshot
380 * @snapshot_finish: finishing a snapshot
381 * @find_snapshot: find data to snapshot within auxtrace mmap
382 * @parse_snapshot_options: parse snapshot options
383 * @reference: provide a 64-bit reference number for auxtrace_event
384 * @read_finish: called after reading from an auxtrace mmap
385 * @alignment: alignment (if any) for AUX area data
386 * @default_aux_sample_size: default sample size for --aux sample option
387 * @pmu: associated pmu
388 * @evlist: selected events list
389 */
390struct auxtrace_record {
391 int (*recording_options)(struct auxtrace_record *itr,
392 struct evlist *evlist,
393 struct record_opts *opts);
394 size_t (*info_priv_size)(struct auxtrace_record *itr,
395 struct evlist *evlist);
396 int (*info_fill)(struct auxtrace_record *itr,
397 struct perf_session *session,
398 struct perf_record_auxtrace_info *auxtrace_info,
399 size_t priv_size);
400 void (*free)(struct auxtrace_record *itr);
401 int (*snapshot_start)(struct auxtrace_record *itr);
402 int (*snapshot_finish)(struct auxtrace_record *itr);
403 int (*find_snapshot)(struct auxtrace_record *itr, int idx,
404 struct auxtrace_mmap *mm, unsigned char *data,
405 u64 *head, u64 *old);
406 int (*parse_snapshot_options)(struct auxtrace_record *itr,
407 struct record_opts *opts,
408 const char *str);
409 u64 (*reference)(struct auxtrace_record *itr);
410 int (*read_finish)(struct auxtrace_record *itr, int idx);
411 unsigned int alignment;
412 unsigned int default_aux_sample_size;
413 struct evlist *evlist;
414};
415
416/**
417 * struct addr_filter - address filter.
418 * @list: list node
419 * @range: true if it is a range filter
420 * @start: true if action is 'filter' or 'start'
421 * @action: 'filter', 'start' or 'stop' ('tracestop' is accepted but converted
422 * to 'stop')
423 * @sym_from: symbol name for the filter address
424 * @sym_to: symbol name that determines the filter size
425 * @sym_from_idx: selects n'th from symbols with the same name (0 means global
426 * and less than 0 means symbol must be unique)
427 * @sym_to_idx: same as @sym_from_idx but for @sym_to
428 * @addr: filter address
429 * @size: filter region size (for range filters)
430 * @filename: DSO file name or NULL for the kernel
431 * @str: allocated string that contains the other string members
432 */
433struct addr_filter {
434 struct list_head list;
435 bool range;
436 bool start;
437 const char *action;
438 const char *sym_from;
439 const char *sym_to;
440 int sym_from_idx;
441 int sym_to_idx;
442 u64 addr;
443 u64 size;
444 const char *filename;
445 char *str;
446};
447
448/**
449 * struct addr_filters - list of address filters.
450 * @head: list of address filters
451 * @cnt: number of address filters
452 */
453struct addr_filters {
454 struct list_head head;
455 int cnt;
456};
457
458struct auxtrace_cache;
459
460#ifdef HAVE_AUXTRACE_SUPPORT
461
462u64 compat_auxtrace_mmap__read_head(struct auxtrace_mmap *mm);
463int compat_auxtrace_mmap__write_tail(struct auxtrace_mmap *mm, u64 tail);
464
465static inline u64 auxtrace_mmap__read_head(struct auxtrace_mmap *mm,
466 int kernel_is_64_bit __maybe_unused)
467{
468 struct perf_event_mmap_page *pc = mm->userpg;
469 u64 head;
470
471#if BITS_PER_LONG == 32
472 if (kernel_is_64_bit)
473 return compat_auxtrace_mmap__read_head(mm);
474#endif
475 head = READ_ONCE(pc->aux_head);
476
477 /* Ensure all reads are done after we read the head */
478 smp_rmb();
479 return head;
480}
481
482static inline int auxtrace_mmap__write_tail(struct auxtrace_mmap *mm, u64 tail,
483 int kernel_is_64_bit __maybe_unused)
484{
485 struct perf_event_mmap_page *pc = mm->userpg;
486
487#if BITS_PER_LONG == 32
488 if (kernel_is_64_bit)
489 return compat_auxtrace_mmap__write_tail(mm, tail);
490#endif
491 /* Ensure all reads are done before we write the tail out */
492 smp_mb();
493 WRITE_ONCE(pc->aux_tail, tail);
494 return 0;
495}
496
497int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
498 struct auxtrace_mmap_params *mp,
499 void *userpg, int fd);
500void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
501void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
502 off_t auxtrace_offset,
503 unsigned int auxtrace_pages,
504 bool auxtrace_overwrite);
505void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
506 struct evlist *evlist,
507 struct evsel *evsel, int idx);
508
509typedef int (*process_auxtrace_t)(const struct perf_tool *tool,
510 struct mmap *map,
511 union perf_event *event, void *data1,
512 size_t len1, void *data2, size_t len2);
513
514int auxtrace_mmap__read(struct mmap *map, struct auxtrace_record *itr,
515 const struct perf_tool *tool, process_auxtrace_t fn);
516
517int auxtrace_mmap__read_snapshot(struct mmap *map,
518 struct auxtrace_record *itr,
519 const struct perf_tool *tool, process_auxtrace_t fn,
520 size_t snapshot_size);
521
522int auxtrace_queues__init_nr(struct auxtrace_queues *queues, int nr_queues);
523int auxtrace_queues__init(struct auxtrace_queues *queues);
524int auxtrace_queues__add_event(struct auxtrace_queues *queues,
525 struct perf_session *session,
526 union perf_event *event, off_t data_offset,
527 struct auxtrace_buffer **buffer_ptr);
528struct auxtrace_queue *
529auxtrace_queues__sample_queue(struct auxtrace_queues *queues,
530 struct perf_sample *sample,
531 struct perf_session *session);
532int auxtrace_queues__add_sample(struct auxtrace_queues *queues,
533 struct perf_session *session,
534 struct perf_sample *sample, u64 data_offset,
535 u64 reference);
536void auxtrace_queues__free(struct auxtrace_queues *queues);
537int auxtrace_queues__process_index(struct auxtrace_queues *queues,
538 struct perf_session *session);
539int auxtrace_queue_data(struct perf_session *session, bool samples,
540 bool events);
541struct auxtrace_buffer *auxtrace_buffer__next(struct auxtrace_queue *queue,
542 struct auxtrace_buffer *buffer);
543void *auxtrace_buffer__get_data_rw(struct auxtrace_buffer *buffer, int fd, bool rw);
544static inline void *auxtrace_buffer__get_data(struct auxtrace_buffer *buffer, int fd)
545{
546 return auxtrace_buffer__get_data_rw(buffer, fd, false);
547}
548void auxtrace_buffer__put_data(struct auxtrace_buffer *buffer);
549void auxtrace_buffer__drop_data(struct auxtrace_buffer *buffer);
550void auxtrace_buffer__free(struct auxtrace_buffer *buffer);
551
552int auxtrace_heap__add(struct auxtrace_heap *heap, unsigned int queue_nr,
553 u64 ordinal);
554void auxtrace_heap__pop(struct auxtrace_heap *heap);
555void auxtrace_heap__free(struct auxtrace_heap *heap);
556
557struct auxtrace_cache_entry {
558 struct hlist_node hash;
559 u32 key;
560};
561
562struct auxtrace_cache *auxtrace_cache__new(unsigned int bits, size_t entry_size,
563 unsigned int limit_percent);
564void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache);
565void *auxtrace_cache__alloc_entry(struct auxtrace_cache *c);
566void auxtrace_cache__free_entry(struct auxtrace_cache *c, void *entry);
567int auxtrace_cache__add(struct auxtrace_cache *c, u32 key,
568 struct auxtrace_cache_entry *entry);
569void auxtrace_cache__remove(struct auxtrace_cache *c, u32 key);
570void *auxtrace_cache__lookup(struct auxtrace_cache *c, u32 key);
571
572struct auxtrace_record *auxtrace_record__init(struct evlist *evlist,
573 int *err);
574
575int auxtrace_parse_snapshot_options(struct auxtrace_record *itr,
576 struct record_opts *opts,
577 const char *str);
578int auxtrace_parse_sample_options(struct auxtrace_record *itr,
579 struct evlist *evlist,
580 struct record_opts *opts, const char *str);
581void auxtrace_regroup_aux_output(struct evlist *evlist);
582int auxtrace_record__options(struct auxtrace_record *itr,
583 struct evlist *evlist,
584 struct record_opts *opts);
585size_t auxtrace_record__info_priv_size(struct auxtrace_record *itr,
586 struct evlist *evlist);
587int auxtrace_record__info_fill(struct auxtrace_record *itr,
588 struct perf_session *session,
589 struct perf_record_auxtrace_info *auxtrace_info,
590 size_t priv_size);
591void auxtrace_record__free(struct auxtrace_record *itr);
592int auxtrace_record__snapshot_start(struct auxtrace_record *itr);
593int auxtrace_record__snapshot_finish(struct auxtrace_record *itr, bool on_exit);
594int auxtrace_record__find_snapshot(struct auxtrace_record *itr, int idx,
595 struct auxtrace_mmap *mm,
596 unsigned char *data, u64 *head, u64 *old);
597u64 auxtrace_record__reference(struct auxtrace_record *itr);
598int auxtrace_record__read_finish(struct auxtrace_record *itr, int idx);
599
600int auxtrace_index__auxtrace_event(struct list_head *head, union perf_event *event,
601 off_t file_offset);
602int auxtrace_index__write(int fd, struct list_head *head);
603int auxtrace_index__process(int fd, u64 size, struct perf_session *session,
604 bool needs_swap);
605void auxtrace_index__free(struct list_head *head);
606
607void auxtrace_synth_guest_error(struct perf_record_auxtrace_error *auxtrace_error, int type,
608 int code, int cpu, pid_t pid, pid_t tid, u64 ip,
609 const char *msg, u64 timestamp,
610 pid_t machine_pid, int vcpu);
611void auxtrace_synth_error(struct perf_record_auxtrace_error *auxtrace_error, int type,
612 int code, int cpu, pid_t pid, pid_t tid, u64 ip,
613 const char *msg, u64 timestamp);
614
615int perf_event__process_auxtrace_info(struct perf_session *session,
616 union perf_event *event);
617s64 perf_event__process_auxtrace(struct perf_session *session,
618 union perf_event *event);
619int perf_event__process_auxtrace_error(struct perf_session *session,
620 union perf_event *event);
621int itrace_do_parse_synth_opts(struct itrace_synth_opts *synth_opts,
622 const char *str, int unset);
623int itrace_parse_synth_opts(const struct option *opt, const char *str,
624 int unset);
625void itrace_synth_opts__set_default(struct itrace_synth_opts *synth_opts,
626 bool no_sample);
627
628size_t perf_event__fprintf_auxtrace_error(union perf_event *event, FILE *fp);
629void perf_session__auxtrace_error_inc(struct perf_session *session,
630 union perf_event *event);
631void events_stats__auxtrace_error_warn(const struct events_stats *stats);
632
633void addr_filters__init(struct addr_filters *filts);
634void addr_filters__exit(struct addr_filters *filts);
635int addr_filters__parse_bare_filter(struct addr_filters *filts,
636 const char *filter);
637int auxtrace_parse_filters(struct evlist *evlist);
638
639int auxtrace__process_event(struct perf_session *session, union perf_event *event,
640 struct perf_sample *sample, const struct perf_tool *tool);
641void auxtrace__dump_auxtrace_sample(struct perf_session *session,
642 struct perf_sample *sample);
643int auxtrace__flush_events(struct perf_session *session, const struct perf_tool *tool);
644void auxtrace__free_events(struct perf_session *session);
645void auxtrace__free(struct perf_session *session);
646bool auxtrace__evsel_is_auxtrace(struct perf_session *session,
647 struct evsel *evsel);
648
649#define ITRACE_HELP \
650" i[period]: synthesize instructions events\n" \
651" y[period]: synthesize cycles events (same period as i)\n" \
652" b: synthesize branches events\n" \
653" c: synthesize branches events (calls only)\n" \
654" r: synthesize branches events (returns only)\n" \
655" x: synthesize transactions events\n" \
656" w: synthesize ptwrite events\n" \
657" p: synthesize power events\n" \
658" o: synthesize other events recorded due to the use\n" \
659" of aux-output (refer to perf record)\n" \
660" I: synthesize interrupt or similar (asynchronous) events\n" \
661" (e.g. Intel PT Event Trace)\n" \
662" e[flags]: synthesize error events\n" \
663" each flag must be preceded by + or -\n" \
664" error flags are: o (overflow)\n" \
665" l (data lost)\n" \
666" d[flags]: create a debug log\n" \
667" each flag must be preceded by + or -\n" \
668" log flags are: a (all perf events)\n" \
669" o (output to stdout)\n" \
670" f: synthesize first level cache events\n" \
671" m: synthesize last level cache events\n" \
672" t: synthesize TLB events\n" \
673" a: synthesize remote access events\n" \
674" g[len]: synthesize a call chain (use with i or x)\n" \
675" G[len]: synthesize a call chain on existing event records\n" \
676" l[len]: synthesize last branch entries (use with i or x)\n" \
677" L[len]: synthesize last branch entries on existing event records\n" \
678" sNUMBER: skip initial number of events\n" \
679" q: quicker (less detailed) decoding\n" \
680" A: approximate IPC\n" \
681" Z: prefer to ignore timestamps (so-called \"timeless\" decoding)\n" \
682" T: use the timestamp trace as kernel time\n" \
683" PERIOD[ns|us|ms|i|t]: specify period to sample stream\n" \
684" concatenate multiple options. Default is iybxwpe or cewp\n"
685
686static inline
687void itrace_synth_opts__set_time_range(struct itrace_synth_opts *opts,
688 struct perf_time_interval *ptime_range,
689 int range_num)
690{
691 opts->ptime_range = ptime_range;
692 opts->range_num = range_num;
693}
694
695static inline
696void itrace_synth_opts__clear_time_range(struct itrace_synth_opts *opts)
697{
698 opts->ptime_range = NULL;
699 opts->range_num = 0;
700}
701
702#else
703#include "debug.h"
704
705static inline struct auxtrace_record *
706auxtrace_record__init(struct evlist *evlist __maybe_unused,
707 int *err)
708{
709 *err = 0;
710 return NULL;
711}
712
713static inline
714void auxtrace_record__free(struct auxtrace_record *itr __maybe_unused)
715{
716}
717
718static inline
719int auxtrace_record__options(struct auxtrace_record *itr __maybe_unused,
720 struct evlist *evlist __maybe_unused,
721 struct record_opts *opts __maybe_unused)
722{
723 return 0;
724}
725
726static inline
727int perf_event__process_auxtrace_info(struct perf_session *session __maybe_unused,
728 union perf_event *event __maybe_unused)
729{
730 return 0;
731}
732
733static inline
734s64 perf_event__process_auxtrace(struct perf_session *session __maybe_unused,
735 union perf_event *event __maybe_unused)
736{
737 return 0;
738}
739
740static inline
741int perf_event__process_auxtrace_error(struct perf_session *session __maybe_unused,
742 union perf_event *event __maybe_unused)
743{
744 return 0;
745}
746
747static inline
748void perf_session__auxtrace_error_inc(struct perf_session *session
749 __maybe_unused,
750 union perf_event *event
751 __maybe_unused)
752{
753}
754
755static inline
756void events_stats__auxtrace_error_warn(const struct events_stats *stats
757 __maybe_unused)
758{
759}
760
761static inline
762int itrace_do_parse_synth_opts(struct itrace_synth_opts *synth_opts __maybe_unused,
763 const char *str __maybe_unused, int unset __maybe_unused)
764{
765 pr_err("AUX area tracing not supported\n");
766 return -EINVAL;
767}
768
769static inline
770int itrace_parse_synth_opts(const struct option *opt __maybe_unused,
771 const char *str __maybe_unused,
772 int unset __maybe_unused)
773{
774 pr_err("AUX area tracing not supported\n");
775 return -EINVAL;
776}
777
778static inline
779int auxtrace_parse_snapshot_options(struct auxtrace_record *itr __maybe_unused,
780 struct record_opts *opts __maybe_unused,
781 const char *str)
782{
783 if (!str)
784 return 0;
785 pr_err("AUX area tracing not supported\n");
786 return -EINVAL;
787}
788
789static inline
790int auxtrace_parse_sample_options(struct auxtrace_record *itr __maybe_unused,
791 struct evlist *evlist __maybe_unused,
792 struct record_opts *opts __maybe_unused,
793 const char *str)
794{
795 if (!str)
796 return 0;
797 pr_err("AUX area tracing not supported\n");
798 return -EINVAL;
799}
800
801static inline
802void auxtrace_regroup_aux_output(struct evlist *evlist __maybe_unused)
803{
804}
805
806static inline
807int auxtrace__process_event(struct perf_session *session __maybe_unused,
808 union perf_event *event __maybe_unused,
809 struct perf_sample *sample __maybe_unused,
810 const struct perf_tool *tool __maybe_unused)
811{
812 return 0;
813}
814
815static inline
816void auxtrace__dump_auxtrace_sample(struct perf_session *session __maybe_unused,
817 struct perf_sample *sample __maybe_unused)
818{
819}
820
821static inline
822int auxtrace__flush_events(struct perf_session *session __maybe_unused,
823 const struct perf_tool *tool __maybe_unused)
824{
825 return 0;
826}
827
828static inline
829void auxtrace__free_events(struct perf_session *session __maybe_unused)
830{
831}
832
833static inline
834void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache __maybe_unused)
835{
836}
837
838static inline
839void auxtrace__free(struct perf_session *session __maybe_unused)
840{
841}
842
843static inline
844int auxtrace_index__write(int fd __maybe_unused,
845 struct list_head *head __maybe_unused)
846{
847 return -EINVAL;
848}
849
850static inline
851int auxtrace_index__process(int fd __maybe_unused,
852 u64 size __maybe_unused,
853 struct perf_session *session __maybe_unused,
854 bool needs_swap __maybe_unused)
855{
856 return -EINVAL;
857}
858
859static inline
860void auxtrace_index__free(struct list_head *head __maybe_unused)
861{
862}
863
864static inline
865bool auxtrace__evsel_is_auxtrace(struct perf_session *session __maybe_unused,
866 struct evsel *evsel __maybe_unused)
867{
868 return false;
869}
870
871static inline
872int auxtrace_parse_filters(struct evlist *evlist __maybe_unused)
873{
874 return 0;
875}
876
877int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
878 struct auxtrace_mmap_params *mp,
879 void *userpg, int fd);
880void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
881void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
882 off_t auxtrace_offset,
883 unsigned int auxtrace_pages,
884 bool auxtrace_overwrite);
885void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
886 struct evlist *evlist,
887 struct evsel *evsel, int idx);
888
889#define ITRACE_HELP ""
890
891static inline
892void itrace_synth_opts__set_time_range(struct itrace_synth_opts *opts
893 __maybe_unused,
894 struct perf_time_interval *ptime_range
895 __maybe_unused,
896 int range_num __maybe_unused)
897{
898}
899
900static inline
901void itrace_synth_opts__clear_time_range(struct itrace_synth_opts *opts
902 __maybe_unused)
903{
904}
905
906#endif
907
908#endif