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