2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1982, 1986, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * @(#)uipc_domain.c 8.2 (Berkeley) 10/18/93
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
37 #include <sys/param.h>
38 #include <sys/socket.h>
39 #include <sys/protosw.h>
40 #include <sys/domain.h>
41 #include <sys/eventhandler.h>
43 #include <sys/kernel.h>
45 #include <sys/mutex.h>
46 #include <sys/socketvar.h>
47 #include <sys/systm.h>
50 #include <net/if.h> /* XXXGL: net_epoch should move out there */
51 #include <net/if_var.h> /* XXXGL: net_epoch should move out there */
54 * System initialization
56 * Note: domain initialization takes place on a per domain basis
57 * as a result of traversing a SYSINIT linker set. Most likely,
58 * each domain would want to call DOMAIN_SET(9) itself, which
59 * would cause the domain to be added just after domaininit()
60 * is called during startup.
62 * See DOMAIN_SET(9) for details on its use.
65 static void domaininit(void *);
66 SYSINIT(domain, SI_SUB_PROTO_DOMAININIT, SI_ORDER_ANY, domaininit, NULL);
68 static void domainfinalize(void *);
69 SYSINIT(domainfin, SI_SUB_PROTO_IFATTACHDOMAIN, SI_ORDER_FIRST, domainfinalize,
72 static struct callout pffast_callout;
73 static struct callout pfslow_callout;
75 static void pffasttimo(void *);
76 static void pfslowtimo(void *);
78 struct domain *domains; /* registered protocol domains */
79 int domain_init_status = 0;
80 static struct mtx dom_mtx; /* domain list lock */
81 MTX_SYSINIT(domain, &dom_mtx, "domain list", MTX_DEF);
84 * Dummy protocol specific user requests function pointer array.
85 * All functions return EOPNOTSUPP.
87 struct pr_usrreqs nousrreqs = {
88 .pru_accept = pru_accept_notsupp,
89 .pru_attach = pru_attach_notsupp,
90 .pru_bind = pru_bind_notsupp,
91 .pru_connect = pru_connect_notsupp,
92 .pru_connect2 = pru_connect2_notsupp,
93 .pru_control = pru_control_notsupp,
94 .pru_disconnect = pru_disconnect_notsupp,
95 .pru_listen = pru_listen_notsupp,
96 .pru_peeraddr = pru_peeraddr_notsupp,
97 .pru_rcvd = pru_rcvd_notsupp,
98 .pru_rcvoob = pru_rcvoob_notsupp,
99 .pru_send = pru_send_notsupp,
100 .pru_sense = pru_sense_null,
101 .pru_shutdown = pru_shutdown_notsupp,
102 .pru_sockaddr = pru_sockaddr_notsupp,
103 .pru_sosend = pru_sosend_notsupp,
104 .pru_soreceive = pru_soreceive_notsupp,
105 .pru_sopoll = pru_sopoll_notsupp,
109 protosw_init(struct protosw *pr)
111 struct pr_usrreqs *pu;
114 KASSERT(pu != NULL, ("protosw_init: %ssw[%d] has no usrreqs!",
115 pr->pr_domain->dom_name,
116 (int)(pr - pr->pr_domain->dom_protosw)));
119 * Protocol switch methods fall into three categories: mandatory,
120 * mandatory but protosw_init() provides a default, and optional.
122 * For true protocols (i.e., pru_attach != NULL), KASSERT truly
123 * mandatory methods with no defaults, and initialize defaults for
124 * other mandatory methods if the protocol hasn't defined an
125 * implementation (NULL function pointer).
128 if (pu->pru_attach != NULL) {
129 KASSERT(pu->pru_abort != NULL,
130 ("protosw_init: %ssw[%d] pru_abort NULL",
131 pr->pr_domain->dom_name,
132 (int)(pr - pr->pr_domain->dom_protosw)));
133 KASSERT(pu->pru_send != NULL,
134 ("protosw_init: %ssw[%d] pru_send NULL",
135 pr->pr_domain->dom_name,
136 (int)(pr - pr->pr_domain->dom_protosw)));
140 #define DEFAULT(foo, bar) if ((foo) == NULL) (foo) = (bar)
141 DEFAULT(pu->pru_accept, pru_accept_notsupp);
142 DEFAULT(pu->pru_aio_queue, pru_aio_queue_notsupp);
143 DEFAULT(pu->pru_bind, pru_bind_notsupp);
144 DEFAULT(pu->pru_bindat, pru_bindat_notsupp);
145 DEFAULT(pu->pru_connect, pru_connect_notsupp);
146 DEFAULT(pu->pru_connect2, pru_connect2_notsupp);
147 DEFAULT(pu->pru_connectat, pru_connectat_notsupp);
148 DEFAULT(pu->pru_control, pru_control_notsupp);
149 DEFAULT(pu->pru_disconnect, pru_disconnect_notsupp);
150 DEFAULT(pu->pru_listen, pru_listen_notsupp);
151 DEFAULT(pu->pru_peeraddr, pru_peeraddr_notsupp);
152 DEFAULT(pu->pru_rcvd, pru_rcvd_notsupp);
153 DEFAULT(pu->pru_rcvoob, pru_rcvoob_notsupp);
154 DEFAULT(pu->pru_sense, pru_sense_null);
155 DEFAULT(pu->pru_shutdown, pru_shutdown_notsupp);
156 DEFAULT(pu->pru_sockaddr, pru_sockaddr_notsupp);
157 DEFAULT(pu->pru_sosend, sosend_generic);
158 DEFAULT(pu->pru_soreceive, soreceive_generic);
159 DEFAULT(pu->pru_sopoll, sopoll_generic);
160 DEFAULT(pu->pru_ready, pru_ready_notsupp);
167 * Add a new protocol domain to the list of supported domains
168 * Note: you cant unload it again because a socket may be using it.
169 * XXX can't fail at this time.
172 domain_init(void *arg)
174 struct domain *dp = arg;
179 for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++)
182 * update global information about maximums
184 max_hdr = max_linkhdr + max_protohdr;
185 max_datalen = MHLEN - max_hdr;
187 panic("%s: max_datalen < 1", __func__);
192 vnet_domain_init(void *arg)
195 /* Virtualized case is no different -- call init functions. */
200 vnet_domain_uninit(void *arg)
202 struct domain *dp = arg;
205 (*dp->dom_destroy)();
210 * Add a new protocol domain to the list of supported domains
211 * Note: you cant unload it again because a socket may be using it.
212 * XXX can't fail at this time.
215 domain_add(void *data)
219 dp = (struct domain *)data;
221 dp->dom_next = domains;
224 KASSERT(domain_init_status >= 1,
225 ("attempt to domain_add(%s) before domaininit()",
228 if (domain_init_status < 1)
229 printf("WARNING: attempt to domain_add(%s) before "
230 "domaininit()\n", dp->dom_name);
233 KASSERT(domain_init_status < 2,
234 ("attempt to domain_add(%s) after domainfinalize()",
237 if (domain_init_status >= 2)
238 printf("WARNING: attempt to domain_add(%s) after "
239 "domainfinalize()\n", dp->dom_name);
241 mtx_unlock(&dom_mtx);
246 domaininit(void *dummy)
249 if (max_linkhdr < 16) /* XXX */
252 callout_init(&pffast_callout, 1);
253 callout_init(&pfslow_callout, 1);
256 KASSERT(domain_init_status == 0, ("domaininit called too late!"));
257 domain_init_status = 1;
258 mtx_unlock(&dom_mtx);
263 domainfinalize(void *dummy)
267 KASSERT(domain_init_status == 1, ("domainfinalize called too late!"));
268 domain_init_status = 2;
269 mtx_unlock(&dom_mtx);
271 callout_reset(&pffast_callout, 1, pffasttimo, NULL);
272 callout_reset(&pfslow_callout, 1, pfslowtimo, NULL);
276 pffinddomain(int family)
280 for (dp = domains; dp != NULL; dp = dp->dom_next)
281 if (dp->dom_family == family)
287 pffindtype(int family, int type)
292 dp = pffinddomain(family);
296 for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++)
297 if (pr->pr_type && pr->pr_type == type)
303 pffindproto(int family, int protocol, int type)
307 struct protosw *maybe;
313 dp = pffinddomain(family);
317 for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++) {
318 if ((pr->pr_protocol == protocol) && (pr->pr_type == type))
321 if (type == SOCK_RAW && pr->pr_type == SOCK_RAW &&
322 pr->pr_protocol == 0 && maybe == NULL)
329 * The caller must make sure that the new protocol is fully set up and ready to
330 * accept requests before it is registered.
333 pf_proto_register(int family, struct protosw *npr)
335 VNET_ITERATOR_DECL(vnet_iter);
337 struct protosw *pr, *fpr;
341 return (EPFNOSUPPORT);
342 if (npr->pr_type == 0)
344 if (npr->pr_protocol == 0)
345 return (EPROTONOSUPPORT);
346 if (npr->pr_usrreqs == NULL)
349 /* Try to find the specified domain based on the family. */
350 dp = pffinddomain(family);
352 return (EPFNOSUPPORT);
354 /* Initialize backpointer to struct domain. */
359 * Protect us against races when two protocol registrations for
360 * the same protocol happen at the same time.
364 /* The new protocol must not yet exist. */
365 for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++) {
366 if ((pr->pr_type == npr->pr_type) &&
367 (pr->pr_protocol == npr->pr_protocol)) {
368 mtx_unlock(&dom_mtx);
369 return (EEXIST); /* XXX: Check only protocol? */
371 /* While here, remember the first free spacer. */
372 if ((fpr == NULL) && (pr->pr_protocol == PROTO_SPACER))
376 /* If no free spacer is found we can't add the new protocol. */
378 mtx_unlock(&dom_mtx);
382 /* Copy the new struct protosw over the spacer. */
383 bcopy(npr, fpr, sizeof(*fpr));
385 /* Job is done, no more protection required. */
386 mtx_unlock(&dom_mtx);
388 /* Initialize and activate the protocol. */
390 VNET_FOREACH(vnet_iter) {
391 CURVNET_SET_QUIET(vnet_iter);
401 * The caller must make sure the protocol and its functions correctly shut down
402 * all sockets and release all locks and memory references.
405 pf_proto_unregister(int family, int protocol, int type)
408 struct protosw *pr, *dpr;
412 return (EPFNOSUPPORT);
414 return (EPROTONOSUPPORT);
418 /* Try to find the specified domain based on the family type. */
419 dp = pffinddomain(family);
421 return (EPFNOSUPPORT);
425 /* Lock out everyone else while we are manipulating the protosw. */
428 /* The protocol must exist and only once. */
429 for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++) {
430 if ((pr->pr_type == type) && (pr->pr_protocol == protocol)) {
432 mtx_unlock(&dom_mtx);
433 return (EMLINK); /* Should not happen! */
439 /* Protocol does not exist. */
441 mtx_unlock(&dom_mtx);
442 return (EPROTONOSUPPORT);
445 /* De-orbit the protocol and make the slot available again. */
448 dpr->pr_protocol = PROTO_SPACER;
450 dpr->pr_input = NULL;
451 dpr->pr_output = NULL;
452 dpr->pr_ctlinput = NULL;
453 dpr->pr_ctloutput = NULL;
455 dpr->pr_fasttimo = NULL;
456 dpr->pr_slowtimo = NULL;
457 dpr->pr_drain = NULL;
458 dpr->pr_usrreqs = &nousrreqs;
460 /* Job is done, not more protection required. */
461 mtx_unlock(&dom_mtx);
467 pfctlinput(int cmd, struct sockaddr *sa)
472 for (dp = domains; dp; dp = dp->dom_next)
473 for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++)
475 (*pr->pr_ctlinput)(cmd, sa, (void *)0);
479 pfslowtimo(void *arg)
481 struct epoch_tracker et;
486 for (dp = domains; dp; dp = dp->dom_next)
487 for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++)
489 (*pr->pr_slowtimo)();
491 callout_reset(&pfslow_callout, hz/2, pfslowtimo, NULL);
495 pffasttimo(void *arg)
497 struct epoch_tracker et;
502 for (dp = domains; dp; dp = dp->dom_next)
503 for (pr = dp->dom_protosw; pr < dp->dom_protoswNPROTOSW; pr++)
505 (*pr->pr_fasttimo)();
507 callout_reset(&pffast_callout, hz/5, pffasttimo, NULL);