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

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

#include "vhost.h"

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

M
Michael S. Tsirkin 已提交
37 38 39
#define vhost_used_event(vq) ((u16 __user *)&vq->avail->ring[vq->num])
#define vhost_avail_event(vq) ((u16 __user *)&vq->used->ring[vq->num])

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

K
Krishna Kumar 已提交
45
	poll = container_of(pt, struct vhost_poll, table);
46 47 48 49 50 51 52
	poll->wqh = wqh;
	add_wait_queue(wqh, &poll->wait);
}

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

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

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

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

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

82
	vhost_work_init(&poll->work, fn);
83
}
A
Asias He 已提交
84
EXPORT_SYMBOL_GPL(vhost_poll_init);
85 86 87

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

J
Jason Wang 已提交
93 94 95
	if (poll->wqh)
		return 0;

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

	return ret;
106
}
A
Asias He 已提交
107
EXPORT_SYMBOL_GPL(vhost_poll_start);
108 109 110 111 112

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

120 121 122 123
static bool vhost_work_seq_done(struct vhost_dev *dev, struct vhost_work *work,
				unsigned seq)
{
	int left;
K
Krishna Kumar 已提交
124

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

A
Asias He 已提交
131
void vhost_work_flush(struct vhost_dev *dev, struct vhost_work *work)
132
{
133 134 135
	unsigned seq;
	int flushing;

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

148 149 150 151 152 153
/* 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 已提交
154
EXPORT_SYMBOL_GPL(vhost_poll_flush);
155

156
void vhost_work_queue(struct vhost_dev *dev, struct vhost_work *work)
157
{
158 159 160 161 162 163
	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++;
164
		spin_unlock_irqrestore(&dev->work_lock, flags);
165
		wake_up_process(dev->worker);
166 167
	} else {
		spin_unlock_irqrestore(&dev->work_lock, flags);
168
	}
169
}
A
Asias He 已提交
170
EXPORT_SYMBOL_GPL(vhost_work_queue);
171

172 173 174 175
void vhost_poll_queue(struct vhost_poll *poll)
{
	vhost_work_queue(poll->dev, &poll->work);
}
A
Asias He 已提交
176
EXPORT_SYMBOL_GPL(vhost_poll_queue);
177

178 179 180 181 182 183 184 185 186 187
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 已提交
188 189
	vq->signalled_used = 0;
	vq->signalled_used_valid = false;
190 191 192 193
	vq->used_flags = 0;
	vq->log_used = false;
	vq->log_addr = -1ull;
	vq->private_data = NULL;
194
	vq->acked_features = 0;
195 196 197 198 199 200
	vq->log_base = NULL;
	vq->error_ctx = NULL;
	vq->error = NULL;
	vq->kick = NULL;
	vq->call_ctx = NULL;
	vq->call = NULL;
201
	vq->log_ctx = 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);
M
Michael S. Tsirkin 已提交
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);
M
Michael S. Tsirkin 已提交
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);
N
Nadav Har'El 已提交
242 243
			if (need_resched())
				schedule();
244 245 246 247
		} else
			schedule();

	}
M
Michael S. Tsirkin 已提交
248
	unuse_mm(dev->mm);
249
	set_fs(oldfs);
M
Michael S. Tsirkin 已提交
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;
}

J
Jason Wang 已提交
263 264 265
/* Helper to allocate iovec buffers for all vqs. */
static long vhost_dev_alloc_iovecs(struct vhost_dev *dev)
{
A
Asias He 已提交
266
	struct vhost_virtqueue *vq;
J
Jason Wang 已提交
267
	int i;
K
Krishna Kumar 已提交
268

J
Jason Wang 已提交
269
	for (i = 0; i < dev->nvqs; ++i) {
A
Asias He 已提交
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)
J
Jason Wang 已提交
276 277 278
			goto err_nomem;
	}
	return 0;
K
Krishna Kumar 已提交
279

J
Jason Wang 已提交
280
err_nomem:
281
	for (; i >= 0; --i)
282
		vhost_vq_free_iovecs(dev->vqs[i]);
J
Jason Wang 已提交
283 284 285 286 287 288
	return -ENOMEM;
}

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

290
	for (i = 0; i < dev->nvqs; ++i)
291
		vhost_vq_free_iovecs(dev->vqs[i]);
J
Jason Wang 已提交
292 293
}

