vhost.c 39.9 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
Rob Landley's avatar
Rob Landley committed
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>
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/kthread.h>
26
#include <linux/cgroup.h>
27
#include <linux/module.h>
28 29 30 31 32 33 34 35

#include "vhost.h"

enum {
	VHOST_MEMORY_MAX_NREGIONS = 64,
	VHOST_MEMORY_F_LOG = 0x1,
};

36 37
#define vhost_used_event(vq) ((__virtio16 __user *)&vq->avail->ring[vq->num])
#define vhost_avail_event(vq) ((__virtio16 __user *)&vq->used->ring[vq->num])
38

39 40 41 42 43
static void vhost_poll_func(struct file *file, wait_queue_head_t *wqh,
			    poll_table *pt)
{
	struct vhost_poll *poll;

44
	poll = container_of(pt, struct vhost_poll, table);
45 46 47 48 49 50 51
	poll->wqh = wqh;
	add_wait_queue(wqh, &poll->wait);
}

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

54 55 56
	if (!((unsigned long)key & poll->mask))
		return 0;

57
	vhost_poll_queue(poll);
58 59 60
	return 0;
}

61
void vhost_work_init(struct vhost_work *work, vhost_work_fn_t fn)
62 63 64 65 66 67 68
{
	INIT_LIST_HEAD(&work->node);
	work->fn = fn;
	init_waitqueue_head(&work->done);
	work->flushing = 0;
	work->queue_seq = work->done_seq = 0;
}
69
EXPORT_SYMBOL_GPL(vhost_work_init);
70

71
/* Init poll structure */
72 73
void vhost_poll_init(struct vhost_poll *poll, vhost_work_fn_t fn,
		     unsigned long mask, struct vhost_dev *dev)
74 75 76 77
{
	init_waitqueue_func_entry(&poll->wait, vhost_poll_wakeup);
	init_poll_funcptr(&poll->table, vhost_poll_func);
	poll->mask = mask;
78
	poll->dev = dev;
79
	poll->wqh = NULL;
80

81
	vhost_work_init(&poll->work, fn);
82
}
83
EXPORT_SYMBOL_GPL(vhost_poll_init);
84 85 86

/* 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. */
87
int vhost_poll_start(struct vhost_poll *poll, struct file *file)
88 89
{
	unsigned long mask;
90
	int ret = 0;
91

92 93 94
	if (poll->wqh)
		return 0;

95 96 97
	mask = file->f_op->poll(file, &poll->table);
	if (mask)
		vhost_poll_wakeup(&poll->wait, 0, 0, (void *)mask);
98 99 100 101 102 103 104
	if (mask & POLLERR) {
		if (poll->wqh)
			remove_wait_queue(poll->wqh, &poll->wait);
		ret = -EINVAL;
	}

	return ret;
105
}
106
EXPORT_SYMBOL_GPL(vhost_poll_start);
107 108 109 110 111

