4 * Copyright(c) 2010-2016 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 #include <sys/types.h>
43 #ifdef RTE_LIBRTE_VHOST_NUMA
47 #include <rte_common.h>
48 #include <rte_malloc.h>
53 #include "vhost_user.h"
55 #define VIRTIO_MIN_MTU 68
56 #define VIRTIO_MAX_MTU 65535
58 static const char *vhost_message_str[VHOST_USER_MAX] = {
59 [VHOST_USER_NONE] = "VHOST_USER_NONE",
60 [VHOST_USER_GET_FEATURES] = "VHOST_USER_GET_FEATURES",
61 [VHOST_USER_SET_FEATURES] = "VHOST_USER_SET_FEATURES",
62 [VHOST_USER_SET_OWNER] = "VHOST_USER_SET_OWNER",
63 [VHOST_USER_RESET_OWNER] = "VHOST_USER_RESET_OWNER",
64 [VHOST_USER_SET_MEM_TABLE] = "VHOST_USER_SET_MEM_TABLE",
65 [VHOST_USER_SET_LOG_BASE] = "VHOST_USER_SET_LOG_BASE",
66 [VHOST_USER_SET_LOG_FD] = "VHOST_USER_SET_LOG_FD",
67 [VHOST_USER_SET_VRING_NUM] = "VHOST_USER_SET_VRING_NUM",
68 [VHOST_USER_SET_VRING_ADDR] = "VHOST_USER_SET_VRING_ADDR",
69 [VHOST_USER_SET_VRING_BASE] = "VHOST_USER_SET_VRING_BASE",
70 [VHOST_USER_GET_VRING_BASE] = "VHOST_USER_GET_VRING_BASE",
71 [VHOST_USER_SET_VRING_KICK] = "VHOST_USER_SET_VRING_KICK",
72 [VHOST_USER_SET_VRING_CALL] = "VHOST_USER_SET_VRING_CALL",
73 [VHOST_USER_SET_VRING_ERR] = "VHOST_USER_SET_VRING_ERR",
74 [VHOST_USER_GET_PROTOCOL_FEATURES] = "VHOST_USER_GET_PROTOCOL_FEATURES",
75 [VHOST_USER_SET_PROTOCOL_FEATURES] = "VHOST_USER_SET_PROTOCOL_FEATURES",
76 [VHOST_USER_GET_QUEUE_NUM] = "VHOST_USER_GET_QUEUE_NUM",
77 [VHOST_USER_SET_VRING_ENABLE] = "VHOST_USER_SET_VRING_ENABLE",
78 [VHOST_USER_SEND_RARP] = "VHOST_USER_SEND_RARP",
79 [VHOST_USER_NET_SET_MTU] = "VHOST_USER_NET_SET_MTU",
80 [VHOST_USER_SET_SLAVE_REQ_FD] = "VHOST_USER_SET_SLAVE_REQ_FD",
81 [VHOST_USER_IOTLB_MSG] = "VHOST_USER_IOTLB_MSG",
90 ret = fstat(fd, &stat);
91 return ret == -1 ? (uint64_t)-1 : (uint64_t)stat.st_blksize;
95 free_mem_region(struct virtio_net *dev)
98 struct rte_vhost_mem_region *reg;
100 if (!dev || !dev->mem)
103 for (i = 0; i < dev->mem->nregions; i++) {
104 reg = &dev->mem->regions[i];
105 if (reg->host_user_addr) {
106 munmap(reg->mmap_addr, reg->mmap_size);
113 vhost_backend_cleanup(struct virtio_net *dev)
116 free_mem_region(dev);
121 free(dev->guest_pages);
122 dev->guest_pages = NULL;
125 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
129 if (dev->slave_req_fd >= 0) {
130 close(dev->slave_req_fd);
131 dev->slave_req_fd = -1;
136 * This function just returns success at the moment unless
137 * the device hasn't been initialised.
140 vhost_user_set_owner(void)
146 vhost_user_reset_owner(struct virtio_net *dev)
148 if (dev->flags & VIRTIO_DEV_RUNNING) {
149 dev->flags &= ~VIRTIO_DEV_RUNNING;
150 dev->notify_ops->destroy_device(dev->vid);
153 cleanup_device(dev, 0);
159 * The features that we support are requested.
162 vhost_user_get_features(struct virtio_net *dev)
164 uint64_t features = 0;
166 rte_vhost_driver_get_features(dev->ifname, &features);
171 * We receive the negotiated features supported by us and the virtio device.
174 vhost_user_set_features(struct virtio_net *dev, uint64_t features)
176 uint64_t vhost_features = 0;
178 rte_vhost_driver_get_features(dev->ifname, &vhost_features);
179 if (features & ~vhost_features) {
180 RTE_LOG(ERR, VHOST_CONFIG,
181 "(%d) received invalid negotiated features.\n",
186 if ((dev->flags & VIRTIO_DEV_RUNNING) && dev->features != features) {
187 if (dev->notify_ops->features_changed)
188 dev->notify_ops->features_changed(dev->vid, features);
191 dev->features = features;
193 ((1 << VIRTIO_NET_F_MRG_RXBUF) | (1ULL << VIRTIO_F_VERSION_1))) {
194 dev->vhost_hlen = sizeof(struct virtio_net_hdr_mrg_rxbuf);
196 dev->vhost_hlen = sizeof(struct virtio_net_hdr);
198 LOG_DEBUG(VHOST_CONFIG,
199 "(%d) mergeable RX buffers %s, virtio 1 %s\n",
201 (dev->features & (1 << VIRTIO_NET_F_MRG_RXBUF)) ? "on" : "off",
202 (dev->features & (1ULL << VIRTIO_F_VERSION_1)) ? "on" : "off");
208 * The virtio device sends us the size of the descriptor ring.
211 vhost_user_set_vring_num(struct virtio_net *dev,
214 struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
216 vq->size = msg->payload.state.num;
218 if (dev->dequeue_zero_copy) {
220 vq->last_zmbuf_idx = 0;
221 vq->zmbuf_size = vq->size;
222 vq->zmbufs = rte_zmalloc(NULL, vq->zmbuf_size *
223 sizeof(struct zcopy_mbuf), 0);
224 if (vq->zmbufs == NULL) {
225 RTE_LOG(WARNING, VHOST_CONFIG,
226 "failed to allocate mem for zero copy; "
227 "zero copy is force disabled\n");
228 dev->dequeue_zero_copy = 0;
232 vq->shadow_used_ring = rte_malloc(NULL,
233 vq->size * sizeof(struct vring_used_elem),
234 RTE_CACHE_LINE_SIZE);
235 if (!vq->shadow_used_ring) {
236 RTE_LOG(ERR, VHOST_CONFIG,
237 "failed to allocate memory for shadow used ring.\n");
241 vq->batch_copy_elems = rte_malloc(NULL,
242 vq->size * sizeof(struct batch_copy_elem),
243 RTE_CACHE_LINE_SIZE);
244 if (!vq->batch_copy_elems) {
245 RTE_LOG(ERR, VHOST_CONFIG,
246 "failed to allocate memory for batching copy.\n");
254 * Reallocate virtio_dev and vhost_virtqueue data structure to make them on the
255 * same numa node as the memory of vring descriptor.
257 #ifdef RTE_LIBRTE_VHOST_NUMA
258 static struct virtio_net*
259 numa_realloc(struct virtio_net *dev, int index)
261 int oldnode, newnode;
262 struct virtio_net *old_dev;
263 struct vhost_virtqueue *old_vq, *vq;
267 vq = old_vq = dev->virtqueue[index];
269 ret = get_mempolicy(&newnode, NULL, 0, old_vq->desc,
270 MPOL_F_NODE | MPOL_F_ADDR);
272 /* check if we need to reallocate vq */
273 ret |= get_mempolicy(&oldnode, NULL, 0, old_vq,
274 MPOL_F_NODE | MPOL_F_ADDR);
276 RTE_LOG(ERR, VHOST_CONFIG,
277 "Unable to get vq numa information.\n");
280 if (oldnode != newnode) {
281 RTE_LOG(INFO, VHOST_CONFIG,
282 "reallocate vq from %d to %d node\n", oldnode, newnode);
283 vq = rte_malloc_socket(NULL, sizeof(*vq), 0, newnode);
287 memcpy(vq, old_vq, sizeof(*vq));
291 /* check if we need to reallocate dev */
292 ret = get_mempolicy(&oldnode, NULL, 0, old_dev,
293 MPOL_F_NODE | MPOL_F_ADDR);
295 RTE_LOG(ERR, VHOST_CONFIG,
296 "Unable to get dev numa information.\n");
299 if (oldnode != newnode) {
300 RTE_LOG(INFO, VHOST_CONFIG,
301 "reallocate dev from %d to %d node\n",
303 dev = rte_malloc_socket(NULL, sizeof(*dev), 0, newnode);
309 memcpy(dev, old_dev, sizeof(*dev));
314 dev->virtqueue[index] = vq;
315 vhost_devices[dev->vid] = dev;
320 static struct virtio_net*
321 numa_realloc(struct virtio_net *dev, int index __rte_unused)
328 * Converts QEMU virtual address to Vhost virtual address. This function is
329 * used to convert the ring addresses to our address space.
332 qva_to_vva(struct virtio_net *dev, uint64_t qva)
334 struct rte_vhost_mem_region *reg;
337 /* Find the region where the address lives. */
338 for (i = 0; i < dev->mem->nregions; i++) {
339 reg = &dev->mem->regions[i];
341 if (qva >= reg->guest_user_addr &&
342 qva < reg->guest_user_addr + reg->size) {
343 return qva - reg->guest_user_addr +
352 * The virtio device sends us the desc, used and avail ring addresses.
353 * This function then converts these to our address space.
356 vhost_user_set_vring_addr(struct virtio_net *dev, VhostUserMsg *msg)
358 struct vhost_virtqueue *vq;
359 struct vhost_vring_addr *addr = &msg->payload.addr;
361 if (dev->mem == NULL)
364 /* addr->index refers to the queue index. The txq 1, rxq is 0. */
365 vq = dev->virtqueue[msg->payload.addr.index];
368 * Rings addresses should not be interpreted as long as the ring is not
369 * started and enabled
371 memcpy(&vq->ring_addrs, addr, sizeof(*addr));
376 static struct virtio_net *
377 translate_ring_addresses(struct virtio_net *dev, int vq_index)
379 struct vhost_virtqueue *vq = dev->virtqueue[vq_index];
380 struct vhost_vring_addr *addr = &vq->ring_addrs;
382 /* The addresses are converted from QEMU virtual to Vhost virtual. */
383 vq->desc = (struct vring_desc *)(uintptr_t)qva_to_vva(dev,
384 addr->desc_user_addr);
386 RTE_LOG(ERR, VHOST_CONFIG,
387 "(%d) failed to find desc ring address.\n",
392 dev = numa_realloc(dev, vq_index);
393 vq = dev->virtqueue[vq_index];
395 vq->avail = (struct vring_avail *)(uintptr_t)qva_to_vva(dev,
396 addr->avail_user_addr);
397 if (vq->avail == 0) {
398 RTE_LOG(ERR, VHOST_CONFIG,
399 "(%d) failed to find avail ring address.\n",
404 vq->used = (struct vring_used *)(uintptr_t)qva_to_vva(dev,
405 addr->used_user_addr);
407 RTE_LOG(ERR, VHOST_CONFIG,
408 "(%d) failed to find used ring address.\n",
413 if (vq->last_used_idx != vq->used->idx) {
414 RTE_LOG(WARNING, VHOST_CONFIG,
415 "last_used_idx (%u) and vq->used->idx (%u) mismatches; "
416 "some packets maybe resent for Tx and dropped for Rx\n",
417 vq->last_used_idx, vq->used->idx);
418 vq->last_used_idx = vq->used->idx;
419 vq->last_avail_idx = vq->used->idx;
422 vq->log_guest_addr = addr->log_guest_addr;
424 LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address desc: %p\n",
426 LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address avail: %p\n",
427 dev->vid, vq->avail);
428 LOG_DEBUG(VHOST_CONFIG, "(%d) mapped address used: %p\n",
430 LOG_DEBUG(VHOST_CONFIG, "(%d) log_guest_addr: %" PRIx64 "\n",
431 dev->vid, vq->log_guest_addr);
437 * The virtio device sends us the available ring last used index.
440 vhost_user_set_vring_base(struct virtio_net *dev,
443 dev->virtqueue[msg->payload.state.index]->last_used_idx =
444 msg->payload.state.num;
445 dev->virtqueue[msg->payload.state.index]->last_avail_idx =
446 msg->payload.state.num;
452 add_one_guest_page(struct virtio_net *dev, uint64_t guest_phys_addr,
453 uint64_t host_phys_addr, uint64_t size)
455 struct guest_page *page, *last_page;
457 if (dev->nr_guest_pages == dev->max_guest_pages) {
458 dev->max_guest_pages *= 2;
459 dev->guest_pages = realloc(dev->guest_pages,
460 dev->max_guest_pages * sizeof(*page));
463 if (dev->nr_guest_pages > 0) {
464 last_page = &dev->guest_pages[dev->nr_guest_pages - 1];
465 /* merge if the two pages are continuous */
466 if (host_phys_addr == last_page->host_phys_addr +
468 last_page->size += size;
473 page = &dev->guest_pages[dev->nr_guest_pages++];
474 page->guest_phys_addr = guest_phys_addr;
475 page->host_phys_addr = host_phys_addr;
480 add_guest_pages(struct virtio_net *dev, struct rte_vhost_mem_region *reg,
483 uint64_t reg_size = reg->size;
484 uint64_t host_user_addr = reg->host_user_addr;
485 uint64_t guest_phys_addr = reg->guest_phys_addr;
486 uint64_t host_phys_addr;
489 host_phys_addr = rte_mem_virt2phy((void *)(uintptr_t)host_user_addr);
490 size = page_size - (guest_phys_addr & (page_size - 1));
491 size = RTE_MIN(size, reg_size);
493 add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size);
494 host_user_addr += size;
495 guest_phys_addr += size;
498 while (reg_size > 0) {
499 size = RTE_MIN(reg_size, page_size);
500 host_phys_addr = rte_mem_virt2phy((void *)(uintptr_t)
502 add_one_guest_page(dev, guest_phys_addr, host_phys_addr, size);
504 host_user_addr += size;
505 guest_phys_addr += size;
510 #ifdef RTE_LIBRTE_VHOST_DEBUG
511 /* TODO: enable it only in debug mode? */
513 dump_guest_pages(struct virtio_net *dev)
516 struct guest_page *page;
518 for (i = 0; i < dev->nr_guest_pages; i++) {
519 page = &dev->guest_pages[i];
521 RTE_LOG(INFO, VHOST_CONFIG,
522 "guest physical page region %u\n"
523 "\t guest_phys_addr: %" PRIx64 "\n"
524 "\t host_phys_addr : %" PRIx64 "\n"
525 "\t size : %" PRIx64 "\n",
527 page->guest_phys_addr,
528 page->host_phys_addr,
533 #define dump_guest_pages(dev)
537 vhost_user_set_mem_table(struct virtio_net *dev, struct VhostUserMsg *pmsg)
539 struct VhostUserMemory memory = pmsg->payload.memory;
540 struct rte_vhost_mem_region *reg;
543 uint64_t mmap_offset;
549 free_mem_region(dev);
554 dev->nr_guest_pages = 0;
555 if (!dev->guest_pages) {
556 dev->max_guest_pages = 8;
557 dev->guest_pages = malloc(dev->max_guest_pages *
558 sizeof(struct guest_page));
559 if (dev->guest_pages == NULL) {
560 RTE_LOG(ERR, VHOST_CONFIG,
561 "(%d) failed to allocate memory "
562 "for dev->guest_pages\n",
568 dev->mem = rte_zmalloc("vhost-mem-table", sizeof(struct rte_vhost_memory) +
569 sizeof(struct rte_vhost_mem_region) * memory.nregions, 0);
570 if (dev->mem == NULL) {
571 RTE_LOG(ERR, VHOST_CONFIG,
572 "(%d) failed to allocate memory for dev->mem\n",
576 dev->mem->nregions = memory.nregions;
578 for (i = 0; i < memory.nregions; i++) {
580 reg = &dev->mem->regions[i];
582 reg->guest_phys_addr = memory.regions[i].guest_phys_addr;
583 reg->guest_user_addr = memory.regions[i].userspace_addr;
584 reg->size = memory.regions[i].memory_size;
587 mmap_offset = memory.regions[i].mmap_offset;
588 mmap_size = reg->size + mmap_offset;
590 /* mmap() without flag of MAP_ANONYMOUS, should be called
591 * with length argument aligned with hugepagesz at older
592 * longterm version Linux, like 2.6.32 and 3.2.72, or
593 * mmap() will fail with EINVAL.
595 * to avoid failure, make sure in caller to keep length
598 alignment = get_blk_size(fd);
599 if (alignment == (uint64_t)-1) {
600 RTE_LOG(ERR, VHOST_CONFIG,
601 "couldn't get hugepage size through fstat\n");
604 mmap_size = RTE_ALIGN_CEIL(mmap_size, alignment);
606 mmap_addr = mmap(NULL, mmap_size, PROT_READ | PROT_WRITE,
607 MAP_SHARED | MAP_POPULATE, fd, 0);
609 if (mmap_addr == MAP_FAILED) {
610 RTE_LOG(ERR, VHOST_CONFIG,
611 "mmap region %u failed.\n", i);
615 reg->mmap_addr = mmap_addr;
616 reg->mmap_size = mmap_size;
617 reg->host_user_addr = (uint64_t)(uintptr_t)mmap_addr +
620 if (dev->dequeue_zero_copy)
621 add_guest_pages(dev, reg, alignment);
623 RTE_LOG(INFO, VHOST_CONFIG,
624 "guest memory region %u, size: 0x%" PRIx64 "\n"
625 "\t guest physical addr: 0x%" PRIx64 "\n"
626 "\t guest virtual addr: 0x%" PRIx64 "\n"
627 "\t host virtual addr: 0x%" PRIx64 "\n"
628 "\t mmap addr : 0x%" PRIx64 "\n"
629 "\t mmap size : 0x%" PRIx64 "\n"
630 "\t mmap align: 0x%" PRIx64 "\n"
631 "\t mmap off : 0x%" PRIx64 "\n",
633 reg->guest_phys_addr,
634 reg->guest_user_addr,
636 (uint64_t)(uintptr_t)mmap_addr,
642 dump_guest_pages(dev);
647 free_mem_region(dev);
654 vq_is_ready(struct vhost_virtqueue *vq)
656 return vq && vq->desc &&
657 vq->kickfd != VIRTIO_UNINITIALIZED_EVENTFD &&
658 vq->callfd != VIRTIO_UNINITIALIZED_EVENTFD;
662 virtio_is_ready(struct virtio_net *dev)
664 struct vhost_virtqueue *vq;
667 if (dev->nr_vring == 0)
670 for (i = 0; i < dev->nr_vring; i++) {
671 vq = dev->virtqueue[i];
673 if (!vq_is_ready(vq))
677 RTE_LOG(INFO, VHOST_CONFIG,
678 "virtio is now ready for processing.\n");
683 vhost_user_set_vring_call(struct virtio_net *dev, struct VhostUserMsg *pmsg)
685 struct vhost_vring_file file;
686 struct vhost_virtqueue *vq;
688 file.index = pmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
689 if (pmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
690 file.fd = VIRTIO_INVALID_EVENTFD;
692 file.fd = pmsg->fds[0];
693 RTE_LOG(INFO, VHOST_CONFIG,
694 "vring call idx:%d file:%d\n", file.index, file.fd);
696 vq = dev->virtqueue[file.index];
700 vq->callfd = file.fd;
704 vhost_user_set_vring_kick(struct virtio_net **pdev, struct VhostUserMsg *pmsg)
706 struct vhost_vring_file file;
707 struct vhost_virtqueue *vq;
708 struct virtio_net *dev = *pdev;
710 file.index = pmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
711 if (pmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK)
712 file.fd = VIRTIO_INVALID_EVENTFD;
714 file.fd = pmsg->fds[0];
715 RTE_LOG(INFO, VHOST_CONFIG,
716 "vring kick idx:%d file:%d\n", file.index, file.fd);
719 * Interpret ring addresses only when ring is started and enabled.
720 * This is now if protocol features aren't supported.
722 if (!(dev->features & (1ULL << VHOST_USER_F_PROTOCOL_FEATURES))) {
723 *pdev = dev = translate_ring_addresses(dev, file.index);
728 vq = dev->virtqueue[file.index];
731 * When VHOST_USER_F_PROTOCOL_FEATURES is not negotiated,
732 * the ring starts already enabled. Otherwise, it is enabled via
733 * the SET_VRING_ENABLE message.
735 if (!(dev->features & (1ULL << VHOST_USER_F_PROTOCOL_FEATURES)))
740 vq->kickfd = file.fd;
744 free_zmbufs(struct vhost_virtqueue *vq)
746 struct zcopy_mbuf *zmbuf, *next;
748 for (zmbuf = TAILQ_FIRST(&vq->zmbuf_list);
749 zmbuf != NULL; zmbuf = next) {
750 next = TAILQ_NEXT(zmbuf, next);
752 rte_pktmbuf_free(zmbuf->mbuf);
753 TAILQ_REMOVE(&vq->zmbuf_list, zmbuf, next);
756 rte_free(vq->zmbufs);
760 * when virtio is stopped, qemu will send us the GET_VRING_BASE message.
763 vhost_user_get_vring_base(struct virtio_net *dev,
766 struct vhost_virtqueue *vq = dev->virtqueue[msg->payload.state.index];
768 /* We have to stop the queue (virtio) if it is running. */
769 if (dev->flags & VIRTIO_DEV_RUNNING) {
770 dev->flags &= ~VIRTIO_DEV_RUNNING;
771 dev->notify_ops->destroy_device(dev->vid);
774 dev->flags &= ~VIRTIO_DEV_READY;
776 /* Here we are safe to get the last used index */
777 msg->payload.state.num = vq->last_used_idx;
779 RTE_LOG(INFO, VHOST_CONFIG,
780 "vring base idx:%d file:%d\n", msg->payload.state.index,
781 msg->payload.state.num);
783 * Based on current qemu vhost-user implementation, this message is
784 * sent and only sent in vhost_vring_stop.
785 * TODO: cleanup the vring, it isn't usable since here.
790 vq->kickfd = VIRTIO_UNINITIALIZED_EVENTFD;
792 if (dev->dequeue_zero_copy)
794 rte_free(vq->shadow_used_ring);
795 vq->shadow_used_ring = NULL;
797 rte_free(vq->batch_copy_elems);
798 vq->batch_copy_elems = NULL;
804 * when virtio queues are ready to work, qemu will send us to
805 * enable the virtio queue pair.
808 vhost_user_set_vring_enable(struct virtio_net **pdev,
811 struct virtio_net *dev = *pdev;
812 int enable = (int)msg->payload.state.num;
814 RTE_LOG(INFO, VHOST_CONFIG,
815 "set queue enable: %d to qp idx: %d\n",
816 enable, msg->payload.state.index);
819 * Interpret ring addresses only when ring is started and enabled.
820 * This is now if protocol features are supported.
822 if (enable && (dev->features &
823 (1ULL << VHOST_USER_F_PROTOCOL_FEATURES))) {
824 dev = translate_ring_addresses(dev, msg->payload.state.index);
831 if (dev->notify_ops->vring_state_changed)
832 dev->notify_ops->vring_state_changed(dev->vid,
833 msg->payload.state.index, enable);
835 dev->virtqueue[msg->payload.state.index]->enabled = enable;
841 vhost_user_set_protocol_features(struct virtio_net *dev,
842 uint64_t protocol_features)
844 if (protocol_features & ~VHOST_USER_PROTOCOL_FEATURES)
847 dev->protocol_features = protocol_features;
851 vhost_user_set_log_base(struct virtio_net *dev, struct VhostUserMsg *msg)
853 int fd = msg->fds[0];
858 RTE_LOG(ERR, VHOST_CONFIG, "invalid log fd: %d\n", fd);
862 if (msg->size != sizeof(VhostUserLog)) {
863 RTE_LOG(ERR, VHOST_CONFIG,
864 "invalid log base msg size: %"PRId32" != %d\n",
865 msg->size, (int)sizeof(VhostUserLog));
869 size = msg->payload.log.mmap_size;
870 off = msg->payload.log.mmap_offset;
871 RTE_LOG(INFO, VHOST_CONFIG,
872 "log mmap size: %"PRId64", offset: %"PRId64"\n",
876 * mmap from 0 to workaround a hugepage mmap bug: mmap will
877 * fail when offset is not page size aligned.
879 addr = mmap(0, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
881 if (addr == MAP_FAILED) {
882 RTE_LOG(ERR, VHOST_CONFIG, "mmap log base failed!\n");
887 * Free previously mapped log memory on occasionally
888 * multiple VHOST_USER_SET_LOG_BASE.
891 munmap((void *)(uintptr_t)dev->log_addr, dev->log_size);
893 dev->log_addr = (uint64_t)(uintptr_t)addr;
894 dev->log_base = dev->log_addr + off;
895 dev->log_size = size;
901 * An rarp packet is constructed and broadcasted to notify switches about
902 * the new location of the migrated VM, so that packets from outside will
903 * not be lost after migration.
905 * However, we don't actually "send" a rarp packet here, instead, we set
906 * a flag 'broadcast_rarp' to let rte_vhost_dequeue_burst() inject it.
909 vhost_user_send_rarp(struct virtio_net *dev, struct VhostUserMsg *msg)
911 uint8_t *mac = (uint8_t *)&msg->payload.u64;
913 RTE_LOG(DEBUG, VHOST_CONFIG,
914 ":: mac: %02x:%02x:%02x:%02x:%02x:%02x\n",
915 mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
916 memcpy(dev->mac.addr_bytes, mac, 6);
919 * Set the flag to inject a RARP broadcast packet at
920 * rte_vhost_dequeue_burst().
922 * rte_smp_wmb() is for making sure the mac is copied
923 * before the flag is set.
926 rte_atomic16_set(&dev->broadcast_rarp, 1);
932 vhost_user_net_set_mtu(struct virtio_net *dev, struct VhostUserMsg *msg)
934 if (msg->payload.u64 < VIRTIO_MIN_MTU ||
935 msg->payload.u64 > VIRTIO_MAX_MTU) {
936 RTE_LOG(ERR, VHOST_CONFIG, "Invalid MTU size (%"PRIu64")\n",
942 dev->mtu = msg->payload.u64;
948 vhost_user_set_req_fd(struct virtio_net *dev, struct VhostUserMsg *msg)
950 int fd = msg->fds[0];
953 RTE_LOG(ERR, VHOST_CONFIG,
954 "Invalid file descriptor for slave channel (%d)\n",
959 dev->slave_req_fd = fd;
965 vhost_user_iotlb_msg(struct virtio_net *dev, struct VhostUserMsg *msg)
967 struct vhost_iotlb_msg *imsg = &msg->payload.iotlb;
971 switch (imsg->type) {
972 case VHOST_IOTLB_UPDATE:
973 vva = qva_to_vva(dev, imsg->uaddr);
977 for (i = 0; i < dev->nr_vring; i++) {
978 struct vhost_virtqueue *vq = dev->virtqueue[i];
980 vhost_user_iotlb_cache_insert(vq, imsg->iova, vva,
981 imsg->size, imsg->perm);
984 case VHOST_IOTLB_INVALIDATE:
985 for (i = 0; i < dev->nr_vring; i++) {
986 struct vhost_virtqueue *vq = dev->virtqueue[i];
988 vhost_user_iotlb_cache_remove(vq, imsg->iova,
993 RTE_LOG(ERR, VHOST_CONFIG, "Invalid IOTLB message type (%d)\n",
1001 /* return bytes# of read on success or negative val on failure. */
1003 read_vhost_message(int sockfd, struct VhostUserMsg *msg)
1007 ret = read_fd_message(sockfd, (char *)msg, VHOST_USER_HDR_SIZE,
1008 msg->fds, VHOST_MEMORY_MAX_NREGIONS);
1012 if (msg && msg->size) {
1013 if (msg->size > sizeof(msg->payload)) {
1014 RTE_LOG(ERR, VHOST_CONFIG,
1015 "invalid msg size: %d\n", msg->size);
1018 ret = read(sockfd, &msg->payload, msg->size);
1021 if (ret != (int)msg->size) {
1022 RTE_LOG(ERR, VHOST_CONFIG,
1023 "read control message failed\n");
1032 send_vhost_message(int sockfd, struct VhostUserMsg *msg)
1037 return send_fd_message(sockfd, (char *)msg,
1038 VHOST_USER_HDR_SIZE + msg->size, NULL, 0);
1042 send_vhost_reply(int sockfd, struct VhostUserMsg *msg)
1047 msg->flags &= ~VHOST_USER_VERSION_MASK;
1048 msg->flags &= ~VHOST_USER_NEED_REPLY;
1049 msg->flags |= VHOST_USER_VERSION;
1050 msg->flags |= VHOST_USER_REPLY_MASK;
1052 return send_vhost_message(sockfd, msg);
1056 * Allocate a queue pair if it hasn't been allocated yet
1059 vhost_user_check_and_alloc_queue_pair(struct virtio_net *dev, VhostUserMsg *msg)
1063 switch (msg->request) {
1064 case VHOST_USER_SET_VRING_KICK:
1065 case VHOST_USER_SET_VRING_CALL:
1066 case VHOST_USER_SET_VRING_ERR:
1067 vring_idx = msg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
1069 case VHOST_USER_SET_VRING_NUM:
1070 case VHOST_USER_SET_VRING_BASE:
1071 case VHOST_USER_SET_VRING_ENABLE:
1072 vring_idx = msg->payload.state.index;
1074 case VHOST_USER_SET_VRING_ADDR:
1075 vring_idx = msg->payload.addr.index;
1081 if (vring_idx >= VHOST_MAX_VRING) {
1082 RTE_LOG(ERR, VHOST_CONFIG,
1083 "invalid vring index: %u\n", vring_idx);
1087 if (dev->virtqueue[vring_idx])
1090 return alloc_vring_queue(dev, vring_idx);
1094 vhost_user_msg_handler(int vid, int fd)
1096 struct virtio_net *dev;
1097 struct VhostUserMsg msg;
1100 dev = get_device(vid);
1104 if (!dev->notify_ops) {
1105 dev->notify_ops = vhost_driver_callback_get(dev->ifname);
1106 if (!dev->notify_ops) {
1107 RTE_LOG(ERR, VHOST_CONFIG,
1108 "failed to get callback ops for driver %s\n",
1114 ret = read_vhost_message(fd, &msg);
1115 if (ret <= 0 || msg.request >= VHOST_USER_MAX) {
1117 RTE_LOG(ERR, VHOST_CONFIG,
1118 "vhost read message failed\n");
1120 RTE_LOG(INFO, VHOST_CONFIG,
1121 "vhost peer closed\n");
1123 RTE_LOG(ERR, VHOST_CONFIG,
1124 "vhost read incorrect message\n");
1130 RTE_LOG(INFO, VHOST_CONFIG, "read message %s\n",
1131 vhost_message_str[msg.request]);
1133 ret = vhost_user_check_and_alloc_queue_pair(dev, &msg);
1135 RTE_LOG(ERR, VHOST_CONFIG,
1136 "failed to alloc queue\n");
1140 switch (msg.request) {
1141 case VHOST_USER_GET_FEATURES:
1142 msg.payload.u64 = vhost_user_get_features(dev);
1143 msg.size = sizeof(msg.payload.u64);
1144 send_vhost_reply(fd, &msg);
1146 case VHOST_USER_SET_FEATURES:
1147 vhost_user_set_features(dev, msg.payload.u64);
1150 case VHOST_USER_GET_PROTOCOL_FEATURES:
1151 msg.payload.u64 = VHOST_USER_PROTOCOL_FEATURES;
1152 msg.size = sizeof(msg.payload.u64);
1153 send_vhost_reply(fd, &msg);
1155 case VHOST_USER_SET_PROTOCOL_FEATURES:
1156 vhost_user_set_protocol_features(dev, msg.payload.u64);
1159 case VHOST_USER_SET_OWNER:
1160 vhost_user_set_owner();
1162 case VHOST_USER_RESET_OWNER:
1163 vhost_user_reset_owner(dev);
1166 case VHOST_USER_SET_MEM_TABLE:
1167 ret = vhost_user_set_mem_table(dev, &msg);
1170 case VHOST_USER_SET_LOG_BASE:
1171 vhost_user_set_log_base(dev, &msg);
1173 /* it needs a reply */
1174 msg.size = sizeof(msg.payload.u64);
1175 send_vhost_reply(fd, &msg);
1177 case VHOST_USER_SET_LOG_FD:
1179 RTE_LOG(INFO, VHOST_CONFIG, "not implemented.\n");
1182 case VHOST_USER_SET_VRING_NUM:
1183 vhost_user_set_vring_num(dev, &msg);
1185 case VHOST_USER_SET_VRING_ADDR:
1186 vhost_user_set_vring_addr(dev, &msg);
1188 case VHOST_USER_SET_VRING_BASE:
1189 vhost_user_set_vring_base(dev, &msg);
1192 case VHOST_USER_GET_VRING_BASE:
1193 vhost_user_get_vring_base(dev, &msg);
1194 msg.size = sizeof(msg.payload.state);
1195 send_vhost_reply(fd, &msg);
1198 case VHOST_USER_SET_VRING_KICK:
1199 vhost_user_set_vring_kick(&dev, &msg);
1201 case VHOST_USER_SET_VRING_CALL:
1202 vhost_user_set_vring_call(dev, &msg);
1205 case VHOST_USER_SET_VRING_ERR:
1206 if (!(msg.payload.u64 & VHOST_USER_VRING_NOFD_MASK))
1208 RTE_LOG(INFO, VHOST_CONFIG, "not implemented\n");
1211 case VHOST_USER_GET_QUEUE_NUM:
1212 msg.payload.u64 = VHOST_MAX_QUEUE_PAIRS;
1213 msg.size = sizeof(msg.payload.u64);
1214 send_vhost_reply(fd, &msg);
1217 case VHOST_USER_SET_VRING_ENABLE:
1218 vhost_user_set_vring_enable(&dev, &msg);
1220 case VHOST_USER_SEND_RARP:
1221 vhost_user_send_rarp(dev, &msg);
1224 case VHOST_USER_NET_SET_MTU:
1225 ret = vhost_user_net_set_mtu(dev, &msg);
1228 case VHOST_USER_SET_SLAVE_REQ_FD:
1229 ret = vhost_user_set_req_fd(dev, &msg);
1232 case VHOST_USER_IOTLB_MSG:
1233 ret = vhost_user_iotlb_msg(dev, &msg);
1243 * The virtio_net struct might have been reallocated on a different
1244 * NUMA node, so dev pointer might no more be valid.
1246 dev = get_device(vid);
1248 if (msg.flags & VHOST_USER_NEED_REPLY) {
1249 msg.payload.u64 = !!ret;
1250 msg.size = sizeof(msg.payload.u64);
1251 send_vhost_reply(fd, &msg);
1254 if (!(dev->flags & VIRTIO_DEV_RUNNING) && virtio_is_ready(dev)) {
1255 dev->flags |= VIRTIO_DEV_READY;
1257 if (!(dev->flags & VIRTIO_DEV_RUNNING)) {
1258 if (dev->dequeue_zero_copy) {
1259 RTE_LOG(INFO, VHOST_CONFIG,
1260 "dequeue zero copy is enabled\n");
1263 if (dev->notify_ops->new_device(dev->vid) == 0)
1264 dev->flags |= VIRTIO_DEV_RUNNING;
1272 vhost_user_iotlb_miss(struct virtio_net *dev, uint64_t iova, uint8_t perm)
1275 struct VhostUserMsg msg = {
1276 .request = (enum VhostUserRequest)VHOST_USER_SLAVE_IOTLB_MSG,
1277 .flags = VHOST_USER_VERSION,
1278 .size = sizeof(msg.payload.iotlb),
1282 .type = VHOST_IOTLB_MISS,
1286 ret = send_vhost_message(dev->slave_req_fd, &msg);
1288 RTE_LOG(ERR, VHOST_CONFIG,
1289 "Failed to send IOTLB miss message (%d)\n",