Z
Zhi Yong Wu 已提交
294
void vhost_dev_init(struct vhost_dev *dev,
295
		    struct vhost_virtqueue **vqs, int nvqs)
296
{
A
Asias He 已提交
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) {
A
Asias He 已提交
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
	}
}
A
Asias He 已提交
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;
}
A
Asias He 已提交
332
EXPORT_SYMBOL_GPL(vhost_dev_check_owner);
333

334
struct vhost_attach_cgroups_struct {
K
Krishna Kumar 已提交
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)
{
K
Krishna Kumar 已提交
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)
{
K
Krishna Kumar 已提交
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;
}
A
Asias He 已提交
364
EXPORT_SYMBOL_GPL(vhost_dev_has_owner);
365

366
/* Caller should have device mutex */
A
Asias He 已提交
367
long vhost_dev_set_owner(struct vhost_dev *dev)
368
{
369 370
	struct task_struct *worker;
	int err;
K
Krishna Kumar 已提交
371

372
	/* Is there an owner already? */
373
	if (vhost_dev_has_owner(dev)) {
374 375 376
		err = -EBUSY;
		goto err_mm;
	}
K
Krishna Kumar 已提交
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

J
Jason Wang 已提交
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);
M
Michael S. Tsirkin 已提交
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
}
A
Asias He 已提交
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);
}
A
Asias He 已提交
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
	vhost_dev_cleanup(dev, true);
420

421
	/* Restore memory to default empty mapping. */
422
	memory->nregions = 0;
A
Arnd Bergmann 已提交
423
	RCU_INIT_POINTER(dev->memory, memory);
424
}
A
Asias He 已提交
425
EXPORT_SYMBOL_GPL(vhost_dev_reset_owner);
426

427
void vhost_dev_stop(struct vhost_dev *dev)
428 429
{
	int i;
430 431

	for (i = 0; i < dev->nvqs; ++i) {
432 433 434
		if (dev->vqs[i]->kick && dev->vqs[i]->handle_kick) {
			vhost_poll_stop(&dev->vqs[i]->poll);
			vhost_poll_flush(&dev->vqs[i]->poll);
435
		}
436 437
	}
}
A
Asias He 已提交
438
EXPORT_SYMBOL_GPL(vhost_dev_stop);
439

440 441
/* Caller should have device mutex if and only if locked is set */
void vhost_dev_cleanup(struct vhost_dev *dev, bool locked)
442 443
{
	int i;
K
Krishna Kumar 已提交
444

445
	for (i = 0; i < dev->nvqs; ++i) {
446 447 448 449 450 451 452 453 454 455 456
		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]);
457
	}
J
Jason Wang 已提交
458
	vhost_dev_free_iovecs(dev);
459 460 461 462 463 464 465
	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 */
A
Arnd Bergmann 已提交
466
	kfree(rcu_dereference_protected(dev->memory,
467 468
					locked ==
						lockdep_is_held(&dev->mutex)));
A
Arnd Bergmann 已提交
469
	RCU_INIT_POINTER(dev->memory, NULL);
470
	WARN_ON(!list_empty(&dev->work_list));
471 472 473 474
	if (dev->worker) {
		kthread_stop(dev->worker);
		dev->worker = NULL;
	}
475 476 477
	if (dev->mm)
		mmput(dev->mm);
	dev->mm = NULL;
478
}
A
Asias He 已提交
479
EXPORT_SYMBOL_GPL(vhost_dev_cleanup);
480 481 482 483

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

485 486 487
	/* Make sure 64 bit math will not overflow. */
	if (a > ULONG_MAX - (unsigned long)log_base ||
	    a + (unsigned long)log_base > ULONG_MAX)
488
		return 0;
489 490 491 492 493 494 495 496 497 498

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

M
Michael S. Tsirkin 已提交
500 501
	if (!mem)
		return 0;
502

503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
	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;
K
Krishna Kumar 已提交
525

