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