vhost.c 57.8 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
static bool log_access_ok(void __user *log_base, u64 addr, unsigned long sz)
645 646
{
	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 false;
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 665
static bool vq_memory_access_ok(void __user *log_base, struct vhost_umem *umem,
				int log_all)
666
{
667
	struct vhost_umem_node *node;
668

669
	if (!umem)
670
		return false;
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 false;
677 678 679


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

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 705
static bool memory_access_ok(struct vhost_dev *d, struct vhost_umem *umem,
			     int log_all)
706 707
{
	int i;
K
Krishna Kumar 已提交
708

709
	for (i = 0; i < d->nvqs; ++i) {
710
		bool 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
		else
720
			ok = true;
721
		mutex_unlock(&d->vqs[i]->mutex);
722
		if (!ok)
723
			return false;
724
	}
725
	return true;
726 727
}

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
		void __user *uaddr = vhost_vq_meta_fetch(vq,
				     (u64)(uintptr_t)to, size,
E
Eric Auger 已提交
747
				     VHOST_ADDR_USED);
748 749 750 751

		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
}

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

962
static bool umem_access_ok(u64 uaddr, u64 size, int access)
J
Jason Wang 已提交
963 964 965
{
	unsigned long a = uaddr;

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

J
Jason Wang 已提交
970 971
	if ((access & VHOST_ACCESS_RO) &&
	    !access_ok(VERIFY_READ, (void __user *)a, size))
972
		return false;
J
Jason Wang 已提交
973 974
	if ((access & VHOST_ACCESS_WO) &&
	    !access_ok(VERIFY_WRITE, (void __user *)a, size))
975 976
		return false;
	return true;
J
Jason Wang 已提交
977 978
}

979 980
static int vhost_process_iotlb_msg(struct vhost_dev *dev,
				   struct vhost_iotlb_msg *msg)
J
Jason Wang 已提交
981 982 983
{
	int ret = 0;

984
	mutex_lock(&dev->mutex);
J
Jason Wang 已提交
985 986 987 988 989 990 991
	vhost_dev_lock_vqs(dev);
	switch (msg->type) {
	case VHOST_IOTLB_UPDATE:
		if (!dev->iotlb) {
			ret = -EFAULT;
			break;
		}
992
		if (!umem_access_ok(msg->uaddr, msg->size, msg->perm)) {
J
Jason Wang 已提交
993 994 995
			ret = -EFAULT;
			break;
		}
996
		vhost_vq_meta_reset(dev);
J
Jason Wang 已提交
997 998 999 1000 1001 1002 1003 1004 1005
		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:
1006 1007 1008 1009
		if (!dev->iotlb) {
			ret = -EFAULT;
			break;
		}
1010
		vhost_vq_meta_reset(dev);
J
Jason Wang 已提交
1011 1012 1013 1014 1015 1016 1017 1018 1019
		vhost_del_umem_range(dev->iotlb, msg->iova,
				     msg->iova + msg->size - 1);
		break;
	default:
		ret = -EINVAL;
		break;
	}

	vhost_dev_unlock_vqs(dev);
1020 1021
	mutex_unlock(&dev->mutex);

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

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

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

	if (!list_empty(&dev->read_list))
1062
		mask |= EPOLLIN | EPOLLRDNORM;
J
Jason Wang 已提交
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 1136 1137 1138

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

1141 1142 1143 1144
static bool vq_access_ok(struct vhost_virtqueue *vq, unsigned int num,
			 struct vring_desc __user *desc,
			 struct vring_avail __user *avail,
			 struct vring_used __user *used)
J
Jason Wang 已提交
1145

1146
{
1147
	size_t s = vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
J
Jason Wang 已提交
1148

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

1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166
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;
}

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

	if (vhost_vq_meta_fetch(vq, addr, len, type))
		return true;
J
Jason Wang 已提交
1176 1177 1178 1179

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

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

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

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

/* Verify access for write logging. */
/* Caller should have vq mutex and device mutex */
1234 1235
static bool vq_log_access_ok(struct vhost_virtqueue *vq,
			     void __user *log_base)
1236
{
1237
	size_t s = vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
A
Arnd Bergmann 已提交
1238

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

/* Can we start vq? */
/* Caller should have vq mutex and device mutex */
1248
bool vhost_vq_access_ok(struct vhost_virtqueue *vq)
1249
{
1250
	if (!vq_log_access_ok(vq, vq->log_base))
1251
		return false;
1252

1253 1254
	/* Access validation occurs at prefetch time with IOTLB */
	if (vq->iotlb)
1255
		return true;
1256 1257

	return vq_access_ok(vq, vq->num, vq->desc, vq->avail, vq->used);
1258
}
A
Asias He 已提交
1259
EXPORT_SYMBOL_GPL(vhost_vq_access_ok);
1260

J
Jason Wang 已提交
1261 1262
static struct vhost_umem *vhost_umem_alloc(void)
{
1263
	struct vhost_umem *umem = kvzalloc(sizeof(*umem), GFP_KERNEL);
J
Jason Wang 已提交
1264 1265 1266 1267

	if (!umem)
		return NULL;

1268
	umem->umem_tree = RB_ROOT_CACHED;
J
Jason Wang 已提交
1269 1270 1271 1272 1273 1274
	umem->numem = 0;
	INIT_LIST_HEAD(&umem->umem_list);

	return umem;
}

1275 1276
static long vhost_set_memory(struct vhost_dev *d, struct vhost_memory __user *m)
{
1277 1278 1279
	struct vhost_memory mem, *newmem;
	struct vhost_memory_region *region;
	struct vhost_umem *newumem, *oldumem;
1280
	unsigned long size = offsetof(struct vhost_memory, regions);
1281
	int i;
K
Krishna Kumar 已提交
1282

1283 1284
	if (copy_from_user(&mem, m, size))
		return -EFAULT;
1285 1286
	if (mem.padding)
		return -EOPNOTSUPP;
1287
	if (mem.nregions > max_mem_regions)
1288
		return -E2BIG;
1289
	newmem = kvzalloc(size + mem.nregions * sizeof(*m->regions), GFP_KERNEL);
1290 1291 1292 1293
	if (!newmem)
		return -ENOMEM;

	memcpy(newmem, &mem, size);
1294 1295
	if (copy_from_user(newmem->regions, m->regions,
			   mem.nregions * sizeof *m->regions)) {
1296
		kvfree(newmem);
1297
		return -EFAULT;
1298 1299
	}

J
Jason Wang 已提交
1300
	newumem = vhost_umem_alloc();
1301
	if (!newumem) {
1302
		kvfree(newmem);
1303 1304 1305 1306 1307 1308
		return -ENOMEM;
	}

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

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

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

1325
	/* All memory accesses are done under some VQ mutex. */
1326 1327
	for (i = 0; i < d->nvqs; ++i) {
		mutex_lock(&d->vqs[i]->mutex);
1328
		d->vqs[i]->umem = newumem;
1329 1330
		mutex_unlock(&d->vqs[i]->mutex);
	}
1331 1332 1333

	kvfree(newmem);
	vhost_umem_clean(oldumem);
1334
	return 0;
1335 1336 1337 1338 1339

err:
	vhost_umem_clean(newumem);
	kvfree(newmem);
	return -EFAULT;
1340 1341
}

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

1361
	vq = d->vqs[idx];
1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372

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

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

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

1530
	if (!IS_ERR_OR_NULL(ctx))
1531 1532 1533 1534 1535
		eventfd_ctx_put(ctx);
	if (filep)
		fput(filep);

	if (pollstart && vq->handle_kick)
1536
		r = vhost_poll_start(&vq->poll, vq->kick);
1537 1538 1539 1540 1541 1542 1543

	mutex_unlock(&vq->mutex);

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

J
Jason Wang 已提交
1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569
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);

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

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

1654
	r = get_user_pages_fast(log, 1, 1, &page);
1655
	if (r < 0)
1656
		return r;
1657
	BUG_ON(r != 1);
1658
	base = kmap_atomic(page);
1659
	set_bit(bit, base);
1660
	kunmap_atomic(base);
1661 1662 1663 1664 1665 1666 1667 1668
	set_page_dirty_lock(page);
	put_page(page);
	return 0;
}

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

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

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

1763
	if (!vq->private_data)
1764
		return 0;
1765 1766

	vhost_init_is_le(vq);
1767 1768 1769

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

1786 1787 1788
err:
	vq->is_le = is_le;
	return r;
1789
}
G
Greg Kurz 已提交
1790
EXPORT_SYMBOL_GPL(vhost_vq_init_access);
1791

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

	while ((u64)len > s) {
		u64 size;
1804
		if (unlikely(ret >= iov_size)) {
1805 1806 1807
			ret = -ENOBUFS;
			break;
		}
J
Jason Wang 已提交
1808

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

1823
		_iov = iov + ret;
1824
		size = node->size - addr + node->start;
1825
		_iov->iov_len = min((u64)len - s, size);
C
Christoph Hellwig 已提交
1826
		_iov->iov_base = (void __user *)(unsigned long)
1827
			(node->userspace_addr + addr - node->start);
1828 1829 1830 1831 1832
		s += size;
		addr += size;
		++ret;
	}

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

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

	/* Check they're not leading us off end of descriptors. */
