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