1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2016 Intel Corporation
5 #include <linux/vhost.h>
6 #include <linux/virtio_net.h>
10 #ifdef RTE_LIBRTE_VHOST_NUMA
14 #include <rte_errno.h>
15 #include <rte_ethdev.h>
17 #include <rte_string_fns.h>
18 #include <rte_memory.h>
19 #include <rte_malloc.h>
20 #include <rte_vhost.h>
21 #include <rte_rwlock.h>
25 #include "vhost_user.h"
27 struct virtio_net *vhost_devices[MAX_VHOST_DEVICE];
29 /* Called with iotlb_lock read-locked */
31 __vhost_iova_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
32 uint64_t iova, uint64_t size, uint8_t perm)
34 uint64_t vva, tmp_size;
41 vva = vhost_user_iotlb_cache_find(vq, iova, &tmp_size, perm);
47 if (!vhost_user_iotlb_pending_miss(vq, iova, perm)) {
49 * iotlb_lock is read-locked for a full burst,
50 * but it only protects the iotlb cache.
51 * In case of IOTLB miss, we might block on the socket,
52 * which could cause a deadlock with QEMU if an IOTLB update
53 * is being handled. We can safely unlock here to avoid it.
55 vhost_user_iotlb_rd_unlock(vq);
57 vhost_user_iotlb_pending_insert(vq, iova, perm);
58 if (vhost_user_iotlb_miss(dev, iova, perm)) {
59 RTE_LOG(ERR, VHOST_CONFIG,
60 "IOTLB miss req failed for IOVA 0x%" PRIx64 "\n",
62 vhost_user_iotlb_pending_remove(vq, iova, 1, perm);
65 vhost_user_iotlb_rd_lock(vq);
72 cleanup_vq(struct vhost_virtqueue *vq, int destroy)
74 if ((vq->callfd >= 0) && (destroy != 0))
81 * Unmap any memory, close any file descriptors and
82 * free any memory owned by a device.
85 cleanup_device(struct virtio_net *dev, int destroy)
89 vhost_backend_cleanup(dev);
91 for (i = 0; i < dev->nr_vring; i++)
92 cleanup_vq(dev->virtqueue[i], destroy);
96 free_vq(struct vhost_virtqueue *vq)
98 rte_free(vq->shadow_used_ring);
99 rte_free(vq->batch_copy_elems);
100 rte_mempool_free(vq->iotlb_pool);
105 * Release virtqueues and device memory.
108 free_device(struct virtio_net *dev)
112 for (i = 0; i < dev->nr_vring; i++)
113 free_vq(dev->virtqueue[i]);
119 vring_translate(struct virtio_net *dev, struct vhost_virtqueue *vq)
123 if (!(dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)))
126 size = sizeof(struct vring_desc) * vq->size;
127 vq->desc = (struct vring_desc *)(uintptr_t)vhost_iova_to_vva(dev, vq,
128 vq->ring_addrs.desc_user_addr,
129 size, VHOST_ACCESS_RW);
133 size = sizeof(struct vring_avail);
134 size += sizeof(uint16_t) * vq->size;
135 vq->avail = (struct vring_avail *)(uintptr_t)vhost_iova_to_vva(dev, vq,
136 vq->ring_addrs.avail_user_addr,
137 size, VHOST_ACCESS_RW);
141 size = sizeof(struct vring_used);
142 size += sizeof(struct vring_used_elem) * vq->size;
143 vq->used = (struct vring_used *)(uintptr_t)vhost_iova_to_vva(dev, vq,
144 vq->ring_addrs.used_user_addr,
145 size, VHOST_ACCESS_RW);
156 vring_invalidate(struct virtio_net *dev, struct vhost_virtqueue *vq)
158 if (dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM))
159 vhost_user_iotlb_wr_lock(vq);
166 if (dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM))
167 vhost_user_iotlb_wr_unlock(vq);
171 init_vring_queue(struct virtio_net *dev, uint32_t vring_idx)
173 struct vhost_virtqueue *vq;
175 if (vring_idx >= VHOST_MAX_VRING) {
176 RTE_LOG(ERR, VHOST_CONFIG,
177 "Failed not init vring, out of bound (%d)\n",
182 vq = dev->virtqueue[vring_idx];
184 memset(vq, 0, sizeof(struct vhost_virtqueue));
186 vq->kickfd = VIRTIO_UNINITIALIZED_EVENTFD;
187 vq->callfd = VIRTIO_UNINITIALIZED_EVENTFD;
189 vhost_user_iotlb_init(dev, vring_idx);
190 /* Backends are set to -1 indicating an inactive device. */
193 TAILQ_INIT(&vq->zmbuf_list);
197 reset_vring_queue(struct virtio_net *dev, uint32_t vring_idx)
199 struct vhost_virtqueue *vq;
202 if (vring_idx >= VHOST_MAX_VRING) {
203 RTE_LOG(ERR, VHOST_CONFIG,
204 "Failed not init vring, out of bound (%d)\n",
209 vq = dev->virtqueue[vring_idx];
211 init_vring_queue(dev, vring_idx);
216 alloc_vring_queue(struct virtio_net *dev, uint32_t vring_idx)
218 struct vhost_virtqueue *vq;
220 vq = rte_malloc(NULL, sizeof(struct vhost_virtqueue), 0);
222 RTE_LOG(ERR, VHOST_CONFIG,
223 "Failed to allocate memory for vring:%u.\n", vring_idx);
227 dev->virtqueue[vring_idx] = vq;
228 init_vring_queue(dev, vring_idx);
229 rte_spinlock_init(&vq->access_lock);
237 * Reset some variables in device structure, while keeping few
238 * others untouched, such as vid, ifname, nr_vring: they
239 * should be same unless the device is removed.
242 reset_device(struct virtio_net *dev)
247 dev->protocol_features = 0;
248 dev->flags &= VIRTIO_DEV_BUILTIN_VIRTIO_NET;
250 for (i = 0; i < dev->nr_vring; i++)
251 reset_vring_queue(dev, i);
255 * Invoked when there is a new vhost-user connection established (when
256 * there is a new virtio device being attached).
259 vhost_new_device(void)
261 struct virtio_net *dev;
264 dev = rte_zmalloc(NULL, sizeof(struct virtio_net), 0);
266 RTE_LOG(ERR, VHOST_CONFIG,
267 "Failed to allocate memory for new 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");
282 vhost_devices[i] = dev;
284 dev->flags = VIRTIO_DEV_BUILTIN_VIRTIO_NET;
285 dev->slave_req_fd = -1;
291 * Invoked when there is the vhost-user connection is broken (when
292 * the virtio device is being detached).
295 vhost_destroy_device(int vid)
297 struct virtio_net *dev = get_device(vid);
302 if (dev->flags & VIRTIO_DEV_RUNNING) {
303 dev->flags &= ~VIRTIO_DEV_RUNNING;
304 dev->notify_ops->destroy_device(vid);
307 cleanup_device(dev, 1);
310 vhost_devices[vid] = NULL;
314 vhost_set_ifname(int vid, const char *if_name, unsigned int if_len)
316 struct virtio_net *dev;
319 dev = get_device(vid);
323 len = if_len > sizeof(dev->ifname) ?
324 sizeof(dev->ifname) : if_len;
326 strncpy(dev->ifname, if_name, len);
327 dev->ifname[sizeof(dev->ifname) - 1] = '\0';
331 vhost_enable_dequeue_zero_copy(int vid)
333 struct virtio_net *dev = get_device(vid);
338 dev->dequeue_zero_copy = 1;
342 vhost_set_builtin_virtio_net(int vid, bool enable)
344 struct virtio_net *dev = get_device(vid);
350 dev->flags |= VIRTIO_DEV_BUILTIN_VIRTIO_NET;
352 dev->flags &= ~VIRTIO_DEV_BUILTIN_VIRTIO_NET;
356 rte_vhost_get_mtu(int vid, uint16_t *mtu)
358 struct virtio_net *dev = get_device(vid);
363 if (!(dev->flags & VIRTIO_DEV_READY))
366 if (!(dev->features & (1ULL << VIRTIO_NET_F_MTU)))
375 rte_vhost_get_numa_node(int vid)
377 #ifdef RTE_LIBRTE_VHOST_NUMA
378 struct virtio_net *dev = get_device(vid);
385 ret = get_mempolicy(&numa_node, NULL, 0, dev,
386 MPOL_F_NODE | MPOL_F_ADDR);
388 RTE_LOG(ERR, VHOST_CONFIG,
389 "(%d) failed to query numa node: %s\n",
390 vid, rte_strerror(errno));
402 rte_vhost_get_queue_num(int vid)
404 struct virtio_net *dev = get_device(vid);
409 return dev->nr_vring / 2;
413 rte_vhost_get_vring_num(int vid)
415 struct virtio_net *dev = get_device(vid);
420 return dev->nr_vring;
424 rte_vhost_get_ifname(int vid, char *buf, size_t len)
426 struct virtio_net *dev = get_device(vid);
431 len = RTE_MIN(len, sizeof(dev->ifname));
433 strncpy(buf, dev->ifname, len);
440 rte_vhost_get_negotiated_features(int vid, uint64_t *features)
442 struct virtio_net *dev;
444 dev = get_device(vid);
448 *features = dev->features;
453 rte_vhost_get_mem_table(int vid, struct rte_vhost_memory **mem)
455 struct virtio_net *dev;
456 struct rte_vhost_memory *m;
459 dev = get_device(vid);
463 size = dev->mem->nregions * sizeof(struct rte_vhost_mem_region);
464 m = malloc(sizeof(struct rte_vhost_memory) + size);
468 m->nregions = dev->mem->nregions;
469 memcpy(m->regions, dev->mem->regions, size);
476 rte_vhost_get_vhost_vring(int vid, uint16_t vring_idx,
477 struct rte_vhost_vring *vring)
479 struct virtio_net *dev;
480 struct vhost_virtqueue *vq;
482 dev = get_device(vid);
486 if (vring_idx >= VHOST_MAX_VRING)
489 vq = dev->virtqueue[vring_idx];
493 vring->desc = vq->desc;
494 vring->avail = vq->avail;
495 vring->used = vq->used;
496 vring->log_guest_addr = vq->log_guest_addr;
498 vring->callfd = vq->callfd;
499 vring->kickfd = vq->kickfd;
500 vring->size = vq->size;
506 rte_vhost_vring_call(int vid, uint16_t vring_idx)
508 struct virtio_net *dev;
509 struct vhost_virtqueue *vq;
511 dev = get_device(vid);
515 if (vring_idx >= VHOST_MAX_VRING)
518 vq = dev->virtqueue[vring_idx];
522 vhost_vring_call(dev, vq);
527 rte_vhost_avail_entries(int vid, uint16_t queue_id)
529 struct virtio_net *dev;
530 struct vhost_virtqueue *vq;
532 dev = get_device(vid);
536 vq = dev->virtqueue[queue_id];
540 return *(volatile uint16_t *)&vq->avail->idx - vq->last_used_idx;
544 rte_vhost_enable_guest_notification(int vid, uint16_t queue_id, int enable)
546 struct virtio_net *dev = get_device(vid);
552 RTE_LOG(ERR, VHOST_CONFIG,
553 "guest notification isn't supported.\n");
557 dev->virtqueue[queue_id]->used->flags = VRING_USED_F_NO_NOTIFY;
562 rte_vhost_log_write(int vid, uint64_t addr, uint64_t len)
564 struct virtio_net *dev = get_device(vid);
569 vhost_log_write(dev, addr, len);
573 rte_vhost_log_used_vring(int vid, uint16_t vring_idx,
574 uint64_t offset, uint64_t len)
576 struct virtio_net *dev;
577 struct vhost_virtqueue *vq;
579 dev = get_device(vid);
583 if (vring_idx >= VHOST_MAX_VRING)
585 vq = dev->virtqueue[vring_idx];
589 vhost_log_used_vring(dev, vq, offset, len);
593 rte_vhost_rx_queue_count(int vid, uint16_t qid)
595 struct virtio_net *dev;
596 struct vhost_virtqueue *vq;
598 dev = get_device(vid);
602 if (unlikely(qid >= dev->nr_vring || (qid & 1) == 0)) {
603 RTE_LOG(ERR, VHOST_DATA, "(%d) %s: invalid virtqueue idx %d.\n",
604 dev->vid, __func__, qid);
608 vq = dev->virtqueue[qid];
612 if (unlikely(vq->enabled == 0 || vq->avail == NULL))
615 return *((volatile uint16_t *)&vq->avail->idx) - vq->last_avail_idx;