/* 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)
{
112 113 114 115
	if (poll->wqh) {
		remove_wait_queue(poll->wqh, &poll->wait);
		poll->wqh = NULL;
	}
116
}
117
EXPORT_SYMBOL_GPL(vhost_poll_stop);
118

119 120 121 122
static bool vhost_work_seq_done(struct vhost_dev *dev, struct vhost_work *work,
				unsigned seq)
{
	int left;
123

124 125 126 127 128 129
	spin_lock_irq(&dev->work_lock);
	left = seq - work->done_seq;
	spin_unlock_irq(&dev->work_lock);
	return left <= 0;
}

130
void vhost_work_flush(struct vhost_dev *dev, struct vhost_work *work)
131
{
132 133 134
	unsigned seq;
	int flushing;

135
	spin_lock_irq(&dev->work_lock);
136 137
	seq = work->queue_seq;
	work->flushing++;
138
	spin_unlock_irq(&dev->work_lock);
139
	wait_event(work->done, vhost_work_seq_done(dev, work, seq));
140
	spin_lock_irq(&dev->work_lock);
141
	flushing = --work->flushing;
142
	spin_unlock_irq(&dev->work_lock);
143
	BUG_ON(flushing < 0);
144
}
145
EXPORT_SYMBOL_GPL(vhost_work_flush);
146

147 148 149 150 151 152
/* 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);
}
153
EXPORT_SYMBOL_GPL(vhost_poll_flush);
154

155
void vhost_work_queue(struct vhost_dev *dev, struct vhost_work *work)
156
{
157 158 159 160 161 162
	unsigned long flags;

	spin_lock_irqsave(&dev->work_lock, flags);
	if (list_empty(&work->node)) {
		list_add_tail(&work->node, &dev->work_list);
		work->queue_seq++;
163
		spin_unlock_irqrestore(&dev->work_lock, flags);
164
		wake_up_process(dev->worker);
165 166
	} else {
		spin_unlock_irqrestore(&dev->work_lock, flags);
167
	}
168
}
169
EXPORT_SYMBOL_GPL(vhost_work_queue);
170

171 172 173 174
void vhost_poll_queue(struct vhost_poll *poll)
{
	vhost_work_queue(poll->dev, &poll->work);
}
175
EXPORT_SYMBOL_GPL(vhost_poll_queue);
176

177 178 179 180 181 182 183 184 185 186
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;
187 188
	vq->signalled_used = 0;
	vq->signalled_used_valid = false;
189 190 191 192
	vq->used_flags = 0;
	vq->log_used = false;
	vq->log_addr = -1ull;
	vq->private_data = NULL;
193
	vq->acked_features = 0;
194 195 196 197 198 199
	vq->log_base = NULL;
	vq->error_ctx = NULL;
	vq->error = NULL;
	vq->kick = NULL;
	vq->call_ctx = NULL;
	vq->call = NULL;
200
	vq->log_ctx = NULL;
201
	vq->memory = NULL;
202 203
}

204 205 206 207 208
static int vhost_worker(void *data)
{
	struct vhost_dev *dev = data;
	struct vhost_work *work = NULL;
	unsigned uninitialized_var(seq);
209
	mm_segment_t oldfs = get_fs();
210

211
	set_fs(USER_DS);
212 213
	use_mm(dev->mm);

214 215 216 217 218 219 220 221 222 223 224 225 226 227
	for (;;) {
		/* mb paired w/ kthread_stop */
		set_current_state(TASK_INTERRUPTIBLE);

		spin_lock_irq(&dev->work_lock);
		if (work) {
			work->done_seq = seq;
			if (work->flushing)
				wake_up_all(&work->done);
		}

		if (kthread_should_stop()) {
			spin_unlock_irq(&dev->work_lock);
			__set_current_state(TASK_RUNNING);
228
			break;
229 230 231 232 233 234 235 236 237 238 239 240 241
		}
		if (!list_empty(&dev->work_list)) {
			work = list_first_entry(&dev->work_list,
						struct vhost_work, node);
			list_del_init(&work->node);
			seq = work->queue_seq;
		} else
			work = NULL;
		spin_unlock_irq(&dev->work_lock);

		if (work) {
			__set_current_state(TASK_RUNNING);
			work->fn(work);
242 243
			if (need_resched())
				schedule();
244 245 246 247
		} else
			schedule();

	}
248
	unuse_mm(dev->mm);
249
	set_fs(oldfs);
250
	return 0;
251 252
}

253 254 255 256 257 258 259 260 261 262
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;
}

Jason Wang's avatar
Jason Wang committed
263 264 265
/* Helper to allocate iovec buffers for all vqs. */
static long vhost_dev_alloc_iovecs(struct vhost_dev *dev)
{
266
	struct vhost_virtqueue *vq;
Jason Wang's avatar
Jason Wang committed
267
	int i;
268

Jason Wang's avatar
Jason Wang committed
269
	for (i = 0; i < dev->nvqs; ++i) {
270 271 272 273 274 275
		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)
Jason Wang's avatar
Jason Wang committed
276 277 278
			goto err_nomem;
	}
	return 0;
279

Jason Wang's avatar
Jason Wang committed
280
err_nomem:
281
	for (; i >= 0; --i)
282
		vhost_vq_free_iovecs(dev->vqs[i]);
Jason Wang's avatar
Jason Wang committed
283 284 285 286 287 288
	return -ENOMEM;
}

static void vhost_dev_free_iovecs(struct vhost_dev *dev)
{
	int i;
289

290
	for (i = 0; i < dev->nvqs; ++i)
291
		vhost_vq_free_iovecs(dev->vqs[i]);
Jason Wang's avatar
Jason Wang committed
292 293
}

