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