[deliverable/linux.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_device;

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;
};

struct vhost_virtqueue;

/* 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;
	/* We use a kind of RCU to access private pointer.
	 * All readers access it from worker, which makes it possible to
	 * flush the vhost_work instead of synchronize_rcu. Therefore readers do
	 * not need to call rcu_read_lock/rcu_read_unlock: the beginning of
	 * vhost_work execution acts instead of rcu_read_lock() and the end of
	 * vhost_work execution acts instead of rcu_read_unlock().
	 * Writers use virtqueue mutex. */
	void __rcu *private_data;
	/* Log write descriptors */
	void __user *log_base;
	struct vhost_log *log;
};

struct vhost_dev {
	/* Readers use RCU to access memory table pointer
	 * log base pointer and features.
	 * Writers use mutex below.*/
	struct vhost_memory __rcu *memory;
	struct mm_struct *mm;
	struct mutex mutex;
	unsigned acked_features;
	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;
};

long 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_dev *, 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 int vhost_has_feature(struct vhost_dev *dev, int bit)
{
	unsigned acked_features;

	/* TODO: check that we are running from vhost_worker or dev mutex is
	 * held? */
	acked_features = rcu_dereference_index_check(dev->acked_features, 1);
	return acked_features & (1 << bit);
}
#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 MT	14
	15	struct vhost_device;
	16
c23f3445 TH	17	struct vhost_work;
	18	typedef void (vhost_work_fn_t)(struct vhost_work work);
	19
	20	struct vhost_work {
	21	struct list_head node;
	22	vhost_work_fn_t fn;
	23	wait_queue_head_t done;
	24	int flushing;
	25	unsigned queue_seq;
	26	unsigned done_seq;
	27	};
	28
3a4d5c94 MT	29	/* Poll a file (eventfd or socket) */
	30	/* Note: there's nothing vhost specific about this structure. */
	31	struct vhost_poll {
	32	poll_table table;
	33	wait_queue_head_t *wqh;
	34	wait_queue_t wait;
c23f3445	35	struct vhost_work work;
3a4d5c94	36	unsigned long mask;
c23f3445	37	struct vhost_dev *dev;
3a4d5c94 MT	38	};
3a4d5c94 MT	39
163049ae SH	40	void vhost_work_init(struct vhost_work *work, vhost_work_fn_t fn);
	41	void vhost_work_queue(struct vhost_dev dev, struct vhost_work work);
	42
c23f3445 TH	43	void vhost_poll_init(struct vhost_poll *poll, vhost_work_fn_t fn,
c23f3445 TH	44	unsigned long mask, struct vhost_dev *dev);
2b8b328b	45	int vhost_poll_start(struct vhost_poll poll, struct file file);
3a4d5c94 MT	46	void vhost_poll_stop(struct vhost_poll *poll);
	47	void vhost_poll_flush(struct vhost_poll *poll);
	48	void vhost_poll_queue(struct vhost_poll *poll);
6ac1afbf AH	49	void vhost_work_flush(struct vhost_dev dev, struct vhost_work work);
6ac1afbf AH	50	long vhost_vring_ioctl(struct vhost_dev d, int ioctl, void __user argp);
3a4d5c94 MT	51
	52	struct vhost_log {
	53	u64 addr;
	54	u64 len;
	55	};
	56