Zhi Yong Wu's avatar
Zhi Yong Wu committed
294
void vhost_dev_init(struct vhost_dev *dev,
295
		    struct vhost_virtqueue **vqs, int nvqs)
296
{
297
	struct vhost_virtqueue *vq;
298
	int i;
299

300 301 302 303 304 305 306
	dev->vqs = vqs;
	dev->nvqs = nvqs;
	mutex_init(&dev->mutex);
	dev->log_ctx = NULL;
	dev->log_file = NULL;
	dev->memory = NULL;
	dev->mm = NULL;
307 308 309
	spin_lock_init(&dev->work_lock);
	INIT_LIST_HEAD(&dev->work_list);
	dev->worker = NULL;
310 311

	for (i = 0; i < dev->nvqs; ++i) {
312 313 314 315 316 317 318 319 320 321
		vq = dev->vqs[i];
		vq->log = NULL;
		vq->indirect = NULL;
		vq->heads = NULL;
		vq->dev = dev;
		mutex_init(&vq->mutex);
		vhost_vq_reset(dev, vq);
		if (vq->handle_kick)
			vhost_poll_init(&vq->poll, vq->handle_kick,
					POLLIN, dev);
322 323
	}
}
324
EXPORT_SYMBOL_GPL(vhost_dev_init);
325 326 327 328 329 330 331

/* 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;
}
332
EXPORT_SYMBOL_GPL(vhost_dev_check_owner);
333

334
struct vhost_attach_cgroups_struct {
335 336 337
	struct vhost_work work;
	struct task_struct *owner;
	int ret;
338 339 340 341
};

static void vhost_attach_cgroups_work(struct vhost_work *work)
{
342 343 344 345
	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);
346 347 348 349
}

static int vhost_attach_cgroups(struct vhost_dev *dev)
{
350 351 352 353 354 355 356
	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;
357 358
}

359 360 361 362 363
/* Caller should have device mutex */
bool vhost_dev_has_owner(struct vhost_dev *dev)
{
	return dev->mm;
}
364
EXPORT_SYMBOL_GPL(vhost_dev_has_owner);
365

366
/* Caller should have device mutex */
Asias He's avatar
Asias He committed
367
long vhost_dev_set_owner(struct vhost_dev *dev)
368
{
369 370
	struct task_struct *worker;
	int err;
371

372
	/* Is there an owner already? */
373
	if (vhost_dev_has_owner(dev)) {
374 375 376
		err = -EBUSY;
		goto err_mm;
	}
377

378 379
	/* No owner, become one */
	dev->mm = get_task_mm(current);
380 381 382 383 384 385 386
	worker = kthread_create(vhost_worker, dev, "vhost-%d", current->pid);
	if (IS_ERR(worker)) {
		err = PTR_ERR(worker);
		goto err_worker;
	}

	dev->worker = worker;
387 388 389
	wake_up_process(worker);	/* avoid contributing to loadavg */

	err = vhost_attach_cgroups(dev);
390 391
	if (err)
		goto err_cgroup;
392

Jason Wang's avatar
Jason Wang committed
393 394 395 396
	err = vhost_dev_alloc_iovecs(dev);
	if (err)
		goto err_cgroup;

397
	return 0;
398 399
err_cgroup:
	kthread_stop(worker);
400
	dev->worker = NULL;
401 402 403 404 405 406
err_worker:
	if (dev->mm)
		mmput(dev->mm);
	dev->mm = NULL;
err_mm:
	return err;
407
}
408
EXPORT_SYMBOL_GPL(vhost_dev_set_owner);
409

410
struct vhost_memory *vhost_dev_reset_owner_prepare(void)
411
{
412 413
	return kmalloc(offsetof(struct vhost_memory, regions), GFP_KERNEL);
}
414
EXPORT_SYMBOL_GPL(vhost_dev_reset_owner_prepare);
415

416 417 418
/* Caller should have device mutex */
void vhost_dev_reset_owner(struct vhost_dev *dev, struct vhost_memory *memory)
{
419 420
	int i;

421
	vhost_dev_cleanup(dev, true);
422

423
	/* Restore memory to default empty mapping. */
424
	memory->nregions = 0;
425 426 427 428 429 430
	dev->memory = memory;
	/* We don't need VQ locks below since vhost_dev_cleanup makes sure
	 * VQs aren't running.
	 */
	for (i = 0; i < dev->nvqs; ++i)
		dev->vqs[i]->memory = memory;
431
}
432
EXPORT_SYMBOL_GPL(vhost_dev_reset_owner);
433

