drivers/net/softnic/rte_eth_softnic.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2017 Intel Corporation
   3  */
   4
   5 #include <stdint.h>
   6 #include <stdlib.h>
   7 #include <string.h>
   8
   9 #include <rte_ethdev_driver.h>
  10 #include <rte_ethdev_vdev.h>
  11 #include <rte_malloc.h>
  12 #include <rte_bus_vdev.h>
  13 #include <rte_kvargs.h>
  14 #include <rte_errno.h>
  15 #include <rte_ring.h>
  16 #include <rte_tm_driver.h>
  17
  18 #include "rte_eth_softnic.h"
  19 #include "rte_eth_softnic_internals.h"
  20
  21 #define PMD_PARAM_FIRMWARE                                 "firmware"
  22 #define PMD_PARAM_CPU_ID                                   "cpu_id"
  23
  24 static const char *pmd_valid_args[] = {
  25         PMD_PARAM_FIRMWARE,
  26         PMD_PARAM_CPU_ID,
  27         NULL
  28 };
  29
  30 static const struct rte_eth_dev_info pmd_dev_info = {
  31         .min_rx_bufsize = 0,
  32         .max_rx_pktlen = UINT32_MAX,
  33         .max_rx_queues = UINT16_MAX,
  34         .max_tx_queues = UINT16_MAX,
  35         .rx_desc_lim = {
  36                 .nb_max = UINT16_MAX,
  37                 .nb_min = 0,
  38                 .nb_align = 1,
  39         },
  40         .tx_desc_lim = {
  41                 .nb_max = UINT16_MAX,
  42                 .nb_min = 0,
  43                 .nb_align = 1,
  44         },
  45         .rx_offload_capa = DEV_RX_OFFLOAD_CRC_STRIP,
  46 };
  47
  48 static int pmd_softnic_logtype;
  49
  50 #define PMD_LOG(level, fmt, args...) \
  51         rte_log(RTE_LOG_ ## level, pmd_softnic_logtype, \
  52                 "%s(): " fmt "\n", __func__, ##args)
  53
  54 static void
  55 pmd_dev_infos_get(struct rte_eth_dev *dev __rte_unused,
  56         struct rte_eth_dev_info *dev_info)
  57 {
  58         memcpy(dev_info, &pmd_dev_info, sizeof(*dev_info));
  59 }
  60
  61 static int
  62 pmd_dev_configure(struct rte_eth_dev *dev __rte_unused)
  63 {
  64         return 0;
  65 }
  66
  67 static int
  68 pmd_rx_queue_setup(struct rte_eth_dev *dev,
  69         uint16_t rx_queue_id,
  70         uint16_t nb_rx_desc,
  71         unsigned int socket_id,
  72         const struct rte_eth_rxconf *rx_conf __rte_unused,
  73         struct rte_mempool *mb_pool __rte_unused)
  74 {
  75         uint32_t size = RTE_ETH_NAME_MAX_LEN + strlen("_rxq") + 4;
  76         char name[size];
  77         struct rte_ring *r;
  78
  79         snprintf(name, sizeof(name), "%s_rxq%04x",
  80                 dev->data->name,
  81                 rx_queue_id);
  82
  83         r = rte_ring_create(name,
  84                 nb_rx_desc,
  85                 socket_id,
  86                 RING_F_SP_ENQ | RING_F_SC_DEQ);
  87         if (r == NULL)
  88                 return -1;
  89
  90         dev->data->rx_queues[rx_queue_id] = r;
  91         return 0;
  92 }
  93
  94 static int
  95 pmd_tx_queue_setup(struct rte_eth_dev *dev,
  96         uint16_t tx_queue_id,
  97         uint16_t nb_tx_desc,
  98         unsigned int socket_id,
  99         const struct rte_eth_txconf *tx_conf __rte_unused)
 100 {
 101         uint32_t size = RTE_ETH_NAME_MAX_LEN + strlen("_txq") + 4;
 102         char name[size];
 103         struct rte_ring *r;
 104
 105         snprintf(name, sizeof(name), "%s_txq%04x",
 106                 dev->data->name,
 107                 tx_queue_id);
 108
 109         r = rte_ring_create(name,
 110                 nb_tx_desc,
 111                 socket_id,
 112                 RING_F_SP_ENQ | RING_F_SC_DEQ);
 113         if (r == NULL)
 114                 return -1;
 115
 116         dev->data->tx_queues[tx_queue_id] = r;
 117         return 0;
 118 }
 119
 120 static int
 121 pmd_dev_start(struct rte_eth_dev *dev)
 122 {
 123         dev->data->dev_link.link_status = ETH_LINK_UP;
 124
 125         return 0;
 126 }
 127
 128 static void
 129 pmd_dev_stop(struct rte_eth_dev *dev)
 130 {
 131         dev->data->dev_link.link_status = ETH_LINK_DOWN;
 132 }
 133
 134 static void
 135 pmd_dev_close(struct rte_eth_dev *dev)
 136 {
 137         uint32_t i;
 138
 139         /* RX queues */
 140         for (i = 0; i < dev->data->nb_rx_queues; i++)
 141                 rte_ring_free((struct rte_ring *)dev->data->rx_queues[i]);
 142
 143         /* TX queues */
 144         for (i = 0; i < dev->data->nb_tx_queues; i++)
 145                 rte_ring_free((struct rte_ring *)dev->data->tx_queues[i]);
 146 }
 147
 148 static int
 149 pmd_link_update(struct rte_eth_dev *dev __rte_unused,
 150         int wait_to_complete __rte_unused)
 151 {
 152         return 0;
 153 }
 154
 155 static int
 156 pmd_tm_ops_get(struct rte_eth_dev *dev __rte_unused, void *arg)
 157 {
 158         *(const struct rte_tm_ops **)arg = NULL;
 159
 160         return 0;
 161 }
 162
 163 static const struct eth_dev_ops pmd_ops = {
 164         .dev_configure = pmd_dev_configure,
 165         .dev_start = pmd_dev_start,
 166         .dev_stop = pmd_dev_stop,
 167         .dev_close = pmd_dev_close,
 168         .link_update = pmd_link_update,
 169         .dev_infos_get = pmd_dev_infos_get,
 170         .rx_queue_setup = pmd_rx_queue_setup,
 171         .tx_queue_setup = pmd_tx_queue_setup,
 172         .tm_ops_get = pmd_tm_ops_get,
 173 };
 174
 175 static uint16_t
 176 pmd_rx_pkt_burst(void *rxq,
 177         struct rte_mbuf **rx_pkts,
 178         uint16_t nb_pkts)
 179 {
 180         return (uint16_t)rte_ring_sc_dequeue_burst(rxq,
 181                 (void **)rx_pkts,
 182                 nb_pkts,
 183                 NULL);
 184 }
 185
 186 static uint16_t
 187 pmd_tx_pkt_burst(void *txq,
 188         struct rte_mbuf **tx_pkts,
 189         uint16_t nb_pkts)
 190 {
 191         return (uint16_t)rte_ring_sp_enqueue_burst(txq,
 192                 (void **)tx_pkts,
 193                 nb_pkts,
 194                 NULL);
 195 }
 196
 197 int
 198 rte_pmd_softnic_run(uint16_t port_id __rte_unused)
 199 {
 200         return 0;
 201 }
 202
 203 static void *
 204 pmd_init(struct pmd_params *params)
 205 {
 206         struct pmd_internals *p;
 207
 208         p = rte_zmalloc_socket(params->name,
 209                 sizeof(struct pmd_internals),
 210                 0,
 211                 params->cpu_id);
 212         if (p == NULL)
 213                 return NULL;
 214
 215         /* Params */
 216         memcpy(&p->params, params, sizeof(p->params));
 217
 218         /* Resources */
 219         softnic_mempool_init(p);
 220         softnic_swq_init(p);
 221         softnic_link_init(p);
 222         softnic_tap_init(p);
 223
 224         return p;
 225 }
 226
 227 static void
 228 pmd_free(struct pmd_internals *p)
 229 {
 230         if (p == NULL)
 231                 return;
 232
 233         softnic_tap_free(p);
 234         softnic_link_free(p);
 235         softnic_swq_free(p);
 236         softnic_mempool_free(p);
 237
 238         rte_free(p);
 239 }
 240
 241 static struct ether_addr eth_addr = {
 242         .addr_bytes = {0},
 243 };
 244
 245 static int
 246 pmd_ethdev_register(struct rte_vdev_device *vdev,
 247         struct pmd_params *params,
 248         void *dev_private)
 249 {
 250         struct rte_eth_dev *dev;
 251
 252         /* Ethdev entry allocation */
 253         dev = rte_eth_dev_allocate(params->name);
 254         if (!dev)
 255                 return -ENOMEM;
 256
 257         /* dev */
 258         dev->rx_pkt_burst = pmd_rx_pkt_burst;
 259         dev->tx_pkt_burst = pmd_tx_pkt_burst;
 260         dev->tx_pkt_prepare = NULL;
 261         dev->dev_ops = &pmd_ops;
 262         dev->device = &vdev->device;
 263
 264         /* dev->data */
 265         dev->data->dev_private = dev_private;
 266         dev->data->dev_link.link_speed = ETH_SPEED_NUM_100G;
 267         dev->data->dev_link.link_duplex = ETH_LINK_FULL_DUPLEX;
 268         dev->data->dev_link.link_autoneg = ETH_LINK_FIXED;
 269         dev->data->dev_link.link_status = ETH_LINK_DOWN;
 270         dev->data->mac_addrs = &eth_addr;
 271         dev->data->promiscuous = 1;
 272         dev->data->kdrv = RTE_KDRV_NONE;
 273         dev->data->numa_node = params->cpu_id;
 274
 275         rte_eth_dev_probing_finish(dev);
 276
 277         return 0;
 278 }
 279
 280 static int
 281 get_string(const char *key __rte_unused, const char *value, void *extra_args)
 282 {
 283         if (!value || !extra_args)
 284                 return -EINVAL;
 285
 286         *(char **)extra_args = strdup(value);
 287
 288         if (!*(char **)extra_args)
 289                 return -ENOMEM;
 290
 291         return 0;
 292 }
 293
 294 static int
 295 get_uint32(const char *key __rte_unused, const char *value, void *extra_args)
 296 {
 297         if (!value || !extra_args)
 298                 return -EINVAL;
 299
 300         *(uint32_t *)extra_args = strtoull(value, NULL, 0);
 301
 302         return 0;
 303 }
 304
 305 static int
 306 pmd_parse_args(struct pmd_params *p, const char *params)
 307 {
 308         struct rte_kvargs *kvlist;
 309         int ret = 0;
 310
 311         kvlist = rte_kvargs_parse(params, pmd_valid_args);
 312         if (kvlist == NULL)
 313                 return -EINVAL;
 314
 315         /* Set default values */
 316         memset(p, 0, sizeof(*p));
 317         p->firmware = SOFTNIC_FIRMWARE;
 318         p->cpu_id = SOFTNIC_CPU_ID;
 319
 320         /* Firmware script (optional) */
 321         if (rte_kvargs_count(kvlist, PMD_PARAM_FIRMWARE) == 1) {
 322                 ret = rte_kvargs_process(kvlist, PMD_PARAM_FIRMWARE,
 323                         &get_string, &p->firmware);
 324                 if (ret < 0)
 325                         goto out_free;
 326         }
 327
 328         /* CPU ID (optional) */
 329         if (rte_kvargs_count(kvlist, PMD_PARAM_CPU_ID) == 1) {
 330                 ret = rte_kvargs_process(kvlist, PMD_PARAM_CPU_ID,
 331                         &get_uint32, &p->cpu_id);
 332                 if (ret < 0)
 333                         goto out_free;
 334         }
 335
 336 out_free:
 337         rte_kvargs_free(kvlist);
 338         return ret;
 339 }
 340
 341 static int
 342 pmd_probe(struct rte_vdev_device *vdev)
 343 {
 344         struct pmd_params p;
 345         const char *params;
 346         int status = 0;
 347
 348         void *dev_private;
 349         const char *name = rte_vdev_device_name(vdev);
 350
 351         PMD_LOG(INFO, "Probing device \"%s\"", name);
 352
 353         /* Parse input arguments */
 354         params = rte_vdev_device_args(vdev);
 355         if (!params)
 356                 return -EINVAL;
 357
 358         status = pmd_parse_args(&p, params);
 359         if (status)
 360                 return status;
 361
 362         p.name = name;
 363
 364         /* Allocate and initialize soft ethdev private data */
 365         dev_private = pmd_init(&p);
 366         if (dev_private == NULL)
 367                 return -ENOMEM;
 368
 369         /* Register soft ethdev */
 370         PMD_LOG(INFO, "Creating soft ethdev \"%s\"", p.name);
 371
 372         status = pmd_ethdev_register(vdev, &p, dev_private);
 373         if (status) {
 374                 pmd_free(dev_private);
 375                 return status;
 376         }
 377
 378         return 0;
 379 }
 380
 381 static int
 382 pmd_remove(struct rte_vdev_device *vdev)
 383 {
 384         struct rte_eth_dev *dev = NULL;
 385         struct pmd_internals *p;
 386
 387         if (!vdev)
 388                 return -EINVAL;
 389
 390         PMD_LOG(INFO, "Removing device \"%s\"", rte_vdev_device_name(vdev));
 391
 392         /* Find the ethdev entry */
 393         dev = rte_eth_dev_allocated(rte_vdev_device_name(vdev));
 394         if (dev == NULL)
 395                 return -ENODEV;
 396         p = dev->data->dev_private;
 397
 398         /* Free device data structures*/
 399         rte_free(dev->data);
 400         rte_eth_dev_release_port(dev);
 401         pmd_free(p);
 402
 403         return 0;
 404 }
 405
 406 static struct rte_vdev_driver pmd_softnic_drv = {
 407         .probe = pmd_probe,
 408         .remove = pmd_remove,
 409 };
 410
 411 RTE_PMD_REGISTER_VDEV(net_softnic, pmd_softnic_drv);
 412 RTE_PMD_REGISTER_PARAM_STRING(net_softnic,
 413         PMD_PARAM_FIRMWARE "=<string> "
 414         PMD_PARAM_CPU_ID "=<uint32>");
 415
 416 RTE_INIT(pmd_softnic_init_log)
 417 {
 418         pmd_softnic_logtype = rte_log_register("pmd.net.softnic");
 419         if (pmd_softnic_logtype >= 0)
 420                 rte_log_set_level(pmd_softnic_logtype, RTE_LOG_NOTICE);
 421 }