2 * Copyright (c) 1982, 1986, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
29 * @(#)uipc_domain.c 8.2 (Berkeley) 10/18/93
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
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>
41 #include <sys/kernel.h>
43 #include <sys/mutex.h>
44 #include <sys/socketvar.h>
45 #include <sys/systm.h>
52 * System initialization
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.
60 * See DOMAIN_SET(9) for details on its use.
63 static void domaininit(void *);
64 SYSINIT(domain, SI_SUB_PROTO_DOMAININIT, SI_ORDER_ANY, domaininit, NULL);
66 static void domainfinalize(void *);
67 SYSINIT(domainfin, SI_SUB_PROTO_IFATTACHDOMAIN, SI_ORDER_FIRST, domainfinalize,
70 static struct callout pffast_callout;
71 static struct callout pfslow_callout;
73 static void pffasttimo(void *);
74 static void pfslowtimo(void *);
76 struct domain *domains; /* registered protocol domains */
77 int domain_init_status = 0;
78 static struct mtx dom_mtx; /* domain list lock */
79 MTX_SYSINIT(domain, &dom_mtx, "domain list", MTX_DEF);
82 * Dummy protocol specific user requests function pointer array.
83 * All functions return EOPNOTSUPP.
85 struct 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,
107 protosw_init(struct protosw *pr)
109 struct pr_usrreqs *pu;
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)));
117 * Protocol switch methods fall into three categories: mandatory,
118 * mandatory but protosw_init() provides a default, and optional.
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).
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)));
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);
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.
166 domain_init(void *arg)
168 struct domain *dp = arg;
173 for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++)
176 * update global information about maximums
178 max_hdr = max_linkhdr + max_protohdr;
179 max_datalen = MHLEN - max_hdr;
181 panic("%s: max_datalen < 1", __func__);
186 vnet_domain_init(void *arg)
189 /* Virtualized case is no different -- call init functions. */
194 vnet_domain_uninit(void *arg)
196 struct domain *dp = arg;
199 for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++)
203 (*dp->dom_destroy)();
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.
213 domain_add(void *data)
217 dp = (struct domain *)data;
219 dp->dom_next = domains;
222 KASSERT(domain_init_status >= 1,
223 ("attempt to domain_add(%s) before domaininit()",
226 if (domain_init_status < 1)
227 printf("WARNING: attempt to domain_add(%s) before "
228 "domaininit()\n", dp->dom_name);
231 KASSERT(domain_init_status < 2,
232 ("attempt to domain_add(%s) after domainfinalize()",
235 if (domain_init_status >= 2)
236 printf("WARNING: attempt to domain_add(%s) after "
237 "domainfinalize()\n", dp->dom_name);
239 mtx_unlock(&dom_mtx);
244 domaininit(void *dummy)
247 if (max_linkhdr < 16) /* XXX */
250 callout_init(&pffast_callout, CALLOUT_MPSAFE);
251 callout_init(&pfslow_callout, CALLOUT_MPSAFE);
254 KASSERT(domain_init_status == 0, ("domaininit called too late!"));
255 domain_init_status = 1;
256 mtx_unlock(&dom_mtx);
261 domainfinalize(void *dummy)
265 KASSERT(domain_init_status == 1, ("domainfinalize called too late!"));
266 domain_init_status = 2;
267 mtx_unlock(&dom_mtx);
269 callout_reset(&pffast_callout, 1, pffasttimo, NULL);
270 callout_reset(&pfslow_callout, 1, pfslowtimo, NULL);
274 pffindtype(int family, int type)
279 for (dp = domains; dp; dp = dp->dom_next)
280 if (dp->dom_family == family)
284 for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++)
285 if (pr->pr_type && pr->pr_type == type)
291 pffindproto(int family, int protocol, int type)
295 struct protosw *maybe = 0;
299 for (dp = domains; dp; dp = dp->dom_next)
300 if (dp->dom_family == family)
304 for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++) {
305 if ((pr->pr_protocol == protocol) && (pr->pr_type == type))
308 if (type == SOCK_RAW && pr->pr_type == SOCK_RAW &&
309 pr->pr_protocol == 0 && maybe == (struct protosw *)0)
316 * The caller must make sure that the new protocol is fully set up and ready to
317 * accept requests before it is registered.
320 pf_proto_register(int family, struct protosw *npr)
322 VNET_ITERATOR_DECL(vnet_iter);
324 struct protosw *pr, *fpr;
328 return (EPFNOSUPPORT);
329 if (npr->pr_type == 0)
331 if (npr->pr_protocol == 0)
332 return (EPROTONOSUPPORT);
333 if (npr->pr_usrreqs == NULL)
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)
340 return (EPFNOSUPPORT);
343 /* Initialize backpointer to struct domain. */
348 * Protect us against races when two protocol registrations for
349 * the same protocol happen at the same time.
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? */
360 /* While here, remember the first free spacer. */
361 if ((fpr == NULL) && (pr->pr_protocol == PROTO_SPACER))
365 /* If no free spacer is found we can't add the new protocol. */
367 mtx_unlock(&dom_mtx);
371 /* Copy the new struct protosw over the spacer. */
372 bcopy(npr, fpr, sizeof(*fpr));
374 /* Job is done, no more protection required. */
375 mtx_unlock(&dom_mtx);
377 /* Initialize and activate the protocol. */
379 VNET_FOREACH(vnet_iter) {
380 CURVNET_SET_QUIET(vnet_iter);
390 * The caller must make sure the protocol and its functions correctly shut down
391 * all sockets and release all locks and memory references.
394 pf_proto_unregister(int family, int protocol, int type)
397 struct protosw *pr, *dpr;
401 return (EPFNOSUPPORT);
403 return (EPROTONOSUPPORT);
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)
411 return (EPFNOSUPPORT);
416 /* Lock out everyone else while we are manipulating the protosw. */
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)) {
423 mtx_unlock(&dom_mtx);
424 return (EMLINK); /* Should not happen! */
430 /* Protocol does not exist. */
432 mtx_unlock(&dom_mtx);
433 return (EPROTONOSUPPORT);
436 /* De-orbit the protocol and make the slot available again. */
439 dpr->pr_protocol = PROTO_SPACER;
441 dpr->pr_input = NULL;
442 dpr->pr_output = NULL;
443 dpr->pr_ctlinput = NULL;
444 dpr->pr_ctloutput = NULL;
446 dpr->pr_fasttimo = NULL;
447 dpr->pr_slowtimo = NULL;
448 dpr->pr_drain = NULL;
449 dpr->pr_usrreqs = &nousrreqs;
451 /* Job is done, not more protection required. */
452 mtx_unlock(&dom_mtx);
458 pfctlinput(int cmd, struct sockaddr *sa)
463 for (dp = domains; dp; dp = dp->dom_next)
464 for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++)
466 (*pr->pr_ctlinput)(cmd, sa, (void *)0);
470 pfctlinput2(int cmd, struct sockaddr *sa, void *ctlparam)
477 for (dp = domains; dp; dp = dp->dom_next) {
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.
483 if (dp->dom_family != sa->sa_family)
486 for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++)
488 (*pr->pr_ctlinput)(cmd, sa, ctlparam);
493 pfslowtimo(void *arg)
498 for (dp = domains; dp; dp = dp->dom_next)
499 for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++)
501 (*pr->pr_slowtimo)();
502 callout_reset(&pfslow_callout, hz/2, pfslowtimo, NULL);
506 pffasttimo(void *arg)
511 for (dp = domains; dp; dp = dp->dom_next)
512 for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++)
514 (*pr->pr_fasttimo)();
515 callout_reset(&pffast_callout, hz/5, pffasttimo, NULL);