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 #include <sys/types.h>
  43 #include <sys/stat.h>
  44 #include <unistd.h>
  45
  46 #include "vhost.h"
  47 #include "virtio_user_dev.h"
  48 #include "../virtio_ethdev.h"
  49
  50 static int
  51 virtio_user_create_queue(struct virtio_user_dev *dev, uint32_t queue_sel)
  52 {
  53         /* Of all per virtqueue MSGs, make sure VHOST_SET_VRING_CALL come
  54          * firstly because vhost depends on this msg to allocate virtqueue
  55          * pair.
  56          */
  57         int callfd;
  58         struct vhost_vring_file file;
  59
  60         /* May use invalid flag, but some backend leverages kickfd and callfd as
  61          * criteria to judge if dev is alive. so finally we use real event_fd.
  62          */
  63         callfd = eventfd(0, EFD_CLOEXEC | EFD_NONBLOCK);
  64         if (callfd < 0) {
  65                 PMD_DRV_LOG(ERR, "callfd error, %s\n", strerror(errno));
  66                 return -1;
  67         }
  68         file.index = queue_sel;
  69         file.fd = callfd;
  70         dev->ops->send_request(dev, VHOST_USER_SET_VRING_CALL, &file);
  71         dev->callfds[queue_sel] = callfd;
  72
  73         return 0;
  74 }
  75
  76 static int
  77 virtio_user_kick_queue(struct virtio_user_dev *dev, uint32_t queue_sel)
  78 {
  79         int kickfd;
  80         struct vhost_vring_file file;
  81         struct vhost_vring_state state;
  82         struct vring *vring = &dev->vrings[queue_sel];
  83         struct vhost_vring_addr addr = {
  84                 .index = queue_sel,
  85                 .desc_user_addr = (uint64_t)(uintptr_t)vring->desc,
  86                 .avail_user_addr = (uint64_t)(uintptr_t)vring->avail,
  87                 .used_user_addr = (uint64_t)(uintptr_t)vring->used,
  88                 .log_guest_addr = 0,
  89                 .flags = 0, /* disable log */
  90         };
  91
  92         state.index = queue_sel;
  93         state.num = vring->num;
  94         dev->ops->send_request(dev, VHOST_USER_SET_VRING_NUM, &state);
  95
  96         state.num = 0; /* no reservation */
  97         dev->ops->send_request(dev, VHOST_USER_SET_VRING_BASE, &state);
  98
  99         dev->ops->send_request(dev, VHOST_USER_SET_VRING_ADDR, &addr);
 100
 101         /* Of all per virtqueue MSGs, make sure VHOST_USER_SET_VRING_KICK comes
 102          * lastly because vhost depends on this msg to judge if
 103          * virtio is ready.
 104          */
 105         kickfd = eventfd(0, EFD_CLOEXEC | EFD_NONBLOCK);
 106         if (kickfd < 0) {
 107                 PMD_DRV_LOG(ERR, "kickfd error, %s\n", strerror(errno));
 108                 return -1;
 109         }
 110         file.index = queue_sel;
 111         file.fd = kickfd;
 112         dev->ops->send_request(dev, VHOST_USER_SET_VRING_KICK, &file);
 113         dev->kickfds[queue_sel] = kickfd;
 114
 115         return 0;
 116 }
 117
 118 static int
 119 virtio_user_queue_setup(struct virtio_user_dev *dev,
 120                         int (*fn)(struct virtio_user_dev *, uint32_t))
 121 {
 122         uint32_t i, queue_sel;
 123
 124         for (i = 0; i < dev->max_queue_pairs; ++i) {
 125                 queue_sel = 2 * i + VTNET_SQ_RQ_QUEUE_IDX;
 126                 if (fn(dev, queue_sel) < 0) {
 127                         PMD_DRV_LOG(INFO, "setup rx vq fails: %u", i);
 128                         return -1;
 129                 }
 130         }
 131         for (i = 0; i < dev->max_queue_pairs; ++i) {
 132                 queue_sel = 2 * i + VTNET_SQ_TQ_QUEUE_IDX;
 133                 if (fn(dev, queue_sel) < 0) {
 134                         PMD_DRV_LOG(INFO, "setup tx vq fails: %u", i);
 135                         return -1;
 136                 }
 137         }
 138
 139         return 0;
 140 }
 141
 142 int
 143 virtio_user_start_device(struct virtio_user_dev *dev)
 144 {
 145         uint64_t features;
 146         int ret;
 147
 148         /* Step 0: tell vhost to create queues */
 149         if (virtio_user_queue_setup(dev, virtio_user_create_queue) < 0)
 150                 goto error;
 151
 152         /* Step 1: set features */
 153         features = dev->features;
 154         /* Strip VIRTIO_NET_F_MAC, as MAC address is handled in vdev init */
 155         features &= ~(1ull << VIRTIO_NET_F_MAC);
 156         /* Strip VIRTIO_NET_F_CTRL_VQ, as devices do not really need to know */
 157         features &= ~(1ull << VIRTIO_NET_F_CTRL_VQ);
 158         ret = dev->ops->send_request(dev, 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 = dev->ops->send_request(dev, 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         dev->ops->enable_qp(dev, 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         uint32_t i;
 186
 187         for (i = 0; i < dev->max_queue_pairs * 2; ++i) {
 188                 close(dev->callfds[i]);
 189                 close(dev->kickfds[i]);
 190         }
 191
 192         for (i = 0; i < dev->max_queue_pairs; ++i)
 193                 dev->ops->enable_qp(dev, i, 0);
 194
 195         free(dev->ifname);
 196         dev->ifname = NULL;
 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 is_vhost_user_by_type(const char *path)
 224 {
 225         struct stat sb;
 226
 227         if (stat(path, &sb) == -1)
 228                 return 0;
 229
 230         return S_ISSOCK(sb.st_mode);
 231 }
 232
 233 static int
 234 virtio_user_dev_setup(struct virtio_user_dev *dev)
 235 {
 236         uint32_t i, q;
 237
 238         dev->vhostfd = -1;
 239         for (i = 0; i < VIRTIO_MAX_VIRTQUEUES * 2 + 1; ++i) {
 240                 dev->kickfds[i] = -1;
 241                 dev->callfds[i] = -1;
 242         }
 243
 244         dev->vhostfds = NULL;
 245         dev->tapfds = NULL;
 246
 247         if (is_vhost_user_by_type(dev->path)) {
 248                 dev->ops = &ops_user;
 249         } else {
 250                 dev->ops = &ops_kernel;
 251
 252                 dev->vhostfds = malloc(dev->max_queue_pairs * sizeof(int));
 253                 dev->tapfds = malloc(dev->max_queue_pairs * sizeof(int));
 254                 if (!dev->vhostfds || !dev->tapfds) {
 255                         PMD_INIT_LOG(ERR, "Failed to malloc");
 256                         return -1;
 257                 }
 258
 259                 for (q = 0; q < dev->max_queue_pairs; ++q) {
 260                         dev->vhostfds[q] = -1;
 261                         dev->tapfds[q] = -1;
 262                 }
 263         }
 264
 265         return dev->ops->setup(dev);
 266 }
 267
 268 int
 269 virtio_user_dev_init(struct virtio_user_dev *dev, char *path, int queues,
 270                      int cq, int queue_size, const char *mac)
 271 {
 272         snprintf(dev->path, PATH_MAX, "%s", path);
 273         dev->max_queue_pairs = queues;
 274         dev->queue_pairs = 1; /* mq disabled by default */
 275         dev->queue_size = queue_size;
 276         dev->mac_specified = 0;
 277         parse_mac(dev, mac);
 278
 279         if (virtio_user_dev_setup(dev) < 0) {
 280                 PMD_INIT_LOG(ERR, "backend set up fails");
 281                 return -1;
 282         }
 283         if (dev->ops->send_request(dev, VHOST_USER_SET_OWNER, NULL) < 0) {
 284                 PMD_INIT_LOG(ERR, "set_owner fails: %s", strerror(errno));
 285                 return -1;
 286         }
 287
 288         if (dev->ops->send_request(dev, VHOST_USER_GET_FEATURES,
 289                             &dev->device_features) < 0) {
 290                 PMD_INIT_LOG(ERR, "get_features failed: %s", strerror(errno));
 291                 return -1;
 292         }
 293         if (dev->mac_specified)
 294                 dev->device_features |= (1ull << VIRTIO_NET_F_MAC);
 295
 296         if (cq) {
 297                 /* device does not really need to know anything about CQ,
 298                  * so if necessary, we just claim to support CQ
 299                  */
 300                 dev->device_features |= (1ull << VIRTIO_NET_F_CTRL_VQ);
 301         } else {
 302                 dev->device_features &= ~(1ull << VIRTIO_NET_F_CTRL_VQ);
 303                 /* Also disable features depends on VIRTIO_NET_F_CTRL_VQ */
 304                 dev->device_features &= ~(1ull << VIRTIO_NET_F_CTRL_RX);
 305                 dev->device_features &= ~(1ull << VIRTIO_NET_F_CTRL_VLAN);
 306                 dev->device_features &= ~(1ull << VIRTIO_NET_F_GUEST_ANNOUNCE);
 307                 dev->device_features &= ~(1ull << VIRTIO_NET_F_MQ);
 308                 dev->device_features &= ~(1ull << VIRTIO_NET_F_CTRL_MAC_ADDR);
 309         }
 310
 311         return 0;
 312 }
 313
 314 void
 315 virtio_user_dev_uninit(struct virtio_user_dev *dev)
 316 {
 317         uint32_t i;
 318
 319         virtio_user_stop_device(dev);
 320
 321         close(dev->vhostfd);
 322
 323         if (dev->vhostfds) {
 324                 for (i = 0; i < dev->max_queue_pairs; ++i)
 325                         close(dev->vhostfds[i]);
 326                 free(dev->vhostfds);
 327                 free(dev->tapfds);
 328         }
 329 }
 330
 331 static uint8_t
 332 virtio_user_handle_mq(struct virtio_user_dev *dev, uint16_t q_pairs)
 333 {
 334         uint16_t i;
 335         uint8_t ret = 0;
 336
 337         if (q_pairs > dev->max_queue_pairs) {
 338                 PMD_INIT_LOG(ERR, "multi-q config %u, but only %u supported",
 339                              q_pairs, dev->max_queue_pairs);
 340                 return -1;
 341         }
 342
 343         for (i = 0; i < q_pairs; ++i)
 344                 ret |= dev->ops->enable_qp(dev, i, 1);
 345         for (i = q_pairs; i < dev->max_queue_pairs; ++i)
 346                 ret |= dev->ops->enable_qp(dev, i, 0);
 347
 348         dev->queue_pairs = q_pairs;
 349
 350         return ret;
 351 }
 352
 353 static uint32_t
 354 virtio_user_handle_ctrl_msg(struct virtio_user_dev *dev, struct vring *vring,
 355                             uint16_t idx_hdr)
 356 {
 357         struct virtio_net_ctrl_hdr *hdr;
 358         virtio_net_ctrl_ack status = ~0;
 359         uint16_t i, idx_data, idx_status;
 360         uint32_t n_descs = 0;
 361
 362         /* locate desc for header, data, and status */
 363         idx_data = vring->desc[idx_hdr].next;
 364         n_descs++;
 365
 366         i = idx_data;
 367         while (vring->desc[i].flags == VRING_DESC_F_NEXT) {
 368                 i = vring->desc[i].next;
 369                 n_descs++;
 370         }
 371
 372         /* locate desc for status */
 373         idx_status = i;
 374         n_descs++;
 375
 376         hdr = (void *)(uintptr_t)vring->desc[idx_hdr].addr;
 377         if (hdr->class == VIRTIO_NET_CTRL_MQ &&
 378             hdr->cmd == VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET) {
 379                 uint16_t queues;
 380
 381                 queues = *(uint16_t *)(uintptr_t)vring->desc[idx_data].addr;
 382                 status = virtio_user_handle_mq(dev, queues);
 383         }
 384
 385         /* Update status */
 386         *(virtio_net_ctrl_ack *)(uintptr_t)vring->desc[idx_status].addr = status;
 387
 388         return n_descs;
 389 }
 390
 391 void
 392 virtio_user_handle_cq(struct virtio_user_dev *dev, uint16_t queue_idx)
 393 {
 394         uint16_t avail_idx, desc_idx;
 395         struct vring_used_elem *uep;
 396         uint32_t n_descs;
 397         struct vring *vring = &dev->vrings[queue_idx];
 398
 399         /* Consume avail ring, using used ring idx as first one */
 400         while (vring->used->idx != vring->avail->idx) {
 401                 avail_idx = (vring->used->idx) & (vring->num - 1);
 402                 desc_idx = vring->avail->ring[avail_idx];
 403
 404                 n_descs = virtio_user_handle_ctrl_msg(dev, vring, desc_idx);
 405
 406                 /* Update used ring */
 407                 uep = &vring->used->ring[avail_idx];
 408                 uep->id = avail_idx;
 409                 uep->len = n_descs;
 410
 411                 vring->used->idx++;
 412         }
 413 }