Merge remote-tracking branch 'remotes/kraxel/tags/usb-20171005-pull-request' into...
[qemu/kevin.git] / contrib / libvhost-user / libvhost-user.c
blobd27d6303db54b79ac8f0bd2070a37e792fe84606
1 /*
2 * Vhost User library
4 * Copyright IBM, Corp. 2007
5 * Copyright (c) 2016 Red Hat, Inc.
7 * Authors:
8 * Anthony Liguori <aliguori@us.ibm.com>
9 * Marc-André Lureau <mlureau@redhat.com>
10 * Victor Kaplansky <victork@redhat.com>
12 * This work is licensed under the terms of the GNU GPL, version 2 or
13 * later. See the COPYING file in the top-level directory.
16 #include <qemu/osdep.h>
17 #include <sys/eventfd.h>
18 #include <linux/vhost.h>
20 #include "qemu/atomic.h"
22 #include "libvhost-user.h"
24 #define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64)
26 /* The version of the protocol we support */
27 #define VHOST_USER_VERSION 1
28 #define LIBVHOST_USER_DEBUG 0
30 #define DPRINT(...) \
31 do { \
32 if (LIBVHOST_USER_DEBUG) { \
33 fprintf(stderr, __VA_ARGS__); \
34 } \
35 } while (0)
37 static const char *
38 vu_request_to_string(int req)
40 #define REQ(req) [req] = #req
41 static const char *vu_request_str[] = {
42 REQ(VHOST_USER_NONE),
43 REQ(VHOST_USER_GET_FEATURES),
44 REQ(VHOST_USER_SET_FEATURES),
45 REQ(VHOST_USER_NONE),
46 REQ(VHOST_USER_GET_FEATURES),
47 REQ(VHOST_USER_SET_FEATURES),
48 REQ(VHOST_USER_SET_OWNER),
49 REQ(VHOST_USER_RESET_OWNER),
50 REQ(VHOST_USER_SET_MEM_TABLE),
51 REQ(VHOST_USER_SET_LOG_BASE),
52 REQ(VHOST_USER_SET_LOG_FD),
53 REQ(VHOST_USER_SET_VRING_NUM),
54 REQ(VHOST_USER_SET_VRING_ADDR),
55 REQ(VHOST_USER_SET_VRING_BASE),
56 REQ(VHOST_USER_GET_VRING_BASE),
57 REQ(VHOST_USER_SET_VRING_KICK),
58 REQ(VHOST_USER_SET_VRING_CALL),
59 REQ(VHOST_USER_SET_VRING_ERR),
60 REQ(VHOST_USER_GET_PROTOCOL_FEATURES),
61 REQ(VHOST_USER_SET_PROTOCOL_FEATURES),
62 REQ(VHOST_USER_GET_QUEUE_NUM),
63 REQ(VHOST_USER_SET_VRING_ENABLE),
64 REQ(VHOST_USER_SEND_RARP),
65 REQ(VHOST_USER_INPUT_GET_CONFIG),
66 REQ(VHOST_USER_MAX),
68 #undef REQ
70 if (req < VHOST_USER_MAX) {
71 return vu_request_str[req];
72 } else {
73 return "unknown";
77 static void
78 vu_panic(VuDev *dev, const char *msg, ...)
80 char *buf = NULL;
81 va_list ap;
83 va_start(ap, msg);
84 buf = g_strdup_vprintf(msg, ap);
85 va_end(ap);
87 dev->broken = true;
88 dev->panic(dev, buf);
89 free(buf);
91 /* FIXME: find a way to call virtio_error? */
94 /* Translate guest physical address to our virtual address. */
95 void *
96 vu_gpa_to_va(VuDev *dev, uint64_t guest_addr)
98 int i;
100 /* Find matching memory region. */
101 for (i = 0; i < dev->nregions; i++) {
102 VuDevRegion *r = &dev->regions[i];
104 if ((guest_addr >= r->gpa) && (guest_addr < (r->gpa + r->size))) {
105 return (void *)(uintptr_t)
106 guest_addr - r->gpa + r->mmap_addr + r->mmap_offset;
110 return NULL;
113 /* Translate qemu virtual address to our virtual address. */
114 static void *
115 qva_to_va(VuDev *dev, uint64_t qemu_addr)
117 int i;
119 /* Find matching memory region. */
120 for (i = 0; i < dev->nregions; i++) {
121 VuDevRegion *r = &dev->regions[i];
123 if ((qemu_addr >= r->qva) && (qemu_addr < (r->qva + r->size))) {
124 return (void *)(uintptr_t)
125 qemu_addr - r->qva + r->mmap_addr + r->mmap_offset;
129 return NULL;
132 static void
133 vmsg_close_fds(VhostUserMsg *vmsg)
135 int i;
137 for (i = 0; i < vmsg->fd_num; i++) {
138 close(vmsg->fds[i]);
142 static bool
143 vu_message_read(VuDev *dev, int conn_fd, VhostUserMsg *vmsg)
145 char control[CMSG_SPACE(VHOST_MEMORY_MAX_NREGIONS * sizeof(int))] = { };
146 struct iovec iov = {
147 .iov_base = (char *)vmsg,
148 .iov_len = VHOST_USER_HDR_SIZE,
150 struct msghdr msg = {
151 .msg_iov = &iov,
152 .msg_iovlen = 1,
153 .msg_control = control,
154 .msg_controllen = sizeof(control),
156 size_t fd_size;
157 struct cmsghdr *cmsg;
158 int rc;
160 do {
161 rc = recvmsg(conn_fd, &msg, 0);
162 } while (rc < 0 && (errno == EINTR || errno == EAGAIN));
164 if (rc < 0) {
165 vu_panic(dev, "Error while recvmsg: %s", strerror(errno));
166 return false;
169 vmsg->fd_num = 0;
170 for (cmsg = CMSG_FIRSTHDR(&msg);
171 cmsg != NULL;
172 cmsg = CMSG_NXTHDR(&msg, cmsg))
174 if (cmsg->cmsg_level == SOL_SOCKET && cmsg->cmsg_type == SCM_RIGHTS) {
175 fd_size = cmsg->cmsg_len - CMSG_LEN(0);
176 vmsg->fd_num = fd_size / sizeof(int);
177 memcpy(vmsg->fds, CMSG_DATA(cmsg), fd_size);
178 break;
182 if (vmsg->size > sizeof(vmsg->payload)) {
183 vu_panic(dev,
184 "Error: too big message request: %d, size: vmsg->size: %u, "
185 "while sizeof(vmsg->payload) = %zu\n",
186 vmsg->request, vmsg->size, sizeof(vmsg->payload));
187 goto fail;
190 if (vmsg->size) {
191 do {
192 rc = read(conn_fd, &vmsg->payload, vmsg->size);
193 } while (rc < 0 && (errno == EINTR || errno == EAGAIN));
195 if (rc <= 0) {
196 vu_panic(dev, "Error while reading: %s", strerror(errno));
197 goto fail;
200 assert(rc == vmsg->size);
203 return true;
205 fail:
206 vmsg_close_fds(vmsg);
208 return false;
211 static bool
212 vu_message_write(VuDev *dev, int conn_fd, VhostUserMsg *vmsg)
214 int rc;
215 uint8_t *p = (uint8_t *)vmsg;
217 /* Set the version in the flags when sending the reply */
218 vmsg->flags &= ~VHOST_USER_VERSION_MASK;
219 vmsg->flags |= VHOST_USER_VERSION;
220 vmsg->flags |= VHOST_USER_REPLY_MASK;
222 do {
223 rc = write(conn_fd, p, VHOST_USER_HDR_SIZE);
224 } while (rc < 0 && (errno == EINTR || errno == EAGAIN));
226 do {
227 if (vmsg->data) {
228 rc = write(conn_fd, vmsg->data, vmsg->size);
229 } else {
230 rc = write(conn_fd, p + VHOST_USER_HDR_SIZE, vmsg->size);
232 } while (rc < 0 && (errno == EINTR || errno == EAGAIN));
234 if (rc <= 0) {
235 vu_panic(dev, "Error while writing: %s", strerror(errno));
236 return false;
239 return true;
242 /* Kick the log_call_fd if required. */
243 static void
244 vu_log_kick(VuDev *dev)
246 if (dev->log_call_fd != -1) {
247 DPRINT("Kicking the QEMU's log...\n");
248 if (eventfd_write(dev->log_call_fd, 1) < 0) {
249 vu_panic(dev, "Error writing eventfd: %s", strerror(errno));
254 static void
255 vu_log_page(uint8_t *log_table, uint64_t page)
257 DPRINT("Logged dirty guest page: %"PRId64"\n", page);
258 atomic_or(&log_table[page / 8], 1 << (page % 8));
261 static void
262 vu_log_write(VuDev *dev, uint64_t address, uint64_t length)
264 uint64_t page;
266 if (!(dev->features & (1ULL << VHOST_F_LOG_ALL)) ||
267 !dev->log_table || !length) {
268 return;
271 assert(dev->log_size > ((address + length - 1) / VHOST_LOG_PAGE / 8));
273 page = address / VHOST_LOG_PAGE;
274 while (page * VHOST_LOG_PAGE < address + length) {
275 vu_log_page(dev->log_table, page);
276 page += VHOST_LOG_PAGE;
279 vu_log_kick(dev);
282 static void
283 vu_kick_cb(VuDev *dev, int condition, void *data)
285 int index = (intptr_t)data;
286 VuVirtq *vq = &dev->vq[index];
287 int sock = vq->kick_fd;
288 eventfd_t kick_data;
289 ssize_t rc;
291 rc = eventfd_read(sock, &kick_data);
292 if (rc == -1) {
293 vu_panic(dev, "kick eventfd_read(): %s", strerror(errno));
294 dev->remove_watch(dev, dev->vq[index].kick_fd);
295 } else {
296 DPRINT("Got kick_data: %016"PRIx64" handler:%p idx:%d\n",
297 kick_data, vq->handler, index);
298 if (vq->handler) {
299 vq->handler(dev, index);
304 static bool
305 vu_get_features_exec(VuDev *dev, VhostUserMsg *vmsg)
307 vmsg->payload.u64 =
308 1ULL << VHOST_F_LOG_ALL |
309 1ULL << VHOST_USER_F_PROTOCOL_FEATURES;
311 if (dev->iface->get_features) {
312 vmsg->payload.u64 |= dev->iface->get_features(dev);
315 vmsg->size = sizeof(vmsg->payload.u64);
317 DPRINT("Sending back to guest u64: 0x%016"PRIx64"\n", vmsg->payload.u64);
319 return true;
322 static void
323 vu_set_enable_all_rings(VuDev *dev, bool enabled)
325 int i;
327 for (i = 0; i < VHOST_MAX_NR_VIRTQUEUE; i++) {
328 dev->vq[i].enable = enabled;
332 static bool
333 vu_set_features_exec(VuDev *dev, VhostUserMsg *vmsg)
335 DPRINT("u64: 0x%016"PRIx64"\n", vmsg->payload.u64);
337 dev->features = vmsg->payload.u64;
339 if (!(dev->features & VHOST_USER_F_PROTOCOL_FEATURES)) {
340 vu_set_enable_all_rings(dev, true);
343 if (dev->iface->set_features) {
344 dev->iface->set_features(dev, dev->features);
347 return false;
350 static bool
351 vu_set_owner_exec(VuDev *dev, VhostUserMsg *vmsg)
353 return false;
356 static void
357 vu_close_log(VuDev *dev)
359 if (dev->log_table) {
360 if (munmap(dev->log_table, dev->log_size) != 0) {
361 perror("close log munmap() error");
364 dev->log_table = NULL;
366 if (dev->log_call_fd != -1) {
367 close(dev->log_call_fd);
368 dev->log_call_fd = -1;
372 static bool
373 vu_reset_device_exec(VuDev *dev, VhostUserMsg *vmsg)
375 vu_set_enable_all_rings(dev, false);
377 return false;
380 static bool
381 vu_set_mem_table_exec(VuDev *dev, VhostUserMsg *vmsg)
383 int i;
384 VhostUserMemory *memory = &vmsg->payload.memory;
385 dev->nregions = memory->nregions;
387 DPRINT("Nregions: %d\n", memory->nregions);
388 for (i = 0; i < dev->nregions; i++) {
389 void *mmap_addr;
390 VhostUserMemoryRegion *msg_region = &memory->regions[i];
391 VuDevRegion *dev_region = &dev->regions[i];
393 DPRINT("Region %d\n", i);
394 DPRINT(" guest_phys_addr: 0x%016"PRIx64"\n",
395 msg_region->guest_phys_addr);
396 DPRINT(" memory_size: 0x%016"PRIx64"\n",
397 msg_region->memory_size);
398 DPRINT(" userspace_addr 0x%016"PRIx64"\n",
399 msg_region->userspace_addr);
400 DPRINT(" mmap_offset 0x%016"PRIx64"\n",
401 msg_region->mmap_offset);
403 dev_region->gpa = msg_region->guest_phys_addr;
404 dev_region->size = msg_region->memory_size;
405 dev_region->qva = msg_region->userspace_addr;
406 dev_region->mmap_offset = msg_region->mmap_offset;
408 /* We don't use offset argument of mmap() since the
409 * mapped address has to be page aligned, and we use huge
410 * pages. */
411 mmap_addr = mmap(0, dev_region->size + dev_region->mmap_offset,
412 PROT_READ | PROT_WRITE, MAP_SHARED,
413 vmsg->fds[i], 0);
415 if (mmap_addr == MAP_FAILED) {
416 vu_panic(dev, "region mmap error: %s", strerror(errno));
417 } else {
418 dev_region->mmap_addr = (uint64_t)(uintptr_t)mmap_addr;
419 DPRINT(" mmap_addr: 0x%016"PRIx64"\n",
420 dev_region->mmap_addr);
423 close(vmsg->fds[i]);
426 return false;
429 static bool
430 vu_set_log_base_exec(VuDev *dev, VhostUserMsg *vmsg)
432 int fd;
433 uint64_t log_mmap_size, log_mmap_offset;
434 void *rc;
436 if (vmsg->fd_num != 1 ||
437 vmsg->size != sizeof(vmsg->payload.log)) {
438 vu_panic(dev, "Invalid log_base message");
439 return true;
442 fd = vmsg->fds[0];
443 log_mmap_offset = vmsg->payload.log.mmap_offset;
444 log_mmap_size = vmsg->payload.log.mmap_size;
445 DPRINT("Log mmap_offset: %"PRId64"\n", log_mmap_offset);
446 DPRINT("Log mmap_size: %"PRId64"\n", log_mmap_size);
448 rc = mmap(0, log_mmap_size, PROT_READ | PROT_WRITE, MAP_SHARED, fd,
449 log_mmap_offset);
450 if (rc == MAP_FAILED) {
451 perror("log mmap error");
453 dev->log_table = rc;
454 dev->log_size = log_mmap_size;
456 vmsg->size = sizeof(vmsg->payload.u64);
458 return true;
461 static bool
462 vu_set_log_fd_exec(VuDev *dev, VhostUserMsg *vmsg)
464 if (vmsg->fd_num != 1) {
465 vu_panic(dev, "Invalid log_fd message");
466 return false;
469 if (dev->log_call_fd != -1) {
470 close(dev->log_call_fd);
472 dev->log_call_fd = vmsg->fds[0];
473 DPRINT("Got log_call_fd: %d\n", vmsg->fds[0]);
475 return false;
478 static bool
479 vu_set_vring_num_exec(VuDev *dev, VhostUserMsg *vmsg)
481 unsigned int index = vmsg->payload.state.index;
482 unsigned int num = vmsg->payload.state.num;
484 DPRINT("State.index: %d\n", index);
485 DPRINT("State.num: %d\n", num);
486 dev->vq[index].vring.num = num;
488 return false;
491 static bool
492 vu_set_vring_addr_exec(VuDev *dev, VhostUserMsg *vmsg)
494 struct vhost_vring_addr *vra = &vmsg->payload.addr;
495 unsigned int index = vra->index;
496 VuVirtq *vq = &dev->vq[index];
498 DPRINT("vhost_vring_addr:\n");
499 DPRINT(" index: %d\n", vra->index);
500 DPRINT(" flags: %d\n", vra->flags);
501 DPRINT(" desc_user_addr: 0x%016llx\n", vra->desc_user_addr);
502 DPRINT(" used_user_addr: 0x%016llx\n", vra->used_user_addr);
503 DPRINT(" avail_user_addr: 0x%016llx\n", vra->avail_user_addr);
504 DPRINT(" log_guest_addr: 0x%016llx\n", vra->log_guest_addr);
506 vq->vring.flags = vra->flags;
507 vq->vring.desc = qva_to_va(dev, vra->desc_user_addr);
508 vq->vring.used = qva_to_va(dev, vra->used_user_addr);
509 vq->vring.avail = qva_to_va(dev, vra->avail_user_addr);
510 vq->vring.log_guest_addr = vra->log_guest_addr;
512 DPRINT("Setting virtq addresses:\n");
513 DPRINT(" vring_desc at %p\n", vq->vring.desc);
514 DPRINT(" vring_used at %p\n", vq->vring.used);
515 DPRINT(" vring_avail at %p\n", vq->vring.avail);
517 if (!(vq->vring.desc && vq->vring.used && vq->vring.avail)) {
518 vu_panic(dev, "Invalid vring_addr message");
519 return false;
522 vq->used_idx = vq->vring.used->idx;
524 if (vq->last_avail_idx != vq->used_idx) {
525 bool resume = dev->iface->queue_is_processed_in_order &&
526 dev->iface->queue_is_processed_in_order(dev, index);
528 DPRINT("Last avail index != used index: %u != %u%s\n",
529 vq->last_avail_idx, vq->used_idx,
530 resume ? ", resuming" : "");
532 if (resume) {
533 vq->shadow_avail_idx = vq->last_avail_idx = vq->used_idx;
537 return false;
540 static bool
541 vu_set_vring_base_exec(VuDev *dev, VhostUserMsg *vmsg)
543 unsigned int index = vmsg->payload.state.index;
544 unsigned int num = vmsg->payload.state.num;
546 DPRINT("State.index: %d\n", index);
547 DPRINT("State.num: %d\n", num);
548 dev->vq[index].shadow_avail_idx = dev->vq[index].last_avail_idx = num;
550 return false;
553 static bool
554 vu_get_vring_base_exec(VuDev *dev, VhostUserMsg *vmsg)
556 unsigned int index = vmsg->payload.state.index;
558 DPRINT("State.index: %d\n", index);
559 vmsg->payload.state.num = dev->vq[index].last_avail_idx;
560 vmsg->size = sizeof(vmsg->payload.state);
562 dev->vq[index].started = false;
563 if (dev->iface->queue_set_started) {
564 dev->iface->queue_set_started(dev, index, false);
567 if (dev->vq[index].call_fd != -1) {
568 close(dev->vq[index].call_fd);
569 dev->vq[index].call_fd = -1;
571 if (dev->vq[index].kick_fd != -1) {
572 dev->remove_watch(dev, dev->vq[index].kick_fd);
573 close(dev->vq[index].kick_fd);
574 dev->vq[index].kick_fd = -1;
577 return true;
580 static bool
581 vu_check_queue_msg_file(VuDev *dev, VhostUserMsg *vmsg)
583 int index = vmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
585 if (index >= VHOST_MAX_NR_VIRTQUEUE) {
586 vmsg_close_fds(vmsg);
587 vu_panic(dev, "Invalid queue index: %u", index);
588 return false;
591 if (vmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK ||
592 vmsg->fd_num != 1) {
593 vmsg_close_fds(vmsg);
594 vu_panic(dev, "Invalid fds in request: %d", vmsg->request);
595 return false;
598 return true;
601 static bool
602 vu_set_vring_kick_exec(VuDev *dev, VhostUserMsg *vmsg)
604 int index = vmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
606 DPRINT("u64: 0x%016"PRIx64"\n", vmsg->payload.u64);
608 if (!vu_check_queue_msg_file(dev, vmsg)) {
609 return false;
612 if (dev->vq[index].kick_fd != -1) {
613 dev->remove_watch(dev, dev->vq[index].kick_fd);
614 close(dev->vq[index].kick_fd);
615 dev->vq[index].kick_fd = -1;
618 if (!(vmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)) {
619 dev->vq[index].kick_fd = vmsg->fds[0];
620 DPRINT("Got kick_fd: %d for vq: %d\n", vmsg->fds[0], index);
623 dev->vq[index].started = true;
624 if (dev->iface->queue_set_started) {
625 dev->iface->queue_set_started(dev, index, true);
628 if (dev->vq[index].kick_fd != -1 && dev->vq[index].handler) {
629 dev->set_watch(dev, dev->vq[index].kick_fd, VU_WATCH_IN,
630 vu_kick_cb, (void *)(long)index);
632 DPRINT("Waiting for kicks on fd: %d for vq: %d\n",
633 dev->vq[index].kick_fd, index);
636 return false;
639 void vu_set_queue_handler(VuDev *dev, VuVirtq *vq,
640 vu_queue_handler_cb handler)
642 int qidx = vq - dev->vq;
644 vq->handler = handler;
645 if (vq->kick_fd >= 0) {
646 if (handler) {
647 dev->set_watch(dev, vq->kick_fd, VU_WATCH_IN,
648 vu_kick_cb, (void *)(long)qidx);
649 } else {
650 dev->remove_watch(dev, vq->kick_fd);
655 static bool
656 vu_set_vring_call_exec(VuDev *dev, VhostUserMsg *vmsg)
658 int index = vmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
660 DPRINT("u64: 0x%016"PRIx64"\n", vmsg->payload.u64);
662 if (!vu_check_queue_msg_file(dev, vmsg)) {
663 return false;
666 if (dev->vq[index].call_fd != -1) {
667 close(dev->vq[index].call_fd);
668 dev->vq[index].call_fd = -1;
671 if (!(vmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)) {
672 dev->vq[index].call_fd = vmsg->fds[0];
675 DPRINT("Got call_fd: %d for vq: %d\n", vmsg->fds[0], index);
677 return false;
680 static bool
681 vu_set_vring_err_exec(VuDev *dev, VhostUserMsg *vmsg)
683 int index = vmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
685 DPRINT("u64: 0x%016"PRIx64"\n", vmsg->payload.u64);
687 if (!vu_check_queue_msg_file(dev, vmsg)) {
688 return false;
691 if (dev->vq[index].err_fd != -1) {
692 close(dev->vq[index].err_fd);
693 dev->vq[index].err_fd = -1;
696 if (!(vmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)) {
697 dev->vq[index].err_fd = vmsg->fds[0];
700 return false;
703 static bool
704 vu_get_protocol_features_exec(VuDev *dev, VhostUserMsg *vmsg)
706 uint64_t features = 1ULL << VHOST_USER_PROTOCOL_F_LOG_SHMFD;
708 if (dev->iface->get_protocol_features) {
709 features |= dev->iface->get_protocol_features(dev);
712 vmsg->payload.u64 = features;
713 vmsg->size = sizeof(vmsg->payload.u64);
715 return true;
718 static bool
719 vu_set_protocol_features_exec(VuDev *dev, VhostUserMsg *vmsg)
721 uint64_t features = vmsg->payload.u64;
723 DPRINT("u64: 0x%016"PRIx64"\n", features);
725 dev->protocol_features = vmsg->payload.u64;
727 if (dev->iface->set_protocol_features) {
728 dev->iface->set_protocol_features(dev, features);
731 return false;
734 static bool
735 vu_get_queue_num_exec(VuDev *dev, VhostUserMsg *vmsg)
737 DPRINT("Function %s() not implemented yet.\n", __func__);
738 return false;
741 static bool
742 vu_set_vring_enable_exec(VuDev *dev, VhostUserMsg *vmsg)
744 unsigned int index = vmsg->payload.state.index;
745 unsigned int enable = vmsg->payload.state.num;
747 DPRINT("State.index: %d\n", index);
748 DPRINT("State.enable: %d\n", enable);
750 if (index >= VHOST_MAX_NR_VIRTQUEUE) {
751 vu_panic(dev, "Invalid vring_enable index: %u", index);
752 return false;
755 dev->vq[index].enable = enable;
756 return false;
759 static bool
760 vu_process_message(VuDev *dev, VhostUserMsg *vmsg)
762 int do_reply = 0;
764 /* Print out generic part of the request. */
765 DPRINT("================ Vhost user message ================\n");
766 DPRINT("Request: %s (%d)\n", vu_request_to_string(vmsg->request),
767 vmsg->request);
768 DPRINT("Flags: 0x%x\n", vmsg->flags);
769 DPRINT("Size: %d\n", vmsg->size);
771 if (vmsg->fd_num) {
772 int i;
773 DPRINT("Fds:");
774 for (i = 0; i < vmsg->fd_num; i++) {
775 DPRINT(" %d", vmsg->fds[i]);
777 DPRINT("\n");
780 if (dev->iface->process_msg &&
781 dev->iface->process_msg(dev, vmsg, &do_reply)) {
782 return do_reply;
785 switch (vmsg->request) {
786 case VHOST_USER_GET_FEATURES:
787 return vu_get_features_exec(dev, vmsg);
788 case VHOST_USER_SET_FEATURES:
789 return vu_set_features_exec(dev, vmsg);
790 case VHOST_USER_GET_PROTOCOL_FEATURES:
791 return vu_get_protocol_features_exec(dev, vmsg);
792 case VHOST_USER_SET_PROTOCOL_FEATURES:
793 return vu_set_protocol_features_exec(dev, vmsg);
794 case VHOST_USER_SET_OWNER:
795 return vu_set_owner_exec(dev, vmsg);
796 case VHOST_USER_RESET_OWNER:
797 return vu_reset_device_exec(dev, vmsg);
798 case VHOST_USER_SET_MEM_TABLE:
799 return vu_set_mem_table_exec(dev, vmsg);
800 case VHOST_USER_SET_LOG_BASE:
801 return vu_set_log_base_exec(dev, vmsg);
802 case VHOST_USER_SET_LOG_FD:
803 return vu_set_log_fd_exec(dev, vmsg);
804 case VHOST_USER_SET_VRING_NUM:
805 return vu_set_vring_num_exec(dev, vmsg);
806 case VHOST_USER_SET_VRING_ADDR:
807 return vu_set_vring_addr_exec(dev, vmsg);
808 case VHOST_USER_SET_VRING_BASE:
809 return vu_set_vring_base_exec(dev, vmsg);
810 case VHOST_USER_GET_VRING_BASE:
811 return vu_get_vring_base_exec(dev, vmsg);
812 case VHOST_USER_SET_VRING_KICK:
813 return vu_set_vring_kick_exec(dev, vmsg);
814 case VHOST_USER_SET_VRING_CALL:
815 return vu_set_vring_call_exec(dev, vmsg);
816 case VHOST_USER_SET_VRING_ERR:
817 return vu_set_vring_err_exec(dev, vmsg);
818 case VHOST_USER_GET_QUEUE_NUM:
819 return vu_get_queue_num_exec(dev, vmsg);
820 case VHOST_USER_SET_VRING_ENABLE:
821 return vu_set_vring_enable_exec(dev, vmsg);
822 case VHOST_USER_NONE:
823 break;
824 default:
825 vmsg_close_fds(vmsg);
826 vu_panic(dev, "Unhandled request: %d", vmsg->request);
829 return false;
832 bool
833 vu_dispatch(VuDev *dev)
835 VhostUserMsg vmsg = { 0, };
836 int reply_requested;
837 bool success = false;
839 if (!vu_message_read(dev, dev->sock, &vmsg)) {
840 goto end;
843 reply_requested = vu_process_message(dev, &vmsg);
844 if (!reply_requested) {
845 success = true;
846 goto end;
849 if (!vu_message_write(dev, dev->sock, &vmsg)) {
850 goto end;
853 success = true;
855 end:
856 g_free(vmsg.data);
857 return success;
860 void
861 vu_deinit(VuDev *dev)
863 int i;
865 for (i = 0; i < dev->nregions; i++) {
866 VuDevRegion *r = &dev->regions[i];
867 void *m = (void *) (uintptr_t) r->mmap_addr;
868 if (m != MAP_FAILED) {
869 munmap(m, r->size + r->mmap_offset);
872 dev->nregions = 0;
874 for (i = 0; i < VHOST_MAX_NR_VIRTQUEUE; i++) {
875 VuVirtq *vq = &dev->vq[i];
877 if (vq->call_fd != -1) {
878 close(vq->call_fd);
879 vq->call_fd = -1;
882 if (vq->kick_fd != -1) {
883 close(vq->kick_fd);
884 vq->kick_fd = -1;
887 if (vq->err_fd != -1) {
888 close(vq->err_fd);
889 vq->err_fd = -1;
894 vu_close_log(dev);
896 if (dev->sock != -1) {
897 close(dev->sock);
901 void
902 vu_init(VuDev *dev,
903 int socket,
904 vu_panic_cb panic,
905 vu_set_watch_cb set_watch,
906 vu_remove_watch_cb remove_watch,
907 const VuDevIface *iface)
909 int i;
911 assert(socket >= 0);
912 assert(set_watch);
913 assert(remove_watch);
914 assert(iface);
915 assert(panic);
917 memset(dev, 0, sizeof(*dev));
919 dev->sock = socket;
920 dev->panic = panic;
921 dev->set_watch = set_watch;
922 dev->remove_watch = remove_watch;
923 dev->iface = iface;
924 dev->log_call_fd = -1;
925 for (i = 0; i < VHOST_MAX_NR_VIRTQUEUE; i++) {
926 dev->vq[i] = (VuVirtq) {
927 .call_fd = -1, .kick_fd = -1, .err_fd = -1,
928 .notification = true,
933 VuVirtq *
934 vu_get_queue(VuDev *dev, int qidx)
936 assert(qidx < VHOST_MAX_NR_VIRTQUEUE);
937 return &dev->vq[qidx];
940 bool
941 vu_queue_enabled(VuDev *dev, VuVirtq *vq)
943 return vq->enable;
946 static inline uint16_t
947 vring_avail_flags(VuVirtq *vq)
949 return vq->vring.avail->flags;
952 static inline uint16_t
953 vring_avail_idx(VuVirtq *vq)
955 vq->shadow_avail_idx = vq->vring.avail->idx;
957 return vq->shadow_avail_idx;
960 static inline uint16_t
961 vring_avail_ring(VuVirtq *vq, int i)
963 return vq->vring.avail->ring[i];
966 static inline uint16_t
967 vring_get_used_event(VuVirtq *vq)
969 return vring_avail_ring(vq, vq->vring.num);
972 static int
973 virtqueue_num_heads(VuDev *dev, VuVirtq *vq, unsigned int idx)
975 uint16_t num_heads = vring_avail_idx(vq) - idx;
977 /* Check it isn't doing very strange things with descriptor numbers. */
978 if (num_heads > vq->vring.num) {
979 vu_panic(dev, "Guest moved used index from %u to %u",
980 idx, vq->shadow_avail_idx);
981 return -1;
983 if (num_heads) {
984 /* On success, callers read a descriptor at vq->last_avail_idx.
985 * Make sure descriptor read does not bypass avail index read. */
986 smp_rmb();
989 return num_heads;
992 static bool
993 virtqueue_get_head(VuDev *dev, VuVirtq *vq,
994 unsigned int idx, unsigned int *head)
996 /* Grab the next descriptor number they're advertising, and increment
997 * the index we've seen. */
998 *head = vring_avail_ring(vq, idx % vq->vring.num);
1000 /* If their number is silly, that's a fatal mistake. */
1001 if (*head >= vq->vring.num) {
1002 vu_panic(dev, "Guest says index %u is available", head);
1003 return false;
1006 return true;
1009 enum {
1010 VIRTQUEUE_READ_DESC_ERROR = -1,
1011 VIRTQUEUE_READ_DESC_DONE = 0, /* end of chain */
1012 VIRTQUEUE_READ_DESC_MORE = 1, /* more buffers in chain */
1015 static int
1016 virtqueue_read_next_desc(VuDev *dev, struct vring_desc *desc,
1017 int i, unsigned int max, unsigned int *next)
1019 /* If this descriptor says it doesn't chain, we're done. */
1020 if (!(desc[i].flags & VRING_DESC_F_NEXT)) {
1021 return VIRTQUEUE_READ_DESC_DONE;
1024 /* Check they're not leading us off end of descriptors. */
1025 *next = desc[i].next;
1026 /* Make sure compiler knows to grab that: we don't want it changing! */
1027 smp_wmb();
1029 if (*next >= max) {
1030 vu_panic(dev, "Desc next is %u", next);
1031 return VIRTQUEUE_READ_DESC_ERROR;
1034 return VIRTQUEUE_READ_DESC_MORE;
1037 void
1038 vu_queue_get_avail_bytes(VuDev *dev, VuVirtq *vq, unsigned int *in_bytes,
1039 unsigned int *out_bytes,
1040 unsigned max_in_bytes, unsigned max_out_bytes)
1042 unsigned int idx;
1043 unsigned int total_bufs, in_total, out_total;
1044 int rc;
1046 idx = vq->last_avail_idx;
1048 total_bufs = in_total = out_total = 0;
1049 if (unlikely(dev->broken) ||
1050 unlikely(!vq->vring.avail)) {
1051 goto done;
1054 while ((rc = virtqueue_num_heads(dev, vq, idx)) > 0) {
1055 unsigned int max, num_bufs, indirect = 0;
1056 struct vring_desc *desc;
1057 unsigned int i;
1059 max = vq->vring.num;
1060 num_bufs = total_bufs;
1061 if (!virtqueue_get_head(dev, vq, idx++, &i)) {
1062 goto err;
1064 desc = vq->vring.desc;
1066 if (desc[i].flags & VRING_DESC_F_INDIRECT) {
1067 if (desc[i].len % sizeof(struct vring_desc)) {
1068 vu_panic(dev, "Invalid size for indirect buffer table");
1069 goto err;
1072 /* If we've got too many, that implies a descriptor loop. */
1073 if (num_bufs >= max) {
1074 vu_panic(dev, "Looped descriptor");
1075 goto err;
1078 /* loop over the indirect descriptor table */
1079 indirect = 1;
1080 max = desc[i].len / sizeof(struct vring_desc);
1081 desc = vu_gpa_to_va(dev, desc[i].addr);
1082 num_bufs = i = 0;
1085 do {
1086 /* If we've got too many, that implies a descriptor loop. */
1087 if (++num_bufs > max) {
1088 vu_panic(dev, "Looped descriptor");
1089 goto err;
1092 if (desc[i].flags & VRING_DESC_F_WRITE) {
1093 in_total += desc[i].len;
1094 } else {
1095 out_total += desc[i].len;
1097 if (in_total >= max_in_bytes && out_total >= max_out_bytes) {
1098 goto done;
1100 rc = virtqueue_read_next_desc(dev, desc, i, max, &i);
1101 } while (rc == VIRTQUEUE_READ_DESC_MORE);
1103 if (rc == VIRTQUEUE_READ_DESC_ERROR) {
1104 goto err;
1107 if (!indirect) {
1108 total_bufs = num_bufs;
1109 } else {
1110 total_bufs++;
1113 if (rc < 0) {
1114 goto err;
1116 done:
1117 if (in_bytes) {
1118 *in_bytes = in_total;
1120 if (out_bytes) {
1121 *out_bytes = out_total;
1123 return;
1125 err:
1126 in_total = out_total = 0;
1127 goto done;
1130 bool
1131 vu_queue_avail_bytes(VuDev *dev, VuVirtq *vq, unsigned int in_bytes,
1132 unsigned int out_bytes)
1134 unsigned int in_total, out_total;
1136 vu_queue_get_avail_bytes(dev, vq, &in_total, &out_total,
1137 in_bytes, out_bytes);
1139 return in_bytes <= in_total && out_bytes <= out_total;
1142 /* Fetch avail_idx from VQ memory only when we really need to know if
1143 * guest has added some buffers. */
1144 bool
1145 vu_queue_empty(VuDev *dev, VuVirtq *vq)
1147 if (unlikely(dev->broken) ||
1148 unlikely(!vq->vring.avail)) {
1149 return true;
1152 if (vq->shadow_avail_idx != vq->last_avail_idx) {
1153 return false;
1156 return vring_avail_idx(vq) == vq->last_avail_idx;
1159 static inline
1160 bool has_feature(uint64_t features, unsigned int fbit)
1162 assert(fbit < 64);
1163 return !!(features & (1ULL << fbit));
1166 static inline
1167 bool vu_has_feature(VuDev *dev,
1168 unsigned int fbit)
1170 return has_feature(dev->features, fbit);
1173 static bool
1174 vring_notify(VuDev *dev, VuVirtq *vq)
1176 uint16_t old, new;
1177 bool v;
1179 /* We need to expose used array entries before checking used event. */
1180 smp_mb();
1182 /* Always notify when queue is empty (when feature acknowledge) */
1183 if (vu_has_feature(dev, VIRTIO_F_NOTIFY_ON_EMPTY) &&
1184 !vq->inuse && vu_queue_empty(dev, vq)) {
1185 return true;
1188 if (!vu_has_feature(dev, VIRTIO_RING_F_EVENT_IDX)) {
1189 return !(vring_avail_flags(vq) & VRING_AVAIL_F_NO_INTERRUPT);
1192 v = vq->signalled_used_valid;
1193 vq->signalled_used_valid = true;
1194 old = vq->signalled_used;
1195 new = vq->signalled_used = vq->used_idx;
1196 return !v || vring_need_event(vring_get_used_event(vq), new, old);
1199 void
1200 vu_queue_notify(VuDev *dev, VuVirtq *vq)
1202 if (unlikely(dev->broken) ||
1203 unlikely(!vq->vring.avail)) {
1204 return;
1207 if (!vring_notify(dev, vq)) {
1208 DPRINT("skipped notify...\n");
1209 return;
1212 if (eventfd_write(vq->call_fd, 1) < 0) {
1213 vu_panic(dev, "Error writing eventfd: %s", strerror(errno));
1217 static inline void
1218 vring_used_flags_set_bit(VuVirtq *vq, int mask)
1220 uint16_t *flags;
1222 flags = (uint16_t *)((char*)vq->vring.used +
1223 offsetof(struct vring_used, flags));
1224 *flags |= mask;
1227 static inline void
1228 vring_used_flags_unset_bit(VuVirtq *vq, int mask)
1230 uint16_t *flags;
1232 flags = (uint16_t *)((char*)vq->vring.used +
1233 offsetof(struct vring_used, flags));
1234 *flags &= ~mask;
1237 static inline void
1238 vring_set_avail_event(VuVirtq *vq, uint16_t val)
1240 if (!vq->notification) {
1241 return;
1244 *((uint16_t *) &vq->vring.used->ring[vq->vring.num]) = val;
1247 void
1248 vu_queue_set_notification(VuDev *dev, VuVirtq *vq, int enable)
1250 vq->notification = enable;
1251 if (vu_has_feature(dev, VIRTIO_RING_F_EVENT_IDX)) {
1252 vring_set_avail_event(vq, vring_avail_idx(vq));
1253 } else if (enable) {
1254 vring_used_flags_unset_bit(vq, VRING_USED_F_NO_NOTIFY);
1255 } else {
1256 vring_used_flags_set_bit(vq, VRING_USED_F_NO_NOTIFY);
1258 if (enable) {
1259 /* Expose avail event/used flags before caller checks the avail idx. */
1260 smp_mb();
1264 static void
1265 virtqueue_map_desc(VuDev *dev,
1266 unsigned int *p_num_sg, struct iovec *iov,
1267 unsigned int max_num_sg, bool is_write,
1268 uint64_t pa, size_t sz)
1270 unsigned num_sg = *p_num_sg;
1272 assert(num_sg <= max_num_sg);
1274 if (!sz) {
1275 vu_panic(dev, "virtio: zero sized buffers are not allowed");
1276 return;
1279 iov[num_sg].iov_base = vu_gpa_to_va(dev, pa);
1280 iov[num_sg].iov_len = sz;
1281 num_sg++;
1283 *p_num_sg = num_sg;
1286 /* Round number down to multiple */
1287 #define ALIGN_DOWN(n, m) ((n) / (m) * (m))
1289 /* Round number up to multiple */
1290 #define ALIGN_UP(n, m) ALIGN_DOWN((n) + (m) - 1, (m))
1292 static void *
1293 virtqueue_alloc_element(size_t sz,
1294 unsigned out_num, unsigned in_num)
1296 VuVirtqElement *elem;
1297 size_t in_sg_ofs = ALIGN_UP(sz, __alignof__(elem->in_sg[0]));
1298 size_t out_sg_ofs = in_sg_ofs + in_num * sizeof(elem->in_sg[0]);
1299 size_t out_sg_end = out_sg_ofs + out_num * sizeof(elem->out_sg[0]);
1301 assert(sz >= sizeof(VuVirtqElement));
1302 elem = malloc(out_sg_end);
1303 elem->out_num = out_num;
1304 elem->in_num = in_num;
1305 elem->in_sg = (void *)elem + in_sg_ofs;
1306 elem->out_sg = (void *)elem + out_sg_ofs;
1307 return elem;
1310 void *
1311 vu_queue_pop(VuDev *dev, VuVirtq *vq, size_t sz)
1313 unsigned int i, head, max;
1314 VuVirtqElement *elem;
1315 unsigned out_num, in_num;
1316 struct iovec iov[VIRTQUEUE_MAX_SIZE];
1317 struct vring_desc *desc;
1318 int rc;
1320 if (unlikely(dev->broken) ||
1321 unlikely(!vq->vring.avail)) {
1322 return NULL;
1325 if (vu_queue_empty(dev, vq)) {
1326 return NULL;
1328 /* Needed after virtio_queue_empty(), see comment in
1329 * virtqueue_num_heads(). */
1330 smp_rmb();
1332 /* When we start there are none of either input nor output. */
1333 out_num = in_num = 0;
1335 max = vq->vring.num;
1336 if (vq->inuse >= vq->vring.num) {
1337 vu_panic(dev, "Virtqueue size exceeded");
1338 return NULL;
1341 if (!virtqueue_get_head(dev, vq, vq->last_avail_idx++, &head)) {
1342 return NULL;
1345 if (vu_has_feature(dev, VIRTIO_RING_F_EVENT_IDX)) {
1346 vring_set_avail_event(vq, vq->last_avail_idx);
1349 i = head;
1350 desc = vq->vring.desc;
1351 if (desc[i].flags & VRING_DESC_F_INDIRECT) {
1352 if (desc[i].len % sizeof(struct vring_desc)) {
1353 vu_panic(dev, "Invalid size for indirect buffer table");
1356 /* loop over the indirect descriptor table */
1357 max = desc[i].len / sizeof(struct vring_desc);
1358 desc = vu_gpa_to_va(dev, desc[i].addr);
1359 i = 0;
1362 /* Collect all the descriptors */
1363 do {
1364 if (desc[i].flags & VRING_DESC_F_WRITE) {
1365 virtqueue_map_desc(dev, &in_num, iov + out_num,
1366 VIRTQUEUE_MAX_SIZE - out_num, true,
1367 desc[i].addr, desc[i].len);
1368 } else {
1369 if (in_num) {
1370 vu_panic(dev, "Incorrect order for descriptors");
1371 return NULL;
1373 virtqueue_map_desc(dev, &out_num, iov,
1374 VIRTQUEUE_MAX_SIZE, false,
1375 desc[i].addr, desc[i].len);
1378 /* If we've got too many, that implies a descriptor loop. */
1379 if ((in_num + out_num) > max) {
1380 vu_panic(dev, "Looped descriptor");
1382 rc = virtqueue_read_next_desc(dev, desc, i, max, &i);
1383 } while (rc == VIRTQUEUE_READ_DESC_MORE);
1385 if (rc == VIRTQUEUE_READ_DESC_ERROR) {
1386 return NULL;
1389 /* Now copy what we have collected and mapped */
1390 elem = virtqueue_alloc_element(sz, out_num, in_num);
1391 elem->index = head;
1392 for (i = 0; i < out_num; i++) {
1393 elem->out_sg[i] = iov[i];
1395 for (i = 0; i < in_num; i++) {
1396 elem->in_sg[i] = iov[out_num + i];
1399 vq->inuse++;
1401 return elem;
1404 bool
1405 vu_queue_rewind(VuDev *dev, VuVirtq *vq, unsigned int num)
1407 if (num > vq->inuse) {
1408 return false;
1410 vq->last_avail_idx -= num;
1411 vq->inuse -= num;
1412 return true;
1415 static inline
1416 void vring_used_write(VuDev *dev, VuVirtq *vq,
1417 struct vring_used_elem *uelem, int i)
1419 struct vring_used *used = vq->vring.used;
1421 used->ring[i] = *uelem;
1422 vu_log_write(dev, vq->vring.log_guest_addr +
1423 offsetof(struct vring_used, ring[i]),
1424 sizeof(used->ring[i]));
1428 static void
1429 vu_log_queue_fill(VuDev *dev, VuVirtq *vq,
1430 const VuVirtqElement *elem,
1431 unsigned int len)
1433 struct vring_desc *desc = vq->vring.desc;
1434 unsigned int i, max, min;
1435 unsigned num_bufs = 0;
1437 max = vq->vring.num;
1438 i = elem->index;
1440 if (desc[i].flags & VRING_DESC_F_INDIRECT) {
1441 if (desc[i].len % sizeof(struct vring_desc)) {
1442 vu_panic(dev, "Invalid size for indirect buffer table");
1445 /* loop over the indirect descriptor table */
1446 max = desc[i].len / sizeof(struct vring_desc);
1447 desc = vu_gpa_to_va(dev, desc[i].addr);
1448 i = 0;
1451 do {
1452 if (++num_bufs > max) {
1453 vu_panic(dev, "Looped descriptor");
1454 return;
1457 if (desc[i].flags & VRING_DESC_F_WRITE) {
1458 min = MIN(desc[i].len, len);
1459 vu_log_write(dev, desc[i].addr, min);
1460 len -= min;
1463 } while (len > 0 &&
1464 (virtqueue_read_next_desc(dev, desc, i, max, &i)
1465 == VIRTQUEUE_READ_DESC_MORE));
1468 void
1469 vu_queue_fill(VuDev *dev, VuVirtq *vq,
1470 const VuVirtqElement *elem,
1471 unsigned int len, unsigned int idx)
1473 struct vring_used_elem uelem;
1475 if (unlikely(dev->broken) ||
1476 unlikely(!vq->vring.avail)) {
1477 return;
1480 vu_log_queue_fill(dev, vq, elem, len);
1482 idx = (idx + vq->used_idx) % vq->vring.num;
1484 uelem.id = elem->index;
1485 uelem.len = len;
1486 vring_used_write(dev, vq, &uelem, idx);
1489 static inline
1490 void vring_used_idx_set(VuDev *dev, VuVirtq *vq, uint16_t val)
1492 vq->vring.used->idx = val;
1493 vu_log_write(dev,
1494 vq->vring.log_guest_addr + offsetof(struct vring_used, idx),
1495 sizeof(vq->vring.used->idx));
1497 vq->used_idx = val;
1500 void
1501 vu_queue_flush(VuDev *dev, VuVirtq *vq, unsigned int count)
1503 uint16_t old, new;
1505 if (unlikely(dev->broken) ||
1506 unlikely(!vq->vring.avail)) {
1507 return;
1510 /* Make sure buffer is written before we update index. */
1511 smp_wmb();
1513 old = vq->used_idx;
1514 new = old + count;
1515 vring_used_idx_set(dev, vq, new);
1516 vq->inuse -= count;
1517 if (unlikely((int16_t)(new - vq->signalled_used) < (uint16_t)(new - old))) {
1518 vq->signalled_used_valid = false;
1522 void
1523 vu_queue_push(VuDev *dev, VuVirtq *vq,
1524 const VuVirtqElement *elem, unsigned int len)
1526 vu_queue_fill(dev, vq, elem, len, 0);
1527 vu_queue_flush(dev, vq, 1);