vhost.c 57.3 KB
Newer Older
1 2 3 4 5 6
/* Copyright (C) 2009 Red Hat, Inc.
 * Copyright (C) 2006 Rusty Russell IBM Corporation
 *
 * Author: Michael S. Tsirkin <mst@redhat.com>
 *
 * Inspiration, some code, and most witty comments come from
R
Rob Landley 已提交
7
 * Documentation/virtual/lguest/lguest.c, by Rusty Russell
8 9 10 11 12 13 14 15
 *
 * This work is licensed under the terms of the GNU GPL, version 2.
 *
 * Generic code for virtio server in host kernel.
 */

#include <linux/eventfd.h>
#include <linux/vhost.h>
16
#include <linux/uio.h>
17
#include <linux/mm.h>
M
Michael S. Tsirkin 已提交
18
#include <linux/mmu_context.h>
19 20 21 22 23
#include <linux/miscdevice.h>
#include <linux/mutex.h>
#include <linux/poll.h>
#include <linux/file.h>
#include <linux/highmem.h>
24
#include <linux/slab.h>
25
#include <linux/vmalloc.h>
26
#include <linux/kthread.h>
27
#include <linux/cgroup.h>
A
Asias He 已提交
28
#include <linux/module.h>
29
#include <linux/sort.h>
30
#include <linux/sched/mm.h>
31
#include <linux/interval_tree_generic.h>
32 33 34

#include "vhost.h"

35 36 37 38
static ushort max_mem_regions = 64;
module_param(max_mem_regions, ushort, 0444);
MODULE_PARM_DESC(max_mem_regions,
	"Maximum number of memory regions in memory map. (default: 64)");
J
Jason Wang 已提交
39 40 41 42
static int max_iotlb_entries = 2048;
module_param(max_iotlb_entries, int, 0444);
MODULE_PARM_DESC(max_iotlb_entries,
	"Maximum number of iotlb entries. (default: 2048)");
43

44 45 46 47
enum {
	VHOST_MEMORY_F_LOG = 0x1,
};

48 49
#define vhost_used_event(vq) ((__virtio16 __user *)&vq->avail->ring[vq->num])
#define vhost_avail_event(vq) ((__virtio16 __user *)&vq->used->ring[vq->num])
M
Michael S. Tsirkin 已提交
50

51 52
INTERVAL_TREE_DEFINE(struct vhost_umem_node,
		     rb, __u64, __subtree_last,
53
		     START, LAST, static inline, vhost_umem_interval_tree);
54

55
#ifdef CONFIG_VHOST_CROSS_ENDIAN_LEGACY
G
Greg Kurz 已提交
56
static void vhost_disable_cross_endian(struct vhost_virtqueue *vq)
57 58 59 60
{
	vq->user_be = !virtio_legacy_is_little_endian();
}

G
Greg Kurz 已提交
61 62 63 64 65 66 67 68 69 70
static void vhost_enable_cross_endian_big(struct vhost_virtqueue *vq)
{
	vq->user_be = true;
}

static void vhost_enable_cross_endian_little(struct vhost_virtqueue *vq)
{
	vq->user_be = false;
}

71 72 73 74 75 76 77 78 79 80 81 82 83 84
static long vhost_set_vring_endian(struct vhost_virtqueue *vq, int __user *argp)
{
	struct vhost_vring_state s;

	if (vq->private_data)
		return -EBUSY;

	if (copy_from_user(&s, argp, sizeof(s)))
		return -EFAULT;

	if (s.num != VHOST_VRING_LITTLE_ENDIAN &&
	    s.num != VHOST_VRING_BIG_ENDIAN)
		return -EINVAL;

G
Greg Kurz 已提交
85 86 87 88
	if (s.num == VHOST_VRING_BIG_ENDIAN)
		vhost_enable_cross_endian_big(vq);
	else
		vhost_enable_cross_endian_little(vq);
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116

	return 0;
}

static long vhost_get_vring_endian(struct vhost_virtqueue *vq, u32 idx,
				   int __user *argp)
{
	struct vhost_vring_state s = {
		.index = idx,
		.num = vq->user_be
	};

	if (copy_to_user(argp, &s, sizeof(s)))
		return -EFAULT;

	return 0;
}

static void vhost_init_is_le(struct vhost_virtqueue *vq)
{
	/* Note for legacy virtio: user_be is initialized at reset time
	 * according to the host endianness. If userspace does not set an
	 * explicit endianness, the default behavior is native endian, as
	 * expected by legacy virtio.
	 */
	vq->is_le = vhost_has_feature(vq, VIRTIO_F_VERSION_1) || !vq->user_be;
}
#else
G
Greg Kurz 已提交
117
static void vhost_disable_cross_endian(struct vhost_virtqueue *vq)
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
{
}

static long vhost_set_vring_endian(struct vhost_virtqueue *vq, int __user *argp)
{
	return -ENOIOCTLCMD;
}

static long vhost_get_vring_endian(struct vhost_virtqueue *vq, u32 idx,
				   int __user *argp)
{
	return -ENOIOCTLCMD;
}

static void vhost_init_is_le(struct vhost_virtqueue *vq)
{
134 135
	vq->is_le = vhost_has_feature(vq, VIRTIO_F_VERSION_1)
		|| virtio_legacy_is_little_endian();
136 137 138
}
#endif /* CONFIG_VHOST_CROSS_ENDIAN_LEGACY */

G
Greg Kurz 已提交
139 140
static void vhost_reset_is_le(struct vhost_virtqueue *vq)
{
141
	vhost_init_is_le(vq);
G
Greg Kurz 已提交
142 143
}

J
Jason Wang 已提交
144 145 146 147 148 149 150 151 152 153 154 155 156
struct vhost_flush_struct {
	struct vhost_work work;
	struct completion wait_event;
};

static void vhost_flush_work(struct vhost_work *work)
{
	struct vhost_flush_struct *s;

	s = container_of(work, struct vhost_flush_struct, work);
	complete(&s->wait_event);
}

157 158 159 160 161
static void vhost_poll_func(struct file *file, wait_queue_head_t *wqh,
			    poll_table *pt)
{
	struct vhost_poll *poll;

K
Krishna Kumar 已提交
162
	poll = container_of(pt, struct vhost_poll, table);
163 164 165 166 167 168 169
	poll->wqh = wqh;
	add_wait_queue(wqh, &poll->wait);
}

static int vhost_poll_wakeup(wait_queue_t *wait, unsigned mode, int sync,
			     void *key)
{
170 171
	struct vhost_poll *poll = container_of(wait, struct vhost_poll, wait);

172 173 174
	if (!((unsigned long)key & poll->mask))
		return 0;

175
	vhost_poll_queue(poll);
176 177 178
	return 0;
}

179
void vhost_work_init(struct vhost_work *work, vhost_work_fn_t fn)
180
{
J
Jason Wang 已提交
181
	clear_bit(VHOST_WORK_QUEUED, &work->flags);
182 183 184
	work->fn = fn;
	init_waitqueue_head(&work->done);
}
A
Asias He 已提交
185
EXPORT_SYMBOL_GPL(vhost_work_init);
186

187
/* Init poll structure */
188 189
void vhost_poll_init(struct vhost_poll *poll, vhost_work_fn_t fn,
		     unsigned long mask, struct vhost_dev *dev)
190 191 192 193
{
	init_waitqueue_func_entry(&poll->wait, vhost_poll_wakeup);
	init_poll_funcptr(&poll->table, vhost_poll_func);
	poll->mask = mask;
194
	poll->dev = dev;
195
	poll->wqh = NULL;
196

197
	vhost_work_init(&poll->work, fn);
198
}
A
Asias He 已提交
199
EXPORT_SYMBOL_GPL(vhost_poll_init);
200 201 202

/* Start polling a file. We add ourselves to file's wait queue. The caller must
 * keep a reference to a file until after vhost_poll_stop is called. */
203
int vhost_poll_start(struct vhost_poll *poll, struct file *file)
204 205
{
	unsigned long mask;
206
	int ret = 0;
K
Krishna Kumar 已提交
207

J
Jason Wang 已提交
208 209 210
	if (poll->wqh)
		return 0;

211 212 213
	mask = file->f_op->poll(file, &poll->table);
	if (mask)
		vhost_poll_wakeup(&poll->wait, 0, 0, (void *)mask);
214 215 216 217 218 219 220
	if (mask & POLLERR) {
		if (poll->wqh)
			remove_wait_queue(poll->wqh, &poll->wait);
		ret = -EINVAL;
	}

	return ret;
221
}
A
Asias He 已提交
222
EXPORT_SYMBOL_GPL(vhost_poll_start);
223 224 225 226 227

/* Stop polling a file. After this function returns, it becomes safe to drop the
 * file reference. You must also flush afterwards. */
void vhost_poll_stop(struct vhost_poll *poll)
{
228 229 230 231
	if (poll->wqh) {
		remove_wait_queue(poll->wqh, &poll->wait);
		poll->wqh = NULL;
	}
232
}
A
Asias He 已提交
233
EXPORT_SYMBOL_GPL(vhost_poll_stop);
234

J
Jason Wang 已提交
235
void vhost_work_flush(struct vhost_dev *dev, struct vhost_work *work)
236
{
J
Jason Wang 已提交
237
	struct vhost_flush_struct flush;
K
Krishna Kumar 已提交
238

J
Jason Wang 已提交
239 240 241
	if (dev->worker) {
		init_completion(&flush.wait_event);
		vhost_work_init(&flush.work, vhost_flush_work);
242

J
Jason Wang 已提交
243 244 245
		vhost_work_queue(dev, &flush.work);
		wait_for_completion(&flush.wait_event);
	}
246
}
A
Asias He 已提交
247
EXPORT_SYMBOL_GPL(vhost_work_flush);
248

249 250 251 252 253 254
/* Flush any work that has been scheduled. When calling this, don't hold any
 * locks that are also used by the callback. */
void vhost_poll_flush(struct vhost_poll *poll)
{
	vhost_work_flush(poll->dev, &poll->work);
}
A
Asias He 已提交
255
EXPORT_SYMBOL_GPL(vhost_poll_flush);
256

257
void vhost_work_queue(struct vhost_dev *dev, struct vhost_work *work)
258
{
J
Jason Wang 已提交
259 260
	if (!dev->worker)
		return;
261

J
Jason Wang 已提交
262 263 264
	if (!test_and_set_bit(VHOST_WORK_QUEUED, &work->flags)) {
		/* We can only add the work to the list after we're
		 * sure it was not in the list.
265
		 * test_and_set_bit() implies a memory barrier.
J
Jason Wang 已提交
266 267
		 */
		llist_add(&work->node, &dev->work_list);
268 269
		wake_up_process(dev->worker);
	}
270
}
A
Asias He 已提交
271
EXPORT_SYMBOL_GPL(vhost_work_queue);
272

J
Jason Wang 已提交
273 274 275
/* A lockless hint for busy polling code to exit the loop */
bool vhost_has_work(struct vhost_dev *dev)
{
J
Jason Wang 已提交
276
	return !llist_empty(&dev->work_list);
J
Jason Wang 已提交
277 278 279
}
EXPORT_SYMBOL_GPL(vhost_has_work);

280 281 282 283
void vhost_poll_queue(struct vhost_poll *poll)
{
	vhost_work_queue(poll->dev, &poll->work);
}
A
Asias He 已提交
284
EXPORT_SYMBOL_GPL(vhost_poll_queue);
285