526 527
	for (i = 0; i < d->nvqs; ++i) {
		int ok;
528 529
		bool log;

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

544
static int vq_access_ok(struct vhost_virtqueue *vq, unsigned int num,
545 546 547 548
			struct vring_desc __user *desc,
			struct vring_avail __user *avail,
			struct vring_used __user *used)
{
549
	size_t s = vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
550 551
	return access_ok(VERIFY_READ, desc, num * sizeof *desc) &&
	       access_ok(VERIFY_READ, avail,
M
Michael S. Tsirkin 已提交
552
			 sizeof *avail + num * sizeof *avail->ring + s) &&
553
	       access_ok(VERIFY_WRITE, used,
M
Michael S. Tsirkin 已提交
554
			sizeof *used + num * sizeof *used->ring + s);
555 556 557 558 559 560
}

/* Can we log writes? */
/* Caller should have device mutex but not vq mutex */
int vhost_log_access_ok(struct vhost_dev *dev)
{
A
Arnd Bergmann 已提交
561 562 563 564 565
	struct vhost_memory *mp;

	mp = rcu_dereference_protected(dev->memory,
				       lockdep_is_held(&dev->mutex));
	return memory_access_ok(dev, mp, 1);
566
}
A
Asias He 已提交
567
EXPORT_SYMBOL_GPL(vhost_log_access_ok);
568 569 570

/* Verify access for write logging. */
/* Caller should have vq mutex and device mutex */
571
static int vq_log_access_ok(struct vhost_virtqueue *vq,
M
Michael S. Tsirkin 已提交
572
			    void __user *log_base)
573
{
A
Arnd Bergmann 已提交
574
	struct vhost_memory *mp;
575
	size_t s = vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
A
Arnd Bergmann 已提交
576 577 578 579

	mp = rcu_dereference_protected(vq->dev->memory,
				       lockdep_is_held(&vq->mutex));
	return vq_memory_access_ok(log_base, mp,
580
				   vhost_has_feature(vq, VHOST_F_LOG_ALL)) &&
581 582
		(!vq->log_used || log_access_ok(log_base, vq->log_addr,
					sizeof *vq->used +
M
Michael S. Tsirkin 已提交
583
					vq->num * sizeof *vq->used->ring + s));
584 585 586 587 588 589
}

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

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);
599
	int i;
K
Krishna Kumar 已提交
600

601 602
	if (copy_from_user(&mem, m, size))
		return -EFAULT;
603 604 605 606 607 608 609 610 611
	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);
612 613
	if (copy_from_user(newmem->regions, m->regions,
			   mem.nregions * sizeof *m->regions)) {
614
		kfree(newmem);
615
		return -EFAULT;
616 617
	}

618
	if (!memory_access_ok(d, newmem, 0)) {
619
		kfree(newmem);
620
		return -EFAULT;
621
	}
A
Arnd Bergmann 已提交
622 623
	oldmem = rcu_dereference_protected(d->memory,
					   lockdep_is_held(&d->mutex));
624
	rcu_assign_pointer(d->memory, newmem);
625 626 627 628 629 630 631 632

	/* All memory accesses are done under some VQ mutex.
	 * So below is a faster equivalent of synchronize_rcu()
	 */
	for (i = 0; i < d->nvqs; ++i) {
		mutex_lock(&d->vqs[i]->mutex);
		mutex_unlock(&d->vqs[i]->mutex);
	}
633 634 635 636
	kfree(oldmem);
	return 0;
}

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

656
	vq = d->vqs[idx];
657 658 659 660 661 662 663 664 665 666 667

	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;
		}
668 669
		if (copy_from_user(&s, argp, sizeof s)) {
			r = -EFAULT;
670
			break;
671
		}
672 673 674 675 676 677 678 679 680 681 682 683 684
		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;
		}
685 686
		if (copy_from_user(&s, argp, sizeof s)) {
			r = -EFAULT;
687
			break;
688
		}
689 690 691 692 693 694 695 696 697 698 699
		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;
700 701
		if (copy_to_user(argp, &s, sizeof s))
			r = -EFAULT;
702 703
		break;
	case VHOST_SET_VRING_ADDR:
