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