434
void vhost_dev_stop(struct vhost_dev *dev)
435 436
{
	int i;
437 438

	for (i = 0; i < dev->nvqs; ++i) {
439 440 441
		if (dev->vqs[i]->kick && dev->vqs[i]->handle_kick) {
			vhost_poll_stop(&dev->vqs[i]->poll);
			vhost_poll_flush(&dev->vqs[i]->poll);
442
		}
443 444
	}
}
445
EXPORT_SYMBOL_GPL(vhost_dev_stop);
446

447 448
/* Caller should have device mutex if and only if locked is set */
void vhost_dev_cleanup(struct vhost_dev *dev, bool locked)
449 450
{
	int i;
451

452
	for (i = 0; i < dev->nvqs; ++i) {
453 454 455 456 457 458 459 460 461 462 463
		if (dev->vqs[i]->error_ctx)
			eventfd_ctx_put(dev->vqs[i]->error_ctx);
		if (dev->vqs[i]->error)
			fput(dev->vqs[i]->error);
		if (dev->vqs[i]->kick)
			fput(dev->vqs[i]->kick);
		if (dev->vqs[i]->call_ctx)
			eventfd_ctx_put(dev->vqs[i]->call_ctx);
		if (dev->vqs[i]->call)
			fput(dev->vqs[i]->call);
		vhost_vq_reset(dev, dev->vqs[i]);
464
	}
Jason Wang's avatar
Jason Wang committed
465
	vhost_dev_free_iovecs(dev);
466 467 468 469 470 471 472
	if (dev->log_ctx)
		eventfd_ctx_put(dev->log_ctx);
	dev->log_ctx = NULL;
	if (dev->log_file)
		fput(dev->log_file);
	dev->log_file = NULL;
	/* No one will access memory at this point */
473 474
	kfree(dev->memory);
	dev->memory = NULL;
475
	WARN_ON(!list_empty(&dev->work_list));
476 477 478 479
	if (dev->worker) {
		kthread_stop(dev->worker);
		dev->worker = NULL;
	}
480 481 482
	if (dev->mm)
		mmput(dev->mm);
	dev->mm = NULL;
483
}
484
EXPORT_SYMBOL_GPL(vhost_dev_cleanup);
485 486 487 488