704 705
		if (copy_from_user(&a, argp, sizeof a)) {
			r = -EFAULT;
706
			break;
707
		}
708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
		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;
		}
		if ((a.avail_user_addr & (sizeof *vq->avail->ring - 1)) ||
		    (a.used_user_addr & (sizeof *vq->used->ring - 1)) ||
		    (a.log_guest_addr & (sizeof *vq->used->ring - 1))) {
			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;
}
A
Asias He 已提交
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;
}
A
Asias He 已提交
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;
K
Krishna Kumar 已提交
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;
K
Krishna Kumar 已提交
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;
K
Krishna Kumar 已提交
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;
}
A
Asias He 已提交
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(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(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 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
		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)
{
	int r;
	if (!vq->private_data)
		return 0;

	r = vhost_update_used_flags(vq);
	if (r)
		return r;
	vq->signalled_used_valid = false;
	return get_user(vq->last_used_idx, &vq->used->idx);
}
A
Asias He 已提交
1055
EXPORT_SYMBOL_GPL(vhost_init_used);
1056

C
Christoph Hellwig 已提交
1057 1058
static int translate_desc(struct vhost_dev *dev, u64 addr, u32 len,
			  struct iovec iov[], int iov_size)
1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
{
	const struct vhost_memory_region *reg;
	struct vhost_memory *mem;
	struct iovec *_iov;
	u64 s = 0;
	int ret = 0;

	rcu_read_lock();

	mem = rcu_dereference(dev->memory);
	while ((u64)len > s) {
		u64 size;
1071
		if (unlikely(ret >= iov_size)) {
1072 1073 1074 1075
			ret = -ENOBUFS;
			break;
		}
		reg = find_region(mem, addr, len);
1076
		if (unlikely(!reg)) {
1077 1078 1079 1080 1081
			ret = -EFAULT;
			break;
		}
		_iov = iov + ret;
		size = reg->memory_size - addr + reg->guest_phys_addr;
1082
		_iov->iov_len = min((u64)len - s, size);
C
Christoph Hellwig 已提交
1083
		_iov->iov_base = (void __user *)(unsigned long)
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
			(reg->userspace_addr + addr - reg->guest_phys_addr);
		s += size;
		addr += size;
		++ret;
	}

	rcu_read_unlock();
	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. */
static unsigned next_desc(struct vring_desc *desc)
{
	unsigned int next;

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

	/* Check they're not leading us off end of descriptors. */
	next = desc->next;
	/* 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;
}

1115 1116 1117 1118 1119
static int get_indirect(struct vhost_dev *dev, struct vhost_virtqueue *vq,
			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)
1120 1121 1122 1123 1124 1125
{
	struct vring_desc desc;
	unsigned int i = 0, count, found = 0;
	int ret;

	/* Sanity check */
1126
	if (unlikely(indirect->len % sizeof desc)) {
1127 1128 1129 1130 1131 1132 1133 1134
		vq_err(vq, "Invalid length in indirect descriptor: "
		       "len 0x%llx not multiple of 0x%zx\n",
		       (unsigned long long)indirect->len,
		       sizeof desc);
		return -EINVAL;
	}

	ret = translate_desc(dev, indirect->addr, indirect->len, vq->indirect,
J
Jason Wang 已提交
1135
			     UIO_MAXIOV);
1136
	if (unlikely(ret < 0)) {
1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
		vq_err(vq, "Translation failure %d in indirect.\n", ret);
		return ret;
	}

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

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

	do {
		unsigned iov_count = *in_num + *out_num;
1156
		if (unlikely(++found > count)) {
1157 1158 1159 1160 1161
			vq_err(vq, "Loop detected: last one at %u "
			       "indirect size %u\n",
			       i, count);
			return -EINVAL;
		}
K
Krishna Kumar 已提交
1162 1163
		if (unlikely(memcpy_fromiovec((unsigned char *)&desc,
					      vq->indirect, sizeof desc))) {
1164 1165 1166 1167
			vq_err(vq, "Failed indirect descriptor: idx %d, %zx\n",
			       i, (size_t)indirect->addr + i * sizeof desc);
			return -EINVAL;
		}
1168
		if (unlikely(desc.flags & VRING_DESC_F_INDIRECT)) {
1169 1170 1171 1172 1173 1174 1175
			vq_err(vq, "Nested indirect descriptor: idx %d, %zx\n",
			       i, (size_t)indirect->addr + i * sizeof desc);
			return -EINVAL;
		}

		ret = translate_desc(dev, desc.addr, desc.len, iov + iov_count,
				     iov_size - iov_count);
1176
		if (unlikely(ret < 0)) {
1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191
			vq_err(vq, "Translation failure %d indirect idx %d\n",
			       ret, i);
			return ret;
		}
		/* If this is an input descriptor, increment that count. */
		if (desc.flags & VRING_DESC_F_WRITE) {
			*in_num += ret;
			if (unlikely(log)) {
				log[*log_num].addr = desc.addr;
				log[*log_num].len = desc.len;
				++*log_num;
			}
		} else {
			/* If it's an output descriptor, they're all supposed
			 * to come before any input descriptors. */
1192
			if (unlikely(*in_num)) {
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207
				vq_err(vq, "Indirect descriptor "
				       "has out after in: idx %d\n", i);
				return -EINVAL;
			}
			*out_num += ret;
		}
	} while ((i = next_desc(&desc)) != -1);
	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.
 *
1208 1209 1210 1211 1212 1213 1214
 * 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. */
int vhost_get_vq_desc(struct vhost_dev *dev, struct vhost_virtqueue *vq,
		      struct iovec iov[], unsigned int iov_size,
		      unsigned int *out_num, unsigned int *in_num,
		      struct vhost_log *log, unsigned int *log_num)
1215 1216 1217 1218 1219 1220 1221 1222
{
	struct vring_desc desc;
	unsigned int i, head, found = 0;
	u16 last_avail_idx;
	int ret;

	/* Check it isn't doing very strange things with descriptor numbers. */
	last_avail_idx = vq->last_avail_idx;
1223
	if (unlikely(__get_user(vq->avail_idx, &vq->avail->idx))) {
1224 1225
		vq_err(vq, "Failed to access avail idx at %p\n",
		       &vq->avail->idx);
1226
		return -EFAULT;
1227 1228
	}

1229
	if (unlikely((u16)(vq->avail_idx - last_avail_idx) > vq->num)) {
1230 1231
		vq_err(vq, "Guest moved used index from %u to %u",
		       last_avail_idx, vq->avail_idx);
1232
		return -EFAULT;
1233 1234 1235 1236 1237 1238 1239
	}

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

	/* Only get avail ring entries after they have been exposed by guest. */
1240
	smp_rmb();
1241 1242 1243

	/* Grab the next descriptor number they're advertising, and increment
	 * the index we've seen. */
1244 1245
	if (unlikely(__get_user(head,
				&vq->avail->ring[last_avail_idx % vq->num]))) {
1246 1247 1248
		vq_err(vq, "Failed to read head: idx %d address %p\n",
		       last_avail_idx,
		       &vq->avail->ring[last_avail_idx % vq->num]);
1249
		return -EFAULT;
1250 1251 1252
	}

	/* If their number is silly, that's an error. */
1253
	if (unlikely(head >= vq->num)) {
1254 1255
		vq_err(vq, "Guest says index %u > %u is available",
		       head, vq->num);
1256
		return -EINVAL;
1257 1258 1259 1260 1261 1262 1263 1264 1265 1266
	}

	/* 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;
1267
		if (unlikely(i >= vq->num)) {
1268 1269
			vq_err(vq, "Desc index is %u > %u, head = %u",
			       i, vq->num, head);
1270
			return -EINVAL;
1271
		}
1272
		if (unlikely(++found > vq->num)) {
1273 1274 1275
			vq_err(vq, "Loop detected: last one at %u "
			       "vq size %u head %u\n",
			       i, vq->num, head);
1276
			return -EINVAL;
1277
		}
1278
		ret = __copy_from_user(&desc, vq->desc + i, sizeof desc);
1279
		if (unlikely(ret)) {
1280 1281
			vq_err(vq, "Failed to get descriptor: idx %d addr %p\n",
			       i, vq->desc + i);
1282
			return -EFAULT;
1283 1284 1285 1286 1287
		}
		if (desc.flags & VRING_DESC_F_INDIRECT) {
			ret = get_indirect(dev, vq, iov, iov_size,
					   out_num, in_num,
					   log, log_num, &desc);
1288
			if (unlikely(ret < 0)) {
1289 1290
				vq_err(vq, "Failure detected "
				       "in indirect descriptor at idx %d\n", i);
1291
				return ret;
1292 1293 1294 1295 1296 1297
			}
			continue;
		}

		ret = translate_desc(dev, desc.addr, desc.len, iov + iov_count,
				     iov_size - iov_count);
1298
		if (unlikely(ret < 0)) {
1299 1300
			vq_err(vq, "Translation failure %d descriptor idx %d\n",
			       ret, i);
1301
			return ret;
1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314
		}
		if (desc.flags & VRING_DESC_F_WRITE) {
			/* If this is an input descriptor,
			 * increment that count. */
			*in_num += ret;
			if (unlikely(log)) {
				log[*log_num].addr = desc.addr;
				log[*log_num].len = desc.len;
				++*log_num;
			}
		} else {
			/* If it's an output descriptor, they're all supposed
			 * to come before any input descriptors. */
1315
			if (unlikely(*in_num)) {
1316 1317
				vq_err(vq, "Descriptor has out after in: "
				       "idx %d\n", i);
1318
				return -EINVAL;
1319 1320 1321 1322 1323 1324 1325
			}
			*out_num += ret;
		}
	} while ((i = next_desc(&desc)) != -1);

	/* On success, increment avail index. */
	vq->last_avail_idx++;
M
Michael S. Tsirkin 已提交
1326 1327 1328 1329

	/* 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));
1330 1331
	return head;
}
A
Asias He 已提交
1332
EXPORT_SYMBOL_GPL(vhost_get_vq_desc);
1333 1334

/* Reverse the effect of vhost_get_vq_desc. Useful for error handling. */
1335
void vhost_discard_vq_desc(struct vhost_virtqueue *vq, int n)
1336
{
1337
	vq->last_avail_idx -= n;
1338
}
A
Asias He 已提交
1339
EXPORT_SYMBOL_GPL(vhost_discard_vq_desc);
1340 1341 1342 1343 1344

/* 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)
{
1345
	struct vring_used_elem heads = { head, len };
1346

1347
	return vhost_add_used_n(vq, &heads, 1);
1348
}
A
Asias He 已提交
1349
EXPORT_SYMBOL_GPL(vhost_add_used);
1350

1351 1352 1353 1354 1355
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 已提交
1356
	u16 old, new;
1357 1358 1359 1360
	int start;

	start = vq->last_used_idx % vq->num;
	used = vq->used->ring + start;
1361 1362 1363 1364 1365 1366 1367 1368 1369 1370
	if (count == 1) {
		if (__put_user(heads[0].id, &used->id)) {
			vq_err(vq, "Failed to write used id");
			return -EFAULT;
		}
		if (__put_user(heads[0].len, &used->len)) {
			vq_err(vq, "Failed to write used len");
			return -EFAULT;
		}
	} else if (__copy_to_user(used, heads, count * sizeof *used)) {
1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382
		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 已提交
1383 1384 1385 1386 1387 1388 1389 1390
	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;
1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427
	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;

	start = vq->last_used_idx % vq->num;
	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();
	if (put_user(vq->last_used_idx, &vq->used->idx)) {
		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 已提交
1428
EXPORT_SYMBOL_GPL(vhost_add_used_n);
1429

M
Michael S. Tsirkin 已提交
1430
static bool vhost_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
1431
{
M
Michael S. Tsirkin 已提交
1432 1433
	__u16 old, new, event;
	bool v;
M
Michael S. Tsirkin 已提交
1434 1435 1436 1437 1438
	/* Flush out used index updates. This is paired
	 * with the barrier that the Guest executes when enabling
	 * interrupts. */
	smp_mb();

1439
	if (vhost_has_feature(vq, VIRTIO_F_NOTIFY_ON_EMPTY) &&
M
Michael S. Tsirkin 已提交
1440 1441 1442
	    unlikely(vq->avail_idx == vq->last_avail_idx))
		return true;

1443
	if (!vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX)) {
M
Michael S. Tsirkin 已提交
1444 1445 1446 1447 1448 1449
		__u16 flags;
		if (__get_user(flags, &vq->avail->flags)) {
			vq_err(vq, "Failed to get flags");
			return true;
		}
		return !(flags & VRING_AVAIL_F_NO_INTERRUPT);
1450
	}
M
Michael S. Tsirkin 已提交
1451 1452 1453 1454
	old = vq->signalled_used;
	v = vq->signalled_used_valid;
	new = vq->signalled_used = vq->last_used_idx;
	vq->signalled_used_valid = true;
1455

M
Michael S. Tsirkin 已提交
1456 1457
	if (unlikely(!v))
		return true;
1458

M
Michael S. Tsirkin 已提交
1459 1460 1461 1462 1463 1464 1465 1466 1467 1468
	if (get_user(event, vhost_used_event(vq))) {
		vq_err(vq, "Failed to get used event idx");
		return true;
	}
	return vring_need_event(event, new, old);
}

