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->wkr_deq_dep = 16;
  30         opt->nb_pkts = (1ULL << 26); /* do ~64M packets */
  31         opt->nb_timers = 1E8;
  32         opt->nb_timer_adptrs = 1;
  33         opt->timer_tick_nsec = 1E3; /* 1000ns ~ 1us */
  34         opt->max_tmo_nsec = 1E5;  /* 100000ns ~100us */
  35         opt->expiry_nsec = 1E4;   /* 10000ns ~10us */
  36         opt->prod_type = EVT_PROD_TYPE_SYNT;
  37 }
  38
  39 typedef int (*option_parser_t)(struct evt_options *opt,
  40                 const char *arg);
  41
  42 struct long_opt_parser {
  43         const char *lgopt_name;
  44         option_parser_t parser_fn;
  45 };
  46
  47 static int
  48 evt_parse_nb_flows(struct evt_options *opt, const char *arg)
  49 {
  50         int ret;
  51
  52         ret = parser_read_uint32(&(opt->nb_flows), arg);
  53
  54         return ret;
  55 }
  56
  57 static int
  58 evt_parse_dev_id(struct evt_options *opt, const char *arg)
  59 {
  60         int ret;
  61
  62         ret = parser_read_uint8(&(opt->dev_id), arg);
  63
  64         return ret;
  65 }
  66
  67 static int
  68 evt_parse_verbose(struct evt_options *opt, const char *arg __rte_unused)
  69 {
  70         opt->verbose_level = atoi(arg);
  71         return 0;
  72 }
  73
  74 static int
  75 evt_parse_fwd_latency(struct evt_options *opt, const char *arg __rte_unused)
  76 {
  77         opt->fwd_latency = 1;
  78         return 0;
  79 }
  80
  81 static int
  82 evt_parse_queue_priority(struct evt_options *opt, const char *arg __rte_unused)
  83 {
  84         opt->q_priority = 1;
  85         return 0;
  86 }
  87
  88 static int
  89 evt_parse_deq_tmo_nsec(struct evt_options *opt, const char *arg)
  90 {
  91         int ret;
  92
  93         ret = parser_read_uint32(&(opt->deq_tmo_nsec), arg);
  94
  95         return ret;
  96 }
  97
  98 static int
  99 evt_parse_eth_prod_type(struct evt_options *opt, const char *arg __rte_unused)
 100 {
 101         opt->prod_type = EVT_PROD_TYPE_ETH_RX_ADPTR;
 102         return 0;
 103 }
 104
 105 static int
 106 evt_parse_timer_prod_type(struct evt_options *opt, const char *arg __rte_unused)
 107 {
 108         opt->prod_type = EVT_PROD_TYPE_EVENT_TIMER_ADPTR;
 109         return 0;
 110 }
 111
 112 static int
 113 evt_parse_timer_prod_type_burst(struct evt_options *opt,
 114                 const char *arg __rte_unused)
 115 {
 116         opt->prod_type = EVT_PROD_TYPE_EVENT_TIMER_ADPTR;
 117         opt->timdev_use_burst = 1;
 118         return 0;
 119 }
 120
 121 static int
 122 evt_parse_test_name(struct evt_options *opt, const char *arg)
 123 {
 124         strlcpy(opt->test_name, arg, EVT_TEST_NAME_MAX_LEN);
 125         return 0;
 126 }
 127
 128 static int
 129 evt_parse_socket_id(struct evt_options *opt, const char *arg)
 130 {
 131         opt->socket_id = atoi(arg);
 132         return 0;
 133 }
 134
 135 static int
 136 evt_parse_wkr_deq_dep(struct evt_options *opt, const char *arg)
 137 {
 138         int ret;
 139
 140         ret = parser_read_uint16(&(opt->wkr_deq_dep), arg);
 141         return ret;
 142 }
 143
 144 static int
 145 evt_parse_nb_pkts(struct evt_options *opt, const char *arg)
 146 {
 147         int ret;
 148
 149         ret = parser_read_uint64(&(opt->nb_pkts), arg);
 150
 151         return ret;
 152 }
 153
 154 static int
 155 evt_parse_nb_timers(struct evt_options *opt, const char *arg)
 156 {
 157         int ret;
 158
 159         ret = parser_read_uint64(&(opt->nb_timers), arg);
 160
 161         return ret;
 162 }
 163
 164 static int
 165 evt_parse_timer_tick_nsec(struct evt_options *opt, const char *arg)
 166 {
 167         int ret;
 168
 169         ret = parser_read_uint64(&(opt->timer_tick_nsec), arg);
 170
 171         return ret;
 172 }
 173
 174 static int
 175 evt_parse_max_tmo_nsec(struct evt_options *opt, const char *arg)
 176 {
 177         int ret;
 178
 179         ret = parser_read_uint64(&(opt->max_tmo_nsec), arg);
 180
 181         return ret;
 182 }
 183
 184 static int
 185 evt_parse_expiry_nsec(struct evt_options *opt, const char *arg)
 186 {
 187         int ret;
 188
 189         ret = parser_read_uint64(&(opt->expiry_nsec), arg);
 190
 191         return ret;
 192 }
 193
 194 static int
 195 evt_parse_nb_timer_adptrs(struct evt_options *opt, const char *arg)
 196 {
 197         int ret;
 198
 199         ret = parser_read_uint8(&(opt->nb_timer_adptrs), arg);
 200
 201         return ret;
 202 }
 203
 204 static int
 205 evt_parse_pool_sz(struct evt_options *opt, const char *arg)
 206 {
 207         opt->pool_sz = atoi(arg);
 208
 209         return 0;
 210 }
 211
 212 static int
 213 evt_parse_plcores(struct evt_options *opt, const char *corelist)
 214 {
 215         int ret;
 216
 217         ret = parse_lcores_list(opt->plcores, corelist);
 218         if (ret == -E2BIG)
 219                 evt_err("duplicate lcores in plcores");
 220
 221         return ret;
 222 }
 223
 224 static int
 225 evt_parse_work_lcores(struct evt_options *opt, const char *corelist)
 226 {
 227         int ret;
 228
 229         ret = parse_lcores_list(opt->wlcores, corelist);
 230         if (ret == -E2BIG)
 231                 evt_err("duplicate lcores in wlcores");
 232
 233         return ret;
 234 }
 235
 236 static void
 237 usage(char *program)
 238 {
 239         printf("usage : %s [EAL options] -- [application options]\n", program);
 240         printf("application options:\n");
 241         printf("\t--verbose          : verbose level\n"
 242                 "\t--dev              : device id of the event device\n"
 243                 "\t--test             : name of the test application to run\n"
 244                 "\t--socket_id        : socket_id of application resources\n"
 245                 "\t--pool_sz          : pool size of the mempool\n"
 246                 "\t--plcores          : list of lcore ids for producers\n"
 247                 "\t--wlcores          : list of lcore ids for workers\n"
 248                 "\t--stlist           : list of scheduled types of the stages\n"
 249                 "\t--nb_flows         : number of flows to produce\n"
 250                 "\t--nb_pkts          : number of packets to produce\n"
 251                 "\t--worker_deq_depth : dequeue depth of the worker\n"
 252                 "\t--fwd_latency      : perform fwd_latency measurement\n"
 253                 "\t--queue_priority   : enable queue priority\n"
 254                 "\t--deq_tmo_nsec     : global dequeue timeout\n"
 255                 "\t--prod_type_ethdev : use ethernet device as producer.\n"
 256                 "\t--prod_type_timerdev : use event timer device as producer.\n"
 257                 "\t                     expity_nsec would be the timeout\n"
 258                 "\t                     in ns.\n"
 259                 "\t--prod_type_timerdev_burst : use timer device as producer\n"
 260                 "\t                             burst mode.\n"
 261                 "\t--nb_timers        : number of timers to arm.\n"
 262                 "\t--nb_timer_adptrs  : number of timer adapters to use.\n"
 263                 "\t--timer_tick_nsec  : timer tick interval in ns.\n"
 264                 "\t--max_tmo_nsec     : max timeout interval in ns.\n"
 265                 "\t--expiry_nsec        : event timer expiry ns.\n"
 266                 );
 267         printf("available tests:\n");
 268         evt_test_dump_names();
 269 }
 270
 271 static int
 272 evt_parse_sched_type_list(struct evt_options *opt, const char *arg)
 273 {
 274         char c;
 275         int i = 0, j = -1;
 276
 277         for (i = 0; i < EVT_MAX_STAGES; i++)
 278                 opt->sched_type_list[i] = (uint8_t)-1;
 279
 280         i = 0;
 281
 282         do {
 283                 c = arg[++j];
 284
 285                 switch (c) {
 286                 case 'o':
 287                 case 'O':
 288                         opt->sched_type_list[i++] = RTE_SCHED_TYPE_ORDERED;
 289                         break;
 290                 case 'a':
 291                 case 'A':
 292                         opt->sched_type_list[i++] = RTE_SCHED_TYPE_ATOMIC;
 293                         break;
 294                 case 'p':
 295                 case 'P':
 296                         opt->sched_type_list[i++] = RTE_SCHED_TYPE_PARALLEL;
 297                         break;
 298                 case ',':
 299                         break;
 300                 default:
 301                         if (c != '\0') {
 302                                 evt_err("invalid sched_type %c", c);
 303                                 return -EINVAL;
 304                         }
 305                 }
 306         } while (c != '\0');
 307
 308         opt->nb_stages = i;
 309         return 0;
 310 }
 311
 312 static struct option lgopts[] = {
 313         { EVT_NB_FLOWS,            1, 0, 0 },
 314         { EVT_DEVICE,              1, 0, 0 },
 315         { EVT_VERBOSE,             1, 0, 0 },
 316         { EVT_TEST,                1, 0, 0 },
 317         { EVT_PROD_LCORES,         1, 0, 0 },
 318         { EVT_WORK_LCORES,         1, 0, 0 },
 319         { EVT_SOCKET_ID,           1, 0, 0 },
 320         { EVT_POOL_SZ,             1, 0, 0 },
 321         { EVT_NB_PKTS,             1, 0, 0 },
 322         { EVT_WKR_DEQ_DEP,         1, 0, 0 },
 323         { EVT_SCHED_TYPE_LIST,     1, 0, 0 },
 324         { EVT_FWD_LATENCY,         0, 0, 0 },
 325         { EVT_QUEUE_PRIORITY,      0, 0, 0 },
 326         { EVT_DEQ_TMO_NSEC,        1, 0, 0 },
 327         { EVT_PROD_ETHDEV,         0, 0, 0 },
 328         { EVT_PROD_TIMERDEV,       0, 0, 0 },
 329         { EVT_PROD_TIMERDEV_BURST, 0, 0, 0 },
 330         { EVT_NB_TIMERS,           1, 0, 0 },
 331         { EVT_NB_TIMER_ADPTRS,     1, 0, 0 },
 332         { EVT_TIMER_TICK_NSEC,     1, 0, 0 },
 333         { EVT_MAX_TMO_NSEC,        1, 0, 0 },
 334         { EVT_EXPIRY_NSEC,         1, 0, 0 },
 335         { EVT_HELP,                0, 0, 0 },
 336         { NULL,                    0, 0, 0 }
 337 };
 338
 339 static int
 340 evt_opts_parse_long(int opt_idx, struct evt_options *opt)
 341 {
 342         unsigned int i;
 343
 344         struct long_opt_parser parsermap[] = {
 345                 { EVT_NB_FLOWS, evt_parse_nb_flows},
 346                 { EVT_DEVICE, evt_parse_dev_id},
 347                 { EVT_VERBOSE, evt_parse_verbose},
 348                 { EVT_TEST, evt_parse_test_name},
 349                 { EVT_PROD_LCORES, evt_parse_plcores},
 350                 { EVT_WORK_LCORES, evt_parse_work_lcores},
 351                 { EVT_SOCKET_ID, evt_parse_socket_id},
 352                 { EVT_POOL_SZ, evt_parse_pool_sz},
 353                 { EVT_NB_PKTS, evt_parse_nb_pkts},
 354                 { EVT_WKR_DEQ_DEP, evt_parse_wkr_deq_dep},
 355                 { EVT_SCHED_TYPE_LIST, evt_parse_sched_type_list},
 356                 { EVT_FWD_LATENCY, evt_parse_fwd_latency},
 357                 { EVT_QUEUE_PRIORITY, evt_parse_queue_priority},
 358                 { EVT_DEQ_TMO_NSEC, evt_parse_deq_tmo_nsec},
 359                 { EVT_PROD_ETHDEV, evt_parse_eth_prod_type},
 360                 { EVT_PROD_TIMERDEV, evt_parse_timer_prod_type},
 361                 { EVT_PROD_TIMERDEV_BURST, evt_parse_timer_prod_type_burst},
 362                 { EVT_NB_TIMERS, evt_parse_nb_timers},
 363                 { EVT_NB_TIMER_ADPTRS, evt_parse_nb_timer_adptrs},
 364                 { EVT_TIMER_TICK_NSEC, evt_parse_timer_tick_nsec},
 365                 { EVT_MAX_TMO_NSEC, evt_parse_max_tmo_nsec},
 366                 { EVT_EXPIRY_NSEC, evt_parse_expiry_nsec},
 367         };
 368
 369         for (i = 0; i < RTE_DIM(parsermap); i++) {
 370                 if (strncmp(lgopts[opt_idx].name, parsermap[i].lgopt_name,
 371                                 strlen(lgopts[opt_idx].name)) == 0)
 372                         return parsermap[i].parser_fn(opt, optarg);
 373         }
 374
 375         return -EINVAL;
 376 }
 377
 378 int
 379 evt_options_parse(struct evt_options *opt, int argc, char **argv)
 380 {
 381         int opts, retval, opt_idx;
 382
 383         while ((opts = getopt_long(argc, argv, "", lgopts, &opt_idx)) != EOF) {
 384                 switch (opts) {
 385                 case 0: /* long options */
 386                         if (!strcmp(lgopts[opt_idx].name, "help")) {
 387                                 usage(argv[0]);
 388                                 exit(EXIT_SUCCESS);
 389                         }
 390
 391                         retval = evt_opts_parse_long(opt_idx, opt);
 392                         if (retval != 0)
 393                                 return retval;
 394                         break;
 395                 default:
 396                         return -EINVAL;
 397                 }
 398         }
 399         return 0;
 400 }
 401
 402 void
 403 evt_options_dump(struct evt_options *opt)
 404 {
 405         int lcore_id;
 406         struct rte_event_dev_info dev_info;
 407
 408         rte_event_dev_info_get(opt->dev_id, &dev_info);
 409         evt_dump("driver", "%s", dev_info.driver_name);
 410         evt_dump("test", "%s", opt->test_name);
 411         evt_dump("dev", "%d", opt->dev_id);
 412         evt_dump("verbose_level", "%d", opt->verbose_level);
 413         evt_dump("socket_id", "%d", opt->socket_id);
 414         evt_dump("pool_sz", "%d", opt->pool_sz);
 415         evt_dump("master lcore", "%d", rte_get_master_lcore());
 416         evt_dump("nb_pkts", "%"PRIu64, opt->nb_pkts);
 417         evt_dump("nb_timers", "%"PRIu64, opt->nb_timers);
 418         evt_dump_begin("available lcores");
 419         RTE_LCORE_FOREACH(lcore_id)
 420                 printf("%d ", lcore_id);
 421         evt_dump_end;
 422         evt_dump_nb_flows(opt);
 423         evt_dump_worker_dequeue_depth(opt);
 424 }