static int log_access_ok(void __user *log_base, u64 addr, unsigned long sz)
{
	u64 a = addr / VHOST_PAGE_SIZE / 8;
489

490 491 492
	/* Make sure 64 bit math will not overflow. */
	if (a > ULONG_MAX - (unsigned long)log_base ||
	    a + (unsigned long)log_base > ULONG_MAX)
493
		return 0;
494 495 496 497 498 499 500 501 502 503

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

/* Caller should have vq mutex and device mutex. */
static int vq_memory_access_ok(void __user *log_base, struct vhost_memory *mem,
			       int log_all)
{
	int i;
504

Michael S. Tsirkin's avatar
Michael S. Tsirkin committed
505 506
	if (!mem)
		return 0;
507

508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
	for (i = 0; i < mem->nregions; ++i) {
		struct vhost_memory_region *m = mem->regions + i;
		unsigned long a = m->userspace_addr;
		if (m->memory_size > ULONG_MAX)
			return 0;
		else if (!access_ok(VERIFY_WRITE, (void __user *)a,
				    m->memory_size))
			return 0;
		else if (log_all && !log_access_ok(log_base,
						   m->guest_phys_addr,
						   m->memory_size))
			return 0;
	}
	return 1;
}

/* Can we switch to this memory table? */
/* Caller should have device mutex but not vq mutex */
static int memory_access_ok(struct vhost_dev *d, struct vhost_memory *mem,
			    int log_all)
{
	int i;
530

531 532
	for (i = 0; i < d->nvqs; ++i) {
		int ok;
533 534
		bool log;

535
		mutex_lock(&d->vqs[i]->mutex);
536
		log = log_all || vhost_has_feature(d->vqs[i], VHOST_F_LOG_ALL);
537
		/* If ring is inactive, will check when it's enabled. */
538
		if (d->vqs[i]->private_data)
539
			ok = vq_memory_access_ok(d->vqs[i]->log_base, mem, log);
540 541
		else
			ok = 1;
542
		mutex_unlock(&d->vqs[i]->mutex);
543 544 545 546 547 548
		if (!ok)
			return 0;
	}
	return 1;
}

549
static int vq_access_ok(struct vhost_virtqueue *vq, unsigned int num,
550 551 552 553
			struct vring_desc __user *desc,
			struct vring_avail __user *avail,
			struct vring_used __user *used)
{
554
	size_t s = vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
555 556
	return access_ok(VERIFY_READ, desc, num * sizeof *desc) &&
	       access_ok(VERIFY_READ, avail,
557
			 sizeof *avail + num * sizeof *avail->ring + s) &&
558
	       access_ok(VERIFY_WRITE, used,
559
			sizeof *used + num * sizeof *used->ring + s);
560 561 562 563 564 565
}

/* Can we log writes? */
/* Caller should have device mutex but not vq mutex */
int vhost_log_access_ok(struct vhost_dev *dev)
{
566
	return memory_access_ok(dev, dev->memory, 1);
567
}
568
EXPORT_SYMBOL_GPL(vhost_log_access_ok);
569 570 571

/* Verify access for write logging. */
/* Caller should have vq mutex and device mutex */
572
static int vq_log_access_ok(struct vhost_virtqueue *vq,
573
			    void __user *log_base)
574
{
575
	size_t s = vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
Arnd Bergmann's avatar
Arnd Bergmann committed
576

577
	return vq_memory_access_ok(log_base, vq->memory,
578
				   vhost_has_feature(vq, VHOST_F_LOG_ALL)) &&
579 580
		(!vq->log_used || log_access_ok(log_base, vq->log_addr,
					sizeof *vq->used +
581
					vq->num * sizeof *vq->used->ring + s));
582 583 584 585 586 587
}

/* Can we start vq? */
/* Caller should have vq mutex and device mutex */
int vhost_vq_access_ok(struct vhost_virtqueue *vq)
{
588 589
	return vq_access_ok(vq, vq->num, vq->desc, vq->avail, vq->used) &&
		vq_log_access_ok(vq, vq->log_base);
590
}
591
EXPORT_SYMBOL_GPL(vhost_vq_access_ok);
592 593 594 595 596

static long vhost_set_memory(struct vhost_dev *d, struct vhost_memory __user *m)
{
	struct vhost_memory mem, *newmem, *oldmem;
	unsigned long size = offsetof(struct vhost_memory, regions);
597
	int i;
598

599 600
	if (copy_from_user(&mem, m, size))
		return -EFAULT;
601 602 603 604 605 606 607 608 609
	if (mem.padding)
		return -EOPNOTSUPP;
	if (mem.nregions > VHOST_MEMORY_MAX_NREGIONS)
		return -E2BIG;
	newmem = kmalloc(size + mem.nregions * sizeof *m->regions, GFP_KERNEL);
	if (!newmem)
		return -ENOMEM;

	memcpy(newmem, &mem, size);
610 611
	if (copy_from_user(newmem->regions, m->regions,
			   mem.nregions * sizeof *m->regions)) {
612
		kfree(newmem);
613
		return -EFAULT;
614 615
	}

616
	if (!memory_access_ok(d, newmem, 0)) {
617
		kfree(newmem);
618
		return -EFAULT;
619
	}
620 621
	oldmem = d->memory;
	d->memory = newmem;
622

623
	/* All memory accesses are done under some VQ mutex. */
624 625
	for (i = 0; i < d->nvqs; ++i) {
		mutex_lock(&d->vqs[i]->mutex);
626
		d->vqs[i]->memory = newmem;
627 628
		mutex_unlock(&d->vqs[i]->mutex);
	}
629 630 631 632
	kfree(oldmem);
	return 0;
}

633
long vhost_vring_ioctl(struct vhost_dev *d, int ioctl, void __user *argp)
634
{
635 636
	struct file *eventfp, *filep = NULL;
	bool pollstart = false, pollstop = false;
637 638 639 640 641 642 643 644 645 646 647 648
	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;
649
	if (idx >= d->nvqs)
650 651
		return -ENOBUFS;

652
	vq = d->vqs[idx];
653 654 655 656 657 658 659 660 661 662 663

	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;
		}
664 665
		if (copy_from_user(&s, argp, sizeof s)) {
			r = -EFAULT;
666
			break;
667
		}
668 669 670 671 672 673 674 675 676 677 678 679 680
		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;
		}
