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>
42 #include <sys/epoch.h>
44 #include <sys/kernel.h>
46 #include <sys/mutex.h>
47 #include <sys/rmlock.h>
48 #include <sys/socketvar.h>
49 #include <sys/systm.h>
51 #include <machine/atomic.h>
55 struct domainhead domains = SLIST_HEAD_INITIALIZER(&domains);
56 int domain_init_status = 1;
57 static struct mtx dom_mtx; /* domain list lock */
58 MTX_SYSINIT(domain, &dom_mtx, "domain list", MTX_DEF);
61 pr_accept_notsupp(struct socket *so, struct sockaddr **nam)
67 pr_aio_queue_notsupp(struct socket *so, struct kaiocb *job)
73 pr_bind_notsupp(struct socket *so, struct sockaddr *nam, struct thread *td)
79 pr_bindat_notsupp(int fd, struct socket *so, struct sockaddr *nam,
86 pr_connect_notsupp(struct socket *so, struct sockaddr *nam, struct thread *td)
92 pr_connectat_notsupp(int fd, struct socket *so, struct sockaddr *nam,
99 pr_connect2_notsupp(struct socket *so1, struct socket *so2)
105 pr_control_notsupp(struct socket *so, u_long cmd, void *data,
106 struct ifnet *ifp, struct thread *td)
112 pr_disconnect_notsupp(struct socket *so)
118 pr_listen_notsupp(struct socket *so, int backlog, struct thread *td)
124 pr_peeraddr_notsupp(struct socket *so, struct sockaddr **nam)
130 pr_rcvd_notsupp(struct socket *so, int flags)
136 pr_rcvoob_notsupp(struct socket *so, struct mbuf *m, int flags)
142 pr_send_notsupp(struct socket *so, int flags, struct mbuf *m,
143 struct sockaddr *addr, struct mbuf *control, struct thread *td)
147 if ((flags & PRUS_NOTREADY) == 0)
153 pr_ready_notsupp(struct socket *so, struct mbuf *m, int count)
159 pr_shutdown_notsupp(struct socket *so)
165 pr_sockaddr_notsupp(struct socket *so, struct sockaddr **nam)
171 pr_sosend_notsupp(struct socket *so, struct sockaddr *addr, struct uio *uio,
172 struct mbuf *top, struct mbuf *control, int flags, struct thread *td)
178 pr_soreceive_notsupp(struct socket *so, struct sockaddr **paddr,
179 struct uio *uio, struct mbuf **mp0, struct mbuf **controlp, int *flagsp)
185 pr_sopoll_notsupp(struct socket *so, int events, struct ucred *cred,
192 pr_init(struct domain *dom, struct protosw *pr)
195 KASSERT(pr->pr_attach != NULL,
196 ("%s: protocol doesn't have pr_attach", __func__));
200 #define DEFAULT(foo, bar) if (pr->foo == NULL) pr->foo = bar
201 DEFAULT(pr_sosend, sosend_generic);
202 DEFAULT(pr_soreceive, soreceive_generic);
203 DEFAULT(pr_sopoll, sopoll_generic);
204 DEFAULT(pr_setsbopt, sbsetopt);
206 #define NOTSUPP(foo) if (pr->foo == NULL) pr->foo = foo ## _notsupp
208 NOTSUPP(pr_aio_queue);
212 NOTSUPP(pr_connect2);
213 NOTSUPP(pr_connectat);
215 NOTSUPP(pr_disconnect);
217 NOTSUPP(pr_peeraddr);
221 NOTSUPP(pr_shutdown);
222 NOTSUPP(pr_sockaddr);
224 NOTSUPP(pr_soreceive);
230 * Add a new protocol domain to the list of supported domains
231 * Note: you cant unload it again because a socket may be using it.
232 * XXX can't fail at this time.
235 domain_add(struct domain *dp)
239 MPASS(IS_DEFAULT_VNET(curvnet));
241 if (dp->dom_probe != NULL && (*dp->dom_probe)() != 0)
244 for (int i = 0; i < dp->dom_nprotosw; i++)
245 if ((pr = dp->dom_protosw[i]) != NULL)
251 SLIST_FOREACH(tmp, &domains, dom_next)
252 MPASS(tmp->dom_family != dp->dom_family);
254 SLIST_INSERT_HEAD(&domains, dp, dom_next);
255 mtx_unlock(&dom_mtx);
259 domain_remove(struct domain *dp)
262 if ((dp->dom_flags & DOMF_UNLOADABLE) == 0)
266 SLIST_REMOVE(&domains, dp, domain, dom_next);
267 mtx_unlock(&dom_mtx);
271 domainfinalize(void *dummy)
275 KASSERT(domain_init_status == 1, ("domainfinalize called too late!"));
276 domain_init_status = 2;
277 mtx_unlock(&dom_mtx);
279 SYSINIT(domainfin, SI_SUB_PROTO_IFATTACHDOMAIN, SI_ORDER_FIRST, domainfinalize,
283 pffinddomain(int family)
287 SLIST_FOREACH(dp, &domains, dom_next)
288 if (dp->dom_family == family)
294 pffindproto(int family, int type, int proto)
299 dp = pffinddomain(family);
303 for (int i = 0; i < dp->dom_nprotosw; i++)
304 if ((pr = dp->dom_protosw[i]) != NULL && pr->pr_type == type &&
305 (pr->pr_protocol == 0 || proto == 0 ||
306 pr->pr_protocol == proto))
313 * The caller must make sure that the new protocol is fully set up and ready to
314 * accept requests before it is registered.
317 protosw_register(struct domain *dp, struct protosw *npr)
319 struct protosw **prp;
322 MPASS(npr && npr->pr_type > 0 && npr->pr_protocol > 0);
326 * Protect us against races when two protocol registrations for
327 * the same protocol happen at the same time.
330 for (int i = 0; i < dp->dom_nprotosw; i++) {
331 if (dp->dom_protosw[i] == NULL) {
332 /* Remember the first free spacer. */
334 prp = &dp->dom_protosw[i];
337 * The new protocol must not yet exist.
338 * XXXAO: Check only protocol?
339 * XXXGL: Maybe assert that it doesn't exist?
341 if ((dp->dom_protosw[i]->pr_type == npr->pr_type) &&
342 (dp->dom_protosw[i]->pr_protocol ==
344 mtx_unlock(&dom_mtx);
351 /* If no free spacer is found we can't add the new protocol. */
353 mtx_unlock(&dom_mtx);
359 mtx_unlock(&dom_mtx);
365 * The caller must make sure the protocol and its functions correctly shut down
366 * all sockets and release all locks and memory references.
369 protosw_unregister(struct protosw *pr)
372 struct protosw **prp;
378 /* The protocol must exist and only once. */
379 for (int i = 0; i < dp->dom_nprotosw; i++) {
380 if (dp->dom_protosw[i] == pr) {
382 ("%s: domain %p protocol %p registered twice\n",
384 prp = &dp->dom_protosw[i];
388 /* Protocol does not exist. XXXGL: assert that it does? */
390 mtx_unlock(&dom_mtx);
391 return (EPROTONOSUPPORT);
394 /* De-orbit the protocol and make the slot available again. */
396 mtx_unlock(&dom_mtx);