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 #include <rte_mtr_driver.h>
  18
  19 #include "rte_eth_softnic.h"
  20 #include "rte_eth_softnic_internals.h"
  21
  22 #define PMD_PARAM_FIRMWARE                                 "firmware"
  23 #define PMD_PARAM_CONN_PORT                                "conn_port"
  24 #define PMD_PARAM_CPU_ID                                   "cpu_id"
  25 #define PMD_PARAM_TM_N_QUEUES                              "tm_n_queues"
  26 #define PMD_PARAM_TM_QSIZE0                                "tm_qsize0"
  27 #define PMD_PARAM_TM_QSIZE1                                "tm_qsize1"
  28 #define PMD_PARAM_TM_QSIZE2                                "tm_qsize2"
  29 #define PMD_PARAM_TM_QSIZE3                                "tm_qsize3"
  30
  31 static const char * const pmd_valid_args[] = {
  32         PMD_PARAM_FIRMWARE,
  33         PMD_PARAM_CONN_PORT,
  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 char welcome[] =
  44         "\n"
  45         "Welcome to Soft NIC!\n"
  46         "\n";
  47
  48 static const char prompt[] = "softnic> ";
  49
  50 static const struct softnic_conn_params conn_params_default = {
  51         .welcome = welcome,
  52         .prompt = prompt,
  53         .addr = "0.0.0.0",
  54         .port = 0,
  55         .buf_size = 1024 * 1024,
  56         .msg_in_len_max = 1024,
  57         .msg_out_len_max = 1024 * 1024,
  58         .msg_handle = softnic_cli_process,
  59         .msg_handle_arg = NULL,
  60 };
  61
  62 static const struct rte_eth_dev_info pmd_dev_info = {
  63         .min_rx_bufsize = 0,
  64         .max_rx_pktlen = UINT32_MAX,
  65         .max_rx_queues = UINT16_MAX,
  66         .max_tx_queues = UINT16_MAX,
  67         .rx_desc_lim = {
  68                 .nb_max = UINT16_MAX,
  69                 .nb_min = 0,
  70                 .nb_align = 1,
  71         },
  72         .tx_desc_lim = {
  73                 .nb_max = UINT16_MAX,
  74                 .nb_min = 0,
  75                 .nb_align = 1,
  76         },
  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         struct pmd_internals *p = dev->data->dev_private;
 157         int status;
 158
 159         /* Firmware */
 160         status = softnic_cli_script_process(p,
 161                 p->params.firmware,
 162                 conn_params_default.msg_in_len_max,
 163                 conn_params_default.msg_out_len_max);
 164         if (status)
 165                 return status;
 166
 167         /* Link UP */
 168         dev->data->dev_link.link_status = ETH_LINK_UP;
 169
 170         return 0;
 171 }
 172
 173 static void
 174 pmd_dev_stop(struct rte_eth_dev *dev)
 175 {
 176         struct pmd_internals *p = dev->data->dev_private;
 177
 178         /* Link DOWN */
 179         dev->data->dev_link.link_status = ETH_LINK_DOWN;
 180
 181         /* Firmware */
 182         softnic_pipeline_disable_all(p);
 183         softnic_pipeline_free(p);
 184         softnic_table_action_profile_free(p);
 185         softnic_port_in_action_profile_free(p);
 186         softnic_tap_free(p);
 187         softnic_tmgr_free(p);
 188         softnic_link_free(p);
 189         softnic_softnic_swq_free_keep_rxq_txq(p);
 190         softnic_mempool_free(p);
 191
 192         tm_hierarchy_free(p);
 193         softnic_mtr_free(p);
 194 }
 195
 196 static void
 197 pmd_dev_close(struct rte_eth_dev *dev __rte_unused)
 198 {
 199         return;
 200 }
 201
 202 static int
 203 pmd_link_update(struct rte_eth_dev *dev __rte_unused,
 204         int wait_to_complete __rte_unused)
 205 {
 206         return 0;
 207 }
 208
 209 static int
 210 pmd_filter_ctrl(struct rte_eth_dev *dev __rte_unused,
 211                 enum rte_filter_type filter_type,
 212                 enum rte_filter_op filter_op,
 213                 void *arg)
 214 {
 215         if (filter_type == RTE_ETH_FILTER_GENERIC &&
 216                         filter_op == RTE_ETH_FILTER_GET) {
 217                 *(const void **)arg = &pmd_flow_ops;
 218                 return 0;
 219         }
 220
 221         return -ENOTSUP;
 222 }
 223
 224 static int
 225 pmd_tm_ops_get(struct rte_eth_dev *dev __rte_unused, void *arg)
 226 {
 227         *(const struct rte_tm_ops **)arg = &pmd_tm_ops;
 228
 229         return 0;
 230 }
 231
 232 static int
 233 pmd_mtr_ops_get(struct rte_eth_dev *dev __rte_unused, void *arg)
 234 {
 235         *(const struct rte_mtr_ops **)arg = &pmd_mtr_ops;
 236
 237         return 0;
 238 }
 239
 240 static const struct eth_dev_ops pmd_ops = {
 241         .dev_configure = pmd_dev_configure,
 242         .dev_start = pmd_dev_start,
 243         .dev_stop = pmd_dev_stop,
 244         .dev_close = pmd_dev_close,
 245         .link_update = pmd_link_update,
 246         .dev_infos_get = pmd_dev_infos_get,
 247         .rx_queue_setup = pmd_rx_queue_setup,
 248         .tx_queue_setup = pmd_tx_queue_setup,
 249         .filter_ctrl = pmd_filter_ctrl,
 250         .tm_ops_get = pmd_tm_ops_get,
 251         .mtr_ops_get = pmd_mtr_ops_get,
 252 };
 253
 254 static uint16_t
 255 pmd_rx_pkt_burst(void *rxq,
 256         struct rte_mbuf **rx_pkts,
 257         uint16_t nb_pkts)
 258 {
 259         return (uint16_t)rte_ring_sc_dequeue_burst(rxq,
 260                 (void **)rx_pkts,
 261                 nb_pkts,
 262                 NULL);
 263 }
 264
 265 static uint16_t
 266 pmd_tx_pkt_burst(void *txq,
 267         struct rte_mbuf **tx_pkts,
 268         uint16_t nb_pkts)
 269 {
 270         return (uint16_t)rte_ring_sp_enqueue_burst(txq,
 271                 (void **)tx_pkts,
 272                 nb_pkts,
 273                 NULL);
 274 }
 275
 276 static void *
 277 pmd_init(struct pmd_params *params)
 278 {
 279         struct pmd_internals *p;
 280         int status;
 281
 282         p = rte_zmalloc_socket(params->name,
 283                 sizeof(struct pmd_internals),
 284                 0,
 285                 params->cpu_id);
 286         if (p == NULL)
 287                 return NULL;
 288
 289         /* Params */
 290         memcpy(&p->params, params, sizeof(p->params));
 291
 292         /* Resources */
 293         tm_hierarchy_init(p);
 294         softnic_mtr_init(p);
 295
 296         softnic_mempool_init(p);
 297         softnic_swq_init(p);
 298         softnic_link_init(p);
 299         softnic_tmgr_init(p);
 300         softnic_tap_init(p);
 301         softnic_cryptodev_init(p);
 302         softnic_port_in_action_profile_init(p);
 303         softnic_table_action_profile_init(p);
 304         softnic_pipeline_init(p);
 305
 306         status = softnic_thread_init(p);
 307         if (status) {
 308                 rte_free(p);
 309                 return NULL;
 310         }
 311
 312         if (params->conn_port) {
 313                 struct softnic_conn_params conn_params;
 314
 315                 memcpy(&conn_params, &conn_params_default, sizeof(conn_params));
 316                 conn_params.port = p->params.conn_port;
 317                 conn_params.msg_handle_arg = p;
 318
 319                 p->conn = softnic_conn_init(&conn_params);
 320                 if (p->conn == NULL) {
 321                         softnic_thread_free(p);
 322                         rte_free(p);
 323                         return NULL;
 324                 }
 325         }
 326
 327         return p;
 328 }
 329
 330 static void
 331 pmd_free(struct pmd_internals *p)
 332 {
 333         if (p == NULL)
 334                 return;
 335
 336         if (p->params.conn_port)
 337                 softnic_conn_free(p->conn);
 338
 339         softnic_thread_free(p);
 340         softnic_pipeline_free(p);
 341         softnic_table_action_profile_free(p);
 342         softnic_port_in_action_profile_free(p);
 343         softnic_tap_free(p);
 344         softnic_tmgr_free(p);
 345         softnic_link_free(p);
 346         softnic_swq_free(p);
 347         softnic_mempool_free(p);
 348
 349         tm_hierarchy_free(p);
 350         softnic_mtr_free(p);
 351
 352         rte_free(p);
 353 }
 354
 355 static struct ether_addr eth_addr = {
 356         .addr_bytes = {0},
 357 };
 358
 359 static int
 360 pmd_ethdev_register(struct rte_vdev_device *vdev,
 361         struct pmd_params *params,
 362         void *dev_private)
 363 {
 364         struct rte_eth_dev *dev;
 365
 366         /* Ethdev entry allocation */
 367         dev = rte_eth_dev_allocate(params->name);
 368         if (!dev)
 369                 return -ENOMEM;
 370
 371         /* dev */
 372         dev->rx_pkt_burst = pmd_rx_pkt_burst;
 373         dev->tx_pkt_burst = pmd_tx_pkt_burst;
 374         dev->tx_pkt_prepare = NULL;
 375         dev->dev_ops = &pmd_ops;
 376         dev->device = &vdev->device;
 377
 378         /* dev->data */
 379         dev->data->dev_private = dev_private;
 380         dev->data->dev_link.link_speed = ETH_SPEED_NUM_100G;
 381         dev->data->dev_link.link_duplex = ETH_LINK_FULL_DUPLEX;
 382         dev->data->dev_link.link_autoneg = ETH_LINK_FIXED;
 383         dev->data->dev_link.link_status = ETH_LINK_DOWN;
 384         dev->data->mac_addrs = &eth_addr;
 385         dev->data->promiscuous = 1;
 386         dev->data->kdrv = RTE_KDRV_NONE;
 387         dev->data->numa_node = params->cpu_id;
 388
 389         rte_eth_dev_probing_finish(dev);
 390
 391         return 0;
 392 }
 393
 394 static int
 395 get_string(const char *key __rte_unused, const char *value, void *extra_args)
 396 {
 397         if (!value || !extra_args)
 398                 return -EINVAL;
 399
 400         *(char **)extra_args = strdup(value);
 401
 402         if (!*(char **)extra_args)
 403                 return -ENOMEM;
 404
 405         return 0;
 406 }
 407
 408 static int
 409 get_uint32(const char *key __rte_unused, const char *value, void *extra_args)
 410 {
 411         if (!value || !extra_args)
 412                 return -EINVAL;
 413
 414         *(uint32_t *)extra_args = strtoull(value, NULL, 0);
 415
 416         return 0;
 417 }
 418
 419 static int
 420 get_uint16(const char *key __rte_unused, const char *value, void *extra_args)
 421 {
 422         if (!value || !extra_args)
 423                 return -EINVAL;
 424
 425         *(uint16_t *)extra_args = strtoull(value, NULL, 0);
 426
 427         return 0;
 428 }
 429
 430 static int
 431 pmd_parse_args(struct pmd_params *p, const char *params)
 432 {
 433         struct rte_kvargs *kvlist;
 434         int ret = 0;
 435
 436         kvlist = rte_kvargs_parse(params, pmd_valid_args);
 437         if (kvlist == NULL)
 438                 return -EINVAL;
 439
 440         /* Set default values */
 441         memset(p, 0, sizeof(*p));
 442         p->firmware = SOFTNIC_FIRMWARE;
 443         p->cpu_id = SOFTNIC_CPU_ID;
 444         p->tm.n_queues = SOFTNIC_TM_N_QUEUES;
 445         p->tm.qsize[0] = SOFTNIC_TM_QUEUE_SIZE;
 446         p->tm.qsize[1] = SOFTNIC_TM_QUEUE_SIZE;
 447         p->tm.qsize[2] = SOFTNIC_TM_QUEUE_SIZE;
 448         p->tm.qsize[3] = SOFTNIC_TM_QUEUE_SIZE;
 449
 450         /* Firmware script (optional) */
 451         if (rte_kvargs_count(kvlist, PMD_PARAM_FIRMWARE) == 1) {
 452                 ret = rte_kvargs_process(kvlist, PMD_PARAM_FIRMWARE,
 453                         &get_string, &p->firmware);
 454                 if (ret < 0)
 455                         goto out_free;
 456         }
 457
 458         /* Connection listening port (optional) */
 459         if (rte_kvargs_count(kvlist, PMD_PARAM_CONN_PORT) == 1) {
 460                 ret = rte_kvargs_process(kvlist, PMD_PARAM_CONN_PORT,
 461                         &get_uint16, &p->conn_port);
 462                 if (ret < 0)
 463                         goto out_free;
 464         }
 465
 466         /* CPU ID (optional) */
 467         if (rte_kvargs_count(kvlist, PMD_PARAM_CPU_ID) == 1) {
 468                 ret = rte_kvargs_process(kvlist, PMD_PARAM_CPU_ID,
 469                         &get_uint32, &p->cpu_id);
 470                 if (ret < 0)
 471                         goto out_free;
 472         }
 473
 474         /* TM number of queues (optional) */
 475         if (rte_kvargs_count(kvlist, PMD_PARAM_TM_N_QUEUES) == 1) {
 476                 ret = rte_kvargs_process(kvlist, PMD_PARAM_TM_N_QUEUES,
 477                         &get_uint32, &p->tm.n_queues);
 478                 if (ret < 0)
 479                         goto out_free;
 480         }
 481
 482         /* TM queue size 0 .. 3 (optional) */
 483         if (rte_kvargs_count(kvlist, PMD_PARAM_TM_QSIZE0) == 1) {
 484                 ret = rte_kvargs_process(kvlist, PMD_PARAM_TM_QSIZE0,
 485                         &get_uint32, &p->tm.qsize[0]);
 486                 if (ret < 0)
 487                         goto out_free;
 488         }
 489
 490         if (rte_kvargs_count(kvlist, PMD_PARAM_TM_QSIZE1) == 1) {
 491                 ret = rte_kvargs_process(kvlist, PMD_PARAM_TM_QSIZE1,
 492                         &get_uint32, &p->tm.qsize[1]);
 493                 if (ret < 0)
 494                         goto out_free;
 495         }
 496
 497         if (rte_kvargs_count(kvlist, PMD_PARAM_TM_QSIZE2) == 1) {
 498                 ret = rte_kvargs_process(kvlist, PMD_PARAM_TM_QSIZE2,
 499                         &get_uint32, &p->tm.qsize[2]);
 500                 if (ret < 0)
 501                         goto out_free;
 502         }
 503
 504         if (rte_kvargs_count(kvlist, PMD_PARAM_TM_QSIZE3) == 1) {
 505                 ret = rte_kvargs_process(kvlist, PMD_PARAM_TM_QSIZE3,
 506                         &get_uint32, &p->tm.qsize[3]);
 507                 if (ret < 0)
 508                         goto out_free;
 509         }
 510
 511 out_free:
 512         rte_kvargs_free(kvlist);
 513         return ret;
 514 }
 515
 516 static int
 517 pmd_probe(struct rte_vdev_device *vdev)
 518 {
 519         struct pmd_params p;
 520         const char *params;
 521         int status = 0;
 522
 523         void *dev_private;
 524         const char *name = rte_vdev_device_name(vdev);
 525
 526         PMD_LOG(INFO, "Probing device \"%s\"", name);
 527
 528         /* Parse input arguments */
 529         params = rte_vdev_device_args(vdev);
 530         if (!params)
 531                 return -EINVAL;
 532
 533         status = pmd_parse_args(&p, params);
 534         if (status)
 535                 return status;
 536
 537         p.name = name;
 538
 539         /* Allocate and initialize soft ethdev private data */
 540         dev_private = pmd_init(&p);
 541         if (dev_private == NULL)
 542                 return -ENOMEM;
 543
 544         /* Register soft ethdev */
 545         PMD_LOG(INFO, "Creating soft ethdev \"%s\"", p.name);
 546
 547         status = pmd_ethdev_register(vdev, &p, dev_private);
 548         if (status) {
 549                 pmd_free(dev_private);
 550                 return status;
 551         }
 552
 553         return 0;
 554 }
 555
 556 static int
 557 pmd_remove(struct rte_vdev_device *vdev)
 558 {
 559         struct rte_eth_dev *dev = NULL;
 560
 561         if (!vdev)
 562                 return -EINVAL;
 563
 564         PMD_LOG(INFO, "Removing device \"%s\"", rte_vdev_device_name(vdev));
 565
 566         /* Find the ethdev entry */
 567         dev = rte_eth_dev_allocated(rte_vdev_device_name(vdev));
 568         if (dev == NULL)
 569                 return -ENODEV;
 570
 571         /* Free device data structures*/
 572         pmd_free(dev->data->dev_private);
 573         dev->data->dev_private = NULL; /* already freed */
 574         dev->data->mac_addrs = NULL; /* statically allocated */
 575         rte_eth_dev_release_port(dev);
 576
 577         return 0;
 578 }
 579
 580 static struct rte_vdev_driver pmd_softnic_drv = {
 581         .probe = pmd_probe,
 582         .remove = pmd_remove,
 583 };
 584
 585 RTE_PMD_REGISTER_VDEV(net_softnic, pmd_softnic_drv);
 586 RTE_PMD_REGISTER_PARAM_STRING(net_softnic,
 587         PMD_PARAM_FIRMWARE "=<string> "
 588         PMD_PARAM_CONN_PORT "=<uint16> "
 589         PMD_PARAM_CPU_ID "=<uint32> "
 590         PMD_PARAM_TM_N_QUEUES "=<uint32> "
 591         PMD_PARAM_TM_QSIZE0 "=<uint32> "
 592         PMD_PARAM_TM_QSIZE1 "=<uint32> "
 593         PMD_PARAM_TM_QSIZE2 "=<uint32> "
 594         PMD_PARAM_TM_QSIZE3 "=<uint32>"
 595 );
 596
 597
 598 RTE_INIT(pmd_softnic_init_log)
 599 {
 600         pmd_softnic_logtype = rte_log_register("pmd.net.softnic");
 601         if (pmd_softnic_logtype >= 0)
 602                 rte_log_set_level(pmd_softnic_logtype, RTE_LOG_NOTICE);
 603 }
 604
 605 int
 606 rte_pmd_softnic_manage(uint16_t port_id)
 607 {
 608         struct rte_eth_dev *dev = &rte_eth_devices[port_id];
 609         struct pmd_internals *softnic;
 610
 611 #ifdef RTE_LIBRTE_ETHDEV_DEBUG
 612         RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
 613 #endif
 614
 615         softnic = dev->data->dev_private;
 616
 617         softnic_conn_poll_for_conn(softnic->conn);
 618
 619         softnic_conn_poll_for_msg(softnic->conn);
 620
 621         return 0;
 622 }