[linux-block.git] / drivers / vhost / vhost.h

/* SPDX-License-Identifier: GPL-2.0 */
#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>
#include <linux/vhost_iotlb.h>
#include <linux/irqbypass.h>

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

#define VHOST_WORK_QUEUED 1
struct vhost_work {
	struct llist_node	node;
	vhost_work_fn_t		fn;
	unsigned long		flags;
};

struct vhost_worker {
	struct vhost_task	*vtsk;
	/* Used to serialize device wide flushing with worker swapping. */
	struct mutex		mutex;
	struct llist_head	work_list;
	u64			kcov_handle;
	u32			id;
	int			attachment_cnt;
};

/* 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_entry_t	wait;
	struct vhost_work	work;
	__poll_t		mask;
	struct vhost_dev	*dev;
	struct vhost_virtqueue	*vq;
};

void vhost_poll_init(struct vhost_poll *poll, vhost_work_fn_t fn,
		     __poll_t mask, struct vhost_dev *dev,
		     struct vhost_virtqueue *vq);
int vhost_poll_start(struct vhost_poll *poll, struct file *file);
void vhost_poll_stop(struct vhost_poll *poll);
void vhost_poll_queue(struct vhost_poll *poll);

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

struct vhost_log {
	u64 addr;
	u64 len;
};

enum vhost_uaddr_type {
	VHOST_ADDR_DESC = 0,
	VHOST_ADDR_AVAIL = 1,
	VHOST_ADDR_USED = 2,
	VHOST_NUM_ADDRS = 3,
};

struct vhost_vring_call {
	struct eventfd_ctx *ctx;
	struct irq_bypass_producer producer;
};

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

	/* The actual ring of buffers. */
	struct mutex mutex;
	unsigned int num;
	vring_desc_t __user *desc;
	vring_avail_t __user *avail;
	vring_used_t __user *used;
	const struct vhost_iotlb_map *meta_iotlb[VHOST_NUM_ADDRS];
	struct file *kick;
	struct vhost_vring_call 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.
	 * Values are limited to 0x7fff, and the high bit is used as
	 * a wrap counter when using VIRTIO_F_RING_PACKED. */
	u16 last_avail_idx;

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

	/* Last index we used.
	 * Values are limited to 0x7fff, and the high bit is used as
	 * a wrap counter when using VIRTIO_F_RING_PACKED. */
	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 iotlb_iov[64];
	struct iovec *indirect;
	struct vring_used_elem *heads;
	/* Protected by virtqueue mutex. */
	struct vhost_iotlb *umem;
	struct vhost_iotlb *iotlb;
	void *private_data;
	u64 acked_features;
	u64 acked_backend_features;
	/* Log write descriptors */
	void __user *log_base;
	struct vhost_log *log;
	struct iovec log_iov[64];

	/* Ring endianness. Defaults to legacy native endianness.
	 * Set to true when starting a modern virtio device. */
	bool is_le;
#ifdef CONFIG_VHOST_CROSS_ENDIAN_LEGACY
	/* Ring endianness requested by userspace for cross-endian support. */
	bool user_be;
#endif
	u32 busyloop_timeout;
};

struct vhost_msg_node {
  union {
	  struct vhost_msg msg;
	  struct vhost_msg_v2 msg_v2;
  };
  struct vhost_virtqueue *vq;
  struct list_head node;
};

struct vhost_dev {
	struct mm_struct *mm;
	struct mutex mutex;
	struct vhost_virtqueue **vqs;
	int nvqs;
	struct eventfd_ctx *log_ctx;
	struct vhost_iotlb *umem;
	struct vhost_iotlb *iotlb;
	spinlock_t iotlb_lock;
	struct list_head read_list;
	struct list_head pending_list;
	wait_queue_head_t wait;
	int iov_limit;
	int weight;
	int byte_weight;
	struct xarray worker_xa;
	bool use_worker;
	int (*msg_handler)(struct vhost_dev *dev, u32 asid,
			   struct vhost_iotlb_msg *msg);
};

bool vhost_exceeds_weight(struct vhost_virtqueue *vq, int pkts, int total_len);
void vhost_dev_init(struct vhost_dev *, struct vhost_virtqueue **vqs,
		    int nvqs, int iov_limit, int weight, int byte_weight,
		    bool use_worker,
		    int (*msg_handler)(struct vhost_dev *dev, u32 asid,
				       struct vhost_iotlb_msg *msg));
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_iotlb *vhost_dev_reset_owner_prepare(void);
void vhost_dev_reset_owner(struct vhost_dev *dev, struct vhost_iotlb *iotlb);
void vhost_dev_cleanup(struct vhost_dev *);
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, unsigned int ioctl, void __user *argp);
long vhost_worker_ioctl(struct vhost_dev *dev, unsigned int ioctl,
			void __user *argp);
