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