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