vhost.c 57.5 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/sched/signal.h>
32
#include <linux/interval_tree_generic.h>
33 34 35

#include "vhost.h"

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

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

49 50
#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 已提交
51

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

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

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

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

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

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)
{
135 136
	vq->is_le = vhost_has_feature(vq, VIRTIO_F_VERSION_1)
		|| virtio_legacy_is_little_endian();
137 138 139
}
#endif /* CONFIG_VHOST_CROSS_ENDIAN_LEGACY */

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

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

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

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

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

A
Al Viro 已提交
173
	if (!(key_to_poll(key) & poll->mask))
174 175
		return 0;

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

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

187
/* Init poll structure */
188
void vhost_poll_init(struct vhost_poll *poll, vhost_work_fn_t fn,
A
Al Viro 已提交
189
		     __poll_t 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
	__poll_t mask;
206
	int ret = 0;
K
Krishna Kumar 已提交
207

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

211 212
	mask = file->f_op->poll(file, &poll->table);
	if (mask)
A
Al Viro 已提交
213
		vhost_poll_wakeup(&poll->wait, 0, 0, poll_to_key(mask));
214
	if (mask & EPOLLERR) {
215
		vhost_poll_stop(poll);
216 217 218 219
		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 293 294 295 296 297 298 299 300
static void __vhost_vq_meta_reset(struct vhost_virtqueue *vq)
{
	int j;

	for (j = 0; j < VHOST_NUM_ADDRS; j++)
		vq->meta_iotlb[j] = NULL;
}

static void vhost_vq_meta_reset(struct vhost_dev *d)
{
	int i;

	for (i = 0; i < d->nvqs; ++i)
		__vhost_vq_meta_reset(d->vqs[i]);
}

301 302 303 304 305 306 307 308 309 310
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;
	vq->avail_idx = 0;
	vq->last_used_idx = 0;
M
Michael S. Tsirkin 已提交
311 312
	vq->signalled_used = 0;
	vq->signalled_used_valid = false;
313 314 315 316
	vq->used_flags = 0;
	vq->log_used = false;
	vq->log_addr = -1ull;
	vq->private_data = NULL;
317
	vq->acked_features = 0;
318 319 320 321
	vq->log_base = NULL;
	vq->error_ctx = NULL;
	vq->kick = NULL;
	vq->call_ctx = NULL;
322
	vq->log_ctx = NULL;
G
Greg Kurz 已提交
323 324
	vhost_reset_is_le(vq);
	vhost_disable_cross_endian(vq);
J
Jason Wang 已提交
325
	vq->busyloop_timeout = 0;
326
	vq->umem = NULL;
J
Jason Wang 已提交
327
	vq->iotlb = NULL;
328
	__vhost_vq_meta_reset(vq);
329 330
}

331 332 333
static int vhost_worker(void *data)
{
	struct vhost_dev *dev = data;
J
Jason Wang 已提交
334 335
	struct vhost_work *work, *work_next;
	struct llist_node *node;
336
	mm_segment_t oldfs = get_fs();
337

338
	set_fs(USER_DS);
M
Michael S. Tsirkin 已提交
339 340
	use_mm(dev->mm);

341 342 343 344 345 346
	for (;;) {
		/* mb paired w/ kthread_stop */
		set_current_state(TASK_INTERRUPTIBLE);

		if (kthread_should_stop()) {
			__set_current_state(TASK_RUNNING);
M
Michael S. Tsirkin 已提交
347
			break;
348
		}
J
Jason Wang 已提交
349 350 351 352 353 354 355 356 357 358

		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);
359 360
			__set_current_state(TASK_RUNNING);
			work->fn(work);
N
Nadav Har'El 已提交
361 362
			if (need_resched())
				schedule();
J
Jason Wang 已提交
363
		}
364
	}
M
Michael S. Tsirkin 已提交
365
	unuse_mm(dev->mm);
366
	set_fs(oldfs);
M
Michael S. Tsirkin 已提交
367
	return 0;
368 369
}

370 371 372 373 374 375 376 377 378 379
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 已提交
380 381 382
/* Helper to allocate iovec buffers for all vqs. */
static long vhost_dev_alloc_iovecs(struct vhost_dev *dev)
{
A
Asias He 已提交
383
	struct vhost_virtqueue *vq;
J
Jason Wang 已提交
384
	int i;
K
Krishna Kumar 已提交
385

J
Jason Wang 已提交
386
	for (i = 0; i < dev->nvqs; ++i) {
A
Asias He 已提交
387 388 389 390 391 392
		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 已提交
393 394 395
			goto err_nomem;
	}
	return 0;
K
Krishna Kumar 已提交
396

J
Jason Wang 已提交
397
err_nomem:
398
	for (; i >= 0; --i)
399
		vhost_vq_free_iovecs(dev->vqs[i]);
J
Jason Wang 已提交
400 401 402 403 404 405
	return -ENOMEM;
}

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

407
	for (i = 0; i < dev->nvqs; ++i)
408
		vhost_vq_free_iovecs(dev->vqs[i]);
J
Jason Wang 已提交
409 410
}

Z
Zhi Yong Wu 已提交
411
void vhost_dev_init(struct vhost_dev *dev,
412
		    struct vhost_virtqueue **vqs, int nvqs)
413
{
A
Asias He 已提交
414
	struct vhost_virtqueue *vq;
415
	int i;
416

417 418 419 420
	dev->vqs = vqs;
	dev->nvqs = nvqs;
	mutex_init(&dev->mutex);
	dev->log_ctx = NULL;
421
	dev->umem = NULL;
J
Jason Wang 已提交
422
	dev->iotlb = NULL;
423
	dev->mm = NULL;
424
	dev->worker = NULL;
J
Jason Wang 已提交
425
	init_llist_head(&dev->work_list);
J
Jason Wang 已提交
426 427 428 429
	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 已提交
430

431 432

	for (i = 0; i < dev->nvqs; ++i) {
A
Asias He 已提交
433 434 435 436 437 438 439 440 441
		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,
442
					EPOLLIN, dev);
443 444
	}
}
A
Asias He 已提交
445
EXPORT_SYMBOL_GPL(vhost_dev_init);
446 447 448 449 450 451 452

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

455
struct vhost_attach_cgroups_struct {
K
Krishna Kumar 已提交
456 457 458
	struct vhost_work work;
	struct task_struct *owner;
	int ret;
459 460 461 462
};

static void vhost_attach_cgroups_work(struct vhost_work *work)
{
K
Krishna Kumar 已提交
463 464 465 466
	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);
467 468 469 470
}

static int vhost_attach_cgroups(struct vhost_dev *dev)
{
K
Krishna Kumar 已提交
471 472 473 474 475 476 477
	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;
478 479
}

