vhost.c 57.2 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/interval_tree_generic.h>
31 32 33

#include "vhost.h"

34 35 36 37
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 已提交
38 39 40 41
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)");
42

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

47 48
#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 已提交
49

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

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

G
Greg Kurz 已提交
60 61 62 63 64 65 66 67 68 69
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;
}

70 71 72 73 74 75 76 77 78 79 80 81 82 83
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 已提交
84 85 86 87
	if (s.num == VHOST_VRING_BIG_ENDIAN)
		vhost_enable_cross_endian_big(vq);
	else
		vhost_enable_cross_endian_little(vq);
88 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

	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 已提交
116
static void vhost_disable_cross_endian(struct vhost_virtqueue *vq)
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
{
}

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)
{
	if (vhost_has_feature(vq, VIRTIO_F_VERSION_1))
		vq->is_le = true;
}
#endif /* CONFIG_VHOST_CROSS_ENDIAN_LEGACY */

G
Greg Kurz 已提交
138 139 140 141 142
static void vhost_reset_is_le(struct vhost_virtqueue *vq)
{
	vq->is_le = virtio_legacy_is_little_endian();
}

J
Jason Wang 已提交
143 144 145 146 147 148 149 150 151 152 153 154 155
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);
}

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

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

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

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

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

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

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

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

/* 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. */
202
int vhost_poll_start(struct vhost_poll *poll, struct file *file)
203 204
{
	unsigned long mask;
205
	int ret = 0;
K
Krishna Kumar 已提交
206

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

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

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

/* 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)
{
227 228 229 230
	if (poll->wqh) {
		remove_wait_queue(poll->wqh, &poll->wait);
		poll->wqh = NULL;
	}
231
}
A
Asias He 已提交
232
EXPORT_SYMBOL_GPL(vhost_poll_stop);
233

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

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

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

248 249 250 251 252 253
/* 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 已提交
254
EXPORT_SYMBOL_GPL(vhost_poll_flush);
255

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

J
Jason Wang 已提交
261 262 263
	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.
264
		 * test_and_set_bit() implies a memory barrier.
J
Jason Wang 已提交
265 266
		 */
		llist_add(&work->node, &dev->work_list);
267 268
		wake_up_process(dev->worker);
	}
269
}
A
Asias He 已提交
270
EXPORT_SYMBOL_GPL(vhost_work_queue);
271

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

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

285 286 287 288 289 290 291 292
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;
293
	vq->last_used_event = 0;
294 295
	vq->avail_idx = 0;
	vq->last_used_idx = 0;
M
Michael S. Tsirkin 已提交
296 297
	vq->signalled_used = 0;
	vq->signalled_used_valid = false;
298 299 300 301
	vq->used_flags = 0;
	vq->log_used = false;
	vq->log_addr = -1ull;
	vq->private_data = NULL;
302
	vq->acked_features = 0;
303 304 305 306 307 308
	vq->log_base = NULL;
	vq->error_ctx = NULL;
	vq->error = NULL;
	vq->kick = NULL;
	vq->call_ctx = NULL;
	vq->call = NULL;
309
	vq->log_ctx = NULL;
G
Greg Kurz 已提交
310 311
	vhost_reset_is_le(vq);
	vhost_disable_cross_endian(vq);
J
Jason Wang 已提交
312
	vq->busyloop_timeout = 0;
313
	vq->umem = NULL;
J
Jason Wang 已提交
314
	vq->iotlb = NULL;
315 316
}

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

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

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

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

		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);
345 346
			__set_current_state(TASK_RUNNING);
			work->fn(work);
N
Nadav Har'El 已提交
347 348
			if (need_resched())
				schedule();
J
Jason Wang 已提交
349
		}
350
	}
M
Michael S. Tsirkin 已提交
351
	unuse_mm(dev->mm);
352
	set_fs(oldfs);
M
Michael S. Tsirkin 已提交
353
	return 0;
354 355
}

