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