480 481 482 483 484
/* Caller should have device mutex */
bool vhost_dev_has_owner(struct vhost_dev *dev)
{
	return dev->mm;
}
A
Asias He 已提交
485
EXPORT_SYMBOL_GPL(vhost_dev_has_owner);
486

487
/* Caller should have device mutex */
A
Asias He 已提交
488
long vhost_dev_set_owner(struct vhost_dev *dev)
489
{
490 491
	struct task_struct *worker;
	int err;
K
Krishna Kumar 已提交
492

493
	/* Is there an owner already? */
494
	if (vhost_dev_has_owner(dev)) {
495 496 497
		err = -EBUSY;
		goto err_mm;
	}
K
Krishna Kumar 已提交
498

499 500
	/* No owner, become one */
	dev->mm = get_task_mm(current);
501 502 503 504 505 506 507
	worker = kthread_create(vhost_worker, dev, "vhost-%d", current->pid);
	if (IS_ERR(worker)) {
		err = PTR_ERR(worker);
		goto err_worker;
	}

	dev->worker = worker;
508 509 510
	wake_up_process(worker);	/* avoid contributing to loadavg */

	err = vhost_attach_cgroups(dev);
511 512
	if (err)
		goto err_cgroup;
513

J
Jason Wang 已提交
514 515 516 517
	err = vhost_dev_alloc_iovecs(dev);
	if (err)
		goto err_cgroup;

518
	return 0;
519 520
err_cgroup:
	kthread_stop(worker);
M
Michael S. Tsirkin 已提交
521
	dev->worker = NULL;
522 523 524 525 526 527
err_worker:
	if (dev->mm)
		mmput(dev->mm);
	dev->mm = NULL;
err_mm:
	return err;
528
}
A
Asias He 已提交
529
EXPORT_SYMBOL_GPL(vhost_dev_set_owner);
530

531 532
struct vhost_umem *vhost_dev_reset_owner_prepare(void)
{
533
	return kvzalloc(sizeof(struct vhost_umem), GFP_KERNEL);
534
}
A
Asias He 已提交
535
EXPORT_SYMBOL_GPL(vhost_dev_reset_owner_prepare);
536

537
/* Caller should have device mutex */
538
void vhost_dev_reset_owner(struct vhost_dev *dev, struct vhost_umem *umem)
539
{
540 541
	int i;

542
	vhost_dev_cleanup(dev);
543

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

555
void vhost_dev_stop(struct vhost_dev *dev)
556 557
{
	int i;
558 559

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

J
Jason Wang 已提交
568 569 570 571 572 573 574 575 576
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--;
}

577 578 579 580 581 582 583
static void vhost_umem_clean(struct vhost_umem *umem)
{
	struct vhost_umem_node *node, *tmp;

	if (!umem)
		return;

J
Jason Wang 已提交
584 585 586
	list_for_each_entry_safe(node, tmp, &umem->umem_list, link)
		vhost_umem_free(umem, node);

587 588 589
	kvfree(umem);
}

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

609
void vhost_dev_cleanup(struct vhost_dev *dev)
610 611
{
	int i;
K
Krishna Kumar 已提交
612

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

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

648 649 650
	/* Make sure 64 bit math will not overflow. */
	if (a > ULONG_MAX - (unsigned long)log_base ||
	    a + (unsigned long)log_base > ULONG_MAX)
651
		return 0;
652 653 654 655 656

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

657 658 659 660 661 662
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;
}

663
/* Caller should have vq mutex and device mutex. */
664
static int vq_memory_access_ok(void __user *log_base, struct vhost_umem *umem,
665 666
			       int log_all)
{
667
	struct vhost_umem_node *node;
668

669
	if (!umem)
M
Michael S. Tsirkin 已提交
670
		return 0;
671

672 673 674
	list_for_each_entry(node, &umem->umem_list, link) {
		unsigned long a = node->userspace_addr;

675
		if (vhost_overflow(node->userspace_addr, node->size))
676
			return 0;
677 678 679


		if (!access_ok(VERIFY_WRITE, (void __user *)a,
680
				    node->size))
681 682
			return 0;
		else if (log_all && !log_access_ok(log_base,
683 684
						   node->start,
						   node->size))
685 686 687 688 689
			return 0;
	}
	return 1;
}

690 691 692 693 694 695 696 697 698 699 700 701
static inline void __user *vhost_vq_meta_fetch(struct vhost_virtqueue *vq,
					       u64 addr, unsigned int size,
					       int type)
{
	const struct vhost_umem_node *node = vq->meta_iotlb[type];

	if (!node)
		return NULL;

	return (void *)(uintptr_t)(node->userspace_addr + addr - node->start);
}

702 703
/* Can we switch to this memory table? */
/* Caller should have device mutex but not vq mutex */
704
static int memory_access_ok(struct vhost_dev *d, struct vhost_umem *umem,
705 706 707
			    int log_all)
{
	int i;
K
Krishna Kumar 已提交
708

709 710
	for (i = 0; i < d->nvqs; ++i) {
		int ok;
711 712
		bool log;

713
		mutex_lock(&d->vqs[i]->mutex);
714
		log = log_all || vhost_has_feature(d->vqs[i], VHOST_F_LOG_ALL);
715
		/* If ring is inactive, will check when it's enabled. */
716
		if (d->vqs[i]->private_data)
717 718
			ok = vq_memory_access_ok(d->vqs[i]->log_base,
						 umem, log);
719 720
		else
			ok = 1;
721
		mutex_unlock(&d->vqs[i]->mutex);
722 723 724 725 726 727
		if (!ok)
			return 0;
	}
	return 1;
}

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

731
static int vhost_copy_to_user(struct vhost_virtqueue *vq, void __user *to,
732 733
			      const void *from, unsigned size)
{
J
Jason Wang 已提交
734
	int ret;
735

J
Jason Wang 已提交
736 737 738 739 740 741 742 743 744
	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.
		 */
		struct iov_iter t;
745 746 747 748 749 750 751
		void __user *uaddr = vhost_vq_meta_fetch(vq,
				     (u64)(uintptr_t)to, size,
				     VHOST_ADDR_DESC);

		if (uaddr)
			return __copy_to_user(uaddr, from, size);

J
Jason Wang 已提交
752 753 754 755 756 757 758 759 760 761 762 763 764
		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;
}
765 766

static int vhost_copy_from_user(struct vhost_virtqueue *vq, void *to,
767
				void __user *from, unsigned size)
768
{
J
Jason Wang 已提交
769 770 771 772 773 774 775 776 777 778
	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.
		 */
779 780 781
		void __user *uaddr = vhost_vq_meta_fetch(vq,
				     (u64)(uintptr_t)from, size,
				     VHOST_ADDR_DESC);
J
Jason Wang 已提交
782
		struct iov_iter f;
783 784 785 786

		if (uaddr)
			return __copy_from_user(to, uaddr, size);

J
Jason Wang 已提交
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
		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;
}

806 807 808
static void __user *__vhost_get_user_slow(struct vhost_virtqueue *vq,
					  void __user *addr, unsigned int size,
					  int type)
J
Jason Wang 已提交
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
{
	int ret;

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

832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849
/* 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.
 */
static inline void __user *__vhost_get_user(struct vhost_virtqueue *vq,
					    void *addr, unsigned int size,
					    int type)
{
	void __user *uaddr = vhost_vq_meta_fetch(vq,
			     (u64)(uintptr_t)addr, size, type);
	if (uaddr)
		return uaddr;

	return __vhost_get_user_slow(vq, addr, size, type);
}

#define vhost_put_user(vq, x, ptr)		\
J
Jason Wang 已提交
850 851 852 853 854 855
({ \
	int ret = -EFAULT; \
	if (!vq->iotlb) { \
		ret = __put_user(x, ptr); \
	} else { \
		__typeof__(ptr) to = \
856 857
			(__typeof__(ptr)) __vhost_get_user(vq, ptr,	\
					  sizeof(*ptr), VHOST_ADDR_USED); \
J
Jason Wang 已提交
858 859 860 861 862 863 864 865
		if (to != NULL) \
			ret = __put_user(x, to); \
		else \
			ret = -EFAULT;	\
	} \
	ret; \
})

866
#define vhost_get_user(vq, x, ptr, type)		\
J
Jason Wang 已提交
867 868 869 870 871 872
({ \
	int ret; \
	if (!vq->iotlb) { \
		ret = __get_user(x, ptr); \
	} else { \
		__typeof__(ptr) from = \
873 874 875
			(__typeof__(ptr)) __vhost_get_user(vq, ptr, \
							   sizeof(*ptr), \
							   type); \
J
Jason Wang 已提交
876 877 878 879 880 881 882 883
		if (from != NULL) \
			ret = __get_user(x, from); \
		else \
			ret = -EFAULT; \
	} \
	ret; \
})

884 885 886 887 888 889
#define vhost_get_avail(vq, x, ptr) \
	vhost_get_user(vq, x, ptr, VHOST_ADDR_AVAIL)

#define vhost_get_used(vq, x, ptr) \
	vhost_get_user(vq, x, ptr, VHOST_ADDR_USED)

J
Jason Wang 已提交
890 891 892 893
static void vhost_dev_lock_vqs(struct vhost_dev *d)
{
	int i = 0;
	for (i = 0; i < d->nvqs; ++i)
894
		mutex_lock_nested(&d->vqs[i]->mutex, i);
J
Jason Wang 已提交
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 926 927 928 929 930 931 932 933 934 935 936 937 938 939 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
}

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;

966 967 968 969
	/* Make sure 64 bit math will not overflow. */
	if (vhost_overflow(uaddr, size))
		return -EFAULT;

J
Jason Wang 已提交
970 971 972 973 974 975 976 977 978
	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;
}

979 980
static int vhost_process_iotlb_msg(struct vhost_dev *dev,
				   struct vhost_iotlb_msg *msg)
J
Jason Wang 已提交
981 982 983 984 985 986 987 988 989 990 991 992 993 994
{
	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;
		}
995
		vhost_vq_meta_reset(dev);
J
Jason Wang 已提交
996 997 998 999 1000 1001 1002 1003 1004
		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:
1005 1006 1007 1008
		if (!dev->iotlb) {
			ret = -EFAULT;
			break;
		}
1009
		vhost_vq_meta_reset(dev);
J
Jason Wang 已提交
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
		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);