/* This actually signals the guest, using eventfd. */
void vhost_signal(struct vhost_dev *dev, struct vhost_virtqueue *vq)
{
1469
	/* Signal the Guest tell them we used something up. */
M
Michael S. Tsirkin 已提交
1470
	if (vq->call_ctx && vhost_notify(dev, vq))
1471 1472
		eventfd_signal(vq->call_ctx, 1);
}
A
Asias He 已提交
1473
EXPORT_SYMBOL_GPL(vhost_signal);
1474 1475 1476 1477 1478 1479 1480 1481 1482

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

1485 1486 1487 1488 1489 1490 1491 1492
/* 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 已提交
1493
EXPORT_SYMBOL_GPL(vhost_add_used_and_signal_n);
1494

1495
/* OK, now we need to know about added descriptors. */
M
Michael S. Tsirkin 已提交
1496
bool vhost_enable_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
1497 1498 1499
{
	u16 avail_idx;
	int r;
K
Krishna Kumar 已提交
1500

1501 1502 1503
	if (!(vq->used_flags & VRING_USED_F_NO_NOTIFY))
		return false;
	vq->used_flags &= ~VRING_USED_F_NO_NOTIFY;
1504
	if (!vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX)) {
1505
		r = vhost_update_used_flags(vq);
M
Michael S. Tsirkin 已提交
1506 1507 1508 1509 1510 1511
		if (r) {
			vq_err(vq, "Failed to enable notification at %p: %d\n",
			       &vq->used->flags, r);
			return false;
		}
	} else {
1512
		r = vhost_update_avail_event(vq, vq->avail_idx);
M
Michael S. Tsirkin 已提交
1513 1514 1515 1516 1517 1518
		if (r) {
			vq_err(vq, "Failed to update avail event index at %p: %d\n",
			       vhost_avail_event(vq), r);
			return false;
		}
	}
1519 1520
	/* They could have slipped one in as we were doing that: make
	 * sure it's written, then check again. */
1521
	smp_mb();
1522
	r = __get_user(avail_idx, &vq->avail->idx);
1523 1524 1525 1526 1527 1528
	if (r) {
		vq_err(vq, "Failed to check avail idx at %p: %d\n",
		       &vq->avail->idx, r);
		return false;
	}

1529
	return avail_idx != vq->avail_idx;
1530
}
A
Asias He 已提交
1531
EXPORT_SYMBOL_GPL(vhost_enable_notify);
1532 1533

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

1538 1539 1540
	if (vq->used_flags & VRING_USED_F_NO_NOTIFY)
		return;
	vq->used_flags |= VRING_USED_F_NO_NOTIFY;
1541
	if (!vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX)) {
1542
		r = vhost_update_used_flags(vq);
M
Michael S. Tsirkin 已提交
1543 1544 1545 1546
		if (r)
			vq_err(vq, "Failed to enable notification at %p: %d\n",
			       &vq->used->flags, r);
	}
1547
}
A
Asias He 已提交
1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565
EXPORT_SYMBOL_GPL(vhost_disable_notify);

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