bool vhost_vq_access_ok(struct vhost_virtqueue *vq);
bool vhost_log_access_ok(struct vhost_dev *);
void vhost_clear_msg(struct vhost_dev *dev);

int vhost_get_vq_desc(struct vhost_virtqueue *,
		      struct iovec iov[], unsigned int iov_size,
		      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);

void vhost_vq_flush(struct vhost_virtqueue *vq);
bool vhost_vq_work_queue(struct vhost_virtqueue *vq, struct vhost_work *work);
bool vhost_vq_has_work(struct vhost_virtqueue *vq);
bool vhost_vq_is_setup(struct vhost_virtqueue *vq);
int vhost_vq_init_access(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_vq_avail_empty(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,
		    struct iovec *iov, int count);
int vq_meta_prefetch(struct vhost_virtqueue *vq);

struct vhost_msg_node *vhost_new_msg(struct vhost_virtqueue *vq, int type);
void vhost_enqueue_msg(struct vhost_dev *dev,
		       struct list_head *head,
		       struct vhost_msg_node *node);
struct vhost_msg_node *vhost_dequeue_msg(struct vhost_dev *dev,
					 struct list_head *head);
void vhost_set_backend_features(struct vhost_dev *dev, u64 features);

__poll_t vhost_chr_poll(struct file *file, struct vhost_dev *dev,
			    poll_table *wait);
ssize_t vhost_chr_read_iter(struct vhost_dev *dev, struct iov_iter *to,
			    int noblock);
ssize_t vhost_chr_write_iter(struct vhost_dev *dev,
			     struct iov_iter *from);
int vhost_init_device_iotlb(struct vhost_dev *d);

void vhost_iotlb_map_free(struct vhost_iotlb *iotlb,
			  struct vhost_iotlb_map *map);

#define vq_err(vq, fmt, ...) do {                                  \
		pr_debug(pr_fmt(fmt), ##__VA_ARGS__);       \
		if ((vq)->error_ctx)                               \
				eventfd_signal((vq)->error_ctx);\
	} 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) |
			 (1ULL << VIRTIO_F_ANY_LAYOUT) |
			 (1ULL << VIRTIO_F_VERSION_1)
};

/**
 * vhost_vq_set_backend - Set backend.
 *
 * @vq            Virtqueue.
 * @private_data  The private data.
 *
 * Context: Need to call with vq->mutex acquired.
 */
static inline void vhost_vq_set_backend(struct vhost_virtqueue *vq,
					void *private_data)
{
	vq->private_data = private_data;
}

/**
 * vhost_vq_get_backend - Get backend.
 *
 * @vq            Virtqueue.
 *
 * Context: Need to call with vq->mutex acquired.
 * Return: Private data previously set with vhost_vq_set_backend.
 */
static inline void *vhost_vq_get_backend(struct vhost_virtqueue *vq)
{
	return vq->private_data;
}

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

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

#ifdef CONFIG_VHOST_CROSS_ENDIAN_LEGACY
static inline bool vhost_is_little_endian(struct vhost_virtqueue *vq)
{
	return vq->is_le;
}
#else
static inline bool vhost_is_little_endian(struct vhost_virtqueue *vq)
{
	return virtio_legacy_is_little_endian() || vq->is_le;
}
#endif

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

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

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

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

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

static inline __virtio64 cpu_to_vhost64(struct vhost_virtqueue *vq, u64 val)
{
	return __cpu_to_virtio64(vhost_is_little_endian(vq), val);
}
#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
3a4d5c94 MT	2	#ifndef _VHOST_H
	3	#define _VHOST_H
	4
	5	#include <linux/eventfd.h>
	6	#include <linux/vhost.h>
	7	#include <linux/mm.h>
	8	#include <linux/mutex.h>
3a4d5c94 MT	9	#include <linux/poll.h>
3a4d5c94 MT	10	#include <linux/file.h>
3a4d5c94 MT	11	#include <linux/uio.h>
	12	#include <linux/virtio_config.h>
	13	#include <linux/virtio_ring.h>
