[mirror_ubuntu-bionic-kernel.git] / drivers / vhost / vhost.h

#ifndef _VHOST_H
#define _VHOST_H

#include <linux/eventfd.h>
#include <linux/vhost.h>
#include <linux/mm.h>
#include <linux/mutex.h>
#include <linux/poll.h>
#include <linux/file.h>
#include <linux/uio.h>
#include <linux/virtio_config.h>
#include <linux/virtio_ring.h>
#include <linux/atomic.h>

struct vhost_work;
typedef void (*vhost_work_fn_t)(struct vhost_work *work);

struct vhost_work {
	struct list_head	  node;
	vhost_work_fn_t		  fn;
	wait_queue_head_t	  done;
	int			  flushing;
	unsigned		  queue_seq;
	unsigned		  done_seq;
};

/* Poll a file (eventfd or socket) */
/* Note: there's nothing vhost specific about this structure. */
struct vhost_poll {
	poll_table                table;
	wait_queue_head_t        *wqh;
	wait_queue_t              wait;
	struct vhost_work	  work;
	unsigned long		  mask;
	struct vhost_dev	 *dev;
};

void vhost_work_init(struct vhost_work *work, vhost_work_fn_t fn);
void vhost_work_queue(struct vhost_dev *dev, struct vhost_work *work);

void vhost_poll_init(struct vhost_poll *poll, vhost_work_fn_t fn,
		     unsigned long mask, struct vhost_dev *dev);
int vhost_poll_start(struct vhost_poll *poll, struct file *file);
void vhost_poll_stop(struct vhost_poll *poll);
void vhost_poll_flush(struct vhost_poll *poll);
void vhost_poll_queue(struct vhost_poll *poll);
void vhost_work_flush(struct vhost_dev *dev, struct vhost_work *work);
long vhost_vring_ioctl(struct vhost_dev *d, int ioctl, void __user *argp);

struct vhost_log {
	u64 addr;
	u64 len;
};

/* The virtqueue structure describes a queue attached to a device. */
struct vhost_virtqueue {
	struct vhost_dev *dev;

	/* The actual ring of buffers. */
	struct mutex mutex;
	unsigned int num;
	struct vring_desc __user *desc;
	struct vring_avail __user *avail;
	struct vring_used __user *used;
	struct file *kick;
	struct file *call;
	struct file *error;
	struct eventfd_ctx *call_ctx;
	struct eventfd_ctx *error_ctx;
	struct eventfd_ctx *log_ctx;

	struct vhost_poll poll;

	/* The routine to call when the Guest pings us, or timeout. */
	vhost_work_fn_t handle_kick;

	/* Last available index we saw. */
	u16 last_avail_idx;

	/* Caches available index value from user. */
	u16 avail_idx;

	/* Last index we used. */
	u16 last_used_idx;

	/* Used flags */
	u16 used_flags;

	/* Last used index value we have signalled on */
	u16 signalled_used;

	/* Last used index value we have signalled on */
	bool signalled_used_valid;

	/* Log writes to used structure. */
	bool log_used;
	u64 log_addr;

	struct iovec iov[UIO_MAXIOV];
	struct iovec *indirect;
	struct vring_used_elem *heads;
	/* Protected by virtqueue mutex. */
	struct vhost_memory *memory;
	void *private_data;
	u64 acked_features;
	/* Log write descriptors */
	void __user *log_base;
	struct vhost_log *log;
};

struct vhost_dev {
	struct vhost_memory *memory;
	struct mm_struct *mm;
	struct mutex mutex;
	struct vhost_virtqueue **vqs;
	int nvqs;
	struct file *log_file;
	struct eventfd_ctx *log_ctx;
	spinlock_t work_lock;
	struct list_head work_list;
	struct task_struct *worker;
};

void vhost_dev_init(struct vhost_dev *, struct vhost_virtqueue **vqs, int nvqs);
long vhost_dev_set_owner(struct vhost_dev *dev);
bool vhost_dev_has_owner(struct vhost_dev *dev);
long vhost_dev_check_owner(struct vhost_dev *);
struct vhost_memory *vhost_dev_reset_owner_prepare(void);
void vhost_dev_reset_owner(struct vhost_dev *, struct vhost_memory *);
void vhost_dev_cleanup(struct vhost_dev *, bool locked);
void vhost_dev_stop(struct vhost_dev *);
long vhost_dev_ioctl(struct vhost_dev *, unsigned int ioctl, void __user *argp);
long vhost_vring_ioctl(struct vhost_dev *d, int ioctl, void __user *argp);
int vhost_vq_access_ok(struct vhost_virtqueue *vq);
int vhost_log_access_ok(struct vhost_dev *);

