1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016 Intel Corporation
16 #include <rte_common.h>
17 #include <rte_debug.h>
18 #include <rte_ethdev.h>
19 #include <rte_memory.h>
20 #include <rte_lcore.h>
21 #include <rte_branch_prediction.h>
22 #include <rte_errno.h>
24 #include <rte_kvargs.h>
25 #include <rte_mempool.h>
27 #include <rte_string_fns.h>
28 #include <rte_pdump.h>
30 #define CMD_LINE_OPT_PDUMP "pdump"
31 #define PDUMP_PORT_ARG "port"
32 #define PDUMP_PCI_ARG "device_id"
33 #define PDUMP_QUEUE_ARG "queue"
34 #define PDUMP_DIR_ARG "dir"
35 #define PDUMP_RX_DEV_ARG "rx-dev"
36 #define PDUMP_TX_DEV_ARG "tx-dev"
37 #define PDUMP_RING_SIZE_ARG "ring-size"
38 #define PDUMP_MSIZE_ARG "mbuf-size"
39 #define PDUMP_NUM_MBUFS_ARG "total-num-mbufs"
40 #define CMD_LINE_OPT_SER_SOCK_PATH "server-socket-path"
41 #define CMD_LINE_OPT_CLI_SOCK_PATH "client-socket-path"
43 #define VDEV_PCAP "net_pcap_%s_%d,tx_pcap=%s"
44 #define VDEV_IFACE "net_pcap_%s_%d,tx_iface=%s"
45 #define TX_STREAM_SIZE 64
47 #define MP_NAME "pdump_pool_%d"
49 #define RX_RING "rx_ring_%d"
50 #define TX_RING "tx_ring_%d"
55 /* Maximum long option length for option parsing. */
56 #define APP_ARG_TCPDUMP_MAX_TUPLES 54
57 #define MBUF_POOL_CACHE_SIZE 250
58 #define TX_DESC_PER_QUEUE 512
59 #define RX_DESC_PER_QUEUE 128
60 #define MBUFS_PER_POOL 65535
61 #define MAX_LONG_OPT_SZ 64
62 #define RING_SIZE 16384
67 /* true if x is a power of 2 */
68 #define POWEROF2(x) ((((x)-1) & (x)) == 0)
85 const char *valid_pdump_arguments[] = {
99 uint64_t dequeue_pkts;
104 struct pdump_tuples {
109 char rx_dev[TX_STREAM_SIZE];
110 char tx_dev[TX_STREAM_SIZE];
112 uint16_t mbuf_data_size;
113 uint32_t total_num_mbufs;
115 /* params for library API call */
117 struct rte_mempool *mp;
118 struct rte_ring *rx_ring;
119 struct rte_ring *tx_ring;
121 /* params for packet dumping */
122 enum pdump_by dump_by_type;
125 enum pcap_stream rx_vdev_stream_type;
126 enum pcap_stream tx_vdev_stream_type;
127 bool single_pdump_dev;
130 struct pdump_stats stats;
131 } __rte_cache_aligned;
132 static struct pdump_tuples pdump_t[APP_ARG_TCPDUMP_MAX_TUPLES];
141 static struct rte_eth_conf port_conf_default;
142 volatile uint8_t quit_signal;
143 static char server_socket_path[PATH_MAX];
144 static char client_socket_path[PATH_MAX];
146 /**< display usage */
148 pdump_usage(const char *prgname)
150 printf("usage: %s [EAL options] -- --pdump "
151 "'(port=<port id> | device_id=<pci id or vdev name>),"
152 "(queue=<queue_id>),"
153 "(rx-dev=<iface or pcap file> |"
154 " tx-dev=<iface or pcap file>,"
155 "[ring-size=<ring size>default:16384],"
156 "[mbuf-size=<mbuf data size>default:2176],"
157 "[total-num-mbufs=<number of mbufs>default:65535]'\n"
158 "[--server-socket-path=<server socket dir>"
159 "default:/var/run/.dpdk/ (or) ~/.dpdk/]\n"
160 "[--client-socket-path=<client socket dir>"
161 "default:/var/run/.dpdk/ (or) ~/.dpdk/]\n",
166 parse_device_id(const char *key __rte_unused, const char *value,
169 struct pdump_tuples *pt = extra_args;
171 pt->device_id = strdup(value);
172 pt->dump_by_type = DEVICE_ID;
178 parse_queue(const char *key __rte_unused, const char *value, void *extra_args)
181 struct pdump_tuples *pt = extra_args;
183 if (!strcmp(value, "*"))
184 pt->queue = RTE_PDUMP_ALL_QUEUES;
186 n = strtoul(value, NULL, 10);
187 pt->queue = (uint16_t) n;
193 parse_rxtxdev(const char *key, const char *value, void *extra_args)
196 struct pdump_tuples *pt = extra_args;
198 if (!strcmp(key, PDUMP_RX_DEV_ARG)) {
199 snprintf(pt->rx_dev, sizeof(pt->rx_dev), "%s", value);
200 /* identify the tx stream type for pcap vdev */
201 if (if_nametoindex(pt->rx_dev))
202 pt->rx_vdev_stream_type = IFACE;
203 } else if (!strcmp(key, PDUMP_TX_DEV_ARG)) {
204 snprintf(pt->tx_dev, sizeof(pt->tx_dev), "%s", value);
205 /* identify the tx stream type for pcap vdev */
206 if (if_nametoindex(pt->tx_dev))
207 pt->tx_vdev_stream_type = IFACE;
214 parse_uint_value(const char *key, const char *value, void *extra_args)
223 t = strtoul(value, &end, 10);
225 if (errno != 0 || end[0] != 0 || t < v->min || t > v->max) {
226 printf("invalid value:\"%s\" for key:\"%s\", "
227 "value must be >= %"PRIu64" and <= %"PRIu64"\n",
228 value, key, v->min, v->max);
231 if (!strcmp(key, PDUMP_RING_SIZE_ARG) && !POWEROF2(t)) {
232 printf("invalid value:\"%s\" for key:\"%s\", "
233 "value must be power of 2\n", value, key);
245 parse_pdump(const char *optarg)
247 struct rte_kvargs *kvlist;
248 int ret = 0, cnt1, cnt2;
249 struct pdump_tuples *pt;
250 struct parse_val v = {0};
252 pt = &pdump_t[num_tuples];
254 /* initial check for invalid arguments */
255 kvlist = rte_kvargs_parse(optarg, valid_pdump_arguments);
256 if (kvlist == NULL) {
257 printf("--pdump=\"%s\": invalid argument passed\n", optarg);
261 /* port/device_id parsing and validation */
262 cnt1 = rte_kvargs_count(kvlist, PDUMP_PORT_ARG);
263 cnt2 = rte_kvargs_count(kvlist, PDUMP_PCI_ARG);
264 if (!((cnt1 == 1 && cnt2 == 0) || (cnt1 == 0 && cnt2 == 1))) {
265 printf("--pdump=\"%s\": must have either port or "
266 "device_id argument\n", optarg);
269 } else if (cnt1 == 1) {
271 v.max = RTE_MAX_ETHPORTS-1;
272 ret = rte_kvargs_process(kvlist, PDUMP_PORT_ARG,
273 &parse_uint_value, &v);
276 pt->port = (uint8_t) v.val;
277 pt->dump_by_type = PORT_ID;
278 } else if (cnt2 == 1) {
279 ret = rte_kvargs_process(kvlist, PDUMP_PCI_ARG,
280 &parse_device_id, pt);
285 /* queue parsing and validation */
286 cnt1 = rte_kvargs_count(kvlist, PDUMP_QUEUE_ARG);
288 printf("--pdump=\"%s\": must have queue argument\n", optarg);
292 ret = rte_kvargs_process(kvlist, PDUMP_QUEUE_ARG, &parse_queue, pt);
296 /* rx-dev and tx-dev parsing and validation */
297 cnt1 = rte_kvargs_count(kvlist, PDUMP_RX_DEV_ARG);
298 cnt2 = rte_kvargs_count(kvlist, PDUMP_TX_DEV_ARG);
299 if (cnt1 == 0 && cnt2 == 0) {
300 printf("--pdump=\"%s\": must have either rx-dev or "
301 "tx-dev argument\n", optarg);
304 } else if (cnt1 == 1 && cnt2 == 1) {
305 ret = rte_kvargs_process(kvlist, PDUMP_RX_DEV_ARG,
309 ret = rte_kvargs_process(kvlist, PDUMP_TX_DEV_ARG,
313 /* if captured packets has to send to the same vdev */
314 if (!strcmp(pt->rx_dev, pt->tx_dev))
315 pt->single_pdump_dev = true;
316 pt->dir = RTE_PDUMP_FLAG_RXTX;
317 } else if (cnt1 == 1) {
318 ret = rte_kvargs_process(kvlist, PDUMP_RX_DEV_ARG,
322 pt->dir = RTE_PDUMP_FLAG_RX;
323 } else if (cnt2 == 1) {
324 ret = rte_kvargs_process(kvlist, PDUMP_TX_DEV_ARG,
328 pt->dir = RTE_PDUMP_FLAG_TX;
332 /* ring_size parsing and validation */
333 cnt1 = rte_kvargs_count(kvlist, PDUMP_RING_SIZE_ARG);
336 v.max = RTE_RING_SZ_MASK-1;
337 ret = rte_kvargs_process(kvlist, PDUMP_RING_SIZE_ARG,
338 &parse_uint_value, &v);
341 pt->ring_size = (uint32_t) v.val;
343 pt->ring_size = RING_SIZE;
345 /* mbuf_data_size parsing and validation */
346 cnt1 = rte_kvargs_count(kvlist, PDUMP_MSIZE_ARG);
350 ret = rte_kvargs_process(kvlist, PDUMP_MSIZE_ARG,
351 &parse_uint_value, &v);
354 pt->mbuf_data_size = (uint16_t) v.val;
356 pt->mbuf_data_size = RTE_MBUF_DEFAULT_BUF_SIZE;
358 /* total_num_mbufs parsing and validation */
359 cnt1 = rte_kvargs_count(kvlist, PDUMP_NUM_MBUFS_ARG);
363 ret = rte_kvargs_process(kvlist, PDUMP_NUM_MBUFS_ARG,
364 &parse_uint_value, &v);
367 pt->total_num_mbufs = (uint16_t) v.val;
369 pt->total_num_mbufs = MBUFS_PER_POOL;
374 rte_kvargs_free(kvlist);
378 /* Parse the argument given in the command line of the application */
380 launch_args_parse(int argc, char **argv, char *prgname)
384 static struct option long_option[] = {
386 {"server-socket-path", 1, 0, 0},
387 {"client-socket-path", 1, 0, 0},
392 pdump_usage(prgname);
394 /* Parse command line */
395 while ((opt = getopt_long(argc, argv, " ",
396 long_option, &option_index)) != EOF) {
399 if (!strncmp(long_option[option_index].name,
401 sizeof(CMD_LINE_OPT_PDUMP))) {
402 ret = parse_pdump(optarg);
404 pdump_usage(prgname);
409 if (!strncmp(long_option[option_index].name,
410 CMD_LINE_OPT_SER_SOCK_PATH,
411 sizeof(CMD_LINE_OPT_SER_SOCK_PATH))) {
412 strlcpy(server_socket_path, optarg,
413 sizeof(server_socket_path));
416 if (!strncmp(long_option[option_index].name,
417 CMD_LINE_OPT_CLI_SOCK_PATH,
418 sizeof(CMD_LINE_OPT_CLI_SOCK_PATH))) {
419 strlcpy(client_socket_path, optarg,
420 sizeof(client_socket_path));
425 pdump_usage(prgname);
434 print_pdump_stats(void)
437 struct pdump_tuples *pt;
439 for (i = 0; i < num_tuples; i++) {
440 printf("##### PDUMP DEBUG STATS #####\n");
442 printf(" -packets dequeued: %"PRIu64"\n",
443 pt->stats.dequeue_pkts);
444 printf(" -packets transmitted to vdev: %"PRIu64"\n",
446 printf(" -packets freed: %"PRIu64"\n",
447 pt->stats.freed_pkts);
452 disable_pdump(struct pdump_tuples *pt)
454 if (pt->dump_by_type == DEVICE_ID)
455 rte_pdump_disable_by_deviceid(pt->device_id, pt->queue,
457 else if (pt->dump_by_type == PORT_ID)
458 rte_pdump_disable(pt->port, pt->queue, pt->dir);
462 pdump_rxtx(struct rte_ring *ring, uint8_t vdev_id, struct pdump_stats *stats)
464 /* write input packets of port to vdev for pdump */
465 struct rte_mbuf *rxtx_bufs[BURST_SIZE];
467 /* first dequeue packets from ring of primary process */
468 const uint16_t nb_in_deq = rte_ring_dequeue_burst(ring,
469 (void *)rxtx_bufs, BURST_SIZE, NULL);
470 stats->dequeue_pkts += nb_in_deq;
473 /* then sent on vdev */
474 uint16_t nb_in_txd = rte_eth_tx_burst(
476 0, rxtx_bufs, nb_in_deq);
477 stats->tx_pkts += nb_in_txd;
479 if (unlikely(nb_in_txd < nb_in_deq)) {
481 rte_pktmbuf_free(rxtx_bufs[nb_in_txd]);
483 } while (++nb_in_txd < nb_in_deq);
489 free_ring_data(struct rte_ring *ring, uint8_t vdev_id,
490 struct pdump_stats *stats)
492 while (rte_ring_count(ring))
493 pdump_rxtx(ring, vdev_id, stats);
500 struct pdump_tuples *pt;
502 for (i = 0; i < num_tuples; i++) {
510 rte_ring_free(pt->rx_ring);
512 rte_ring_free(pt->tx_ring);
517 cleanup_pdump_resources(void)
520 struct pdump_tuples *pt;
522 /* disable pdump and free the pdump_tuple resources */
523 for (i = 0; i < num_tuples; i++) {
526 /* remove callbacks */
530 * transmit rest of the enqueued packets of the rings on to
531 * the vdev, in order to release mbufs to the mepool.
533 if (pt->dir & RTE_PDUMP_FLAG_RX)
534 free_ring_data(pt->rx_ring, pt->rx_vdev_id, &pt->stats);
535 if (pt->dir & RTE_PDUMP_FLAG_TX)
536 free_ring_data(pt->tx_ring, pt->tx_vdev_id, &pt->stats);
542 signal_handler(int sig_num)
544 if (sig_num == SIGINT) {
545 printf("\n\nSignal %d received, preparing to exit...\n",
552 configure_vdev(uint16_t port_id)
554 struct ether_addr addr;
555 const uint16_t rxRings = 0, txRings = 1;
556 const uint8_t nb_ports = rte_eth_dev_count();
560 if (port_id > nb_ports)
563 ret = rte_eth_dev_configure(port_id, rxRings, txRings,
566 rte_exit(EXIT_FAILURE, "dev config failed\n");
568 for (q = 0; q < txRings; q++) {
569 ret = rte_eth_tx_queue_setup(port_id, q, TX_DESC_PER_QUEUE,
570 rte_eth_dev_socket_id(port_id), NULL);
572 rte_exit(EXIT_FAILURE, "queue setup failed\n");
575 ret = rte_eth_dev_start(port_id);
577 rte_exit(EXIT_FAILURE, "dev start failed\n");
579 rte_eth_macaddr_get(port_id, &addr);
580 printf("Port %u MAC: %02"PRIx8" %02"PRIx8" %02"PRIx8
581 " %02"PRIx8" %02"PRIx8" %02"PRIx8"\n",
583 addr.addr_bytes[0], addr.addr_bytes[1],
584 addr.addr_bytes[2], addr.addr_bytes[3],
585 addr.addr_bytes[4], addr.addr_bytes[5]);
587 rte_eth_promiscuous_enable(port_id);
593 create_mp_ring_vdev(void)
597 struct pdump_tuples *pt = NULL;
598 struct rte_mempool *mbuf_pool = NULL;
599 char vdev_args[SIZE];
600 char ring_name[SIZE];
601 char mempool_name[SIZE];
603 for (i = 0; i < num_tuples; i++) {
605 snprintf(mempool_name, SIZE, MP_NAME, i);
606 mbuf_pool = rte_mempool_lookup(mempool_name);
607 if (mbuf_pool == NULL) {
609 mbuf_pool = rte_pktmbuf_pool_create(mempool_name,
611 MBUF_POOL_CACHE_SIZE, 0,
614 if (mbuf_pool == NULL) {
616 rte_exit(EXIT_FAILURE,
617 "Mempool creation failed: %s\n",
618 rte_strerror(rte_errno));
623 if (pt->dir == RTE_PDUMP_FLAG_RXTX) {
624 /* if captured packets has to send to the same vdev */
626 snprintf(ring_name, SIZE, RX_RING, i);
627 pt->rx_ring = rte_ring_create(ring_name, pt->ring_size,
629 if (pt->rx_ring == NULL) {
631 rte_exit(EXIT_FAILURE, "%s:%s:%d\n",
632 rte_strerror(rte_errno),
637 snprintf(ring_name, SIZE, TX_RING, i);
638 pt->tx_ring = rte_ring_create(ring_name, pt->ring_size,
640 if (pt->tx_ring == NULL) {
642 rte_exit(EXIT_FAILURE, "%s:%s:%d\n",
643 rte_strerror(rte_errno),
648 (pt->rx_vdev_stream_type == IFACE) ?
649 snprintf(vdev_args, SIZE, VDEV_IFACE, RX_STR, i,
651 snprintf(vdev_args, SIZE, VDEV_PCAP, RX_STR, i,
653 if (rte_eth_dev_attach(vdev_args, &portid) < 0) {
655 rte_exit(EXIT_FAILURE,
656 "vdev creation failed:%s:%d\n",
659 pt->rx_vdev_id = portid;
662 configure_vdev(pt->rx_vdev_id);
664 if (pt->single_pdump_dev)
665 pt->tx_vdev_id = portid;
667 (pt->tx_vdev_stream_type == IFACE) ?
668 snprintf(vdev_args, SIZE, VDEV_IFACE, TX_STR, i,
670 snprintf(vdev_args, SIZE, VDEV_PCAP, TX_STR, i,
672 if (rte_eth_dev_attach(vdev_args,
675 rte_exit(EXIT_FAILURE,
676 "vdev creation failed:"
677 "%s:%d\n", __func__, __LINE__);
679 pt->tx_vdev_id = portid;
682 configure_vdev(pt->tx_vdev_id);
684 } else if (pt->dir == RTE_PDUMP_FLAG_RX) {
687 snprintf(ring_name, SIZE, RX_RING, i);
688 pt->rx_ring = rte_ring_create(ring_name, pt->ring_size,
690 if (pt->rx_ring == NULL) {
692 rte_exit(EXIT_FAILURE, "%s\n",
693 rte_strerror(rte_errno));
696 (pt->rx_vdev_stream_type == IFACE) ?
697 snprintf(vdev_args, SIZE, VDEV_IFACE, RX_STR, i,
699 snprintf(vdev_args, SIZE, VDEV_PCAP, RX_STR, i,
701 if (rte_eth_dev_attach(vdev_args, &portid) < 0) {
703 rte_exit(EXIT_FAILURE,
704 "vdev creation failed:%s:%d\n",
707 pt->rx_vdev_id = portid;
709 configure_vdev(pt->rx_vdev_id);
710 } else if (pt->dir == RTE_PDUMP_FLAG_TX) {
713 snprintf(ring_name, SIZE, TX_RING, i);
714 pt->tx_ring = rte_ring_create(ring_name, pt->ring_size,
716 if (pt->tx_ring == NULL) {
718 rte_exit(EXIT_FAILURE, "%s\n",
719 rte_strerror(rte_errno));
722 (pt->tx_vdev_stream_type == IFACE) ?
723 snprintf(vdev_args, SIZE, VDEV_IFACE, TX_STR, i,
725 snprintf(vdev_args, SIZE, VDEV_PCAP, TX_STR, i,
727 if (rte_eth_dev_attach(vdev_args, &portid) < 0) {
729 rte_exit(EXIT_FAILURE,
730 "vdev creation failed\n");
732 pt->tx_vdev_id = portid;
735 configure_vdev(pt->tx_vdev_id);
744 struct pdump_tuples *pt;
745 int ret = 0, ret1 = 0;
747 if (server_socket_path[0] != 0)
748 ret = rte_pdump_set_socket_dir(server_socket_path,
749 RTE_PDUMP_SOCKET_SERVER);
750 if (ret == 0 && client_socket_path[0] != 0) {
751 ret = rte_pdump_set_socket_dir(client_socket_path,
752 RTE_PDUMP_SOCKET_CLIENT);
755 cleanup_pdump_resources();
756 rte_exit(EXIT_FAILURE,
757 "failed to set socket paths of server:%s, "
763 for (i = 0; i < num_tuples; i++) {
765 if (pt->dir == RTE_PDUMP_FLAG_RXTX) {
766 if (pt->dump_by_type == DEVICE_ID) {
767 ret = rte_pdump_enable_by_deviceid(
773 ret1 = rte_pdump_enable_by_deviceid(
779 } else if (pt->dump_by_type == PORT_ID) {
780 ret = rte_pdump_enable(pt->port, pt->queue,
782 pt->rx_ring, pt->mp, NULL);
783 ret1 = rte_pdump_enable(pt->port, pt->queue,
785 pt->tx_ring, pt->mp, NULL);
787 } else if (pt->dir == RTE_PDUMP_FLAG_RX) {
788 if (pt->dump_by_type == DEVICE_ID)
789 ret = rte_pdump_enable_by_deviceid(
792 pt->dir, pt->rx_ring,
794 else if (pt->dump_by_type == PORT_ID)
795 ret = rte_pdump_enable(pt->port, pt->queue,
797 pt->rx_ring, pt->mp, NULL);
798 } else if (pt->dir == RTE_PDUMP_FLAG_TX) {
799 if (pt->dump_by_type == DEVICE_ID)
800 ret = rte_pdump_enable_by_deviceid(
804 pt->tx_ring, pt->mp, NULL);
805 else if (pt->dump_by_type == PORT_ID)
806 ret = rte_pdump_enable(pt->port, pt->queue,
808 pt->tx_ring, pt->mp, NULL);
810 if (ret < 0 || ret1 < 0) {
811 cleanup_pdump_resources();
812 rte_exit(EXIT_FAILURE, "%s\n", rte_strerror(rte_errno));
821 struct pdump_tuples *pt;
823 while (!quit_signal) {
824 for (i = 0; i < num_tuples; i++) {
826 if (pt->dir & RTE_PDUMP_FLAG_RX)
827 pdump_rxtx(pt->rx_ring, pt->rx_vdev_id,
829 if (pt->dir & RTE_PDUMP_FLAG_TX)
830 pdump_rxtx(pt->tx_ring, pt->tx_vdev_id,
837 main(int argc, char **argv)
843 char c_flag[] = "-c1";
844 char n_flag[] = "-n4";
845 char mp_flag[] = "--proc-type=secondary";
846 char *argp[argc + 3];
848 /* catch ctrl-c so we can print on exit */
849 signal(SIGINT, signal_handler);
856 for (i = 1; i < argc; i++)
857 argp[i + 3] = argv[i];
861 diag = rte_eal_init(argc, argp);
863 rte_panic("Cannot init EAL\n");
868 /* parse app arguments */
870 ret = launch_args_parse(argc, argv, argp[0]);
872 rte_exit(EXIT_FAILURE, "Invalid argument\n");
875 /* create mempool, ring and vdevs info */
876 create_mp_ring_vdev();
880 cleanup_pdump_resources();
881 /* dump debug stats */
884 ret = rte_eal_cleanup();
886 printf("Error from rte_eal_cleanup(), %d\n", ret);