286 287 288 289 290 291 292 293
static void vhost_vq_reset(struct vhost_dev *dev,
			   struct vhost_virtqueue *vq)
{
	vq->num = 1;
	vq->desc = NULL;
	vq->avail = NULL;
	vq->used = NULL;
	vq->last_avail_idx = 0;
294
	vq->last_used_event = 0;
295 296
	vq->avail_idx = 0;
	vq->last_used_idx = 0;
M
Michael S. Tsirkin 已提交
297 298
	vq->signalled_used = 0;
	vq->signalled_used_valid = false;
299 300 301 302
	vq->used_flags = 0;
	vq->log_used = false;
	vq->log_addr = -1ull;
	vq->private_data = NULL;
303
	vq->acked_features = 0;
304 305 306 307 308 309
	vq->log_base = NULL;
	vq->error_ctx = NULL;
	vq->error = NULL;
	vq->kick = NULL;
	vq->call_ctx = NULL;
	vq->call = NULL;
310
	vq->log_ctx = NULL;
G
Greg Kurz 已提交
311 312
	vhost_reset_is_le(vq);
	vhost_disable_cross_endian(vq);
J
Jason Wang 已提交
313
	vq->busyloop_timeout = 0;
314
	vq->umem = NULL;
J
Jason Wang 已提交
315
	vq->iotlb = NULL;
316 317
}

318 319 320
static int vhost_worker(void *data)
{
	struct vhost_dev *dev = data;
J
Jason Wang 已提交
321 322
	struct vhost_work *work, *work_next;
	struct llist_node *node;
323
	mm_segment_t oldfs = get_fs();
324

325
	set_fs(USER_DS);
M
Michael S. Tsirkin 已提交
326 327
	use_mm(dev->mm);

328 329 330 331 332 333
	for (;;) {
		/* mb paired w/ kthread_stop */
		set_current_state(TASK_INTERRUPTIBLE);

		if (kthread_should_stop()) {
			__set_current_state(TASK_RUNNING);
M
Michael S. Tsirkin 已提交
334
			break;
335
		}
J
Jason Wang 已提交
336 337 338 339 340 341 342 343 344 345

		node = llist_del_all(&dev->work_list);
		if (!node)
			schedule();

		node = llist_reverse_order(node);
		/* make sure flag is seen after deletion */
		smp_wmb();
		llist_for_each_entry_safe(work, work_next, node, node) {
			clear_bit(VHOST_WORK_QUEUED, &work->flags);
346 347
			__set_current_state(TASK_RUNNING);
			work->fn(work);
N
Nadav Har'El 已提交
348 349
			if (need_resched())
				schedule();
J
Jason Wang 已提交
350
		}
351
	}
M
Michael S. Tsirkin 已提交
352
	unuse_mm(dev->mm);
353
	set_fs(oldfs);
M
Michael S. Tsirkin 已提交
354
	return 0;
355 356
}

357 358 359 360 361 362 363 364 365 366
static void vhost_vq_free_iovecs(struct vhost_virtqueue *vq)
{
	kfree(vq->indirect);
	vq->indirect = NULL;
	kfree(vq->log);
	vq->log = NULL;
	kfree(vq->heads);
	vq->heads = NULL;
}

J
Jason Wang 已提交
367 368 369
/* Helper to allocate iovec buffers for all vqs. */
static long vhost_dev_alloc_iovecs(struct vhost_dev *dev)
{
A
Asias He 已提交
370
	struct vhost_virtqueue *vq;
J
Jason Wang 已提交
371
	int i;
K
Krishna Kumar 已提交
372

J
Jason Wang 已提交
373
	for (i = 0; i < dev->nvqs; ++i) {
A
Asias He 已提交
374 375 376 377 378 379
		vq = dev->vqs[i];
		vq->indirect = kmalloc(sizeof *vq->indirect * UIO_MAXIOV,
				       GFP_KERNEL);
		vq->log = kmalloc(sizeof *vq->log * UIO_MAXIOV, GFP_KERNEL);
		vq->heads = kmalloc(sizeof *vq->heads * UIO_MAXIOV, GFP_KERNEL);
		if (!vq->indirect || !vq->log || !vq->heads)
J
Jason Wang 已提交
380 381 382
			goto err_nomem;
	}
	return 0;
K
Krishna Kumar 已提交
383

J
Jason Wang 已提交
384
err_nomem:
385
	for (; i >= 0; --i)
386
		vhost_vq_free_iovecs(dev->vqs[i]);
J
Jason Wang 已提交
387 388 389 390 391 392
	return -ENOMEM;
}

static void vhost_dev_free_iovecs(struct vhost_dev *dev)
{
	int i;
K
Krishna Kumar 已提交
393

394
	for (i = 0; i < dev->nvqs; ++i)
395
		vhost_vq_free_iovecs(dev->vqs[i]);
J
Jason Wang 已提交
396 397
}

Z
Zhi Yong Wu 已提交
398
void vhost_dev_init(struct vhost_dev *dev,
399
		    struct vhost_virtqueue **vqs, int nvqs)
400
{
A
Asias He 已提交
401
	struct vhost_virtqueue *vq;
402
	int i;
403

404 405 406 407 408
	dev->vqs = vqs;
	dev->nvqs = nvqs;
	mutex_init(&dev->mutex);
	dev->log_ctx = NULL;
	dev->log_file = NULL;
409
	dev->umem = NULL;
J
Jason Wang 已提交
410
	dev->iotlb = NULL;
411
	dev->mm = NULL;
412
	dev->worker = NULL;
J
Jason Wang 已提交
413
	init_llist_head(&dev->work_list);
J
Jason Wang 已提交
414 415 416 417
	init_waitqueue_head(&dev->wait);
	INIT_LIST_HEAD(&dev->read_list);
	INIT_LIST_HEAD(&dev->pending_list);
	spin_lock_init(&dev->iotlb_lock);
J
Jason Wang 已提交
418

419 420

	for (i = 0; i < dev->nvqs; ++i) {
A
Asias He 已提交
421 422 423 424 425 426 427 428 429 430
		vq = dev->vqs[i];
		vq->log = NULL;
		vq->indirect = NULL;
		vq->heads = NULL;
		vq->dev = dev;
		mutex_init(&vq->mutex);
		vhost_vq_reset(dev, vq);
		if (vq->handle_kick)
			vhost_poll_init(&vq->poll, vq->handle_kick,
					POLLIN, dev);
431 432
	}
}
A
Asias He 已提交
433
EXPORT_SYMBOL_GPL(vhost_dev_init);
434 435 436 437 438 439 440

/* Caller should have device mutex */
long vhost_dev_check_owner(struct vhost_dev *dev)
{
	/* Are you the owner? If not, I don't think you mean to do that */
	return dev->mm == current->mm ? 0 : -EPERM;
}
A
Asias He 已提交
441
EXPORT_SYMBOL_GPL(vhost_dev_check_owner);
442

443
struct vhost_attach_cgroups_struct {
K
Krishna Kumar 已提交
444 445 446
	struct vhost_work work;
	struct task_struct *owner;
	int ret;
447 448 449 450
};

static void vhost_attach_cgroups_work(struct vhost_work *work)
{
K
Krishna Kumar 已提交
451 452 453 454
	struct vhost_attach_cgroups_struct *s;

	s = container_of(work, struct vhost_attach_cgroups_struct, work);
	s->ret = cgroup_attach_task_all(s->owner, current);
455 456 457 458
}

static int vhost_attach_cgroups(struct vhost_dev *dev)
{
K
Krishna Kumar 已提交
459 460 461 462 463 464 465
	struct vhost_attach_cgroups_struct attach;

	attach.owner = current;
	vhost_work_init(&attach.work, vhost_attach_cgroups_work);
	vhost_work_queue(dev, &attach.work);
	vhost_work_flush(dev, &attach.work);
	return attach.ret;
466 467
}

468 469 470 471 472
/* Caller should have device mutex */
bool vhost_dev_has_owner(struct vhost_dev *dev)
{
	return dev->mm;
}
A
Asias He 已提交
473
EXPORT_SYMBOL_GPL(vhost_dev_has_owner);
474

475
/* Caller should have device mutex */
A
Asias He 已提交
476
long vhost_dev_set_owner(struct vhost_dev *dev)
477
{
478 479
	struct task_struct *worker;
	int err;
K
Krishna Kumar 已提交
480

481
	/* Is there an owner already? */
482
	if (vhost_dev_has_owner(dev)) {
483 484 485
		err = -EBUSY;
		goto err_mm;
	}
K
Krishna Kumar 已提交
486

487 488
	/* No owner, become one */
	dev->mm = get_task_mm(current);
489 490 491 492 493 494 495
	worker = kthread_create(vhost_worker, dev, "vhost-%d", current->pid);
	if (IS_ERR(worker)) {
		err = PTR_ERR(worker);
		goto err_worker;
	}

	dev->worker = worker;
496 497 498
	wake_up_process(worker);	/* avoid contributing to loadavg */

	err = vhost_attach_cgroups(dev);
499 500
	if (err)
		goto err_cgroup;
501

J
Jason Wang 已提交
502 503 504 505
	err = vhost_dev_alloc_iovecs(dev);
	if (err)
		goto err_cgroup;

506
	return 0;
507 508
err_cgroup:
	kthread_stop(worker);
M
Michael S. Tsirkin 已提交
509
	dev->worker = NULL;
510 511 512 513 514 515
err_worker:
	if (dev->mm)
		mmput(dev->mm);
	dev->mm = NULL;
err_mm:
	return err;
516
}
A
Asias He 已提交
517
EXPORT_SYMBOL_GPL(vhost_dev_set_owner);
518

519
static void *vhost_kvzalloc(unsigned long size)
520
{
521 522 523 524 525 526 527 528 529 530
	void *n = kzalloc(size, GFP_KERNEL | __GFP_NOWARN | __GFP_REPEAT);

	if (!n)
		n = vzalloc(size);
	return n;
}

struct vhost_umem *vhost_dev_reset_owner_prepare(void)
{
	return vhost_kvzalloc(sizeof(struct vhost_umem));
531
}
A
Asias He 已提交
532
EXPORT_SYMBOL_GPL(vhost_dev_reset_owner_prepare);
533

534
/* Caller should have device mutex */
535
void vhost_dev_reset_owner(struct vhost_dev *dev, struct vhost_umem *umem)
536
{
537 538
	int i;

539
	vhost_dev_cleanup(dev, true);
540

541
	/* Restore memory to default empty mapping. */
542 543
	INIT_LIST_HEAD(&umem->umem_list);
	dev->umem = umem;
544 545 546 547
	/* We don't need VQ locks below since vhost_dev_cleanup makes sure
	 * VQs aren't running.
	 */
	for (i = 0; i < dev->nvqs; ++i)
548
		dev->vqs[i]->umem = umem;
549
}
A
Asias He 已提交
550
EXPORT_SYMBOL_GPL(vhost_dev_reset_owner);
551

552
void vhost_dev_stop(struct vhost_dev *dev)
553 554
{
	int i;
555 556

	for (i = 0; i < dev->nvqs; ++i) {
557 558 559
		if (dev->vqs[i]->kick && dev->vqs[i]->handle_kick) {
			vhost_poll_stop(&dev->vqs[i]->poll);
			vhost_poll_flush(&dev->vqs[i]->poll);
560
		}
561 562
	}
}
A
Asias He 已提交
563
EXPORT_SYMBOL_GPL(vhost_dev_stop);
564