1051
__poll_t vhost_chr_poll(struct file *file, struct vhost_dev *dev,
J
Jason Wang 已提交
1052 1053
			    poll_table *wait)
{
1054
	__poll_t mask = 0;
J
Jason Wang 已提交
1055 1056 1057 1058

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

	if (!list_empty(&dev->read_list))
1059
		mask |= EPOLLIN | EPOLLRDNORM;
J
Jason Wang 已提交
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 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 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

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

1138
static int vq_access_ok(struct vhost_virtqueue *vq, unsigned int num,
1139 1140 1141
			struct vring_desc __user *desc,
			struct vring_avail __user *avail,
			struct vring_used __user *used)
J
Jason Wang 已提交
1142

1143
{
1144
	size_t s = vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
J
Jason Wang 已提交
1145

1146 1147
	return access_ok(VERIFY_READ, desc, num * sizeof *desc) &&
	       access_ok(VERIFY_READ, avail,
M
Michael S. Tsirkin 已提交
1148
			 sizeof *avail + num * sizeof *avail->ring + s) &&
1149
	       access_ok(VERIFY_WRITE, used,
M
Michael S. Tsirkin 已提交
1150
			sizeof *used + num * sizeof *used->ring + s);
1151 1152
}

1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163
static void vhost_vq_meta_update(struct vhost_virtqueue *vq,
				 const struct vhost_umem_node *node,
				 int type)
{
	int access = (type == VHOST_ADDR_USED) ?
		     VHOST_ACCESS_WO : VHOST_ACCESS_RO;

	if (likely(node->perm & access))
		vq->meta_iotlb[type] = node;
}

J
Jason Wang 已提交
1164
static int iotlb_access_ok(struct vhost_virtqueue *vq,
1165
			   int access, u64 addr, u64 len, int type)
J
Jason Wang 已提交
1166 1167 1168
{
	const struct vhost_umem_node *node;
	struct vhost_umem *umem = vq->iotlb;
1169
	u64 s = 0, size, orig_addr = addr, last = addr + len - 1;
1170 1171 1172

	if (vhost_vq_meta_fetch(vq, addr, len, type))
		return true;
J
Jason Wang 已提交
1173 1174 1175 1176

	while (len > s) {
		node = vhost_umem_interval_tree_iter_first(&umem->umem_tree,
							   addr,
1177
							   last);
J
Jason Wang 已提交
1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188
		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;
1189 1190 1191 1192

		if (orig_addr == addr && size >= len)
			vhost_vq_meta_update(vq, node, type);

J
Jason Wang 已提交
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208
		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,
1209
			       num * sizeof(*vq->desc), VHOST_ADDR_DESC) &&
J
Jason Wang 已提交
1210 1211
	       iotlb_access_ok(vq, VHOST_ACCESS_RO, (u64)(uintptr_t)vq->avail,
			       sizeof *vq->avail +
1212 1213
			       num * sizeof(*vq->avail->ring) + s,
			       VHOST_ADDR_AVAIL) &&
J
Jason Wang 已提交
1214 1215
	       iotlb_access_ok(vq, VHOST_ACCESS_WO, (u64)(uintptr_t)vq->used,
			       sizeof *vq->used +
1216 1217
			       num * sizeof(*vq->used->ring) + s,
			       VHOST_ADDR_USED);
J
Jason Wang 已提交
1218 1219 1220
}
EXPORT_SYMBOL_GPL(vq_iotlb_prefetch);

1221 1222 1223 1224
/* Can we log writes? */
/* Caller should have device mutex but not vq mutex */
int vhost_log_access_ok(struct vhost_dev *dev)
{
1225
	return memory_access_ok(dev, dev->umem, 1);
1226
}
A
Asias He 已提交
1227
EXPORT_SYMBOL_GPL(vhost_log_access_ok);
1228 1229 1230

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

1236
	return vq_memory_access_ok(log_base, vq->umem,
1237
				   vhost_has_feature(vq, VHOST_F_LOG_ALL)) &&
1238 1239
		(!vq->log_used || log_access_ok(log_base, vq->log_addr,
					sizeof *vq->used +
M
Michael S. Tsirkin 已提交
1240
					vq->num * sizeof *vq->used->ring + s));
1241 1242 1243 1244 1245 1246
}