681 682
		if (copy_from_user(&s, argp, sizeof s)) {
			r = -EFAULT;
683
			break;
684
		}
685 686 687 688 689 690 691 692 693 694 695
		if (s.num > 0xffff) {
			r = -EINVAL;
			break;
		}
		vq->last_avail_idx = s.num;
		/* 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;
696 697
		if (copy_to_user(argp, &s, sizeof s))
			r = -EFAULT;
698 699
		break;
	case VHOST_SET_VRING_ADDR:
700 701
		if (copy_from_user(&a, argp, sizeof a)) {
			r = -EFAULT;
702
			break;
703
		}
704 705 706 707 708 709 710 711 712 713 714 715
		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;
		}
716 717 718 719 720 721 722

		/* 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)) ||
		    (a.log_guest_addr & (sizeof(u64) - 1))) {
723 724 725 726 727 728 729 730
			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) {
731
			if (!vq_access_ok(vq, vq->num,
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
				(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:
756 757
		if (copy_from_user(&f, argp, sizeof f)) {
			r = -EFAULT;
758
			break;
759
		}
760
		eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
761 762 763 764
		if (IS_ERR(eventfp)) {
			r = PTR_ERR(eventfp);
			break;
		}
765
		if (eventfp != vq->kick) {
766 767
			pollstop = (filep = vq->kick) != NULL;
			pollstart = (vq->kick = eventfp) != NULL;
768 769 770 771
		} else
			filep = eventfp;
		break;
	case VHOST_SET_VRING_CALL:
772 773
		if (copy_from_user(&f, argp, sizeof f)) {
			r = -EFAULT;
774
			break;
775
		}
776
		eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
777 778 779 780
		if (IS_ERR(eventfp)) {
			r = PTR_ERR(eventfp);
			break;
		}
781 782 783 784 785 786 787 788 789 790
		if (eventfp != vq->call) {
			filep = vq->call;
			ctx = vq->call_ctx;
			vq->call = eventfp;
			vq->call_ctx = eventfp ?
				eventfd_ctx_fileget(eventfp) : NULL;
		} else
			filep = eventfp;
		break;
	case VHOST_SET_VRING_ERR:
791 792
		if (copy_from_user(&f, argp, sizeof f)) {
			r = -EFAULT;
793
			break;
794
		}
795
		eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
796 797 798 799
		if (IS_ERR(eventfp)) {
			r = PTR_ERR(eventfp);
			break;
		}
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821
		if (eventfp != vq->error) {
			filep = vq->error;
			vq->error = eventfp;
			ctx = vq->error_ctx;
			vq->error_ctx = eventfp ?
				eventfd_ctx_fileget(eventfp) : NULL;
		} else
			filep = eventfp;
		break;
	default:
		r = -ENOIOCTLCMD;
	}

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

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

	if (pollstart && vq->handle_kick)
822
		r = vhost_poll_start(&vq->poll, vq->kick);
823 824 825 826 827 828 829

	mutex_unlock(&vq->mutex);

	if (pollstop && vq->handle_kick)
		vhost_poll_flush(&vq->poll);
	return r;
}
830
EXPORT_SYMBOL_GPL(vhost_vring_ioctl);
831 832

/* Caller must have device mutex */
833
long vhost_dev_ioctl(struct vhost_dev *d, unsigned int ioctl, void __user *argp)
834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856
{
	struct file *eventfp, *filep = NULL;
	struct eventfd_ctx *ctx = NULL;
	u64 p;
	long r;
	int i, fd;

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

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

	switch (ioctl) {
	case VHOST_SET_MEM_TABLE:
		r = vhost_set_memory(d, argp);
		break;
	case VHOST_SET_LOG_BASE:
857 858
		if (copy_from_user(&p, argp, sizeof p)) {
			r = -EFAULT;
859
			break;
860
		}
861 862 863 864 865 866 867
		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;
868
			vq = d->vqs[i];
869 870
			mutex_lock(&vq->mutex);
			/* If ring is inactive, will check when it's enabled. */
871
			if (vq->private_data && !vq_log_access_ok(vq, base))
872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
				r = -EFAULT;
			else
				vq->log_base = base;
			mutex_unlock(&vq->mutex);
		}
		break;
	case VHOST_SET_LOG_FD:
		r = get_user(fd, (int __user *)argp);
		if (r < 0)
			break;
		eventfp = fd == -1 ? NULL : eventfd_fget(fd);
		if (IS_ERR(eventfp)) {
			r = PTR_ERR(eventfp);
			break;
		}
		if (eventfp != d->log_file) {
			filep = d->log_file;
			ctx = d->log_ctx;
			d->log_ctx = eventfp ?
				eventfd_ctx_fileget(eventfp) : NULL;
		} else
			filep = eventfp;
		for (i = 0; i < d->nvqs; ++i) {
895 896 897
			mutex_lock(&d->vqs[i]->mutex);
			d->vqs[i]->log_ctx = d->log_ctx;
			mutex_unlock(&d->vqs[i]->mutex);
898 899 900 901 902 903 904
		}
		if (ctx)
			eventfd_ctx_put(ctx);
		if (filep)
			fput(filep);
		break;
	default:
905
		r = -ENOIOCTLCMD;
906 907 908 909 910
		break;
	}
