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.
11 #include "qemu/osdep.h"
12 #include "qapi/error.h"
13 #include "hw/virtio/vhost.h"
14 #include "hw/virtio/vhost-backend.h"
15 #include "hw/virtio/virtio-net.h"
16 #include "sysemu/char.h"
17 #include "sysemu/kvm.h"
18 #include "qemu/error-report.h"
19 #include "qemu/sockets.h"
20 #include "migration/migration.h"
22 #include <sys/ioctl.h>
23 #include <sys/socket.h>
25 #include <linux/vhost.h>
27 #define VHOST_MEMORY_MAX_NREGIONS 8
28 #define VHOST_USER_F_PROTOCOL_FEATURES 30
30 enum VhostUserProtocolFeature
{
31 VHOST_USER_PROTOCOL_F_MQ
= 0,
32 VHOST_USER_PROTOCOL_F_LOG_SHMFD
= 1,
33 VHOST_USER_PROTOCOL_F_RARP
= 2,
35 VHOST_USER_PROTOCOL_F_MAX
38 #define VHOST_USER_PROTOCOL_FEATURE_MASK ((1 << VHOST_USER_PROTOCOL_F_MAX) - 1)
40 typedef enum VhostUserRequest
{
42 VHOST_USER_GET_FEATURES
= 1,
43 VHOST_USER_SET_FEATURES
= 2,
44 VHOST_USER_SET_OWNER
= 3,
45 VHOST_USER_RESET_OWNER
= 4,
46 VHOST_USER_SET_MEM_TABLE
= 5,
47 VHOST_USER_SET_LOG_BASE
= 6,
48 VHOST_USER_SET_LOG_FD
= 7,
49 VHOST_USER_SET_VRING_NUM
= 8,
50 VHOST_USER_SET_VRING_ADDR
= 9,
51 VHOST_USER_SET_VRING_BASE
= 10,
52 VHOST_USER_GET_VRING_BASE
= 11,
53 VHOST_USER_SET_VRING_KICK
= 12,
54 VHOST_USER_SET_VRING_CALL
= 13,
55 VHOST_USER_SET_VRING_ERR
= 14,
56 VHOST_USER_GET_PROTOCOL_FEATURES
= 15,
57 VHOST_USER_SET_PROTOCOL_FEATURES
= 16,
58 VHOST_USER_GET_QUEUE_NUM
= 17,
59 VHOST_USER_SET_VRING_ENABLE
= 18,
60 VHOST_USER_SEND_RARP
= 19,
64 typedef struct VhostUserMemoryRegion
{
65 uint64_t guest_phys_addr
;
67 uint64_t userspace_addr
;
69 } VhostUserMemoryRegion
;
71 typedef struct VhostUserMemory
{
74 VhostUserMemoryRegion regions
[VHOST_MEMORY_MAX_NREGIONS
];
77 typedef struct VhostUserLog
{
82 typedef struct VhostUserMsg
{
83 VhostUserRequest request
;
85 #define VHOST_USER_VERSION_MASK (0x3)
86 #define VHOST_USER_REPLY_MASK (0x1<<2)
88 uint32_t size
; /* the following payload size */
90 #define VHOST_USER_VRING_IDX_MASK (0xff)
91 #define VHOST_USER_VRING_NOFD_MASK (0x1<<8)
93 struct vhost_vring_state state
;
94 struct vhost_vring_addr addr
;
95 VhostUserMemory memory
;
98 } QEMU_PACKED VhostUserMsg
;
100 static VhostUserMsg m
__attribute__ ((unused
));
101 #define VHOST_USER_HDR_SIZE (sizeof(m.request) \
105 #define VHOST_USER_PAYLOAD_SIZE (sizeof(m) - VHOST_USER_HDR_SIZE)
107 /* The version of the protocol we support */
108 #define VHOST_USER_VERSION (0x1)
110 static bool ioeventfd_enabled(void)
112 return kvm_enabled() && kvm_eventfds_enabled();
115 static int vhost_user_read(struct vhost_dev
*dev
, VhostUserMsg
*msg
)
117 CharDriverState
*chr
= dev
->opaque
;
118 uint8_t *p
= (uint8_t *) msg
;
119 int r
, size
= VHOST_USER_HDR_SIZE
;
121 r
= qemu_chr_fe_read_all(chr
, p
, size
);
123 error_report("Failed to read msg header. Read %d instead of %d."
124 " Original request %d.", r
, size
, msg
->request
);
128 /* validate received flags */
129 if (msg
->flags
!= (VHOST_USER_REPLY_MASK
| VHOST_USER_VERSION
)) {
130 error_report("Failed to read msg header."
131 " Flags 0x%x instead of 0x%x.", msg
->flags
,
132 VHOST_USER_REPLY_MASK
| VHOST_USER_VERSION
);
136 /* validate message size is sane */
137 if (msg
->size
> VHOST_USER_PAYLOAD_SIZE
) {
138 error_report("Failed to read msg header."
139 " Size %d exceeds the maximum %zu.", msg
->size
,
140 VHOST_USER_PAYLOAD_SIZE
);
145 p
+= VHOST_USER_HDR_SIZE
;
147 r
= qemu_chr_fe_read_all(chr
, p
, size
);
149 error_report("Failed to read msg payload."
150 " Read %d instead of %d.", r
, msg
->size
);
161 static bool vhost_user_one_time_request(VhostUserRequest request
)
164 case VHOST_USER_SET_OWNER
:
165 case VHOST_USER_RESET_OWNER
:
166 case VHOST_USER_SET_MEM_TABLE
:
167 case VHOST_USER_GET_QUEUE_NUM
:
174 /* most non-init callers ignore the error */
175 static int vhost_user_write(struct vhost_dev
*dev
, VhostUserMsg
*msg
,
176 int *fds
, int fd_num
)
178 CharDriverState
*chr
= dev
->opaque
;
179 int ret
, size
= VHOST_USER_HDR_SIZE
+ msg
->size
;
182 * For non-vring specific requests, like VHOST_USER_SET_MEM_TABLE,
183 * we just need send it once in the first time. For later such
184 * request, we just ignore it.
186 if (vhost_user_one_time_request(msg
->request
) && dev
->vq_index
!= 0) {
190 if (qemu_chr_fe_set_msgfds(chr
, fds
, fd_num
) < 0) {
191 error_report("Failed to set msg fds.");
195 ret
= qemu_chr_fe_write_all(chr
, (const uint8_t *) msg
, size
);
197 error_report("Failed to write msg."
198 " Wrote %d instead of %d.", ret
, size
);
205 static int vhost_user_set_log_base(struct vhost_dev
*dev
, uint64_t base
,
206 struct vhost_log
*log
)
208 int fds
[VHOST_MEMORY_MAX_NREGIONS
];
210 bool shmfd
= virtio_has_feature(dev
->protocol_features
,
211 VHOST_USER_PROTOCOL_F_LOG_SHMFD
);
213 .request
= VHOST_USER_SET_LOG_BASE
,
214 .flags
= VHOST_USER_VERSION
,
215 .payload
.log
.mmap_size
= log
->size
* sizeof(*(log
->log
)),
216 .payload
.log
.mmap_offset
= 0,
217 .size
= sizeof(msg
.payload
.log
),
220 if (shmfd
&& log
->fd
!= -1) {
221 fds
[fd_num
++] = log
->fd
;
224 if (vhost_user_write(dev
, &msg
, fds
, fd_num
) < 0) {
230 if (vhost_user_read(dev
, &msg
) < 0) {
234 if (msg
.request
!= VHOST_USER_SET_LOG_BASE
) {
235 error_report("Received unexpected msg type. "
236 "Expected %d received %d",
237 VHOST_USER_SET_LOG_BASE
, msg
.request
);
245 static int vhost_user_set_mem_table(struct vhost_dev
*dev
,
246 struct vhost_memory
*mem
)
248 int fds
[VHOST_MEMORY_MAX_NREGIONS
];
252 .request
= VHOST_USER_SET_MEM_TABLE
,
253 .flags
= VHOST_USER_VERSION
,
256 for (i
= 0; i
< dev
->mem
->nregions
; ++i
) {
257 struct vhost_memory_region
*reg
= dev
->mem
->regions
+ i
;
261 assert((uintptr_t)reg
->userspace_addr
== reg
->userspace_addr
);
262 mr
= memory_region_from_host((void *)(uintptr_t)reg
->userspace_addr
,
264 fd
= memory_region_get_fd(mr
);
266 msg
.payload
.memory
.regions
[fd_num
].userspace_addr
= reg
->userspace_addr
;
267 msg
.payload
.memory
.regions
[fd_num
].memory_size
= reg
->memory_size
;
268 msg
.payload
.memory
.regions
[fd_num
].guest_phys_addr
= reg
->guest_phys_addr
;
269 msg
.payload
.memory
.regions
[fd_num
].mmap_offset
= offset
;
270 assert(fd_num
< VHOST_MEMORY_MAX_NREGIONS
);
275 msg
.payload
.memory
.nregions
= fd_num
;
278 error_report("Failed initializing vhost-user memory map, "
279 "consider using -object memory-backend-file share=on");
283 msg
.size
= sizeof(msg
.payload
.memory
.nregions
);
284 msg
.size
+= sizeof(msg
.payload
.memory
.padding
);
285 msg
.size
+= fd_num
* sizeof(VhostUserMemoryRegion
);
287 if (vhost_user_write(dev
, &msg
, fds
, fd_num
) < 0) {
294 static int vhost_user_set_vring_addr(struct vhost_dev
*dev
,
295 struct vhost_vring_addr
*addr
)
298 .request
= VHOST_USER_SET_VRING_ADDR
,
299 .flags
= VHOST_USER_VERSION
,
300 .payload
.addr
= *addr
,
301 .size
= sizeof(msg
.payload
.addr
),
304 if (vhost_user_write(dev
, &msg
, NULL
, 0) < 0) {
311 static int vhost_user_set_vring_endian(struct vhost_dev
*dev
,
312 struct vhost_vring_state
*ring
)
314 error_report("vhost-user trying to send unhandled ioctl");
318 static int vhost_set_vring(struct vhost_dev
*dev
,
319 unsigned long int request
,
320 struct vhost_vring_state
*ring
)
324 .flags
= VHOST_USER_VERSION
,
325 .payload
.state
= *ring
,
326 .size
= sizeof(msg
.payload
.state
),
329 if (vhost_user_write(dev
, &msg
, NULL
, 0) < 0) {
336 static int vhost_user_set_vring_num(struct vhost_dev
*dev
,
337 struct vhost_vring_state
*ring
)
339 return vhost_set_vring(dev
, VHOST_USER_SET_VRING_NUM
, ring
);
342 static int vhost_user_set_vring_base(struct vhost_dev
*dev
,
343 struct vhost_vring_state
*ring
)
345 return vhost_set_vring(dev
, VHOST_USER_SET_VRING_BASE
, ring
);
348 static int vhost_user_set_vring_enable(struct vhost_dev
*dev
, int enable
)
352 if (!virtio_has_feature(dev
->features
, VHOST_USER_F_PROTOCOL_FEATURES
)) {
356 for (i
= 0; i
< dev
->nvqs
; ++i
) {
357 struct vhost_vring_state state
= {
358 .index
= dev
->vq_index
+ i
,
362 vhost_set_vring(dev
, VHOST_USER_SET_VRING_ENABLE
, &state
);
368 static int vhost_user_get_vring_base(struct vhost_dev
*dev
,
369 struct vhost_vring_state
*ring
)
372 .request
= VHOST_USER_GET_VRING_BASE
,
373 .flags
= VHOST_USER_VERSION
,
374 .payload
.state
= *ring
,
375 .size
= sizeof(msg
.payload
.state
),
378 if (vhost_user_write(dev
, &msg
, NULL
, 0) < 0) {
382 if (vhost_user_read(dev
, &msg
) < 0) {
386 if (msg
.request
!= VHOST_USER_GET_VRING_BASE
) {
387 error_report("Received unexpected msg type. Expected %d received %d",
388 VHOST_USER_GET_VRING_BASE
, msg
.request
);
392 if (msg
.size
!= sizeof(msg
.payload
.state
)) {
393 error_report("Received bad msg size.");
397 *ring
= msg
.payload
.state
;
402 static int vhost_set_vring_file(struct vhost_dev
*dev
,
403 VhostUserRequest request
,
404 struct vhost_vring_file
*file
)
406 int fds
[VHOST_MEMORY_MAX_NREGIONS
];
410 .flags
= VHOST_USER_VERSION
,
411 .payload
.u64
= file
->index
& VHOST_USER_VRING_IDX_MASK
,
412 .size
= sizeof(msg
.payload
.u64
),
415 if (ioeventfd_enabled() && file
->fd
> 0) {
416 fds
[fd_num
++] = file
->fd
;
418 msg
.payload
.u64
|= VHOST_USER_VRING_NOFD_MASK
;
421 if (vhost_user_write(dev
, &msg
, fds
, fd_num
) < 0) {
428 static int vhost_user_set_vring_kick(struct vhost_dev
*dev
,
429 struct vhost_vring_file
*file
)
431 return vhost_set_vring_file(dev
, VHOST_USER_SET_VRING_KICK
, file
);
434 static int vhost_user_set_vring_call(struct vhost_dev
*dev
,
435 struct vhost_vring_file
*file
)
437 return vhost_set_vring_file(dev
, VHOST_USER_SET_VRING_CALL
, file
);
440 static int vhost_user_set_u64(struct vhost_dev
*dev
, int request
, uint64_t u64
)
444 .flags
= VHOST_USER_VERSION
,
446 .size
= sizeof(msg
.payload
.u64
),
449 if (vhost_user_write(dev
, &msg
, NULL
, 0) < 0) {
456 static int vhost_user_set_features(struct vhost_dev
*dev
,
459 return vhost_user_set_u64(dev
, VHOST_USER_SET_FEATURES
, features
);
462 static int vhost_user_set_protocol_features(struct vhost_dev
*dev
,
465 return vhost_user_set_u64(dev
, VHOST_USER_SET_PROTOCOL_FEATURES
, features
);
468 static int vhost_user_get_u64(struct vhost_dev
*dev
, int request
, uint64_t *u64
)
472 .flags
= VHOST_USER_VERSION
,
475 if (vhost_user_one_time_request(request
) && dev
->vq_index
!= 0) {
479 if (vhost_user_write(dev
, &msg
, NULL
, 0) < 0) {
483 if (vhost_user_read(dev
, &msg
) < 0) {
487 if (msg
.request
!= request
) {
488 error_report("Received unexpected msg type. Expected %d received %d",
489 request
, msg
.request
);
493 if (msg
.size
!= sizeof(msg
.payload
.u64
)) {
494 error_report("Received bad msg size.");
498 *u64
= msg
.payload
.u64
;
503 static int vhost_user_get_features(struct vhost_dev
*dev
, uint64_t *features
)
505 return vhost_user_get_u64(dev
, VHOST_USER_GET_FEATURES
, features
);
508 static int vhost_user_set_owner(struct vhost_dev
*dev
)
511 .request
= VHOST_USER_SET_OWNER
,
512 .flags
= VHOST_USER_VERSION
,
515 if (vhost_user_write(dev
, &msg
, NULL
, 0) < 0) {
522 static int vhost_user_reset_device(struct vhost_dev
*dev
)
525 .request
= VHOST_USER_RESET_OWNER
,
526 .flags
= VHOST_USER_VERSION
,
529 if (vhost_user_write(dev
, &msg
, NULL
, 0) < 0) {
536 static int vhost_user_init(struct vhost_dev
*dev
, void *opaque
)
541 assert(dev
->vhost_ops
->backend_type
== VHOST_BACKEND_TYPE_USER
);
543 dev
->opaque
= opaque
;
545 err
= vhost_user_get_features(dev
, &features
);
550 if (virtio_has_feature(features
, VHOST_USER_F_PROTOCOL_FEATURES
)) {
551 dev
->backend_features
|= 1ULL << VHOST_USER_F_PROTOCOL_FEATURES
;
553 err
= vhost_user_get_u64(dev
, VHOST_USER_GET_PROTOCOL_FEATURES
,
559 dev
->protocol_features
= features
& VHOST_USER_PROTOCOL_FEATURE_MASK
;
560 err
= vhost_user_set_protocol_features(dev
, dev
->protocol_features
);
565 /* query the max queues we support if backend supports Multiple Queue */
566 if (dev
->protocol_features
& (1ULL << VHOST_USER_PROTOCOL_F_MQ
)) {
567 err
= vhost_user_get_u64(dev
, VHOST_USER_GET_QUEUE_NUM
,
575 if (dev
->migration_blocker
== NULL
&&
576 !virtio_has_feature(dev
->protocol_features
,
577 VHOST_USER_PROTOCOL_F_LOG_SHMFD
)) {
578 error_setg(&dev
->migration_blocker
,
579 "Migration disabled: vhost-user backend lacks "
580 "VHOST_USER_PROTOCOL_F_LOG_SHMFD feature.");
586 static int vhost_user_cleanup(struct vhost_dev
*dev
)
588 assert(dev
->vhost_ops
->backend_type
== VHOST_BACKEND_TYPE_USER
);
595 static int vhost_user_get_vq_index(struct vhost_dev
*dev
, int idx
)
597 assert(idx
>= dev
->vq_index
&& idx
< dev
->vq_index
+ dev
->nvqs
);
602 static int vhost_user_memslots_limit(struct vhost_dev
*dev
)
604 return VHOST_MEMORY_MAX_NREGIONS
;
607 static bool vhost_user_requires_shm_log(struct vhost_dev
*dev
)
609 assert(dev
->vhost_ops
->backend_type
== VHOST_BACKEND_TYPE_USER
);
611 return virtio_has_feature(dev
->protocol_features
,
612 VHOST_USER_PROTOCOL_F_LOG_SHMFD
);
615 static int vhost_user_migration_done(struct vhost_dev
*dev
, char* mac_addr
)
617 VhostUserMsg msg
= { 0 };
619 assert(dev
->vhost_ops
->backend_type
== VHOST_BACKEND_TYPE_USER
);
621 /* If guest supports GUEST_ANNOUNCE do nothing */
622 if (virtio_has_feature(dev
->acked_features
, VIRTIO_NET_F_GUEST_ANNOUNCE
)) {
626 /* if backend supports VHOST_USER_PROTOCOL_F_RARP ask it to send the RARP */
627 if (virtio_has_feature(dev
->protocol_features
,
628 VHOST_USER_PROTOCOL_F_RARP
)) {
629 msg
.request
= VHOST_USER_SEND_RARP
;
630 msg
.flags
= VHOST_USER_VERSION
;
631 memcpy((char *)&msg
.payload
.u64
, mac_addr
, 6);
632 msg
.size
= sizeof(msg
.payload
.u64
);
634 return vhost_user_write(dev
, &msg
, NULL
, 0);
639 static bool vhost_user_can_merge(struct vhost_dev
*dev
,
640 uint64_t start1
, uint64_t size1
,
641 uint64_t start2
, uint64_t size2
)
647 mr
= memory_region_from_host((void *)(uintptr_t)start1
, &offset
);
648 mfd
= memory_region_get_fd(mr
);
650 mr
= memory_region_from_host((void *)(uintptr_t)start2
, &offset
);
651 rfd
= memory_region_get_fd(mr
);
656 const VhostOps user_ops
= {
657 .backend_type
= VHOST_BACKEND_TYPE_USER
,
658 .vhost_backend_init
= vhost_user_init
,
659 .vhost_backend_cleanup
= vhost_user_cleanup
,
660 .vhost_backend_memslots_limit
= vhost_user_memslots_limit
,
661 .vhost_set_log_base
= vhost_user_set_log_base
,
662 .vhost_set_mem_table
= vhost_user_set_mem_table
,
663 .vhost_set_vring_addr
= vhost_user_set_vring_addr
,
664 .vhost_set_vring_endian
= vhost_user_set_vring_endian
,
665 .vhost_set_vring_num
= vhost_user_set_vring_num
,
666 .vhost_set_vring_base
= vhost_user_set_vring_base
,
667 .vhost_get_vring_base
= vhost_user_get_vring_base
,
668 .vhost_set_vring_kick
= vhost_user_set_vring_kick
,
669 .vhost_set_vring_call
= vhost_user_set_vring_call
,
670 .vhost_set_features
= vhost_user_set_features
,
671 .vhost_get_features
= vhost_user_get_features
,
672 .vhost_set_owner
= vhost_user_set_owner
,
673 .vhost_reset_device
= vhost_user_reset_device
,
674 .vhost_get_vq_index
= vhost_user_get_vq_index
,
675 .vhost_set_vring_enable
= vhost_user_set_vring_enable
,
676 .vhost_requires_shm_log
= vhost_user_requires_shm_log
,
677 .vhost_migration_done
= vhost_user_migration_done
,
678 .vhost_backend_can_merge
= vhost_user_can_merge
,