a1e32158bbfd8a6fd7abd0c1d17932414526c6ab
[dpdk.git] / drivers / net / virtio / virtio_user / virtio_user_dev.c
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2016 Intel Corporation
3  */
4
5 #include <stdint.h>
6 #include <stdio.h>
7 #include <fcntl.h>
8 #include <string.h>
9 #include <errno.h>
10 #include <sys/mman.h>
11 #include <unistd.h>
12 #include <sys/eventfd.h>
13 #include <sys/types.h>
14 #include <sys/stat.h>
15
16 #include <rte_string_fns.h>
17 #include <rte_eal_memconfig.h>
18
19 #include "vhost.h"
20 #include "virtio_user_dev.h"
21 #include "../virtio_ethdev.h"
22
23 #define VIRTIO_USER_MEM_EVENT_CLB_NAME "virtio_user_mem_event_clb"
24
25 const char * const virtio_user_backend_strings[] = {
26         [VIRTIO_USER_BACKEND_UNKNOWN] = "VIRTIO_USER_BACKEND_UNKNOWN",
27         [VIRTIO_USER_BACKEND_VHOST_USER] = "VHOST_USER",
28         [VIRTIO_USER_BACKEND_VHOST_KERNEL] = "VHOST_NET",
29         [VIRTIO_USER_BACKEND_VHOST_VDPA] = "VHOST_VDPA",
30 };
31
32 static int
33 virtio_user_create_queue(struct virtio_user_dev *dev, uint32_t queue_sel)
34 {
35         /* Of all per virtqueue MSGs, make sure VHOST_SET_VRING_CALL come
36          * firstly because vhost depends on this msg to allocate virtqueue
37          * pair.
38          */
39         struct vhost_vring_file file;
40         int ret;
41
42         file.index = queue_sel;
43         file.fd = dev->callfds[queue_sel];
44         ret = dev->ops->set_vring_call(dev, &file);
45         if (ret < 0) {
46                 PMD_INIT_LOG(ERR, "(%s) Failed to create queue %u\n", dev->path, queue_sel);
47                 return -1;
48         }
49
50         return 0;
51 }
52
53 static int
54 virtio_user_kick_queue(struct virtio_user_dev *dev, uint32_t queue_sel)
55 {
56         int ret;
57         struct vhost_vring_file file;
58         struct vhost_vring_state state;
59         struct vring *vring = &dev->vrings[queue_sel];
60         struct vring_packed *pq_vring = &dev->packed_vrings[queue_sel];
61         struct vhost_vring_addr addr = {
62                 .index = queue_sel,
63                 .log_guest_addr = 0,
64                 .flags = 0, /* disable log */
65         };
66
67         if (dev->features & (1ULL << VIRTIO_F_RING_PACKED)) {
68                 addr.desc_user_addr =
69                         (uint64_t)(uintptr_t)pq_vring->desc;
70                 addr.avail_user_addr =
71                         (uint64_t)(uintptr_t)pq_vring->driver;
72                 addr.used_user_addr =
73                         (uint64_t)(uintptr_t)pq_vring->device;
74         } else {
75                 addr.desc_user_addr = (uint64_t)(uintptr_t)vring->desc;
76                 addr.avail_user_addr = (uint64_t)(uintptr_t)vring->avail;
77                 addr.used_user_addr = (uint64_t)(uintptr_t)vring->used;
78         }
79
80         state.index = queue_sel;
81         state.num = vring->num;
82         ret = dev->ops->set_vring_num(dev, &state);
83         if (ret < 0)
84                 goto err;
85
86         state.index = queue_sel;
87         state.num = 0; /* no reservation */
88         if (dev->features & (1ULL << VIRTIO_F_RING_PACKED))
89                 state.num |= (1 << 15);
90         ret = dev->ops->set_vring_base(dev, &state);
91         if (ret < 0)
92                 goto err;
93
94         ret = dev->ops->set_vring_addr(dev, &addr);
95         if (ret < 0)
96                 goto err;
97
98         /* Of all per virtqueue MSGs, make sure VHOST_USER_SET_VRING_KICK comes
99          * lastly because vhost depends on this msg to judge if
100          * virtio is ready.
101          */
102         file.index = queue_sel;
103         file.fd = dev->kickfds[queue_sel];
104         ret = dev->ops->set_vring_kick(dev, &file);
105         if (ret < 0)
106                 goto err;
107
108         return 0;
109 err:
110         PMD_INIT_LOG(ERR, "(%s) Failed to kick queue %u\n", dev->path, queue_sel);
111
112         return -1;
113 }
114
115 static int
116 virtio_user_queue_setup(struct virtio_user_dev *dev,
117                         int (*fn)(struct virtio_user_dev *, uint32_t))
118 {
119         uint32_t i, queue_sel;
120
121         for (i = 0; i < dev->max_queue_pairs; ++i) {
122                 queue_sel = 2 * i + VTNET_SQ_RQ_QUEUE_IDX;
123                 if (fn(dev, queue_sel) < 0) {
124                         PMD_DRV_LOG(ERR, "(%s) setup rx vq %u failed", dev->path, i);
125                         return -1;
126                 }
127         }
128         for (i = 0; i < dev->max_queue_pairs; ++i) {
129                 queue_sel = 2 * i + VTNET_SQ_TQ_QUEUE_IDX;
130                 if (fn(dev, queue_sel) < 0) {
131                         PMD_DRV_LOG(INFO, "(%s) setup tx vq %u failed", dev->path, i);
132                         return -1;
133                 }
134         }
135
136         return 0;
137 }
138
139 int
140 virtio_user_dev_set_features(struct virtio_user_dev *dev)
141 {
142         uint64_t features;
143         int ret = -1;
144
145         pthread_mutex_lock(&dev->mutex);
146
147         /* Step 0: tell vhost to create queues */
148         if (virtio_user_queue_setup(dev, virtio_user_create_queue) < 0)
149                 goto error;
150
151         features = dev->features;
152
153         /* Strip VIRTIO_NET_F_MAC, as MAC address is handled in vdev init */
154         features &= ~(1ull << VIRTIO_NET_F_MAC);
155         /* Strip VIRTIO_NET_F_CTRL_VQ, as devices do not really need to know */
156         features &= ~(1ull << VIRTIO_NET_F_CTRL_VQ);
157         features &= ~(1ull << VIRTIO_NET_F_STATUS);
158         ret = dev->ops->set_features(dev, features);
159         if (ret < 0)
160                 goto error;
161         PMD_DRV_LOG(INFO, "(%s) set features: 0x%" PRIx64, dev->path, features);
162 error:
163         pthread_mutex_unlock(&dev->mutex);
164
165         return ret;
166 }
167
168 int
169 virtio_user_start_device(struct virtio_user_dev *dev)
170 {
171         int ret;
172
173         /*
174          * XXX workaround!
175          *
176          * We need to make sure that the locks will be
177          * taken in the correct order to avoid deadlocks.
178          *
179          * Before releasing this lock, this thread should
180          * not trigger any memory hotplug events.
181          *
182          * This is a temporary workaround, and should be
183          * replaced when we get proper supports from the
184          * memory subsystem in the future.
185          */
186         rte_mcfg_mem_read_lock();
187         pthread_mutex_lock(&dev->mutex);
188
189         /* Step 2: share memory regions */
190         ret = dev->ops->set_memory_table(dev);
191         if (ret < 0)
192                 goto error;
193
194         /* Step 3: kick queues */
195         ret = virtio_user_queue_setup(dev, virtio_user_kick_queue);
196         if (ret < 0)
197                 goto error;
198
199         /* Step 4: enable queues
200          * we enable the 1st queue pair by default.
201          */
202         ret = dev->ops->enable_qp(dev, 0, 1);
203         if (ret < 0)
204                 goto error;
205
206         dev->started = true;
207
208         pthread_mutex_unlock(&dev->mutex);
209         rte_mcfg_mem_read_unlock();
210
211         return 0;
212 error:
213         pthread_mutex_unlock(&dev->mutex);
214         rte_mcfg_mem_read_unlock();
215
216         PMD_INIT_LOG(ERR, "(%s) Failed to start device\n", dev->path);
217
218         /* TODO: free resource here or caller to check */
219         return -1;
220 }
221
222 int virtio_user_stop_device(struct virtio_user_dev *dev)
223 {
224         struct vhost_vring_state state;
225         uint32_t i;
226         int ret;
227
228         pthread_mutex_lock(&dev->mutex);
229         if (!dev->started)
230                 goto out;
231
232         for (i = 0; i < dev->max_queue_pairs; ++i) {
233                 ret = dev->ops->enable_qp(dev, i, 0);
234                 if (ret < 0)
235                         goto err;
236         }
237
238         /* Stop the backend. */
239         for (i = 0; i < dev->max_queue_pairs * 2; ++i) {
240                 state.index = i;
241                 ret = dev->ops->get_vring_base(dev, &state);
242                 if (ret < 0) {
243                         PMD_DRV_LOG(ERR, "(%s) get_vring_base failed, index=%u", dev->path, i);
244                         goto err;
245                 }
246         }
247
248         dev->started = false;
249
250 out:
251         pthread_mutex_unlock(&dev->mutex);
252
253         return 0;
254 err:
255         pthread_mutex_unlock(&dev->mutex);
256
257         PMD_INIT_LOG(ERR, "(%s) Failed to stop device\n", dev->path);
258
259         return -1;
260 }
261
262 static inline void
263 parse_mac(struct virtio_user_dev *dev, const char *mac)
264 {
265         struct rte_ether_addr tmp;
266
267         if (!mac)
268                 return;
269
270         if (rte_ether_unformat_addr(mac, &tmp) == 0) {
271                 memcpy(dev->mac_addr, &tmp, RTE_ETHER_ADDR_LEN);
272                 dev->mac_specified = 1;
273         } else {
274                 /* ignore the wrong mac, use random mac */
275                 PMD_DRV_LOG(ERR, "wrong format of mac: %s", mac);
276         }
277 }
278
279 static int
280 virtio_user_dev_init_notify(struct virtio_user_dev *dev)
281 {
282         uint32_t i, j;
283         int callfd;
284         int kickfd;
285
286         for (i = 0; i < VIRTIO_MAX_VIRTQUEUES; ++i) {
287                 if (i >= dev->max_queue_pairs * 2) {
288                         dev->kickfds[i] = -1;
289                         dev->callfds[i] = -1;
290                         continue;
291                 }
292
293                 /* May use invalid flag, but some backend uses kickfd and
294                  * callfd as criteria to judge if dev is alive. so finally we
295                  * use real event_fd.
296                  */
297                 callfd = eventfd(0, EFD_CLOEXEC | EFD_NONBLOCK);
298                 if (callfd < 0) {
299                         PMD_DRV_LOG(ERR, "(%s) callfd error, %s", dev->path, strerror(errno));
300                         break;
301                 }
302                 kickfd = eventfd(0, EFD_CLOEXEC | EFD_NONBLOCK);
303                 if (kickfd < 0) {
304                         close(callfd);
305                         PMD_DRV_LOG(ERR, "(%s) kickfd error, %s", dev->path, strerror(errno));
306                         break;
307                 }
308                 dev->callfds[i] = callfd;
309                 dev->kickfds[i] = kickfd;
310         }
311
312         if (i < VIRTIO_MAX_VIRTQUEUES) {
313                 for (j = 0; j < i; ++j) {
314                         close(dev->callfds[j]);
315                         close(dev->kickfds[j]);
316                 }
317
318                 return -1;
319         }
320
321         return 0;
322 }
323
324 static int
325 virtio_user_fill_intr_handle(struct virtio_user_dev *dev)
326 {
327         uint32_t i;
328         struct rte_eth_dev *eth_dev = &rte_eth_devices[dev->port_id];
329
330         if (!eth_dev->intr_handle) {
331                 eth_dev->intr_handle = malloc(sizeof(*eth_dev->intr_handle));
332                 if (!eth_dev->intr_handle) {
333                         PMD_DRV_LOG(ERR, "(%s) failed to allocate intr_handle", dev->path);
334                         return -1;
335                 }
336                 memset(eth_dev->intr_handle, 0, sizeof(*eth_dev->intr_handle));
337         }
338
339         for (i = 0; i < dev->max_queue_pairs; ++i)
340                 eth_dev->intr_handle->efds[i] = dev->callfds[i];
341         eth_dev->intr_handle->nb_efd = dev->max_queue_pairs;
342         eth_dev->intr_handle->max_intr = dev->max_queue_pairs + 1;
343         eth_dev->intr_handle->type = RTE_INTR_HANDLE_VDEV;
344         /* For virtio vdev, no need to read counter for clean */
345         eth_dev->intr_handle->efd_counter_size = 0;
346         eth_dev->intr_handle->fd = dev->ops->get_intr_fd(dev);
347
348         return 0;
349 }
350
351 static void
352 virtio_user_mem_event_cb(enum rte_mem_event type __rte_unused,
353                          const void *addr,
354                          size_t len __rte_unused,
355                          void *arg)
356 {
357         struct virtio_user_dev *dev = arg;
358         struct rte_memseg_list *msl;
359         uint16_t i;
360         int ret = 0;
361
362         /* ignore externally allocated memory */
363         msl = rte_mem_virt2memseg_list(addr);
364         if (msl->external)
365                 return;
366
367         pthread_mutex_lock(&dev->mutex);
368
369         if (dev->started == false)
370                 goto exit;
371
372         /* Step 1: pause the active queues */
373         for (i = 0; i < dev->queue_pairs; i++) {
374                 ret = dev->ops->enable_qp(dev, i, 0);
375                 if (ret < 0)
376                         goto exit;
377         }
378
379         /* Step 2: update memory regions */
380         ret = dev->ops->set_memory_table(dev);
381         if (ret < 0)
382                 goto exit;
383
384         /* Step 3: resume the active queues */
385         for (i = 0; i < dev->queue_pairs; i++) {
386                 ret = dev->ops->enable_qp(dev, i, 1);
387                 if (ret < 0)
388                         goto exit;
389         }
390
391 exit:
392         pthread_mutex_unlock(&dev->mutex);
393
394         if (ret < 0)
395                 PMD_DRV_LOG(ERR, "(%s) Failed to update memory table\n", dev->path);
396 }
397
398 static int
399 virtio_user_dev_setup(struct virtio_user_dev *dev)
400 {
401         if (dev->is_server) {
402                 if (dev->backend_type != VIRTIO_USER_BACKEND_VHOST_USER) {
403                         PMD_DRV_LOG(ERR, "Server mode only supports vhost-user!");
404                         return -1;
405                 }
406         }
407
408         switch (dev->backend_type) {
409         case VIRTIO_USER_BACKEND_VHOST_USER:
410                 dev->ops = &virtio_ops_user;
411                 break;
412         case VIRTIO_USER_BACKEND_VHOST_KERNEL:
413                 dev->ops = &virtio_ops_kernel;
414                 break;
415         case VIRTIO_USER_BACKEND_VHOST_VDPA:
416                 dev->ops = &virtio_ops_vdpa;
417                 break;
418         default:
419                 PMD_DRV_LOG(ERR, "(%s) Unknown backend type", dev->path);
420                 return -1;
421         }
422
423         if (dev->ops->setup(dev) < 0) {
424                 PMD_INIT_LOG(ERR, "(%s) Failed to setup backend\n", dev->path);
425                 return -1;
426         }
427
428         if (virtio_user_dev_init_notify(dev) < 0) {
429                 PMD_INIT_LOG(ERR, "(%s) Failed to init notifiers\n", dev->path);
430                 return -1;
431         }
432
433         if (virtio_user_fill_intr_handle(dev) < 0) {
434                 PMD_INIT_LOG(ERR, "(%s) Failed to init interrupt handler\n", dev->path);
435                 return -1;
436         }
437
438         return 0;
439 }
440
441 /* Use below macro to filter features from vhost backend */
442 #define VIRTIO_USER_SUPPORTED_FEATURES                  \
443         (1ULL << VIRTIO_NET_F_MAC               |       \
444          1ULL << VIRTIO_NET_F_STATUS            |       \
445          1ULL << VIRTIO_NET_F_MQ                |       \
446          1ULL << VIRTIO_NET_F_CTRL_MAC_ADDR     |       \
447          1ULL << VIRTIO_NET_F_CTRL_VQ           |       \
448          1ULL << VIRTIO_NET_F_CTRL_RX           |       \
449          1ULL << VIRTIO_NET_F_CTRL_VLAN         |       \
450          1ULL << VIRTIO_NET_F_CSUM              |       \
451          1ULL << VIRTIO_NET_F_HOST_TSO4         |       \
452          1ULL << VIRTIO_NET_F_HOST_TSO6         |       \
453          1ULL << VIRTIO_NET_F_MRG_RXBUF         |       \
454          1ULL << VIRTIO_RING_F_INDIRECT_DESC    |       \
455          1ULL << VIRTIO_NET_F_GUEST_CSUM        |       \
456          1ULL << VIRTIO_NET_F_GUEST_TSO4        |       \
457          1ULL << VIRTIO_NET_F_GUEST_TSO6        |       \
458          1ULL << VIRTIO_F_IN_ORDER              |       \
459          1ULL << VIRTIO_F_VERSION_1             |       \
460          1ULL << VIRTIO_F_RING_PACKED)
461
462 int
463 virtio_user_dev_init(struct virtio_user_dev *dev, char *path, int queues,
464                      int cq, int queue_size, const char *mac, char **ifname,
465                      int server, int mrg_rxbuf, int in_order, int packed_vq,
466                      enum virtio_user_backend_type backend_type)
467 {
468         uint64_t backend_features;
469
470         pthread_mutex_init(&dev->mutex, NULL);
471         strlcpy(dev->path, path, PATH_MAX);
472         dev->started = 0;
473         dev->max_queue_pairs = queues;
474         dev->queue_pairs = 1; /* mq disabled by default */
475         dev->queue_size = queue_size;
476         dev->is_server = server;
477         dev->mac_specified = 0;
478         dev->frontend_features = 0;
479         dev->unsupported_features = 0;
480         dev->backend_type = backend_type;
481
482         parse_mac(dev, mac);
483
484         if (*ifname) {
485                 dev->ifname = *ifname;
486                 *ifname = NULL;
487         }
488
489         if (virtio_user_dev_setup(dev) < 0) {
490                 PMD_INIT_LOG(ERR, "(%s) backend set up fails", dev->path);
491                 return -1;
492         }
493
494         if (dev->ops->set_owner(dev) < 0) {
495                 PMD_INIT_LOG(ERR, "(%s) Failed to set backend owner", dev->path);
496                 return -1;
497         }
498
499         if (dev->ops->get_backend_features(&backend_features) < 0) {
500                 PMD_INIT_LOG(ERR, "(%s) Failed to get backend features", dev->path);
501                 return -1;
502         }
503
504         dev->unsupported_features = ~(VIRTIO_USER_SUPPORTED_FEATURES | backend_features);
505
506         if (dev->ops->get_features(dev, &dev->device_features) < 0) {
507                 PMD_INIT_LOG(ERR, "(%s) Failed to get device features", dev->path);
508                 return -1;
509         }
510
511         if (!mrg_rxbuf)
512                 dev->unsupported_features |= (1ull << VIRTIO_NET_F_MRG_RXBUF);
513
514         if (!in_order)
515                 dev->unsupported_features |= (1ull << VIRTIO_F_IN_ORDER);
516
517         if (!packed_vq)
518                 dev->unsupported_features |= (1ull << VIRTIO_F_RING_PACKED);
519
520         if (dev->mac_specified)
521                 dev->frontend_features |= (1ull << VIRTIO_NET_F_MAC);
522         else
523                 dev->unsupported_features |= (1ull << VIRTIO_NET_F_MAC);
524
525         if (cq) {
526                 /* device does not really need to know anything about CQ,
527                  * so if necessary, we just claim to support CQ
528                  */
529                 dev->frontend_features |= (1ull << VIRTIO_NET_F_CTRL_VQ);
530         } else {
531                 dev->unsupported_features |= (1ull << VIRTIO_NET_F_CTRL_VQ);
532                 /* Also disable features that depend on VIRTIO_NET_F_CTRL_VQ */
533                 dev->unsupported_features |= (1ull << VIRTIO_NET_F_CTRL_RX);
534                 dev->unsupported_features |= (1ull << VIRTIO_NET_F_CTRL_VLAN);
535                 dev->unsupported_features |=
536                         (1ull << VIRTIO_NET_F_GUEST_ANNOUNCE);
537                 dev->unsupported_features |= (1ull << VIRTIO_NET_F_MQ);
538                 dev->unsupported_features |=
539                         (1ull << VIRTIO_NET_F_CTRL_MAC_ADDR);
540         }
541
542         /* The backend will not report this feature, we add it explicitly */
543         if (dev->backend_type == VIRTIO_USER_BACKEND_VHOST_USER)
544                 dev->frontend_features |= (1ull << VIRTIO_NET_F_STATUS);
545
546         /*
547          * Device features =
548          *     (frontend_features | backend_features) & ~unsupported_features;
549          */
550         dev->device_features |= dev->frontend_features;
551         dev->device_features &= ~dev->unsupported_features;
552
553         if (rte_mem_event_callback_register(VIRTIO_USER_MEM_EVENT_CLB_NAME,
554                                 virtio_user_mem_event_cb, dev)) {
555                 if (rte_errno != ENOTSUP) {
556                         PMD_INIT_LOG(ERR, "(%s) Failed to register mem event callback\n",
557                                         dev->path);
558                         return -1;
559                 }
560         }
561
562         return 0;
563 }
564
565 void
566 virtio_user_dev_uninit(struct virtio_user_dev *dev)
567 {
568         uint32_t i;
569
570         virtio_user_stop_device(dev);
571
572         rte_mem_event_callback_unregister(VIRTIO_USER_MEM_EVENT_CLB_NAME, dev);
573
574         for (i = 0; i < dev->max_queue_pairs * 2; ++i) {
575                 close(dev->callfds[i]);
576                 close(dev->kickfds[i]);
577         }
578
579         free(dev->ifname);
580
581         if (dev->is_server)
582                 unlink(dev->path);
583
584         dev->ops->destroy(dev);
585 }
586
587 uint8_t
588 virtio_user_handle_mq(struct virtio_user_dev *dev, uint16_t q_pairs)
589 {
590         uint16_t i;
591         uint8_t ret = 0;
592
593         if (q_pairs > dev->max_queue_pairs) {
594                 PMD_INIT_LOG(ERR, "(%s) multi-q config %u, but only %u supported",
595                              dev->path, q_pairs, dev->max_queue_pairs);
596                 return -1;
597         }
598
599         for (i = 0; i < q_pairs; ++i)
600                 ret |= dev->ops->enable_qp(dev, i, 1);
601         for (i = q_pairs; i < dev->max_queue_pairs; ++i)
602                 ret |= dev->ops->enable_qp(dev, i, 0);
603
604         dev->queue_pairs = q_pairs;
605
606         return ret;
607 }
608
609 static uint32_t
610 virtio_user_handle_ctrl_msg(struct virtio_user_dev *dev, struct vring *vring,
611                             uint16_t idx_hdr)
612 {
613         struct virtio_net_ctrl_hdr *hdr;
614         virtio_net_ctrl_ack status = ~0;
615         uint16_t i, idx_data, idx_status;
616         uint32_t n_descs = 0;
617
618         /* locate desc for header, data, and status */
619         idx_data = vring->desc[idx_hdr].next;
620         n_descs++;
621
622         i = idx_data;
623         while (vring->desc[i].flags == VRING_DESC_F_NEXT) {
624                 i = vring->desc[i].next;
625                 n_descs++;
626         }
627
628         /* locate desc for status */
629         idx_status = i;
630         n_descs++;
631
632         hdr = (void *)(uintptr_t)vring->desc[idx_hdr].addr;
633         if (hdr->class == VIRTIO_NET_CTRL_MQ &&
634             hdr->cmd == VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET) {
635                 uint16_t queues;
636
637                 queues = *(uint16_t *)(uintptr_t)vring->desc[idx_data].addr;
638                 status = virtio_user_handle_mq(dev, queues);
639         } else if (hdr->class == VIRTIO_NET_CTRL_RX  ||
640                    hdr->class == VIRTIO_NET_CTRL_MAC ||
641                    hdr->class == VIRTIO_NET_CTRL_VLAN) {
642                 status = 0;
643         }
644
645         /* Update status */
646         *(virtio_net_ctrl_ack *)(uintptr_t)vring->desc[idx_status].addr = status;
647
648         return n_descs;
649 }
650
651 static inline int
652 desc_is_avail(struct vring_packed_desc *desc, bool wrap_counter)
653 {
654         uint16_t flags = __atomic_load_n(&desc->flags, __ATOMIC_ACQUIRE);
655
656         return wrap_counter == !!(flags & VRING_PACKED_DESC_F_AVAIL) &&
657                 wrap_counter != !!(flags & VRING_PACKED_DESC_F_USED);
658 }
659
660 static uint32_t
661 virtio_user_handle_ctrl_msg_packed(struct virtio_user_dev *dev,
662                                    struct vring_packed *vring,
663                                    uint16_t idx_hdr)
664 {
665         struct virtio_net_ctrl_hdr *hdr;
666         virtio_net_ctrl_ack status = ~0;
667         uint16_t idx_data, idx_status;
668         /* initialize to one, header is first */
669         uint32_t n_descs = 1;
670
671         /* locate desc for header, data, and status */
672         idx_data = idx_hdr + 1;
673         if (idx_data >= dev->queue_size)
674                 idx_data -= dev->queue_size;
675
676         n_descs++;
677
678         idx_status = idx_data;
679         while (vring->desc[idx_status].flags & VRING_DESC_F_NEXT) {
680                 idx_status++;
681                 if (idx_status >= dev->queue_size)
682                         idx_status -= dev->queue_size;
683                 n_descs++;
684         }
685
686         hdr = (void *)(uintptr_t)vring->desc[idx_hdr].addr;
687         if (hdr->class == VIRTIO_NET_CTRL_MQ &&
688             hdr->cmd == VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET) {
689                 uint16_t queues;
690
691                 queues = *(uint16_t *)(uintptr_t)
692                                 vring->desc[idx_data].addr;
693                 status = virtio_user_handle_mq(dev, queues);
694         } else if (hdr->class == VIRTIO_NET_CTRL_RX  ||
695                    hdr->class == VIRTIO_NET_CTRL_MAC ||
696                    hdr->class == VIRTIO_NET_CTRL_VLAN) {
697                 status = 0;
698         }
699
700         /* Update status */
701         *(virtio_net_ctrl_ack *)(uintptr_t)
702                 vring->desc[idx_status].addr = status;
703
704         /* Update used descriptor */
705         vring->desc[idx_hdr].id = vring->desc[idx_status].id;
706         vring->desc[idx_hdr].len = sizeof(status);
707
708         return n_descs;
709 }
710
711 void
712 virtio_user_handle_cq_packed(struct virtio_user_dev *dev, uint16_t queue_idx)
713 {
714         struct virtio_user_queue *vq = &dev->packed_queues[queue_idx];
715         struct vring_packed *vring = &dev->packed_vrings[queue_idx];
716         uint16_t n_descs, flags;
717
718         /* Perform a load-acquire barrier in desc_is_avail to
719          * enforce the ordering between desc flags and desc
720          * content.
721          */
722         while (desc_is_avail(&vring->desc[vq->used_idx],
723                              vq->used_wrap_counter)) {
724
725                 n_descs = virtio_user_handle_ctrl_msg_packed(dev, vring,
726                                 vq->used_idx);
727
728                 flags = VRING_DESC_F_WRITE;
729                 if (vq->used_wrap_counter)
730                         flags |= VRING_PACKED_DESC_F_AVAIL_USED;
731
732                 __atomic_store_n(&vring->desc[vq->used_idx].flags, flags,
733                                  __ATOMIC_RELEASE);
734
735                 vq->used_idx += n_descs;
736                 if (vq->used_idx >= dev->queue_size) {
737                         vq->used_idx -= dev->queue_size;
738                         vq->used_wrap_counter ^= 1;
739                 }
740         }
741 }
742
743 void
744 virtio_user_handle_cq(struct virtio_user_dev *dev, uint16_t queue_idx)
745 {
746         uint16_t avail_idx, desc_idx;
747         struct vring_used_elem *uep;
748         uint32_t n_descs;
749         struct vring *vring = &dev->vrings[queue_idx];
750
751         /* Consume avail ring, using used ring idx as first one */
752         while (__atomic_load_n(&vring->used->idx, __ATOMIC_RELAXED)
753                != vring->avail->idx) {
754                 avail_idx = __atomic_load_n(&vring->used->idx, __ATOMIC_RELAXED)
755                             & (vring->num - 1);
756                 desc_idx = vring->avail->ring[avail_idx];
757
758                 n_descs = virtio_user_handle_ctrl_msg(dev, vring, desc_idx);
759
760                 /* Update used ring */
761                 uep = &vring->used->ring[avail_idx];
762                 uep->id = desc_idx;
763                 uep->len = n_descs;
764
765                 __atomic_add_fetch(&vring->used->idx, 1, __ATOMIC_RELAXED);
766         }
767 }
768
769 int
770 virtio_user_dev_set_status(struct virtio_user_dev *dev, uint8_t status)
771 {
772         int ret;
773
774         pthread_mutex_lock(&dev->mutex);
775         dev->status = status;
776         ret = dev->ops->set_status(dev, status);
777         if (ret && ret != -ENOTSUP)
778                 PMD_INIT_LOG(ERR, "(%s) Failed to set backend status\n", dev->path);
779
780         pthread_mutex_unlock(&dev->mutex);
781         return ret;
782 }
783
784 int
785 virtio_user_dev_update_status(struct virtio_user_dev *dev)
786 {
787         int ret;
788         uint8_t status;
789
790         pthread_mutex_lock(&dev->mutex);
791
792         ret = dev->ops->get_status(dev, &status);
793         if (!ret) {
794                 dev->status = status;
795                 PMD_INIT_LOG(DEBUG, "Updated Device Status(0x%08x):\n"
796                         "\t-RESET: %u\n"
797                         "\t-ACKNOWLEDGE: %u\n"
798                         "\t-DRIVER: %u\n"
799                         "\t-DRIVER_OK: %u\n"
800                         "\t-FEATURES_OK: %u\n"
801                         "\t-DEVICE_NEED_RESET: %u\n"
802                         "\t-FAILED: %u\n",
803                         dev->status,
804                         (dev->status == VIRTIO_CONFIG_STATUS_RESET),
805                         !!(dev->status & VIRTIO_CONFIG_STATUS_ACK),
806                         !!(dev->status & VIRTIO_CONFIG_STATUS_DRIVER),
807                         !!(dev->status & VIRTIO_CONFIG_STATUS_DRIVER_OK),
808                         !!(dev->status & VIRTIO_CONFIG_STATUS_FEATURES_OK),
809                         !!(dev->status & VIRTIO_CONFIG_STATUS_DEV_NEED_RESET),
810                         !!(dev->status & VIRTIO_CONFIG_STATUS_FAILED));
811         } else if (ret != -ENOTSUP) {
812                 PMD_INIT_LOG(ERR, "(%s) Failed to get backend status\n", dev->path);
813         }
814
815         pthread_mutex_unlock(&dev->mutex);
816         return ret;
817 }
818
819 int
820 virtio_user_dev_update_link_state(struct virtio_user_dev *dev)
821 {
822         if (dev->ops->update_link_state)
823                 return dev->ops->update_link_state(dev);
824
825         return 0;
826 }
827
828 static void
829 virtio_user_dev_reset_queues_packed(struct rte_eth_dev *eth_dev)
830 {
831         struct virtio_user_dev *dev = eth_dev->data->dev_private;
832         struct virtio_hw *hw = &dev->hw;
833         struct virtnet_rx *rxvq;
834         struct virtnet_tx *txvq;
835         uint16_t i;
836
837         /* Add lock to avoid queue contention. */
838         rte_spinlock_lock(&hw->state_lock);
839         hw->started = 0;
840
841         /*
842          * Waiting for datapath to complete before resetting queues.
843          * 1 ms should be enough for the ongoing Tx/Rx function to finish.
844          */
845         rte_delay_ms(1);
846
847         /* Vring reset for each Tx queue and Rx queue. */
848         for (i = 0; i < eth_dev->data->nb_rx_queues; i++) {
849                 rxvq = eth_dev->data->rx_queues[i];
850                 virtqueue_rxvq_reset_packed(rxvq->vq);
851                 virtio_dev_rx_queue_setup_finish(eth_dev, i);
852         }
853
854         for (i = 0; i < eth_dev->data->nb_tx_queues; i++) {
855                 txvq = eth_dev->data->tx_queues[i];
856                 virtqueue_txvq_reset_packed(txvq->vq);
857         }
858
859         hw->started = 1;
860         rte_spinlock_unlock(&hw->state_lock);
861 }
862
863 void
864 virtio_user_dev_delayed_handler(void *param)
865 {
866         struct virtio_user_dev *dev = param;
867         struct rte_eth_dev *eth_dev = &rte_eth_devices[dev->port_id];
868
869         if (rte_intr_disable(eth_dev->intr_handle) < 0) {
870                 PMD_DRV_LOG(ERR, "interrupt disable failed");
871                 return;
872         }
873         rte_intr_callback_unregister(eth_dev->intr_handle,
874                                      virtio_interrupt_handler, eth_dev);
875         if (dev->is_server) {
876                 if (dev->ops->server_disconnect)
877                         dev->ops->server_disconnect(dev);
878                 eth_dev->intr_handle->fd = dev->ops->get_intr_fd(dev);
879                 rte_intr_callback_register(eth_dev->intr_handle,
880                                            virtio_interrupt_handler, eth_dev);
881                 if (rte_intr_enable(eth_dev->intr_handle) < 0) {
882                         PMD_DRV_LOG(ERR, "interrupt enable failed");
883                         return;
884                 }
885         }
886 }
887
888 int
889 virtio_user_dev_server_reconnect(struct virtio_user_dev *dev)
890 {
891         int ret, old_status;
892         struct rte_eth_dev *eth_dev = &rte_eth_devices[dev->port_id];
893         struct virtio_hw *hw = &dev->hw;
894
895         if (!dev->ops->server_reconnect) {
896                 PMD_DRV_LOG(ERR, "(%s) Missing server reconnect callback", dev->path);
897                 return -1;
898         }
899
900         if (dev->ops->server_reconnect(dev)) {
901                 PMD_DRV_LOG(ERR, "(%s) Reconnect callback call failed", dev->path);
902                 return -1;
903         }
904
905         old_status = dev->status;
906
907         virtio_reset(hw);
908
909         virtio_set_status(hw, VIRTIO_CONFIG_STATUS_ACK);
910
911         virtio_set_status(hw, VIRTIO_CONFIG_STATUS_DRIVER);
912
913         if (dev->ops->get_features(dev, &dev->device_features) < 0) {
914                 PMD_INIT_LOG(ERR, "get_features failed: %s",
915                              strerror(errno));
916                 return -1;
917         }
918
919         dev->device_features |= dev->frontend_features;
920
921         /* unmask vhost-user unsupported features */
922         dev->device_features &= ~(dev->unsupported_features);
923
924         dev->features &= dev->device_features;
925
926         /* For packed ring, resetting queues is required in reconnection. */
927         if (virtio_with_packed_queue(hw) &&
928            (old_status & VIRTIO_CONFIG_STATUS_DRIVER_OK)) {
929                 PMD_INIT_LOG(NOTICE, "Packets on the fly will be dropped"
930                                 " when packed ring reconnecting.");
931                 virtio_user_dev_reset_queues_packed(eth_dev);
932         }
933
934         virtio_set_status(hw, VIRTIO_CONFIG_STATUS_FEATURES_OK);
935
936         /* Start the device */
937         virtio_set_status(hw, VIRTIO_CONFIG_STATUS_DRIVER_OK);
938         if (!dev->started)
939                 return -1;
940
941         if (dev->queue_pairs > 1) {
942                 ret = virtio_user_handle_mq(dev, dev->queue_pairs);
943                 if (ret != 0) {
944                         PMD_INIT_LOG(ERR, "Fails to enable multi-queue pairs!");
945                         return -1;
946                 }
947         }
948         if (eth_dev->data->dev_flags & RTE_ETH_DEV_INTR_LSC) {
949                 if (rte_intr_disable(eth_dev->intr_handle) < 0) {
950                         PMD_DRV_LOG(ERR, "interrupt disable failed");
951                         return -1;
952                 }
953                 rte_intr_callback_unregister(eth_dev->intr_handle,
954                                              virtio_interrupt_handler,
955                                              eth_dev);
956
957                 eth_dev->intr_handle->fd = dev->ops->get_intr_fd(dev);
958                 rte_intr_callback_register(eth_dev->intr_handle,
959                                            virtio_interrupt_handler, eth_dev);
960
961                 if (rte_intr_enable(eth_dev->intr_handle) < 0) {
962                         PMD_DRV_LOG(ERR, "interrupt enable failed");
963                         return -1;
964                 }
965         }
966         PMD_INIT_LOG(NOTICE, "server mode virtio-user reconnection succeeds!");
967         return 0;
968 }