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