J
Jason Wang 已提交
565 566 567 568 569 570 571 572 573
static void vhost_umem_free(struct vhost_umem *umem,
			    struct vhost_umem_node *node)
{
	vhost_umem_interval_tree_remove(node, &umem->umem_tree);
	list_del(&node->link);
	kfree(node);
	umem->numem--;
}

574 575 576 577 578 579 580
static void vhost_umem_clean(struct vhost_umem *umem)
{
	struct vhost_umem_node *node, *tmp;

	if (!umem)
		return;

J
Jason Wang 已提交
581 582 583
	list_for_each_entry_safe(node, tmp, &umem->umem_list, link)
		vhost_umem_free(umem, node);

584 585 586
	kvfree(umem);
}

J
Jason Wang 已提交
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
static void vhost_clear_msg(struct vhost_dev *dev)
{
	struct vhost_msg_node *node, *n;

	spin_lock(&dev->iotlb_lock);

	list_for_each_entry_safe(node, n, &dev->read_list, node) {
		list_del(&node->node);
		kfree(node);
	}

	list_for_each_entry_safe(node, n, &dev->pending_list, node) {
		list_del(&node->node);
		kfree(node);
	}

	spin_unlock(&dev->iotlb_lock);
}

606 607
/* Caller should have device mutex if and only if locked is set */
void vhost_dev_cleanup(struct vhost_dev *dev, bool locked)
608 609
{
	int i;
K
Krishna Kumar 已提交
610

611
	for (i = 0; i < dev->nvqs; ++i) {
612 613 614 615 616 617 618 619 620 621 622
		if (dev->vqs[i]->error_ctx)
			eventfd_ctx_put(dev->vqs[i]->error_ctx);
		if (dev->vqs[i]->error)
			fput(dev->vqs[i]->error);
		if (dev->vqs[i]->kick)
			fput(dev->vqs[i]->kick);
		if (dev->vqs[i]->call_ctx)
			eventfd_ctx_put(dev->vqs[i]->call_ctx);
		if (dev->vqs[i]->call)
			fput(dev->vqs[i]->call);
		vhost_vq_reset(dev, dev->vqs[i]);
623
	}
J
Jason Wang 已提交
624
	vhost_dev_free_iovecs(dev);
625 626 627 628 629 630 631
	if (dev->log_ctx)
		eventfd_ctx_put(dev->log_ctx);
	dev->log_ctx = NULL;
	if (dev->log_file)
		fput(dev->log_file);
	dev->log_file = NULL;
	/* No one will access memory at this point */
632 633
	vhost_umem_clean(dev->umem);
	dev->umem = NULL;
J
Jason Wang 已提交
634 635 636 637
	vhost_umem_clean(dev->iotlb);
	dev->iotlb = NULL;
	vhost_clear_msg(dev);
	wake_up_interruptible_poll(&dev->wait, POLLIN | POLLRDNORM);
J
Jason Wang 已提交
638
	WARN_ON(!llist_empty(&dev->work_list));
639 640 641 642
	if (dev->worker) {
		kthread_stop(dev->worker);
		dev->worker = NULL;
	}
643 644 645
	if (dev->mm)
		mmput(dev->mm);
	dev->mm = NULL;
646
}
A
Asias He 已提交
647
EXPORT_SYMBOL_GPL(vhost_dev_cleanup);
648 649 650 651

static int log_access_ok(void __user *log_base, u64 addr, unsigned long sz)
{
	u64 a = addr / VHOST_PAGE_SIZE / 8;
K
Krishna Kumar 已提交
652

653 654 655
	/* Make sure 64 bit math will not overflow. */
	if (a > ULONG_MAX - (unsigned long)log_base ||
	    a + (unsigned long)log_base > ULONG_MAX)
656
		return 0;
657 658 659 660 661

	return access_ok(VERIFY_WRITE, log_base + a,
			 (sz + VHOST_PAGE_SIZE * 8 - 1) / VHOST_PAGE_SIZE / 8);
}

662 663 664 665 666 667
static bool vhost_overflow(u64 uaddr, u64 size)
{
	/* Make sure 64 bit math will not overflow. */
	return uaddr > ULONG_MAX || size > ULONG_MAX || uaddr > ULONG_MAX - size;
}

668
/* Caller should have vq mutex and device mutex. */
669
static int vq_memory_access_ok(void __user *log_base, struct vhost_umem *umem,
670 671
			       int log_all)
{
672
	struct vhost_umem_node *node;
673

674
	if (!umem)
M
Michael S. Tsirkin 已提交
675
		return 0;
676

677 678 679
	list_for_each_entry(node, &umem->umem_list, link) {
		unsigned long a = node->userspace_addr;

680
		if (vhost_overflow(node->userspace_addr, node->size))
681
			return 0;
682 683 684


		if (!access_ok(VERIFY_WRITE, (void __user *)a,
685
				    node->size))
686 687
			return 0;
		else if (log_all && !log_access_ok(log_base,
688 689
						   node->start,
						   node->size))
690 691 692 693 694 695 696
			return 0;
	}
	return 1;
}

/* Can we switch to this memory table? */
/* Caller should have device mutex but not vq mutex */
697
static int memory_access_ok(struct vhost_dev *d, struct vhost_umem *umem,
698 699 700
			    int log_all)
{
	int i;
K
Krishna Kumar 已提交
701

702 703
	for (i = 0; i < d->nvqs; ++i) {
		int ok;
704 705
		bool log;

706
		mutex_lock(&d->vqs[i]->mutex);
707
		log = log_all || vhost_has_feature(d->vqs[i], VHOST_F_LOG_ALL);
708
		/* If ring is inactive, will check when it's enabled. */
709
		if (d->vqs[i]->private_data)
710 711
			ok = vq_memory_access_ok(d->vqs[i]->log_base,
						 umem, log);
712 713
		else
			ok = 1;
714
		mutex_unlock(&d->vqs[i]->mutex);
715 716 717 718 719 720
		if (!ok)
			return 0;
	}
	return 1;
}

J
Jason Wang 已提交
721 722
static int translate_desc(struct vhost_virtqueue *vq, u64 addr, u32 len,
			  struct iovec iov[], int iov_size, int access);
723

724
static int vhost_copy_to_user(struct vhost_virtqueue *vq, void __user *to,
725 726
			      const void *from, unsigned size)
{
J
Jason Wang 已提交
727
	int ret;
728

J
Jason Wang 已提交
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
	if (!vq->iotlb)
		return __copy_to_user(to, from, size);
	else {
		/* This function should be called after iotlb
		 * prefetch, which means we're sure that all vq
		 * could be access through iotlb. So -EAGAIN should
		 * not happen in this case.
		 */
		/* TODO: more fast path */
		struct iov_iter t;
		ret = translate_desc(vq, (u64)(uintptr_t)to, size, vq->iotlb_iov,
				     ARRAY_SIZE(vq->iotlb_iov),
				     VHOST_ACCESS_WO);
		if (ret < 0)
			goto out;
		iov_iter_init(&t, WRITE, vq->iotlb_iov, ret, size);
		ret = copy_to_iter(from, size, &t);
		if (ret == size)
			ret = 0;
	}
out:
	return ret;
}
752 753

static int vhost_copy_from_user(struct vhost_virtqueue *vq, void *to,
754
				void __user *from, unsigned size)
755
{
J
Jason Wang 已提交
756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787
	int ret;

	if (!vq->iotlb)
		return __copy_from_user(to, from, size);
	else {
		/* This function should be called after iotlb
		 * prefetch, which means we're sure that vq
		 * could be access through iotlb. So -EAGAIN should
		 * not happen in this case.
		 */
		/* TODO: more fast path */
		struct iov_iter f;
		ret = translate_desc(vq, (u64)(uintptr_t)from, size, vq->iotlb_iov,
				     ARRAY_SIZE(vq->iotlb_iov),
				     VHOST_ACCESS_RO);
		if (ret < 0) {
			vq_err(vq, "IOTLB translation failure: uaddr "
			       "%p size 0x%llx\n", from,
			       (unsigned long long) size);
			goto out;
		}
		iov_iter_init(&f, READ, vq->iotlb_iov, ret, size);
		ret = copy_from_iter(to, size, &f);
		if (ret == size)
			ret = 0;
	}

out:
	return ret;
}

static void __user *__vhost_get_user(struct vhost_virtqueue *vq,
788
				     void __user *addr, unsigned size)
J
Jason Wang 已提交
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
{
	int ret;

	/* This function should be called after iotlb
	 * prefetch, which means we're sure that vq
	 * could be access through iotlb. So -EAGAIN should
	 * not happen in this case.
	 */
	/* TODO: more fast path */
	ret = translate_desc(vq, (u64)(uintptr_t)addr, size, vq->iotlb_iov,
			     ARRAY_SIZE(vq->iotlb_iov),
			     VHOST_ACCESS_RO);
	if (ret < 0) {
		vq_err(vq, "IOTLB translation failure: uaddr "
			"%p size 0x%llx\n", addr,
			(unsigned long long) size);
		return NULL;
	}

	if (ret != 1 || vq->iotlb_iov[0].iov_len != size) {
		vq_err(vq, "Non atomic userspace memory access: uaddr "
			"%p size 0x%llx\n", addr,
			(unsigned long long) size);
		return NULL;
	}

	return vq->iotlb_iov[0].iov_base;
}

#define vhost_put_user(vq, x, ptr) \
({ \
	int ret = -EFAULT; \
	if (!vq->iotlb) { \
		ret = __put_user(x, ptr); \
	} else { \
		__typeof__(ptr) to = \
			(__typeof__(ptr)) __vhost_get_user(vq, ptr, sizeof(*ptr)); \
		if (to != NULL) \
			ret = __put_user(x, to); \
		else \
			ret = -EFAULT;	\
	} \
	ret; \
})

#define vhost_get_user(vq, x, ptr) \
({ \
	int ret; \
	if (!vq->iotlb) { \
		ret = __get_user(x, ptr); \
	} else { \
		__typeof__(ptr) from = \
			(__typeof__(ptr)) __vhost_get_user(vq, ptr, sizeof(*ptr)); \
		if (from != NULL) \
			ret = __get_user(x, from); \
		else \
			ret = -EFAULT; \
	} \
	ret; \
})

static void vhost_dev_lock_vqs(struct vhost_dev *d)
{
	int i = 0;
	for (i = 0; i < d->nvqs; ++i)
		mutex_lock(&d->vqs[i]->mutex);
}

static void vhost_dev_unlock_vqs(struct vhost_dev *d)
{
	int i = 0;
	for (i = 0; i < d->nvqs; ++i)
		mutex_unlock(&d->vqs[i]->mutex);
}

static int vhost_new_umem_range(struct vhost_umem *umem,
				u64 start, u64 size, u64 end,
				u64 userspace_addr, int perm)
{
	struct vhost_umem_node *tmp, *node = kmalloc(sizeof(*node), GFP_ATOMIC);

	if (!node)
		return -ENOMEM;

	if (umem->numem == max_iotlb_entries) {
		tmp = list_first_entry(&umem->umem_list, typeof(*tmp), link);
		vhost_umem_free(umem, tmp);
	}

	node->start = start;
	node->size = size;
	node->last = end;
	node->userspace_addr = userspace_addr;
	node->perm = perm;
	INIT_LIST_HEAD(&node->link);
	list_add_tail(&node->link, &umem->umem_list);
	vhost_umem_interval_tree_insert(node, &umem->umem_tree);
	umem->numem++;

	return 0;
}

