drivers/net/virtio/virtio_user/virtio_user_dev.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 <stdint.h>
  35 #include <stdio.h>
  36 #include <fcntl.h>
  37 #include <string.h>
  38 #include <errno.h>
  39 #include <sys/mman.h>
  40 #include <unistd.h>
  41 #include <sys/eventfd.h>
  42
  43 #include "vhost.h"
  44 #include "virtio_user_dev.h"
  45 #include "../virtio_ethdev.h"
  46
  47 static int
  48 virtio_user_create_queue(struct virtio_user_dev *dev, uint32_t queue_sel)
  49 {
  50         /* Of all per virtqueue MSGs, make sure VHOST_SET_VRING_CALL come
  51          * firstly because vhost depends on this msg to allocate virtqueue
  52          * pair.
  53          */
  54         int callfd;
  55         struct vhost_vring_file file;
  56
  57         /* May use invalid flag, but some backend leverages kickfd and callfd as
  58          * criteria to judge if dev is alive. so finally we use real event_fd.
  59          */
  60         callfd = eventfd(0, EFD_CLOEXEC | EFD_NONBLOCK);
  61         if (callfd < 0) {
  62                 PMD_DRV_LOG(ERR, "callfd error, %s\n", strerror(errno));
  63                 return -1;
  64         }
  65         file.index = queue_sel;
  66         file.fd = callfd;
  67         vhost_user_sock(dev->vhostfd, VHOST_USER_SET_VRING_CALL, &file);
  68         dev->callfds[queue_sel] = callfd;
  69
  70         return 0;
  71 }
  72
  73 static int
  74 virtio_user_kick_queue(struct virtio_user_dev *dev, uint32_t queue_sel)
  75 {
  76         int kickfd;
  77         struct vhost_vring_file file;
  78         struct vhost_vring_state state;
  79         struct vring *vring = &dev->vrings[queue_sel];
  80         struct vhost_vring_addr addr = {
  81                 .index = queue_sel,
  82                 .desc_user_addr = (uint64_t)(uintptr_t)vring->desc,
  83                 .avail_user_addr = (uint64_t)(uintptr_t)vring->avail,
  84                 .used_user_addr = (uint64_t)(uintptr_t)vring->used,
  85                 .log_guest_addr = 0,
  86                 .flags = 0, /* disable log */
  87         };
  88
  89         state.index = queue_sel;
  90         state.num = vring->num;
  91         vhost_user_sock(dev->vhostfd, VHOST_USER_SET_VRING_NUM, &state);
  92
  93         state.num = 0; /* no reservation */
  94         vhost_user_sock(dev->vhostfd, VHOST_USER_SET_VRING_BASE, &state);
  95
  96         vhost_user_sock(dev->vhostfd, VHOST_USER_SET_VRING_ADDR, &addr);
  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         kickfd = eventfd(0, EFD_CLOEXEC | EFD_NONBLOCK);
 103         if (kickfd < 0) {
 104                 PMD_DRV_LOG(ERR, "kickfd error, %s\n", strerror(errno));
 105                 return -1;
 106         }
 107         file.index = queue_sel;
 108         file.fd = kickfd;
 109         vhost_user_sock(dev->vhostfd, VHOST_USER_SET_VRING_KICK, &file);
 110         dev->kickfds[queue_sel] = kickfd;
 111
 112         return 0;
 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(INFO, "setup rx vq fails: %u", 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, "setup tx vq fails: %u", i);
 132                         return -1;
 133                 }
 134         }
 135
 136         return 0;
 137 }
 138
 139 int
 140 virtio_user_start_device(struct virtio_user_dev *dev)
 141 {
 142         uint64_t features;
 143         int ret;
 144
 145         /* Step 0: tell vhost to create queues */
 146         if (virtio_user_queue_setup(dev, virtio_user_create_queue) < 0)
 147                 goto error;
 148
 149         /* Step 1: set features
 150          * Make sure VHOST_USER_F_PROTOCOL_FEATURES is added if mq is enabled,
 151          * VIRTIO_NET_F_MAC and VIRTIO_NET_F_CTRL_VQ is stripped.
 152          */
 153         features = dev->features;
 154         if (dev->max_queue_pairs > 1)
 155                 features |= VHOST_USER_MQ;
 156         features &= ~(1ull << VIRTIO_NET_F_MAC);
 157         features &= ~(1ull << VIRTIO_NET_F_CTRL_VQ);
 158         ret = vhost_user_sock(dev->vhostfd, VHOST_USER_SET_FEATURES, &features);
 159         if (ret < 0)
 160                 goto error;
 161         PMD_DRV_LOG(INFO, "set features: %" PRIx64, features);
 162
 163         /* Step 2: share memory regions */
 164         ret = vhost_user_sock(dev->vhostfd, VHOST_USER_SET_MEM_TABLE, NULL);
 165         if (ret < 0)
 166                 goto error;
 167
 168         /* Step 3: kick queues */
 169         if (virtio_user_queue_setup(dev, virtio_user_kick_queue) < 0)
 170                 goto error;
 171
 172         /* Step 4: enable queues
 173          * we enable the 1st queue pair by default.
 174          */
 175         vhost_user_enable_queue_pair(dev->vhostfd, 0, 1);
 176
 177         return 0;
 178 error:
 179         /* TODO: free resource here or caller to check */
 180         return -1;
 181 }
 182
 183 int virtio_user_stop_device(struct virtio_user_dev *dev)
 184 {
 185         struct vhost_vring_state state;
 186         uint32_t i;
 187
 188         for (i = 0; i < dev->max_queue_pairs * 2; ++i) {
 189                 close(dev->callfds[i]);
 190                 close(dev->kickfds[i]);
 191         }
 192
 193         for (i = 0; i < dev->max_queue_pairs; ++i)
 194                 vhost_user_enable_queue_pair(dev->vhostfd, i, 0);
 195
 196         /* Stop the backend. */
 197         for (i = 0; i < dev->max_queue_pairs * 2; ++i) {
 198                 state.index = i;
 199                 if (vhost_user_sock(dev->vhostfd, VHOST_USER_GET_VRING_BASE,
 200                                            &state) < 0) {
 201                         PMD_DRV_LOG(ERR, "get_vring_base failed, index=%u\n",
 202                                     i);
 203                         return -1;
 204                 }
 205         }
 206
 207         return 0;
 208 }
 209
 210 static inline void
 211 parse_mac(struct virtio_user_dev *dev, const char *mac)
 212 {
 213         int i, r;
 214         uint32_t tmp[ETHER_ADDR_LEN];
 215
 216         if (!mac)
 217                 return;
 218
 219         r = sscanf(mac, "%x:%x:%x:%x:%x:%x", &tmp[0],
 220                         &tmp[1], &tmp[2], &tmp[3], &tmp[4], &tmp[5]);
 221         if (r == ETHER_ADDR_LEN) {
 222                 for (i = 0; i < ETHER_ADDR_LEN; ++i)
 223                         dev->mac_addr[i] = (uint8_t)tmp[i];
 224                 dev->mac_specified = 1;
 225         } else {
 226                 /* ignore the wrong mac, use random mac */
 227                 PMD_DRV_LOG(ERR, "wrong format of mac: %s", mac);
 228         }
 229 }
 230
 231 int
 232 virtio_user_dev_init(struct virtio_user_dev *dev, char *path, int queues,
 233                      int cq, int queue_size, const char *mac)
 234 {
 235         uint32_t i;
 236
 237         snprintf(dev->path, PATH_MAX, "%s", path);
 238         dev->max_queue_pairs = queues;
 239         dev->queue_pairs = 1; /* mq disabled by default */
 240         dev->queue_size = queue_size;
 241         dev->mac_specified = 0;
 242         parse_mac(dev, mac);
 243         dev->vhostfd = -1;
 244
 245         for (i = 0; i < VIRTIO_MAX_VIRTQUEUES; ++i) {
 246                 dev->kickfds[i] = -1;
 247                 dev->callfds[i] = -1;
 248         }
 249
 250         dev->vhostfd = vhost_user_setup(dev->path);
 251         if (dev->vhostfd < 0) {
 252                 PMD_INIT_LOG(ERR, "backend set up fails");
 253                 return -1;
 254         }
 255
 256         if (vhost_user_sock(dev->vhostfd, VHOST_USER_SET_OWNER, NULL) < 0) {
 257                 PMD_INIT_LOG(ERR, "set_owner fails: %s", strerror(errno));
 258                 return -1;
 259         }
 260
 261         if (vhost_user_sock(dev->vhostfd, VHOST_USER_GET_FEATURES,
 262                             &dev->device_features) < 0) {
 263                 PMD_INIT_LOG(ERR, "get_features failed: %s", strerror(errno));
 264                 return -1;
 265         }
 266         if (dev->mac_specified)
 267                 dev->device_features |= (1ull << VIRTIO_NET_F_MAC);
 268
 269         if (cq) {
 270                 /* device does not really need to know anything about CQ,
 271                  * so if necessary, we just claim to support CQ
 272                  */
 273                 dev->device_features |= (1ull << VIRTIO_NET_F_CTRL_VQ);
 274         } else {
 275                 dev->device_features &= ~(1ull << VIRTIO_NET_F_CTRL_VQ);
 276                 /* Also disable features depends on VIRTIO_NET_F_CTRL_VQ */
 277                 dev->device_features &= ~(1ull << VIRTIO_NET_F_CTRL_RX);
 278                 dev->device_features &= ~(1ull << VIRTIO_NET_F_CTRL_VLAN);
 279                 dev->device_features &= ~(1ull << VIRTIO_NET_F_GUEST_ANNOUNCE);
 280                 dev->device_features &= ~(1ull << VIRTIO_NET_F_MQ);
 281                 dev->device_features &= ~(1ull << VIRTIO_NET_F_CTRL_MAC_ADDR);
 282         }
 283
 284         if (dev->max_queue_pairs > 1) {
 285                 if (!(dev->features & VHOST_USER_MQ)) {
 286                         PMD_INIT_LOG(ERR, "MQ not supported by the backend");
 287                         return -1;
 288                 }
 289         }
 290
 291         return 0;
 292 }
 293
 294 void
 295 virtio_user_dev_uninit(struct virtio_user_dev *dev)
 296 {
 297         close(dev->vhostfd);
 298 }
 299
 300 static uint8_t
 301 virtio_user_handle_mq(struct virtio_user_dev *dev, uint16_t q_pairs)
 302 {
 303         uint16_t i;
 304         uint8_t ret = 0;
 305
 306         if (q_pairs > dev->max_queue_pairs) {
 307                 PMD_INIT_LOG(ERR, "multi-q config %u, but only %u supported",
 308                              q_pairs, dev->max_queue_pairs);
 309                 return -1;
 310         }
 311
 312         for (i = 0; i < q_pairs; ++i)
 313                 ret |= vhost_user_enable_queue_pair(dev->vhostfd, i, 1);
 314         for (i = q_pairs; i < dev->max_queue_pairs; ++i)
 315                 ret |= vhost_user_enable_queue_pair(dev->vhostfd, i, 0);
 316
 317         dev->queue_pairs = q_pairs;
 318
 319         return ret;
 320 }
 321
 322 static uint32_t
 323 virtio_user_handle_ctrl_msg(struct virtio_user_dev *dev, struct vring *vring,
 324                             uint16_t idx_hdr)
 325 {
 326         struct virtio_net_ctrl_hdr *hdr;
 327         virtio_net_ctrl_ack status = ~0;
 328         uint16_t i, idx_data, idx_status;
 329         uint32_t n_descs = 0;
 330
 331         /* locate desc for header, data, and status */
 332         idx_data = vring->desc[idx_hdr].next;
 333         n_descs++;
 334
 335         i = idx_data;
 336         while (vring->desc[i].flags == VRING_DESC_F_NEXT) {
 337                 i = vring->desc[i].next;
 338                 n_descs++;
 339         }
 340
 341         /* locate desc for status */
 342         idx_status = i;
 343         n_descs++;
 344
 345         hdr = (void *)(uintptr_t)vring->desc[idx_hdr].addr;
 346         if (hdr->class == VIRTIO_NET_CTRL_MQ &&
 347             hdr->cmd == VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET) {
 348                 uint16_t queues;
 349
 350                 queues = *(uint16_t *)(uintptr_t)vring->desc[idx_data].addr;
 351                 status = virtio_user_handle_mq(dev, queues);
 352         }
 353
 354         /* Update status */
 355         *(virtio_net_ctrl_ack *)(uintptr_t)vring->desc[idx_status].addr = status;
 356
 357         return n_descs;
 358 }
 359
 360 void
 361 virtio_user_handle_cq(struct virtio_user_dev *dev, uint16_t queue_idx)
 362 {
 363         uint16_t avail_idx, desc_idx;
 364         struct vring_used_elem *uep;
 365         uint32_t n_descs;
 366         struct vring *vring = &dev->vrings[queue_idx];
 367
 368         /* Consume avail ring, using used ring idx as first one */
 369         while (vring->used->idx != vring->avail->idx) {
 370                 avail_idx = (vring->used->idx) & (vring->num - 1);
 371                 desc_idx = vring->avail->ring[avail_idx];
 372
 373                 n_descs = virtio_user_handle_ctrl_msg(dev, vring, desc_idx);
 374
 375                 /* Update used ring */
 376                 uep = &vring->used->ring[avail_idx];
 377                 uep->id = avail_idx;
 378                 uep->len = n_descs;
 379
 380                 vring->used->idx++;
 381         }
 382 }