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_ethdev.h>
45 #include <rte_string_fns.h>
46 #include <rte_memory.h>
47 #include <rte_malloc.h>
48 #include <rte_virtio_net.h>
52 #define VHOST_USER_F_PROTOCOL_FEATURES 30
54 /* Features supported by this lib. */
55 #define VHOST_SUPPORTED_FEATURES ((1ULL << VIRTIO_NET_F_MRG_RXBUF) | \
56 (1ULL << VIRTIO_NET_F_CTRL_VQ) | \
57 (1ULL << VIRTIO_NET_F_CTRL_RX) | \
58 (1ULL << VIRTIO_NET_F_GUEST_ANNOUNCE) | \
59 (1ULL << VIRTIO_NET_F_MQ) | \
60 (1ULL << VIRTIO_F_VERSION_1) | \
61 (1ULL << VHOST_F_LOG_ALL) | \
62 (1ULL << VHOST_USER_F_PROTOCOL_FEATURES) | \
63 (1ULL << VIRTIO_NET_F_HOST_TSO4) | \
64 (1ULL << VIRTIO_NET_F_HOST_TSO6) | \
65 (1ULL << VIRTIO_NET_F_CSUM) | \
66 (1ULL << VIRTIO_NET_F_GUEST_CSUM) | \
67 (1ULL << VIRTIO_NET_F_GUEST_TSO4) | \
68 (1ULL << VIRTIO_NET_F_GUEST_TSO6) | \
69 (1ULL << VIRTIO_RING_F_INDIRECT_DESC) | \
70 (1ULL << VIRTIO_NET_F_MTU))
72 uint64_t VHOST_FEATURES = VHOST_SUPPORTED_FEATURES;
74 struct virtio_net *vhost_devices[MAX_VHOST_DEVICE];
76 /* device ops to add/remove device to/from data core. */
77 struct virtio_net_device_ops const *notify_ops;
82 struct virtio_net *dev = vhost_devices[vid];
85 RTE_LOG(ERR, VHOST_CONFIG,
86 "(%d) device not found.\n", vid);
93 cleanup_vq(struct vhost_virtqueue *vq, int destroy)
95 if ((vq->callfd >= 0) && (destroy != 0))
102 * Unmap any memory, close any file descriptors and
103 * free any memory owned by a device.
106 cleanup_device(struct virtio_net *dev, int destroy)
110 vhost_backend_cleanup(dev);
112 for (i = 0; i < dev->virt_qp_nb; i++) {
113 cleanup_vq(dev->virtqueue[i * VIRTIO_QNUM + VIRTIO_RXQ], destroy);
114 cleanup_vq(dev->virtqueue[i * VIRTIO_QNUM + VIRTIO_TXQ], destroy);
119 * Release virtqueues and device memory.
122 free_device(struct virtio_net *dev)
125 struct vhost_virtqueue *rxq, *txq;
127 for (i = 0; i < dev->virt_qp_nb; i++) {
128 rxq = dev->virtqueue[i * VIRTIO_QNUM + VIRTIO_RXQ];
129 txq = dev->virtqueue[i * VIRTIO_QNUM + VIRTIO_TXQ];
131 rte_free(rxq->shadow_used_ring);
132 rte_free(txq->shadow_used_ring);
134 /* rxq and txq are allocated together as queue-pair */
142 init_vring_queue(struct vhost_virtqueue *vq, int qp_idx)
144 memset(vq, 0, sizeof(struct vhost_virtqueue));
146 vq->kickfd = VIRTIO_UNINITIALIZED_EVENTFD;
147 vq->callfd = VIRTIO_UNINITIALIZED_EVENTFD;
149 /* Backends are set to -1 indicating an inactive device. */
152 /* always set the default vq pair to enabled */
156 TAILQ_INIT(&vq->zmbuf_list);
160 init_vring_queue_pair(struct virtio_net *dev, uint32_t qp_idx)
162 uint32_t base_idx = qp_idx * VIRTIO_QNUM;
164 init_vring_queue(dev->virtqueue[base_idx + VIRTIO_RXQ], qp_idx);
165 init_vring_queue(dev->virtqueue[base_idx + VIRTIO_TXQ], qp_idx);
169 reset_vring_queue(struct vhost_virtqueue *vq, int qp_idx)
174 init_vring_queue(vq, qp_idx);
179 reset_vring_queue_pair(struct virtio_net *dev, uint32_t qp_idx)
181 uint32_t base_idx = qp_idx * VIRTIO_QNUM;
183 reset_vring_queue(dev->virtqueue[base_idx + VIRTIO_RXQ], qp_idx);
184 reset_vring_queue(dev->virtqueue[base_idx + VIRTIO_TXQ], qp_idx);
188 alloc_vring_queue_pair(struct virtio_net *dev, uint32_t qp_idx)
190 struct vhost_virtqueue *virtqueue = NULL;
191 uint32_t virt_rx_q_idx = qp_idx * VIRTIO_QNUM + VIRTIO_RXQ;
192 uint32_t virt_tx_q_idx = qp_idx * VIRTIO_QNUM + VIRTIO_TXQ;
194 virtqueue = rte_malloc(NULL,
195 sizeof(struct vhost_virtqueue) * VIRTIO_QNUM, 0);
196 if (virtqueue == NULL) {
197 RTE_LOG(ERR, VHOST_CONFIG,
198 "Failed to allocate memory for virt qp:%d.\n", qp_idx);
202 dev->virtqueue[virt_rx_q_idx] = virtqueue;
203 dev->virtqueue[virt_tx_q_idx] = virtqueue + VIRTIO_TXQ;
205 init_vring_queue_pair(dev, qp_idx);
207 dev->virt_qp_nb += 1;
213 * Reset some variables in device structure, while keeping few
214 * others untouched, such as vid, ifname, virt_qp_nb: they
215 * should be same unless the device is removed.
218 reset_device(struct virtio_net *dev)
223 dev->protocol_features = 0;
226 for (i = 0; i < dev->virt_qp_nb; i++)
227 reset_vring_queue_pair(dev, i);
231 * Invoked when there is a new vhost-user connection established (when
232 * there is a new virtio device being attached).
235 vhost_new_device(void)
237 struct virtio_net *dev;
240 dev = rte_zmalloc(NULL, sizeof(struct virtio_net), 0);
242 RTE_LOG(ERR, VHOST_CONFIG,
243 "Failed to allocate memory for new dev.\n");
247 for (i = 0; i < MAX_VHOST_DEVICE; i++) {
248 if (vhost_devices[i] == NULL)
251 if (i == MAX_VHOST_DEVICE) {
252 RTE_LOG(ERR, VHOST_CONFIG,
253 "Failed to find a free slot for new device.\n");
258 vhost_devices[i] = dev;
265 * Invoked when there is the vhost-user connection is broken (when
266 * the virtio device is being detached).
269 vhost_destroy_device(int vid)
271 struct virtio_net *dev = get_device(vid);
276 if (dev->flags & VIRTIO_DEV_RUNNING) {
277 dev->flags &= ~VIRTIO_DEV_RUNNING;
278 notify_ops->destroy_device(vid);
281 cleanup_device(dev, 1);
284 vhost_devices[vid] = NULL;
288 vhost_set_ifname(int vid, const char *if_name, unsigned int if_len)
290 struct virtio_net *dev;
293 dev = get_device(vid);
297 len = if_len > sizeof(dev->ifname) ?
298 sizeof(dev->ifname) : if_len;
300 strncpy(dev->ifname, if_name, len);
301 dev->ifname[sizeof(dev->ifname) - 1] = '\0';
305 vhost_enable_dequeue_zero_copy(int vid)
307 struct virtio_net *dev = get_device(vid);
312 dev->dequeue_zero_copy = 1;
316 rte_vhost_get_mtu(int vid, uint16_t *mtu)
318 struct virtio_net *dev = get_device(vid);
323 if (!(dev->flags & VIRTIO_DEV_READY))
326 if (!(dev->features & VIRTIO_NET_F_MTU))
335 rte_vhost_get_numa_node(int vid)
337 #ifdef RTE_LIBRTE_VHOST_NUMA
338 struct virtio_net *dev = get_device(vid);
345 ret = get_mempolicy(&numa_node, NULL, 0, dev,
346 MPOL_F_NODE | MPOL_F_ADDR);
348 RTE_LOG(ERR, VHOST_CONFIG,
349 "(%d) failed to query numa node: %d\n", vid, ret);
361 rte_vhost_get_queue_num(int vid)
363 struct virtio_net *dev = get_device(vid);
368 return dev->virt_qp_nb;
372 rte_vhost_get_ifname(int vid, char *buf, size_t len)
374 struct virtio_net *dev = get_device(vid);
379 len = RTE_MIN(len, sizeof(dev->ifname));
381 strncpy(buf, dev->ifname, len);
388 rte_vhost_avail_entries(int vid, uint16_t queue_id)
390 struct virtio_net *dev;
391 struct vhost_virtqueue *vq;
393 dev = get_device(vid);
397 vq = dev->virtqueue[queue_id];
401 return *(volatile uint16_t *)&vq->avail->idx - vq->last_used_idx;
405 rte_vhost_enable_guest_notification(int vid, uint16_t queue_id, int enable)
407 struct virtio_net *dev = get_device(vid);
413 RTE_LOG(ERR, VHOST_CONFIG,
414 "guest notification isn't supported.\n");
418 dev->virtqueue[queue_id]->used->flags = VRING_USED_F_NO_NOTIFY;
422 uint64_t rte_vhost_feature_get(void)
424 return VHOST_FEATURES;
427 int rte_vhost_feature_disable(uint64_t feature_mask)
429 VHOST_FEATURES = VHOST_FEATURES & ~feature_mask;
433 int rte_vhost_feature_enable(uint64_t feature_mask)
435 if ((feature_mask & VHOST_SUPPORTED_FEATURES) == feature_mask) {
436 VHOST_FEATURES = VHOST_FEATURES | feature_mask;
443 * Register ops so that we can add/remove device to data core.
446 rte_vhost_driver_callback_register(struct virtio_net_device_ops const * const ops)