target/mips: Raise exception when DINSV opcode used with DSP disabled
[qemu/ar7.git] / hw / virtio / vhost-user.c
blobee57abe04526f6c55d983cb0254c95d4262977b3
1 /*
2 * vhost-user
4 * Copyright (c) 2013 Virtual Open Systems Sarl.
6 * This work is licensed under the terms of the GNU GPL, version 2 or later.
7 * See the COPYING file in the top-level directory.
9 */
11 #include "qemu/osdep.h"
12 #include "qapi/error.h"
13 #include "hw/virtio/vhost.h"
14 #include "hw/virtio/vhost-user.h"
15 #include "hw/virtio/vhost-backend.h"
16 #include "hw/virtio/virtio.h"
17 #include "hw/virtio/virtio-net.h"
18 #include "chardev/char-fe.h"
19 #include "io/channel-socket.h"
20 #include "sysemu/kvm.h"
21 #include "qemu/error-report.h"
22 #include "qemu/main-loop.h"
23 #include "qemu/sockets.h"
24 #include "sysemu/cryptodev.h"
25 #include "migration/migration.h"
26 #include "migration/postcopy-ram.h"
27 #include "trace.h"
29 #include <sys/ioctl.h>
30 #include <sys/socket.h>
31 #include <sys/un.h>
33 #include "standard-headers/linux/vhost_types.h"
35 #ifdef CONFIG_LINUX
36 #include <linux/userfaultfd.h>
37 #endif
39 #define VHOST_MEMORY_BASELINE_NREGIONS 8
40 #define VHOST_USER_F_PROTOCOL_FEATURES 30
41 #define VHOST_USER_SLAVE_MAX_FDS 8
44 * Set maximum number of RAM slots supported to
45 * the maximum number supported by the target
46 * hardware plaform.
48 #if defined(TARGET_X86) || defined(TARGET_X86_64) || \
49 defined(TARGET_ARM) || defined(TARGET_ARM_64)
50 #include "hw/acpi/acpi.h"
51 #define VHOST_USER_MAX_RAM_SLOTS ACPI_MAX_RAM_SLOTS
53 #elif defined(TARGET_PPC) || defined(TARGET_PPC_64)
54 #include "hw/ppc/spapr.h"
55 #define VHOST_USER_MAX_RAM_SLOTS SPAPR_MAX_RAM_SLOTS
57 #else
58 #define VHOST_USER_MAX_RAM_SLOTS 512
59 #endif
62 * Maximum size of virtio device config space
64 #define VHOST_USER_MAX_CONFIG_SIZE 256
66 enum VhostUserProtocolFeature {
67 VHOST_USER_PROTOCOL_F_MQ = 0,
68 VHOST_USER_PROTOCOL_F_LOG_SHMFD = 1,
69 VHOST_USER_PROTOCOL_F_RARP = 2,
70 VHOST_USER_PROTOCOL_F_REPLY_ACK = 3,
71 VHOST_USER_PROTOCOL_F_NET_MTU = 4,
72 VHOST_USER_PROTOCOL_F_SLAVE_REQ = 5,
73 VHOST_USER_PROTOCOL_F_CROSS_ENDIAN = 6,
74 VHOST_USER_PROTOCOL_F_CRYPTO_SESSION = 7,
75 VHOST_USER_PROTOCOL_F_PAGEFAULT = 8,
76 VHOST_USER_PROTOCOL_F_CONFIG = 9,
77 VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD = 10,
78 VHOST_USER_PROTOCOL_F_HOST_NOTIFIER = 11,
79 VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD = 12,
80 VHOST_USER_PROTOCOL_F_RESET_DEVICE = 13,
81 /* Feature 14 reserved for VHOST_USER_PROTOCOL_F_INBAND_NOTIFICATIONS. */
82 VHOST_USER_PROTOCOL_F_CONFIGURE_MEM_SLOTS = 15,
83 VHOST_USER_PROTOCOL_F_MAX
86 #define VHOST_USER_PROTOCOL_FEATURE_MASK ((1 << VHOST_USER_PROTOCOL_F_MAX) - 1)
88 typedef enum VhostUserRequest {
89 VHOST_USER_NONE = 0,
90 VHOST_USER_GET_FEATURES = 1,
91 VHOST_USER_SET_FEATURES = 2,
92 VHOST_USER_SET_OWNER = 3,
93 VHOST_USER_RESET_OWNER = 4,
94 VHOST_USER_SET_MEM_TABLE = 5,
95 VHOST_USER_SET_LOG_BASE = 6,
96 VHOST_USER_SET_LOG_FD = 7,
97 VHOST_USER_SET_VRING_NUM = 8,
98 VHOST_USER_SET_VRING_ADDR = 9,
99 VHOST_USER_SET_VRING_BASE = 10,
100 VHOST_USER_GET_VRING_BASE = 11,
101 VHOST_USER_SET_VRING_KICK = 12,
102 VHOST_USER_SET_VRING_CALL = 13,
103 VHOST_USER_SET_VRING_ERR = 14,
104 VHOST_USER_GET_PROTOCOL_FEATURES = 15,
105 VHOST_USER_SET_PROTOCOL_FEATURES = 16,
106 VHOST_USER_GET_QUEUE_NUM = 17,
107 VHOST_USER_SET_VRING_ENABLE = 18,
108 VHOST_USER_SEND_RARP = 19,
109 VHOST_USER_NET_SET_MTU = 20,
110 VHOST_USER_SET_SLAVE_REQ_FD = 21,
111 VHOST_USER_IOTLB_MSG = 22,
112 VHOST_USER_SET_VRING_ENDIAN = 23,
113 VHOST_USER_GET_CONFIG = 24,
114 VHOST_USER_SET_CONFIG = 25,
115 VHOST_USER_CREATE_CRYPTO_SESSION = 26,
116 VHOST_USER_CLOSE_CRYPTO_SESSION = 27,
117 VHOST_USER_POSTCOPY_ADVISE = 28,
118 VHOST_USER_POSTCOPY_LISTEN = 29,
119 VHOST_USER_POSTCOPY_END = 30,
120 VHOST_USER_GET_INFLIGHT_FD = 31,
121 VHOST_USER_SET_INFLIGHT_FD = 32,
122 VHOST_USER_GPU_SET_SOCKET = 33,
123 VHOST_USER_RESET_DEVICE = 34,
124 /* Message number 35 reserved for VHOST_USER_VRING_KICK. */
125 VHOST_USER_GET_MAX_MEM_SLOTS = 36,
126 VHOST_USER_ADD_MEM_REG = 37,
127 VHOST_USER_REM_MEM_REG = 38,
128 VHOST_USER_MAX
129 } VhostUserRequest;
131 typedef enum VhostUserSlaveRequest {
132 VHOST_USER_SLAVE_NONE = 0,
133 VHOST_USER_SLAVE_IOTLB_MSG = 1,
134 VHOST_USER_SLAVE_CONFIG_CHANGE_MSG = 2,
135 VHOST_USER_SLAVE_VRING_HOST_NOTIFIER_MSG = 3,
136 VHOST_USER_SLAVE_MAX
137 } VhostUserSlaveRequest;
139 typedef struct VhostUserMemoryRegion {
140 uint64_t guest_phys_addr;
141 uint64_t memory_size;
142 uint64_t userspace_addr;
143 uint64_t mmap_offset;
144 } VhostUserMemoryRegion;
146 typedef struct VhostUserMemory {
147 uint32_t nregions;
148 uint32_t padding;
149 VhostUserMemoryRegion regions[VHOST_MEMORY_BASELINE_NREGIONS];
150 } VhostUserMemory;
152 typedef struct VhostUserMemRegMsg {
153 uint64_t padding;
154 VhostUserMemoryRegion region;
155 } VhostUserMemRegMsg;
157 typedef struct VhostUserLog {
158 uint64_t mmap_size;
159 uint64_t mmap_offset;
160 } VhostUserLog;
162 typedef struct VhostUserConfig {
163 uint32_t offset;
164 uint32_t size;
165 uint32_t flags;
166 uint8_t region[VHOST_USER_MAX_CONFIG_SIZE];
167 } VhostUserConfig;
169 #define VHOST_CRYPTO_SYM_HMAC_MAX_KEY_LEN 512
170 #define VHOST_CRYPTO_SYM_CIPHER_MAX_KEY_LEN 64
172 typedef struct VhostUserCryptoSession {
173 /* session id for success, -1 on errors */
174 int64_t session_id;
175 CryptoDevBackendSymSessionInfo session_setup_data;
176 uint8_t key[VHOST_CRYPTO_SYM_CIPHER_MAX_KEY_LEN];
177 uint8_t auth_key[VHOST_CRYPTO_SYM_HMAC_MAX_KEY_LEN];
178 } VhostUserCryptoSession;
180 static VhostUserConfig c __attribute__ ((unused));
181 #define VHOST_USER_CONFIG_HDR_SIZE (sizeof(c.offset) \
182 + sizeof(c.size) \
183 + sizeof(c.flags))
185 typedef struct VhostUserVringArea {
186 uint64_t u64;
187 uint64_t size;
188 uint64_t offset;
189 } VhostUserVringArea;
191 typedef struct VhostUserInflight {
192 uint64_t mmap_size;
193 uint64_t mmap_offset;
194 uint16_t num_queues;
195 uint16_t queue_size;
196 } VhostUserInflight;
198 typedef struct {
199 VhostUserRequest request;
201 #define VHOST_USER_VERSION_MASK (0x3)
202 #define VHOST_USER_REPLY_MASK (0x1<<2)
203 #define VHOST_USER_NEED_REPLY_MASK (0x1 << 3)
204 uint32_t flags;
205 uint32_t size; /* the following payload size */
206 } QEMU_PACKED VhostUserHeader;
208 typedef union {
209 #define VHOST_USER_VRING_IDX_MASK (0xff)
210 #define VHOST_USER_VRING_NOFD_MASK (0x1<<8)
211 uint64_t u64;
212 struct vhost_vring_state state;
213 struct vhost_vring_addr addr;
214 VhostUserMemory memory;
215 VhostUserMemRegMsg mem_reg;
216 VhostUserLog log;
217 struct vhost_iotlb_msg iotlb;
218 VhostUserConfig config;
219 VhostUserCryptoSession session;
220 VhostUserVringArea area;
221 VhostUserInflight inflight;
222 } VhostUserPayload;
224 typedef struct VhostUserMsg {
225 VhostUserHeader hdr;
226 VhostUserPayload payload;
227 } QEMU_PACKED VhostUserMsg;
229 static VhostUserMsg m __attribute__ ((unused));
230 #define VHOST_USER_HDR_SIZE (sizeof(VhostUserHeader))
232 #define VHOST_USER_PAYLOAD_SIZE (sizeof(VhostUserPayload))
234 /* The version of the protocol we support */
235 #define VHOST_USER_VERSION (0x1)
237 struct vhost_user {
238 struct vhost_dev *dev;
239 /* Shared between vhost devs of the same virtio device */
240 VhostUserState *user;
241 QIOChannel *slave_ioc;
242 GSource *slave_src;
243 NotifierWithReturn postcopy_notifier;
244 struct PostCopyFD postcopy_fd;
245 uint64_t postcopy_client_bases[VHOST_USER_MAX_RAM_SLOTS];
246 /* Length of the region_rb and region_rb_offset arrays */
247 size_t region_rb_len;
248 /* RAMBlock associated with a given region */
249 RAMBlock **region_rb;
250 /* The offset from the start of the RAMBlock to the start of the
251 * vhost region.
253 ram_addr_t *region_rb_offset;
255 /* True once we've entered postcopy_listen */
256 bool postcopy_listen;
258 /* Our current regions */
259 int num_shadow_regions;
260 struct vhost_memory_region shadow_regions[VHOST_USER_MAX_RAM_SLOTS];
263 struct scrub_regions {
264 struct vhost_memory_region *region;
265 int reg_idx;
266 int fd_idx;
269 static bool ioeventfd_enabled(void)
271 return !kvm_enabled() || kvm_eventfds_enabled();
274 static int vhost_user_read_header(struct vhost_dev *dev, VhostUserMsg *msg)
276 struct vhost_user *u = dev->opaque;
277 CharBackend *chr = u->user->chr;
278 uint8_t *p = (uint8_t *) msg;
279 int r, size = VHOST_USER_HDR_SIZE;
281 r = qemu_chr_fe_read_all(chr, p, size);
282 if (r != size) {
283 error_report("Failed to read msg header. Read %d instead of %d."
284 " Original request %d.", r, size, msg->hdr.request);
285 return -1;
288 /* validate received flags */
289 if (msg->hdr.flags != (VHOST_USER_REPLY_MASK | VHOST_USER_VERSION)) {
290 error_report("Failed to read msg header."
291 " Flags 0x%x instead of 0x%x.", msg->hdr.flags,
292 VHOST_USER_REPLY_MASK | VHOST_USER_VERSION);
293 return -1;
296 return 0;
299 struct vhost_user_read_cb_data {
300 struct vhost_dev *dev;
301 VhostUserMsg *msg;
302 GMainLoop *loop;
303 int ret;
306 static gboolean vhost_user_read_cb(GIOChannel *source, GIOCondition condition,
307 gpointer opaque)
309 struct vhost_user_read_cb_data *data = opaque;
310 struct vhost_dev *dev = data->dev;
311 VhostUserMsg *msg = data->msg;
312 struct vhost_user *u = dev->opaque;
313 CharBackend *chr = u->user->chr;
314 uint8_t *p = (uint8_t *) msg;
315 int r, size;
317 if (vhost_user_read_header(dev, msg) < 0) {
318 data->ret = -1;
319 goto end;
322 /* validate message size is sane */
323 if (msg->hdr.size > VHOST_USER_PAYLOAD_SIZE) {
324 error_report("Failed to read msg header."
325 " Size %d exceeds the maximum %zu.", msg->hdr.size,
326 VHOST_USER_PAYLOAD_SIZE);
327 data->ret = -1;
328 goto end;
331 if (msg->hdr.size) {
332 p += VHOST_USER_HDR_SIZE;
333 size = msg->hdr.size;
334 r = qemu_chr_fe_read_all(chr, p, size);
335 if (r != size) {
336 error_report("Failed to read msg payload."
337 " Read %d instead of %d.", r, msg->hdr.size);
338 data->ret = -1;
339 goto end;
343 end:
344 g_main_loop_quit(data->loop);
345 return G_SOURCE_REMOVE;
348 static gboolean slave_read(QIOChannel *ioc, GIOCondition condition,
349 gpointer opaque);
352 * This updates the read handler to use a new event loop context.
353 * Event sources are removed from the previous context : this ensures
354 * that events detected in the previous context are purged. They will
355 * be re-detected and processed in the new context.
357 static void slave_update_read_handler(struct vhost_dev *dev,
358 GMainContext *ctxt)
360 struct vhost_user *u = dev->opaque;
362 if (!u->slave_ioc) {
363 return;
366 if (u->slave_src) {
367 g_source_destroy(u->slave_src);
368 g_source_unref(u->slave_src);
371 u->slave_src = qio_channel_add_watch_source(u->slave_ioc,
372 G_IO_IN | G_IO_HUP,
373 slave_read, dev, NULL,
374 ctxt);
377 static int vhost_user_read(struct vhost_dev *dev, VhostUserMsg *msg)
379 struct vhost_user *u = dev->opaque;
380 CharBackend *chr = u->user->chr;
381 GMainContext *prev_ctxt = chr->chr->gcontext;
382 GMainContext *ctxt = g_main_context_new();
383 GMainLoop *loop = g_main_loop_new(ctxt, FALSE);
384 struct vhost_user_read_cb_data data = {
385 .dev = dev,
386 .loop = loop,
387 .msg = msg,
388 .ret = 0
392 * We want to be able to monitor the slave channel fd while waiting
393 * for chr I/O. This requires an event loop, but we can't nest the
394 * one to which chr is currently attached : its fd handlers might not
395 * be prepared for re-entrancy. So we create a new one and switch chr
396 * to use it.
398 slave_update_read_handler(dev, ctxt);
399 qemu_chr_be_update_read_handlers(chr->chr, ctxt);
400 qemu_chr_fe_add_watch(chr, G_IO_IN | G_IO_HUP, vhost_user_read_cb, &data);
402 g_main_loop_run(loop);
405 * Restore the previous event loop context. This also destroys/recreates
406 * event sources : this guarantees that all pending events in the original
407 * context that have been processed by the nested loop are purged.
409 qemu_chr_be_update_read_handlers(chr->chr, prev_ctxt);
410 slave_update_read_handler(dev, NULL);
412 g_main_loop_unref(loop);
413 g_main_context_unref(ctxt);
415 return data.ret;
418 static int process_message_reply(struct vhost_dev *dev,
419 const VhostUserMsg *msg)
421 VhostUserMsg msg_reply;
423 if ((msg->hdr.flags & VHOST_USER_NEED_REPLY_MASK) == 0) {
424 return 0;
427 if (vhost_user_read(dev, &msg_reply) < 0) {
428 return -1;
431 if (msg_reply.hdr.request != msg->hdr.request) {
432 error_report("Received unexpected msg type."
433 "Expected %d received %d",
434 msg->hdr.request, msg_reply.hdr.request);
435 return -1;
438 return msg_reply.payload.u64 ? -1 : 0;
441 static bool vhost_user_one_time_request(VhostUserRequest request)
443 switch (request) {
444 case VHOST_USER_SET_OWNER:
445 case VHOST_USER_RESET_OWNER:
446 case VHOST_USER_SET_MEM_TABLE:
447 case VHOST_USER_GET_QUEUE_NUM:
448 case VHOST_USER_NET_SET_MTU:
449 return true;
450 default:
451 return false;
455 /* most non-init callers ignore the error */
456 static int vhost_user_write(struct vhost_dev *dev, VhostUserMsg *msg,
457 int *fds, int fd_num)
459 struct vhost_user *u = dev->opaque;
460 CharBackend *chr = u->user->chr;
461 int ret, size = VHOST_USER_HDR_SIZE + msg->hdr.size;
464 * For non-vring specific requests, like VHOST_USER_SET_MEM_TABLE,
465 * we just need send it once in the first time. For later such
466 * request, we just ignore it.
468 if (vhost_user_one_time_request(msg->hdr.request) && dev->vq_index != 0) {
469 msg->hdr.flags &= ~VHOST_USER_NEED_REPLY_MASK;
470 return 0;
473 if (qemu_chr_fe_set_msgfds(chr, fds, fd_num) < 0) {
474 error_report("Failed to set msg fds.");
475 return -1;
478 ret = qemu_chr_fe_write_all(chr, (const uint8_t *) msg, size);
479 if (ret != size) {
480 error_report("Failed to write msg."
481 " Wrote %d instead of %d.", ret, size);
482 return -1;
485 return 0;
488 int vhost_user_gpu_set_socket(struct vhost_dev *dev, int fd)
490 VhostUserMsg msg = {
491 .hdr.request = VHOST_USER_GPU_SET_SOCKET,
492 .hdr.flags = VHOST_USER_VERSION,
495 return vhost_user_write(dev, &msg, &fd, 1);
498 static int vhost_user_set_log_base(struct vhost_dev *dev, uint64_t base,
499 struct vhost_log *log)
501 int fds[VHOST_USER_MAX_RAM_SLOTS];
502 size_t fd_num = 0;
503 bool shmfd = virtio_has_feature(dev->protocol_features,
504 VHOST_USER_PROTOCOL_F_LOG_SHMFD);
505 VhostUserMsg msg = {
506 .hdr.request = VHOST_USER_SET_LOG_BASE,
507 .hdr.flags = VHOST_USER_VERSION,
508 .payload.log.mmap_size = log->size * sizeof(*(log->log)),
509 .payload.log.mmap_offset = 0,
510 .hdr.size = sizeof(msg.payload.log),
513 if (shmfd && log->fd != -1) {
514 fds[fd_num++] = log->fd;
517 if (vhost_user_write(dev, &msg, fds, fd_num) < 0) {
518 return -1;
521 if (shmfd) {
522 msg.hdr.size = 0;
523 if (vhost_user_read(dev, &msg) < 0) {
524 return -1;
527 if (msg.hdr.request != VHOST_USER_SET_LOG_BASE) {
528 error_report("Received unexpected msg type. "
529 "Expected %d received %d",
530 VHOST_USER_SET_LOG_BASE, msg.hdr.request);
531 return -1;
535 return 0;
538 static MemoryRegion *vhost_user_get_mr_data(uint64_t addr, ram_addr_t *offset,
539 int *fd)
541 MemoryRegion *mr;
543 assert((uintptr_t)addr == addr);
544 mr = memory_region_from_host((void *)(uintptr_t)addr, offset);
545 *fd = memory_region_get_fd(mr);
547 return mr;
550 static void vhost_user_fill_msg_region(VhostUserMemoryRegion *dst,
551 struct vhost_memory_region *src,
552 uint64_t mmap_offset)
554 assert(src != NULL && dst != NULL);
555 dst->userspace_addr = src->userspace_addr;
556 dst->memory_size = src->memory_size;
557 dst->guest_phys_addr = src->guest_phys_addr;
558 dst->mmap_offset = mmap_offset;
561 static int vhost_user_fill_set_mem_table_msg(struct vhost_user *u,
562 struct vhost_dev *dev,
563 VhostUserMsg *msg,
564 int *fds, size_t *fd_num,
565 bool track_ramblocks)
567 int i, fd;
568 ram_addr_t offset;
569 MemoryRegion *mr;
570 struct vhost_memory_region *reg;
571 VhostUserMemoryRegion region_buffer;
573 msg->hdr.request = VHOST_USER_SET_MEM_TABLE;
575 for (i = 0; i < dev->mem->nregions; ++i) {
576 reg = dev->mem->regions + i;
578 mr = vhost_user_get_mr_data(reg->userspace_addr, &offset, &fd);
579 if (fd > 0) {
580 if (track_ramblocks) {
581 assert(*fd_num < VHOST_MEMORY_BASELINE_NREGIONS);
582 trace_vhost_user_set_mem_table_withfd(*fd_num, mr->name,
583 reg->memory_size,
584 reg->guest_phys_addr,
585 reg->userspace_addr,
586 offset);
587 u->region_rb_offset[i] = offset;
588 u->region_rb[i] = mr->ram_block;
589 } else if (*fd_num == VHOST_MEMORY_BASELINE_NREGIONS) {
590 error_report("Failed preparing vhost-user memory table msg");
591 return -1;
593 vhost_user_fill_msg_region(&region_buffer, reg, offset);
594 msg->payload.memory.regions[*fd_num] = region_buffer;
595 fds[(*fd_num)++] = fd;
596 } else if (track_ramblocks) {
597 u->region_rb_offset[i] = 0;
598 u->region_rb[i] = NULL;
602 msg->payload.memory.nregions = *fd_num;
604 if (!*fd_num) {
605 error_report("Failed initializing vhost-user memory map, "
606 "consider using -object memory-backend-file share=on");
607 return -1;
610 msg->hdr.size = sizeof(msg->payload.memory.nregions);
611 msg->hdr.size += sizeof(msg->payload.memory.padding);
612 msg->hdr.size += *fd_num * sizeof(VhostUserMemoryRegion);
614 return 1;
617 static inline bool reg_equal(struct vhost_memory_region *shadow_reg,
618 struct vhost_memory_region *vdev_reg)
620 return shadow_reg->guest_phys_addr == vdev_reg->guest_phys_addr &&
621 shadow_reg->userspace_addr == vdev_reg->userspace_addr &&
622 shadow_reg->memory_size == vdev_reg->memory_size;
625 static void scrub_shadow_regions(struct vhost_dev *dev,
626 struct scrub_regions *add_reg,
627 int *nr_add_reg,
628 struct scrub_regions *rem_reg,
629 int *nr_rem_reg, uint64_t *shadow_pcb,
630 bool track_ramblocks)
632 struct vhost_user *u = dev->opaque;
633 bool found[VHOST_USER_MAX_RAM_SLOTS] = {};
634 struct vhost_memory_region *reg, *shadow_reg;
635 int i, j, fd, add_idx = 0, rm_idx = 0, fd_num = 0;
636 ram_addr_t offset;
637 MemoryRegion *mr;
638 bool matching;
641 * Find memory regions present in our shadow state which are not in
642 * the device's current memory state.
644 * Mark regions in both the shadow and device state as "found".
646 for (i = 0; i < u->num_shadow_regions; i++) {
647 shadow_reg = &u->shadow_regions[i];
648 matching = false;
650 for (j = 0; j < dev->mem->nregions; j++) {
651 reg = &dev->mem->regions[j];
653 mr = vhost_user_get_mr_data(reg->userspace_addr, &offset, &fd);
655 if (reg_equal(shadow_reg, reg)) {
656 matching = true;
657 found[j] = true;
658 if (track_ramblocks) {
660 * Reset postcopy client bases, region_rb, and
661 * region_rb_offset in case regions are removed.
663 if (fd > 0) {
664 u->region_rb_offset[j] = offset;
665 u->region_rb[j] = mr->ram_block;
666 shadow_pcb[j] = u->postcopy_client_bases[i];
667 } else {
668 u->region_rb_offset[j] = 0;
669 u->region_rb[j] = NULL;
672 break;
677 * If the region was not found in the current device memory state
678 * create an entry for it in the removed list.
680 if (!matching) {
681 rem_reg[rm_idx].region = shadow_reg;
682 rem_reg[rm_idx++].reg_idx = i;
687 * For regions not marked "found", create entries in the added list.
689 * Note their indexes in the device memory state and the indexes of their
690 * file descriptors.
692 for (i = 0; i < dev->mem->nregions; i++) {
693 reg = &dev->mem->regions[i];
694 vhost_user_get_mr_data(reg->userspace_addr, &offset, &fd);
695 if (fd > 0) {
696 ++fd_num;
700 * If the region was in both the shadow and device state we don't
701 * need to send a VHOST_USER_ADD_MEM_REG message for it.
703 if (found[i]) {
704 continue;
707 add_reg[add_idx].region = reg;
708 add_reg[add_idx].reg_idx = i;
709 add_reg[add_idx++].fd_idx = fd_num;
711 *nr_rem_reg = rm_idx;
712 *nr_add_reg = add_idx;
714 return;
717 static int send_remove_regions(struct vhost_dev *dev,
718 struct scrub_regions *remove_reg,
719 int nr_rem_reg, VhostUserMsg *msg,
720 bool reply_supported)
722 struct vhost_user *u = dev->opaque;
723 struct vhost_memory_region *shadow_reg;
724 int i, fd, shadow_reg_idx, ret;
725 ram_addr_t offset;
726 VhostUserMemoryRegion region_buffer;
729 * The regions in remove_reg appear in the same order they do in the
730 * shadow table. Therefore we can minimize memory copies by iterating
731 * through remove_reg backwards.
733 for (i = nr_rem_reg - 1; i >= 0; i--) {
734 shadow_reg = remove_reg[i].region;
735 shadow_reg_idx = remove_reg[i].reg_idx;
737 vhost_user_get_mr_data(shadow_reg->userspace_addr, &offset, &fd);
739 if (fd > 0) {
740 msg->hdr.request = VHOST_USER_REM_MEM_REG;
741 vhost_user_fill_msg_region(&region_buffer, shadow_reg, 0);
742 msg->payload.mem_reg.region = region_buffer;
744 if (vhost_user_write(dev, msg, &fd, 1) < 0) {
745 return -1;
748 if (reply_supported) {
749 ret = process_message_reply(dev, msg);
750 if (ret) {
751 return ret;
757 * At this point we know the backend has unmapped the region. It is now
758 * safe to remove it from the shadow table.
760 memmove(&u->shadow_regions[shadow_reg_idx],
761 &u->shadow_regions[shadow_reg_idx + 1],
762 sizeof(struct vhost_memory_region) *
763 (u->num_shadow_regions - shadow_reg_idx - 1));
764 u->num_shadow_regions--;
767 return 0;
770 static int send_add_regions(struct vhost_dev *dev,
771 struct scrub_regions *add_reg, int nr_add_reg,
772 VhostUserMsg *msg, uint64_t *shadow_pcb,
773 bool reply_supported, bool track_ramblocks)
775 struct vhost_user *u = dev->opaque;
776 int i, fd, ret, reg_idx, reg_fd_idx;
777 struct vhost_memory_region *reg;
778 MemoryRegion *mr;
779 ram_addr_t offset;
780 VhostUserMsg msg_reply;
781 VhostUserMemoryRegion region_buffer;
783 for (i = 0; i < nr_add_reg; i++) {
784 reg = add_reg[i].region;
785 reg_idx = add_reg[i].reg_idx;
786 reg_fd_idx = add_reg[i].fd_idx;
788 mr = vhost_user_get_mr_data(reg->userspace_addr, &offset, &fd);
790 if (fd > 0) {
791 if (track_ramblocks) {
792 trace_vhost_user_set_mem_table_withfd(reg_fd_idx, mr->name,
793 reg->memory_size,
794 reg->guest_phys_addr,
795 reg->userspace_addr,
796 offset);
797 u->region_rb_offset[reg_idx] = offset;
798 u->region_rb[reg_idx] = mr->ram_block;
800 msg->hdr.request = VHOST_USER_ADD_MEM_REG;
801 vhost_user_fill_msg_region(&region_buffer, reg, offset);
802 msg->payload.mem_reg.region = region_buffer;
804 if (vhost_user_write(dev, msg, &fd, 1) < 0) {
805 return -1;
808 if (track_ramblocks) {
809 uint64_t reply_gpa;
811 if (vhost_user_read(dev, &msg_reply) < 0) {
812 return -1;
815 reply_gpa = msg_reply.payload.mem_reg.region.guest_phys_addr;
817 if (msg_reply.hdr.request != VHOST_USER_ADD_MEM_REG) {
818 error_report("%s: Received unexpected msg type."
819 "Expected %d received %d", __func__,
820 VHOST_USER_ADD_MEM_REG,
821 msg_reply.hdr.request);
822 return -1;
826 * We're using the same structure, just reusing one of the
827 * fields, so it should be the same size.
829 if (msg_reply.hdr.size != msg->hdr.size) {
830 error_report("%s: Unexpected size for postcopy reply "
831 "%d vs %d", __func__, msg_reply.hdr.size,
832 msg->hdr.size);
833 return -1;
836 /* Get the postcopy client base from the backend's reply. */
837 if (reply_gpa == dev->mem->regions[reg_idx].guest_phys_addr) {
838 shadow_pcb[reg_idx] =
839 msg_reply.payload.mem_reg.region.userspace_addr;
840 trace_vhost_user_set_mem_table_postcopy(
841 msg_reply.payload.mem_reg.region.userspace_addr,
842 msg->payload.mem_reg.region.userspace_addr,
843 reg_fd_idx, reg_idx);
844 } else {
845 error_report("%s: invalid postcopy reply for region. "
846 "Got guest physical address %" PRIX64 ", expected "
847 "%" PRIX64, __func__, reply_gpa,
848 dev->mem->regions[reg_idx].guest_phys_addr);
849 return -1;
851 } else if (reply_supported) {
852 ret = process_message_reply(dev, msg);
853 if (ret) {
854 return ret;
857 } else if (track_ramblocks) {
858 u->region_rb_offset[reg_idx] = 0;
859 u->region_rb[reg_idx] = NULL;
863 * At this point, we know the backend has mapped in the new
864 * region, if the region has a valid file descriptor.
866 * The region should now be added to the shadow table.
868 u->shadow_regions[u->num_shadow_regions].guest_phys_addr =
869 reg->guest_phys_addr;
870 u->shadow_regions[u->num_shadow_regions].userspace_addr =
871 reg->userspace_addr;
872 u->shadow_regions[u->num_shadow_regions].memory_size =
873 reg->memory_size;
874 u->num_shadow_regions++;
877 return 0;
880 static int vhost_user_add_remove_regions(struct vhost_dev *dev,
881 VhostUserMsg *msg,
882 bool reply_supported,
883 bool track_ramblocks)
885 struct vhost_user *u = dev->opaque;
886 struct scrub_regions add_reg[VHOST_USER_MAX_RAM_SLOTS];
887 struct scrub_regions rem_reg[VHOST_USER_MAX_RAM_SLOTS];
888 uint64_t shadow_pcb[VHOST_USER_MAX_RAM_SLOTS] = {};
889 int nr_add_reg, nr_rem_reg;
891 msg->hdr.size = sizeof(msg->payload.mem_reg);
893 /* Find the regions which need to be removed or added. */
894 scrub_shadow_regions(dev, add_reg, &nr_add_reg, rem_reg, &nr_rem_reg,
895 shadow_pcb, track_ramblocks);
897 if (nr_rem_reg && send_remove_regions(dev, rem_reg, nr_rem_reg, msg,
898 reply_supported) < 0)
900 goto err;
903 if (nr_add_reg && send_add_regions(dev, add_reg, nr_add_reg, msg,
904 shadow_pcb, reply_supported, track_ramblocks) < 0)
906 goto err;
909 if (track_ramblocks) {
910 memcpy(u->postcopy_client_bases, shadow_pcb,
911 sizeof(uint64_t) * VHOST_USER_MAX_RAM_SLOTS);
913 * Now we've registered this with the postcopy code, we ack to the
914 * client, because now we're in the position to be able to deal with
915 * any faults it generates.
917 /* TODO: Use this for failure cases as well with a bad value. */
918 msg->hdr.size = sizeof(msg->payload.u64);
919 msg->payload.u64 = 0; /* OK */
921 if (vhost_user_write(dev, msg, NULL, 0) < 0) {
922 return -1;
926 return 0;
928 err:
929 if (track_ramblocks) {
930 memcpy(u->postcopy_client_bases, shadow_pcb,
931 sizeof(uint64_t) * VHOST_USER_MAX_RAM_SLOTS);
934 return -1;
937 static int vhost_user_set_mem_table_postcopy(struct vhost_dev *dev,
938 struct vhost_memory *mem,
939 bool reply_supported,
940 bool config_mem_slots)
942 struct vhost_user *u = dev->opaque;
943 int fds[VHOST_MEMORY_BASELINE_NREGIONS];
944 size_t fd_num = 0;
945 VhostUserMsg msg_reply;
946 int region_i, msg_i;
948 VhostUserMsg msg = {
949 .hdr.flags = VHOST_USER_VERSION,
952 if (u->region_rb_len < dev->mem->nregions) {
953 u->region_rb = g_renew(RAMBlock*, u->region_rb, dev->mem->nregions);
954 u->region_rb_offset = g_renew(ram_addr_t, u->region_rb_offset,
955 dev->mem->nregions);
956 memset(&(u->region_rb[u->region_rb_len]), '\0',
957 sizeof(RAMBlock *) * (dev->mem->nregions - u->region_rb_len));
958 memset(&(u->region_rb_offset[u->region_rb_len]), '\0',
959 sizeof(ram_addr_t) * (dev->mem->nregions - u->region_rb_len));
960 u->region_rb_len = dev->mem->nregions;
963 if (config_mem_slots) {
964 if (vhost_user_add_remove_regions(dev, &msg, reply_supported,
965 true) < 0) {
966 return -1;
968 } else {
969 if (vhost_user_fill_set_mem_table_msg(u, dev, &msg, fds, &fd_num,
970 true) < 0) {
971 return -1;
974 if (vhost_user_write(dev, &msg, fds, fd_num) < 0) {
975 return -1;
978 if (vhost_user_read(dev, &msg_reply) < 0) {
979 return -1;
982 if (msg_reply.hdr.request != VHOST_USER_SET_MEM_TABLE) {
983 error_report("%s: Received unexpected msg type."
984 "Expected %d received %d", __func__,
985 VHOST_USER_SET_MEM_TABLE, msg_reply.hdr.request);
986 return -1;
990 * We're using the same structure, just reusing one of the
991 * fields, so it should be the same size.
993 if (msg_reply.hdr.size != msg.hdr.size) {
994 error_report("%s: Unexpected size for postcopy reply "
995 "%d vs %d", __func__, msg_reply.hdr.size,
996 msg.hdr.size);
997 return -1;
1000 memset(u->postcopy_client_bases, 0,
1001 sizeof(uint64_t) * VHOST_USER_MAX_RAM_SLOTS);
1004 * They're in the same order as the regions that were sent
1005 * but some of the regions were skipped (above) if they
1006 * didn't have fd's
1008 for (msg_i = 0, region_i = 0;
1009 region_i < dev->mem->nregions;
1010 region_i++) {
1011 if (msg_i < fd_num &&
1012 msg_reply.payload.memory.regions[msg_i].guest_phys_addr ==
1013 dev->mem->regions[region_i].guest_phys_addr) {
1014 u->postcopy_client_bases[region_i] =
1015 msg_reply.payload.memory.regions[msg_i].userspace_addr;
1016 trace_vhost_user_set_mem_table_postcopy(
1017 msg_reply.payload.memory.regions[msg_i].userspace_addr,
1018 msg.payload.memory.regions[msg_i].userspace_addr,
1019 msg_i, region_i);
1020 msg_i++;
1023 if (msg_i != fd_num) {
1024 error_report("%s: postcopy reply not fully consumed "
1025 "%d vs %zd",
1026 __func__, msg_i, fd_num);
1027 return -1;
1031 * Now we've registered this with the postcopy code, we ack to the
1032 * client, because now we're in the position to be able to deal
1033 * with any faults it generates.
1035 /* TODO: Use this for failure cases as well with a bad value. */
1036 msg.hdr.size = sizeof(msg.payload.u64);
1037 msg.payload.u64 = 0; /* OK */
1038 if (vhost_user_write(dev, &msg, NULL, 0) < 0) {
1039 return -1;
1043 return 0;
1046 static int vhost_user_set_mem_table(struct vhost_dev *dev,
1047 struct vhost_memory *mem)
1049 struct vhost_user *u = dev->opaque;
1050 int fds[VHOST_MEMORY_BASELINE_NREGIONS];
1051 size_t fd_num = 0;
1052 bool do_postcopy = u->postcopy_listen && u->postcopy_fd.handler;
1053 bool reply_supported = virtio_has_feature(dev->protocol_features,
1054 VHOST_USER_PROTOCOL_F_REPLY_ACK);
1055 bool config_mem_slots =
1056 virtio_has_feature(dev->protocol_features,
1057 VHOST_USER_PROTOCOL_F_CONFIGURE_MEM_SLOTS);
1059 if (do_postcopy) {
1061 * Postcopy has enough differences that it's best done in it's own
1062 * version
1064 return vhost_user_set_mem_table_postcopy(dev, mem, reply_supported,
1065 config_mem_slots);
1068 VhostUserMsg msg = {
1069 .hdr.flags = VHOST_USER_VERSION,
1072 if (reply_supported) {
1073 msg.hdr.flags |= VHOST_USER_NEED_REPLY_MASK;
1076 if (config_mem_slots) {
1077 if (vhost_user_add_remove_regions(dev, &msg, reply_supported,
1078 false) < 0) {
1079 return -1;
1081 } else {
1082 if (vhost_user_fill_set_mem_table_msg(u, dev, &msg, fds, &fd_num,
1083 false) < 0) {
1084 return -1;
1086 if (vhost_user_write(dev, &msg, fds, fd_num) < 0) {
1087 return -1;
1090 if (reply_supported) {
1091 return process_message_reply(dev, &msg);
1095 return 0;
1098 static int vhost_user_set_vring_addr(struct vhost_dev *dev,
1099 struct vhost_vring_addr *addr)
1101 VhostUserMsg msg = {
1102 .hdr.request = VHOST_USER_SET_VRING_ADDR,
1103 .hdr.flags = VHOST_USER_VERSION,
1104 .payload.addr = *addr,
1105 .hdr.size = sizeof(msg.payload.addr),
1108 if (vhost_user_write(dev, &msg, NULL, 0) < 0) {
1109 return -1;
1112 return 0;
1115 static int vhost_user_set_vring_endian(struct vhost_dev *dev,
1116 struct vhost_vring_state *ring)
1118 bool cross_endian = virtio_has_feature(dev->protocol_features,
1119 VHOST_USER_PROTOCOL_F_CROSS_ENDIAN);
1120 VhostUserMsg msg = {
1121 .hdr.request = VHOST_USER_SET_VRING_ENDIAN,
1122 .hdr.flags = VHOST_USER_VERSION,
1123 .payload.state = *ring,
1124 .hdr.size = sizeof(msg.payload.state),
1127 if (!cross_endian) {
1128 error_report("vhost-user trying to send unhandled ioctl");
1129 return -1;
1132 if (vhost_user_write(dev, &msg, NULL, 0) < 0) {
1133 return -1;
1136 return 0;
1139 static int vhost_set_vring(struct vhost_dev *dev,
1140 unsigned long int request,
1141 struct vhost_vring_state *ring)
1143 VhostUserMsg msg = {
1144 .hdr.request = request,
1145 .hdr.flags = VHOST_USER_VERSION,
1146 .payload.state = *ring,
1147 .hdr.size = sizeof(msg.payload.state),
1150 if (vhost_user_write(dev, &msg, NULL, 0) < 0) {
1151 return -1;
1154 return 0;
1157 static int vhost_user_set_vring_num(struct vhost_dev *dev,
1158 struct vhost_vring_state *ring)
1160 return vhost_set_vring(dev, VHOST_USER_SET_VRING_NUM, ring);
1163 static void vhost_user_host_notifier_restore(struct vhost_dev *dev,
1164 int queue_idx)
1166 struct vhost_user *u = dev->opaque;
1167 VhostUserHostNotifier *n = &u->user->notifier[queue_idx];
1168 VirtIODevice *vdev = dev->vdev;
1170 if (n->addr && !n->set) {
1171 virtio_queue_set_host_notifier_mr(vdev, queue_idx, &n->mr, true);
1172 n->set = true;
1176 static void vhost_user_host_notifier_remove(struct vhost_dev *dev,
1177 int queue_idx)
1179 struct vhost_user *u = dev->opaque;
1180 VhostUserHostNotifier *n = &u->user->notifier[queue_idx];
1181 VirtIODevice *vdev = dev->vdev;
1183 if (n->addr && n->set) {
1184 virtio_queue_set_host_notifier_mr(vdev, queue_idx, &n->mr, false);
1185 n->set = false;
1189 static int vhost_user_set_vring_base(struct vhost_dev *dev,
1190 struct vhost_vring_state *ring)
1192 vhost_user_host_notifier_restore(dev, ring->index);
1194 return vhost_set_vring(dev, VHOST_USER_SET_VRING_BASE, ring);
1197 static int vhost_user_set_vring_enable(struct vhost_dev *dev, int enable)
1199 int i;
1201 if (!virtio_has_feature(dev->features, VHOST_USER_F_PROTOCOL_FEATURES)) {
1202 return -1;
1205 for (i = 0; i < dev->nvqs; ++i) {
1206 struct vhost_vring_state state = {
1207 .index = dev->vq_index + i,
1208 .num = enable,
1211 vhost_set_vring(dev, VHOST_USER_SET_VRING_ENABLE, &state);
1214 return 0;
1217 static int vhost_user_get_vring_base(struct vhost_dev *dev,
1218 struct vhost_vring_state *ring)
1220 VhostUserMsg msg = {
1221 .hdr.request = VHOST_USER_GET_VRING_BASE,
1222 .hdr.flags = VHOST_USER_VERSION,
1223 .payload.state = *ring,
1224 .hdr.size = sizeof(msg.payload.state),
1227 vhost_user_host_notifier_remove(dev, ring->index);
1229 if (vhost_user_write(dev, &msg, NULL, 0) < 0) {
1230 return -1;
1233 if (vhost_user_read(dev, &msg) < 0) {
1234 return -1;
1237 if (msg.hdr.request != VHOST_USER_GET_VRING_BASE) {
1238 error_report("Received unexpected msg type. Expected %d received %d",
1239 VHOST_USER_GET_VRING_BASE, msg.hdr.request);
1240 return -1;
1243 if (msg.hdr.size != sizeof(msg.payload.state)) {
1244 error_report("Received bad msg size.");
1245 return -1;
1248 *ring = msg.payload.state;
1250 return 0;
1253 static int vhost_set_vring_file(struct vhost_dev *dev,
1254 VhostUserRequest request,
1255 struct vhost_vring_file *file)
1257 int fds[VHOST_USER_MAX_RAM_SLOTS];
1258 size_t fd_num = 0;
1259 VhostUserMsg msg = {
1260 .hdr.request = request,
1261 .hdr.flags = VHOST_USER_VERSION,
1262 .payload.u64 = file->index & VHOST_USER_VRING_IDX_MASK,
1263 .hdr.size = sizeof(msg.payload.u64),
1266 if (ioeventfd_enabled() && file->fd > 0) {
1267 fds[fd_num++] = file->fd;
1268 } else {
1269 msg.payload.u64 |= VHOST_USER_VRING_NOFD_MASK;
1272 if (vhost_user_write(dev, &msg, fds, fd_num) < 0) {
1273 return -1;
1276 return 0;
1279 static int vhost_user_set_vring_kick(struct vhost_dev *dev,
1280 struct vhost_vring_file *file)
1282 return vhost_set_vring_file(dev, VHOST_USER_SET_VRING_KICK, file);
1285 static int vhost_user_set_vring_call(struct vhost_dev *dev,
1286 struct vhost_vring_file *file)
1288 return vhost_set_vring_file(dev, VHOST_USER_SET_VRING_CALL, file);
1291 static int vhost_user_set_u64(struct vhost_dev *dev, int request, uint64_t u64)
1293 VhostUserMsg msg = {
1294 .hdr.request = request,
1295 .hdr.flags = VHOST_USER_VERSION,
1296 .payload.u64 = u64,
1297 .hdr.size = sizeof(msg.payload.u64),
1300 if (vhost_user_write(dev, &msg, NULL, 0) < 0) {
1301 return -1;
1304 return 0;
1307 static int vhost_user_set_features(struct vhost_dev *dev,
1308 uint64_t features)
1310 return vhost_user_set_u64(dev, VHOST_USER_SET_FEATURES, features);
1313 static int vhost_user_set_protocol_features(struct vhost_dev *dev,
1314 uint64_t features)
1316 return vhost_user_set_u64(dev, VHOST_USER_SET_PROTOCOL_FEATURES, features);
1319 static int vhost_user_get_u64(struct vhost_dev *dev, int request, uint64_t *u64)
1321 VhostUserMsg msg = {
1322 .hdr.request = request,
1323 .hdr.flags = VHOST_USER_VERSION,
1326 if (vhost_user_one_time_request(request) && dev->vq_index != 0) {
1327 return 0;
1330 if (vhost_user_write(dev, &msg, NULL, 0) < 0) {
1331 return -1;
1334 if (vhost_user_read(dev, &msg) < 0) {
1335 return -1;
1338 if (msg.hdr.request != request) {
1339 error_report("Received unexpected msg type. Expected %d received %d",
1340 request, msg.hdr.request);
1341 return -1;
1344 if (msg.hdr.size != sizeof(msg.payload.u64)) {
1345 error_report("Received bad msg size.");
1346 return -1;
1349 *u64 = msg.payload.u64;
1351 return 0;
1354 static int vhost_user_get_features(struct vhost_dev *dev, uint64_t *features)
1356 return vhost_user_get_u64(dev, VHOST_USER_GET_FEATURES, features);
1359 static int vhost_user_set_owner(struct vhost_dev *dev)
1361 VhostUserMsg msg = {
1362 .hdr.request = VHOST_USER_SET_OWNER,
1363 .hdr.flags = VHOST_USER_VERSION,
1366 if (vhost_user_write(dev, &msg, NULL, 0) < 0) {
1367 return -1;
1370 return 0;
1373 static int vhost_user_get_max_memslots(struct vhost_dev *dev,
1374 uint64_t *max_memslots)
1376 uint64_t backend_max_memslots;
1377 int err;
1379 err = vhost_user_get_u64(dev, VHOST_USER_GET_MAX_MEM_SLOTS,
1380 &backend_max_memslots);
1381 if (err < 0) {
1382 return err;
1385 *max_memslots = backend_max_memslots;
1387 return 0;
1390 static int vhost_user_reset_device(struct vhost_dev *dev)
1392 VhostUserMsg msg = {
1393 .hdr.flags = VHOST_USER_VERSION,
1396 msg.hdr.request = virtio_has_feature(dev->protocol_features,
1397 VHOST_USER_PROTOCOL_F_RESET_DEVICE)
1398 ? VHOST_USER_RESET_DEVICE
1399 : VHOST_USER_RESET_OWNER;
1401 if (vhost_user_write(dev, &msg, NULL, 0) < 0) {
1402 return -1;
1405 return 0;
1408 static int vhost_user_slave_handle_config_change(struct vhost_dev *dev)
1410 int ret = -1;
1412 if (!dev->config_ops) {
1413 return -1;
1416 if (dev->config_ops->vhost_dev_config_notifier) {
1417 ret = dev->config_ops->vhost_dev_config_notifier(dev);
1420 return ret;
1423 static int vhost_user_slave_handle_vring_host_notifier(struct vhost_dev *dev,
1424 VhostUserVringArea *area,
1425 int fd)
1427 int queue_idx = area->u64 & VHOST_USER_VRING_IDX_MASK;
1428 size_t page_size = qemu_real_host_page_size;
1429 struct vhost_user *u = dev->opaque;
1430 VhostUserState *user = u->user;
1431 VirtIODevice *vdev = dev->vdev;
1432 VhostUserHostNotifier *n;
1433 void *addr;
1434 char *name;
1436 if (!virtio_has_feature(dev->protocol_features,
1437 VHOST_USER_PROTOCOL_F_HOST_NOTIFIER) ||
1438 vdev == NULL || queue_idx >= virtio_get_num_queues(vdev)) {
1439 return -1;
1442 n = &user->notifier[queue_idx];
1444 if (n->addr) {
1445 virtio_queue_set_host_notifier_mr(vdev, queue_idx, &n->mr, false);
1446 object_unparent(OBJECT(&n->mr));
1447 munmap(n->addr, page_size);
1448 n->addr = NULL;
1451 if (area->u64 & VHOST_USER_VRING_NOFD_MASK) {
1452 return 0;
1455 /* Sanity check. */
1456 if (area->size != page_size) {
1457 return -1;
1460 addr = mmap(NULL, page_size, PROT_READ | PROT_WRITE, MAP_SHARED,
1461 fd, area->offset);
1462 if (addr == MAP_FAILED) {
1463 return -1;
1466 name = g_strdup_printf("vhost-user/host-notifier@%p mmaps[%d]",
1467 user, queue_idx);
1468 memory_region_init_ram_device_ptr(&n->mr, OBJECT(vdev), name,
1469 page_size, addr);
1470 g_free(name);
1472 if (virtio_queue_set_host_notifier_mr(vdev, queue_idx, &n->mr, true)) {
1473 munmap(addr, page_size);
1474 return -1;
1477 n->addr = addr;
1478 n->set = true;
1480 return 0;
1483 static void close_slave_channel(struct vhost_user *u)
1485 g_source_destroy(u->slave_src);
1486 g_source_unref(u->slave_src);
1487 u->slave_src = NULL;
1488 object_unref(OBJECT(u->slave_ioc));
1489 u->slave_ioc = NULL;
1492 static gboolean slave_read(QIOChannel *ioc, GIOCondition condition,
1493 gpointer opaque)
1495 struct vhost_dev *dev = opaque;
1496 struct vhost_user *u = dev->opaque;
1497 VhostUserHeader hdr = { 0, };
1498 VhostUserPayload payload = { 0, };
1499 Error *local_err = NULL;
1500 gboolean rc = G_SOURCE_CONTINUE;
1501 int ret = 0;
1502 struct iovec iov;
1503 g_autofree int *fd = NULL;
1504 size_t fdsize = 0;
1505 int i;
1507 /* Read header */
1508 iov.iov_base = &hdr;
1509 iov.iov_len = VHOST_USER_HDR_SIZE;
1511 if (qio_channel_readv_full_all(ioc, &iov, 1, &fd, &fdsize, &local_err)) {
1512 error_report_err(local_err);
1513 goto err;
1516 if (hdr.size > VHOST_USER_PAYLOAD_SIZE) {
1517 error_report("Failed to read msg header."
1518 " Size %d exceeds the maximum %zu.", hdr.size,
1519 VHOST_USER_PAYLOAD_SIZE);
1520 goto err;
1523 /* Read payload */
1524 if (qio_channel_read_all(ioc, (char *) &payload, hdr.size, &local_err)) {
1525 error_report_err(local_err);
1526 goto err;
1529 switch (hdr.request) {
1530 case VHOST_USER_SLAVE_IOTLB_MSG:
1531 ret = vhost_backend_handle_iotlb_msg(dev, &payload.iotlb);
1532 break;
1533 case VHOST_USER_SLAVE_CONFIG_CHANGE_MSG :
1534 ret = vhost_user_slave_handle_config_change(dev);
1535 break;
1536 case VHOST_USER_SLAVE_VRING_HOST_NOTIFIER_MSG:
1537 ret = vhost_user_slave_handle_vring_host_notifier(dev, &payload.area,
1538 fd ? fd[0] : -1);
1539 break;
1540 default:
1541 error_report("Received unexpected msg type: %d.", hdr.request);
1542 ret = -EINVAL;
1546 * REPLY_ACK feature handling. Other reply types has to be managed
1547 * directly in their request handlers.
1549 if (hdr.flags & VHOST_USER_NEED_REPLY_MASK) {
1550 struct iovec iovec[2];
1553 hdr.flags &= ~VHOST_USER_NEED_REPLY_MASK;
1554 hdr.flags |= VHOST_USER_REPLY_MASK;
1556 payload.u64 = !!ret;
1557 hdr.size = sizeof(payload.u64);
1559 iovec[0].iov_base = &hdr;
1560 iovec[0].iov_len = VHOST_USER_HDR_SIZE;
1561 iovec[1].iov_base = &payload;
1562 iovec[1].iov_len = hdr.size;
1564 if (qio_channel_writev_all(ioc, iovec, ARRAY_SIZE(iovec), &local_err)) {
1565 error_report_err(local_err);
1566 goto err;
1570 goto fdcleanup;
1572 err:
1573 close_slave_channel(u);
1574 rc = G_SOURCE_REMOVE;
1576 fdcleanup:
1577 if (fd) {
1578 for (i = 0; i < fdsize; i++) {
1579 close(fd[i]);
1582 return rc;
1585 static int vhost_setup_slave_channel(struct vhost_dev *dev)
1587 VhostUserMsg msg = {
1588 .hdr.request = VHOST_USER_SET_SLAVE_REQ_FD,
1589 .hdr.flags = VHOST_USER_VERSION,
1591 struct vhost_user *u = dev->opaque;
1592 int sv[2], ret = 0;
1593 bool reply_supported = virtio_has_feature(dev->protocol_features,
1594 VHOST_USER_PROTOCOL_F_REPLY_ACK);
1595 Error *local_err = NULL;
1596 QIOChannel *ioc;
1598 if (!virtio_has_feature(dev->protocol_features,
1599 VHOST_USER_PROTOCOL_F_SLAVE_REQ)) {
1600 return 0;
1603 if (socketpair(PF_UNIX, SOCK_STREAM, 0, sv) == -1) {
1604 error_report("socketpair() failed");
1605 return -1;
1608 ioc = QIO_CHANNEL(qio_channel_socket_new_fd(sv[0], &local_err));
1609 if (!ioc) {
1610 error_report_err(local_err);
1611 return -1;
1613 u->slave_ioc = ioc;
1614 slave_update_read_handler(dev, NULL);
1616 if (reply_supported) {
1617 msg.hdr.flags |= VHOST_USER_NEED_REPLY_MASK;
1620 ret = vhost_user_write(dev, &msg, &sv[1], 1);
1621 if (ret) {
1622 goto out;
1625 if (reply_supported) {
1626 ret = process_message_reply(dev, &msg);
1629 out:
1630 close(sv[1]);
1631 if (ret) {
1632 close_slave_channel(u);
1635 return ret;
1638 #ifdef CONFIG_LINUX
1640 * Called back from the postcopy fault thread when a fault is received on our
1641 * ufd.
1642 * TODO: This is Linux specific
1644 static int vhost_user_postcopy_fault_handler(struct PostCopyFD *pcfd,
1645 void *ufd)
1647 struct vhost_dev *dev = pcfd->data;
1648 struct vhost_user *u = dev->opaque;
1649 struct uffd_msg *msg = ufd;
1650 uint64_t faultaddr = msg->arg.pagefault.address;
1651 RAMBlock *rb = NULL;
1652 uint64_t rb_offset;
1653 int i;
1655 trace_vhost_user_postcopy_fault_handler(pcfd->idstr, faultaddr,
1656 dev->mem->nregions);
1657 for (i = 0; i < MIN(dev->mem->nregions, u->region_rb_len); i++) {
1658 trace_vhost_user_postcopy_fault_handler_loop(i,
1659 u->postcopy_client_bases[i], dev->mem->regions[i].memory_size);
1660 if (faultaddr >= u->postcopy_client_bases[i]) {
1661 /* Ofset of the fault address in the vhost region */
1662 uint64_t region_offset = faultaddr - u->postcopy_client_bases[i];
1663 if (region_offset < dev->mem->regions[i].memory_size) {
1664 rb_offset = region_offset + u->region_rb_offset[i];
1665 trace_vhost_user_postcopy_fault_handler_found(i,
1666 region_offset, rb_offset);
1667 rb = u->region_rb[i];
1668 return postcopy_request_shared_page(pcfd, rb, faultaddr,
1669 rb_offset);
1673 error_report("%s: Failed to find region for fault %" PRIx64,
1674 __func__, faultaddr);
1675 return -1;
1678 static int vhost_user_postcopy_waker(struct PostCopyFD *pcfd, RAMBlock *rb,
1679 uint64_t offset)
1681 struct vhost_dev *dev = pcfd->data;
1682 struct vhost_user *u = dev->opaque;
1683 int i;
1685 trace_vhost_user_postcopy_waker(qemu_ram_get_idstr(rb), offset);
1687 if (!u) {
1688 return 0;
1690 /* Translate the offset into an address in the clients address space */
1691 for (i = 0; i < MIN(dev->mem->nregions, u->region_rb_len); i++) {
1692 if (u->region_rb[i] == rb &&
1693 offset >= u->region_rb_offset[i] &&
1694 offset < (u->region_rb_offset[i] +
1695 dev->mem->regions[i].memory_size)) {
1696 uint64_t client_addr = (offset - u->region_rb_offset[i]) +
1697 u->postcopy_client_bases[i];
1698 trace_vhost_user_postcopy_waker_found(client_addr);
1699 return postcopy_wake_shared(pcfd, client_addr, rb);
1703 trace_vhost_user_postcopy_waker_nomatch(qemu_ram_get_idstr(rb), offset);
1704 return 0;
1706 #endif
1709 * Called at the start of an inbound postcopy on reception of the
1710 * 'advise' command.
1712 static int vhost_user_postcopy_advise(struct vhost_dev *dev, Error **errp)
1714 #ifdef CONFIG_LINUX
1715 struct vhost_user *u = dev->opaque;
1716 CharBackend *chr = u->user->chr;
1717 int ufd;
1718 VhostUserMsg msg = {
1719 .hdr.request = VHOST_USER_POSTCOPY_ADVISE,
1720 .hdr.flags = VHOST_USER_VERSION,
1723 if (vhost_user_write(dev, &msg, NULL, 0) < 0) {
1724 error_setg(errp, "Failed to send postcopy_advise to vhost");
1725 return -1;
1728 if (vhost_user_read(dev, &msg) < 0) {
1729 error_setg(errp, "Failed to get postcopy_advise reply from vhost");
1730 return -1;
1733 if (msg.hdr.request != VHOST_USER_POSTCOPY_ADVISE) {
1734 error_setg(errp, "Unexpected msg type. Expected %d received %d",
1735 VHOST_USER_POSTCOPY_ADVISE, msg.hdr.request);
1736 return -1;
1739 if (msg.hdr.size) {
1740 error_setg(errp, "Received bad msg size.");
1741 return -1;
1743 ufd = qemu_chr_fe_get_msgfd(chr);
1744 if (ufd < 0) {
1745 error_setg(errp, "%s: Failed to get ufd", __func__);
1746 return -1;
1748 qemu_set_nonblock(ufd);
1750 /* register ufd with userfault thread */
1751 u->postcopy_fd.fd = ufd;
1752 u->postcopy_fd.data = dev;
1753 u->postcopy_fd.handler = vhost_user_postcopy_fault_handler;
1754 u->postcopy_fd.waker = vhost_user_postcopy_waker;
1755 u->postcopy_fd.idstr = "vhost-user"; /* Need to find unique name */
1756 postcopy_register_shared_ufd(&u->postcopy_fd);
1757 return 0;
1758 #else
1759 error_setg(errp, "Postcopy not supported on non-Linux systems");
1760 return -1;
1761 #endif
1765 * Called at the switch to postcopy on reception of the 'listen' command.
1767 static int vhost_user_postcopy_listen(struct vhost_dev *dev, Error **errp)
1769 struct vhost_user *u = dev->opaque;
1770 int ret;
1771 VhostUserMsg msg = {
1772 .hdr.request = VHOST_USER_POSTCOPY_LISTEN,
1773 .hdr.flags = VHOST_USER_VERSION | VHOST_USER_NEED_REPLY_MASK,
1775 u->postcopy_listen = true;
1776 trace_vhost_user_postcopy_listen();
1777 if (vhost_user_write(dev, &msg, NULL, 0) < 0) {
1778 error_setg(errp, "Failed to send postcopy_listen to vhost");
1779 return -1;
1782 ret = process_message_reply(dev, &msg);
1783 if (ret) {
1784 error_setg(errp, "Failed to receive reply to postcopy_listen");
1785 return ret;
1788 return 0;
1792 * Called at the end of postcopy
1794 static int vhost_user_postcopy_end(struct vhost_dev *dev, Error **errp)
1796 VhostUserMsg msg = {
1797 .hdr.request = VHOST_USER_POSTCOPY_END,
1798 .hdr.flags = VHOST_USER_VERSION | VHOST_USER_NEED_REPLY_MASK,
1800 int ret;
1801 struct vhost_user *u = dev->opaque;
1803 trace_vhost_user_postcopy_end_entry();
1804 if (vhost_user_write(dev, &msg, NULL, 0) < 0) {
1805 error_setg(errp, "Failed to send postcopy_end to vhost");
1806 return -1;
1809 ret = process_message_reply(dev, &msg);
1810 if (ret) {
1811 error_setg(errp, "Failed to receive reply to postcopy_end");
1812 return ret;
1814 postcopy_unregister_shared_ufd(&u->postcopy_fd);
1815 close(u->postcopy_fd.fd);
1816 u->postcopy_fd.handler = NULL;
1818 trace_vhost_user_postcopy_end_exit();
1820 return 0;
1823 static int vhost_user_postcopy_notifier(NotifierWithReturn *notifier,
1824 void *opaque)
1826 struct PostcopyNotifyData *pnd = opaque;
1827 struct vhost_user *u = container_of(notifier, struct vhost_user,
1828 postcopy_notifier);
1829 struct vhost_dev *dev = u->dev;
1831 switch (pnd->reason) {
1832 case POSTCOPY_NOTIFY_PROBE:
1833 if (!virtio_has_feature(dev->protocol_features,
1834 VHOST_USER_PROTOCOL_F_PAGEFAULT)) {
1835 /* TODO: Get the device name into this error somehow */
1836 error_setg(pnd->errp,
1837 "vhost-user backend not capable of postcopy");
1838 return -ENOENT;
1840 break;
1842 case POSTCOPY_NOTIFY_INBOUND_ADVISE:
1843 return vhost_user_postcopy_advise(dev, pnd->errp);
1845 case POSTCOPY_NOTIFY_INBOUND_LISTEN:
1846 return vhost_user_postcopy_listen(dev, pnd->errp);
1848 case POSTCOPY_NOTIFY_INBOUND_END:
1849 return vhost_user_postcopy_end(dev, pnd->errp);
1851 default:
1852 /* We ignore notifications we don't know */
1853 break;
1856 return 0;
1859 static int vhost_user_backend_init(struct vhost_dev *dev, void *opaque)
1861 uint64_t features, protocol_features, ram_slots;
1862 struct vhost_user *u;
1863 int err;
1865 assert(dev->vhost_ops->backend_type == VHOST_BACKEND_TYPE_USER);
1867 u = g_new0(struct vhost_user, 1);
1868 u->user = opaque;
1869 u->dev = dev;
1870 dev->opaque = u;
1872 err = vhost_user_get_features(dev, &features);
1873 if (err < 0) {
1874 return err;
1877 if (virtio_has_feature(features, VHOST_USER_F_PROTOCOL_FEATURES)) {
1878 dev->backend_features |= 1ULL << VHOST_USER_F_PROTOCOL_FEATURES;
1880 err = vhost_user_get_u64(dev, VHOST_USER_GET_PROTOCOL_FEATURES,
1881 &protocol_features);
1882 if (err < 0) {
1883 return err;
1886 dev->protocol_features =
1887 protocol_features & VHOST_USER_PROTOCOL_FEATURE_MASK;
1889 if (!dev->config_ops || !dev->config_ops->vhost_dev_config_notifier) {
1890 /* Don't acknowledge CONFIG feature if device doesn't support it */
1891 dev->protocol_features &= ~(1ULL << VHOST_USER_PROTOCOL_F_CONFIG);
1892 } else if (!(protocol_features &
1893 (1ULL << VHOST_USER_PROTOCOL_F_CONFIG))) {
1894 error_report("Device expects VHOST_USER_PROTOCOL_F_CONFIG "
1895 "but backend does not support it.");
1896 return -1;
1899 err = vhost_user_set_protocol_features(dev, dev->protocol_features);
1900 if (err < 0) {
1901 return err;
1904 /* query the max queues we support if backend supports Multiple Queue */
1905 if (dev->protocol_features & (1ULL << VHOST_USER_PROTOCOL_F_MQ)) {
1906 err = vhost_user_get_u64(dev, VHOST_USER_GET_QUEUE_NUM,
1907 &dev->max_queues);
1908 if (err < 0) {
1909 return err;
1912 if (dev->num_queues && dev->max_queues < dev->num_queues) {
1913 error_report("The maximum number of queues supported by the "
1914 "backend is %" PRIu64, dev->max_queues);
1915 return -EINVAL;
1918 if (virtio_has_feature(features, VIRTIO_F_IOMMU_PLATFORM) &&
1919 !(virtio_has_feature(dev->protocol_features,
1920 VHOST_USER_PROTOCOL_F_SLAVE_REQ) &&
1921 virtio_has_feature(dev->protocol_features,
1922 VHOST_USER_PROTOCOL_F_REPLY_ACK))) {
1923 error_report("IOMMU support requires reply-ack and "
1924 "slave-req protocol features.");
1925 return -1;
1928 /* get max memory regions if backend supports configurable RAM slots */
1929 if (!virtio_has_feature(dev->protocol_features,
1930 VHOST_USER_PROTOCOL_F_CONFIGURE_MEM_SLOTS)) {
1931 u->user->memory_slots = VHOST_MEMORY_BASELINE_NREGIONS;
1932 } else {
1933 err = vhost_user_get_max_memslots(dev, &ram_slots);
1934 if (err < 0) {
1935 return err;
1938 if (ram_slots < u->user->memory_slots) {
1939 error_report("The backend specified a max ram slots limit "
1940 "of %" PRIu64", when the prior validated limit was %d. "
1941 "This limit should never decrease.", ram_slots,
1942 u->user->memory_slots);
1943 return -1;
1946 u->user->memory_slots = MIN(ram_slots, VHOST_USER_MAX_RAM_SLOTS);
1950 if (dev->migration_blocker == NULL &&
1951 !virtio_has_feature(dev->protocol_features,
1952 VHOST_USER_PROTOCOL_F_LOG_SHMFD)) {
1953 error_setg(&dev->migration_blocker,
1954 "Migration disabled: vhost-user backend lacks "
1955 "VHOST_USER_PROTOCOL_F_LOG_SHMFD feature.");
1958 if (dev->vq_index == 0) {
1959 err = vhost_setup_slave_channel(dev);
1960 if (err < 0) {
1961 return err;
1965 u->postcopy_notifier.notify = vhost_user_postcopy_notifier;
1966 postcopy_add_notifier(&u->postcopy_notifier);
1968 return 0;
1971 static int vhost_user_backend_cleanup(struct vhost_dev *dev)
1973 struct vhost_user *u;
1975 assert(dev->vhost_ops->backend_type == VHOST_BACKEND_TYPE_USER);
1977 u = dev->opaque;
1978 if (u->postcopy_notifier.notify) {
1979 postcopy_remove_notifier(&u->postcopy_notifier);
1980 u->postcopy_notifier.notify = NULL;
1982 u->postcopy_listen = false;
1983 if (u->postcopy_fd.handler) {
1984 postcopy_unregister_shared_ufd(&u->postcopy_fd);
1985 close(u->postcopy_fd.fd);
1986 u->postcopy_fd.handler = NULL;
1988 if (u->slave_ioc) {
1989 close_slave_channel(u);
1991 g_free(u->region_rb);
1992 u->region_rb = NULL;
1993 g_free(u->region_rb_offset);
1994 u->region_rb_offset = NULL;
1995 u->region_rb_len = 0;
1996 g_free(u);
1997 dev->opaque = 0;
1999 return 0;
2002 static int vhost_user_get_vq_index(struct vhost_dev *dev, int idx)
2004 assert(idx >= dev->vq_index && idx < dev->vq_index + dev->nvqs);
2006 return idx;
2009 static int vhost_user_memslots_limit(struct vhost_dev *dev)
2011 struct vhost_user *u = dev->opaque;
2013 return u->user->memory_slots;
2016 static bool vhost_user_requires_shm_log(struct vhost_dev *dev)
2018 assert(dev->vhost_ops->backend_type == VHOST_BACKEND_TYPE_USER);
2020 return virtio_has_feature(dev->protocol_features,
2021 VHOST_USER_PROTOCOL_F_LOG_SHMFD);
2024 static int vhost_user_migration_done(struct vhost_dev *dev, char* mac_addr)
2026 VhostUserMsg msg = { };
2028 assert(dev->vhost_ops->backend_type == VHOST_BACKEND_TYPE_USER);
2030 /* If guest supports GUEST_ANNOUNCE do nothing */
2031 if (virtio_has_feature(dev->acked_features, VIRTIO_NET_F_GUEST_ANNOUNCE)) {
2032 return 0;
2035 /* if backend supports VHOST_USER_PROTOCOL_F_RARP ask it to send the RARP */
2036 if (virtio_has_feature(dev->protocol_features,
2037 VHOST_USER_PROTOCOL_F_RARP)) {
2038 msg.hdr.request = VHOST_USER_SEND_RARP;
2039 msg.hdr.flags = VHOST_USER_VERSION;
2040 memcpy((char *)&msg.payload.u64, mac_addr, 6);
2041 msg.hdr.size = sizeof(msg.payload.u64);
2043 return vhost_user_write(dev, &msg, NULL, 0);
2045 return -1;
2048 static bool vhost_user_can_merge(struct vhost_dev *dev,
2049 uint64_t start1, uint64_t size1,
2050 uint64_t start2, uint64_t size2)
2052 ram_addr_t offset;
2053 int mfd, rfd;
2055 (void)vhost_user_get_mr_data(start1, &offset, &mfd);
2056 (void)vhost_user_get_mr_data(start2, &offset, &rfd);
2058 return mfd == rfd;
2061 static int vhost_user_net_set_mtu(struct vhost_dev *dev, uint16_t mtu)
2063 VhostUserMsg msg;
2064 bool reply_supported = virtio_has_feature(dev->protocol_features,
2065 VHOST_USER_PROTOCOL_F_REPLY_ACK);
2067 if (!(dev->protocol_features & (1ULL << VHOST_USER_PROTOCOL_F_NET_MTU))) {
2068 return 0;
2071 msg.hdr.request = VHOST_USER_NET_SET_MTU;
2072 msg.payload.u64 = mtu;
2073 msg.hdr.size = sizeof(msg.payload.u64);
2074 msg.hdr.flags = VHOST_USER_VERSION;
2075 if (reply_supported) {
2076 msg.hdr.flags |= VHOST_USER_NEED_REPLY_MASK;
2079 if (vhost_user_write(dev, &msg, NULL, 0) < 0) {
2080 return -1;
2083 /* If reply_ack supported, slave has to ack specified MTU is valid */
2084 if (reply_supported) {
2085 return process_message_reply(dev, &msg);
2088 return 0;
2091 static int vhost_user_send_device_iotlb_msg(struct vhost_dev *dev,
2092 struct vhost_iotlb_msg *imsg)
2094 VhostUserMsg msg = {
2095 .hdr.request = VHOST_USER_IOTLB_MSG,
2096 .hdr.size = sizeof(msg.payload.iotlb),
2097 .hdr.flags = VHOST_USER_VERSION | VHOST_USER_NEED_REPLY_MASK,
2098 .payload.iotlb = *imsg,
2101 if (vhost_user_write(dev, &msg, NULL, 0) < 0) {
2102 return -EFAULT;
2105 return process_message_reply(dev, &msg);
2109 static void vhost_user_set_iotlb_callback(struct vhost_dev *dev, int enabled)
2111 /* No-op as the receive channel is not dedicated to IOTLB messages. */
2114 static int vhost_user_get_config(struct vhost_dev *dev, uint8_t *config,
2115 uint32_t config_len)
2117 VhostUserMsg msg = {
2118 .hdr.request = VHOST_USER_GET_CONFIG,
2119 .hdr.flags = VHOST_USER_VERSION,
2120 .hdr.size = VHOST_USER_CONFIG_HDR_SIZE + config_len,
2123 if (!virtio_has_feature(dev->protocol_features,
2124 VHOST_USER_PROTOCOL_F_CONFIG)) {
2125 return -1;
2128 if (config_len > VHOST_USER_MAX_CONFIG_SIZE) {
2129 return -1;
2132 msg.payload.config.offset = 0;
2133 msg.payload.config.size = config_len;
2134 if (vhost_user_write(dev, &msg, NULL, 0) < 0) {
2135 return -1;
2138 if (vhost_user_read(dev, &msg) < 0) {
2139 return -1;
2142 if (msg.hdr.request != VHOST_USER_GET_CONFIG) {
2143 error_report("Received unexpected msg type. Expected %d received %d",
2144 VHOST_USER_GET_CONFIG, msg.hdr.request);
2145 return -1;
2148 if (msg.hdr.size != VHOST_USER_CONFIG_HDR_SIZE + config_len) {
2149 error_report("Received bad msg size.");
2150 return -1;
2153 memcpy(config, msg.payload.config.region, config_len);
2155 return 0;
2158 static int vhost_user_set_config(struct vhost_dev *dev, const uint8_t *data,
2159 uint32_t offset, uint32_t size, uint32_t flags)
2161 uint8_t *p;
2162 bool reply_supported = virtio_has_feature(dev->protocol_features,
2163 VHOST_USER_PROTOCOL_F_REPLY_ACK);
2165 VhostUserMsg msg = {
2166 .hdr.request = VHOST_USER_SET_CONFIG,
2167 .hdr.flags = VHOST_USER_VERSION,
2168 .hdr.size = VHOST_USER_CONFIG_HDR_SIZE + size,
2171 if (!virtio_has_feature(dev->protocol_features,
2172 VHOST_USER_PROTOCOL_F_CONFIG)) {
2173 return -1;
2176 if (reply_supported) {
2177 msg.hdr.flags |= VHOST_USER_NEED_REPLY_MASK;
2180 if (size > VHOST_USER_MAX_CONFIG_SIZE) {
2181 return -1;
2184 msg.payload.config.offset = offset,
2185 msg.payload.config.size = size,
2186 msg.payload.config.flags = flags,
2187 p = msg.payload.config.region;
2188 memcpy(p, data, size);
2190 if (vhost_user_write(dev, &msg, NULL, 0) < 0) {
2191 return -1;
2194 if (reply_supported) {
2195 return process_message_reply(dev, &msg);
2198 return 0;
2201 static int vhost_user_crypto_create_session(struct vhost_dev *dev,
2202 void *session_info,
2203 uint64_t *session_id)
2205 bool crypto_session = virtio_has_feature(dev->protocol_features,
2206 VHOST_USER_PROTOCOL_F_CRYPTO_SESSION);
2207 CryptoDevBackendSymSessionInfo *sess_info = session_info;
2208 VhostUserMsg msg = {
2209 .hdr.request = VHOST_USER_CREATE_CRYPTO_SESSION,
2210 .hdr.flags = VHOST_USER_VERSION,
2211 .hdr.size = sizeof(msg.payload.session),
2214 assert(dev->vhost_ops->backend_type == VHOST_BACKEND_TYPE_USER);
2216 if (!crypto_session) {
2217 error_report("vhost-user trying to send unhandled ioctl");
2218 return -1;
2221 memcpy(&msg.payload.session.session_setup_data, sess_info,
2222 sizeof(CryptoDevBackendSymSessionInfo));
2223 if (sess_info->key_len) {
2224 memcpy(&msg.payload.session.key, sess_info->cipher_key,
2225 sess_info->key_len);
2227 if (sess_info->auth_key_len > 0) {
2228 memcpy(&msg.payload.session.auth_key, sess_info->auth_key,
2229 sess_info->auth_key_len);
2231 if (vhost_user_write(dev, &msg, NULL, 0) < 0) {
2232 error_report("vhost_user_write() return -1, create session failed");
2233 return -1;
2236 if (vhost_user_read(dev, &msg) < 0) {
2237 error_report("vhost_user_read() return -1, create session failed");
2238 return -1;
2241 if (msg.hdr.request != VHOST_USER_CREATE_CRYPTO_SESSION) {
2242 error_report("Received unexpected msg type. Expected %d received %d",
2243 VHOST_USER_CREATE_CRYPTO_SESSION, msg.hdr.request);
2244 return -1;
2247 if (msg.hdr.size != sizeof(msg.payload.session)) {
2248 error_report("Received bad msg size.");
2249 return -1;
2252 if (msg.payload.session.session_id < 0) {
2253 error_report("Bad session id: %" PRId64 "",
2254 msg.payload.session.session_id);
2255 return -1;
2257 *session_id = msg.payload.session.session_id;
2259 return 0;
2262 static int
2263 vhost_user_crypto_close_session(struct vhost_dev *dev, uint64_t session_id)
2265 bool crypto_session = virtio_has_feature(dev->protocol_features,
2266 VHOST_USER_PROTOCOL_F_CRYPTO_SESSION);
2267 VhostUserMsg msg = {
2268 .hdr.request = VHOST_USER_CLOSE_CRYPTO_SESSION,
2269 .hdr.flags = VHOST_USER_VERSION,
2270 .hdr.size = sizeof(msg.payload.u64),
2272 msg.payload.u64 = session_id;
2274 if (!crypto_session) {
2275 error_report("vhost-user trying to send unhandled ioctl");
2276 return -1;
2279 if (vhost_user_write(dev, &msg, NULL, 0) < 0) {
2280 error_report("vhost_user_write() return -1, close session failed");
2281 return -1;
2284 return 0;
2287 static bool vhost_user_mem_section_filter(struct vhost_dev *dev,
2288 MemoryRegionSection *section)
2290 bool result;
2292 result = memory_region_get_fd(section->mr) >= 0;
2294 return result;
2297 static int vhost_user_get_inflight_fd(struct vhost_dev *dev,
2298 uint16_t queue_size,
2299 struct vhost_inflight *inflight)
2301 void *addr;
2302 int fd;
2303 struct vhost_user *u = dev->opaque;
2304 CharBackend *chr = u->user->chr;
2305 VhostUserMsg msg = {
2306 .hdr.request = VHOST_USER_GET_INFLIGHT_FD,
2307 .hdr.flags = VHOST_USER_VERSION,
2308 .payload.inflight.num_queues = dev->nvqs,
2309 .payload.inflight.queue_size = queue_size,
2310 .hdr.size = sizeof(msg.payload.inflight),
2313 if (!virtio_has_feature(dev->protocol_features,
2314 VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD)) {
2315 return 0;
2318 if (vhost_user_write(dev, &msg, NULL, 0) < 0) {
2319 return -1;
2322 if (vhost_user_read(dev, &msg) < 0) {
2323 return -1;
2326 if (msg.hdr.request != VHOST_USER_GET_INFLIGHT_FD) {
2327 error_report("Received unexpected msg type. "
2328 "Expected %d received %d",
2329 VHOST_USER_GET_INFLIGHT_FD, msg.hdr.request);
2330 return -1;
2333 if (msg.hdr.size != sizeof(msg.payload.inflight)) {
2334 error_report("Received bad msg size.");
2335 return -1;
2338 if (!msg.payload.inflight.mmap_size) {
2339 return 0;
2342 fd = qemu_chr_fe_get_msgfd(chr);
2343 if (fd < 0) {
2344 error_report("Failed to get mem fd");
2345 return -1;
2348 addr = mmap(0, msg.payload.inflight.mmap_size, PROT_READ | PROT_WRITE,
2349 MAP_SHARED, fd, msg.payload.inflight.mmap_offset);
2351 if (addr == MAP_FAILED) {
2352 error_report("Failed to mmap mem fd");
2353 close(fd);
2354 return -1;
2357 inflight->addr = addr;
2358 inflight->fd = fd;
2359 inflight->size = msg.payload.inflight.mmap_size;
2360 inflight->offset = msg.payload.inflight.mmap_offset;
2361 inflight->queue_size = queue_size;
2363 return 0;
2366 static int vhost_user_set_inflight_fd(struct vhost_dev *dev,
2367 struct vhost_inflight *inflight)
2369 VhostUserMsg msg = {
2370 .hdr.request = VHOST_USER_SET_INFLIGHT_FD,
2371 .hdr.flags = VHOST_USER_VERSION,
2372 .payload.inflight.mmap_size = inflight->size,
2373 .payload.inflight.mmap_offset = inflight->offset,
2374 .payload.inflight.num_queues = dev->nvqs,
2375 .payload.inflight.queue_size = inflight->queue_size,
2376 .hdr.size = sizeof(msg.payload.inflight),
2379 if (!virtio_has_feature(dev->protocol_features,
2380 VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD)) {
2381 return 0;
2384 if (vhost_user_write(dev, &msg, &inflight->fd, 1) < 0) {
2385 return -1;
2388 return 0;
2391 bool vhost_user_init(VhostUserState *user, CharBackend *chr, Error **errp)
2393 if (user->chr) {
2394 error_setg(errp, "Cannot initialize vhost-user state");
2395 return false;
2397 user->chr = chr;
2398 user->memory_slots = 0;
2399 return true;
2402 void vhost_user_cleanup(VhostUserState *user)
2404 int i;
2406 if (!user->chr) {
2407 return;
2410 for (i = 0; i < VIRTIO_QUEUE_MAX; i++) {
2411 if (user->notifier[i].addr) {
2412 object_unparent(OBJECT(&user->notifier[i].mr));
2413 munmap(user->notifier[i].addr, qemu_real_host_page_size);
2414 user->notifier[i].addr = NULL;
2417 user->chr = NULL;
2420 const VhostOps user_ops = {
2421 .backend_type = VHOST_BACKEND_TYPE_USER,
2422 .vhost_backend_init = vhost_user_backend_init,
2423 .vhost_backend_cleanup = vhost_user_backend_cleanup,
2424 .vhost_backend_memslots_limit = vhost_user_memslots_limit,
2425 .vhost_set_log_base = vhost_user_set_log_base,
2426 .vhost_set_mem_table = vhost_user_set_mem_table,
2427 .vhost_set_vring_addr = vhost_user_set_vring_addr,
2428 .vhost_set_vring_endian = vhost_user_set_vring_endian,
2429 .vhost_set_vring_num = vhost_user_set_vring_num,
2430 .vhost_set_vring_base = vhost_user_set_vring_base,
2431 .vhost_get_vring_base = vhost_user_get_vring_base,
2432 .vhost_set_vring_kick = vhost_user_set_vring_kick,
2433 .vhost_set_vring_call = vhost_user_set_vring_call,
2434 .vhost_set_features = vhost_user_set_features,
2435 .vhost_get_features = vhost_user_get_features,
2436 .vhost_set_owner = vhost_user_set_owner,
2437 .vhost_reset_device = vhost_user_reset_device,
2438 .vhost_get_vq_index = vhost_user_get_vq_index,
2439 .vhost_set_vring_enable = vhost_user_set_vring_enable,
2440 .vhost_requires_shm_log = vhost_user_requires_shm_log,
2441 .vhost_migration_done = vhost_user_migration_done,
2442 .vhost_backend_can_merge = vhost_user_can_merge,
2443 .vhost_net_set_mtu = vhost_user_net_set_mtu,
2444 .vhost_set_iotlb_callback = vhost_user_set_iotlb_callback,
2445 .vhost_send_device_iotlb_msg = vhost_user_send_device_iotlb_msg,
2446 .vhost_get_config = vhost_user_get_config,
2447 .vhost_set_config = vhost_user_set_config,
2448 .vhost_crypto_create_session = vhost_user_crypto_create_session,
2449 .vhost_crypto_close_session = vhost_user_crypto_close_session,
2450 .vhost_backend_mem_section_filter = vhost_user_mem_section_filter,
2451 .vhost_get_inflight_fd = vhost_user_get_inflight_fd,
2452 .vhost_set_inflight_fd = vhost_user_set_inflight_fd,