]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - tools/perf/util/auxtrace.h
Merge tag 'fuse-update-5.5' of git://git.kernel.org/pub/scm/linux/kernel/git/mszeredi...
[mirror_ubuntu-jammy-kernel.git] / tools / perf / util / auxtrace.h
CommitLineData
2025cf9e 1/* SPDX-License-Identifier: GPL-2.0-only */
718c602d
AH
2/*
3 * auxtrace.h: AUX area trace support
4 * Copyright (c) 2013-2015, Intel Corporation.
718c602d
AH
5 */
6
7#ifndef __PERF_AUXTRACE_H
8#define __PERF_AUXTRACE_H
9
10#include <sys/types.h>
a43783ae 11#include <errno.h>
718c602d 12#include <stdbool.h>
9e0cc4fe 13#include <stddef.h>
ea49e01c 14#include <stdio.h> // FILE
e5027893 15#include <linux/list.h>
718c602d
AH
16#include <linux/perf_event.h>
17#include <linux/types.h>
291ed51d 18#include <asm/bitsperlong.h>
91854f9a 19#include <asm/barrier.h>
718c602d 20
9e0cc4fe
AH
21union perf_event;
22struct perf_session;
63503dba 23struct evlist;
9e0cc4fe 24struct perf_tool;
a5830532 25struct mmap;
bd23ac11 26struct perf_sample;
f6986c95 27struct option;
9e0cc4fe 28struct record_opts;
ea49e01c 29struct perf_record_auxtrace_error;
72932371 30struct perf_record_auxtrace_info;
85ed4729 31struct events_stats;
718c602d 32
47729258
ACM
33enum auxtrace_error_type {
34 PERF_AUXTRACE_ERROR_ITRACE = 1,
35 PERF_AUXTRACE_ERROR_MAX
36};
37
c3fcadf0
AH
38/* Auxtrace records must have the same alignment as perf event records */
39#define PERF_AUXTRACE_RECORD_ALIGNMENT 8
40
73f75fb1
AH
41enum auxtrace_type {
42 PERF_AUXTRACE_UNKNOWN,
55ea4ab4 43 PERF_AUXTRACE_INTEL_PT,
d0170af7 44 PERF_AUXTRACE_INTEL_BTS,
a818c563 45 PERF_AUXTRACE_CS_ETM,
ffd3d18c 46 PERF_AUXTRACE_ARM_SPE,
b96e6615 47 PERF_AUXTRACE_S390_CPUMSF,
73f75fb1
AH
48};
49
f6986c95
AH
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
4eb06815 59 * @default_no_sample: Default to no sampling.
f6986c95
AH
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
53c76b0e 64 * @transactions: whether to synthesize events for transactions
3bdafdff 65 * @ptwrites: whether to synthesize events for ptwrites
70d110d7 66 * @pwr_events: whether to synthesize power events
181ebb5e
AH
67 * @other_events: whether to synthesize other events recorded due to the use of
68 * aux_output
f6986c95
AH
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
50f73637 75 * @thread_stack: feed branches to the thread_stack
601897b5 76 * @last_branch: add branch context to 'instruction' events
f6986c95 77 * @callchain_sz: maximum callchain size
601897b5 78 * @last_branch_sz: branch context size
f6986c95
AH
79 * @period: 'instructions' events period
80 * @period_type: 'instructions' events period type
d1706b39 81 * @initial_skip: skip N events at the beginning.
644e0840 82 * @cpu_bitmap: CPUs for which to synthesize events, or NULL for all
33526f36
AH
83 * @ptime_range: time intervals to trace or NULL
84 * @range_num: number of time intervals to trace
f6986c95
AH
85 */
86struct itrace_synth_opts {
87 bool set;
4eb06815 88 bool default_no_sample;
f6986c95
AH
89 bool inject;
90 bool instructions;
91 bool branches;
53c76b0e 92 bool transactions;
3bdafdff 93 bool ptwrites;
70d110d7 94 bool pwr_events;
181ebb5e 95 bool other_events;
f6986c95
AH
96 bool errors;
97 bool dont_decode;
98 bool log;
99 bool calls;
100 bool returns;
101 bool callchain;
50f73637 102 bool thread_stack;
601897b5 103 bool last_branch;
f6986c95 104 unsigned int callchain_sz;
601897b5 105 unsigned int last_branch_sz;
f6986c95
AH
106 unsigned long long period;
107 enum itrace_period_type period_type;
d1706b39 108 unsigned long initial_skip;
644e0840 109 unsigned long *cpu_bitmap;
33526f36
AH
110 struct perf_time_interval *ptime_range;
111 int range_num;
f6986c95
AH
112};
113
99fa2984
AH
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
c446870d
AH
140/**
141 * struct auxtrace - session callbacks to allow AUX area data decoding.
142 * @process_event: lets the decoder see all session events
b818ec61 143 * @process_auxtrace_event: process a PERF_RECORD_AUXTRACE event
ac2f445f
AH
144 * @queue_data: queue an AUX sample or PERF_RECORD_AUXTRACE event for later
145 * processing
b04b8dd1 146 * @dump_auxtrace_sample: dump AUX area sample data
c446870d
AH
147 * @flush_events: process any remaining data
148 * @free_events: free resources associated with event processing
149 * @free: free resources associated with the session
150 */
151struct auxtrace {
152 int (*process_event)(struct perf_session *session,
153 union perf_event *event,
154 struct perf_sample *sample,
155 struct perf_tool *tool);
73f75fb1
AH
156 int (*process_auxtrace_event)(struct perf_session *session,
157 union perf_event *event,
158 struct perf_tool *tool);
ac2f445f
AH
159 int (*queue_data)(struct perf_session *session,
160 struct perf_sample *sample, union perf_event *event,
161 u64 data_offset);
b04b8dd1
AH
162 void (*dump_auxtrace_sample)(struct perf_session *session,
163 struct perf_sample *sample);
c446870d
AH
164 int (*flush_events)(struct perf_session *session,
165 struct perf_tool *tool);
166 void (*free_events)(struct perf_session *session);
167 void (*free)(struct perf_session *session);
168};
169
e5027893
AH
170/**
171 * struct auxtrace_buffer - a buffer containing AUX area tracing data.
172 * @list: buffers are queued in a list held by struct auxtrace_queue
173 * @size: size of the buffer in bytes
174 * @pid: in per-thread mode, the pid this buffer is associated with
175 * @tid: in per-thread mode, the tid this buffer is associated with
176 * @cpu: in per-cpu mode, the cpu this buffer is associated with
177 * @data: actual buffer data (can be null if the data has not been loaded)
178 * @data_offset: file offset at which the buffer can be read
179 * @mmap_addr: mmap address at which the buffer can be read
180 * @mmap_size: size of the mmap at @mmap_addr
181 * @data_needs_freeing: @data was malloc'd so free it when it is no longer
182 * needed
183 * @consecutive: the original data was split up and this buffer is consecutive
184 * to the previous buffer
185 * @offset: offset as determined by aux_head / aux_tail members of struct
186 * perf_event_mmap_page
187 * @reference: an implementation-specific reference determined when the data is
188 * recorded
189 * @buffer_nr: used to number each buffer
190 * @use_size: implementation actually only uses this number of bytes
191 * @use_data: implementation actually only uses data starting at this address
192 */
193struct auxtrace_buffer {
194 struct list_head list;
195 size_t size;
196 pid_t pid;
197 pid_t tid;
198 int cpu;
199 void *data;
200 off_t data_offset;
201 void *mmap_addr;
202 size_t mmap_size;
203 bool data_needs_freeing;
204 bool consecutive;
205 u64 offset;
206 u64 reference;
207 u64 buffer_nr;
208 size_t use_size;
209 void *use_data;
210};
211
212/**
213 * struct auxtrace_queue - a queue of AUX area tracing data buffers.
214 * @head: head of buffer list
215 * @tid: in per-thread mode, the tid this queue is associated with
216 * @cpu: in per-cpu mode, the cpu this queue is associated with
217 * @set: %true once this queue has been dedicated to a specific thread or cpu
218 * @priv: implementation-specific data
219 */
220struct auxtrace_queue {
221 struct list_head head;
222 pid_t tid;
223 int cpu;
224 bool set;
225 void *priv;
226};
227
228/**
229 * struct auxtrace_queues - an array of AUX area tracing queues.
230 * @queue_array: array of queues
231 * @nr_queues: number of queues
232 * @new_data: set whenever new data is queued
233 * @populated: queues have been fully populated using the auxtrace_index
234 * @next_buffer_nr: used to number each buffer
235 */
236struct auxtrace_queues {
237 struct auxtrace_queue *queue_array;
238 unsigned int nr_queues;
239 bool new_data;
240 bool populated;
241 u64 next_buffer_nr;
242};
243
f9397155
AH
244/**
245 * struct auxtrace_heap_item - element of struct auxtrace_heap.
246 * @queue_nr: queue number
247 * @ordinal: value used for sorting (lowest ordinal is top of the heap) expected
248 * to be a timestamp
249 */
250struct auxtrace_heap_item {
251 unsigned int queue_nr;
252 u64 ordinal;
253};
254
255/**
256 * struct auxtrace_heap - a heap suitable for sorting AUX area tracing queues.
257 * @heap_array: the heap
258 * @heap_cnt: the number of elements in the heap
259 * @heap_sz: maximum number of elements (grows as needed)
260 */
261struct auxtrace_heap {
262 struct auxtrace_heap_item *heap_array;
263 unsigned int heap_cnt;
264 unsigned int heap_sz;
265};
266
718c602d
AH
267/**
268 * struct auxtrace_mmap - records an mmap of the auxtrace buffer.
269 * @base: address of mapped area
270 * @userpg: pointer to buffer's perf_event_mmap_page
271 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
272 * @len: size of mapped area
273 * @prev: previous aux_head
274 * @idx: index of this mmap
275 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
276 * mmap) otherwise %0
277 * @cpu: cpu number for a per-cpu mmap otherwise %-1
278 */
279struct auxtrace_mmap {
280 void *base;
281 void *userpg;
282 size_t mask;
283 size_t len;
284 u64 prev;
285 int idx;
286 pid_t tid;
287 int cpu;
288};
289
290/**
291 * struct auxtrace_mmap_params - parameters to set up struct auxtrace_mmap.
292 * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
293 * @offset: file offset of mapped area
294 * @len: size of mapped area
295 * @prot: mmap memory protection
296 * @idx: index of this mmap
297 * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
298 * mmap) otherwise %0
299 * @cpu: cpu number for a per-cpu mmap otherwise %-1
300 */
301struct auxtrace_mmap_params {
302 size_t mask;
303 off_t offset;
304 size_t len;
305 int prot;
306 int idx;
307 pid_t tid;
308 int cpu;
309};
310
9e0cc4fe
AH
311/**
312 * struct auxtrace_record - callbacks for recording AUX area data.
313 * @recording_options: validate and process recording options
314 * @info_priv_size: return the size of the private data in auxtrace_info_event
315 * @info_fill: fill-in the private data in auxtrace_info_event
316 * @free: free this auxtrace record structure
d20031bb
AH
317 * @snapshot_start: starting a snapshot
318 * @snapshot_finish: finishing a snapshot
319 * @find_snapshot: find data to snapshot within auxtrace mmap
320 * @parse_snapshot_options: parse snapshot options
9e0cc4fe
AH
321 * @reference: provide a 64-bit reference number for auxtrace_event
322 * @read_finish: called after reading from an auxtrace mmap
b818ec61 323 * @alignment: alignment (if any) for AUX area data
f0bb7ee8 324 * @default_aux_sample_size: default sample size for --aux sample option
9e0cc4fe
AH
325 */
326struct auxtrace_record {
327 int (*recording_options)(struct auxtrace_record *itr,
63503dba 328 struct evlist *evlist,
9e0cc4fe 329 struct record_opts *opts);
14a05e13 330 size_t (*info_priv_size)(struct auxtrace_record *itr,
63503dba 331 struct evlist *evlist);
9e0cc4fe
AH
332 int (*info_fill)(struct auxtrace_record *itr,
333 struct perf_session *session,
72932371 334 struct perf_record_auxtrace_info *auxtrace_info,
9e0cc4fe
AH
335 size_t priv_size);
336 void (*free)(struct auxtrace_record *itr);
d20031bb
AH
337 int (*snapshot_start)(struct auxtrace_record *itr);
338 int (*snapshot_finish)(struct auxtrace_record *itr);
339 int (*find_snapshot)(struct auxtrace_record *itr, int idx,
340 struct auxtrace_mmap *mm, unsigned char *data,
341 u64 *head, u64 *old);
342 int (*parse_snapshot_options)(struct auxtrace_record *itr,
343 struct record_opts *opts,
344 const char *str);
9e0cc4fe
AH
345 u64 (*reference)(struct auxtrace_record *itr);
346 int (*read_finish)(struct auxtrace_record *itr, int idx);
83b2ea25 347 unsigned int alignment;
f0bb7ee8 348 unsigned int default_aux_sample_size;
9e0cc4fe
AH
349};
350
1b36c03e
AH
351/**
352 * struct addr_filter - address filter.
353 * @list: list node
354 * @range: true if it is a range filter
355 * @start: true if action is 'filter' or 'start'
356 * @action: 'filter', 'start' or 'stop' ('tracestop' is accepted but converted
357 * to 'stop')
358 * @sym_from: symbol name for the filter address
359 * @sym_to: symbol name that determines the filter size
360 * @sym_from_idx: selects n'th from symbols with the same name (0 means global
361 * and less than 0 means symbol must be unique)
362 * @sym_to_idx: same as @sym_from_idx but for @sym_to
363 * @addr: filter address
364 * @size: filter region size (for range filters)
365 * @filename: DSO file name or NULL for the kernel
366 * @str: allocated string that contains the other string members
367 */
368struct addr_filter {
369 struct list_head list;
370 bool range;
371 bool start;
372 const char *action;
373 const char *sym_from;
374 const char *sym_to;
375 int sym_from_idx;
376 int sym_to_idx;
377 u64 addr;
378 u64 size;
379 const char *filename;
380 char *str;
381};
382
383/**
384 * struct addr_filters - list of address filters.
385 * @head: list of address filters
386 * @cnt: number of address filters
387 */
388struct addr_filters {
389 struct list_head head;
390 int cnt;
391};
392
f2a39fe8
ACM
393struct auxtrace_cache;
394
e31f0d01
AH
395#ifdef HAVE_AUXTRACE_SUPPORT
396
d20031bb
AH
397/*
398 * In snapshot mode the mmapped page is read-only which makes using
399 * __sync_val_compare_and_swap() problematic. However, snapshot mode expects
400 * the buffer is not updated while the snapshot is made (e.g. Intel PT disables
401 * the event) so there is not a race anyway.
402 */
403static inline u64 auxtrace_mmap__read_snapshot_head(struct auxtrace_mmap *mm)
404{
405 struct perf_event_mmap_page *pc = mm->userpg;
6aa7de05 406 u64 head = READ_ONCE(pc->aux_head);
d20031bb
AH
407
408 /* Ensure all reads are done after we read the head */
409 rmb();
410 return head;
411}
412
718c602d
AH
413static inline u64 auxtrace_mmap__read_head(struct auxtrace_mmap *mm)
414{
415 struct perf_event_mmap_page *pc = mm->userpg;
416#if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
6aa7de05 417 u64 head = READ_ONCE(pc->aux_head);
718c602d
AH
418#else
419 u64 head = __sync_val_compare_and_swap(&pc->aux_head, 0, 0);
420#endif
421
422 /* Ensure all reads are done after we read the head */
423 rmb();
424 return head;
425}
426
427static inline void auxtrace_mmap__write_tail(struct auxtrace_mmap *mm, u64 tail)
428{
429 struct perf_event_mmap_page *pc = mm->userpg;
430#if BITS_PER_LONG != 64 && defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
431 u64 old_tail;
432#endif
433
434 /* Ensure all reads are done before we write the tail out */
435 mb();
436#if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
437 pc->aux_tail = tail;
438#else
439 do {
440 old_tail = __sync_val_compare_and_swap(&pc->aux_tail, 0, 0);
441 } while (!__sync_bool_compare_and_swap(&pc->aux_tail, old_tail, tail));
442#endif
443}
444
445int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
446 struct auxtrace_mmap_params *mp,
447 void *userpg, int fd);
448void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
449void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
450 off_t auxtrace_offset,
451 unsigned int auxtrace_pages,
452 bool auxtrace_overwrite);
453void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
63503dba 454 struct evlist *evlist, int idx,
718c602d
AH
455 bool per_cpu);
456
9e0cc4fe 457typedef int (*process_auxtrace_t)(struct perf_tool *tool,
a5830532 458 struct mmap *map,
9e0cc4fe
AH
459 union perf_event *event, void *data1,
460 size_t len1, void *data2, size_t len2);
461
a5830532 462int auxtrace_mmap__read(struct mmap *map, struct auxtrace_record *itr,
9e0cc4fe
AH
463 struct perf_tool *tool, process_auxtrace_t fn);
464
a5830532 465int auxtrace_mmap__read_snapshot(struct mmap *map,
d20031bb
AH
466 struct auxtrace_record *itr,
467 struct perf_tool *tool, process_auxtrace_t fn,
468 size_t snapshot_size);
469
e5027893
AH
470int auxtrace_queues__init(struct auxtrace_queues *queues);
471int auxtrace_queues__add_event(struct auxtrace_queues *queues,
472 struct perf_session *session,
473 union perf_event *event, off_t data_offset,
474 struct auxtrace_buffer **buffer_ptr);
ac2f445f
AH
475struct auxtrace_queue *
476auxtrace_queues__sample_queue(struct auxtrace_queues *queues,
477 struct perf_sample *sample,
478 struct perf_session *session);
479int auxtrace_queues__add_sample(struct auxtrace_queues *queues,
480 struct perf_session *session,
481 struct perf_sample *sample, u64 data_offset,
482 u64 reference);
e5027893 483void auxtrace_queues__free(struct auxtrace_queues *queues);
99fa2984
AH
484int auxtrace_queues__process_index(struct auxtrace_queues *queues,
485 struct perf_session *session);
ac2f445f
AH
486int auxtrace_queue_data(struct perf_session *session, bool samples,
487 bool events);
e5027893
AH
488struct auxtrace_buffer *auxtrace_buffer__next(struct auxtrace_queue *queue,
489 struct auxtrace_buffer *buffer);
490void *auxtrace_buffer__get_data(struct auxtrace_buffer *buffer, int fd);
491void auxtrace_buffer__put_data(struct auxtrace_buffer *buffer);
492void auxtrace_buffer__drop_data(struct auxtrace_buffer *buffer);
493void auxtrace_buffer__free(struct auxtrace_buffer *buffer);
f9397155
AH
494
495int auxtrace_heap__add(struct auxtrace_heap *heap, unsigned int queue_nr,
496 u64 ordinal);
497void auxtrace_heap__pop(struct auxtrace_heap *heap);
498void auxtrace_heap__free(struct auxtrace_heap *heap);
499
c3278f02
AH
500struct auxtrace_cache_entry {
501 struct hlist_node hash;
502 u32 key;
503};
504
505struct auxtrace_cache *auxtrace_cache__new(unsigned int bits, size_t entry_size,
506 unsigned int limit_percent);
507void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache);
508void *auxtrace_cache__alloc_entry(struct auxtrace_cache *c);
509void auxtrace_cache__free_entry(struct auxtrace_cache *c, void *entry);
510int auxtrace_cache__add(struct auxtrace_cache *c, u32 key,
511 struct auxtrace_cache_entry *entry);
fd62c109 512void auxtrace_cache__remove(struct auxtrace_cache *c, u32 key);
c3278f02
AH
513void *auxtrace_cache__lookup(struct auxtrace_cache *c, u32 key);
514
63503dba 515struct auxtrace_record *auxtrace_record__init(struct evlist *evlist,
9e0cc4fe
AH
516 int *err);
517
d20031bb
AH
518int auxtrace_parse_snapshot_options(struct auxtrace_record *itr,
519 struct record_opts *opts,
520 const char *str);
f0bb7ee8
AH
521int auxtrace_parse_sample_options(struct auxtrace_record *itr,
522 struct evlist *evlist,
523 struct record_opts *opts, const char *str);
9e0cc4fe 524int auxtrace_record__options(struct auxtrace_record *itr,
63503dba 525 struct evlist *evlist,
9e0cc4fe 526 struct record_opts *opts);
14a05e13 527size_t auxtrace_record__info_priv_size(struct auxtrace_record *itr,
63503dba 528 struct evlist *evlist);
9e0cc4fe
AH
529int auxtrace_record__info_fill(struct auxtrace_record *itr,
530 struct perf_session *session,
72932371 531 struct perf_record_auxtrace_info *auxtrace_info,
9e0cc4fe
AH
532 size_t priv_size);
533void auxtrace_record__free(struct auxtrace_record *itr);
d20031bb 534int auxtrace_record__snapshot_start(struct auxtrace_record *itr);
ce7b0e42 535int auxtrace_record__snapshot_finish(struct auxtrace_record *itr, bool on_exit);
d20031bb
AH
536int auxtrace_record__find_snapshot(struct auxtrace_record *itr, int idx,
537 struct auxtrace_mmap *mm,
538 unsigned char *data, u64 *head, u64 *old);
9e0cc4fe
AH
539u64 auxtrace_record__reference(struct auxtrace_record *itr);
540
99fa2984
AH
541int auxtrace_index__auxtrace_event(struct list_head *head, union perf_event *event,
542 off_t file_offset);
543int auxtrace_index__write(int fd, struct list_head *head);
544int auxtrace_index__process(int fd, u64 size, struct perf_session *session,
545 bool needs_swap);
546void auxtrace_index__free(struct list_head *head);
547
72932371 548void auxtrace_synth_error(struct perf_record_auxtrace_error *auxtrace_error, int type,
85ed4729 549 int code, int cpu, pid_t pid, pid_t tid, u64 ip,
16bd4321 550 const char *msg, u64 timestamp);
85ed4729 551
89f1688a
JO
552int perf_event__process_auxtrace_info(struct perf_session *session,
553 union perf_event *event);
7336555a
JO
554s64 perf_event__process_auxtrace(struct perf_session *session,
555 union perf_event *event);
89f1688a
JO
556int perf_event__process_auxtrace_error(struct perf_session *session,
557 union perf_event *event);
f6986c95
AH
558int itrace_parse_synth_opts(const struct option *opt, const char *str,
559 int unset);
4eb06815
AK
560void itrace_synth_opts__set_default(struct itrace_synth_opts *synth_opts,
561 bool no_sample);
9e0cc4fe 562
85ed4729
AH
563size_t perf_event__fprintf_auxtrace_error(union perf_event *event, FILE *fp);
564void perf_session__auxtrace_error_inc(struct perf_session *session,
565 union perf_event *event);
566void events_stats__auxtrace_error_warn(const struct events_stats *stats);
567
1b36c03e
AH
568void addr_filters__init(struct addr_filters *filts);
569void addr_filters__exit(struct addr_filters *filts);
570int addr_filters__parse_bare_filter(struct addr_filters *filts,
571 const char *filter);
63503dba 572int auxtrace_parse_filters(struct evlist *evlist);
1b36c03e 573
f2a39fe8
ACM
574int auxtrace__process_event(struct perf_session *session, union perf_event *event,
575 struct perf_sample *sample, struct perf_tool *tool);
b04b8dd1
AH
576void auxtrace__dump_auxtrace_sample(struct perf_session *session,
577 struct perf_sample *sample);
f2a39fe8
ACM
578int auxtrace__flush_events(struct perf_session *session, struct perf_tool *tool);
579void auxtrace__free_events(struct perf_session *session);
580void auxtrace__free(struct perf_session *session);
c446870d 581
c12e039d
AK
582#define ITRACE_HELP \
583" i: synthesize instructions events\n" \
584" b: synthesize branches events\n" \
585" c: synthesize branches events (calls only)\n" \
586" r: synthesize branches events (returns only)\n" \
587" x: synthesize transactions events\n" \
588" w: synthesize ptwrite events\n" \
589" p: synthesize power events\n" \
590" e: synthesize error events\n" \
591" d: create a debug log\n" \
592" g[len]: synthesize a call chain (use with i or x)\n" \
593" l[len]: synthesize last branch entries (use with i or x)\n" \
594" sNUMBER: skip initial number of events\n" \
595" PERIOD[ns|us|ms|i|t]: specify period to sample stream\n" \
596" concatenate multiple options. Default is ibxwpe or cewp\n"
597
33526f36
AH
598static inline
599void itrace_synth_opts__set_time_range(struct itrace_synth_opts *opts,
600 struct perf_time_interval *ptime_range,
601 int range_num)
602{
603 opts->ptime_range = ptime_range;
604 opts->range_num = range_num;
605}
606
607static inline
608void itrace_synth_opts__clear_time_range(struct itrace_synth_opts *opts)
609{
610 opts->ptime_range = NULL;
611 opts->range_num = 0;
612}
c12e039d 613
e31f0d01 614#else
b4209025 615#include "debug.h"
e31f0d01
AH
616
617static inline struct auxtrace_record *
63503dba 618auxtrace_record__init(struct evlist *evlist __maybe_unused,
b8f8eb84 619 int *err)
e31f0d01
AH
620{
621 *err = 0;
622 return NULL;
623}
624
625static inline
626void auxtrace_record__free(struct auxtrace_record *itr __maybe_unused)
627{
628}
629
e31f0d01
AH
630static inline
631int auxtrace_record__options(struct auxtrace_record *itr __maybe_unused,
63503dba 632 struct evlist *evlist __maybe_unused,
e31f0d01
AH
633 struct record_opts *opts __maybe_unused)
634{
635 return 0;
636}
637
638#define perf_event__process_auxtrace_info 0
639#define perf_event__process_auxtrace 0
640#define perf_event__process_auxtrace_error 0
641
642static inline
643void perf_session__auxtrace_error_inc(struct perf_session *session
644 __maybe_unused,
645 union perf_event *event
646 __maybe_unused)
647{
648}
649
650static inline
651void events_stats__auxtrace_error_warn(const struct events_stats *stats
652 __maybe_unused)
653{
654}
655
656static inline
657int itrace_parse_synth_opts(const struct option *opt __maybe_unused,
658 const char *str __maybe_unused,
659 int unset __maybe_unused)
660{
661 pr_err("AUX area tracing not supported\n");
662 return -EINVAL;
663}
664
2dd6d8a1
AH
665static inline
666int auxtrace_parse_snapshot_options(struct auxtrace_record *itr __maybe_unused,
667 struct record_opts *opts __maybe_unused,
668 const char *str)
f0bb7ee8
AH
669{
670 if (!str)
671 return 0;
672 pr_err("AUX area tracing not supported\n");
673 return -EINVAL;
674}
675
676static inline
677int auxtrace_parse_sample_options(struct auxtrace_record *itr __maybe_unused,
678 struct evlist *evlist __maybe_unused,
679 struct record_opts *opts __maybe_unused,
680 const char *str)
2dd6d8a1
AH
681{
682 if (!str)
683 return 0;
684 pr_err("AUX area tracing not supported\n");
685 return -EINVAL;
686}
687
e31f0d01
AH
688static inline
689int auxtrace__process_event(struct perf_session *session __maybe_unused,
690 union perf_event *event __maybe_unused,
691 struct perf_sample *sample __maybe_unused,
692 struct perf_tool *tool __maybe_unused)
693{
694 return 0;
695}
696
b04b8dd1
AH
697static inline
698void auxtrace__dump_auxtrace_sample(struct perf_session *session __maybe_unused,
699 struct perf_sample *sample __maybe_unused)
700{
701}
702
e31f0d01
AH
703static inline
704int auxtrace__flush_events(struct perf_session *session __maybe_unused,
705 struct perf_tool *tool __maybe_unused)
706{
707 return 0;
708}
709
710static inline
711void auxtrace__free_events(struct perf_session *session __maybe_unused)
712{
713}
714
715static inline
716void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache __maybe_unused)
717{
718}
719
720static inline
721void auxtrace__free(struct perf_session *session __maybe_unused)
722{
723}
724
725static inline
726int auxtrace_index__write(int fd __maybe_unused,
727 struct list_head *head __maybe_unused)
728{
729 return -EINVAL;
730}
731
732static inline
733int auxtrace_index__process(int fd __maybe_unused,
734 u64 size __maybe_unused,
735 struct perf_session *session __maybe_unused,
736 bool needs_swap __maybe_unused)
737{
738 return -EINVAL;
739}
740
741static inline
742void auxtrace_index__free(struct list_head *head __maybe_unused)
743{
744}
745
1b36c03e 746static inline
63503dba 747int auxtrace_parse_filters(struct evlist *evlist __maybe_unused)
1b36c03e
AH
748{
749 return 0;
750}
751
e31f0d01
AH
752int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
753 struct auxtrace_mmap_params *mp,
754 void *userpg, int fd);
755void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
756void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
757 off_t auxtrace_offset,
758 unsigned int auxtrace_pages,
759 bool auxtrace_overwrite);
760void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
63503dba 761 struct evlist *evlist, int idx,
e31f0d01
AH
762 bool per_cpu);
763
c12e039d
AK
764#define ITRACE_HELP ""
765
33526f36
AH
766static inline
767void itrace_synth_opts__set_time_range(struct itrace_synth_opts *opts
768 __maybe_unused,
769 struct perf_time_interval *ptime_range
770 __maybe_unused,
771 int range_num __maybe_unused)
772{
773}
774
775static inline
776void itrace_synth_opts__clear_time_range(struct itrace_synth_opts *opts
777 __maybe_unused)
778{
779}
780
e31f0d01
AH
781#endif
782
718c602d 783#endif