/* Can we start vq? */
/* Caller should have vq mutex and device mutex */
int vhost_vq_access_ok(struct vhost_virtqueue *vq)
{
1247 1248 1249 1250 1251 1252
	int ret = vq_log_access_ok(vq, vq->log_base);

	if (ret || vq->iotlb)
		return ret;

	return vq_access_ok(vq, vq->num, vq->desc, vq->avail, vq->used);
1253
}
A
Asias He 已提交
1254
EXPORT_SYMBOL_GPL(vhost_vq_access_ok);
1255

J
Jason Wang 已提交
1256 1257
static struct vhost_umem *vhost_umem_alloc(void)
{
1258
	struct vhost_umem *umem = kvzalloc(sizeof(*umem), GFP_KERNEL);
J
Jason Wang 已提交
1259 1260 1261 1262

	if (!umem)
		return NULL;

1263
	umem->umem_tree = RB_ROOT_CACHED;
J
Jason Wang 已提交
1264 1265 1266 1267 1268 1269
	umem->numem = 0;
	INIT_LIST_HEAD(&umem->umem_list);

	return umem;
}

1270 1271
static long vhost_set_memory(struct vhost_dev *d, struct vhost_memory __user *m)
{
1272 1273 1274
	struct vhost_memory mem, *newmem;
	struct vhost_memory_region *region;
	struct vhost_umem *newumem, *oldumem;
1275
	unsigned long size = offsetof(struct vhost_memory, regions);
1276
	int i;
K
Krishna Kumar 已提交
1277

1278 1279
	if (copy_from_user(&mem, m, size))
		return -EFAULT;
1280 1281
	if (mem.padding)
		return -EOPNOTSUPP;
1282
	if (mem.nregions > max_mem_regions)
1283
		return -E2BIG;
1284
	newmem = kvzalloc(size + mem.nregions * sizeof(*m->regions), GFP_KERNEL);
1285 1286 1287 1288
	if (!newmem)
		return -ENOMEM;

	memcpy(newmem, &mem, size);
1289 1290
	if (copy_from_user(newmem->regions, m->regions,
			   mem.nregions * sizeof *m->regions)) {
1291
		kvfree(newmem);
1292
		return -EFAULT;
1293 1294
	}

J
Jason Wang 已提交
1295
	newumem = vhost_umem_alloc();
1296
	if (!newumem) {
1297
		kvfree(newmem);
1298 1299 1300 1301 1302 1303
		return -ENOMEM;
	}

	for (region = newmem->regions;
	     region < newmem->regions + mem.nregions;
	     region++) {
J
Jason Wang 已提交
1304 1305 1306 1307 1308 1309 1310
		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))
1311
			goto err;
1312
	}
1313 1314 1315 1316 1317 1318

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

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

1320
	/* All memory accesses are done under some VQ mutex. */
1321 1322
	for (i = 0; i < d->nvqs; ++i) {
		mutex_lock(&d->vqs[i]->mutex);
1323
		d->vqs[i]->umem = newumem;
1324 1325
		mutex_unlock(&d->vqs[i]->mutex);
	}
1326 1327 1328

	kvfree(newmem);
	vhost_umem_clean(oldumem);
1329
	return 0;
1330 1331 1332 1333 1334

err:
	vhost_umem_clean(newumem);
	kvfree(newmem);
	return -EFAULT;
1335 1336
}

1337
long vhost_vring_ioctl(struct vhost_dev *d, unsigned int ioctl, void __user *argp)
1338
{
1339 1340
	struct file *eventfp, *filep = NULL;
	bool pollstart = false, pollstop = false;
1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352
	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;
1353
	if (idx >= d->nvqs)
1354 1355
		return -ENOBUFS;

1356
	vq = d->vqs[idx];
1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367

	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;
		}
1368 1369
		if (copy_from_user(&s, argp, sizeof s)) {
			r = -EFAULT;
1370
			break;
1371
		}
1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384
		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;
		}
1385 1386
		if (copy_from_user(&s, argp, sizeof s)) {
			r = -EFAULT;
1387
			break;
1388
		}
1389 1390 1391 1392
		if (s.num > 0xffff) {
			r = -EINVAL;
			break;
		}
1393
		vq->last_avail_idx = s.num;
