tools/perf/util/auxtrace.h

   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 perf_tool;
  25 struct mmap;
  26 struct perf_sample;
  27 struct option;
  28 struct record_opts;
  29 struct perf_record_auxtrace_error;
  30 struct perf_record_auxtrace_info;
  31 struct events_stats;
  32
  33 enum 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
  41 enum 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
  50 enum 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  */
  86 struct 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  */
 120 struct 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  */
 134 struct 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  * @queue_data: queue an AUX sample or PERF_RECORD_AUXTRACE event for later
 145  *              processing
 146  * @dump_auxtrace_sample: dump AUX area sample data
 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  */
 151 struct auxtrace {
 152         int (*process_event)(struct perf_session *session,
 153                              union perf_event *event,
 154                              struct perf_sample *sample,
 155                              struct perf_tool *tool);
 156         int (*process_auxtrace_event)(struct perf_session *session,
 157                                       union perf_event *event,
 158                                       struct perf_tool *tool);
 159         int (*queue_data)(struct perf_session *session,
 160                           struct perf_sample *sample, union perf_event *event,
 161                           u64 data_offset);
 162         void (*dump_auxtrace_sample)(struct perf_session *session,
 163                                      struct perf_sample *sample);
 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
 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  */
 193 struct 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  */
 220 struct 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  */
 236 struct 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
 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  */
 250 struct 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  */
 261 struct auxtrace_heap {
 262         struct auxtrace_heap_item       *heap_array;
 263         unsigned int            heap_cnt;
 264         unsigned int            heap_sz;
 265 };
 266
 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  */
 279 struct 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  */
 301 struct 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
 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
 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
 321  * @reference: provide a 64-bit reference number for auxtrace_event
 322  * @read_finish: called after reading from an auxtrace mmap
 323  * @alignment: alignment (if any) for AUX area data
 324  * @default_aux_sample_size: default sample size for --aux sample option
 325  */
 326 struct auxtrace_record {
 327         int (*recording_options)(struct auxtrace_record *itr,
 328                                  struct evlist *evlist,
 329                                  struct record_opts *opts);
 330         size_t (*info_priv_size)(struct auxtrace_record *itr,
 331                                  struct evlist *evlist);
 332         int (*info_fill)(struct auxtrace_record *itr,
 333                          struct perf_session *session,
 334                          struct perf_record_auxtrace_info *auxtrace_info,
 335                          size_t priv_size);
 336         void (*free)(struct auxtrace_record *itr);
 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);
 345         u64 (*reference)(struct auxtrace_record *itr);
 346         int (*read_finish)(struct auxtrace_record *itr, int idx);
 347         unsigned int alignment;
 348         unsigned int default_aux_sample_size;
 349 };
 350
 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  */
 368 struct 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  */
 388 struct addr_filters {
 389         struct list_head        head;
 390         int                     cnt;
 391 };
 392
 393 struct auxtrace_cache;
 394
 395 #ifdef HAVE_AUXTRACE_SUPPORT
 396
 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  */
 403 static inline u64 auxtrace_mmap__read_snapshot_head(struct auxtrace_mmap *mm)
 404 {
 405         struct perf_event_mmap_page *pc = mm->userpg;
 406         u64 head = READ_ONCE(pc->aux_head);
 407
 408         /* Ensure all reads are done after we read the head */
 409         rmb();
 410         return head;
 411 }
 412
 413 static 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)
 417         u64 head = READ_ONCE(pc->aux_head);
 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
 427 static 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
 445 int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
 446                         struct auxtrace_mmap_params *mp,
 447                         void *userpg, int fd);
 448 void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
 449 void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
 450                                 off_t auxtrace_offset,
 451                                 unsigned int auxtrace_pages,
 452                                 bool auxtrace_overwrite);
 453 void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
 454                                    struct evlist *evlist, int idx,
 455                                    bool per_cpu);
 456
 457 typedef int (*process_auxtrace_t)(struct perf_tool *tool,
 458                                   struct mmap *map,
 459                                   union perf_event *event, void *data1,
 460                                   size_t len1, void *data2, size_t len2);
 461
 462 int auxtrace_mmap__read(struct mmap *map, struct auxtrace_record *itr,
 463                         struct perf_tool *tool, process_auxtrace_t fn);
 464
 465 int auxtrace_mmap__read_snapshot(struct mmap *map,
 466                                  struct auxtrace_record *itr,
 467                                  struct perf_tool *tool, process_auxtrace_t fn,
 468                                  size_t snapshot_size);
 469
 470 int auxtrace_queues__init(struct auxtrace_queues *queues);
 471 int 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);
 475 struct auxtrace_queue *
 476 auxtrace_queues__sample_queue(struct auxtrace_queues *queues,
 477                               struct perf_sample *sample,
 478                               struct perf_session *session);
 479 int auxtrace_queues__add_sample(struct auxtrace_queues *queues,
 480                                 struct perf_session *session,
 481                                 struct perf_sample *sample, u64 data_offset,
 482                                 u64 reference);
 483 void auxtrace_queues__free(struct auxtrace_queues *queues);
 484 int auxtrace_queues__process_index(struct auxtrace_queues *queues,
 485                                    struct perf_session *session);
 486 int auxtrace_queue_data(struct perf_session *session, bool samples,
 487                         bool events);
 488 struct auxtrace_buffer *auxtrace_buffer__next(struct auxtrace_queue *queue,
 489                                               struct auxtrace_buffer *buffer);
 490 void *auxtrace_buffer__get_data(struct auxtrace_buffer *buffer, int fd);
 491 void auxtrace_buffer__put_data(struct auxtrace_buffer *buffer);
 492 void auxtrace_buffer__drop_data(struct auxtrace_buffer *buffer);
 493 void auxtrace_buffer__free(struct auxtrace_buffer *buffer);
 494
 495 int auxtrace_heap__add(struct auxtrace_heap *heap, unsigned int queue_nr,
 496                        u64 ordinal);
 497 void auxtrace_heap__pop(struct auxtrace_heap *heap);
 498 void auxtrace_heap__free(struct auxtrace_heap *heap);
 499
 500 struct auxtrace_cache_entry {
 501         struct hlist_node hash;
 502         u32 key;
 503 };
 504
 505 struct auxtrace_cache *auxtrace_cache__new(unsigned int bits, size_t entry_size,
 506                                            unsigned int limit_percent);
 507 void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache);
 508 void *auxtrace_cache__alloc_entry(struct auxtrace_cache *c);
 509 void auxtrace_cache__free_entry(struct auxtrace_cache *c, void *entry);
 510 int auxtrace_cache__add(struct auxtrace_cache *c, u32 key,
 511                         struct auxtrace_cache_entry *entry);
 512 void auxtrace_cache__remove(struct auxtrace_cache *c, u32 key);
 513 void *auxtrace_cache__lookup(struct auxtrace_cache *c, u32 key);
 514
 515 struct auxtrace_record *auxtrace_record__init(struct evlist *evlist,
 516                                               int *err);
 517
 518 int auxtrace_parse_snapshot_options(struct auxtrace_record *itr,
 519                                     struct record_opts *opts,
 520                                     const char *str);
 521 int auxtrace_parse_sample_options(struct auxtrace_record *itr,
 522                                   struct evlist *evlist,
 523                                   struct record_opts *opts, const char *str);
 524 int auxtrace_record__options(struct auxtrace_record *itr,
 525                              struct evlist *evlist,
 526                              struct record_opts *opts);
 527 size_t auxtrace_record__info_priv_size(struct auxtrace_record *itr,
 528                                        struct evlist *evlist);
 529 int auxtrace_record__info_fill(struct auxtrace_record *itr,
 530                                struct perf_session *session,
 531                                struct perf_record_auxtrace_info *auxtrace_info,
 532                                size_t priv_size);
 533 void auxtrace_record__free(struct auxtrace_record *itr);
 534 int auxtrace_record__snapshot_start(struct auxtrace_record *itr);
 535 int auxtrace_record__snapshot_finish(struct auxtrace_record *itr, bool on_exit);
 536 int auxtrace_record__find_snapshot(struct auxtrace_record *itr, int idx,
 537                                    struct auxtrace_mmap *mm,
 538                                    unsigned char *data, u64 *head, u64 *old);
 539 u64 auxtrace_record__reference(struct auxtrace_record *itr);
 540
 541 int auxtrace_index__auxtrace_event(struct list_head *head, union perf_event *event,
 542                                    off_t file_offset);
 543 int auxtrace_index__write(int fd, struct list_head *head);
 544 int auxtrace_index__process(int fd, u64 size, struct perf_session *session,
 545                             bool needs_swap);
 546 void auxtrace_index__free(struct list_head *head);
 547
 548 void auxtrace_synth_error(struct perf_record_auxtrace_error *auxtrace_error, int type,
 549                           int code, int cpu, pid_t pid, pid_t tid, u64 ip,
 550                           const char *msg, u64 timestamp);
 551
 552 int perf_event__process_auxtrace_info(struct perf_session *session,
 553                                       union perf_event *event);
 554 s64 perf_event__process_auxtrace(struct perf_session *session,
 555                                  union perf_event *event);
 556 int perf_event__process_auxtrace_error(struct perf_session *session,
 557                                        union perf_event *event);
 558 int itrace_parse_synth_opts(const struct option *opt, const char *str,
 559                             int unset);
 560 void itrace_synth_opts__set_default(struct itrace_synth_opts *synth_opts,
 561                                     bool no_sample);
 562
 563 size_t perf_event__fprintf_auxtrace_error(union perf_event *event, FILE *fp);
 564 void perf_session__auxtrace_error_inc(struct perf_session *session,
 565                                       union perf_event *event);
 566 void events_stats__auxtrace_error_warn(const struct events_stats *stats);
 567
 568 void addr_filters__init(struct addr_filters *filts);
 569 void addr_filters__exit(struct addr_filters *filts);
 570 int addr_filters__parse_bare_filter(struct addr_filters *filts,
 571                                     const char *filter);
 572 int auxtrace_parse_filters(struct evlist *evlist);
 573
 574 int auxtrace__process_event(struct perf_session *session, union perf_event *event,
 575                             struct perf_sample *sample, struct perf_tool *tool);
 576 void auxtrace__dump_auxtrace_sample(struct perf_session *session,
 577                                     struct perf_sample *sample);
 578 int auxtrace__flush_events(struct perf_session *session, struct perf_tool *tool);
 579 void auxtrace__free_events(struct perf_session *session);
 580 void auxtrace__free(struct perf_session *session);
 581
 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
 598 static inline
 599 void 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
 607 static inline
 608 void itrace_synth_opts__clear_time_range(struct itrace_synth_opts *opts)
 609 {
 610         opts->ptime_range = NULL;
 611         opts->range_num = 0;
 612 }
 613
 614 #else
 615 #include "debug.h"
 616
 617 static inline struct auxtrace_record *
 618 auxtrace_record__init(struct evlist *evlist __maybe_unused,
 619                       int *err)
 620 {
 621         *err = 0;
 622         return NULL;
 623 }
 624
 625 static inline
 626 void auxtrace_record__free(struct auxtrace_record *itr __maybe_unused)
 627 {
 628 }
 629
 630 static inline
 631 int auxtrace_record__options(struct auxtrace_record *itr __maybe_unused,
 632                              struct evlist *evlist __maybe_unused,
 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
 642 static inline
 643 void perf_session__auxtrace_error_inc(struct perf_session *session
 644                                       __maybe_unused,
 645                                       union perf_event *event
 646                                       __maybe_unused)
 647 {
 648 }
 649
 650 static inline
 651 void events_stats__auxtrace_error_warn(const struct events_stats *stats
 652                                        __maybe_unused)
 653 {
 654 }
 655
 656 static inline
 657 int 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
 665 static inline
 666 int auxtrace_parse_snapshot_options(struct auxtrace_record *itr __maybe_unused,
 667                                     struct record_opts *opts __maybe_unused,
 668                                     const char *str)
 669 {
 670         if (!str)
 671                 return 0;
 672         pr_err("AUX area tracing not supported\n");
 673         return -EINVAL;
 674 }
 675
 676 static inline
 677 int 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)
 681 {
 682         if (!str)
 683                 return 0;
 684         pr_err("AUX area tracing not supported\n");
 685         return -EINVAL;
 686 }
 687
 688 static inline
 689 int 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
 697 static inline
 698 void auxtrace__dump_auxtrace_sample(struct perf_session *session __maybe_unused,
 699                                     struct perf_sample *sample __maybe_unused)
 700 {
 701 }
 702
 703 static inline
 704 int auxtrace__flush_events(struct perf_session *session __maybe_unused,
 705                            struct perf_tool *tool __maybe_unused)
 706 {
 707         return 0;
 708 }
 709
 710 static inline
 711 void auxtrace__free_events(struct perf_session *session __maybe_unused)
 712 {
 713 }
 714
 715 static inline
 716 void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache __maybe_unused)
 717 {
 718 }
 719
 720 static inline
 721 void auxtrace__free(struct perf_session *session __maybe_unused)
 722 {
 723 }
 724
 725 static inline
 726 int auxtrace_index__write(int fd __maybe_unused,
 727                           struct list_head *head __maybe_unused)
 728 {
 729         return -EINVAL;
 730 }
 731
 732 static inline
 733 int 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
 741 static inline
 742 void auxtrace_index__free(struct list_head *head __maybe_unused)
 743 {
 744 }
 745
 746 static inline
 747 int auxtrace_parse_filters(struct evlist *evlist __maybe_unused)
 748 {
 749         return 0;
 750 }
 751
 752 int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
 753                         struct auxtrace_mmap_params *mp,
 754                         void *userpg, int fd);
 755 void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
 756 void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
 757                                 off_t auxtrace_offset,
 758                                 unsigned int auxtrace_pages,
 759                                 bool auxtrace_overwrite);
 760 void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
 761                                    struct evlist *evlist, int idx,
 762                                    bool per_cpu);
 763
 764 #define ITRACE_HELP ""
 765
 766 static inline
 767 void 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
 775 static inline
 776 void itrace_synth_opts__clear_time_range(struct itrace_synth_opts *opts
 777                                          __maybe_unused)
 778 {
 779 }
 780
 781 #endif
 782
 783 #endif