60063497	14	#include <linux/atomic.h>
0bbe3066	15	#include <linux/vhost_iotlb.h>
265a0ad8	16	#include <linux/irqbypass.h>
3a4d5c94	17
c23f3445	18	struct vhost_work;
6e890c5d	19	struct vhost_task;
c23f3445 TH	20	typedef void (vhost_work_fn_t)(struct vhost_work work);
c23f3445 TH	21
04b96e55	22	#define VHOST_WORK_QUEUED 1
c23f3445	23	struct vhost_work {
d8f35f41 MC	24	struct llist_node node;
	25	vhost_work_fn_t fn;
	26	unsigned long flags;
c23f3445 TH	27	};
c23f3445 TH	28
1a5f8090	29	struct vhost_worker {
6e890c5d	30	struct vhost_task *vtsk;
228a27cf MC	31	/* Used to serialize device wide flushing with worker swapping. */
228a27cf MC	32	struct mutex mutex;
1a5f8090	33	struct llist_head work_list;
1a5f8090	34	u64 kcov_handle;
1cdaafa1	35	u32 id;
c1ecd8e9	36	int attachment_cnt;
1a5f8090 MC	37	};
1a5f8090 MC	38
3a4d5c94 MT	39	/* Poll a file (eventfd or socket) */
	40	/* Note: there's nothing vhost specific about this structure. */
	41	struct vhost_poll {
efb18e1e MC	42	poll_table table;
	43	wait_queue_head_t *wqh;
	44	wait_queue_entry_t wait;
	45	struct vhost_work work;
	46	__poll_t mask;
	47	struct vhost_dev *dev;
493b94bf	48	struct vhost_virtqueue *vq;
3a4d5c94 MT	49	};
3a4d5c94 MT	50
c23f3445	51	void vhost_poll_init(struct vhost_poll *poll, vhost_work_fn_t fn,
493b94bf MC	52	__poll_t mask, struct vhost_dev *dev,
493b94bf MC	53	struct vhost_virtqueue *vq);
2b8b328b	54	int vhost_poll_start(struct vhost_poll poll, struct file file);
3a4d5c94	55	void vhost_poll_stop(struct vhost_poll *poll);
3a4d5c94	56	void vhost_poll_queue(struct vhost_poll *poll);
27eca189 MC	57
27eca189 MC	58	void vhost_work_init(struct vhost_work *work, vhost_work_fn_t fn);
b2ffa407	59	void vhost_dev_flush(struct vhost_dev *dev);
3a4d5c94 MT	60
	61	struct vhost_log {
	62	u64 addr;
	63	u64 len;
	64	};
	65
f8894913 JW	66	enum vhost_uaddr_type {
	67	VHOST_ADDR_DESC = 0,
	68	VHOST_ADDR_AVAIL = 1,
	69	VHOST_ADDR_USED = 2,
	70	VHOST_NUM_ADDRS = 3,
	71	};
	72
