examples/eventdev_pipeline_sw_pmd/main.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2016-2017 Intel Corporation
   3  */
   4
   5 #include <getopt.h>
   6 #include <stdint.h>
   7 #include <stdio.h>
   8 #include <signal.h>
   9 #include <sched.h>
  10
  11 #include "pipeline_common.h"
  12
  13 struct config_data cdata = {
  14         .num_packets = (1L << 25), /* do ~32M packets */
  15         .num_fids = 512,
  16         .queue_type = RTE_SCHED_TYPE_ATOMIC,
  17         .next_qid = {-1},
  18         .qid = {-1},
  19         .num_stages = 1,
  20         .worker_cq_depth = 16
  21 };
  22
  23 static bool
  24 core_in_use(unsigned int lcore_id) {
  25         return (fdata->rx_core[lcore_id] || fdata->sched_core[lcore_id] ||
  26                 fdata->tx_core[lcore_id] || fdata->worker_core[lcore_id]);
  27 }
  28
  29 static void
  30 eth_tx_buffer_retry(struct rte_mbuf **pkts, uint16_t unsent,
  31                         void *userdata)
  32 {
  33         int port_id = (uintptr_t) userdata;
  34         unsigned int _sent = 0;
  35
  36         do {
  37                 /* Note: hard-coded TX queue */
  38                 _sent += rte_eth_tx_burst(port_id, 0, &pkts[_sent],
  39                                           unsent - _sent);
  40         } while (_sent != unsent);
  41 }
  42
  43 /*
  44  * Parse the coremask given as argument (hexadecimal string) and fill
  45  * the global configuration (core role and core count) with the parsed
  46  * value.
  47  */
  48 static int xdigit2val(unsigned char c)
  49 {
  50         int val;
  51
  52         if (isdigit(c))
  53                 val = c - '0';
  54         else if (isupper(c))
  55                 val = c - 'A' + 10;
  56         else
  57                 val = c - 'a' + 10;
  58         return val;
  59 }
  60
  61 static uint64_t
  62 parse_coremask(const char *coremask)
  63 {
  64         int i, j, idx = 0;
  65         unsigned int count = 0;
  66         char c;
  67         int val;
  68         uint64_t mask = 0;
  69         const int32_t BITS_HEX = 4;
  70
  71         if (coremask == NULL)
  72                 return -1;
  73         /* Remove all blank characters ahead and after .
  74          * Remove 0x/0X if exists.
  75          */
  76         while (isblank(*coremask))
  77                 coremask++;
  78         if (coremask[0] == '0' && ((coremask[1] == 'x')
  79                 || (coremask[1] == 'X')))
  80                 coremask += 2;
  81         i = strlen(coremask);
  82         while ((i > 0) && isblank(coremask[i - 1]))
  83                 i--;
  84         if (i == 0)
  85                 return -1;
  86
  87         for (i = i - 1; i >= 0 && idx < MAX_NUM_CORE; i--) {
  88                 c = coremask[i];
  89                 if (isxdigit(c) == 0) {
  90                         /* invalid characters */
  91                         return -1;
  92                 }
  93                 val = xdigit2val(c);
  94                 for (j = 0; j < BITS_HEX && idx < MAX_NUM_CORE; j++, idx++) {
  95                         if ((1 << j) & val) {
  96                                 mask |= (1UL << idx);
  97                                 count++;
  98                         }
  99                 }
 100         }
 101         for (; i >= 0; i--)
 102                 if (coremask[i] != '0')
 103                         return -1;
 104         if (count == 0)
 105                 return -1;
 106         return mask;
 107 }
 108
 109 static struct option long_options[] = {
 110         {"workers", required_argument, 0, 'w'},
 111         {"packets", required_argument, 0, 'n'},
 112         {"atomic-flows", required_argument, 0, 'f'},
 113         {"num_stages", required_argument, 0, 's'},
 114         {"rx-mask", required_argument, 0, 'r'},
 115         {"tx-mask", required_argument, 0, 't'},
 116         {"sched-mask", required_argument, 0, 'e'},
 117         {"cq-depth", required_argument, 0, 'c'},
 118         {"work-cycles", required_argument, 0, 'W'},
 119         {"queue-priority", no_argument, 0, 'P'},
 120         {"parallel", no_argument, 0, 'p'},
 121         {"ordered", no_argument, 0, 'o'},
 122         {"quiet", no_argument, 0, 'q'},
 123         {"use-atq", no_argument, 0, 'a'},
 124         {"dump", no_argument, 0, 'D'},
 125         {0, 0, 0, 0}
 126 };
 127
 128 static void
 129 usage(void)
 130 {
 131         const char *usage_str =
 132                 "  Usage: eventdev_demo [options]\n"
 133                 "  Options:\n"
 134                 "  -n, --packets=N              Send N packets (default ~32M), 0 implies no limit\n"
 135                 "  -f, --atomic-flows=N         Use N random flows from 1 to N (default 16)\n"
 136                 "  -s, --num_stages=N           Use N atomic stages (default 1)\n"
 137                 "  -r, --rx-mask=core mask      Run NIC rx on CPUs in core mask\n"
 138                 "  -w, --worker-mask=core mask  Run worker on CPUs in core mask\n"
 139                 "  -t, --tx-mask=core mask      Run NIC tx on CPUs in core mask\n"
 140                 "  -e  --sched-mask=core mask   Run scheduler on CPUs in core mask\n"
 141                 "  -c  --cq-depth=N             Worker CQ depth (default 16)\n"
 142                 "  -W  --work-cycles=N          Worker cycles (default 0)\n"
 143                 "  -P  --queue-priority         Enable scheduler queue prioritization\n"
 144                 "  -o, --ordered                Use ordered scheduling\n"
 145                 "  -p, --parallel               Use parallel scheduling\n"
 146                 "  -q, --quiet                  Minimize printed output\n"
 147                 "  -a, --use-atq                Use all type queues\n"
 148                 "  -D, --dump                   Print detailed statistics before exit"
 149                 "\n";
 150         fprintf(stderr, "%s", usage_str);
 151         exit(1);
 152 }
 153
 154 static void
 155 parse_app_args(int argc, char **argv)
 156 {
 157         /* Parse cli options*/
 158         int option_index;
 159         int c;
 160         opterr = 0;
 161         uint64_t rx_lcore_mask = 0;
 162         uint64_t tx_lcore_mask = 0;
 163         uint64_t sched_lcore_mask = 0;
 164         uint64_t worker_lcore_mask = 0;
 165         int i;
 166
 167         for (;;) {
 168                 c = getopt_long(argc, argv, "r:t:e:c:w:n:f:s:paoPqDW:",
 169                                 long_options, &option_index);
 170                 if (c == -1)
 171                         break;
 172
 173                 int popcnt = 0;
 174                 switch (c) {
 175                 case 'n':
 176                         cdata.num_packets = (int64_t)atol(optarg);
 177                         if (cdata.num_packets == 0)
 178                                 cdata.num_packets = INT64_MAX;
 179                         break;
 180                 case 'f':
 181                         cdata.num_fids = (unsigned int)atoi(optarg);
 182                         break;
 183                 case 's':
 184                         cdata.num_stages = (unsigned int)atoi(optarg);
 185                         break;
 186                 case 'c':
 187                         cdata.worker_cq_depth = (unsigned int)atoi(optarg);
 188                         break;
 189                 case 'W':
 190                         cdata.worker_cycles = (unsigned int)atoi(optarg);
 191                         break;
 192                 case 'P':
 193                         cdata.enable_queue_priorities = 1;
 194                         break;
 195                 case 'o':
 196                         cdata.queue_type = RTE_SCHED_TYPE_ORDERED;
 197                         break;
 198                 case 'p':
 199                         cdata.queue_type = RTE_SCHED_TYPE_PARALLEL;
 200                         break;
 201                 case 'a':
 202                         cdata.all_type_queues = 1;
 203                         break;
 204                 case 'q':
 205                         cdata.quiet = 1;
 206                         break;
 207                 case 'D':
 208                         cdata.dump_dev = 1;
 209                         break;
 210                 case 'w':
 211                         worker_lcore_mask = parse_coremask(optarg);
 212                         break;
 213                 case 'r':
 214                         rx_lcore_mask = parse_coremask(optarg);
 215                         popcnt = __builtin_popcountll(rx_lcore_mask);
 216                         fdata->rx_single = (popcnt == 1);
 217                         break;
 218                 case 't':
 219                         tx_lcore_mask = parse_coremask(optarg);
 220                         popcnt = __builtin_popcountll(tx_lcore_mask);
 221                         fdata->tx_single = (popcnt == 1);
 222                         break;
 223                 case 'e':
 224                         sched_lcore_mask = parse_coremask(optarg);
 225                         popcnt = __builtin_popcountll(sched_lcore_mask);
 226                         fdata->sched_single = (popcnt == 1);
 227                         break;
 228                 default:
 229                         usage();
 230                 }
 231         }
 232
 233         cdata.worker_lcore_mask = worker_lcore_mask;
 234         cdata.sched_lcore_mask = sched_lcore_mask;
 235         cdata.rx_lcore_mask = rx_lcore_mask;
 236         cdata.tx_lcore_mask = tx_lcore_mask;
 237
 238         if (cdata.num_stages == 0 || cdata.num_stages > MAX_NUM_STAGES)
 239                 usage();
 240
 241         for (i = 0; i < MAX_NUM_CORE; i++) {
 242                 fdata->rx_core[i] = !!(rx_lcore_mask & (1UL << i));
 243                 fdata->tx_core[i] = !!(tx_lcore_mask & (1UL << i));
 244                 fdata->sched_core[i] = !!(sched_lcore_mask & (1UL << i));
 245                 fdata->worker_core[i] = !!(worker_lcore_mask & (1UL << i));
 246
 247                 if (fdata->worker_core[i])
 248                         cdata.num_workers++;
 249                 if (core_in_use(i))
 250                         cdata.active_cores++;
 251         }
 252 }
 253
 254 /*
 255  * Initializes a given port using global settings and with the RX buffers
 256  * coming from the mbuf_pool passed as a parameter.
 257  */
 258 static inline int
 259 port_init(uint8_t port, struct rte_mempool *mbuf_pool)
 260 {
 261         static const struct rte_eth_conf port_conf_default = {
 262                 .rxmode = {
 263                         .mq_mode = ETH_MQ_RX_RSS,
 264                         .max_rx_pkt_len = ETHER_MAX_LEN,
 265                         .ignore_offload_bitfield = 1,
 266                 },
 267                 .rx_adv_conf = {
 268                         .rss_conf = {
 269                                 .rss_hf = ETH_RSS_IP |
 270                                           ETH_RSS_TCP |
 271                                           ETH_RSS_UDP,
 272                         }
 273                 }
 274         };
 275         const uint16_t rx_rings = 1, tx_rings = 1;
 276         const uint16_t rx_ring_size = 512, tx_ring_size = 512;
 277         struct rte_eth_conf port_conf = port_conf_default;
 278         int retval;
 279         uint16_t q;
 280         struct rte_eth_dev_info dev_info;
 281         struct rte_eth_txconf txconf;
 282
 283         if (port >= rte_eth_dev_count())
 284                 return -1;
 285
 286         rte_eth_dev_info_get(port, &dev_info);
 287         if (dev_info.tx_offload_capa & DEV_TX_OFFLOAD_MBUF_FAST_FREE)
 288                 port_conf.txmode.offloads |=
 289                         DEV_TX_OFFLOAD_MBUF_FAST_FREE;
 290
 291         /* Configure the Ethernet device. */
 292         retval = rte_eth_dev_configure(port, rx_rings, tx_rings, &port_conf);
 293         if (retval != 0)
 294                 return retval;
 295
 296         /* Allocate and set up 1 RX queue per Ethernet port. */
 297         for (q = 0; q < rx_rings; q++) {
 298                 retval = rte_eth_rx_queue_setup(port, q, rx_ring_size,
 299                                 rte_eth_dev_socket_id(port), NULL, mbuf_pool);
 300                 if (retval < 0)
 301                         return retval;
 302         }
 303
 304         txconf = dev_info.default_txconf;
 305         txconf.txq_flags = ETH_TXQ_FLAGS_IGNORE;
 306         txconf.offloads = port_conf_default.txmode.offloads;
 307         /* Allocate and set up 1 TX queue per Ethernet port. */
 308         for (q = 0; q < tx_rings; q++) {
 309                 retval = rte_eth_tx_queue_setup(port, q, tx_ring_size,
 310                                 rte_eth_dev_socket_id(port), &txconf);
 311                 if (retval < 0)
 312                         return retval;
 313         }
 314
 315         /* Start the Ethernet port. */
 316         retval = rte_eth_dev_start(port);
 317         if (retval < 0)
 318                 return retval;
 319
 320         /* Display the port MAC address. */
 321         struct ether_addr addr;
 322         rte_eth_macaddr_get(port, &addr);
 323         printf("Port %u MAC: %02" PRIx8 " %02" PRIx8 " %02" PRIx8
 324                            " %02" PRIx8 " %02" PRIx8 " %02" PRIx8 "\n",
 325                         (unsigned int)port,
 326                         addr.addr_bytes[0], addr.addr_bytes[1],
 327                         addr.addr_bytes[2], addr.addr_bytes[3],
 328                         addr.addr_bytes[4], addr.addr_bytes[5]);
 329
 330         /* Enable RX in promiscuous mode for the Ethernet device. */
 331         rte_eth_promiscuous_enable(port);
 332
 333         return 0;
 334 }
 335
 336 static int
 337 init_ports(unsigned int num_ports)
 338 {
 339         uint8_t portid;
 340         unsigned int i;
 341
 342         struct rte_mempool *mp = rte_pktmbuf_pool_create("packet_pool",
 343                         /* mbufs */ 16384 * num_ports,
 344                         /* cache_size */ 512,
 345                         /* priv_size*/ 0,
 346                         /* data_room_size */ RTE_MBUF_DEFAULT_BUF_SIZE,
 347                         rte_socket_id());
 348
 349         for (portid = 0; portid < num_ports; portid++)
 350                 if (port_init(portid, mp) != 0)
 351                         rte_exit(EXIT_FAILURE, "Cannot init port %"PRIu8 "\n",
 352                                         portid);
 353
 354         for (i = 0; i < num_ports; i++) {
 355                 void *userdata = (void *)(uintptr_t) i;
 356                 fdata->tx_buf[i] =
 357                         rte_malloc(NULL, RTE_ETH_TX_BUFFER_SIZE(32), 0);
 358                 if (fdata->tx_buf[i] == NULL)
 359                         rte_panic("Out of memory\n");
 360                 rte_eth_tx_buffer_init(fdata->tx_buf[i], 32);
 361                 rte_eth_tx_buffer_set_err_callback(fdata->tx_buf[i],
 362                                                    eth_tx_buffer_retry,
 363                                                    userdata);
 364         }
 365
 366         return 0;
 367 }
 368
 369 static void
 370 do_capability_setup(uint16_t nb_ethdev, uint8_t eventdev_id)
 371 {
 372         int i;
 373         uint8_t mt_unsafe = 0;
 374         uint8_t burst = 0;
 375
 376         for (i = 0; i < nb_ethdev; i++) {
 377                 struct rte_eth_dev_info dev_info;
 378                 memset(&dev_info, 0, sizeof(struct rte_eth_dev_info));
 379
 380                 rte_eth_dev_info_get(i, &dev_info);
 381                 /* Check if it is safe ask worker to tx. */
 382                 mt_unsafe |= !(dev_info.tx_offload_capa &
 383                                 DEV_TX_OFFLOAD_MT_LOCKFREE);
 384         }
 385
 386         struct rte_event_dev_info eventdev_info;
 387         memset(&eventdev_info, 0, sizeof(struct rte_event_dev_info));
 388
 389         rte_event_dev_info_get(eventdev_id, &eventdev_info);
 390         burst = eventdev_info.event_dev_cap & RTE_EVENT_DEV_CAP_BURST_MODE ? 1 :
 391                 0;
 392
 393         if (mt_unsafe)
 394                 set_worker_generic_setup_data(&fdata->cap, burst);
 395         else
 396                 set_worker_tx_setup_data(&fdata->cap, burst);
 397 }
 398
 399 static void
 400 signal_handler(int signum)
 401 {
 402         if (fdata->done)
 403                 rte_exit(1, "Exiting on signal %d\n", signum);
 404         if (signum == SIGINT || signum == SIGTERM) {
 405                 printf("\n\nSignal %d received, preparing to exit...\n",
 406                                 signum);
 407                 fdata->done = 1;
 408         }
 409         if (signum == SIGTSTP)
 410                 rte_event_dev_dump(0, stdout);
 411 }
 412
 413 static inline uint64_t
 414 port_stat(int dev_id, int32_t p)
 415 {
 416         char statname[64];
 417         snprintf(statname, sizeof(statname), "port_%u_rx", p);
 418         return rte_event_dev_xstats_by_name_get(dev_id, statname, NULL);
 419 }
 420
 421 int
 422 main(int argc, char **argv)
 423 {
 424         struct worker_data *worker_data;
 425         unsigned int num_ports;
 426         int lcore_id;
 427         int err;
 428
 429         signal(SIGINT, signal_handler);
 430         signal(SIGTERM, signal_handler);
 431         signal(SIGTSTP, signal_handler);
 432
 433         err = rte_eal_init(argc, argv);
 434         if (err < 0)
 435                 rte_panic("Invalid EAL arguments\n");
 436
 437         argc -= err;
 438         argv += err;
 439
 440         fdata = rte_malloc(NULL, sizeof(struct fastpath_data), 0);
 441         if (fdata == NULL)
 442                 rte_panic("Out of memory\n");
 443
 444         /* Parse cli options*/
 445         parse_app_args(argc, argv);
 446
 447         num_ports = rte_eth_dev_count();
 448         if (num_ports == 0)
 449                 rte_panic("No ethernet ports found\n");
 450
 451         const unsigned int cores_needed = cdata.active_cores;
 452
 453         if (!cdata.quiet) {
 454                 printf("  Config:\n");
 455                 printf("\tports: %u\n", num_ports);
 456                 printf("\tworkers: %u\n", cdata.num_workers);
 457                 printf("\tpackets: %"PRIi64"\n", cdata.num_packets);
 458                 printf("\tQueue-prio: %u\n", cdata.enable_queue_priorities);
 459                 if (cdata.queue_type == RTE_SCHED_TYPE_ORDERED)
 460                         printf("\tqid0 type: ordered\n");
 461                 if (cdata.queue_type == RTE_SCHED_TYPE_ATOMIC)
 462                         printf("\tqid0 type: atomic\n");
 463                 printf("\tCores available: %u\n", rte_lcore_count());
 464                 printf("\tCores used: %u\n", cores_needed);
 465         }
 466
 467         if (rte_lcore_count() < cores_needed)
 468                 rte_panic("Too few cores (%d < %d)\n", rte_lcore_count(),
 469                                 cores_needed);
 470
 471         const unsigned int ndevs = rte_event_dev_count();
 472         if (ndevs == 0)
 473                 rte_panic("No dev_id devs found. Pasl in a --vdev eventdev.\n");
 474         if (ndevs > 1)
 475                 fprintf(stderr, "Warning: More than one eventdev, using idx 0");
 476
 477
 478         do_capability_setup(num_ports, 0);
 479         fdata->cap.check_opt();
 480
 481         worker_data = rte_calloc(0, cdata.num_workers,
 482                         sizeof(worker_data[0]), 0);
 483         if (worker_data == NULL)
 484                 rte_panic("rte_calloc failed\n");
 485
 486         int dev_id = fdata->cap.evdev_setup(&cons_data, worker_data);
 487         if (dev_id < 0)
 488                 rte_exit(EXIT_FAILURE, "Error setting up eventdev\n");
 489
 490         init_ports(num_ports);
 491         fdata->cap.adptr_setup(num_ports);
 492
 493         int worker_idx = 0;
 494         RTE_LCORE_FOREACH_SLAVE(lcore_id) {
 495                 if (lcore_id >= MAX_NUM_CORE)
 496                         break;
 497
 498                 if (!fdata->rx_core[lcore_id] &&
 499                         !fdata->worker_core[lcore_id] &&
 500                         !fdata->tx_core[lcore_id] &&
 501                         !fdata->sched_core[lcore_id])
 502                         continue;
 503
 504                 if (fdata->rx_core[lcore_id])
 505                         printf(
 506                                 "[%s()] lcore %d executing NIC Rx\n",
 507                                 __func__, lcore_id);
 508
 509                 if (fdata->tx_core[lcore_id])
 510                         printf(
 511                                 "[%s()] lcore %d executing NIC Tx, and using eventdev port %u\n",
 512                                 __func__, lcore_id, cons_data.port_id);
 513
 514                 if (fdata->sched_core[lcore_id])
 515                         printf("[%s()] lcore %d executing scheduler\n",
 516                                         __func__, lcore_id);
 517
 518                 if (fdata->worker_core[lcore_id])
 519                         printf(
 520                                 "[%s()] lcore %d executing worker, using eventdev port %u\n",
 521                                 __func__, lcore_id,
 522                                 worker_data[worker_idx].port_id);
 523
 524                 err = rte_eal_remote_launch(fdata->cap.worker,
 525                                 &worker_data[worker_idx], lcore_id);
 526                 if (err) {
 527                         rte_panic("Failed to launch worker on core %d\n",
 528                                         lcore_id);
 529                         continue;
 530                 }
 531                 if (fdata->worker_core[lcore_id])
 532                         worker_idx++;
 533         }
 534
 535         lcore_id = rte_lcore_id();
 536
 537         if (core_in_use(lcore_id))
 538                 fdata->cap.worker(&worker_data[worker_idx++]);
 539
 540         rte_eal_mp_wait_lcore();
 541
 542         if (cdata.dump_dev)
 543                 rte_event_dev_dump(dev_id, stdout);
 544
 545         if (!cdata.quiet && (port_stat(dev_id, worker_data[0].port_id) !=
 546                         (uint64_t)-ENOTSUP)) {
 547                 printf("\nPort Workload distribution:\n");
 548                 uint32_t i;
 549                 uint64_t tot_pkts = 0;
 550                 uint64_t pkts_per_wkr[RTE_MAX_LCORE] = {0};
 551                 for (i = 0; i < cdata.num_workers; i++) {
 552                         pkts_per_wkr[i] =
 553                                 port_stat(dev_id, worker_data[i].port_id);
 554                         tot_pkts += pkts_per_wkr[i];
 555                 }
 556                 for (i = 0; i < cdata.num_workers; i++) {
 557                         float pc = pkts_per_wkr[i]  * 100 /
 558                                 ((float)tot_pkts);
 559                         printf("worker %i :\t%.1f %% (%"PRIu64" pkts)\n",
 560                                         i, pc, pkts_per_wkr[i]);
 561                 }
 562
 563         }
 564
 565         return 0;
 566 }