done:
	return r;
}
911
EXPORT_SYMBOL_GPL(vhost_dev_ioctl);
912 913 914 915 916 917

static const struct vhost_memory_region *find_region(struct vhost_memory *mem,
						     __u64 addr, __u32 len)
{
	struct vhost_memory_region *reg;
	int i;
918

919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
	/* linear search is not brilliant, but we really have on the order of 6
	 * regions in practice */
	for (i = 0; i < mem->nregions; ++i) {
		reg = mem->regions + i;
		if (reg->guest_phys_addr <= addr &&
		    reg->guest_phys_addr + reg->memory_size - 1 >= addr)
			return reg;
	}
	return NULL;
}

/* 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;
941

942
	r = get_user_pages_fast(log, 1, 1, &page);
943
	if (r < 0)
944
		return r;
945
	BUG_ON(r != 1);
946
	base = kmap_atomic(page);
947
	set_bit(bit, base);
948
	kunmap_atomic(base);
949 950 951 952 953 954 955 956
	set_page_dirty_lock(page);
	put_page(page);
	return 0;
}

static int log_write(void __user *log_base,
		     u64 write_address, u64 write_length)
{
957
	u64 write_page = write_address / VHOST_PAGE_SIZE;
958
	int r;
959

960 961
	if (!write_length)
		return 0;
962
	write_length += write_address % VHOST_PAGE_SIZE;
963 964
	for (;;) {
		u64 base = (u64)(unsigned long)log_base;
965 966
		u64 log = base + write_page / 8;
		int bit = write_page % 8;
967 968 969 970 971 972 973 974
		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;
975
		write_page += 1;
976 977 978 979 980 981 982 983 984 985
	}
	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. */
986
	smp_wmb();
987 988 989 990 991 992
	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;
993 994 995
		if (!len) {
			if (vq->log_ctx)
				eventfd_signal(vq->log_ctx, 1);
996
			return 0;
997
		}
998 999 1000 1001 1002
	}
	/* Length written exceeds what we have stored. This is a bug. */
	BUG();
	return 0;
}
1003
EXPORT_SYMBOL_GPL(vhost_log_write);
1004

1005 1006 1007
static int vhost_update_used_flags(struct vhost_virtqueue *vq)
{
	void __user *used;
1008
	if (__put_user(cpu_to_vhost16(vq, vq->used_flags), &vq->used->flags) < 0)
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
		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)
{
1026
	if (__put_user(cpu_to_vhost16(vq, vq->avail_idx), vhost_avail_event(vq)))
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
		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;
}

int vhost_init_used(struct vhost_virtqueue *vq)
{
1045
	__virtio16 last_used_idx;
1046 1047 1048 1049 1050 1051 1052 1053
	int r;
	if (!vq->private_data)
		return 0;

	r = vhost_update_used_flags(vq);
	if (r)
		return r;
	vq->signalled_used_valid = false;
1054 1055 1056 1057 1058
	if (!access_ok(VERIFY_READ, &vq->used->idx, sizeof vq->used->idx))
		return -EFAULT;
	r = __get_user(last_used_idx, &vq->used->idx);
	if (r)
		return r;
1059
	vq->last_used_idx = vhost16_to_cpu(vq, last_used_idx);
1060
	return 0;
1061
}
1062
EXPORT_SYMBOL_GPL(vhost_init_used);
1063

