New upstream version 18.11-rc1
[deb_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_eal_memconfig.h>
17
18 #include "vhost.h"
19 #include "virtio_user_dev.h"
20 #include "../virtio_ethdev.h"
21
22 #define VIRTIO_USER_MEM_EVENT_CLB_NAME "virtio_user_mem_event_clb"
23
24 static int
25 virtio_user_create_queue(struct virtio_user_dev *dev, uint32_t queue_sel)
26 {
27         /* Of all per virtqueue MSGs, make sure VHOST_SET_VRING_CALL come
28          * firstly because vhost depends on this msg to allocate virtqueue
29          * pair.
30          */
31         struct vhost_vring_file file;
32
33         file.index = queue_sel;
34         file.fd = dev->callfds[queue_sel];
35         dev->ops->send_request(dev, VHOST_USER_SET_VRING_CALL, &file);
36
37         return 0;
38 }
39
40 static int
41 virtio_user_kick_queue(struct virtio_user_dev *dev, uint32_t queue_sel)
42 {
43         struct vhost_vring_file file;
44         struct vhost_vring_state state;
45         struct vring *vring = &dev->vrings[queue_sel];
46         struct vhost_vring_addr addr = {
47                 .index = queue_sel,
48                 .desc_user_addr = (uint64_t)(uintptr_t)vring->desc,
49                 .avail_user_addr = (uint64_t)(uintptr_t)vring->avail,
50                 .used_user_addr = (uint64_t)(uintptr_t)vring->used,
51                 .log_guest_addr = 0,
52                 .flags = 0, /* disable log */
53         };
54
55         state.index = queue_sel;
56         state.num = vring->num;
57         dev->ops->send_request(dev, VHOST_USER_SET_VRING_NUM, &state);
58
59         state.index = queue_sel;
60         state.num = 0; /* no reservation */
61         dev->ops->send_request(dev, VHOST_USER_SET_VRING_BASE, &state);
62
63         dev->ops->send_request(dev, VHOST_USER_SET_VRING_ADDR, &addr);
64
65         /* Of all per virtqueue MSGs, make sure VHOST_USER_SET_VRING_KICK comes
66          * lastly because vhost depends on this msg to judge if
67          * virtio is ready.
68          */
69         file.index = queue_sel;
70         file.fd = dev->kickfds[queue_sel];
71         dev->ops->send_request(dev, VHOST_USER_SET_VRING_KICK, &file);
72
73         return 0;
74 }
75
76 static int
77 virtio_user_queue_setup(struct virtio_user_dev *dev,
78                         int (*fn)(struct virtio_user_dev *, uint32_t))
79 {
80         uint32_t i, queue_sel;
81
82         for (i = 0; i < dev->max_queue_pairs; ++i) {
83                 queue_sel = 2 * i + VTNET_SQ_RQ_QUEUE_IDX;
84                 if (fn(dev, queue_sel) < 0) {
85                         PMD_DRV_LOG(INFO, "setup rx vq fails: %u", i);
86                         return -1;
87                 }
88         }
89         for (i = 0; i < dev->max_queue_pairs; ++i) {
90                 queue_sel = 2 * i + VTNET_SQ_TQ_QUEUE_IDX;
91                 if (fn(dev, queue_sel) < 0) {
92                         PMD_DRV_LOG(INFO, "setup tx vq fails: %u", i);
93                         return -1;
94                 }
95         }
96
97         return 0;
98 }
99
100 int
101 is_vhost_user_by_type(const char *path)
102 {
103         struct stat sb;
104
105         if (stat(path, &sb) == -1)
106                 return 0;
107
108         return S_ISSOCK(sb.st_mode);
109 }
110
111 int
112 virtio_user_start_device(struct virtio_user_dev *dev)
113 {
114         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
115         uint64_t features;
116         int ret;
117
118         /*
119          * XXX workaround!
120          *
121          * We need to make sure that the locks will be
122          * taken in the correct order to avoid deadlocks.
123          *
124          * Before releasing this lock, this thread should
125          * not trigger any memory hotplug events.
126          *
127          * This is a temporary workaround, and should be
128          * replaced when we get proper supports from the
129          * memory subsystem in the future.
130          */
131         rte_rwlock_read_lock(&mcfg->memory_hotplug_lock);
132         pthread_mutex_lock(&dev->mutex);
133
134         if (is_vhost_user_by_type(dev->path) && dev->vhostfd < 0)
135                 goto error;
136
137         /* Do not check return as already done in init, or reset in stop */
138         dev->ops->send_request(dev, VHOST_USER_SET_OWNER, NULL);
139
140         /* Step 0: tell vhost to create queues */
141         if (virtio_user_queue_setup(dev, virtio_user_create_queue) < 0)
142                 goto error;
143
144         /* Step 1: set features */
145         features = dev->features;
146         /* Strip VIRTIO_NET_F_MAC, as MAC address is handled in vdev init */
147         features &= ~(1ull << VIRTIO_NET_F_MAC);
148         /* Strip VIRTIO_NET_F_CTRL_VQ, as devices do not really need to know */
149         features &= ~(1ull << VIRTIO_NET_F_CTRL_VQ);
150         features &= ~(1ull << VIRTIO_NET_F_STATUS);
151         ret = dev->ops->send_request(dev, VHOST_USER_SET_FEATURES, &features);
152         if (ret < 0)
153                 goto error;
154         PMD_DRV_LOG(INFO, "set features: %" PRIx64, features);
155
156         /* Step 2: share memory regions */
157         ret = dev->ops->send_request(dev, VHOST_USER_SET_MEM_TABLE, NULL);
158         if (ret < 0)
159                 goto error;
160
161         /* Step 3: kick queues */
162         if (virtio_user_queue_setup(dev, virtio_user_kick_queue) < 0)
163                 goto error;
164
165         /* Step 4: enable queues
166          * we enable the 1st queue pair by default.
167          */
168         dev->ops->enable_qp(dev, 0, 1);
169
170         dev->started = true;
171         pthread_mutex_unlock(&dev->mutex);
172         rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
173
174         return 0;
175 error:
176         pthread_mutex_unlock(&dev->mutex);
177         rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
178         /* TODO: free resource here or caller to check */
179         return -1;
180 }
181
182 int virtio_user_stop_device(struct virtio_user_dev *dev)
183 {
184         uint32_t i;
185
186         pthread_mutex_lock(&dev->mutex);
187         for (i = 0; i < dev->max_queue_pairs; ++i)
188                 dev->ops->enable_qp(dev, i, 0);
189
190         if (dev->ops->send_request(dev, VHOST_USER_RESET_OWNER, NULL) < 0) {
191                 PMD_DRV_LOG(INFO, "Failed to reset the device\n");
192                 pthread_mutex_unlock(&dev->mutex);
193                 return -1;
194         }
195         dev->started = false;
196         pthread_mutex_unlock(&dev->mutex);
197
198         return 0;
199 }
200
201 static inline void
202 parse_mac(struct virtio_user_dev *dev, const char *mac)
203 {
204         int i, r;
205         uint32_t tmp[ETHER_ADDR_LEN];
206
207         if (!mac)
208                 return;
209
210         r = sscanf(mac, "%x:%x:%x:%x:%x:%x", &tmp[0],
211                         &tmp[1], &tmp[2], &tmp[3], &tmp[4], &tmp[5]);
212         if (r == ETHER_ADDR_LEN) {
213                 for (i = 0; i < ETHER_ADDR_LEN; ++i)
214                         dev->mac_addr[i] = (uint8_t)tmp[i];
215                 dev->mac_specified = 1;
216         } else {
217                 /* ignore the wrong mac, use random mac */
218                 PMD_DRV_LOG(ERR, "wrong format of mac: %s", mac);
219         }
220 }
221
222 static int
223 virtio_user_dev_init_notify(struct virtio_user_dev *dev)
224 {
225         uint32_t i, j;
226         int callfd;
227         int kickfd;
228
229         for (i = 0; i < VIRTIO_MAX_VIRTQUEUES; ++i) {
230                 if (i >= dev->max_queue_pairs * 2) {
231                         dev->kickfds[i] = -1;
232                         dev->callfds[i] = -1;
233                         continue;
234                 }
235
236                 /* May use invalid flag, but some backend uses kickfd and
237                  * callfd as criteria to judge if dev is alive. so finally we
238                  * use real event_fd.
239                  */
240                 callfd = eventfd(0, EFD_CLOEXEC | EFD_NONBLOCK);
241                 if (callfd < 0) {
242                         PMD_DRV_LOG(ERR, "callfd error, %s", strerror(errno));
243                         break;
244                 }
245                 kickfd = eventfd(0, EFD_CLOEXEC | EFD_NONBLOCK);
246                 if (kickfd < 0) {
247                         PMD_DRV_LOG(ERR, "kickfd error, %s", strerror(errno));
248                         break;
249                 }
250                 dev->callfds[i] = callfd;
251                 dev->kickfds[i] = kickfd;
252         }
253
254         if (i < VIRTIO_MAX_VIRTQUEUES) {
255                 for (j = 0; j <= i; ++j) {
256                         close(dev->callfds[j]);
257                         close(dev->kickfds[j]);
258                 }
259
260                 return -1;
261         }
262
263         return 0;
264 }
265
266 static int
267 virtio_user_fill_intr_handle(struct virtio_user_dev *dev)
268 {
269         uint32_t i;
270         struct rte_eth_dev *eth_dev = &rte_eth_devices[dev->port_id];
271
272         if (!eth_dev->intr_handle) {
273                 eth_dev->intr_handle = malloc(sizeof(*eth_dev->intr_handle));
274                 if (!eth_dev->intr_handle) {
275                         PMD_DRV_LOG(ERR, "fail to allocate intr_handle");
276                         return -1;
277                 }
278                 memset(eth_dev->intr_handle, 0, sizeof(*eth_dev->intr_handle));
279         }
280
281         for (i = 0; i < dev->max_queue_pairs; ++i)
282                 eth_dev->intr_handle->efds[i] = dev->callfds[i];
283         eth_dev->intr_handle->nb_efd = dev->max_queue_pairs;
284         eth_dev->intr_handle->max_intr = dev->max_queue_pairs + 1;
285         eth_dev->intr_handle->type = RTE_INTR_HANDLE_VDEV;
286         /* For virtio vdev, no need to read counter for clean */
287         eth_dev->intr_handle->efd_counter_size = 0;
288         eth_dev->intr_handle->fd = -1;
289         if (dev->vhostfd >= 0)
290                 eth_dev->intr_handle->fd = dev->vhostfd;
291         else if (dev->is_server)
292                 eth_dev->intr_handle->fd = dev->listenfd;
293
294         return 0;
295 }
296
297 static void
298 virtio_user_mem_event_cb(enum rte_mem_event type __rte_unused,
299                                                  const void *addr __rte_unused,
300                                                  size_t len __rte_unused,
301                                                  void *arg)
302 {
303         struct virtio_user_dev *dev = arg;
304         struct rte_memseg_list *msl;
305         uint16_t i;
306
307         /* ignore externally allocated memory */
308         msl = rte_mem_virt2memseg_list(addr);
309         if (msl->external)
310                 return;
311
312         pthread_mutex_lock(&dev->mutex);
313
314         if (dev->started == false)
315                 goto exit;
316
317         /* Step 1: pause the active queues */
318         for (i = 0; i < dev->queue_pairs; i++)
319                 dev->ops->enable_qp(dev, i, 0);
320
321         /* Step 2: update memory regions */
322         dev->ops->send_request(dev, VHOST_USER_SET_MEM_TABLE, NULL);
323
324         /* Step 3: resume the active queues */
325         for (i = 0; i < dev->queue_pairs; i++)
326                 dev->ops->enable_qp(dev, i, 1);
327
328 exit:
329         pthread_mutex_unlock(&dev->mutex);
330 }
331
332 static int
333 virtio_user_dev_setup(struct virtio_user_dev *dev)
334 {
335         uint32_t q;
336
337         dev->vhostfd = -1;
338         dev->vhostfds = NULL;
339         dev->tapfds = NULL;
340
341         if (dev->is_server) {
342                 if (access(dev->path, F_OK) == 0 &&
343                     !is_vhost_user_by_type(dev->path)) {
344                         PMD_DRV_LOG(ERR, "Server mode doesn't support vhost-kernel!");
345                         return -1;
346                 }
347                 dev->ops = &virtio_ops_user;
348         } else {
349                 if (is_vhost_user_by_type(dev->path)) {
350                         dev->ops = &virtio_ops_user;
351                 } else {
352                         dev->ops = &virtio_ops_kernel;
353
354                         dev->vhostfds = malloc(dev->max_queue_pairs *
355                                                sizeof(int));
356                         dev->tapfds = malloc(dev->max_queue_pairs *
357                                              sizeof(int));
358                         if (!dev->vhostfds || !dev->tapfds) {
359                                 PMD_INIT_LOG(ERR, "Failed to malloc");
360                                 return -1;
361                         }
362
363                         for (q = 0; q < dev->max_queue_pairs; ++q) {
364                                 dev->vhostfds[q] = -1;
365                                 dev->tapfds[q] = -1;
366                         }
367                 }
368         }
369
370         if (dev->ops->setup(dev) < 0)
371                 return -1;
372
373         if (virtio_user_dev_init_notify(dev) < 0)
374                 return -1;
375
376         if (virtio_user_fill_intr_handle(dev) < 0)
377                 return -1;
378
379         return 0;
380 }
381
382 /* Use below macro to filter features from vhost backend */
383 #define VIRTIO_USER_SUPPORTED_FEATURES                  \
384         (1ULL << VIRTIO_NET_F_MAC               |       \
385          1ULL << VIRTIO_NET_F_STATUS            |       \
386          1ULL << VIRTIO_NET_F_MQ                |       \
387          1ULL << VIRTIO_NET_F_CTRL_MAC_ADDR     |       \
388          1ULL << VIRTIO_NET_F_CTRL_VQ           |       \
389          1ULL << VIRTIO_NET_F_CTRL_RX           |       \
390          1ULL << VIRTIO_NET_F_CTRL_VLAN         |       \
391          1ULL << VIRTIO_NET_F_CSUM              |       \
392          1ULL << VIRTIO_NET_F_HOST_TSO4         |       \
393          1ULL << VIRTIO_NET_F_HOST_TSO6         |       \
394          1ULL << VIRTIO_NET_F_MRG_RXBUF         |       \
395          1ULL << VIRTIO_RING_F_INDIRECT_DESC    |       \
396          1ULL << VIRTIO_NET_F_GUEST_CSUM        |       \
397          1ULL << VIRTIO_NET_F_GUEST_TSO4        |       \
398          1ULL << VIRTIO_NET_F_GUEST_TSO6        |       \
399          1ULL << VIRTIO_F_IN_ORDER              |       \
400          1ULL << VIRTIO_F_VERSION_1)
401
402 int
403 virtio_user_dev_init(struct virtio_user_dev *dev, char *path, int queues,
404                      int cq, int queue_size, const char *mac, char **ifname,
405                      int mrg_rxbuf, int in_order)
406 {
407         pthread_mutex_init(&dev->mutex, NULL);
408         snprintf(dev->path, PATH_MAX, "%s", path);
409         dev->started = 0;
410         dev->max_queue_pairs = queues;
411         dev->queue_pairs = 1; /* mq disabled by default */
412         dev->queue_size = queue_size;
413         dev->mac_specified = 0;
414         dev->unsupported_features = 0;
415         parse_mac(dev, mac);
416
417         if (*ifname) {
418                 dev->ifname = *ifname;
419                 *ifname = NULL;
420         }
421
422         if (virtio_user_dev_setup(dev) < 0) {
423                 PMD_INIT_LOG(ERR, "backend set up fails");
424                 return -1;
425         }
426
427         if (!dev->is_server) {
428                 if (dev->ops->send_request(dev, VHOST_USER_SET_OWNER,
429                                            NULL) < 0) {
430                         PMD_INIT_LOG(ERR, "set_owner fails: %s",
431                                      strerror(errno));
432                         return -1;
433                 }
434
435                 if (dev->ops->send_request(dev, VHOST_USER_GET_FEATURES,
436                                            &dev->device_features) < 0) {
437                         PMD_INIT_LOG(ERR, "get_features failed: %s",
438                                      strerror(errno));
439                         return -1;
440                 }
441         } else {
442                 /* We just pretend vhost-user can support all these features.
443                  * Note that this could be problematic that if some feature is
444                  * negotiated but not supported by the vhost-user which comes
445                  * later.
446                  */
447                 dev->device_features = VIRTIO_USER_SUPPORTED_FEATURES;
448         }
449
450         if (!mrg_rxbuf) {
451                 dev->device_features &= ~(1ull << VIRTIO_NET_F_MRG_RXBUF);
452                 dev->unsupported_features |= (1ull << VIRTIO_NET_F_MRG_RXBUF);
453         }
454
455         if (!in_order) {
456                 dev->device_features &= ~(1ull << VIRTIO_F_IN_ORDER);
457                 dev->unsupported_features |= (1ull << VIRTIO_F_IN_ORDER);
458         }
459
460         if (dev->mac_specified) {
461                 dev->device_features |= (1ull << VIRTIO_NET_F_MAC);
462         } else {
463                 dev->device_features &= ~(1ull << VIRTIO_NET_F_MAC);
464                 dev->unsupported_features |= (1ull << VIRTIO_NET_F_MAC);
465         }
466
467         if (cq) {
468                 /* device does not really need to know anything about CQ,
469                  * so if necessary, we just claim to support CQ
470                  */
471                 dev->device_features |= (1ull << VIRTIO_NET_F_CTRL_VQ);
472         } else {
473                 dev->device_features &= ~(1ull << VIRTIO_NET_F_CTRL_VQ);
474                 /* Also disable features depends on VIRTIO_NET_F_CTRL_VQ */
475                 dev->device_features &= ~(1ull << VIRTIO_NET_F_CTRL_RX);
476                 dev->device_features &= ~(1ull << VIRTIO_NET_F_CTRL_VLAN);
477                 dev->device_features &= ~(1ull << VIRTIO_NET_F_GUEST_ANNOUNCE);
478                 dev->device_features &= ~(1ull << VIRTIO_NET_F_MQ);
479                 dev->device_features &= ~(1ull << VIRTIO_NET_F_CTRL_MAC_ADDR);
480                 dev->unsupported_features |= (1ull << VIRTIO_NET_F_CTRL_VQ);
481                 dev->unsupported_features |= (1ull << VIRTIO_NET_F_CTRL_RX);
482                 dev->unsupported_features |= (1ull << VIRTIO_NET_F_CTRL_VLAN);
483                 dev->unsupported_features |=
484                         (1ull << VIRTIO_NET_F_GUEST_ANNOUNCE);
485                 dev->unsupported_features |= (1ull << VIRTIO_NET_F_MQ);
486                 dev->unsupported_features |=
487                         (1ull << VIRTIO_NET_F_CTRL_MAC_ADDR);
488         }
489
490         /* The backend will not report this feature, we add it explicitly */
491         if (is_vhost_user_by_type(dev->path))
492                 dev->device_features |= (1ull << VIRTIO_NET_F_STATUS);
493
494         dev->device_features &= VIRTIO_USER_SUPPORTED_FEATURES;
495         dev->unsupported_features |= ~VIRTIO_USER_SUPPORTED_FEATURES;
496
497         if (rte_mem_event_callback_register(VIRTIO_USER_MEM_EVENT_CLB_NAME,
498                                 virtio_user_mem_event_cb, dev)) {
499                 if (rte_errno != ENOTSUP) {
500                         PMD_INIT_LOG(ERR, "Failed to register mem event"
501                                         " callback\n");
502                         return -1;
503                 }
504         }
505
506         return 0;
507 }
508
509 void
510 virtio_user_dev_uninit(struct virtio_user_dev *dev)
511 {
512         uint32_t i;
513
514         virtio_user_stop_device(dev);
515
516         rte_mem_event_callback_unregister(VIRTIO_USER_MEM_EVENT_CLB_NAME, dev);
517
518         for (i = 0; i < dev->max_queue_pairs * 2; ++i) {
519                 close(dev->callfds[i]);
520                 close(dev->kickfds[i]);
521         }
522
523         close(dev->vhostfd);
524
525         if (dev->is_server && dev->listenfd >= 0) {
526                 close(dev->listenfd);
527                 dev->listenfd = -1;
528         }
529
530         if (dev->vhostfds) {
531                 for (i = 0; i < dev->max_queue_pairs; ++i)
532                         close(dev->vhostfds[i]);
533                 free(dev->vhostfds);
534                 free(dev->tapfds);
535         }
536
537         free(dev->ifname);
538
539         if (dev->is_server)
540                 unlink(dev->path);
541 }
542
543 uint8_t
544 virtio_user_handle_mq(struct virtio_user_dev *dev, uint16_t q_pairs)
545 {
546         uint16_t i;
547         uint8_t ret = 0;
548
549         if (q_pairs > dev->max_queue_pairs) {
550                 PMD_INIT_LOG(ERR, "multi-q config %u, but only %u supported",
551                              q_pairs, dev->max_queue_pairs);
552                 return -1;
553         }
554
555         /* Server mode can't enable queue pairs if vhostfd is invalid,
556          * always return 0 in this case.
557          */
558         if (!dev->is_server || dev->vhostfd >= 0) {
559                 for (i = 0; i < q_pairs; ++i)
560                         ret |= dev->ops->enable_qp(dev, i, 1);
561                 for (i = q_pairs; i < dev->max_queue_pairs; ++i)
562                         ret |= dev->ops->enable_qp(dev, i, 0);
563         }
564         dev->queue_pairs = q_pairs;
565
566         return ret;
567 }
568
569 static uint32_t
570 virtio_user_handle_ctrl_msg(struct virtio_user_dev *dev, struct vring *vring,
571                             uint16_t idx_hdr)
572 {
573         struct virtio_net_ctrl_hdr *hdr;
574         virtio_net_ctrl_ack status = ~0;
575         uint16_t i, idx_data, idx_status;
576         uint32_t n_descs = 0;
577
578         /* locate desc for header, data, and status */
579         idx_data = vring->desc[idx_hdr].next;
580         n_descs++;
581
582         i = idx_data;
583         while (vring->desc[i].flags == VRING_DESC_F_NEXT) {
584                 i = vring->desc[i].next;
585                 n_descs++;
586         }
587
588         /* locate desc for status */
589         idx_status = i;
590         n_descs++;
591
592         hdr = (void *)(uintptr_t)vring->desc[idx_hdr].addr;
593         if (hdr->class == VIRTIO_NET_CTRL_MQ &&
594             hdr->cmd == VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET) {
595                 uint16_t queues;
596
597                 queues = *(uint16_t *)(uintptr_t)vring->desc[idx_data].addr;
598                 status = virtio_user_handle_mq(dev, queues);
599         }
600
601         /* Update status */
602         *(virtio_net_ctrl_ack *)(uintptr_t)vring->desc[idx_status].addr = status;
603
604         return n_descs;
605 }
606
607 void
608 virtio_user_handle_cq(struct virtio_user_dev *dev, uint16_t queue_idx)
609 {
610         uint16_t avail_idx, desc_idx;
611         struct vring_used_elem *uep;
612         uint32_t n_descs;
613         struct vring *vring = &dev->vrings[queue_idx];
614
615         /* Consume avail ring, using used ring idx as first one */
616         while (vring->used->idx != vring->avail->idx) {
617                 avail_idx = (vring->used->idx) & (vring->num - 1);
618                 desc_idx = vring->avail->ring[avail_idx];
619
620                 n_descs = virtio_user_handle_ctrl_msg(dev, vring, desc_idx);
621
622                 /* Update used ring */
623                 uep = &vring->used->ring[avail_idx];
624                 uep->id = avail_idx;
625                 uep->len = n_descs;
626
627                 vring->used->idx++;
628         }
629 }