356 357 358 359 360 361 362 363 364 365
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 已提交
366 367 368
/* Helper to allocate iovec buffers for all vqs. */
static long vhost_dev_alloc_iovecs(struct vhost_dev *dev)
{
A
Asias He 已提交
369
	struct vhost_virtqueue *vq;
J
Jason Wang 已提交
370
	int i;
K
Krishna Kumar 已提交
371

J
Jason Wang 已提交
372
	for (i = 0; i < dev->nvqs; ++i) {
A
Asias He 已提交
373 374 375 376 377 378
		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 已提交
379 380 381
			goto err_nomem;
	}
	return 0;
K
Krishna Kumar 已提交
382

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

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

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

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

403 404 405 406 407
	dev->vqs = vqs;
	dev->nvqs = nvqs;
	mutex_init(&dev->mutex);
	dev->log_ctx = NULL;
	dev->log_file = NULL;
408
	dev->umem = NULL;
J
Jason Wang 已提交
409
	dev->iotlb = NULL;
410
	dev->mm = NULL;
411
	dev->worker = NULL;
J
Jason Wang 已提交
412
	init_llist_head(&dev->work_list);
J
Jason Wang 已提交
413 414 415 416
	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 已提交
417

418 419

	for (i = 0; i < dev->nvqs; ++i) {
A
Asias He 已提交
420 421 422 423 424 425 426 427 428 429
		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);
430 431
	}
}
A
Asias He 已提交
432
EXPORT_SYMBOL_GPL(vhost_dev_init);
433 434 435 436 437 438 439

/* 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 已提交
440
EXPORT_SYMBOL_GPL(vhost_dev_check_owner);
441

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

static void vhost_attach_cgroups_work(struct vhost_work *work)
{
K
Krishna Kumar 已提交
450 451 452 453
	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);
454 455 456 457
}

static int vhost_attach_cgroups(struct vhost_dev *dev)
{
K
Krishna Kumar 已提交
458 459 460 461 462 463 464
	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;
465 466
}

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

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

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

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

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

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

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

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

518
static void *vhost_kvzalloc(unsigned long size)
519
{
520 521 522 523 524 525 526 527 528 529
	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));
530
}
A
Asias He 已提交
531
EXPORT_SYMBOL_GPL(vhost_dev_reset_owner_prepare);
532

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

538
	vhost_dev_cleanup(dev, true);
539

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

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

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

J
Jason Wang 已提交
564 565 566 567 568 569 570 571 572
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--;
}

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

	if (!umem)
		return;

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

583 584 585
	kvfree(umem);
}

J
Jason Wang 已提交
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
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);
}

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

610
	for (i = 0; i < dev->nvqs; ++i) {
611 612 613 614 615 616 617 618 619 620 621
		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]);
622
	}
J
Jason Wang 已提交
623
	vhost_dev_free_iovecs(dev);
624 625 626 627 628 629 630
	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 */
631 632
	vhost_umem_clean(dev->umem);
	dev->umem = NULL;
J
Jason Wang 已提交
633 634 635 636
	vhost_umem_clean(dev->iotlb);
	dev->iotlb = NULL;
	vhost_clear_msg(dev);
	wake_up_interruptible_poll(&dev->wait, POLLIN | POLLRDNORM);
J
Jason Wang 已提交
637
	WARN_ON(!llist_empty(&dev->work_list));
638 639 640 641
	if (dev->worker) {
		kthread_stop(dev->worker);
		dev->worker = NULL;
	}
642 643 644
	if (dev->mm)
		mmput(dev->mm);
	dev->mm = NULL;
645
}
A
Asias He 已提交
646
EXPORT_SYMBOL_GPL(vhost_dev_cleanup);
647 648 649 650

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

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

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

661 662 663 664 665 666
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;
}

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

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

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

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


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

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

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

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

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

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

J
Jason Wang 已提交
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
	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;
}
751 752

static int vhost_copy_from_user(struct vhost_virtqueue *vq, void *to,
753
				void __user *from, unsigned size)
754
{
J
Jason Wang 已提交
755 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
	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,
787
				     void __user *addr, unsigned size)
J
Jason Wang 已提交
788 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
{
	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;

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

J
Jason Wang 已提交
929 930 931 932 933 934 935 936 937
	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;
}

938 939
static int vhost_process_iotlb_msg(struct vhost_dev *dev,
				   struct vhost_iotlb_msg *msg)
J
Jason Wang 已提交
940 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
{
	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;
1089 1090
}

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

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

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

J
Jason Wang 已提交
1106 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
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);

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

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

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

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