static void vhost_del_umem_range(struct vhost_umem *umem,
				 u64 start, u64 end)
{
	struct vhost_umem_node *node;

	while ((node = vhost_umem_interval_tree_iter_first(&umem->umem_tree,
							   start, end)))
		vhost_umem_free(umem, node);
}

static void vhost_iotlb_notify_vq(struct vhost_dev *d,
				  struct vhost_iotlb_msg *msg)
{
	struct vhost_msg_node *node, *n;

	spin_lock(&d->iotlb_lock);

	list_for_each_entry_safe(node, n, &d->pending_list, node) {
		struct vhost_iotlb_msg *vq_msg = &node->msg.iotlb;
		if (msg->iova <= vq_msg->iova &&
		    msg->iova + msg->size - 1 > vq_msg->iova &&
		    vq_msg->type == VHOST_IOTLB_MISS) {
			vhost_poll_queue(&node->vq->poll);
			list_del(&node->node);
			kfree(node);
		}
	}

	spin_unlock(&d->iotlb_lock);
}

static int umem_access_ok(u64 uaddr, u64 size, int access)
{
	unsigned long a = uaddr;

926 927 928 929
	/* Make sure 64 bit math will not overflow. */
	if (vhost_overflow(uaddr, size))
		return -EFAULT;

J
Jason Wang 已提交
930 931 932 933 934 935 936 937 938
	if ((access & VHOST_ACCESS_RO) &&
	    !access_ok(VERIFY_READ, (void __user *)a, size))
		return -EFAULT;
	if ((access & VHOST_ACCESS_WO) &&
	    !access_ok(VERIFY_WRITE, (void __user *)a, size))
		return -EFAULT;
	return 0;
}

939 940
static int vhost_process_iotlb_msg(struct vhost_dev *dev,
				   struct vhost_iotlb_msg *msg)
J
Jason Wang 已提交
941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
{
	int ret = 0;

	vhost_dev_lock_vqs(dev);
	switch (msg->type) {
	case VHOST_IOTLB_UPDATE:
		if (!dev->iotlb) {
			ret = -EFAULT;
			break;
		}
		if (umem_access_ok(msg->uaddr, msg->size, msg->perm)) {
			ret = -EFAULT;
			break;
		}
		if (vhost_new_umem_range(dev->iotlb, msg->iova, msg->size,
					 msg->iova + msg->size - 1,
					 msg->uaddr, msg->perm)) {
			ret = -ENOMEM;
			break;
		}
		vhost_iotlb_notify_vq(dev, msg);
		break;
	case VHOST_IOTLB_INVALIDATE:
		vhost_del_umem_range(dev->iotlb, msg->iova,
				     msg->iova + msg->size - 1);
		break;
	default:
		ret = -EINVAL;
		break;
	}

	vhost_dev_unlock_vqs(dev);
	return ret;
}
ssize_t vhost_chr_write_iter(struct vhost_dev *dev,
			     struct iov_iter *from)
{
	struct vhost_msg_node node;
	unsigned size = sizeof(struct vhost_msg);
	size_t ret;
	int err;

	if (iov_iter_count(from) < size)
		return 0;
	ret = copy_from_iter(&node.msg, size, from);
	if (ret != size)
		goto done;

	switch (node.msg.type) {
	case VHOST_IOTLB_MSG:
		err = vhost_process_iotlb_msg(dev, &node.msg.iotlb);
		if (err)
			ret = err;
		break;
	default:
		ret = -EINVAL;
		break;
	}

done:
	return ret;
}
EXPORT_SYMBOL(vhost_chr_write_iter);

unsigned int vhost_chr_poll(struct file *file, struct vhost_dev *dev,
			    poll_table *wait)
{
	unsigned int mask = 0;

	poll_wait(file, &dev->wait, wait);

	if (!list_empty(&dev->read_list))
		mask |= POLLIN | POLLRDNORM;

	return mask;
}
EXPORT_SYMBOL(vhost_chr_poll);

ssize_t vhost_chr_read_iter(struct vhost_dev *dev, struct iov_iter *to,
			    int noblock)
{
	DEFINE_WAIT(wait);
	struct vhost_msg_node *node;
	ssize_t ret = 0;
	unsigned size = sizeof(struct vhost_msg);

	if (iov_iter_count(to) < size)
		return 0;

	while (1) {
		if (!noblock)
			prepare_to_wait(&dev->wait, &wait,
					TASK_INTERRUPTIBLE);

		node = vhost_dequeue_msg(dev, &dev->read_list);
		if (node)
			break;
		if (noblock) {
			ret = -EAGAIN;
			break;
		}
		if (signal_pending(current)) {
			ret = -ERESTARTSYS;
			break;
		}
		if (!dev->iotlb) {
			ret = -EBADFD;
			break;
		}

		schedule();
	}

	if (!noblock)
		finish_wait(&dev->wait, &wait);

	if (node) {
		ret = copy_to_iter(&node->msg, size, to);

		if (ret != size || node->msg.type != VHOST_IOTLB_MISS) {
			kfree(node);
			return ret;
		}

		vhost_enqueue_msg(dev, &dev->pending_list, node);
	}

	return ret;
}
EXPORT_SYMBOL_GPL(vhost_chr_read_iter);

static int vhost_iotlb_miss(struct vhost_virtqueue *vq, u64 iova, int access)
{
	struct vhost_dev *dev = vq->dev;
	struct vhost_msg_node *node;
	struct vhost_iotlb_msg *msg;

	node = vhost_new_msg(vq, VHOST_IOTLB_MISS);
	if (!node)
		return -ENOMEM;

	msg = &node->msg.iotlb;
	msg->type = VHOST_IOTLB_MISS;
	msg->iova = iova;
	msg->perm = access;

	vhost_enqueue_msg(dev, &dev->read_list, node);

	return 0;
1090 1091
}

1092
static int vq_access_ok(struct vhost_virtqueue *vq, unsigned int num,
1093 1094 1095
			struct vring_desc __user *desc,
			struct vring_avail __user *avail,
			struct vring_used __user *used)
J
Jason Wang 已提交
1096

1097
{
1098
	size_t s = vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
J
Jason Wang 已提交
1099

1100 1101
	return access_ok(VERIFY_READ, desc, num * sizeof *desc) &&
	       access_ok(VERIFY_READ, avail,
M
Michael S. Tsirkin 已提交
1102
			 sizeof *avail + num * sizeof *avail->ring + s) &&
1103
	       access_ok(VERIFY_WRITE, used,
M
Michael S. Tsirkin 已提交
1104
			sizeof *used + num * sizeof *used->ring + s);
1105 1106
}

J
Jason Wang 已提交
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
static int iotlb_access_ok(struct vhost_virtqueue *vq,
			   int access, u64 addr, u64 len)
{
	const struct vhost_umem_node *node;
	struct vhost_umem *umem = vq->iotlb;
	u64 s = 0, size;

	while (len > s) {
		node = vhost_umem_interval_tree_iter_first(&umem->umem_tree,
							   addr,
							   addr + len - 1);
		if (node == NULL || node->start > addr) {
			vhost_iotlb_miss(vq, addr, access);
			return false;
		} else if (!(node->perm & access)) {
			/* Report the possible access violation by
			 * request another translation from userspace.
			 */
			return false;
		}

		size = node->size - addr + node->start;
		s += size;
		addr += size;
	}

	return true;
}

int vq_iotlb_prefetch(struct vhost_virtqueue *vq)
{
	size_t s = vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
	unsigned int num = vq->num;

	if (!vq->iotlb)
		return 1;

	return iotlb_access_ok(vq, VHOST_ACCESS_RO, (u64)(uintptr_t)vq->desc,
			       num * sizeof *vq->desc) &&
	       iotlb_access_ok(vq, VHOST_ACCESS_RO, (u64)(uintptr_t)vq->avail,
			       sizeof *vq->avail +
			       num * sizeof *vq->avail->ring + s) &&
	       iotlb_access_ok(vq, VHOST_ACCESS_WO, (u64)(uintptr_t)vq->used,
			       sizeof *vq->used +
			       num * sizeof *vq->used->ring + s);
}
EXPORT_SYMBOL_GPL(vq_iotlb_prefetch);

1155 1156 1157 1158
/* Can we log writes? */
/* Caller should have device mutex but not vq mutex */
int vhost_log_access_ok(struct vhost_dev *dev)
{
1159
	return memory_access_ok(dev, dev->umem, 1);
1160
}
A
Asias He 已提交
1161
EXPORT_SYMBOL_GPL(vhost_log_access_ok);
1162 1163 1164

/* Verify access for write logging. */
/* Caller should have vq mutex and device mutex */
1165
static int vq_log_access_ok(struct vhost_virtqueue *vq,
M
Michael S. Tsirkin 已提交
1166
			    void __user *log_base)
1167
{
1168
	size_t s = vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
A
Arnd Bergmann 已提交
1169

1170
	return vq_memory_access_ok(log_base, vq->umem,
1171
				   vhost_has_feature(vq, VHOST_F_LOG_ALL)) &&
1172 1173
		(!vq->log_used || log_access_ok(log_base, vq->log_addr,
					sizeof *vq->used +
M
Michael S. Tsirkin 已提交
1174
					vq->num * sizeof *vq->used->ring + s));
1175 1176 1177 1178 1179 1180
}

/* Can we start vq? */
/* Caller should have vq mutex and device mutex */
int vhost_vq_access_ok(struct vhost_virtqueue *vq)
{
J
Jason Wang 已提交
1181 1182 1183 1184 1185 1186
	if (vq->iotlb) {
		/* When device IOTLB was used, the access validation
		 * will be validated during prefetching.
		 */
		return 1;
	}
1187 1188
	return vq_access_ok(vq, vq->num, vq->desc, vq->avail, vq->used) &&
		vq_log_access_ok(vq, vq->log_base);
1189
}
A
Asias He 已提交
1190
EXPORT_SYMBOL_GPL(vhost_vq_access_ok);
1191

J
Jason Wang 已提交
1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
static struct vhost_umem *vhost_umem_alloc(void)
{
	struct vhost_umem *umem = vhost_kvzalloc(sizeof(*umem));

	if (!umem)
		return NULL;

	umem->umem_tree = RB_ROOT;
	umem->numem = 0;
	INIT_LIST_HEAD(&umem->umem_list);

	return umem;
}

