2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1982, 1986, 1989, 1991, 1993
5 * The Regents of the University of California. All Rights Reserved.
6 * Copyright (c) 2004-2009 Robert N. M. Watson All Rights Reserved.
7 * Copyright (c) 2018 Matthew Macy
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * From: @(#)uipc_usrreq.c 8.3 (Berkeley) 1/4/94
37 * UNIX Domain (Local) Sockets
39 * This is an implementation of UNIX (local) domain sockets. Each socket has
40 * an associated struct unpcb (UNIX protocol control block). Stream sockets
41 * may be connected to 0 or 1 other socket. Datagram sockets may be
42 * connected to 0, 1, or many other sockets. Sockets may be created and
43 * connected in pairs (socketpair(2)), or bound/connected to using the file
44 * system name space. For most purposes, only the receive socket buffer is
45 * used, as sending on one socket delivers directly to the receive socket
46 * buffer of a second socket.
48 * The implementation is substantially complicated by the fact that
49 * "ancillary data", such as file descriptors or credentials, may be passed
50 * across UNIX domain sockets. The potential for passing UNIX domain sockets
51 * over other UNIX domain sockets requires the implementation of a simple
52 * garbage collector to find and tear down cycles of disconnected sockets.
56 * rethink name space problems
57 * need a proper out-of-band
60 #include <sys/cdefs.h>
61 __FBSDID("$FreeBSD$");
65 #include <sys/param.h>
66 #include <sys/capsicum.h>
67 #include <sys/domain.h>
68 #include <sys/eventhandler.h>
69 #include <sys/fcntl.h>
71 #include <sys/filedesc.h>
72 #include <sys/kernel.h>
74 #include <sys/malloc.h>
76 #include <sys/mount.h>
77 #include <sys/mutex.h>
78 #include <sys/namei.h>
80 #include <sys/protosw.h>
81 #include <sys/queue.h>
82 #include <sys/resourcevar.h>
83 #include <sys/rwlock.h>
84 #include <sys/socket.h>
85 #include <sys/socketvar.h>
86 #include <sys/signalvar.h>
89 #include <sys/sysctl.h>
90 #include <sys/systm.h>
91 #include <sys/taskqueue.h>
93 #include <sys/unpcb.h>
94 #include <sys/vnode.h>
102 #include <security/mac/mac_framework.h>
106 MALLOC_DECLARE(M_FILECAPS);
109 * See unpcb.h for the locking key.
112 static uma_zone_t unp_zone;
113 static unp_gen_t unp_gencnt; /* (l) */
114 static u_int unp_count; /* (l) Count of local sockets. */
115 static ino_t unp_ino; /* Prototype for fake inode numbers. */
116 static int unp_rights; /* (g) File descriptors in flight. */
117 static struct unp_head unp_shead; /* (l) List of stream sockets. */
118 static struct unp_head unp_dhead; /* (l) List of datagram sockets. */
119 static struct unp_head unp_sphead; /* (l) List of seqpacket sockets. */
122 SLIST_ENTRY(unp_defer) ud_link;
125 static SLIST_HEAD(, unp_defer) unp_defers;
126 static int unp_defers_count;
128 static const struct sockaddr sun_noname = { sizeof(sun_noname), AF_LOCAL };
131 * Garbage collection of cyclic file descriptor/socket references occurs
132 * asynchronously in a taskqueue context in order to avoid recursion and
133 * reentrance in the UNIX domain socket, file descriptor, and socket layer
134 * code. See unp_gc() for a full description.
136 static struct timeout_task unp_gc_task;
139 * The close of unix domain sockets attached as SCM_RIGHTS is
140 * postponed to the taskqueue, to avoid arbitrary recursion depth.
141 * The attached sockets might have another sockets attached.
143 static struct task unp_defer_task;
146 * Both send and receive buffers are allocated PIPSIZ bytes of buffering for
147 * stream sockets, although the total for sender and receiver is actually
150 * Datagram sockets really use the sendspace as the maximum datagram size,
151 * and don't really want to reserve the sendspace. Their recvspace should be
152 * large enough for at least one max-size datagram plus address.
157 static u_long unpst_sendspace = PIPSIZ;
158 static u_long unpst_recvspace = PIPSIZ;
159 static u_long unpdg_sendspace = 2*1024; /* really max datagram size */
160 static u_long unpdg_recvspace = 4*1024;
161 static u_long unpsp_sendspace = PIPSIZ; /* really max datagram size */
162 static u_long unpsp_recvspace = PIPSIZ;
164 static SYSCTL_NODE(_net, PF_LOCAL, local, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
166 static SYSCTL_NODE(_net_local, SOCK_STREAM, stream,
167 CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
169 static SYSCTL_NODE(_net_local, SOCK_DGRAM, dgram,
170 CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
172 static SYSCTL_NODE(_net_local, SOCK_SEQPACKET, seqpacket,
173 CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
176 SYSCTL_ULONG(_net_local_stream, OID_AUTO, sendspace, CTLFLAG_RW,
177 &unpst_sendspace, 0, "Default stream send space.");
178 SYSCTL_ULONG(_net_local_stream, OID_AUTO, recvspace, CTLFLAG_RW,
179 &unpst_recvspace, 0, "Default stream receive space.");
180 SYSCTL_ULONG(_net_local_dgram, OID_AUTO, maxdgram, CTLFLAG_RW,
181 &unpdg_sendspace, 0, "Default datagram send space.");
182 SYSCTL_ULONG(_net_local_dgram, OID_AUTO, recvspace, CTLFLAG_RW,
183 &unpdg_recvspace, 0, "Default datagram receive space.");
184 SYSCTL_ULONG(_net_local_seqpacket, OID_AUTO, maxseqpacket, CTLFLAG_RW,
185 &unpsp_sendspace, 0, "Default seqpacket send space.");
186 SYSCTL_ULONG(_net_local_seqpacket, OID_AUTO, recvspace, CTLFLAG_RW,
187 &unpsp_recvspace, 0, "Default seqpacket receive space.");
188 SYSCTL_INT(_net_local, OID_AUTO, inflight, CTLFLAG_RD, &unp_rights, 0,
189 "File descriptors in flight.");
190 SYSCTL_INT(_net_local, OID_AUTO, deferred, CTLFLAG_RD,
191 &unp_defers_count, 0,
192 "File descriptors deferred to taskqueue for close.");
195 * Locking and synchronization:
197 * Several types of locks exist in the local domain socket implementation:
198 * - a global linkage lock
199 * - a global connection list lock
201 * - per-unpcb mutexes
203 * The linkage lock protects the global socket lists, the generation number
204 * counter and garbage collector state.
206 * The connection list lock protects the list of referring sockets in a datagram
207 * socket PCB. This lock is also overloaded to protect a global list of
208 * sockets whose buffers contain socket references in the form of SCM_RIGHTS
209 * messages. To avoid recursion, such references are released by a dedicated
212 * The mtxpool lock protects the vnode from being modified while referenced.
213 * Lock ordering rules require that it be acquired before any PCB locks.
215 * The unpcb lock (unp_mtx) protects the most commonly referenced fields in the
216 * unpcb. This includes the unp_conn field, which either links two connected
217 * PCBs together (for connected socket types) or points at the destination
218 * socket (for connectionless socket types). The operations of creating or
219 * destroying a connection therefore involve locking multiple PCBs. To avoid
220 * lock order reversals, in some cases this involves dropping a PCB lock and
221 * using a reference counter to maintain liveness.
223 * UNIX domain sockets each have an unpcb hung off of their so_pcb pointer,
224 * allocated in pru_attach() and freed in pru_detach(). The validity of that
225 * pointer is an invariant, so no lock is required to dereference the so_pcb
226 * pointer if a valid socket reference is held by the caller. In practice,
227 * this is always true during operations performed on a socket. Each unpcb
228 * has a back-pointer to its socket, unp_socket, which will be stable under
229 * the same circumstances.
231 * This pointer may only be safely dereferenced as long as a valid reference
232 * to the unpcb is held. Typically, this reference will be from the socket,
233 * or from another unpcb when the referring unpcb's lock is held (in order
234 * that the reference not be invalidated during use). For example, to follow
235 * unp->unp_conn->unp_socket, you need to hold a lock on unp_conn to guarantee
236 * that detach is not run clearing unp_socket.
238 * Blocking with UNIX domain sockets is a tricky issue: unlike most network
239 * protocols, bind() is a non-atomic operation, and connect() requires
240 * potential sleeping in the protocol, due to potentially waiting on local or
241 * distributed file systems. We try to separate "lookup" operations, which
242 * may sleep, and the IPC operations themselves, which typically can occur
243 * with relative atomicity as locks can be held over the entire operation.
245 * Another tricky issue is simultaneous multi-threaded or multi-process
246 * access to a single UNIX domain socket. These are handled by the flags
247 * UNP_CONNECTING and UNP_BINDING, which prevent concurrent connecting or
248 * binding, both of which involve dropping UNIX domain socket locks in order
249 * to perform namei() and other file system operations.
251 static struct rwlock unp_link_rwlock;
252 static struct mtx unp_defers_lock;
254 #define UNP_LINK_LOCK_INIT() rw_init(&unp_link_rwlock, \
257 #define UNP_LINK_LOCK_ASSERT() rw_assert(&unp_link_rwlock, \
259 #define UNP_LINK_UNLOCK_ASSERT() rw_assert(&unp_link_rwlock, \
262 #define UNP_LINK_RLOCK() rw_rlock(&unp_link_rwlock)
263 #define UNP_LINK_RUNLOCK() rw_runlock(&unp_link_rwlock)
264 #define UNP_LINK_WLOCK() rw_wlock(&unp_link_rwlock)
265 #define UNP_LINK_WUNLOCK() rw_wunlock(&unp_link_rwlock)
266 #define UNP_LINK_WLOCK_ASSERT() rw_assert(&unp_link_rwlock, \
268 #define UNP_LINK_WOWNED() rw_wowned(&unp_link_rwlock)
270 #define UNP_DEFERRED_LOCK_INIT() mtx_init(&unp_defers_lock, \
271 "unp_defer", NULL, MTX_DEF)
272 #define UNP_DEFERRED_LOCK() mtx_lock(&unp_defers_lock)
273 #define UNP_DEFERRED_UNLOCK() mtx_unlock(&unp_defers_lock)
275 #define UNP_REF_LIST_LOCK() UNP_DEFERRED_LOCK();
276 #define UNP_REF_LIST_UNLOCK() UNP_DEFERRED_UNLOCK();
278 #define UNP_PCB_LOCK_INIT(unp) mtx_init(&(unp)->unp_mtx, \
281 #define UNP_PCB_LOCK_DESTROY(unp) mtx_destroy(&(unp)->unp_mtx)
282 #define UNP_PCB_LOCKPTR(unp) (&(unp)->unp_mtx)
283 #define UNP_PCB_LOCK(unp) mtx_lock(&(unp)->unp_mtx)
284 #define UNP_PCB_TRYLOCK(unp) mtx_trylock(&(unp)->unp_mtx)
285 #define UNP_PCB_UNLOCK(unp) mtx_unlock(&(unp)->unp_mtx)
286 #define UNP_PCB_OWNED(unp) mtx_owned(&(unp)->unp_mtx)
287 #define UNP_PCB_LOCK_ASSERT(unp) mtx_assert(&(unp)->unp_mtx, MA_OWNED)
288 #define UNP_PCB_UNLOCK_ASSERT(unp) mtx_assert(&(unp)->unp_mtx, MA_NOTOWNED)
290 static int uipc_connect2(struct socket *, struct socket *);
291 static int uipc_ctloutput(struct socket *, struct sockopt *);
292 static int unp_connect(struct socket *, struct sockaddr *,
294 static int unp_connectat(int, struct socket *, struct sockaddr *,
296 static int unp_connect2(struct socket *so, struct socket *so2, int);
297 static void unp_disconnect(struct unpcb *unp, struct unpcb *unp2);
298 static void unp_dispose(struct socket *so);
299 static void unp_dispose_mbuf(struct mbuf *);
300 static void unp_shutdown(struct unpcb *);
301 static void unp_drop(struct unpcb *);
302 static void unp_gc(__unused void *, int);
303 static void unp_scan(struct mbuf *, void (*)(struct filedescent **, int));
304 static void unp_discard(struct file *);
305 static void unp_freerights(struct filedescent **, int);
306 static void unp_init(void);
307 static int unp_internalize(struct mbuf **, struct thread *);
308 static void unp_internalize_fp(struct file *);
309 static int unp_externalize(struct mbuf *, struct mbuf **, int);
310 static int unp_externalize_fp(struct file *);
311 static struct mbuf *unp_addsockcred(struct thread *, struct mbuf *, int);
312 static void unp_process_defers(void * __unused, int);
315 unp_pcb_hold(struct unpcb *unp)
319 old = refcount_acquire(&unp->unp_refcount);
320 KASSERT(old > 0, ("%s: unpcb %p has no references", __func__, unp));
323 static __result_use_check bool
324 unp_pcb_rele(struct unpcb *unp)
328 UNP_PCB_LOCK_ASSERT(unp);
330 if ((ret = refcount_release(&unp->unp_refcount))) {
332 UNP_PCB_LOCK_DESTROY(unp);
333 uma_zfree(unp_zone, unp);
339 unp_pcb_rele_notlast(struct unpcb *unp)
343 ret = refcount_release(&unp->unp_refcount);
344 KASSERT(!ret, ("%s: unpcb %p has no references", __func__, unp));
348 unp_pcb_lock_pair(struct unpcb *unp, struct unpcb *unp2)
350 UNP_PCB_UNLOCK_ASSERT(unp);
351 UNP_PCB_UNLOCK_ASSERT(unp2);
355 } else if ((uintptr_t)unp2 > (uintptr_t)unp) {
365 unp_pcb_unlock_pair(struct unpcb *unp, struct unpcb *unp2)
369 UNP_PCB_UNLOCK(unp2);
373 * Try to lock the connected peer of an already locked socket. In some cases
374 * this requires that we unlock the current socket. The pairbusy counter is
375 * used to block concurrent connection attempts while the lock is dropped. The
376 * caller must be careful to revalidate PCB state.
378 static struct unpcb *
379 unp_pcb_lock_peer(struct unpcb *unp)
383 UNP_PCB_LOCK_ASSERT(unp);
384 unp2 = unp->unp_conn;
387 if (__predict_false(unp == unp2))
390 UNP_PCB_UNLOCK_ASSERT(unp2);
392 if (__predict_true(UNP_PCB_TRYLOCK(unp2)))
394 if ((uintptr_t)unp2 > (uintptr_t)unp) {
404 KASSERT(unp->unp_conn == unp2 || unp->unp_conn == NULL,
405 ("%s: socket %p was reconnected", __func__, unp));
406 if (--unp->unp_pairbusy == 0 && (unp->unp_flags & UNP_WAITING) != 0) {
407 unp->unp_flags &= ~UNP_WAITING;
410 if (unp_pcb_rele(unp2)) {
411 /* unp2 is unlocked. */
414 if (unp->unp_conn == NULL) {
415 UNP_PCB_UNLOCK(unp2);
422 * Definitions of protocols supported in the LOCAL domain.
424 static struct domain localdomain;
425 static struct pr_usrreqs uipc_usrreqs_dgram, uipc_usrreqs_stream;
426 static struct pr_usrreqs uipc_usrreqs_seqpacket;
427 static struct protosw localsw[] = {
429 .pr_type = SOCK_STREAM,
430 .pr_domain = &localdomain,
431 .pr_flags = PR_CONNREQUIRED|PR_WANTRCVD|PR_RIGHTS,
432 .pr_ctloutput = &uipc_ctloutput,
433 .pr_usrreqs = &uipc_usrreqs_stream
436 .pr_type = SOCK_DGRAM,
437 .pr_domain = &localdomain,
438 .pr_flags = PR_ATOMIC|PR_ADDR|PR_RIGHTS,
439 .pr_ctloutput = &uipc_ctloutput,
440 .pr_usrreqs = &uipc_usrreqs_dgram
443 .pr_type = SOCK_SEQPACKET,
444 .pr_domain = &localdomain,
447 * XXXRW: For now, PR_ADDR because soreceive will bump into them
448 * due to our use of sbappendaddr. A new sbappend variants is needed
449 * that supports both atomic record writes and control data.
451 .pr_flags = PR_ADDR|PR_ATOMIC|PR_CONNREQUIRED|PR_WANTRCVD|
453 .pr_ctloutput = &uipc_ctloutput,
454 .pr_usrreqs = &uipc_usrreqs_seqpacket,
458 static struct domain localdomain = {
459 .dom_family = AF_LOCAL,
461 .dom_init = unp_init,
462 .dom_externalize = unp_externalize,
463 .dom_dispose = unp_dispose,
464 .dom_protosw = localsw,
465 .dom_protoswNPROTOSW = &localsw[nitems(localsw)]
470 uipc_abort(struct socket *so)
472 struct unpcb *unp, *unp2;
475 KASSERT(unp != NULL, ("uipc_abort: unp == NULL"));
476 UNP_PCB_UNLOCK_ASSERT(unp);
479 unp2 = unp->unp_conn;
489 uipc_accept(struct socket *so, struct sockaddr **nam)
491 struct unpcb *unp, *unp2;
492 const struct sockaddr *sa;
495 * Pass back name of connected socket, if it was bound and we are
496 * still connected (our peer may have closed already!).
499 KASSERT(unp != NULL, ("uipc_accept: unp == NULL"));
501 *nam = malloc(sizeof(struct sockaddr_un), M_SONAME, M_WAITOK);
503 unp2 = unp_pcb_lock_peer(unp);
504 if (unp2 != NULL && unp2->unp_addr != NULL)
505 sa = (struct sockaddr *)unp2->unp_addr;
508 bcopy(sa, *nam, sa->sa_len);
510 unp_pcb_unlock_pair(unp, unp2);
517 uipc_attach(struct socket *so, int proto, struct thread *td)
519 u_long sendspace, recvspace;
524 KASSERT(so->so_pcb == NULL, ("uipc_attach: so_pcb != NULL"));
525 if (so->so_snd.sb_hiwat == 0 || so->so_rcv.sb_hiwat == 0) {
526 switch (so->so_type) {
528 sendspace = unpst_sendspace;
529 recvspace = unpst_recvspace;
533 sendspace = unpdg_sendspace;
534 recvspace = unpdg_recvspace;
538 sendspace = unpsp_sendspace;
539 recvspace = unpsp_recvspace;
543 panic("uipc_attach");
545 error = soreserve(so, sendspace, recvspace);
549 unp = uma_zalloc(unp_zone, M_NOWAIT | M_ZERO);
552 LIST_INIT(&unp->unp_refs);
553 UNP_PCB_LOCK_INIT(unp);
554 unp->unp_socket = so;
556 refcount_init(&unp->unp_refcount, 1);
558 if ((locked = UNP_LINK_WOWNED()) == false)
561 unp->unp_gencnt = ++unp_gencnt;
562 unp->unp_ino = ++unp_ino;
564 switch (so->so_type) {
566 LIST_INSERT_HEAD(&unp_shead, unp, unp_link);
570 LIST_INSERT_HEAD(&unp_dhead, unp, unp_link);
574 LIST_INSERT_HEAD(&unp_sphead, unp, unp_link);
578 panic("uipc_attach");
588 uipc_bindat(int fd, struct socket *so, struct sockaddr *nam, struct thread *td)
590 struct sockaddr_un *soun = (struct sockaddr_un *)nam;
600 if (nam->sa_family != AF_UNIX)
601 return (EAFNOSUPPORT);
604 KASSERT(unp != NULL, ("uipc_bind: unp == NULL"));
606 if (soun->sun_len > sizeof(struct sockaddr_un))
608 namelen = soun->sun_len - offsetof(struct sockaddr_un, sun_path);
613 * We don't allow simultaneous bind() calls on a single UNIX domain
614 * socket, so flag in-progress operations, and return an error if an
615 * operation is already in progress.
617 * Historically, we have not allowed a socket to be rebound, so this
618 * also returns an error. Not allowing re-binding simplifies the
619 * implementation and avoids a great many possible failure modes.
622 if (unp->unp_vnode != NULL) {
626 if (unp->unp_flags & UNP_BINDING) {
630 unp->unp_flags |= UNP_BINDING;
633 buf = malloc(namelen + 1, M_TEMP, M_WAITOK);
634 bcopy(soun->sun_path, buf, namelen);
638 NDINIT_ATRIGHTS(&nd, CREATE, NOFOLLOW | LOCKPARENT | SAVENAME | NOCACHE,
639 UIO_SYSSPACE, buf, fd, cap_rights_init_one(&rights, CAP_BINDAT),
641 /* SHOULD BE ABLE TO ADOPT EXISTING AND wakeup() ALA FIFO's */
646 if (vp != NULL || vn_start_write(nd.ni_dvp, &mp, V_NOWAIT) != 0) {
647 NDFREE(&nd, NDF_ONLY_PNBUF);
657 error = vn_start_write(NULL, &mp, V_XSLEEP | PCATCH);
663 vattr.va_type = VSOCK;
664 vattr.va_mode = (ACCESSPERMS & ~td->td_proc->p_pd->pd_cmask);
666 error = mac_vnode_check_create(td->td_ucred, nd.ni_dvp, &nd.ni_cnd,
670 error = VOP_CREATE(nd.ni_dvp, &nd.ni_vp, &nd.ni_cnd, &vattr);
671 NDFREE(&nd, NDF_ONLY_PNBUF);
673 VOP_VPUT_PAIR(nd.ni_dvp, NULL, true);
674 vn_finished_write(mp);
675 if (error == ERELOOKUP)
680 ASSERT_VOP_ELOCKED(vp, "uipc_bind");
681 soun = (struct sockaddr_un *)sodupsockaddr(nam, M_WAITOK);
684 VOP_UNP_BIND(vp, unp);
686 unp->unp_addr = soun;
687 unp->unp_flags &= ~UNP_BINDING;
690 VOP_VPUT_PAIR(nd.ni_dvp, &vp, true);
691 vn_finished_write(mp);
697 unp->unp_flags &= ~UNP_BINDING;
704 uipc_bind(struct socket *so, struct sockaddr *nam, struct thread *td)
707 return (uipc_bindat(AT_FDCWD, so, nam, td));
711 uipc_connect(struct socket *so, struct sockaddr *nam, struct thread *td)
715 KASSERT(td == curthread, ("uipc_connect: td != curthread"));
716 error = unp_connect(so, nam, td);
721 uipc_connectat(int fd, struct socket *so, struct sockaddr *nam,
726 KASSERT(td == curthread, ("uipc_connectat: td != curthread"));
727 error = unp_connectat(fd, so, nam, td);
732 uipc_close(struct socket *so)
734 struct unpcb *unp, *unp2;
735 struct vnode *vp = NULL;
739 KASSERT(unp != NULL, ("uipc_close: unp == NULL"));
742 if ((vp = unp->unp_vnode) != NULL) {
743 vplock = mtx_pool_find(mtxpool_sleep, vp);
747 if (vp && unp->unp_vnode == NULL) {
753 unp->unp_vnode = NULL;
755 if ((unp2 = unp_pcb_lock_peer(unp)) != NULL)
756 unp_disconnect(unp, unp2);
766 uipc_connect2(struct socket *so1, struct socket *so2)
768 struct unpcb *unp, *unp2;
772 KASSERT(unp != NULL, ("uipc_connect2: unp == NULL"));
774 KASSERT(unp2 != NULL, ("uipc_connect2: unp2 == NULL"));
775 unp_pcb_lock_pair(unp, unp2);
776 error = unp_connect2(so1, so2, PRU_CONNECT2);
777 unp_pcb_unlock_pair(unp, unp2);
782 uipc_detach(struct socket *so)
784 struct unpcb *unp, *unp2;
787 int local_unp_rights;
790 KASSERT(unp != NULL, ("uipc_detach: unp == NULL"));
796 if (!SOLISTENING(so)) {
798 * Once the socket is removed from the global lists,
799 * uipc_ready() will not be able to locate its socket buffer, so
800 * clear the buffer now. At this point internalized rights have
801 * already been disposed of.
803 sbrelease(&so->so_rcv, so);
808 LIST_REMOVE(unp, unp_link);
809 if (unp->unp_gcflag & UNPGC_DEAD)
810 LIST_REMOVE(unp, unp_dead);
811 unp->unp_gencnt = ++unp_gencnt;
815 UNP_PCB_UNLOCK_ASSERT(unp);
817 if ((vp = unp->unp_vnode) != NULL) {
818 vplock = mtx_pool_find(mtxpool_sleep, vp);
822 if (unp->unp_vnode != vp && unp->unp_vnode != NULL) {
828 if ((vp = unp->unp_vnode) != NULL) {
830 unp->unp_vnode = NULL;
832 if ((unp2 = unp_pcb_lock_peer(unp)) != NULL)
833 unp_disconnect(unp, unp2);
838 while (!LIST_EMPTY(&unp->unp_refs)) {
839 struct unpcb *ref = LIST_FIRST(&unp->unp_refs);
842 UNP_REF_LIST_UNLOCK();
845 UNP_PCB_UNLOCK_ASSERT(ref);
849 UNP_REF_LIST_UNLOCK();
852 local_unp_rights = unp_rights;
853 unp->unp_socket->so_pcb = NULL;
854 unp->unp_socket = NULL;
855 free(unp->unp_addr, M_SONAME);
856 unp->unp_addr = NULL;
857 if (!unp_pcb_rele(unp))
863 if (local_unp_rights)
864 taskqueue_enqueue_timeout(taskqueue_thread, &unp_gc_task, -1);
868 uipc_disconnect(struct socket *so)
870 struct unpcb *unp, *unp2;
873 KASSERT(unp != NULL, ("uipc_disconnect: unp == NULL"));
876 if ((unp2 = unp_pcb_lock_peer(unp)) != NULL)
877 unp_disconnect(unp, unp2);
884 uipc_listen(struct socket *so, int backlog, struct thread *td)
889 if (so->so_type != SOCK_STREAM && so->so_type != SOCK_SEQPACKET)
893 KASSERT(unp != NULL, ("uipc_listen: unp == NULL"));
896 if (unp->unp_vnode == NULL) {
897 /* Already connected or not bound to an address. */
898 error = unp->unp_conn != NULL ? EINVAL : EDESTADDRREQ;
904 error = solisten_proto_check(so);
906 cru2xt(td, &unp->unp_peercred);
907 solisten_proto(so, backlog);
915 uipc_peeraddr(struct socket *so, struct sockaddr **nam)
917 struct unpcb *unp, *unp2;
918 const struct sockaddr *sa;
921 KASSERT(unp != NULL, ("uipc_peeraddr: unp == NULL"));
923 *nam = malloc(sizeof(struct sockaddr_un), M_SONAME, M_WAITOK);
926 * XXX: It seems that this test always fails even when connection is
927 * established. So, this else clause is added as workaround to
928 * return PF_LOCAL sockaddr.
930 unp2 = unp->unp_conn;
933 if (unp2->unp_addr != NULL)
934 sa = (struct sockaddr *) unp2->unp_addr;
937 bcopy(sa, *nam, sa->sa_len);
938 UNP_PCB_UNLOCK(unp2);
941 bcopy(sa, *nam, sa->sa_len);
948 uipc_rcvd(struct socket *so, int flags)
950 struct unpcb *unp, *unp2;
955 KASSERT(unp != NULL, ("%s: unp == NULL", __func__));
956 KASSERT(so->so_type == SOCK_STREAM || so->so_type == SOCK_SEQPACKET,
957 ("%s: socktype %d", __func__, so->so_type));
960 * Adjust backpressure on sender and wakeup any waiting to write.
962 * The unp lock is acquired to maintain the validity of the unp_conn
963 * pointer; no lock on unp2 is required as unp2->unp_socket will be
964 * static as long as we don't permit unp2 to disconnect from unp,
965 * which is prevented by the lock on unp. We cache values from
966 * so_rcv to avoid holding the so_rcv lock over the entire
967 * transaction on the remote so_snd.
969 SOCKBUF_LOCK(&so->so_rcv);
970 mbcnt = so->so_rcv.sb_mbcnt;
971 sbcc = sbavail(&so->so_rcv);
972 SOCKBUF_UNLOCK(&so->so_rcv);
974 * There is a benign race condition at this point. If we're planning to
975 * clear SB_STOP, but uipc_send is called on the connected socket at
976 * this instant, it might add data to the sockbuf and set SB_STOP. Then
977 * we would erroneously clear SB_STOP below, even though the sockbuf is
978 * full. The race is benign because the only ill effect is to allow the
979 * sockbuf to exceed its size limit, and the size limits are not
980 * strictly guaranteed anyway.
983 unp2 = unp->unp_conn;
988 so2 = unp2->unp_socket;
989 SOCKBUF_LOCK(&so2->so_snd);
990 if (sbcc < so2->so_snd.sb_hiwat && mbcnt < so2->so_snd.sb_mbmax)
991 so2->so_snd.sb_flags &= ~SB_STOP;
992 sowwakeup_locked(so2);
998 uipc_send(struct socket *so, int flags, struct mbuf *m, struct sockaddr *nam,
999 struct mbuf *control, struct thread *td)
1001 struct unpcb *unp, *unp2;
1006 unp = sotounpcb(so);
1007 KASSERT(unp != NULL, ("%s: unp == NULL", __func__));
1008 KASSERT(so->so_type == SOCK_STREAM || so->so_type == SOCK_DGRAM ||
1009 so->so_type == SOCK_SEQPACKET,
1010 ("%s: socktype %d", __func__, so->so_type));
1013 if (flags & PRUS_OOB) {
1017 if (control != NULL && (error = unp_internalize(&control, td)))
1021 switch (so->so_type) {
1024 const struct sockaddr *from;
1027 error = unp_connect(so, nam, td);
1034 * Because connect() and send() are non-atomic in a sendto()
1035 * with a target address, it's possible that the socket will
1036 * have disconnected before the send() can run. In that case
1037 * return the slightly counter-intuitive but otherwise
1038 * correct error that the socket is not connected.
1040 unp2 = unp_pcb_lock_peer(unp);
1042 UNP_PCB_UNLOCK(unp);
1047 if (unp2->unp_flags & UNP_WANTCRED_MASK)
1048 control = unp_addsockcred(td, control,
1050 if (unp->unp_addr != NULL)
1051 from = (struct sockaddr *)unp->unp_addr;
1054 so2 = unp2->unp_socket;
1055 SOCKBUF_LOCK(&so2->so_rcv);
1056 if (sbappendaddr_locked(&so2->so_rcv, from, m,
1058 sorwakeup_locked(so2);
1062 soroverflow_locked(so2);
1066 unp_disconnect(unp, unp2);
1068 unp_pcb_unlock_pair(unp, unp2);
1072 case SOCK_SEQPACKET:
1074 if ((so->so_state & SS_ISCONNECTED) == 0) {
1076 error = unp_connect(so, nam, td);
1086 if ((unp2 = unp_pcb_lock_peer(unp)) == NULL) {
1087 UNP_PCB_UNLOCK(unp);
1090 } else if (so->so_snd.sb_state & SBS_CANTSENDMORE) {
1091 unp_pcb_unlock_pair(unp, unp2);
1095 UNP_PCB_UNLOCK(unp);
1096 if ((so2 = unp2->unp_socket) == NULL) {
1097 UNP_PCB_UNLOCK(unp2);
1101 SOCKBUF_LOCK(&so2->so_rcv);
1102 if (unp2->unp_flags & UNP_WANTCRED_MASK) {
1104 * Credentials are passed only once on SOCK_STREAM and
1105 * SOCK_SEQPACKET (LOCAL_CREDS => WANTCRED_ONESHOT), or
1106 * forever (LOCAL_CREDS_PERSISTENT => WANTCRED_ALWAYS).
1108 control = unp_addsockcred(td, control, unp2->unp_flags);
1109 unp2->unp_flags &= ~UNP_WANTCRED_ONESHOT;
1113 * Send to paired receive port and wake up readers. Don't
1114 * check for space available in the receive buffer if we're
1115 * attaching ancillary data; Unix domain sockets only check
1116 * for space in the sending sockbuf, and that check is
1117 * performed one level up the stack. At that level we cannot
1118 * precisely account for the amount of buffer space used
1119 * (e.g., because control messages are not yet internalized).
1121 switch (so->so_type) {
1123 if (control != NULL) {
1124 sbappendcontrol_locked(&so2->so_rcv, m,
1128 sbappend_locked(&so2->so_rcv, m, flags);
1131 case SOCK_SEQPACKET:
1132 if (sbappendaddr_nospacecheck_locked(&so2->so_rcv,
1133 &sun_noname, m, control))
1138 mbcnt = so2->so_rcv.sb_mbcnt;
1139 sbcc = sbavail(&so2->so_rcv);
1141 sorwakeup_locked(so2);
1143 SOCKBUF_UNLOCK(&so2->so_rcv);
1146 * The PCB lock on unp2 protects the SB_STOP flag. Without it,
1147 * it would be possible for uipc_rcvd to be called at this
1148 * point, drain the receiving sockbuf, clear SB_STOP, and then
1149 * we would set SB_STOP below. That could lead to an empty
1150 * sockbuf having SB_STOP set
1152 SOCKBUF_LOCK(&so->so_snd);
1153 if (sbcc >= so->so_snd.sb_hiwat || mbcnt >= so->so_snd.sb_mbmax)
1154 so->so_snd.sb_flags |= SB_STOP;
1155 SOCKBUF_UNLOCK(&so->so_snd);
1156 UNP_PCB_UNLOCK(unp2);
1162 * PRUS_EOF is equivalent to pru_send followed by pru_shutdown.
1164 if (flags & PRUS_EOF) {
1168 UNP_PCB_UNLOCK(unp);
1170 if (control != NULL && error != 0)
1171 unp_dispose_mbuf(control);
1174 if (control != NULL)
1177 * In case of PRUS_NOTREADY, uipc_ready() is responsible
1178 * for freeing memory.
1180 if (m != NULL && (flags & PRUS_NOTREADY) == 0)
1186 uipc_ready_scan(struct socket *so, struct mbuf *m, int count, int *errorp)
1188 struct mbuf *mb, *n;
1192 if (SOLISTENING(so)) {
1199 if (sb->sb_fnrdy != NULL) {
1200 for (mb = sb->sb_mb, n = mb->m_nextpkt; mb != NULL;) {
1202 *errorp = sbready(sb, m, count);
1215 return (mb != NULL);
1219 uipc_ready(struct socket *so, struct mbuf *m, int count)
1221 struct unpcb *unp, *unp2;
1225 unp = sotounpcb(so);
1227 KASSERT(so->so_type == SOCK_STREAM,
1228 ("%s: unexpected socket type for %p", __func__, so));
1231 if ((unp2 = unp_pcb_lock_peer(unp)) != NULL) {
1232 UNP_PCB_UNLOCK(unp);
1233 so2 = unp2->unp_socket;
1234 SOCKBUF_LOCK(&so2->so_rcv);
1235 if ((error = sbready(&so2->so_rcv, m, count)) == 0)
1236 sorwakeup_locked(so2);
1238 SOCKBUF_UNLOCK(&so2->so_rcv);
1239 UNP_PCB_UNLOCK(unp2);
1242 UNP_PCB_UNLOCK(unp);
1245 * The receiving socket has been disconnected, but may still be valid.
1246 * In this case, the now-ready mbufs are still present in its socket
1247 * buffer, so perform an exhaustive search before giving up and freeing
1251 LIST_FOREACH(unp, &unp_shead, unp_link) {
1252 if (uipc_ready_scan(unp->unp_socket, m, count, &error))
1258 for (i = 0; i < count; i++)
1266 uipc_sense(struct socket *so, struct stat *sb)
1270 unp = sotounpcb(so);
1271 KASSERT(unp != NULL, ("uipc_sense: unp == NULL"));
1273 sb->st_blksize = so->so_snd.sb_hiwat;
1275 sb->st_ino = unp->unp_ino;
1280 uipc_shutdown(struct socket *so)
1284 unp = sotounpcb(so);
1285 KASSERT(unp != NULL, ("uipc_shutdown: unp == NULL"));
1290 UNP_PCB_UNLOCK(unp);
1295 uipc_sockaddr(struct socket *so, struct sockaddr **nam)
1298 const struct sockaddr *sa;
1300 unp = sotounpcb(so);
1301 KASSERT(unp != NULL, ("uipc_sockaddr: unp == NULL"));
1303 *nam = malloc(sizeof(struct sockaddr_un), M_SONAME, M_WAITOK);
1305 if (unp->unp_addr != NULL)
1306 sa = (struct sockaddr *) unp->unp_addr;
1309 bcopy(sa, *nam, sa->sa_len);
1310 UNP_PCB_UNLOCK(unp);
1314 static struct pr_usrreqs uipc_usrreqs_dgram = {
1315 .pru_abort = uipc_abort,
1316 .pru_accept = uipc_accept,
1317 .pru_attach = uipc_attach,
1318 .pru_bind = uipc_bind,
1319 .pru_bindat = uipc_bindat,
1320 .pru_connect = uipc_connect,
1321 .pru_connectat = uipc_connectat,
1322 .pru_connect2 = uipc_connect2,
1323 .pru_detach = uipc_detach,
1324 .pru_disconnect = uipc_disconnect,
1325 .pru_listen = uipc_listen,
1326 .pru_peeraddr = uipc_peeraddr,
1327 .pru_rcvd = uipc_rcvd,
1328 .pru_send = uipc_send,
1329 .pru_sense = uipc_sense,
1330 .pru_shutdown = uipc_shutdown,
1331 .pru_sockaddr = uipc_sockaddr,
1332 .pru_soreceive = soreceive_dgram,
1333 .pru_close = uipc_close,
1336 static struct pr_usrreqs uipc_usrreqs_seqpacket = {
1337 .pru_abort = uipc_abort,
1338 .pru_accept = uipc_accept,
1339 .pru_attach = uipc_attach,
1340 .pru_bind = uipc_bind,
1341 .pru_bindat = uipc_bindat,
1342 .pru_connect = uipc_connect,
1343 .pru_connectat = uipc_connectat,
1344 .pru_connect2 = uipc_connect2,
1345 .pru_detach = uipc_detach,
1346 .pru_disconnect = uipc_disconnect,
1347 .pru_listen = uipc_listen,
1348 .pru_peeraddr = uipc_peeraddr,
1349 .pru_rcvd = uipc_rcvd,
1350 .pru_send = uipc_send,
1351 .pru_sense = uipc_sense,
1352 .pru_shutdown = uipc_shutdown,
1353 .pru_sockaddr = uipc_sockaddr,
1354 .pru_soreceive = soreceive_generic, /* XXX: or...? */
1355 .pru_close = uipc_close,
1358 static struct pr_usrreqs uipc_usrreqs_stream = {
1359 .pru_abort = uipc_abort,
1360 .pru_accept = uipc_accept,
1361 .pru_attach = uipc_attach,
1362 .pru_bind = uipc_bind,
1363 .pru_bindat = uipc_bindat,
1364 .pru_connect = uipc_connect,
1365 .pru_connectat = uipc_connectat,
1366 .pru_connect2 = uipc_connect2,
1367 .pru_detach = uipc_detach,
1368 .pru_disconnect = uipc_disconnect,
1369 .pru_listen = uipc_listen,
1370 .pru_peeraddr = uipc_peeraddr,
1371 .pru_rcvd = uipc_rcvd,
1372 .pru_send = uipc_send,
1373 .pru_ready = uipc_ready,
1374 .pru_sense = uipc_sense,
1375 .pru_shutdown = uipc_shutdown,
1376 .pru_sockaddr = uipc_sockaddr,
1377 .pru_soreceive = soreceive_generic,
1378 .pru_close = uipc_close,
1382 uipc_ctloutput(struct socket *so, struct sockopt *sopt)
1388 if (sopt->sopt_level != SOL_LOCAL)
1391 unp = sotounpcb(so);
1392 KASSERT(unp != NULL, ("uipc_ctloutput: unp == NULL"));
1394 switch (sopt->sopt_dir) {
1396 switch (sopt->sopt_name) {
1397 case LOCAL_PEERCRED:
1399 if (unp->unp_flags & UNP_HAVEPC)
1400 xu = unp->unp_peercred;
1402 if (so->so_type == SOCK_STREAM)
1407 UNP_PCB_UNLOCK(unp);
1409 error = sooptcopyout(sopt, &xu, sizeof(xu));
1413 /* Unlocked read. */
1414 optval = unp->unp_flags & UNP_WANTCRED_ONESHOT ? 1 : 0;
1415 error = sooptcopyout(sopt, &optval, sizeof(optval));
1418 case LOCAL_CREDS_PERSISTENT:
1419 /* Unlocked read. */
1420 optval = unp->unp_flags & UNP_WANTCRED_ALWAYS ? 1 : 0;
1421 error = sooptcopyout(sopt, &optval, sizeof(optval));
1424 case LOCAL_CONNWAIT:
1425 /* Unlocked read. */
1426 optval = unp->unp_flags & UNP_CONNWAIT ? 1 : 0;
1427 error = sooptcopyout(sopt, &optval, sizeof(optval));
1437 switch (sopt->sopt_name) {
1439 case LOCAL_CREDS_PERSISTENT:
1440 case LOCAL_CONNWAIT:
1441 error = sooptcopyin(sopt, &optval, sizeof(optval),
1446 #define OPTSET(bit, exclusive) do { \
1447 UNP_PCB_LOCK(unp); \
1449 if ((unp->unp_flags & (exclusive)) != 0) { \
1450 UNP_PCB_UNLOCK(unp); \
1454 unp->unp_flags |= (bit); \
1456 unp->unp_flags &= ~(bit); \
1457 UNP_PCB_UNLOCK(unp); \
1460 switch (sopt->sopt_name) {
1462 OPTSET(UNP_WANTCRED_ONESHOT, UNP_WANTCRED_ALWAYS);
1465 case LOCAL_CREDS_PERSISTENT:
1466 OPTSET(UNP_WANTCRED_ALWAYS, UNP_WANTCRED_ONESHOT);
1469 case LOCAL_CONNWAIT:
1470 OPTSET(UNP_CONNWAIT, 0);
1479 error = ENOPROTOOPT;
1492 unp_connect(struct socket *so, struct sockaddr *nam, struct thread *td)
1495 return (unp_connectat(AT_FDCWD, so, nam, td));
1499 unp_connectat(int fd, struct socket *so, struct sockaddr *nam,
1503 struct sockaddr_un *soun;
1506 struct unpcb *unp, *unp2, *unp3;
1507 struct nameidata nd;
1508 char buf[SOCK_MAXADDRLEN];
1509 struct sockaddr *sa;
1510 cap_rights_t rights;
1514 if (nam->sa_family != AF_UNIX)
1515 return (EAFNOSUPPORT);
1516 if (nam->sa_len > sizeof(struct sockaddr_un))
1518 len = nam->sa_len - offsetof(struct sockaddr_un, sun_path);
1521 soun = (struct sockaddr_un *)nam;
1522 bcopy(soun->sun_path, buf, len);
1525 unp = sotounpcb(so);
1529 * Wait for connection state to stabilize. If a connection
1530 * already exists, give up. For datagram sockets, which permit
1531 * multiple consecutive connect(2) calls, upper layers are
1532 * responsible for disconnecting in advance of a subsequent
1533 * connect(2), but this is not synchronized with PCB connection
1536 * Also make sure that no threads are currently attempting to
1537 * lock the peer socket, to ensure that unp_conn cannot
1538 * transition between two valid sockets while locks are dropped.
1540 if (unp->unp_conn != NULL) {
1541 UNP_PCB_UNLOCK(unp);
1544 if ((unp->unp_flags & UNP_CONNECTING) != 0) {
1545 UNP_PCB_UNLOCK(unp);
1548 if (unp->unp_pairbusy > 0) {
1549 unp->unp_flags |= UNP_WAITING;
1550 mtx_sleep(unp, UNP_PCB_LOCKPTR(unp), 0, "unpeer", 0);
1555 unp->unp_flags |= UNP_CONNECTING;
1556 UNP_PCB_UNLOCK(unp);
1558 connreq = (so->so_proto->pr_flags & PR_CONNREQUIRED) != 0;
1560 sa = malloc(sizeof(struct sockaddr_un), M_SONAME, M_WAITOK);
1563 NDINIT_ATRIGHTS(&nd, LOOKUP, FOLLOW | LOCKSHARED | LOCKLEAF,
1564 UIO_SYSSPACE, buf, fd, cap_rights_init_one(&rights, CAP_CONNECTAT),
1571 ASSERT_VOP_LOCKED(vp, "unp_connect");
1572 NDFREE_NOTHING(&nd);
1576 if (vp->v_type != VSOCK) {
1581 error = mac_vnode_check_open(td->td_ucred, vp, VWRITE | VREAD);
1585 error = VOP_ACCESS(vp, VWRITE, td->td_ucred, td);
1589 unp = sotounpcb(so);
1590 KASSERT(unp != NULL, ("unp_connect: unp == NULL"));
1592 vplock = mtx_pool_find(mtxpool_sleep, vp);
1594 VOP_UNP_CONNECT(vp, &unp2);
1596 error = ECONNREFUSED;
1599 so2 = unp2->unp_socket;
1600 if (so->so_type != so2->so_type) {
1605 if (SOLISTENING(so2)) {
1606 CURVNET_SET(so2->so_vnet);
1607 so2 = sonewconn(so2, 0);
1612 error = ECONNREFUSED;
1615 unp3 = sotounpcb(so2);
1616 unp_pcb_lock_pair(unp2, unp3);
1617 if (unp2->unp_addr != NULL) {
1618 bcopy(unp2->unp_addr, sa, unp2->unp_addr->sun_len);
1619 unp3->unp_addr = (struct sockaddr_un *) sa;
1623 unp_copy_peercred(td, unp3, unp, unp2);
1625 UNP_PCB_UNLOCK(unp2);
1629 * It is safe to block on the PCB lock here since unp2 is
1630 * nascent and cannot be connected to any other sockets.
1634 mac_socketpeer_set_from_socket(so, so2);
1635 mac_socketpeer_set_from_socket(so2, so);
1638 unp_pcb_lock_pair(unp, unp2);
1640 KASSERT(unp2 != NULL && so2 != NULL && unp2->unp_socket == so2 &&
1641 sotounpcb(so2) == unp2,
1642 ("%s: unp2 %p so2 %p", __func__, unp2, so2));
1643 error = unp_connect2(so, so2, PRU_CONNECT);
1644 unp_pcb_unlock_pair(unp, unp2);
1653 KASSERT((unp->unp_flags & UNP_CONNECTING) != 0,
1654 ("%s: unp %p has UNP_CONNECTING clear", __func__, unp));
1655 unp->unp_flags &= ~UNP_CONNECTING;
1656 UNP_PCB_UNLOCK(unp);
1661 * Set socket peer credentials at connection time.
1663 * The client's PCB credentials are copied from its process structure. The
1664 * server's PCB credentials are copied from the socket on which it called
1665 * listen(2). uipc_listen cached that process's credentials at the time.
1668 unp_copy_peercred(struct thread *td, struct unpcb *client_unp,
1669 struct unpcb *server_unp, struct unpcb *listen_unp)
1671 cru2xt(td, &client_unp->unp_peercred);
1672 client_unp->unp_flags |= UNP_HAVEPC;
1674 memcpy(&server_unp->unp_peercred, &listen_unp->unp_peercred,
1675 sizeof(server_unp->unp_peercred));
1676 server_unp->unp_flags |= UNP_HAVEPC;
1677 client_unp->unp_flags |= (listen_unp->unp_flags & UNP_WANTCRED_MASK);
1681 unp_connect2(struct socket *so, struct socket *so2, int req)
1686 unp = sotounpcb(so);
1687 KASSERT(unp != NULL, ("unp_connect2: unp == NULL"));
1688 unp2 = sotounpcb(so2);
1689 KASSERT(unp2 != NULL, ("unp_connect2: unp2 == NULL"));
1691 UNP_PCB_LOCK_ASSERT(unp);
1692 UNP_PCB_LOCK_ASSERT(unp2);
1693 KASSERT(unp->unp_conn == NULL,
1694 ("%s: socket %p is already connected", __func__, unp));
1696 if (so2->so_type != so->so_type)
1697 return (EPROTOTYPE);
1698 unp->unp_conn = unp2;
1701 switch (so->so_type) {
1703 UNP_REF_LIST_LOCK();
1704 LIST_INSERT_HEAD(&unp2->unp_refs, unp, unp_reflink);
1705 UNP_REF_LIST_UNLOCK();
1710 case SOCK_SEQPACKET:
1711 KASSERT(unp2->unp_conn == NULL,
1712 ("%s: socket %p is already connected", __func__, unp2));
1713 unp2->unp_conn = unp;
1714 if (req == PRU_CONNECT &&
1715 ((unp->unp_flags | unp2->unp_flags) & UNP_CONNWAIT))
1723 panic("unp_connect2");
1729 unp_disconnect(struct unpcb *unp, struct unpcb *unp2)
1731 struct socket *so, *so2;
1733 struct unpcb *unptmp;
1736 UNP_PCB_LOCK_ASSERT(unp);
1737 UNP_PCB_LOCK_ASSERT(unp2);
1738 KASSERT(unp->unp_conn == unp2,
1739 ("%s: unpcb %p is not connected to %p", __func__, unp, unp2));
1741 unp->unp_conn = NULL;
1742 so = unp->unp_socket;
1743 so2 = unp2->unp_socket;
1744 switch (unp->unp_socket->so_type) {
1746 UNP_REF_LIST_LOCK();
1748 LIST_FOREACH(unptmp, &unp2->unp_refs, unp_reflink) {
1752 KASSERT(unptmp != NULL,
1753 ("%s: %p not found in reflist of %p", __func__, unp, unp2));
1755 LIST_REMOVE(unp, unp_reflink);
1756 UNP_REF_LIST_UNLOCK();
1759 so->so_state &= ~SS_ISCONNECTED;
1765 case SOCK_SEQPACKET:
1767 soisdisconnected(so);
1768 MPASS(unp2->unp_conn == unp);
1769 unp2->unp_conn = NULL;
1771 soisdisconnected(so2);
1776 unp_pcb_rele_notlast(unp);
1777 if (!unp_pcb_rele(unp))
1778 UNP_PCB_UNLOCK(unp);
1780 if (!unp_pcb_rele(unp))
1781 UNP_PCB_UNLOCK(unp);
1782 if (!unp_pcb_rele(unp2))
1783 UNP_PCB_UNLOCK(unp2);
1788 * unp_pcblist() walks the global list of struct unpcb's to generate a
1789 * pointer list, bumping the refcount on each unpcb. It then copies them out
1790 * sequentially, validating the generation number on each to see if it has
1791 * been detached. All of this is necessary because copyout() may sleep on
1795 unp_pcblist(SYSCTL_HANDLER_ARGS)
1797 struct unpcb *unp, **unp_list;
1799 struct xunpgen *xug;
1800 struct unp_head *head;
1805 switch ((intptr_t)arg1) {
1814 case SOCK_SEQPACKET:
1819 panic("unp_pcblist: arg1 %d", (int)(intptr_t)arg1);
1823 * The process of preparing the PCB list is too time-consuming and
1824 * resource-intensive to repeat twice on every request.
1826 if (req->oldptr == NULL) {
1828 req->oldidx = 2 * (sizeof *xug)
1829 + (n + n/8) * sizeof(struct xunpcb);
1833 if (req->newptr != NULL)
1837 * OK, now we're committed to doing something.
1839 xug = malloc(sizeof(*xug), M_TEMP, M_WAITOK | M_ZERO);
1841 gencnt = unp_gencnt;
1845 xug->xug_len = sizeof *xug;
1847 xug->xug_gen = gencnt;
1848 xug->xug_sogen = so_gencnt;
1849 error = SYSCTL_OUT(req, xug, sizeof *xug);
1855 unp_list = malloc(n * sizeof *unp_list, M_TEMP, M_WAITOK);
1858 for (unp = LIST_FIRST(head), i = 0; unp && i < n;
1859 unp = LIST_NEXT(unp, unp_link)) {
1861 if (unp->unp_gencnt <= gencnt) {
1862 if (cr_cansee(req->td->td_ucred,
1863 unp->unp_socket->so_cred)) {
1864 UNP_PCB_UNLOCK(unp);
1867 unp_list[i++] = unp;
1870 UNP_PCB_UNLOCK(unp);
1873 n = i; /* In case we lost some during malloc. */
1876 xu = malloc(sizeof(*xu), M_TEMP, M_WAITOK | M_ZERO);
1877 for (i = 0; i < n; i++) {
1880 if (unp_pcb_rele(unp))
1883 if (unp->unp_gencnt <= gencnt) {
1884 xu->xu_len = sizeof *xu;
1885 xu->xu_unpp = (uintptr_t)unp;
1887 * XXX - need more locking here to protect against
1888 * connect/disconnect races for SMP.
1890 if (unp->unp_addr != NULL)
1891 bcopy(unp->unp_addr, &xu->xu_addr,
1892 unp->unp_addr->sun_len);
1894 bzero(&xu->xu_addr, sizeof(xu->xu_addr));
1895 if (unp->unp_conn != NULL &&
1896 unp->unp_conn->unp_addr != NULL)
1897 bcopy(unp->unp_conn->unp_addr,
1899 unp->unp_conn->unp_addr->sun_len);
1901 bzero(&xu->xu_caddr, sizeof(xu->xu_caddr));
1902 xu->unp_vnode = (uintptr_t)unp->unp_vnode;
1903 xu->unp_conn = (uintptr_t)unp->unp_conn;
1904 xu->xu_firstref = (uintptr_t)LIST_FIRST(&unp->unp_refs);
1905 xu->xu_nextref = (uintptr_t)LIST_NEXT(unp, unp_reflink);
1906 xu->unp_gencnt = unp->unp_gencnt;
1907 sotoxsocket(unp->unp_socket, &xu->xu_socket);
1908 UNP_PCB_UNLOCK(unp);
1909 error = SYSCTL_OUT(req, xu, sizeof *xu);
1911 UNP_PCB_UNLOCK(unp);
1917 * Give the user an updated idea of our state. If the
1918 * generation differs from what we told her before, she knows
1919 * that something happened while we were processing this
1920 * request, and it might be necessary to retry.
1922 xug->xug_gen = unp_gencnt;
1923 xug->xug_sogen = so_gencnt;
1924 xug->xug_count = unp_count;
1925 error = SYSCTL_OUT(req, xug, sizeof *xug);
1927 free(unp_list, M_TEMP);
1932 SYSCTL_PROC(_net_local_dgram, OID_AUTO, pcblist,
1933 CTLTYPE_OPAQUE | CTLFLAG_RD | CTLFLAG_MPSAFE,
1934 (void *)(intptr_t)SOCK_DGRAM, 0, unp_pcblist, "S,xunpcb",
1935 "List of active local datagram sockets");
1936 SYSCTL_PROC(_net_local_stream, OID_AUTO, pcblist,
1937 CTLTYPE_OPAQUE | CTLFLAG_RD | CTLFLAG_MPSAFE,
1938 (void *)(intptr_t)SOCK_STREAM, 0, unp_pcblist, "S,xunpcb",
1939 "List of active local stream sockets");
1940 SYSCTL_PROC(_net_local_seqpacket, OID_AUTO, pcblist,
1941 CTLTYPE_OPAQUE | CTLFLAG_RD | CTLFLAG_MPSAFE,
1942 (void *)(intptr_t)SOCK_SEQPACKET, 0, unp_pcblist, "S,xunpcb",
1943 "List of active local seqpacket sockets");
1946 unp_shutdown(struct unpcb *unp)
1951 UNP_PCB_LOCK_ASSERT(unp);
1953 unp2 = unp->unp_conn;
1954 if ((unp->unp_socket->so_type == SOCK_STREAM ||
1955 (unp->unp_socket->so_type == SOCK_SEQPACKET)) && unp2 != NULL) {
1956 so = unp2->unp_socket;
1963 unp_drop(struct unpcb *unp)
1969 * Regardless of whether the socket's peer dropped the connection
1970 * with this socket by aborting or disconnecting, POSIX requires
1971 * that ECONNRESET is returned.
1975 so = unp->unp_socket;
1977 so->so_error = ECONNRESET;
1978 if ((unp2 = unp_pcb_lock_peer(unp)) != NULL) {
1979 /* Last reference dropped in unp_disconnect(). */
1980 unp_pcb_rele_notlast(unp);
1981 unp_disconnect(unp, unp2);
1982 } else if (!unp_pcb_rele(unp)) {
1983 UNP_PCB_UNLOCK(unp);
1988 unp_freerights(struct filedescent **fdep, int fdcount)
1993 KASSERT(fdcount > 0, ("%s: fdcount %d", __func__, fdcount));
1995 for (i = 0; i < fdcount; i++) {
1996 fp = fdep[i]->fde_file;
1997 filecaps_free(&fdep[i]->fde_caps);
2000 free(fdep[0], M_FILECAPS);
2004 unp_externalize(struct mbuf *control, struct mbuf **controlp, int flags)
2006 struct thread *td = curthread; /* XXX */
2007 struct cmsghdr *cm = mtod(control, struct cmsghdr *);
2010 struct filedesc *fdesc = td->td_proc->p_fd;
2011 struct filedescent **fdep;
2013 socklen_t clen = control->m_len, datalen;
2017 UNP_LINK_UNLOCK_ASSERT();
2020 if (controlp != NULL) /* controlp == NULL => free control messages */
2022 while (cm != NULL) {
2023 if (sizeof(*cm) > clen || cm->cmsg_len > clen) {
2027 data = CMSG_DATA(cm);
2028 datalen = (caddr_t)cm + cm->cmsg_len - (caddr_t)data;
2029 if (cm->cmsg_level == SOL_SOCKET
2030 && cm->cmsg_type == SCM_RIGHTS) {
2031 newfds = datalen / sizeof(*fdep);
2036 /* If we're not outputting the descriptors free them. */
2037 if (error || controlp == NULL) {
2038 unp_freerights(fdep, newfds);
2041 FILEDESC_XLOCK(fdesc);
2044 * Now change each pointer to an fd in the global
2045 * table to an integer that is the index to the local
2046 * fd table entry that we set up to point to the
2047 * global one we are transferring.
2049 newlen = newfds * sizeof(int);
2050 *controlp = sbcreatecontrol(NULL, newlen,
2051 SCM_RIGHTS, SOL_SOCKET);
2052 if (*controlp == NULL) {
2053 FILEDESC_XUNLOCK(fdesc);
2055 unp_freerights(fdep, newfds);
2060 CMSG_DATA(mtod(*controlp, struct cmsghdr *));
2061 if (fdallocn(td, 0, fdp, newfds) != 0) {
2062 FILEDESC_XUNLOCK(fdesc);
2064 unp_freerights(fdep, newfds);
2069 for (i = 0; i < newfds; i++, fdp++) {
2070 _finstall(fdesc, fdep[i]->fde_file, *fdp,
2071 (flags & MSG_CMSG_CLOEXEC) != 0 ? O_CLOEXEC : 0,
2072 &fdep[i]->fde_caps);
2073 unp_externalize_fp(fdep[i]->fde_file);
2077 * The new type indicates that the mbuf data refers to
2078 * kernel resources that may need to be released before
2079 * the mbuf is freed.
2081 m_chtype(*controlp, MT_EXTCONTROL);
2082 FILEDESC_XUNLOCK(fdesc);
2083 free(fdep[0], M_FILECAPS);
2085 /* We can just copy anything else across. */
2086 if (error || controlp == NULL)
2088 *controlp = sbcreatecontrol(NULL, datalen,
2089 cm->cmsg_type, cm->cmsg_level);
2090 if (*controlp == NULL) {
2095 CMSG_DATA(mtod(*controlp, struct cmsghdr *)),
2098 controlp = &(*controlp)->m_next;
2101 if (CMSG_SPACE(datalen) < clen) {
2102 clen -= CMSG_SPACE(datalen);
2103 cm = (struct cmsghdr *)
2104 ((caddr_t)cm + CMSG_SPACE(datalen));
2116 unp_zone_change(void *tag)
2119 uma_zone_set_max(unp_zone, maxsockets);
2124 unp_zdtor(void *mem, int size __unused, void *arg __unused)
2130 KASSERT(LIST_EMPTY(&unp->unp_refs),
2131 ("%s: unpcb %p has lingering refs", __func__, unp));
2132 KASSERT(unp->unp_socket == NULL,
2133 ("%s: unpcb %p has socket backpointer", __func__, unp));
2134 KASSERT(unp->unp_vnode == NULL,
2135 ("%s: unpcb %p has vnode references", __func__, unp));
2136 KASSERT(unp->unp_conn == NULL,
2137 ("%s: unpcb %p is still connected", __func__, unp));
2138 KASSERT(unp->unp_addr == NULL,
2139 ("%s: unpcb %p has leaked addr", __func__, unp));
2149 if (!IS_DEFAULT_VNET(curvnet))
2158 unp_zone = uma_zcreate("unpcb", sizeof(struct unpcb), NULL, dtor,
2159 NULL, NULL, UMA_ALIGN_CACHE, 0);
2160 uma_zone_set_max(unp_zone, maxsockets);
2161 uma_zone_set_warning(unp_zone, "kern.ipc.maxsockets limit reached");
2162 EVENTHANDLER_REGISTER(maxsockets_change, unp_zone_change,
2163 NULL, EVENTHANDLER_PRI_ANY);
2164 LIST_INIT(&unp_dhead);
2165 LIST_INIT(&unp_shead);
2166 LIST_INIT(&unp_sphead);
2167 SLIST_INIT(&unp_defers);
2168 TIMEOUT_TASK_INIT(taskqueue_thread, &unp_gc_task, 0, unp_gc, NULL);
2169 TASK_INIT(&unp_defer_task, 0, unp_process_defers, NULL);
2170 UNP_LINK_LOCK_INIT();
2171 UNP_DEFERRED_LOCK_INIT();
2175 unp_internalize_cleanup_rights(struct mbuf *control)
2182 for (m = control; m != NULL; m = m->m_next) {
2183 cp = mtod(m, struct cmsghdr *);
2184 if (cp->cmsg_level != SOL_SOCKET ||
2185 cp->cmsg_type != SCM_RIGHTS)
2187 data = CMSG_DATA(cp);
2188 datalen = (caddr_t)cp + cp->cmsg_len - (caddr_t)data;
2189 unp_freerights(data, datalen / sizeof(struct filedesc *));
2194 unp_internalize(struct mbuf **controlp, struct thread *td)
2196 struct mbuf *control, **initial_controlp;
2198 struct filedesc *fdesc;
2201 struct cmsgcred *cmcred;
2202 struct filedescent *fde, **fdep, *fdev;
2205 struct timespec *ts;
2207 socklen_t clen, datalen;
2208 int i, j, error, *fdp, oldfds;
2211 UNP_LINK_UNLOCK_ASSERT();
2216 control = *controlp;
2217 clen = control->m_len;
2219 initial_controlp = controlp;
2220 for (cm = mtod(control, struct cmsghdr *); cm != NULL;) {
2221 if (sizeof(*cm) > clen || cm->cmsg_level != SOL_SOCKET
2222 || cm->cmsg_len > clen || cm->cmsg_len < sizeof(*cm)) {
2226 data = CMSG_DATA(cm);
2227 datalen = (caddr_t)cm + cm->cmsg_len - (caddr_t)data;
2229 switch (cm->cmsg_type) {
2231 * Fill in credential information.
2234 *controlp = sbcreatecontrol(NULL, sizeof(*cmcred),
2235 SCM_CREDS, SOL_SOCKET);
2236 if (*controlp == NULL) {
2240 cmcred = (struct cmsgcred *)
2241 CMSG_DATA(mtod(*controlp, struct cmsghdr *));
2242 cmcred->cmcred_pid = p->p_pid;
2243 cmcred->cmcred_uid = td->td_ucred->cr_ruid;
2244 cmcred->cmcred_gid = td->td_ucred->cr_rgid;
2245 cmcred->cmcred_euid = td->td_ucred->cr_uid;
2246 cmcred->cmcred_ngroups = MIN(td->td_ucred->cr_ngroups,
2248 for (i = 0; i < cmcred->cmcred_ngroups; i++)
2249 cmcred->cmcred_groups[i] =
2250 td->td_ucred->cr_groups[i];
2254 oldfds = datalen / sizeof (int);
2258 * Check that all the FDs passed in refer to legal
2259 * files. If not, reject the entire operation.
2262 FILEDESC_SLOCK(fdesc);
2263 for (i = 0; i < oldfds; i++, fdp++) {
2264 fp = fget_locked(fdesc, *fdp);
2266 FILEDESC_SUNLOCK(fdesc);
2270 if (!(fp->f_ops->fo_flags & DFLAG_PASSABLE)) {
2271 FILEDESC_SUNLOCK(fdesc);
2278 * Now replace the integer FDs with pointers to the
2279 * file structure and capability rights.
2281 newlen = oldfds * sizeof(fdep[0]);
2282 *controlp = sbcreatecontrol(NULL, newlen,
2283 SCM_RIGHTS, SOL_SOCKET);
2284 if (*controlp == NULL) {
2285 FILEDESC_SUNLOCK(fdesc);
2290 for (i = 0; i < oldfds; i++, fdp++) {
2291 if (!fhold(fdesc->fd_ofiles[*fdp].fde_file)) {
2293 for (j = 0; j < i; j++, fdp++) {
2294 fdrop(fdesc->fd_ofiles[*fdp].
2297 FILEDESC_SUNLOCK(fdesc);
2303 fdep = (struct filedescent **)
2304 CMSG_DATA(mtod(*controlp, struct cmsghdr *));
2305 fdev = malloc(sizeof(*fdev) * oldfds, M_FILECAPS,
2307 for (i = 0; i < oldfds; i++, fdev++, fdp++) {
2308 fde = &fdesc->fd_ofiles[*fdp];
2310 fdep[i]->fde_file = fde->fde_file;
2311 filecaps_copy(&fde->fde_caps,
2312 &fdep[i]->fde_caps, true);
2313 unp_internalize_fp(fdep[i]->fde_file);
2315 FILEDESC_SUNLOCK(fdesc);
2319 *controlp = sbcreatecontrol(NULL, sizeof(*tv),
2320 SCM_TIMESTAMP, SOL_SOCKET);
2321 if (*controlp == NULL) {
2325 tv = (struct timeval *)
2326 CMSG_DATA(mtod(*controlp, struct cmsghdr *));
2331 *controlp = sbcreatecontrol(NULL, sizeof(*bt),
2332 SCM_BINTIME, SOL_SOCKET);
2333 if (*controlp == NULL) {
2337 bt = (struct bintime *)
2338 CMSG_DATA(mtod(*controlp, struct cmsghdr *));
2343 *controlp = sbcreatecontrol(NULL, sizeof(*ts),
2344 SCM_REALTIME, SOL_SOCKET);
2345 if (*controlp == NULL) {
2349 ts = (struct timespec *)
2350 CMSG_DATA(mtod(*controlp, struct cmsghdr *));
2355 *controlp = sbcreatecontrol(NULL, sizeof(*ts),
2356 SCM_MONOTONIC, SOL_SOCKET);
2357 if (*controlp == NULL) {
2361 ts = (struct timespec *)
2362 CMSG_DATA(mtod(*controlp, struct cmsghdr *));
2371 if (*controlp != NULL)
2372 controlp = &(*controlp)->m_next;
2373 if (CMSG_SPACE(datalen) < clen) {
2374 clen -= CMSG_SPACE(datalen);
2375 cm = (struct cmsghdr *)
2376 ((caddr_t)cm + CMSG_SPACE(datalen));
2384 if (error != 0 && initial_controlp != NULL)
2385 unp_internalize_cleanup_rights(*initial_controlp);
2390 static struct mbuf *
2391 unp_addsockcred(struct thread *td, struct mbuf *control, int mode)
2393 struct mbuf *m, *n, *n_prev;
2394 const struct cmsghdr *cm;
2395 int ngroups, i, cmsgtype;
2398 ngroups = MIN(td->td_ucred->cr_ngroups, CMGROUP_MAX);
2399 if (mode & UNP_WANTCRED_ALWAYS) {
2400 ctrlsz = SOCKCRED2SIZE(ngroups);
2401 cmsgtype = SCM_CREDS2;
2403 ctrlsz = SOCKCREDSIZE(ngroups);
2404 cmsgtype = SCM_CREDS;
2407 m = sbcreatecontrol(NULL, ctrlsz, cmsgtype, SOL_SOCKET);
2411 if (mode & UNP_WANTCRED_ALWAYS) {
2412 struct sockcred2 *sc;
2414 sc = (void *)CMSG_DATA(mtod(m, struct cmsghdr *));
2416 sc->sc_pid = td->td_proc->p_pid;
2417 sc->sc_uid = td->td_ucred->cr_ruid;
2418 sc->sc_euid = td->td_ucred->cr_uid;
2419 sc->sc_gid = td->td_ucred->cr_rgid;
2420 sc->sc_egid = td->td_ucred->cr_gid;
2421 sc->sc_ngroups = ngroups;
2422 for (i = 0; i < sc->sc_ngroups; i++)
2423 sc->sc_groups[i] = td->td_ucred->cr_groups[i];
2425 struct sockcred *sc;
2427 sc = (void *)CMSG_DATA(mtod(m, struct cmsghdr *));
2428 sc->sc_uid = td->td_ucred->cr_ruid;
2429 sc->sc_euid = td->td_ucred->cr_uid;
2430 sc->sc_gid = td->td_ucred->cr_rgid;
2431 sc->sc_egid = td->td_ucred->cr_gid;
2432 sc->sc_ngroups = ngroups;
2433 for (i = 0; i < sc->sc_ngroups; i++)
2434 sc->sc_groups[i] = td->td_ucred->cr_groups[i];
2438 * Unlink SCM_CREDS control messages (struct cmsgcred), since just
2439 * created SCM_CREDS control message (struct sockcred) has another
2442 if (control != NULL && cmsgtype == SCM_CREDS)
2443 for (n = control, n_prev = NULL; n != NULL;) {
2444 cm = mtod(n, struct cmsghdr *);
2445 if (cm->cmsg_level == SOL_SOCKET &&
2446 cm->cmsg_type == SCM_CREDS) {
2448 control = n->m_next;
2450 n_prev->m_next = n->m_next;
2458 /* Prepend it to the head. */
2459 m->m_next = control;
2463 static struct unpcb *
2464 fptounp(struct file *fp)
2468 if (fp->f_type != DTYPE_SOCKET)
2470 if ((so = fp->f_data) == NULL)
2472 if (so->so_proto->pr_domain != &localdomain)
2474 return sotounpcb(so);
2478 unp_discard(struct file *fp)
2480 struct unp_defer *dr;
2482 if (unp_externalize_fp(fp)) {
2483 dr = malloc(sizeof(*dr), M_TEMP, M_WAITOK);
2485 UNP_DEFERRED_LOCK();
2486 SLIST_INSERT_HEAD(&unp_defers, dr, ud_link);
2487 UNP_DEFERRED_UNLOCK();
2488 atomic_add_int(&unp_defers_count, 1);
2489 taskqueue_enqueue(taskqueue_thread, &unp_defer_task);
2491 closef_nothread(fp);
2495 unp_process_defers(void *arg __unused, int pending)
2497 struct unp_defer *dr;
2498 SLIST_HEAD(, unp_defer) drl;
2503 UNP_DEFERRED_LOCK();
2504 if (SLIST_FIRST(&unp_defers) == NULL) {
2505 UNP_DEFERRED_UNLOCK();
2508 SLIST_SWAP(&unp_defers, &drl, unp_defer);
2509 UNP_DEFERRED_UNLOCK();
2511 while ((dr = SLIST_FIRST(&drl)) != NULL) {
2512 SLIST_REMOVE_HEAD(&drl, ud_link);
2513 closef_nothread(dr->ud_fp);
2517 atomic_add_int(&unp_defers_count, -count);
2522 unp_internalize_fp(struct file *fp)
2527 if ((unp = fptounp(fp)) != NULL) {
2529 unp->unp_msgcount++;
2536 unp_externalize_fp(struct file *fp)
2542 if ((unp = fptounp(fp)) != NULL) {
2543 unp->unp_msgcount--;
2553 * unp_defer indicates whether additional work has been defered for a future
2554 * pass through unp_gc(). It is thread local and does not require explicit
2557 static int unp_marked;
2560 unp_remove_dead_ref(struct filedescent **fdep, int fdcount)
2567 * This function can only be called from the gc task.
2569 KASSERT(taskqueue_member(taskqueue_thread, curthread) != 0,
2570 ("%s: not on gc callout", __func__));
2571 UNP_LINK_LOCK_ASSERT();
2573 for (i = 0; i < fdcount; i++) {
2574 fp = fdep[i]->fde_file;
2575 if ((unp = fptounp(fp)) == NULL)
2577 if ((unp->unp_gcflag & UNPGC_DEAD) == 0)
2584 unp_restore_undead_ref(struct filedescent **fdep, int fdcount)
2591 * This function can only be called from the gc task.
2593 KASSERT(taskqueue_member(taskqueue_thread, curthread) != 0,
2594 ("%s: not on gc callout", __func__));
2595 UNP_LINK_LOCK_ASSERT();
2597 for (i = 0; i < fdcount; i++) {
2598 fp = fdep[i]->fde_file;
2599 if ((unp = fptounp(fp)) == NULL)
2601 if ((unp->unp_gcflag & UNPGC_DEAD) == 0)
2609 unp_gc_scan(struct unpcb *unp, void (*op)(struct filedescent **, int))
2611 struct socket *so, *soa;
2613 so = unp->unp_socket;
2615 if (SOLISTENING(so)) {
2617 * Mark all sockets in our accept queue.
2619 TAILQ_FOREACH(soa, &so->sol_comp, so_list) {
2620 if (sotounpcb(soa)->unp_gcflag & UNPGC_IGNORE_RIGHTS)
2622 SOCKBUF_LOCK(&soa->so_rcv);
2623 unp_scan(soa->so_rcv.sb_mb, op);
2624 SOCKBUF_UNLOCK(&soa->so_rcv);
2628 * Mark all sockets we reference with RIGHTS.
2630 if ((unp->unp_gcflag & UNPGC_IGNORE_RIGHTS) == 0) {
2631 SOCKBUF_LOCK(&so->so_rcv);
2632 unp_scan(so->so_rcv.sb_mb, op);
2633 SOCKBUF_UNLOCK(&so->so_rcv);
2639 static int unp_recycled;
2640 SYSCTL_INT(_net_local, OID_AUTO, recycled, CTLFLAG_RD, &unp_recycled, 0,
2641 "Number of unreachable sockets claimed by the garbage collector.");
2643 static int unp_taskcount;
2644 SYSCTL_INT(_net_local, OID_AUTO, taskcount, CTLFLAG_RD, &unp_taskcount, 0,
2645 "Number of times the garbage collector has run.");
2647 SYSCTL_UINT(_net_local, OID_AUTO, sockcount, CTLFLAG_RD, &unp_count, 0,
2648 "Number of active local sockets.");
2651 unp_gc(__unused void *arg, int pending)
2653 struct unp_head *heads[] = { &unp_dhead, &unp_shead, &unp_sphead,
2655 struct unp_head **head;
2656 struct unp_head unp_deadhead; /* List of potentially-dead sockets. */
2657 struct file *f, **unref;
2658 struct unpcb *unp, *unptmp;
2659 int i, total, unp_unreachable;
2661 LIST_INIT(&unp_deadhead);
2665 * First determine which sockets may be in cycles.
2667 unp_unreachable = 0;
2669 for (head = heads; *head != NULL; head++)
2670 LIST_FOREACH(unp, *head, unp_link) {
2671 KASSERT((unp->unp_gcflag & ~UNPGC_IGNORE_RIGHTS) == 0,
2672 ("%s: unp %p has unexpected gc flags 0x%x",
2673 __func__, unp, (unsigned int)unp->unp_gcflag));
2678 * Check for an unreachable socket potentially in a
2679 * cycle. It must be in a queue as indicated by
2680 * msgcount, and this must equal the file reference
2681 * count. Note that when msgcount is 0 the file is
2684 if (f != NULL && unp->unp_msgcount != 0 &&
2685 refcount_load(&f->f_count) == unp->unp_msgcount) {
2686 LIST_INSERT_HEAD(&unp_deadhead, unp, unp_dead);
2687 unp->unp_gcflag |= UNPGC_DEAD;
2688 unp->unp_gcrefs = unp->unp_msgcount;
2694 * Scan all sockets previously marked as potentially being in a cycle
2695 * and remove the references each socket holds on any UNPGC_DEAD
2696 * sockets in its queue. After this step, all remaining references on
2697 * sockets marked UNPGC_DEAD should not be part of any cycle.
2699 LIST_FOREACH(unp, &unp_deadhead, unp_dead)
2700 unp_gc_scan(unp, unp_remove_dead_ref);
2703 * If a socket still has a non-negative refcount, it cannot be in a
2704 * cycle. In this case increment refcount of all children iteratively.
2705 * Stop the scan once we do a complete loop without discovering
2706 * a new reachable socket.
2710 LIST_FOREACH_SAFE(unp, &unp_deadhead, unp_dead, unptmp)
2711 if (unp->unp_gcrefs > 0) {
2712 unp->unp_gcflag &= ~UNPGC_DEAD;
2713 LIST_REMOVE(unp, unp_dead);
2714 KASSERT(unp_unreachable > 0,
2715 ("%s: unp_unreachable underflow.",
2718 unp_gc_scan(unp, unp_restore_undead_ref);
2720 } while (unp_marked);
2724 if (unp_unreachable == 0)
2728 * Allocate space for a local array of dead unpcbs.
2729 * TODO: can this path be simplified by instead using the local
2730 * dead list at unp_deadhead, after taking out references
2731 * on the file object and/or unpcb and dropping the link lock?
2733 unref = malloc(unp_unreachable * sizeof(struct file *),
2737 * Iterate looking for sockets which have been specifically marked
2738 * as unreachable and store them locally.
2742 LIST_FOREACH(unp, &unp_deadhead, unp_dead) {
2743 KASSERT((unp->unp_gcflag & UNPGC_DEAD) != 0,
2744 ("%s: unp %p not marked UNPGC_DEAD", __func__, unp));
2745 unp->unp_gcflag &= ~UNPGC_DEAD;
2747 if (unp->unp_msgcount == 0 || f == NULL ||
2748 refcount_load(&f->f_count) != unp->unp_msgcount ||
2752 KASSERT(total <= unp_unreachable,
2753 ("%s: incorrect unreachable count.", __func__));
2758 * Now flush all sockets, free'ing rights. This will free the
2759 * struct files associated with these sockets but leave each socket
2760 * with one remaining ref.
2762 for (i = 0; i < total; i++) {
2765 so = unref[i]->f_data;
2766 CURVNET_SET(so->so_vnet);
2772 * And finally release the sockets so they can be reclaimed.
2774 for (i = 0; i < total; i++)
2775 fdrop(unref[i], NULL);
2776 unp_recycled += total;
2777 free(unref, M_TEMP);
2781 unp_dispose_mbuf(struct mbuf *m)
2785 unp_scan(m, unp_freerights);
2789 * Synchronize against unp_gc, which can trip over data as we are freeing it.
2792 unp_dispose(struct socket *so)
2796 unp = sotounpcb(so);
2798 unp->unp_gcflag |= UNPGC_IGNORE_RIGHTS;
2800 if (!SOLISTENING(so))
2801 unp_dispose_mbuf(so->so_rcv.sb_mb);
2805 unp_scan(struct mbuf *m0, void (*op)(struct filedescent **, int))
2810 socklen_t clen, datalen;
2812 while (m0 != NULL) {
2813 for (m = m0; m; m = m->m_next) {
2814 if (m->m_type != MT_CONTROL)
2817 cm = mtod(m, struct cmsghdr *);
2820 while (cm != NULL) {
2821 if (sizeof(*cm) > clen || cm->cmsg_len > clen)
2824 data = CMSG_DATA(cm);
2825 datalen = (caddr_t)cm + cm->cmsg_len
2828 if (cm->cmsg_level == SOL_SOCKET &&
2829 cm->cmsg_type == SCM_RIGHTS) {
2830 (*op)(data, datalen /
2831 sizeof(struct filedescent *));
2834 if (CMSG_SPACE(datalen) < clen) {
2835 clen -= CMSG_SPACE(datalen);
2836 cm = (struct cmsghdr *)
2837 ((caddr_t)cm + CMSG_SPACE(datalen));
2849 * A helper function called by VFS before socket-type vnode reclamation.
2850 * For an active vnode it clears unp_vnode pointer and decrements unp_vnode
2854 vfs_unp_reclaim(struct vnode *vp)
2860 ASSERT_VOP_ELOCKED(vp, "vfs_unp_reclaim");
2861 KASSERT(vp->v_type == VSOCK,
2862 ("vfs_unp_reclaim: vp->v_type != VSOCK"));
2865 vplock = mtx_pool_find(mtxpool_sleep, vp);
2867 VOP_UNP_CONNECT(vp, &unp);
2871 if (unp->unp_vnode == vp) {
2873 unp->unp_vnode = NULL;
2876 UNP_PCB_UNLOCK(unp);
2885 db_print_indent(int indent)
2889 for (i = 0; i < indent; i++)
2894 db_print_unpflags(int unp_flags)
2899 if (unp_flags & UNP_HAVEPC) {
2900 db_printf("%sUNP_HAVEPC", comma ? ", " : "");
2903 if (unp_flags & UNP_WANTCRED_ALWAYS) {
2904 db_printf("%sUNP_WANTCRED_ALWAYS", comma ? ", " : "");
2907 if (unp_flags & UNP_WANTCRED_ONESHOT) {
2908 db_printf("%sUNP_WANTCRED_ONESHOT", comma ? ", " : "");
2911 if (unp_flags & UNP_CONNWAIT) {
2912 db_printf("%sUNP_CONNWAIT", comma ? ", " : "");
2915 if (unp_flags & UNP_CONNECTING) {
2916 db_printf("%sUNP_CONNECTING", comma ? ", " : "");
2919 if (unp_flags & UNP_BINDING) {
2920 db_printf("%sUNP_BINDING", comma ? ", " : "");
2926 db_print_xucred(int indent, struct xucred *xu)
2930 db_print_indent(indent);
2931 db_printf("cr_version: %u cr_uid: %u cr_pid: %d cr_ngroups: %d\n",
2932 xu->cr_version, xu->cr_uid, xu->cr_pid, xu->cr_ngroups);
2933 db_print_indent(indent);
2934 db_printf("cr_groups: ");
2936 for (i = 0; i < xu->cr_ngroups; i++) {
2937 db_printf("%s%u", comma ? ", " : "", xu->cr_groups[i]);
2944 db_print_unprefs(int indent, struct unp_head *uh)
2950 LIST_FOREACH(unp, uh, unp_reflink) {
2951 if (counter % 4 == 0)
2952 db_print_indent(indent);
2953 db_printf("%p ", unp);
2954 if (counter % 4 == 3)
2958 if (counter != 0 && counter % 4 != 0)
2962 DB_SHOW_COMMAND(unpcb, db_show_unpcb)
2967 db_printf("usage: show unpcb <addr>\n");
2970 unp = (struct unpcb *)addr;
2972 db_printf("unp_socket: %p unp_vnode: %p\n", unp->unp_socket,
2975 db_printf("unp_ino: %ju unp_conn: %p\n", (uintmax_t)unp->unp_ino,
2978 db_printf("unp_refs:\n");
2979 db_print_unprefs(2, &unp->unp_refs);
2981 /* XXXRW: Would be nice to print the full address, if any. */
2982 db_printf("unp_addr: %p\n", unp->unp_addr);
2984 db_printf("unp_gencnt: %llu\n",
2985 (unsigned long long)unp->unp_gencnt);
2987 db_printf("unp_flags: %x (", unp->unp_flags);
2988 db_print_unpflags(unp->unp_flags);
2991 db_printf("unp_peercred:\n");
2992 db_print_xucred(2, &unp->unp_peercred);
2994 db_printf("unp_refcount: %u\n", unp->unp_refcount);