1064
static int translate_desc(struct vhost_virtqueue *vq, u64 addr, u32 len,
1065
			  struct iovec iov[], int iov_size)
1066 1067 1068 1069 1070 1071 1072
{
	const struct vhost_memory_region *reg;
	struct vhost_memory *mem;
	struct iovec *_iov;
	u64 s = 0;
	int ret = 0;

1073
	mem = vq->memory;
1074 1075
	while ((u64)len > s) {
		u64 size;
1076
		if (unlikely(ret >= iov_size)) {
1077 1078 1079 1080
			ret = -ENOBUFS;
			break;
		}
		reg = find_region(mem, addr, len);
1081
		if (unlikely(!reg)) {
1082 1083 1084 1085 1086
			ret = -EFAULT;
			break;
		}
		_iov = iov + ret;
		size = reg->memory_size - addr + reg->guest_phys_addr;
1087
		_iov->iov_len = min((u64)len - s, size);
1088
		_iov->iov_base = (void __user *)(unsigned long)
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
			(reg->userspace_addr + addr - reg->guest_phys_addr);
		s += size;
		addr += size;
		++ret;
	}

	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. */
1101
static unsigned next_desc(struct vhost_virtqueue *vq, struct vring_desc *desc)
1102 1103 1104 1105
{
	unsigned int next;

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

	/* Check they're not leading us off end of descriptors. */
1110
	next = vhost16_to_cpu(vq, desc->next);
1111 1112 1113 1114 1115 1116 1117 1118
	/* Make sure compiler knows to grab that: we don't want it changing! */
	/* We will use the result as an index in an array, so most
	 * architectures only need a compiler barrier here. */
	read_barrier_depends();

	return next;
}

1119
static int get_indirect(struct vhost_virtqueue *vq,
1120 1121 1122 1123
			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)
1124 1125 1126
{
	struct vring_desc desc;
	unsigned int i = 0, count, found = 0;
1127
	u32 len = vhost32_to_cpu(vq, indirect->len);
1128
	struct iov_iter from;
1129 1130 1131
	int ret;

	/* Sanity check */
1132
	if (unlikely(len % sizeof desc)) {
1133 1134
		vq_err(vq, "Invalid length in indirect descriptor: "
		       "len 0x%llx not multiple of 0x%zx\n",
1135
		       (unsigned long long)len,
1136 1137 1138 1139
		       sizeof desc);
		return -EINVAL;
	}

1140
	ret = translate_desc(vq, vhost64_to_cpu(vq, indirect->addr), len, vq->indirect,
Jason Wang's avatar
Jason Wang committed
1141
			     UIO_MAXIOV);
1142
	if (unlikely(ret < 0)) {
1143 1144 1145
		vq_err(vq, "Translation failure %d in indirect.\n", ret);
		return ret;
	}
1146
	iov_iter_init(&from, READ, vq->indirect, ret, len);
1147 1148 1149 1150 1151

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

1152
	count = len / sizeof desc;
1153 1154
	/* Buffers are chained via a 16 bit next field, so
	 * we can have at most 2^16 of these. */
1155
	if (unlikely(count > USHRT_MAX + 1)) {
1156 1157 1158 1159 1160 1161 1162
		vq_err(vq, "Indirect buffer length too big: %d\n",
		       indirect->len);
		return -E2BIG;
	}

	do {
		unsigned iov_count = *in_num + *out_num;
1163
		if (unlikely(++found > count)) {
1164 1165 1166 1167 1168
			vq_err(vq, "Loop detected: last one at %u "
			       "indirect size %u\n",
			       i, count);
			return -EINVAL;
		}
1169 1170
		if (unlikely(copy_from_iter(&desc, sizeof(desc), &from) !=
			     sizeof(desc))) {
1171
			vq_err(vq, "Failed indirect descriptor: idx %d, %zx\n",
1172
			       i, (size_t)vhost64_to_cpu(vq, indirect->addr) + i * sizeof desc);
1173 1174
			return -EINVAL;
		}
1175
		if (unlikely(desc.flags & cpu_to_vhost16(vq, VRING_DESC_F_INDIRECT))) {
1176
			vq_err(vq, "Nested indirect descriptor: idx %d, %zx\n",