1206 1207
static long vhost_set_memory(struct vhost_dev *d, struct vhost_memory __user *m)
{
1208 1209 1210
	struct vhost_memory mem, *newmem;
	struct vhost_memory_region *region;
	struct vhost_umem *newumem, *oldumem;
1211
	unsigned long size = offsetof(struct vhost_memory, regions);
1212
	int i;
K
Krishna Kumar 已提交
1213

1214 1215
	if (copy_from_user(&mem, m, size))
		return -EFAULT;
1216 1217
	if (mem.padding)
		return -EOPNOTSUPP;
1218
	if (mem.nregions > max_mem_regions)
1219
		return -E2BIG;
1220
	newmem = vhost_kvzalloc(size + mem.nregions * sizeof(*m->regions));
1221 1222 1223 1224
	if (!newmem)
		return -ENOMEM;

	memcpy(newmem, &mem, size);
1225 1226
	if (copy_from_user(newmem->regions, m->regions,
			   mem.nregions * sizeof *m->regions)) {
1227
		kvfree(newmem);
1228
		return -EFAULT;
1229 1230
	}

J
Jason Wang 已提交
1231
	newumem = vhost_umem_alloc();
1232
	if (!newumem) {
1233
		kvfree(newmem);
1234 1235 1236 1237 1238 1239
		return -ENOMEM;
	}

	for (region = newmem->regions;
	     region < newmem->regions + mem.nregions;
	     region++) {
J
Jason Wang 已提交
1240 1241 1242 1243 1244 1245 1246
		if (vhost_new_umem_range(newumem,
					 region->guest_phys_addr,
					 region->memory_size,
					 region->guest_phys_addr +
					 region->memory_size - 1,
					 region->userspace_addr,
					 VHOST_ACCESS_RW))
1247
			goto err;
1248
	}
1249 1250 1251 1252 1253 1254

	if (!memory_access_ok(d, newumem, 0))
		goto err;

	oldumem = d->umem;
	d->umem = newumem;
1255

1256
	/* All memory accesses are done under some VQ mutex. */
1257 1258
	for (i = 0; i < d->nvqs; ++i) {
		mutex_lock(&d->vqs[i]->mutex);
1259
		d->vqs[i]->umem = newumem;
1260 1261
		mutex_unlock(&d->vqs[i]->mutex);
	}
1262 1263 1264

	kvfree(newmem);
	vhost_umem_clean(oldumem);
1265
	return 0;
1266 1267 1268 1269 1270

err:
	vhost_umem_clean(newumem);
	kvfree(newmem);
	return -EFAULT;
1271 1272
}

1273
long vhost_vring_ioctl(struct vhost_dev *d, int ioctl, void __user *argp)
1274
{
1275 1276
	struct file *eventfp, *filep = NULL;
	bool pollstart = false, pollstop = false;
1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288
	struct eventfd_ctx *ctx = NULL;
	u32 __user *idxp = argp;
	struct vhost_virtqueue *vq;
	struct vhost_vring_state s;
	struct vhost_vring_file f;
	struct vhost_vring_addr a;
	u32 idx;
	long r;

	r = get_user(idx, idxp);
	if (r < 0)
		return r;
1289
	if (idx >= d->nvqs)
1290 1291
		return -ENOBUFS;

1292
	vq = d->vqs[idx];
1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303

	mutex_lock(&vq->mutex);

	switch (ioctl) {
	case VHOST_SET_VRING_NUM:
		/* Resizing ring with an active backend?
		 * You don't want to do that. */
		if (vq->private_data) {
			r = -EBUSY;
			break;
		}
1304 1305
		if (copy_from_user(&s, argp, sizeof s)) {
			r = -EFAULT;
1306
			break;
1307
		}
1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320
		if (!s.num || s.num > 0xffff || (s.num & (s.num - 1))) {
			r = -EINVAL;
			break;
		}
		vq->num = s.num;
		break;
	case VHOST_SET_VRING_BASE:
		/* Moving base with an active backend?
		 * You don't want to do that. */
		if (vq->private_data) {
			r = -EBUSY;
			break;
		}
1321 1322
		if (copy_from_user(&s, argp, sizeof s)) {
			r = -EFAULT;
1323
			break;
1324
		}
1325 1326 1327 1328
		if (s.num > 0xffff) {
			r = -EINVAL;
			break;
		}
1329
		vq->last_avail_idx = vq->last_used_event = s.num;
1330 1331 1332 1333 1334 1335
		/* Forget the cached index value. */
		vq->avail_idx = vq->last_avail_idx;
		break;
	case VHOST_GET_VRING_BASE:
		s.index = idx;
		s.num = vq->last_avail_idx;
1336 1337
		if (copy_to_user(argp, &s, sizeof s))
			r = -EFAULT;
1338 1339
		break;
	case VHOST_SET_VRING_ADDR:
1340 1341
		if (copy_from_user(&a, argp, sizeof a)) {
			r = -EFAULT;
1342
			break;
1343
		}
1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355
		if (a.flags & ~(0x1 << VHOST_VRING_F_LOG)) {
			r = -EOPNOTSUPP;
			break;
		}
		/* For 32bit, verify that the top 32bits of the user
		   data are set to zero. */
		if ((u64)(unsigned long)a.desc_user_addr != a.desc_user_addr ||
		    (u64)(unsigned long)a.used_user_addr != a.used_user_addr ||
		    (u64)(unsigned long)a.avail_user_addr != a.avail_user_addr) {
			r = -EFAULT;
			break;
		}
1356 1357 1358 1359 1360 1361

		/* Make sure it's safe to cast pointers to vring types. */
		BUILD_BUG_ON(__alignof__ *vq->avail > VRING_AVAIL_ALIGN_SIZE);
		BUILD_BUG_ON(__alignof__ *vq->used > VRING_USED_ALIGN_SIZE);
		if ((a.avail_user_addr & (VRING_AVAIL_ALIGN_SIZE - 1)) ||
		    (a.used_user_addr & (VRING_USED_ALIGN_SIZE - 1)) ||
1362
		    (a.log_guest_addr & (VRING_USED_ALIGN_SIZE - 1))) {
1363 1364 1365 1366 1367 1368 1369 1370
			r = -EINVAL;
			break;
		}

		/* We only verify access here if backend is configured.
		 * If it is not, we don't as size might not have been setup.
		 * We will verify when backend is configured. */
		if (vq->private_data) {
1371
			if (!vq_access_ok(vq, vq->num,
1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395
				(void __user *)(unsigned long)a.desc_user_addr,
				(void __user *)(unsigned long)a.avail_user_addr,
				(void __user *)(unsigned long)a.used_user_addr)) {
				r = -EINVAL;
				break;
			}

			/* Also validate log access for used ring if enabled. */
			if ((a.flags & (0x1 << VHOST_VRING_F_LOG)) &&
			    !log_access_ok(vq->log_base, a.log_guest_addr,
					   sizeof *vq->used +
					   vq->num * sizeof *vq->used->ring)) {
				r = -EINVAL;
				break;
			}
		}

		vq->log_used = !!(a.flags & (0x1 << VHOST_VRING_F_LOG));
		vq->desc = (void __user *)(unsigned long)a.desc_user_addr;
		vq->avail = (void __user *)(unsigned long)a.avail_user_addr;
		vq->log_addr = a.log_guest_addr;
		vq->used = (void __user *)(unsigned long)a.used_user_addr;
		break;
	case VHOST_SET_VRING_KICK:
1396 1397
		if (copy_from_user(&f, argp, sizeof f)) {
			r = -EFAULT;
1398
			break;
1399
		}
1400
		eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
1401 1402 1403 1404
		if (IS_ERR(eventfp)) {
			r = PTR_ERR(eventfp);
			break;
		}
1405
		if (eventfp != vq->kick) {
1406 1407
			pollstop = (filep = vq->kick) != NULL;
			pollstart = (vq->kick = eventfp) != NULL;
1408 1409 1410 1411
		} else
			filep = eventfp;
		break;
	case VHOST_SET_VRING_CALL:
1412 1413
		if (copy_from_user(&f, argp, sizeof f)) {
			r = -EFAULT;
1414
			break;
1415
		}
1416
		eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
1417 1418 1419 1420
		if (IS_ERR(eventfp)) {
			r = PTR_ERR(eventfp);
			break;
		}
1421 1422 1423 1424 1425 1426 1427 1428 1429 1430
		if (eventfp != vq->call) {
			filep = vq->call;
			ctx = vq->call_ctx;
			vq->call = eventfp;
			vq->call_ctx = eventfp ?
				eventfd_ctx_fileget(eventfp) : NULL;
		} else
			filep = eventfp;
		break;
	case VHOST_SET_VRING_ERR:
1431 1432
		if (copy_from_user(&f, argp, sizeof f)) {
			r = -EFAULT;
1433
			break;
1434
		}
1435
		eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
1436 1437 1438 1439
		if (IS_ERR(eventfp)) {
			r = PTR_ERR(eventfp);
			break;
		}
1440 1441 1442 1443 1444 1445 1446 1447 1448
		if (eventfp != vq->error) {
			filep = vq->error;
			vq->error = eventfp;
			ctx = vq->error_ctx;
			vq->error_ctx = eventfp ?
				eventfd_ctx_fileget(eventfp) : NULL;
		} else
			filep = eventfp;
		break;
1449 1450 1451 1452 1453 1454
	case VHOST_SET_VRING_ENDIAN:
		r = vhost_set_vring_endian(vq, argp);
		break;
	case VHOST_GET_VRING_ENDIAN:
		r = vhost_get_vring_endian(vq, idx, argp);
		break;
J
Jason Wang 已提交
1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467
	case VHOST_SET_VRING_BUSYLOOP_TIMEOUT:
		if (copy_from_user(&s, argp, sizeof(s))) {
			r = -EFAULT;
			break;
		}
		vq->busyloop_timeout = s.num;
		break;
	case VHOST_GET_VRING_BUSYLOOP_TIMEOUT:
		s.index = idx;
		s.num = vq->busyloop_timeout;
		if (copy_to_user(argp, &s, sizeof(s)))
			r = -EFAULT;
		break;
1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480
	default:
		r = -ENOIOCTLCMD;
	}

	if (pollstop && vq->handle_kick)
		vhost_poll_stop(&vq->poll);

	if (ctx)
		eventfd_ctx_put(ctx);
	if (filep)
		fput(filep);

	if (pollstart && vq->handle_kick)
1481
		r = vhost_poll_start(&vq->poll, vq->kick);
1482 1483 1484 1485 1486 1487 1488

	mutex_unlock(&vq->mutex);

	if (pollstop && vq->handle_kick)
		vhost_poll_flush(&vq->poll);
	return r;
}
A
Asias He 已提交
1489
EXPORT_SYMBOL_GPL(vhost_vring_ioctl);
1490

J
Jason Wang 已提交
1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514
int vhost_init_device_iotlb(struct vhost_dev *d, bool enabled)
{
	struct vhost_umem *niotlb, *oiotlb;
	int i;

	niotlb = vhost_umem_alloc();
	if (!niotlb)
		return -ENOMEM;

	oiotlb = d->iotlb;
	d->iotlb = niotlb;

	for (i = 0; i < d->nvqs; ++i) {
		mutex_lock(&d->vqs[i]->mutex);
		d->vqs[i]->iotlb = niotlb;
		mutex_unlock(&d->vqs[i]->mutex);
	}

	vhost_umem_clean(oiotlb);

	return 0;
}
EXPORT_SYMBOL_GPL(vhost_init_device_iotlb);

