app/test-eventdev/evt_options.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2017 Cavium, Inc
   3  */
   4
   5 #include <stdio.h>
   6 #include <string.h>
   7 #include <inttypes.h>
   8 #include <getopt.h>
   9
  10 #include <rte_string_fns.h>
  11 #include <rte_common.h>
  12 #include <rte_eventdev.h>
  13 #include <rte_lcore.h>
  14
  15 #include "evt_options.h"
  16 #include "evt_test.h"
  17 #include "parser.h"
  18
  19 void
  20 evt_options_default(struct evt_options *opt)
  21 {
  22         memset(opt, 0, sizeof(*opt));
  23         opt->verbose_level = 1; /* Enable minimal prints */
  24         opt->dev_id = 0;
  25         strncpy(opt->test_name, "order_queue", EVT_TEST_NAME_MAX_LEN);
  26         opt->nb_flows = 1024;
  27         opt->socket_id = SOCKET_ID_ANY;
  28         opt->pool_sz = 16 * 1024;
  29         opt->prod_enq_burst_sz = 1;
  30         opt->wkr_deq_dep = 16;
  31         opt->nb_pkts = (1ULL << 26); /* do ~64M packets */
  32         opt->nb_timers = 1E8;
  33         opt->nb_timer_adptrs = 1;
  34         opt->timer_tick_nsec = 1E3; /* 1000ns ~ 1us */
  35         opt->max_tmo_nsec = 1E5;  /* 100000ns ~100us */
  36         opt->expiry_nsec = 1E4;   /* 10000ns ~10us */
  37         opt->prod_type = EVT_PROD_TYPE_SYNT;
  38         opt->eth_queues = 1;
  39         opt->vector_size = 64;
  40         opt->vector_tmo_nsec = 100E3;
  41 }
  42
  43 typedef int (*option_parser_t)(struct evt_options *opt,
  44                 const char *arg);
  45
  46 struct long_opt_parser {
  47         const char *lgopt_name;
  48         option_parser_t parser_fn;
  49 };
  50
  51 static int
  52 evt_parse_nb_flows(struct evt_options *opt, const char *arg)
  53 {
  54         int ret;
  55
  56         ret = parser_read_uint32(&(opt->nb_flows), arg);
  57
  58         return ret;
  59 }
  60
  61 static int
  62 evt_parse_dev_id(struct evt_options *opt, const char *arg)
  63 {
  64         int ret;
  65
  66         ret = parser_read_uint8(&(opt->dev_id), arg);
  67
  68         return ret;
  69 }
  70
  71 static int
  72 evt_parse_verbose(struct evt_options *opt, const char *arg __rte_unused)
  73 {
  74         opt->verbose_level = atoi(arg);
  75         return 0;
  76 }
  77
  78 static int
  79 evt_parse_fwd_latency(struct evt_options *opt, const char *arg __rte_unused)
  80 {
  81         opt->fwd_latency = 1;
  82         return 0;
  83 }
  84
  85 static int
  86 evt_parse_queue_priority(struct evt_options *opt, const char *arg __rte_unused)
  87 {
  88         opt->q_priority = 1;
  89         return 0;
  90 }
  91
  92 static int
  93 evt_parse_deq_tmo_nsec(struct evt_options *opt, const char *arg)
  94 {
  95         int ret;
  96
  97         ret = parser_read_uint32(&(opt->deq_tmo_nsec), arg);
  98
  99         return ret;
 100 }
 101
 102 static int
 103 evt_parse_eth_prod_type(struct evt_options *opt, const char *arg __rte_unused)
 104 {
 105         opt->prod_type = EVT_PROD_TYPE_ETH_RX_ADPTR;
 106         return 0;
 107 }
 108
 109 static int
 110 evt_parse_timer_prod_type(struct evt_options *opt, const char *arg __rte_unused)
 111 {
 112         opt->prod_type = EVT_PROD_TYPE_EVENT_TIMER_ADPTR;
 113         return 0;
 114 }
 115
 116 static int
 117 evt_parse_timer_prod_type_burst(struct evt_options *opt,
 118                 const char *arg __rte_unused)
 119 {
 120         opt->prod_type = EVT_PROD_TYPE_EVENT_TIMER_ADPTR;
 121         opt->timdev_use_burst = 1;
 122         return 0;
 123 }
 124
 125 static int
 126 evt_parse_test_name(struct evt_options *opt, const char *arg)
 127 {
 128         strlcpy(opt->test_name, arg, EVT_TEST_NAME_MAX_LEN);
 129         return 0;
 130 }
 131
 132 static int
 133 evt_parse_socket_id(struct evt_options *opt, const char *arg)
 134 {
 135         opt->socket_id = atoi(arg);
 136         return 0;
 137 }
 138
 139 static int
 140 evt_parse_wkr_deq_dep(struct evt_options *opt, const char *arg)
 141 {
 142         int ret;
 143
 144         ret = parser_read_uint16(&(opt->wkr_deq_dep), arg);
 145         return ret;
 146 }
 147
 148 static int
 149 evt_parse_nb_pkts(struct evt_options *opt, const char *arg)
 150 {
 151         int ret;
 152
 153         ret = parser_read_uint64(&(opt->nb_pkts), arg);
 154
 155         return ret;
 156 }
 157
 158 static int
 159 evt_parse_nb_timers(struct evt_options *opt, const char *arg)
 160 {
 161         int ret;
 162
 163         ret = parser_read_uint64(&(opt->nb_timers), arg);
 164
 165         return ret;
 166 }
 167
 168 static int
 169 evt_parse_timer_tick_nsec(struct evt_options *opt, const char *arg)
 170 {
 171         int ret;
 172
 173         ret = parser_read_uint64(&(opt->timer_tick_nsec), arg);
 174
 175         return ret;
 176 }
 177
 178 static int
 179 evt_parse_max_tmo_nsec(struct evt_options *opt, const char *arg)
 180 {
 181         int ret;
 182
 183         ret = parser_read_uint64(&(opt->max_tmo_nsec), arg);
 184
 185         return ret;
 186 }
 187
 188 static int
 189 evt_parse_expiry_nsec(struct evt_options *opt, const char *arg)
 190 {
 191         int ret;
 192
 193         ret = parser_read_uint64(&(opt->expiry_nsec), arg);
 194
 195         return ret;
 196 }
 197
 198 static int
 199 evt_parse_nb_timer_adptrs(struct evt_options *opt, const char *arg)
 200 {
 201         int ret;
 202
 203         ret = parser_read_uint8(&(opt->nb_timer_adptrs), arg);
 204         if (opt->nb_timer_adptrs <= 0) {
 205                 evt_err("Number of timer adapters cannot be <= 0");
 206                 return -EINVAL;
 207         }
 208
 209         return ret;
 210 }
 211
 212 static int
 213 evt_parse_pool_sz(struct evt_options *opt, const char *arg)
 214 {
 215         opt->pool_sz = atoi(arg);
 216
 217         return 0;
 218 }
 219
 220 static int
 221 evt_parse_plcores(struct evt_options *opt, const char *corelist)
 222 {
 223         int ret;
 224
 225         ret = parse_lcores_list(opt->plcores, RTE_MAX_LCORE, corelist);
 226         if (ret == -E2BIG)
 227                 evt_err("duplicate lcores in plcores");
 228
 229         return ret;
 230 }
 231
 232 static int
 233 evt_parse_work_lcores(struct evt_options *opt, const char *corelist)
 234 {
 235         int ret;
 236
 237         ret = parse_lcores_list(opt->wlcores, RTE_MAX_LCORE, corelist);
 238         if (ret == -E2BIG)
 239                 evt_err("duplicate lcores in wlcores");
 240
 241         return ret;
 242 }
 243
 244 static int
 245 evt_parse_mbuf_sz(struct evt_options *opt, const char *arg)
 246 {
 247         int ret;
 248
 249         ret = parser_read_uint16(&(opt->mbuf_sz), arg);
 250
 251         return ret;
 252 }
 253
 254 static int
 255 evt_parse_max_pkt_sz(struct evt_options *opt, const char *arg)
 256 {
 257         int ret;
 258
 259         ret = parser_read_uint32(&(opt->max_pkt_sz), arg);
 260
 261         return ret;
 262 }
 263
 264 static int
 265 evt_parse_ena_vector(struct evt_options *opt, const char *arg __rte_unused)
 266 {
 267         opt->ena_vector = 1;
 268         return 0;
 269 }
 270
 271 static int
 272 evt_parse_vector_size(struct evt_options *opt, const char *arg)
 273 {
 274         int ret;
 275
 276         ret = parser_read_uint16(&(opt->vector_size), arg);
 277
 278         return ret;
 279 }
 280
 281 static int
 282 evt_parse_vector_tmo_ns(struct evt_options *opt, const char *arg)
 283 {
 284         int ret;
 285
 286         ret = parser_read_uint64(&(opt->vector_tmo_nsec), arg);
 287
 288         return ret;
 289 }
 290
 291 static int
 292 evt_parse_eth_queues(struct evt_options *opt, const char *arg)
 293 {
 294         int ret;
 295
 296         ret = parser_read_uint16(&(opt->eth_queues), arg);
 297
 298         return ret;
 299 }
 300
 301 static int
 302 evt_parse_per_port_pool(struct evt_options *opt, const char *arg __rte_unused)
 303 {
 304         opt->per_port_pool = 1;
 305         return 0;
 306 }
 307
 308 static int
 309 evt_parse_prod_enq_burst_sz(struct evt_options *opt, const char *arg)
 310 {
 311         int ret;
 312
 313         ret = parser_read_uint32(&(opt->prod_enq_burst_sz), arg);
 314
 315         return ret;
 316 }
 317
 318 static void
 319 usage(char *program)
 320 {
 321         printf("usage : %s [EAL options] -- [application options]\n", program);
 322         printf("application options:\n");
 323         printf("\t--verbose          : verbose level\n"
 324                 "\t--dev              : device id of the event device\n"
 325                 "\t--test             : name of the test application to run\n"
 326                 "\t--socket_id        : socket_id of application resources\n"
 327                 "\t--pool_sz          : pool size of the mempool\n"
 328                 "\t--plcores          : list of lcore ids for producers\n"
 329                 "\t--wlcores          : list of lcore ids for workers\n"
 330                 "\t--stlist           : list of scheduled types of the stages\n"
 331                 "\t--nb_flows         : number of flows to produce\n"
 332                 "\t--nb_pkts          : number of packets to produce\n"
 333                 "\t--worker_deq_depth : dequeue depth of the worker\n"
 334                 "\t--fwd_latency      : perform fwd_latency measurement\n"
 335                 "\t--queue_priority   : enable queue priority\n"
 336                 "\t--deq_tmo_nsec     : global dequeue timeout\n"
 337                 "\t--prod_type_ethdev : use ethernet device as producer.\n"
 338                 "\t--prod_type_timerdev : use event timer device as producer.\n"
 339                 "\t                     expiry_nsec would be the timeout\n"
 340                 "\t                     in ns.\n"
 341                 "\t--prod_type_timerdev_burst : use timer device as producer\n"
 342                 "\t                             burst mode.\n"
 343                 "\t--nb_timers        : number of timers to arm.\n"
 344                 "\t--nb_timer_adptrs  : number of timer adapters to use.\n"
 345                 "\t--timer_tick_nsec  : timer tick interval in ns.\n"
 346                 "\t--max_tmo_nsec     : max timeout interval in ns.\n"
 347                 "\t--expiry_nsec      : event timer expiry ns.\n"
 348                 "\t--mbuf_sz          : packet mbuf size.\n"
 349                 "\t--max_pkt_sz       : max packet size.\n"
 350                 "\t--prod_enq_burst_sz : producer enqueue burst size.\n"
 351                 "\t--nb_eth_queues    : number of ethernet Rx queues.\n"
 352                 "\t--enable_vector    : enable event vectorization.\n"
 353                 "\t--vector_size      : Max vector size.\n"
 354                 "\t--vector_tmo_ns    : Max vector timeout in nanoseconds\n"
 355                 "\t--per_port_pool    : Configure unique pool per ethdev port\n"
 356                 );
 357         printf("available tests:\n");
 358         evt_test_dump_names();
 359 }
 360
 361 static int
 362 evt_parse_sched_type_list(struct evt_options *opt, const char *arg)
 363 {
 364         char c;
 365         int i = 0, j = -1;
 366
 367         for (i = 0; i < EVT_MAX_STAGES; i++)
 368                 opt->sched_type_list[i] = (uint8_t)-1;
 369
 370         i = 0;
 371
 372         do {
 373                 c = arg[++j];
 374
 375                 switch (c) {
 376                 case 'o':
 377                 case 'O':
 378                         opt->sched_type_list[i++] = RTE_SCHED_TYPE_ORDERED;
 379                         break;
 380                 case 'a':
 381                 case 'A':
 382                         opt->sched_type_list[i++] = RTE_SCHED_TYPE_ATOMIC;
 383                         break;
 384                 case 'p':
 385                 case 'P':
 386                         opt->sched_type_list[i++] = RTE_SCHED_TYPE_PARALLEL;
 387                         break;
 388                 case ',':
 389                         break;
 390                 default:
 391                         if (c != '\0') {
 392                                 evt_err("invalid sched_type %c", c);
 393                                 return -EINVAL;
 394                         }
 395                 }
 396         } while (c != '\0');
 397
 398         opt->nb_stages = i;
 399         return 0;
 400 }
 401
 402 static struct option lgopts[] = {
 403         { EVT_NB_FLOWS,            1, 0, 0 },
 404         { EVT_DEVICE,              1, 0, 0 },
 405         { EVT_VERBOSE,             1, 0, 0 },
 406         { EVT_TEST,                1, 0, 0 },
 407         { EVT_PROD_LCORES,         1, 0, 0 },
 408         { EVT_WORK_LCORES,         1, 0, 0 },
 409         { EVT_SOCKET_ID,           1, 0, 0 },
 410         { EVT_POOL_SZ,             1, 0, 0 },
 411         { EVT_NB_PKTS,             1, 0, 0 },
 412         { EVT_WKR_DEQ_DEP,         1, 0, 0 },
 413         { EVT_SCHED_TYPE_LIST,     1, 0, 0 },
 414         { EVT_FWD_LATENCY,         0, 0, 0 },
 415         { EVT_QUEUE_PRIORITY,      0, 0, 0 },
 416         { EVT_DEQ_TMO_NSEC,        1, 0, 0 },
 417         { EVT_PROD_ETHDEV,         0, 0, 0 },
 418         { EVT_PROD_TIMERDEV,       0, 0, 0 },
 419         { EVT_PROD_TIMERDEV_BURST, 0, 0, 0 },
 420         { EVT_NB_TIMERS,           1, 0, 0 },
 421         { EVT_NB_TIMER_ADPTRS,     1, 0, 0 },
 422         { EVT_TIMER_TICK_NSEC,     1, 0, 0 },
 423         { EVT_MAX_TMO_NSEC,        1, 0, 0 },
 424         { EVT_EXPIRY_NSEC,         1, 0, 0 },
 425         { EVT_MBUF_SZ,             1, 0, 0 },
 426         { EVT_MAX_PKT_SZ,          1, 0, 0 },
 427         { EVT_PROD_ENQ_BURST_SZ,   1, 0, 0 },
 428         { EVT_NB_ETH_QUEUES,       1, 0, 0 },
 429         { EVT_ENA_VECTOR,          0, 0, 0 },
 430         { EVT_VECTOR_SZ,           1, 0, 0 },
 431         { EVT_VECTOR_TMO,          1, 0, 0 },
 432         { EVT_PER_PORT_POOL,       0, 0, 0 },
 433         { EVT_HELP,                0, 0, 0 },
 434         { NULL,                    0, 0, 0 }
 435 };
 436
 437 static int
 438 evt_opts_parse_long(int opt_idx, struct evt_options *opt)
 439 {
 440         unsigned int i;
 441
 442         struct long_opt_parser parsermap[] = {
 443                 { EVT_NB_FLOWS, evt_parse_nb_flows},
 444                 { EVT_DEVICE, evt_parse_dev_id},
 445                 { EVT_VERBOSE, evt_parse_verbose},
 446                 { EVT_TEST, evt_parse_test_name},
 447                 { EVT_PROD_LCORES, evt_parse_plcores},
 448                 { EVT_WORK_LCORES, evt_parse_work_lcores},
 449                 { EVT_SOCKET_ID, evt_parse_socket_id},
 450                 { EVT_POOL_SZ, evt_parse_pool_sz},
 451                 { EVT_NB_PKTS, evt_parse_nb_pkts},
 452                 { EVT_WKR_DEQ_DEP, evt_parse_wkr_deq_dep},
 453                 { EVT_SCHED_TYPE_LIST, evt_parse_sched_type_list},
 454                 { EVT_FWD_LATENCY, evt_parse_fwd_latency},
 455                 { EVT_QUEUE_PRIORITY, evt_parse_queue_priority},
 456                 { EVT_DEQ_TMO_NSEC, evt_parse_deq_tmo_nsec},
 457                 { EVT_PROD_ETHDEV, evt_parse_eth_prod_type},
 458                 { EVT_PROD_TIMERDEV, evt_parse_timer_prod_type},
 459                 { EVT_PROD_TIMERDEV_BURST, evt_parse_timer_prod_type_burst},
 460                 { EVT_NB_TIMERS, evt_parse_nb_timers},
 461                 { EVT_NB_TIMER_ADPTRS, evt_parse_nb_timer_adptrs},
 462                 { EVT_TIMER_TICK_NSEC, evt_parse_timer_tick_nsec},
 463                 { EVT_MAX_TMO_NSEC, evt_parse_max_tmo_nsec},
 464                 { EVT_EXPIRY_NSEC, evt_parse_expiry_nsec},
 465                 { EVT_MBUF_SZ, evt_parse_mbuf_sz},
 466                 { EVT_MAX_PKT_SZ, evt_parse_max_pkt_sz},
 467                 { EVT_PROD_ENQ_BURST_SZ, evt_parse_prod_enq_burst_sz},
 468                 { EVT_NB_ETH_QUEUES, evt_parse_eth_queues},
 469                 { EVT_ENA_VECTOR, evt_parse_ena_vector},
 470                 { EVT_VECTOR_SZ, evt_parse_vector_size},
 471                 { EVT_VECTOR_TMO, evt_parse_vector_tmo_ns},
 472                 { EVT_PER_PORT_POOL, evt_parse_per_port_pool},
 473         };
 474
 475         for (i = 0; i < RTE_DIM(parsermap); i++) {
 476                 if (strncmp(lgopts[opt_idx].name, parsermap[i].lgopt_name,
 477                                 strlen(lgopts[opt_idx].name)) == 0)
 478                         return parsermap[i].parser_fn(opt, optarg);
 479         }
 480
 481         return -EINVAL;
 482 }
 483
 484 int
 485 evt_options_parse(struct evt_options *opt, int argc, char **argv)
 486 {
 487         int opts, retval, opt_idx;
 488
 489         while ((opts = getopt_long(argc, argv, "", lgopts, &opt_idx)) != EOF) {
 490                 switch (opts) {
 491                 case 0: /* long options */
 492                         if (!strcmp(lgopts[opt_idx].name, "help")) {
 493                                 usage(argv[0]);
 494                                 exit(EXIT_SUCCESS);
 495                         }
 496
 497                         retval = evt_opts_parse_long(opt_idx, opt);
 498                         if (retval != 0)
 499                                 return retval;
 500                         break;
 501                 default:
 502                         return -EINVAL;
 503                 }
 504         }
 505         return 0;
 506 }
 507
 508 void
 509 evt_options_dump(struct evt_options *opt)
 510 {
 511         int lcore_id;
 512         struct rte_event_dev_info dev_info;
 513
 514         rte_event_dev_info_get(opt->dev_id, &dev_info);
 515         evt_dump("driver", "%s", dev_info.driver_name);
 516         evt_dump("test", "%s", opt->test_name);
 517         evt_dump("dev", "%d", opt->dev_id);
 518         evt_dump("verbose_level", "%d", opt->verbose_level);
 519         evt_dump("socket_id", "%d", opt->socket_id);
 520         evt_dump("pool_sz", "%d", opt->pool_sz);
 521         evt_dump("main lcore", "%d", rte_get_main_lcore());
 522         evt_dump("nb_pkts", "%"PRIu64, opt->nb_pkts);
 523         evt_dump("nb_timers", "%"PRIu64, opt->nb_timers);
 524         evt_dump_begin("available lcores");
 525         RTE_LCORE_FOREACH(lcore_id)
 526                 printf("%d ", lcore_id);
 527         evt_dump_end;
 528         evt_dump_nb_flows(opt);
 529         evt_dump_worker_dequeue_depth(opt);
 530 }