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