1515
/* Caller must have device mutex */
1516
long vhost_dev_ioctl(struct vhost_dev *d, unsigned int ioctl, void __user *argp)
1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539
{
	struct file *eventfp, *filep = NULL;
	struct eventfd_ctx *ctx = NULL;
	u64 p;
	long r;
	int i, fd;

	/* If you are not the owner, you can become one */
	if (ioctl == VHOST_SET_OWNER) {
		r = vhost_dev_set_owner(d);
		goto done;
	}

	/* You must be the owner to do anything else */
	r = vhost_dev_check_owner(d);
	if (r)
		goto done;

	switch (ioctl) {
	case VHOST_SET_MEM_TABLE:
		r = vhost_set_memory(d, argp);
		break;
	case VHOST_SET_LOG_BASE:
1540 1541
		if (copy_from_user(&p, argp, sizeof p)) {
			r = -EFAULT;
1542
			break;
1543
		}
1544 1545 1546 1547 1548 1549 1550
		if ((u64)(unsigned long)p != p) {
			r = -EFAULT;
			break;
		}
		for (i = 0; i < d->nvqs; ++i) {
			struct vhost_virtqueue *vq;
			void __user *base = (void __user *)(unsigned long)p;
1551
			vq = d->vqs[i];
1552 1553
			mutex_lock(&vq->mutex);
			/* If ring is inactive, will check when it's enabled. */
1554
			if (vq->private_data && !vq_log_access_ok(vq, base))
1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571
				r = -EFAULT;
			else
				vq->log_base = base;
			mutex_unlock(&vq->mutex);
		}
		break;
	case VHOST_SET_LOG_FD:
		r = get_user(fd, (int __user *)argp);
		if (r < 0)
			break;
		eventfp = fd == -1 ? NULL : eventfd_fget(fd);
		if (IS_ERR(eventfp)) {
			r = PTR_ERR(eventfp);
			break;
		}
		if (eventfp != d->log_file) {
			filep = d->log_file;
1572
			d->log_file = eventfp;
1573 1574 1575 1576 1577 1578
			ctx = d->log_ctx;
			d->log_ctx = eventfp ?
				eventfd_ctx_fileget(eventfp) : NULL;
		} else
			filep = eventfp;
		for (i = 0; i < d->nvqs; ++i) {
1579 1580 1581
			mutex_lock(&d->vqs[i]->mutex);
			d->vqs[i]->log_ctx = d->log_ctx;
			mutex_unlock(&d->vqs[i]->mutex);
1582 1583 1584 1585 1586 1587 1588
		}
		if (ctx)
			eventfd_ctx_put(ctx);
		if (filep)
			fput(filep);
		break;
	default:
1589
		r = -ENOIOCTLCMD;
1590 1591 1592 1593 1594
		break;
	}
done:
	return r;
}
A
Asias He 已提交
1595
EXPORT_SYMBOL_GPL(vhost_dev_ioctl);
1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607

/* TODO: This is really inefficient.  We need something like get_user()
 * (instruction directly accesses the data, with an exception table entry
 * returning -EFAULT). See Documentation/x86/exception-tables.txt.
 */
static int set_bit_to_user(int nr, void __user *addr)
{
	unsigned long log = (unsigned long)addr;
	struct page *page;
	void *base;
	int bit = nr + (log % PAGE_SIZE) * 8;
	int r;
K
Krishna Kumar 已提交
1608

1609
	r = get_user_pages_fast(log, 1, 1, &page);
1610
	if (r < 0)
1611
		return r;
1612
	BUG_ON(r != 1);
1613
	base = kmap_atomic(page);
1614
	set_bit(bit, base);
1615
	kunmap_atomic(base);
1616 1617 1618 1619 1620 1621 1622 1623
	set_page_dirty_lock(page);
	put_page(page);
	return 0;
}

static int log_write(void __user *log_base,
		     u64 write_address, u64 write_length)
{
1624
	u64 write_page = write_address / VHOST_PAGE_SIZE;
1625
	int r;
K
Krishna Kumar 已提交
1626

1627 1628
	if (!write_length)
		return 0;
1629
	write_length += write_address % VHOST_PAGE_SIZE;
1630 1631
	for (;;) {
		u64 base = (u64)(unsigned long)log_base;
1632 1633
		u64 log = base + write_page / 8;
		int bit = write_page % 8;
1634 1635 1636 1637 1638 1639 1640 1641
		if ((u64)(unsigned long)log != log)
			return -EFAULT;
		r = set_bit_to_user(bit, (void __user *)(unsigned long)log);
		if (r < 0)
			return r;
		if (write_length <= VHOST_PAGE_SIZE)
			break;
		write_length -= VHOST_PAGE_SIZE;
1642
		write_page += 1;
1643 1644 1645 1646 1647 1648 1649 1650 1651 1652
	}
	return r;
}

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

	/* Make sure data written is seen before log. */
1653
	smp_wmb();
1654 1655 1656 1657 1658 1659
	for (i = 0; i < log_num; ++i) {
		u64 l = min(log[i].len, len);
		r = log_write(vq->log_base, log[i].addr, l);
		if (r < 0)
			return r;
		len -= l;
1660 1661 1662
		if (!len) {
			if (vq->log_ctx)
				eventfd_signal(vq->log_ctx, 1);
1663
			return 0;
1664
		}
1665 1666 1667 1668 1669
	}
	/* Length written exceeds what we have stored. This is a bug. */
	BUG();
	return 0;
}
A
Asias He 已提交
1670
EXPORT_SYMBOL_GPL(vhost_log_write);
1671

1672 1673 1674
static int vhost_update_used_flags(struct vhost_virtqueue *vq)
{
	void __user *used;
1675 1676
	if (vhost_put_user(vq, cpu_to_vhost16(vq, vq->used_flags),
			   &vq->used->flags) < 0)
1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693
		return -EFAULT;
	if (unlikely(vq->log_used)) {
		/* Make sure the flag is seen before log. */
		smp_wmb();
		/* Log used flag write. */
		used = &vq->used->flags;
		log_write(vq->log_base, vq->log_addr +
			  (used - (void __user *)vq->used),
			  sizeof vq->used->flags);
		if (vq->log_ctx)
			eventfd_signal(vq->log_ctx, 1);
	}
	return 0;
}

static int vhost_update_avail_event(struct vhost_virtqueue *vq, u16 avail_event)
{
1694 1695
	if (vhost_put_user(vq, cpu_to_vhost16(vq, vq->avail_idx),
			   vhost_avail_event(vq)))
1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711
		return -EFAULT;
	if (unlikely(vq->log_used)) {
		void __user *used;
		/* Make sure the event is seen before log. */
		smp_wmb();
		/* Log avail event write */
		used = vhost_avail_event(vq);
		log_write(vq->log_base, vq->log_addr +
			  (used - (void __user *)vq->used),
			  sizeof *vhost_avail_event(vq));
		if (vq->log_ctx)
			eventfd_signal(vq->log_ctx, 1);
	}
	return 0;
}

G
Greg Kurz 已提交
1712
int vhost_vq_init_access(struct vhost_virtqueue *vq)
1713
{
1714
	__virtio16 last_used_idx;
1715
	int r;
1716 1717
	bool is_le = vq->is_le;

1718
	if (!vq->private_data)
1719
		return 0;
1720 1721

	vhost_init_is_le(vq);
1722 1723 1724

	r = vhost_update_used_flags(vq);
	if (r)
1725
		goto err;
1726
	vq->signalled_used_valid = false;
J
Jason Wang 已提交
1727 1728
	if (!vq->iotlb &&
	    !access_ok(VERIFY_READ, &vq->used->idx, sizeof vq->used->idx)) {
1729 1730 1731
		r = -EFAULT;
		goto err;
	}
1732
	r = vhost_get_user(vq, last_used_idx, &vq->used->idx);
J
Jason Wang 已提交
1733 1734 1735
	if (r) {
		vq_err(vq, "Can't access used idx at %p\n",
		       &vq->used->idx);
1736
		goto err;
J
Jason Wang 已提交
1737
	}
1738
	vq->last_used_idx = vhost16_to_cpu(vq, last_used_idx);
1739
	return 0;
J
Jason Wang 已提交
1740

1741 1742 1743
err:
	vq->is_le = is_le;
	return r;
1744
}
G
Greg Kurz 已提交
1745
EXPORT_SYMBOL_GPL(vhost_vq_init_access);
1746

1747
static int translate_desc(struct vhost_virtqueue *vq, u64 addr, u32 len,
J
Jason Wang 已提交
1748
			  struct iovec iov[], int iov_size, int access)
1749
{
1750
	const struct vhost_umem_node *node;
J
Jason Wang 已提交
1751 1752
	struct vhost_dev *dev = vq->dev;
	struct vhost_umem *umem = dev->iotlb ? dev->iotlb : dev->umem;
1753 1754 1755 1756 1757 1758
	struct iovec *_iov;
	u64 s = 0;
	int ret = 0;

	while ((u64)len > s) {
		u64 size;
1759
		if (unlikely(ret >= iov_size)) {
1760 1761 1762
			ret = -ENOBUFS;
			break;
		}
J
Jason Wang 已提交
1763

1764 1765 1766
		node = vhost_umem_interval_tree_iter_first(&umem->umem_tree,
							addr, addr + len - 1);
		if (node == NULL || node->start > addr) {
J
Jason Wang 已提交
1767 1768 1769 1770 1771 1772 1773 1774
			if (umem != dev->iotlb) {
				ret = -EFAULT;
				break;
			}
			ret = -EAGAIN;
			break;
		} else if (!(node->perm & access)) {
			ret = -EPERM;
1775 1776
			break;
		}
J
Jason Wang 已提交
1777

1778
		_iov = iov + ret;
1779
		size = node->size - addr + node->start;
1780
		_iov->iov_len = min((u64)len - s, size);
C
Christoph Hellwig 已提交
1781
		_iov->iov_base = (void __user *)(unsigned long)
1782
			(node->userspace_addr + addr - node->start);
1783 1784 1785 1786 1787
		s += size;
		addr += size;
		++ret;
	}

J
Jason Wang 已提交
1788 1789
	if (ret == -EAGAIN)
		vhost_iotlb_miss(vq, addr, access);
1790 1791 1792 1793 1794 1795
	return ret;
}

/* Each buffer in the virtqueues is actually a chain of descriptors.  This
 * function returns the next descriptor in the chain,
 * or -1U if we're at the end. */
1796
static unsigned next_desc(struct vhost_virtqueue *vq, struct vring_desc *desc)
1797 1798 1799 1800
{
	unsigned int next;

	/* If this descriptor says it doesn't chain, we're done. */
1801
	if (!(desc->flags & cpu_to_vhost16(vq, VRING_DESC_F_NEXT)))
1802 1803 1804
		return -1U;

	/* Check they're not leading us off end of descriptors. */
1805
	next = vhost16_to_cpu(vq, desc->next);
1806 1807 1808 1809 1810 1811 1812 1813
	/* Make sure compiler knows to grab that: we don't want it changing! */
	/* We will use the result as an index in an array, so most
	 * architectures only need a compiler barrier here. */
	read_barrier_depends();

	return next;
}

1814
static int get_indirect(struct vhost_virtqueue *vq,
1815 1816 1817 1818
			struct iovec iov[], unsigned int iov_size,
			unsigned int *out_num, unsigned int *in_num,
			struct vhost_log *log, unsigned int *log_num,
			struct vring_desc *indirect)
