drivers/net/kni/rte_eth_kni.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2017 Intel Corporation
   3  */
   4
   5 #include <fcntl.h>
   6 #include <pthread.h>
   7 #include <unistd.h>
   8
   9 #include <rte_string_fns.h>
  10 #include <rte_ethdev_driver.h>
  11 #include <rte_ethdev_vdev.h>
  12 #include <rte_kni.h>
  13 #include <rte_kvargs.h>
  14 #include <rte_malloc.h>
  15 #include <rte_bus_vdev.h>
  16
  17 /* Only single queue supported */
  18 #define KNI_MAX_QUEUE_PER_PORT 1
  19
  20 #define MAX_KNI_PORTS 8
  21
  22 #define KNI_ETHER_MTU(mbuf_size)       \
  23         ((mbuf_size) - RTE_ETHER_HDR_LEN) /**< Ethernet MTU. */
  24
  25 #define ETH_KNI_NO_REQUEST_THREAD_ARG   "no_request_thread"
  26 static const char * const valid_arguments[] = {
  27         ETH_KNI_NO_REQUEST_THREAD_ARG,
  28         NULL
  29 };
  30
  31 struct eth_kni_args {
  32         int no_request_thread;
  33 };
  34
  35 struct pmd_queue_stats {
  36         uint64_t pkts;
  37         uint64_t bytes;
  38 };
  39
  40 struct pmd_queue {
  41         struct pmd_internals *internals;
  42         struct rte_mempool *mb_pool;
  43
  44         struct pmd_queue_stats rx;
  45         struct pmd_queue_stats tx;
  46 };
  47
  48 struct pmd_internals {
  49         struct rte_kni *kni;
  50         uint16_t port_id;
  51         int is_kni_started;
  52
  53         pthread_t thread;
  54         int stop_thread;
  55         int no_request_thread;
  56
  57         struct rte_ether_addr eth_addr;
  58
  59         struct pmd_queue rx_queues[KNI_MAX_QUEUE_PER_PORT];
  60         struct pmd_queue tx_queues[KNI_MAX_QUEUE_PER_PORT];
  61 };
  62
  63 static const struct rte_eth_link pmd_link = {
  64                 .link_speed = ETH_SPEED_NUM_10G,
  65                 .link_duplex = ETH_LINK_FULL_DUPLEX,
  66                 .link_status = ETH_LINK_DOWN,
  67                 .link_autoneg = ETH_LINK_FIXED,
  68 };
  69 static int is_kni_initialized;
  70
  71 RTE_LOG_REGISTER(eth_kni_logtype, pmd.net.kni, NOTICE);
  72
  73 #define PMD_LOG(level, fmt, args...) \
  74         rte_log(RTE_LOG_ ## level, eth_kni_logtype, \
  75                 "%s(): " fmt "\n", __func__, ##args)
  76 static uint16_t
  77 eth_kni_rx(void *q, struct rte_mbuf **bufs, uint16_t nb_bufs)
  78 {
  79         struct pmd_queue *kni_q = q;
  80         struct rte_kni *kni = kni_q->internals->kni;
  81         uint16_t nb_pkts;
  82         int i;
  83
  84         nb_pkts = rte_kni_rx_burst(kni, bufs, nb_bufs);
  85         for (i = 0; i < nb_pkts; i++)
  86                 bufs[i]->port = kni_q->internals->port_id;
  87
  88         kni_q->rx.pkts += nb_pkts;
  89
  90         return nb_pkts;
  91 }
  92
  93 static uint16_t
  94 eth_kni_tx(void *q, struct rte_mbuf **bufs, uint16_t nb_bufs)
  95 {
  96         struct pmd_queue *kni_q = q;
  97         struct rte_kni *kni = kni_q->internals->kni;
  98         uint16_t nb_pkts;
  99
 100         nb_pkts =  rte_kni_tx_burst(kni, bufs, nb_bufs);
 101
 102         kni_q->tx.pkts += nb_pkts;
 103
 104         return nb_pkts;
 105 }
 106
 107 static void *
 108 kni_handle_request(void *param)
 109 {
 110         struct pmd_internals *internals = param;
 111 #define MS 1000
 112
 113         while (!internals->stop_thread) {
 114                 rte_kni_handle_request(internals->kni);
 115                 usleep(500 * MS);
 116         }
 117
 118         return param;
 119 }
 120
 121 static int
 122 eth_kni_start(struct rte_eth_dev *dev)
 123 {
 124         struct pmd_internals *internals = dev->data->dev_private;
 125         uint16_t port_id = dev->data->port_id;
 126         struct rte_mempool *mb_pool;
 127         struct rte_kni_conf conf;
 128         const char *name = dev->device->name + 4; /* remove net_ */
 129
 130         mb_pool = internals->rx_queues[0].mb_pool;
 131         strlcpy(conf.name, name, RTE_KNI_NAMESIZE);
 132         conf.force_bind = 0;
 133         conf.group_id = port_id;
 134         conf.mbuf_size =
 135                 rte_pktmbuf_data_room_size(mb_pool) - RTE_PKTMBUF_HEADROOM;
 136         conf.mtu = KNI_ETHER_MTU(conf.mbuf_size);
 137
 138         internals->kni = rte_kni_alloc(mb_pool, &conf, NULL);
 139         if (internals->kni == NULL) {
 140                 PMD_LOG(ERR,
 141                         "Fail to create kni interface for port: %d",
 142                         port_id);
 143                 return -1;
 144         }
 145
 146         return 0;
 147 }
 148
 149 static int
 150 eth_kni_dev_start(struct rte_eth_dev *dev)
 151 {
 152         struct pmd_internals *internals = dev->data->dev_private;
 153         int ret;
 154
 155         if (internals->is_kni_started == 0) {
 156                 ret = eth_kni_start(dev);
 157                 if (ret)
 158                         return -1;
 159                 internals->is_kni_started = 1;
 160         }
 161
 162         if (internals->no_request_thread == 0) {
 163                 internals->stop_thread = 0;
 164
 165                 ret = rte_ctrl_thread_create(&internals->thread,
 166                         "kni_handle_req", NULL,
 167                         kni_handle_request, internals);
 168                 if (ret) {
 169                         PMD_LOG(ERR,
 170                                 "Fail to create kni request thread");
 171                         return -1;
 172                 }
 173         }
 174
 175         dev->data->dev_link.link_status = 1;
 176
 177         return 0;
 178 }
 179
 180 static void
 181 eth_kni_dev_stop(struct rte_eth_dev *dev)
 182 {
 183         struct pmd_internals *internals = dev->data->dev_private;
 184         int ret;
 185
 186         if (internals->no_request_thread == 0 && internals->stop_thread == 0) {
 187                 internals->stop_thread = 1;
 188
 189                 ret = pthread_cancel(internals->thread);
 190                 if (ret)
 191                         PMD_LOG(ERR, "Can't cancel the thread");
 192
 193                 ret = pthread_join(internals->thread, NULL);
 194                 if (ret)
 195                         PMD_LOG(ERR, "Can't join the thread");
 196         }
 197
 198         dev->data->dev_link.link_status = 0;
 199         dev->data->dev_started = 0;
 200 }
 201
 202 static int
 203 eth_kni_close(struct rte_eth_dev *eth_dev)
 204 {
 205         struct pmd_internals *internals;
 206         int ret;
 207
 208         if (rte_eal_process_type() != RTE_PROC_PRIMARY)
 209                 return 0;
 210
 211         eth_kni_dev_stop(eth_dev);
 212
 213         /* mac_addrs must not be freed alone because part of dev_private */
 214         eth_dev->data->mac_addrs = NULL;
 215
 216         internals = eth_dev->data->dev_private;
 217         ret = rte_kni_release(internals->kni);
 218         if (ret)
 219                 PMD_LOG(WARNING, "Not able to release kni for %s",
 220                         eth_dev->data->name);
 221
 222         return 0;
 223 }
 224
 225 static int
 226 eth_kni_dev_configure(struct rte_eth_dev *dev __rte_unused)
 227 {
 228         return 0;
 229 }
 230
 231 static int
 232 eth_kni_dev_info(struct rte_eth_dev *dev __rte_unused,
 233                 struct rte_eth_dev_info *dev_info)
 234 {
 235         dev_info->max_mac_addrs = 1;
 236         dev_info->max_rx_pktlen = UINT32_MAX;
 237         dev_info->max_rx_queues = KNI_MAX_QUEUE_PER_PORT;
 238         dev_info->max_tx_queues = KNI_MAX_QUEUE_PER_PORT;
 239         dev_info->min_rx_bufsize = 0;
 240
 241         return 0;
 242 }
 243
 244 static int
 245 eth_kni_rx_queue_setup(struct rte_eth_dev *dev,
 246                 uint16_t rx_queue_id,
 247                 uint16_t nb_rx_desc __rte_unused,
 248                 unsigned int socket_id __rte_unused,
 249                 const struct rte_eth_rxconf *rx_conf __rte_unused,
 250                 struct rte_mempool *mb_pool)
 251 {
 252         struct pmd_internals *internals = dev->data->dev_private;
 253         struct pmd_queue *q;
 254
 255         q = &internals->rx_queues[rx_queue_id];
 256         q->internals = internals;
 257         q->mb_pool = mb_pool;
 258
 259         dev->data->rx_queues[rx_queue_id] = q;
 260
 261         return 0;
 262 }
 263
 264 static int
 265 eth_kni_tx_queue_setup(struct rte_eth_dev *dev,
 266                 uint16_t tx_queue_id,
 267                 uint16_t nb_tx_desc __rte_unused,
 268                 unsigned int socket_id __rte_unused,
 269                 const struct rte_eth_txconf *tx_conf __rte_unused)
 270 {
 271         struct pmd_internals *internals = dev->data->dev_private;
 272         struct pmd_queue *q;
 273
 274         q = &internals->tx_queues[tx_queue_id];
 275         q->internals = internals;
 276
 277         dev->data->tx_queues[tx_queue_id] = q;
 278
 279         return 0;
 280 }
 281
 282 static void
 283 eth_kni_queue_release(void *q __rte_unused)
 284 {
 285 }
 286
 287 static int
 288 eth_kni_link_update(struct rte_eth_dev *dev __rte_unused,
 289                 int wait_to_complete __rte_unused)
 290 {
 291         return 0;
 292 }
 293
 294 static int
 295 eth_kni_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats)
 296 {
 297         unsigned long rx_packets_total = 0, rx_bytes_total = 0;
 298         unsigned long tx_packets_total = 0, tx_bytes_total = 0;
 299         struct rte_eth_dev_data *data = dev->data;
 300         unsigned int i, num_stats;
 301         struct pmd_queue *q;
 302
 303         num_stats = RTE_MIN((unsigned int)RTE_ETHDEV_QUEUE_STAT_CNTRS,
 304                         data->nb_rx_queues);
 305         for (i = 0; i < num_stats; i++) {
 306                 q = data->rx_queues[i];
 307                 stats->q_ipackets[i] = q->rx.pkts;
 308                 stats->q_ibytes[i] = q->rx.bytes;
 309                 rx_packets_total += stats->q_ipackets[i];
 310                 rx_bytes_total += stats->q_ibytes[i];
 311         }
 312
 313         num_stats = RTE_MIN((unsigned int)RTE_ETHDEV_QUEUE_STAT_CNTRS,
 314                         data->nb_tx_queues);
 315         for (i = 0; i < num_stats; i++) {
 316                 q = data->tx_queues[i];
 317                 stats->q_opackets[i] = q->tx.pkts;
 318                 stats->q_obytes[i] = q->tx.bytes;
 319                 tx_packets_total += stats->q_opackets[i];
 320                 tx_bytes_total += stats->q_obytes[i];
 321         }
 322
 323         stats->ipackets = rx_packets_total;
 324         stats->ibytes = rx_bytes_total;
 325         stats->opackets = tx_packets_total;
 326         stats->obytes = tx_bytes_total;
 327
 328         return 0;
 329 }
 330
 331 static int
 332 eth_kni_stats_reset(struct rte_eth_dev *dev)
 333 {
 334         struct rte_eth_dev_data *data = dev->data;
 335         struct pmd_queue *q;
 336         unsigned int i;
 337
 338         for (i = 0; i < data->nb_rx_queues; i++) {
 339                 q = data->rx_queues[i];
 340                 q->rx.pkts = 0;
 341                 q->rx.bytes = 0;
 342         }
 343         for (i = 0; i < data->nb_tx_queues; i++) {
 344                 q = data->tx_queues[i];
 345                 q->tx.pkts = 0;
 346                 q->tx.bytes = 0;
 347         }
 348
 349         return 0;
 350 }
 351
 352 static const struct eth_dev_ops eth_kni_ops = {
 353         .dev_start = eth_kni_dev_start,
 354         .dev_stop = eth_kni_dev_stop,
 355         .dev_close = eth_kni_close,
 356         .dev_configure = eth_kni_dev_configure,
 357         .dev_infos_get = eth_kni_dev_info,
 358         .rx_queue_setup = eth_kni_rx_queue_setup,
 359         .tx_queue_setup = eth_kni_tx_queue_setup,
 360         .rx_queue_release = eth_kni_queue_release,
 361         .tx_queue_release = eth_kni_queue_release,
 362         .link_update = eth_kni_link_update,
 363         .stats_get = eth_kni_stats_get,
 364         .stats_reset = eth_kni_stats_reset,
 365 };
 366
 367 static struct rte_eth_dev *
 368 eth_kni_create(struct rte_vdev_device *vdev,
 369                 struct eth_kni_args *args,
 370                 unsigned int numa_node)
 371 {
 372         struct pmd_internals *internals;
 373         struct rte_eth_dev_data *data;
 374         struct rte_eth_dev *eth_dev;
 375
 376         PMD_LOG(INFO, "Creating kni ethdev on numa socket %u",
 377                         numa_node);
 378
 379         /* reserve an ethdev entry */
 380         eth_dev = rte_eth_vdev_allocate(vdev, sizeof(*internals));
 381         if (!eth_dev)
 382                 return NULL;
 383
 384         internals = eth_dev->data->dev_private;
 385         internals->port_id = eth_dev->data->port_id;
 386         data = eth_dev->data;
 387         data->nb_rx_queues = 1;
 388         data->nb_tx_queues = 1;
 389         data->dev_link = pmd_link;
 390         data->mac_addrs = &internals->eth_addr;
 391         data->promiscuous = 1;
 392         data->all_multicast = 1;
 393
 394         rte_eth_random_addr(internals->eth_addr.addr_bytes);
 395
 396         eth_dev->dev_ops = &eth_kni_ops;
 397
 398         internals->no_request_thread = args->no_request_thread;
 399
 400         return eth_dev;
 401 }
 402
 403 static int
 404 kni_init(void)
 405 {
 406         if (is_kni_initialized == 0)
 407                 rte_kni_init(MAX_KNI_PORTS);
 408
 409         is_kni_initialized++;
 410
 411         return 0;
 412 }
 413
 414 static int
 415 eth_kni_kvargs_process(struct eth_kni_args *args, const char *params)
 416 {
 417         struct rte_kvargs *kvlist;
 418
 419         kvlist = rte_kvargs_parse(params, valid_arguments);
 420         if (kvlist == NULL)
 421                 return -1;
 422
 423         memset(args, 0, sizeof(struct eth_kni_args));
 424
 425         if (rte_kvargs_count(kvlist, ETH_KNI_NO_REQUEST_THREAD_ARG) == 1)
 426                 args->no_request_thread = 1;
 427
 428         rte_kvargs_free(kvlist);
 429
 430         return 0;
 431 }
 432
 433 static int
 434 eth_kni_probe(struct rte_vdev_device *vdev)
 435 {
 436         struct rte_eth_dev *eth_dev;
 437         struct eth_kni_args args;
 438         const char *name;
 439         const char *params;
 440         int ret;
 441
 442         name = rte_vdev_device_name(vdev);
 443         params = rte_vdev_device_args(vdev);
 444         PMD_LOG(INFO, "Initializing eth_kni for %s", name);
 445
 446         if (rte_eal_process_type() == RTE_PROC_SECONDARY) {
 447                 eth_dev = rte_eth_dev_attach_secondary(name);
 448                 if (!eth_dev) {
 449                         PMD_LOG(ERR, "Failed to probe %s", name);
 450                         return -1;
 451                 }
 452                 /* TODO: request info from primary to set up Rx and Tx */
 453                 eth_dev->dev_ops = &eth_kni_ops;
 454                 eth_dev->device = &vdev->device;
 455                 rte_eth_dev_probing_finish(eth_dev);
 456                 return 0;
 457         }
 458
 459         ret = eth_kni_kvargs_process(&args, params);
 460         if (ret < 0)
 461                 return ret;
 462
 463         ret = kni_init();
 464         if (ret < 0)
 465                 return ret;
 466
 467         eth_dev = eth_kni_create(vdev, &args, rte_socket_id());
 468         if (eth_dev == NULL)
 469                 goto kni_uninit;
 470
 471         eth_dev->rx_pkt_burst = eth_kni_rx;
 472         eth_dev->tx_pkt_burst = eth_kni_tx;
 473
 474         rte_eth_dev_probing_finish(eth_dev);
 475         return 0;
 476
 477 kni_uninit:
 478         is_kni_initialized--;
 479         if (is_kni_initialized == 0)
 480                 rte_kni_close();
 481         return -1;
 482 }
 483
 484 static int
 485 eth_kni_remove(struct rte_vdev_device *vdev)
 486 {
 487         struct rte_eth_dev *eth_dev;
 488         const char *name;
 489
 490         name = rte_vdev_device_name(vdev);
 491         PMD_LOG(INFO, "Un-Initializing eth_kni for %s", name);
 492
 493         /* find the ethdev entry */
 494         eth_dev = rte_eth_dev_allocated(name);
 495         if (eth_dev != NULL) {
 496                 if (rte_eal_process_type() != RTE_PROC_PRIMARY) {
 497                         eth_kni_dev_stop(eth_dev);
 498                         return rte_eth_dev_release_port(eth_dev);
 499                 }
 500                 eth_kni_close(eth_dev);
 501                 rte_eth_dev_release_port(eth_dev);
 502         }
 503
 504         is_kni_initialized--;
 505         if (is_kni_initialized == 0)
 506                 rte_kni_close();
 507
 508         return 0;
 509 }
 510
 511 static struct rte_vdev_driver eth_kni_drv = {
 512         .probe = eth_kni_probe,
 513         .remove = eth_kni_remove,
 514 };
 515
 516 RTE_PMD_REGISTER_VDEV(net_kni, eth_kni_drv);
 517 RTE_PMD_REGISTER_PARAM_STRING(net_kni, ETH_KNI_NO_REQUEST_THREAD_ARG "=<int>");