[mirror_ubuntu-eoan-kernel.git] / tools / perf / util / mmap.h

#ifndef __PERF_MMAP_H
#define __PERF_MMAP_H 1

#include <linux/compiler.h>
#include <linux/refcount.h>
#include <linux/types.h>
#include <linux/ring_buffer.h>
#include <stdbool.h>
#include "auxtrace.h"
#include "event.h"

/**
 * struct perf_mmap - perf's ring buffer mmap details
 *
 * @refcnt - e.g. code using PERF_EVENT_IOC_SET_OUTPUT to share this
 */
struct perf_mmap {
	void		 *base;
	int		 mask;
	int		 fd;
	int		 cpu;
	refcount_t	 refcnt;
	u64		 prev;
	u64		 start;
	u64		 end;
	bool		 overwrite;
	struct auxtrace_mmap auxtrace_mmap;
	char		 event_copy[PERF_SAMPLE_MAX_SIZE] __aligned(8);
};

/*
 * State machine of bkw_mmap_state:
 *
 *                     .________________(forbid)_____________.
 *                     |                                     V
 * NOTREADY --(0)--> RUNNING --(1)--> DATA_PENDING --(2)--> EMPTY
 *                     ^  ^              |   ^               |
 *                     |  |__(forbid)____/   |___(forbid)___/|
 *                     |                                     |
 *                      \_________________(3)_______________/
 *
 * NOTREADY     : Backward ring buffers are not ready
 * RUNNING      : Backward ring buffers are recording
 * DATA_PENDING : We are required to collect data from backward ring buffers
 * EMPTY        : We have collected data from backward ring buffers.
 *
 * (0): Setup backward ring buffer
 * (1): Pause ring buffers for reading
 * (2): Read from ring buffers
 * (3): Resume ring buffers for recording
 */
enum bkw_mmap_state {
	BKW_MMAP_NOTREADY,
	BKW_MMAP_RUNNING,
	BKW_MMAP_DATA_PENDING,
	BKW_MMAP_EMPTY,
};

struct mmap_params {
	int			    prot, mask;
	struct auxtrace_mmap_params auxtrace_mp;
};

int perf_mmap__mmap(struct perf_mmap *map, struct mmap_params *mp, int fd, int cpu);
void perf_mmap__munmap(struct perf_mmap *map);

void perf_mmap__get(struct perf_mmap *map);
void perf_mmap__put(struct perf_mmap *map);

void perf_mmap__consume(struct perf_mmap *map);

static inline u64 perf_mmap__read_head(struct perf_mmap *mm)
{
	return ring_buffer_read_head(mm->base);
}

static inline void perf_mmap__write_tail(struct perf_mmap *md, u64 tail)
{
	ring_buffer_write_tail(md->base, tail);
}

union perf_event *perf_mmap__read_forward(struct perf_mmap *map);

union perf_event *perf_mmap__read_event(struct perf_mmap *map);

int perf_mmap__push(struct perf_mmap *md, void *to,
		    int push(struct perf_mmap *map, void *to, void *buf, size_t size));

size_t perf_mmap__mmap_len(struct perf_mmap *map);

int perf_mmap__read_init(struct perf_mmap *md);
void perf_mmap__read_done(struct perf_mmap *map);
#endif /*__PERF_MMAP_H */
Commit	Line	Data
16958497 ACM	1	#ifndef __PERF_MMAP_H
	2	#define __PERF_MMAP_H 1
	3
	4	#include <linux/compiler.h>
	5	#include <linux/refcount.h>
	6	#include <linux/types.h>
09d62154	7	#include <linux/ring_buffer.h>
16958497 ACM	8	#include <stdbool.h>
	9	#include "auxtrace.h"
	10	#include "event.h"
	11
	12	/**
	13	* struct perf_mmap - perf's ring buffer mmap details
	14	*
	15	* @refcnt - e.g. code using PERF_EVENT_IOC_SET_OUTPUT to share this
	16	*/
	17	struct perf_mmap {
	18	void *base;
	19	int mask;
	20	int fd;
31fb4c0d	21	int cpu;
16958497 ACM	22	refcount_t refcnt;
16958497 ACM	23	u64 prev;
4fda3459 KL	24	u64 start;
4fda3459 KL	25	u64 end;
2c5f6d87	26	bool overwrite;
16958497 ACM	27	struct auxtrace_mmap auxtrace_mmap;
	28	char event_copy[PERF_SAMPLE_MAX_SIZE] __aligned(8);
	29	};
	30
	31	/*
	32	* State machine of bkw_mmap_state:
	33	*
	34	* .________________(forbid)_____________.
	35	* \| V
	36	* NOTREADY --(0)--> RUNNING --(1)--> DATA_PENDING --(2)--> EMPTY
	37	* ^ ^ \| ^ \|
	38	* \| \|__(forbid)____/ \|___(forbid)___/\|
	39	* \| \|
	40	* \_________________(3)_______________/
	41	*
	42	* NOTREADY : Backward ring buffers are not ready
	43	* RUNNING : Backward ring buffers are recording
	44	* DATA_PENDING : We are required to collect data from backward ring buffers
	45	* EMPTY : We have collected data from backward ring buffers.
	46	*
	47	* (0): Setup backward ring buffer
	48	* (1): Pause ring buffers for reading
	49	* (2): Read from ring buffers
	50	* (3): Resume ring buffers for recording
	51	*/
	52	enum bkw_mmap_state {
	53	BKW_MMAP_NOTREADY,
	54	BKW_MMAP_RUNNING,
	55	BKW_MMAP_DATA_PENDING,
	56	BKW_MMAP_EMPTY,
	57	};
	58
	59	struct mmap_params {
	60	int prot, mask;
	61	struct auxtrace_mmap_params auxtrace_mp;
	62	};
	63
31fb4c0d	64	int perf_mmap__mmap(struct perf_mmap map, struct mmap_params mp, int fd, int cpu);
16958497 ACM	65	void perf_mmap__munmap(struct perf_mmap *map);
	66
	67	void perf_mmap__get(struct perf_mmap *map);
	68	void perf_mmap__put(struct perf_mmap *map);
	69
d6ace3df	70	void perf_mmap__consume(struct perf_mmap *map);
16958497	71
16958497 ACM	72	static inline u64 perf_mmap__read_head(struct perf_mmap *mm)
16958497 ACM	73	{
09d62154	74	return ring_buffer_read_head(mm->base);
16958497 ACM	75	}
	76
	77	static inline void perf_mmap__write_tail(struct perf_mmap *md, u64 tail)
	78	{
09d62154	79	ring_buffer_write_tail(md->base, tail);
16958497 ACM	80	}
16958497 ACM	81
8eb7a1fe	82	union perf_event perf_mmap__read_forward(struct perf_mmap map);
16958497	83
0019dc87	84	union perf_event perf_mmap__read_event(struct perf_mmap map);
7bb45972	85
07a9461d	86	int perf_mmap__push(struct perf_mmap md, void to,
ded2b8fe	87	int push(struct perf_mmap map, void to, void *buf, size_t size));
73c17d81	88
16958497 ACM	89	size_t perf_mmap__mmap_len(struct perf_mmap *map);
16958497 ACM	90
b9bae2c8	91	int perf_mmap__read_init(struct perf_mmap *md);
ee023de0	92	void perf_mmap__read_done(struct perf_mmap *map);
16958497	93	#endif /__PERF_MMAP_H /