xref: /freebsd/tests/sys/netgraph/util.c (revision 09307dbfb888a98232096c751a96ecb3344aa77c)
124ea1dbfSLutz Donnerhacke /*
224ea1dbfSLutz Donnerhacke  * SPDX-License-Identifier: BSD-3-Clause
324ea1dbfSLutz Donnerhacke  *
424ea1dbfSLutz Donnerhacke  * Copyright 2021 Lutz Donnerhacke
524ea1dbfSLutz Donnerhacke  *
624ea1dbfSLutz Donnerhacke  * Redistribution and use in source and binary forms, with or without
724ea1dbfSLutz Donnerhacke  * modification, are permitted provided that the following conditions
824ea1dbfSLutz Donnerhacke  * are met:
924ea1dbfSLutz Donnerhacke  *
1024ea1dbfSLutz Donnerhacke  * 1. Redistributions of source code must retain the above copyright
1124ea1dbfSLutz Donnerhacke  *    notice, this list of conditions and the following disclaimer.
1224ea1dbfSLutz Donnerhacke  * 2. Redistributions in binary form must reproduce the above
1324ea1dbfSLutz Donnerhacke  *    copyright notice, this list of conditions and the following
1424ea1dbfSLutz Donnerhacke  *    disclaimer in the documentation and/or other materials provided
1524ea1dbfSLutz Donnerhacke  *    with the distribution.
1624ea1dbfSLutz Donnerhacke  * 3. Neither the name of the copyright holder nor the names of its
1724ea1dbfSLutz Donnerhacke  *    contributors may be used to endorse or promote products derived
1824ea1dbfSLutz Donnerhacke  *    from this software without specific prior written permission.
1924ea1dbfSLutz Donnerhacke  *
2024ea1dbfSLutz Donnerhacke  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
2124ea1dbfSLutz Donnerhacke  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
2224ea1dbfSLutz Donnerhacke  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
2324ea1dbfSLutz Donnerhacke  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
2424ea1dbfSLutz Donnerhacke  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
2524ea1dbfSLutz Donnerhacke  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
2624ea1dbfSLutz Donnerhacke  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
2724ea1dbfSLutz Donnerhacke  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2824ea1dbfSLutz Donnerhacke  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
2924ea1dbfSLutz Donnerhacke  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
3024ea1dbfSLutz Donnerhacke  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
3124ea1dbfSLutz Donnerhacke  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
3224ea1dbfSLutz Donnerhacke  * SUCH DAMAGE.
3324ea1dbfSLutz Donnerhacke  */
3424ea1dbfSLutz Donnerhacke #include <atf-c.h>
3524ea1dbfSLutz Donnerhacke #include <errno.h>
3624ea1dbfSLutz Donnerhacke #include <stdlib.h>
3724ea1dbfSLutz Donnerhacke #include <string.h>
3824ea1dbfSLutz Donnerhacke 
3924ea1dbfSLutz Donnerhacke #include <sys/select.h>
4024ea1dbfSLutz Donnerhacke #include <sys/queue.h>
4124ea1dbfSLutz Donnerhacke 
4224ea1dbfSLutz Donnerhacke #include "util.h"
4324ea1dbfSLutz Donnerhacke 
4424ea1dbfSLutz Donnerhacke 
4524ea1dbfSLutz Donnerhacke static int cs = -1, ds = -1;
4624ea1dbfSLutz Donnerhacke static ng_error_t error_handling = FAIL;
4724ea1dbfSLutz Donnerhacke 
4824ea1dbfSLutz Donnerhacke #define CHECK(r, x)	do {		\
4924ea1dbfSLutz Donnerhacke 	if (error_handling == FAIL)	\
5024ea1dbfSLutz Donnerhacke 	    ATF_REQUIRE(x);		\
5124ea1dbfSLutz Donnerhacke 	else if(!(x))			\
5224ea1dbfSLutz Donnerhacke 	    return r;			\
5324ea1dbfSLutz Donnerhacke } while(0)
5424ea1dbfSLutz Donnerhacke 
5524ea1dbfSLutz Donnerhacke struct data_handler {
5624ea1dbfSLutz Donnerhacke 	char const *hook;
5724ea1dbfSLutz Donnerhacke 	ng_data_handler_t handler;
5824ea1dbfSLutz Donnerhacke 	SLIST_ENTRY(data_handler) next;
5924ea1dbfSLutz Donnerhacke };
6024ea1dbfSLutz Donnerhacke static SLIST_HEAD(, data_handler) data_head = SLIST_HEAD_INITIALIZER(data_head);
61*09307dbfSLutz Donnerhacke static ng_msg_handler_t msg_handler = NULL;
6224ea1dbfSLutz Donnerhacke 
6324ea1dbfSLutz Donnerhacke static void handle_data(void *ctx);
64*09307dbfSLutz Donnerhacke static void handle_msg(void *ctx);
6524ea1dbfSLutz Donnerhacke 
6624ea1dbfSLutz Donnerhacke void
6724ea1dbfSLutz Donnerhacke ng_connect(char const *path1, char const *hook1,
6824ea1dbfSLutz Donnerhacke 	   char const *path2, char const *hook2)
6924ea1dbfSLutz Donnerhacke {
7024ea1dbfSLutz Donnerhacke 	struct ngm_connect c;
7124ea1dbfSLutz Donnerhacke 
7224ea1dbfSLutz Donnerhacke 	strncpy(c.ourhook,  hook1, sizeof(c.ourhook));
7324ea1dbfSLutz Donnerhacke 	strncpy(c.peerhook, hook2, sizeof(c.peerhook));
7424ea1dbfSLutz Donnerhacke 	strncpy(c.path,     path2, sizeof(c.path));
7524ea1dbfSLutz Donnerhacke 
7624ea1dbfSLutz Donnerhacke 	CHECK(, -1 != NgSendMsg(cs, path1,
7724ea1dbfSLutz Donnerhacke 	    NGM_GENERIC_COOKIE, NGM_CONNECT,
7824ea1dbfSLutz Donnerhacke 	    &c, sizeof(c)));
7924ea1dbfSLutz Donnerhacke }
8024ea1dbfSLutz Donnerhacke 
8124ea1dbfSLutz Donnerhacke void
8224ea1dbfSLutz Donnerhacke ng_mkpeer(char const *path1, char const *hook1,
8324ea1dbfSLutz Donnerhacke 	  char const *type,  char const *hook2)
8424ea1dbfSLutz Donnerhacke {
8524ea1dbfSLutz Donnerhacke 	struct ngm_mkpeer p;
8624ea1dbfSLutz Donnerhacke 
8724ea1dbfSLutz Donnerhacke 	strncpy(p.ourhook,  hook1, sizeof(p.ourhook));
8824ea1dbfSLutz Donnerhacke 	strncpy(p.peerhook, hook2, sizeof(p.peerhook));
8924ea1dbfSLutz Donnerhacke 	strncpy(p.type,     type,  sizeof(p.type));
9024ea1dbfSLutz Donnerhacke 
9124ea1dbfSLutz Donnerhacke 	CHECK(, -1 != NgSendMsg(cs, path1,
9224ea1dbfSLutz Donnerhacke 	    NGM_GENERIC_COOKIE, NGM_MKPEER,
9324ea1dbfSLutz Donnerhacke 	    &p, sizeof(p)));
9424ea1dbfSLutz Donnerhacke }
9524ea1dbfSLutz Donnerhacke 
9624ea1dbfSLutz Donnerhacke void
9724ea1dbfSLutz Donnerhacke ng_rmhook(char const *path, char const *hook)
9824ea1dbfSLutz Donnerhacke {
9924ea1dbfSLutz Donnerhacke 	struct ngm_rmhook h;
10024ea1dbfSLutz Donnerhacke 
10124ea1dbfSLutz Donnerhacke 	strncpy(h.ourhook, hook, sizeof(h.ourhook));
10224ea1dbfSLutz Donnerhacke 
10324ea1dbfSLutz Donnerhacke 	CHECK(, -1 != NgSendMsg(cs, path,
10424ea1dbfSLutz Donnerhacke 	    NGM_GENERIC_COOKIE, NGM_RMHOOK,
10524ea1dbfSLutz Donnerhacke 	    &h, sizeof(h)));
10624ea1dbfSLutz Donnerhacke }
10724ea1dbfSLutz Donnerhacke 
10824ea1dbfSLutz Donnerhacke void
10924ea1dbfSLutz Donnerhacke ng_name(char const *path, char const *name)
11024ea1dbfSLutz Donnerhacke {
11124ea1dbfSLutz Donnerhacke 	struct ngm_name n;
11224ea1dbfSLutz Donnerhacke 
11324ea1dbfSLutz Donnerhacke 	strncpy(n.name, name, sizeof(n.name));
11424ea1dbfSLutz Donnerhacke 
11524ea1dbfSLutz Donnerhacke 	CHECK(, -1 != NgSendMsg(cs, path,
11624ea1dbfSLutz Donnerhacke 	    NGM_GENERIC_COOKIE, NGM_NAME,
11724ea1dbfSLutz Donnerhacke 	    &n, sizeof(n)));
11824ea1dbfSLutz Donnerhacke }
11924ea1dbfSLutz Donnerhacke 
12024ea1dbfSLutz Donnerhacke void
12124ea1dbfSLutz Donnerhacke ng_shutdown(char const *path)
12224ea1dbfSLutz Donnerhacke {
12324ea1dbfSLutz Donnerhacke 	CHECK(, -1 != NgSendMsg(cs, path,
12424ea1dbfSLutz Donnerhacke 	    NGM_GENERIC_COOKIE, NGM_SHUTDOWN,
12524ea1dbfSLutz Donnerhacke 	    NULL, 0));
12624ea1dbfSLutz Donnerhacke }
12724ea1dbfSLutz Donnerhacke 
12824ea1dbfSLutz Donnerhacke void
12924ea1dbfSLutz Donnerhacke ng_register_data(char const *hook, ng_data_handler_t proc)
13024ea1dbfSLutz Donnerhacke {
13124ea1dbfSLutz Donnerhacke 	struct data_handler *p;
13224ea1dbfSLutz Donnerhacke 
13324ea1dbfSLutz Donnerhacke 	ATF_REQUIRE(NULL != (p = calloc(1, sizeof(struct data_handler))));
13424ea1dbfSLutz Donnerhacke 	ATF_REQUIRE(NULL != (p->hook = strdup(hook)));
13524ea1dbfSLutz Donnerhacke 	ATF_REQUIRE(NULL != (p->handler = proc));
13624ea1dbfSLutz Donnerhacke 	SLIST_INSERT_HEAD(&data_head, p, next);
13724ea1dbfSLutz Donnerhacke }
13824ea1dbfSLutz Donnerhacke 
13924ea1dbfSLutz Donnerhacke void
14024ea1dbfSLutz Donnerhacke ng_send_data(char const *hook,
14124ea1dbfSLutz Donnerhacke 	     void const *data, size_t len)
14224ea1dbfSLutz Donnerhacke {
14324ea1dbfSLutz Donnerhacke 	CHECK(, -1 != NgSendData(ds, hook, data, len));
14424ea1dbfSLutz Donnerhacke }
14524ea1dbfSLutz Donnerhacke 
146*09307dbfSLutz Donnerhacke void
147*09307dbfSLutz Donnerhacke ng_register_msg(ng_msg_handler_t proc) {
148*09307dbfSLutz Donnerhacke 	msg_handler = proc;
149*09307dbfSLutz Donnerhacke }
150*09307dbfSLutz Donnerhacke 
15124ea1dbfSLutz Donnerhacke static void
152*09307dbfSLutz Donnerhacke handle_msg(void *ctx) {
15324ea1dbfSLutz Donnerhacke 	struct ng_mesg *m;
15424ea1dbfSLutz Donnerhacke 	char path[NG_PATHSIZ];
15524ea1dbfSLutz Donnerhacke 
15624ea1dbfSLutz Donnerhacke 	ATF_REQUIRE(-1 != NgAllocRecvMsg(cs, &m, path));
15724ea1dbfSLutz Donnerhacke 
158*09307dbfSLutz Donnerhacke 	if(msg_handler != NULL)
159*09307dbfSLutz Donnerhacke 		(*msg_handler)(path, m, ctx);
160*09307dbfSLutz Donnerhacke 
16124ea1dbfSLutz Donnerhacke 	free(m);
16224ea1dbfSLutz Donnerhacke }
16324ea1dbfSLutz Donnerhacke 
16424ea1dbfSLutz Donnerhacke static void
16524ea1dbfSLutz Donnerhacke handle_data(void *ctx) {
16624ea1dbfSLutz Donnerhacke 	char hook[NG_HOOKSIZ];
16724ea1dbfSLutz Donnerhacke 	struct data_handler *hnd;
16824ea1dbfSLutz Donnerhacke 	u_char *data;
16924ea1dbfSLutz Donnerhacke 	int len;
17024ea1dbfSLutz Donnerhacke 
17124ea1dbfSLutz Donnerhacke 	ATF_REQUIRE(0 < (len = NgAllocRecvData(ds, &data, hook)));
17224ea1dbfSLutz Donnerhacke 	SLIST_FOREACH(hnd, &data_head, next)
17324ea1dbfSLutz Donnerhacke 		if (0 == strcmp(hnd->hook, hook))
17424ea1dbfSLutz Donnerhacke 			break;
17524ea1dbfSLutz Donnerhacke 
17624ea1dbfSLutz Donnerhacke 	if (hnd != NULL)
17724ea1dbfSLutz Donnerhacke 		(*(hnd->handler))(data, len, ctx);
17824ea1dbfSLutz Donnerhacke 
17924ea1dbfSLutz Donnerhacke 	free(data);
18024ea1dbfSLutz Donnerhacke }
18124ea1dbfSLutz Donnerhacke 
18224ea1dbfSLutz Donnerhacke int
18324ea1dbfSLutz Donnerhacke ng_handle_event(unsigned int ms, void *context)
18424ea1dbfSLutz Donnerhacke {
18524ea1dbfSLutz Donnerhacke 	fd_set fds;
18624ea1dbfSLutz Donnerhacke 	int maxfd = (ds < cs) ? cs : ds;
18724ea1dbfSLutz Donnerhacke 	struct timeval timeout = { 0, ms * 1000lu };
18824ea1dbfSLutz Donnerhacke 
18924ea1dbfSLutz Donnerhacke 	FD_ZERO(&fds);
19024ea1dbfSLutz Donnerhacke 	FD_SET(cs, &fds);
19124ea1dbfSLutz Donnerhacke 	FD_SET(ds, &fds);
19224ea1dbfSLutz Donnerhacke retry:
19324ea1dbfSLutz Donnerhacke 	switch (select(maxfd+1, &fds, NULL, NULL, &timeout)) {
19424ea1dbfSLutz Donnerhacke 	case -1:
19524ea1dbfSLutz Donnerhacke 		ATF_REQUIRE_ERRNO(EINTR, 1);
19624ea1dbfSLutz Donnerhacke 		goto retry;
19724ea1dbfSLutz Donnerhacke 	case 0:			       /* timeout */
19824ea1dbfSLutz Donnerhacke 		return 0;
19924ea1dbfSLutz Donnerhacke 	default:		       /* something to do */
20024ea1dbfSLutz Donnerhacke 		if (FD_ISSET(cs, &fds))
201*09307dbfSLutz Donnerhacke 		    handle_msg(context);
20224ea1dbfSLutz Donnerhacke 		if (FD_ISSET(ds, &fds))
20324ea1dbfSLutz Donnerhacke 		    handle_data(context);
20424ea1dbfSLutz Donnerhacke 		return 1;
20524ea1dbfSLutz Donnerhacke 	}
20624ea1dbfSLutz Donnerhacke }
20724ea1dbfSLutz Donnerhacke 
20824ea1dbfSLutz Donnerhacke void
20924ea1dbfSLutz Donnerhacke ng_handle_events(unsigned int ms, void *context)
21024ea1dbfSLutz Donnerhacke {
21124ea1dbfSLutz Donnerhacke 	while(ng_handle_event(ms, context))
21224ea1dbfSLutz Donnerhacke 		;
21324ea1dbfSLutz Donnerhacke }
21424ea1dbfSLutz Donnerhacke 
21524ea1dbfSLutz Donnerhacke int
21624ea1dbfSLutz Donnerhacke ng_send_msg(char const *path, char const *msg)
21724ea1dbfSLutz Donnerhacke {
21824ea1dbfSLutz Donnerhacke 	int res;
21924ea1dbfSLutz Donnerhacke 
22024ea1dbfSLutz Donnerhacke 	CHECK(-1, -1 != (res = NgSendAsciiMsg(cs, path, "%s", msg)));
22124ea1dbfSLutz Donnerhacke 	return (res);
22224ea1dbfSLutz Donnerhacke }
22324ea1dbfSLutz Donnerhacke 
22424ea1dbfSLutz Donnerhacke ng_error_t
22524ea1dbfSLutz Donnerhacke ng_errors(ng_error_t n)
22624ea1dbfSLutz Donnerhacke {
22724ea1dbfSLutz Donnerhacke 	ng_error_t o = error_handling;
22824ea1dbfSLutz Donnerhacke 
22924ea1dbfSLutz Donnerhacke 	error_handling = n;
23024ea1dbfSLutz Donnerhacke 	return (o);
23124ea1dbfSLutz Donnerhacke }
23224ea1dbfSLutz Donnerhacke 
23324ea1dbfSLutz Donnerhacke void
23424ea1dbfSLutz Donnerhacke ng_init(void) {
23524ea1dbfSLutz Donnerhacke 	if (cs >= 0)		       /* prevent reinit */
23624ea1dbfSLutz Donnerhacke 		return;
23724ea1dbfSLutz Donnerhacke 
23824ea1dbfSLutz Donnerhacke 	ATF_REQUIRE(0 == NgMkSockNode(NULL, &cs, &ds));
23924ea1dbfSLutz Donnerhacke 	NgSetDebug(3);
24024ea1dbfSLutz Donnerhacke }
241