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 int
 237 evt_parse_mbuf_sz(struct evt_options *opt, const char *arg)
 238 {
 239         int ret;
 240
 241         ret = parser_read_uint16(&(opt->mbuf_sz), arg);
 242
 243         return ret;
 244 }
 245
 246 static int
 247 evt_parse_max_pkt_sz(struct evt_options *opt, const char *arg)
 248 {
 249         int ret;
 250
 251         ret = parser_read_uint32(&(opt->max_pkt_sz), arg);
 252
 253         return ret;
 254 }
 255
 256 static void
 257 usage(char *program)
 258 {
 259         printf("usage : %s [EAL options] -- [application options]\n", program);
 260         printf("application options:\n");
 261         printf("\t--verbose          : verbose level\n"
 262                 "\t--dev              : device id of the event device\n"
 263                 "\t--test             : name of the test application to run\n"
 264                 "\t--socket_id        : socket_id of application resources\n"
 265                 "\t--pool_sz          : pool size of the mempool\n"
 266                 "\t--plcores          : list of lcore ids for producers\n"
 267                 "\t--wlcores          : list of lcore ids for workers\n"
 268                 "\t--stlist           : list of scheduled types of the stages\n"
 269                 "\t--nb_flows         : number of flows to produce\n"
 270                 "\t--nb_pkts          : number of packets to produce\n"
 271                 "\t--worker_deq_depth : dequeue depth of the worker\n"
 272                 "\t--fwd_latency      : perform fwd_latency measurement\n"
 273                 "\t--queue_priority   : enable queue priority\n"
 274                 "\t--deq_tmo_nsec     : global dequeue timeout\n"
 275                 "\t--prod_type_ethdev : use ethernet device as producer.\n"
 276                 "\t--prod_type_timerdev : use event timer device as producer.\n"
 277                 "\t                     expity_nsec would be the timeout\n"
 278                 "\t                     in ns.\n"
 279                 "\t--prod_type_timerdev_burst : use timer device as producer\n"
 280                 "\t                             burst mode.\n"
 281                 "\t--nb_timers        : number of timers to arm.\n"
 282                 "\t--nb_timer_adptrs  : number of timer adapters to use.\n"
 283                 "\t--timer_tick_nsec  : timer tick interval in ns.\n"
 284                 "\t--max_tmo_nsec     : max timeout interval in ns.\n"
 285                 "\t--expiry_nsec      : event timer expiry ns.\n"
 286                 "\t--mbuf_sz          : packet mbuf size.\n"
 287                 "\t--max_pkt_sz       : max packet size.\n"
 288                 );
 289         printf("available tests:\n");
 290         evt_test_dump_names();
 291 }
 292
 293 static int
 294 evt_parse_sched_type_list(struct evt_options *opt, const char *arg)
 295 {
 296         char c;
 297         int i = 0, j = -1;
 298
 299         for (i = 0; i < EVT_MAX_STAGES; i++)
 300                 opt->sched_type_list[i] = (uint8_t)-1;
 301
 302         i = 0;
 303
 304         do {
 305                 c = arg[++j];
 306
 307                 switch (c) {
 308                 case 'o':
 309                 case 'O':
 310                         opt->sched_type_list[i++] = RTE_SCHED_TYPE_ORDERED;
 311                         break;
 312                 case 'a':
 313                 case 'A':
 314                         opt->sched_type_list[i++] = RTE_SCHED_TYPE_ATOMIC;
 315                         break;
 316                 case 'p':
 317                 case 'P':
 318                         opt->sched_type_list[i++] = RTE_SCHED_TYPE_PARALLEL;
 319                         break;
 320                 case ',':
 321                         break;
 322                 default:
 323                         if (c != '\0') {
 324                                 evt_err("invalid sched_type %c", c);
 325                                 return -EINVAL;
 326                         }
 327                 }
 328         } while (c != '\0');
 329
 330         opt->nb_stages = i;
 331         return 0;
 332 }
 333
 334 static struct option lgopts[] = {
 335         { EVT_NB_FLOWS,            1, 0, 0 },
 336         { EVT_DEVICE,              1, 0, 0 },
 337         { EVT_VERBOSE,             1, 0, 0 },
 338         { EVT_TEST,                1, 0, 0 },
 339         { EVT_PROD_LCORES,         1, 0, 0 },
 340         { EVT_WORK_LCORES,         1, 0, 0 },
 341         { EVT_SOCKET_ID,           1, 0, 0 },
 342         { EVT_POOL_SZ,             1, 0, 0 },
 343         { EVT_NB_PKTS,             1, 0, 0 },
 344         { EVT_WKR_DEQ_DEP,         1, 0, 0 },
 345         { EVT_SCHED_TYPE_LIST,     1, 0, 0 },
 346         { EVT_FWD_LATENCY,         0, 0, 0 },
 347         { EVT_QUEUE_PRIORITY,      0, 0, 0 },
 348         { EVT_DEQ_TMO_NSEC,        1, 0, 0 },
 349         { EVT_PROD_ETHDEV,         0, 0, 0 },
 350         { EVT_PROD_TIMERDEV,       0, 0, 0 },
 351         { EVT_PROD_TIMERDEV_BURST, 0, 0, 0 },
 352         { EVT_NB_TIMERS,           1, 0, 0 },
 353         { EVT_NB_TIMER_ADPTRS,     1, 0, 0 },
 354         { EVT_TIMER_TICK_NSEC,     1, 0, 0 },
 355         { EVT_MAX_TMO_NSEC,        1, 0, 0 },
 356         { EVT_EXPIRY_NSEC,         1, 0, 0 },
 357         { EVT_MBUF_SZ,             1, 0, 0 },
 358         { EVT_MAX_PKT_SZ,          1, 0, 0 },
 359         { EVT_HELP,                0, 0, 0 },
 360         { NULL,                    0, 0, 0 }
 361 };
 362
 363 static int
 364 evt_opts_parse_long(int opt_idx, struct evt_options *opt)
 365 {
 366         unsigned int i;
 367
 368         struct long_opt_parser parsermap[] = {
 369                 { EVT_NB_FLOWS, evt_parse_nb_flows},
 370                 { EVT_DEVICE, evt_parse_dev_id},
 371                 { EVT_VERBOSE, evt_parse_verbose},
 372                 { EVT_TEST, evt_parse_test_name},
 373                 { EVT_PROD_LCORES, evt_parse_plcores},
 374                 { EVT_WORK_LCORES, evt_parse_work_lcores},
 375                 { EVT_SOCKET_ID, evt_parse_socket_id},
 376                 { EVT_POOL_SZ, evt_parse_pool_sz},
 377                 { EVT_NB_PKTS, evt_parse_nb_pkts},
 378                 { EVT_WKR_DEQ_DEP, evt_parse_wkr_deq_dep},
 379                 { EVT_SCHED_TYPE_LIST, evt_parse_sched_type_list},
 380                 { EVT_FWD_LATENCY, evt_parse_fwd_latency},
 381                 { EVT_QUEUE_PRIORITY, evt_parse_queue_priority},
 382                 { EVT_DEQ_TMO_NSEC, evt_parse_deq_tmo_nsec},
 383                 { EVT_PROD_ETHDEV, evt_parse_eth_prod_type},
 384                 { EVT_PROD_TIMERDEV, evt_parse_timer_prod_type},
 385                 { EVT_PROD_TIMERDEV_BURST, evt_parse_timer_prod_type_burst},
 386                 { EVT_NB_TIMERS, evt_parse_nb_timers},
 387                 { EVT_NB_TIMER_ADPTRS, evt_parse_nb_timer_adptrs},
 388                 { EVT_TIMER_TICK_NSEC, evt_parse_timer_tick_nsec},
 389                 { EVT_MAX_TMO_NSEC, evt_parse_max_tmo_nsec},
 390                 { EVT_EXPIRY_NSEC, evt_parse_expiry_nsec},
 391                 { EVT_MBUF_SZ, evt_parse_mbuf_sz},
 392                 { EVT_MAX_PKT_SZ, evt_parse_max_pkt_sz},
 393         };
 394
 395         for (i = 0; i < RTE_DIM(parsermap); i++) {
 396                 if (strncmp(lgopts[opt_idx].name, parsermap[i].lgopt_name,
 397                                 strlen(lgopts[opt_idx].name)) == 0)
 398                         return parsermap[i].parser_fn(opt, optarg);
 399         }
 400
 401         return -EINVAL;
 402 }
 403
 404 int
 405 evt_options_parse(struct evt_options *opt, int argc, char **argv)
 406 {
 407         int opts, retval, opt_idx;
 408
 409         while ((opts = getopt_long(argc, argv, "", lgopts, &opt_idx)) != EOF) {
 410                 switch (opts) {
 411                 case 0: /* long options */
 412                         if (!strcmp(lgopts[opt_idx].name, "help")) {
 413                                 usage(argv[0]);
 414                                 exit(EXIT_SUCCESS);
 415                         }
 416
 417                         retval = evt_opts_parse_long(opt_idx, opt);
 418                         if (retval != 0)
 419                                 return retval;
 420                         break;
 421                 default:
 422                         return -EINVAL;
 423                 }
 424         }
 425         return 0;
 426 }
 427
 428 void
 429 evt_options_dump(struct evt_options *opt)
 430 {
 431         int lcore_id;
 432         struct rte_event_dev_info dev_info;
 433
 434         rte_event_dev_info_get(opt->dev_id, &dev_info);
 435         evt_dump("driver", "%s", dev_info.driver_name);
 436         evt_dump("test", "%s", opt->test_name);
 437         evt_dump("dev", "%d", opt->dev_id);
 438         evt_dump("verbose_level", "%d", opt->verbose_level);
 439         evt_dump("socket_id", "%d", opt->socket_id);
 440         evt_dump("pool_sz", "%d", opt->pool_sz);
 441         evt_dump("master lcore", "%d", rte_get_master_lcore());
 442         evt_dump("nb_pkts", "%"PRIu64, opt->nb_pkts);
 443         evt_dump("nb_timers", "%"PRIu64, opt->nb_timers);
 444         evt_dump_begin("available lcores");
 445         RTE_LCORE_FOREACH(lcore_id)
 446                 printf("%d ", lcore_id);
 447         evt_dump_end;
 448         evt_dump_nb_flows(opt);
 449         evt_dump_worker_dequeue_depth(opt);
 450 }