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);
71 if (tmp_size == *size)
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)
161 uint64_t req_size, size;
163 if (!(dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM)))
166 req_size = sizeof(struct vring_desc) * vq->size;
168 vq->desc = (struct vring_desc *)(uintptr_t)vhost_iova_to_vva(dev, vq,
169 vq->ring_addrs.desc_user_addr,
170 &size, VHOST_ACCESS_RW);
171 if (!vq->desc || size != req_size)
174 req_size = sizeof(struct vring_avail);
175 req_size += sizeof(uint16_t) * vq->size;
176 if (dev->features & (1ULL << VIRTIO_RING_F_EVENT_IDX))
177 req_size += sizeof(uint16_t);
179 vq->avail = (struct vring_avail *)(uintptr_t)vhost_iova_to_vva(dev, vq,
180 vq->ring_addrs.avail_user_addr,
181 &size, VHOST_ACCESS_RW);
182 if (!vq->avail || size != req_size)
185 req_size = sizeof(struct vring_used);
186 req_size += sizeof(struct vring_used_elem) * vq->size;
187 if (dev->features & (1ULL << VIRTIO_RING_F_EVENT_IDX))
188 req_size += sizeof(uint16_t);
190 vq->used = (struct vring_used *)(uintptr_t)vhost_iova_to_vva(dev, vq,
191 vq->ring_addrs.used_user_addr,
192 &size, VHOST_ACCESS_RW);
193 if (!vq->used || size != req_size)
203 vring_invalidate(struct virtio_net *dev, struct vhost_virtqueue *vq)
205 if (dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM))
206 vhost_user_iotlb_wr_lock(vq);
213 if (dev->features & (1ULL << VIRTIO_F_IOMMU_PLATFORM))
214 vhost_user_iotlb_wr_unlock(vq);
218 init_vring_queue(struct virtio_net *dev, uint32_t vring_idx)
220 struct vhost_virtqueue *vq;
222 if (vring_idx >= VHOST_MAX_VRING) {
223 RTE_LOG(ERR, VHOST_CONFIG,
224 "Failed not init vring, out of bound (%d)\n",
229 vq = dev->virtqueue[vring_idx];
231 memset(vq, 0, sizeof(struct vhost_virtqueue));
233 vq->kickfd = VIRTIO_UNINITIALIZED_EVENTFD;
234 vq->callfd = VIRTIO_UNINITIALIZED_EVENTFD;
236 vhost_user_iotlb_init(dev, vring_idx);
237 /* Backends are set to -1 indicating an inactive device. */
240 TAILQ_INIT(&vq->zmbuf_list);
244 reset_vring_queue(struct virtio_net *dev, uint32_t vring_idx)
246 struct vhost_virtqueue *vq;
249 if (vring_idx >= VHOST_MAX_VRING) {
250 RTE_LOG(ERR, VHOST_CONFIG,
251 "Failed not init vring, out of bound (%d)\n",
256 vq = dev->virtqueue[vring_idx];
258 init_vring_queue(dev, vring_idx);
263 alloc_vring_queue(struct virtio_net *dev, uint32_t vring_idx)
265 struct vhost_virtqueue *vq;
267 vq = rte_malloc(NULL, sizeof(struct vhost_virtqueue), 0);
269 RTE_LOG(ERR, VHOST_CONFIG,
270 "Failed to allocate memory for vring:%u.\n", vring_idx);
274 dev->virtqueue[vring_idx] = vq;
275 init_vring_queue(dev, vring_idx);
276 rte_spinlock_init(&vq->access_lock);
284 * Reset some variables in device structure, while keeping few
285 * others untouched, such as vid, ifname, nr_vring: they
286 * should be same unless the device is removed.
289 reset_device(struct virtio_net *dev)
294 dev->protocol_features = 0;
297 for (i = 0; i < dev->nr_vring; i++)
298 reset_vring_queue(dev, i);
302 * Invoked when there is a new vhost-user connection established (when
303 * there is a new virtio device being attached).
306 vhost_new_device(void)
308 struct virtio_net *dev;
311 dev = rte_zmalloc(NULL, sizeof(struct virtio_net), 0);
313 RTE_LOG(ERR, VHOST_CONFIG,
314 "Failed to allocate memory for new dev.\n");
318 for (i = 0; i < MAX_VHOST_DEVICE; i++) {
319 if (vhost_devices[i] == NULL)
322 if (i == MAX_VHOST_DEVICE) {
323 RTE_LOG(ERR, VHOST_CONFIG,
324 "Failed to find a free slot for new device.\n");
329 vhost_devices[i] = dev;
331 dev->slave_req_fd = -1;
337 * Invoked when there is the vhost-user connection is broken (when
338 * the virtio device is being detached).
341 vhost_destroy_device(int vid)
343 struct virtio_net *dev = get_device(vid);
348 if (dev->flags & VIRTIO_DEV_RUNNING) {
349 dev->flags &= ~VIRTIO_DEV_RUNNING;
350 dev->notify_ops->destroy_device(vid);
353 cleanup_device(dev, 1);
356 vhost_devices[vid] = NULL;
360 vhost_set_ifname(int vid, const char *if_name, unsigned int if_len)
362 struct virtio_net *dev;
365 dev = get_device(vid);
369 len = if_len > sizeof(dev->ifname) ?
370 sizeof(dev->ifname) : if_len;
372 strncpy(dev->ifname, if_name, len);
373 dev->ifname[sizeof(dev->ifname) - 1] = '\0';
377 vhost_enable_dequeue_zero_copy(int vid)
379 struct virtio_net *dev = get_device(vid);
384 dev->dequeue_zero_copy = 1;
388 rte_vhost_get_mtu(int vid, uint16_t *mtu)
390 struct virtio_net *dev = get_device(vid);
395 if (!(dev->flags & VIRTIO_DEV_READY))
398 if (!(dev->features & (1ULL << VIRTIO_NET_F_MTU)))
407 rte_vhost_get_numa_node(int vid)
409 #ifdef RTE_LIBRTE_VHOST_NUMA
410 struct virtio_net *dev = get_device(vid);
417 ret = get_mempolicy(&numa_node, NULL, 0, dev,
418 MPOL_F_NODE | MPOL_F_ADDR);
420 RTE_LOG(ERR, VHOST_CONFIG,
421 "(%d) failed to query numa node: %s\n",
422 vid, rte_strerror(errno));
434 rte_vhost_get_queue_num(int vid)
436 struct virtio_net *dev = get_device(vid);
441 return dev->nr_vring / 2;
445 rte_vhost_get_vring_num(int vid)
447 struct virtio_net *dev = get_device(vid);
452 return dev->nr_vring;
456 rte_vhost_get_ifname(int vid, char *buf, size_t len)
458 struct virtio_net *dev = get_device(vid);
463 len = RTE_MIN(len, sizeof(dev->ifname));
465 strncpy(buf, dev->ifname, len);
472 rte_vhost_get_negotiated_features(int vid, uint64_t *features)
474 struct virtio_net *dev;
476 dev = get_device(vid);
480 *features = dev->features;
485 rte_vhost_get_mem_table(int vid, struct rte_vhost_memory **mem)
487 struct virtio_net *dev;
488 struct rte_vhost_memory *m;
491 dev = get_device(vid);
495 size = dev->mem->nregions * sizeof(struct rte_vhost_mem_region);
496 m = malloc(sizeof(struct rte_vhost_memory) + size);
500 m->nregions = dev->mem->nregions;
501 memcpy(m->regions, dev->mem->regions, size);
508 rte_vhost_get_vhost_vring(int vid, uint16_t vring_idx,
509 struct rte_vhost_vring *vring)
511 struct virtio_net *dev;
512 struct vhost_virtqueue *vq;
514 dev = get_device(vid);
518 if (vring_idx >= VHOST_MAX_VRING)
521 vq = dev->virtqueue[vring_idx];
525 vring->desc = vq->desc;
526 vring->avail = vq->avail;
527 vring->used = vq->used;
528 vring->log_guest_addr = vq->log_guest_addr;
530 vring->callfd = vq->callfd;
531 vring->kickfd = vq->kickfd;
532 vring->size = vq->size;
538 rte_vhost_avail_entries(int vid, uint16_t queue_id)
540 struct virtio_net *dev;
541 struct vhost_virtqueue *vq;
543 dev = get_device(vid);
547 vq = dev->virtqueue[queue_id];
551 return *(volatile uint16_t *)&vq->avail->idx - vq->last_used_idx;
555 rte_vhost_enable_guest_notification(int vid, uint16_t queue_id, int enable)
557 struct virtio_net *dev = get_device(vid);
563 RTE_LOG(ERR, VHOST_CONFIG,
564 "guest notification isn't supported.\n");
568 dev->virtqueue[queue_id]->used->flags = VRING_USED_F_NO_NOTIFY;
573 rte_vhost_log_write(int vid, uint64_t addr, uint64_t len)
575 struct virtio_net *dev = get_device(vid);
580 vhost_log_write(dev, addr, len);
584 rte_vhost_log_used_vring(int vid, uint16_t vring_idx,
585 uint64_t offset, uint64_t len)
587 struct virtio_net *dev;
588 struct vhost_virtqueue *vq;
590 dev = get_device(vid);
594 if (vring_idx >= VHOST_MAX_VRING)
596 vq = dev->virtqueue[vring_idx];
600 vhost_log_used_vring(dev, vq, offset, len);
604 rte_vhost_rx_queue_count(int vid, uint16_t qid)
606 struct virtio_net *dev;
607 struct vhost_virtqueue *vq;
609 dev = get_device(vid);
613 if (unlikely(qid >= dev->nr_vring || (qid & 1) == 0)) {
614 RTE_LOG(ERR, VHOST_DATA, "(%d) %s: invalid virtqueue idx %d.\n",
615 dev->vid, __func__, qid);
619 vq = dev->virtqueue[qid];
623 if (unlikely(vq->enabled == 0 || vq->avail == NULL))
626 return *((volatile uint16_t *)&vq->avail->idx) - vq->last_avail_idx;