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