4 * Copyright IBM, Corp. 2007
5 * Copyright (c) 2016 Red Hat, Inc.
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 /* this code avoids GLib dependency */
25 #include <sys/types.h>
26 #include <sys/socket.h>
27 #include <sys/eventfd.h>
29 #include "qemu/compiler.h"
31 #if defined(__linux__)
32 #include <sys/syscall.h>
34 #include <sys/ioctl.h>
35 #include <linux/vhost.h>
37 #ifdef __NR_userfaultfd
38 #include <linux/userfaultfd.h>
43 #include "qemu/atomic.h"
44 #include "qemu/osdep.h"
45 #include "qemu/memfd.h"
47 #include "libvhost-user.h"
49 /* usually provided by GLib */
51 #define MIN(x, y) ({ \
52 typeof(x) _min1 = (x); \
53 typeof(y) _min2 = (y); \
54 (void) (&_min1 == &_min2); \
55 _min1 < _min2 ? _min1 : _min2; })
58 /* Round number down to multiple */
59 #define ALIGN_DOWN(n, m) ((n) / (m) * (m))
61 /* Round number up to multiple */
62 #define ALIGN_UP(n, m) ALIGN_DOWN((n) + (m) - 1, (m))
64 /* Align each region to cache line size in inflight buffer */
65 #define INFLIGHT_ALIGNMENT 64
67 /* The version of inflight buffer */
68 #define INFLIGHT_VERSION 1
70 #define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64)
72 /* The version of the protocol we support */
73 #define VHOST_USER_VERSION 1
74 #define LIBVHOST_USER_DEBUG 0
78 if (LIBVHOST_USER_DEBUG) { \
79 fprintf(stderr, __VA_ARGS__); \
84 bool has_feature(uint64_t features
, unsigned int fbit
)
87 return !!(features
& (1ULL << fbit
));
91 bool vu_has_feature(VuDev
*dev
,
94 return has_feature(dev
->features
, fbit
);
97 static inline bool vu_has_protocol_feature(VuDev
*dev
, unsigned int fbit
)
99 return has_feature(dev
->protocol_features
, fbit
);
103 vu_request_to_string(unsigned int req
)
105 #define REQ(req) [req] = #req
106 static const char *vu_request_str
[] = {
107 REQ(VHOST_USER_NONE
),
108 REQ(VHOST_USER_GET_FEATURES
),
109 REQ(VHOST_USER_SET_FEATURES
),
110 REQ(VHOST_USER_SET_OWNER
),
111 REQ(VHOST_USER_RESET_OWNER
),
112 REQ(VHOST_USER_SET_MEM_TABLE
),
113 REQ(VHOST_USER_SET_LOG_BASE
),
114 REQ(VHOST_USER_SET_LOG_FD
),
115 REQ(VHOST_USER_SET_VRING_NUM
),
116 REQ(VHOST_USER_SET_VRING_ADDR
),
117 REQ(VHOST_USER_SET_VRING_BASE
),
118 REQ(VHOST_USER_GET_VRING_BASE
),
119 REQ(VHOST_USER_SET_VRING_KICK
),
120 REQ(VHOST_USER_SET_VRING_CALL
),
121 REQ(VHOST_USER_SET_VRING_ERR
),
122 REQ(VHOST_USER_GET_PROTOCOL_FEATURES
),
123 REQ(VHOST_USER_SET_PROTOCOL_FEATURES
),
124 REQ(VHOST_USER_GET_QUEUE_NUM
),
125 REQ(VHOST_USER_SET_VRING_ENABLE
),
126 REQ(VHOST_USER_SEND_RARP
),
127 REQ(VHOST_USER_NET_SET_MTU
),
128 REQ(VHOST_USER_SET_SLAVE_REQ_FD
),
129 REQ(VHOST_USER_IOTLB_MSG
),
130 REQ(VHOST_USER_SET_VRING_ENDIAN
),
131 REQ(VHOST_USER_GET_CONFIG
),
132 REQ(VHOST_USER_SET_CONFIG
),
133 REQ(VHOST_USER_POSTCOPY_ADVISE
),
134 REQ(VHOST_USER_POSTCOPY_LISTEN
),
135 REQ(VHOST_USER_POSTCOPY_END
),
136 REQ(VHOST_USER_GET_INFLIGHT_FD
),
137 REQ(VHOST_USER_SET_INFLIGHT_FD
),
138 REQ(VHOST_USER_GPU_SET_SOCKET
),
139 REQ(VHOST_USER_VRING_KICK
),
140 REQ(VHOST_USER_GET_MAX_MEM_SLOTS
),
141 REQ(VHOST_USER_ADD_MEM_REG
),
142 REQ(VHOST_USER_REM_MEM_REG
),
147 if (req
< VHOST_USER_MAX
) {
148 return vu_request_str
[req
];
155 vu_panic(VuDev
*dev
, const char *msg
, ...)
161 if (vasprintf(&buf
, msg
, ap
) < 0) {
167 dev
->panic(dev
, buf
);
172 * find a way to call virtio_error, or perhaps close the connection?
176 /* Translate guest physical address to our virtual address. */
178 vu_gpa_to_va(VuDev
*dev
, uint64_t *plen
, uint64_t guest_addr
)
186 /* Find matching memory region. */
187 for (i
= 0; i
< dev
->nregions
; i
++) {
188 VuDevRegion
*r
= &dev
->regions
[i
];
190 if ((guest_addr
>= r
->gpa
) && (guest_addr
< (r
->gpa
+ r
->size
))) {
191 if ((guest_addr
+ *plen
) > (r
->gpa
+ r
->size
)) {
192 *plen
= r
->gpa
+ r
->size
- guest_addr
;
194 return (void *)(uintptr_t)
195 guest_addr
- r
->gpa
+ r
->mmap_addr
+ r
->mmap_offset
;
202 /* Translate qemu virtual address to our virtual address. */
204 qva_to_va(VuDev
*dev
, uint64_t qemu_addr
)
208 /* Find matching memory region. */
209 for (i
= 0; i
< dev
->nregions
; i
++) {
210 VuDevRegion
*r
= &dev
->regions
[i
];
212 if ((qemu_addr
>= r
->qva
) && (qemu_addr
< (r
->qva
+ r
->size
))) {
213 return (void *)(uintptr_t)
214 qemu_addr
- r
->qva
+ r
->mmap_addr
+ r
->mmap_offset
;
222 vmsg_close_fds(VhostUserMsg
*vmsg
)
226 for (i
= 0; i
< vmsg
->fd_num
; i
++) {
231 /* Set reply payload.u64 and clear request flags and fd_num */
232 static void vmsg_set_reply_u64(VhostUserMsg
*vmsg
, uint64_t val
)
234 vmsg
->flags
= 0; /* defaults will be set by vu_send_reply() */
235 vmsg
->size
= sizeof(vmsg
->payload
.u64
);
236 vmsg
->payload
.u64
= val
;
240 /* A test to see if we have userfault available */
244 #if defined(__linux__) && defined(__NR_userfaultfd) &&\
245 defined(UFFD_FEATURE_MISSING_SHMEM) &&\
246 defined(UFFD_FEATURE_MISSING_HUGETLBFS)
247 /* Now test the kernel we're running on really has the features */
248 int ufd
= syscall(__NR_userfaultfd
, O_CLOEXEC
| O_NONBLOCK
);
249 struct uffdio_api api_struct
;
254 api_struct
.api
= UFFD_API
;
255 api_struct
.features
= UFFD_FEATURE_MISSING_SHMEM
|
256 UFFD_FEATURE_MISSING_HUGETLBFS
;
257 if (ioctl(ufd
, UFFDIO_API
, &api_struct
)) {
270 vu_message_read(VuDev
*dev
, int conn_fd
, VhostUserMsg
*vmsg
)
272 char control
[CMSG_SPACE(VHOST_MEMORY_BASELINE_NREGIONS
* sizeof(int))] = {};
274 .iov_base
= (char *)vmsg
,
275 .iov_len
= VHOST_USER_HDR_SIZE
,
277 struct msghdr msg
= {
280 .msg_control
= control
,
281 .msg_controllen
= sizeof(control
),
284 struct cmsghdr
*cmsg
;
288 rc
= recvmsg(conn_fd
, &msg
, 0);
289 } while (rc
< 0 && (errno
== EINTR
|| errno
== EAGAIN
));
292 vu_panic(dev
, "Error while recvmsg: %s", strerror(errno
));
297 for (cmsg
= CMSG_FIRSTHDR(&msg
);
299 cmsg
= CMSG_NXTHDR(&msg
, cmsg
))
301 if (cmsg
->cmsg_level
== SOL_SOCKET
&& cmsg
->cmsg_type
== SCM_RIGHTS
) {
302 fd_size
= cmsg
->cmsg_len
- CMSG_LEN(0);
303 vmsg
->fd_num
= fd_size
/ sizeof(int);
304 memcpy(vmsg
->fds
, CMSG_DATA(cmsg
), fd_size
);
309 if (vmsg
->size
> sizeof(vmsg
->payload
)) {
311 "Error: too big message request: %d, size: vmsg->size: %u, "
312 "while sizeof(vmsg->payload) = %zu\n",
313 vmsg
->request
, vmsg
->size
, sizeof(vmsg
->payload
));
319 rc
= read(conn_fd
, &vmsg
->payload
, vmsg
->size
);
320 } while (rc
< 0 && (errno
== EINTR
|| errno
== EAGAIN
));
323 vu_panic(dev
, "Error while reading: %s", strerror(errno
));
327 assert(rc
== vmsg
->size
);
333 vmsg_close_fds(vmsg
);
339 vu_message_write(VuDev
*dev
, int conn_fd
, VhostUserMsg
*vmsg
)
342 uint8_t *p
= (uint8_t *)vmsg
;
343 char control
[CMSG_SPACE(VHOST_MEMORY_BASELINE_NREGIONS
* sizeof(int))] = {};
345 .iov_base
= (char *)vmsg
,
346 .iov_len
= VHOST_USER_HDR_SIZE
,
348 struct msghdr msg
= {
351 .msg_control
= control
,
353 struct cmsghdr
*cmsg
;
355 memset(control
, 0, sizeof(control
));
356 assert(vmsg
->fd_num
<= VHOST_MEMORY_BASELINE_NREGIONS
);
357 if (vmsg
->fd_num
> 0) {
358 size_t fdsize
= vmsg
->fd_num
* sizeof(int);
359 msg
.msg_controllen
= CMSG_SPACE(fdsize
);
360 cmsg
= CMSG_FIRSTHDR(&msg
);
361 cmsg
->cmsg_len
= CMSG_LEN(fdsize
);
362 cmsg
->cmsg_level
= SOL_SOCKET
;
363 cmsg
->cmsg_type
= SCM_RIGHTS
;
364 memcpy(CMSG_DATA(cmsg
), vmsg
->fds
, fdsize
);
366 msg
.msg_controllen
= 0;
370 rc
= sendmsg(conn_fd
, &msg
, 0);
371 } while (rc
< 0 && (errno
== EINTR
|| errno
== EAGAIN
));
376 rc
= write(conn_fd
, vmsg
->data
, vmsg
->size
);
378 rc
= write(conn_fd
, p
+ VHOST_USER_HDR_SIZE
, vmsg
->size
);
380 } while (rc
< 0 && (errno
== EINTR
|| errno
== EAGAIN
));
384 vu_panic(dev
, "Error while writing: %s", strerror(errno
));
392 vu_send_reply(VuDev
*dev
, int conn_fd
, VhostUserMsg
*vmsg
)
394 /* Set the version in the flags when sending the reply */
395 vmsg
->flags
&= ~VHOST_USER_VERSION_MASK
;
396 vmsg
->flags
|= VHOST_USER_VERSION
;
397 vmsg
->flags
|= VHOST_USER_REPLY_MASK
;
399 return vu_message_write(dev
, conn_fd
, vmsg
);
403 * Processes a reply on the slave channel.
404 * Entered with slave_mutex held and releases it before exit.
405 * Returns true on success.
408 vu_process_message_reply(VuDev
*dev
, const VhostUserMsg
*vmsg
)
410 VhostUserMsg msg_reply
;
413 if ((vmsg
->flags
& VHOST_USER_NEED_REPLY_MASK
) == 0) {
418 if (!vu_message_read(dev
, dev
->slave_fd
, &msg_reply
)) {
422 if (msg_reply
.request
!= vmsg
->request
) {
423 DPRINT("Received unexpected msg type. Expected %d received %d",
424 vmsg
->request
, msg_reply
.request
);
428 result
= msg_reply
.payload
.u64
== 0;
431 pthread_mutex_unlock(&dev
->slave_mutex
);
435 /* Kick the log_call_fd if required. */
437 vu_log_kick(VuDev
*dev
)
439 if (dev
->log_call_fd
!= -1) {
440 DPRINT("Kicking the QEMU's log...\n");
441 if (eventfd_write(dev
->log_call_fd
, 1) < 0) {
442 vu_panic(dev
, "Error writing eventfd: %s", strerror(errno
));
448 vu_log_page(uint8_t *log_table
, uint64_t page
)
450 DPRINT("Logged dirty guest page: %"PRId64
"\n", page
);
451 atomic_or(&log_table
[page
/ 8], 1 << (page
% 8));
455 vu_log_write(VuDev
*dev
, uint64_t address
, uint64_t length
)
459 if (!(dev
->features
& (1ULL << VHOST_F_LOG_ALL
)) ||
460 !dev
->log_table
|| !length
) {
464 assert(dev
->log_size
> ((address
+ length
- 1) / VHOST_LOG_PAGE
/ 8));
466 page
= address
/ VHOST_LOG_PAGE
;
467 while (page
* VHOST_LOG_PAGE
< address
+ length
) {
468 vu_log_page(dev
->log_table
, page
);
476 vu_kick_cb(VuDev
*dev
, int condition
, void *data
)
478 int index
= (intptr_t)data
;
479 VuVirtq
*vq
= &dev
->vq
[index
];
480 int sock
= vq
->kick_fd
;
484 rc
= eventfd_read(sock
, &kick_data
);
486 vu_panic(dev
, "kick eventfd_read(): %s", strerror(errno
));
487 dev
->remove_watch(dev
, dev
->vq
[index
].kick_fd
);
489 DPRINT("Got kick_data: %016"PRIx64
" handler:%p idx:%d\n",
490 kick_data
, vq
->handler
, index
);
492 vq
->handler(dev
, index
);
498 vu_get_features_exec(VuDev
*dev
, VhostUserMsg
*vmsg
)
502 * The following VIRTIO feature bits are supported by our virtqueue
505 1ULL << VIRTIO_F_NOTIFY_ON_EMPTY
|
506 1ULL << VIRTIO_RING_F_INDIRECT_DESC
|
507 1ULL << VIRTIO_RING_F_EVENT_IDX
|
508 1ULL << VIRTIO_F_VERSION_1
|
510 /* vhost-user feature bits */
511 1ULL << VHOST_F_LOG_ALL
|
512 1ULL << VHOST_USER_F_PROTOCOL_FEATURES
;
514 if (dev
->iface
->get_features
) {
515 vmsg
->payload
.u64
|= dev
->iface
->get_features(dev
);
518 vmsg
->size
= sizeof(vmsg
->payload
.u64
);
521 DPRINT("Sending back to guest u64: 0x%016"PRIx64
"\n", vmsg
->payload
.u64
);
527 vu_set_enable_all_rings(VuDev
*dev
, bool enabled
)
531 for (i
= 0; i
< dev
->max_queues
; i
++) {
532 dev
->vq
[i
].enable
= enabled
;
537 vu_set_features_exec(VuDev
*dev
, VhostUserMsg
*vmsg
)
539 DPRINT("u64: 0x%016"PRIx64
"\n", vmsg
->payload
.u64
);
541 dev
->features
= vmsg
->payload
.u64
;
543 if (!(dev
->features
& VHOST_USER_F_PROTOCOL_FEATURES
)) {
544 vu_set_enable_all_rings(dev
, true);
547 if (dev
->iface
->set_features
) {
548 dev
->iface
->set_features(dev
, dev
->features
);
555 vu_set_owner_exec(VuDev
*dev
, VhostUserMsg
*vmsg
)
561 vu_close_log(VuDev
*dev
)
563 if (dev
->log_table
) {
564 if (munmap(dev
->log_table
, dev
->log_size
) != 0) {
565 perror("close log munmap() error");
568 dev
->log_table
= NULL
;
570 if (dev
->log_call_fd
!= -1) {
571 close(dev
->log_call_fd
);
572 dev
->log_call_fd
= -1;
577 vu_reset_device_exec(VuDev
*dev
, VhostUserMsg
*vmsg
)
579 vu_set_enable_all_rings(dev
, false);
585 map_ring(VuDev
*dev
, VuVirtq
*vq
)
587 vq
->vring
.desc
= qva_to_va(dev
, vq
->vra
.desc_user_addr
);
588 vq
->vring
.used
= qva_to_va(dev
, vq
->vra
.used_user_addr
);
589 vq
->vring
.avail
= qva_to_va(dev
, vq
->vra
.avail_user_addr
);
591 DPRINT("Setting virtq addresses:\n");
592 DPRINT(" vring_desc at %p\n", vq
->vring
.desc
);
593 DPRINT(" vring_used at %p\n", vq
->vring
.used
);
594 DPRINT(" vring_avail at %p\n", vq
->vring
.avail
);
596 return !(vq
->vring
.desc
&& vq
->vring
.used
&& vq
->vring
.avail
);
600 generate_faults(VuDev
*dev
) {
602 for (i
= 0; i
< dev
->nregions
; i
++) {
603 VuDevRegion
*dev_region
= &dev
->regions
[i
];
605 #ifdef UFFDIO_REGISTER
607 * We should already have an open ufd. Mark each memory
609 * Discard any mapping we have here; note I can't use MADV_REMOVE
610 * or fallocate to make the hole since I don't want to lose
611 * data that's already arrived in the shared process.
612 * TODO: How to do hugepage
614 ret
= madvise((void *)(uintptr_t)dev_region
->mmap_addr
,
615 dev_region
->size
+ dev_region
->mmap_offset
,
619 "%s: Failed to madvise(DONTNEED) region %d: %s\n",
620 __func__
, i
, strerror(errno
));
623 * Turn off transparent hugepages so we dont get lose wakeups
624 * in neighbouring pages.
625 * TODO: Turn this backon later.
627 ret
= madvise((void *)(uintptr_t)dev_region
->mmap_addr
,
628 dev_region
->size
+ dev_region
->mmap_offset
,
632 * Note: This can happen legally on kernels that are configured
633 * without madvise'able hugepages
636 "%s: Failed to madvise(NOHUGEPAGE) region %d: %s\n",
637 __func__
, i
, strerror(errno
));
639 struct uffdio_register reg_struct
;
640 reg_struct
.range
.start
= (uintptr_t)dev_region
->mmap_addr
;
641 reg_struct
.range
.len
= dev_region
->size
+ dev_region
->mmap_offset
;
642 reg_struct
.mode
= UFFDIO_REGISTER_MODE_MISSING
;
644 if (ioctl(dev
->postcopy_ufd
, UFFDIO_REGISTER
, ®_struct
)) {
645 vu_panic(dev
, "%s: Failed to userfault region %d "
646 "@%p + size:%zx offset: %zx: (ufd=%d)%s\n",
648 dev_region
->mmap_addr
,
649 dev_region
->size
, dev_region
->mmap_offset
,
650 dev
->postcopy_ufd
, strerror(errno
));
653 if (!(reg_struct
.ioctls
& ((__u64
)1 << _UFFDIO_COPY
))) {
654 vu_panic(dev
, "%s Region (%d) doesn't support COPY",
658 DPRINT("%s: region %d: Registered userfault for %"
659 PRIx64
" + %" PRIx64
"\n", __func__
, i
,
660 (uint64_t)reg_struct
.range
.start
,
661 (uint64_t)reg_struct
.range
.len
);
662 /* Now it's registered we can let the client at it */
663 if (mprotect((void *)(uintptr_t)dev_region
->mmap_addr
,
664 dev_region
->size
+ dev_region
->mmap_offset
,
665 PROT_READ
| PROT_WRITE
)) {
666 vu_panic(dev
, "failed to mprotect region %d for postcopy (%s)",
670 /* TODO: Stash 'zero' support flags somewhere */
678 vu_add_mem_reg(VuDev
*dev
, VhostUserMsg
*vmsg
) {
680 bool track_ramblocks
= dev
->postcopy_listening
;
681 VhostUserMemoryRegion m
= vmsg
->payload
.memreg
.region
, *msg_region
= &m
;
682 VuDevRegion
*dev_region
= &dev
->regions
[dev
->nregions
];
686 * If we are in postcopy mode and we receive a u64 payload with a 0 value
687 * we know all the postcopy client bases have been recieved, and we
688 * should start generating faults.
690 if (track_ramblocks
&&
691 vmsg
->size
== sizeof(vmsg
->payload
.u64
) &&
692 vmsg
->payload
.u64
== 0) {
693 (void)generate_faults(dev
);
697 DPRINT("Adding region: %d\n", dev
->nregions
);
698 DPRINT(" guest_phys_addr: 0x%016"PRIx64
"\n",
699 msg_region
->guest_phys_addr
);
700 DPRINT(" memory_size: 0x%016"PRIx64
"\n",
701 msg_region
->memory_size
);
702 DPRINT(" userspace_addr 0x%016"PRIx64
"\n",
703 msg_region
->userspace_addr
);
704 DPRINT(" mmap_offset 0x%016"PRIx64
"\n",
705 msg_region
->mmap_offset
);
707 dev_region
->gpa
= msg_region
->guest_phys_addr
;
708 dev_region
->size
= msg_region
->memory_size
;
709 dev_region
->qva
= msg_region
->userspace_addr
;
710 dev_region
->mmap_offset
= msg_region
->mmap_offset
;
713 * We don't use offset argument of mmap() since the
714 * mapped address has to be page aligned, and we use huge
717 if (track_ramblocks
) {
719 * In postcopy we're using PROT_NONE here to catch anyone
720 * accessing it before we userfault.
722 mmap_addr
= mmap(0, dev_region
->size
+ dev_region
->mmap_offset
,
723 PROT_NONE
, MAP_SHARED
,
726 mmap_addr
= mmap(0, dev_region
->size
+ dev_region
->mmap_offset
,
727 PROT_READ
| PROT_WRITE
, MAP_SHARED
, vmsg
->fds
[0],
731 if (mmap_addr
== MAP_FAILED
) {
732 vu_panic(dev
, "region mmap error: %s", strerror(errno
));
734 dev_region
->mmap_addr
= (uint64_t)(uintptr_t)mmap_addr
;
735 DPRINT(" mmap_addr: 0x%016"PRIx64
"\n",
736 dev_region
->mmap_addr
);
741 if (track_ramblocks
) {
743 * Return the address to QEMU so that it can translate the ufd
744 * fault addresses back.
746 msg_region
->userspace_addr
= (uintptr_t)(mmap_addr
+
747 dev_region
->mmap_offset
);
749 /* Send the message back to qemu with the addresses filled in. */
751 if (!vu_send_reply(dev
, dev
->sock
, vmsg
)) {
752 vu_panic(dev
, "failed to respond to add-mem-region for postcopy");
756 DPRINT("Successfully added new region in postcopy\n");
761 for (i
= 0; i
< dev
->max_queues
; i
++) {
762 if (dev
->vq
[i
].vring
.desc
) {
763 if (map_ring(dev
, &dev
->vq
[i
])) {
764 vu_panic(dev
, "remapping queue %d for new memory region",
770 DPRINT("Successfully added new region\n");
772 vmsg_set_reply_u64(vmsg
, 0);
777 static inline bool reg_equal(VuDevRegion
*vudev_reg
,
778 VhostUserMemoryRegion
*msg_reg
)
780 if (vudev_reg
->gpa
== msg_reg
->guest_phys_addr
&&
781 vudev_reg
->qva
== msg_reg
->userspace_addr
&&
782 vudev_reg
->size
== msg_reg
->memory_size
) {
790 vu_rem_mem_reg(VuDev
*dev
, VhostUserMsg
*vmsg
) {
793 VuDevRegion shadow_regions
[VHOST_USER_MAX_RAM_SLOTS
] = {};
794 VhostUserMemoryRegion m
= vmsg
->payload
.memreg
.region
, *msg_region
= &m
;
796 DPRINT("Removing region:\n");
797 DPRINT(" guest_phys_addr: 0x%016"PRIx64
"\n",
798 msg_region
->guest_phys_addr
);
799 DPRINT(" memory_size: 0x%016"PRIx64
"\n",
800 msg_region
->memory_size
);
801 DPRINT(" userspace_addr 0x%016"PRIx64
"\n",
802 msg_region
->userspace_addr
);
803 DPRINT(" mmap_offset 0x%016"PRIx64
"\n",
804 msg_region
->mmap_offset
);
806 for (i
= 0, j
= 0; i
< dev
->nregions
; i
++) {
807 if (!reg_equal(&dev
->regions
[i
], msg_region
)) {
808 shadow_regions
[j
].gpa
= dev
->regions
[i
].gpa
;
809 shadow_regions
[j
].size
= dev
->regions
[i
].size
;
810 shadow_regions
[j
].qva
= dev
->regions
[i
].qva
;
811 shadow_regions
[j
].mmap_offset
= dev
->regions
[i
].mmap_offset
;
815 VuDevRegion
*r
= &dev
->regions
[i
];
816 void *m
= (void *) (uintptr_t) r
->mmap_addr
;
819 munmap(m
, r
->size
+ r
->mmap_offset
);
825 memcpy(dev
->regions
, shadow_regions
,
826 sizeof(VuDevRegion
) * VHOST_USER_MAX_RAM_SLOTS
);
827 DPRINT("Successfully removed a region\n");
829 vmsg_set_reply_u64(vmsg
, 0);
831 vu_panic(dev
, "Specified region not found\n");
838 vu_set_mem_table_exec_postcopy(VuDev
*dev
, VhostUserMsg
*vmsg
)
841 VhostUserMemory m
= vmsg
->payload
.memory
, *memory
= &m
;
842 dev
->nregions
= memory
->nregions
;
844 DPRINT("Nregions: %d\n", memory
->nregions
);
845 for (i
= 0; i
< dev
->nregions
; i
++) {
847 VhostUserMemoryRegion
*msg_region
= &memory
->regions
[i
];
848 VuDevRegion
*dev_region
= &dev
->regions
[i
];
850 DPRINT("Region %d\n", i
);
851 DPRINT(" guest_phys_addr: 0x%016"PRIx64
"\n",
852 msg_region
->guest_phys_addr
);
853 DPRINT(" memory_size: 0x%016"PRIx64
"\n",
854 msg_region
->memory_size
);
855 DPRINT(" userspace_addr 0x%016"PRIx64
"\n",
856 msg_region
->userspace_addr
);
857 DPRINT(" mmap_offset 0x%016"PRIx64
"\n",
858 msg_region
->mmap_offset
);
860 dev_region
->gpa
= msg_region
->guest_phys_addr
;
861 dev_region
->size
= msg_region
->memory_size
;
862 dev_region
->qva
= msg_region
->userspace_addr
;
863 dev_region
->mmap_offset
= msg_region
->mmap_offset
;
865 /* We don't use offset argument of mmap() since the
866 * mapped address has to be page aligned, and we use huge
868 * In postcopy we're using PROT_NONE here to catch anyone
869 * accessing it before we userfault
871 mmap_addr
= mmap(0, dev_region
->size
+ dev_region
->mmap_offset
,
872 PROT_NONE
, MAP_SHARED
,
875 if (mmap_addr
== MAP_FAILED
) {
876 vu_panic(dev
, "region mmap error: %s", strerror(errno
));
878 dev_region
->mmap_addr
= (uint64_t)(uintptr_t)mmap_addr
;
879 DPRINT(" mmap_addr: 0x%016"PRIx64
"\n",
880 dev_region
->mmap_addr
);
883 /* Return the address to QEMU so that it can translate the ufd
884 * fault addresses back.
886 msg_region
->userspace_addr
= (uintptr_t)(mmap_addr
+
887 dev_region
->mmap_offset
);
891 /* Send the message back to qemu with the addresses filled in */
893 if (!vu_send_reply(dev
, dev
->sock
, vmsg
)) {
894 vu_panic(dev
, "failed to respond to set-mem-table for postcopy");
898 /* Wait for QEMU to confirm that it's registered the handler for the
901 if (!vu_message_read(dev
, dev
->sock
, vmsg
) ||
902 vmsg
->size
!= sizeof(vmsg
->payload
.u64
) ||
903 vmsg
->payload
.u64
!= 0) {
904 vu_panic(dev
, "failed to receive valid ack for postcopy set-mem-table");
908 /* OK, now we can go and register the memory and generate faults */
909 (void)generate_faults(dev
);
915 vu_set_mem_table_exec(VuDev
*dev
, VhostUserMsg
*vmsg
)
918 VhostUserMemory m
= vmsg
->payload
.memory
, *memory
= &m
;
920 for (i
= 0; i
< dev
->nregions
; i
++) {
921 VuDevRegion
*r
= &dev
->regions
[i
];
922 void *m
= (void *) (uintptr_t) r
->mmap_addr
;
925 munmap(m
, r
->size
+ r
->mmap_offset
);
928 dev
->nregions
= memory
->nregions
;
930 if (dev
->postcopy_listening
) {
931 return vu_set_mem_table_exec_postcopy(dev
, vmsg
);
934 DPRINT("Nregions: %d\n", memory
->nregions
);
935 for (i
= 0; i
< dev
->nregions
; i
++) {
937 VhostUserMemoryRegion
*msg_region
= &memory
->regions
[i
];
938 VuDevRegion
*dev_region
= &dev
->regions
[i
];
940 DPRINT("Region %d\n", i
);
941 DPRINT(" guest_phys_addr: 0x%016"PRIx64
"\n",
942 msg_region
->guest_phys_addr
);
943 DPRINT(" memory_size: 0x%016"PRIx64
"\n",
944 msg_region
->memory_size
);
945 DPRINT(" userspace_addr 0x%016"PRIx64
"\n",
946 msg_region
->userspace_addr
);
947 DPRINT(" mmap_offset 0x%016"PRIx64
"\n",
948 msg_region
->mmap_offset
);
950 dev_region
->gpa
= msg_region
->guest_phys_addr
;
951 dev_region
->size
= msg_region
->memory_size
;
952 dev_region
->qva
= msg_region
->userspace_addr
;
953 dev_region
->mmap_offset
= msg_region
->mmap_offset
;
955 /* We don't use offset argument of mmap() since the
956 * mapped address has to be page aligned, and we use huge
958 mmap_addr
= mmap(0, dev_region
->size
+ dev_region
->mmap_offset
,
959 PROT_READ
| PROT_WRITE
, MAP_SHARED
,
962 if (mmap_addr
== MAP_FAILED
) {
963 vu_panic(dev
, "region mmap error: %s", strerror(errno
));
965 dev_region
->mmap_addr
= (uint64_t)(uintptr_t)mmap_addr
;
966 DPRINT(" mmap_addr: 0x%016"PRIx64
"\n",
967 dev_region
->mmap_addr
);
973 for (i
= 0; i
< dev
->max_queues
; i
++) {
974 if (dev
->vq
[i
].vring
.desc
) {
975 if (map_ring(dev
, &dev
->vq
[i
])) {
976 vu_panic(dev
, "remaping queue %d during setmemtable", i
);
985 vu_set_log_base_exec(VuDev
*dev
, VhostUserMsg
*vmsg
)
988 uint64_t log_mmap_size
, log_mmap_offset
;
991 if (vmsg
->fd_num
!= 1 ||
992 vmsg
->size
!= sizeof(vmsg
->payload
.log
)) {
993 vu_panic(dev
, "Invalid log_base message");
998 log_mmap_offset
= vmsg
->payload
.log
.mmap_offset
;
999 log_mmap_size
= vmsg
->payload
.log
.mmap_size
;
1000 DPRINT("Log mmap_offset: %"PRId64
"\n", log_mmap_offset
);
1001 DPRINT("Log mmap_size: %"PRId64
"\n", log_mmap_size
);
1003 rc
= mmap(0, log_mmap_size
, PROT_READ
| PROT_WRITE
, MAP_SHARED
, fd
,
1006 if (rc
== MAP_FAILED
) {
1007 perror("log mmap error");
1010 if (dev
->log_table
) {
1011 munmap(dev
->log_table
, dev
->log_size
);
1013 dev
->log_table
= rc
;
1014 dev
->log_size
= log_mmap_size
;
1016 vmsg
->size
= sizeof(vmsg
->payload
.u64
);
1023 vu_set_log_fd_exec(VuDev
*dev
, VhostUserMsg
*vmsg
)
1025 if (vmsg
->fd_num
!= 1) {
1026 vu_panic(dev
, "Invalid log_fd message");
1030 if (dev
->log_call_fd
!= -1) {
1031 close(dev
->log_call_fd
);
1033 dev
->log_call_fd
= vmsg
->fds
[0];
1034 DPRINT("Got log_call_fd: %d\n", vmsg
->fds
[0]);
1040 vu_set_vring_num_exec(VuDev
*dev
, VhostUserMsg
*vmsg
)
1042 unsigned int index
= vmsg
->payload
.state
.index
;
1043 unsigned int num
= vmsg
->payload
.state
.num
;
1045 DPRINT("State.index: %d\n", index
);
1046 DPRINT("State.num: %d\n", num
);
1047 dev
->vq
[index
].vring
.num
= num
;
1053 vu_set_vring_addr_exec(VuDev
*dev
, VhostUserMsg
*vmsg
)
1055 struct vhost_vring_addr addr
= vmsg
->payload
.addr
, *vra
= &addr
;
1056 unsigned int index
= vra
->index
;
1057 VuVirtq
*vq
= &dev
->vq
[index
];
1059 DPRINT("vhost_vring_addr:\n");
1060 DPRINT(" index: %d\n", vra
->index
);
1061 DPRINT(" flags: %d\n", vra
->flags
);
1062 DPRINT(" desc_user_addr: 0x%016" PRIx64
"\n", vra
->desc_user_addr
);
1063 DPRINT(" used_user_addr: 0x%016" PRIx64
"\n", vra
->used_user_addr
);
1064 DPRINT(" avail_user_addr: 0x%016" PRIx64
"\n", vra
->avail_user_addr
);
1065 DPRINT(" log_guest_addr: 0x%016" PRIx64
"\n", vra
->log_guest_addr
);
1068 vq
->vring
.flags
= vra
->flags
;
1069 vq
->vring
.log_guest_addr
= vra
->log_guest_addr
;
1072 if (map_ring(dev
, vq
)) {
1073 vu_panic(dev
, "Invalid vring_addr message");
1077 vq
->used_idx
= vq
->vring
.used
->idx
;
1079 if (vq
->last_avail_idx
!= vq
->used_idx
) {
1080 bool resume
= dev
->iface
->queue_is_processed_in_order
&&
1081 dev
->iface
->queue_is_processed_in_order(dev
, index
);
1083 DPRINT("Last avail index != used index: %u != %u%s\n",
1084 vq
->last_avail_idx
, vq
->used_idx
,
1085 resume
? ", resuming" : "");
1088 vq
->shadow_avail_idx
= vq
->last_avail_idx
= vq
->used_idx
;
1096 vu_set_vring_base_exec(VuDev
*dev
, VhostUserMsg
*vmsg
)
1098 unsigned int index
= vmsg
->payload
.state
.index
;
1099 unsigned int num
= vmsg
->payload
.state
.num
;
1101 DPRINT("State.index: %d\n", index
);
1102 DPRINT("State.num: %d\n", num
);
1103 dev
->vq
[index
].shadow_avail_idx
= dev
->vq
[index
].last_avail_idx
= num
;
1109 vu_get_vring_base_exec(VuDev
*dev
, VhostUserMsg
*vmsg
)
1111 unsigned int index
= vmsg
->payload
.state
.index
;
1113 DPRINT("State.index: %d\n", index
);
1114 vmsg
->payload
.state
.num
= dev
->vq
[index
].last_avail_idx
;
1115 vmsg
->size
= sizeof(vmsg
->payload
.state
);
1117 dev
->vq
[index
].started
= false;
1118 if (dev
->iface
->queue_set_started
) {
1119 dev
->iface
->queue_set_started(dev
, index
, false);
1122 if (dev
->vq
[index
].call_fd
!= -1) {
1123 close(dev
->vq
[index
].call_fd
);
1124 dev
->vq
[index
].call_fd
= -1;
1126 if (dev
->vq
[index
].kick_fd
!= -1) {
1127 dev
->remove_watch(dev
, dev
->vq
[index
].kick_fd
);
1128 close(dev
->vq
[index
].kick_fd
);
1129 dev
->vq
[index
].kick_fd
= -1;
1136 vu_check_queue_msg_file(VuDev
*dev
, VhostUserMsg
*vmsg
)
1138 int index
= vmsg
->payload
.u64
& VHOST_USER_VRING_IDX_MASK
;
1139 bool nofd
= vmsg
->payload
.u64
& VHOST_USER_VRING_NOFD_MASK
;
1141 if (index
>= dev
->max_queues
) {
1142 vmsg_close_fds(vmsg
);
1143 vu_panic(dev
, "Invalid queue index: %u", index
);
1148 vmsg_close_fds(vmsg
);
1152 if (vmsg
->fd_num
!= 1) {
1153 vmsg_close_fds(vmsg
);
1154 vu_panic(dev
, "Invalid fds in request: %d", vmsg
->request
);
1162 inflight_desc_compare(const void *a
, const void *b
)
1164 VuVirtqInflightDesc
*desc0
= (VuVirtqInflightDesc
*)a
,
1165 *desc1
= (VuVirtqInflightDesc
*)b
;
1167 if (desc1
->counter
> desc0
->counter
&&
1168 (desc1
->counter
- desc0
->counter
) < VIRTQUEUE_MAX_SIZE
* 2) {
1176 vu_check_queue_inflights(VuDev
*dev
, VuVirtq
*vq
)
1180 if (!vu_has_protocol_feature(dev
, VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD
)) {
1184 if (unlikely(!vq
->inflight
)) {
1188 if (unlikely(!vq
->inflight
->version
)) {
1189 /* initialize the buffer */
1190 vq
->inflight
->version
= INFLIGHT_VERSION
;
1194 vq
->used_idx
= vq
->vring
.used
->idx
;
1195 vq
->resubmit_num
= 0;
1196 vq
->resubmit_list
= NULL
;
1199 if (unlikely(vq
->inflight
->used_idx
!= vq
->used_idx
)) {
1200 vq
->inflight
->desc
[vq
->inflight
->last_batch_head
].inflight
= 0;
1204 vq
->inflight
->used_idx
= vq
->used_idx
;
1207 for (i
= 0; i
< vq
->inflight
->desc_num
; i
++) {
1208 if (vq
->inflight
->desc
[i
].inflight
== 1) {
1213 vq
->shadow_avail_idx
= vq
->last_avail_idx
= vq
->inuse
+ vq
->used_idx
;
1216 vq
->resubmit_list
= calloc(vq
->inuse
, sizeof(VuVirtqInflightDesc
));
1217 if (!vq
->resubmit_list
) {
1221 for (i
= 0; i
< vq
->inflight
->desc_num
; i
++) {
1222 if (vq
->inflight
->desc
[i
].inflight
) {
1223 vq
->resubmit_list
[vq
->resubmit_num
].index
= i
;
1224 vq
->resubmit_list
[vq
->resubmit_num
].counter
=
1225 vq
->inflight
->desc
[i
].counter
;
1230 if (vq
->resubmit_num
> 1) {
1231 qsort(vq
->resubmit_list
, vq
->resubmit_num
,
1232 sizeof(VuVirtqInflightDesc
), inflight_desc_compare
);
1234 vq
->counter
= vq
->resubmit_list
[0].counter
+ 1;
1237 /* in case of I/O hang after reconnecting */
1238 if (eventfd_write(vq
->kick_fd
, 1)) {
1246 vu_set_vring_kick_exec(VuDev
*dev
, VhostUserMsg
*vmsg
)
1248 int index
= vmsg
->payload
.u64
& VHOST_USER_VRING_IDX_MASK
;
1249 bool nofd
= vmsg
->payload
.u64
& VHOST_USER_VRING_NOFD_MASK
;
1251 DPRINT("u64: 0x%016"PRIx64
"\n", vmsg
->payload
.u64
);
1253 if (!vu_check_queue_msg_file(dev
, vmsg
)) {
1257 if (dev
->vq
[index
].kick_fd
!= -1) {
1258 dev
->remove_watch(dev
, dev
->vq
[index
].kick_fd
);
1259 close(dev
->vq
[index
].kick_fd
);
1260 dev
->vq
[index
].kick_fd
= -1;
1263 dev
->vq
[index
].kick_fd
= nofd
? -1 : vmsg
->fds
[0];
1264 DPRINT("Got kick_fd: %d for vq: %d\n", dev
->vq
[index
].kick_fd
, index
);
1266 dev
->vq
[index
].started
= true;
1267 if (dev
->iface
->queue_set_started
) {
1268 dev
->iface
->queue_set_started(dev
, index
, true);
1271 if (dev
->vq
[index
].kick_fd
!= -1 && dev
->vq
[index
].handler
) {
1272 dev
->set_watch(dev
, dev
->vq
[index
].kick_fd
, VU_WATCH_IN
,
1273 vu_kick_cb
, (void *)(long)index
);
1275 DPRINT("Waiting for kicks on fd: %d for vq: %d\n",
1276 dev
->vq
[index
].kick_fd
, index
);
1279 if (vu_check_queue_inflights(dev
, &dev
->vq
[index
])) {
1280 vu_panic(dev
, "Failed to check inflights for vq: %d\n", index
);
1286 void vu_set_queue_handler(VuDev
*dev
, VuVirtq
*vq
,
1287 vu_queue_handler_cb handler
)
1289 int qidx
= vq
- dev
->vq
;
1291 vq
->handler
= handler
;
1292 if (vq
->kick_fd
>= 0) {
1294 dev
->set_watch(dev
, vq
->kick_fd
, VU_WATCH_IN
,
1295 vu_kick_cb
, (void *)(long)qidx
);
1297 dev
->remove_watch(dev
, vq
->kick_fd
);
1302 bool vu_set_queue_host_notifier(VuDev
*dev
, VuVirtq
*vq
, int fd
,
1303 int size
, int offset
)
1305 int qidx
= vq
- dev
->vq
;
1307 VhostUserMsg vmsg
= {
1308 .request
= VHOST_USER_SLAVE_VRING_HOST_NOTIFIER_MSG
,
1309 .flags
= VHOST_USER_VERSION
| VHOST_USER_NEED_REPLY_MASK
,
1310 .size
= sizeof(vmsg
.payload
.area
),
1312 .u64
= qidx
& VHOST_USER_VRING_IDX_MASK
,
1319 vmsg
.payload
.area
.u64
|= VHOST_USER_VRING_NOFD_MASK
;
1321 vmsg
.fds
[fd_num
++] = fd
;
1324 vmsg
.fd_num
= fd_num
;
1326 if (!vu_has_protocol_feature(dev
, VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD
)) {
1330 pthread_mutex_lock(&dev
->slave_mutex
);
1331 if (!vu_message_write(dev
, dev
->slave_fd
, &vmsg
)) {
1332 pthread_mutex_unlock(&dev
->slave_mutex
);
1336 /* Also unlocks the slave_mutex */
1337 return vu_process_message_reply(dev
, &vmsg
);
1341 vu_set_vring_call_exec(VuDev
*dev
, VhostUserMsg
*vmsg
)
1343 int index
= vmsg
->payload
.u64
& VHOST_USER_VRING_IDX_MASK
;
1344 bool nofd
= vmsg
->payload
.u64
& VHOST_USER_VRING_NOFD_MASK
;
1346 DPRINT("u64: 0x%016"PRIx64
"\n", vmsg
->payload
.u64
);
1348 if (!vu_check_queue_msg_file(dev
, vmsg
)) {
1352 if (dev
->vq
[index
].call_fd
!= -1) {
1353 close(dev
->vq
[index
].call_fd
);
1354 dev
->vq
[index
].call_fd
= -1;
1357 dev
->vq
[index
].call_fd
= nofd
? -1 : vmsg
->fds
[0];
1359 /* in case of I/O hang after reconnecting */
1360 if (dev
->vq
[index
].call_fd
!= -1 && eventfd_write(vmsg
->fds
[0], 1)) {
1364 DPRINT("Got call_fd: %d for vq: %d\n", dev
->vq
[index
].call_fd
, index
);
1370 vu_set_vring_err_exec(VuDev
*dev
, VhostUserMsg
*vmsg
)
1372 int index
= vmsg
->payload
.u64
& VHOST_USER_VRING_IDX_MASK
;
1373 bool nofd
= vmsg
->payload
.u64
& VHOST_USER_VRING_NOFD_MASK
;
1375 DPRINT("u64: 0x%016"PRIx64
"\n", vmsg
->payload
.u64
);
1377 if (!vu_check_queue_msg_file(dev
, vmsg
)) {
1381 if (dev
->vq
[index
].err_fd
!= -1) {
1382 close(dev
->vq
[index
].err_fd
);
1383 dev
->vq
[index
].err_fd
= -1;
1386 dev
->vq
[index
].err_fd
= nofd
? -1 : vmsg
->fds
[0];
1392 vu_get_protocol_features_exec(VuDev
*dev
, VhostUserMsg
*vmsg
)
1395 * Note that we support, but intentionally do not set,
1396 * VHOST_USER_PROTOCOL_F_INBAND_NOTIFICATIONS. This means that
1397 * a device implementation can return it in its callback
1398 * (get_protocol_features) if it wants to use this for
1399 * simulation, but it is otherwise not desirable (if even
1400 * implemented by the master.)
1402 uint64_t features
= 1ULL << VHOST_USER_PROTOCOL_F_MQ
|
1403 1ULL << VHOST_USER_PROTOCOL_F_LOG_SHMFD
|
1404 1ULL << VHOST_USER_PROTOCOL_F_SLAVE_REQ
|
1405 1ULL << VHOST_USER_PROTOCOL_F_HOST_NOTIFIER
|
1406 1ULL << VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD
|
1407 1ULL << VHOST_USER_PROTOCOL_F_REPLY_ACK
|
1408 1ULL << VHOST_USER_PROTOCOL_F_CONFIGURE_MEM_SLOTS
;
1410 if (have_userfault()) {
1411 features
|= 1ULL << VHOST_USER_PROTOCOL_F_PAGEFAULT
;
1414 if (dev
->iface
->get_config
&& dev
->iface
->set_config
) {
1415 features
|= 1ULL << VHOST_USER_PROTOCOL_F_CONFIG
;
1418 if (dev
->iface
->get_protocol_features
) {
1419 features
|= dev
->iface
->get_protocol_features(dev
);
1422 vmsg_set_reply_u64(vmsg
, features
);
1427 vu_set_protocol_features_exec(VuDev
*dev
, VhostUserMsg
*vmsg
)
1429 uint64_t features
= vmsg
->payload
.u64
;
1431 DPRINT("u64: 0x%016"PRIx64
"\n", features
);
1433 dev
->protocol_features
= vmsg
->payload
.u64
;
1435 if (vu_has_protocol_feature(dev
,
1436 VHOST_USER_PROTOCOL_F_INBAND_NOTIFICATIONS
) &&
1437 (!vu_has_protocol_feature(dev
, VHOST_USER_PROTOCOL_F_SLAVE_REQ
) ||
1438 !vu_has_protocol_feature(dev
, VHOST_USER_PROTOCOL_F_REPLY_ACK
))) {
1440 * The use case for using messages for kick/call is simulation, to make
1441 * the kick and call synchronous. To actually get that behaviour, both
1442 * of the other features are required.
1443 * Theoretically, one could use only kick messages, or do them without
1444 * having F_REPLY_ACK, but too many (possibly pending) messages on the
1445 * socket will eventually cause the master to hang, to avoid this in
1446 * scenarios where not desired enforce that the settings are in a way
1447 * that actually enables the simulation case.
1450 "F_IN_BAND_NOTIFICATIONS requires F_SLAVE_REQ && F_REPLY_ACK");
1454 if (dev
->iface
->set_protocol_features
) {
1455 dev
->iface
->set_protocol_features(dev
, features
);
1462 vu_get_queue_num_exec(VuDev
*dev
, VhostUserMsg
*vmsg
)
1464 vmsg_set_reply_u64(vmsg
, dev
->max_queues
);
1469 vu_set_vring_enable_exec(VuDev
*dev
, VhostUserMsg
*vmsg
)
1471 unsigned int index
= vmsg
->payload
.state
.index
;
1472 unsigned int enable
= vmsg
->payload
.state
.num
;
1474 DPRINT("State.index: %d\n", index
);
1475 DPRINT("State.enable: %d\n", enable
);
1477 if (index
>= dev
->max_queues
) {
1478 vu_panic(dev
, "Invalid vring_enable index: %u", index
);
1482 dev
->vq
[index
].enable
= enable
;
1487 vu_set_slave_req_fd(VuDev
*dev
, VhostUserMsg
*vmsg
)
1489 if (vmsg
->fd_num
!= 1) {
1490 vu_panic(dev
, "Invalid slave_req_fd message (%d fd's)", vmsg
->fd_num
);
1494 if (dev
->slave_fd
!= -1) {
1495 close(dev
->slave_fd
);
1497 dev
->slave_fd
= vmsg
->fds
[0];
1498 DPRINT("Got slave_fd: %d\n", vmsg
->fds
[0]);
1504 vu_get_config(VuDev
*dev
, VhostUserMsg
*vmsg
)
1508 if (dev
->iface
->get_config
) {
1509 ret
= dev
->iface
->get_config(dev
, vmsg
->payload
.config
.region
,
1510 vmsg
->payload
.config
.size
);
1514 /* resize to zero to indicate an error to master */
1522 vu_set_config(VuDev
*dev
, VhostUserMsg
*vmsg
)
1526 if (dev
->iface
->set_config
) {
1527 ret
= dev
->iface
->set_config(dev
, vmsg
->payload
.config
.region
,
1528 vmsg
->payload
.config
.offset
,
1529 vmsg
->payload
.config
.size
,
1530 vmsg
->payload
.config
.flags
);
1532 vu_panic(dev
, "Set virtio configuration space failed");
1540 vu_set_postcopy_advise(VuDev
*dev
, VhostUserMsg
*vmsg
)
1542 dev
->postcopy_ufd
= -1;
1544 struct uffdio_api api_struct
;
1546 dev
->postcopy_ufd
= syscall(__NR_userfaultfd
, O_CLOEXEC
| O_NONBLOCK
);
1550 if (dev
->postcopy_ufd
== -1) {
1551 vu_panic(dev
, "Userfaultfd not available: %s", strerror(errno
));
1556 api_struct
.api
= UFFD_API
;
1557 api_struct
.features
= 0;
1558 if (ioctl(dev
->postcopy_ufd
, UFFDIO_API
, &api_struct
)) {
1559 vu_panic(dev
, "Failed UFFDIO_API: %s", strerror(errno
));
1560 close(dev
->postcopy_ufd
);
1561 dev
->postcopy_ufd
= -1;
1564 /* TODO: Stash feature flags somewhere */
1568 /* Return a ufd to the QEMU */
1570 vmsg
->fds
[0] = dev
->postcopy_ufd
;
1571 return true; /* = send a reply */
1575 vu_set_postcopy_listen(VuDev
*dev
, VhostUserMsg
*vmsg
)
1577 if (dev
->nregions
) {
1578 vu_panic(dev
, "Regions already registered at postcopy-listen");
1579 vmsg_set_reply_u64(vmsg
, -1);
1582 dev
->postcopy_listening
= true;
1584 vmsg_set_reply_u64(vmsg
, 0);
1589 vu_set_postcopy_end(VuDev
*dev
, VhostUserMsg
*vmsg
)
1591 DPRINT("%s: Entry\n", __func__
);
1592 dev
->postcopy_listening
= false;
1593 if (dev
->postcopy_ufd
> 0) {
1594 close(dev
->postcopy_ufd
);
1595 dev
->postcopy_ufd
= -1;
1596 DPRINT("%s: Done close\n", __func__
);
1599 vmsg_set_reply_u64(vmsg
, 0);
1600 DPRINT("%s: exit\n", __func__
);
1604 static inline uint64_t
1605 vu_inflight_queue_size(uint16_t queue_size
)
1607 return ALIGN_UP(sizeof(VuDescStateSplit
) * queue_size
+
1608 sizeof(uint16_t), INFLIGHT_ALIGNMENT
);
1612 vu_get_inflight_fd(VuDev
*dev
, VhostUserMsg
*vmsg
)
1617 uint16_t num_queues
, queue_size
;
1619 if (vmsg
->size
!= sizeof(vmsg
->payload
.inflight
)) {
1620 vu_panic(dev
, "Invalid get_inflight_fd message:%d", vmsg
->size
);
1621 vmsg
->payload
.inflight
.mmap_size
= 0;
1625 num_queues
= vmsg
->payload
.inflight
.num_queues
;
1626 queue_size
= vmsg
->payload
.inflight
.queue_size
;
1628 DPRINT("set_inflight_fd num_queues: %"PRId16
"\n", num_queues
);
1629 DPRINT("set_inflight_fd queue_size: %"PRId16
"\n", queue_size
);
1631 mmap_size
= vu_inflight_queue_size(queue_size
) * num_queues
;
1633 addr
= qemu_memfd_alloc("vhost-inflight", mmap_size
,
1634 F_SEAL_GROW
| F_SEAL_SHRINK
| F_SEAL_SEAL
,
1638 vu_panic(dev
, "Failed to alloc vhost inflight area");
1639 vmsg
->payload
.inflight
.mmap_size
= 0;
1643 memset(addr
, 0, mmap_size
);
1645 dev
->inflight_info
.addr
= addr
;
1646 dev
->inflight_info
.size
= vmsg
->payload
.inflight
.mmap_size
= mmap_size
;
1647 dev
->inflight_info
.fd
= vmsg
->fds
[0] = fd
;
1649 vmsg
->payload
.inflight
.mmap_offset
= 0;
1651 DPRINT("send inflight mmap_size: %"PRId64
"\n",
1652 vmsg
->payload
.inflight
.mmap_size
);
1653 DPRINT("send inflight mmap offset: %"PRId64
"\n",
1654 vmsg
->payload
.inflight
.mmap_offset
);
1660 vu_set_inflight_fd(VuDev
*dev
, VhostUserMsg
*vmsg
)
1663 uint64_t mmap_size
, mmap_offset
;
1664 uint16_t num_queues
, queue_size
;
1667 if (vmsg
->fd_num
!= 1 ||
1668 vmsg
->size
!= sizeof(vmsg
->payload
.inflight
)) {
1669 vu_panic(dev
, "Invalid set_inflight_fd message size:%d fds:%d",
1670 vmsg
->size
, vmsg
->fd_num
);
1675 mmap_size
= vmsg
->payload
.inflight
.mmap_size
;
1676 mmap_offset
= vmsg
->payload
.inflight
.mmap_offset
;
1677 num_queues
= vmsg
->payload
.inflight
.num_queues
;
1678 queue_size
= vmsg
->payload
.inflight
.queue_size
;
1680 DPRINT("set_inflight_fd mmap_size: %"PRId64
"\n", mmap_size
);
1681 DPRINT("set_inflight_fd mmap_offset: %"PRId64
"\n", mmap_offset
);
1682 DPRINT("set_inflight_fd num_queues: %"PRId16
"\n", num_queues
);
1683 DPRINT("set_inflight_fd queue_size: %"PRId16
"\n", queue_size
);
1685 rc
= mmap(0, mmap_size
, PROT_READ
| PROT_WRITE
, MAP_SHARED
,
1688 if (rc
== MAP_FAILED
) {
1689 vu_panic(dev
, "set_inflight_fd mmap error: %s", strerror(errno
));
1693 if (dev
->inflight_info
.fd
) {
1694 close(dev
->inflight_info
.fd
);
1697 if (dev
->inflight_info
.addr
) {
1698 munmap(dev
->inflight_info
.addr
, dev
->inflight_info
.size
);
1701 dev
->inflight_info
.fd
= fd
;
1702 dev
->inflight_info
.addr
= rc
;
1703 dev
->inflight_info
.size
= mmap_size
;
1705 for (i
= 0; i
< num_queues
; i
++) {
1706 dev
->vq
[i
].inflight
= (VuVirtqInflight
*)rc
;
1707 dev
->vq
[i
].inflight
->desc_num
= queue_size
;
1708 rc
= (void *)((char *)rc
+ vu_inflight_queue_size(queue_size
));
1715 vu_handle_vring_kick(VuDev
*dev
, VhostUserMsg
*vmsg
)
1717 unsigned int index
= vmsg
->payload
.state
.index
;
1719 if (index
>= dev
->max_queues
) {
1720 vu_panic(dev
, "Invalid queue index: %u", index
);
1724 DPRINT("Got kick message: handler:%p idx:%d\n",
1725 dev
->vq
[index
].handler
, index
);
1727 if (!dev
->vq
[index
].started
) {
1728 dev
->vq
[index
].started
= true;
1730 if (dev
->iface
->queue_set_started
) {
1731 dev
->iface
->queue_set_started(dev
, index
, true);
1735 if (dev
->vq
[index
].handler
) {
1736 dev
->vq
[index
].handler(dev
, index
);
1742 static bool vu_handle_get_max_memslots(VuDev
*dev
, VhostUserMsg
*vmsg
)
1744 vmsg
->flags
= VHOST_USER_REPLY_MASK
| VHOST_USER_VERSION
;
1745 vmsg
->size
= sizeof(vmsg
->payload
.u64
);
1746 vmsg
->payload
.u64
= VHOST_USER_MAX_RAM_SLOTS
;
1749 if (!vu_message_write(dev
, dev
->sock
, vmsg
)) {
1750 vu_panic(dev
, "Failed to send max ram slots: %s\n", strerror(errno
));
1753 DPRINT("u64: 0x%016"PRIx64
"\n", (uint64_t) VHOST_USER_MAX_RAM_SLOTS
);
1759 vu_process_message(VuDev
*dev
, VhostUserMsg
*vmsg
)
1763 /* Print out generic part of the request. */
1764 DPRINT("================ Vhost user message ================\n");
1765 DPRINT("Request: %s (%d)\n", vu_request_to_string(vmsg
->request
),
1767 DPRINT("Flags: 0x%x\n", vmsg
->flags
);
1768 DPRINT("Size: %d\n", vmsg
->size
);
1773 for (i
= 0; i
< vmsg
->fd_num
; i
++) {
1774 DPRINT(" %d", vmsg
->fds
[i
]);
1779 if (dev
->iface
->process_msg
&&
1780 dev
->iface
->process_msg(dev
, vmsg
, &do_reply
)) {
1784 switch (vmsg
->request
) {
1785 case VHOST_USER_GET_FEATURES
:
1786 return vu_get_features_exec(dev
, vmsg
);
1787 case VHOST_USER_SET_FEATURES
:
1788 return vu_set_features_exec(dev
, vmsg
);
1789 case VHOST_USER_GET_PROTOCOL_FEATURES
:
1790 return vu_get_protocol_features_exec(dev
, vmsg
);
1791 case VHOST_USER_SET_PROTOCOL_FEATURES
:
1792 return vu_set_protocol_features_exec(dev
, vmsg
);
1793 case VHOST_USER_SET_OWNER
:
1794 return vu_set_owner_exec(dev
, vmsg
);
1795 case VHOST_USER_RESET_OWNER
:
1796 return vu_reset_device_exec(dev
, vmsg
);
1797 case VHOST_USER_SET_MEM_TABLE
:
1798 return vu_set_mem_table_exec(dev
, vmsg
);
1799 case VHOST_USER_SET_LOG_BASE
:
1800 return vu_set_log_base_exec(dev
, vmsg
);
1801 case VHOST_USER_SET_LOG_FD
:
1802 return vu_set_log_fd_exec(dev
, vmsg
);
1803 case VHOST_USER_SET_VRING_NUM
:
1804 return vu_set_vring_num_exec(dev
, vmsg
);
1805 case VHOST_USER_SET_VRING_ADDR
:
1806 return vu_set_vring_addr_exec(dev
, vmsg
);
1807 case VHOST_USER_SET_VRING_BASE
:
1808 return vu_set_vring_base_exec(dev
, vmsg
);
1809 case VHOST_USER_GET_VRING_BASE
:
1810 return vu_get_vring_base_exec(dev
, vmsg
);
1811 case VHOST_USER_SET_VRING_KICK
:
1812 return vu_set_vring_kick_exec(dev
, vmsg
);
1813 case VHOST_USER_SET_VRING_CALL
:
1814 return vu_set_vring_call_exec(dev
, vmsg
);
1815 case VHOST_USER_SET_VRING_ERR
:
1816 return vu_set_vring_err_exec(dev
, vmsg
);
1817 case VHOST_USER_GET_QUEUE_NUM
:
1818 return vu_get_queue_num_exec(dev
, vmsg
);
1819 case VHOST_USER_SET_VRING_ENABLE
:
1820 return vu_set_vring_enable_exec(dev
, vmsg
);
1821 case VHOST_USER_SET_SLAVE_REQ_FD
:
1822 return vu_set_slave_req_fd(dev
, vmsg
);
1823 case VHOST_USER_GET_CONFIG
:
1824 return vu_get_config(dev
, vmsg
);
1825 case VHOST_USER_SET_CONFIG
:
1826 return vu_set_config(dev
, vmsg
);
1827 case VHOST_USER_NONE
:
1828 /* if you need processing before exit, override iface->process_msg */
1830 case VHOST_USER_POSTCOPY_ADVISE
:
1831 return vu_set_postcopy_advise(dev
, vmsg
);
1832 case VHOST_USER_POSTCOPY_LISTEN
:
1833 return vu_set_postcopy_listen(dev
, vmsg
);
1834 case VHOST_USER_POSTCOPY_END
:
1835 return vu_set_postcopy_end(dev
, vmsg
);
1836 case VHOST_USER_GET_INFLIGHT_FD
:
1837 return vu_get_inflight_fd(dev
, vmsg
);
1838 case VHOST_USER_SET_INFLIGHT_FD
:
1839 return vu_set_inflight_fd(dev
, vmsg
);
1840 case VHOST_USER_VRING_KICK
:
1841 return vu_handle_vring_kick(dev
, vmsg
);
1842 case VHOST_USER_GET_MAX_MEM_SLOTS
:
1843 return vu_handle_get_max_memslots(dev
, vmsg
);
1844 case VHOST_USER_ADD_MEM_REG
:
1845 return vu_add_mem_reg(dev
, vmsg
);
1846 case VHOST_USER_REM_MEM_REG
:
1847 return vu_rem_mem_reg(dev
, vmsg
);
1849 vmsg_close_fds(vmsg
);
1850 vu_panic(dev
, "Unhandled request: %d", vmsg
->request
);
1857 vu_dispatch(VuDev
*dev
)
1859 VhostUserMsg vmsg
= { 0, };
1860 int reply_requested
;
1861 bool need_reply
, success
= false;
1863 if (!vu_message_read(dev
, dev
->sock
, &vmsg
)) {
1867 need_reply
= vmsg
.flags
& VHOST_USER_NEED_REPLY_MASK
;
1869 reply_requested
= vu_process_message(dev
, &vmsg
);
1870 if (!reply_requested
&& need_reply
) {
1871 vmsg_set_reply_u64(&vmsg
, 0);
1872 reply_requested
= 1;
1875 if (!reply_requested
) {
1880 if (!vu_send_reply(dev
, dev
->sock
, &vmsg
)) {
1892 vu_deinit(VuDev
*dev
)
1896 for (i
= 0; i
< dev
->nregions
; i
++) {
1897 VuDevRegion
*r
= &dev
->regions
[i
];
1898 void *m
= (void *) (uintptr_t) r
->mmap_addr
;
1899 if (m
!= MAP_FAILED
) {
1900 munmap(m
, r
->size
+ r
->mmap_offset
);
1905 for (i
= 0; i
< dev
->max_queues
; i
++) {
1906 VuVirtq
*vq
= &dev
->vq
[i
];
1908 if (vq
->call_fd
!= -1) {
1913 if (vq
->kick_fd
!= -1) {
1918 if (vq
->err_fd
!= -1) {
1923 if (vq
->resubmit_list
) {
1924 free(vq
->resubmit_list
);
1925 vq
->resubmit_list
= NULL
;
1928 vq
->inflight
= NULL
;
1931 if (dev
->inflight_info
.addr
) {
1932 munmap(dev
->inflight_info
.addr
, dev
->inflight_info
.size
);
1933 dev
->inflight_info
.addr
= NULL
;
1936 if (dev
->inflight_info
.fd
> 0) {
1937 close(dev
->inflight_info
.fd
);
1938 dev
->inflight_info
.fd
= -1;
1942 if (dev
->slave_fd
!= -1) {
1943 close(dev
->slave_fd
);
1946 pthread_mutex_destroy(&dev
->slave_mutex
);
1948 if (dev
->sock
!= -1) {
1958 uint16_t max_queues
,
1961 vu_set_watch_cb set_watch
,
1962 vu_remove_watch_cb remove_watch
,
1963 const VuDevIface
*iface
)
1967 assert(max_queues
> 0);
1968 assert(socket
>= 0);
1970 assert(remove_watch
);
1974 memset(dev
, 0, sizeof(*dev
));
1978 dev
->set_watch
= set_watch
;
1979 dev
->remove_watch
= remove_watch
;
1981 dev
->log_call_fd
= -1;
1982 pthread_mutex_init(&dev
->slave_mutex
, NULL
);
1984 dev
->max_queues
= max_queues
;
1986 dev
->vq
= malloc(max_queues
* sizeof(dev
->vq
[0]));
1988 DPRINT("%s: failed to malloc virtqueues\n", __func__
);
1992 for (i
= 0; i
< max_queues
; i
++) {
1993 dev
->vq
[i
] = (VuVirtq
) {
1994 .call_fd
= -1, .kick_fd
= -1, .err_fd
= -1,
1995 .notification
= true,
2003 vu_get_queue(VuDev
*dev
, int qidx
)
2005 assert(qidx
< dev
->max_queues
);
2006 return &dev
->vq
[qidx
];
2010 vu_queue_enabled(VuDev
*dev
, VuVirtq
*vq
)
2016 vu_queue_started(const VuDev
*dev
, const VuVirtq
*vq
)
2021 static inline uint16_t
2022 vring_avail_flags(VuVirtq
*vq
)
2024 return vq
->vring
.avail
->flags
;
2027 static inline uint16_t
2028 vring_avail_idx(VuVirtq
*vq
)
2030 vq
->shadow_avail_idx
= vq
->vring
.avail
->idx
;
2032 return vq
->shadow_avail_idx
;
2035 static inline uint16_t
2036 vring_avail_ring(VuVirtq
*vq
, int i
)
2038 return vq
->vring
.avail
->ring
[i
];
2041 static inline uint16_t
2042 vring_get_used_event(VuVirtq
*vq
)
2044 return vring_avail_ring(vq
, vq
->vring
.num
);
2048 virtqueue_num_heads(VuDev
*dev
, VuVirtq
*vq
, unsigned int idx
)
2050 uint16_t num_heads
= vring_avail_idx(vq
) - idx
;
2052 /* Check it isn't doing very strange things with descriptor numbers. */
2053 if (num_heads
> vq
->vring
.num
) {
2054 vu_panic(dev
, "Guest moved used index from %u to %u",
2055 idx
, vq
->shadow_avail_idx
);
2059 /* On success, callers read a descriptor at vq->last_avail_idx.
2060 * Make sure descriptor read does not bypass avail index read. */
2068 virtqueue_get_head(VuDev
*dev
, VuVirtq
*vq
,
2069 unsigned int idx
, unsigned int *head
)
2071 /* Grab the next descriptor number they're advertising, and increment
2072 * the index we've seen. */
2073 *head
= vring_avail_ring(vq
, idx
% vq
->vring
.num
);
2075 /* If their number is silly, that's a fatal mistake. */
2076 if (*head
>= vq
->vring
.num
) {
2077 vu_panic(dev
, "Guest says index %u is available", head
);
2085 virtqueue_read_indirect_desc(VuDev
*dev
, struct vring_desc
*desc
,
2086 uint64_t addr
, size_t len
)
2088 struct vring_desc
*ori_desc
;
2091 if (len
> (VIRTQUEUE_MAX_SIZE
* sizeof(struct vring_desc
))) {
2101 ori_desc
= vu_gpa_to_va(dev
, &read_len
, addr
);
2106 memcpy(desc
, ori_desc
, read_len
);
2116 VIRTQUEUE_READ_DESC_ERROR
= -1,
2117 VIRTQUEUE_READ_DESC_DONE
= 0, /* end of chain */
2118 VIRTQUEUE_READ_DESC_MORE
= 1, /* more buffers in chain */
2122 virtqueue_read_next_desc(VuDev
*dev
, struct vring_desc
*desc
,
2123 int i
, unsigned int max
, unsigned int *next
)
2125 /* If this descriptor says it doesn't chain, we're done. */
2126 if (!(desc
[i
].flags
& VRING_DESC_F_NEXT
)) {
2127 return VIRTQUEUE_READ_DESC_DONE
;
2130 /* Check they're not leading us off end of descriptors. */
2131 *next
= desc
[i
].next
;
2132 /* Make sure compiler knows to grab that: we don't want it changing! */
2136 vu_panic(dev
, "Desc next is %u", next
);
2137 return VIRTQUEUE_READ_DESC_ERROR
;
2140 return VIRTQUEUE_READ_DESC_MORE
;
2144 vu_queue_get_avail_bytes(VuDev
*dev
, VuVirtq
*vq
, unsigned int *in_bytes
,
2145 unsigned int *out_bytes
,
2146 unsigned max_in_bytes
, unsigned max_out_bytes
)
2149 unsigned int total_bufs
, in_total
, out_total
;
2152 idx
= vq
->last_avail_idx
;
2154 total_bufs
= in_total
= out_total
= 0;
2155 if (unlikely(dev
->broken
) ||
2156 unlikely(!vq
->vring
.avail
)) {
2160 while ((rc
= virtqueue_num_heads(dev
, vq
, idx
)) > 0) {
2161 unsigned int max
, desc_len
, num_bufs
, indirect
= 0;
2162 uint64_t desc_addr
, read_len
;
2163 struct vring_desc
*desc
;
2164 struct vring_desc desc_buf
[VIRTQUEUE_MAX_SIZE
];
2167 max
= vq
->vring
.num
;
2168 num_bufs
= total_bufs
;
2169 if (!virtqueue_get_head(dev
, vq
, idx
++, &i
)) {
2172 desc
= vq
->vring
.desc
;
2174 if (desc
[i
].flags
& VRING_DESC_F_INDIRECT
) {
2175 if (desc
[i
].len
% sizeof(struct vring_desc
)) {
2176 vu_panic(dev
, "Invalid size for indirect buffer table");
2180 /* If we've got too many, that implies a descriptor loop. */
2181 if (num_bufs
>= max
) {
2182 vu_panic(dev
, "Looped descriptor");
2186 /* loop over the indirect descriptor table */
2188 desc_addr
= desc
[i
].addr
;
2189 desc_len
= desc
[i
].len
;
2190 max
= desc_len
/ sizeof(struct vring_desc
);
2191 read_len
= desc_len
;
2192 desc
= vu_gpa_to_va(dev
, &read_len
, desc_addr
);
2193 if (unlikely(desc
&& read_len
!= desc_len
)) {
2194 /* Failed to use zero copy */
2196 if (!virtqueue_read_indirect_desc(dev
, desc_buf
,
2203 vu_panic(dev
, "Invalid indirect buffer table");
2210 /* If we've got too many, that implies a descriptor loop. */
2211 if (++num_bufs
> max
) {
2212 vu_panic(dev
, "Looped descriptor");
2216 if (desc
[i
].flags
& VRING_DESC_F_WRITE
) {
2217 in_total
+= desc
[i
].len
;
2219 out_total
+= desc
[i
].len
;
2221 if (in_total
>= max_in_bytes
&& out_total
>= max_out_bytes
) {
2224 rc
= virtqueue_read_next_desc(dev
, desc
, i
, max
, &i
);
2225 } while (rc
== VIRTQUEUE_READ_DESC_MORE
);
2227 if (rc
== VIRTQUEUE_READ_DESC_ERROR
) {
2232 total_bufs
= num_bufs
;
2242 *in_bytes
= in_total
;
2245 *out_bytes
= out_total
;
2250 in_total
= out_total
= 0;
2255 vu_queue_avail_bytes(VuDev
*dev
, VuVirtq
*vq
, unsigned int in_bytes
,
2256 unsigned int out_bytes
)
2258 unsigned int in_total
, out_total
;
2260 vu_queue_get_avail_bytes(dev
, vq
, &in_total
, &out_total
,
2261 in_bytes
, out_bytes
);
2263 return in_bytes
<= in_total
&& out_bytes
<= out_total
;
2266 /* Fetch avail_idx from VQ memory only when we really need to know if
2267 * guest has added some buffers. */
2269 vu_queue_empty(VuDev
*dev
, VuVirtq
*vq
)
2271 if (unlikely(dev
->broken
) ||
2272 unlikely(!vq
->vring
.avail
)) {
2276 if (vq
->shadow_avail_idx
!= vq
->last_avail_idx
) {
2280 return vring_avail_idx(vq
) == vq
->last_avail_idx
;
2284 vring_notify(VuDev
*dev
, VuVirtq
*vq
)
2289 /* We need to expose used array entries before checking used event. */
2292 /* Always notify when queue is empty (when feature acknowledge) */
2293 if (vu_has_feature(dev
, VIRTIO_F_NOTIFY_ON_EMPTY
) &&
2294 !vq
->inuse
&& vu_queue_empty(dev
, vq
)) {
2298 if (!vu_has_feature(dev
, VIRTIO_RING_F_EVENT_IDX
)) {
2299 return !(vring_avail_flags(vq
) & VRING_AVAIL_F_NO_INTERRUPT
);
2302 v
= vq
->signalled_used_valid
;
2303 vq
->signalled_used_valid
= true;
2304 old
= vq
->signalled_used
;
2305 new = vq
->signalled_used
= vq
->used_idx
;
2306 return !v
|| vring_need_event(vring_get_used_event(vq
), new, old
);
2309 static void _vu_queue_notify(VuDev
*dev
, VuVirtq
*vq
, bool sync
)
2311 if (unlikely(dev
->broken
) ||
2312 unlikely(!vq
->vring
.avail
)) {
2316 if (!vring_notify(dev
, vq
)) {
2317 DPRINT("skipped notify...\n");
2321 if (vq
->call_fd
< 0 &&
2322 vu_has_protocol_feature(dev
,
2323 VHOST_USER_PROTOCOL_F_INBAND_NOTIFICATIONS
) &&
2324 vu_has_protocol_feature(dev
, VHOST_USER_PROTOCOL_F_SLAVE_REQ
)) {
2325 VhostUserMsg vmsg
= {
2326 .request
= VHOST_USER_SLAVE_VRING_CALL
,
2327 .flags
= VHOST_USER_VERSION
,
2328 .size
= sizeof(vmsg
.payload
.state
),
2330 .index
= vq
- dev
->vq
,
2334 vu_has_protocol_feature(dev
,
2335 VHOST_USER_PROTOCOL_F_REPLY_ACK
);
2338 vmsg
.flags
|= VHOST_USER_NEED_REPLY_MASK
;
2341 vu_message_write(dev
, dev
->slave_fd
, &vmsg
);
2343 vu_message_read(dev
, dev
->slave_fd
, &vmsg
);
2348 if (eventfd_write(vq
->call_fd
, 1) < 0) {
2349 vu_panic(dev
, "Error writing eventfd: %s", strerror(errno
));
2353 void vu_queue_notify(VuDev
*dev
, VuVirtq
*vq
)
2355 _vu_queue_notify(dev
, vq
, false);
2358 void vu_queue_notify_sync(VuDev
*dev
, VuVirtq
*vq
)
2360 _vu_queue_notify(dev
, vq
, true);
2364 vring_used_flags_set_bit(VuVirtq
*vq
, int mask
)
2368 flags
= (uint16_t *)((char*)vq
->vring
.used
+
2369 offsetof(struct vring_used
, flags
));
2374 vring_used_flags_unset_bit(VuVirtq
*vq
, int mask
)
2378 flags
= (uint16_t *)((char*)vq
->vring
.used
+
2379 offsetof(struct vring_used
, flags
));
2384 vring_set_avail_event(VuVirtq
*vq
, uint16_t val
)
2386 if (!vq
->notification
) {
2390 *((uint16_t *) &vq
->vring
.used
->ring
[vq
->vring
.num
]) = val
;
2394 vu_queue_set_notification(VuDev
*dev
, VuVirtq
*vq
, int enable
)
2396 vq
->notification
= enable
;
2397 if (vu_has_feature(dev
, VIRTIO_RING_F_EVENT_IDX
)) {
2398 vring_set_avail_event(vq
, vring_avail_idx(vq
));
2399 } else if (enable
) {
2400 vring_used_flags_unset_bit(vq
, VRING_USED_F_NO_NOTIFY
);
2402 vring_used_flags_set_bit(vq
, VRING_USED_F_NO_NOTIFY
);
2405 /* Expose avail event/used flags before caller checks the avail idx. */
2411 virtqueue_map_desc(VuDev
*dev
,
2412 unsigned int *p_num_sg
, struct iovec
*iov
,
2413 unsigned int max_num_sg
, bool is_write
,
2414 uint64_t pa
, size_t sz
)
2416 unsigned num_sg
= *p_num_sg
;
2418 assert(num_sg
<= max_num_sg
);
2421 vu_panic(dev
, "virtio: zero sized buffers are not allowed");
2428 if (num_sg
== max_num_sg
) {
2429 vu_panic(dev
, "virtio: too many descriptors in indirect table");
2433 iov
[num_sg
].iov_base
= vu_gpa_to_va(dev
, &len
, pa
);
2434 if (iov
[num_sg
].iov_base
== NULL
) {
2435 vu_panic(dev
, "virtio: invalid address for buffers");
2438 iov
[num_sg
].iov_len
= len
;
2448 virtqueue_alloc_element(size_t sz
,
2449 unsigned out_num
, unsigned in_num
)
2451 VuVirtqElement
*elem
;
2452 size_t in_sg_ofs
= ALIGN_UP(sz
, __alignof__(elem
->in_sg
[0]));
2453 size_t out_sg_ofs
= in_sg_ofs
+ in_num
* sizeof(elem
->in_sg
[0]);
2454 size_t out_sg_end
= out_sg_ofs
+ out_num
* sizeof(elem
->out_sg
[0]);
2456 assert(sz
>= sizeof(VuVirtqElement
));
2457 elem
= malloc(out_sg_end
);
2458 elem
->out_num
= out_num
;
2459 elem
->in_num
= in_num
;
2460 elem
->in_sg
= (void *)elem
+ in_sg_ofs
;
2461 elem
->out_sg
= (void *)elem
+ out_sg_ofs
;
2466 vu_queue_map_desc(VuDev
*dev
, VuVirtq
*vq
, unsigned int idx
, size_t sz
)
2468 struct vring_desc
*desc
= vq
->vring
.desc
;
2469 uint64_t desc_addr
, read_len
;
2470 unsigned int desc_len
;
2471 unsigned int max
= vq
->vring
.num
;
2472 unsigned int i
= idx
;
2473 VuVirtqElement
*elem
;
2474 unsigned int out_num
= 0, in_num
= 0;
2475 struct iovec iov
[VIRTQUEUE_MAX_SIZE
];
2476 struct vring_desc desc_buf
[VIRTQUEUE_MAX_SIZE
];
2479 if (desc
[i
].flags
& VRING_DESC_F_INDIRECT
) {
2480 if (desc
[i
].len
% sizeof(struct vring_desc
)) {
2481 vu_panic(dev
, "Invalid size for indirect buffer table");
2484 /* loop over the indirect descriptor table */
2485 desc_addr
= desc
[i
].addr
;
2486 desc_len
= desc
[i
].len
;
2487 max
= desc_len
/ sizeof(struct vring_desc
);
2488 read_len
= desc_len
;
2489 desc
= vu_gpa_to_va(dev
, &read_len
, desc_addr
);
2490 if (unlikely(desc
&& read_len
!= desc_len
)) {
2491 /* Failed to use zero copy */
2493 if (!virtqueue_read_indirect_desc(dev
, desc_buf
,
2500 vu_panic(dev
, "Invalid indirect buffer table");
2506 /* Collect all the descriptors */
2508 if (desc
[i
].flags
& VRING_DESC_F_WRITE
) {
2509 virtqueue_map_desc(dev
, &in_num
, iov
+ out_num
,
2510 VIRTQUEUE_MAX_SIZE
- out_num
, true,
2511 desc
[i
].addr
, desc
[i
].len
);
2514 vu_panic(dev
, "Incorrect order for descriptors");
2517 virtqueue_map_desc(dev
, &out_num
, iov
,
2518 VIRTQUEUE_MAX_SIZE
, false,
2519 desc
[i
].addr
, desc
[i
].len
);
2522 /* If we've got too many, that implies a descriptor loop. */
2523 if ((in_num
+ out_num
) > max
) {
2524 vu_panic(dev
, "Looped descriptor");
2526 rc
= virtqueue_read_next_desc(dev
, desc
, i
, max
, &i
);
2527 } while (rc
== VIRTQUEUE_READ_DESC_MORE
);
2529 if (rc
== VIRTQUEUE_READ_DESC_ERROR
) {
2530 vu_panic(dev
, "read descriptor error");
2534 /* Now copy what we have collected and mapped */
2535 elem
= virtqueue_alloc_element(sz
, out_num
, in_num
);
2537 for (i
= 0; i
< out_num
; i
++) {
2538 elem
->out_sg
[i
] = iov
[i
];
2540 for (i
= 0; i
< in_num
; i
++) {
2541 elem
->in_sg
[i
] = iov
[out_num
+ i
];
2548 vu_queue_inflight_get(VuDev
*dev
, VuVirtq
*vq
, int desc_idx
)
2550 if (!vu_has_protocol_feature(dev
, VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD
)) {
2554 if (unlikely(!vq
->inflight
)) {
2558 vq
->inflight
->desc
[desc_idx
].counter
= vq
->counter
++;
2559 vq
->inflight
->desc
[desc_idx
].inflight
= 1;
2565 vu_queue_inflight_pre_put(VuDev
*dev
, VuVirtq
*vq
, int desc_idx
)
2567 if (!vu_has_protocol_feature(dev
, VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD
)) {
2571 if (unlikely(!vq
->inflight
)) {
2575 vq
->inflight
->last_batch_head
= desc_idx
;
2581 vu_queue_inflight_post_put(VuDev
*dev
, VuVirtq
*vq
, int desc_idx
)
2583 if (!vu_has_protocol_feature(dev
, VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD
)) {
2587 if (unlikely(!vq
->inflight
)) {
2593 vq
->inflight
->desc
[desc_idx
].inflight
= 0;
2597 vq
->inflight
->used_idx
= vq
->used_idx
;
2603 vu_queue_pop(VuDev
*dev
, VuVirtq
*vq
, size_t sz
)
2607 VuVirtqElement
*elem
;
2609 if (unlikely(dev
->broken
) ||
2610 unlikely(!vq
->vring
.avail
)) {
2614 if (unlikely(vq
->resubmit_list
&& vq
->resubmit_num
> 0)) {
2615 i
= (--vq
->resubmit_num
);
2616 elem
= vu_queue_map_desc(dev
, vq
, vq
->resubmit_list
[i
].index
, sz
);
2618 if (!vq
->resubmit_num
) {
2619 free(vq
->resubmit_list
);
2620 vq
->resubmit_list
= NULL
;
2626 if (vu_queue_empty(dev
, vq
)) {
2630 * Needed after virtio_queue_empty(), see comment in
2631 * virtqueue_num_heads().
2635 if (vq
->inuse
>= vq
->vring
.num
) {
2636 vu_panic(dev
, "Virtqueue size exceeded");
2640 if (!virtqueue_get_head(dev
, vq
, vq
->last_avail_idx
++, &head
)) {
2644 if (vu_has_feature(dev
, VIRTIO_RING_F_EVENT_IDX
)) {
2645 vring_set_avail_event(vq
, vq
->last_avail_idx
);
2648 elem
= vu_queue_map_desc(dev
, vq
, head
, sz
);
2656 vu_queue_inflight_get(dev
, vq
, head
);
2662 vu_queue_detach_element(VuDev
*dev
, VuVirtq
*vq
, VuVirtqElement
*elem
,
2666 /* unmap, when DMA support is added */
2670 vu_queue_unpop(VuDev
*dev
, VuVirtq
*vq
, VuVirtqElement
*elem
,
2673 vq
->last_avail_idx
--;
2674 vu_queue_detach_element(dev
, vq
, elem
, len
);
2678 vu_queue_rewind(VuDev
*dev
, VuVirtq
*vq
, unsigned int num
)
2680 if (num
> vq
->inuse
) {
2683 vq
->last_avail_idx
-= num
;
2689 void vring_used_write(VuDev
*dev
, VuVirtq
*vq
,
2690 struct vring_used_elem
*uelem
, int i
)
2692 struct vring_used
*used
= vq
->vring
.used
;
2694 used
->ring
[i
] = *uelem
;
2695 vu_log_write(dev
, vq
->vring
.log_guest_addr
+
2696 offsetof(struct vring_used
, ring
[i
]),
2697 sizeof(used
->ring
[i
]));
2702 vu_log_queue_fill(VuDev
*dev
, VuVirtq
*vq
,
2703 const VuVirtqElement
*elem
,
2706 struct vring_desc
*desc
= vq
->vring
.desc
;
2707 unsigned int i
, max
, min
, desc_len
;
2708 uint64_t desc_addr
, read_len
;
2709 struct vring_desc desc_buf
[VIRTQUEUE_MAX_SIZE
];
2710 unsigned num_bufs
= 0;
2712 max
= vq
->vring
.num
;
2715 if (desc
[i
].flags
& VRING_DESC_F_INDIRECT
) {
2716 if (desc
[i
].len
% sizeof(struct vring_desc
)) {
2717 vu_panic(dev
, "Invalid size for indirect buffer table");
2720 /* loop over the indirect descriptor table */
2721 desc_addr
= desc
[i
].addr
;
2722 desc_len
= desc
[i
].len
;
2723 max
= desc_len
/ sizeof(struct vring_desc
);
2724 read_len
= desc_len
;
2725 desc
= vu_gpa_to_va(dev
, &read_len
, desc_addr
);
2726 if (unlikely(desc
&& read_len
!= desc_len
)) {
2727 /* Failed to use zero copy */
2729 if (!virtqueue_read_indirect_desc(dev
, desc_buf
,
2736 vu_panic(dev
, "Invalid indirect buffer table");
2743 if (++num_bufs
> max
) {
2744 vu_panic(dev
, "Looped descriptor");
2748 if (desc
[i
].flags
& VRING_DESC_F_WRITE
) {
2749 min
= MIN(desc
[i
].len
, len
);
2750 vu_log_write(dev
, desc
[i
].addr
, min
);
2755 (virtqueue_read_next_desc(dev
, desc
, i
, max
, &i
)
2756 == VIRTQUEUE_READ_DESC_MORE
));
2760 vu_queue_fill(VuDev
*dev
, VuVirtq
*vq
,
2761 const VuVirtqElement
*elem
,
2762 unsigned int len
, unsigned int idx
)
2764 struct vring_used_elem uelem
;
2766 if (unlikely(dev
->broken
) ||
2767 unlikely(!vq
->vring
.avail
)) {
2771 vu_log_queue_fill(dev
, vq
, elem
, len
);
2773 idx
= (idx
+ vq
->used_idx
) % vq
->vring
.num
;
2775 uelem
.id
= elem
->index
;
2777 vring_used_write(dev
, vq
, &uelem
, idx
);
2781 void vring_used_idx_set(VuDev
*dev
, VuVirtq
*vq
, uint16_t val
)
2783 vq
->vring
.used
->idx
= val
;
2785 vq
->vring
.log_guest_addr
+ offsetof(struct vring_used
, idx
),
2786 sizeof(vq
->vring
.used
->idx
));
2792 vu_queue_flush(VuDev
*dev
, VuVirtq
*vq
, unsigned int count
)
2796 if (unlikely(dev
->broken
) ||
2797 unlikely(!vq
->vring
.avail
)) {
2801 /* Make sure buffer is written before we update index. */
2806 vring_used_idx_set(dev
, vq
, new);
2808 if (unlikely((int16_t)(new - vq
->signalled_used
) < (uint16_t)(new - old
))) {
2809 vq
->signalled_used_valid
= false;
2814 vu_queue_push(VuDev
*dev
, VuVirtq
*vq
,
2815 const VuVirtqElement
*elem
, unsigned int len
)
2817 vu_queue_fill(dev
, vq
, elem
, len
, 0);
2818 vu_queue_inflight_pre_put(dev
, vq
, elem
->index
);
2819 vu_queue_flush(dev
, vq
, 1);
2820 vu_queue_inflight_post_put(dev
, vq
, elem
->index
);