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.
34 #include <linux/vhost.h>
35 #include <linux/virtio_net.h>
39 #ifdef RTE_LIBRTE_VHOST_NUMA
43 #include <rte_errno.h>
44 #include <rte_ethdev.h>
46 #include <rte_string_fns.h>
47 #include <rte_memory.h>
48 #include <rte_malloc.h>
49 #include <rte_vhost.h>
50 #include <rte_rwlock.h>
54 #include "vhost_user.h"
56 struct virtio_net *vhost_devices[MAX_VHOST_DEVICE];
58 /* Called with iotlb_lock read-locked */
60 __vhost_iova_to_vva(struct virtio_net *dev, struct vhost_virtqueue *vq,
61 uint64_t iova, uint64_t size, uint8_t perm)
63 uint64_t vva, tmp_size;
70 vva = vhost_user_iotlb_cache_find(vq, iova, &tmp_size, perm);
76 if (!vhost_user_iotlb_pending_miss(vq, iova, perm)) {
78 * iotlb_lock is read-locked for a full burst,
79 * but it only protects the iotlb cache.
80 * In case of IOTLB miss, we might block on the socket,
81 * which could cause a deadlock with QEMU if an IOTLB update
82 * is being handled. We can safely unlock here to avoid it.
84 vhost_user_iotlb_rd_unlock(vq);
86 vhost_user_iotlb_pending_insert(vq, iova, perm);
87 if (vhost_user_iotlb_miss(dev, iova, perm)) {
88 RTE_LOG(ERR, VHOST_CONFIG,
89 "IOTLB miss req failed for IOVA 0x%" PRIx64 "\n",
91 vhost_user_iotlb_pending_remove(vq, iova, 1, perm);
94 vhost_user_iotlb_rd_lock(vq);
103 struct virtio_net *dev = vhost_devices[vid];
105 if (unlikely(!dev)) {
106 RTE_LOG(ERR, VHOST_CONFIG,
107 "(%d) device not found.\n", vid);
114 cleanup_vq(struct vhost_virtqueue *vq, int destroy)
116 if ((vq->callfd >= 0) && (destroy != 0))
123 * Unmap any memory, close any file descriptors and
124 * free any memory owned by a device.
127 cleanup_device(struct virtio_net *dev, int destroy)
131 vhost_backend_cleanup(dev);
133 for (i = 0; i < dev->nr_vring; i++)
134 cleanup_vq(dev->virtqueue[i], destroy);
138 * Release virtqueues and device memory.
141 free_device(struct virtio_net *dev)
144 struct vhost_virtqueue *vq;
146 for (i = 0; i < dev->nr_vring; i++) {
147 vq = dev->virtqueue[i];
149 rte_free(vq->shadow_used_ring);
150 rte_free(vq->batch_copy_elems);
151 rte_mempool_free(vq->iotlb_pool);
159 vring_translate(struct virtio_net *dev, struct vhost_virtqueue *vq)
163 if (!(dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)))
166 size = sizeof(struct vring_desc) * vq->size;
167 vq->desc = (struct vring_desc *)(uintptr_t)vhost_iova_to_vva(dev, vq,
168 vq->ring_addrs.desc_user_addr,
169 size, VHOST_ACCESS_RW);
173 size = sizeof(struct vring_avail);
174 size += sizeof(uint16_t) * vq->size;
175 vq->avail = (struct vring_avail *)(uintptr_t)vhost_iova_to_vva(dev, vq,
176 vq->ring_addrs.avail_user_addr,
177 size, VHOST_ACCESS_RW);
181 size = sizeof(struct vring_used);
182 size += sizeof(struct vring_used_elem) * vq->size;
183 vq->used = (struct vring_used *)(uintptr_t)vhost_iova_to_vva(dev, vq,
184 vq->ring_addrs.used_user_addr,
185 size, VHOST_ACCESS_RW);
196 vring_invalidate(struct virtio_net *dev, struct vhost_virtqueue *vq)
198 if (dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM))
199 vhost_user_iotlb_wr_lock(vq);
206 if (dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM))
207 vhost_user_iotlb_wr_unlock(vq);
211 init_vring_queue(struct virtio_net *dev, uint32_t vring_idx)
213 struct vhost_virtqueue *vq;
215 if (vring_idx >= VHOST_MAX_VRING) {
216 RTE_LOG(ERR, VHOST_CONFIG,
217 "Failed not init vring, out of bound (%d)\n",
222 vq = dev->virtqueue[vring_idx];
224 memset(vq, 0, sizeof(struct vhost_virtqueue));
226 vq->kickfd = VIRTIO_UNINITIALIZED_EVENTFD;
227 vq->callfd = VIRTIO_UNINITIALIZED_EVENTFD;
229 vhost_user_iotlb_init(dev, vring_idx);
230 /* Backends are set to -1 indicating an inactive device. */
233 TAILQ_INIT(&vq->zmbuf_list);
237 reset_vring_queue(struct virtio_net *dev, uint32_t vring_idx)
239 struct vhost_virtqueue *vq;
242 if (vring_idx >= VHOST_MAX_VRING) {
243 RTE_LOG(ERR, VHOST_CONFIG,
244 "Failed not init vring, out of bound (%d)\n",
249 vq = dev->virtqueue[vring_idx];
251 init_vring_queue(dev, vring_idx);
256 alloc_vring_queue(struct virtio_net *dev, uint32_t vring_idx)
258 struct vhost_virtqueue *vq;
260 vq = rte_malloc(NULL, sizeof(struct vhost_virtqueue), 0);
262 RTE_LOG(ERR, VHOST_CONFIG,
263 "Failed to allocate memory for vring:%u.\n", vring_idx);
267 dev->virtqueue[vring_idx] = vq;
268 init_vring_queue(dev, vring_idx);
269 rte_spinlock_init(&vq->access_lock);
277 * Reset some variables in device structure, while keeping few
278 * others untouched, such as vid, ifname, nr_vring: they
279 * should be same unless the device is removed.
282 reset_device(struct virtio_net *dev)
287 dev->protocol_features = 0;
290 for (i = 0; i < dev->nr_vring; i++)
291 reset_vring_queue(dev, i);
295 * Invoked when there is a new vhost-user connection established (when
296 * there is a new virtio device being attached).
299 vhost_new_device(void)
301 struct virtio_net *dev;
304 dev = rte_zmalloc(NULL, sizeof(struct virtio_net), 0);
306 RTE_LOG(ERR, VHOST_CONFIG,
307 "Failed to allocate memory for new dev.\n");
311 for (i = 0; i < MAX_VHOST_DEVICE; i++) {
312 if (vhost_devices[i] == NULL)
315 if (i == MAX_VHOST_DEVICE) {
316 RTE_LOG(ERR, VHOST_CONFIG,
317 "Failed to find a free slot for new device.\n");
322 vhost_devices[i] = dev;
324 dev->slave_req_fd = -1;
330 * Invoked when there is the vhost-user connection is broken (when
331 * the virtio device is being detached).
334 vhost_destroy_device(int vid)
336 struct virtio_net *dev = get_device(vid);
341 if (dev->flags & VIRTIO_DEV_RUNNING) {
342 dev->flags &= ~VIRTIO_DEV_RUNNING;
343 dev->notify_ops->destroy_device(vid);
346 cleanup_device(dev, 1);
349 vhost_devices[vid] = NULL;
353 vhost_set_ifname(int vid, const char *if_name, unsigned int if_len)
355 struct virtio_net *dev;
358 dev = get_device(vid);
362 len = if_len > sizeof(dev->ifname) ?
363 sizeof(dev->ifname) : if_len;
365 strncpy(dev->ifname, if_name, len);
366 dev->ifname[sizeof(dev->ifname) - 1] = '\0';
370 vhost_enable_dequeue_zero_copy(int vid)
372 struct virtio_net *dev = get_device(vid);
377 dev->dequeue_zero_copy = 1;
381 rte_vhost_get_mtu(int vid, uint16_t *mtu)
383 struct virtio_net *dev = get_device(vid);
388 if (!(dev->flags & VIRTIO_DEV_READY))
391 if (!(dev->features & (1ULL << VIRTIO_NET_F_MTU)))
400 rte_vhost_get_numa_node(int vid)
402 #ifdef RTE_LIBRTE_VHOST_NUMA
403 struct virtio_net *dev = get_device(vid);
410 ret = get_mempolicy(&numa_node, NULL, 0, dev,
411 MPOL_F_NODE | MPOL_F_ADDR);
413 RTE_LOG(ERR, VHOST_CONFIG,
414 "(%d) failed to query numa node: %s\n",
415 vid, rte_strerror(errno));
427 rte_vhost_get_queue_num(int vid)
429 struct virtio_net *dev = get_device(vid);
434 return dev->nr_vring / 2;
438 rte_vhost_get_vring_num(int vid)
440 struct virtio_net *dev = get_device(vid);
445 return dev->nr_vring;
449 rte_vhost_get_ifname(int vid, char *buf, size_t len)
451 struct virtio_net *dev = get_device(vid);
456 len = RTE_MIN(len, sizeof(dev->ifname));
458 strncpy(buf, dev->ifname, len);
465 rte_vhost_get_negotiated_features(int vid, uint64_t *features)
467 struct virtio_net *dev;
469 dev = get_device(vid);
473 *features = dev->features;
478 rte_vhost_get_mem_table(int vid, struct rte_vhost_memory **mem)
480 struct virtio_net *dev;
481 struct rte_vhost_memory *m;
484 dev = get_device(vid);
488 size = dev->mem->nregions * sizeof(struct rte_vhost_mem_region);
489 m = malloc(sizeof(struct rte_vhost_memory) + size);
493 m->nregions = dev->mem->nregions;
494 memcpy(m->regions, dev->mem->regions, size);
501 rte_vhost_get_vhost_vring(int vid, uint16_t vring_idx,
502 struct rte_vhost_vring *vring)
504 struct virtio_net *dev;
505 struct vhost_virtqueue *vq;
507 dev = get_device(vid);
511 if (vring_idx >= VHOST_MAX_VRING)
514 vq = dev->virtqueue[vring_idx];
518 vring->desc = vq->desc;
519 vring->avail = vq->avail;
520 vring->used = vq->used;
521 vring->log_guest_addr = vq->log_guest_addr;
523 vring->callfd = vq->callfd;
524 vring->kickfd = vq->kickfd;
525 vring->size = vq->size;
531 rte_vhost_avail_entries(int vid, uint16_t queue_id)
533 struct virtio_net *dev;
534 struct vhost_virtqueue *vq;
536 dev = get_device(vid);
540 vq = dev->virtqueue[queue_id];
544 return *(volatile uint16_t *)&vq->avail->idx - vq->last_used_idx;
548 rte_vhost_enable_guest_notification(int vid, uint16_t queue_id, int enable)
550 struct virtio_net *dev = get_device(vid);
556 RTE_LOG(ERR, VHOST_CONFIG,
557 "guest notification isn't supported.\n");
561 dev->virtqueue[queue_id]->used->flags = VRING_USED_F_NO_NOTIFY;
566 rte_vhost_log_write(int vid, uint64_t addr, uint64_t len)
568 struct virtio_net *dev = get_device(vid);
573 vhost_log_write(dev, addr, len);
577 rte_vhost_log_used_vring(int vid, uint16_t vring_idx,
578 uint64_t offset, uint64_t len)
580 struct virtio_net *dev;
581 struct vhost_virtqueue *vq;
583 dev = get_device(vid);
587 if (vring_idx >= VHOST_MAX_VRING)
589 vq = dev->virtqueue[vring_idx];
593 vhost_log_used_vring(dev, vq, offset, len);
597 rte_vhost_rx_queue_count(int vid, uint16_t qid)
599 struct virtio_net *dev;
600 struct vhost_virtqueue *vq;
602 dev = get_device(vid);
606 if (unlikely(qid >= dev->nr_vring || (qid & 1) == 0)) {
607 RTE_LOG(ERR, VHOST_DATA, "(%d) %s: invalid virtqueue idx %d.\n",
608 dev->vid, __func__, qid);
612 vq = dev->virtqueue[qid];
616 if (unlikely(vq->enabled == 0 || vq->avail == NULL))
619 return *((volatile uint16_t *)&vq->avail->idx) - vq->last_avail_idx;