test/pcapng: test pcapng library

Simple unit test that created pcapng file using API.

To run this test you need to have at least one device.
For example:

DPDK_TEST=pcapng_autotest ./build/app/test/dpdk-test -l 0-15 \
    --no-huge -m 2048 --vdev=net_tap,iface=dummy

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>

MAINTAINERS

@@ -1437,6 +1437,7 @@ F: doc/guides/prog_guide/pdump_lib.rst
 F: app/test/test_pdump.*
 F: lib/pcapng/
 F: doc/guides/prog_guide/pcapng_lib.rst
+F: app/test/test_pcapng.c
 F: app/pdump/
 F: doc/guides/tools/pdump.rst
 

app/test/meson.build

@@ -402,6 +402,10 @@ if dpdk_conf.has('RTE_NET_RING')
     fast_tests += [['pdump_autotest', true]]
 endif
 
+if dpdk_conf.has('RTE_PORT_PCAP')
+    test_sources += 'test_pcapng.c'
+endif
+
 if dpdk_conf.has('RTE_LIB_POWER')
     test_deps += 'power'
 endif

app/test/test_pcapng.c

@@ -0,0 +1,270 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright (c) 2021 Microsoft Corporation
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <unistd.h>
+
+#include <rte_ethdev.h>
+#include <rte_ether.h>
+#include <rte_mbuf.h>
+#include <rte_mempool.h>
+#include <rte_net.h>
+#include <rte_pcapng.h>
+
+#include <pcap/pcap.h>
+
+#include "test.h"
+
+#define NUM_PACKETS    10
+#define DUMMY_MBUF_NUM 3
+
+static rte_pcapng_t *pcapng;
+static struct rte_mempool *mp;
+static const uint32_t pkt_len = 200;
+static uint16_t port_id;
+static char file_name[] = "/tmp/pcapng_test_XXXXXX.pcapng";
+
+/* first mbuf in the packet, should always be at offset 0 */
+struct dummy_mbuf {
+	struct rte_mbuf mb[DUMMY_MBUF_NUM];
+	uint8_t buf[DUMMY_MBUF_NUM][RTE_MBUF_DEFAULT_BUF_SIZE];
+};
+
+static void
+dummy_mbuf_prep(struct rte_mbuf *mb, uint8_t buf[], uint32_t buf_len,
+	uint32_t data_len)
+{
+	uint32_t i;
+	uint8_t *db;
+
+	mb->buf_addr = buf;
+	mb->buf_iova = (uintptr_t)buf;
+	mb->buf_len = buf_len;
+	rte_mbuf_refcnt_set(mb, 1);
+
+	/* set pool pointer to dummy value, test doesn't use it */
+	mb->pool = (void *)buf;
+
+	rte_pktmbuf_reset(mb);
+	db = (uint8_t *)rte_pktmbuf_append(mb, data_len);
+
+	for (i = 0; i != data_len; i++)
+		db[i] = i;
+}
+
+/* Make an IP packet consisting of chain of one packets */
+static void
+mbuf1_prepare(struct dummy_mbuf *dm, uint32_t plen)
+{
+	struct {
+		struct rte_ether_hdr eth;
+		struct rte_ipv4_hdr ip;
+	} pkt = {
+		.eth = {
+			.dst_addr.addr_bytes = "\xff\xff\xff\xff\xff\xff",
+			.ether_type = rte_cpu_to_be_16(RTE_ETHER_TYPE_IPV4),
+		},
+		.ip = {
+			.version_ihl = RTE_IPV4_VHL_DEF,
+			.total_length = rte_cpu_to_be_16(plen),
+			.time_to_live = IPDEFTTL,
+			.next_proto_id = IPPROTO_RAW,
+			.src_addr = rte_cpu_to_be_32(RTE_IPV4_LOOPBACK),
+			.dst_addr = rte_cpu_to_be_32(RTE_IPV4_BROADCAST),
+		}
+	};
+
+	memset(dm, 0, sizeof(*dm));
+	dummy_mbuf_prep(&dm->mb[0], dm->buf[0], sizeof(dm->buf[0]), plen);
+
+	rte_eth_random_addr(pkt.eth.src_addr.addr_bytes);
+	memcpy(rte_pktmbuf_mtod(dm->mb, void *), &pkt, RTE_MIN(sizeof(pkt), plen));
+}
+
+static int
+test_setup(void)
+{
+	int tmp_fd;
+
+	port_id = rte_eth_find_next(0);
+	if (port_id >= RTE_MAX_ETHPORTS) {
+		fprintf(stderr, "No valid Ether port\n");
+		return -1;
+	}
+
+	tmp_fd = mkstemps(file_name, strlen(".pcapng"));
+	if (tmp_fd == -1) {
+		perror("mkstemps() failure");
+		return -1;
+	}
+	printf("pcapng: output file %s\n", file_name);
+
+	/* open a test capture file */
+	pcapng = rte_pcapng_fdopen(tmp_fd, NULL, NULL, "pcapng_test", NULL);
+	if (pcapng == NULL) {
+		fprintf(stderr, "rte_pcapng_fdopen failed\n");
+		close(tmp_fd);
+		return -1;
+	}
+
+	/* Make a pool for cloned packeets */
+	mp = rte_pktmbuf_pool_create_by_ops("pcapng_test_pool", NUM_PACKETS,
+					    0, 0,
+					    rte_pcapng_mbuf_size(pkt_len),
+					    SOCKET_ID_ANY, "ring_mp_sc");
+	if (mp == NULL) {
+		fprintf(stderr, "Cannot create mempool\n");
+		return -1;
+	}
+	return 0;
+}
+
+static int
+test_write_packets(void)
+{
+	struct rte_mbuf *orig;
+	struct rte_mbuf *clones[NUM_PACKETS] = { };
+	struct dummy_mbuf mbfs;
+	unsigned int i;
+	ssize_t len;
+
+	/* make a dummy packet */
+	mbuf1_prepare(&mbfs, pkt_len);
+
+	/* clone them */
+	orig  = &mbfs.mb[0];
+	for (i = 0; i < NUM_PACKETS; i++) {
+		struct rte_mbuf *mc;
+
+		mc = rte_pcapng_copy(port_id, 0, orig, mp, pkt_len,
+				rte_get_tsc_cycles(), 0);
+		if (mc == NULL) {
+			fprintf(stderr, "Cannot copy packet\n");
+			return -1;
+		}
+		clones[i] = mc;
+	}
+
+	/* write it to capture file */
+	len = rte_pcapng_write_packets(pcapng, clones, NUM_PACKETS);
+
+	rte_pktmbuf_free_bulk(clones, NUM_PACKETS);
+
+	if (len <= 0) {
+		fprintf(stderr, "Write of packets failed\n");
+		return -1;
+	}
+
+	return 0;
+}
+
+static int
+test_write_stats(void)
+{
+	ssize_t len;
+
+	/* write a statistics block */
+	len = rte_pcapng_write_stats(pcapng, port_id,
+				     NULL, 0, 0,
+				     NUM_PACKETS, 0);
+	if (len <= 0) {
+		fprintf(stderr, "Write of statistics failed\n");
+		return -1;
+	}
+	return 0;
+}
+
+static void
+pkt_print(u_char *user, const struct pcap_pkthdr *h,
+	  const u_char *bytes)
+{
+	unsigned int *countp = (unsigned int *)user;
+	const struct rte_ether_hdr *eh;
+	struct tm *tm;
+	char tbuf[128], src[64], dst[64];
+
+	tm = localtime(&h->ts.tv_sec);
+	if (tm == NULL) {
+		perror("localtime");
+		return;
+	}
+
+	if (strftime(tbuf, sizeof(tbuf), "%X", tm) == 0) {
+		fprintf(stderr, "strftime returned 0!\n");
+		return;
+	}
+
+	eh = (const struct rte_ether_hdr *)bytes;
+	rte_ether_format_addr(dst, sizeof(dst), &eh->dst_addr);
+	rte_ether_format_addr(src, sizeof(src), &eh->src_addr);
+	printf("%s.%06lu: %s -> %s type %x length %u\n",
+	       tbuf, (unsigned long)h->ts.tv_usec,
+	       src, dst, rte_be_to_cpu_16(eh->ether_type), h->len);
+
+	*countp += 1;
+}
+
+/*
+ * Open the resulting pcapng file with libpcap
+ * Would be better to use capinfos from wireshark
+ * but that creates an unwanted dependency.
+ */
+static int
+test_validate(void)
+{
+	char errbuf[PCAP_ERRBUF_SIZE];
+	unsigned int count = 0;
+	pcap_t *pcap;
+	int ret;
+
+	pcap = pcap_open_offline(file_name, errbuf);
+	if (pcap == NULL) {
+		fprintf(stderr, "pcap_open_offline('%s') failed: %s\n",
+			file_name, errbuf);
+		return -1;
+	}
+
+	ret = pcap_loop(pcap, 0, pkt_print, (u_char *)&count);
+	if (ret == 0)
+		printf("Saw %u packets\n", count);
+	else
+		fprintf(stderr, "pcap_dispatch: failed: %s\n",
+			pcap_geterr(pcap));
+	pcap_close(pcap);
+
+	return ret;
+}
+
+static void
+test_cleanup(void)
+{
+	if (mp)
+		rte_mempool_free(mp);
+
+	if (pcapng)
+		rte_pcapng_close(pcapng);
+
+}
+
+static struct
+unit_test_suite test_pcapng_suite  = {
+	.setup = test_setup,
+	.teardown = test_cleanup,
+	.suite_name = "Test Pcapng Unit Test Suite",
+	.unit_test_cases = {
+		TEST_CASE(test_write_packets),
+		TEST_CASE(test_write_stats),
+		TEST_CASE(test_validate),
+		TEST_CASES_END()
+	}
+};
+
+static int
+test_pcapng(void)
+{
+	return unit_test_suite_runner(&test_pcapng_suite);
+}
+
+REGISTER_TEST_COMMAND(pcapng_autotest, test_pcapng);