1/*-
2 * Copyright (c) 1982, 1986, 1993
3 *	The Regents of the University of California.  All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 4. Neither the name of the University nor the names of its contributors
14 *    may be used to endorse or promote products derived from this software
15 *    without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 *	@(#)uipc_domain.c	8.2 (Berkeley) 10/18/93
30 */
31
32#include <sys/cdefs.h>
33__FBSDID("$FreeBSD$");
34
35#include <sys/param.h>
36#include <sys/socket.h>
37#include <sys/protosw.h>
38#include <sys/domain.h>
39#include <sys/eventhandler.h>
40#include <sys/mbuf.h>
41#include <sys/kernel.h>
42#include <sys/lock.h>
43#include <sys/mutex.h>
44#include <sys/socketvar.h>
45#include <sys/systm.h>
46
47#include <net/vnet.h>
48
49#include <vm/uma.h>
50
51/*
52 * System initialization
53 *
54 * Note: domain initialization takes place on a per domain basis
55 * as a result of traversing a SYSINIT linker set.  Most likely,
56 * each domain would want to call DOMAIN_SET(9) itself, which
57 * would cause the domain to be added just after domaininit()
58 * is called during startup.
59 *
60 * See DOMAIN_SET(9) for details on its use.
61 */
62
63static void domaininit(void *);
64SYSINIT(domain, SI_SUB_PROTO_DOMAININIT, SI_ORDER_ANY, domaininit, NULL);
65
66static void domainfinalize(void *);
67SYSINIT(domainfin, SI_SUB_PROTO_IFATTACHDOMAIN, SI_ORDER_FIRST, domainfinalize,
68    NULL);
69
70static struct callout pffast_callout;
71static struct callout pfslow_callout;
72
73static void	pffasttimo(void *);
74static void	pfslowtimo(void *);
75
76struct domain *domains;		/* registered protocol domains */
77int domain_init_status = 0;
78static struct mtx dom_mtx;		/* domain list lock */
79MTX_SYSINIT(domain, &dom_mtx, "domain list", MTX_DEF);
80
81/*
82 * Dummy protocol specific user requests function pointer array.
83 * All functions return EOPNOTSUPP.
84 */
85struct pr_usrreqs nousrreqs = {
86	.pru_accept =		pru_accept_notsupp,
87	.pru_attach =		pru_attach_notsupp,
88	.pru_bind =		pru_bind_notsupp,
89	.pru_connect =		pru_connect_notsupp,
90	.pru_connect2 =		pru_connect2_notsupp,
91	.pru_control =		pru_control_notsupp,
92	.pru_disconnect	=	pru_disconnect_notsupp,
93	.pru_listen =		pru_listen_notsupp,
94	.pru_peeraddr =		pru_peeraddr_notsupp,
95	.pru_rcvd =		pru_rcvd_notsupp,
96	.pru_rcvoob =		pru_rcvoob_notsupp,
97	.pru_send =		pru_send_notsupp,
98	.pru_sense =		pru_sense_null,
99	.pru_shutdown =		pru_shutdown_notsupp,
100	.pru_sockaddr =		pru_sockaddr_notsupp,
101	.pru_sosend =		pru_sosend_notsupp,
102	.pru_soreceive =	pru_soreceive_notsupp,
103	.pru_sopoll =		pru_sopoll_notsupp,
104};
105
106static void
107protosw_init(struct protosw *pr)
108{
109	struct pr_usrreqs *pu;
110
111	pu = pr->pr_usrreqs;
112	KASSERT(pu != NULL, ("protosw_init: %ssw[%d] has no usrreqs!",
113	    pr->pr_domain->dom_name,
114	    (int)(pr - pr->pr_domain->dom_protosw)));
115
116	/*
117	 * Protocol switch methods fall into three categories: mandatory,
118	 * mandatory but protosw_init() provides a default, and optional.
119	 *
120	 * For true protocols (i.e., pru_attach != NULL), KASSERT truly
121	 * mandatory methods with no defaults, and initialize defaults for
122	 * other mandatory methods if the protocol hasn't defined an
123	 * implementation (NULL function pointer).
124	 */
125#if 0
126	if (pu->pru_attach != NULL) {
127		KASSERT(pu->pru_abort != NULL,
128		    ("protosw_init: %ssw[%d] pru_abort NULL",
129		    pr->pr_domain->dom_name,
130		    (int)(pr - pr->pr_domain->dom_protosw)));
131		KASSERT(pu->pru_send != NULL,
132		    ("protosw_init: %ssw[%d] pru_send NULL",
133		    pr->pr_domain->dom_name,
134		    (int)(pr - pr->pr_domain->dom_protosw)));
135	}
136#endif
137
138#define DEFAULT(foo, bar)	if ((foo) == NULL)  (foo) = (bar)
139	DEFAULT(pu->pru_accept, pru_accept_notsupp);
140	DEFAULT(pu->pru_bind, pru_bind_notsupp);
141	DEFAULT(pu->pru_connect, pru_connect_notsupp);
142	DEFAULT(pu->pru_connect2, pru_connect2_notsupp);
143	DEFAULT(pu->pru_control, pru_control_notsupp);
144	DEFAULT(pu->pru_disconnect, pru_disconnect_notsupp);
145	DEFAULT(pu->pru_listen, pru_listen_notsupp);
146	DEFAULT(pu->pru_peeraddr, pru_peeraddr_notsupp);
147	DEFAULT(pu->pru_rcvd, pru_rcvd_notsupp);
148	DEFAULT(pu->pru_rcvoob, pru_rcvoob_notsupp);
149	DEFAULT(pu->pru_sense, pru_sense_null);
150	DEFAULT(pu->pru_shutdown, pru_shutdown_notsupp);
151	DEFAULT(pu->pru_sockaddr, pru_sockaddr_notsupp);
152	DEFAULT(pu->pru_sosend, sosend_generic);
153	DEFAULT(pu->pru_soreceive, soreceive_generic);
154	DEFAULT(pu->pru_sopoll, sopoll_generic);
155#undef DEFAULT
156	if (pr->pr_init)
157		(*pr->pr_init)();
158}
159
160/*
161 * Add a new protocol domain to the list of supported domains
162 * Note: you cant unload it again because a socket may be using it.
163 * XXX can't fail at this time.
164 */
165void
166domain_init(void *arg)
167{
168	struct domain *dp = arg;
169	struct protosw *pr;
170
171	if (dp->dom_init)
172		(*dp->dom_init)();
173	for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++)
174		protosw_init(pr);
175	/*
176	 * update global information about maximums
177	 */
178	max_hdr = max_linkhdr + max_protohdr;
179	max_datalen = MHLEN - max_hdr;
180	if (max_datalen < 1)
181		panic("%s: max_datalen < 1", __func__);
182}
183
184#ifdef VIMAGE
185void
186vnet_domain_init(void *arg)
187{
188
189	/* Virtualized case is no different -- call init functions. */
190	domain_init(arg);
191}
192
193void
194vnet_domain_uninit(void *arg)
195{
196	struct domain *dp = arg;
197	struct protosw *pr;
198
199	for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++)
200		if (pr->pr_destroy)
201			(*pr->pr_destroy)();
202	if (dp->dom_destroy)
203		(*dp->dom_destroy)();
204}
205#endif
206
207/*
208 * Add a new protocol domain to the list of supported domains
209 * Note: you cant unload it again because a socket may be using it.
210 * XXX can't fail at this time.
211 */
212void
213domain_add(void *data)
214{
215	struct domain *dp;
216
217	dp = (struct domain *)data;
218	mtx_lock(&dom_mtx);
219	dp->dom_next = domains;
220	domains = dp;
221
222	KASSERT(domain_init_status >= 1,
223	    ("attempt to domain_add(%s) before domaininit()",
224	    dp->dom_name));
225#ifndef INVARIANTS
226	if (domain_init_status < 1)
227		printf("WARNING: attempt to domain_add(%s) before "
228		    "domaininit()\n", dp->dom_name);
229#endif
230#ifdef notyet
231	KASSERT(domain_init_status < 2,
232	    ("attempt to domain_add(%s) after domainfinalize()",
233	    dp->dom_name));
234#else
235	if (domain_init_status >= 2)
236		printf("WARNING: attempt to domain_add(%s) after "
237		    "domainfinalize()\n", dp->dom_name);
238#endif
239	mtx_unlock(&dom_mtx);
240}
241
242/* ARGSUSED*/
243static void
244domaininit(void *dummy)
245{
246
247	if (max_linkhdr < 16)		/* XXX */
248		max_linkhdr = 16;
249
250	callout_init(&pffast_callout, CALLOUT_MPSAFE);
251	callout_init(&pfslow_callout, CALLOUT_MPSAFE);
252
253	mtx_lock(&dom_mtx);
254	KASSERT(domain_init_status == 0, ("domaininit called too late!"));
255	domain_init_status = 1;
256	mtx_unlock(&dom_mtx);
257}
258
259/* ARGSUSED*/
260static void
261domainfinalize(void *dummy)
262{
263
264	mtx_lock(&dom_mtx);
265	KASSERT(domain_init_status == 1, ("domainfinalize called too late!"));
266	domain_init_status = 2;
267	mtx_unlock(&dom_mtx);
268
269	callout_reset(&pffast_callout, 1, pffasttimo, NULL);
270	callout_reset(&pfslow_callout, 1, pfslowtimo, NULL);
271}
272
273struct protosw *
274pffindtype(int family, int type)
275{
276	struct domain *dp;
277	struct protosw *pr;
278
279	for (dp = domains; dp; dp = dp->dom_next)
280		if (dp->dom_family == family)
281			goto found;
282	return (0);
283found:
284	for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++)
285		if (pr->pr_type && pr->pr_type == type)
286			return (pr);
287	return (0);
288}
289
290struct protosw *
291pffindproto(int family, int protocol, int type)
292{
293	struct domain *dp;
294	struct protosw *pr;
295	struct protosw *maybe = 0;
296
297	if (family == 0)
298		return (0);
299	for (dp = domains; dp; dp = dp->dom_next)
300		if (dp->dom_family == family)
301			goto found;
302	return (0);
303found:
304	for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++) {
305		if ((pr->pr_protocol == protocol) && (pr->pr_type == type))
306			return (pr);
307
308		if (type == SOCK_RAW && pr->pr_type == SOCK_RAW &&
309		    pr->pr_protocol == 0 && maybe == (struct protosw *)0)
310			maybe = pr;
311	}
312	return (maybe);
313}
314
315/*
316 * The caller must make sure that the new protocol is fully set up and ready to
317 * accept requests before it is registered.
318 */
319int
320pf_proto_register(int family, struct protosw *npr)
321{
322	VNET_ITERATOR_DECL(vnet_iter);
323	struct domain *dp;
324	struct protosw *pr, *fpr;
325
326	/* Sanity checks. */
327	if (family == 0)
328		return (EPFNOSUPPORT);
329	if (npr->pr_type == 0)
330		return (EPROTOTYPE);
331	if (npr->pr_protocol == 0)
332		return (EPROTONOSUPPORT);
333	if (npr->pr_usrreqs == NULL)
334		return (ENXIO);
335
336	/* Try to find the specified domain based on the family. */
337	for (dp = domains; dp; dp = dp->dom_next)
338		if (dp->dom_family == family)
339			goto found;
340	return (EPFNOSUPPORT);
341
342found:
343	/* Initialize backpointer to struct domain. */
344	npr->pr_domain = dp;
345	fpr = NULL;
346
347	/*
348	 * Protect us against races when two protocol registrations for
349	 * the same protocol happen at the same time.
350	 */
351	mtx_lock(&dom_mtx);
352
353	/* The new protocol must not yet exist. */
354	for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++) {
355		if ((pr->pr_type == npr->pr_type) &&
356		    (pr->pr_protocol == npr->pr_protocol)) {
357			mtx_unlock(&dom_mtx);
358			return (EEXIST);	/* XXX: Check only protocol? */
359		}
360		/* While here, remember the first free spacer. */
361		if ((fpr == NULL) && (pr->pr_protocol == PROTO_SPACER))
362			fpr = pr;
363	}
364
365	/* If no free spacer is found we can't add the new protocol. */
366	if (fpr == NULL) {
367		mtx_unlock(&dom_mtx);
368		return (ENOMEM);
369	}
370
371	/* Copy the new struct protosw over the spacer. */
372	bcopy(npr, fpr, sizeof(*fpr));
373
374	/* Job is done, no more protection required. */
375	mtx_unlock(&dom_mtx);
376
377	/* Initialize and activate the protocol. */
378	VNET_LIST_RLOCK();
379	VNET_FOREACH(vnet_iter) {
380		CURVNET_SET_QUIET(vnet_iter);
381		protosw_init(fpr);
382		CURVNET_RESTORE();
383	}
384	VNET_LIST_RUNLOCK();
385
386	return (0);
387}
388
389/*
390 * The caller must make sure the protocol and its functions correctly shut down
391 * all sockets and release all locks and memory references.
392 */
393int
394pf_proto_unregister(int family, int protocol, int type)
395{
396	struct domain *dp;
397	struct protosw *pr, *dpr;
398
399	/* Sanity checks. */
400	if (family == 0)
401		return (EPFNOSUPPORT);
402	if (protocol == 0)
403		return (EPROTONOSUPPORT);
404	if (type == 0)
405		return (EPROTOTYPE);
406
407	/* Try to find the specified domain based on the family type. */
408	for (dp = domains; dp; dp = dp->dom_next)
409		if (dp->dom_family == family)
410			goto found;
411	return (EPFNOSUPPORT);
412
413found:
414	dpr = NULL;
415
416	/* Lock out everyone else while we are manipulating the protosw. */
417	mtx_lock(&dom_mtx);
418
419	/* The protocol must exist and only once. */
420	for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++) {
421		if ((pr->pr_type == type) && (pr->pr_protocol == protocol)) {
422			if (dpr != NULL) {
423				mtx_unlock(&dom_mtx);
424				return (EMLINK);   /* Should not happen! */
425			} else
426				dpr = pr;
427		}
428	}
429
430	/* Protocol does not exist. */
431	if (dpr == NULL) {
432		mtx_unlock(&dom_mtx);
433		return (EPROTONOSUPPORT);
434	}
435
436	/* De-orbit the protocol and make the slot available again. */
437	dpr->pr_type = 0;
438	dpr->pr_domain = dp;
439	dpr->pr_protocol = PROTO_SPACER;
440	dpr->pr_flags = 0;
441	dpr->pr_input = NULL;
442	dpr->pr_output = NULL;
443	dpr->pr_ctlinput = NULL;
444	dpr->pr_ctloutput = NULL;
445	dpr->pr_init = NULL;
446	dpr->pr_fasttimo = NULL;
447	dpr->pr_slowtimo = NULL;
448	dpr->pr_drain = NULL;
449	dpr->pr_usrreqs = &nousrreqs;
450
451	/* Job is done, not more protection required. */
452	mtx_unlock(&dom_mtx);
453
454	return (0);
455}
456
457void
458pfctlinput(int cmd, struct sockaddr *sa)
459{
460	struct domain *dp;
461	struct protosw *pr;
462
463	for (dp = domains; dp; dp = dp->dom_next)
464		for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++)
465			if (pr->pr_ctlinput)
466				(*pr->pr_ctlinput)(cmd, sa, (void *)0);
467}
468
469void
470pfctlinput2(int cmd, struct sockaddr *sa, void *ctlparam)
471{
472	struct domain *dp;
473	struct protosw *pr;
474
475	if (!sa)
476		return;
477	for (dp = domains; dp; dp = dp->dom_next) {
478		/*
479		 * the check must be made by xx_ctlinput() anyways, to
480		 * make sure we use data item pointed to by ctlparam in
481		 * correct way.  the following check is made just for safety.
482		 */
483		if (dp->dom_family != sa->sa_family)
484			continue;
485
486		for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++)
487			if (pr->pr_ctlinput)
488				(*pr->pr_ctlinput)(cmd, sa, ctlparam);
489	}
490}
491
492static void
493pfslowtimo(void *arg)
494{
495	struct domain *dp;
496	struct protosw *pr;
497
498	for (dp = domains; dp; dp = dp->dom_next)
499		for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++)
500			if (pr->pr_slowtimo)
501				(*pr->pr_slowtimo)();
502	callout_reset(&pfslow_callout, hz/2, pfslowtimo, NULL);
503}
504
505static void
506pffasttimo(void *arg)
507{
508	struct domain *dp;
509	struct protosw *pr;
510
511	for (dp = domains; dp; dp = dp->dom_next)
512		for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++)
513			if (pr->pr_fasttimo)
514				(*pr->pr_fasttimo)();
515	callout_reset(&pffast_callout, hz/5, pffasttimo, NULL);
516}
517