drivers/net/virtio/virtio_user_ethdev.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 <sys/types.h>
  36 #include <unistd.h>
  37
  38 #include <rte_malloc.h>
  39 #include <rte_kvargs.h>
  40 #include <rte_vdev.h>
  41
  42 #include "virtio_ethdev.h"
  43 #include "virtio_logs.h"
  44 #include "virtio_pci.h"
  45 #include "virtqueue.h"
  46 #include "virtio_rxtx.h"
  47 #include "virtio_user/virtio_user_dev.h"
  48
  49 #define virtio_user_get_dev(hw) \
  50         ((struct virtio_user_dev *)(hw)->virtio_user_dev)
  51
  52 static void
  53 virtio_user_read_dev_config(struct virtio_hw *hw, size_t offset,
  54                      void *dst, int length)
  55 {
  56         int i;
  57         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
  58
  59         if (offset == offsetof(struct virtio_net_config, mac) &&
  60             length == ETHER_ADDR_LEN) {
  61                 for (i = 0; i < ETHER_ADDR_LEN; ++i)
  62                         ((uint8_t *)dst)[i] = dev->mac_addr[i];
  63                 return;
  64         }
  65
  66         if (offset == offsetof(struct virtio_net_config, status))
  67                 *(uint16_t *)dst = dev->status;
  68
  69         if (offset == offsetof(struct virtio_net_config, max_virtqueue_pairs))
  70                 *(uint16_t *)dst = dev->max_queue_pairs;
  71 }
  72
  73 static void
  74 virtio_user_write_dev_config(struct virtio_hw *hw, size_t offset,
  75                       const void *src, int length)
  76 {
  77         int i;
  78         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
  79
  80         if ((offset == offsetof(struct virtio_net_config, mac)) &&
  81             (length == ETHER_ADDR_LEN))
  82                 for (i = 0; i < ETHER_ADDR_LEN; ++i)
  83                         dev->mac_addr[i] = ((const uint8_t *)src)[i];
  84         else
  85                 PMD_DRV_LOG(ERR, "not supported offset=%zu, len=%d",
  86                             offset, length);
  87 }
  88
  89 static void
  90 virtio_user_reset(struct virtio_hw *hw)
  91 {
  92         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
  93
  94         if (dev->status & VIRTIO_CONFIG_STATUS_DRIVER_OK)
  95                 virtio_user_stop_device(dev);
  96 }
  97
  98 static void
  99 virtio_user_set_status(struct virtio_hw *hw, uint8_t status)
 100 {
 101         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
 102
 103         if (status & VIRTIO_CONFIG_STATUS_DRIVER_OK)
 104                 virtio_user_start_device(dev);
 105         else if (status == VIRTIO_CONFIG_STATUS_RESET)
 106                 virtio_user_reset(hw);
 107         dev->status = status;
 108 }
 109
 110 static uint8_t
 111 virtio_user_get_status(struct virtio_hw *hw)
 112 {
 113         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
 114
 115         return dev->status;
 116 }
 117
 118 static uint64_t
 119 virtio_user_get_features(struct virtio_hw *hw)
 120 {
 121         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
 122
 123         /* unmask feature bits defined in vhost user protocol */
 124         return dev->device_features & VIRTIO_PMD_SUPPORTED_GUEST_FEATURES;
 125 }
 126
 127 static void
 128 virtio_user_set_features(struct virtio_hw *hw, uint64_t features)
 129 {
 130         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
 131
 132         dev->features = features & dev->device_features;
 133 }
 134
 135 static uint8_t
 136 virtio_user_get_isr(struct virtio_hw *hw __rte_unused)
 137 {
 138         /* When config interrupt happens, driver calls this function to query
 139          * what kinds of change happen. Interrupt mode not supported for now.
 140          */
 141         return 0;
 142 }
 143
 144 static uint16_t
 145 virtio_user_set_config_irq(struct virtio_hw *hw __rte_unused,
 146                     uint16_t vec __rte_unused)
 147 {
 148         return VIRTIO_MSI_NO_VECTOR;
 149 }
 150
 151 /* This function is to get the queue size, aka, number of descs, of a specified
 152  * queue. Different with the VHOST_USER_GET_QUEUE_NUM, which is used to get the
 153  * max supported queues.
 154  */
 155 static uint16_t
 156 virtio_user_get_queue_num(struct virtio_hw *hw, uint16_t queue_id __rte_unused)
 157 {
 158         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
 159
 160         /* Currently, each queue has same queue size */
 161         return dev->queue_size;
 162 }
 163
 164 static int
 165 virtio_user_setup_queue(struct virtio_hw *hw, struct virtqueue *vq)
 166 {
 167         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
 168         uint16_t queue_idx = vq->vq_queue_index;
 169         uint64_t desc_addr, avail_addr, used_addr;
 170
 171         desc_addr = (uintptr_t)vq->vq_ring_virt_mem;
 172         avail_addr = desc_addr + vq->vq_nentries * sizeof(struct vring_desc);
 173         used_addr = RTE_ALIGN_CEIL(avail_addr + offsetof(struct vring_avail,
 174                                                          ring[vq->vq_nentries]),
 175                                    VIRTIO_PCI_VRING_ALIGN);
 176
 177         dev->vrings[queue_idx].num = vq->vq_nentries;
 178         dev->vrings[queue_idx].desc = (void *)(uintptr_t)desc_addr;
 179         dev->vrings[queue_idx].avail = (void *)(uintptr_t)avail_addr;
 180         dev->vrings[queue_idx].used = (void *)(uintptr_t)used_addr;
 181
 182         return 0;
 183 }
 184
 185 static void
 186 virtio_user_del_queue(struct virtio_hw *hw, struct virtqueue *vq)
 187 {
 188         /* For legacy devices, write 0 to VIRTIO_PCI_QUEUE_PFN port, QEMU
 189          * correspondingly stops the ioeventfds, and reset the status of
 190          * the device.
 191          * For modern devices, set queue desc, avail, used in PCI bar to 0,
 192          * not see any more behavior in QEMU.
 193          *
 194          * Here we just care about what information to deliver to vhost-user
 195          * or vhost-kernel. So we just close ioeventfd for now.
 196          */
 197         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
 198
 199         close(dev->callfds[vq->vq_queue_index]);
 200         close(dev->kickfds[vq->vq_queue_index]);
 201 }
 202
 203 static void
 204 virtio_user_notify_queue(struct virtio_hw *hw, struct virtqueue *vq)
 205 {
 206         uint64_t buf = 1;
 207         struct virtio_user_dev *dev = virtio_user_get_dev(hw);
 208
 209         if (hw->cvq && (hw->cvq->vq == vq)) {
 210                 virtio_user_handle_cq(dev, vq->vq_queue_index);
 211                 return;
 212         }
 213
 214         if (write(dev->kickfds[vq->vq_queue_index], &buf, sizeof(buf)) < 0)
 215                 PMD_DRV_LOG(ERR, "failed to kick backend: %s",
 216                             strerror(errno));
 217 }
 218
 219 const struct virtio_pci_ops virtio_user_ops = {
 220         .read_dev_cfg   = virtio_user_read_dev_config,
 221         .write_dev_cfg  = virtio_user_write_dev_config,
 222         .reset          = virtio_user_reset,
 223         .get_status     = virtio_user_get_status,
 224         .set_status     = virtio_user_set_status,
 225         .get_features   = virtio_user_get_features,
 226         .set_features   = virtio_user_set_features,
 227         .get_isr        = virtio_user_get_isr,
 228         .set_config_irq = virtio_user_set_config_irq,
 229         .get_queue_num  = virtio_user_get_queue_num,
 230         .setup_queue    = virtio_user_setup_queue,
 231         .del_queue      = virtio_user_del_queue,
 232         .notify_queue   = virtio_user_notify_queue,
 233 };
 234
 235 static const char *valid_args[] = {
 236 #define VIRTIO_USER_ARG_QUEUES_NUM     "queues"
 237         VIRTIO_USER_ARG_QUEUES_NUM,
 238 #define VIRTIO_USER_ARG_CQ_NUM         "cq"
 239         VIRTIO_USER_ARG_CQ_NUM,
 240 #define VIRTIO_USER_ARG_MAC            "mac"
 241         VIRTIO_USER_ARG_MAC,
 242 #define VIRTIO_USER_ARG_PATH           "path"
 243         VIRTIO_USER_ARG_PATH,
 244 #define VIRTIO_USER_ARG_QUEUE_SIZE     "queue_size"
 245         VIRTIO_USER_ARG_QUEUE_SIZE,
 246 #define VIRTIO_USER_ARG_INTERFACE_NAME "iface"
 247         VIRTIO_USER_ARG_INTERFACE_NAME,
 248         NULL
 249 };
 250
 251 #define VIRTIO_USER_DEF_CQ_EN   0
 252 #define VIRTIO_USER_DEF_Q_NUM   1
 253 #define VIRTIO_USER_DEF_Q_SZ    256
 254
 255 static int
 256 get_string_arg(const char *key __rte_unused,
 257                const char *value, void *extra_args)
 258 {
 259         if (!value || !extra_args)
 260                 return -EINVAL;
 261
 262         *(char **)extra_args = strdup(value);
 263
 264         if (!*(char **)extra_args)
 265                 return -ENOMEM;
 266
 267         return 0;
 268 }
 269
 270 static int
 271 get_integer_arg(const char *key __rte_unused,
 272                 const char *value, void *extra_args)
 273 {
 274         if (!value || !extra_args)
 275                 return -EINVAL;
 276
 277         *(uint64_t *)extra_args = strtoull(value, NULL, 0);
 278
 279         return 0;
 280 }
 281
 282 static struct rte_vdev_driver virtio_user_driver;
 283
 284 static struct rte_eth_dev *
 285 virtio_user_eth_dev_alloc(const char *name)
 286 {
 287         struct rte_eth_dev *eth_dev;
 288         struct rte_eth_dev_data *data;
 289         struct virtio_hw *hw;
 290         struct virtio_user_dev *dev;
 291
 292         eth_dev = rte_eth_dev_allocate(name);
 293         if (!eth_dev) {
 294                 PMD_INIT_LOG(ERR, "cannot alloc rte_eth_dev");
 295                 return NULL;
 296         }
 297
 298         data = eth_dev->data;
 299
 300         hw = rte_zmalloc(NULL, sizeof(*hw), 0);
 301         if (!hw) {
 302                 PMD_INIT_LOG(ERR, "malloc virtio_hw failed");
 303                 rte_eth_dev_release_port(eth_dev);
 304                 return NULL;
 305         }
 306
 307         dev = rte_zmalloc(NULL, sizeof(*dev), 0);
 308         if (!dev) {
 309                 PMD_INIT_LOG(ERR, "malloc virtio_user_dev failed");
 310                 rte_eth_dev_release_port(eth_dev);
 311                 rte_free(hw);
 312                 return NULL;
 313         }
 314
 315         hw->port_id = data->port_id;
 316         virtio_hw_internal[hw->port_id].vtpci_ops = &virtio_user_ops;
 317         hw->use_msix = 0;
 318         hw->modern   = 0;
 319         hw->use_simple_rxtx = 0;
 320         hw->virtio_user_dev = dev;
 321         data->dev_private = hw;
 322         data->drv_name = virtio_user_driver.driver.name;
 323         data->numa_node = SOCKET_ID_ANY;
 324         data->kdrv = RTE_KDRV_NONE;
 325         data->dev_flags = RTE_ETH_DEV_DETACHABLE;
 326         eth_dev->driver = NULL;
 327         return eth_dev;
 328 }
 329
 330 static void
 331 virtio_user_eth_dev_free(struct rte_eth_dev *eth_dev)
 332 {
 333         struct rte_eth_dev_data *data = eth_dev->data;
 334         struct virtio_hw *hw = data->dev_private;
 335
 336         rte_free(hw->virtio_user_dev);
 337         rte_free(hw);
 338         rte_eth_dev_release_port(eth_dev);
 339 }
 340
 341 /* Dev initialization routine. Invoked once for each virtio vdev at
 342  * EAL init time, see rte_eal_dev_init().
 343  * Returns 0 on success.
 344  */
 345 static int
 346 virtio_user_pmd_probe(const char *name, const char *params)
 347 {
 348         struct rte_kvargs *kvlist = NULL;
 349         struct rte_eth_dev *eth_dev;
 350         struct virtio_hw *hw;
 351         uint64_t queues = VIRTIO_USER_DEF_Q_NUM;
 352         uint64_t cq = VIRTIO_USER_DEF_CQ_EN;
 353         uint64_t queue_size = VIRTIO_USER_DEF_Q_SZ;
 354         char *path = NULL;
 355         char *ifname = NULL;
 356         char *mac_addr = NULL;
 357         int ret = -1;
 358
 359         if (!params || params[0] == '\0') {
 360                 PMD_INIT_LOG(ERR, "arg %s is mandatory for virtio_user",
 361                           VIRTIO_USER_ARG_QUEUE_SIZE);
 362                 goto end;
 363         }
 364
 365         kvlist = rte_kvargs_parse(params, valid_args);
 366         if (!kvlist) {
 367                 PMD_INIT_LOG(ERR, "error when parsing param");
 368                 goto end;
 369         }
 370
 371         if (rte_kvargs_count(kvlist, VIRTIO_USER_ARG_PATH) == 1) {
 372                 if (rte_kvargs_process(kvlist, VIRTIO_USER_ARG_PATH,
 373                                        &get_string_arg, &path) < 0) {
 374                         PMD_INIT_LOG(ERR, "error to parse %s",
 375                                      VIRTIO_USER_ARG_PATH);
 376                         goto end;
 377                 }
 378         } else {
 379                 PMD_INIT_LOG(ERR, "arg %s is mandatory for virtio_user",
 380                           VIRTIO_USER_ARG_QUEUE_SIZE);
 381                 goto end;
 382         }
 383
 384         if (rte_kvargs_count(kvlist, VIRTIO_USER_ARG_INTERFACE_NAME) == 1) {
 385                 if (is_vhost_user_by_type(path)) {
 386                         PMD_INIT_LOG(ERR,
 387                                 "arg %s applies only to vhost-kernel backend",
 388                                 VIRTIO_USER_ARG_INTERFACE_NAME);
 389                         goto end;
 390                 }
 391
 392                 if (rte_kvargs_process(kvlist, VIRTIO_USER_ARG_INTERFACE_NAME,
 393                                        &get_string_arg, &ifname) < 0) {
 394                         PMD_INIT_LOG(ERR, "error to parse %s",
 395                                      VIRTIO_USER_ARG_INTERFACE_NAME);
 396                         goto end;
 397                 }
 398         }
 399
 400         if (rte_kvargs_count(kvlist, VIRTIO_USER_ARG_MAC) == 1) {
 401                 if (rte_kvargs_process(kvlist, VIRTIO_USER_ARG_MAC,
 402                                        &get_string_arg, &mac_addr) < 0) {
 403                         PMD_INIT_LOG(ERR, "error to parse %s",
 404                                      VIRTIO_USER_ARG_MAC);
 405                         goto end;
 406                 }
 407         }
 408
 409         if (rte_kvargs_count(kvlist, VIRTIO_USER_ARG_QUEUE_SIZE) == 1) {
 410                 if (rte_kvargs_process(kvlist, VIRTIO_USER_ARG_QUEUE_SIZE,
 411                                        &get_integer_arg, &queue_size) < 0) {
 412                         PMD_INIT_LOG(ERR, "error to parse %s",
 413                                      VIRTIO_USER_ARG_QUEUE_SIZE);
 414                         goto end;
 415                 }
 416         }
 417
 418         if (rte_kvargs_count(kvlist, VIRTIO_USER_ARG_QUEUES_NUM) == 1) {
 419                 if (rte_kvargs_process(kvlist, VIRTIO_USER_ARG_QUEUES_NUM,
 420                                        &get_integer_arg, &queues) < 0) {
 421                         PMD_INIT_LOG(ERR, "error to parse %s",
 422                                      VIRTIO_USER_ARG_QUEUES_NUM);
 423                         goto end;
 424                 }
 425         }
 426
 427         if (rte_kvargs_count(kvlist, VIRTIO_USER_ARG_CQ_NUM) == 1) {
 428                 if (rte_kvargs_process(kvlist, VIRTIO_USER_ARG_CQ_NUM,
 429                                        &get_integer_arg, &cq) < 0) {
 430                         PMD_INIT_LOG(ERR, "error to parse %s",
 431                                      VIRTIO_USER_ARG_CQ_NUM);
 432                         goto end;
 433                 }
 434         } else if (queues > 1) {
 435                 cq = 1;
 436         }
 437
 438         if (queues > 1 && cq == 0) {
 439                 PMD_INIT_LOG(ERR, "multi-q requires ctrl-q");
 440                 goto end;
 441         }
 442
 443         if (queues > VIRTIO_MAX_VIRTQUEUE_PAIRS) {
 444                 PMD_INIT_LOG(ERR, "arg %s %" PRIu64 " exceeds the limit %u",
 445                         VIRTIO_USER_ARG_QUEUES_NUM, queues,
 446                         VIRTIO_MAX_VIRTQUEUE_PAIRS);
 447                 goto end;
 448         }
 449
 450         eth_dev = virtio_user_eth_dev_alloc(name);
 451         if (!eth_dev) {
 452                 PMD_INIT_LOG(ERR, "virtio_user fails to alloc device");
 453                 goto end;
 454         }
 455
 456         hw = eth_dev->data->dev_private;
 457         if (virtio_user_dev_init(hw->virtio_user_dev, path, queues, cq,
 458                                  queue_size, mac_addr, &ifname) < 0) {
 459                 PMD_INIT_LOG(ERR, "virtio_user_dev_init fails");
 460                 virtio_user_eth_dev_free(eth_dev);
 461                 goto end;
 462         }
 463
 464         /* previously called by rte_eal_pci_probe() for physical dev */
 465         if (eth_virtio_dev_init(eth_dev) < 0) {
 466                 PMD_INIT_LOG(ERR, "eth_virtio_dev_init fails");
 467                 virtio_user_eth_dev_free(eth_dev);
 468                 goto end;
 469         }
 470         ret = 0;
 471
 472 end:
 473         if (kvlist)
 474                 rte_kvargs_free(kvlist);
 475         if (path)
 476                 free(path);
 477         if (mac_addr)
 478                 free(mac_addr);
 479         if (ifname)
 480                 free(ifname);
 481         return ret;
 482 }
 483
 484 /** Called by rte_eth_dev_detach() */
 485 static int
 486 virtio_user_pmd_remove(const char *name)
 487 {
 488         struct rte_eth_dev *eth_dev;
 489         struct virtio_hw *hw;
 490         struct virtio_user_dev *dev;
 491
 492         if (!name)
 493                 return -EINVAL;
 494
 495         PMD_DRV_LOG(INFO, "Un-Initializing %s", name);
 496         eth_dev = rte_eth_dev_allocated(name);
 497         if (!eth_dev)
 498                 return -ENODEV;
 499
 500         /* make sure the device is stopped, queues freed */
 501         rte_eth_dev_close(eth_dev->data->port_id);
 502
 503         hw = eth_dev->data->dev_private;
 504         dev = hw->virtio_user_dev;
 505         virtio_user_dev_uninit(dev);
 506
 507         rte_free(eth_dev->data->dev_private);
 508         rte_free(eth_dev->data);
 509         rte_eth_dev_release_port(eth_dev);
 510
 511         return 0;
 512 }
 513
 514 static struct rte_vdev_driver virtio_user_driver = {
 515         .probe = virtio_user_pmd_probe,
 516         .remove = virtio_user_pmd_remove,
 517 };
 518
 519 RTE_PMD_REGISTER_VDEV(net_virtio_user, virtio_user_driver);
 520 RTE_PMD_REGISTER_ALIAS(net_virtio_user, virtio_user);
 521 RTE_PMD_REGISTER_PARAM_STRING(net_virtio_user,
 522         "path=<path> "
 523         "mac=<mac addr> "
 524         "cq=<int> "
 525         "queue_size=<int> "
 526         "queues=<int> "
 527         "iface=<string>");