1850
	next = vhost16_to_cpu(vq, READ_ONCE(desc->next));
1851 1852 1853
	return next;
}

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

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

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

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

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

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

J
Jason Wang 已提交
1916 1917 1918 1919 1920
		if (desc.flags & cpu_to_vhost16(vq, VRING_DESC_F_WRITE))
			access = VHOST_ACCESS_WO;
		else
			access = VHOST_ACCESS_RO;

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

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

1975
	if (vq->avail_idx == vq->last_avail_idx) {
1976
		if (unlikely(vhost_get_avail(vq, avail_idx, &vq->avail->idx))) {
1977 1978 1979 1980 1981
			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);
1982

1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993
		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;
1994

1995 1996 1997 1998 1999
		/* Only get avail ring entries after they have been
		 * exposed by guest.
		 */
		smp_rmb();
	}
2000 2001 2002

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

2011 2012
	head = vhost16_to_cpu(vq, ring_head);

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

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

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

	/* On success, increment avail index. */
	vq->last_avail_idx++;
M
Michael S. Tsirkin 已提交
2095 2096 2097 2098

	/* 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));
2099 2100
	return head;
}
A
Asias He 已提交
2101
EXPORT_SYMBOL_GPL(vhost_get_vq_desc);
2102 2103

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

/* 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)
{
2114 2115 2116 2117
	struct vring_used_elem heads = {
		cpu_to_vhost32(vq, head),
		cpu_to_vhost32(vq, len)
	};
2118

2119
	return vhost_add_used_n(vq, &heads, 1);
2120
}
A
Asias He 已提交
2121
EXPORT_SYMBOL_GPL(vhost_add_used);
2122

2123 2124 2125 2126 2127
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 已提交
2128
	u16 old, new;
2129 2130
	int start;

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

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

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

2213
	if (vhost_has_feature(vq, VIRTIO_F_NOTIFY_ON_EMPTY) &&
M
Michael S. Tsirkin 已提交
2214 2215 2216
	    unlikely(vq->avail_idx == vq->last_avail_idx))
		return true;

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

M
Michael S. Tsirkin 已提交
2230 2231
	if (unlikely(!v))
		return true;
2232

2233
	if (vhost_get_avail(vq, event, vhost_used_event(vq))) {
M
Michael S. Tsirkin 已提交
2234 2235 2236
		vq_err(vq, "Failed to get used event idx");
		return true;
	}
2237
	return vring_need_event(vhost16_to_cpu(vq, event), new, old);
M
Michael S. Tsirkin 已提交
2238 2239 2240 2241 2242
}

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

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

2259 2260 2261 2262 2263 2264 2265 2266
/* 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 已提交
2267
EXPORT_SYMBOL_GPL(vhost_add_used_and_signal_n);
2268

2269 2270 2271 2272 2273 2274
/* 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;

2275 2276 2277
	if (vq->avail_idx != vq->last_avail_idx)
		return false;

2278
	r = vhost_get_avail(vq, avail_idx, &vq->avail->idx);
2279
	if (unlikely(r))
2280
		return false;
2281
	vq->avail_idx = vhost16_to_cpu(vq, avail_idx);
2282

2283
	return vq->avail_idx == vq->last_avail_idx;
2284 2285 2286
}
EXPORT_SYMBOL_GPL(vhost_vq_avail_empty);

2287
/* OK, now we need to know about added descriptors. */
M
Michael S. Tsirkin 已提交
2288
bool vhost_enable_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
2289
{
2290
	__virtio16 avail_idx;
2291
	int r;
K
Krishna Kumar 已提交
2292

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

2321
	return vhost16_to_cpu(vq, avail_idx) != vq->avail_idx;
2322
}
A
Asias He 已提交
2323
EXPORT_SYMBOL_GPL(vhost_enable_notify);
2324 2325

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

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

J
Jason Wang 已提交
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;
2348 2349 2350

	/* Make sure all padding within the structure is initialized. */
	memset(&node->msg, 0, sizeof node->msg);
J
Jason Wang 已提交
2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363
	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);

2364
	wake_up_interruptible_poll(&dev->wait, EPOLLIN | EPOLLRDNORM);
J
Jason Wang 已提交
2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385
}
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 已提交
2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401
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");