265a0ad8 ZL	73	struct vhost_vring_call {
	74	struct eventfd_ctx *ctx;
	75	struct irq_bypass_producer producer;
265a0ad8 ZL	76	};
265a0ad8 ZL	77
3a4d5c94 MT	78	/* The virtqueue structure describes a queue attached to a device. */
	79	struct vhost_virtqueue {
	80	struct vhost_dev *dev;
228a27cf	81	struct vhost_worker __rcu *worker;
3a4d5c94 MT	82
	83	/* The actual ring of buffers. */
	84	struct mutex mutex;
	85	unsigned int num;
a865e420 MT	86	vring_desc_t __user *desc;
	87	vring_avail_t __user *avail;
	88	vring_used_t __user *used;
0bbe3066	89	const struct vhost_iotlb_map *meta_iotlb[VHOST_NUM_ADDRS];
3a4d5c94	90	struct file *kick;
265a0ad8	91	struct vhost_vring_call call_ctx;
3a4d5c94 MT	92	struct eventfd_ctx *error_ctx;
	93	struct eventfd_ctx *log_ctx;
	94
	95	struct vhost_poll poll;
	96
	97	/* The routine to call when the Guest pings us, or timeout. */
c23f3445	98	vhost_work_fn_t handle_kick;
3a4d5c94	99
55d8122f SN	100	/* Last available index we saw.
	101	* Values are limited to 0x7fff, and the high bit is used as
	102	* a wrap counter when using VIRTIO_F_RING_PACKED. */
3a4d5c94 MT	103	u16 last_avail_idx;
	104
	105	/* Caches available index value from user. */
	106	u16 avail_idx;
	107
55d8122f SN	108	/* Last index we used.
	109	* Values are limited to 0x7fff, and the high bit is used as
	110	* a wrap counter when using VIRTIO_F_RING_PACKED. */
3a4d5c94 MT	111	u16 last_used_idx;
	112
	113	/* Used flags */
	114	u16 used_flags;
	115
8ea8cf89 MT	116	/* Last used index value we have signalled on */
	117	u16 signalled_used;
	118
	119	/* Last used index value we have signalled on */
	120	bool signalled_used_valid;
	121
3a4d5c94 MT	122	/* Log writes to used structure. */
	123	bool log_used;
	124	u64 log_addr;
	125
e0e9b406	126	struct iovec iov[UIO_MAXIOV];
6b1e6cc7	127	struct iovec iotlb_iov[64];
e0e9b406	128	struct iovec *indirect;
e0e9b406	129	struct vring_used_elem *heads;
22fa90c7	130	/* Protected by virtqueue mutex. */
0bbe3066 JW	131	struct vhost_iotlb *umem;
0bbe3066 JW	132	struct vhost_iotlb *iotlb;
22fa90c7	133	void *private_data;
bd82752a	134	u64 acked_features;
429711ae	135	u64 acked_backend_features;
3a4d5c94 MT	136	/* Log write descriptors */
3a4d5c94 MT	137	void __user *log_base;
e0e9b406	138	struct vhost_log *log;
5e5e8736	139	struct iovec log_iov[64];
2751c988 GK	140
	141	/* Ring endianness. Defaults to legacy native endianness.
	142	* Set to true when starting a modern virtio device. */
	143	bool is_le;
	144	#ifdef CONFIG_VHOST_CROSS_ENDIAN_LEGACY
	145	/* Ring endianness requested by userspace for cross-endian support. */
	146	bool user_be;
	147	#endif
03088137	148	u32 busyloop_timeout;
3a4d5c94 MT	149	};
3a4d5c94 MT	150
6b1e6cc7	151	struct vhost_msg_node {
429711ae JW	152	union {
	153	struct vhost_msg msg;
	154	struct vhost_msg_v2 msg_v2;
	155	};
6b1e6cc7 JW	156	struct vhost_virtqueue *vq;
	157	struct list_head node;
	158	};
	159
