xref: /src/usr.sbin/npf/npftest/npftest.c

/*	$NetBSD: npftest.c,v 1.29 2025/07/01 20:19:30 joe Exp $	*/

/*
 * NPF testing framework.
 *
 * Public Domain.
 */

#include <stdio.h>
#include <stdlib.h>
#include <stdbool.h>
#include <string.h>
#include <unistd.h>
#include <assert.h>
#include <fcntl.h>
#include <err.h>

#include <sys/mman.h>
#include <sys/stat.h>
#if !defined(_NPF_STANDALONE)
#include <sys/ioctl.h>
#include <net/if.h>
#include <arpa/inet.h>

#include <dnv.h>
#include <nv.h>

#include <rump/rump.h>
#include <rump/rump_syscalls.h>
#endif

#include <cdbw.h>

#include "npftest.h"

static bool verbose, quiet;

__dead static void
usage(const char *progname)
{
	printf("usage:\n"
	    "  %s [ -q | -v ] [ -c <config> ] "
	        "[ -i <interface> ] < -b | -t | -s file >\n"
	    "  %s -T <testname> -c <config>\n"
	    "  %s -L\n"
	    "where:\n"
	    "\t-b: benchmark\n"
	    "\t-t: regression test\n"
	    "\t-T <testname>: specific test\n"
	    "\t-s <file>: pcap stream\n"
	    "\t-c <config>: NPF configuration file\n"
	    "\t-i <interface>: primary interface\n"
	    "\t-L: list testnames and description for -T\n"
	    "\t-q: quiet mode\n"
	    "\t-v: verbose mode\n",
	    progname, progname, progname);
	exit(EXIT_FAILURE);
}

__dead static void
describe_tests(void)
{
	printf(	"nbuf\tbasic npf mbuf handling\n"
		"bpf\tBPF coprocessor\n"
		"table\ttable handling\n"
		"state\tstate handling and processing\n"
		"gc\tconnection G/C\n"
		"rule\trule processing\n"
		"nat\tNAT rule processing\n"
		"guid\tUser/group filtering\n"
		"ether\tlayer 2 rule processing\n");
	exit(EXIT_SUCCESS);
}

static bool
result(const char *testcase, bool ok)
{
	if (!quiet) {
		printf("NPF %-10s\t%s\n", testcase, ok ? "OK" : "fail");
	}
	if (verbose) {
		puts("-----");
	}
	return !ok;
}

static void
load_npf_config(const char *fpath)
{
	struct stat sb;
	int error, fd;
	size_t len;
	void *buf;

	/*
	 * Read the configuration from the specified file.
	 */
	if ((fd = open(fpath, O_RDONLY)) == -1) {
		err(EXIT_FAILURE, "open");
	}
	if (fstat(fd, &sb) == -1) {
		err(EXIT_FAILURE, "fstat");
	}
	len = sb.st_size;
	buf = mmap(NULL, len, PROT_READ, MAP_FILE | MAP_PRIVATE, fd, 0);
	if (buf == MAP_FAILED) {
		err(EXIT_FAILURE, "mmap");
	}
	close(fd);

	/*
	 * Load the NPF configuration.
	 */
	error = rumpns_npf_test_load(buf, len, verbose);
	if (error) {
		errx(EXIT_FAILURE, "npf_test_load: %s\n", strerror(error));
	}
	munmap(buf, len);

	if (verbose) {
		printf("Loaded NPF config at '%s'\n", fpath);
	}
}

static void *
generate_test_cdb(size_t *size)
{
	in_addr_t addr;
	struct cdbw *cdbw;
	struct stat sb;
	char sfn[32];
	int alen, fd;
	void *cdb;

	if ((cdbw = cdbw_open()) == NULL) {
		err(EXIT_FAILURE, "cdbw_open");
	}
	strlcpy(sfn, "/tmp/npftest_cdb.XXXXXX", sizeof(sfn));
	if ((fd = mkstemp(sfn)) == -1) {
		err(EXIT_FAILURE, "mkstemp");
	}
	unlink(sfn);

	addr = inet_addr("192.168.1.1"), alen = sizeof(struct in_addr);
	if (cdbw_put(cdbw, &addr, alen, &addr, alen) == -1)
		err(EXIT_FAILURE, "cdbw_put");

	addr = inet_addr("10.0.0.2"), alen = sizeof(struct in_addr);
	if (cdbw_put(cdbw, &addr, alen, &addr, alen) == -1)
		err(EXIT_FAILURE, "cdbw_put");

	if (cdbw_output(cdbw, fd, "npf-table-cdb", NULL) == -1) {
		err(EXIT_FAILURE, "cdbw_output");
	}
	cdbw_close(cdbw);

	if (fstat(fd, &sb) == -1) {
		err(EXIT_FAILURE, "fstat");
	}
	if ((cdb = mmap(NULL, sb.st_size, PROT_READ,
	    MAP_FILE | MAP_PRIVATE, fd, 0)) == MAP_FAILED) {
		err(EXIT_FAILURE, "mmap");
	}
	close(fd);

	*size = sb.st_size;
	return cdb;
}