bab632d6 MT	57	struct vhost_virtqueue;
bab632d6 MT	58
3a4d5c94 MT	59	/* The virtqueue structure describes a queue attached to a device. */
	60	struct vhost_virtqueue {
	61	struct vhost_dev *dev;
	62
	63	/* The actual ring of buffers. */
	64	struct mutex mutex;
	65	unsigned int num;
	66	struct vring_desc __user *desc;
	67	struct vring_avail __user *avail;
	68	struct vring_used __user *used;
	69	struct file *kick;
	70	struct file *call;
	71	struct file *error;
	72	struct eventfd_ctx *call_ctx;
	73	struct eventfd_ctx *error_ctx;
	74	struct eventfd_ctx *log_ctx;
	75
	76	struct vhost_poll poll;
	77
	78	/* The routine to call when the Guest pings us, or timeout. */
c23f3445	79	vhost_work_fn_t handle_kick;
3a4d5c94 MT	80
	81	/* Last available index we saw. */
	82	u16 last_avail_idx;
	83
	84	/* Caches available index value from user. */
	85	u16 avail_idx;
	86
	87	/* Last index we used. */
	88	u16 last_used_idx;
	89
	90	/* Used flags */
	91	u16 used_flags;
	92
8ea8cf89 MT	93	/* Last used index value we have signalled on */
	94	u16 signalled_used;
	95
	96	/* Last used index value we have signalled on */
	97	bool signalled_used_valid;
	98
3a4d5c94 MT	99	/* Log writes to used structure. */
	100	bool log_used;
	101	u64 log_addr;
	102
e0e9b406	103	struct iovec iov[UIO_MAXIOV];
e0e9b406	104	struct iovec *indirect;
e0e9b406	105	struct vring_used_elem *heads;
3a4d5c94	106	/* We use a kind of RCU to access private pointer.
c23f3445 TH	107	* All readers access it from worker, which makes it possible to
c23f3445 TH	108	* flush the vhost_work instead of synchronize_rcu. Therefore readers do
3a4d5c94	109	* not need to call rcu_read_lock/rcu_read_unlock: the beginning of
c23f3445	110	* vhost_work execution acts instead of rcu_read_lock() and the end of
a290aec8	111	* vhost_work execution acts instead of rcu_read_unlock().
3a4d5c94	112	* Writers use virtqueue mutex. */
28457ee6	113	void __rcu *private_data;
3a4d5c94 MT	114	/* Log write descriptors */
3a4d5c94 MT	115	void __user *log_base;
e0e9b406	116	struct vhost_log *log;
3a4d5c94 MT	117	};
	118
	119	struct vhost_dev {
	120	/* Readers use RCU to access memory table pointer
	121	* log base pointer and features.
	122	* Writers use mutex below.*/
28457ee6	123	struct vhost_memory __rcu *memory;
3a4d5c94 MT	124	struct mm_struct *mm;
	125	struct mutex mutex;
	126	unsigned acked_features;
3ab2e420	127	struct vhost_virtqueue **vqs;
3a4d5c94 MT	128	int nvqs;
	129	struct file *log_file;
	130	struct eventfd_ctx *log_ctx;
c23f3445 TH	131	spinlock_t work_lock;
	132	struct list_head work_list;
	133	struct task_struct *worker;
3a4d5c94 MT	134	};
3a4d5c94 MT	135
3ab2e420	136	long vhost_dev_init(struct vhost_dev , struct vhost_virtqueue *vqs, int nvqs);
54db63c2	137	long vhost_dev_set_owner(struct vhost_dev *dev);
05c05351	138	bool vhost_dev_has_owner(struct vhost_dev *dev);
3a4d5c94	139	long vhost_dev_check_owner(struct vhost_dev *);
150b9e51 MT	140	struct vhost_memory *vhost_dev_reset_owner_prepare(void);
150b9e51 MT	141	void vhost_dev_reset_owner(struct vhost_dev , struct vhost_memory );
ea5d4046	142	void vhost_dev_cleanup(struct vhost_dev *, bool locked);
b211616d	143	void vhost_dev_stop(struct vhost_dev *);
935cdee7 MT	144	long vhost_dev_ioctl(struct vhost_dev , unsigned int ioctl, void __user argp);
935cdee7 MT	145	long vhost_vring_ioctl(struct vhost_dev d, int ioctl, void __user argp);
3a4d5c94 MT	146	int vhost_vq_access_ok(struct vhost_virtqueue *vq);
	147	int vhost_log_access_ok(struct vhost_dev *);
	148
d5675bd2 MT	149	int vhost_get_vq_desc(struct vhost_dev , struct vhost_virtqueue ,
	150	struct iovec iov[], unsigned int iov_count,
	151	unsigned int out_num, unsigned int in_num,
	152	struct vhost_log log, unsigned int log_num);
8dd014ad	153	void vhost_discard_vq_desc(struct vhost_virtqueue *, int n);
3a4d5c94	154
f59281da	155	int vhost_init_used(struct vhost_virtqueue *);
3a4d5c94	156	int vhost_add_used(struct vhost_virtqueue *, unsigned int head, int len);
8dd014ad DS	157	int vhost_add_used_n(struct vhost_virtqueue , struct vring_used_elem heads,
8dd014ad DS	158	unsigned count);
3a4d5c94	159	void vhost_add_used_and_signal(struct vhost_dev , struct vhost_virtqueue ,
8dd014ad DS	160	unsigned int id, int len);
	161	void vhost_add_used_and_signal_n(struct vhost_dev , struct vhost_virtqueue ,
	162	struct vring_used_elem *heads, unsigned count);
	163	void vhost_signal(struct vhost_dev , struct vhost_virtqueue );
8ea8cf89 MT	164	void vhost_disable_notify(struct vhost_dev , struct vhost_virtqueue );
8ea8cf89 MT	165	bool vhost_enable_notify(struct vhost_dev , struct vhost_virtqueue );
3a4d5c94 MT	166
	167	int vhost_log_write(struct vhost_virtqueue vq, struct vhost_log log,
	168	unsigned int log_num, u64 len);
	169
3a4d5c94 MT	170	#define vq_err(vq, fmt, ...) do { \
	171	pr_debug(pr_fmt(fmt), ##__VA_ARGS__); \
	172	if ((vq)->error_ctx) \
	173	eventfd_signal((vq)->error_ctx, 1);\
	174	} while (0)
	175
	176	enum {
8ea8cf89 MT	177	VHOST_FEATURES = (1ULL << VIRTIO_F_NOTIFY_ON_EMPTY) \|
	178	(1ULL << VIRTIO_RING_F_INDIRECT_DESC) \|
	179	(1ULL << VIRTIO_RING_F_EVENT_IDX) \|
0dd05a3b	180	(1ULL << VHOST_F_LOG_ALL),
3a4d5c94 MT	181	};
	182
	183	static inline int vhost_has_feature(struct vhost_dev *dev, int bit)
	184	{
28457ee6 AB	185	unsigned acked_features;
28457ee6 AB	186
5e18247b MT	187	/* TODO: check that we are running from vhost_worker or dev mutex is
	188	* held? */
	189	acked_features = rcu_dereference_index_check(dev->acked_features, 1);
3a4d5c94 MT	190	return acked_features & (1 << bit);
3a4d5c94 MT	191	}
3a4d5c94	192	#endif