3a4d5c94	160	struct vhost_dev {
3a4d5c94 MT	161	struct mm_struct *mm;
3a4d5c94 MT	162	struct mutex mutex;
3ab2e420	163	struct vhost_virtqueue **vqs;
3a4d5c94	164	int nvqs;
3a4d5c94	165	struct eventfd_ctx *log_ctx;
0bbe3066 JW	166	struct vhost_iotlb *umem;
0bbe3066 JW	167	struct vhost_iotlb *iotlb;
6b1e6cc7 JW	168	spinlock_t iotlb_lock;
	169	struct list_head read_list;
	170	struct list_head pending_list;
	171	wait_queue_head_t wait;
b46a0bf7	172	int iov_limit;
e82b9b07 JW	173	int weight;
e82b9b07 JW	174	int byte_weight;
1cdaafa1	175	struct xarray worker_xa;
01fcb1cb	176	bool use_worker;
91233ad7	177	int (msg_handler)(struct vhost_dev dev, u32 asid,
792a4f2e	178	struct vhost_iotlb_msg *msg);
3a4d5c94 MT	179	};
3a4d5c94 MT	180
e82b9b07	181	bool vhost_exceeds_weight(struct vhost_virtqueue *vq, int pkts, int total_len);
b46a0bf7	182	void vhost_dev_init(struct vhost_dev , struct vhost_virtqueue *vqs,
792a4f2e	183	int nvqs, int iov_limit, int weight, int byte_weight,
01fcb1cb	184	bool use_worker,
91233ad7	185	int (msg_handler)(struct vhost_dev dev, u32 asid,
792a4f2e	186	struct vhost_iotlb_msg *msg));
54db63c2	187	long vhost_dev_set_owner(struct vhost_dev *dev);
05c05351	188	bool vhost_dev_has_owner(struct vhost_dev *dev);
3a4d5c94	189	long vhost_dev_check_owner(struct vhost_dev *);
0bbe3066 JW	190	struct vhost_iotlb *vhost_dev_reset_owner_prepare(void);
0bbe3066 JW	191	void vhost_dev_reset_owner(struct vhost_dev dev, struct vhost_iotlb iotlb);
f6f93f75	192	void vhost_dev_cleanup(struct vhost_dev *);
b211616d	193	void vhost_dev_stop(struct vhost_dev *);
935cdee7	194	long vhost_dev_ioctl(struct vhost_dev , unsigned int ioctl, void __user argp);
26b36604	195	long vhost_vring_ioctl(struct vhost_dev d, unsigned int ioctl, void __user argp);
c1ecd8e9 MC	196	long vhost_worker_ioctl(struct vhost_dev *dev, unsigned int ioctl,
c1ecd8e9 MC	197	void __user *argp);
ddd3d408 SH	198	bool vhost_vq_access_ok(struct vhost_virtqueue *vq);
ddd3d408 SH	199	bool vhost_log_access_ok(struct vhost_dev *);
9526f9a2	200	void vhost_clear_msg(struct vhost_dev *dev);
3a4d5c94	201
47283bef	202	int vhost_get_vq_desc(struct vhost_virtqueue *,
9e396a2f	203	struct iovec iov[], unsigned int iov_size,
d5675bd2 MT	204	unsigned int out_num, unsigned int in_num,
d5675bd2 MT	205	struct vhost_log log, unsigned int log_num);
8dd014ad	206	void vhost_discard_vq_desc(struct vhost_virtqueue *, int n);
3a4d5c94	207
a6fc0473	208	void vhost_vq_flush(struct vhost_virtqueue *vq);
0921dddc	209	bool vhost_vq_work_queue(struct vhost_virtqueue vq, struct vhost_work work);
9784df15	210	bool vhost_vq_has_work(struct vhost_virtqueue *vq);
6bcf3422	211	bool vhost_vq_is_setup(struct vhost_virtqueue *vq);
80f7d030	212	int vhost_vq_init_access(struct vhost_virtqueue *);
3a4d5c94	213	int vhost_add_used(struct vhost_virtqueue *, unsigned int head, int len);
8dd014ad DS	214	int vhost_add_used_n(struct vhost_virtqueue , struct vring_used_elem heads,
8dd014ad DS	215	unsigned count);
3a4d5c94	216	void vhost_add_used_and_signal(struct vhost_dev , struct vhost_virtqueue ,
8dd014ad DS	217	unsigned int id, int len);
	218	void vhost_add_used_and_signal_n(struct vhost_dev , struct vhost_virtqueue ,
	219	struct vring_used_elem *heads, unsigned count);
	220	void vhost_signal(struct vhost_dev , struct vhost_virtqueue );
8ea8cf89	221	void vhost_disable_notify(struct vhost_dev , struct vhost_virtqueue );
d4a60603	222	bool vhost_vq_avail_empty(struct vhost_dev , struct vhost_virtqueue );
8ea8cf89	223	bool vhost_enable_notify(struct vhost_dev , struct vhost_virtqueue );
3a4d5c94 MT	224
3a4d5c94 MT	225	int vhost_log_write(struct vhost_virtqueue vq, struct vhost_log log,
cc5e7107 JW	226	unsigned int log_num, u64 len,
cc5e7107 JW	227	struct iovec *iov, int count);
9b5e830b	228	int vq_meta_prefetch(struct vhost_virtqueue *vq);
6b1e6cc7 JW	229
	230	struct vhost_msg_node vhost_new_msg(struct vhost_virtqueue vq, int type);
	231	void vhost_enqueue_msg(struct vhost_dev *dev,
	232	struct list_head *head,
	233	struct vhost_msg_node *node);
	234	struct vhost_msg_node vhost_dequeue_msg(struct vhost_dev dev,
	235	struct list_head *head);
460f7ce1 JW	236	void vhost_set_backend_features(struct vhost_dev *dev, u64 features);
460f7ce1 JW	237
afc9a42b	238	__poll_t vhost_chr_poll(struct file file, struct vhost_dev dev,
6b1e6cc7 JW	239	poll_table *wait);
	240	ssize_t vhost_chr_read_iter(struct vhost_dev dev, struct iov_iter to,
	241	int noblock);
	242	ssize_t vhost_chr_write_iter(struct vhost_dev *dev,
	243	struct iov_iter *from);
759aba1e	244	int vhost_init_device_iotlb(struct vhost_dev *d);
3a4d5c94	245
0bbe3066 JW	246	void vhost_iotlb_map_free(struct vhost_iotlb *iotlb,
	247	struct vhost_iotlb_map *map);
	248