J
Jason Wang 已提交
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204
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;
}

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

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

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

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

	for (region = newmem->regions;
	     region < newmem->regions + mem.nregions;
	     region++) {
J
Jason Wang 已提交
1239 1240 1241 1242 1243 1244 1245
		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))
1246
			goto err;
1247
	}
1248 1249 1250 1251 1252 1253

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

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

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

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

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

1272
long vhost_vring_ioctl(struct vhost_dev *d, int ioctl, void __user *argp)
1273
{
1274 1275
	struct file *eventfp, *filep = NULL;
	bool pollstart = false, pollstop = false;
1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287
	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;
1288
	if (idx >= d->nvqs)
1289 1290
		return -ENOBUFS;

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

	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;
		}
1303 1304
		if (copy_from_user(&s, argp, sizeof s)) {
			r = -EFAULT;
1305
			break;
1306
		}
1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319
		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;
		}
1320 1321
		if (copy_from_user(&s, argp, sizeof s)) {
			r = -EFAULT;
1322
			break;
1323
		}
1324 1325 1326 1327
		if (s.num > 0xffff) {
			r = -EINVAL;
			break;
		}
1328
		vq->last_avail_idx = vq->last_used_event = s.num;
1329 1330 1331 1332 1333 1334
		/* 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;
1335 1336
		if (copy_to_user(argp, &s, sizeof s))
			r = -EFAULT;
1337 1338
		break;
	case VHOST_SET_VRING_ADDR:
1339 1340
		if (copy_from_user(&a, argp, sizeof a)) {
			r = -EFAULT;
1341
			break;
1342
		}
1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354
		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;
		}
1355 1356 1357 1358 1359 1360

		/* 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)) ||
1361
		    (a.log_guest_addr & (VRING_USED_ALIGN_SIZE - 1))) {
1362 1363 1364 1365 1366 1367 1368 1369
			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) {
1370
			if (!vq_access_ok(vq, vq->num,
1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394
				(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:
1395 1396
		if (copy_from_user(&f, argp, sizeof f)) {
			r = -EFAULT;
1397
			break;
1398
		}
1399
		eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
1400 1401 1402 1403
		if (IS_ERR(eventfp)) {
			r = PTR_ERR(eventfp);
			break;
		}
1404
		if (eventfp != vq->kick) {
1405 1406
			pollstop = (filep = vq->kick) != NULL;
			pollstart = (vq->kick = eventfp) != NULL;
1407 1408 1409 1410
		} else
			filep = eventfp;
		break;
	case VHOST_SET_VRING_CALL:
1411 1412
		if (copy_from_user(&f, argp, sizeof f)) {
			r = -EFAULT;
1413
			break;
1414
		}
1415
		eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
1416 1417 1418 1419
		if (IS_ERR(eventfp)) {
			r = PTR_ERR(eventfp);
			break;
		}
1420 1421 1422 1423 1424 1425 1426 1427 1428 1429
		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:
1430 1431
		if (copy_from_user(&f, argp, sizeof f)) {
			r = -EFAULT;
1432
			break;
1433
		}
1434
		eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
1435 1436 1437 1438
		if (IS_ERR(eventfp)) {
			r = PTR_ERR(eventfp);
			break;
		}
1439 1440 1441 1442 1443 1444 1445 1446 1447
		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;
1448 1449 1450 1451 1452 1453
	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 已提交
1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466
	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;
1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479
	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)
1480
		r = vhost_poll_start(&vq->poll, vq->kick);
1481 1482 1483 1484 1485 1486 1487

	mutex_unlock(&vq->mutex);

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

J
Jason Wang 已提交
1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513
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);

1514
/* Caller must have device mutex */
1515
long vhost_dev_ioctl(struct vhost_dev *d, unsigned int ioctl, void __user *argp)
1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538
{
	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:
1539 1540
		if (copy_from_user(&p, argp, sizeof p)) {
			r = -EFAULT;
1541
			break;
1542
		}
1543 1544 1545 1546 1547 1548 1549
		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;
1550
			vq = d->vqs[i];
1551 1552
			mutex_lock(&vq->mutex);
			/* If ring is inactive, will check when it's enabled. */
1553
			if (vq->private_data && !vq_log_access_ok(vq, base))
1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570
				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;
1571
			d->log_file = eventfp;
1572 1573 1574 1575 1576 1577
			ctx = d->log_ctx;
			d->log_ctx = eventfp ?
				eventfd_ctx_fileget(eventfp) : NULL;
		} else
			filep = eventfp;
		for (i = 0; i < d->nvqs; ++i) {
1578 1579 1580
			mutex_lock(&d->vqs[i]->mutex);
			d->vqs[i]->log_ctx = d->log_ctx;
			mutex_unlock(&d->vqs[i]->mutex);
1581 1582 1583 1584 1585 1586 1587
		}
		if (ctx)
			eventfd_ctx_put(ctx);
		if (filep)
			fput(filep);
		break;
	default:
1588
		r = -ENOIOCTLCMD;
1589 1590 1591 1592 1593
		break;
	}
done:
	return r;
}
A
Asias He 已提交
1594
EXPORT_SYMBOL_GPL(vhost_dev_ioctl);
1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606

/* 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 已提交
1607

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

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

1626 1627
	if (!write_length)
		return 0;
1628
	write_length += write_address % VHOST_PAGE_SIZE;
1629 1630
	for (;;) {
		u64 base = (u64)(unsigned long)log_base;
1631 1632
		u64 log = base + write_page / 8;
		int bit = write_page % 8;
1633 1634 1635 1636 1637 1638 1639 1640
		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;
1641
		write_page += 1;
1642 1643 1644 1645 1646 1647 1648 1649 1650 1651
	}
	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. */
1652
	smp_wmb();
1653 1654 1655 1656 1657 1658
	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;
1659 1660 1661
		if (!len) {
			if (vq->log_ctx)
				eventfd_signal(vq->log_ctx, 1);
1662
			return 0;
1663
		}
1664 1665 1666 1667 1668
	}
	/* Length written exceeds what we have stored. This is a bug. */
	BUG();
	return 0;
}
A
Asias He 已提交
1669
EXPORT_SYMBOL_GPL(vhost_log_write);
1670