1819 1820 1821
{
	struct vring_desc desc;
	unsigned int i = 0, count, found = 0;
1822
	u32 len = vhost32_to_cpu(vq, indirect->len);
1823
	struct iov_iter from;
J
Jason Wang 已提交
1824
	int ret, access;
1825 1826

	/* Sanity check */
1827
	if (unlikely(len % sizeof desc)) {
1828 1829
		vq_err(vq, "Invalid length in indirect descriptor: "
		       "len 0x%llx not multiple of 0x%zx\n",
1830
		       (unsigned long long)len,
1831 1832 1833 1834
		       sizeof desc);
		return -EINVAL;
	}

1835
	ret = translate_desc(vq, vhost64_to_cpu(vq, indirect->addr), len, vq->indirect,
J
Jason Wang 已提交
1836
			     UIO_MAXIOV, VHOST_ACCESS_RO);
1837
	if (unlikely(ret < 0)) {
J
Jason Wang 已提交
1838 1839
		if (ret != -EAGAIN)
			vq_err(vq, "Translation failure %d in indirect.\n", ret);
1840 1841
		return ret;
	}
1842
	iov_iter_init(&from, READ, vq->indirect, ret, len);
1843 1844 1845 1846 1847

	/* We will use the result as an address to read from, so most
	 * architectures only need a compiler barrier here. */
	read_barrier_depends();

1848
	count = len / sizeof desc;
1849 1850
	/* Buffers are chained via a 16 bit next field, so
	 * we can have at most 2^16 of these. */
1851
	if (unlikely(count > USHRT_MAX + 1)) {
1852 1853 1854 1855 1856 1857 1858
		vq_err(vq, "Indirect buffer length too big: %d\n",
		       indirect->len);
		return -E2BIG;
	}

	do {
		unsigned iov_count = *in_num + *out_num;
1859
		if (unlikely(++found > count)) {
1860 1861 1862 1863 1864
			vq_err(vq, "Loop detected: last one at %u "
			       "indirect size %u\n",
			       i, count);
			return -EINVAL;
		}
1865
		if (unlikely(!copy_from_iter_full(&desc, sizeof(desc), &from))) {
1866
			vq_err(vq, "Failed indirect descriptor: idx %d, %zx\n",
1867
			       i, (size_t)vhost64_to_cpu(vq, indirect->addr) + i * sizeof desc);
1868 1869
			return -EINVAL;
		}
1870
		if (unlikely(desc.flags & cpu_to_vhost16(vq, VRING_DESC_F_INDIRECT))) {
1871
			vq_err(vq, "Nested indirect descriptor: idx %d, %zx\n",
1872
			       i, (size_t)vhost64_to_cpu(vq, indirect->addr) + i * sizeof desc);
1873 1874 1875
			return -EINVAL;
		}

J
Jason Wang 已提交
1876 1877 1878 1879 1880
		if (desc.flags & cpu_to_vhost16(vq, VRING_DESC_F_WRITE))
			access = VHOST_ACCESS_WO;
		else
			access = VHOST_ACCESS_RO;

1881 1882
		ret = translate_desc(vq, vhost64_to_cpu(vq, desc.addr),
				     vhost32_to_cpu(vq, desc.len), iov + iov_count,
J
Jason Wang 已提交
1883
				     iov_size - iov_count, access);
1884
		if (unlikely(ret < 0)) {
J
Jason Wang 已提交
1885 1886 1887
			if (ret != -EAGAIN)
				vq_err(vq, "Translation failure %d indirect idx %d\n",
					ret, i);
1888 1889 1890
			return ret;
		}
		/* If this is an input descriptor, increment that count. */
J
Jason Wang 已提交
1891
		if (access == VHOST_ACCESS_WO) {
1892 1893
			*in_num += ret;
			if (unlikely(log)) {
1894 1895
				log[*log_num].addr = vhost64_to_cpu(vq, desc.addr);
				log[*log_num].len = vhost32_to_cpu(vq, desc.len);
1896 1897 1898 1899 1900
				++*log_num;
			}
		} else {
			/* If it's an output descriptor, they're all supposed
			 * to come before any input descriptors. */
1901
			if (unlikely(*in_num)) {
1902 1903 1904 1905 1906 1907
				vq_err(vq, "Indirect descriptor "
				       "has out after in: idx %d\n", i);
				return -EINVAL;
			}
			*out_num += ret;
		}
1908
	} while ((i = next_desc(vq, &desc)) != -1);
1909 1910 1911 1912 1913 1914 1915 1916
	return 0;
}

/* This looks in the virtqueue and for the first available buffer, and converts
 * it to an iovec for convenient access.  Since descriptors consist of some
 * number of output then some number of input descriptors, it's actually two
 * iovecs, but we pack them into one and note how many of each there were.
 *
1917 1918 1919
 * This function returns the descriptor number found, or vq->num (which is
 * never a valid descriptor number) if none was found.  A negative code is
 * returned on error. */
1920
int vhost_get_vq_desc(struct vhost_virtqueue *vq,
1921 1922 1923
		      struct iovec iov[], unsigned int iov_size,
		      unsigned int *out_num, unsigned int *in_num,
		      struct vhost_log *log, unsigned int *log_num)
1924 1925 1926 1927
{
	struct vring_desc desc;
	unsigned int i, head, found = 0;
	u16 last_avail_idx;
1928 1929
	__virtio16 avail_idx;
	__virtio16 ring_head;
J
Jason Wang 已提交
1930
	int ret, access;
1931 1932 1933

	/* Check it isn't doing very strange things with descriptor numbers. */
	last_avail_idx = vq->last_avail_idx;
1934
	if (unlikely(vhost_get_user(vq, avail_idx, &vq->avail->idx))) {
1935 1936
		vq_err(vq, "Failed to access avail idx at %p\n",
		       &vq->avail->idx);
1937
		return -EFAULT;
1938
	}
1939
	vq->avail_idx = vhost16_to_cpu(vq, avail_idx);
1940

1941
	if (unlikely((u16)(vq->avail_idx - last_avail_idx) > vq->num)) {
1942 1943
		vq_err(vq, "Guest moved used index from %u to %u",
		       last_avail_idx, vq->avail_idx);
1944
		return -EFAULT;
1945 1946 1947 1948 1949 1950 1951
	}

	/* If there's nothing new since last we looked, return invalid. */
	if (vq->avail_idx == last_avail_idx)
		return vq->num;

	/* Only get avail ring entries after they have been exposed by guest. */
1952
	smp_rmb();
1953 1954 1955

	/* Grab the next descriptor number they're advertising, and increment
	 * the index we've seen. */
1956 1957
	if (unlikely(vhost_get_user(vq, ring_head,
		     &vq->avail->ring[last_avail_idx & (vq->num - 1)]))) {
1958 1959 1960
		vq_err(vq, "Failed to read head: idx %d address %p\n",
		       last_avail_idx,
		       &vq->avail->ring[last_avail_idx % vq->num]);
1961
		return -EFAULT;
1962 1963
	}

1964 1965
	head = vhost16_to_cpu(vq, ring_head);

1966
	/* If their number is silly, that's an error. */
1967
	if (unlikely(head >= vq->num)) {
1968 1969
		vq_err(vq, "Guest says index %u > %u is available",
		       head, vq->num);
1970
		return -EINVAL;
1971 1972 1973 1974 1975 1976 1977 1978 1979 1980
	}

	/* When we start there are none of either input nor output. */
	*out_num = *in_num = 0;
	if (unlikely(log))
		*log_num = 0;

	i = head;
	do {
		unsigned iov_count = *in_num + *out_num;
1981
		if (unlikely(i >= vq->num)) {
1982 1983
			vq_err(vq, "Desc index is %u > %u, head = %u",
			       i, vq->num, head);
1984
			return -EINVAL;
1985
		}
1986
		if (unlikely(++found > vq->num)) {
1987 1988 1989
			vq_err(vq, "Loop detected: last one at %u "
			       "vq size %u head %u\n",
			       i, vq->num, head);
1990
			return -EINVAL;
1991
		}
1992 1993
		ret = vhost_copy_from_user(vq, &desc, vq->desc + i,
					   sizeof desc);
1994
		if (unlikely(ret)) {
1995 1996
			vq_err(vq, "Failed to get descriptor: idx %d addr %p\n",
			       i, vq->desc + i);
1997
			return -EFAULT;
1998
		}
1999
		if (desc.flags & cpu_to_vhost16(vq, VRING_DESC_F_INDIRECT)) {
2000
			ret = get_indirect(vq, iov, iov_size,
2001 2002
					   out_num, in_num,
					   log, log_num, &desc);
2003
			if (unlikely(ret < 0)) {
J
Jason Wang 已提交
2004 2005 2006
				if (ret != -EAGAIN)
					vq_err(vq, "Failure detected "
						"in indirect descriptor at idx %d\n", i);
2007
				return ret;
2008 2009 2010 2011
			}
			continue;
		}

J
Jason Wang 已提交
2012 2013 2014 2015
		if (desc.flags & cpu_to_vhost16(vq, VRING_DESC_F_WRITE))
			access = VHOST_ACCESS_WO;
		else
			access = VHOST_ACCESS_RO;
2016 2017
		ret = translate_desc(vq, vhost64_to_cpu(vq, desc.addr),
				     vhost32_to_cpu(vq, desc.len), iov + iov_count,
J
Jason Wang 已提交
2018
				     iov_size - iov_count, access);
2019
		if (unlikely(ret < 0)) {
J
Jason Wang 已提交
2020 2021 2022
			if (ret != -EAGAIN)
				vq_err(vq, "Translation failure %d descriptor idx %d\n",
					ret, i);
2023
			return ret;
2024
		}
J
Jason Wang 已提交
2025
		if (access == VHOST_ACCESS_WO) {
2026 2027 2028 2029
			/* If this is an input descriptor,
			 * increment that count. */
			*in_num += ret;
			if (unlikely(log)) {
2030 2031
				log[*log_num].addr = vhost64_to_cpu(vq, desc.addr);
				log[*log_num].len = vhost32_to_cpu(vq, desc.len);
2032 2033 2034 2035 2036
				++*log_num;
			}
		} else {
			/* If it's an output descriptor, they're all supposed
			 * to come before any input descriptors. */
2037
			if (unlikely(*in_num)) {
2038 2039
				vq_err(vq, "Descriptor has out after in: "
				       "idx %d\n", i);
2040
				return -EINVAL;
2041 2042 2043
			}
			*out_num += ret;
		}
2044
	} while ((i = next_desc(vq, &desc)) != -1);
2045 2046 2047

	/* On success, increment avail index. */
	vq->last_avail_idx++;
M
Michael S. Tsirkin 已提交
2048 2049 2050 2051

	/* Assume notifications from guest are disabled at this point,
	 * if they aren't we would need to update avail_event index. */
	BUG_ON(!(vq->used_flags & VRING_USED_F_NO_NOTIFY));
2052 2053
	return head;
}
A
Asias He 已提交
2054
EXPORT_SYMBOL_GPL(vhost_get_vq_desc);
2055 2056

/* Reverse the effect of vhost_get_vq_desc. Useful for error handling. */
2057
void vhost_discard_vq_desc(struct vhost_virtqueue *vq, int n)
2058
{
2059
	vq->last_avail_idx -= n;
2060
}
A
Asias He 已提交
2061
EXPORT_SYMBOL_GPL(vhost_discard_vq_desc);
2062 2063 2064 2065 2066

/* After we've used one of their buffers, we tell them about it.  We'll then
 * want to notify the guest, using eventfd. */
int vhost_add_used(struct vhost_virtqueue *vq, unsigned int head, int len)
{
2067 2068 2069 2070
	struct vring_used_elem heads = {
		cpu_to_vhost32(vq, head),
		cpu_to_vhost32(vq, len)
	};
2071

2072
	return vhost_add_used_n(vq, &heads, 1);
2073
}
A
Asias He 已提交
2074
EXPORT_SYMBOL_GPL(vhost_add_used);
2075

