1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2018 Intel Corporation
7 * The vhost-user protocol connection is an external interface, so it must be
8 * robust against invalid inputs.
10 * This is important because the vhost-user master is only one step removed
11 * from the guest. Malicious guests that have escaped will then launch further
12 * attacks from the vhost-user master.
14 * Even in deployments where guests are trusted, a bug in the vhost-user master
15 * can still cause invalid messages to be sent. Such messages must not
16 * compromise the stability of the DPDK application by causing crashes, memory
17 * corruption, or other problematic behavior.
19 * Do not assume received VhostUserMsg fields contain sensible values!
28 #include <sys/types.h>
31 #ifdef RTE_LIBRTE_VHOST_NUMA
35 #include <rte_common.h>
36 #include <rte_malloc.h>
41 #include "vhost_user.h"
43 #define VIRTIO_MIN_MTU 68
44 #define VIRTIO_MAX_MTU 65535
46 static const char *vhost_message_str[VHOST_USER_MAX] = {
47 [VHOST_USER_NONE] = "VHOST_USER_NONE",
48 [VHOST_USER_GET_FEATURES] = "VHOST_USER_GET_FEATURES",
49 [VHOST_USER_SET_FEATURES] = "VHOST_USER_SET_FEATURES",
50 [VHOST_USER_SET_OWNER] = "VHOST_USER_SET_OWNER",
51 [VHOST_USER_RESET_OWNER] = "VHOST_USER_RESET_OWNER",
52 [VHOST_USER_SET_MEM_TABLE] = "VHOST_USER_SET_MEM_TABLE",
53 [VHOST_USER_SET_LOG_BASE] = "VHOST_USER_SET_LOG_BASE",
54 [VHOST_USER_SET_LOG_FD] = "VHOST_USER_SET_LOG_FD",
55 [VHOST_USER_SET_VRING_NUM] = "VHOST_USER_SET_VRING_NUM",
56 [VHOST_USER_SET_VRING_ADDR] = "VHOST_USER_SET_VRING_ADDR",
57 [VHOST_USER_SET_VRING_BASE] = "VHOST_USER_SET_VRING_BASE",
58 [VHOST_USER_GET_VRING_BASE] = "VHOST_USER_GET_VRING_BASE",
59 [VHOST_USER_SET_VRING_KICK] = "VHOST_USER_SET_VRING_KICK",
60 [VHOST_USER_SET_VRING_CALL] = "VHOST_USER_SET_VRING_CALL",
61 [VHOST_USER_SET_VRING_ERR] = "VHOST_USER_SET_VRING_ERR",
62 [VHOST_USER_GET_PROTOCOL_FEATURES] = "VHOST_USER_GET_PROTOCOL_FEATURES",
63 [VHOST_USER_SET_PROTOCOL_FEATURES] = "VHOST_USER_SET_PROTOCOL_FEATURES",
64 [VHOST_USER_GET_QUEUE_NUM] = "VHOST_USER_GET_QUEUE_NUM",
65 [VHOST_USER_SET_VRING_ENABLE] = "VHOST_USER_SET_VRING_ENABLE",
66 [VHOST_USER_SEND_RARP] = "VHOST_USER_SEND_RARP",
67 [VHOST_USER_NET_SET_MTU] = "VHOST_USER_NET_SET_MTU",
68 [VHOST_USER_SET_SLAVE_REQ_FD] = "VHOST_USER_SET_SLAVE_REQ_FD",
69 [VHOST_USER_IOTLB_MSG] = "VHOST_USER_IOTLB_MSG",
70 [VHOST_USER_CRYPTO_CREATE_SESS] = "VHOST_USER_CRYPTO_CREATE_SESS",
71 [VHOST_USER_CRYPTO_CLOSE_SESS] = "VHOST_USER_CRYPTO_CLOSE_SESS",
80 ret = fstat(fd, &stat);
81 return ret == -1 ? (uint64_t)-1 : (uint64_t)stat.st_blksize;
85 free_mem_region(struct virtio_net *dev)
88 struct rte_vhost_mem_region *reg;
90 if (!dev || !dev->mem)
93 for (i = 0; i < dev->mem->nregions; i++) {
94 reg = &dev->mem->regions[i];
95 if (reg->host_user_addr) {
96 munmap(reg->mmap_addr, reg->mmap_size);
103 vhost_backend_cleanup(struct virtio_net *dev)
106 free_mem_region(dev);
111 free(dev->guest_pages);
112 dev->guest_pages = NULL;
115 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
119 if (dev->slave_req_fd >= 0) {
120 close(dev->slave_req_fd);
121 dev->slave_req_fd = -1;
126 * This function just returns success at the moment unless
127 * the device hasn't been initialised.
130 vhost_user_set_owner(struct virtio_net **pdev __rte_unused,
131 struct VhostUserMsg *msg __rte_unused)
137 vhost_user_reset_owner(struct virtio_net **pdev,
138 struct VhostUserMsg *msg __rte_unused)
140 struct virtio_net *dev = *pdev;
141 vhost_destroy_device_notify(dev);
143 cleanup_device(dev, 0);
149 * The features that we support are requested.
152 vhost_user_get_features(struct virtio_net **pdev, struct VhostUserMsg *msg)
154 struct virtio_net *dev = *pdev;
155 uint64_t features = 0;
157 rte_vhost_driver_get_features(dev->ifname, &features);
159 msg->payload.u64 = features;
160 msg->size = sizeof(msg->payload.u64);
162 return VH_RESULT_REPLY;
166 * The queue number that we support are requested.
169 vhost_user_get_queue_num(struct virtio_net **pdev, struct VhostUserMsg *msg)
171 struct virtio_net *dev = *pdev;
172 uint32_t queue_num = 0;
174 rte_vhost_driver_get_queue_num(dev->ifname, &queue_num);
176 msg->payload.u64 = (uint64_t)queue_num;
177 msg->size = sizeof(msg->payload.u64);
179 return VH_RESULT_REPLY;
183 * We receive the negotiated features supported by us and the virtio device.
186 vhost_user_set_features(struct virtio_net **pdev, struct VhostUserMsg *msg)
188 struct virtio_net *dev = *pdev;
189 uint64_t features = msg->payload.u64;
190 uint64_t vhost_features = 0;
191 struct rte_vdpa_device *vdpa_dev;
194 rte_vhost_driver_get_features(dev->ifname, &vhost_features);
195 if (features & ~vhost_features) {
196 RTE_LOG(ERR, VHOST_CONFIG,
197 "(%d) received invalid negotiated features.\n",
199 return VH_RESULT_ERR;
202 if (dev->flags & VIRTIO_DEV_RUNNING) {
203 if (dev->features == features)
207 * Error out if master tries to change features while device is
208 * in running state. The exception being VHOST_F_LOG_ALL, which
209 * is enabled when the live-migration starts.
211 if ((dev->features ^ features) & ~(1ULL << VHOST_F_LOG_ALL)) {
212 RTE_LOG(ERR, VHOST_CONFIG,
213 "(%d) features changed while device is running.\n",
215 return VH_RESULT_ERR;
218 if (dev->notify_ops->features_changed)
219 dev->notify_ops->features_changed(dev->vid, features);
222 dev->features = features;
224 ((1 << VIRTIO_NET_F_MRG_RXBUF) | (1ULL << VIRTIO_F_VERSION_1))) {
225 dev->vhost_hlen = sizeof(struct virtio_net_hdr_mrg_rxbuf);
227 dev->vhost_hlen = sizeof(struct virtio_net_hdr);
229 VHOST_LOG_DEBUG(VHOST_CONFIG,
230 "(%d) mergeable RX buffers %s, virtio 1 %s\n",
232 (dev->features & (1 << VIRTIO_NET_F_MRG_RXBUF)) ? "on" : "off",
233 (dev->features & (1ULL << VIRTIO_F_VERSION_1)) ? "on" : "off");
235 if ((dev->flags & VIRTIO_DEV_BUILTIN_VIRTIO_NET) &&
236 !(dev->features & (1ULL << VIRTIO_NET_F_MQ))) {
238 * Remove all but first queue pair if MQ hasn't been
239 * negotiated. This is safe because the device is not
240 * running at this stage.
242 while (dev->nr_vring > 2) {
243 struct vhost_virtqueue *vq;
245 vq = dev->virtqueue[--dev->nr_vring];
249 dev->virtqueue[dev->nr_vring] = NULL;
255 did = dev->vdpa_dev_id;
256 vdpa_dev = rte_vdpa_get_device(did);
257 if (vdpa_dev && vdpa_dev->ops->set_features)
258 vdpa_dev->ops->set_features(dev->vid);
264 * The virtio device sends us the size of the descriptor ring.
267 vhost_user_set_vring_num(struct virtio_net **pdev,
268 struct VhostUserMsg *msg)
270 struct virtio_net *dev = *pdev;
271 struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
273 vq->size = msg->payload.state.num;
275 /* VIRTIO 1.0, 2.4 Virtqueues says:
277 * Queue Size value is always a power of 2. The maximum Queue Size
280 if ((vq->size & (vq->size - 1)) || vq->size > 32768) {
281 RTE_LOG(ERR, VHOST_CONFIG,
282 "invalid virtqueue size %u\n", vq->size);
283 return VH_RESULT_ERR;
286 if (dev->dequeue_zero_copy) {
288 vq->last_zmbuf_idx = 0;
289 vq->zmbuf_size = vq->size;
290 vq->zmbufs = rte_zmalloc(NULL, vq->zmbuf_size *
291 sizeof(struct zcopy_mbuf), 0);
292 if (vq->zmbufs == NULL) {
293 RTE_LOG(WARNING, VHOST_CONFIG,
294 "failed to allocate mem for zero copy; "
295 "zero copy is force disabled\n");
296 dev->dequeue_zero_copy = 0;
298 TAILQ_INIT(&vq->zmbuf_list);
301 if (vq_is_packed(dev)) {
302 vq->shadow_used_packed = rte_malloc(NULL,
304 sizeof(struct vring_used_elem_packed),
305 RTE_CACHE_LINE_SIZE);
306 if (!vq->shadow_used_packed) {
307 RTE_LOG(ERR, VHOST_CONFIG,
308 "failed to allocate memory for shadow used ring.\n");
309 return VH_RESULT_ERR;
313 vq->shadow_used_split = rte_malloc(NULL,
314 vq->size * sizeof(struct vring_used_elem),
315 RTE_CACHE_LINE_SIZE);
316 if (!vq->shadow_used_split) {
317 RTE_LOG(ERR, VHOST_CONFIG,
318 "failed to allocate memory for shadow used ring.\n");
319 return VH_RESULT_ERR;
323 vq->batch_copy_elems = rte_malloc(NULL,
324 vq->size * sizeof(struct batch_copy_elem),
325 RTE_CACHE_LINE_SIZE);
326 if (!vq->batch_copy_elems) {
327 RTE_LOG(ERR, VHOST_CONFIG,
328 "failed to allocate memory for batching copy.\n");
329 return VH_RESULT_ERR;
336 * Reallocate virtio_dev and vhost_virtqueue data structure to make them on the
337 * same numa node as the memory of vring descriptor.
339 #ifdef RTE_LIBRTE_VHOST_NUMA
340 static struct virtio_net*
341 numa_realloc(struct virtio_net *dev, int index)
343 int oldnode, newnode;
344 struct virtio_net *old_dev;
345 struct vhost_virtqueue *old_vq, *vq;
346 struct zcopy_mbuf *new_zmbuf;
347 struct vring_used_elem *new_shadow_used_split;
348 struct vring_used_elem_packed *new_shadow_used_packed;
349 struct batch_copy_elem *new_batch_copy_elems;
353 vq = old_vq = dev->virtqueue[index];
355 ret = get_mempolicy(&newnode, NULL, 0, old_vq->desc,
356 MPOL_F_NODE | MPOL_F_ADDR);
358 /* check if we need to reallocate vq */
359 ret |= get_mempolicy(&oldnode, NULL, 0, old_vq,
360 MPOL_F_NODE | MPOL_F_ADDR);
362 RTE_LOG(ERR, VHOST_CONFIG,
363 "Unable to get vq numa information.\n");
366 if (oldnode != newnode) {
367 RTE_LOG(INFO, VHOST_CONFIG,
368 "reallocate vq from %d to %d node\n", oldnode, newnode);
369 vq = rte_malloc_socket(NULL, sizeof(*vq), 0, newnode);
373 memcpy(vq, old_vq, sizeof(*vq));
374 TAILQ_INIT(&vq->zmbuf_list);
376 if (dev->dequeue_zero_copy) {
377 new_zmbuf = rte_malloc_socket(NULL, vq->zmbuf_size *
378 sizeof(struct zcopy_mbuf), 0, newnode);
380 rte_free(vq->zmbufs);
381 vq->zmbufs = new_zmbuf;
385 if (vq_is_packed(dev)) {
386 new_shadow_used_packed = rte_malloc_socket(NULL,
388 sizeof(struct vring_used_elem_packed),
391 if (new_shadow_used_packed) {
392 rte_free(vq->shadow_used_packed);
393 vq->shadow_used_packed = new_shadow_used_packed;
396 new_shadow_used_split = rte_malloc_socket(NULL,
398 sizeof(struct vring_used_elem),
401 if (new_shadow_used_split) {
402 rte_free(vq->shadow_used_split);
403 vq->shadow_used_split = new_shadow_used_split;
407 new_batch_copy_elems = rte_malloc_socket(NULL,
408 vq->size * sizeof(struct batch_copy_elem),
411 if (new_batch_copy_elems) {
412 rte_free(vq->batch_copy_elems);
413 vq->batch_copy_elems = new_batch_copy_elems;
419 /* check if we need to reallocate dev */
420 ret = get_mempolicy(&oldnode, NULL, 0, old_dev,
421 MPOL_F_NODE | MPOL_F_ADDR);
423 RTE_LOG(ERR, VHOST_CONFIG,
424 "Unable to get dev numa information.\n");
427 if (oldnode != newnode) {
428 RTE_LOG(INFO, VHOST_CONFIG,
429 "reallocate dev from %d to %d node\n",
431 dev = rte_malloc_socket(NULL, sizeof(*dev), 0, newnode);
437 memcpy(dev, old_dev, sizeof(*dev));
442 dev->virtqueue[index] = vq;
443 vhost_devices[dev->vid] = dev;
446 vhost_user_iotlb_init(dev, index);
451 static struct virtio_net*
452 numa_realloc(struct virtio_net *dev, int index __rte_unused)
458 /* Converts QEMU virtual address to Vhost virtual address. */
460 qva_to_vva(struct virtio_net *dev, uint64_t qva, uint64_t *len)
462 struct rte_vhost_mem_region *r;
465 /* Find the region where the address lives. */
466 for (i = 0; i < dev->mem->nregions; i++) {
467 r = &dev->mem->regions[i];
469 if (qva >= r->guest_user_addr &&
470 qva < r->guest_user_addr + r->size) {
472 if (unlikely(*len > r->guest_user_addr + r->size - qva))
473 *len = r->guest_user_addr + r->size - qva;
475 return qva - r->guest_user_addr +
486 * Converts ring address to Vhost virtual address.
487 * If IOMMU is enabled, the ring address is a guest IO virtual address,
488 * else it is a QEMU virtual address.
491 ring_addr_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
492 uint64_t ra, uint64_t *size)
494 if (dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)) {
497 vva = vhost_user_iotlb_cache_find(vq, ra,
498 size, VHOST_ACCESS_RW);
500 vhost_user_iotlb_miss(dev, ra, VHOST_ACCESS_RW);
505 return qva_to_vva(dev, ra, size);
508 static struct virtio_net *
509 translate_ring_addresses(struct virtio_net *dev, int vq_index)
511 struct vhost_virtqueue *vq = dev->virtqueue[vq_index];
512 struct vhost_vring_addr *addr = &vq->ring_addrs;
515 if (vq_is_packed(dev)) {
516 len = sizeof(struct vring_packed_desc) * vq->size;
517 vq->desc_packed = (struct vring_packed_desc *)(uintptr_t)
518 ring_addr_to_vva(dev, vq, addr->desc_user_addr, &len);
519 vq->log_guest_addr = 0;
520 if (vq->desc_packed == NULL ||
521 len != sizeof(struct vring_packed_desc) *
523 RTE_LOG(DEBUG, VHOST_CONFIG,
524 "(%d) failed to map desc_packed ring.\n",
529 dev = numa_realloc(dev, vq_index);
530 vq = dev->virtqueue[vq_index];
531 addr = &vq->ring_addrs;
533 len = sizeof(struct vring_packed_desc_event);
534 vq->driver_event = (struct vring_packed_desc_event *)
535 (uintptr_t)ring_addr_to_vva(dev,
536 vq, addr->avail_user_addr, &len);
537 if (vq->driver_event == NULL ||
538 len != sizeof(struct vring_packed_desc_event)) {
539 RTE_LOG(DEBUG, VHOST_CONFIG,
540 "(%d) failed to find driver area address.\n",
545 len = sizeof(struct vring_packed_desc_event);
546 vq->device_event = (struct vring_packed_desc_event *)
547 (uintptr_t)ring_addr_to_vva(dev,
548 vq, addr->used_user_addr, &len);
549 if (vq->device_event == NULL ||
550 len != sizeof(struct vring_packed_desc_event)) {
551 RTE_LOG(DEBUG, VHOST_CONFIG,
552 "(%d) failed to find device area address.\n",
560 /* The addresses are converted from QEMU virtual to Vhost virtual. */
561 if (vq->desc && vq->avail && vq->used)
564 len = sizeof(struct vring_desc) * vq->size;
565 vq->desc = (struct vring_desc *)(uintptr_t)ring_addr_to_vva(dev,
566 vq, addr->desc_user_addr, &len);
567 if (vq->desc == 0 || len != sizeof(struct vring_desc) * vq->size) {
568 RTE_LOG(DEBUG, VHOST_CONFIG,
569 "(%d) failed to map desc ring.\n",
574 dev = numa_realloc(dev, vq_index);
575 vq = dev->virtqueue[vq_index];
576 addr = &vq->ring_addrs;
578 len = sizeof(struct vring_avail) + sizeof(uint16_t) * vq->size;
579 vq->avail = (struct vring_avail *)(uintptr_t)ring_addr_to_vva(dev,
580 vq, addr->avail_user_addr, &len);
581 if (vq->avail == 0 ||
582 len != sizeof(struct vring_avail) +
583 sizeof(uint16_t) * vq->size) {
584 RTE_LOG(DEBUG, VHOST_CONFIG,
585 "(%d) failed to map avail ring.\n",
590 len = sizeof(struct vring_used) +
591 sizeof(struct vring_used_elem) * vq->size;
592 vq->used = (struct vring_used *)(uintptr_t)ring_addr_to_vva(dev,
593 vq, addr->used_user_addr, &len);
594 if (vq->used == 0 || len != sizeof(struct vring_used) +
595 sizeof(struct vring_used_elem) * vq->size) {
596 RTE_LOG(DEBUG, VHOST_CONFIG,
597 "(%d) failed to map used ring.\n",
602 if (vq->last_used_idx != vq->used->idx) {
603 RTE_LOG(WARNING, VHOST_CONFIG,
604 "last_used_idx (%u) and vq->used->idx (%u) mismatches; "
605 "some packets maybe resent for Tx and dropped for Rx\n",
606 vq->last_used_idx, vq->used->idx);
607 vq->last_used_idx = vq->used->idx;
608 vq->last_avail_idx = vq->used->idx;
611 vq->log_guest_addr = addr->log_guest_addr;
613 VHOST_LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address desc: %p\n",
615 VHOST_LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address avail: %p\n",
616 dev->vid, vq->avail);
617 VHOST_LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address used: %p\n",
619 VHOST_LOG_DEBUG(VHOST_CONFIG, "(%d) log_guest_addr: %" PRIx64 "\n",
620 dev->vid, vq->log_guest_addr);
626 * The virtio device sends us the desc, used and avail ring addresses.
627 * This function then converts these to our address space.
630 vhost_user_set_vring_addr(struct virtio_net **pdev, struct VhostUserMsg *msg)
632 struct virtio_net *dev = *pdev;
633 struct vhost_virtqueue *vq;
634 struct vhost_vring_addr *addr = &msg->payload.addr;
636 if (dev->mem == NULL)
637 return VH_RESULT_ERR;
639 /* addr->index refers to the queue index. The txq 1, rxq is 0. */
640 vq = dev->virtqueue[msg->payload.addr.index];
643 * Rings addresses should not be interpreted as long as the ring is not
644 * started and enabled
646 memcpy(&vq->ring_addrs, addr, sizeof(*addr));
648 vring_invalidate(dev, vq);
650 if (vq->enabled && (dev->features &
651 (1ULL << VHOST_USER_F_PROTOCOL_FEATURES))) {
652 dev = translate_ring_addresses(dev, msg->payload.addr.index);
654 return VH_RESULT_ERR;
663 * The virtio device sends us the available ring last used index.
666 vhost_user_set_vring_base(struct virtio_net **pdev,
667 struct VhostUserMsg *msg)
669 struct virtio_net *dev = *pdev;
670 dev->virtqueue[msg->payload.state.index]->last_used_idx =
671 msg->payload.state.num;
672 dev->virtqueue[msg->payload.state.index]->last_avail_idx =
673 msg->payload.state.num;
679 add_one_guest_page(struct virtio_net *dev, uint64_t guest_phys_addr,
680 uint64_t host_phys_addr, uint64_t size)
682 struct guest_page *page, *last_page;
684 if (dev->nr_guest_pages == dev->max_guest_pages) {
685 dev->max_guest_pages *= 2;
686 dev->guest_pages = realloc(dev->guest_pages,
687 dev->max_guest_pages * sizeof(*page));
688 if (!dev->guest_pages) {
689 RTE_LOG(ERR, VHOST_CONFIG, "cannot realloc guest_pages\n");
694 if (dev->nr_guest_pages > 0) {
695 last_page = &dev->guest_pages[dev->nr_guest_pages - 1];
696 /* merge if the two pages are continuous */
697 if (host_phys_addr == last_page->host_phys_addr +
699 last_page->size += size;
704 page = &dev->guest_pages[dev->nr_guest_pages++];
705 page->guest_phys_addr = guest_phys_addr;
706 page->host_phys_addr = host_phys_addr;
713 add_guest_pages(struct virtio_net *dev, struct rte_vhost_mem_region *reg,
716 uint64_t reg_size = reg->size;
717 uint64_t host_user_addr = reg->host_user_addr;
718 uint64_t guest_phys_addr = reg->guest_phys_addr;
719 uint64_t host_phys_addr;
722 host_phys_addr = rte_mem_virt2iova((void *)(uintptr_t)host_user_addr);
723 size = page_size - (guest_phys_addr & (page_size - 1));
724 size = RTE_MIN(size, reg_size);
726 if (add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size) < 0)
729 host_user_addr += size;
730 guest_phys_addr += size;
733 while (reg_size > 0) {
734 size = RTE_MIN(reg_size, page_size);
735 host_phys_addr = rte_mem_virt2iova((void *)(uintptr_t)
737 if (add_one_guest_page(dev, guest_phys_addr, host_phys_addr,
741 host_user_addr += size;
742 guest_phys_addr += size;
749 #ifdef RTE_LIBRTE_VHOST_DEBUG
750 /* TODO: enable it only in debug mode? */
752 dump_guest_pages(struct virtio_net *dev)
755 struct guest_page *page;
757 for (i = 0; i < dev->nr_guest_pages; i++) {
758 page = &dev->guest_pages[i];
760 RTE_LOG(INFO, VHOST_CONFIG,
761 "guest physical page region %u\n"
762 "\t guest_phys_addr: %" PRIx64 "\n"
763 "\t host_phys_addr : %" PRIx64 "\n"
764 "\t size : %" PRIx64 "\n",
766 page->guest_phys_addr,
767 page->host_phys_addr,
772 #define dump_guest_pages(dev)
776 vhost_memory_changed(struct VhostUserMemory *new,
777 struct rte_vhost_memory *old)
781 if (new->nregions != old->nregions)
784 for (i = 0; i < new->nregions; ++i) {
785 VhostUserMemoryRegion *new_r = &new->regions[i];
786 struct rte_vhost_mem_region *old_r = &old->regions[i];
788 if (new_r->guest_phys_addr != old_r->guest_phys_addr)
790 if (new_r->memory_size != old_r->size)
792 if (new_r->userspace_addr != old_r->guest_user_addr)
800 vhost_user_set_mem_table(struct virtio_net **pdev, struct VhostUserMsg *msg)
802 struct virtio_net *dev = *pdev;
803 struct VhostUserMemory memory = msg->payload.memory;
804 struct rte_vhost_mem_region *reg;
807 uint64_t mmap_offset;
813 if (memory.nregions > VHOST_MEMORY_MAX_NREGIONS) {
814 RTE_LOG(ERR, VHOST_CONFIG,
815 "too many memory regions (%u)\n", memory.nregions);
816 return VH_RESULT_ERR;
819 if (dev->mem && !vhost_memory_changed(&memory, dev->mem)) {
820 RTE_LOG(INFO, VHOST_CONFIG,
821 "(%d) memory regions not changed\n", dev->vid);
823 for (i = 0; i < memory.nregions; i++)
830 free_mem_region(dev);
835 /* Flush IOTLB cache as previous HVAs are now invalid */
836 if (dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM))
837 for (i = 0; i < dev->nr_vring; i++)
838 vhost_user_iotlb_flush_all(dev->virtqueue[i]);
840 dev->nr_guest_pages = 0;
841 if (!dev->guest_pages) {
842 dev->max_guest_pages = 8;
843 dev->guest_pages = malloc(dev->max_guest_pages *
844 sizeof(struct guest_page));
845 if (dev->guest_pages == NULL) {
846 RTE_LOG(ERR, VHOST_CONFIG,
847 "(%d) failed to allocate memory "
848 "for dev->guest_pages\n",
850 return VH_RESULT_ERR;
854 dev->mem = rte_zmalloc("vhost-mem-table", sizeof(struct rte_vhost_memory) +
855 sizeof(struct rte_vhost_mem_region) * memory.nregions, 0);
856 if (dev->mem == NULL) {
857 RTE_LOG(ERR, VHOST_CONFIG,
858 "(%d) failed to allocate memory for dev->mem\n",
860 return VH_RESULT_ERR;
862 dev->mem->nregions = memory.nregions;
864 for (i = 0; i < memory.nregions; i++) {
866 reg = &dev->mem->regions[i];
868 reg->guest_phys_addr = memory.regions[i].guest_phys_addr;
869 reg->guest_user_addr = memory.regions[i].userspace_addr;
870 reg->size = memory.regions[i].memory_size;
873 mmap_offset = memory.regions[i].mmap_offset;
875 /* Check for memory_size + mmap_offset overflow */
876 if (mmap_offset >= -reg->size) {
877 RTE_LOG(ERR, VHOST_CONFIG,
878 "mmap_offset (%#"PRIx64") and memory_size "
879 "(%#"PRIx64") overflow\n",
880 mmap_offset, reg->size);
884 mmap_size = reg->size + mmap_offset;
886 /* mmap() without flag of MAP_ANONYMOUS, should be called
887 * with length argument aligned with hugepagesz at older
888 * longterm version Linux, like 2.6.32 and 3.2.72, or
889 * mmap() will fail with EINVAL.
891 * to avoid failure, make sure in caller to keep length
894 alignment = get_blk_size(fd);
895 if (alignment == (uint64_t)-1) {
896 RTE_LOG(ERR, VHOST_CONFIG,
897 "couldn't get hugepage size through fstat\n");
900 mmap_size = RTE_ALIGN_CEIL(mmap_size, alignment);
902 populate = (dev->dequeue_zero_copy) ? MAP_POPULATE : 0;
903 mmap_addr = mmap(NULL, mmap_size, PROT_READ | PROT_WRITE,
904 MAP_SHARED | populate, fd, 0);
906 if (mmap_addr == MAP_FAILED) {
907 RTE_LOG(ERR, VHOST_CONFIG,
908 "mmap region %u failed.\n", i);
912 reg->mmap_addr = mmap_addr;
913 reg->mmap_size = mmap_size;
914 reg->host_user_addr = (uint64_t)(uintptr_t)mmap_addr +
917 if (dev->dequeue_zero_copy)
918 if (add_guest_pages(dev, reg, alignment) < 0) {
919 RTE_LOG(ERR, VHOST_CONFIG,
920 "adding guest pages to region %u failed.\n",
925 RTE_LOG(INFO, VHOST_CONFIG,
926 "guest memory region %u, size: 0x%" PRIx64 "\n"
927 "\t guest physical addr: 0x%" PRIx64 "\n"
928 "\t guest virtual addr: 0x%" PRIx64 "\n"
929 "\t host virtual addr: 0x%" PRIx64 "\n"
930 "\t mmap addr : 0x%" PRIx64 "\n"
931 "\t mmap size : 0x%" PRIx64 "\n"
932 "\t mmap align: 0x%" PRIx64 "\n"
933 "\t mmap off : 0x%" PRIx64 "\n",
935 reg->guest_phys_addr,
936 reg->guest_user_addr,
938 (uint64_t)(uintptr_t)mmap_addr,
944 for (i = 0; i < dev->nr_vring; i++) {
945 struct vhost_virtqueue *vq = dev->virtqueue[i];
947 if (vq->desc || vq->avail || vq->used) {
949 * If the memory table got updated, the ring addresses
950 * need to be translated again as virtual addresses have
953 vring_invalidate(dev, vq);
955 dev = translate_ring_addresses(dev, i);
965 dump_guest_pages(dev);
970 free_mem_region(dev);
973 return VH_RESULT_ERR;
977 vq_is_ready(struct virtio_net *dev, struct vhost_virtqueue *vq)
984 if (vq_is_packed(dev))
985 rings_ok = !!vq->desc_packed;
987 rings_ok = vq->desc && vq->avail && vq->used;
990 vq->kickfd != VIRTIO_UNINITIALIZED_EVENTFD &&
991 vq->callfd != VIRTIO_UNINITIALIZED_EVENTFD;
995 virtio_is_ready(struct virtio_net *dev)
997 struct vhost_virtqueue *vq;
1000 if (dev->nr_vring == 0)
1003 for (i = 0; i < dev->nr_vring; i++) {
1004 vq = dev->virtqueue[i];
1006 if (!vq_is_ready(dev, vq))
1010 RTE_LOG(INFO, VHOST_CONFIG,
1011 "virtio is now ready for processing.\n");
1016 vhost_user_set_vring_call(struct virtio_net **pdev, struct VhostUserMsg *msg)
1018 struct virtio_net *dev = *pdev;
1019 struct vhost_vring_file file;
1020 struct vhost_virtqueue *vq;
1022 file.index = msg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
1023 if (msg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
1024 file.fd = VIRTIO_INVALID_EVENTFD;
1026 file.fd = msg->fds[0];
1027 RTE_LOG(INFO, VHOST_CONFIG,
1028 "vring call idx:%d file:%d\n", file.index, file.fd);
1030 vq = dev->virtqueue[file.index];
1031 if (vq->callfd >= 0)
1034 vq->callfd = file.fd;
1036 return VH_RESULT_OK;
1039 static int vhost_user_set_vring_err(struct virtio_net **pdev __rte_unused,
1040 struct VhostUserMsg *msg)
1042 if (!(msg->payload.u64 & VHOST_USER_VRING_NOFD_MASK))
1044 RTE_LOG(INFO, VHOST_CONFIG, "not implemented\n");
1046 return VH_RESULT_OK;
1050 vhost_user_set_vring_kick(struct virtio_net **pdev, struct VhostUserMsg *msg)
1052 struct virtio_net *dev = *pdev;
1053 struct vhost_vring_file file;
1054 struct vhost_virtqueue *vq;
1056 file.index = msg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
1057 if (msg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
1058 file.fd = VIRTIO_INVALID_EVENTFD;
1060 file.fd = msg->fds[0];
1061 RTE_LOG(INFO, VHOST_CONFIG,
1062 "vring kick idx:%d file:%d\n", file.index, file.fd);
1064 /* Interpret ring addresses only when ring is started. */
1065 dev = translate_ring_addresses(dev, file.index);
1067 return VH_RESULT_ERR;
1071 vq = dev->virtqueue[file.index];
1074 * When VHOST_USER_F_PROTOCOL_FEATURES is not negotiated,
1075 * the ring starts already enabled. Otherwise, it is enabled via
1076 * the SET_VRING_ENABLE message.
1078 if (!(dev->features & (1ULL << VHOST_USER_F_PROTOCOL_FEATURES)))
1081 if (vq->kickfd >= 0)
1083 vq->kickfd = file.fd;
1085 return VH_RESULT_OK;
1089 free_zmbufs(struct vhost_virtqueue *vq)
1091 struct zcopy_mbuf *zmbuf, *next;
1093 for (zmbuf = TAILQ_FIRST(&vq->zmbuf_list);
1094 zmbuf != NULL; zmbuf = next) {
1095 next = TAILQ_NEXT(zmbuf, next);
1097 rte_pktmbuf_free(zmbuf->mbuf);
1098 TAILQ_REMOVE(&vq->zmbuf_list, zmbuf, next);
1101 rte_free(vq->zmbufs);
1105 * when virtio is stopped, qemu will send us the GET_VRING_BASE message.
1108 vhost_user_get_vring_base(struct virtio_net **pdev,
1109 struct VhostUserMsg *msg)
1111 struct virtio_net *dev = *pdev;
1112 struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
1114 /* We have to stop the queue (virtio) if it is running. */
1115 vhost_destroy_device_notify(dev);
1117 dev->flags &= ~VIRTIO_DEV_READY;
1118 dev->flags &= ~VIRTIO_DEV_VDPA_CONFIGURED;
1120 /* Here we are safe to get the last avail index */
1121 msg->payload.state.num = vq->last_avail_idx;
1123 RTE_LOG(INFO, VHOST_CONFIG,
1124 "vring base idx:%d file:%d\n", msg->payload.state.index,
1125 msg->payload.state.num);
1127 * Based on current qemu vhost-user implementation, this message is
1128 * sent and only sent in vhost_vring_stop.
1129 * TODO: cleanup the vring, it isn't usable since here.
1131 if (vq->kickfd >= 0)
1134 vq->kickfd = VIRTIO_UNINITIALIZED_EVENTFD;
1136 if (vq->callfd >= 0)
1139 vq->callfd = VIRTIO_UNINITIALIZED_EVENTFD;
1141 if (dev->dequeue_zero_copy)
1143 if (vq_is_packed(dev)) {
1144 rte_free(vq->shadow_used_packed);
1145 vq->shadow_used_packed = NULL;
1147 rte_free(vq->shadow_used_split);
1148 vq->shadow_used_split = NULL;
1151 rte_free(vq->batch_copy_elems);
1152 vq->batch_copy_elems = NULL;
1154 msg->size = sizeof(msg->payload.state);
1156 return VH_RESULT_REPLY;
1160 * when virtio queues are ready to work, qemu will send us to
1161 * enable the virtio queue pair.
1164 vhost_user_set_vring_enable(struct virtio_net **pdev,
1165 struct VhostUserMsg *msg)
1167 struct virtio_net *dev = *pdev;
1168 int enable = (int)msg->payload.state.num;
1169 int index = (int)msg->payload.state.index;
1170 struct rte_vdpa_device *vdpa_dev;
1173 RTE_LOG(INFO, VHOST_CONFIG,
1174 "set queue enable: %d to qp idx: %d\n",
1177 did = dev->vdpa_dev_id;
1178 vdpa_dev = rte_vdpa_get_device(did);
1179 if (vdpa_dev && vdpa_dev->ops->set_vring_state)
1180 vdpa_dev->ops->set_vring_state(dev->vid, index, enable);
1182 if (dev->notify_ops->vring_state_changed)
1183 dev->notify_ops->vring_state_changed(dev->vid,
1186 dev->virtqueue[index]->enabled = enable;
1188 return VH_RESULT_OK;
1192 vhost_user_get_protocol_features(struct virtio_net **pdev,
1193 struct VhostUserMsg *msg)
1195 struct virtio_net *dev = *pdev;
1196 uint64_t features, protocol_features;
1198 rte_vhost_driver_get_features(dev->ifname, &features);
1199 rte_vhost_driver_get_protocol_features(dev->ifname, &protocol_features);
1202 * REPLY_ACK protocol feature is only mandatory for now
1203 * for IOMMU feature. If IOMMU is explicitly disabled by the
1204 * application, disable also REPLY_ACK feature for older buggy
1205 * Qemu versions (from v2.7.0 to v2.9.0).
1207 if (!(features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)))
1208 protocol_features &= ~(1ULL << VHOST_USER_PROTOCOL_F_REPLY_ACK);
1210 msg->payload.u64 = protocol_features;
1211 msg->size = sizeof(msg->payload.u64);
1213 return VH_RESULT_REPLY;
1217 vhost_user_set_protocol_features(struct virtio_net **pdev,
1218 struct VhostUserMsg *msg)
1220 struct virtio_net *dev = *pdev;
1221 uint64_t protocol_features = msg->payload.u64;
1222 if (protocol_features & ~VHOST_USER_PROTOCOL_FEATURES) {
1223 RTE_LOG(ERR, VHOST_CONFIG,
1224 "(%d) received invalid protocol features.\n",
1226 return VH_RESULT_ERR;
1229 dev->protocol_features = protocol_features;
1231 return VH_RESULT_OK;
1235 vhost_user_set_log_base(struct virtio_net **pdev, struct VhostUserMsg *msg)
1237 struct virtio_net *dev = *pdev;
1238 int fd = msg->fds[0];
1243 RTE_LOG(ERR, VHOST_CONFIG, "invalid log fd: %d\n", fd);
1244 return VH_RESULT_ERR;
1247 if (msg->size != sizeof(VhostUserLog)) {
1248 RTE_LOG(ERR, VHOST_CONFIG,
1249 "invalid log base msg size: %"PRId32" != %d\n",
1250 msg->size, (int)sizeof(VhostUserLog));
1251 return VH_RESULT_ERR;
1254 size = msg->payload.log.mmap_size;
1255 off = msg->payload.log.mmap_offset;
1257 /* Don't allow mmap_offset to point outside the mmap region */
1259 RTE_LOG(ERR, VHOST_CONFIG,
1260 "log offset %#"PRIx64" exceeds log size %#"PRIx64"\n",
1262 return VH_RESULT_ERR;
1265 RTE_LOG(INFO, VHOST_CONFIG,
1266 "log mmap size: %"PRId64", offset: %"PRId64"\n",
1270 * mmap from 0 to workaround a hugepage mmap bug: mmap will
1271 * fail when offset is not page size aligned.
1273 addr = mmap(0, size + off, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
1275 if (addr == MAP_FAILED) {
1276 RTE_LOG(ERR, VHOST_CONFIG, "mmap log base failed!\n");
1277 return VH_RESULT_ERR;
1281 * Free previously mapped log memory on occasionally
1282 * multiple VHOST_USER_SET_LOG_BASE.
1284 if (dev->log_addr) {
1285 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
1287 dev->log_addr = (uint64_t)(uintptr_t)addr;
1288 dev->log_base = dev->log_addr + off;
1289 dev->log_size = size;
1292 * The spec is not clear about it (yet), but QEMU doesn't expect
1293 * any payload in the reply.
1297 return VH_RESULT_REPLY;
1300 static int vhost_user_set_log_fd(struct virtio_net **pdev __rte_unused,
1301 struct VhostUserMsg *msg)
1304 RTE_LOG(INFO, VHOST_CONFIG, "not implemented.\n");
1306 return VH_RESULT_OK;
1310 * An rarp packet is constructed and broadcasted to notify switches about
1311 * the new location of the migrated VM, so that packets from outside will
1312 * not be lost after migration.
1314 * However, we don't actually "send" a rarp packet here, instead, we set
1315 * a flag 'broadcast_rarp' to let rte_vhost_dequeue_burst() inject it.
1318 vhost_user_send_rarp(struct virtio_net **pdev, struct VhostUserMsg *msg)
1320 struct virtio_net *dev = *pdev;
1321 uint8_t *mac = (uint8_t *)&msg->payload.u64;
1322 struct rte_vdpa_device *vdpa_dev;
1325 RTE_LOG(DEBUG, VHOST_CONFIG,
1326 ":: mac: %02x:%02x:%02x:%02x:%02x:%02x\n",
1327 mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
1328 memcpy(dev->mac.addr_bytes, mac, 6);
1331 * Set the flag to inject a RARP broadcast packet at
1332 * rte_vhost_dequeue_burst().
1334 * rte_smp_wmb() is for making sure the mac is copied
1335 * before the flag is set.
1338 rte_atomic16_set(&dev->broadcast_rarp, 1);
1339 did = dev->vdpa_dev_id;
1340 vdpa_dev = rte_vdpa_get_device(did);
1341 if (vdpa_dev && vdpa_dev->ops->migration_done)
1342 vdpa_dev->ops->migration_done(dev->vid);
1344 return VH_RESULT_OK;
1348 vhost_user_net_set_mtu(struct virtio_net **pdev, struct VhostUserMsg *msg)
1350 struct virtio_net *dev = *pdev;
1351 if (msg->payload.u64 < VIRTIO_MIN_MTU ||
1352 msg->payload.u64 > VIRTIO_MAX_MTU) {
1353 RTE_LOG(ERR, VHOST_CONFIG, "Invalid MTU size (%"PRIu64")\n",
1356 return VH_RESULT_ERR;
1359 dev->mtu = msg->payload.u64;
1361 return VH_RESULT_OK;
1365 vhost_user_set_req_fd(struct virtio_net **pdev, struct VhostUserMsg *msg)
1367 struct virtio_net *dev = *pdev;
1368 int fd = msg->fds[0];
1371 RTE_LOG(ERR, VHOST_CONFIG,
1372 "Invalid file descriptor for slave channel (%d)\n",
1374 return VH_RESULT_ERR;
1377 dev->slave_req_fd = fd;
1379 return VH_RESULT_OK;
1383 is_vring_iotlb_update(struct vhost_virtqueue *vq, struct vhost_iotlb_msg *imsg)
1385 struct vhost_vring_addr *ra;
1386 uint64_t start, end;
1389 end = start + imsg->size;
1391 ra = &vq->ring_addrs;
1392 if (ra->desc_user_addr >= start && ra->desc_user_addr < end)
1394 if (ra->avail_user_addr >= start && ra->avail_user_addr < end)
1396 if (ra->used_user_addr >= start && ra->used_user_addr < end)
1403 is_vring_iotlb_invalidate(struct vhost_virtqueue *vq,
1404 struct vhost_iotlb_msg *imsg)
1406 uint64_t istart, iend, vstart, vend;
1408 istart = imsg->iova;
1409 iend = istart + imsg->size - 1;
1411 vstart = (uintptr_t)vq->desc;
1412 vend = vstart + sizeof(struct vring_desc) * vq->size - 1;
1413 if (vstart <= iend && istart <= vend)
1416 vstart = (uintptr_t)vq->avail;
1417 vend = vstart + sizeof(struct vring_avail);
1418 vend += sizeof(uint16_t) * vq->size - 1;
1419 if (vstart <= iend && istart <= vend)
1422 vstart = (uintptr_t)vq->used;
1423 vend = vstart + sizeof(struct vring_used);
1424 vend += sizeof(struct vring_used_elem) * vq->size - 1;
1425 if (vstart <= iend && istart <= vend)
1432 vhost_user_iotlb_msg(struct virtio_net **pdev, struct VhostUserMsg *msg)
1434 struct virtio_net *dev = *pdev;
1435 struct vhost_iotlb_msg *imsg = &msg->payload.iotlb;
1439 switch (imsg->type) {
1440 case VHOST_IOTLB_UPDATE:
1442 vva = qva_to_vva(dev, imsg->uaddr, &len);
1444 return VH_RESULT_ERR;
1446 for (i = 0; i < dev->nr_vring; i++) {
1447 struct vhost_virtqueue *vq = dev->virtqueue[i];
1449 vhost_user_iotlb_cache_insert(vq, imsg->iova, vva,
1452 if (is_vring_iotlb_update(vq, imsg))
1453 *pdev = dev = translate_ring_addresses(dev, i);
1456 case VHOST_IOTLB_INVALIDATE:
1457 for (i = 0; i < dev->nr_vring; i++) {
1458 struct vhost_virtqueue *vq = dev->virtqueue[i];
1460 vhost_user_iotlb_cache_remove(vq, imsg->iova,
1463 if (is_vring_iotlb_invalidate(vq, imsg))
1464 vring_invalidate(dev, vq);
1468 RTE_LOG(ERR, VHOST_CONFIG, "Invalid IOTLB message type (%d)\n",
1470 return VH_RESULT_ERR;
1473 return VH_RESULT_OK;
1476 typedef int (*vhost_message_handler_t)(struct virtio_net **pdev,
1477 struct VhostUserMsg *msg);
1478 static vhost_message_handler_t vhost_message_handlers[VHOST_USER_MAX] = {
1479 [VHOST_USER_NONE] = NULL,
1480 [VHOST_USER_GET_FEATURES] = vhost_user_get_features,
1481 [VHOST_USER_SET_FEATURES] = vhost_user_set_features,
1482 [VHOST_USER_SET_OWNER] = vhost_user_set_owner,
1483 [VHOST_USER_RESET_OWNER] = vhost_user_reset_owner,
1484 [VHOST_USER_SET_MEM_TABLE] = vhost_user_set_mem_table,
1485 [VHOST_USER_SET_LOG_BASE] = vhost_user_set_log_base,
1486 [VHOST_USER_SET_LOG_FD] = vhost_user_set_log_fd,
1487 [VHOST_USER_SET_VRING_NUM] = vhost_user_set_vring_num,
1488 [VHOST_USER_SET_VRING_ADDR] = vhost_user_set_vring_addr,
1489 [VHOST_USER_SET_VRING_BASE] = vhost_user_set_vring_base,
1490 [VHOST_USER_GET_VRING_BASE] = vhost_user_get_vring_base,
1491 [VHOST_USER_SET_VRING_KICK] = vhost_user_set_vring_kick,
1492 [VHOST_USER_SET_VRING_CALL] = vhost_user_set_vring_call,
1493 [VHOST_USER_SET_VRING_ERR] = vhost_user_set_vring_err,
1494 [VHOST_USER_GET_PROTOCOL_FEATURES] = vhost_user_get_protocol_features,
1495 [VHOST_USER_SET_PROTOCOL_FEATURES] = vhost_user_set_protocol_features,
1496 [VHOST_USER_GET_QUEUE_NUM] = vhost_user_get_queue_num,
1497 [VHOST_USER_SET_VRING_ENABLE] = vhost_user_set_vring_enable,
1498 [VHOST_USER_SEND_RARP] = vhost_user_send_rarp,
1499 [VHOST_USER_NET_SET_MTU] = vhost_user_net_set_mtu,
1500 [VHOST_USER_SET_SLAVE_REQ_FD] = vhost_user_set_req_fd,
1501 [VHOST_USER_IOTLB_MSG] = vhost_user_iotlb_msg,
1505 /* return bytes# of read on success or negative val on failure. */
1507 read_vhost_message(int sockfd, struct VhostUserMsg *msg)
1511 ret = read_fd_message(sockfd, (char *)msg, VHOST_USER_HDR_SIZE,
1512 msg->fds, VHOST_MEMORY_MAX_NREGIONS, &msg->fd_num);
1516 if (msg && msg->size) {
1517 if (msg->size > sizeof(msg->payload)) {
1518 RTE_LOG(ERR, VHOST_CONFIG,
1519 "invalid msg size: %d\n", msg->size);
1522 ret = read(sockfd, &msg->payload, msg->size);
1525 if (ret != (int)msg->size) {
1526 RTE_LOG(ERR, VHOST_CONFIG,
1527 "read control message failed\n");
1536 send_vhost_message(int sockfd, struct VhostUserMsg *msg, int *fds, int fd_num)
1541 return send_fd_message(sockfd, (char *)msg,
1542 VHOST_USER_HDR_SIZE + msg->size, fds, fd_num);
1546 send_vhost_reply(int sockfd, struct VhostUserMsg *msg)
1551 msg->flags &= ~VHOST_USER_VERSION_MASK;
1552 msg->flags &= ~VHOST_USER_NEED_REPLY;
1553 msg->flags |= VHOST_USER_VERSION;
1554 msg->flags |= VHOST_USER_REPLY_MASK;
1556 return send_vhost_message(sockfd, msg, NULL, 0);
1560 send_vhost_slave_message(struct virtio_net *dev, struct VhostUserMsg *msg,
1561 int *fds, int fd_num)
1565 if (msg->flags & VHOST_USER_NEED_REPLY)
1566 rte_spinlock_lock(&dev->slave_req_lock);
1568 ret = send_vhost_message(dev->slave_req_fd, msg, fds, fd_num);
1569 if (ret < 0 && (msg->flags & VHOST_USER_NEED_REPLY))
1570 rte_spinlock_unlock(&dev->slave_req_lock);
1576 * Allocate a queue pair if it hasn't been allocated yet
1579 vhost_user_check_and_alloc_queue_pair(struct virtio_net *dev,
1580 struct VhostUserMsg *msg)
1584 switch (msg->request.master) {
1585 case VHOST_USER_SET_VRING_KICK:
1586 case VHOST_USER_SET_VRING_CALL:
1587 case VHOST_USER_SET_VRING_ERR:
1588 vring_idx = msg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
1590 case VHOST_USER_SET_VRING_NUM:
1591 case VHOST_USER_SET_VRING_BASE:
1592 case VHOST_USER_SET_VRING_ENABLE:
1593 vring_idx = msg->payload.state.index;
1595 case VHOST_USER_SET_VRING_ADDR:
1596 vring_idx = msg->payload.addr.index;
1602 if (vring_idx >= VHOST_MAX_VRING) {
1603 RTE_LOG(ERR, VHOST_CONFIG,
1604 "invalid vring index: %u\n", vring_idx);
1608 if (dev->virtqueue[vring_idx])
1611 return alloc_vring_queue(dev, vring_idx);
1615 vhost_user_lock_all_queue_pairs(struct virtio_net *dev)
1618 unsigned int vq_num = 0;
1620 while (vq_num < dev->nr_vring) {
1621 struct vhost_virtqueue *vq = dev->virtqueue[i];
1624 rte_spinlock_lock(&vq->access_lock);
1632 vhost_user_unlock_all_queue_pairs(struct virtio_net *dev)
1635 unsigned int vq_num = 0;
1637 while (vq_num < dev->nr_vring) {
1638 struct vhost_virtqueue *vq = dev->virtqueue[i];
1641 rte_spinlock_unlock(&vq->access_lock);
1649 vhost_user_msg_handler(int vid, int fd)
1651 struct virtio_net *dev;
1652 struct VhostUserMsg msg;
1653 struct rte_vdpa_device *vdpa_dev;
1656 int unlock_required = 0;
1657 uint32_t skip_master = 0;
1660 dev = get_device(vid);
1664 if (!dev->notify_ops) {
1665 dev->notify_ops = vhost_driver_callback_get(dev->ifname);
1666 if (!dev->notify_ops) {
1667 RTE_LOG(ERR, VHOST_CONFIG,
1668 "failed to get callback ops for driver %s\n",
1674 ret = read_vhost_message(fd, &msg);
1675 if (ret <= 0 || msg.request.master >= VHOST_USER_MAX) {
1677 RTE_LOG(ERR, VHOST_CONFIG,
1678 "vhost read message failed\n");
1680 RTE_LOG(INFO, VHOST_CONFIG,
1681 "vhost peer closed\n");
1683 RTE_LOG(ERR, VHOST_CONFIG,
1684 "vhost read incorrect message\n");
1690 if (msg.request.master != VHOST_USER_IOTLB_MSG)
1691 RTE_LOG(INFO, VHOST_CONFIG, "read message %s\n",
1692 vhost_message_str[msg.request.master]);
1694 RTE_LOG(DEBUG, VHOST_CONFIG, "read message %s\n",
1695 vhost_message_str[msg.request.master]);
1697 ret = vhost_user_check_and_alloc_queue_pair(dev, &msg);
1699 RTE_LOG(ERR, VHOST_CONFIG,
1700 "failed to alloc queue\n");
1705 * Note: we don't lock all queues on VHOST_USER_GET_VRING_BASE
1706 * and VHOST_USER_RESET_OWNER, since it is sent when virtio stops
1707 * and device is destroyed. destroy_device waits for queues to be
1708 * inactive, so it is safe. Otherwise taking the access_lock
1709 * would cause a dead lock.
1711 switch (msg.request.master) {
1712 case VHOST_USER_SET_FEATURES:
1713 case VHOST_USER_SET_PROTOCOL_FEATURES:
1714 case VHOST_USER_SET_OWNER:
1715 case VHOST_USER_SET_MEM_TABLE:
1716 case VHOST_USER_SET_LOG_BASE:
1717 case VHOST_USER_SET_LOG_FD:
1718 case VHOST_USER_SET_VRING_NUM:
1719 case VHOST_USER_SET_VRING_ADDR:
1720 case VHOST_USER_SET_VRING_BASE:
1721 case VHOST_USER_SET_VRING_KICK:
1722 case VHOST_USER_SET_VRING_CALL:
1723 case VHOST_USER_SET_VRING_ERR:
1724 case VHOST_USER_SET_VRING_ENABLE:
1725 case VHOST_USER_SEND_RARP:
1726 case VHOST_USER_NET_SET_MTU:
1727 case VHOST_USER_SET_SLAVE_REQ_FD:
1728 vhost_user_lock_all_queue_pairs(dev);
1729 unlock_required = 1;
1736 if (dev->extern_ops.pre_msg_handle) {
1737 ret = (*dev->extern_ops.pre_msg_handle)(dev->vid,
1738 (void *)&msg, &skip_master);
1739 if (ret == VH_RESULT_ERR)
1741 else if (ret == VH_RESULT_REPLY)
1742 send_vhost_reply(fd, &msg);
1745 goto skip_to_post_handle;
1748 request = msg.request.master;
1749 if (request > VHOST_USER_NONE && request < VHOST_USER_MAX) {
1750 if (!vhost_message_handlers[request])
1751 goto skip_to_post_handle;
1752 ret = vhost_message_handlers[request](&dev, &msg);
1756 RTE_LOG(ERR, VHOST_CONFIG,
1757 "Processing %s failed.\n",
1758 vhost_message_str[request]);
1761 RTE_LOG(DEBUG, VHOST_CONFIG,
1762 "Processing %s succeeded.\n",
1763 vhost_message_str[request]);
1765 case VH_RESULT_REPLY:
1766 RTE_LOG(DEBUG, VHOST_CONFIG,
1767 "Processing %s succeeded and needs reply.\n",
1768 vhost_message_str[request]);
1769 send_vhost_reply(fd, &msg);
1773 RTE_LOG(ERR, VHOST_CONFIG,
1774 "Requested invalid message type %d.\n", request);
1775 ret = VH_RESULT_ERR;
1778 skip_to_post_handle:
1779 if (ret != VH_RESULT_ERR && dev->extern_ops.post_msg_handle) {
1780 ret = (*dev->extern_ops.post_msg_handle)(
1781 dev->vid, (void *)&msg);
1782 if (ret == VH_RESULT_ERR)
1784 else if (ret == VH_RESULT_REPLY)
1785 send_vhost_reply(fd, &msg);
1789 if (unlock_required)
1790 vhost_user_unlock_all_queue_pairs(dev);
1793 * If the request required a reply that was already sent,
1794 * this optional reply-ack won't be sent as the
1795 * VHOST_USER_NEED_REPLY was cleared in send_vhost_reply().
1797 if (msg.flags & VHOST_USER_NEED_REPLY) {
1798 msg.payload.u64 = ret == VH_RESULT_ERR;
1799 msg.size = sizeof(msg.payload.u64);
1800 send_vhost_reply(fd, &msg);
1801 } else if (ret == VH_RESULT_ERR) {
1802 RTE_LOG(ERR, VHOST_CONFIG,
1803 "vhost message handling failed.\n");
1807 if (!(dev->flags & VIRTIO_DEV_RUNNING) && virtio_is_ready(dev)) {
1808 dev->flags |= VIRTIO_DEV_READY;
1810 if (!(dev->flags & VIRTIO_DEV_RUNNING)) {
1811 if (dev->dequeue_zero_copy) {
1812 RTE_LOG(INFO, VHOST_CONFIG,
1813 "dequeue zero copy is enabled\n");
1816 if (dev->notify_ops->new_device(dev->vid) == 0)
1817 dev->flags |= VIRTIO_DEV_RUNNING;
1821 did = dev->vdpa_dev_id;
1822 vdpa_dev = rte_vdpa_get_device(did);
1823 if (vdpa_dev && virtio_is_ready(dev) &&
1824 !(dev->flags & VIRTIO_DEV_VDPA_CONFIGURED) &&
1825 msg.request.master == VHOST_USER_SET_VRING_ENABLE) {
1826 if (vdpa_dev->ops->dev_conf)
1827 vdpa_dev->ops->dev_conf(dev->vid);
1828 dev->flags |= VIRTIO_DEV_VDPA_CONFIGURED;
1829 if (vhost_user_host_notifier_ctrl(dev->vid, true) != 0) {
1830 RTE_LOG(INFO, VHOST_CONFIG,
1831 "(%d) software relay is used for vDPA, performance may be low.\n",
1839 static int process_slave_message_reply(struct virtio_net *dev,
1840 const struct VhostUserMsg *msg)
1842 struct VhostUserMsg msg_reply;
1845 if ((msg->flags & VHOST_USER_NEED_REPLY) == 0)
1848 if (read_vhost_message(dev->slave_req_fd, &msg_reply) < 0) {
1853 if (msg_reply.request.slave != msg->request.slave) {
1854 RTE_LOG(ERR, VHOST_CONFIG,
1855 "Received unexpected msg type (%u), expected %u\n",
1856 msg_reply.request.slave, msg->request.slave);
1861 ret = msg_reply.payload.u64 ? -1 : 0;
1864 rte_spinlock_unlock(&dev->slave_req_lock);
1869 vhost_user_iotlb_miss(struct virtio_net *dev, uint64_t iova, uint8_t perm)
1872 struct VhostUserMsg msg = {
1873 .request.slave = VHOST_USER_SLAVE_IOTLB_MSG,
1874 .flags = VHOST_USER_VERSION,
1875 .size = sizeof(msg.payload.iotlb),
1879 .type = VHOST_IOTLB_MISS,
1883 ret = send_vhost_message(dev->slave_req_fd, &msg, NULL, 0);
1885 RTE_LOG(ERR, VHOST_CONFIG,
1886 "Failed to send IOTLB miss message (%d)\n",
1894 static int vhost_user_slave_set_vring_host_notifier(struct virtio_net *dev,
1902 struct VhostUserMsg msg = {
1903 .request.slave = VHOST_USER_SLAVE_VRING_HOST_NOTIFIER_MSG,
1904 .flags = VHOST_USER_VERSION | VHOST_USER_NEED_REPLY,
1905 .size = sizeof(msg.payload.area),
1907 .u64 = index & VHOST_USER_VRING_IDX_MASK,
1914 msg.payload.area.u64 |= VHOST_USER_VRING_NOFD_MASK;
1920 ret = send_vhost_slave_message(dev, &msg, fdp, fd_num);
1922 RTE_LOG(ERR, VHOST_CONFIG,
1923 "Failed to set host notifier (%d)\n", ret);
1927 return process_slave_message_reply(dev, &msg);
1930 int vhost_user_host_notifier_ctrl(int vid, bool enable)
1932 struct virtio_net *dev;
1933 struct rte_vdpa_device *vdpa_dev;
1934 int vfio_device_fd, did, ret = 0;
1935 uint64_t offset, size;
1938 dev = get_device(vid);
1942 did = dev->vdpa_dev_id;
1946 if (!(dev->features & (1ULL << VIRTIO_F_VERSION_1)) ||
1947 !(dev->features & (1ULL << VHOST_USER_F_PROTOCOL_FEATURES)) ||
1948 !(dev->protocol_features &
1949 (1ULL << VHOST_USER_PROTOCOL_F_SLAVE_REQ)) ||
1950 !(dev->protocol_features &
1951 (1ULL << VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD)) ||
1952 !(dev->protocol_features &
1953 (1ULL << VHOST_USER_PROTOCOL_F_HOST_NOTIFIER)))
1956 vdpa_dev = rte_vdpa_get_device(did);
1960 RTE_FUNC_PTR_OR_ERR_RET(vdpa_dev->ops->get_vfio_device_fd, -ENOTSUP);
1961 RTE_FUNC_PTR_OR_ERR_RET(vdpa_dev->ops->get_notify_area, -ENOTSUP);
1963 vfio_device_fd = vdpa_dev->ops->get_vfio_device_fd(vid);
1964 if (vfio_device_fd < 0)
1968 for (i = 0; i < dev->nr_vring; i++) {
1969 if (vdpa_dev->ops->get_notify_area(vid, i, &offset,
1975 if (vhost_user_slave_set_vring_host_notifier(dev, i,
1976 vfio_device_fd, offset, size) < 0) {
1983 for (i = 0; i < dev->nr_vring; i++) {
1984 vhost_user_slave_set_vring_host_notifier(dev, i, -1,