int vhost_get_vq_desc(struct vhost_virtqueue *,
		      struct iovec iov[], unsigned int iov_count,
		      unsigned int *out_num, unsigned int *in_num,
		      struct vhost_log *log, unsigned int *log_num);
void vhost_discard_vq_desc(struct vhost_virtqueue *, int n);

int vhost_init_used(struct vhost_virtqueue *);
int vhost_add_used(struct vhost_virtqueue *, unsigned int head, int len);
int vhost_add_used_n(struct vhost_virtqueue *, struct vring_used_elem *heads,
		     unsigned count);
void vhost_add_used_and_signal(struct vhost_dev *, struct vhost_virtqueue *,
			       unsigned int id, int len);
void vhost_add_used_and_signal_n(struct vhost_dev *, struct vhost_virtqueue *,
			       struct vring_used_elem *heads, unsigned count);
void vhost_signal(struct vhost_dev *, struct vhost_virtqueue *);
void vhost_disable_notify(struct vhost_dev *, struct vhost_virtqueue *);
bool vhost_enable_notify(struct vhost_dev *, struct vhost_virtqueue *);

int vhost_log_write(struct vhost_virtqueue *vq, struct vhost_log *log,
		    unsigned int log_num, u64 len);

#define vq_err(vq, fmt, ...) do {                                  \
		pr_debug(pr_fmt(fmt), ##__VA_ARGS__);       \
		if ((vq)->error_ctx)                               \
				eventfd_signal((vq)->error_ctx, 1);\
	} while (0)

enum {
	VHOST_FEATURES = (1ULL << VIRTIO_F_NOTIFY_ON_EMPTY) |
			 (1ULL << VIRTIO_RING_F_INDIRECT_DESC) |
			 (1ULL << VIRTIO_RING_F_EVENT_IDX) |
			 (1ULL << VHOST_F_LOG_ALL),
};

static inline bool vhost_has_feature(struct vhost_virtqueue *vq, int bit)
{
	return vq->acked_features & (1ULL << bit);
}

/* Memory accessors */
static inline u16 vhost16_to_cpu(struct vhost_virtqueue *vq, __virtio16 val)
{
	return __virtio16_to_cpu(vhost_has_feature(vq, VIRTIO_F_VERSION_1), val);
}

static inline __virtio16 cpu_to_vhost16(struct vhost_virtqueue *vq, u16 val)
{
	return __cpu_to_virtio16(vhost_has_feature(vq, VIRTIO_F_VERSION_1), val);
}

static inline u32 vhost32_to_cpu(struct vhost_virtqueue *vq, __virtio32 val)
{
	return __virtio32_to_cpu(vhost_has_feature(vq, VIRTIO_F_VERSION_1), val);
}

static inline __virtio32 cpu_to_vhost32(struct vhost_virtqueue *vq, u32 val)
{
	return __cpu_to_virtio32(vhost_has_feature(vq, VIRTIO_F_VERSION_1), val);
}

static inline u64 vhost64_to_cpu(struct vhost_virtqueue *vq, __virtio64 val)
{
	return __virtio64_to_cpu(vhost_has_feature(vq, VIRTIO_F_VERSION_1), val);
}

static inline __virtio64 cpu_to_vhost64(struct vhost_virtqueue *vq, u64 val)
{
	return __cpu_to_virtio64(vhost_has_feature(vq, VIRTIO_F_VERSION_1), val);
}
#endif
Commit	Line	Data
3a4d5c94 MT	1	#ifndef _VHOST_H
	2	#define _VHOST_H
	3
	4	#include <linux/eventfd.h>
	5	#include <linux/vhost.h>
	6	#include <linux/mm.h>
	7	#include <linux/mutex.h>
3a4d5c94 MT	8	#include <linux/poll.h>
3a4d5c94 MT	9	#include <linux/file.h>
3a4d5c94 MT	10	#include <linux/uio.h>
	11	#include <linux/virtio_config.h>
	12	#include <linux/virtio_ring.h>
60063497	13	#include <linux/atomic.h>
3a4d5c94	14
c23f3445 TH	15	struct vhost_work;
	16	typedef void (vhost_work_fn_t)(struct vhost_work work);
	17
	18	struct vhost_work {
	19	struct list_head node;
	20	vhost_work_fn_t fn;
	21	wait_queue_head_t done;
	22	int flushing;
	23	unsigned queue_seq;
	24	unsigned done_seq;
	25	};
	26