static void
npf_kern_init(void)
{
#if !defined(_NPF_STANDALONE)
	/* XXX rn_init */
	extern int rumpns_max_keylen;
	rumpns_max_keylen = 1;

	rump_init();
	rump_schedule();
#endif
}

static void
npf_kern_fini(void)
{
#if !defined(_NPF_STANDALONE)
	rump_unschedule();
#endif
}

int
main(int argc, char **argv)
{
	bool test, ok, fail, tname_matched;
	char *benchmark, *config, *interface, *stream, *testname;
	unsigned nthreads = 0;
	ifnet_t *ifp = NULL;
	int ch;

	benchmark = NULL;
	test = false;

	tname_matched = false;
	testname = NULL;
	config = NULL;
	interface = NULL;
	stream = NULL;

	verbose = false;
	quiet = false;

	while ((ch = getopt(argc, argv, "b:qvc:i:s:tT:Lp:")) != -1) {
		switch (ch) {
		case 'b':
			benchmark = optarg;
			break;
		case 'q':
			quiet = true;
			break;
		case 'v':
			verbose = true;
			break;
		case 'c':
			config = optarg;
			break;
		case 'i':
			interface = optarg;
			break;
		case 's':
			stream = optarg;
			break;
		case 't':
			test = true;
			break;
		case 'T':
			test = true;
			testname = optarg;
			break;
		case 'L':
			describe_tests();
			break;
		case 'p':
			/* Note: RUMP_NCPU must be high enough. */
			if ((nthreads = atoi(optarg)) > 0 &&
			    getenv("RUMP_NCPU") == NULL) {
				static char nthr[64];
				sprintf(nthr, "%u", nthreads + 1);
				setenv("RUMP_NCPU", nthr, 1);
			}
			break;
		default:
			usage(argv[0]);
		}
	}

	/*
	 * Either benchmark or test.  If stream analysis, then the
	 * interface should be specified.  If benchmark, then the
	 * config should be loaded.
	 */
	if ((benchmark != NULL) == test && (stream && !interface)) {
		usage(argv[0]);
	}
	if (benchmark && (!config || !nthreads)) {
		errx(EXIT_FAILURE, "missing config for the benchmark or "
		    "invalid thread count");
	}

	/*
	 * Initialise the NPF kernel component.
	 */
	npf_kern_init();
	rumpns_npf_test_init(inet_pton, inet_ntop, random);

	if (config) {
		load_npf_config(config);
	}
	if (interface && (ifp = rumpns_npf_test_getif(interface)) == 0) {
		errx(EXIT_FAILURE, "failed to find the interface");
	}

	fail = false;

	if (test) {
		if (!testname || strcmp("nbuf", testname) == 0) {
			ok = rumpns_npf_nbuf_test(verbose);
			fail |= result("nbuf", ok);
			tname_matched = true;
		}

		if (!testname || strcmp("bpf", testname) == 0) {
			ok = rumpns_npf_bpf_test(verbose);
			fail |= result("bpf", ok);
			tname_matched = true;
		}

		if (!testname || strcmp("table", testname) == 0) {
			void *cdb;
			size_t len;

			cdb = generate_test_cdb(&len);
			ok = rumpns_npf_table_test(verbose, cdb, len);
			fail |= result("table", ok);
			tname_matched = true;
			munmap(cdb, len);
		}

		if (!testname || strcmp("state", testname) == 0) {
			ok = rumpns_npf_state_test(verbose);
			fail |= result("state", ok);
			tname_matched = true;
		}

		if (!testname || strcmp("gc", testname) == 0) {
			ok = rumpns_npf_gc_test(verbose);
			fail |= result("gc", ok);
			tname_matched = true;
		}
	}

	if (test && config) {
		if (!testname || strcmp("rule", testname) == 0) {
			ok = rumpns_npf_rule_test(verbose);
			fail |= result("rules - layer 3", ok);
			tname_matched = true;
		}

		if (!testname || strcmp("ether", testname) == 0) {
			ok = rumpns_npf_layer2_rule_test(verbose);
			fail |= result("rules - layer 2", ok);
			tname_matched = true;
		}

		if (!testname || strcmp("guid", testname) == 0) {
			ok = rumpns_npf_guid_test(verbose);
			fail |= result("guid", ok);
			tname_matched = true;
		}

		if (!testname || strcmp("nat", testname) == 0) {
			srandom(1);
			ok = rumpns_npf_nat_test(verbose);
			fail |= result("nat", ok);
			tname_matched = true;
		}
	}

	if (stream) {
		process_stream(stream, NULL, ifp);
	}

	if (benchmark) {
		if (strcmp("rule", benchmark) == 0) {
			rumpns_npf_test_conc(false, nthreads);
		}
		if (strcmp("state", benchmark) == 0) {
			rumpns_npf_test_conc(true, nthreads);
		}
	}

	rumpns_npf_test_fini();
	npf_kern_fini();

	if (testname && !tname_matched)
		errx(EXIT_FAILURE, "test \"%s\" unknown", testname);

	return fail ? EXIT_FAILURE : EXIT_SUCCESS;
}