4 * Copyright(c) 2010-2014 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.
34 #include <linux/vhost.h>
35 #include <linux/virtio_net.h>
42 #ifdef RTE_LIBRTE_VHOST_NUMA
46 #include <sys/socket.h>
48 #include <rte_ethdev.h>
50 #include <rte_string_fns.h>
51 #include <rte_memory.h>
52 #include <rte_malloc.h>
53 #include <rte_virtio_net.h>
55 #include "vhost-net.h"
56 #include "virtio-net.h"
58 #define MAX_VHOST_DEVICE 1024
59 static struct virtio_net *vhost_devices[MAX_VHOST_DEVICE];
61 /* device ops to add/remove device to/from data core. */
62 struct virtio_net_device_ops const *notify_ops;
64 #define VHOST_USER_F_PROTOCOL_FEATURES 30
66 /* Features supported by this lib. */
67 #define VHOST_SUPPORTED_FEATURES ((1ULL << VIRTIO_NET_F_MRG_RXBUF) | \
68 (1ULL << VIRTIO_NET_F_CTRL_VQ) | \
69 (1ULL << VIRTIO_NET_F_CTRL_RX) | \
70 (1ULL << VIRTIO_NET_F_GUEST_ANNOUNCE) | \
71 (VHOST_SUPPORTS_MQ) | \
72 (1ULL << VIRTIO_F_VERSION_1) | \
73 (1ULL << VHOST_F_LOG_ALL) | \
74 (1ULL << VHOST_USER_F_PROTOCOL_FEATURES) | \
75 (1ULL << VIRTIO_NET_F_HOST_TSO4) | \
76 (1ULL << VIRTIO_NET_F_HOST_TSO6) | \
77 (1ULL << VIRTIO_NET_F_CSUM) | \
78 (1ULL << VIRTIO_NET_F_GUEST_CSUM) | \
79 (1ULL << VIRTIO_NET_F_GUEST_TSO4) | \
80 (1ULL << VIRTIO_NET_F_GUEST_TSO6))
82 static uint64_t VHOST_FEATURES = VHOST_SUPPORTED_FEATURES;
86 * Converts QEMU virtual address to Vhost virtual address. This function is
87 * used to convert the ring addresses to our address space.
90 qva_to_vva(struct virtio_net *dev, uint64_t qemu_va)
92 struct virtio_memory_regions *region;
93 uint64_t vhost_va = 0;
94 uint32_t regionidx = 0;
96 /* Find the region where the address lives. */
97 for (regionidx = 0; regionidx < dev->mem->nregions; regionidx++) {
98 region = &dev->mem->regions[regionidx];
99 if ((qemu_va >= region->userspace_address) &&
100 (qemu_va <= region->userspace_address +
101 region->memory_size)) {
102 vhost_va = qemu_va + region->guest_phys_address +
103 region->address_offset -
104 region->userspace_address;
113 get_device(struct vhost_device_ctx ctx)
115 struct virtio_net *dev = vhost_devices[ctx.fh];
117 if (unlikely(!dev)) {
118 RTE_LOG(ERR, VHOST_CONFIG,
119 "(%"PRIu64") device not found.\n", ctx.fh);
126 cleanup_vq(struct vhost_virtqueue *vq, int destroy)
128 if ((vq->callfd >= 0) && (destroy != 0))
135 * Unmap any memory, close any file descriptors and
136 * free any memory owned by a device.
139 cleanup_device(struct virtio_net *dev, int destroy)
143 vhost_backend_cleanup(dev);
145 for (i = 0; i < dev->virt_qp_nb; i++) {
146 cleanup_vq(dev->virtqueue[i * VIRTIO_QNUM + VIRTIO_RXQ], destroy);
147 cleanup_vq(dev->virtqueue[i * VIRTIO_QNUM + VIRTIO_TXQ], destroy);
152 * Release virtqueues and device memory.
155 free_device(struct virtio_net *dev)
159 for (i = 0; i < dev->virt_qp_nb; i++)
160 rte_free(dev->virtqueue[i * VIRTIO_QNUM]);
166 init_vring_queue(struct vhost_virtqueue *vq, int qp_idx)
168 memset(vq, 0, sizeof(struct vhost_virtqueue));
170 vq->kickfd = VIRTIO_UNINITIALIZED_EVENTFD;
171 vq->callfd = VIRTIO_UNINITIALIZED_EVENTFD;
173 /* Backends are set to -1 indicating an inactive device. */
176 /* always set the default vq pair to enabled */
182 init_vring_queue_pair(struct virtio_net *dev, uint32_t qp_idx)
184 uint32_t base_idx = qp_idx * VIRTIO_QNUM;
186 init_vring_queue(dev->virtqueue[base_idx + VIRTIO_RXQ], qp_idx);
187 init_vring_queue(dev->virtqueue[base_idx + VIRTIO_TXQ], qp_idx);
191 reset_vring_queue(struct vhost_virtqueue *vq, int qp_idx)
196 init_vring_queue(vq, qp_idx);
201 reset_vring_queue_pair(struct virtio_net *dev, uint32_t qp_idx)
203 uint32_t base_idx = qp_idx * VIRTIO_QNUM;
205 reset_vring_queue(dev->virtqueue[base_idx + VIRTIO_RXQ], qp_idx);
206 reset_vring_queue(dev->virtqueue[base_idx + VIRTIO_TXQ], qp_idx);
210 alloc_vring_queue_pair(struct virtio_net *dev, uint32_t qp_idx)
212 struct vhost_virtqueue *virtqueue = NULL;
213 uint32_t virt_rx_q_idx = qp_idx * VIRTIO_QNUM + VIRTIO_RXQ;
214 uint32_t virt_tx_q_idx = qp_idx * VIRTIO_QNUM + VIRTIO_TXQ;
216 virtqueue = rte_malloc(NULL,
217 sizeof(struct vhost_virtqueue) * VIRTIO_QNUM, 0);
218 if (virtqueue == NULL) {
219 RTE_LOG(ERR, VHOST_CONFIG,
220 "Failed to allocate memory for virt qp:%d.\n", qp_idx);
224 dev->virtqueue[virt_rx_q_idx] = virtqueue;
225 dev->virtqueue[virt_tx_q_idx] = virtqueue + VIRTIO_TXQ;
227 init_vring_queue_pair(dev, qp_idx);
229 dev->virt_qp_nb += 1;
235 * Reset some variables in device structure, while keeping few
236 * others untouched, such as device_fh, ifname, virt_qp_nb: they
237 * should be same unless the device is removed.
240 reset_device(struct virtio_net *dev)
245 dev->protocol_features = 0;
248 for (i = 0; i < dev->virt_qp_nb; i++)
249 reset_vring_queue_pair(dev, i);
253 * Function is called from the CUSE open function. The device structure is
254 * initialised and a new entry is added to the device configuration linked
258 vhost_new_device(struct vhost_device_ctx ctx)
260 struct virtio_net *dev;
263 dev = rte_zmalloc(NULL, sizeof(struct virtio_net), 0);
265 RTE_LOG(ERR, VHOST_CONFIG,
266 "(%"PRIu64") Failed to allocate memory for dev.\n",
271 for (i = 0; i < MAX_VHOST_DEVICE; i++) {
272 if (vhost_devices[i] == NULL)
275 if (i == MAX_VHOST_DEVICE) {
276 RTE_LOG(ERR, VHOST_CONFIG,
277 "Failed to find a free slot for new device.\n");
281 vhost_devices[i] = dev;
288 * Function is called from the CUSE release function. This function will
289 * cleanup the device and remove it from device configuration linked list.
292 vhost_destroy_device(struct vhost_device_ctx ctx)
294 struct virtio_net *dev = get_device(ctx);
296 if (dev->flags & VIRTIO_DEV_RUNNING)
297 notify_ops->destroy_device(dev);
299 cleanup_device(dev, 1);
302 vhost_devices[ctx.fh] = NULL;
306 vhost_set_ifname(struct vhost_device_ctx ctx,
307 const char *if_name, unsigned int if_len)
309 struct virtio_net *dev;
312 dev = get_device(ctx);
316 len = if_len > sizeof(dev->ifname) ?
317 sizeof(dev->ifname) : if_len;
319 strncpy(dev->ifname, if_name, len);
324 * Called from CUSE IOCTL: VHOST_SET_OWNER
325 * This function just returns success at the moment unless
326 * the device hasn't been initialised.
329 vhost_set_owner(struct vhost_device_ctx ctx)
331 struct virtio_net *dev;
333 dev = get_device(ctx);
341 * Called from CUSE IOCTL: VHOST_RESET_OWNER
344 vhost_reset_owner(struct vhost_device_ctx ctx)
346 struct virtio_net *dev;
348 dev = get_device(ctx);
352 if (dev->flags & VIRTIO_DEV_RUNNING)
353 notify_ops->destroy_device(dev);
355 cleanup_device(dev, 0);
361 * Called from CUSE IOCTL: VHOST_GET_FEATURES
362 * The features that we support are requested.
365 vhost_get_features(struct vhost_device_ctx ctx, uint64_t *pu)
367 struct virtio_net *dev;
369 dev = get_device(ctx);
373 /* Send our supported features. */
374 *pu = VHOST_FEATURES;
379 * Called from CUSE IOCTL: VHOST_SET_FEATURES
380 * We receive the negotiated features supported by us and the virtio device.
383 vhost_set_features(struct vhost_device_ctx ctx, uint64_t *pu)
385 struct virtio_net *dev;
389 dev = get_device(ctx);
392 if (*pu & ~VHOST_FEATURES)
397 ((1 << VIRTIO_NET_F_MRG_RXBUF) | (1ULL << VIRTIO_F_VERSION_1))) {
398 vhost_hlen = sizeof(struct virtio_net_hdr_mrg_rxbuf);
400 vhost_hlen = sizeof(struct virtio_net_hdr);
402 LOG_DEBUG(VHOST_CONFIG,
403 "(%"PRIu64") Mergeable RX buffers %s, virtio 1 %s\n",
405 (dev->features & (1 << VIRTIO_NET_F_MRG_RXBUF)) ? "on" : "off",
406 (dev->features & (1ULL << VIRTIO_F_VERSION_1)) ? "on" : "off");
408 for (i = 0; i < dev->virt_qp_nb; i++) {
409 uint16_t base_idx = i * VIRTIO_QNUM;
411 dev->virtqueue[base_idx + VIRTIO_RXQ]->vhost_hlen = vhost_hlen;
412 dev->virtqueue[base_idx + VIRTIO_TXQ]->vhost_hlen = vhost_hlen;
419 * Called from CUSE IOCTL: VHOST_SET_VRING_NUM
420 * The virtio device sends us the size of the descriptor ring.
423 vhost_set_vring_num(struct vhost_device_ctx ctx,
424 struct vhost_vring_state *state)
426 struct virtio_net *dev;
428 dev = get_device(ctx);
432 /* State->index refers to the queue index. The txq is 1, rxq is 0. */
433 dev->virtqueue[state->index]->size = state->num;
439 * Reallocate virtio_dev and vhost_virtqueue data structure to make them on the
440 * same numa node as the memory of vring descriptor.
442 #ifdef RTE_LIBRTE_VHOST_NUMA
443 static struct virtio_net*
444 numa_realloc(struct virtio_net *dev, int index)
446 int oldnode, newnode;
447 struct virtio_net *old_dev;
448 struct vhost_virtqueue *old_vq, *vq;
452 * vq is allocated on pairs, we should try to do realloc
453 * on first queue of one queue pair only.
455 if (index % VIRTIO_QNUM != 0)
459 vq = old_vq = dev->virtqueue[index];
461 ret = get_mempolicy(&newnode, NULL, 0, old_vq->desc,
462 MPOL_F_NODE | MPOL_F_ADDR);
464 /* check if we need to reallocate vq */
465 ret |= get_mempolicy(&oldnode, NULL, 0, old_vq,
466 MPOL_F_NODE | MPOL_F_ADDR);
468 RTE_LOG(ERR, VHOST_CONFIG,
469 "Unable to get vq numa information.\n");
472 if (oldnode != newnode) {
473 RTE_LOG(INFO, VHOST_CONFIG,
474 "reallocate vq from %d to %d node\n", oldnode, newnode);
475 vq = rte_malloc_socket(NULL, sizeof(*vq) * VIRTIO_QNUM, 0,
480 memcpy(vq, old_vq, sizeof(*vq) * VIRTIO_QNUM);
484 /* check if we need to reallocate dev */
485 ret = get_mempolicy(&oldnode, NULL, 0, old_dev,
486 MPOL_F_NODE | MPOL_F_ADDR);
488 RTE_LOG(ERR, VHOST_CONFIG,
489 "Unable to get dev numa information.\n");
492 if (oldnode != newnode) {
493 RTE_LOG(INFO, VHOST_CONFIG,
494 "reallocate dev from %d to %d node\n",
496 dev = rte_malloc_socket(NULL, sizeof(*dev), 0, newnode);
502 memcpy(dev, old_dev, sizeof(*dev));
507 dev->virtqueue[index] = vq;
508 dev->virtqueue[index + 1] = vq + 1;
509 vhost_devices[dev->device_fh] = dev;
514 static struct virtio_net*
515 numa_realloc(struct virtio_net *dev, int index __rte_unused)
522 * Called from CUSE IOCTL: VHOST_SET_VRING_ADDR
523 * The virtio device sends us the desc, used and avail ring addresses.
524 * This function then converts these to our address space.
527 vhost_set_vring_addr(struct vhost_device_ctx ctx, struct vhost_vring_addr *addr)
529 struct virtio_net *dev;
530 struct vhost_virtqueue *vq;
532 dev = get_device(ctx);
533 if ((dev == NULL) || (dev->mem == NULL))
536 /* addr->index refers to the queue index. The txq 1, rxq is 0. */
537 vq = dev->virtqueue[addr->index];
539 /* The addresses are converted from QEMU virtual to Vhost virtual. */
540 vq->desc = (struct vring_desc *)(uintptr_t)qva_to_vva(dev,
541 addr->desc_user_addr);
543 RTE_LOG(ERR, VHOST_CONFIG,
544 "(%"PRIu64") Failed to find desc ring address.\n",
549 dev = numa_realloc(dev, addr->index);
550 vq = dev->virtqueue[addr->index];
552 vq->avail = (struct vring_avail *)(uintptr_t)qva_to_vva(dev,
553 addr->avail_user_addr);
554 if (vq->avail == 0) {
555 RTE_LOG(ERR, VHOST_CONFIG,
556 "(%"PRIu64") Failed to find avail ring address.\n",
561 vq->used = (struct vring_used *)(uintptr_t)qva_to_vva(dev,
562 addr->used_user_addr);
564 RTE_LOG(ERR, VHOST_CONFIG,
565 "(%"PRIu64") Failed to find used ring address.\n",
570 vq->log_guest_addr = addr->log_guest_addr;
572 LOG_DEBUG(VHOST_CONFIG, "(%"PRIu64") mapped address desc: %p\n",
573 dev->device_fh, vq->desc);
574 LOG_DEBUG(VHOST_CONFIG, "(%"PRIu64") mapped address avail: %p\n",
575 dev->device_fh, vq->avail);
576 LOG_DEBUG(VHOST_CONFIG, "(%"PRIu64") mapped address used: %p\n",
577 dev->device_fh, vq->used);
578 LOG_DEBUG(VHOST_CONFIG, "(%"PRIu64") log_guest_addr: %"PRIx64"\n",
579 dev->device_fh, vq->log_guest_addr);
585 * Called from CUSE IOCTL: VHOST_SET_VRING_BASE
586 * The virtio device sends us the available ring last used index.
589 vhost_set_vring_base(struct vhost_device_ctx ctx,
590 struct vhost_vring_state *state)
592 struct virtio_net *dev;
594 dev = get_device(ctx);
598 /* State->index refers to the queue index. The txq is 1, rxq is 0. */
599 dev->virtqueue[state->index]->last_used_idx = state->num;
600 dev->virtqueue[state->index]->last_used_idx_res = state->num;
606 * Called from CUSE IOCTL: VHOST_GET_VRING_BASE
607 * We send the virtio device our available ring last used index.
610 vhost_get_vring_base(struct vhost_device_ctx ctx, uint32_t index,
611 struct vhost_vring_state *state)
613 struct virtio_net *dev;
615 dev = get_device(ctx);
619 state->index = index;
620 /* State->index refers to the queue index. The txq is 1, rxq is 0. */
621 state->num = dev->virtqueue[state->index]->last_used_idx;
628 * Called from CUSE IOCTL: VHOST_SET_VRING_CALL
629 * The virtio device sends an eventfd to interrupt the guest. This fd gets
630 * copied into our process space.
633 vhost_set_vring_call(struct vhost_device_ctx ctx, struct vhost_vring_file *file)
635 struct virtio_net *dev;
636 struct vhost_virtqueue *vq;
637 uint32_t cur_qp_idx = file->index / VIRTIO_QNUM;
639 dev = get_device(ctx);
644 * FIXME: VHOST_SET_VRING_CALL is the first per-vring message
645 * we get, so we do vring queue pair allocation here.
647 if (cur_qp_idx + 1 > dev->virt_qp_nb) {
648 if (alloc_vring_queue_pair(dev, cur_qp_idx) < 0)
652 /* file->index refers to the queue index. The txq is 1, rxq is 0. */
653 vq = dev->virtqueue[file->index];
659 vq->callfd = file->fd;
665 * Called from CUSE IOCTL: VHOST_SET_VRING_KICK
666 * The virtio device sends an eventfd that it can use to notify us.
667 * This fd gets copied into our process space.
670 vhost_set_vring_kick(struct vhost_device_ctx ctx, struct vhost_vring_file *file)
672 struct virtio_net *dev;
673 struct vhost_virtqueue *vq;
675 dev = get_device(ctx);
679 /* file->index refers to the queue index. The txq is 1, rxq is 0. */
680 vq = dev->virtqueue[file->index];
685 vq->kickfd = file->fd;
691 * Called from CUSE IOCTL: VHOST_NET_SET_BACKEND
692 * To complete device initialisation when the virtio driver is loaded,
693 * we are provided with a valid fd for a tap device (not used by us).
694 * If this happens then we can add the device to a data core.
695 * When the virtio driver is removed we get fd=-1.
696 * At that point we remove the device from the data core.
697 * The device will still exist in the device configuration linked list.
700 vhost_set_backend(struct vhost_device_ctx ctx, struct vhost_vring_file *file)
702 struct virtio_net *dev;
704 dev = get_device(ctx);
708 /* file->index refers to the queue index. The txq is 1, rxq is 0. */
709 dev->virtqueue[file->index]->backend = file->fd;
712 * If the device isn't already running and both backend fds are set,
715 if (!(dev->flags & VIRTIO_DEV_RUNNING)) {
716 if (((int)dev->virtqueue[VIRTIO_TXQ]->backend != VIRTIO_DEV_STOPPED) &&
717 ((int)dev->virtqueue[VIRTIO_RXQ]->backend != VIRTIO_DEV_STOPPED)) {
718 return notify_ops->new_device(dev);
720 /* Otherwise we remove it. */
722 if (file->fd == VIRTIO_DEV_STOPPED)
723 notify_ops->destroy_device(dev);
727 int rte_vhost_enable_guest_notification(struct virtio_net *dev,
728 uint16_t queue_id, int enable)
731 RTE_LOG(ERR, VHOST_CONFIG,
732 "guest notification isn't supported.\n");
736 dev->virtqueue[queue_id]->used->flags = VRING_USED_F_NO_NOTIFY;
740 uint64_t rte_vhost_feature_get(void)
742 return VHOST_FEATURES;
745 int rte_vhost_feature_disable(uint64_t feature_mask)
747 VHOST_FEATURES = VHOST_FEATURES & ~feature_mask;
751 int rte_vhost_feature_enable(uint64_t feature_mask)
753 if ((feature_mask & VHOST_SUPPORTED_FEATURES) == feature_mask) {
754 VHOST_FEATURES = VHOST_FEATURES | feature_mask;
761 * Register ops so that we can add/remove device to data core.
764 rte_vhost_driver_callback_register(struct virtio_net_device_ops const * const ops)