1394 1395 1396 1397 1398 1399
		/* 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;
1400 1401
		if (copy_to_user(argp, &s, sizeof s))
			r = -EFAULT;
1402 1403
		break;
	case VHOST_SET_VRING_ADDR:
1404 1405
		if (copy_from_user(&a, argp, sizeof a)) {
			r = -EFAULT;
1406
			break;
1407
		}
1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419
		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;
		}
1420 1421 1422 1423 1424 1425

		/* 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)) ||
1426
		    (a.log_guest_addr & (VRING_USED_ALIGN_SIZE - 1))) {
1427 1428 1429 1430 1431 1432 1433 1434
			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) {
1435
			if (!vq_access_ok(vq, vq->num,
1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459
				(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:
1460 1461
		if (copy_from_user(&f, argp, sizeof f)) {
			r = -EFAULT;
1462
			break;
1463
		}
1464
		eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
1465 1466 1467 1468
		if (IS_ERR(eventfp)) {
			r = PTR_ERR(eventfp);
			break;
		}
1469
		if (eventfp != vq->kick) {
1470 1471
			pollstop = (filep = vq->kick) != NULL;
			pollstart = (vq->kick = eventfp) != NULL;
1472 1473 1474 1475
		} else
			filep = eventfp;
		break;
	case VHOST_SET_VRING_CALL:
1476 1477
		if (copy_from_user(&f, argp, sizeof f)) {
			r = -EFAULT;
1478
			break;
1479
		}
1480 1481 1482
		ctx = f.fd == -1 ? NULL : eventfd_ctx_fdget(f.fd);
		if (IS_ERR(ctx)) {
			r = PTR_ERR(ctx);
1483 1484
			break;
		}
1485
		swap(ctx, vq->call_ctx);
1486 1487
		break;
	case VHOST_SET_VRING_ERR:
1488 1489
		if (copy_from_user(&f, argp, sizeof f)) {
			r = -EFAULT;
1490
			break;
1491
		}
1492 1493 1494
		ctx = f.fd == -1 ? NULL : eventfd_ctx_fdget(f.fd);
		if (IS_ERR(ctx)) {
			r = PTR_ERR(ctx);
1495 1496
			break;
		}
1497
		swap(ctx, vq->error_ctx);
1498
		break;
1499 1500 1501 1502 1503 1504
	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 已提交
1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517
	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;
1518 1519 1520 1521 1522 1523 1524
	default:
		r = -ENOIOCTLCMD;
	}

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

1525
	if (!IS_ERR_OR_NULL(ctx))
1526 1527 1528 1529 1530
		eventfd_ctx_put(ctx);
	if (filep)
		fput(filep);

	if (pollstart && vq->handle_kick)
1531
		r = vhost_poll_start(&vq->poll, vq->kick);
1532 1533 1534 1535 1536 1537 1538

	mutex_unlock(&vq->mutex);

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

J
Jason Wang 已提交
1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564
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);

1565
/* Caller must have device mutex */
1566
long vhost_dev_ioctl(struct vhost_dev *d, unsigned int ioctl, void __user *argp)
1567
{
1568
	struct eventfd_ctx *ctx;
1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588
	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:
1589 1590
		if (copy_from_user(&p, argp, sizeof p)) {
			r = -EFAULT;
1591
			break;
1592
		}
1593 1594 1595 1596 1597 1598 1599
		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;
1600
			vq = d->vqs[i];
1601 1602
			mutex_lock(&vq->mutex);
			/* If ring is inactive, will check when it's enabled. */
1603
			if (vq->private_data && !vq_log_access_ok(vq, base))
1604 1605 1606 1607 1608 1609 1610 1611 1612 1613
				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;
1614 1615 1616
		ctx = fd == -1 ? NULL : eventfd_ctx_fdget(fd);
		if (IS_ERR(ctx)) {
			r = PTR_ERR(ctx);
1617 1618
			break;
		}
1619
		swap(ctx, d->log_ctx);
1620
		for (i = 0; i < d->nvqs; ++i) {
1621 1622 1623
			mutex_lock(&d->vqs[i]->mutex);
			d->vqs[i]->log_ctx = d->log_ctx;
			mutex_unlock(&d->vqs[i]->mutex);
1624 1625 1626 1627 1628
		}
		if (ctx)
			eventfd_ctx_put(ctx);
		break;
	default:
1629
		r = -ENOIOCTLCMD;
1630 1631 1632 1633 1634
		break;
	}
done:
	return r;
}
A
Asias He 已提交
1635
EXPORT_SYMBOL_GPL(vhost_dev_ioctl);
1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647

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

1649
	r = get_user_pages_fast(log, 1, 1, &page);
1650
	if (r < 0)
1651
		return r;
1652
	BUG_ON(r != 1);
1653
	base = kmap_atomic(page);
1654
	set_bit(bit, base);
1655
	kunmap_atomic(base);
1656 1657 1658 1659 1660 1661 1662 1663
	set_page_dirty_lock(page);
	put_page(page);
	return 0;
}

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

1667 1668
	if (!write_length)
		return 0;
1669
	write_length += write_address % VHOST_PAGE_SIZE;
1670 1671
	for (;;) {
		u64 base = (u64)(unsigned long)log_base;
1672 1673
		u64 log = base + write_page / 8;
		int bit = write_page % 8;
1674 1675 1676 1677 1678 1679 1680 1681
		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;
1682
		write_page += 1;
1683 1684 1685 1686 1687 1688 1689 1690 1691 1692
	}
	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. */
1693
	smp_wmb();
1694 1695 1696 1697 1698 1699
	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;
1700 1701 1702
		if (!len) {
			if (vq->log_ctx)
				eventfd_signal(vq->log_ctx, 1);
1703
			return 0;
1704
		}
1705 1706 1707 1708 1709
	}
	/* Length written exceeds what we have stored. This is a bug. */
	BUG();
	return 0;
}
A
Asias He 已提交
1710
EXPORT_SYMBOL_GPL(vhost_log_write);
1711

