2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1982, 1986, 1988, 1990, 1993
5 * The Regents of the University of California.
6 * Copyright (c) 2004 The FreeBSD Foundation
7 * Copyright (c) 2004-2008 Robert N. M. Watson
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * @(#)uipc_socket.c 8.3 (Berkeley) 4/15/94
38 * Comments on the socket life cycle:
40 * soalloc() sets of socket layer state for a socket, called only by
41 * socreate() and sonewconn(). Socket layer private.
43 * sodealloc() tears down socket layer state for a socket, called only by
44 * sofree() and sonewconn(). Socket layer private.
46 * pru_attach() associates protocol layer state with an allocated socket;
47 * called only once, may fail, aborting socket allocation. This is called
48 * from socreate() and sonewconn(). Socket layer private.
50 * pru_detach() disassociates protocol layer state from an attached socket,
51 * and will be called exactly once for sockets in which pru_attach() has
52 * been successfully called. If pru_attach() returned an error,
53 * pru_detach() will not be called. Socket layer private.
55 * pru_abort() and pru_close() notify the protocol layer that the last
56 * consumer of a socket is starting to tear down the socket, and that the
57 * protocol should terminate the connection. Historically, pru_abort() also
58 * detached protocol state from the socket state, but this is no longer the
61 * socreate() creates a socket and attaches protocol state. This is a public
62 * interface that may be used by socket layer consumers to create new
65 * sonewconn() creates a socket and attaches protocol state. This is a
66 * public interface that may be used by protocols to create new sockets when
67 * a new connection is received and will be available for accept() on a
70 * soclose() destroys a socket after possibly waiting for it to disconnect.
71 * This is a public interface that socket consumers should use to close and
72 * release a socket when done with it.
74 * soabort() destroys a socket without waiting for it to disconnect (used
75 * only for incoming connections that are already partially or fully
76 * connected). This is used internally by the socket layer when clearing
77 * listen socket queues (due to overflow or close on the listen socket), but
78 * is also a public interface protocols may use to abort connections in
79 * their incomplete listen queues should they no longer be required. Sockets
80 * placed in completed connection listen queues should not be aborted for
81 * reasons described in the comment above the soclose() implementation. This
82 * is not a general purpose close routine, and except in the specific
83 * circumstances described here, should not be used.
85 * sofree() will free a socket and its protocol state if all references on
86 * the socket have been released, and is the public interface to attempt to
87 * free a socket when a reference is removed. This is a socket layer private
90 * NOTE: In addition to socreate() and soclose(), which provide a single
91 * socket reference to the consumer to be managed as required, there are two
92 * calls to explicitly manage socket references, soref(), and sorele().
93 * Currently, these are generally required only when transitioning a socket
94 * from a listen queue to a file descriptor, in order to prevent garbage
95 * collection of the socket at an untimely moment. For a number of reasons,
96 * these interfaces are not preferred, and should be avoided.
98 * NOTE: With regard to VNETs the general rule is that callers do not set
99 * curvnet. Exceptions to this rule include soabort(), sodisconnect(),
100 * sofree() (and with that sorele(), sotryfree()), as well as sonewconn()
101 * and sorflush(), which are usually called from a pre-set VNET context.
102 * sopoll() currently does not need a VNET context to be set.
105 #include <sys/cdefs.h>
106 __FBSDID("$FreeBSD$");
108 #include "opt_inet.h"
109 #include "opt_inet6.h"
110 #include "opt_sctp.h"
112 #include <sys/param.h>
113 #include <sys/systm.h>
114 #include <sys/fcntl.h>
115 #include <sys/limits.h>
116 #include <sys/lock.h>
118 #include <sys/malloc.h>
119 #include <sys/mbuf.h>
120 #include <sys/mutex.h>
121 #include <sys/domain.h>
122 #include <sys/file.h> /* for struct knote */
123 #include <sys/hhook.h>
124 #include <sys/kernel.h>
125 #include <sys/khelp.h>
126 #include <sys/event.h>
127 #include <sys/eventhandler.h>
128 #include <sys/poll.h>
129 #include <sys/proc.h>
130 #include <sys/protosw.h>
131 #include <sys/socket.h>
132 #include <sys/socketvar.h>
133 #include <sys/resourcevar.h>
134 #include <net/route.h>
135 #include <sys/signalvar.h>
136 #include <sys/stat.h>
138 #include <sys/sysctl.h>
139 #include <sys/taskqueue.h>
141 #include <sys/jail.h>
142 #include <sys/syslog.h>
143 #include <netinet/in.h>
145 #include <net/vnet.h>
147 #include <security/mac/mac_framework.h>
151 #ifdef COMPAT_FREEBSD32
152 #include <sys/mount.h>
153 #include <sys/sysent.h>
154 #include <compat/freebsd32/freebsd32.h>
157 static int soreceive_rcvoob(struct socket *so, struct uio *uio,
159 static void so_rdknl_lock(void *);
160 static void so_rdknl_unlock(void *);
161 static void so_rdknl_assert_locked(void *);
162 static void so_rdknl_assert_unlocked(void *);
163 static void so_wrknl_lock(void *);
164 static void so_wrknl_unlock(void *);
165 static void so_wrknl_assert_locked(void *);
166 static void so_wrknl_assert_unlocked(void *);
168 static void filt_sordetach(struct knote *kn);
169 static int filt_soread(struct knote *kn, long hint);
170 static void filt_sowdetach(struct knote *kn);
171 static int filt_sowrite(struct knote *kn, long hint);
172 static int filt_soempty(struct knote *kn, long hint);
173 static int inline hhook_run_socket(struct socket *so, void *hctx, int32_t h_id);
174 fo_kqfilter_t soo_kqfilter;
176 static struct filterops soread_filtops = {
178 .f_detach = filt_sordetach,
179 .f_event = filt_soread,
181 static struct filterops sowrite_filtops = {
183 .f_detach = filt_sowdetach,
184 .f_event = filt_sowrite,
186 static struct filterops soempty_filtops = {
188 .f_detach = filt_sowdetach,
189 .f_event = filt_soempty,
192 so_gen_t so_gencnt; /* generation count for sockets */
194 MALLOC_DEFINE(M_SONAME, "soname", "socket name");
195 MALLOC_DEFINE(M_PCB, "pcb", "protocol control block");
197 #define VNET_SO_ASSERT(so) \
198 VNET_ASSERT(curvnet != NULL, \
199 ("%s:%d curvnet is NULL, so=%p", __func__, __LINE__, (so)));
201 VNET_DEFINE(struct hhook_head *, socket_hhh[HHOOK_SOCKET_LAST + 1]);
202 #define V_socket_hhh VNET(socket_hhh)
205 * Limit on the number of connections in the listen queue waiting
207 * NB: The original sysctl somaxconn is still available but hidden
208 * to prevent confusion about the actual purpose of this number.
210 static u_int somaxconn = SOMAXCONN;
213 sysctl_somaxconn(SYSCTL_HANDLER_ARGS)
219 error = sysctl_handle_int(oidp, &val, 0, req);
220 if (error || !req->newptr )
224 * The purpose of the UINT_MAX / 3 limit, is so that the formula
226 * below, will not overflow.
229 if (val < 1 || val > UINT_MAX / 3)
235 SYSCTL_PROC(_kern_ipc, OID_AUTO, soacceptqueue, CTLTYPE_UINT | CTLFLAG_RW,
236 0, sizeof(int), sysctl_somaxconn, "I",
237 "Maximum listen socket pending connection accept queue size");
238 SYSCTL_PROC(_kern_ipc, KIPC_SOMAXCONN, somaxconn,
239 CTLTYPE_UINT | CTLFLAG_RW | CTLFLAG_SKIP,
240 0, sizeof(int), sysctl_somaxconn, "I",
241 "Maximum listen socket pending connection accept queue size (compat)");
243 static int numopensockets;
244 SYSCTL_INT(_kern_ipc, OID_AUTO, numopensockets, CTLFLAG_RD,
245 &numopensockets, 0, "Number of open sockets");
248 * accept_mtx locks down per-socket fields relating to accept queues. See
249 * socketvar.h for an annotation of the protected fields of struct socket.
251 struct mtx accept_mtx;
252 MTX_SYSINIT(accept_mtx, &accept_mtx, "accept", MTX_DEF);
255 * so_global_mtx protects so_gencnt, numopensockets, and the per-socket
258 static struct mtx so_global_mtx;
259 MTX_SYSINIT(so_global_mtx, &so_global_mtx, "so_glabel", MTX_DEF);
262 * General IPC sysctl name space, used by sockets and a variety of other IPC
265 SYSCTL_NODE(_kern, KERN_IPC, ipc, CTLFLAG_RW, 0, "IPC");
268 * Initialize the socket subsystem and set up the socket
271 static uma_zone_t socket_zone;
275 socket_zone_change(void *tag)
278 maxsockets = uma_zone_set_max(socket_zone, maxsockets);
282 socket_hhook_register(int subtype)
285 if (hhook_head_register(HHOOK_TYPE_SOCKET, subtype,
286 &V_socket_hhh[subtype],
287 HHOOK_NOWAIT|HHOOK_HEADISINVNET) != 0)
288 printf("%s: WARNING: unable to register hook\n", __func__);
292 socket_hhook_deregister(int subtype)
295 if (hhook_head_deregister(V_socket_hhh[subtype]) != 0)
296 printf("%s: WARNING: unable to deregister hook\n", __func__);
300 socket_init(void *tag)
303 socket_zone = uma_zcreate("socket", sizeof(struct socket), NULL, NULL,
304 NULL, NULL, UMA_ALIGN_PTR, UMA_ZONE_NOFREE);
305 maxsockets = uma_zone_set_max(socket_zone, maxsockets);
306 uma_zone_set_warning(socket_zone, "kern.ipc.maxsockets limit reached");
307 EVENTHANDLER_REGISTER(maxsockets_change, socket_zone_change, NULL,
308 EVENTHANDLER_PRI_FIRST);
310 SYSINIT(socket, SI_SUB_PROTO_DOMAININIT, SI_ORDER_ANY, socket_init, NULL);
313 socket_vnet_init(const void *unused __unused)
317 /* We expect a contiguous range */
318 for (i = 0; i <= HHOOK_SOCKET_LAST; i++)
319 socket_hhook_register(i);
321 VNET_SYSINIT(socket_vnet_init, SI_SUB_PROTO_DOMAININIT, SI_ORDER_ANY,
322 socket_vnet_init, NULL);
325 socket_vnet_uninit(const void *unused __unused)
329 for (i = 0; i <= HHOOK_SOCKET_LAST; i++)
330 socket_hhook_deregister(i);
332 VNET_SYSUNINIT(socket_vnet_uninit, SI_SUB_PROTO_DOMAININIT, SI_ORDER_ANY,
333 socket_vnet_uninit, NULL);
336 * Initialise maxsockets. This SYSINIT must be run after
340 init_maxsockets(void *ignored)
343 TUNABLE_INT_FETCH("kern.ipc.maxsockets", &maxsockets);
344 maxsockets = imax(maxsockets, maxfiles);
346 SYSINIT(param, SI_SUB_TUNABLES, SI_ORDER_ANY, init_maxsockets, NULL);
349 * Sysctl to get and set the maximum global sockets limit. Notify protocols
350 * of the change so that they can update their dependent limits as required.
353 sysctl_maxsockets(SYSCTL_HANDLER_ARGS)
355 int error, newmaxsockets;
357 newmaxsockets = maxsockets;
358 error = sysctl_handle_int(oidp, &newmaxsockets, 0, req);
359 if (error == 0 && req->newptr) {
360 if (newmaxsockets > maxsockets &&
361 newmaxsockets <= maxfiles) {
362 maxsockets = newmaxsockets;
363 EVENTHANDLER_INVOKE(maxsockets_change);
369 SYSCTL_PROC(_kern_ipc, OID_AUTO, maxsockets, CTLTYPE_INT|CTLFLAG_RW,
370 &maxsockets, 0, sysctl_maxsockets, "IU",
371 "Maximum number of sockets available");
374 * Socket operation routines. These routines are called by the routines in
375 * sys_socket.c or from a system process, and implement the semantics of
376 * socket operations by switching out to the protocol specific routines.
380 * Get a socket structure from our zone, and initialize it. Note that it
381 * would probably be better to allocate socket and PCB at the same time, but
382 * I'm not convinced that all the protocols can be easily modified to do
385 * soalloc() returns a socket with a ref count of 0.
387 static struct socket *
388 soalloc(struct vnet *vnet)
392 so = uma_zalloc(socket_zone, M_NOWAIT | M_ZERO);
396 if (mac_socket_init(so, M_NOWAIT) != 0) {
397 uma_zfree(socket_zone, so);
401 if (khelp_init_osd(HELPER_CLASS_SOCKET, &so->osd)) {
402 uma_zfree(socket_zone, so);
407 * The socket locking protocol allows to lock 2 sockets at a time,
408 * however, the first one must be a listening socket. WITNESS lacks
409 * a feature to change class of an existing lock, so we use DUPOK.
411 mtx_init(&so->so_lock, "socket", NULL, MTX_DEF | MTX_DUPOK);
412 SOCKBUF_LOCK_INIT(&so->so_snd, "so_snd");
413 SOCKBUF_LOCK_INIT(&so->so_rcv, "so_rcv");
414 so->so_rcv.sb_sel = &so->so_rdsel;
415 so->so_snd.sb_sel = &so->so_wrsel;
416 sx_init(&so->so_snd.sb_sx, "so_snd_sx");
417 sx_init(&so->so_rcv.sb_sx, "so_rcv_sx");
418 TAILQ_INIT(&so->so_snd.sb_aiojobq);
419 TAILQ_INIT(&so->so_rcv.sb_aiojobq);
420 TASK_INIT(&so->so_snd.sb_aiotask, 0, soaio_snd, so);
421 TASK_INIT(&so->so_rcv.sb_aiotask, 0, soaio_rcv, so);
423 VNET_ASSERT(vnet != NULL, ("%s:%d vnet is NULL, so=%p",
424 __func__, __LINE__, so));
427 /* We shouldn't need the so_global_mtx */
428 if (hhook_run_socket(so, NULL, HHOOK_SOCKET_CREATE)) {
429 /* Do we need more comprehensive error returns? */
430 uma_zfree(socket_zone, so);
433 mtx_lock(&so_global_mtx);
434 so->so_gencnt = ++so_gencnt;
437 vnet->vnet_sockcnt++;
439 mtx_unlock(&so_global_mtx);
445 * Free the storage associated with a socket at the socket layer, tear down
446 * locks, labels, etc. All protocol state is assumed already to have been
447 * torn down (and possibly never set up) by the caller.
450 sodealloc(struct socket *so)
453 KASSERT(so->so_count == 0, ("sodealloc(): so_count %d", so->so_count));
454 KASSERT(so->so_pcb == NULL, ("sodealloc(): so_pcb != NULL"));
456 mtx_lock(&so_global_mtx);
457 so->so_gencnt = ++so_gencnt;
458 --numopensockets; /* Could be below, but faster here. */
460 VNET_ASSERT(so->so_vnet != NULL, ("%s:%d so_vnet is NULL, so=%p",
461 __func__, __LINE__, so));
462 so->so_vnet->vnet_sockcnt--;
464 mtx_unlock(&so_global_mtx);
466 mac_socket_destroy(so);
468 hhook_run_socket(so, NULL, HHOOK_SOCKET_CLOSE);
471 khelp_destroy_osd(&so->osd);
472 if (SOLISTENING(so)) {
473 if (so->sol_accept_filter != NULL)
474 accept_filt_setopt(so, NULL);
476 if (so->so_rcv.sb_hiwat)
477 (void)chgsbsize(so->so_cred->cr_uidinfo,
478 &so->so_rcv.sb_hiwat, 0, RLIM_INFINITY);
479 if (so->so_snd.sb_hiwat)
480 (void)chgsbsize(so->so_cred->cr_uidinfo,
481 &so->so_snd.sb_hiwat, 0, RLIM_INFINITY);
482 sx_destroy(&so->so_snd.sb_sx);
483 sx_destroy(&so->so_rcv.sb_sx);
484 SOCKBUF_LOCK_DESTROY(&so->so_snd);
485 SOCKBUF_LOCK_DESTROY(&so->so_rcv);
487 mtx_destroy(&so->so_lock);
488 uma_zfree(socket_zone, so);
492 * socreate returns a socket with a ref count of 1. The socket should be
493 * closed with soclose().
496 socreate(int dom, struct socket **aso, int type, int proto,
497 struct ucred *cred, struct thread *td)
504 prp = pffindproto(dom, proto, type);
506 prp = pffindtype(dom, type);
509 /* No support for domain. */
510 if (pffinddomain(dom) == NULL)
511 return (EAFNOSUPPORT);
512 /* No support for socket type. */
513 if (proto == 0 && type != 0)
515 return (EPROTONOSUPPORT);
517 if (prp->pr_usrreqs->pru_attach == NULL ||
518 prp->pr_usrreqs->pru_attach == pru_attach_notsupp)
519 return (EPROTONOSUPPORT);
521 if (prison_check_af(cred, prp->pr_domain->dom_family) != 0)
522 return (EPROTONOSUPPORT);
524 if (prp->pr_type != type)
526 so = soalloc(CRED_TO_VNET(cred));
531 so->so_cred = crhold(cred);
532 if ((prp->pr_domain->dom_family == PF_INET) ||
533 (prp->pr_domain->dom_family == PF_INET6) ||
534 (prp->pr_domain->dom_family == PF_ROUTE))
535 so->so_fibnum = td->td_proc->p_fibnum;
540 mac_socket_create(cred, so);
542 knlist_init(&so->so_rdsel.si_note, so, so_rdknl_lock, so_rdknl_unlock,
543 so_rdknl_assert_locked, so_rdknl_assert_unlocked);
544 knlist_init(&so->so_wrsel.si_note, so, so_wrknl_lock, so_wrknl_unlock,
545 so_wrknl_assert_locked, so_wrknl_assert_unlocked);
547 * Auto-sizing of socket buffers is managed by the protocols and
548 * the appropriate flags must be set in the pru_attach function.
550 CURVNET_SET(so->so_vnet);
551 error = (*prp->pr_usrreqs->pru_attach)(so, proto, td);
563 static int regression_sonewconn_earlytest = 1;
564 SYSCTL_INT(_regression, OID_AUTO, sonewconn_earlytest, CTLFLAG_RW,
565 ®ression_sonewconn_earlytest, 0, "Perform early sonewconn limit test");
569 * When an attempt at a new connection is noted on a socket which accepts
570 * connections, sonewconn is called. If the connection is possible (subject
571 * to space constraints, etc.) then we allocate a new structure, properly
572 * linked into the data structure of the original socket, and return this.
573 * Connstatus may be 0, or SS_ISCONFIRMING, or SS_ISCONNECTED.
575 * Note: the ref count on the socket is 0 on return.
578 sonewconn(struct socket *head, int connstatus)
580 static struct timeval lastover;
581 static struct timeval overinterval = { 60, 0 };
582 static int overcount;
588 over = (head->sol_qlen > 3 * head->sol_qlimit / 2);
589 SOLISTEN_UNLOCK(head);
591 if (regression_sonewconn_earlytest && over) {
597 if (ratecheck(&lastover, &overinterval)) {
598 log(LOG_DEBUG, "%s: pcb %p: Listen queue overflow: "
599 "%i already in queue awaiting acceptance "
600 "(%d occurrences)\n",
601 __func__, head->so_pcb, head->sol_qlen, overcount);
608 VNET_ASSERT(head->so_vnet != NULL, ("%s: so %p vnet is NULL",
610 so = soalloc(head->so_vnet);
612 log(LOG_DEBUG, "%s: pcb %p: New socket allocation failure: "
613 "limit reached or out of memory\n",
614 __func__, head->so_pcb);
617 so->so_listen = head;
618 so->so_type = head->so_type;
619 so->so_linger = head->so_linger;
620 so->so_state = head->so_state | SS_NOFDREF;
621 so->so_fibnum = head->so_fibnum;
622 so->so_proto = head->so_proto;
623 so->so_cred = crhold(head->so_cred);
625 mac_socket_newconn(head, so);
627 knlist_init(&so->so_rdsel.si_note, so, so_rdknl_lock, so_rdknl_unlock,
628 so_rdknl_assert_locked, so_rdknl_assert_unlocked);
629 knlist_init(&so->so_wrsel.si_note, so, so_wrknl_lock, so_wrknl_unlock,
630 so_wrknl_assert_locked, so_wrknl_assert_unlocked);
631 VNET_SO_ASSERT(head);
632 if (soreserve(so, head->sol_sbsnd_hiwat, head->sol_sbrcv_hiwat)) {
634 log(LOG_DEBUG, "%s: pcb %p: soreserve() failed\n",
635 __func__, head->so_pcb);
638 if ((*so->so_proto->pr_usrreqs->pru_attach)(so, 0, NULL)) {
640 log(LOG_DEBUG, "%s: pcb %p: pru_attach() failed\n",
641 __func__, head->so_pcb);
644 so->so_rcv.sb_lowat = head->sol_sbrcv_lowat;
645 so->so_snd.sb_lowat = head->sol_sbsnd_lowat;
646 so->so_rcv.sb_timeo = head->sol_sbrcv_timeo;
647 so->so_snd.sb_timeo = head->sol_sbsnd_timeo;
648 so->so_rcv.sb_flags |= head->sol_sbrcv_flags & SB_AUTOSIZE;
649 so->so_snd.sb_flags |= head->sol_sbsnd_flags & SB_AUTOSIZE;
652 if (head->sol_accept_filter != NULL)
654 so->so_state |= connstatus;
655 so->so_options = head->so_options & ~SO_ACCEPTCONN;
656 soref(head); /* A socket on (in)complete queue refs head. */
658 TAILQ_INSERT_TAIL(&head->sol_comp, so, so_list);
659 so->so_qstate = SQ_COMP;
661 solisten_wakeup(head); /* unlocks */
664 * Keep removing sockets from the head until there's room for
665 * us to insert on the tail. In pre-locking revisions, this
666 * was a simple if(), but as we could be racing with other
667 * threads and soabort() requires dropping locks, we must
668 * loop waiting for the condition to be true.
670 while (head->sol_incqlen > head->sol_qlimit) {
673 sp = TAILQ_FIRST(&head->sol_incomp);
674 TAILQ_REMOVE(&head->sol_incomp, sp, so_list);
677 sp->so_qstate = SQ_NONE;
678 sp->so_listen = NULL;
680 sorele(head); /* does SOLISTEN_UNLOCK, head stays */
684 TAILQ_INSERT_TAIL(&head->sol_incomp, so, so_list);
685 so->so_qstate = SQ_INCOMP;
687 SOLISTEN_UNLOCK(head);
694 * Socket part of sctp_peeloff(). Detach a new socket from an
695 * association. The new socket is returned with a reference.
698 sopeeloff(struct socket *head)
702 VNET_ASSERT(head->so_vnet != NULL, ("%s:%d so_vnet is NULL, head=%p",
703 __func__, __LINE__, head));
704 so = soalloc(head->so_vnet);
706 log(LOG_DEBUG, "%s: pcb %p: New socket allocation failure: "
707 "limit reached or out of memory\n",
708 __func__, head->so_pcb);
711 so->so_type = head->so_type;
712 so->so_options = head->so_options;
713 so->so_linger = head->so_linger;
714 so->so_state = (head->so_state & SS_NBIO) | SS_ISCONNECTED;
715 so->so_fibnum = head->so_fibnum;
716 so->so_proto = head->so_proto;
717 so->so_cred = crhold(head->so_cred);
719 mac_socket_newconn(head, so);
721 knlist_init(&so->so_rdsel.si_note, so, so_rdknl_lock, so_rdknl_unlock,
722 so_rdknl_assert_locked, so_rdknl_assert_unlocked);
723 knlist_init(&so->so_wrsel.si_note, so, so_wrknl_lock, so_wrknl_unlock,
724 so_wrknl_assert_locked, so_wrknl_assert_unlocked);
725 VNET_SO_ASSERT(head);
726 if (soreserve(so, head->so_snd.sb_hiwat, head->so_rcv.sb_hiwat)) {
728 log(LOG_DEBUG, "%s: pcb %p: soreserve() failed\n",
729 __func__, head->so_pcb);
732 if ((*so->so_proto->pr_usrreqs->pru_attach)(so, 0, NULL)) {
734 log(LOG_DEBUG, "%s: pcb %p: pru_attach() failed\n",
735 __func__, head->so_pcb);
738 so->so_rcv.sb_lowat = head->so_rcv.sb_lowat;
739 so->so_snd.sb_lowat = head->so_snd.sb_lowat;
740 so->so_rcv.sb_timeo = head->so_rcv.sb_timeo;
741 so->so_snd.sb_timeo = head->so_snd.sb_timeo;
742 so->so_rcv.sb_flags |= head->so_rcv.sb_flags & SB_AUTOSIZE;
743 so->so_snd.sb_flags |= head->so_snd.sb_flags & SB_AUTOSIZE;
752 sobind(struct socket *so, struct sockaddr *nam, struct thread *td)
756 CURVNET_SET(so->so_vnet);
757 error = (*so->so_proto->pr_usrreqs->pru_bind)(so, nam, td);
763 sobindat(int fd, struct socket *so, struct sockaddr *nam, struct thread *td)
767 CURVNET_SET(so->so_vnet);
768 error = (*so->so_proto->pr_usrreqs->pru_bindat)(fd, so, nam, td);
774 * solisten() transitions a socket from a non-listening state to a listening
775 * state, but can also be used to update the listen queue depth on an
776 * existing listen socket. The protocol will call back into the sockets
777 * layer using solisten_proto_check() and solisten_proto() to check and set
778 * socket-layer listen state. Call backs are used so that the protocol can
779 * acquire both protocol and socket layer locks in whatever order is required
782 * Protocol implementors are advised to hold the socket lock across the
783 * socket-layer test and set to avoid races at the socket layer.
786 solisten(struct socket *so, int backlog, struct thread *td)
790 CURVNET_SET(so->so_vnet);
791 error = (*so->so_proto->pr_usrreqs->pru_listen)(so, backlog, td);
797 solisten_proto_check(struct socket *so)
800 SOCK_LOCK_ASSERT(so);
802 if (so->so_state & (SS_ISCONNECTED | SS_ISCONNECTING |
809 solisten_proto(struct socket *so, int backlog)
811 int sbrcv_lowat, sbsnd_lowat;
812 u_int sbrcv_hiwat, sbsnd_hiwat;
813 short sbrcv_flags, sbsnd_flags;
814 sbintime_t sbrcv_timeo, sbsnd_timeo;
816 SOCK_LOCK_ASSERT(so);
822 * Change this socket to listening state.
824 sbrcv_lowat = so->so_rcv.sb_lowat;
825 sbsnd_lowat = so->so_snd.sb_lowat;
826 sbrcv_hiwat = so->so_rcv.sb_hiwat;
827 sbsnd_hiwat = so->so_snd.sb_hiwat;
828 sbrcv_flags = so->so_rcv.sb_flags;
829 sbsnd_flags = so->so_snd.sb_flags;
830 sbrcv_timeo = so->so_rcv.sb_timeo;
831 sbsnd_timeo = so->so_snd.sb_timeo;
833 sbdestroy(&so->so_snd, so);
834 sbdestroy(&so->so_rcv, so);
835 sx_destroy(&so->so_snd.sb_sx);
836 sx_destroy(&so->so_rcv.sb_sx);
837 SOCKBUF_LOCK_DESTROY(&so->so_snd);
838 SOCKBUF_LOCK_DESTROY(&so->so_rcv);
842 sizeof(struct socket) - offsetof(struct socket, so_rcv));
845 so->sol_sbrcv_lowat = sbrcv_lowat;
846 so->sol_sbsnd_lowat = sbsnd_lowat;
847 so->sol_sbrcv_hiwat = sbrcv_hiwat;
848 so->sol_sbsnd_hiwat = sbsnd_hiwat;
849 so->sol_sbrcv_flags = sbrcv_flags;
850 so->sol_sbsnd_flags = sbsnd_flags;
851 so->sol_sbrcv_timeo = sbrcv_timeo;
852 so->sol_sbsnd_timeo = sbsnd_timeo;
854 so->sol_qlen = so->sol_incqlen = 0;
855 TAILQ_INIT(&so->sol_incomp);
856 TAILQ_INIT(&so->sol_comp);
858 so->sol_accept_filter = NULL;
859 so->sol_accept_filter_arg = NULL;
860 so->sol_accept_filter_str = NULL;
862 so->sol_upcall = NULL;
863 so->sol_upcallarg = NULL;
865 so->so_options |= SO_ACCEPTCONN;
868 if (backlog < 0 || backlog > somaxconn)
870 so->sol_qlimit = backlog;
874 * Wakeup listeners/subsystems once we have a complete connection.
875 * Enters with lock, returns unlocked.
878 solisten_wakeup(struct socket *sol)
881 if (sol->sol_upcall != NULL)
882 (void )sol->sol_upcall(sol, sol->sol_upcallarg, M_NOWAIT);
884 selwakeuppri(&sol->so_rdsel, PSOCK);
885 KNOTE_LOCKED(&sol->so_rdsel.si_note, 0);
887 SOLISTEN_UNLOCK(sol);
888 wakeup_one(&sol->sol_comp);
892 * Return single connection off a listening socket queue. Main consumer of
893 * the function is kern_accept4(). Some modules, that do their own accept
894 * management also use the function.
896 * Listening socket must be locked on entry and is returned unlocked on
898 * The flags argument is set of accept4(2) flags and ACCEPT4_INHERIT.
901 solisten_dequeue(struct socket *head, struct socket **ret, int flags)
906 SOLISTEN_LOCK_ASSERT(head);
908 while (!(head->so_state & SS_NBIO) && TAILQ_EMPTY(&head->sol_comp) &&
909 head->so_error == 0) {
910 error = msleep(&head->sol_comp, &head->so_lock, PSOCK | PCATCH,
913 SOLISTEN_UNLOCK(head);
917 if (head->so_error) {
918 error = head->so_error;
920 } else if ((head->so_state & SS_NBIO) && TAILQ_EMPTY(&head->sol_comp))
925 SOLISTEN_UNLOCK(head);
928 so = TAILQ_FIRST(&head->sol_comp);
930 KASSERT(so->so_qstate == SQ_COMP,
931 ("%s: so %p not SQ_COMP", __func__, so));
934 so->so_qstate = SQ_NONE;
935 so->so_listen = NULL;
936 TAILQ_REMOVE(&head->sol_comp, so, so_list);
937 if (flags & ACCEPT4_INHERIT)
938 so->so_state |= (head->so_state & SS_NBIO);
940 so->so_state |= (flags & SOCK_NONBLOCK) ? SS_NBIO : 0;
949 * Evaluate the reference count and named references on a socket; if no
950 * references remain, free it. This should be called whenever a reference is
951 * released, such as in sorele(), but also when named reference flags are
952 * cleared in socket or protocol code.
954 * sofree() will free the socket if:
956 * - There are no outstanding file descriptor references or related consumers
959 * - The socket has been closed by user space, if ever open (SS_NOFDREF).
961 * - The protocol does not have an outstanding strong reference on the socket
964 * - The socket is not in a completed connection queue, so a process has been
965 * notified that it is present. If it is removed, the user process may
966 * block in accept() despite select() saying the socket was ready.
969 sofree(struct socket *so)
971 struct protosw *pr = so->so_proto;
973 SOCK_LOCK_ASSERT(so);
975 if ((so->so_state & SS_NOFDREF) == 0 || so->so_count != 0 ||
976 (so->so_state & SS_PROTOREF) || (so->so_qstate == SQ_COMP)) {
981 if (!SOLISTENING(so) && so->so_qstate == SQ_INCOMP) {
985 KASSERT(sol, ("%s: so %p on incomp of NULL", __func__, so));
988 * To solve race between close of a listening socket and
989 * a socket on its incomplete queue, we need to lock both.
990 * The order is first listening socket, then regular.
991 * Since we don't have SS_NOFDREF neither SS_PROTOREF, this
992 * function and the listening socket are the only pointers
993 * to so. To preserve so and sol, we reference both and then
995 * After relock the socket may not move to so_comp since it
996 * doesn't have PCB already, but it may be removed from
997 * so_incomp. If that happens, we share responsiblity on
998 * freeing the socket, but soclose() has already removed
1006 if (so->so_qstate == SQ_INCOMP) {
1007 KASSERT(so->so_listen == sol,
1008 ("%s: so %p migrated out of sol %p",
1009 __func__, so, sol));
1010 TAILQ_REMOVE(&sol->sol_incomp, so, so_list);
1012 /* This is guarenteed not to be the last. */
1013 refcount_release(&sol->so_count);
1014 so->so_qstate = SQ_NONE;
1015 so->so_listen = NULL;
1017 KASSERT(so->so_listen == NULL,
1018 ("%s: so %p not on (in)comp with so_listen",
1021 KASSERT(so->so_count == 1,
1022 ("%s: so %p count %u", __func__, so, so->so_count));
1025 if (SOLISTENING(so))
1026 so->so_error = ECONNABORTED;
1029 if (so->so_dtor != NULL)
1033 if (pr->pr_flags & PR_RIGHTS && pr->pr_domain->dom_dispose != NULL)
1034 (*pr->pr_domain->dom_dispose)(so);
1035 if (pr->pr_usrreqs->pru_detach != NULL)
1036 (*pr->pr_usrreqs->pru_detach)(so);
1039 * From this point on, we assume that no other references to this
1040 * socket exist anywhere else in the stack. Therefore, no locks need
1041 * to be acquired or held.
1043 * We used to do a lot of socket buffer and socket locking here, as
1044 * well as invoke sorflush() and perform wakeups. The direct call to
1045 * dom_dispose() and sbrelease_internal() are an inlining of what was
1046 * necessary from sorflush().
1048 * Notice that the socket buffer and kqueue state are torn down
1049 * before calling pru_detach. This means that protocols shold not
1050 * assume they can perform socket wakeups, etc, in their detach code.
1052 if (!SOLISTENING(so)) {
1053 sbdestroy(&so->so_snd, so);
1054 sbdestroy(&so->so_rcv, so);
1056 seldrain(&so->so_rdsel);
1057 seldrain(&so->so_wrsel);
1058 knlist_destroy(&so->so_rdsel.si_note);
1059 knlist_destroy(&so->so_wrsel.si_note);
1064 * Close a socket on last file table reference removal. Initiate disconnect
1065 * if connected. Free socket when disconnect complete.
1067 * This function will sorele() the socket. Note that soclose() may be called
1068 * prior to the ref count reaching zero. The actual socket structure will
1069 * not be freed until the ref count reaches zero.
1072 soclose(struct socket *so)
1074 struct accept_queue lqueue;
1078 KASSERT(!(so->so_state & SS_NOFDREF), ("soclose: SS_NOFDREF on enter"));
1080 CURVNET_SET(so->so_vnet);
1081 funsetown(&so->so_sigio);
1082 if (so->so_state & SS_ISCONNECTED) {
1083 if ((so->so_state & SS_ISDISCONNECTING) == 0) {
1084 error = sodisconnect(so);
1086 if (error == ENOTCONN)
1091 if (so->so_options & SO_LINGER) {
1092 if ((so->so_state & SS_ISDISCONNECTING) &&
1093 (so->so_state & SS_NBIO))
1095 while (so->so_state & SS_ISCONNECTED) {
1096 error = tsleep(&so->so_timeo,
1097 PSOCK | PCATCH, "soclos",
1098 so->so_linger * hz);
1106 if (so->so_proto->pr_usrreqs->pru_close != NULL)
1107 (*so->so_proto->pr_usrreqs->pru_close)(so);
1110 if ((listening = (so->so_options & SO_ACCEPTCONN))) {
1113 TAILQ_INIT(&lqueue);
1114 TAILQ_SWAP(&lqueue, &so->sol_incomp, socket, so_list);
1115 TAILQ_CONCAT(&lqueue, &so->sol_comp, so_list);
1117 so->sol_qlen = so->sol_incqlen = 0;
1119 TAILQ_FOREACH(sp, &lqueue, so_list) {
1121 sp->so_qstate = SQ_NONE;
1122 sp->so_listen = NULL;
1124 /* Guaranteed not to be the last. */
1125 refcount_release(&so->so_count);
1128 KASSERT((so->so_state & SS_NOFDREF) == 0, ("soclose: NOFDREF"));
1129 so->so_state |= SS_NOFDREF;
1134 TAILQ_FOREACH(sp, &lqueue, so_list) {
1136 if (sp->so_count == 0) {
1140 /* sp is now in sofree() */
1149 * soabort() is used to abruptly tear down a connection, such as when a
1150 * resource limit is reached (listen queue depth exceeded), or if a listen
1151 * socket is closed while there are sockets waiting to be accepted.
1153 * This interface is tricky, because it is called on an unreferenced socket,
1154 * and must be called only by a thread that has actually removed the socket
1155 * from the listen queue it was on, or races with other threads are risked.
1157 * This interface will call into the protocol code, so must not be called
1158 * with any socket locks held. Protocols do call it while holding their own
1159 * recursible protocol mutexes, but this is something that should be subject
1160 * to review in the future.
1163 soabort(struct socket *so)
1167 * In as much as is possible, assert that no references to this
1168 * socket are held. This is not quite the same as asserting that the
1169 * current thread is responsible for arranging for no references, but
1170 * is as close as we can get for now.
1172 KASSERT(so->so_count == 0, ("soabort: so_count"));
1173 KASSERT((so->so_state & SS_PROTOREF) == 0, ("soabort: SS_PROTOREF"));
1174 KASSERT(so->so_state & SS_NOFDREF, ("soabort: !SS_NOFDREF"));
1175 KASSERT(so->so_qstate == SQ_NONE, ("soabort: !SQ_NONE"));
1178 if (so->so_proto->pr_usrreqs->pru_abort != NULL)
1179 (*so->so_proto->pr_usrreqs->pru_abort)(so);
1185 soaccept(struct socket *so, struct sockaddr **nam)
1190 KASSERT((so->so_state & SS_NOFDREF) != 0, ("soaccept: !NOFDREF"));
1191 so->so_state &= ~SS_NOFDREF;
1194 CURVNET_SET(so->so_vnet);
1195 error = (*so->so_proto->pr_usrreqs->pru_accept)(so, nam);
1201 soconnect(struct socket *so, struct sockaddr *nam, struct thread *td)
1204 return (soconnectat(AT_FDCWD, so, nam, td));
1208 soconnectat(int fd, struct socket *so, struct sockaddr *nam, struct thread *td)
1212 if (so->so_options & SO_ACCEPTCONN)
1213 return (EOPNOTSUPP);
1215 CURVNET_SET(so->so_vnet);
1217 * If protocol is connection-based, can only connect once.
1218 * Otherwise, if connected, try to disconnect first. This allows
1219 * user to disconnect by connecting to, e.g., a null address.
1221 if (so->so_state & (SS_ISCONNECTED|SS_ISCONNECTING) &&
1222 ((so->so_proto->pr_flags & PR_CONNREQUIRED) ||
1223 (error = sodisconnect(so)))) {
1227 * Prevent accumulated error from previous connection from
1231 if (fd == AT_FDCWD) {
1232 error = (*so->so_proto->pr_usrreqs->pru_connect)(so,
1235 error = (*so->so_proto->pr_usrreqs->pru_connectat)(fd,
1245 soconnect2(struct socket *so1, struct socket *so2)
1249 CURVNET_SET(so1->so_vnet);
1250 error = (*so1->so_proto->pr_usrreqs->pru_connect2)(so1, so2);
1256 sodisconnect(struct socket *so)
1260 if ((so->so_state & SS_ISCONNECTED) == 0)
1262 if (so->so_state & SS_ISDISCONNECTING)
1265 error = (*so->so_proto->pr_usrreqs->pru_disconnect)(so);
1269 #define SBLOCKWAIT(f) (((f) & MSG_DONTWAIT) ? 0 : SBL_WAIT)
1272 sosend_dgram(struct socket *so, struct sockaddr *addr, struct uio *uio,
1273 struct mbuf *top, struct mbuf *control, int flags, struct thread *td)
1277 int clen = 0, error, dontroute;
1279 KASSERT(so->so_type == SOCK_DGRAM, ("sosend_dgram: !SOCK_DGRAM"));
1280 KASSERT(so->so_proto->pr_flags & PR_ATOMIC,
1281 ("sosend_dgram: !PR_ATOMIC"));
1284 resid = uio->uio_resid;
1286 resid = top->m_pkthdr.len;
1288 * In theory resid should be unsigned. However, space must be
1289 * signed, as it might be less than 0 if we over-committed, and we
1290 * must use a signed comparison of space and resid. On the other
1291 * hand, a negative resid causes us to loop sending 0-length
1292 * segments to the protocol.
1300 (flags & MSG_DONTROUTE) && (so->so_options & SO_DONTROUTE) == 0;
1302 td->td_ru.ru_msgsnd++;
1303 if (control != NULL)
1304 clen = control->m_len;
1306 SOCKBUF_LOCK(&so->so_snd);
1307 if (so->so_snd.sb_state & SBS_CANTSENDMORE) {
1308 SOCKBUF_UNLOCK(&so->so_snd);
1313 error = so->so_error;
1315 SOCKBUF_UNLOCK(&so->so_snd);
1318 if ((so->so_state & SS_ISCONNECTED) == 0) {
1320 * `sendto' and `sendmsg' is allowed on a connection-based
1321 * socket if it supports implied connect. Return ENOTCONN if
1322 * not connected and no address is supplied.
1324 if ((so->so_proto->pr_flags & PR_CONNREQUIRED) &&
1325 (so->so_proto->pr_flags & PR_IMPLOPCL) == 0) {
1326 if ((so->so_state & SS_ISCONFIRMING) == 0 &&
1327 !(resid == 0 && clen != 0)) {
1328 SOCKBUF_UNLOCK(&so->so_snd);
1332 } else if (addr == NULL) {
1333 if (so->so_proto->pr_flags & PR_CONNREQUIRED)
1336 error = EDESTADDRREQ;
1337 SOCKBUF_UNLOCK(&so->so_snd);
1343 * Do we need MSG_OOB support in SOCK_DGRAM? Signs here may be a
1344 * problem and need fixing.
1346 space = sbspace(&so->so_snd);
1347 if (flags & MSG_OOB)
1350 SOCKBUF_UNLOCK(&so->so_snd);
1351 if (resid > space) {
1357 if (flags & MSG_EOR)
1358 top->m_flags |= M_EOR;
1361 * Copy the data from userland into a mbuf chain.
1362 * If no data is to be copied in, a single empty mbuf
1365 top = m_uiotombuf(uio, M_WAITOK, space, max_hdr,
1366 (M_PKTHDR | ((flags & MSG_EOR) ? M_EOR : 0)));
1368 error = EFAULT; /* only possible error */
1371 space -= resid - uio->uio_resid;
1372 resid = uio->uio_resid;
1374 KASSERT(resid == 0, ("sosend_dgram: resid != 0"));
1376 * XXXRW: Frobbing SO_DONTROUTE here is even worse without sblock
1381 so->so_options |= SO_DONTROUTE;
1385 * XXX all the SBS_CANTSENDMORE checks previously done could be out
1386 * of date. We could have received a reset packet in an interrupt or
1387 * maybe we slept while doing page faults in uiomove() etc. We could
1388 * probably recheck again inside the locking protection here, but
1389 * there are probably other places that this also happens. We must
1393 error = (*so->so_proto->pr_usrreqs->pru_send)(so,
1394 (flags & MSG_OOB) ? PRUS_OOB :
1396 * If the user set MSG_EOF, the protocol understands this flag and
1397 * nothing left to send then use PRU_SEND_EOF instead of PRU_SEND.
1399 ((flags & MSG_EOF) &&
1400 (so->so_proto->pr_flags & PR_IMPLOPCL) &&
1403 /* If there is more to send set PRUS_MORETOCOME */
1404 (flags & MSG_MORETOCOME) ||
1405 (resid > 0 && space > 0) ? PRUS_MORETOCOME : 0,
1406 top, addr, control, td);
1409 so->so_options &= ~SO_DONTROUTE;
1418 if (control != NULL)
1424 * Send on a socket. If send must go all at once and message is larger than
1425 * send buffering, then hard error. Lock against other senders. If must go
1426 * all at once and not enough room now, then inform user that this would
1427 * block and do nothing. Otherwise, if nonblocking, send as much as
1428 * possible. The data to be sent is described by "uio" if nonzero, otherwise
1429 * by the mbuf chain "top" (which must be null if uio is not). Data provided
1430 * in mbuf chain must be small enough to send all at once.
1432 * Returns nonzero on error, timeout or signal; callers must check for short
1433 * counts if EINTR/ERESTART are returned. Data and control buffers are freed
1437 sosend_generic(struct socket *so, struct sockaddr *addr, struct uio *uio,
1438 struct mbuf *top, struct mbuf *control, int flags, struct thread *td)
1442 int clen = 0, error, dontroute;
1443 int atomic = sosendallatonce(so) || top;
1446 resid = uio->uio_resid;
1448 resid = top->m_pkthdr.len;
1450 * In theory resid should be unsigned. However, space must be
1451 * signed, as it might be less than 0 if we over-committed, and we
1452 * must use a signed comparison of space and resid. On the other
1453 * hand, a negative resid causes us to loop sending 0-length
1454 * segments to the protocol.
1456 * Also check to make sure that MSG_EOR isn't used on SOCK_STREAM
1457 * type sockets since that's an error.
1459 if (resid < 0 || (so->so_type == SOCK_STREAM && (flags & MSG_EOR))) {
1465 (flags & MSG_DONTROUTE) && (so->so_options & SO_DONTROUTE) == 0 &&
1466 (so->so_proto->pr_flags & PR_ATOMIC);
1468 td->td_ru.ru_msgsnd++;
1469 if (control != NULL)
1470 clen = control->m_len;
1472 error = sblock(&so->so_snd, SBLOCKWAIT(flags));
1478 SOCKBUF_LOCK(&so->so_snd);
1479 if (so->so_snd.sb_state & SBS_CANTSENDMORE) {
1480 SOCKBUF_UNLOCK(&so->so_snd);
1485 error = so->so_error;
1487 SOCKBUF_UNLOCK(&so->so_snd);
1490 if ((so->so_state & SS_ISCONNECTED) == 0) {
1492 * `sendto' and `sendmsg' is allowed on a connection-
1493 * based socket if it supports implied connect.
1494 * Return ENOTCONN if not connected and no address is
1497 if ((so->so_proto->pr_flags & PR_CONNREQUIRED) &&
1498 (so->so_proto->pr_flags & PR_IMPLOPCL) == 0) {
1499 if ((so->so_state & SS_ISCONFIRMING) == 0 &&
1500 !(resid == 0 && clen != 0)) {
1501 SOCKBUF_UNLOCK(&so->so_snd);
1505 } else if (addr == NULL) {
1506 SOCKBUF_UNLOCK(&so->so_snd);
1507 if (so->so_proto->pr_flags & PR_CONNREQUIRED)
1510 error = EDESTADDRREQ;
1514 space = sbspace(&so->so_snd);
1515 if (flags & MSG_OOB)
1517 if ((atomic && resid > so->so_snd.sb_hiwat) ||
1518 clen > so->so_snd.sb_hiwat) {
1519 SOCKBUF_UNLOCK(&so->so_snd);
1523 if (space < resid + clen &&
1524 (atomic || space < so->so_snd.sb_lowat || space < clen)) {
1525 if ((so->so_state & SS_NBIO) || (flags & MSG_NBIO)) {
1526 SOCKBUF_UNLOCK(&so->so_snd);
1527 error = EWOULDBLOCK;
1530 error = sbwait(&so->so_snd);
1531 SOCKBUF_UNLOCK(&so->so_snd);
1536 SOCKBUF_UNLOCK(&so->so_snd);
1541 if (flags & MSG_EOR)
1542 top->m_flags |= M_EOR;
1545 * Copy the data from userland into a mbuf
1546 * chain. If resid is 0, which can happen
1547 * only if we have control to send, then
1548 * a single empty mbuf is returned. This
1549 * is a workaround to prevent protocol send
1552 top = m_uiotombuf(uio, M_WAITOK, space,
1553 (atomic ? max_hdr : 0),
1554 (atomic ? M_PKTHDR : 0) |
1555 ((flags & MSG_EOR) ? M_EOR : 0));
1557 error = EFAULT; /* only possible error */
1560 space -= resid - uio->uio_resid;
1561 resid = uio->uio_resid;
1565 so->so_options |= SO_DONTROUTE;
1569 * XXX all the SBS_CANTSENDMORE checks previously
1570 * done could be out of date. We could have received
1571 * a reset packet in an interrupt or maybe we slept
1572 * while doing page faults in uiomove() etc. We
1573 * could probably recheck again inside the locking
1574 * protection here, but there are probably other
1575 * places that this also happens. We must rethink
1579 error = (*so->so_proto->pr_usrreqs->pru_send)(so,
1580 (flags & MSG_OOB) ? PRUS_OOB :
1582 * If the user set MSG_EOF, the protocol understands
1583 * this flag and nothing left to send then use
1584 * PRU_SEND_EOF instead of PRU_SEND.
1586 ((flags & MSG_EOF) &&
1587 (so->so_proto->pr_flags & PR_IMPLOPCL) &&
1590 /* If there is more to send set PRUS_MORETOCOME. */
1591 (flags & MSG_MORETOCOME) ||
1592 (resid > 0 && space > 0) ? PRUS_MORETOCOME : 0,
1593 top, addr, control, td);
1596 so->so_options &= ~SO_DONTROUTE;
1604 } while (resid && space > 0);
1608 sbunlock(&so->so_snd);
1612 if (control != NULL)
1618 sosend(struct socket *so, struct sockaddr *addr, struct uio *uio,
1619 struct mbuf *top, struct mbuf *control, int flags, struct thread *td)
1623 CURVNET_SET(so->so_vnet);
1624 if (!SOLISTENING(so))
1625 error = so->so_proto->pr_usrreqs->pru_sosend(so, addr, uio,
1626 top, control, flags, td);
1637 * The part of soreceive() that implements reading non-inline out-of-band
1638 * data from a socket. For more complete comments, see soreceive(), from
1639 * which this code originated.
1641 * Note that soreceive_rcvoob(), unlike the remainder of soreceive(), is
1642 * unable to return an mbuf chain to the caller.
1645 soreceive_rcvoob(struct socket *so, struct uio *uio, int flags)
1647 struct protosw *pr = so->so_proto;
1651 KASSERT(flags & MSG_OOB, ("soreceive_rcvoob: (flags & MSG_OOB) == 0"));
1654 m = m_get(M_WAITOK, MT_DATA);
1655 error = (*pr->pr_usrreqs->pru_rcvoob)(so, m, flags & MSG_PEEK);
1659 error = uiomove(mtod(m, void *),
1660 (int) min(uio->uio_resid, m->m_len), uio);
1662 } while (uio->uio_resid && error == 0 && m);
1670 * Following replacement or removal of the first mbuf on the first mbuf chain
1671 * of a socket buffer, push necessary state changes back into the socket
1672 * buffer so that other consumers see the values consistently. 'nextrecord'
1673 * is the callers locally stored value of the original value of
1674 * sb->sb_mb->m_nextpkt which must be restored when the lead mbuf changes.
1675 * NOTE: 'nextrecord' may be NULL.
1677 static __inline void
1678 sockbuf_pushsync(struct sockbuf *sb, struct mbuf *nextrecord)
1681 SOCKBUF_LOCK_ASSERT(sb);
1683 * First, update for the new value of nextrecord. If necessary, make
1684 * it the first record.
1686 if (sb->sb_mb != NULL)
1687 sb->sb_mb->m_nextpkt = nextrecord;
1689 sb->sb_mb = nextrecord;
1692 * Now update any dependent socket buffer fields to reflect the new
1693 * state. This is an expanded inline of SB_EMPTY_FIXUP(), with the
1694 * addition of a second clause that takes care of the case where
1695 * sb_mb has been updated, but remains the last record.
1697 if (sb->sb_mb == NULL) {
1698 sb->sb_mbtail = NULL;
1699 sb->sb_lastrecord = NULL;
1700 } else if (sb->sb_mb->m_nextpkt == NULL)
1701 sb->sb_lastrecord = sb->sb_mb;
1705 * Implement receive operations on a socket. We depend on the way that
1706 * records are added to the sockbuf by sbappend. In particular, each record
1707 * (mbufs linked through m_next) must begin with an address if the protocol
1708 * so specifies, followed by an optional mbuf or mbufs containing ancillary
1709 * data, and then zero or more mbufs of data. In order to allow parallelism
1710 * between network receive and copying to user space, as well as avoid
1711 * sleeping with a mutex held, we release the socket buffer mutex during the
1712 * user space copy. Although the sockbuf is locked, new data may still be
1713 * appended, and thus we must maintain consistency of the sockbuf during that
1716 * The caller may receive the data as a single mbuf chain by supplying an
1717 * mbuf **mp0 for use in returning the chain. The uio is then used only for
1718 * the count in uio_resid.
1721 soreceive_generic(struct socket *so, struct sockaddr **psa, struct uio *uio,
1722 struct mbuf **mp0, struct mbuf **controlp, int *flagsp)
1724 struct mbuf *m, **mp;
1725 int flags, error, offset;
1727 struct protosw *pr = so->so_proto;
1728 struct mbuf *nextrecord;
1730 ssize_t orig_resid = uio->uio_resid;
1735 if (controlp != NULL)
1738 flags = *flagsp &~ MSG_EOR;
1741 if (flags & MSG_OOB)
1742 return (soreceive_rcvoob(so, uio, flags));
1745 if ((pr->pr_flags & PR_WANTRCVD) && (so->so_state & SS_ISCONFIRMING)
1746 && uio->uio_resid) {
1748 (*pr->pr_usrreqs->pru_rcvd)(so, 0);
1751 error = sblock(&so->so_rcv, SBLOCKWAIT(flags));
1756 SOCKBUF_LOCK(&so->so_rcv);
1757 m = so->so_rcv.sb_mb;
1759 * If we have less data than requested, block awaiting more (subject
1760 * to any timeout) if:
1761 * 1. the current count is less than the low water mark, or
1762 * 2. MSG_DONTWAIT is not set
1764 if (m == NULL || (((flags & MSG_DONTWAIT) == 0 &&
1765 sbavail(&so->so_rcv) < uio->uio_resid) &&
1766 sbavail(&so->so_rcv) < so->so_rcv.sb_lowat &&
1767 m->m_nextpkt == NULL && (pr->pr_flags & PR_ATOMIC) == 0)) {
1768 KASSERT(m != NULL || !sbavail(&so->so_rcv),
1769 ("receive: m == %p sbavail == %u",
1770 m, sbavail(&so->so_rcv)));
1774 error = so->so_error;
1775 if ((flags & MSG_PEEK) == 0)
1777 SOCKBUF_UNLOCK(&so->so_rcv);
1780 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
1781 if (so->so_rcv.sb_state & SBS_CANTRCVMORE) {
1783 SOCKBUF_UNLOCK(&so->so_rcv);
1788 for (; m != NULL; m = m->m_next)
1789 if (m->m_type == MT_OOBDATA || (m->m_flags & M_EOR)) {
1790 m = so->so_rcv.sb_mb;
1793 if ((so->so_state & (SS_ISCONNECTED|SS_ISCONNECTING)) == 0 &&
1794 (so->so_proto->pr_flags & PR_CONNREQUIRED)) {
1795 SOCKBUF_UNLOCK(&so->so_rcv);
1799 if (uio->uio_resid == 0) {
1800 SOCKBUF_UNLOCK(&so->so_rcv);
1803 if ((so->so_state & SS_NBIO) ||
1804 (flags & (MSG_DONTWAIT|MSG_NBIO))) {
1805 SOCKBUF_UNLOCK(&so->so_rcv);
1806 error = EWOULDBLOCK;
1809 SBLASTRECORDCHK(&so->so_rcv);
1810 SBLASTMBUFCHK(&so->so_rcv);
1811 error = sbwait(&so->so_rcv);
1812 SOCKBUF_UNLOCK(&so->so_rcv);
1819 * From this point onward, we maintain 'nextrecord' as a cache of the
1820 * pointer to the next record in the socket buffer. We must keep the
1821 * various socket buffer pointers and local stack versions of the
1822 * pointers in sync, pushing out modifications before dropping the
1823 * socket buffer mutex, and re-reading them when picking it up.
1825 * Otherwise, we will race with the network stack appending new data
1826 * or records onto the socket buffer by using inconsistent/stale
1827 * versions of the field, possibly resulting in socket buffer
1830 * By holding the high-level sblock(), we prevent simultaneous
1831 * readers from pulling off the front of the socket buffer.
1833 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
1835 uio->uio_td->td_ru.ru_msgrcv++;
1836 KASSERT(m == so->so_rcv.sb_mb, ("soreceive: m != so->so_rcv.sb_mb"));
1837 SBLASTRECORDCHK(&so->so_rcv);
1838 SBLASTMBUFCHK(&so->so_rcv);
1839 nextrecord = m->m_nextpkt;
1840 if (pr->pr_flags & PR_ADDR) {
1841 KASSERT(m->m_type == MT_SONAME,
1842 ("m->m_type == %d", m->m_type));
1845 *psa = sodupsockaddr(mtod(m, struct sockaddr *),
1847 if (flags & MSG_PEEK) {
1850 sbfree(&so->so_rcv, m);
1851 so->so_rcv.sb_mb = m_free(m);
1852 m = so->so_rcv.sb_mb;
1853 sockbuf_pushsync(&so->so_rcv, nextrecord);
1858 * Process one or more MT_CONTROL mbufs present before any data mbufs
1859 * in the first mbuf chain on the socket buffer. If MSG_PEEK, we
1860 * just copy the data; if !MSG_PEEK, we call into the protocol to
1861 * perform externalization (or freeing if controlp == NULL).
1863 if (m != NULL && m->m_type == MT_CONTROL) {
1864 struct mbuf *cm = NULL, *cmn;
1865 struct mbuf **cme = &cm;
1868 if (flags & MSG_PEEK) {
1869 if (controlp != NULL) {
1870 *controlp = m_copym(m, 0, m->m_len,
1872 controlp = &(*controlp)->m_next;
1876 sbfree(&so->so_rcv, m);
1877 so->so_rcv.sb_mb = m->m_next;
1880 cme = &(*cme)->m_next;
1881 m = so->so_rcv.sb_mb;
1883 } while (m != NULL && m->m_type == MT_CONTROL);
1884 if ((flags & MSG_PEEK) == 0)
1885 sockbuf_pushsync(&so->so_rcv, nextrecord);
1886 while (cm != NULL) {
1889 if (pr->pr_domain->dom_externalize != NULL) {
1890 SOCKBUF_UNLOCK(&so->so_rcv);
1892 error = (*pr->pr_domain->dom_externalize)
1893 (cm, controlp, flags);
1894 SOCKBUF_LOCK(&so->so_rcv);
1895 } else if (controlp != NULL)
1899 if (controlp != NULL) {
1901 while (*controlp != NULL)
1902 controlp = &(*controlp)->m_next;
1907 nextrecord = so->so_rcv.sb_mb->m_nextpkt;
1909 nextrecord = so->so_rcv.sb_mb;
1913 if ((flags & MSG_PEEK) == 0) {
1914 KASSERT(m->m_nextpkt == nextrecord,
1915 ("soreceive: post-control, nextrecord !sync"));
1916 if (nextrecord == NULL) {
1917 KASSERT(so->so_rcv.sb_mb == m,
1918 ("soreceive: post-control, sb_mb!=m"));
1919 KASSERT(so->so_rcv.sb_lastrecord == m,
1920 ("soreceive: post-control, lastrecord!=m"));
1924 if (type == MT_OOBDATA)
1927 if ((flags & MSG_PEEK) == 0) {
1928 KASSERT(so->so_rcv.sb_mb == nextrecord,
1929 ("soreceive: sb_mb != nextrecord"));
1930 if (so->so_rcv.sb_mb == NULL) {
1931 KASSERT(so->so_rcv.sb_lastrecord == NULL,
1932 ("soreceive: sb_lastercord != NULL"));
1936 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
1937 SBLASTRECORDCHK(&so->so_rcv);
1938 SBLASTMBUFCHK(&so->so_rcv);
1941 * Now continue to read any data mbufs off of the head of the socket
1942 * buffer until the read request is satisfied. Note that 'type' is
1943 * used to store the type of any mbuf reads that have happened so far
1944 * such that soreceive() can stop reading if the type changes, which
1945 * causes soreceive() to return only one of regular data and inline
1946 * out-of-band data in a single socket receive operation.
1950 while (m != NULL && !(m->m_flags & M_NOTAVAIL) && uio->uio_resid > 0
1953 * If the type of mbuf has changed since the last mbuf
1954 * examined ('type'), end the receive operation.
1956 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
1957 if (m->m_type == MT_OOBDATA || m->m_type == MT_CONTROL) {
1958 if (type != m->m_type)
1960 } else if (type == MT_OOBDATA)
1963 KASSERT(m->m_type == MT_DATA,
1964 ("m->m_type == %d", m->m_type));
1965 so->so_rcv.sb_state &= ~SBS_RCVATMARK;
1966 len = uio->uio_resid;
1967 if (so->so_oobmark && len > so->so_oobmark - offset)
1968 len = so->so_oobmark - offset;
1969 if (len > m->m_len - moff)
1970 len = m->m_len - moff;
1972 * If mp is set, just pass back the mbufs. Otherwise copy
1973 * them out via the uio, then free. Sockbuf must be
1974 * consistent here (points to current mbuf, it points to next
1975 * record) when we drop priority; we must note any additions
1976 * to the sockbuf when we block interrupts again.
1979 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
1980 SBLASTRECORDCHK(&so->so_rcv);
1981 SBLASTMBUFCHK(&so->so_rcv);
1982 SOCKBUF_UNLOCK(&so->so_rcv);
1983 error = uiomove(mtod(m, char *) + moff, (int)len, uio);
1984 SOCKBUF_LOCK(&so->so_rcv);
1987 * The MT_SONAME mbuf has already been removed
1988 * from the record, so it is necessary to
1989 * remove the data mbufs, if any, to preserve
1990 * the invariant in the case of PR_ADDR that
1991 * requires MT_SONAME mbufs at the head of
1994 if (pr->pr_flags & PR_ATOMIC &&
1995 ((flags & MSG_PEEK) == 0))
1996 (void)sbdroprecord_locked(&so->so_rcv);
1997 SOCKBUF_UNLOCK(&so->so_rcv);
2001 uio->uio_resid -= len;
2002 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2003 if (len == m->m_len - moff) {
2004 if (m->m_flags & M_EOR)
2006 if (flags & MSG_PEEK) {
2010 nextrecord = m->m_nextpkt;
2011 sbfree(&so->so_rcv, m);
2013 m->m_nextpkt = NULL;
2016 so->so_rcv.sb_mb = m = m->m_next;
2019 so->so_rcv.sb_mb = m_free(m);
2020 m = so->so_rcv.sb_mb;
2022 sockbuf_pushsync(&so->so_rcv, nextrecord);
2023 SBLASTRECORDCHK(&so->so_rcv);
2024 SBLASTMBUFCHK(&so->so_rcv);
2027 if (flags & MSG_PEEK)
2031 if (flags & MSG_DONTWAIT) {
2032 *mp = m_copym(m, 0, len,
2036 * m_copym() couldn't
2038 * Adjust uio_resid back
2040 * down by len bytes,
2041 * which we didn't end
2042 * up "copying" over).
2044 uio->uio_resid += len;
2048 SOCKBUF_UNLOCK(&so->so_rcv);
2049 *mp = m_copym(m, 0, len,
2051 SOCKBUF_LOCK(&so->so_rcv);
2054 sbcut_locked(&so->so_rcv, len);
2057 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2058 if (so->so_oobmark) {
2059 if ((flags & MSG_PEEK) == 0) {
2060 so->so_oobmark -= len;
2061 if (so->so_oobmark == 0) {
2062 so->so_rcv.sb_state |= SBS_RCVATMARK;
2067 if (offset == so->so_oobmark)
2071 if (flags & MSG_EOR)
2074 * If the MSG_WAITALL flag is set (for non-atomic socket), we
2075 * must not quit until "uio->uio_resid == 0" or an error
2076 * termination. If a signal/timeout occurs, return with a
2077 * short count but without error. Keep sockbuf locked
2078 * against other readers.
2080 while (flags & MSG_WAITALL && m == NULL && uio->uio_resid > 0 &&
2081 !sosendallatonce(so) && nextrecord == NULL) {
2082 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2084 so->so_rcv.sb_state & SBS_CANTRCVMORE)
2087 * Notify the protocol that some data has been
2088 * drained before blocking.
2090 if (pr->pr_flags & PR_WANTRCVD) {
2091 SOCKBUF_UNLOCK(&so->so_rcv);
2093 (*pr->pr_usrreqs->pru_rcvd)(so, flags);
2094 SOCKBUF_LOCK(&so->so_rcv);
2096 SBLASTRECORDCHK(&so->so_rcv);
2097 SBLASTMBUFCHK(&so->so_rcv);
2099 * We could receive some data while was notifying
2100 * the protocol. Skip blocking in this case.
2102 if (so->so_rcv.sb_mb == NULL) {
2103 error = sbwait(&so->so_rcv);
2105 SOCKBUF_UNLOCK(&so->so_rcv);
2109 m = so->so_rcv.sb_mb;
2111 nextrecord = m->m_nextpkt;
2115 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2116 if (m != NULL && pr->pr_flags & PR_ATOMIC) {
2118 if ((flags & MSG_PEEK) == 0)
2119 (void) sbdroprecord_locked(&so->so_rcv);
2121 if ((flags & MSG_PEEK) == 0) {
2124 * First part is an inline SB_EMPTY_FIXUP(). Second
2125 * part makes sure sb_lastrecord is up-to-date if
2126 * there is still data in the socket buffer.
2128 so->so_rcv.sb_mb = nextrecord;
2129 if (so->so_rcv.sb_mb == NULL) {
2130 so->so_rcv.sb_mbtail = NULL;
2131 so->so_rcv.sb_lastrecord = NULL;
2132 } else if (nextrecord->m_nextpkt == NULL)
2133 so->so_rcv.sb_lastrecord = nextrecord;
2135 SBLASTRECORDCHK(&so->so_rcv);
2136 SBLASTMBUFCHK(&so->so_rcv);
2138 * If soreceive() is being done from the socket callback,
2139 * then don't need to generate ACK to peer to update window,
2140 * since ACK will be generated on return to TCP.
2142 if (!(flags & MSG_SOCALLBCK) &&
2143 (pr->pr_flags & PR_WANTRCVD)) {
2144 SOCKBUF_UNLOCK(&so->so_rcv);
2146 (*pr->pr_usrreqs->pru_rcvd)(so, flags);
2147 SOCKBUF_LOCK(&so->so_rcv);
2150 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2151 if (orig_resid == uio->uio_resid && orig_resid &&
2152 (flags & MSG_EOR) == 0 && (so->so_rcv.sb_state & SBS_CANTRCVMORE) == 0) {
2153 SOCKBUF_UNLOCK(&so->so_rcv);
2156 SOCKBUF_UNLOCK(&so->so_rcv);
2161 sbunlock(&so->so_rcv);
2166 * Optimized version of soreceive() for stream (TCP) sockets.
2169 soreceive_stream(struct socket *so, struct sockaddr **psa, struct uio *uio,
2170 struct mbuf **mp0, struct mbuf **controlp, int *flagsp)
2172 int len = 0, error = 0, flags, oresid;
2174 struct mbuf *m, *n = NULL;
2176 /* We only do stream sockets. */
2177 if (so->so_type != SOCK_STREAM)
2182 flags = *flagsp &~ MSG_EOR;
2185 if (controlp != NULL)
2187 if (flags & MSG_OOB)
2188 return (soreceive_rcvoob(so, uio, flags));
2194 /* Prevent other readers from entering the socket. */
2195 error = sblock(sb, SBLOCKWAIT(flags));
2200 /* Easy one, no space to copyout anything. */
2201 if (uio->uio_resid == 0) {
2205 oresid = uio->uio_resid;
2207 /* We will never ever get anything unless we are or were connected. */
2208 if (!(so->so_state & (SS_ISCONNECTED|SS_ISDISCONNECTED))) {
2214 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2216 /* Abort if socket has reported problems. */
2218 if (sbavail(sb) > 0)
2220 if (oresid > uio->uio_resid)
2222 error = so->so_error;
2223 if (!(flags & MSG_PEEK))
2228 /* Door is closed. Deliver what is left, if any. */
2229 if (sb->sb_state & SBS_CANTRCVMORE) {
2230 if (sbavail(sb) > 0)
2236 /* Socket buffer is empty and we shall not block. */
2237 if (sbavail(sb) == 0 &&
2238 ((so->so_state & SS_NBIO) || (flags & (MSG_DONTWAIT|MSG_NBIO)))) {
2243 /* Socket buffer got some data that we shall deliver now. */
2244 if (sbavail(sb) > 0 && !(flags & MSG_WAITALL) &&
2245 ((so->so_state & SS_NBIO) ||
2246 (flags & (MSG_DONTWAIT|MSG_NBIO)) ||
2247 sbavail(sb) >= sb->sb_lowat ||
2248 sbavail(sb) >= uio->uio_resid ||
2249 sbavail(sb) >= sb->sb_hiwat) ) {
2253 /* On MSG_WAITALL we must wait until all data or error arrives. */
2254 if ((flags & MSG_WAITALL) &&
2255 (sbavail(sb) >= uio->uio_resid || sbavail(sb) >= sb->sb_hiwat))
2259 * Wait and block until (more) data comes in.
2260 * NB: Drops the sockbuf lock during wait.
2268 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2269 KASSERT(sbavail(sb) > 0, ("%s: sockbuf empty", __func__));
2270 KASSERT(sb->sb_mb != NULL, ("%s: sb_mb == NULL", __func__));
2274 uio->uio_td->td_ru.ru_msgrcv++;
2276 /* Fill uio until full or current end of socket buffer is reached. */
2277 len = min(uio->uio_resid, sbavail(sb));
2279 /* Dequeue as many mbufs as possible. */
2280 if (!(flags & MSG_PEEK) && len >= sb->sb_mb->m_len) {
2284 m_cat(*mp0, sb->sb_mb);
2286 m != NULL && m->m_len <= len;
2288 KASSERT(!(m->m_flags & M_NOTAVAIL),
2289 ("%s: m %p not available", __func__, m));
2291 uio->uio_resid -= m->m_len;
2297 sb->sb_lastrecord = sb->sb_mb;
2298 if (sb->sb_mb == NULL)
2301 /* Copy the remainder. */
2303 KASSERT(sb->sb_mb != NULL,
2304 ("%s: len > 0 && sb->sb_mb empty", __func__));
2306 m = m_copym(sb->sb_mb, 0, len, M_NOWAIT);
2308 len = 0; /* Don't flush data from sockbuf. */
2310 uio->uio_resid -= len;
2321 /* NB: Must unlock socket buffer as uiomove may sleep. */
2323 error = m_mbuftouio(uio, sb->sb_mb, len);
2328 SBLASTRECORDCHK(sb);
2332 * Remove the delivered data from the socket buffer unless we
2333 * were only peeking.
2335 if (!(flags & MSG_PEEK)) {
2337 sbdrop_locked(sb, len);
2339 /* Notify protocol that we drained some data. */
2340 if ((so->so_proto->pr_flags & PR_WANTRCVD) &&
2341 (((flags & MSG_WAITALL) && uio->uio_resid > 0) ||
2342 !(flags & MSG_SOCALLBCK))) {
2345 (*so->so_proto->pr_usrreqs->pru_rcvd)(so, flags);
2351 * For MSG_WAITALL we may have to loop again and wait for
2352 * more data to come in.
2354 if ((flags & MSG_WAITALL) && uio->uio_resid > 0)
2357 SOCKBUF_LOCK_ASSERT(sb);
2358 SBLASTRECORDCHK(sb);
2366 * Optimized version of soreceive() for simple datagram cases from userspace.
2367 * Unlike in the stream case, we're able to drop a datagram if copyout()
2368 * fails, and because we handle datagrams atomically, we don't need to use a
2369 * sleep lock to prevent I/O interlacing.
2372 soreceive_dgram(struct socket *so, struct sockaddr **psa, struct uio *uio,
2373 struct mbuf **mp0, struct mbuf **controlp, int *flagsp)
2375 struct mbuf *m, *m2;
2378 struct protosw *pr = so->so_proto;
2379 struct mbuf *nextrecord;
2383 if (controlp != NULL)
2386 flags = *flagsp &~ MSG_EOR;
2391 * For any complicated cases, fall back to the full
2392 * soreceive_generic().
2394 if (mp0 != NULL || (flags & MSG_PEEK) || (flags & MSG_OOB))
2395 return (soreceive_generic(so, psa, uio, mp0, controlp,
2399 * Enforce restrictions on use.
2401 KASSERT((pr->pr_flags & PR_WANTRCVD) == 0,
2402 ("soreceive_dgram: wantrcvd"));
2403 KASSERT(pr->pr_flags & PR_ATOMIC, ("soreceive_dgram: !atomic"));
2404 KASSERT((so->so_rcv.sb_state & SBS_RCVATMARK) == 0,
2405 ("soreceive_dgram: SBS_RCVATMARK"));
2406 KASSERT((so->so_proto->pr_flags & PR_CONNREQUIRED) == 0,
2407 ("soreceive_dgram: P_CONNREQUIRED"));
2410 * Loop blocking while waiting for a datagram.
2412 SOCKBUF_LOCK(&so->so_rcv);
2413 while ((m = so->so_rcv.sb_mb) == NULL) {
2414 KASSERT(sbavail(&so->so_rcv) == 0,
2415 ("soreceive_dgram: sb_mb NULL but sbavail %u",
2416 sbavail(&so->so_rcv)));
2418 error = so->so_error;
2420 SOCKBUF_UNLOCK(&so->so_rcv);
2423 if (so->so_rcv.sb_state & SBS_CANTRCVMORE ||
2424 uio->uio_resid == 0) {
2425 SOCKBUF_UNLOCK(&so->so_rcv);
2428 if ((so->so_state & SS_NBIO) ||
2429 (flags & (MSG_DONTWAIT|MSG_NBIO))) {
2430 SOCKBUF_UNLOCK(&so->so_rcv);
2431 return (EWOULDBLOCK);
2433 SBLASTRECORDCHK(&so->so_rcv);
2434 SBLASTMBUFCHK(&so->so_rcv);
2435 error = sbwait(&so->so_rcv);
2437 SOCKBUF_UNLOCK(&so->so_rcv);
2441 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2444 uio->uio_td->td_ru.ru_msgrcv++;
2445 SBLASTRECORDCHK(&so->so_rcv);
2446 SBLASTMBUFCHK(&so->so_rcv);
2447 nextrecord = m->m_nextpkt;
2448 if (nextrecord == NULL) {
2449 KASSERT(so->so_rcv.sb_lastrecord == m,
2450 ("soreceive_dgram: lastrecord != m"));
2453 KASSERT(so->so_rcv.sb_mb->m_nextpkt == nextrecord,
2454 ("soreceive_dgram: m_nextpkt != nextrecord"));
2457 * Pull 'm' and its chain off the front of the packet queue.
2459 so->so_rcv.sb_mb = NULL;
2460 sockbuf_pushsync(&so->so_rcv, nextrecord);
2463 * Walk 'm's chain and free that many bytes from the socket buffer.
2465 for (m2 = m; m2 != NULL; m2 = m2->m_next)
2466 sbfree(&so->so_rcv, m2);
2469 * Do a few last checks before we let go of the lock.
2471 SBLASTRECORDCHK(&so->so_rcv);
2472 SBLASTMBUFCHK(&so->so_rcv);
2473 SOCKBUF_UNLOCK(&so->so_rcv);
2475 if (pr->pr_flags & PR_ADDR) {
2476 KASSERT(m->m_type == MT_SONAME,
2477 ("m->m_type == %d", m->m_type));
2479 *psa = sodupsockaddr(mtod(m, struct sockaddr *),
2484 /* XXXRW: Can this happen? */
2489 * Packet to copyout() is now in 'm' and it is disconnected from the
2492 * Process one or more MT_CONTROL mbufs present before any data mbufs
2493 * in the first mbuf chain on the socket buffer. We call into the
2494 * protocol to perform externalization (or freeing if controlp ==
2495 * NULL). In some cases there can be only MT_CONTROL mbufs without
2498 if (m->m_type == MT_CONTROL) {
2499 struct mbuf *cm = NULL, *cmn;
2500 struct mbuf **cme = &cm;
2506 cme = &(*cme)->m_next;
2508 } while (m != NULL && m->m_type == MT_CONTROL);
2509 while (cm != NULL) {
2512 if (pr->pr_domain->dom_externalize != NULL) {
2513 error = (*pr->pr_domain->dom_externalize)
2514 (cm, controlp, flags);
2515 } else if (controlp != NULL)
2519 if (controlp != NULL) {
2520 while (*controlp != NULL)
2521 controlp = &(*controlp)->m_next;
2526 KASSERT(m == NULL || m->m_type == MT_DATA,
2527 ("soreceive_dgram: !data"));
2528 while (m != NULL && uio->uio_resid > 0) {
2529 len = uio->uio_resid;
2532 error = uiomove(mtod(m, char *), (int)len, uio);
2537 if (len == m->m_len)
2554 soreceive(struct socket *so, struct sockaddr **psa, struct uio *uio,
2555 struct mbuf **mp0, struct mbuf **controlp, int *flagsp)
2559 CURVNET_SET(so->so_vnet);
2560 if (!SOLISTENING(so))
2561 error = (so->so_proto->pr_usrreqs->pru_soreceive(so, psa, uio,
2562 mp0, controlp, flagsp));
2570 soshutdown(struct socket *so, int how)
2572 struct protosw *pr = so->so_proto;
2573 int error, soerror_enotconn;
2575 if (!(how == SHUT_RD || how == SHUT_WR || how == SHUT_RDWR))
2578 soerror_enotconn = 0;
2580 (SS_ISCONNECTED | SS_ISCONNECTING | SS_ISDISCONNECTING)) == 0) {
2582 * POSIX mandates us to return ENOTCONN when shutdown(2) is
2583 * invoked on a datagram sockets, however historically we would
2584 * actually tear socket down. This is known to be leveraged by
2585 * some applications to unblock process waiting in recvXXX(2)
2586 * by other process that it shares that socket with. Try to meet
2587 * both backward-compatibility and POSIX requirements by forcing
2588 * ENOTCONN but still asking protocol to perform pru_shutdown().
2590 if (so->so_type != SOCK_DGRAM && !SOLISTENING(so))
2592 soerror_enotconn = 1;
2595 if (SOLISTENING(so)) {
2596 if (how != SHUT_WR) {
2598 so->so_error = ECONNABORTED;
2599 solisten_wakeup(so); /* unlocks so */
2604 CURVNET_SET(so->so_vnet);
2605 if (pr->pr_usrreqs->pru_flush != NULL)
2606 (*pr->pr_usrreqs->pru_flush)(so, how);
2609 if (how != SHUT_RD) {
2610 error = (*pr->pr_usrreqs->pru_shutdown)(so);
2611 wakeup(&so->so_timeo);
2613 return ((error == 0 && soerror_enotconn) ? ENOTCONN : error);
2615 wakeup(&so->so_timeo);
2619 return (soerror_enotconn ? ENOTCONN : 0);
2623 sorflush(struct socket *so)
2625 struct sockbuf *sb = &so->so_rcv;
2626 struct protosw *pr = so->so_proto;
2632 * In order to avoid calling dom_dispose with the socket buffer mutex
2633 * held, and in order to generally avoid holding the lock for a long
2634 * time, we make a copy of the socket buffer and clear the original
2635 * (except locks, state). The new socket buffer copy won't have
2636 * initialized locks so we can only call routines that won't use or
2637 * assert those locks.
2639 * Dislodge threads currently blocked in receive and wait to acquire
2640 * a lock against other simultaneous readers before clearing the
2641 * socket buffer. Don't let our acquire be interrupted by a signal
2642 * despite any existing socket disposition on interruptable waiting.
2645 (void) sblock(sb, SBL_WAIT | SBL_NOINTR);
2648 * Invalidate/clear most of the sockbuf structure, but leave selinfo
2649 * and mutex data unchanged.
2652 bzero(&aso, sizeof(aso));
2653 aso.so_pcb = so->so_pcb;
2654 bcopy(&sb->sb_startzero, &aso.so_rcv.sb_startzero,
2655 sizeof(*sb) - offsetof(struct sockbuf, sb_startzero));
2656 bzero(&sb->sb_startzero,
2657 sizeof(*sb) - offsetof(struct sockbuf, sb_startzero));
2662 * Dispose of special rights and flush the copied socket. Don't call
2663 * any unsafe routines (that rely on locks being initialized) on aso.
2665 if (pr->pr_flags & PR_RIGHTS && pr->pr_domain->dom_dispose != NULL)
2666 (*pr->pr_domain->dom_dispose)(&aso);
2667 sbrelease_internal(&aso.so_rcv, so);
2671 * Wrapper for Socket established helper hook.
2672 * Parameters: socket, context of the hook point, hook id.
2675 hhook_run_socket(struct socket *so, void *hctx, int32_t h_id)
2677 struct socket_hhook_data hhook_data = {
2684 CURVNET_SET(so->so_vnet);
2685 HHOOKS_RUN_IF(V_socket_hhh[h_id], &hhook_data, &so->osd);
2688 /* Ugly but needed, since hhooks return void for now */
2689 return (hhook_data.status);
2693 * Perhaps this routine, and sooptcopyout(), below, ought to come in an
2694 * additional variant to handle the case where the option value needs to be
2695 * some kind of integer, but not a specific size. In addition to their use
2696 * here, these functions are also called by the protocol-level pr_ctloutput()
2700 sooptcopyin(struct sockopt *sopt, void *buf, size_t len, size_t minlen)
2705 * If the user gives us more than we wanted, we ignore it, but if we
2706 * don't get the minimum length the caller wants, we return EINVAL.
2707 * On success, sopt->sopt_valsize is set to however much we actually
2710 if ((valsize = sopt->sopt_valsize) < minlen)
2713 sopt->sopt_valsize = valsize = len;
2715 if (sopt->sopt_td != NULL)
2716 return (copyin(sopt->sopt_val, buf, valsize));
2718 bcopy(sopt->sopt_val, buf, valsize);
2723 * Kernel version of setsockopt(2).
2725 * XXX: optlen is size_t, not socklen_t
2728 so_setsockopt(struct socket *so, int level, int optname, void *optval,
2731 struct sockopt sopt;
2733 sopt.sopt_level = level;
2734 sopt.sopt_name = optname;
2735 sopt.sopt_dir = SOPT_SET;
2736 sopt.sopt_val = optval;
2737 sopt.sopt_valsize = optlen;
2738 sopt.sopt_td = NULL;
2739 return (sosetopt(so, &sopt));
2743 sosetopt(struct socket *so, struct sockopt *sopt)
2754 CURVNET_SET(so->so_vnet);
2756 if (sopt->sopt_level != SOL_SOCKET) {
2757 if (so->so_proto->pr_ctloutput != NULL) {
2758 error = (*so->so_proto->pr_ctloutput)(so, sopt);
2762 error = ENOPROTOOPT;
2764 switch (sopt->sopt_name) {
2765 case SO_ACCEPTFILTER:
2766 error = accept_filt_setopt(so, sopt);
2772 error = sooptcopyin(sopt, &l, sizeof l, sizeof l);
2777 so->so_linger = l.l_linger;
2779 so->so_options |= SO_LINGER;
2781 so->so_options &= ~SO_LINGER;
2788 case SO_USELOOPBACK:
2792 case SO_REUSEPORT_LB:
2799 error = sooptcopyin(sopt, &optval, sizeof optval,
2805 so->so_options |= sopt->sopt_name;
2807 so->so_options &= ~sopt->sopt_name;
2812 error = sooptcopyin(sopt, &optval, sizeof optval,
2817 if (optval < 0 || optval >= rt_numfibs) {
2821 if (((so->so_proto->pr_domain->dom_family == PF_INET) ||
2822 (so->so_proto->pr_domain->dom_family == PF_INET6) ||
2823 (so->so_proto->pr_domain->dom_family == PF_ROUTE)))
2824 so->so_fibnum = optval;
2829 case SO_USER_COOKIE:
2830 error = sooptcopyin(sopt, &val32, sizeof val32,
2834 so->so_user_cookie = val32;
2841 error = sooptcopyin(sopt, &optval, sizeof optval,
2847 * Values < 1 make no sense for any of these options,
2855 error = sbsetopt(so, sopt->sopt_name, optval);
2860 #ifdef COMPAT_FREEBSD32
2861 if (SV_CURPROC_FLAG(SV_ILP32)) {
2862 struct timeval32 tv32;
2864 error = sooptcopyin(sopt, &tv32, sizeof tv32,
2866 CP(tv32, tv, tv_sec);
2867 CP(tv32, tv, tv_usec);
2870 error = sooptcopyin(sopt, &tv, sizeof tv,
2874 if (tv.tv_sec < 0 || tv.tv_usec < 0 ||
2875 tv.tv_usec >= 1000000) {
2879 if (tv.tv_sec > INT32_MAX)
2883 switch (sopt->sopt_name) {
2885 so->so_snd.sb_timeo = val;
2888 so->so_rcv.sb_timeo = val;
2895 error = sooptcopyin(sopt, &extmac, sizeof extmac,
2899 error = mac_setsockopt_label(sopt->sopt_td->td_ucred,
2907 error = sooptcopyin(sopt, &optval, sizeof optval,
2911 if (optval < 0 || optval > SO_TS_CLOCK_MAX) {
2915 so->so_ts_clock = optval;
2918 case SO_MAX_PACING_RATE:
2919 error = sooptcopyin(sopt, &val32, sizeof(val32),
2923 so->so_max_pacing_rate = val32;
2927 if (V_socket_hhh[HHOOK_SOCKET_OPT]->hhh_nhooks > 0)
2928 error = hhook_run_socket(so, sopt,
2931 error = ENOPROTOOPT;
2934 if (error == 0 && so->so_proto->pr_ctloutput != NULL)
2935 (void)(*so->so_proto->pr_ctloutput)(so, sopt);
2943 * Helper routine for getsockopt.
2946 sooptcopyout(struct sockopt *sopt, const void *buf, size_t len)
2954 * Documented get behavior is that we always return a value, possibly
2955 * truncated to fit in the user's buffer. Traditional behavior is
2956 * that we always tell the user precisely how much we copied, rather
2957 * than something useful like the total amount we had available for
2958 * her. Note that this interface is not idempotent; the entire
2959 * answer must be generated ahead of time.
2961 valsize = min(len, sopt->sopt_valsize);
2962 sopt->sopt_valsize = valsize;
2963 if (sopt->sopt_val != NULL) {
2964 if (sopt->sopt_td != NULL)
2965 error = copyout(buf, sopt->sopt_val, valsize);
2967 bcopy(buf, sopt->sopt_val, valsize);
2973 sogetopt(struct socket *so, struct sockopt *sopt)
2982 CURVNET_SET(so->so_vnet);
2984 if (sopt->sopt_level != SOL_SOCKET) {
2985 if (so->so_proto->pr_ctloutput != NULL)
2986 error = (*so->so_proto->pr_ctloutput)(so, sopt);
2988 error = ENOPROTOOPT;
2992 switch (sopt->sopt_name) {
2993 case SO_ACCEPTFILTER:
2994 error = accept_filt_getopt(so, sopt);
2999 l.l_onoff = so->so_options & SO_LINGER;
3000 l.l_linger = so->so_linger;
3002 error = sooptcopyout(sopt, &l, sizeof l);
3005 case SO_USELOOPBACK:
3011 case SO_REUSEPORT_LB:
3018 optval = so->so_options & sopt->sopt_name;
3020 error = sooptcopyout(sopt, &optval, sizeof optval);
3024 optval = so->so_proto->pr_domain->dom_family;
3028 optval = so->so_type;
3032 optval = so->so_proto->pr_protocol;
3037 optval = so->so_error;
3043 optval = SOLISTENING(so) ? so->sol_sbsnd_hiwat :
3044 so->so_snd.sb_hiwat;
3048 optval = SOLISTENING(so) ? so->sol_sbrcv_hiwat :
3049 so->so_rcv.sb_hiwat;
3053 optval = SOLISTENING(so) ? so->sol_sbsnd_lowat :
3054 so->so_snd.sb_lowat;
3058 optval = SOLISTENING(so) ? so->sol_sbrcv_lowat :
3059 so->so_rcv.sb_lowat;
3064 tv = sbttotv(sopt->sopt_name == SO_SNDTIMEO ?
3065 so->so_snd.sb_timeo : so->so_rcv.sb_timeo);
3066 #ifdef COMPAT_FREEBSD32
3067 if (SV_CURPROC_FLAG(SV_ILP32)) {
3068 struct timeval32 tv32;
3070 CP(tv, tv32, tv_sec);
3071 CP(tv, tv32, tv_usec);
3072 error = sooptcopyout(sopt, &tv32, sizeof tv32);
3075 error = sooptcopyout(sopt, &tv, sizeof tv);
3080 error = sooptcopyin(sopt, &extmac, sizeof(extmac),
3084 error = mac_getsockopt_label(sopt->sopt_td->td_ucred,
3088 error = sooptcopyout(sopt, &extmac, sizeof extmac);
3096 error = sooptcopyin(sopt, &extmac, sizeof(extmac),
3100 error = mac_getsockopt_peerlabel(
3101 sopt->sopt_td->td_ucred, so, &extmac);
3104 error = sooptcopyout(sopt, &extmac, sizeof extmac);
3110 case SO_LISTENQLIMIT:
3111 optval = SOLISTENING(so) ? so->sol_qlimit : 0;
3115 optval = SOLISTENING(so) ? so->sol_qlen : 0;
3118 case SO_LISTENINCQLEN:
3119 optval = SOLISTENING(so) ? so->sol_incqlen : 0;
3123 optval = so->so_ts_clock;
3126 case SO_MAX_PACING_RATE:
3127 optval = so->so_max_pacing_rate;
3131 if (V_socket_hhh[HHOOK_SOCKET_OPT]->hhh_nhooks > 0)
3132 error = hhook_run_socket(so, sopt,
3135 error = ENOPROTOOPT;
3147 soopt_getm(struct sockopt *sopt, struct mbuf **mp)
3149 struct mbuf *m, *m_prev;
3150 int sopt_size = sopt->sopt_valsize;
3152 MGET(m, sopt->sopt_td ? M_WAITOK : M_NOWAIT, MT_DATA);
3155 if (sopt_size > MLEN) {
3156 MCLGET(m, sopt->sopt_td ? M_WAITOK : M_NOWAIT);
3157 if ((m->m_flags & M_EXT) == 0) {
3161 m->m_len = min(MCLBYTES, sopt_size);
3163 m->m_len = min(MLEN, sopt_size);
3165 sopt_size -= m->m_len;
3170 MGET(m, sopt->sopt_td ? M_WAITOK : M_NOWAIT, MT_DATA);
3175 if (sopt_size > MLEN) {
3176 MCLGET(m, sopt->sopt_td != NULL ? M_WAITOK :
3178 if ((m->m_flags & M_EXT) == 0) {
3183 m->m_len = min(MCLBYTES, sopt_size);
3185 m->m_len = min(MLEN, sopt_size);
3187 sopt_size -= m->m_len;
3195 soopt_mcopyin(struct sockopt *sopt, struct mbuf *m)
3197 struct mbuf *m0 = m;
3199 if (sopt->sopt_val == NULL)
3201 while (m != NULL && sopt->sopt_valsize >= m->m_len) {
3202 if (sopt->sopt_td != NULL) {
3205 error = copyin(sopt->sopt_val, mtod(m, char *),
3212 bcopy(sopt->sopt_val, mtod(m, char *), m->m_len);
3213 sopt->sopt_valsize -= m->m_len;
3214 sopt->sopt_val = (char *)sopt->sopt_val + m->m_len;
3217 if (m != NULL) /* should be allocated enoughly at ip6_sooptmcopyin() */
3218 panic("ip6_sooptmcopyin");
3223 soopt_mcopyout(struct sockopt *sopt, struct mbuf *m)
3225 struct mbuf *m0 = m;
3228 if (sopt->sopt_val == NULL)
3230 while (m != NULL && sopt->sopt_valsize >= m->m_len) {
3231 if (sopt->sopt_td != NULL) {
3234 error = copyout(mtod(m, char *), sopt->sopt_val,
3241 bcopy(mtod(m, char *), sopt->sopt_val, m->m_len);
3242 sopt->sopt_valsize -= m->m_len;
3243 sopt->sopt_val = (char *)sopt->sopt_val + m->m_len;
3244 valsize += m->m_len;
3248 /* enough soopt buffer should be given from user-land */
3252 sopt->sopt_valsize = valsize;
3257 * sohasoutofband(): protocol notifies socket layer of the arrival of new
3258 * out-of-band data, which will then notify socket consumers.
3261 sohasoutofband(struct socket *so)
3264 if (so->so_sigio != NULL)
3265 pgsigio(&so->so_sigio, SIGURG, 0);
3266 selwakeuppri(&so->so_rdsel, PSOCK);
3270 sopoll(struct socket *so, int events, struct ucred *active_cred,
3275 * We do not need to set or assert curvnet as long as everyone uses
3278 return (so->so_proto->pr_usrreqs->pru_sopoll(so, events, active_cred,
3283 sopoll_generic(struct socket *so, int events, struct ucred *active_cred,
3289 if (SOLISTENING(so)) {
3290 if (!(events & (POLLIN | POLLRDNORM)))
3292 else if (!TAILQ_EMPTY(&so->sol_comp))
3293 revents = events & (POLLIN | POLLRDNORM);
3294 else if ((events & POLLINIGNEOF) == 0 && so->so_error)
3295 revents = (events & (POLLIN | POLLRDNORM)) | POLLHUP;
3297 selrecord(td, &so->so_rdsel);
3302 SOCKBUF_LOCK(&so->so_snd);
3303 SOCKBUF_LOCK(&so->so_rcv);
3304 if (events & (POLLIN | POLLRDNORM))
3305 if (soreadabledata(so))
3306 revents |= events & (POLLIN | POLLRDNORM);
3307 if (events & (POLLOUT | POLLWRNORM))
3308 if (sowriteable(so))
3309 revents |= events & (POLLOUT | POLLWRNORM);
3310 if (events & (POLLPRI | POLLRDBAND))
3311 if (so->so_oobmark ||
3312 (so->so_rcv.sb_state & SBS_RCVATMARK))
3313 revents |= events & (POLLPRI | POLLRDBAND);
3314 if ((events & POLLINIGNEOF) == 0) {
3315 if (so->so_rcv.sb_state & SBS_CANTRCVMORE) {
3316 revents |= events & (POLLIN | POLLRDNORM);
3317 if (so->so_snd.sb_state & SBS_CANTSENDMORE)
3323 (POLLIN | POLLPRI | POLLRDNORM | POLLRDBAND)) {
3324 selrecord(td, &so->so_rdsel);
3325 so->so_rcv.sb_flags |= SB_SEL;
3327 if (events & (POLLOUT | POLLWRNORM)) {
3328 selrecord(td, &so->so_wrsel);
3329 so->so_snd.sb_flags |= SB_SEL;
3332 SOCKBUF_UNLOCK(&so->so_rcv);
3333 SOCKBUF_UNLOCK(&so->so_snd);
3340 soo_kqfilter(struct file *fp, struct knote *kn)
3342 struct socket *so = kn->kn_fp->f_data;
3346 switch (kn->kn_filter) {
3348 kn->kn_fop = &soread_filtops;
3349 knl = &so->so_rdsel.si_note;
3353 kn->kn_fop = &sowrite_filtops;
3354 knl = &so->so_wrsel.si_note;
3358 kn->kn_fop = &soempty_filtops;
3359 knl = &so->so_wrsel.si_note;
3367 if (SOLISTENING(so)) {
3368 knlist_add(knl, kn, 1);
3371 knlist_add(knl, kn, 1);
3372 sb->sb_flags |= SB_KNOTE;
3380 * Some routines that return EOPNOTSUPP for entry points that are not
3381 * supported by a protocol. Fill in as needed.
3384 pru_accept_notsupp(struct socket *so, struct sockaddr **nam)
3391 pru_aio_queue_notsupp(struct socket *so, struct kaiocb *job)
3398 pru_attach_notsupp(struct socket *so, int proto, struct thread *td)
3405 pru_bind_notsupp(struct socket *so, struct sockaddr *nam, struct thread *td)
3412 pru_bindat_notsupp(int fd, struct socket *so, struct sockaddr *nam,
3420 pru_connect_notsupp(struct socket *so, struct sockaddr *nam, struct thread *td)
3427 pru_connectat_notsupp(int fd, struct socket *so, struct sockaddr *nam,
3435 pru_connect2_notsupp(struct socket *so1, struct socket *so2)
3442 pru_control_notsupp(struct socket *so, u_long cmd, caddr_t data,
3443 struct ifnet *ifp, struct thread *td)
3450 pru_disconnect_notsupp(struct socket *so)
3457 pru_listen_notsupp(struct socket *so, int backlog, struct thread *td)
3464 pru_peeraddr_notsupp(struct socket *so, struct sockaddr **nam)
3471 pru_rcvd_notsupp(struct socket *so, int flags)
3478 pru_rcvoob_notsupp(struct socket *so, struct mbuf *m, int flags)
3485 pru_send_notsupp(struct socket *so, int flags, struct mbuf *m,
3486 struct sockaddr *addr, struct mbuf *control, struct thread *td)
3493 pru_ready_notsupp(struct socket *so, struct mbuf *m, int count)
3496 return (EOPNOTSUPP);
3500 * This isn't really a ``null'' operation, but it's the default one and
3501 * doesn't do anything destructive.
3504 pru_sense_null(struct socket *so, struct stat *sb)
3507 sb->st_blksize = so->so_snd.sb_hiwat;
3512 pru_shutdown_notsupp(struct socket *so)
3519 pru_sockaddr_notsupp(struct socket *so, struct sockaddr **nam)
3526 pru_sosend_notsupp(struct socket *so, struct sockaddr *addr, struct uio *uio,
3527 struct mbuf *top, struct mbuf *control, int flags, struct thread *td)
3534 pru_soreceive_notsupp(struct socket *so, struct sockaddr **paddr,
3535 struct uio *uio, struct mbuf **mp0, struct mbuf **controlp, int *flagsp)
3542 pru_sopoll_notsupp(struct socket *so, int events, struct ucred *cred,
3550 filt_sordetach(struct knote *kn)
3552 struct socket *so = kn->kn_fp->f_data;
3555 knlist_remove(&so->so_rdsel.si_note, kn, 1);
3556 if (!SOLISTENING(so) && knlist_empty(&so->so_rdsel.si_note))
3557 so->so_rcv.sb_flags &= ~SB_KNOTE;
3558 so_rdknl_unlock(so);
3563 filt_soread(struct knote *kn, long hint)
3567 so = kn->kn_fp->f_data;
3569 if (SOLISTENING(so)) {
3570 SOCK_LOCK_ASSERT(so);
3571 kn->kn_data = so->sol_qlen;
3573 kn->kn_flags |= EV_EOF;
3574 kn->kn_fflags = so->so_error;
3577 return (!TAILQ_EMPTY(&so->sol_comp));
3580 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
3582 kn->kn_data = sbavail(&so->so_rcv) - so->so_rcv.sb_ctl;
3583 if (so->so_rcv.sb_state & SBS_CANTRCVMORE) {
3584 kn->kn_flags |= EV_EOF;
3585 kn->kn_fflags = so->so_error;
3587 } else if (so->so_error) /* temporary udp error */
3590 if (kn->kn_sfflags & NOTE_LOWAT) {
3591 if (kn->kn_data >= kn->kn_sdata)
3593 } else if (sbavail(&so->so_rcv) >= so->so_rcv.sb_lowat)
3596 /* This hook returning non-zero indicates an event, not error */
3597 return (hhook_run_socket(so, NULL, HHOOK_FILT_SOREAD));
3601 filt_sowdetach(struct knote *kn)
3603 struct socket *so = kn->kn_fp->f_data;
3606 knlist_remove(&so->so_wrsel.si_note, kn, 1);
3607 if (!SOLISTENING(so) && knlist_empty(&so->so_wrsel.si_note))
3608 so->so_snd.sb_flags &= ~SB_KNOTE;
3609 so_wrknl_unlock(so);
3614 filt_sowrite(struct knote *kn, long hint)
3618 so = kn->kn_fp->f_data;
3620 if (SOLISTENING(so))
3623 SOCKBUF_LOCK_ASSERT(&so->so_snd);
3624 kn->kn_data = sbspace(&so->so_snd);
3626 hhook_run_socket(so, kn, HHOOK_FILT_SOWRITE);
3628 if (so->so_snd.sb_state & SBS_CANTSENDMORE) {
3629 kn->kn_flags |= EV_EOF;
3630 kn->kn_fflags = so->so_error;
3632 } else if (so->so_error) /* temporary udp error */
3634 else if (((so->so_state & SS_ISCONNECTED) == 0) &&
3635 (so->so_proto->pr_flags & PR_CONNREQUIRED))
3637 else if (kn->kn_sfflags & NOTE_LOWAT)
3638 return (kn->kn_data >= kn->kn_sdata);
3640 return (kn->kn_data >= so->so_snd.sb_lowat);
3644 filt_soempty(struct knote *kn, long hint)
3648 so = kn->kn_fp->f_data;
3650 if (SOLISTENING(so))
3653 SOCKBUF_LOCK_ASSERT(&so->so_snd);
3654 kn->kn_data = sbused(&so->so_snd);
3656 if (kn->kn_data == 0)
3663 socheckuid(struct socket *so, uid_t uid)
3668 if (so->so_cred->cr_uid != uid)
3674 * These functions are used by protocols to notify the socket layer (and its
3675 * consumers) of state changes in the sockets driven by protocol-side events.
3679 * Procedures to manipulate state flags of socket and do appropriate wakeups.
3681 * Normal sequence from the active (originating) side is that
3682 * soisconnecting() is called during processing of connect() call, resulting
3683 * in an eventual call to soisconnected() if/when the connection is
3684 * established. When the connection is torn down soisdisconnecting() is
3685 * called during processing of disconnect() call, and soisdisconnected() is
3686 * called when the connection to the peer is totally severed. The semantics
3687 * of these routines are such that connectionless protocols can call
3688 * soisconnected() and soisdisconnected() only, bypassing the in-progress
3689 * calls when setting up a ``connection'' takes no time.
3691 * From the passive side, a socket is created with two queues of sockets:
3692 * so_incomp for connections in progress and so_comp for connections already
3693 * made and awaiting user acceptance. As a protocol is preparing incoming
3694 * connections, it creates a socket structure queued on so_incomp by calling
3695 * sonewconn(). When the connection is established, soisconnected() is
3696 * called, and transfers the socket structure to so_comp, making it available
3699 * If a socket is closed with sockets on either so_incomp or so_comp, these
3700 * sockets are dropped.
3702 * If higher-level protocols are implemented in the kernel, the wakeups done
3703 * here will sometimes cause software-interrupt process scheduling.
3706 soisconnecting(struct socket *so)
3710 so->so_state &= ~(SS_ISCONNECTED|SS_ISDISCONNECTING);
3711 so->so_state |= SS_ISCONNECTING;
3716 soisconnected(struct socket *so)
3720 so->so_state &= ~(SS_ISCONNECTING|SS_ISDISCONNECTING|SS_ISCONFIRMING);
3721 so->so_state |= SS_ISCONNECTED;
3723 if (so->so_qstate == SQ_INCOMP) {
3724 struct socket *head = so->so_listen;
3727 KASSERT(head, ("%s: so %p on incomp of NULL", __func__, so));
3729 * Promoting a socket from incomplete queue to complete, we
3730 * need to go through reverse order of locking. We first do
3731 * trylock, and if that doesn't succeed, we go the hard way
3732 * leaving a reference and rechecking consistency after proper
3735 if (__predict_false(SOLISTEN_TRYLOCK(head) == 0)) {
3738 SOLISTEN_LOCK(head);
3740 if (__predict_false(head != so->so_listen)) {
3742 * The socket went off the listen queue,
3743 * should be lost race to close(2) of sol.
3744 * The socket is about to soabort().
3750 /* Not the last one, as so holds a ref. */
3751 refcount_release(&head->so_count);
3754 if ((so->so_options & SO_ACCEPTFILTER) == 0) {
3755 TAILQ_REMOVE(&head->sol_incomp, so, so_list);
3756 head->sol_incqlen--;
3757 TAILQ_INSERT_TAIL(&head->sol_comp, so, so_list);
3759 so->so_qstate = SQ_COMP;
3761 solisten_wakeup(head); /* unlocks */
3763 SOCKBUF_LOCK(&so->so_rcv);
3764 soupcall_set(so, SO_RCV,
3765 head->sol_accept_filter->accf_callback,
3766 head->sol_accept_filter_arg);
3767 so->so_options &= ~SO_ACCEPTFILTER;
3768 ret = head->sol_accept_filter->accf_callback(so,
3769 head->sol_accept_filter_arg, M_NOWAIT);
3770 if (ret == SU_ISCONNECTED) {
3771 soupcall_clear(so, SO_RCV);
3772 SOCKBUF_UNLOCK(&so->so_rcv);
3775 SOCKBUF_UNLOCK(&so->so_rcv);
3777 SOLISTEN_UNLOCK(head);
3782 wakeup(&so->so_timeo);
3788 soisdisconnecting(struct socket *so)
3792 so->so_state &= ~SS_ISCONNECTING;
3793 so->so_state |= SS_ISDISCONNECTING;
3795 if (!SOLISTENING(so)) {
3796 SOCKBUF_LOCK(&so->so_rcv);
3797 socantrcvmore_locked(so);
3798 SOCKBUF_LOCK(&so->so_snd);
3799 socantsendmore_locked(so);
3802 wakeup(&so->so_timeo);
3806 soisdisconnected(struct socket *so)
3810 so->so_state &= ~(SS_ISCONNECTING|SS_ISCONNECTED|SS_ISDISCONNECTING);
3811 so->so_state |= SS_ISDISCONNECTED;
3813 if (!SOLISTENING(so)) {
3815 SOCKBUF_LOCK(&so->so_rcv);
3816 socantrcvmore_locked(so);
3817 SOCKBUF_LOCK(&so->so_snd);
3818 sbdrop_locked(&so->so_snd, sbused(&so->so_snd));
3819 socantsendmore_locked(so);
3822 wakeup(&so->so_timeo);
3826 * Make a copy of a sockaddr in a malloced buffer of type M_SONAME.
3829 sodupsockaddr(const struct sockaddr *sa, int mflags)
3831 struct sockaddr *sa2;
3833 sa2 = malloc(sa->sa_len, M_SONAME, mflags);
3835 bcopy(sa, sa2, sa->sa_len);
3840 * Register per-socket destructor.
3843 sodtor_set(struct socket *so, so_dtor_t *func)
3846 SOCK_LOCK_ASSERT(so);
3851 * Register per-socket buffer upcalls.
3854 soupcall_set(struct socket *so, int which, so_upcall_t func, void *arg)
3858 KASSERT(!SOLISTENING(so), ("%s: so %p listening", __func__, so));
3868 panic("soupcall_set: bad which");
3870 SOCKBUF_LOCK_ASSERT(sb);
3871 sb->sb_upcall = func;
3872 sb->sb_upcallarg = arg;
3873 sb->sb_flags |= SB_UPCALL;
3877 soupcall_clear(struct socket *so, int which)
3881 KASSERT(!SOLISTENING(so), ("%s: so %p listening", __func__, so));
3891 panic("soupcall_clear: bad which");
3893 SOCKBUF_LOCK_ASSERT(sb);
3894 KASSERT(sb->sb_upcall != NULL,
3895 ("%s: so %p no upcall to clear", __func__, so));
3896 sb->sb_upcall = NULL;
3897 sb->sb_upcallarg = NULL;
3898 sb->sb_flags &= ~SB_UPCALL;
3902 solisten_upcall_set(struct socket *so, so_upcall_t func, void *arg)
3905 SOLISTEN_LOCK_ASSERT(so);
3906 so->sol_upcall = func;
3907 so->sol_upcallarg = arg;
3911 so_rdknl_lock(void *arg)
3913 struct socket *so = arg;
3915 if (SOLISTENING(so))
3918 SOCKBUF_LOCK(&so->so_rcv);
3922 so_rdknl_unlock(void *arg)
3924 struct socket *so = arg;
3926 if (SOLISTENING(so))
3929 SOCKBUF_UNLOCK(&so->so_rcv);
3933 so_rdknl_assert_locked(void *arg)
3935 struct socket *so = arg;
3937 if (SOLISTENING(so))
3938 SOCK_LOCK_ASSERT(so);
3940 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
3944 so_rdknl_assert_unlocked(void *arg)
3946 struct socket *so = arg;
3948 if (SOLISTENING(so))
3949 SOCK_UNLOCK_ASSERT(so);
3951 SOCKBUF_UNLOCK_ASSERT(&so->so_rcv);
3955 so_wrknl_lock(void *arg)
3957 struct socket *so = arg;
3959 if (SOLISTENING(so))
3962 SOCKBUF_LOCK(&so->so_snd);
3966 so_wrknl_unlock(void *arg)
3968 struct socket *so = arg;
3970 if (SOLISTENING(so))
3973 SOCKBUF_UNLOCK(&so->so_snd);
3977 so_wrknl_assert_locked(void *arg)
3979 struct socket *so = arg;
3981 if (SOLISTENING(so))
3982 SOCK_LOCK_ASSERT(so);
3984 SOCKBUF_LOCK_ASSERT(&so->so_snd);
3988 so_wrknl_assert_unlocked(void *arg)
3990 struct socket *so = arg;
3992 if (SOLISTENING(so))
3993 SOCK_UNLOCK_ASSERT(so);
3995 SOCKBUF_UNLOCK_ASSERT(&so->so_snd);
3999 * Create an external-format (``xsocket'') structure using the information in
4000 * the kernel-format socket structure pointed to by so. This is done to
4001 * reduce the spew of irrelevant information over this interface, to isolate
4002 * user code from changes in the kernel structure, and potentially to provide
4003 * information-hiding if we decide that some of this information should be
4004 * hidden from users.
4007 sotoxsocket(struct socket *so, struct xsocket *xso)
4010 xso->xso_len = sizeof *xso;
4011 xso->xso_so = (uintptr_t)so;
4012 xso->so_type = so->so_type;
4013 xso->so_options = so->so_options;
4014 xso->so_linger = so->so_linger;
4015 xso->so_state = so->so_state;
4016 xso->so_pcb = (uintptr_t)so->so_pcb;
4017 xso->xso_protocol = so->so_proto->pr_protocol;
4018 xso->xso_family = so->so_proto->pr_domain->dom_family;
4019 xso->so_timeo = so->so_timeo;
4020 xso->so_error = so->so_error;
4021 xso->so_uid = so->so_cred->cr_uid;
4022 xso->so_pgid = so->so_sigio ? so->so_sigio->sio_pgid : 0;
4023 if (SOLISTENING(so)) {
4024 xso->so_qlen = so->sol_qlen;
4025 xso->so_incqlen = so->sol_incqlen;
4026 xso->so_qlimit = so->sol_qlimit;
4027 xso->so_oobmark = 0;
4028 bzero(&xso->so_snd, sizeof(xso->so_snd));
4029 bzero(&xso->so_rcv, sizeof(xso->so_rcv));
4031 xso->so_state |= so->so_qstate;
4032 xso->so_qlen = xso->so_incqlen = xso->so_qlimit = 0;
4033 xso->so_oobmark = so->so_oobmark;
4034 sbtoxsockbuf(&so->so_snd, &xso->so_snd);
4035 sbtoxsockbuf(&so->so_rcv, &xso->so_rcv);
4040 so_sockbuf_rcv(struct socket *so)
4043 return (&so->so_rcv);
4047 so_sockbuf_snd(struct socket *so)
4050 return (&so->so_snd);
4054 so_state_get(const struct socket *so)
4057 return (so->so_state);
4061 so_state_set(struct socket *so, int val)
4068 so_options_get(const struct socket *so)
4071 return (so->so_options);
4075 so_options_set(struct socket *so, int val)
4078 so->so_options = val;
4082 so_error_get(const struct socket *so)
4085 return (so->so_error);
4089 so_error_set(struct socket *so, int val)
4096 so_linger_get(const struct socket *so)
4099 return (so->so_linger);
4103 so_linger_set(struct socket *so, int val)
4106 so->so_linger = val;
4110 so_protosw_get(const struct socket *so)
4113 return (so->so_proto);
4117 so_protosw_set(struct socket *so, struct protosw *val)
4124 so_sorwakeup(struct socket *so)
4131 so_sowwakeup(struct socket *so)
4138 so_sorwakeup_locked(struct socket *so)
4141 sorwakeup_locked(so);
4145 so_sowwakeup_locked(struct socket *so)
4148 sowwakeup_locked(so);
4152 so_lock(struct socket *so)
4159 so_unlock(struct socket *so)