3a4d5c94 MT	249	#define vq_err(vq, fmt, ...) do { \
	250	pr_debug(pr_fmt(fmt), ##__VA_ARGS__); \
	251	if ((vq)->error_ctx) \
3652117f	252	eventfd_signal((vq)->error_ctx);\
3a4d5c94 MT	253	} while (0)
	254
	255	enum {
8ea8cf89 MT	256	VHOST_FEATURES = (1ULL << VIRTIO_F_NOTIFY_ON_EMPTY) \|
	257	(1ULL << VIRTIO_RING_F_INDIRECT_DESC) \|
	258	(1ULL << VIRTIO_RING_F_EVENT_IDX) \|
4e9fa50c MT	259	(1ULL << VHOST_F_LOG_ALL) \|
	260	(1ULL << VIRTIO_F_ANY_LAYOUT) \|
	261	(1ULL << VIRTIO_F_VERSION_1)
3a4d5c94 MT	262	};
3a4d5c94 MT	263
247643f8 EP	264	/**
	265	* vhost_vq_set_backend - Set backend.
	266	*
	267	* @vq Virtqueue.
	268	* @private_data The private data.
	269	*
	270	* Context: Need to call with vq->mutex acquired.
	271	*/
	272	static inline void vhost_vq_set_backend(struct vhost_virtqueue *vq,
	273	void *private_data)
	274	{
	275	vq->private_data = private_data;
	276	}
	277
	278	/**
	279	* vhost_vq_get_backend - Get backend.
	280	*
	281	* @vq Virtqueue.
	282	*
	283	* Context: Need to call with vq->mutex acquired.
	284	* Return: Private data previously set with vhost_vq_set_backend.
	285	*/
	286	static inline void vhost_vq_get_backend(struct vhost_virtqueue vq)
	287	{
	288	return vq->private_data;
	289	}
	290
bd82752a	291	static inline bool vhost_has_feature(struct vhost_virtqueue *vq, int bit)
3a4d5c94	292	{
bd82752a	293	return vq->acked_features & (1ULL << bit);
3a4d5c94	294	}
e05fd12b	295
429711ae JW	296	static inline bool vhost_backend_has_feature(struct vhost_virtqueue *vq, int bit)
	297	{
	298	return vq->acked_backend_features & (1ULL << bit);
	299	}
	300
e407f39a	301	#ifdef CONFIG_VHOST_CROSS_ENDIAN_LEGACY
ab27c07f GK	302	static inline bool vhost_is_little_endian(struct vhost_virtqueue *vq)
ab27c07f GK	303	{
2751c988	304	return vq->is_le;
ab27c07f	305	}
e407f39a MT	306	#else
	307	static inline bool vhost_is_little_endian(struct vhost_virtqueue *vq)
	308	{
	309	return virtio_legacy_is_little_endian() \|\| vq->is_le;
	310	}
	311	#endif
ab27c07f	312
e05fd12b MT	313	/* Memory accessors */
	314	static inline u16 vhost16_to_cpu(struct vhost_virtqueue *vq, __virtio16 val)
	315	{
ab27c07f	316	return __virtio16_to_cpu(vhost_is_little_endian(vq), val);
e05fd12b MT	317	}
	318
	319	static inline __virtio16 cpu_to_vhost16(struct vhost_virtqueue *vq, u16 val)
	320	{
ab27c07f	321	return __cpu_to_virtio16(vhost_is_little_endian(vq), val);
e05fd12b MT	322	}
	323
	324	static inline u32 vhost32_to_cpu(struct vhost_virtqueue *vq, __virtio32 val)
	325	{
ab27c07f	326	return __virtio32_to_cpu(vhost_is_little_endian(vq), val);
e05fd12b MT	327	}
	328
	329	static inline __virtio32 cpu_to_vhost32(struct vhost_virtqueue *vq, u32 val)
	330	{
ab27c07f	331	return __cpu_to_virtio32(vhost_is_little_endian(vq), val);
e05fd12b MT	332	}
	333
	334	static inline u64 vhost64_to_cpu(struct vhost_virtqueue *vq, __virtio64 val)
	335	{
ab27c07f	336	return __virtio64_to_cpu(vhost_is_little_endian(vq), val);
e05fd12b MT	337	}
	338
	339	static inline __virtio64 cpu_to_vhost64(struct vhost_virtqueue *vq, u64 val)
	340	{
ab27c07f	341	return __cpu_to_virtio64(vhost_is_little_endian(vq), val);
e05fd12b	342	}
3a4d5c94	343	#endif