2076 2077 2078 2079 2080
static int __vhost_add_used_n(struct vhost_virtqueue *vq,
			    struct vring_used_elem *heads,
			    unsigned count)
{
	struct vring_used_elem __user *used;
M
Michael S. Tsirkin 已提交
2081
	u16 old, new;
2082 2083
	int start;

2084
	start = vq->last_used_idx & (vq->num - 1);
2085
	used = vq->used->ring + start;
2086
	if (count == 1) {
2087
		if (vhost_put_user(vq, heads[0].id, &used->id)) {
2088 2089 2090
			vq_err(vq, "Failed to write used id");
			return -EFAULT;
		}
2091
		if (vhost_put_user(vq, heads[0].len, &used->len)) {
2092 2093 2094
			vq_err(vq, "Failed to write used len");
			return -EFAULT;
		}
2095
	} else if (vhost_copy_to_user(vq, used, heads, count * sizeof *used)) {
2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107
		vq_err(vq, "Failed to write used");
		return -EFAULT;
	}
	if (unlikely(vq->log_used)) {
		/* Make sure data is seen before log. */
		smp_wmb();
		/* Log used ring entry write. */
		log_write(vq->log_base,
			  vq->log_addr +
			   ((void __user *)used - (void __user *)vq->used),
			  count * sizeof *used);
	}
M
Michael S. Tsirkin 已提交
2108 2109 2110 2111 2112 2113 2114 2115
	old = vq->last_used_idx;
	new = (vq->last_used_idx += count);
	/* If the driver never bothers to signal in a very long while,
	 * used index might wrap around. If that happens, invalidate
	 * signalled_used index we stored. TODO: make sure driver
	 * signals at least once in 2^16 and remove this. */
	if (unlikely((u16)(new - vq->signalled_used) < (u16)(new - old)))
		vq->signalled_used_valid = false;
2116 2117 2118 2119 2120 2121 2122 2123 2124 2125
	return 0;
}

/* After we've used one of their buffers, we tell them about it.  We'll then
 * want to notify the guest, using eventfd. */
int vhost_add_used_n(struct vhost_virtqueue *vq, struct vring_used_elem *heads,
		     unsigned count)
{
	int start, n, r;

2126
	start = vq->last_used_idx & (vq->num - 1);
2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138
	n = vq->num - start;
	if (n < count) {
		r = __vhost_add_used_n(vq, heads, n);
		if (r < 0)
			return r;
		heads += n;
		count -= n;
	}
	r = __vhost_add_used_n(vq, heads, count);

	/* Make sure buffer is written before we update index. */
	smp_wmb();
2139 2140
	if (vhost_put_user(vq, cpu_to_vhost16(vq, vq->last_used_idx),
			   &vq->used->idx)) {
2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153
		vq_err(vq, "Failed to increment used idx");
		return -EFAULT;
	}
	if (unlikely(vq->log_used)) {
		/* Log used index update. */
		log_write(vq->log_base,
			  vq->log_addr + offsetof(struct vring_used, idx),
			  sizeof vq->used->idx);
		if (vq->log_ctx)
			eventfd_signal(vq->log_ctx, 1);
	}
	return r;
}
A
Asias He 已提交
2154
EXPORT_SYMBOL_GPL(vhost_add_used_n);
2155

M
Michael S. Tsirkin 已提交
2156
static bool vhost_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
2157
{
2158 2159
	__u16 old, new;
	__virtio16 event;
M
Michael S. Tsirkin 已提交
2160
	bool v;
M
Michael S. Tsirkin 已提交
2161

2162
	if (vhost_has_feature(vq, VIRTIO_F_NOTIFY_ON_EMPTY) &&
M
Michael S. Tsirkin 已提交
2163 2164 2165
	    unlikely(vq->avail_idx == vq->last_avail_idx))
		return true;

2166
	if (!vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX)) {
2167
		__virtio16 flags;
2168 2169 2170 2171
		/* Flush out used index updates. This is paired
		 * with the barrier that the Guest executes when enabling
		 * interrupts. */
		smp_mb();
2172
		if (vhost_get_user(vq, flags, &vq->avail->flags)) {
M
Michael S. Tsirkin 已提交
2173 2174 2175
			vq_err(vq, "Failed to get flags");
			return true;
		}
2176
		return !(flags & cpu_to_vhost16(vq, VRING_AVAIL_F_NO_INTERRUPT));
2177
	}
M
Michael S. Tsirkin 已提交
2178 2179 2180 2181
	old = vq->signalled_used;
	v = vq->signalled_used_valid;
	new = vq->signalled_used = vq->last_used_idx;
	vq->signalled_used_valid = true;
2182

M
Michael S. Tsirkin 已提交
2183 2184
	if (unlikely(!v))
		return true;
2185

2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198
	/* We're sure if the following conditions are met, there's no
	 * need to notify guest:
	 * 1) cached used event is ahead of new
	 * 2) old to new updating does not cross cached used event. */
	if (vring_need_event(vq->last_used_event, new + vq->num, new) &&
	    !vring_need_event(vq->last_used_event, new, old))
		return false;

	/* Flush out used index updates. This is paired
	 * with the barrier that the Guest executes when enabling
	 * interrupts. */
	smp_mb();

2199
	if (vhost_get_user(vq, event, vhost_used_event(vq))) {
M
Michael S. Tsirkin 已提交
2200 2201 2202
		vq_err(vq, "Failed to get used event idx");
		return true;
	}
2203 2204 2205
	vq->last_used_event = vhost16_to_cpu(vq, event);

	return vring_need_event(vq->last_used_event, new, old);
M
Michael S. Tsirkin 已提交
2206 2207 2208 2209 2210
}

/* This actually signals the guest, using eventfd. */
void vhost_signal(struct vhost_dev *dev, struct vhost_virtqueue *vq)
{
2211
	/* Signal the Guest tell them we used something up. */
M
Michael S. Tsirkin 已提交
2212
	if (vq->call_ctx && vhost_notify(dev, vq))
2213 2214
		eventfd_signal(vq->call_ctx, 1);
}
A
Asias He 已提交
2215
EXPORT_SYMBOL_GPL(vhost_signal);
2216 2217 2218 2219 2220 2221 2222 2223 2224

/* And here's the combo meal deal.  Supersize me! */
void vhost_add_used_and_signal(struct vhost_dev *dev,
			       struct vhost_virtqueue *vq,
			       unsigned int head, int len)
{
	vhost_add_used(vq, head, len);
	vhost_signal(dev, vq);
}
A
Asias He 已提交
2225
EXPORT_SYMBOL_GPL(vhost_add_used_and_signal);
2226

2227 2228 2229 2230 2231 2232 2233 2234
/* multi-buffer version of vhost_add_used_and_signal */
void vhost_add_used_and_signal_n(struct vhost_dev *dev,
				 struct vhost_virtqueue *vq,
				 struct vring_used_elem *heads, unsigned count)
{
	vhost_add_used_n(vq, heads, count);
	vhost_signal(dev, vq);
}
A
Asias He 已提交
2235
EXPORT_SYMBOL_GPL(vhost_add_used_and_signal_n);
2236

2237 2238 2239 2240 2241 2242
/* return true if we're sure that avaiable ring is empty */
bool vhost_vq_avail_empty(struct vhost_dev *dev, struct vhost_virtqueue *vq)
{
	__virtio16 avail_idx;
	int r;

2243 2244 2245
	if (vq->avail_idx != vq->last_avail_idx)
		return false;

2246
	r = vhost_get_user(vq, avail_idx, &vq->avail->idx);
2247
	if (unlikely(r))
2248
		return false;
2249
	vq->avail_idx = vhost16_to_cpu(vq, avail_idx);
2250

2251
	return vq->avail_idx == vq->last_avail_idx;
2252 2253 2254
}
EXPORT_SYMBOL_GPL(vhost_vq_avail_empty);

2255
/* OK, now we need to know about added descriptors. */
M
Michael S. Tsirkin 已提交
2256
bool vhost_enable_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
2257
{
2258
	__virtio16 avail_idx;
2259
	int r;
K
Krishna Kumar 已提交
2260

2261 2262 2263
	if (!(vq->used_flags & VRING_USED_F_NO_NOTIFY))
		return false;
	vq->used_flags &= ~VRING_USED_F_NO_NOTIFY;
2264
	if (!vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX)) {
2265
		r = vhost_update_used_flags(vq);
M
Michael S. Tsirkin 已提交
2266 2267 2268 2269 2270 2271
		if (r) {
			vq_err(vq, "Failed to enable notification at %p: %d\n",
			       &vq->used->flags, r);
			return false;
		}
	} else {
2272
		r = vhost_update_avail_event(vq, vq->avail_idx);
M
Michael S. Tsirkin 已提交
2273 2274 2275 2276 2277 2278
		if (r) {
			vq_err(vq, "Failed to update avail event index at %p: %d\n",
			       vhost_avail_event(vq), r);
			return false;
		}
	}
2279 2280
	/* They could have slipped one in as we were doing that: make
	 * sure it's written, then check again. */
2281
	smp_mb();
2282
	r = vhost_get_user(vq, avail_idx, &vq->avail->idx);
2283 2284 2285 2286 2287 2288
	if (r) {
		vq_err(vq, "Failed to check avail idx at %p: %d\n",
		       &vq->avail->idx, r);
		return false;
	}

2289
	return vhost16_to_cpu(vq, avail_idx) != vq->avail_idx;
2290
}
A
Asias He 已提交
2291
EXPORT_SYMBOL_GPL(vhost_enable_notify);
2292 2293

/* We don't need to be notified again. */
M
Michael S. Tsirkin 已提交
2294
void vhost_disable_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
2295 2296
{
	int r;
K
Krishna Kumar 已提交
2297

2298 2299 2300
	if (vq->used_flags & VRING_USED_F_NO_NOTIFY)
		return;
	vq->used_flags |= VRING_USED_F_NO_NOTIFY;
2301
	if (!vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX)) {
2302
		r = vhost_update_used_flags(vq);
M
Michael S. Tsirkin 已提交
2303 2304 2305 2306
		if (r)
			vq_err(vq, "Failed to enable notification at %p: %d\n",
			       &vq->used->flags, r);
	}
2307
}
A
Asias He 已提交
2308 2309
EXPORT_SYMBOL_GPL(vhost_disable_notify);

J
Jason Wang 已提交
2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350
/* Create a new message. */
struct vhost_msg_node *vhost_new_msg(struct vhost_virtqueue *vq, int type)
{
	struct vhost_msg_node *node = kmalloc(sizeof *node, GFP_KERNEL);
	if (!node)
		return NULL;
	node->vq = vq;
	node->msg.type = type;
	return node;
}
EXPORT_SYMBOL_GPL(vhost_new_msg);

void vhost_enqueue_msg(struct vhost_dev *dev, struct list_head *head,
		       struct vhost_msg_node *node)
{
	spin_lock(&dev->iotlb_lock);
	list_add_tail(&node->node, head);
	spin_unlock(&dev->iotlb_lock);

	wake_up_interruptible_poll(&dev->wait, POLLIN | POLLRDNORM);
}
EXPORT_SYMBOL_GPL(vhost_enqueue_msg);

struct vhost_msg_node *vhost_dequeue_msg(struct vhost_dev *dev,
					 struct list_head *head)
{
	struct vhost_msg_node *node = NULL;

	spin_lock(&dev->iotlb_lock);
	if (!list_empty(head)) {
		node = list_first_entry(head, struct vhost_msg_node,
					node);
		list_del(&node->node);
	}
	spin_unlock(&dev->iotlb_lock);

	return node;
}
EXPORT_SYMBOL_GPL(vhost_dequeue_msg);


A
Asias He 已提交
2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366
static int __init vhost_init(void)
{
	return 0;
}

static void __exit vhost_exit(void)
{
}

module_init(vhost_init);
module_exit(vhost_exit);

MODULE_VERSION("0.0.1");
MODULE_LICENSE("GPL v2");
MODULE_AUTHOR("Michael S. Tsirkin");
MODULE_DESCRIPTION("Host kernel accelerator for virtio");