1671 1672 1673
static int vhost_update_used_flags(struct vhost_virtqueue *vq)
{
	void __user *used;
1674 1675
	if (vhost_put_user(vq, cpu_to_vhost16(vq, vq->used_flags),
			   &vq->used->flags) < 0)
1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692
		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)
{
1693 1694
	if (vhost_put_user(vq, cpu_to_vhost16(vq, vq->avail_idx),
			   vhost_avail_event(vq)))
1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710
		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 已提交
1711
int vhost_vq_init_access(struct vhost_virtqueue *vq)
1712
{
1713
	__virtio16 last_used_idx;
1714
	int r;
1715 1716
	bool is_le = vq->is_le;

1717
	if (!vq->private_data) {
G
Greg Kurz 已提交
1718
		vhost_reset_is_le(vq);
1719
		return 0;
1720 1721 1722
	}

	vhost_init_is_le(vq);
1723 1724 1725

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

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

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

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

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

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

J
Jason Wang 已提交
1789 1790
	if (ret == -EAGAIN)
		vhost_iotlb_miss(vq, addr, access);
1791 1792 1793 1794 1795 1796
	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. */
1797
static unsigned next_desc(struct vhost_virtqueue *vq, struct vring_desc *desc)
1798 1799 1800 1801
{
	unsigned int next;

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

	/* Check they're not leading us off end of descriptors. */
1806
	next = vhost16_to_cpu(vq, desc->next);
1807 1808 1809 1810 1811 1812 1813 1814
	/* 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;
}

1815
static int get_indirect(struct vhost_virtqueue *vq,
1816 1817 1818 1819
			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)
1820 1821 1822
{
	struct vring_desc desc;
	unsigned int i = 0, count, found = 0;
1823
	u32 len = vhost32_to_cpu(vq, indirect->len);
1824
	struct iov_iter from;
J
Jason Wang 已提交
1825
	int ret, access;
1826 1827

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

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

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

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

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

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

1882 1883
		ret = translate_desc(vq, vhost64_to_cpu(vq, desc.addr),
				     vhost32_to_cpu(vq, desc.len), iov + iov_count,
J
Jason Wang 已提交
1884
				     iov_size - iov_count, access);
1885
		if (unlikely(ret < 0)) {
J
Jason Wang 已提交
1886 1887 1888
			if (ret != -EAGAIN)
				vq_err(vq, "Translation failure %d indirect idx %d\n",
					ret, i);
1889 1890 1891
			return ret;
		}
		/* If this is an input descriptor, increment that count. */
J
Jason Wang 已提交
1892
		if (access == VHOST_ACCESS_WO) {
1893 1894
			*in_num += ret;
			if (unlikely(log)) {
1895 1896
				log[*log_num].addr = vhost64_to_cpu(vq, desc.addr);
				log[*log_num].len = vhost32_to_cpu(vq, desc.len);
1897 1898 1899 1900 1901
				++*log_num;
			}
		} else {
			/* If it's an output descriptor, they're all supposed
			 * to come before any input descriptors. */
1902
			if (unlikely(*in_num)) {
1903 1904 1905 1906 1907 1908
				vq_err(vq, "Indirect descriptor "
				       "has out after in: idx %d\n", i);
				return -EINVAL;
			}
			*out_num += ret;
		}
1909
	} while ((i = next_desc(vq, &desc)) != -1);
1910 1911 1912 1913 1914 1915 1916 1917
	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.
 *
1918 1919 1920
 * 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. */
1921
int vhost_get_vq_desc(struct vhost_virtqueue *vq,
1922 1923 1924
		      struct iovec iov[], unsigned int iov_size,
		      unsigned int *out_num, unsigned int *in_num,
		      struct vhost_log *log, unsigned int *log_num)
1925 1926 1927 1928
{
	struct vring_desc desc;
	unsigned int i, head, found = 0;
	u16 last_avail_idx;
1929 1930
	__virtio16 avail_idx;
	__virtio16 ring_head;
J
Jason Wang 已提交
1931
	int ret, access;
1932 1933 1934

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

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

	/* 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. */
1953
	smp_rmb();
1954 1955 1956

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

1965 1966
	head = vhost16_to_cpu(vq, ring_head);

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

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

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

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

	/* 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));
2053 2054
	return head;
}
A
Asias He 已提交
2055
EXPORT_SYMBOL_GPL(vhost_get_vq_desc);
2056 2057

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

/* 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)
{
2068 2069 2070 2071
	struct vring_used_elem heads = {
		cpu_to_vhost32(vq, head),
		cpu_to_vhost32(vq, len)
	};
2072

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

2077 2078 2079 2080 2081
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 已提交
2082
	u16 old, new;
2083 2084
	int start;

2085
	start = vq->last_used_idx & (vq->num - 1);
2086
	used = vq->used->ring + start;
2087
	if (count == 1) {
2088
		if (vhost_put_user(vq, heads[0].id, &used->id)) {
2089 2090 2091
			vq_err(vq, "Failed to write used id");
			return -EFAULT;
		}
2092
		if (vhost_put_user(vq, heads[0].len, &used->len)) {
2093 2094 2095
			vq_err(vq, "Failed to write used len");
			return -EFAULT;
		}
2096
	} else if (vhost_copy_to_user(vq, used, heads, count * sizeof *used)) {
2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108
		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 已提交
2109 2110 2111 2112 2113 2114 2115 2116
	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;
2117 2118 2119 2120 2121 2122 2123 2124 2125 2126
	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;

2127
	start = vq->last_used_idx & (vq->num - 1);
2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139
	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();
2140 2141
	if (vhost_put_user(vq, cpu_to_vhost16(vq, vq->last_used_idx),
			   &vq->used->idx)) {
2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154
		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 已提交
2155
EXPORT_SYMBOL_GPL(vhost_add_used_n);
2156

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

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

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

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

2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199
	/* 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();

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

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

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

/* 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 已提交
2226
EXPORT_SYMBOL_GPL(vhost_add_used_and_signal);
2227

2228 2229 2230 2231 2232 2233 2234 2235
/* 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 已提交
2236
EXPORT_SYMBOL_GPL(vhost_add_used_and_signal_n);
2237

2238 2239 2240 2241 2242 2243
/* 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;

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

	return vhost16_to_cpu(vq, avail_idx) == vq->avail_idx;
}
EXPORT_SYMBOL_GPL(vhost_vq_avail_empty);

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

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

2286
	return vhost16_to_cpu(vq, avail_idx) != vq->avail_idx;
2287
}
A
Asias He 已提交
2288
EXPORT_SYMBOL_GPL(vhost_enable_notify);
2289 2290

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

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

J
Jason Wang 已提交
2307 2308 2309 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
/* 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 已提交
2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363
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");