3a4d5c94 MT	27	/* Poll a file (eventfd or socket) */
	28	/* Note: there's nothing vhost specific about this structure. */
	29	struct vhost_poll {
	30	poll_table table;
	31	wait_queue_head_t *wqh;
	32	wait_queue_t wait;
c23f3445	33	struct vhost_work work;
3a4d5c94	34	unsigned long mask;
c23f3445	35	struct vhost_dev *dev;
3a4d5c94 MT	36	};
3a4d5c94 MT	37
163049ae SH	38	void vhost_work_init(struct vhost_work *work, vhost_work_fn_t fn);
	39	void vhost_work_queue(struct vhost_dev dev, struct vhost_work work);
	40
c23f3445 TH	41	void vhost_poll_init(struct vhost_poll *poll, vhost_work_fn_t fn,
c23f3445 TH	42	unsigned long mask, struct vhost_dev *dev);
2b8b328b	43	int vhost_poll_start(struct vhost_poll poll, struct file file);
3a4d5c94 MT	44	void vhost_poll_stop(struct vhost_poll *poll);
	45	void vhost_poll_flush(struct vhost_poll *poll);
	46	void vhost_poll_queue(struct vhost_poll *poll);
6ac1afbf AH	47	void vhost_work_flush(struct vhost_dev dev, struct vhost_work work);
6ac1afbf AH	48	long vhost_vring_ioctl(struct vhost_dev d, int ioctl, void __user argp);
3a4d5c94 MT	49
	50	struct vhost_log {
	51	u64 addr;
	52	u64 len;
	53	};
	54
	55	/* The virtqueue structure describes a queue attached to a device. */
	56	struct vhost_virtqueue {
	57	struct vhost_dev *dev;
	58
	59	/* The actual ring of buffers. */
	60	struct mutex mutex;
	61	unsigned int num;
	62	struct vring_desc __user *desc;
	63	struct vring_avail __user *avail;
	64	struct vring_used __user *used;
	65	struct file *kick;
	66	struct file *call;
	67	struct file *error;
	68	struct eventfd_ctx *call_ctx;
	69	struct eventfd_ctx *error_ctx;
	70	struct eventfd_ctx *log_ctx;
	71
	72	struct vhost_poll poll;
	73
	74	/* The routine to call when the Guest pings us, or timeout. */
c23f3445	75	vhost_work_fn_t handle_kick;
3a4d5c94 MT	76
	77	/* Last available index we saw. */
	78	u16 last_avail_idx;
	79
	80	/* Caches available index value from user. */
	81	u16 avail_idx;
	82
	83	/* Last index we used. */
	84	u16 last_used_idx;
	85
	86	/* Used flags */
	87	u16 used_flags;
	88
8ea8cf89 MT	89	/* Last used index value we have signalled on */
	90	u16 signalled_used;
	91
	92	/* Last used index value we have signalled on */
	93	bool signalled_used_valid;
	94
3a4d5c94 MT	95	/* Log writes to used structure. */
	96	bool log_used;
	97	u64 log_addr;
	98
e0e9b406	99	struct iovec iov[UIO_MAXIOV];
e0e9b406	100	struct iovec *indirect;
e0e9b406	101	struct vring_used_elem *heads;
22fa90c7	102	/* Protected by virtqueue mutex. */
47283bef	103	struct vhost_memory *memory;
22fa90c7	104	void *private_data;
bd82752a	105	u64 acked_features;
3a4d5c94 MT	106	/* Log write descriptors */
3a4d5c94 MT	107	void __user *log_base;
e0e9b406	108	struct vhost_log *log;
3a4d5c94 MT	109	};
	110
	111	struct vhost_dev {
47283bef	112	struct vhost_memory *memory;
3a4d5c94 MT	113	struct mm_struct *mm;
3a4d5c94 MT	114	struct mutex mutex;
3ab2e420	115	struct vhost_virtqueue **vqs;
3a4d5c94 MT	116	int nvqs;
	117	struct file *log_file;
	118	struct eventfd_ctx *log_ctx;
c23f3445 TH	119	spinlock_t work_lock;
	120	struct list_head work_list;
	121	struct task_struct *worker;
3a4d5c94 MT	122	};
3a4d5c94 MT	123
59566b6e	124	void vhost_dev_init(struct vhost_dev , struct vhost_virtqueue *vqs, int nvqs);
54db63c2	125	long vhost_dev_set_owner(struct vhost_dev *dev);
05c05351	126	bool vhost_dev_has_owner(struct vhost_dev *dev);
3a4d5c94	127	long vhost_dev_check_owner(struct vhost_dev *);
150b9e51 MT	128	struct vhost_memory *vhost_dev_reset_owner_prepare(void);
150b9e51 MT	129	void vhost_dev_reset_owner(struct vhost_dev , struct vhost_memory );
ea5d4046	130	void vhost_dev_cleanup(struct vhost_dev *, bool locked);
b211616d	131	void vhost_dev_stop(struct vhost_dev *);
935cdee7 MT	132	long vhost_dev_ioctl(struct vhost_dev , unsigned int ioctl, void __user argp);
935cdee7 MT	133	long vhost_vring_ioctl(struct vhost_dev d, int ioctl, void __user argp);
3a4d5c94 MT	134	int vhost_vq_access_ok(struct vhost_virtqueue *vq);
	135	int vhost_log_access_ok(struct vhost_dev *);
	136