1712 1713 1714
static int vhost_update_used_flags(struct vhost_virtqueue *vq)
{
	void __user *used;
1715 1716
	if (vhost_put_user(vq, cpu_to_vhost16(vq, vq->used_flags),
			   &vq->used->flags) < 0)
1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733
		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)
{
1734 1735
	if (vhost_put_user(vq, cpu_to_vhost16(vq, vq->avail_idx),
			   vhost_avail_event(vq)))
1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751
		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 已提交
1752
int vhost_vq_init_access(struct vhost_virtqueue *vq)
1753
{
1754
	__virtio16 last_used_idx;
1755
	int r;
1756 1757
	bool is_le = vq->is_le;

1758
	if (!vq->private_data)
1759
		return 0;
1760 1761

	vhost_init_is_le(vq);
1762 1763 1764

	r = vhost_update_used_flags(vq);
	if (r)
1765
		goto err;
1766
	vq->signalled_used_valid = false;
J
Jason Wang 已提交
1767 1768
	if (!vq->iotlb &&
	    !access_ok(VERIFY_READ, &vq->used->idx, sizeof vq->used->idx)) {
1769 1770 1771
		r = -EFAULT;
		goto err;
	}
1772
	r = vhost_get_used(vq, last_used_idx, &vq->used->idx);
J
Jason Wang 已提交
1773 1774 1775
	if (r) {
		vq_err(vq, "Can't access used idx at %p\n",
		       &vq->used->idx);
1776
		goto err;
J
Jason Wang 已提交
1777
	}
1778
	vq->last_used_idx = vhost16_to_cpu(vq, last_used_idx);
1779
	return 0;
J
Jason Wang 已提交
1780

1781 1782 1783
err:
	vq->is_le = is_le;
	return r;
1784
}
G
Greg Kurz 已提交
1785
EXPORT_SYMBOL_GPL(vhost_vq_init_access);
1786

1787
static int translate_desc(struct vhost_virtqueue *vq, u64 addr, u32 len,
J
Jason Wang 已提交
1788
			  struct iovec iov[], int iov_size, int access)
1789
{
1790
	const struct vhost_umem_node *node;
J
Jason Wang 已提交
1791 1792
	struct vhost_dev *dev = vq->dev;
	struct vhost_umem *umem = dev->iotlb ? dev->iotlb : dev->umem;
1793 1794 1795 1796 1797 1798
	struct iovec *_iov;
	u64 s = 0;
	int ret = 0;

	while ((u64)len > s) {
		u64 size;
1799
		if (unlikely(ret >= iov_size)) {
1800 1801 1802
			ret = -ENOBUFS;
			break;
		}
J
Jason Wang 已提交
1803

1804 1805 1806
		node = vhost_umem_interval_tree_iter_first(&umem->umem_tree,
							addr, addr + len - 1);
		if (node == NULL || node->start > addr) {
J
Jason Wang 已提交
1807 1808 1809 1810 1811 1812 1813 1814
			if (umem != dev->iotlb) {
				ret = -EFAULT;
				break;
			}
			ret = -EAGAIN;
			break;
		} else if (!(node->perm & access)) {
			ret = -EPERM;
1815 1816
			break;
		}
J
Jason Wang 已提交
1817

1818
		_iov = iov + ret;
1819
		size = node->size - addr + node->start;
1820
		_iov->iov_len = min((u64)len - s, size);
C
Christoph Hellwig 已提交
1821
		_iov->iov_base = (void __user *)(unsigned long)
1822
			(node->userspace_addr + addr - node->start);
1823 1824 1825 1826 1827
		s += size;
		addr += size;
		++ret;
	}

J
Jason Wang 已提交
1828 1829
	if (ret == -EAGAIN)
		vhost_iotlb_miss(vq, addr, access);
1830 1831 1832 1833 1834 1835
	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. */
1836
static unsigned next_desc(struct vhost_virtqueue *vq, struct vring_desc *desc)
1837 1838 1839 1840
{
	unsigned int next;

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

	/* Check they're not leading us off end of descriptors. */
1845
	next = vhost16_to_cpu(vq, READ_ONCE(desc->next));
1846 1847 1848
	return next;
}

1849
static int get_indirect(struct vhost_virtqueue *vq,
1850 1851 1852 1853
			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)
1854 1855 1856
{
	struct vring_desc desc;
	unsigned int i = 0, count, found = 0;
1857
	u32 len = vhost32_to_cpu(vq, indirect->len);
1858
	struct iov_iter from;
J
Jason Wang 已提交
1859
	int ret, access;
1860 1861

	/* Sanity check */
1862
	if (unlikely(len % sizeof desc)) {
1863 1864
		vq_err(vq, "Invalid length in indirect descriptor: "
		       "len 0x%llx not multiple of 0x%zx\n",
1865
		       (unsigned long long)len,
1866 1867 1868 1869
		       sizeof desc);
		return -EINVAL;
	}

1870
	ret = translate_desc(vq, vhost64_to_cpu(vq, indirect->addr), len, vq->indirect,
J
Jason Wang 已提交
1871
			     UIO_MAXIOV, VHOST_ACCESS_RO);
1872
	if (unlikely(ret < 0)) {
J
Jason Wang 已提交
1873 1874
		if (ret != -EAGAIN)
			vq_err(vq, "Translation failure %d in indirect.\n", ret);
1875 1876
		return ret;
	}
1877
	iov_iter_init(&from, READ, vq->indirect, ret, len);
1878 1879 1880 1881 1882

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

1883
	count = len / sizeof desc;
1884 1885
	/* Buffers are chained via a 16 bit next field, so
	 * we can have at most 2^16 of these. */
1886
	if (unlikely(count > USHRT_MAX + 1)) {
1887 1888 1889 1890 1891 1892 1893
		vq_err(vq, "Indirect buffer length too big: %d\n",
		       indirect->len);
		return -E2BIG;
	}

	do {
		unsigned iov_count = *in_num + *out_num;
1894
		if (unlikely(++found > count)) {
1895 1896 1897 1898 1899
			vq_err(vq, "Loop detected: last one at %u "
			       "indirect size %u\n",
			       i, count);
			return -EINVAL;
		}
1900
		if (unlikely(!copy_from_iter_full(&desc, sizeof(desc), &from))) {
1901
			vq_err(vq, "Failed indirect descriptor: idx %d, %zx\n",
1902
			       i, (size_t)vhost64_to_cpu(vq, indirect->addr) + i * sizeof desc);
1903 1904
			return -EINVAL;
		}
1905
		if (unlikely(desc.flags & cpu_to_vhost16(vq, VRING_DESC_F_INDIRECT))) {
1906
			vq_err(vq, "Nested indirect descriptor: idx %d, %zx\n",
1907
			       i, (size_t)vhost64_to_cpu(vq, indirect->addr) + i * sizeof desc);
1908 1909 1910
			return -EINVAL;
		}

J
Jason Wang 已提交
1911 1912 1913 1914 1915
		if (desc.flags & cpu_to_vhost16(vq, VRING_DESC_F_WRITE))
			access = VHOST_ACCESS_WO;
		else
			access = VHOST_ACCESS_RO;

1916 1917
		ret = translate_desc(vq, vhost64_to_cpu(vq, desc.addr),
				     vhost32_to_cpu(vq, desc.len), iov + iov_count,
J
Jason Wang 已提交
1918
				     iov_size - iov_count, access);
1919
		if (unlikely(ret < 0)) {
J
Jason Wang 已提交
1920 1921 1922
			if (ret != -EAGAIN)
				vq_err(vq, "Translation failure %d indirect idx %d\n",
					ret, i);
1923 1924 1925
			return ret;
		}
		/* If this is an input descriptor, increment that count. */
J
Jason Wang 已提交
1926
		if (access == VHOST_ACCESS_WO) {
1927 1928
			*in_num += ret;
			if (unlikely(log)) {
1929 1930
				log[*log_num].addr = vhost64_to_cpu(vq, desc.addr);
				log[*log_num].len = vhost32_to_cpu(vq, desc.len);
1931 1932 1933 1934 1935
				++*log_num;
			}
		} else {
			/* If it's an output descriptor, they're all supposed
			 * to come before any input descriptors. */
1936
			if (unlikely(*in_num)) {
1937 1938 1939 1940 1941 1942
				vq_err(vq, "Indirect descriptor "
				       "has out after in: idx %d\n", i);
				return -EINVAL;
			}
			*out_num += ret;
		}
1943
	} while ((i = next_desc(vq, &desc)) != -1);
1944 1945 1946 1947 1948 1949 1950 1951
	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.
 *
1952 1953 1954
 * 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. */
1955
int vhost_get_vq_desc(struct vhost_virtqueue *vq,
1956 1957 1958
		      struct iovec iov[], unsigned int iov_size,
		      unsigned int *out_num, unsigned int *in_num,
		      struct vhost_log *log, unsigned int *log_num)
1959 1960 1961 1962
{
	struct vring_desc desc;
	unsigned int i, head, found = 0;
	u16 last_avail_idx;
1963 1964
	__virtio16 avail_idx;
	__virtio16 ring_head;
J
Jason Wang 已提交
1965
	int ret, access;
1966 1967 1968 1969

	/* Check it isn't doing very strange things with descriptor numbers. */
	last_avail_idx = vq->last_avail_idx;

1970
	if (vq->avail_idx == vq->last_avail_idx) {
1971
		if (unlikely(vhost_get_avail(vq, avail_idx, &vq->avail->idx))) {
1972 1973 1974 1975 1976
			vq_err(vq, "Failed to access avail idx at %p\n",
				&vq->avail->idx);
			return -EFAULT;
		}
		vq->avail_idx = vhost16_to_cpu(vq, avail_idx);
1977

1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988
		if (unlikely((u16)(vq->avail_idx - last_avail_idx) > vq->num)) {
			vq_err(vq, "Guest moved used index from %u to %u",
				last_avail_idx, vq->avail_idx);
			return -EFAULT;
		}

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

1990 1991 1992 1993 1994
		/* Only get avail ring entries after they have been
		 * exposed by guest.
		 */
		smp_rmb();
	}
1995 1996 1997

	/* Grab the next descriptor number they're advertising, and increment
	 * the index we've seen. */
1998
	if (unlikely(vhost_get_avail(vq, ring_head,
1999
		     &vq->avail->ring[last_avail_idx & (vq->num - 1)]))) {
2000 2001 2002
		vq_err(vq, "Failed to read head: idx %d address %p\n",
		       last_avail_idx,
		       &vq->avail->ring[last_avail_idx % vq->num]);
2003
		return -EFAULT;
2004 2005
	}

2006 2007
	head = vhost16_to_cpu(vq, ring_head);

2008
	/* If their number is silly, that's an error. */
2009
	if (unlikely(head >= vq->num)) {
2010 2011
		vq_err(vq, "Guest says index %u > %u is available",
		       head, vq->num);
2012
		return -EINVAL;
2013 2014 2015 2016 2017 2018 2019 2020 2021 2022
	}

	/* 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;
2023
		if (unlikely(i >= vq->num)) {
2024 2025
			vq_err(vq, "Desc index is %u > %u, head = %u",
			       i, vq->num, head);
2026
			return -EINVAL;
2027
		}
2028
		if (unlikely(++found > vq->num)) {
2029 2030 2031
			vq_err(vq, "Loop detected: last one at %u "
			       "vq size %u head %u\n",
			       i, vq->num, head);
2032
			return -EINVAL;
2033
		}
2034 2035
		ret = vhost_copy_from_user(vq, &desc, vq->desc + i,
					   sizeof desc);
2036
		if (unlikely(ret)) {
2037 2038
			vq_err(vq, "Failed to get descriptor: idx %d addr %p\n",
			       i, vq->desc + i);
2039
			return -EFAULT;
2040
		}
2041
		if (desc.flags & cpu_to_vhost16(vq, VRING_DESC_F_INDIRECT)) {
2042
			ret = get_indirect(vq, iov, iov_size,
2043 2044
					   out_num, in_num,
					   log, log_num, &desc);
2045
			if (unlikely(ret < 0)) {
J
Jason Wang 已提交
2046 2047 2048
				if (ret != -EAGAIN)
					vq_err(vq, "Failure detected "
						"in indirect descriptor at idx %d\n", i);
2049
				return ret;
2050 2051 2052 2053
			}
			continue;
		}

J
Jason Wang 已提交
2054 2055 2056 2057
		if (desc.flags & cpu_to_vhost16(vq, VRING_DESC_F_WRITE))
			access = VHOST_ACCESS_WO;
		else
			access = VHOST_ACCESS_RO;
2058 2059
		ret = translate_desc(vq, vhost64_to_cpu(vq, desc.addr),
				     vhost32_to_cpu(vq, desc.len), iov + iov_count,
J
Jason Wang 已提交
2060
				     iov_size - iov_count, access);
2061
		if (unlikely(ret < 0)) {
J
Jason Wang 已提交
2062 2063 2064
			if (ret != -EAGAIN)
				vq_err(vq, "Translation failure %d descriptor idx %d\n",
					ret, i);
2065
			return ret;
2066
		}
J
Jason Wang 已提交
2067
		if (access == VHOST_ACCESS_WO) {
2068 2069 2070 2071
			/* If this is an input descriptor,
			 * increment that count. */
			*in_num += ret;
			if (unlikely(log)) {
2072 2073
				log[*log_num].addr = vhost64_to_cpu(vq, desc.addr);
				log[*log_num].len = vhost32_to_cpu(vq, desc.len);
2074 2075 2076 2077 2078
				++*log_num;
			}
		} else {
			/* If it's an output descriptor, they're all supposed
			 * to come before any input descriptors. */
2079
			if (unlikely(*in_num)) {
2080 2081
				vq_err(vq, "Descriptor has out after in: "
				       "idx %d\n", i);
2082
				return -EINVAL;
2083 2084 2085
			}
			*out_num += ret;
		}
2086
	} while ((i = next_desc(vq, &desc)) != -1);
2087 2088 2089

	/* On success, increment avail index. */
	vq->last_avail_idx++;
M
Michael S. Tsirkin 已提交
2090 2091 2092 2093

	/* 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));
2094 2095
	return head;
}
A
Asias He 已提交
2096
EXPORT_SYMBOL_GPL(vhost_get_vq_desc);
2097 2098

/* Reverse the effect of vhost_get_vq_desc. Useful for error handling. */
2099
void vhost_discard_vq_desc(struct vhost_virtqueue *vq, int n)
2100
{
2101
	vq->last_avail_idx -= n;
2102
}
A
Asias He 已提交
2103
EXPORT_SYMBOL_GPL(vhost_discard_vq_desc);
2104 2105 2106 2107 2108

/* 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)
{
2109 2110 2111 2112
	struct vring_used_elem heads = {
		cpu_to_vhost32(vq, head),
		cpu_to_vhost32(vq, len)
	};
2113

2114
	return vhost_add_used_n(vq, &heads, 1);
2115
}
A
Asias He 已提交
2116
EXPORT_SYMBOL_GPL(vhost_add_used);
2117

2118 2119 2120 2121 2122
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 已提交
2123
	u16 old, new;
2124 2125
	int start;

2126
	start = vq->last_used_idx & (vq->num - 1);
2127
	used = vq->used->ring + start;
2128
	if (count == 1) {
2129
		if (vhost_put_user(vq, heads[0].id, &used->id)) {
2130 2131 2132
			vq_err(vq, "Failed to write used id");
			return -EFAULT;
		}
2133
		if (vhost_put_user(vq, heads[0].len, &used->len)) {
2134 2135 2136
			vq_err(vq, "Failed to write used len");
			return -EFAULT;
		}
2137
	} else if (vhost_copy_to_user(vq, used, heads, count * sizeof *used)) {
2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149
		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 已提交
2150 2151 2152 2153 2154 2155 2156 2157
	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;
2158 2159 2160 2161 2162 2163 2164 2165 2166 2167
	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;

2168
	start = vq->last_used_idx & (vq->num - 1);
2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180
	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();
2181 2182
	if (vhost_put_user(vq, cpu_to_vhost16(vq, vq->last_used_idx),
			   &vq->used->idx)) {
2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195
		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 已提交
2196
EXPORT_SYMBOL_GPL(vhost_add_used_n);
2197

M
Michael S. Tsirkin 已提交
2198
static bool vhost_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
2199
{
2200 2201
	__u16 old, new;
	__virtio16 event;
M
Michael S. Tsirkin 已提交
2202
	bool v;
2203 2204 2205 2206
	/* Flush out used index updates. This is paired
	 * with the barrier that the Guest executes when enabling
	 * interrupts. */
	smp_mb();
M
Michael S. Tsirkin 已提交
2207

2208
	if (vhost_has_feature(vq, VIRTIO_F_NOTIFY_ON_EMPTY) &&
M
Michael S. Tsirkin 已提交
2209 2210 2211
	    unlikely(vq->avail_idx == vq->last_avail_idx))
		return true;

2212
	if (!vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX)) {
2213
		__virtio16 flags;
2214
		if (vhost_get_avail(vq, flags, &vq->avail->flags)) {
M
Michael S. Tsirkin 已提交
2215 2216 2217
			vq_err(vq, "Failed to get flags");
			return true;
		}
2218
		return !(flags & cpu_to_vhost16(vq, VRING_AVAIL_F_NO_INTERRUPT));
2219
	}
M
Michael S. Tsirkin 已提交
2220 2221 2222 2223
	old = vq->signalled_used;
	v = vq->signalled_used_valid;
	new = vq->signalled_used = vq->last_used_idx;
	vq->signalled_used_valid = true;
2224

M
Michael S. Tsirkin 已提交
2225 2226
	if (unlikely(!v))
		return true;
2227

2228
	if (vhost_get_avail(vq, event, vhost_used_event(vq))) {
M
Michael S. Tsirkin 已提交
2229 2230 2231
		vq_err(vq, "Failed to get used event idx");
		return true;
	}
2232
	return vring_need_event(vhost16_to_cpu(vq, event), new, old);
M
Michael S. Tsirkin 已提交
2233 2234 2235 2236 2237
}

