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 (VHOST_SUPPORTS_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))
71 uint64_t VHOST_FEATURES = VHOST_SUPPORTED_FEATURES;
73 struct virtio_net *vhost_devices[MAX_VHOST_DEVICE];
75 /* device ops to add/remove device to/from data core. */
76 struct virtio_net_device_ops const *notify_ops;
81 struct virtio_net *dev = vhost_devices[vid];
84 RTE_LOG(ERR, VHOST_CONFIG,
85 "(%d) device not found.\n", vid);
92 cleanup_vq(struct vhost_virtqueue *vq, int destroy)
94 if ((vq->callfd >= 0) && (destroy != 0))
101 * Unmap any memory, close any file descriptors and
102 * free any memory owned by a device.
105 cleanup_device(struct virtio_net *dev, int destroy)
109 vhost_backend_cleanup(dev);
111 for (i = 0; i < dev->virt_qp_nb; i++) {
112 cleanup_vq(dev->virtqueue[i * VIRTIO_QNUM + VIRTIO_RXQ], destroy);
113 cleanup_vq(dev->virtqueue[i * VIRTIO_QNUM + VIRTIO_TXQ], destroy);
118 * Release virtqueues and device memory.
121 free_device(struct virtio_net *dev)
124 struct vhost_virtqueue *rxq, *txq;
126 for (i = 0; i < dev->virt_qp_nb; i++) {
127 rxq = dev->virtqueue[i * VIRTIO_QNUM + VIRTIO_RXQ];
128 txq = dev->virtqueue[i * VIRTIO_QNUM + VIRTIO_TXQ];
130 rte_free(rxq->shadow_used_ring);
131 rte_free(txq->shadow_used_ring);
133 /* rxq and txq are allocated together as queue-pair */
141 init_vring_queue(struct vhost_virtqueue *vq, int qp_idx)
143 memset(vq, 0, sizeof(struct vhost_virtqueue));
145 vq->kickfd = VIRTIO_UNINITIALIZED_EVENTFD;
146 vq->callfd = VIRTIO_UNINITIALIZED_EVENTFD;
148 /* Backends are set to -1 indicating an inactive device. */
151 /* always set the default vq pair to enabled */
155 TAILQ_INIT(&vq->zmbuf_list);
159 init_vring_queue_pair(struct virtio_net *dev, uint32_t qp_idx)
161 uint32_t base_idx = qp_idx * VIRTIO_QNUM;
163 init_vring_queue(dev->virtqueue[base_idx + VIRTIO_RXQ], qp_idx);
164 init_vring_queue(dev->virtqueue[base_idx + VIRTIO_TXQ], qp_idx);
168 reset_vring_queue(struct vhost_virtqueue *vq, int qp_idx)
173 init_vring_queue(vq, qp_idx);
178 reset_vring_queue_pair(struct virtio_net *dev, uint32_t qp_idx)
180 uint32_t base_idx = qp_idx * VIRTIO_QNUM;
182 reset_vring_queue(dev->virtqueue[base_idx + VIRTIO_RXQ], qp_idx);
183 reset_vring_queue(dev->virtqueue[base_idx + VIRTIO_TXQ], qp_idx);
187 alloc_vring_queue_pair(struct virtio_net *dev, uint32_t qp_idx)
189 struct vhost_virtqueue *virtqueue = NULL;
190 uint32_t virt_rx_q_idx = qp_idx * VIRTIO_QNUM + VIRTIO_RXQ;
191 uint32_t virt_tx_q_idx = qp_idx * VIRTIO_QNUM + VIRTIO_TXQ;
193 virtqueue = rte_malloc(NULL,
194 sizeof(struct vhost_virtqueue) * VIRTIO_QNUM, 0);
195 if (virtqueue == NULL) {
196 RTE_LOG(ERR, VHOST_CONFIG,
197 "Failed to allocate memory for virt qp:%d.\n", qp_idx);
201 dev->virtqueue[virt_rx_q_idx] = virtqueue;
202 dev->virtqueue[virt_tx_q_idx] = virtqueue + VIRTIO_TXQ;
204 init_vring_queue_pair(dev, qp_idx);
206 dev->virt_qp_nb += 1;
212 * Reset some variables in device structure, while keeping few
213 * others untouched, such as vid, ifname, virt_qp_nb: they
214 * should be same unless the device is removed.
217 reset_device(struct virtio_net *dev)
222 dev->protocol_features = 0;
225 for (i = 0; i < dev->virt_qp_nb; i++)
226 reset_vring_queue_pair(dev, i);
230 * Invoked when there is a new vhost-user connection established (when
231 * there is a new virtio device being attached).
234 vhost_new_device(void)
236 struct virtio_net *dev;
239 dev = rte_zmalloc(NULL, sizeof(struct virtio_net), 0);
241 RTE_LOG(ERR, VHOST_CONFIG,
242 "Failed to allocate memory for new dev.\n");
246 for (i = 0; i < MAX_VHOST_DEVICE; i++) {
247 if (vhost_devices[i] == NULL)
250 if (i == MAX_VHOST_DEVICE) {
251 RTE_LOG(ERR, VHOST_CONFIG,
252 "Failed to find a free slot for new device.\n");
256 vhost_devices[i] = dev;
263 * Invoked when there is the vhost-user connection is broken (when
264 * the virtio device is being detached).
267 vhost_destroy_device(int vid)
269 struct virtio_net *dev = get_device(vid);
274 if (dev->flags & VIRTIO_DEV_RUNNING) {
275 dev->flags &= ~VIRTIO_DEV_RUNNING;
276 notify_ops->destroy_device(vid);
279 cleanup_device(dev, 1);
282 vhost_devices[vid] = NULL;
286 vhost_set_ifname(int vid, const char *if_name, unsigned int if_len)
288 struct virtio_net *dev;
291 dev = get_device(vid);
295 len = if_len > sizeof(dev->ifname) ?
296 sizeof(dev->ifname) : if_len;
298 strncpy(dev->ifname, if_name, len);
299 dev->ifname[sizeof(dev->ifname) - 1] = '\0';
303 vhost_enable_dequeue_zero_copy(int vid)
305 struct virtio_net *dev = get_device(vid);
310 dev->dequeue_zero_copy = 1;
314 rte_vhost_get_numa_node(int vid)
316 #ifdef RTE_LIBRTE_VHOST_NUMA
317 struct virtio_net *dev = get_device(vid);
324 ret = get_mempolicy(&numa_node, NULL, 0, dev,
325 MPOL_F_NODE | MPOL_F_ADDR);
327 RTE_LOG(ERR, VHOST_CONFIG,
328 "(%d) failed to query numa node: %d\n", vid, ret);
340 rte_vhost_get_queue_num(int vid)
342 struct virtio_net *dev = get_device(vid);
347 return dev->virt_qp_nb;
351 rte_vhost_get_ifname(int vid, char *buf, size_t len)
353 struct virtio_net *dev = get_device(vid);
358 len = RTE_MIN(len, sizeof(dev->ifname));
360 strncpy(buf, dev->ifname, len);
367 rte_vhost_avail_entries(int vid, uint16_t queue_id)
369 struct virtio_net *dev;
370 struct vhost_virtqueue *vq;
372 dev = get_device(vid);
376 vq = dev->virtqueue[queue_id];
380 return *(volatile uint16_t *)&vq->avail->idx - vq->last_used_idx;
384 rte_vhost_enable_guest_notification(int vid, uint16_t queue_id, int enable)
386 struct virtio_net *dev = get_device(vid);
392 RTE_LOG(ERR, VHOST_CONFIG,
393 "guest notification isn't supported.\n");
397 dev->virtqueue[queue_id]->used->flags = VRING_USED_F_NO_NOTIFY;
401 uint64_t rte_vhost_feature_get(void)
403 return VHOST_FEATURES;
406 int rte_vhost_feature_disable(uint64_t feature_mask)
408 VHOST_FEATURES = VHOST_FEATURES & ~feature_mask;
412 int rte_vhost_feature_enable(uint64_t feature_mask)
414 if ((feature_mask & VHOST_SUPPORTED_FEATURES) == feature_mask) {
415 VHOST_FEATURES = VHOST_FEATURES | feature_mask;
422 * Register ops so that we can add/remove device to data core.
425 rte_vhost_driver_callback_register(struct virtio_net_device_ops const * const ops)