47283bef	137	int vhost_get_vq_desc(struct vhost_virtqueue *,
d5675bd2 MT	138	struct iovec iov[], unsigned int iov_count,
	139	unsigned int out_num, unsigned int in_num,
	140	struct vhost_log log, unsigned int log_num);
8dd014ad	141	void vhost_discard_vq_desc(struct vhost_virtqueue *, int n);
3a4d5c94	142
f59281da	143	int vhost_init_used(struct vhost_virtqueue *);
3a4d5c94	144	int vhost_add_used(struct vhost_virtqueue *, unsigned int head, int len);
8dd014ad DS	145	int vhost_add_used_n(struct vhost_virtqueue , struct vring_used_elem heads,
8dd014ad DS	146	unsigned count);
3a4d5c94	147	void vhost_add_used_and_signal(struct vhost_dev , struct vhost_virtqueue ,
8dd014ad DS	148	unsigned int id, int len);
	149	void vhost_add_used_and_signal_n(struct vhost_dev , struct vhost_virtqueue ,
	150	struct vring_used_elem *heads, unsigned count);
	151	void vhost_signal(struct vhost_dev , struct vhost_virtqueue );
8ea8cf89 MT	152	void vhost_disable_notify(struct vhost_dev , struct vhost_virtqueue );
8ea8cf89 MT	153	bool vhost_enable_notify(struct vhost_dev , struct vhost_virtqueue );
3a4d5c94 MT	154
	155	int vhost_log_write(struct vhost_virtqueue vq, struct vhost_log log,
	156	unsigned int log_num, u64 len);
	157
3a4d5c94 MT	158	#define vq_err(vq, fmt, ...) do { \
	159	pr_debug(pr_fmt(fmt), ##__VA_ARGS__); \
	160	if ((vq)->error_ctx) \
	161	eventfd_signal((vq)->error_ctx, 1);\
	162	} while (0)
	163
	164	enum {
8ea8cf89 MT	165	VHOST_FEATURES = (1ULL << VIRTIO_F_NOTIFY_ON_EMPTY) \|
	166	(1ULL << VIRTIO_RING_F_INDIRECT_DESC) \|
	167	(1ULL << VIRTIO_RING_F_EVENT_IDX) \|
0dd05a3b	168	(1ULL << VHOST_F_LOG_ALL),
3a4d5c94 MT	169	};
3a4d5c94 MT	170
bd82752a	171	static inline bool vhost_has_feature(struct vhost_virtqueue *vq, int bit)
3a4d5c94	172	{
bd82752a	173	return vq->acked_features & (1ULL << bit);
3a4d5c94	174	}
e05fd12b MT	175
	176	/* Memory accessors */
	177	static inline u16 vhost16_to_cpu(struct vhost_virtqueue *vq, __virtio16 val)
	178	{
	179	return __virtio16_to_cpu(vhost_has_feature(vq, VIRTIO_F_VERSION_1), val);
	180	}
	181
	182	static inline __virtio16 cpu_to_vhost16(struct vhost_virtqueue *vq, u16 val)
	183	{
	184	return __cpu_to_virtio16(vhost_has_feature(vq, VIRTIO_F_VERSION_1), val);
	185	}
	186
	187	static inline u32 vhost32_to_cpu(struct vhost_virtqueue *vq, __virtio32 val)
	188	{
	189	return __virtio32_to_cpu(vhost_has_feature(vq, VIRTIO_F_VERSION_1), val);
	190	}
	191
	192	static inline __virtio32 cpu_to_vhost32(struct vhost_virtqueue *vq, u32 val)
	193	{
	194	return __cpu_to_virtio32(vhost_has_feature(vq, VIRTIO_F_VERSION_1), val);
	195	}
	196
	197	static inline u64 vhost64_to_cpu(struct vhost_virtqueue *vq, __virtio64 val)
	198	{
	199	return __virtio64_to_cpu(vhost_has_feature(vq, VIRTIO_F_VERSION_1), val);
	200	}
	201
	202	static inline __virtio64 cpu_to_vhost64(struct vhost_virtqueue *vq, u64 val)
	203	{
	204	return __cpu_to_virtio64(vhost_has_feature(vq, VIRTIO_F_VERSION_1), val);
	205	}
3a4d5c94	206	#endif