tools/lib/perf/include/internal/mmap.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __LIBPERF_INTERNAL_MMAP_H
   3 #define __LIBPERF_INTERNAL_MMAP_H
   4
   5 #include <linux/compiler.h>
   6 #include <linux/refcount.h>
   7 #include <linux/types.h>
   8 #include <stdbool.h>
   9
  10 /* perf sample has 16 bits size limit */
  11 #define PERF_SAMPLE_MAX_SIZE (1 << 16)
  12
  13 struct perf_mmap;
  14 struct perf_counts_values;
  15
  16 typedef void (*libperf_unmap_cb_t)(struct perf_mmap *map);
  17
  18 /**
  19  * struct perf_mmap - perf's ring buffer mmap details
  20  *
  21  * @refcnt - e.g. code using PERF_EVENT_IOC_SET_OUTPUT to share this
  22  */
  23 struct perf_mmap {
  24         void                    *base;
  25         int                      mask;
  26         int                      fd;
  27         int                      cpu;
  28         refcount_t               refcnt;
  29         u64                      prev;
  30         u64                      start;
  31         u64                      end;
  32         bool                     overwrite;
  33         u64                      flush;
  34         libperf_unmap_cb_t       unmap_cb;
  35         char                     event_copy[PERF_SAMPLE_MAX_SIZE] __aligned(8);
  36         struct perf_mmap        *next;
  37 };
  38
  39 struct perf_mmap_param {
  40         int     prot;
  41         int     mask;
  42 };
  43
  44 size_t perf_mmap__mmap_len(struct perf_mmap *map);
  45
  46 void perf_mmap__init(struct perf_mmap *map, struct perf_mmap *prev,
  47                      bool overwrite, libperf_unmap_cb_t unmap_cb);
  48 int perf_mmap__mmap(struct perf_mmap *map, struct perf_mmap_param *mp,
  49                     int fd, int cpu);
  50 void perf_mmap__munmap(struct perf_mmap *map);
  51 void perf_mmap__get(struct perf_mmap *map);
  52 void perf_mmap__put(struct perf_mmap *map);
  53
  54 u64 perf_mmap__read_head(struct perf_mmap *map);
  55
  56 int perf_mmap__read_self(struct perf_mmap *map, struct perf_counts_values *count);
  57
  58 #endif /* __LIBPERF_INTERNAL_MMAP_H */