dbf5d1b8623553ba75ade6121d9560edf6d18b52
[dpdk.git] / lib / librte_vhost / vhost.c
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2016 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
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
16  *       distribution.
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.
20  *
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.
32  */
33
34 #include <linux/vhost.h>
35 #include <linux/virtio_net.h>
36 #include <stddef.h>
37 #include <stdint.h>
38 #include <stdlib.h>
39 #ifdef RTE_LIBRTE_VHOST_NUMA
40 #include <numaif.h>
41 #endif
42
43 #include <rte_ethdev.h>
44 #include <rte_log.h>
45 #include <rte_string_fns.h>
46 #include <rte_memory.h>
47 #include <rte_malloc.h>
48 #include <rte_virtio_net.h>
49
50 #include "vhost.h"
51
52 #define VHOST_USER_F_PROTOCOL_FEATURES  30
53
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))
70
71 uint64_t VHOST_FEATURES = VHOST_SUPPORTED_FEATURES;
72
73 struct virtio_net *vhost_devices[MAX_VHOST_DEVICE];
74
75 /* device ops to add/remove device to/from data core. */
76 struct virtio_net_device_ops const *notify_ops;
77
78 struct virtio_net *
79 get_device(int vid)
80 {
81         struct virtio_net *dev = vhost_devices[vid];
82
83         if (unlikely(!dev)) {
84                 RTE_LOG(ERR, VHOST_CONFIG,
85                         "(%d) device not found.\n", vid);
86         }
87
88         return dev;
89 }
90
91 static void
92 cleanup_vq(struct vhost_virtqueue *vq, int destroy)
93 {
94         if ((vq->callfd >= 0) && (destroy != 0))
95                 close(vq->callfd);
96         if (vq->kickfd >= 0)
97                 close(vq->kickfd);
98 }
99
100 /*
101  * Unmap any memory, close any file descriptors and
102  * free any memory owned by a device.
103  */
104 void
105 cleanup_device(struct virtio_net *dev, int destroy)
106 {
107         uint32_t i;
108
109         vhost_backend_cleanup(dev);
110
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);
114         }
115 }
116
117 /*
118  * Release virtqueues and device memory.
119  */
120 static void
121 free_device(struct virtio_net *dev)
122 {
123         uint32_t i;
124
125         for (i = 0; i < dev->virt_qp_nb; i++)
126                 rte_free(dev->virtqueue[i * VIRTIO_QNUM]);
127
128         rte_free(dev);
129 }
130
131 static void
132 init_vring_queue(struct vhost_virtqueue *vq, int qp_idx)
133 {
134         memset(vq, 0, sizeof(struct vhost_virtqueue));
135
136         vq->kickfd = VIRTIO_UNINITIALIZED_EVENTFD;
137         vq->callfd = VIRTIO_UNINITIALIZED_EVENTFD;
138
139         /* Backends are set to -1 indicating an inactive device. */
140         vq->backend = -1;
141
142         /* always set the default vq pair to enabled */
143         if (qp_idx == 0)
144                 vq->enabled = 1;
145
146         TAILQ_INIT(&vq->zmbuf_list);
147 }
148
149 static void
150 init_vring_queue_pair(struct virtio_net *dev, uint32_t qp_idx)
151 {
152         uint32_t base_idx = qp_idx * VIRTIO_QNUM;
153
154         init_vring_queue(dev->virtqueue[base_idx + VIRTIO_RXQ], qp_idx);
155         init_vring_queue(dev->virtqueue[base_idx + VIRTIO_TXQ], qp_idx);
156 }
157
158 static void
159 reset_vring_queue(struct vhost_virtqueue *vq, int qp_idx)
160 {
161         int callfd;
162
163         callfd = vq->callfd;
164         init_vring_queue(vq, qp_idx);
165         vq->callfd = callfd;
166 }
167
168 static void
169 reset_vring_queue_pair(struct virtio_net *dev, uint32_t qp_idx)
170 {
171         uint32_t base_idx = qp_idx * VIRTIO_QNUM;
172
173         reset_vring_queue(dev->virtqueue[base_idx + VIRTIO_RXQ], qp_idx);
174         reset_vring_queue(dev->virtqueue[base_idx + VIRTIO_TXQ], qp_idx);
175 }
176
177 int
178 alloc_vring_queue_pair(struct virtio_net *dev, uint32_t qp_idx)
179 {
180         struct vhost_virtqueue *virtqueue = NULL;
181         uint32_t virt_rx_q_idx = qp_idx * VIRTIO_QNUM + VIRTIO_RXQ;
182         uint32_t virt_tx_q_idx = qp_idx * VIRTIO_QNUM + VIRTIO_TXQ;
183
184         virtqueue = rte_malloc(NULL,
185                                sizeof(struct vhost_virtqueue) * VIRTIO_QNUM, 0);
186         if (virtqueue == NULL) {
187                 RTE_LOG(ERR, VHOST_CONFIG,
188                         "Failed to allocate memory for virt qp:%d.\n", qp_idx);
189                 return -1;
190         }
191
192         dev->virtqueue[virt_rx_q_idx] = virtqueue;
193         dev->virtqueue[virt_tx_q_idx] = virtqueue + VIRTIO_TXQ;
194
195         init_vring_queue_pair(dev, qp_idx);
196
197         dev->virt_qp_nb += 1;
198
199         return 0;
200 }
201
202 /*
203  * Reset some variables in device structure, while keeping few
204  * others untouched, such as vid, ifname, virt_qp_nb: they
205  * should be same unless the device is removed.
206  */
207 void
208 reset_device(struct virtio_net *dev)
209 {
210         uint32_t i;
211
212         dev->features = 0;
213         dev->protocol_features = 0;
214         dev->flags = 0;
215
216         for (i = 0; i < dev->virt_qp_nb; i++)
217                 reset_vring_queue_pair(dev, i);
218 }
219
220 /*
221  * Function is called from the CUSE open function. The device structure is
222  * initialised and a new entry is added to the device configuration linked
223  * list.
224  */
225 int
226 vhost_new_device(void)
227 {
228         struct virtio_net *dev;
229         int i;
230
231         dev = rte_zmalloc(NULL, sizeof(struct virtio_net), 0);
232         if (dev == NULL) {
233                 RTE_LOG(ERR, VHOST_CONFIG,
234                         "Failed to allocate memory for new dev.\n");
235                 return -1;
236         }
237
238         for (i = 0; i < MAX_VHOST_DEVICE; i++) {
239                 if (vhost_devices[i] == NULL)
240                         break;
241         }
242         if (i == MAX_VHOST_DEVICE) {
243                 RTE_LOG(ERR, VHOST_CONFIG,
244                         "Failed to find a free slot for new device.\n");
245                 return -1;
246         }
247
248         vhost_devices[i] = dev;
249         dev->vid = i;
250
251         return i;
252 }
253
254 /*
255  * Function is called from the CUSE release function. This function will
256  * cleanup the device and remove it from device configuration linked list.
257  */
258 void
259 vhost_destroy_device(int vid)
260 {
261         struct virtio_net *dev = get_device(vid);
262
263         if (dev == NULL)
264                 return;
265
266         if (dev->flags & VIRTIO_DEV_RUNNING) {
267                 dev->flags &= ~VIRTIO_DEV_RUNNING;
268                 notify_ops->destroy_device(vid);
269         }
270
271         cleanup_device(dev, 1);
272         free_device(dev);
273
274         vhost_devices[vid] = NULL;
275 }
276
277 void
278 vhost_set_ifname(int vid, const char *if_name, unsigned int if_len)
279 {
280         struct virtio_net *dev;
281         unsigned int len;
282
283         dev = get_device(vid);
284         if (dev == NULL)
285                 return;
286
287         len = if_len > sizeof(dev->ifname) ?
288                 sizeof(dev->ifname) : if_len;
289
290         strncpy(dev->ifname, if_name, len);
291         dev->ifname[sizeof(dev->ifname) - 1] = '\0';
292 }
293
294
295 int
296 rte_vhost_get_numa_node(int vid)
297 {
298 #ifdef RTE_LIBRTE_VHOST_NUMA
299         struct virtio_net *dev = get_device(vid);
300         int numa_node;
301         int ret;
302
303         if (dev == NULL)
304                 return -1;
305
306         ret = get_mempolicy(&numa_node, NULL, 0, dev,
307                             MPOL_F_NODE | MPOL_F_ADDR);
308         if (ret < 0) {
309                 RTE_LOG(ERR, VHOST_CONFIG,
310                         "(%d) failed to query numa node: %d\n", vid, ret);
311                 return -1;
312         }
313
314         return numa_node;
315 #else
316         RTE_SET_USED(vid);
317         return -1;
318 #endif
319 }
320
321 uint32_t
322 rte_vhost_get_queue_num(int vid)
323 {
324         struct virtio_net *dev = get_device(vid);
325
326         if (dev == NULL)
327                 return 0;
328
329         return dev->virt_qp_nb;
330 }
331
332 int
333 rte_vhost_get_ifname(int vid, char *buf, size_t len)
334 {
335         struct virtio_net *dev = get_device(vid);
336
337         if (dev == NULL)
338                 return -1;
339
340         len = RTE_MIN(len, sizeof(dev->ifname));
341
342         strncpy(buf, dev->ifname, len);
343         buf[len - 1] = '\0';
344
345         return 0;
346 }
347
348 uint16_t
349 rte_vhost_avail_entries(int vid, uint16_t queue_id)
350 {
351         struct virtio_net *dev;
352         struct vhost_virtqueue *vq;
353
354         dev = get_device(vid);
355         if (!dev)
356                 return 0;
357
358         vq = dev->virtqueue[queue_id];
359         if (!vq->enabled)
360                 return 0;
361
362         return *(volatile uint16_t *)&vq->avail->idx - vq->last_used_idx;
363 }
364
365 int
366 rte_vhost_enable_guest_notification(int vid, uint16_t queue_id, int enable)
367 {
368         struct virtio_net *dev = get_device(vid);
369
370         if (dev == NULL)
371                 return -1;
372
373         if (enable) {
374                 RTE_LOG(ERR, VHOST_CONFIG,
375                         "guest notification isn't supported.\n");
376                 return -1;
377         }
378
379         dev->virtqueue[queue_id]->used->flags = VRING_USED_F_NO_NOTIFY;
380         return 0;
381 }
382
383 uint64_t rte_vhost_feature_get(void)
384 {
385         return VHOST_FEATURES;
386 }
387
388 int rte_vhost_feature_disable(uint64_t feature_mask)
389 {
390         VHOST_FEATURES = VHOST_FEATURES & ~feature_mask;
391         return 0;
392 }
393
394 int rte_vhost_feature_enable(uint64_t feature_mask)
395 {
396         if ((feature_mask & VHOST_SUPPORTED_FEATURES) == feature_mask) {
397                 VHOST_FEATURES = VHOST_FEATURES | feature_mask;
398                 return 0;
399         }
400         return -1;
401 }
402
403 /*
404  * Register ops so that we can add/remove device to data core.
405  */
406 int
407 rte_vhost_driver_callback_register(struct virtio_net_device_ops const * const ops)
408 {
409         notify_ops = ops;
410
411         return 0;
412 }