1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2016 Intel Corporation
11 #include <sys/types.h>
14 #ifdef RTE_LIBRTE_VHOST_NUMA
18 #include <rte_common.h>
19 #include <rte_malloc.h>
24 #include "vhost_user.h"
26 #define VIRTIO_MIN_MTU 68
27 #define VIRTIO_MAX_MTU 65535
29 static const char *vhost_message_str[VHOST_USER_MAX] = {
30 [VHOST_USER_NONE] = "VHOST_USER_NONE",
31 [VHOST_USER_GET_FEATURES] = "VHOST_USER_GET_FEATURES",
32 [VHOST_USER_SET_FEATURES] = "VHOST_USER_SET_FEATURES",
33 [VHOST_USER_SET_OWNER] = "VHOST_USER_SET_OWNER",
34 [VHOST_USER_RESET_OWNER] = "VHOST_USER_RESET_OWNER",
35 [VHOST_USER_SET_MEM_TABLE] = "VHOST_USER_SET_MEM_TABLE",
36 [VHOST_USER_SET_LOG_BASE] = "VHOST_USER_SET_LOG_BASE",
37 [VHOST_USER_SET_LOG_FD] = "VHOST_USER_SET_LOG_FD",
38 [VHOST_USER_SET_VRING_NUM] = "VHOST_USER_SET_VRING_NUM",
39 [VHOST_USER_SET_VRING_ADDR] = "VHOST_USER_SET_VRING_ADDR",
40 [VHOST_USER_SET_VRING_BASE] = "VHOST_USER_SET_VRING_BASE",
41 [VHOST_USER_GET_VRING_BASE] = "VHOST_USER_GET_VRING_BASE",
42 [VHOST_USER_SET_VRING_KICK] = "VHOST_USER_SET_VRING_KICK",
43 [VHOST_USER_SET_VRING_CALL] = "VHOST_USER_SET_VRING_CALL",
44 [VHOST_USER_SET_VRING_ERR] = "VHOST_USER_SET_VRING_ERR",
45 [VHOST_USER_GET_PROTOCOL_FEATURES] = "VHOST_USER_GET_PROTOCOL_FEATURES",
46 [VHOST_USER_SET_PROTOCOL_FEATURES] = "VHOST_USER_SET_PROTOCOL_FEATURES",
47 [VHOST_USER_GET_QUEUE_NUM] = "VHOST_USER_GET_QUEUE_NUM",
48 [VHOST_USER_SET_VRING_ENABLE] = "VHOST_USER_SET_VRING_ENABLE",
49 [VHOST_USER_SEND_RARP] = "VHOST_USER_SEND_RARP",
50 [VHOST_USER_NET_SET_MTU] = "VHOST_USER_NET_SET_MTU",
51 [VHOST_USER_SET_SLAVE_REQ_FD] = "VHOST_USER_SET_SLAVE_REQ_FD",
52 [VHOST_USER_IOTLB_MSG] = "VHOST_USER_IOTLB_MSG",
61 ret = fstat(fd, &stat);
62 return ret == -1 ? (uint64_t)-1 : (uint64_t)stat.st_blksize;
66 free_mem_region(struct virtio_net *dev)
69 struct rte_vhost_mem_region *reg;
71 if (!dev || !dev->mem)
74 for (i = 0; i < dev->mem->nregions; i++) {
75 reg = &dev->mem->regions[i];
76 if (reg->host_user_addr) {
77 munmap(reg->mmap_addr, reg->mmap_size);
84 vhost_backend_cleanup(struct virtio_net *dev)
92 free(dev->guest_pages);
93 dev->guest_pages = NULL;
96 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
100 if (dev->slave_req_fd >= 0) {
101 close(dev->slave_req_fd);
102 dev->slave_req_fd = -1;
107 * This function just returns success at the moment unless
108 * the device hasn't been initialised.
111 vhost_user_set_owner(void)
117 vhost_user_reset_owner(struct virtio_net *dev)
119 if (dev->flags & VIRTIO_DEV_RUNNING) {
120 dev->flags &= ~VIRTIO_DEV_RUNNING;
121 dev->notify_ops->destroy_device(dev->vid);
124 cleanup_device(dev, 0);
130 * The features that we support are requested.
133 vhost_user_get_features(struct virtio_net *dev)
135 uint64_t features = 0;
137 rte_vhost_driver_get_features(dev->ifname, &features);
142 * We receive the negotiated features supported by us and the virtio device.
145 vhost_user_set_features(struct virtio_net *dev, uint64_t features)
147 uint64_t vhost_features = 0;
149 rte_vhost_driver_get_features(dev->ifname, &vhost_features);
150 if (features & ~vhost_features) {
151 RTE_LOG(ERR, VHOST_CONFIG,
152 "(%d) received invalid negotiated features.\n",
157 if (dev->flags & VIRTIO_DEV_RUNNING) {
158 if (dev->features == features)
162 * Error out if master tries to change features while device is
163 * in running state. The exception being VHOST_F_LOG_ALL, which
164 * is enabled when the live-migration starts.
166 if ((dev->features ^ features) & ~(1ULL << VHOST_F_LOG_ALL)) {
167 RTE_LOG(ERR, VHOST_CONFIG,
168 "(%d) features changed while device is running.\n",
173 if (dev->notify_ops->features_changed)
174 dev->notify_ops->features_changed(dev->vid, features);
177 dev->features = features;
179 ((1 << VIRTIO_NET_F_MRG_RXBUF) | (1ULL << VIRTIO_F_VERSION_1))) {
180 dev->vhost_hlen = sizeof(struct virtio_net_hdr_mrg_rxbuf);
182 dev->vhost_hlen = sizeof(struct virtio_net_hdr);
184 LOG_DEBUG(VHOST_CONFIG,
185 "(%d) mergeable RX buffers %s, virtio 1 %s\n",
187 (dev->features & (1 << VIRTIO_NET_F_MRG_RXBUF)) ? "on" : "off",
188 (dev->features & (1ULL << VIRTIO_F_VERSION_1)) ? "on" : "off");
190 if ((dev->flags & VIRTIO_DEV_BUILTIN_VIRTIO_NET) &&
191 !(dev->features & (1ULL << VIRTIO_NET_F_MQ))) {
193 * Remove all but first queue pair if MQ hasn't been
194 * negotiated. This is safe because the device is not
195 * running at this stage.
197 while (dev->nr_vring > 2) {
198 struct vhost_virtqueue *vq;
200 vq = dev->virtqueue[--dev->nr_vring];
204 dev->virtqueue[dev->nr_vring] = NULL;
214 * The virtio device sends us the size of the descriptor ring.
217 vhost_user_set_vring_num(struct virtio_net *dev,
220 struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
222 vq->size = msg->payload.state.num;
224 if (dev->dequeue_zero_copy) {
226 vq->last_zmbuf_idx = 0;
227 vq->zmbuf_size = vq->size;
228 vq->zmbufs = rte_zmalloc(NULL, vq->zmbuf_size *
229 sizeof(struct zcopy_mbuf), 0);
230 if (vq->zmbufs == NULL) {
231 RTE_LOG(WARNING, VHOST_CONFIG,
232 "failed to allocate mem for zero copy; "
233 "zero copy is force disabled\n");
234 dev->dequeue_zero_copy = 0;
236 TAILQ_INIT(&vq->zmbuf_list);
239 vq->shadow_used_ring = rte_malloc(NULL,
240 vq->size * sizeof(struct vring_used_elem),
241 RTE_CACHE_LINE_SIZE);
242 if (!vq->shadow_used_ring) {
243 RTE_LOG(ERR, VHOST_CONFIG,
244 "failed to allocate memory for shadow used ring.\n");
248 vq->batch_copy_elems = rte_malloc(NULL,
249 vq->size * sizeof(struct batch_copy_elem),
250 RTE_CACHE_LINE_SIZE);
251 if (!vq->batch_copy_elems) {
252 RTE_LOG(ERR, VHOST_CONFIG,
253 "failed to allocate memory for batching copy.\n");
261 * Reallocate virtio_dev and vhost_virtqueue data structure to make them on the
262 * same numa node as the memory of vring descriptor.
264 #ifdef RTE_LIBRTE_VHOST_NUMA
265 static struct virtio_net*
266 numa_realloc(struct virtio_net *dev, int index)
268 int oldnode, newnode;
269 struct virtio_net *old_dev;
270 struct vhost_virtqueue *old_vq, *vq;
271 struct zcopy_mbuf *new_zmbuf;
272 struct vring_used_elem *new_shadow_used_ring;
273 struct batch_copy_elem *new_batch_copy_elems;
277 vq = old_vq = dev->virtqueue[index];
279 ret = get_mempolicy(&newnode, NULL, 0, old_vq->desc,
280 MPOL_F_NODE | MPOL_F_ADDR);
282 /* check if we need to reallocate vq */
283 ret |= get_mempolicy(&oldnode, NULL, 0, old_vq,
284 MPOL_F_NODE | MPOL_F_ADDR);
286 RTE_LOG(ERR, VHOST_CONFIG,
287 "Unable to get vq numa information.\n");
290 if (oldnode != newnode) {
291 RTE_LOG(INFO, VHOST_CONFIG,
292 "reallocate vq from %d to %d node\n", oldnode, newnode);
293 vq = rte_malloc_socket(NULL, sizeof(*vq), 0, newnode);
297 memcpy(vq, old_vq, sizeof(*vq));
298 TAILQ_INIT(&vq->zmbuf_list);
300 new_zmbuf = rte_malloc_socket(NULL, vq->zmbuf_size *
301 sizeof(struct zcopy_mbuf), 0, newnode);
303 rte_free(vq->zmbufs);
304 vq->zmbufs = new_zmbuf;
307 new_shadow_used_ring = rte_malloc_socket(NULL,
308 vq->size * sizeof(struct vring_used_elem),
311 if (new_shadow_used_ring) {
312 rte_free(vq->shadow_used_ring);
313 vq->shadow_used_ring = new_shadow_used_ring;
316 new_batch_copy_elems = rte_malloc_socket(NULL,
317 vq->size * sizeof(struct batch_copy_elem),
320 if (new_batch_copy_elems) {
321 rte_free(vq->batch_copy_elems);
322 vq->batch_copy_elems = new_batch_copy_elems;
328 /* check if we need to reallocate dev */
329 ret = get_mempolicy(&oldnode, NULL, 0, old_dev,
330 MPOL_F_NODE | MPOL_F_ADDR);
332 RTE_LOG(ERR, VHOST_CONFIG,
333 "Unable to get dev numa information.\n");
336 if (oldnode != newnode) {
337 RTE_LOG(INFO, VHOST_CONFIG,
338 "reallocate dev from %d to %d node\n",
340 dev = rte_malloc_socket(NULL, sizeof(*dev), 0, newnode);
346 memcpy(dev, old_dev, sizeof(*dev));
351 dev->virtqueue[index] = vq;
352 vhost_devices[dev->vid] = dev;
355 vhost_user_iotlb_init(dev, index);
360 static struct virtio_net*
361 numa_realloc(struct virtio_net *dev, int index __rte_unused)
367 /* Converts QEMU virtual address to Vhost virtual address. */
369 qva_to_vva(struct virtio_net *dev, uint64_t qva, uint64_t *len)
371 struct rte_vhost_mem_region *r;
374 /* Find the region where the address lives. */
375 for (i = 0; i < dev->mem->nregions; i++) {
376 r = &dev->mem->regions[i];
378 if (qva >= r->guest_user_addr &&
379 qva < r->guest_user_addr + r->size) {
381 if (unlikely(*len > r->guest_user_addr + r->size - qva))
382 *len = r->guest_user_addr + r->size - qva;
384 return qva - r->guest_user_addr +
395 * Converts ring address to Vhost virtual address.
396 * If IOMMU is enabled, the ring address is a guest IO virtual address,
397 * else it is a QEMU virtual address.
400 ring_addr_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
401 uint64_t ra, uint64_t *size)
403 if (dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)) {
406 vva = vhost_user_iotlb_cache_find(vq, ra,
407 size, VHOST_ACCESS_RW);
409 vhost_user_iotlb_miss(dev, ra, VHOST_ACCESS_RW);
414 return qva_to_vva(dev, ra, size);
417 static struct virtio_net *
418 translate_ring_addresses(struct virtio_net *dev, int vq_index)
420 struct vhost_virtqueue *vq = dev->virtqueue[vq_index];
421 struct vhost_vring_addr *addr = &vq->ring_addrs;
424 /* The addresses are converted from QEMU virtual to Vhost virtual. */
425 if (vq->desc && vq->avail && vq->used)
428 len = sizeof(struct vring_desc) * vq->size;
429 vq->desc = (struct vring_desc *)(uintptr_t)ring_addr_to_vva(dev,
430 vq, addr->desc_user_addr, &len);
431 if (vq->desc == 0 || len != sizeof(struct vring_desc) * vq->size) {
432 RTE_LOG(DEBUG, VHOST_CONFIG,
433 "(%d) failed to map desc ring.\n",
438 dev = numa_realloc(dev, vq_index);
439 vq = dev->virtqueue[vq_index];
440 addr = &vq->ring_addrs;
442 len = sizeof(struct vring_avail) + sizeof(uint16_t) * vq->size;
443 vq->avail = (struct vring_avail *)(uintptr_t)ring_addr_to_vva(dev,
444 vq, addr->avail_user_addr, &len);
445 if (vq->avail == 0 ||
446 len != sizeof(struct vring_avail) +
447 sizeof(uint16_t) * vq->size) {
448 RTE_LOG(DEBUG, VHOST_CONFIG,
449 "(%d) failed to map avail ring.\n",
454 len = sizeof(struct vring_used) +
455 sizeof(struct vring_used_elem) * vq->size;
456 vq->used = (struct vring_used *)(uintptr_t)ring_addr_to_vva(dev,
457 vq, addr->used_user_addr, &len);
458 if (vq->used == 0 || len != sizeof(struct vring_used) +
459 sizeof(struct vring_used_elem) * vq->size) {
460 RTE_LOG(DEBUG, VHOST_CONFIG,
461 "(%d) failed to map used ring.\n",
466 if (vq->last_used_idx != vq->used->idx) {
467 RTE_LOG(WARNING, VHOST_CONFIG,
468 "last_used_idx (%u) and vq->used->idx (%u) mismatches; "
469 "some packets maybe resent for Tx and dropped for Rx\n",
470 vq->last_used_idx, vq->used->idx);
471 vq->last_used_idx = vq->used->idx;
472 vq->last_avail_idx = vq->used->idx;
475 vq->log_guest_addr = addr->log_guest_addr;
477 LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address desc: %p\n",
479 LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address avail: %p\n",
480 dev->vid, vq->avail);
481 LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address used: %p\n",
483 LOG_DEBUG(VHOST_CONFIG, "(%d) log_guest_addr: %" PRIx64 "\n",
484 dev->vid, vq->log_guest_addr);
490 * The virtio device sends us the desc, used and avail ring addresses.
491 * This function then converts these to our address space.
494 vhost_user_set_vring_addr(struct virtio_net **pdev, VhostUserMsg *msg)
496 struct vhost_virtqueue *vq;
497 struct vhost_vring_addr *addr = &msg->payload.addr;
498 struct virtio_net *dev = *pdev;
500 if (dev->mem == NULL)
503 /* addr->index refers to the queue index. The txq 1, rxq is 0. */
504 vq = dev->virtqueue[msg->payload.addr.index];
507 * Rings addresses should not be interpreted as long as the ring is not
508 * started and enabled
510 memcpy(&vq->ring_addrs, addr, sizeof(*addr));
512 vring_invalidate(dev, vq);
514 if (vq->enabled && (dev->features &
515 (1ULL << VHOST_USER_F_PROTOCOL_FEATURES))) {
516 dev = translate_ring_addresses(dev, msg->payload.state.index);
527 * The virtio device sends us the available ring last used index.
530 vhost_user_set_vring_base(struct virtio_net *dev,
533 dev->virtqueue[msg->payload.state.index]->last_used_idx =
534 msg->payload.state.num;
535 dev->virtqueue[msg->payload.state.index]->last_avail_idx =
536 msg->payload.state.num;
542 add_one_guest_page(struct virtio_net *dev, uint64_t guest_phys_addr,
543 uint64_t host_phys_addr, uint64_t size)
545 struct guest_page *page, *last_page;
547 if (dev->nr_guest_pages == dev->max_guest_pages) {
548 dev->max_guest_pages *= 2;
549 dev->guest_pages = realloc(dev->guest_pages,
550 dev->max_guest_pages * sizeof(*page));
553 if (dev->nr_guest_pages > 0) {
554 last_page = &dev->guest_pages[dev->nr_guest_pages - 1];
555 /* merge if the two pages are continuous */
556 if (host_phys_addr == last_page->host_phys_addr +
558 last_page->size += size;
563 page = &dev->guest_pages[dev->nr_guest_pages++];
564 page->guest_phys_addr = guest_phys_addr;
565 page->host_phys_addr = host_phys_addr;
570 add_guest_pages(struct virtio_net *dev, struct rte_vhost_mem_region *reg,
573 uint64_t reg_size = reg->size;
574 uint64_t host_user_addr = reg->host_user_addr;
575 uint64_t guest_phys_addr = reg->guest_phys_addr;
576 uint64_t host_phys_addr;
579 host_phys_addr = rte_mem_virt2iova((void *)(uintptr_t)host_user_addr);
580 size = page_size - (guest_phys_addr & (page_size - 1));
581 size = RTE_MIN(size, reg_size);
583 add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size);
584 host_user_addr += size;
585 guest_phys_addr += size;
588 while (reg_size > 0) {
589 size = RTE_MIN(reg_size, page_size);
590 host_phys_addr = rte_mem_virt2iova((void *)(uintptr_t)
592 add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size);
594 host_user_addr += size;
595 guest_phys_addr += size;
600 #ifdef RTE_LIBRTE_VHOST_DEBUG
601 /* TODO: enable it only in debug mode? */
603 dump_guest_pages(struct virtio_net *dev)
606 struct guest_page *page;
608 for (i = 0; i < dev->nr_guest_pages; i++) {
609 page = &dev->guest_pages[i];
611 RTE_LOG(INFO, VHOST_CONFIG,
612 "guest physical page region %u\n"
613 "\t guest_phys_addr: %" PRIx64 "\n"
614 "\t host_phys_addr : %" PRIx64 "\n"
615 "\t size : %" PRIx64 "\n",
617 page->guest_phys_addr,
618 page->host_phys_addr,
623 #define dump_guest_pages(dev)
627 vhost_memory_changed(struct VhostUserMemory *new,
628 struct rte_vhost_memory *old)
632 if (new->nregions != old->nregions)
635 for (i = 0; i < new->nregions; ++i) {
636 VhostUserMemoryRegion *new_r = &new->regions[i];
637 struct rte_vhost_mem_region *old_r = &old->regions[i];
639 if (new_r->guest_phys_addr != old_r->guest_phys_addr)
641 if (new_r->memory_size != old_r->size)
643 if (new_r->userspace_addr != old_r->guest_user_addr)
651 vhost_user_set_mem_table(struct virtio_net *dev, struct VhostUserMsg *pmsg)
653 struct VhostUserMemory memory = pmsg->payload.memory;
654 struct rte_vhost_mem_region *reg;
657 uint64_t mmap_offset;
662 if (dev->mem && !vhost_memory_changed(&memory, dev->mem)) {
663 RTE_LOG(INFO, VHOST_CONFIG,
664 "(%d) memory regions not changed\n", dev->vid);
666 for (i = 0; i < memory.nregions; i++)
673 free_mem_region(dev);
678 dev->nr_guest_pages = 0;
679 if (!dev->guest_pages) {
680 dev->max_guest_pages = 8;
681 dev->guest_pages = malloc(dev->max_guest_pages *
682 sizeof(struct guest_page));
683 if (dev->guest_pages == NULL) {
684 RTE_LOG(ERR, VHOST_CONFIG,
685 "(%d) failed to allocate memory "
686 "for dev->guest_pages\n",
692 dev->mem = rte_zmalloc("vhost-mem-table", sizeof(struct rte_vhost_memory) +
693 sizeof(struct rte_vhost_mem_region) * memory.nregions, 0);
694 if (dev->mem == NULL) {
695 RTE_LOG(ERR, VHOST_CONFIG,
696 "(%d) failed to allocate memory for dev->mem\n",
700 dev->mem->nregions = memory.nregions;
702 for (i = 0; i < memory.nregions; i++) {
704 reg = &dev->mem->regions[i];
706 reg->guest_phys_addr = memory.regions[i].guest_phys_addr;
707 reg->guest_user_addr = memory.regions[i].userspace_addr;
708 reg->size = memory.regions[i].memory_size;
711 mmap_offset = memory.regions[i].mmap_offset;
712 mmap_size = reg->size + mmap_offset;
714 /* mmap() without flag of MAP_ANONYMOUS, should be called
715 * with length argument aligned with hugepagesz at older
716 * longterm version Linux, like 2.6.32 and 3.2.72, or
717 * mmap() will fail with EINVAL.
719 * to avoid failure, make sure in caller to keep length
722 alignment = get_blk_size(fd);
723 if (alignment == (uint64_t)-1) {
724 RTE_LOG(ERR, VHOST_CONFIG,
725 "couldn't get hugepage size through fstat\n");
728 mmap_size = RTE_ALIGN_CEIL(mmap_size, alignment);
730 mmap_addr = mmap(NULL, mmap_size, PROT_READ | PROT_WRITE,
731 MAP_SHARED | MAP_POPULATE, fd, 0);
733 if (mmap_addr == MAP_FAILED) {
734 RTE_LOG(ERR, VHOST_CONFIG,
735 "mmap region %u failed.\n", i);
739 reg->mmap_addr = mmap_addr;
740 reg->mmap_size = mmap_size;
741 reg->host_user_addr = (uint64_t)(uintptr_t)mmap_addr +
744 if (dev->dequeue_zero_copy)
745 add_guest_pages(dev, reg, alignment);
747 RTE_LOG(INFO, VHOST_CONFIG,
748 "guest memory region %u, size: 0x%" PRIx64 "\n"
749 "\t guest physical addr: 0x%" PRIx64 "\n"
750 "\t guest virtual addr: 0x%" PRIx64 "\n"
751 "\t host virtual addr: 0x%" PRIx64 "\n"
752 "\t mmap addr : 0x%" PRIx64 "\n"
753 "\t mmap size : 0x%" PRIx64 "\n"
754 "\t mmap align: 0x%" PRIx64 "\n"
755 "\t mmap off : 0x%" PRIx64 "\n",
757 reg->guest_phys_addr,
758 reg->guest_user_addr,
760 (uint64_t)(uintptr_t)mmap_addr,
766 dump_guest_pages(dev);
771 free_mem_region(dev);
778 vq_is_ready(struct vhost_virtqueue *vq)
780 return vq && vq->desc && vq->avail && vq->used &&
781 vq->kickfd != VIRTIO_UNINITIALIZED_EVENTFD &&
782 vq->callfd != VIRTIO_UNINITIALIZED_EVENTFD;
786 virtio_is_ready(struct virtio_net *dev)
788 struct vhost_virtqueue *vq;
791 if (dev->nr_vring == 0)
794 for (i = 0; i < dev->nr_vring; i++) {
795 vq = dev->virtqueue[i];
797 if (!vq_is_ready(vq))
801 RTE_LOG(INFO, VHOST_CONFIG,
802 "virtio is now ready for processing.\n");
807 vhost_user_set_vring_call(struct virtio_net *dev, struct VhostUserMsg *pmsg)
809 struct vhost_vring_file file;
810 struct vhost_virtqueue *vq;
812 file.index = pmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
813 if (pmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
814 file.fd = VIRTIO_INVALID_EVENTFD;
816 file.fd = pmsg->fds[0];
817 RTE_LOG(INFO, VHOST_CONFIG,
818 "vring call idx:%d file:%d\n", file.index, file.fd);
820 vq = dev->virtqueue[file.index];
824 vq->callfd = file.fd;
828 vhost_user_set_vring_kick(struct virtio_net **pdev, struct VhostUserMsg *pmsg)
830 struct vhost_vring_file file;
831 struct vhost_virtqueue *vq;
832 struct virtio_net *dev = *pdev;
834 file.index = pmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
835 if (pmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
836 file.fd = VIRTIO_INVALID_EVENTFD;
838 file.fd = pmsg->fds[0];
839 RTE_LOG(INFO, VHOST_CONFIG,
840 "vring kick idx:%d file:%d\n", file.index, file.fd);
842 /* Interpret ring addresses only when ring is started. */
843 dev = translate_ring_addresses(dev, file.index);
849 vq = dev->virtqueue[file.index];
852 * When VHOST_USER_F_PROTOCOL_FEATURES is not negotiated,
853 * the ring starts already enabled. Otherwise, it is enabled via
854 * the SET_VRING_ENABLE message.
856 if (!(dev->features & (1ULL << VHOST_USER_F_PROTOCOL_FEATURES)))
861 vq->kickfd = file.fd;
865 free_zmbufs(struct vhost_virtqueue *vq)
867 struct zcopy_mbuf *zmbuf, *next;
869 for (zmbuf = TAILQ_FIRST(&vq->zmbuf_list);
870 zmbuf != NULL; zmbuf = next) {
871 next = TAILQ_NEXT(zmbuf, next);
873 rte_pktmbuf_free(zmbuf->mbuf);
874 TAILQ_REMOVE(&vq->zmbuf_list, zmbuf, next);
877 rte_free(vq->zmbufs);
881 * when virtio is stopped, qemu will send us the GET_VRING_BASE message.
884 vhost_user_get_vring_base(struct virtio_net *dev,
887 struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
889 /* We have to stop the queue (virtio) if it is running. */
890 if (dev->flags & VIRTIO_DEV_RUNNING) {
891 dev->flags &= ~VIRTIO_DEV_RUNNING;
892 dev->notify_ops->destroy_device(dev->vid);
895 dev->flags &= ~VIRTIO_DEV_READY;
897 /* Here we are safe to get the last used index */
898 msg->payload.state.num = vq->last_used_idx;
900 RTE_LOG(INFO, VHOST_CONFIG,
901 "vring base idx:%d file:%d\n", msg->payload.state.index,
902 msg->payload.state.num);
904 * Based on current qemu vhost-user implementation, this message is
905 * sent and only sent in vhost_vring_stop.
906 * TODO: cleanup the vring, it isn't usable since here.
911 vq->kickfd = VIRTIO_UNINITIALIZED_EVENTFD;
913 if (dev->dequeue_zero_copy)
915 rte_free(vq->shadow_used_ring);
916 vq->shadow_used_ring = NULL;
918 rte_free(vq->batch_copy_elems);
919 vq->batch_copy_elems = NULL;
925 * when virtio queues are ready to work, qemu will send us to
926 * enable the virtio queue pair.
929 vhost_user_set_vring_enable(struct virtio_net *dev,
932 int enable = (int)msg->payload.state.num;
934 RTE_LOG(INFO, VHOST_CONFIG,
935 "set queue enable: %d to qp idx: %d\n",
936 enable, msg->payload.state.index);
938 if (dev->notify_ops->vring_state_changed)
939 dev->notify_ops->vring_state_changed(dev->vid,
940 msg->payload.state.index, enable);
942 dev->virtqueue[msg->payload.state.index]->enabled = enable;
948 vhost_user_get_protocol_features(struct virtio_net *dev,
949 struct VhostUserMsg *msg)
951 uint64_t features, protocol_features = VHOST_USER_PROTOCOL_FEATURES;
953 rte_vhost_driver_get_features(dev->ifname, &features);
956 * REPLY_ACK protocol feature is only mandatory for now
957 * for IOMMU feature. If IOMMU is explicitly disabled by the
958 * application, disable also REPLY_ACK feature for older buggy
959 * Qemu versions (from v2.7.0 to v2.9.0).
961 if (!(features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)))
962 protocol_features &= ~(1ULL << VHOST_USER_PROTOCOL_F_REPLY_ACK);
964 msg->payload.u64 = protocol_features;
965 msg->size = sizeof(msg->payload.u64);
969 vhost_user_set_protocol_features(struct virtio_net *dev,
970 uint64_t protocol_features)
972 if (protocol_features & ~VHOST_USER_PROTOCOL_FEATURES)
975 dev->protocol_features = protocol_features;
979 vhost_user_set_log_base(struct virtio_net *dev, struct VhostUserMsg *msg)
981 int fd = msg->fds[0];
986 RTE_LOG(ERR, VHOST_CONFIG, "invalid log fd: %d\n", fd);
990 if (msg->size != sizeof(VhostUserLog)) {
991 RTE_LOG(ERR, VHOST_CONFIG,
992 "invalid log base msg size: %"PRId32" != %d\n",
993 msg->size, (int)sizeof(VhostUserLog));
997 size = msg->payload.log.mmap_size;
998 off = msg->payload.log.mmap_offset;
999 RTE_LOG(INFO, VHOST_CONFIG,
1000 "log mmap size: %"PRId64", offset: %"PRId64"\n",
1004 * mmap from 0 to workaround a hugepage mmap bug: mmap will
1005 * fail when offset is not page size aligned.
1007 addr = mmap(0, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
1009 if (addr == MAP_FAILED) {
1010 RTE_LOG(ERR, VHOST_CONFIG, "mmap log base failed!\n");
1015 * Free previously mapped log memory on occasionally
1016 * multiple VHOST_USER_SET_LOG_BASE.
1018 if (dev->log_addr) {
1019 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
1021 dev->log_addr = (uint64_t)(uintptr_t)addr;
1022 dev->log_base = dev->log_addr + off;
1023 dev->log_size = size;
1029 * An rarp packet is constructed and broadcasted to notify switches about
1030 * the new location of the migrated VM, so that packets from outside will
1031 * not be lost after migration.
1033 * However, we don't actually "send" a rarp packet here, instead, we set
1034 * a flag 'broadcast_rarp' to let rte_vhost_dequeue_burst() inject it.
1037 vhost_user_send_rarp(struct virtio_net *dev, struct VhostUserMsg *msg)
1039 uint8_t *mac = (uint8_t *)&msg->payload.u64;
1041 RTE_LOG(DEBUG, VHOST_CONFIG,
1042 ":: mac: %02x:%02x:%02x:%02x:%02x:%02x\n",
1043 mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
1044 memcpy(dev->mac.addr_bytes, mac, 6);
1047 * Set the flag to inject a RARP broadcast packet at
1048 * rte_vhost_dequeue_burst().
1050 * rte_smp_wmb() is for making sure the mac is copied
1051 * before the flag is set.
1054 rte_atomic16_set(&dev->broadcast_rarp, 1);
1060 vhost_user_net_set_mtu(struct virtio_net *dev, struct VhostUserMsg *msg)
1062 if (msg->payload.u64 < VIRTIO_MIN_MTU ||
1063 msg->payload.u64 > VIRTIO_MAX_MTU) {
1064 RTE_LOG(ERR, VHOST_CONFIG, "Invalid MTU size (%"PRIu64")\n",
1070 dev->mtu = msg->payload.u64;
1076 vhost_user_set_req_fd(struct virtio_net *dev, struct VhostUserMsg *msg)
1078 int fd = msg->fds[0];
1081 RTE_LOG(ERR, VHOST_CONFIG,
1082 "Invalid file descriptor for slave channel (%d)\n",
1087 dev->slave_req_fd = fd;
1093 is_vring_iotlb_update(struct vhost_virtqueue *vq, struct vhost_iotlb_msg *imsg)
1095 struct vhost_vring_addr *ra;
1096 uint64_t start, end;
1099 end = start + imsg->size;
1101 ra = &vq->ring_addrs;
1102 if (ra->desc_user_addr >= start && ra->desc_user_addr < end)
1104 if (ra->avail_user_addr >= start && ra->avail_user_addr < end)
1106 if (ra->used_user_addr >= start && ra->used_user_addr < end)
1113 is_vring_iotlb_invalidate(struct vhost_virtqueue *vq,
1114 struct vhost_iotlb_msg *imsg)
1116 uint64_t istart, iend, vstart, vend;
1118 istart = imsg->iova;
1119 iend = istart + imsg->size - 1;
1121 vstart = (uintptr_t)vq->desc;
1122 vend = vstart + sizeof(struct vring_desc) * vq->size - 1;
1123 if (vstart <= iend && istart <= vend)
1126 vstart = (uintptr_t)vq->avail;
1127 vend = vstart + sizeof(struct vring_avail);
1128 vend += sizeof(uint16_t) * vq->size - 1;
1129 if (vstart <= iend && istart <= vend)
1132 vstart = (uintptr_t)vq->used;
1133 vend = vstart + sizeof(struct vring_used);
1134 vend += sizeof(struct vring_used_elem) * vq->size - 1;
1135 if (vstart <= iend && istart <= vend)
1142 vhost_user_iotlb_msg(struct virtio_net **pdev, struct VhostUserMsg *msg)
1144 struct virtio_net *dev = *pdev;
1145 struct vhost_iotlb_msg *imsg = &msg->payload.iotlb;
1149 switch (imsg->type) {
1150 case VHOST_IOTLB_UPDATE:
1152 vva = qva_to_vva(dev, imsg->uaddr, &len);
1156 for (i = 0; i < dev->nr_vring; i++) {
1157 struct vhost_virtqueue *vq = dev->virtqueue[i];
1159 vhost_user_iotlb_cache_insert(vq, imsg->iova, vva,
1162 if (is_vring_iotlb_update(vq, imsg))
1163 *pdev = dev = translate_ring_addresses(dev, i);
1166 case VHOST_IOTLB_INVALIDATE:
1167 for (i = 0; i < dev->nr_vring; i++) {
1168 struct vhost_virtqueue *vq = dev->virtqueue[i];
1170 vhost_user_iotlb_cache_remove(vq, imsg->iova,
1173 if (is_vring_iotlb_invalidate(vq, imsg))
1174 vring_invalidate(dev, vq);
1178 RTE_LOG(ERR, VHOST_CONFIG, "Invalid IOTLB message type (%d)\n",
1186 /* return bytes# of read on success or negative val on failure. */
1188 read_vhost_message(int sockfd, struct VhostUserMsg *msg)
1192 ret = read_fd_message(sockfd, (char *)msg, VHOST_USER_HDR_SIZE,
1193 msg->fds, VHOST_MEMORY_MAX_NREGIONS);
1197 if (msg && msg->size) {
1198 if (msg->size > sizeof(msg->payload)) {
1199 RTE_LOG(ERR, VHOST_CONFIG,
1200 "invalid msg size: %d\n", msg->size);
1203 ret = read(sockfd, &msg->payload, msg->size);
1206 if (ret != (int)msg->size) {
1207 RTE_LOG(ERR, VHOST_CONFIG,
1208 "read control message failed\n");
1217 send_vhost_message(int sockfd, struct VhostUserMsg *msg)
1222 return send_fd_message(sockfd, (char *)msg,
1223 VHOST_USER_HDR_SIZE + msg->size, NULL, 0);
1227 send_vhost_reply(int sockfd, struct VhostUserMsg *msg)
1232 msg->flags &= ~VHOST_USER_VERSION_MASK;
1233 msg->flags &= ~VHOST_USER_NEED_REPLY;
1234 msg->flags |= VHOST_USER_VERSION;
1235 msg->flags |= VHOST_USER_REPLY_MASK;
1237 return send_vhost_message(sockfd, msg);
1241 * Allocate a queue pair if it hasn't been allocated yet
1244 vhost_user_check_and_alloc_queue_pair(struct virtio_net *dev, VhostUserMsg *msg)
1248 switch (msg->request.master) {
1249 case VHOST_USER_SET_VRING_KICK:
1250 case VHOST_USER_SET_VRING_CALL:
1251 case VHOST_USER_SET_VRING_ERR:
1252 vring_idx = msg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
1254 case VHOST_USER_SET_VRING_NUM:
1255 case VHOST_USER_SET_VRING_BASE:
1256 case VHOST_USER_SET_VRING_ENABLE:
1257 vring_idx = msg->payload.state.index;
1259 case VHOST_USER_SET_VRING_ADDR:
1260 vring_idx = msg->payload.addr.index;
1266 if (vring_idx >= VHOST_MAX_VRING) {
1267 RTE_LOG(ERR, VHOST_CONFIG,
1268 "invalid vring index: %u\n", vring_idx);
1272 if (dev->virtqueue[vring_idx])
1275 return alloc_vring_queue(dev, vring_idx);
1279 vhost_user_lock_all_queue_pairs(struct virtio_net *dev)
1282 unsigned int vq_num = 0;
1284 while (vq_num < dev->nr_vring) {
1285 struct vhost_virtqueue *vq = dev->virtqueue[i];
1288 rte_spinlock_lock(&vq->access_lock);
1296 vhost_user_unlock_all_queue_pairs(struct virtio_net *dev)
1299 unsigned int vq_num = 0;
1301 while (vq_num < dev->nr_vring) {
1302 struct vhost_virtqueue *vq = dev->virtqueue[i];
1305 rte_spinlock_unlock(&vq->access_lock);
1313 vhost_user_msg_handler(int vid, int fd)
1315 struct virtio_net *dev;
1316 struct VhostUserMsg msg;
1318 int unlock_required = 0;
1320 dev = get_device(vid);
1324 if (!dev->notify_ops) {
1325 dev->notify_ops = vhost_driver_callback_get(dev->ifname);
1326 if (!dev->notify_ops) {
1327 RTE_LOG(ERR, VHOST_CONFIG,
1328 "failed to get callback ops for driver %s\n",
1334 ret = read_vhost_message(fd, &msg);
1335 if (ret <= 0 || msg.request.master >= VHOST_USER_MAX) {
1337 RTE_LOG(ERR, VHOST_CONFIG,
1338 "vhost read message failed\n");
1340 RTE_LOG(INFO, VHOST_CONFIG,
1341 "vhost peer closed\n");
1343 RTE_LOG(ERR, VHOST_CONFIG,
1344 "vhost read incorrect message\n");
1350 if (msg.request.master != VHOST_USER_IOTLB_MSG)
1351 RTE_LOG(INFO, VHOST_CONFIG, "read message %s\n",
1352 vhost_message_str[msg.request.master]);
1354 RTE_LOG(DEBUG, VHOST_CONFIG, "read message %s\n",
1355 vhost_message_str[msg.request.master]);
1357 ret = vhost_user_check_and_alloc_queue_pair(dev, &msg);
1359 RTE_LOG(ERR, VHOST_CONFIG,
1360 "failed to alloc queue\n");
1365 * Note: we don't lock all queues on VHOST_USER_GET_VRING_BASE
1366 * and VHOST_USER_RESET_OWNER, since it is sent when virtio stops
1367 * and device is destroyed. destroy_device waits for queues to be
1368 * inactive, so it is safe. Otherwise taking the access_lock
1369 * would cause a dead lock.
1371 switch (msg.request.master) {
1372 case VHOST_USER_SET_FEATURES:
1373 case VHOST_USER_SET_PROTOCOL_FEATURES:
1374 case VHOST_USER_SET_OWNER:
1375 case VHOST_USER_SET_MEM_TABLE:
1376 case VHOST_USER_SET_LOG_BASE:
1377 case VHOST_USER_SET_LOG_FD:
1378 case VHOST_USER_SET_VRING_NUM:
1379 case VHOST_USER_SET_VRING_ADDR:
1380 case VHOST_USER_SET_VRING_BASE:
1381 case VHOST_USER_SET_VRING_KICK:
1382 case VHOST_USER_SET_VRING_CALL:
1383 case VHOST_USER_SET_VRING_ERR:
1384 case VHOST_USER_SET_VRING_ENABLE:
1385 case VHOST_USER_SEND_RARP:
1386 case VHOST_USER_NET_SET_MTU:
1387 case VHOST_USER_SET_SLAVE_REQ_FD:
1388 vhost_user_lock_all_queue_pairs(dev);
1389 unlock_required = 1;
1396 switch (msg.request.master) {
1397 case VHOST_USER_GET_FEATURES:
1398 msg.payload.u64 = vhost_user_get_features(dev);
1399 msg.size = sizeof(msg.payload.u64);
1400 send_vhost_reply(fd, &msg);
1402 case VHOST_USER_SET_FEATURES:
1403 ret = vhost_user_set_features(dev, msg.payload.u64);
1408 case VHOST_USER_GET_PROTOCOL_FEATURES:
1409 vhost_user_get_protocol_features(dev, &msg);
1410 send_vhost_reply(fd, &msg);
1412 case VHOST_USER_SET_PROTOCOL_FEATURES:
1413 vhost_user_set_protocol_features(dev, msg.payload.u64);
1416 case VHOST_USER_SET_OWNER:
1417 vhost_user_set_owner();
1419 case VHOST_USER_RESET_OWNER:
1420 vhost_user_reset_owner(dev);
1423 case VHOST_USER_SET_MEM_TABLE:
1424 ret = vhost_user_set_mem_table(dev, &msg);
1427 case VHOST_USER_SET_LOG_BASE:
1428 vhost_user_set_log_base(dev, &msg);
1430 /* it needs a reply */
1431 msg.size = sizeof(msg.payload.u64);
1432 send_vhost_reply(fd, &msg);
1434 case VHOST_USER_SET_LOG_FD:
1436 RTE_LOG(INFO, VHOST_CONFIG, "not implemented.\n");
1439 case VHOST_USER_SET_VRING_NUM:
1440 vhost_user_set_vring_num(dev, &msg);
1442 case VHOST_USER_SET_VRING_ADDR:
1443 vhost_user_set_vring_addr(&dev, &msg);
1445 case VHOST_USER_SET_VRING_BASE:
1446 vhost_user_set_vring_base(dev, &msg);
1449 case VHOST_USER_GET_VRING_BASE:
1450 vhost_user_get_vring_base(dev, &msg);
1451 msg.size = sizeof(msg.payload.state);
1452 send_vhost_reply(fd, &msg);
1455 case VHOST_USER_SET_VRING_KICK:
1456 vhost_user_set_vring_kick(&dev, &msg);
1458 case VHOST_USER_SET_VRING_CALL:
1459 vhost_user_set_vring_call(dev, &msg);
1462 case VHOST_USER_SET_VRING_ERR:
1463 if (!(msg.payload.u64 & VHOST_USER_VRING_NOFD_MASK))
1465 RTE_LOG(INFO, VHOST_CONFIG, "not implemented\n");
1468 case VHOST_USER_GET_QUEUE_NUM:
1469 msg.payload.u64 = VHOST_MAX_QUEUE_PAIRS;
1470 msg.size = sizeof(msg.payload.u64);
1471 send_vhost_reply(fd, &msg);
1474 case VHOST_USER_SET_VRING_ENABLE:
1475 vhost_user_set_vring_enable(dev, &msg);
1477 case VHOST_USER_SEND_RARP:
1478 vhost_user_send_rarp(dev, &msg);
1481 case VHOST_USER_NET_SET_MTU:
1482 ret = vhost_user_net_set_mtu(dev, &msg);
1485 case VHOST_USER_SET_SLAVE_REQ_FD:
1486 ret = vhost_user_set_req_fd(dev, &msg);
1489 case VHOST_USER_IOTLB_MSG:
1490 ret = vhost_user_iotlb_msg(&dev, &msg);
1499 if (unlock_required)
1500 vhost_user_unlock_all_queue_pairs(dev);
1502 if (msg.flags & VHOST_USER_NEED_REPLY) {
1503 msg.payload.u64 = !!ret;
1504 msg.size = sizeof(msg.payload.u64);
1505 send_vhost_reply(fd, &msg);
1508 if (!(dev->flags & VIRTIO_DEV_RUNNING) && virtio_is_ready(dev)) {
1509 dev->flags |= VIRTIO_DEV_READY;
1511 if (!(dev->flags & VIRTIO_DEV_RUNNING)) {
1512 if (dev->dequeue_zero_copy) {
1513 RTE_LOG(INFO, VHOST_CONFIG,
1514 "dequeue zero copy is enabled\n");
1517 if (dev->notify_ops->new_device(dev->vid) == 0)
1518 dev->flags |= VIRTIO_DEV_RUNNING;
1526 vhost_user_iotlb_miss(struct virtio_net *dev, uint64_t iova, uint8_t perm)
1529 struct VhostUserMsg msg = {
1530 .request.slave = VHOST_USER_SLAVE_IOTLB_MSG,
1531 .flags = VHOST_USER_VERSION,
1532 .size = sizeof(msg.payload.iotlb),
1536 .type = VHOST_IOTLB_MISS,
1540 ret = send_vhost_message(dev->slave_req_fd, &msg);
1542 RTE_LOG(ERR, VHOST_CONFIG,
1543 "Failed to send IOTLB miss message (%d)\n",