/* This actually signals the guest, using eventfd. */
void vhost_signal(struct vhost_dev *dev, struct vhost_virtqueue *vq)
{
2238
	/* Signal the Guest tell them we used something up. */
M
Michael S. Tsirkin 已提交
2239
	if (vq->call_ctx && vhost_notify(dev, vq))
2240 2241
		eventfd_signal(vq->call_ctx, 1);
}
A
Asias He 已提交
2242
EXPORT_SYMBOL_GPL(vhost_signal);
2243 2244 2245 2246 2247 2248 2249 2250 2251

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

2254 2255 2256 2257 2258 2259 2260 2261
/* 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 已提交
2262
EXPORT_SYMBOL_GPL(vhost_add_used_and_signal_n);
2263

2264 2265 2266 2267 2268 2269
/* 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;

2270 2271 2272
	if (vq->avail_idx != vq->last_avail_idx)
		return false;

2273
	r = vhost_get_avail(vq, avail_idx, &vq->avail->idx);
2274
	if (unlikely(r))
2275
		return false;
2276
	vq->avail_idx = vhost16_to_cpu(vq, avail_idx);
2277

2278
	return vq->avail_idx == vq->last_avail_idx;
2279 2280 2281
}
EXPORT_SYMBOL_GPL(vhost_vq_avail_empty);

2282
/* OK, now we need to know about added descriptors. */
M
Michael S. Tsirkin 已提交
2283
bool vhost_enable_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
2284
{
2285
	__virtio16 avail_idx;
2286
	int r;
K
Krishna Kumar 已提交
2287

2288 2289 2290
	if (!(vq->used_flags & VRING_USED_F_NO_NOTIFY))
		return false;
	vq->used_flags &= ~VRING_USED_F_NO_NOTIFY;
2291
	if (!vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX)) {
2292
		r = vhost_update_used_flags(vq);
M
Michael S. Tsirkin 已提交
2293 2294 2295 2296 2297 2298
		if (r) {
			vq_err(vq, "Failed to enable notification at %p: %d\n",
			       &vq->used->flags, r);
			return false;
		}
	} else {
2299
		r = vhost_update_avail_event(vq, vq->avail_idx);
M
Michael S. Tsirkin 已提交
2300 2301 2302 2303 2304 2305
		if (r) {
			vq_err(vq, "Failed to update avail event index at %p: %d\n",
			       vhost_avail_event(vq), r);
			return false;
		}
	}
2306 2307
	/* They could have slipped one in as we were doing that: make
	 * sure it's written, then check again. */
2308
	smp_mb();
2309
	r = vhost_get_avail(vq, avail_idx, &vq->avail->idx);
2310 2311 2312 2313 2314 2315
	if (r) {
		vq_err(vq, "Failed to check avail idx at %p: %d\n",
		       &vq->avail->idx, r);
		return false;
	}

2316
	return vhost16_to_cpu(vq, avail_idx) != vq->avail_idx;
2317
}
A
Asias He 已提交
2318
EXPORT_SYMBOL_GPL(vhost_enable_notify);
2319 2320

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

2325 2326 2327
	if (vq->used_flags & VRING_USED_F_NO_NOTIFY)
		return;
	vq->used_flags |= VRING_USED_F_NO_NOTIFY;
2328
	if (!vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX)) {
2329
		r = vhost_update_used_flags(vq);
M
Michael S. Tsirkin 已提交
2330 2331 2332 2333
		if (r)
			vq_err(vq, "Failed to enable notification at %p: %d\n",
			       &vq->used->flags, r);
	}
2334
}
A
Asias He 已提交
2335 2336
EXPORT_SYMBOL_GPL(vhost_disable_notify);

J
Jason Wang 已提交
2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355
/* 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);

2356
	wake_up_interruptible_poll(&dev->wait, EPOLLIN | EPOLLRDNORM);
J
Jason Wang 已提交
2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377
}
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 已提交
2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393
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");