]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/kern/uipc_socket.c
Revert "vnode read(2)/write(2): acquire rangelock regardless of do_vn_io_fault()"
[FreeBSD/FreeBSD.git] / sys / kern / uipc_socket.c
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
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
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
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.
21  *
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
32  * SUCH DAMAGE.
33  *
34  *      @(#)uipc_socket.c       8.3 (Berkeley) 4/15/94
35  */
36
37 /*
38  * Comments on the socket life cycle:
39  *
40  * soalloc() sets of socket layer state for a socket, called only by
41  * socreate() and sonewconn().  Socket layer private.
42  *
43  * sodealloc() tears down socket layer state for a socket, called only by
44  * sofree() and sonewconn().  Socket layer private.
45  *
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.
49  *
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.
54  *
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
59  * case.
60  *
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
63  * sockets.
64  *
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
68  * listen socket.
69  *
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.
73  *
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.
84  *
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
88  * interface.
89  *
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.
97  *
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.
103  */
104
105 #include <sys/cdefs.h>
106 __FBSDID("$FreeBSD$");
107
108 #include "opt_inet.h"
109 #include "opt_inet6.h"
110 #include "opt_kern_tls.h"
111 #include "opt_sctp.h"
112
113 #include <sys/param.h>
114 #include <sys/systm.h>
115 #include <sys/fcntl.h>
116 #include <sys/limits.h>
117 #include <sys/lock.h>
118 #include <sys/mac.h>
119 #include <sys/malloc.h>
120 #include <sys/mbuf.h>
121 #include <sys/mutex.h>
122 #include <sys/domain.h>
123 #include <sys/file.h>                   /* for struct knote */
124 #include <sys/hhook.h>
125 #include <sys/kernel.h>
126 #include <sys/khelp.h>
127 #include <sys/ktls.h>
128 #include <sys/event.h>
129 #include <sys/eventhandler.h>
130 #include <sys/poll.h>
131 #include <sys/priv.h>
132 #include <sys/proc.h>
133 #include <sys/protosw.h>
134 #include <sys/sbuf.h>
135 #include <sys/socket.h>
136 #include <sys/socketvar.h>
137 #include <sys/resourcevar.h>
138 #include <net/route.h>
139 #include <sys/signalvar.h>
140 #include <sys/stat.h>
141 #include <sys/sx.h>
142 #include <sys/sysctl.h>
143 #include <sys/taskqueue.h>
144 #include <sys/uio.h>
145 #include <sys/un.h>
146 #include <sys/unpcb.h>
147 #include <sys/jail.h>
148 #include <sys/syslog.h>
149 #include <netinet/in.h>
150 #include <netinet/in_pcb.h>
151 #include <netinet/tcp.h>
152
153 #include <net/vnet.h>
154
155 #include <security/mac/mac_framework.h>
156
157 #include <vm/uma.h>
158
159 #ifdef COMPAT_FREEBSD32
160 #include <sys/mount.h>
161 #include <sys/sysent.h>
162 #include <compat/freebsd32/freebsd32.h>
163 #endif
164
165 static int      soreceive_rcvoob(struct socket *so, struct uio *uio,
166                     int flags);
167 static void     so_rdknl_lock(void *);
168 static void     so_rdknl_unlock(void *);
169 static void     so_rdknl_assert_lock(void *, int);
170 static void     so_wrknl_lock(void *);
171 static void     so_wrknl_unlock(void *);
172 static void     so_wrknl_assert_lock(void *, int);
173
174 static void     filt_sordetach(struct knote *kn);
175 static int      filt_soread(struct knote *kn, long hint);
176 static void     filt_sowdetach(struct knote *kn);
177 static int      filt_sowrite(struct knote *kn, long hint);
178 static int      filt_soempty(struct knote *kn, long hint);
179 static int inline hhook_run_socket(struct socket *so, void *hctx, int32_t h_id);
180 fo_kqfilter_t   soo_kqfilter;
181
182 static struct filterops soread_filtops = {
183         .f_isfd = 1,
184         .f_detach = filt_sordetach,
185         .f_event = filt_soread,
186 };
187 static struct filterops sowrite_filtops = {
188         .f_isfd = 1,
189         .f_detach = filt_sowdetach,
190         .f_event = filt_sowrite,
191 };
192 static struct filterops soempty_filtops = {
193         .f_isfd = 1,
194         .f_detach = filt_sowdetach,
195         .f_event = filt_soempty,
196 };
197
198 so_gen_t        so_gencnt;      /* generation count for sockets */
199
200 MALLOC_DEFINE(M_SONAME, "soname", "socket name");
201 MALLOC_DEFINE(M_PCB, "pcb", "protocol control block");
202
203 #define VNET_SO_ASSERT(so)                                              \
204         VNET_ASSERT(curvnet != NULL,                                    \
205             ("%s:%d curvnet is NULL, so=%p", __func__, __LINE__, (so)));
206
207 VNET_DEFINE(struct hhook_head *, socket_hhh[HHOOK_SOCKET_LAST + 1]);
208 #define V_socket_hhh            VNET(socket_hhh)
209
210 /*
211  * Limit on the number of connections in the listen queue waiting
212  * for accept(2).
213  * NB: The original sysctl somaxconn is still available but hidden
214  * to prevent confusion about the actual purpose of this number.
215  */
216 static u_int somaxconn = SOMAXCONN;
217
218 static int
219 sysctl_somaxconn(SYSCTL_HANDLER_ARGS)
220 {
221         int error;
222         int val;
223
224         val = somaxconn;
225         error = sysctl_handle_int(oidp, &val, 0, req);
226         if (error || !req->newptr )
227                 return (error);
228
229         /*
230          * The purpose of the UINT_MAX / 3 limit, is so that the formula
231          *   3 * so_qlimit / 2
232          * below, will not overflow.
233          */
234
235         if (val < 1 || val > UINT_MAX / 3)
236                 return (EINVAL);
237
238         somaxconn = val;
239         return (0);
240 }
241 SYSCTL_PROC(_kern_ipc, OID_AUTO, soacceptqueue,
242     CTLTYPE_UINT | CTLFLAG_RW | CTLFLAG_MPSAFE, 0, sizeof(int),
243     sysctl_somaxconn, "I",
244     "Maximum listen socket pending connection accept queue size");
245 SYSCTL_PROC(_kern_ipc, KIPC_SOMAXCONN, somaxconn,
246     CTLTYPE_UINT | CTLFLAG_RW | CTLFLAG_SKIP | CTLFLAG_MPSAFE, 0,
247     sizeof(int), sysctl_somaxconn, "I",
248     "Maximum listen socket pending connection accept queue size (compat)");
249
250 static int numopensockets;
251 SYSCTL_INT(_kern_ipc, OID_AUTO, numopensockets, CTLFLAG_RD,
252     &numopensockets, 0, "Number of open sockets");
253
254 /*
255  * accept_mtx locks down per-socket fields relating to accept queues.  See
256  * socketvar.h for an annotation of the protected fields of struct socket.
257  */
258 struct mtx accept_mtx;
259 MTX_SYSINIT(accept_mtx, &accept_mtx, "accept", MTX_DEF);
260
261 /*
262  * so_global_mtx protects so_gencnt, numopensockets, and the per-socket
263  * so_gencnt field.
264  */
265 static struct mtx so_global_mtx;
266 MTX_SYSINIT(so_global_mtx, &so_global_mtx, "so_glabel", MTX_DEF);
267
268 /*
269  * General IPC sysctl name space, used by sockets and a variety of other IPC
270  * types.
271  */
272 SYSCTL_NODE(_kern, KERN_IPC, ipc, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
273     "IPC");
274
275 /*
276  * Initialize the socket subsystem and set up the socket
277  * memory allocator.
278  */
279 static uma_zone_t socket_zone;
280 int     maxsockets;
281
282 static void
283 socket_zone_change(void *tag)
284 {
285
286         maxsockets = uma_zone_set_max(socket_zone, maxsockets);
287 }
288
289 static void
290 socket_hhook_register(int subtype)
291 {
292
293         if (hhook_head_register(HHOOK_TYPE_SOCKET, subtype,
294             &V_socket_hhh[subtype],
295             HHOOK_NOWAIT|HHOOK_HEADISINVNET) != 0)
296                 printf("%s: WARNING: unable to register hook\n", __func__);
297 }
298
299 static void
300 socket_hhook_deregister(int subtype)
301 {
302
303         if (hhook_head_deregister(V_socket_hhh[subtype]) != 0)
304                 printf("%s: WARNING: unable to deregister hook\n", __func__);
305 }
306
307 static void
308 socket_init(void *tag)
309 {
310
311         socket_zone = uma_zcreate("socket", sizeof(struct socket), NULL, NULL,
312             NULL, NULL, UMA_ALIGN_PTR, UMA_ZONE_NOFREE);
313         maxsockets = uma_zone_set_max(socket_zone, maxsockets);
314         uma_zone_set_warning(socket_zone, "kern.ipc.maxsockets limit reached");
315         EVENTHANDLER_REGISTER(maxsockets_change, socket_zone_change, NULL,
316             EVENTHANDLER_PRI_FIRST);
317 }
318 SYSINIT(socket, SI_SUB_PROTO_DOMAININIT, SI_ORDER_ANY, socket_init, NULL);
319
320 static void
321 socket_vnet_init(const void *unused __unused)
322 {
323         int i;
324
325         /* We expect a contiguous range */
326         for (i = 0; i <= HHOOK_SOCKET_LAST; i++)
327                 socket_hhook_register(i);
328 }
329 VNET_SYSINIT(socket_vnet_init, SI_SUB_PROTO_DOMAININIT, SI_ORDER_ANY,
330     socket_vnet_init, NULL);
331
332 static void
333 socket_vnet_uninit(const void *unused __unused)
334 {
335         int i;
336
337         for (i = 0; i <= HHOOK_SOCKET_LAST; i++)
338                 socket_hhook_deregister(i);
339 }
340 VNET_SYSUNINIT(socket_vnet_uninit, SI_SUB_PROTO_DOMAININIT, SI_ORDER_ANY,
341     socket_vnet_uninit, NULL);
342
343 /*
344  * Initialise maxsockets.  This SYSINIT must be run after
345  * tunable_mbinit().
346  */
347 static void
348 init_maxsockets(void *ignored)
349 {
350
351         TUNABLE_INT_FETCH("kern.ipc.maxsockets", &maxsockets);
352         maxsockets = imax(maxsockets, maxfiles);
353 }
354 SYSINIT(param, SI_SUB_TUNABLES, SI_ORDER_ANY, init_maxsockets, NULL);
355
356 /*
357  * Sysctl to get and set the maximum global sockets limit.  Notify protocols
358  * of the change so that they can update their dependent limits as required.
359  */
360 static int
361 sysctl_maxsockets(SYSCTL_HANDLER_ARGS)
362 {
363         int error, newmaxsockets;
364
365         newmaxsockets = maxsockets;
366         error = sysctl_handle_int(oidp, &newmaxsockets, 0, req);
367         if (error == 0 && req->newptr && newmaxsockets != maxsockets) {
368                 if (newmaxsockets > maxsockets &&
369                     newmaxsockets <= maxfiles) {
370                         maxsockets = newmaxsockets;
371                         EVENTHANDLER_INVOKE(maxsockets_change);
372                 } else
373                         error = EINVAL;
374         }
375         return (error);
376 }
377 SYSCTL_PROC(_kern_ipc, OID_AUTO, maxsockets,
378     CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_MPSAFE, &maxsockets, 0,
379     sysctl_maxsockets, "IU",
380     "Maximum number of sockets available");
381
382 /*
383  * Socket operation routines.  These routines are called by the routines in
384  * sys_socket.c or from a system process, and implement the semantics of
385  * socket operations by switching out to the protocol specific routines.
386  */
387
388 /*
389  * Get a socket structure from our zone, and initialize it.  Note that it
390  * would probably be better to allocate socket and PCB at the same time, but
391  * I'm not convinced that all the protocols can be easily modified to do
392  * this.
393  *
394  * soalloc() returns a socket with a ref count of 0.
395  */
396 static struct socket *
397 soalloc(struct vnet *vnet)
398 {
399         struct socket *so;
400
401         so = uma_zalloc(socket_zone, M_NOWAIT | M_ZERO);
402         if (so == NULL)
403                 return (NULL);
404 #ifdef MAC
405         if (mac_socket_init(so, M_NOWAIT) != 0) {
406                 uma_zfree(socket_zone, so);
407                 return (NULL);
408         }
409 #endif
410         if (khelp_init_osd(HELPER_CLASS_SOCKET, &so->osd)) {
411                 uma_zfree(socket_zone, so);
412                 return (NULL);
413         }
414
415         /*
416          * The socket locking protocol allows to lock 2 sockets at a time,
417          * however, the first one must be a listening socket.  WITNESS lacks
418          * a feature to change class of an existing lock, so we use DUPOK.
419          */
420         mtx_init(&so->so_lock, "socket", NULL, MTX_DEF | MTX_DUPOK);
421         SOCKBUF_LOCK_INIT(&so->so_snd, "so_snd");
422         SOCKBUF_LOCK_INIT(&so->so_rcv, "so_rcv");
423         so->so_rcv.sb_sel = &so->so_rdsel;
424         so->so_snd.sb_sel = &so->so_wrsel;
425         sx_init(&so->so_snd.sb_sx, "so_snd_sx");
426         sx_init(&so->so_rcv.sb_sx, "so_rcv_sx");
427         TAILQ_INIT(&so->so_snd.sb_aiojobq);
428         TAILQ_INIT(&so->so_rcv.sb_aiojobq);
429         TASK_INIT(&so->so_snd.sb_aiotask, 0, soaio_snd, so);
430         TASK_INIT(&so->so_rcv.sb_aiotask, 0, soaio_rcv, so);
431 #ifdef VIMAGE
432         VNET_ASSERT(vnet != NULL, ("%s:%d vnet is NULL, so=%p",
433             __func__, __LINE__, so));
434         so->so_vnet = vnet;
435 #endif
436         /* We shouldn't need the so_global_mtx */
437         if (hhook_run_socket(so, NULL, HHOOK_SOCKET_CREATE)) {
438                 /* Do we need more comprehensive error returns? */
439                 uma_zfree(socket_zone, so);
440                 return (NULL);
441         }
442         mtx_lock(&so_global_mtx);
443         so->so_gencnt = ++so_gencnt;
444         ++numopensockets;
445 #ifdef VIMAGE
446         vnet->vnet_sockcnt++;
447 #endif
448         mtx_unlock(&so_global_mtx);
449
450         return (so);
451 }
452
453 /*
454  * Free the storage associated with a socket at the socket layer, tear down
455  * locks, labels, etc.  All protocol state is assumed already to have been
456  * torn down (and possibly never set up) by the caller.
457  */
458 static void
459 sodealloc(struct socket *so)
460 {
461
462         KASSERT(so->so_count == 0, ("sodealloc(): so_count %d", so->so_count));
463         KASSERT(so->so_pcb == NULL, ("sodealloc(): so_pcb != NULL"));
464
465         mtx_lock(&so_global_mtx);
466         so->so_gencnt = ++so_gencnt;
467         --numopensockets;       /* Could be below, but faster here. */
468 #ifdef VIMAGE
469         VNET_ASSERT(so->so_vnet != NULL, ("%s:%d so_vnet is NULL, so=%p",
470             __func__, __LINE__, so));
471         so->so_vnet->vnet_sockcnt--;
472 #endif
473         mtx_unlock(&so_global_mtx);
474 #ifdef MAC
475         mac_socket_destroy(so);
476 #endif
477         hhook_run_socket(so, NULL, HHOOK_SOCKET_CLOSE);
478
479         khelp_destroy_osd(&so->osd);
480         if (SOLISTENING(so)) {
481                 if (so->sol_accept_filter != NULL)
482                         accept_filt_setopt(so, NULL);
483         } else {
484                 if (so->so_rcv.sb_hiwat)
485                         (void)chgsbsize(so->so_cred->cr_uidinfo,
486                             &so->so_rcv.sb_hiwat, 0, RLIM_INFINITY);
487                 if (so->so_snd.sb_hiwat)
488                         (void)chgsbsize(so->so_cred->cr_uidinfo,
489                             &so->so_snd.sb_hiwat, 0, RLIM_INFINITY);
490                 sx_destroy(&so->so_snd.sb_sx);
491                 sx_destroy(&so->so_rcv.sb_sx);
492                 SOCKBUF_LOCK_DESTROY(&so->so_snd);
493                 SOCKBUF_LOCK_DESTROY(&so->so_rcv);
494         }
495         crfree(so->so_cred);
496         mtx_destroy(&so->so_lock);
497         uma_zfree(socket_zone, so);
498 }
499
500 /*
501  * socreate returns a socket with a ref count of 1.  The socket should be
502  * closed with soclose().
503  */
504 int
505 socreate(int dom, struct socket **aso, int type, int proto,
506     struct ucred *cred, struct thread *td)
507 {
508         struct protosw *prp;
509         struct socket *so;
510         int error;
511
512         if (proto)
513                 prp = pffindproto(dom, proto, type);
514         else
515                 prp = pffindtype(dom, type);
516
517         if (prp == NULL) {
518                 /* No support for domain. */
519                 if (pffinddomain(dom) == NULL)
520                         return (EAFNOSUPPORT);
521                 /* No support for socket type. */
522                 if (proto == 0 && type != 0)
523                         return (EPROTOTYPE);
524                 return (EPROTONOSUPPORT);
525         }
526         if (prp->pr_usrreqs->pru_attach == NULL ||
527             prp->pr_usrreqs->pru_attach == pru_attach_notsupp)
528                 return (EPROTONOSUPPORT);
529
530         if (prison_check_af(cred, prp->pr_domain->dom_family) != 0)
531                 return (EPROTONOSUPPORT);
532
533         if (prp->pr_type != type)
534                 return (EPROTOTYPE);
535         so = soalloc(CRED_TO_VNET(cred));
536         if (so == NULL)
537                 return (ENOBUFS);
538
539         so->so_type = type;
540         so->so_cred = crhold(cred);
541         if ((prp->pr_domain->dom_family == PF_INET) ||
542             (prp->pr_domain->dom_family == PF_INET6) ||
543             (prp->pr_domain->dom_family == PF_ROUTE))
544                 so->so_fibnum = td->td_proc->p_fibnum;
545         else
546                 so->so_fibnum = 0;
547         so->so_proto = prp;
548 #ifdef MAC
549         mac_socket_create(cred, so);
550 #endif
551         knlist_init(&so->so_rdsel.si_note, so, so_rdknl_lock, so_rdknl_unlock,
552             so_rdknl_assert_lock);
553         knlist_init(&so->so_wrsel.si_note, so, so_wrknl_lock, so_wrknl_unlock,
554             so_wrknl_assert_lock);
555         /*
556          * Auto-sizing of socket buffers is managed by the protocols and
557          * the appropriate flags must be set in the pru_attach function.
558          */
559         CURVNET_SET(so->so_vnet);
560         error = (*prp->pr_usrreqs->pru_attach)(so, proto, td);
561         CURVNET_RESTORE();
562         if (error) {
563                 sodealloc(so);
564                 return (error);
565         }
566         soref(so);
567         *aso = so;
568         return (0);
569 }
570
571 #ifdef REGRESSION
572 static int regression_sonewconn_earlytest = 1;
573 SYSCTL_INT(_regression, OID_AUTO, sonewconn_earlytest, CTLFLAG_RW,
574     &regression_sonewconn_earlytest, 0, "Perform early sonewconn limit test");
575 #endif
576
577 static int sooverprio = LOG_DEBUG;
578 SYSCTL_INT(_kern_ipc, OID_AUTO, sooverprio, CTLFLAG_RW,
579     &sooverprio, 0, "Log priority for listen socket overflows: 0..7 or -1 to disable");
580
581 static struct timeval overinterval = { 60, 0 };
582 SYSCTL_TIMEVAL_SEC(_kern_ipc, OID_AUTO, sooverinterval, CTLFLAG_RW,
583     &overinterval,
584     "Delay in seconds between warnings for listen socket overflows");
585
586 /*
587  * When an attempt at a new connection is noted on a socket which accepts
588  * connections, sonewconn is called.  If the connection is possible (subject
589  * to space constraints, etc.) then we allocate a new structure, properly
590  * linked into the data structure of the original socket, and return this.
591  * Connstatus may be 0, or SS_ISCONFIRMING, or SS_ISCONNECTED.
592  *
593  * Note: the ref count on the socket is 0 on return.
594  */
595 struct socket *
596 sonewconn(struct socket *head, int connstatus)
597 {
598         struct sbuf descrsb;
599         struct socket *so;
600         int len, overcount;
601         u_int qlen;
602         const char localprefix[] = "local:";
603         char descrbuf[SUNPATHLEN + sizeof(localprefix)];
604 #if defined(INET6)
605         char addrbuf[INET6_ADDRSTRLEN];
606 #elif defined(INET)
607         char addrbuf[INET_ADDRSTRLEN];
608 #endif
609         bool dolog, over;
610
611         SOLISTEN_LOCK(head);
612         over = (head->sol_qlen > 3 * head->sol_qlimit / 2);
613 #ifdef REGRESSION
614         if (regression_sonewconn_earlytest && over) {
615 #else
616         if (over) {
617 #endif
618                 head->sol_overcount++;
619                 dolog = (sooverprio >= 0) &&
620                         !!ratecheck(&head->sol_lastover, &overinterval);
621
622                 /*
623                  * If we're going to log, copy the overflow count and queue
624                  * length from the listen socket before dropping the lock.
625                  * Also, reset the overflow count.
626                  */
627                 if (dolog) {
628                         overcount = head->sol_overcount;
629                         head->sol_overcount = 0;
630                         qlen = head->sol_qlen;
631                 }
632                 SOLISTEN_UNLOCK(head);
633
634                 if (dolog) {
635                         /*
636                          * Try to print something descriptive about the
637                          * socket for the error message.
638                          */
639                         sbuf_new(&descrsb, descrbuf, sizeof(descrbuf),
640                             SBUF_FIXEDLEN);
641                         switch (head->so_proto->pr_domain->dom_family) {
642 #if defined(INET) || defined(INET6)
643 #ifdef INET
644                         case AF_INET:
645 #endif
646 #ifdef INET6
647                         case AF_INET6:
648                                 if (head->so_proto->pr_domain->dom_family ==
649                                     AF_INET6 ||
650                                     (sotoinpcb(head)->inp_inc.inc_flags &
651                                     INC_ISIPV6)) {
652                                         ip6_sprintf(addrbuf,
653                                             &sotoinpcb(head)->inp_inc.inc6_laddr);
654                                         sbuf_printf(&descrsb, "[%s]", addrbuf);
655                                 } else
656 #endif
657                                 {
658 #ifdef INET
659                                         inet_ntoa_r(
660                                             sotoinpcb(head)->inp_inc.inc_laddr,
661                                             addrbuf);
662                                         sbuf_cat(&descrsb, addrbuf);
663 #endif
664                                 }
665                                 sbuf_printf(&descrsb, ":%hu (proto %u)",
666                                     ntohs(sotoinpcb(head)->inp_inc.inc_lport),
667                                     head->so_proto->pr_protocol);
668                                 break;
669 #endif /* INET || INET6 */
670                         case AF_UNIX:
671                                 sbuf_cat(&descrsb, localprefix);
672                                 if (sotounpcb(head)->unp_addr != NULL)
673                                         len =
674                                             sotounpcb(head)->unp_addr->sun_len -
675                                             offsetof(struct sockaddr_un,
676                                             sun_path);
677                                 else
678                                         len = 0;
679                                 if (len > 0)
680                                         sbuf_bcat(&descrsb,
681                                             sotounpcb(head)->unp_addr->sun_path,
682                                             len);
683                                 else
684                                         sbuf_cat(&descrsb, "(unknown)");
685                                 break;
686                         }
687
688                         /*
689                          * If we can't print something more specific, at least
690                          * print the domain name.
691                          */
692                         if (sbuf_finish(&descrsb) != 0 ||
693                             sbuf_len(&descrsb) <= 0) {
694                                 sbuf_clear(&descrsb);
695                                 sbuf_cat(&descrsb,
696                                     head->so_proto->pr_domain->dom_name ?:
697                                     "unknown");
698                                 sbuf_finish(&descrsb);
699                         }
700                         KASSERT(sbuf_len(&descrsb) > 0,
701                             ("%s: sbuf creation failed", __func__));
702                         log(LOG_PRI(sooverprio),
703                             "%s: pcb %p (%s): Listen queue overflow: "
704                             "%i already in queue awaiting acceptance "
705                             "(%d occurrences)\n",
706                             __func__, head->so_pcb, sbuf_data(&descrsb),
707                             qlen, overcount);
708                         sbuf_delete(&descrsb);
709
710                         overcount = 0;
711                 }
712
713                 return (NULL);
714         }
715         SOLISTEN_UNLOCK(head);
716         VNET_ASSERT(head->so_vnet != NULL, ("%s: so %p vnet is NULL",
717             __func__, head));
718         so = soalloc(head->so_vnet);
719         if (so == NULL) {
720                 log(LOG_DEBUG, "%s: pcb %p: New socket allocation failure: "
721                     "limit reached or out of memory\n",
722                     __func__, head->so_pcb);
723                 return (NULL);
724         }
725         so->so_listen = head;
726         so->so_type = head->so_type;
727         so->so_options = head->so_options & ~SO_ACCEPTCONN;
728         so->so_linger = head->so_linger;
729         so->so_state = head->so_state | SS_NOFDREF;
730         so->so_fibnum = head->so_fibnum;
731         so->so_proto = head->so_proto;
732         so->so_cred = crhold(head->so_cred);
733 #ifdef MAC
734         mac_socket_newconn(head, so);
735 #endif
736         knlist_init(&so->so_rdsel.si_note, so, so_rdknl_lock, so_rdknl_unlock,
737             so_rdknl_assert_lock);
738         knlist_init(&so->so_wrsel.si_note, so, so_wrknl_lock, so_wrknl_unlock,
739             so_wrknl_assert_lock);
740         VNET_SO_ASSERT(head);
741         if (soreserve(so, head->sol_sbsnd_hiwat, head->sol_sbrcv_hiwat)) {
742                 sodealloc(so);
743                 log(LOG_DEBUG, "%s: pcb %p: soreserve() failed\n",
744                     __func__, head->so_pcb);
745                 return (NULL);
746         }
747         if ((*so->so_proto->pr_usrreqs->pru_attach)(so, 0, NULL)) {
748                 sodealloc(so);
749                 log(LOG_DEBUG, "%s: pcb %p: pru_attach() failed\n",
750                     __func__, head->so_pcb);
751                 return (NULL);
752         }
753         so->so_rcv.sb_lowat = head->sol_sbrcv_lowat;
754         so->so_snd.sb_lowat = head->sol_sbsnd_lowat;
755         so->so_rcv.sb_timeo = head->sol_sbrcv_timeo;
756         so->so_snd.sb_timeo = head->sol_sbsnd_timeo;
757         so->so_rcv.sb_flags |= head->sol_sbrcv_flags & SB_AUTOSIZE;
758         so->so_snd.sb_flags |= head->sol_sbsnd_flags & SB_AUTOSIZE;
759
760         SOLISTEN_LOCK(head);
761         if (head->sol_accept_filter != NULL)
762                 connstatus = 0;
763         so->so_state |= connstatus;
764         soref(head); /* A socket on (in)complete queue refs head. */
765         if (connstatus) {
766                 TAILQ_INSERT_TAIL(&head->sol_comp, so, so_list);
767                 so->so_qstate = SQ_COMP;
768                 head->sol_qlen++;
769                 solisten_wakeup(head);  /* unlocks */
770         } else {
771                 /*
772                  * Keep removing sockets from the head until there's room for
773                  * us to insert on the tail.  In pre-locking revisions, this
774                  * was a simple if(), but as we could be racing with other
775                  * threads and soabort() requires dropping locks, we must
776                  * loop waiting for the condition to be true.
777                  */
778                 while (head->sol_incqlen > head->sol_qlimit) {
779                         struct socket *sp;
780
781                         sp = TAILQ_FIRST(&head->sol_incomp);
782                         TAILQ_REMOVE(&head->sol_incomp, sp, so_list);
783                         head->sol_incqlen--;
784                         SOCK_LOCK(sp);
785                         sp->so_qstate = SQ_NONE;
786                         sp->so_listen = NULL;
787                         SOCK_UNLOCK(sp);
788                         sorele(head);   /* does SOLISTEN_UNLOCK, head stays */
789                         soabort(sp);
790                         SOLISTEN_LOCK(head);
791                 }
792                 TAILQ_INSERT_TAIL(&head->sol_incomp, so, so_list);
793                 so->so_qstate = SQ_INCOMP;
794                 head->sol_incqlen++;
795                 SOLISTEN_UNLOCK(head);
796         }
797         return (so);
798 }
799
800 #if defined(SCTP) || defined(SCTP_SUPPORT)
801 /*
802  * Socket part of sctp_peeloff().  Detach a new socket from an
803  * association.  The new socket is returned with a reference.
804  */
805 struct socket *
806 sopeeloff(struct socket *head)
807 {
808         struct socket *so;
809
810         VNET_ASSERT(head->so_vnet != NULL, ("%s:%d so_vnet is NULL, head=%p",
811             __func__, __LINE__, head));
812         so = soalloc(head->so_vnet);
813         if (so == NULL) {
814                 log(LOG_DEBUG, "%s: pcb %p: New socket allocation failure: "
815                     "limit reached or out of memory\n",
816                     __func__, head->so_pcb);
817                 return (NULL);
818         }
819         so->so_type = head->so_type;
820         so->so_options = head->so_options;
821         so->so_linger = head->so_linger;
822         so->so_state = (head->so_state & SS_NBIO) | SS_ISCONNECTED;
823         so->so_fibnum = head->so_fibnum;
824         so->so_proto = head->so_proto;
825         so->so_cred = crhold(head->so_cred);
826 #ifdef MAC
827         mac_socket_newconn(head, so);
828 #endif
829         knlist_init(&so->so_rdsel.si_note, so, so_rdknl_lock, so_rdknl_unlock,
830             so_rdknl_assert_lock);
831         knlist_init(&so->so_wrsel.si_note, so, so_wrknl_lock, so_wrknl_unlock,
832             so_wrknl_assert_lock);
833         VNET_SO_ASSERT(head);
834         if (soreserve(so, head->so_snd.sb_hiwat, head->so_rcv.sb_hiwat)) {
835                 sodealloc(so);
836                 log(LOG_DEBUG, "%s: pcb %p: soreserve() failed\n",
837                     __func__, head->so_pcb);
838                 return (NULL);
839         }
840         if ((*so->so_proto->pr_usrreqs->pru_attach)(so, 0, NULL)) {
841                 sodealloc(so);
842                 log(LOG_DEBUG, "%s: pcb %p: pru_attach() failed\n",
843                     __func__, head->so_pcb);
844                 return (NULL);
845         }
846         so->so_rcv.sb_lowat = head->so_rcv.sb_lowat;
847         so->so_snd.sb_lowat = head->so_snd.sb_lowat;
848         so->so_rcv.sb_timeo = head->so_rcv.sb_timeo;
849         so->so_snd.sb_timeo = head->so_snd.sb_timeo;
850         so->so_rcv.sb_flags |= head->so_rcv.sb_flags & SB_AUTOSIZE;
851         so->so_snd.sb_flags |= head->so_snd.sb_flags & SB_AUTOSIZE;
852
853         soref(so);
854
855         return (so);
856 }
857 #endif  /* SCTP */
858
859 int
860 sobind(struct socket *so, struct sockaddr *nam, struct thread *td)
861 {
862         int error;
863
864         CURVNET_SET(so->so_vnet);
865         error = (*so->so_proto->pr_usrreqs->pru_bind)(so, nam, td);
866         CURVNET_RESTORE();
867         return (error);
868 }
869
870 int
871 sobindat(int fd, struct socket *so, struct sockaddr *nam, struct thread *td)
872 {
873         int error;
874
875         CURVNET_SET(so->so_vnet);
876         error = (*so->so_proto->pr_usrreqs->pru_bindat)(fd, so, nam, td);
877         CURVNET_RESTORE();
878         return (error);
879 }
880
881 /*
882  * solisten() transitions a socket from a non-listening state to a listening
883  * state, but can also be used to update the listen queue depth on an
884  * existing listen socket.  The protocol will call back into the sockets
885  * layer using solisten_proto_check() and solisten_proto() to check and set
886  * socket-layer listen state.  Call backs are used so that the protocol can
887  * acquire both protocol and socket layer locks in whatever order is required
888  * by the protocol.
889  *
890  * Protocol implementors are advised to hold the socket lock across the
891  * socket-layer test and set to avoid races at the socket layer.
892  */
893 int
894 solisten(struct socket *so, int backlog, struct thread *td)
895 {
896         int error;
897
898         CURVNET_SET(so->so_vnet);
899         error = (*so->so_proto->pr_usrreqs->pru_listen)(so, backlog, td);
900         CURVNET_RESTORE();
901         return (error);
902 }
903
904 int
905 solisten_proto_check(struct socket *so)
906 {
907
908         SOCK_LOCK_ASSERT(so);
909
910         if (so->so_state & (SS_ISCONNECTED | SS_ISCONNECTING |
911             SS_ISDISCONNECTING))
912                 return (EINVAL);
913         return (0);
914 }
915
916 void
917 solisten_proto(struct socket *so, int backlog)
918 {
919         int sbrcv_lowat, sbsnd_lowat;
920         u_int sbrcv_hiwat, sbsnd_hiwat;
921         short sbrcv_flags, sbsnd_flags;
922         sbintime_t sbrcv_timeo, sbsnd_timeo;
923
924         SOCK_LOCK_ASSERT(so);
925
926         if (SOLISTENING(so))
927                 goto listening;
928
929         /*
930          * Change this socket to listening state.
931          */
932         sbrcv_lowat = so->so_rcv.sb_lowat;
933         sbsnd_lowat = so->so_snd.sb_lowat;
934         sbrcv_hiwat = so->so_rcv.sb_hiwat;
935         sbsnd_hiwat = so->so_snd.sb_hiwat;
936         sbrcv_flags = so->so_rcv.sb_flags;
937         sbsnd_flags = so->so_snd.sb_flags;
938         sbrcv_timeo = so->so_rcv.sb_timeo;
939         sbsnd_timeo = so->so_snd.sb_timeo;
940
941         sbdestroy(&so->so_snd, so);
942         sbdestroy(&so->so_rcv, so);
943         sx_destroy(&so->so_snd.sb_sx);
944         sx_destroy(&so->so_rcv.sb_sx);
945         SOCKBUF_LOCK_DESTROY(&so->so_snd);
946         SOCKBUF_LOCK_DESTROY(&so->so_rcv);
947
948 #ifdef INVARIANTS
949         bzero(&so->so_rcv,
950             sizeof(struct socket) - offsetof(struct socket, so_rcv));
951 #endif
952
953         so->sol_sbrcv_lowat = sbrcv_lowat;
954         so->sol_sbsnd_lowat = sbsnd_lowat;
955         so->sol_sbrcv_hiwat = sbrcv_hiwat;
956         so->sol_sbsnd_hiwat = sbsnd_hiwat;
957         so->sol_sbrcv_flags = sbrcv_flags;
958         so->sol_sbsnd_flags = sbsnd_flags;
959         so->sol_sbrcv_timeo = sbrcv_timeo;
960         so->sol_sbsnd_timeo = sbsnd_timeo;
961
962         so->sol_qlen = so->sol_incqlen = 0;
963         TAILQ_INIT(&so->sol_incomp);
964         TAILQ_INIT(&so->sol_comp);
965
966         so->sol_accept_filter = NULL;
967         so->sol_accept_filter_arg = NULL;
968         so->sol_accept_filter_str = NULL;
969
970         so->sol_upcall = NULL;
971         so->sol_upcallarg = NULL;
972
973         so->so_options |= SO_ACCEPTCONN;
974
975 listening:
976         if (backlog < 0 || backlog > somaxconn)
977                 backlog = somaxconn;
978         so->sol_qlimit = backlog;
979 }
980
981 /*
982  * Wakeup listeners/subsystems once we have a complete connection.
983  * Enters with lock, returns unlocked.
984  */
985 void
986 solisten_wakeup(struct socket *sol)
987 {
988
989         if (sol->sol_upcall != NULL)
990                 (void )sol->sol_upcall(sol, sol->sol_upcallarg, M_NOWAIT);
991         else {
992                 selwakeuppri(&sol->so_rdsel, PSOCK);
993                 KNOTE_LOCKED(&sol->so_rdsel.si_note, 0);
994         }
995         SOLISTEN_UNLOCK(sol);
996         wakeup_one(&sol->sol_comp);
997         if ((sol->so_state & SS_ASYNC) && sol->so_sigio != NULL)
998                 pgsigio(&sol->so_sigio, SIGIO, 0);
999 }
1000
1001 /*
1002  * Return single connection off a listening socket queue.  Main consumer of
1003  * the function is kern_accept4().  Some modules, that do their own accept
1004  * management also use the function.
1005  *
1006  * Listening socket must be locked on entry and is returned unlocked on
1007  * return.
1008  * The flags argument is set of accept4(2) flags and ACCEPT4_INHERIT.
1009  */
1010 int
1011 solisten_dequeue(struct socket *head, struct socket **ret, int flags)
1012 {
1013         struct socket *so;
1014         int error;
1015
1016         SOLISTEN_LOCK_ASSERT(head);
1017
1018         while (!(head->so_state & SS_NBIO) && TAILQ_EMPTY(&head->sol_comp) &&
1019             head->so_error == 0) {
1020                 error = msleep(&head->sol_comp, SOCK_MTX(head), PSOCK | PCATCH,
1021                     "accept", 0);
1022                 if (error != 0) {
1023                         SOLISTEN_UNLOCK(head);
1024                         return (error);
1025                 }
1026         }
1027         if (head->so_error) {
1028                 error = head->so_error;
1029                 head->so_error = 0;
1030         } else if ((head->so_state & SS_NBIO) && TAILQ_EMPTY(&head->sol_comp))
1031                 error = EWOULDBLOCK;
1032         else
1033                 error = 0;
1034         if (error) {
1035                 SOLISTEN_UNLOCK(head);
1036                 return (error);
1037         }
1038         so = TAILQ_FIRST(&head->sol_comp);
1039         SOCK_LOCK(so);
1040         KASSERT(so->so_qstate == SQ_COMP,
1041             ("%s: so %p not SQ_COMP", __func__, so));
1042         soref(so);
1043         head->sol_qlen--;
1044         so->so_qstate = SQ_NONE;
1045         so->so_listen = NULL;
1046         TAILQ_REMOVE(&head->sol_comp, so, so_list);
1047         if (flags & ACCEPT4_INHERIT)
1048                 so->so_state |= (head->so_state & SS_NBIO);
1049         else
1050                 so->so_state |= (flags & SOCK_NONBLOCK) ? SS_NBIO : 0;
1051         SOCK_UNLOCK(so);
1052         sorele(head);
1053
1054         *ret = so;
1055         return (0);
1056 }
1057
1058 /*
1059  * Evaluate the reference count and named references on a socket; if no
1060  * references remain, free it.  This should be called whenever a reference is
1061  * released, such as in sorele(), but also when named reference flags are
1062  * cleared in socket or protocol code.
1063  *
1064  * sofree() will free the socket if:
1065  *
1066  * - There are no outstanding file descriptor references or related consumers
1067  *   (so_count == 0).
1068  *
1069  * - The socket has been closed by user space, if ever open (SS_NOFDREF).
1070  *
1071  * - The protocol does not have an outstanding strong reference on the socket
1072  *   (SS_PROTOREF).
1073  *
1074  * - The socket is not in a completed connection queue, so a process has been
1075  *   notified that it is present.  If it is removed, the user process may
1076  *   block in accept() despite select() saying the socket was ready.
1077  */
1078 void
1079 sofree(struct socket *so)
1080 {
1081         struct protosw *pr = so->so_proto;
1082         bool last __diagused;
1083
1084         SOCK_LOCK_ASSERT(so);
1085
1086         if ((so->so_state & (SS_NOFDREF | SS_PROTOREF)) != SS_NOFDREF ||
1087             refcount_load(&so->so_count) != 0 || so->so_qstate == SQ_COMP) {
1088                 SOCK_UNLOCK(so);
1089                 return;
1090         }
1091
1092         if (!SOLISTENING(so) && so->so_qstate == SQ_INCOMP) {
1093                 struct socket *sol;
1094
1095                 sol = so->so_listen;
1096                 KASSERT(sol, ("%s: so %p on incomp of NULL", __func__, so));
1097
1098                 /*
1099                  * To solve race between close of a listening socket and
1100                  * a socket on its incomplete queue, we need to lock both.
1101                  * The order is first listening socket, then regular.
1102                  * Since we don't have SS_NOFDREF neither SS_PROTOREF, this
1103                  * function and the listening socket are the only pointers
1104                  * to so.  To preserve so and sol, we reference both and then
1105                  * relock.
1106                  * After relock the socket may not move to so_comp since it
1107                  * doesn't have PCB already, but it may be removed from
1108                  * so_incomp. If that happens, we share responsiblity on
1109                  * freeing the socket, but soclose() has already removed
1110                  * it from queue.
1111                  */
1112                 soref(sol);
1113                 soref(so);
1114                 SOCK_UNLOCK(so);
1115                 SOLISTEN_LOCK(sol);
1116                 SOCK_LOCK(so);
1117                 if (so->so_qstate == SQ_INCOMP) {
1118                         KASSERT(so->so_listen == sol,
1119                             ("%s: so %p migrated out of sol %p",
1120                             __func__, so, sol));
1121                         TAILQ_REMOVE(&sol->sol_incomp, so, so_list);
1122                         sol->sol_incqlen--;
1123                         last = refcount_release(&sol->so_count);
1124                         KASSERT(!last, ("%s: released last reference for %p",
1125                             __func__, sol));
1126                         so->so_qstate = SQ_NONE;
1127                         so->so_listen = NULL;
1128                 } else
1129                         KASSERT(so->so_listen == NULL,
1130                             ("%s: so %p not on (in)comp with so_listen",
1131                             __func__, so));
1132                 sorele(sol);
1133                 KASSERT(refcount_load(&so->so_count) == 1,
1134                     ("%s: so %p count %u", __func__, so, so->so_count));
1135                 so->so_count = 0;
1136         }
1137         if (SOLISTENING(so))
1138                 so->so_error = ECONNABORTED;
1139         SOCK_UNLOCK(so);
1140
1141         if (so->so_dtor != NULL)
1142                 so->so_dtor(so);
1143
1144         VNET_SO_ASSERT(so);
1145         if (pr->pr_flags & PR_RIGHTS && pr->pr_domain->dom_dispose != NULL)
1146                 (*pr->pr_domain->dom_dispose)(so);
1147         if (pr->pr_usrreqs->pru_detach != NULL)
1148                 (*pr->pr_usrreqs->pru_detach)(so);
1149
1150         /*
1151          * From this point on, we assume that no other references to this
1152          * socket exist anywhere else in the stack.  Therefore, no locks need
1153          * to be acquired or held.
1154          *
1155          * We used to do a lot of socket buffer and socket locking here, as
1156          * well as invoke sorflush() and perform wakeups.  The direct call to
1157          * dom_dispose() and sbdestroy() are an inlining of what was
1158          * necessary from sorflush().
1159          *
1160          * Notice that the socket buffer and kqueue state are torn down
1161          * before calling pru_detach.  This means that protocols shold not
1162          * assume they can perform socket wakeups, etc, in their detach code.
1163          */
1164         if (!SOLISTENING(so)) {
1165                 sbdestroy(&so->so_snd, so);
1166                 sbdestroy(&so->so_rcv, so);
1167         }
1168         seldrain(&so->so_rdsel);
1169         seldrain(&so->so_wrsel);
1170         knlist_destroy(&so->so_rdsel.si_note);
1171         knlist_destroy(&so->so_wrsel.si_note);
1172         sodealloc(so);
1173 }
1174
1175 /*
1176  * Close a socket on last file table reference removal.  Initiate disconnect
1177  * if connected.  Free socket when disconnect complete.
1178  *
1179  * This function will sorele() the socket.  Note that soclose() may be called
1180  * prior to the ref count reaching zero.  The actual socket structure will
1181  * not be freed until the ref count reaches zero.
1182  */
1183 int
1184 soclose(struct socket *so)
1185 {
1186         struct accept_queue lqueue;
1187         struct socket *sp, *tsp;
1188         int error = 0;
1189         bool last __diagused;
1190
1191         KASSERT(!(so->so_state & SS_NOFDREF), ("soclose: SS_NOFDREF on enter"));
1192
1193         CURVNET_SET(so->so_vnet);
1194         funsetown(&so->so_sigio);
1195         if (so->so_state & SS_ISCONNECTED) {
1196                 if ((so->so_state & SS_ISDISCONNECTING) == 0) {
1197                         error = sodisconnect(so);
1198                         if (error) {
1199                                 if (error == ENOTCONN)
1200                                         error = 0;
1201                                 goto drop;
1202                         }
1203                 }
1204
1205                 if ((so->so_options & SO_LINGER) != 0 && so->so_linger != 0) {
1206                         if ((so->so_state & SS_ISDISCONNECTING) &&
1207                             (so->so_state & SS_NBIO))
1208                                 goto drop;
1209                         while (so->so_state & SS_ISCONNECTED) {
1210                                 error = tsleep(&so->so_timeo,
1211                                     PSOCK | PCATCH, "soclos",
1212                                     so->so_linger * hz);
1213                                 if (error)
1214                                         break;
1215                         }
1216                 }
1217         }
1218
1219 drop:
1220         if (so->so_proto->pr_usrreqs->pru_close != NULL)
1221                 (*so->so_proto->pr_usrreqs->pru_close)(so);
1222
1223         TAILQ_INIT(&lqueue);
1224         SOCK_LOCK(so);
1225         if (SOLISTENING(so)) {
1226                 TAILQ_SWAP(&lqueue, &so->sol_incomp, socket, so_list);
1227                 TAILQ_CONCAT(&lqueue, &so->sol_comp, so_list);
1228
1229                 so->sol_qlen = so->sol_incqlen = 0;
1230
1231                 TAILQ_FOREACH(sp, &lqueue, so_list) {
1232                         SOCK_LOCK(sp);
1233                         sp->so_qstate = SQ_NONE;
1234                         sp->so_listen = NULL;
1235                         SOCK_UNLOCK(sp);
1236                         last = refcount_release(&so->so_count);
1237                         KASSERT(!last, ("%s: released last reference for %p",
1238                             __func__, so));
1239                 }
1240         }
1241         KASSERT((so->so_state & SS_NOFDREF) == 0, ("soclose: NOFDREF"));
1242         so->so_state |= SS_NOFDREF;
1243         sorele(so);
1244         TAILQ_FOREACH_SAFE(sp, &lqueue, so_list, tsp) {
1245                 SOCK_LOCK(sp);
1246                 if (refcount_load(&sp->so_count) == 0) {
1247                         SOCK_UNLOCK(sp);
1248                         soabort(sp);
1249                 } else {
1250                         /* See the handling of queued sockets in sofree(). */
1251                         SOCK_UNLOCK(sp);
1252                 }
1253         }
1254         CURVNET_RESTORE();
1255         return (error);
1256 }
1257
1258 /*
1259  * soabort() is used to abruptly tear down a connection, such as when a
1260  * resource limit is reached (listen queue depth exceeded), or if a listen
1261  * socket is closed while there are sockets waiting to be accepted.
1262  *
1263  * This interface is tricky, because it is called on an unreferenced socket,
1264  * and must be called only by a thread that has actually removed the socket
1265  * from the listen queue it was on, or races with other threads are risked.
1266  *
1267  * This interface will call into the protocol code, so must not be called
1268  * with any socket locks held.  Protocols do call it while holding their own
1269  * recursible protocol mutexes, but this is something that should be subject
1270  * to review in the future.
1271  */
1272 void
1273 soabort(struct socket *so)
1274 {
1275
1276         /*
1277          * In as much as is possible, assert that no references to this
1278          * socket are held.  This is not quite the same as asserting that the
1279          * current thread is responsible for arranging for no references, but
1280          * is as close as we can get for now.
1281          */
1282         KASSERT(so->so_count == 0, ("soabort: so_count"));
1283         KASSERT((so->so_state & SS_PROTOREF) == 0, ("soabort: SS_PROTOREF"));
1284         KASSERT(so->so_state & SS_NOFDREF, ("soabort: !SS_NOFDREF"));
1285         VNET_SO_ASSERT(so);
1286
1287         if (so->so_proto->pr_usrreqs->pru_abort != NULL)
1288                 (*so->so_proto->pr_usrreqs->pru_abort)(so);
1289         SOCK_LOCK(so);
1290         sofree(so);
1291 }
1292
1293 int
1294 soaccept(struct socket *so, struct sockaddr **nam)
1295 {
1296         int error;
1297
1298         SOCK_LOCK(so);
1299         KASSERT((so->so_state & SS_NOFDREF) != 0, ("soaccept: !NOFDREF"));
1300         so->so_state &= ~SS_NOFDREF;
1301         SOCK_UNLOCK(so);
1302
1303         CURVNET_SET(so->so_vnet);
1304         error = (*so->so_proto->pr_usrreqs->pru_accept)(so, nam);
1305         CURVNET_RESTORE();
1306         return (error);
1307 }
1308
1309 int
1310 soconnect(struct socket *so, struct sockaddr *nam, struct thread *td)
1311 {
1312
1313         return (soconnectat(AT_FDCWD, so, nam, td));
1314 }
1315
1316 int
1317 soconnectat(int fd, struct socket *so, struct sockaddr *nam, struct thread *td)
1318 {
1319         int error;
1320
1321         /* XXXMJ racy */
1322         if (SOLISTENING(so))
1323                 return (EOPNOTSUPP);
1324
1325         CURVNET_SET(so->so_vnet);
1326         /*
1327          * If protocol is connection-based, can only connect once.
1328          * Otherwise, if connected, try to disconnect first.  This allows
1329          * user to disconnect by connecting to, e.g., a null address.
1330          */
1331         if (so->so_state & (SS_ISCONNECTED|SS_ISCONNECTING) &&
1332             ((so->so_proto->pr_flags & PR_CONNREQUIRED) ||
1333             (error = sodisconnect(so)))) {
1334                 error = EISCONN;
1335         } else {
1336                 /*
1337                  * Prevent accumulated error from previous connection from
1338                  * biting us.
1339                  */
1340                 so->so_error = 0;
1341                 if (fd == AT_FDCWD) {
1342                         error = (*so->so_proto->pr_usrreqs->pru_connect)(so,
1343                             nam, td);
1344                 } else {
1345                         error = (*so->so_proto->pr_usrreqs->pru_connectat)(fd,
1346                             so, nam, td);
1347                 }
1348         }
1349         CURVNET_RESTORE();
1350
1351         return (error);
1352 }
1353
1354 int
1355 soconnect2(struct socket *so1, struct socket *so2)
1356 {
1357         int error;
1358
1359         CURVNET_SET(so1->so_vnet);
1360         error = (*so1->so_proto->pr_usrreqs->pru_connect2)(so1, so2);
1361         CURVNET_RESTORE();
1362         return (error);
1363 }
1364
1365 int
1366 sodisconnect(struct socket *so)
1367 {
1368         int error;
1369
1370         if ((so->so_state & SS_ISCONNECTED) == 0)
1371                 return (ENOTCONN);
1372         if (so->so_state & SS_ISDISCONNECTING)
1373                 return (EALREADY);
1374         VNET_SO_ASSERT(so);
1375         error = (*so->so_proto->pr_usrreqs->pru_disconnect)(so);
1376         return (error);
1377 }
1378
1379 int
1380 sosend_dgram(struct socket *so, struct sockaddr *addr, struct uio *uio,
1381     struct mbuf *top, struct mbuf *control, int flags, struct thread *td)
1382 {
1383         long space;
1384         ssize_t resid;
1385         int clen = 0, error, dontroute;
1386
1387         KASSERT(so->so_type == SOCK_DGRAM, ("sosend_dgram: !SOCK_DGRAM"));
1388         KASSERT(so->so_proto->pr_flags & PR_ATOMIC,
1389             ("sosend_dgram: !PR_ATOMIC"));
1390
1391         if (uio != NULL)
1392                 resid = uio->uio_resid;
1393         else
1394                 resid = top->m_pkthdr.len;
1395         /*
1396          * In theory resid should be unsigned.  However, space must be
1397          * signed, as it might be less than 0 if we over-committed, and we
1398          * must use a signed comparison of space and resid.  On the other
1399          * hand, a negative resid causes us to loop sending 0-length
1400          * segments to the protocol.
1401          */
1402         if (resid < 0) {
1403                 error = EINVAL;
1404                 goto out;
1405         }
1406
1407         dontroute =
1408             (flags & MSG_DONTROUTE) && (so->so_options & SO_DONTROUTE) == 0;
1409         if (td != NULL)
1410                 td->td_ru.ru_msgsnd++;
1411         if (control != NULL)
1412                 clen = control->m_len;
1413
1414         SOCKBUF_LOCK(&so->so_snd);
1415         if (so->so_snd.sb_state & SBS_CANTSENDMORE) {
1416                 SOCKBUF_UNLOCK(&so->so_snd);
1417                 error = EPIPE;
1418                 goto out;
1419         }
1420         if (so->so_error) {
1421                 error = so->so_error;
1422                 so->so_error = 0;
1423                 SOCKBUF_UNLOCK(&so->so_snd);
1424                 goto out;
1425         }
1426         if ((so->so_state & SS_ISCONNECTED) == 0) {
1427                 /*
1428                  * `sendto' and `sendmsg' is allowed on a connection-based
1429                  * socket if it supports implied connect.  Return ENOTCONN if
1430                  * not connected and no address is supplied.
1431                  */
1432                 if ((so->so_proto->pr_flags & PR_CONNREQUIRED) &&
1433                     (so->so_proto->pr_flags & PR_IMPLOPCL) == 0) {
1434                         if ((so->so_state & SS_ISCONFIRMING) == 0 &&
1435                             !(resid == 0 && clen != 0)) {
1436                                 SOCKBUF_UNLOCK(&so->so_snd);
1437                                 error = ENOTCONN;
1438                                 goto out;
1439                         }
1440                 } else if (addr == NULL) {
1441                         if (so->so_proto->pr_flags & PR_CONNREQUIRED)
1442                                 error = ENOTCONN;
1443                         else
1444                                 error = EDESTADDRREQ;
1445                         SOCKBUF_UNLOCK(&so->so_snd);
1446                         goto out;
1447                 }
1448         }
1449
1450         /*
1451          * Do we need MSG_OOB support in SOCK_DGRAM?  Signs here may be a
1452          * problem and need fixing.
1453          */
1454         space = sbspace(&so->so_snd);
1455         if (flags & MSG_OOB)
1456                 space += 1024;
1457         space -= clen;
1458         SOCKBUF_UNLOCK(&so->so_snd);
1459         if (resid > space) {
1460                 error = EMSGSIZE;
1461                 goto out;
1462         }
1463         if (uio == NULL) {
1464                 resid = 0;
1465                 if (flags & MSG_EOR)
1466                         top->m_flags |= M_EOR;
1467         } else {
1468                 /*
1469                  * Copy the data from userland into a mbuf chain.
1470                  * If no data is to be copied in, a single empty mbuf
1471                  * is returned.
1472                  */
1473                 top = m_uiotombuf(uio, M_WAITOK, space, max_hdr,
1474                     (M_PKTHDR | ((flags & MSG_EOR) ? M_EOR : 0)));
1475                 if (top == NULL) {
1476                         error = EFAULT; /* only possible error */
1477                         goto out;
1478                 }
1479                 space -= resid - uio->uio_resid;
1480                 resid = uio->uio_resid;
1481         }
1482         KASSERT(resid == 0, ("sosend_dgram: resid != 0"));
1483         /*
1484          * XXXRW: Frobbing SO_DONTROUTE here is even worse without sblock
1485          * than with.
1486          */
1487         if (dontroute) {
1488                 SOCK_LOCK(so);
1489                 so->so_options |= SO_DONTROUTE;
1490                 SOCK_UNLOCK(so);
1491         }
1492         /*
1493          * XXX all the SBS_CANTSENDMORE checks previously done could be out
1494          * of date.  We could have received a reset packet in an interrupt or
1495          * maybe we slept while doing page faults in uiomove() etc.  We could
1496          * probably recheck again inside the locking protection here, but
1497          * there are probably other places that this also happens.  We must
1498          * rethink this.
1499          */
1500         VNET_SO_ASSERT(so);
1501         error = (*so->so_proto->pr_usrreqs->pru_send)(so,
1502             (flags & MSG_OOB) ? PRUS_OOB :
1503         /*
1504          * If the user set MSG_EOF, the protocol understands this flag and
1505          * nothing left to send then use PRU_SEND_EOF instead of PRU_SEND.
1506          */
1507             ((flags & MSG_EOF) &&
1508              (so->so_proto->pr_flags & PR_IMPLOPCL) &&
1509              (resid <= 0)) ?
1510                 PRUS_EOF :
1511                 /* If there is more to send set PRUS_MORETOCOME */
1512                 (flags & MSG_MORETOCOME) ||
1513                 (resid > 0 && space > 0) ? PRUS_MORETOCOME : 0,
1514                 top, addr, control, td);
1515         if (dontroute) {
1516                 SOCK_LOCK(so);
1517                 so->so_options &= ~SO_DONTROUTE;
1518                 SOCK_UNLOCK(so);
1519         }
1520         clen = 0;
1521         control = NULL;
1522         top = NULL;
1523 out:
1524         if (top != NULL)
1525                 m_freem(top);
1526         if (control != NULL)
1527                 m_freem(control);
1528         return (error);
1529 }
1530
1531 /*
1532  * Send on a socket.  If send must go all at once and message is larger than
1533  * send buffering, then hard error.  Lock against other senders.  If must go
1534  * all at once and not enough room now, then inform user that this would
1535  * block and do nothing.  Otherwise, if nonblocking, send as much as
1536  * possible.  The data to be sent is described by "uio" if nonzero, otherwise
1537  * by the mbuf chain "top" (which must be null if uio is not).  Data provided
1538  * in mbuf chain must be small enough to send all at once.
1539  *
1540  * Returns nonzero on error, timeout or signal; callers must check for short
1541  * counts if EINTR/ERESTART are returned.  Data and control buffers are freed
1542  * on return.
1543  */
1544 int
1545 sosend_generic(struct socket *so, struct sockaddr *addr, struct uio *uio,
1546     struct mbuf *top, struct mbuf *control, int flags, struct thread *td)
1547 {
1548         long space;
1549         ssize_t resid;
1550         int clen = 0, error, dontroute;
1551         int atomic = sosendallatonce(so) || top;
1552         int pru_flag;
1553 #ifdef KERN_TLS
1554         struct ktls_session *tls;
1555         int tls_enq_cnt, tls_pruflag;
1556         uint8_t tls_rtype;
1557
1558         tls = NULL;
1559         tls_rtype = TLS_RLTYPE_APP;
1560 #endif
1561         if (uio != NULL)
1562                 resid = uio->uio_resid;
1563         else if ((top->m_flags & M_PKTHDR) != 0)
1564                 resid = top->m_pkthdr.len;
1565         else
1566                 resid = m_length(top, NULL);
1567         /*
1568          * In theory resid should be unsigned.  However, space must be
1569          * signed, as it might be less than 0 if we over-committed, and we
1570          * must use a signed comparison of space and resid.  On the other
1571          * hand, a negative resid causes us to loop sending 0-length
1572          * segments to the protocol.
1573          *
1574          * Also check to make sure that MSG_EOR isn't used on SOCK_STREAM
1575          * type sockets since that's an error.
1576          */
1577         if (resid < 0 || (so->so_type == SOCK_STREAM && (flags & MSG_EOR))) {
1578                 error = EINVAL;
1579                 goto out;
1580         }
1581
1582         dontroute =
1583             (flags & MSG_DONTROUTE) && (so->so_options & SO_DONTROUTE) == 0 &&
1584             (so->so_proto->pr_flags & PR_ATOMIC);
1585         if (td != NULL)
1586                 td->td_ru.ru_msgsnd++;
1587         if (control != NULL)
1588                 clen = control->m_len;
1589
1590         error = SOCK_IO_SEND_LOCK(so, SBLOCKWAIT(flags));
1591         if (error)
1592                 goto out;
1593
1594 #ifdef KERN_TLS
1595         tls_pruflag = 0;
1596         tls = ktls_hold(so->so_snd.sb_tls_info);
1597         if (tls != NULL) {
1598                 if (tls->mode == TCP_TLS_MODE_SW)
1599                         tls_pruflag = PRUS_NOTREADY;
1600
1601                 if (control != NULL) {
1602                         struct cmsghdr *cm = mtod(control, struct cmsghdr *);
1603
1604                         if (clen >= sizeof(*cm) &&
1605                             cm->cmsg_type == TLS_SET_RECORD_TYPE) {
1606                                 tls_rtype = *((uint8_t *)CMSG_DATA(cm));
1607                                 clen = 0;
1608                                 m_freem(control);
1609                                 control = NULL;
1610                                 atomic = 1;
1611                         }
1612                 }
1613
1614                 if (resid == 0 && !ktls_permit_empty_frames(tls)) {
1615                         error = EINVAL;
1616                         goto release;
1617                 }
1618         }
1619 #endif
1620
1621 restart:
1622         do {
1623                 SOCKBUF_LOCK(&so->so_snd);
1624                 if (so->so_snd.sb_state & SBS_CANTSENDMORE) {
1625                         SOCKBUF_UNLOCK(&so->so_snd);
1626                         error = EPIPE;
1627                         goto release;
1628                 }
1629                 if (so->so_error) {
1630                         error = so->so_error;
1631                         so->so_error = 0;
1632                         SOCKBUF_UNLOCK(&so->so_snd);
1633                         goto release;
1634                 }
1635                 if ((so->so_state & SS_ISCONNECTED) == 0) {
1636                         /*
1637                          * `sendto' and `sendmsg' is allowed on a connection-
1638                          * based socket if it supports implied connect.
1639                          * Return ENOTCONN if not connected and no address is
1640                          * supplied.
1641                          */
1642                         if ((so->so_proto->pr_flags & PR_CONNREQUIRED) &&
1643                             (so->so_proto->pr_flags & PR_IMPLOPCL) == 0) {
1644                                 if ((so->so_state & SS_ISCONFIRMING) == 0 &&
1645                                     !(resid == 0 && clen != 0)) {
1646                                         SOCKBUF_UNLOCK(&so->so_snd);
1647                                         error = ENOTCONN;
1648                                         goto release;
1649                                 }
1650                         } else if (addr == NULL) {
1651                                 SOCKBUF_UNLOCK(&so->so_snd);
1652                                 if (so->so_proto->pr_flags & PR_CONNREQUIRED)
1653                                         error = ENOTCONN;
1654                                 else
1655                                         error = EDESTADDRREQ;
1656                                 goto release;
1657                         }
1658                 }
1659                 space = sbspace(&so->so_snd);
1660                 if (flags & MSG_OOB)
1661                         space += 1024;
1662                 if ((atomic && resid > so->so_snd.sb_hiwat) ||
1663                     clen > so->so_snd.sb_hiwat) {
1664                         SOCKBUF_UNLOCK(&so->so_snd);
1665                         error = EMSGSIZE;
1666                         goto release;
1667                 }
1668                 if (space < resid + clen &&
1669                     (atomic || space < so->so_snd.sb_lowat || space < clen)) {
1670                         if ((so->so_state & SS_NBIO) ||
1671                             (flags & (MSG_NBIO | MSG_DONTWAIT)) != 0) {
1672                                 SOCKBUF_UNLOCK(&so->so_snd);
1673                                 error = EWOULDBLOCK;
1674                                 goto release;
1675                         }
1676                         error = sbwait(&so->so_snd);
1677                         SOCKBUF_UNLOCK(&so->so_snd);
1678                         if (error)
1679                                 goto release;
1680                         goto restart;
1681                 }
1682                 SOCKBUF_UNLOCK(&so->so_snd);
1683                 space -= clen;
1684                 do {
1685                         if (uio == NULL) {
1686                                 resid = 0;
1687                                 if (flags & MSG_EOR)
1688                                         top->m_flags |= M_EOR;
1689 #ifdef KERN_TLS
1690                                 if (tls != NULL) {
1691                                         ktls_frame(top, tls, &tls_enq_cnt,
1692                                             tls_rtype);
1693                                         tls_rtype = TLS_RLTYPE_APP;
1694                                 }
1695 #endif
1696                         } else {
1697                                 /*
1698                                  * Copy the data from userland into a mbuf
1699                                  * chain.  If resid is 0, which can happen
1700                                  * only if we have control to send, then
1701                                  * a single empty mbuf is returned.  This
1702                                  * is a workaround to prevent protocol send
1703                                  * methods to panic.
1704                                  */
1705 #ifdef KERN_TLS
1706                                 if (tls != NULL) {
1707                                         top = m_uiotombuf(uio, M_WAITOK, space,
1708                                             tls->params.max_frame_len,
1709                                             M_EXTPG |
1710                                             ((flags & MSG_EOR) ? M_EOR : 0));
1711                                         if (top != NULL) {
1712                                                 ktls_frame(top, tls,
1713                                                     &tls_enq_cnt, tls_rtype);
1714                                         }
1715                                         tls_rtype = TLS_RLTYPE_APP;
1716                                 } else
1717 #endif
1718                                         top = m_uiotombuf(uio, M_WAITOK, space,
1719                                             (atomic ? max_hdr : 0),
1720                                             (atomic ? M_PKTHDR : 0) |
1721                                             ((flags & MSG_EOR) ? M_EOR : 0));
1722                                 if (top == NULL) {
1723                                         error = EFAULT; /* only possible error */
1724                                         goto release;
1725                                 }
1726                                 space -= resid - uio->uio_resid;
1727                                 resid = uio->uio_resid;
1728                         }
1729                         if (dontroute) {
1730                                 SOCK_LOCK(so);
1731                                 so->so_options |= SO_DONTROUTE;
1732                                 SOCK_UNLOCK(so);
1733                         }
1734                         /*
1735                          * XXX all the SBS_CANTSENDMORE checks previously
1736                          * done could be out of date.  We could have received
1737                          * a reset packet in an interrupt or maybe we slept
1738                          * while doing page faults in uiomove() etc.  We
1739                          * could probably recheck again inside the locking
1740                          * protection here, but there are probably other
1741                          * places that this also happens.  We must rethink
1742                          * this.
1743                          */
1744                         VNET_SO_ASSERT(so);
1745
1746                         pru_flag = (flags & MSG_OOB) ? PRUS_OOB :
1747                         /*
1748                          * If the user set MSG_EOF, the protocol understands
1749                          * this flag and nothing left to send then use
1750                          * PRU_SEND_EOF instead of PRU_SEND.
1751                          */
1752                             ((flags & MSG_EOF) &&
1753                              (so->so_proto->pr_flags & PR_IMPLOPCL) &&
1754                              (resid <= 0)) ?
1755                                 PRUS_EOF :
1756                         /* If there is more to send set PRUS_MORETOCOME. */
1757                             (flags & MSG_MORETOCOME) ||
1758                             (resid > 0 && space > 0) ? PRUS_MORETOCOME : 0;
1759
1760 #ifdef KERN_TLS
1761                         pru_flag |= tls_pruflag;
1762 #endif
1763
1764                         error = (*so->so_proto->pr_usrreqs->pru_send)(so,
1765                             pru_flag, top, addr, control, td);
1766
1767                         if (dontroute) {
1768                                 SOCK_LOCK(so);
1769                                 so->so_options &= ~SO_DONTROUTE;
1770                                 SOCK_UNLOCK(so);
1771                         }
1772
1773 #ifdef KERN_TLS
1774                         if (tls != NULL && tls->mode == TCP_TLS_MODE_SW) {
1775                                 if (error != 0) {
1776                                         m_freem(top);
1777                                         top = NULL;
1778                                 } else {
1779                                         soref(so);
1780                                         ktls_enqueue(top, so, tls_enq_cnt);
1781                                 }
1782                         }
1783 #endif
1784                         clen = 0;
1785                         control = NULL;
1786                         top = NULL;
1787                         if (error)
1788                                 goto release;
1789                 } while (resid && space > 0);
1790         } while (resid);
1791
1792 release:
1793         SOCK_IO_SEND_UNLOCK(so);
1794 out:
1795 #ifdef KERN_TLS
1796         if (tls != NULL)
1797                 ktls_free(tls);
1798 #endif
1799         if (top != NULL)
1800                 m_freem(top);
1801         if (control != NULL)
1802                 m_freem(control);
1803         return (error);
1804 }
1805
1806 int
1807 sosend(struct socket *so, struct sockaddr *addr, struct uio *uio,
1808     struct mbuf *top, struct mbuf *control, int flags, struct thread *td)
1809 {
1810         int error;
1811
1812         CURVNET_SET(so->so_vnet);
1813         if (!SOLISTENING(so))
1814                 error = so->so_proto->pr_usrreqs->pru_sosend(so, addr, uio,
1815                     top, control, flags, td);
1816         else {
1817                 m_freem(top);
1818                 m_freem(control);
1819                 error = ENOTCONN;
1820         }
1821         CURVNET_RESTORE();
1822         return (error);
1823 }
1824
1825 /*
1826  * The part of soreceive() that implements reading non-inline out-of-band
1827  * data from a socket.  For more complete comments, see soreceive(), from
1828  * which this code originated.
1829  *
1830  * Note that soreceive_rcvoob(), unlike the remainder of soreceive(), is
1831  * unable to return an mbuf chain to the caller.
1832  */
1833 static int
1834 soreceive_rcvoob(struct socket *so, struct uio *uio, int flags)
1835 {
1836         struct protosw *pr = so->so_proto;
1837         struct mbuf *m;
1838         int error;
1839
1840         KASSERT(flags & MSG_OOB, ("soreceive_rcvoob: (flags & MSG_OOB) == 0"));
1841         VNET_SO_ASSERT(so);
1842
1843         m = m_get(M_WAITOK, MT_DATA);
1844         error = (*pr->pr_usrreqs->pru_rcvoob)(so, m, flags & MSG_PEEK);
1845         if (error)
1846                 goto bad;
1847         do {
1848                 error = uiomove(mtod(m, void *),
1849                     (int) min(uio->uio_resid, m->m_len), uio);
1850                 m = m_free(m);
1851         } while (uio->uio_resid && error == 0 && m);
1852 bad:
1853         if (m != NULL)
1854                 m_freem(m);
1855         return (error);
1856 }
1857
1858 /*
1859  * Following replacement or removal of the first mbuf on the first mbuf chain
1860  * of a socket buffer, push necessary state changes back into the socket
1861  * buffer so that other consumers see the values consistently.  'nextrecord'
1862  * is the callers locally stored value of the original value of
1863  * sb->sb_mb->m_nextpkt which must be restored when the lead mbuf changes.
1864  * NOTE: 'nextrecord' may be NULL.
1865  */
1866 static __inline void
1867 sockbuf_pushsync(struct sockbuf *sb, struct mbuf *nextrecord)
1868 {
1869
1870         SOCKBUF_LOCK_ASSERT(sb);
1871         /*
1872          * First, update for the new value of nextrecord.  If necessary, make
1873          * it the first record.
1874          */
1875         if (sb->sb_mb != NULL)
1876                 sb->sb_mb->m_nextpkt = nextrecord;
1877         else
1878                 sb->sb_mb = nextrecord;
1879
1880         /*
1881          * Now update any dependent socket buffer fields to reflect the new
1882          * state.  This is an expanded inline of SB_EMPTY_FIXUP(), with the
1883          * addition of a second clause that takes care of the case where
1884          * sb_mb has been updated, but remains the last record.
1885          */
1886         if (sb->sb_mb == NULL) {
1887                 sb->sb_mbtail = NULL;
1888                 sb->sb_lastrecord = NULL;
1889         } else if (sb->sb_mb->m_nextpkt == NULL)
1890                 sb->sb_lastrecord = sb->sb_mb;
1891 }
1892
1893 /*
1894  * Implement receive operations on a socket.  We depend on the way that
1895  * records are added to the sockbuf by sbappend.  In particular, each record
1896  * (mbufs linked through m_next) must begin with an address if the protocol
1897  * so specifies, followed by an optional mbuf or mbufs containing ancillary
1898  * data, and then zero or more mbufs of data.  In order to allow parallelism
1899  * between network receive and copying to user space, as well as avoid
1900  * sleeping with a mutex held, we release the socket buffer mutex during the
1901  * user space copy.  Although the sockbuf is locked, new data may still be
1902  * appended, and thus we must maintain consistency of the sockbuf during that
1903  * time.
1904  *
1905  * The caller may receive the data as a single mbuf chain by supplying an
1906  * mbuf **mp0 for use in returning the chain.  The uio is then used only for
1907  * the count in uio_resid.
1908  */
1909 int
1910 soreceive_generic(struct socket *so, struct sockaddr **psa, struct uio *uio,
1911     struct mbuf **mp0, struct mbuf **controlp, int *flagsp)
1912 {
1913         struct mbuf *m, **mp;
1914         int flags, error, offset;
1915         ssize_t len;
1916         struct protosw *pr = so->so_proto;
1917         struct mbuf *nextrecord;
1918         int moff, type = 0;
1919         ssize_t orig_resid = uio->uio_resid;
1920         bool report_real_len = false;
1921
1922         mp = mp0;
1923         if (psa != NULL)
1924                 *psa = NULL;
1925         if (controlp != NULL)
1926                 *controlp = NULL;
1927         if (flagsp != NULL) {
1928                 report_real_len = *flagsp & MSG_TRUNC;
1929                 *flagsp &= ~MSG_TRUNC;
1930                 flags = *flagsp &~ MSG_EOR;
1931         } else
1932                 flags = 0;
1933         if (flags & MSG_OOB)
1934                 return (soreceive_rcvoob(so, uio, flags));
1935         if (mp != NULL)
1936                 *mp = NULL;
1937         if ((pr->pr_flags & PR_WANTRCVD) && (so->so_state & SS_ISCONFIRMING)
1938             && uio->uio_resid) {
1939                 VNET_SO_ASSERT(so);
1940                 (*pr->pr_usrreqs->pru_rcvd)(so, 0);
1941         }
1942
1943         error = SOCK_IO_RECV_LOCK(so, SBLOCKWAIT(flags));
1944         if (error)
1945                 return (error);
1946
1947 restart:
1948         SOCKBUF_LOCK(&so->so_rcv);
1949         m = so->so_rcv.sb_mb;
1950         /*
1951          * If we have less data than requested, block awaiting more (subject
1952          * to any timeout) if:
1953          *   1. the current count is less than the low water mark, or
1954          *   2. MSG_DONTWAIT is not set
1955          */
1956         if (m == NULL || (((flags & MSG_DONTWAIT) == 0 &&
1957             sbavail(&so->so_rcv) < uio->uio_resid) &&
1958             sbavail(&so->so_rcv) < so->so_rcv.sb_lowat &&
1959             m->m_nextpkt == NULL && (pr->pr_flags & PR_ATOMIC) == 0)) {
1960                 KASSERT(m != NULL || !sbavail(&so->so_rcv),
1961                     ("receive: m == %p sbavail == %u",
1962                     m, sbavail(&so->so_rcv)));
1963                 if (so->so_error || so->so_rerror) {
1964                         if (m != NULL)
1965                                 goto dontblock;
1966                         if (so->so_error)
1967                                 error = so->so_error;
1968                         else
1969                                 error = so->so_rerror;
1970                         if ((flags & MSG_PEEK) == 0) {
1971                                 if (so->so_error)
1972                                         so->so_error = 0;
1973                                 else
1974                                         so->so_rerror = 0;
1975                         }
1976                         SOCKBUF_UNLOCK(&so->so_rcv);
1977                         goto release;
1978                 }
1979                 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
1980                 if (so->so_rcv.sb_state & SBS_CANTRCVMORE) {
1981                         if (m != NULL)
1982                                 goto dontblock;
1983 #ifdef KERN_TLS
1984                         else if (so->so_rcv.sb_tlsdcc == 0 &&
1985                             so->so_rcv.sb_tlscc == 0) {
1986 #else
1987                         else {
1988 #endif
1989                                 SOCKBUF_UNLOCK(&so->so_rcv);
1990                                 goto release;
1991                         }
1992                 }
1993                 for (; m != NULL; m = m->m_next)
1994                         if (m->m_type == MT_OOBDATA  || (m->m_flags & M_EOR)) {
1995                                 m = so->so_rcv.sb_mb;
1996                                 goto dontblock;
1997                         }
1998                 if ((so->so_state & (SS_ISCONNECTING | SS_ISCONNECTED |
1999                     SS_ISDISCONNECTING | SS_ISDISCONNECTED)) == 0 &&
2000                     (so->so_proto->pr_flags & PR_CONNREQUIRED) != 0) {
2001                         SOCKBUF_UNLOCK(&so->so_rcv);
2002                         error = ENOTCONN;
2003                         goto release;
2004                 }
2005                 if (uio->uio_resid == 0 && !report_real_len) {
2006                         SOCKBUF_UNLOCK(&so->so_rcv);
2007                         goto release;
2008                 }
2009                 if ((so->so_state & SS_NBIO) ||
2010                     (flags & (MSG_DONTWAIT|MSG_NBIO))) {
2011                         SOCKBUF_UNLOCK(&so->so_rcv);
2012                         error = EWOULDBLOCK;
2013                         goto release;
2014                 }
2015                 SBLASTRECORDCHK(&so->so_rcv);
2016                 SBLASTMBUFCHK(&so->so_rcv);
2017                 error = sbwait(&so->so_rcv);
2018                 SOCKBUF_UNLOCK(&so->so_rcv);
2019                 if (error)
2020                         goto release;
2021                 goto restart;
2022         }
2023 dontblock:
2024         /*
2025          * From this point onward, we maintain 'nextrecord' as a cache of the
2026          * pointer to the next record in the socket buffer.  We must keep the
2027          * various socket buffer pointers and local stack versions of the
2028          * pointers in sync, pushing out modifications before dropping the
2029          * socket buffer mutex, and re-reading them when picking it up.
2030          *
2031          * Otherwise, we will race with the network stack appending new data
2032          * or records onto the socket buffer by using inconsistent/stale
2033          * versions of the field, possibly resulting in socket buffer
2034          * corruption.
2035          *
2036          * By holding the high-level sblock(), we prevent simultaneous
2037          * readers from pulling off the front of the socket buffer.
2038          */
2039         SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2040         if (uio->uio_td)
2041                 uio->uio_td->td_ru.ru_msgrcv++;
2042         KASSERT(m == so->so_rcv.sb_mb, ("soreceive: m != so->so_rcv.sb_mb"));
2043         SBLASTRECORDCHK(&so->so_rcv);
2044         SBLASTMBUFCHK(&so->so_rcv);
2045         nextrecord = m->m_nextpkt;
2046         if (pr->pr_flags & PR_ADDR) {
2047                 KASSERT(m->m_type == MT_SONAME,
2048                     ("m->m_type == %d", m->m_type));
2049                 orig_resid = 0;
2050                 if (psa != NULL)
2051                         *psa = sodupsockaddr(mtod(m, struct sockaddr *),
2052                             M_NOWAIT);
2053                 if (flags & MSG_PEEK) {
2054                         m = m->m_next;
2055                 } else {
2056                         sbfree(&so->so_rcv, m);
2057                         so->so_rcv.sb_mb = m_free(m);
2058                         m = so->so_rcv.sb_mb;
2059                         sockbuf_pushsync(&so->so_rcv, nextrecord);
2060                 }
2061         }
2062
2063         /*
2064          * Process one or more MT_CONTROL mbufs present before any data mbufs
2065          * in the first mbuf chain on the socket buffer.  If MSG_PEEK, we
2066          * just copy the data; if !MSG_PEEK, we call into the protocol to
2067          * perform externalization (or freeing if controlp == NULL).
2068          */
2069         if (m != NULL && m->m_type == MT_CONTROL) {
2070                 struct mbuf *cm = NULL, *cmn;
2071                 struct mbuf **cme = &cm;
2072 #ifdef KERN_TLS
2073                 struct cmsghdr *cmsg;
2074                 struct tls_get_record tgr;
2075
2076                 /*
2077                  * For MSG_TLSAPPDATA, check for an alert record.
2078                  * If found, return ENXIO without removing
2079                  * it from the receive queue.  This allows a subsequent
2080                  * call without MSG_TLSAPPDATA to receive it.
2081                  * Note that, for TLS, there should only be a single
2082                  * control mbuf with the TLS_GET_RECORD message in it.
2083                  */
2084                 if (flags & MSG_TLSAPPDATA) {
2085                         cmsg = mtod(m, struct cmsghdr *);
2086                         if (cmsg->cmsg_type == TLS_GET_RECORD &&
2087                             cmsg->cmsg_len == CMSG_LEN(sizeof(tgr))) {
2088                                 memcpy(&tgr, CMSG_DATA(cmsg), sizeof(tgr));
2089                                 if (__predict_false(tgr.tls_type ==
2090                                     TLS_RLTYPE_ALERT)) {
2091                                         SOCKBUF_UNLOCK(&so->so_rcv);
2092                                         error = ENXIO;
2093                                         goto release;
2094                                 }
2095                         }
2096                 }
2097 #endif
2098
2099                 do {
2100                         if (flags & MSG_PEEK) {
2101                                 if (controlp != NULL) {
2102                                         *controlp = m_copym(m, 0, m->m_len,
2103                                             M_NOWAIT);
2104                                         controlp = &(*controlp)->m_next;
2105                                 }
2106                                 m = m->m_next;
2107                         } else {
2108                                 sbfree(&so->so_rcv, m);
2109                                 so->so_rcv.sb_mb = m->m_next;
2110                                 m->m_next = NULL;
2111                                 *cme = m;
2112                                 cme = &(*cme)->m_next;
2113                                 m = so->so_rcv.sb_mb;
2114                         }
2115                 } while (m != NULL && m->m_type == MT_CONTROL);
2116                 if ((flags & MSG_PEEK) == 0)
2117                         sockbuf_pushsync(&so->so_rcv, nextrecord);
2118                 while (cm != NULL) {
2119                         cmn = cm->m_next;
2120                         cm->m_next = NULL;
2121                         if (pr->pr_domain->dom_externalize != NULL) {
2122                                 SOCKBUF_UNLOCK(&so->so_rcv);
2123                                 VNET_SO_ASSERT(so);
2124                                 error = (*pr->pr_domain->dom_externalize)
2125                                     (cm, controlp, flags);
2126                                 SOCKBUF_LOCK(&so->so_rcv);
2127                         } else if (controlp != NULL)
2128                                 *controlp = cm;
2129                         else
2130                                 m_freem(cm);
2131                         if (controlp != NULL) {
2132                                 while (*controlp != NULL)
2133                                         controlp = &(*controlp)->m_next;
2134                         }
2135                         cm = cmn;
2136                 }
2137                 if (m != NULL)
2138                         nextrecord = so->so_rcv.sb_mb->m_nextpkt;
2139                 else
2140                         nextrecord = so->so_rcv.sb_mb;
2141                 orig_resid = 0;
2142         }
2143         if (m != NULL) {
2144                 if ((flags & MSG_PEEK) == 0) {
2145                         KASSERT(m->m_nextpkt == nextrecord,
2146                             ("soreceive: post-control, nextrecord !sync"));
2147                         if (nextrecord == NULL) {
2148                                 KASSERT(so->so_rcv.sb_mb == m,
2149                                     ("soreceive: post-control, sb_mb!=m"));
2150                                 KASSERT(so->so_rcv.sb_lastrecord == m,
2151                                     ("soreceive: post-control, lastrecord!=m"));
2152                         }
2153                 }
2154                 type = m->m_type;
2155                 if (type == MT_OOBDATA)
2156                         flags |= MSG_OOB;
2157         } else {
2158                 if ((flags & MSG_PEEK) == 0) {
2159                         KASSERT(so->so_rcv.sb_mb == nextrecord,
2160                             ("soreceive: sb_mb != nextrecord"));
2161                         if (so->so_rcv.sb_mb == NULL) {
2162                                 KASSERT(so->so_rcv.sb_lastrecord == NULL,
2163                                     ("soreceive: sb_lastercord != NULL"));
2164                         }
2165                 }
2166         }
2167         SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2168         SBLASTRECORDCHK(&so->so_rcv);
2169         SBLASTMBUFCHK(&so->so_rcv);
2170
2171         /*
2172          * Now continue to read any data mbufs off of the head of the socket
2173          * buffer until the read request is satisfied.  Note that 'type' is
2174          * used to store the type of any mbuf reads that have happened so far
2175          * such that soreceive() can stop reading if the type changes, which
2176          * causes soreceive() to return only one of regular data and inline
2177          * out-of-band data in a single socket receive operation.
2178          */
2179         moff = 0;
2180         offset = 0;
2181         while (m != NULL && !(m->m_flags & M_NOTAVAIL) && uio->uio_resid > 0
2182             && error == 0) {
2183                 /*
2184                  * If the type of mbuf has changed since the last mbuf
2185                  * examined ('type'), end the receive operation.
2186                  */
2187                 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2188                 if (m->m_type == MT_OOBDATA || m->m_type == MT_CONTROL) {
2189                         if (type != m->m_type)
2190                                 break;
2191                 } else if (type == MT_OOBDATA)
2192                         break;
2193                 else
2194                     KASSERT(m->m_type == MT_DATA,
2195                         ("m->m_type == %d", m->m_type));
2196                 so->so_rcv.sb_state &= ~SBS_RCVATMARK;
2197                 len = uio->uio_resid;
2198                 if (so->so_oobmark && len > so->so_oobmark - offset)
2199                         len = so->so_oobmark - offset;
2200                 if (len > m->m_len - moff)
2201                         len = m->m_len - moff;
2202                 /*
2203                  * If mp is set, just pass back the mbufs.  Otherwise copy
2204                  * them out via the uio, then free.  Sockbuf must be
2205                  * consistent here (points to current mbuf, it points to next
2206                  * record) when we drop priority; we must note any additions
2207                  * to the sockbuf when we block interrupts again.
2208                  */
2209                 if (mp == NULL) {
2210                         SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2211                         SBLASTRECORDCHK(&so->so_rcv);
2212                         SBLASTMBUFCHK(&so->so_rcv);
2213                         SOCKBUF_UNLOCK(&so->so_rcv);
2214                         if ((m->m_flags & M_EXTPG) != 0)
2215                                 error = m_unmapped_uiomove(m, moff, uio,
2216                                     (int)len);
2217                         else
2218                                 error = uiomove(mtod(m, char *) + moff,
2219                                     (int)len, uio);
2220                         SOCKBUF_LOCK(&so->so_rcv);
2221                         if (error) {
2222                                 /*
2223                                  * The MT_SONAME mbuf has already been removed
2224                                  * from the record, so it is necessary to
2225                                  * remove the data mbufs, if any, to preserve
2226                                  * the invariant in the case of PR_ADDR that
2227                                  * requires MT_SONAME mbufs at the head of
2228                                  * each record.
2229                                  */
2230                                 if (pr->pr_flags & PR_ATOMIC &&
2231                                     ((flags & MSG_PEEK) == 0))
2232                                         (void)sbdroprecord_locked(&so->so_rcv);
2233                                 SOCKBUF_UNLOCK(&so->so_rcv);
2234                                 goto release;
2235                         }
2236                 } else
2237                         uio->uio_resid -= len;
2238                 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2239                 if (len == m->m_len - moff) {
2240                         if (m->m_flags & M_EOR)
2241                                 flags |= MSG_EOR;
2242                         if (flags & MSG_PEEK) {
2243                                 m = m->m_next;
2244                                 moff = 0;
2245                         } else {
2246                                 nextrecord = m->m_nextpkt;
2247                                 sbfree(&so->so_rcv, m);
2248                                 if (mp != NULL) {
2249                                         m->m_nextpkt = NULL;
2250                                         *mp = m;
2251                                         mp = &m->m_next;
2252                                         so->so_rcv.sb_mb = m = m->m_next;
2253                                         *mp = NULL;
2254                                 } else {
2255                                         so->so_rcv.sb_mb = m_free(m);
2256                                         m = so->so_rcv.sb_mb;
2257                                 }
2258                                 sockbuf_pushsync(&so->so_rcv, nextrecord);
2259                                 SBLASTRECORDCHK(&so->so_rcv);
2260                                 SBLASTMBUFCHK(&so->so_rcv);
2261                         }
2262                 } else {
2263                         if (flags & MSG_PEEK)
2264                                 moff += len;
2265                         else {
2266                                 if (mp != NULL) {
2267                                         if (flags & MSG_DONTWAIT) {
2268                                                 *mp = m_copym(m, 0, len,
2269                                                     M_NOWAIT);
2270                                                 if (*mp == NULL) {
2271                                                         /*
2272                                                          * m_copym() couldn't
2273                                                          * allocate an mbuf.
2274                                                          * Adjust uio_resid back
2275                                                          * (it was adjusted
2276                                                          * down by len bytes,
2277                                                          * which we didn't end
2278                                                          * up "copying" over).
2279                                                          */
2280                                                         uio->uio_resid += len;
2281                                                         break;
2282                                                 }
2283                                         } else {
2284                                                 SOCKBUF_UNLOCK(&so->so_rcv);
2285                                                 *mp = m_copym(m, 0, len,
2286                                                     M_WAITOK);
2287                                                 SOCKBUF_LOCK(&so->so_rcv);
2288                                         }
2289                                 }
2290                                 sbcut_locked(&so->so_rcv, len);
2291                         }
2292                 }
2293                 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2294                 if (so->so_oobmark) {
2295                         if ((flags & MSG_PEEK) == 0) {
2296                                 so->so_oobmark -= len;
2297                                 if (so->so_oobmark == 0) {
2298                                         so->so_rcv.sb_state |= SBS_RCVATMARK;
2299                                         break;
2300                                 }
2301                         } else {
2302                                 offset += len;
2303                                 if (offset == so->so_oobmark)
2304                                         break;
2305                         }
2306                 }
2307                 if (flags & MSG_EOR)
2308                         break;
2309                 /*
2310                  * If the MSG_WAITALL flag is set (for non-atomic socket), we
2311                  * must not quit until "uio->uio_resid == 0" or an error
2312                  * termination.  If a signal/timeout occurs, return with a
2313                  * short count but without error.  Keep sockbuf locked
2314                  * against other readers.
2315                  */
2316                 while (flags & MSG_WAITALL && m == NULL && uio->uio_resid > 0 &&
2317                     !sosendallatonce(so) && nextrecord == NULL) {
2318                         SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2319                         if (so->so_error || so->so_rerror ||
2320                             so->so_rcv.sb_state & SBS_CANTRCVMORE)
2321                                 break;
2322                         /*
2323                          * Notify the protocol that some data has been
2324                          * drained before blocking.
2325                          */
2326                         if (pr->pr_flags & PR_WANTRCVD) {
2327                                 SOCKBUF_UNLOCK(&so->so_rcv);
2328                                 VNET_SO_ASSERT(so);
2329                                 (*pr->pr_usrreqs->pru_rcvd)(so, flags);
2330                                 SOCKBUF_LOCK(&so->so_rcv);
2331                         }
2332                         SBLASTRECORDCHK(&so->so_rcv);
2333                         SBLASTMBUFCHK(&so->so_rcv);
2334                         /*
2335                          * We could receive some data while was notifying
2336                          * the protocol. Skip blocking in this case.
2337                          */
2338                         if (so->so_rcv.sb_mb == NULL) {
2339                                 error = sbwait(&so->so_rcv);
2340                                 if (error) {
2341                                         SOCKBUF_UNLOCK(&so->so_rcv);
2342                                         goto release;
2343                                 }
2344                         }
2345                         m = so->so_rcv.sb_mb;
2346                         if (m != NULL)
2347                                 nextrecord = m->m_nextpkt;
2348                 }
2349         }
2350
2351         SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2352         if (m != NULL && pr->pr_flags & PR_ATOMIC) {
2353                 if (report_real_len)
2354                         uio->uio_resid -= m_length(m, NULL) - moff;
2355                 flags |= MSG_TRUNC;
2356                 if ((flags & MSG_PEEK) == 0)
2357                         (void) sbdroprecord_locked(&so->so_rcv);
2358         }
2359         if ((flags & MSG_PEEK) == 0) {
2360                 if (m == NULL) {
2361                         /*
2362                          * First part is an inline SB_EMPTY_FIXUP().  Second
2363                          * part makes sure sb_lastrecord is up-to-date if
2364                          * there is still data in the socket buffer.
2365                          */
2366                         so->so_rcv.sb_mb = nextrecord;
2367                         if (so->so_rcv.sb_mb == NULL) {
2368                                 so->so_rcv.sb_mbtail = NULL;
2369                                 so->so_rcv.sb_lastrecord = NULL;
2370                         } else if (nextrecord->m_nextpkt == NULL)
2371                                 so->so_rcv.sb_lastrecord = nextrecord;
2372                 }
2373                 SBLASTRECORDCHK(&so->so_rcv);
2374                 SBLASTMBUFCHK(&so->so_rcv);
2375                 /*
2376                  * If soreceive() is being done from the socket callback,
2377                  * then don't need to generate ACK to peer to update window,
2378                  * since ACK will be generated on return to TCP.
2379                  */
2380                 if (!(flags & MSG_SOCALLBCK) &&
2381                     (pr->pr_flags & PR_WANTRCVD)) {
2382                         SOCKBUF_UNLOCK(&so->so_rcv);
2383                         VNET_SO_ASSERT(so);
2384                         (*pr->pr_usrreqs->pru_rcvd)(so, flags);
2385                         SOCKBUF_LOCK(&so->so_rcv);
2386                 }
2387         }
2388         SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2389         if (orig_resid == uio->uio_resid && orig_resid &&
2390             (flags & MSG_EOR) == 0 && (so->so_rcv.sb_state & SBS_CANTRCVMORE) == 0) {
2391                 SOCKBUF_UNLOCK(&so->so_rcv);
2392                 goto restart;
2393         }
2394         SOCKBUF_UNLOCK(&so->so_rcv);
2395
2396         if (flagsp != NULL)
2397                 *flagsp |= flags;
2398 release:
2399         SOCK_IO_RECV_UNLOCK(so);
2400         return (error);
2401 }
2402
2403 /*
2404  * Optimized version of soreceive() for stream (TCP) sockets.
2405  */
2406 int
2407 soreceive_stream(struct socket *so, struct sockaddr **psa, struct uio *uio,
2408     struct mbuf **mp0, struct mbuf **controlp, int *flagsp)
2409 {
2410         int len = 0, error = 0, flags, oresid;
2411         struct sockbuf *sb;
2412         struct mbuf *m, *n = NULL;
2413
2414         /* We only do stream sockets. */
2415         if (so->so_type != SOCK_STREAM)
2416                 return (EINVAL);
2417         if (psa != NULL)
2418                 *psa = NULL;
2419         if (flagsp != NULL)
2420                 flags = *flagsp &~ MSG_EOR;
2421         else
2422                 flags = 0;
2423         if (controlp != NULL)
2424                 *controlp = NULL;
2425         if (flags & MSG_OOB)
2426                 return (soreceive_rcvoob(so, uio, flags));
2427         if (mp0 != NULL)
2428                 *mp0 = NULL;
2429
2430         sb = &so->so_rcv;
2431
2432 #ifdef KERN_TLS
2433         /*
2434          * KTLS store TLS records as records with a control message to
2435          * describe the framing.
2436          *
2437          * We check once here before acquiring locks to optimize the
2438          * common case.
2439          */
2440         if (sb->sb_tls_info != NULL)
2441                 return (soreceive_generic(so, psa, uio, mp0, controlp,
2442                     flagsp));
2443 #endif
2444
2445         /* Prevent other readers from entering the socket. */
2446         error = SOCK_IO_RECV_LOCK(so, SBLOCKWAIT(flags));
2447         if (error)
2448                 return (error);
2449         SOCKBUF_LOCK(sb);
2450
2451 #ifdef KERN_TLS
2452         if (sb->sb_tls_info != NULL) {
2453                 SOCKBUF_UNLOCK(sb);
2454                 SOCK_IO_RECV_UNLOCK(so);
2455                 return (soreceive_generic(so, psa, uio, mp0, controlp,
2456                     flagsp));
2457         }
2458 #endif
2459
2460         /* Easy one, no space to copyout anything. */
2461         if (uio->uio_resid == 0) {
2462                 error = EINVAL;
2463                 goto out;
2464         }
2465         oresid = uio->uio_resid;
2466
2467         /* We will never ever get anything unless we are or were connected. */
2468         if (!(so->so_state & (SS_ISCONNECTED|SS_ISDISCONNECTED))) {
2469                 error = ENOTCONN;
2470                 goto out;
2471         }
2472
2473 restart:
2474         SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2475
2476         /* Abort if socket has reported problems. */
2477         if (so->so_error) {
2478                 if (sbavail(sb) > 0)
2479                         goto deliver;
2480                 if (oresid > uio->uio_resid)
2481                         goto out;
2482                 error = so->so_error;
2483                 if (!(flags & MSG_PEEK))
2484                         so->so_error = 0;
2485                 goto out;
2486         }
2487
2488         /* Door is closed.  Deliver what is left, if any. */
2489         if (sb->sb_state & SBS_CANTRCVMORE) {
2490                 if (sbavail(sb) > 0)
2491                         goto deliver;
2492                 else
2493                         goto out;
2494         }
2495
2496         /* Socket buffer is empty and we shall not block. */
2497         if (sbavail(sb) == 0 &&
2498             ((so->so_state & SS_NBIO) || (flags & (MSG_DONTWAIT|MSG_NBIO)))) {
2499                 error = EAGAIN;
2500                 goto out;
2501         }
2502
2503         /* Socket buffer got some data that we shall deliver now. */
2504         if (sbavail(sb) > 0 && !(flags & MSG_WAITALL) &&
2505             ((so->so_state & SS_NBIO) ||
2506              (flags & (MSG_DONTWAIT|MSG_NBIO)) ||
2507              sbavail(sb) >= sb->sb_lowat ||
2508              sbavail(sb) >= uio->uio_resid ||
2509              sbavail(sb) >= sb->sb_hiwat) ) {
2510                 goto deliver;
2511         }
2512
2513         /* On MSG_WAITALL we must wait until all data or error arrives. */
2514         if ((flags & MSG_WAITALL) &&
2515             (sbavail(sb) >= uio->uio_resid || sbavail(sb) >= sb->sb_hiwat))
2516                 goto deliver;
2517
2518         /*
2519          * Wait and block until (more) data comes in.
2520          * NB: Drops the sockbuf lock during wait.
2521          */
2522         error = sbwait(sb);
2523         if (error)
2524                 goto out;
2525         goto restart;
2526
2527 deliver:
2528         SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2529         KASSERT(sbavail(sb) > 0, ("%s: sockbuf empty", __func__));
2530         KASSERT(sb->sb_mb != NULL, ("%s: sb_mb == NULL", __func__));
2531
2532         /* Statistics. */
2533         if (uio->uio_td)
2534                 uio->uio_td->td_ru.ru_msgrcv++;
2535
2536         /* Fill uio until full or current end of socket buffer is reached. */
2537         len = min(uio->uio_resid, sbavail(sb));
2538         if (mp0 != NULL) {
2539                 /* Dequeue as many mbufs as possible. */
2540                 if (!(flags & MSG_PEEK) && len >= sb->sb_mb->m_len) {
2541                         if (*mp0 == NULL)
2542                                 *mp0 = sb->sb_mb;
2543                         else
2544                                 m_cat(*mp0, sb->sb_mb);
2545                         for (m = sb->sb_mb;
2546                              m != NULL && m->m_len <= len;
2547                              m = m->m_next) {
2548                                 KASSERT(!(m->m_flags & M_NOTAVAIL),
2549                                     ("%s: m %p not available", __func__, m));
2550                                 len -= m->m_len;
2551                                 uio->uio_resid -= m->m_len;
2552                                 sbfree(sb, m);
2553                                 n = m;
2554                         }
2555                         n->m_next = NULL;
2556                         sb->sb_mb = m;
2557                         sb->sb_lastrecord = sb->sb_mb;
2558                         if (sb->sb_mb == NULL)
2559                                 SB_EMPTY_FIXUP(sb);
2560                 }
2561                 /* Copy the remainder. */
2562                 if (len > 0) {
2563                         KASSERT(sb->sb_mb != NULL,
2564                             ("%s: len > 0 && sb->sb_mb empty", __func__));
2565
2566                         m = m_copym(sb->sb_mb, 0, len, M_NOWAIT);
2567                         if (m == NULL)
2568                                 len = 0;        /* Don't flush data from sockbuf. */
2569                         else
2570                                 uio->uio_resid -= len;
2571                         if (*mp0 != NULL)
2572                                 m_cat(*mp0, m);
2573                         else
2574                                 *mp0 = m;
2575                         if (*mp0 == NULL) {
2576                                 error = ENOBUFS;
2577                                 goto out;
2578                         }
2579                 }
2580         } else {
2581                 /* NB: Must unlock socket buffer as uiomove may sleep. */
2582                 SOCKBUF_UNLOCK(sb);
2583                 error = m_mbuftouio(uio, sb->sb_mb, len);
2584                 SOCKBUF_LOCK(sb);
2585                 if (error)
2586                         goto out;
2587         }
2588         SBLASTRECORDCHK(sb);
2589         SBLASTMBUFCHK(sb);
2590
2591         /*
2592          * Remove the delivered data from the socket buffer unless we
2593          * were only peeking.
2594          */
2595         if (!(flags & MSG_PEEK)) {
2596                 if (len > 0)
2597                         sbdrop_locked(sb, len);
2598
2599                 /* Notify protocol that we drained some data. */
2600                 if ((so->so_proto->pr_flags & PR_WANTRCVD) &&
2601                     (((flags & MSG_WAITALL) && uio->uio_resid > 0) ||
2602                      !(flags & MSG_SOCALLBCK))) {
2603                         SOCKBUF_UNLOCK(sb);
2604                         VNET_SO_ASSERT(so);
2605                         (*so->so_proto->pr_usrreqs->pru_rcvd)(so, flags);
2606                         SOCKBUF_LOCK(sb);
2607                 }
2608         }
2609
2610         /*
2611          * For MSG_WAITALL we may have to loop again and wait for
2612          * more data to come in.
2613          */
2614         if ((flags & MSG_WAITALL) && uio->uio_resid > 0)
2615                 goto restart;
2616 out:
2617         SBLASTRECORDCHK(sb);
2618         SBLASTMBUFCHK(sb);
2619         SOCKBUF_UNLOCK(sb);
2620         SOCK_IO_RECV_UNLOCK(so);
2621         return (error);
2622 }
2623
2624 /*
2625  * Optimized version of soreceive() for simple datagram cases from userspace.
2626  * Unlike in the stream case, we're able to drop a datagram if copyout()
2627  * fails, and because we handle datagrams atomically, we don't need to use a
2628  * sleep lock to prevent I/O interlacing.
2629  */
2630 int
2631 soreceive_dgram(struct socket *so, struct sockaddr **psa, struct uio *uio,
2632     struct mbuf **mp0, struct mbuf **controlp, int *flagsp)
2633 {
2634         struct mbuf *m, *m2;
2635         int flags, error;
2636         ssize_t len;
2637         struct protosw *pr = so->so_proto;
2638         struct mbuf *nextrecord;
2639
2640         if (psa != NULL)
2641                 *psa = NULL;
2642         if (controlp != NULL)
2643                 *controlp = NULL;
2644         if (flagsp != NULL)
2645                 flags = *flagsp &~ MSG_EOR;
2646         else
2647                 flags = 0;
2648
2649         /*
2650          * For any complicated cases, fall back to the full
2651          * soreceive_generic().
2652          */
2653         if (mp0 != NULL || (flags & (MSG_PEEK | MSG_OOB | MSG_TRUNC)))
2654                 return (soreceive_generic(so, psa, uio, mp0, controlp,
2655                     flagsp));
2656
2657         /*
2658          * Enforce restrictions on use.
2659          */
2660         KASSERT((pr->pr_flags & PR_WANTRCVD) == 0,
2661             ("soreceive_dgram: wantrcvd"));
2662         KASSERT(pr->pr_flags & PR_ATOMIC, ("soreceive_dgram: !atomic"));
2663         KASSERT((so->so_rcv.sb_state & SBS_RCVATMARK) == 0,
2664             ("soreceive_dgram: SBS_RCVATMARK"));
2665         KASSERT((so->so_proto->pr_flags & PR_CONNREQUIRED) == 0,
2666             ("soreceive_dgram: P_CONNREQUIRED"));
2667
2668         /*
2669          * Loop blocking while waiting for a datagram.
2670          */
2671         SOCKBUF_LOCK(&so->so_rcv);
2672         while ((m = so->so_rcv.sb_mb) == NULL) {
2673                 KASSERT(sbavail(&so->so_rcv) == 0,
2674                     ("soreceive_dgram: sb_mb NULL but sbavail %u",
2675                     sbavail(&so->so_rcv)));
2676                 if (so->so_error) {
2677                         error = so->so_error;
2678                         so->so_error = 0;
2679                         SOCKBUF_UNLOCK(&so->so_rcv);
2680                         return (error);
2681                 }
2682                 if (so->so_rcv.sb_state & SBS_CANTRCVMORE ||
2683                     uio->uio_resid == 0) {
2684                         SOCKBUF_UNLOCK(&so->so_rcv);
2685                         return (0);
2686                 }
2687                 if ((so->so_state & SS_NBIO) ||
2688                     (flags & (MSG_DONTWAIT|MSG_NBIO))) {
2689                         SOCKBUF_UNLOCK(&so->so_rcv);
2690                         return (EWOULDBLOCK);
2691                 }
2692                 SBLASTRECORDCHK(&so->so_rcv);
2693                 SBLASTMBUFCHK(&so->so_rcv);
2694                 error = sbwait(&so->so_rcv);
2695                 if (error) {
2696                         SOCKBUF_UNLOCK(&so->so_rcv);
2697                         return (error);
2698                 }
2699         }
2700         SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2701
2702         if (uio->uio_td)
2703                 uio->uio_td->td_ru.ru_msgrcv++;
2704         SBLASTRECORDCHK(&so->so_rcv);
2705         SBLASTMBUFCHK(&so->so_rcv);
2706         nextrecord = m->m_nextpkt;
2707         if (nextrecord == NULL) {
2708                 KASSERT(so->so_rcv.sb_lastrecord == m,
2709                     ("soreceive_dgram: lastrecord != m"));
2710         }
2711
2712         KASSERT(so->so_rcv.sb_mb->m_nextpkt == nextrecord,
2713             ("soreceive_dgram: m_nextpkt != nextrecord"));
2714
2715         /*
2716          * Pull 'm' and its chain off the front of the packet queue.
2717          */
2718         so->so_rcv.sb_mb = NULL;
2719         sockbuf_pushsync(&so->so_rcv, nextrecord);
2720
2721         /*
2722          * Walk 'm's chain and free that many bytes from the socket buffer.
2723          */
2724         for (m2 = m; m2 != NULL; m2 = m2->m_next)
2725                 sbfree(&so->so_rcv, m2);
2726
2727         /*
2728          * Do a few last checks before we let go of the lock.
2729          */
2730         SBLASTRECORDCHK(&so->so_rcv);
2731         SBLASTMBUFCHK(&so->so_rcv);
2732         SOCKBUF_UNLOCK(&so->so_rcv);
2733
2734         if (pr->pr_flags & PR_ADDR) {
2735                 KASSERT(m->m_type == MT_SONAME,
2736                     ("m->m_type == %d", m->m_type));
2737                 if (psa != NULL)
2738                         *psa = sodupsockaddr(mtod(m, struct sockaddr *),
2739                             M_NOWAIT);
2740                 m = m_free(m);
2741         }
2742         if (m == NULL) {
2743                 /* XXXRW: Can this happen? */
2744                 return (0);
2745         }
2746
2747         /*
2748          * Packet to copyout() is now in 'm' and it is disconnected from the
2749          * queue.
2750          *
2751          * Process one or more MT_CONTROL mbufs present before any data mbufs
2752          * in the first mbuf chain on the socket buffer.  We call into the
2753          * protocol to perform externalization (or freeing if controlp ==
2754          * NULL). In some cases there can be only MT_CONTROL mbufs without
2755          * MT_DATA mbufs.
2756          */
2757         if (m->m_type == MT_CONTROL) {
2758                 struct mbuf *cm = NULL, *cmn;
2759                 struct mbuf **cme = &cm;
2760
2761                 do {
2762                         m2 = m->m_next;
2763                         m->m_next = NULL;
2764                         *cme = m;
2765                         cme = &(*cme)->m_next;
2766                         m = m2;
2767                 } while (m != NULL && m->m_type == MT_CONTROL);
2768                 while (cm != NULL) {
2769                         cmn = cm->m_next;
2770                         cm->m_next = NULL;
2771                         if (pr->pr_domain->dom_externalize != NULL) {
2772                                 error = (*pr->pr_domain->dom_externalize)
2773                                     (cm, controlp, flags);
2774                         } else if (controlp != NULL)
2775                                 *controlp = cm;
2776                         else
2777                                 m_freem(cm);
2778                         if (controlp != NULL) {
2779                                 while (*controlp != NULL)
2780                                         controlp = &(*controlp)->m_next;
2781                         }
2782                         cm = cmn;
2783                 }
2784         }
2785         KASSERT(m == NULL || m->m_type == MT_DATA,
2786             ("soreceive_dgram: !data"));
2787         while (m != NULL && uio->uio_resid > 0) {
2788                 len = uio->uio_resid;
2789                 if (len > m->m_len)
2790                         len = m->m_len;
2791                 error = uiomove(mtod(m, char *), (int)len, uio);
2792                 if (error) {
2793                         m_freem(m);
2794                         return (error);
2795                 }
2796                 if (len == m->m_len)
2797                         m = m_free(m);
2798                 else {
2799                         m->m_data += len;
2800                         m->m_len -= len;
2801                 }
2802         }
2803         if (m != NULL) {
2804                 flags |= MSG_TRUNC;
2805                 m_freem(m);
2806         }
2807         if (flagsp != NULL)
2808                 *flagsp |= flags;
2809         return (0);
2810 }
2811
2812 int
2813 soreceive(struct socket *so, struct sockaddr **psa, struct uio *uio,
2814     struct mbuf **mp0, struct mbuf **controlp, int *flagsp)
2815 {
2816         int error;
2817
2818         CURVNET_SET(so->so_vnet);
2819         if (!SOLISTENING(so))
2820                 error = (so->so_proto->pr_usrreqs->pru_soreceive(so, psa, uio,
2821                     mp0, controlp, flagsp));
2822         else
2823                 error = ENOTCONN;
2824         CURVNET_RESTORE();
2825         return (error);
2826 }
2827
2828 int
2829 soshutdown(struct socket *so, int how)
2830 {
2831         struct protosw *pr = so->so_proto;
2832         int error, soerror_enotconn;
2833
2834         if (!(how == SHUT_RD || how == SHUT_WR || how == SHUT_RDWR))
2835                 return (EINVAL);
2836
2837         soerror_enotconn = 0;
2838         if ((so->so_state &
2839             (SS_ISCONNECTED | SS_ISCONNECTING | SS_ISDISCONNECTING)) == 0) {
2840                 /*
2841                  * POSIX mandates us to return ENOTCONN when shutdown(2) is
2842                  * invoked on a datagram sockets, however historically we would
2843                  * actually tear socket down. This is known to be leveraged by
2844                  * some applications to unblock process waiting in recvXXX(2)
2845                  * by other process that it shares that socket with. Try to meet
2846                  * both backward-compatibility and POSIX requirements by forcing
2847                  * ENOTCONN but still asking protocol to perform pru_shutdown().
2848                  */
2849                 if (so->so_type != SOCK_DGRAM && !SOLISTENING(so))
2850                         return (ENOTCONN);
2851                 soerror_enotconn = 1;
2852         }
2853
2854         if (SOLISTENING(so)) {
2855                 if (how != SHUT_WR) {
2856                         SOLISTEN_LOCK(so);
2857                         so->so_error = ECONNABORTED;
2858                         solisten_wakeup(so);    /* unlocks so */
2859                 }
2860                 goto done;
2861         }
2862
2863         CURVNET_SET(so->so_vnet);
2864         if (pr->pr_usrreqs->pru_flush != NULL)
2865                 (*pr->pr_usrreqs->pru_flush)(so, how);
2866         if (how != SHUT_WR)
2867                 sorflush(so);
2868         if (how != SHUT_RD) {
2869                 error = (*pr->pr_usrreqs->pru_shutdown)(so);
2870                 wakeup(&so->so_timeo);
2871                 CURVNET_RESTORE();
2872                 return ((error == 0 && soerror_enotconn) ? ENOTCONN : error);
2873         }
2874         wakeup(&so->so_timeo);
2875         CURVNET_RESTORE();
2876
2877 done:
2878         return (soerror_enotconn ? ENOTCONN : 0);
2879 }
2880
2881 void
2882 sorflush(struct socket *so)
2883 {
2884         struct sockbuf *sb = &so->so_rcv;
2885         struct protosw *pr = so->so_proto;
2886         struct socket aso;
2887         int error;
2888
2889         VNET_SO_ASSERT(so);
2890
2891         /*
2892          * In order to avoid calling dom_dispose with the socket buffer mutex
2893          * held, and in order to generally avoid holding the lock for a long
2894          * time, we make a copy of the socket buffer and clear the original
2895          * (except locks, state).  The new socket buffer copy won't have
2896          * initialized locks so we can only call routines that won't use or
2897          * assert those locks.
2898          *
2899          * Dislodge threads currently blocked in receive and wait to acquire
2900          * a lock against other simultaneous readers before clearing the
2901          * socket buffer.  Don't let our acquire be interrupted by a signal
2902          * despite any existing socket disposition on interruptable waiting.
2903          */
2904         socantrcvmore(so);
2905         error = SOCK_IO_RECV_LOCK(so, SBL_WAIT | SBL_NOINTR);
2906         KASSERT(error == 0, ("%s: cannot lock sock %p recv buffer",
2907             __func__, so));
2908
2909         /*
2910          * Invalidate/clear most of the sockbuf structure, but leave selinfo
2911          * and mutex data unchanged.
2912          */
2913         SOCKBUF_LOCK(sb);
2914         bzero(&aso, sizeof(aso));
2915         aso.so_pcb = so->so_pcb;
2916         bcopy(&sb->sb_startzero, &aso.so_rcv.sb_startzero,
2917             sizeof(*sb) - offsetof(struct sockbuf, sb_startzero));
2918         bzero(&sb->sb_startzero,
2919             sizeof(*sb) - offsetof(struct sockbuf, sb_startzero));
2920         SOCKBUF_UNLOCK(sb);
2921         SOCK_IO_RECV_UNLOCK(so);
2922
2923         /*
2924          * Dispose of special rights and flush the copied socket.  Don't call
2925          * any unsafe routines (that rely on locks being initialized) on aso.
2926          */
2927         if (pr->pr_flags & PR_RIGHTS && pr->pr_domain->dom_dispose != NULL)
2928                 (*pr->pr_domain->dom_dispose)(&aso);
2929         sbrelease_internal(&aso.so_rcv, so);
2930 }
2931
2932 /*
2933  * Wrapper for Socket established helper hook.
2934  * Parameters: socket, context of the hook point, hook id.
2935  */
2936 static int inline
2937 hhook_run_socket(struct socket *so, void *hctx, int32_t h_id)
2938 {
2939         struct socket_hhook_data hhook_data = {
2940                 .so = so,
2941                 .hctx = hctx,
2942                 .m = NULL,
2943                 .status = 0
2944         };
2945
2946         CURVNET_SET(so->so_vnet);
2947         HHOOKS_RUN_IF(V_socket_hhh[h_id], &hhook_data, &so->osd);
2948         CURVNET_RESTORE();
2949
2950         /* Ugly but needed, since hhooks return void for now */
2951         return (hhook_data.status);
2952 }
2953
2954 /*
2955  * Perhaps this routine, and sooptcopyout(), below, ought to come in an
2956  * additional variant to handle the case where the option value needs to be
2957  * some kind of integer, but not a specific size.  In addition to their use
2958  * here, these functions are also called by the protocol-level pr_ctloutput()
2959  * routines.
2960  */
2961 int
2962 sooptcopyin(struct sockopt *sopt, void *buf, size_t len, size_t minlen)
2963 {
2964         size_t  valsize;
2965
2966         /*
2967          * If the user gives us more than we wanted, we ignore it, but if we
2968          * don't get the minimum length the caller wants, we return EINVAL.
2969          * On success, sopt->sopt_valsize is set to however much we actually
2970          * retrieved.
2971          */
2972         if ((valsize = sopt->sopt_valsize) < minlen)
2973                 return EINVAL;
2974         if (valsize > len)
2975                 sopt->sopt_valsize = valsize = len;
2976
2977         if (sopt->sopt_td != NULL)
2978                 return (copyin(sopt->sopt_val, buf, valsize));
2979
2980         bcopy(sopt->sopt_val, buf, valsize);
2981         return (0);
2982 }
2983
2984 u_long nl_maxsockbuf = 512 * 1024 * 1024; /* 512M, XXX: init based on physmem */
2985
2986 u_long
2987 sogetmaxbuf(struct socket *so)
2988 {
2989         if (so->so_proto->pr_domain->dom_family != PF_NETLINK)
2990                 return (sb_max);
2991         return ((priv_check(curthread, PRIV_NET_ROUTE) == 0) ? nl_maxsockbuf : sb_max);
2992 }
2993
2994 /*
2995  * Kernel version of setsockopt(2).
2996  *
2997  * XXX: optlen is size_t, not socklen_t
2998  */
2999 int
3000 so_setsockopt(struct socket *so, int level, int optname, void *optval,
3001     size_t optlen)
3002 {
3003         struct sockopt sopt;
3004
3005         sopt.sopt_level = level;
3006         sopt.sopt_name = optname;
3007         sopt.sopt_dir = SOPT_SET;
3008         sopt.sopt_val = optval;
3009         sopt.sopt_valsize = optlen;
3010         sopt.sopt_td = NULL;
3011         return (sosetopt(so, &sopt));
3012 }
3013
3014 int
3015 sosetopt(struct socket *so, struct sockopt *sopt)
3016 {
3017         int     error, optval;
3018         struct  linger l;
3019         struct  timeval tv;
3020         sbintime_t val, *valp;
3021         uint32_t val32;
3022 #ifdef MAC
3023         struct mac extmac;
3024 #endif
3025
3026         CURVNET_SET(so->so_vnet);
3027         error = 0;
3028         if (sopt->sopt_level != SOL_SOCKET) {
3029                 if (so->so_proto->pr_ctloutput != NULL)
3030                         error = (*so->so_proto->pr_ctloutput)(so, sopt);
3031                 else
3032                         error = ENOPROTOOPT;
3033         } else {
3034                 switch (sopt->sopt_name) {
3035                 case SO_ACCEPTFILTER:
3036                         error = accept_filt_setopt(so, sopt);
3037                         if (error)
3038                                 goto bad;
3039                         break;
3040
3041                 case SO_LINGER:
3042                         error = sooptcopyin(sopt, &l, sizeof l, sizeof l);
3043                         if (error)
3044                                 goto bad;
3045                         if (l.l_linger < 0 ||
3046                             l.l_linger > USHRT_MAX ||
3047                             l.l_linger > (INT_MAX / hz)) {
3048                                 error = EDOM;
3049                                 goto bad;
3050                         }
3051                         SOCK_LOCK(so);
3052                         so->so_linger = l.l_linger;
3053                         if (l.l_onoff)
3054                                 so->so_options |= SO_LINGER;
3055                         else
3056                                 so->so_options &= ~SO_LINGER;
3057                         SOCK_UNLOCK(so);
3058                         break;
3059
3060                 case SO_DEBUG:
3061                 case SO_KEEPALIVE:
3062                 case SO_DONTROUTE:
3063                 case SO_USELOOPBACK:
3064                 case SO_BROADCAST:
3065                 case SO_REUSEADDR:
3066                 case SO_REUSEPORT:
3067                 case SO_REUSEPORT_LB:
3068                 case SO_OOBINLINE:
3069                 case SO_TIMESTAMP:
3070                 case SO_BINTIME:
3071                 case SO_NOSIGPIPE:
3072                 case SO_NO_DDP:
3073                 case SO_NO_OFFLOAD:
3074                 case SO_RERROR:
3075                         error = sooptcopyin(sopt, &optval, sizeof optval,
3076                             sizeof optval);
3077                         if (error)
3078                                 goto bad;
3079                         SOCK_LOCK(so);
3080                         if (optval)
3081                                 so->so_options |= sopt->sopt_name;
3082                         else
3083                                 so->so_options &= ~sopt->sopt_name;
3084                         SOCK_UNLOCK(so);
3085                         break;
3086
3087                 case SO_SETFIB:
3088                         error = sooptcopyin(sopt, &optval, sizeof optval,
3089                             sizeof optval);
3090                         if (error)
3091                                 goto bad;
3092
3093                         if (optval < 0 || optval >= rt_numfibs) {
3094                                 error = EINVAL;
3095                                 goto bad;
3096                         }
3097                         if (((so->so_proto->pr_domain->dom_family == PF_INET) ||
3098                            (so->so_proto->pr_domain->dom_family == PF_INET6) ||
3099                            (so->so_proto->pr_domain->dom_family == PF_ROUTE)))
3100                                 so->so_fibnum = optval;
3101                         else
3102                                 so->so_fibnum = 0;
3103                         break;
3104
3105                 case SO_USER_COOKIE:
3106                         error = sooptcopyin(sopt, &val32, sizeof val32,
3107                             sizeof val32);
3108                         if (error)
3109                                 goto bad;
3110                         so->so_user_cookie = val32;
3111                         break;
3112
3113                 case SO_SNDBUF:
3114                 case SO_RCVBUF:
3115                 case SO_SNDLOWAT:
3116                 case SO_RCVLOWAT:
3117                         error = sooptcopyin(sopt, &optval, sizeof optval,
3118                             sizeof optval);
3119                         if (error)
3120                                 goto bad;
3121
3122                         /*
3123                          * Values < 1 make no sense for any of these options,
3124                          * so disallow them.
3125                          */
3126                         if (optval < 1) {
3127                                 error = EINVAL;
3128                                 goto bad;
3129                         }
3130
3131                         error = sbsetopt(so, sopt->sopt_name, optval);
3132                         break;
3133
3134                 case SO_SNDTIMEO:
3135                 case SO_RCVTIMEO:
3136 #ifdef COMPAT_FREEBSD32
3137                         if (SV_CURPROC_FLAG(SV_ILP32)) {
3138                                 struct timeval32 tv32;
3139
3140                                 error = sooptcopyin(sopt, &tv32, sizeof tv32,
3141                                     sizeof tv32);
3142                                 CP(tv32, tv, tv_sec);
3143                                 CP(tv32, tv, tv_usec);
3144                         } else
3145 #endif
3146                                 error = sooptcopyin(sopt, &tv, sizeof tv,
3147                                     sizeof tv);
3148                         if (error)
3149                                 goto bad;
3150                         if (tv.tv_sec < 0 || tv.tv_usec < 0 ||
3151                             tv.tv_usec >= 1000000) {
3152                                 error = EDOM;
3153                                 goto bad;
3154                         }
3155                         if (tv.tv_sec > INT32_MAX)
3156                                 val = SBT_MAX;
3157                         else
3158                                 val = tvtosbt(tv);
3159                         SOCK_LOCK(so);
3160                         valp = sopt->sopt_name == SO_SNDTIMEO ?
3161                             (SOLISTENING(so) ? &so->sol_sbsnd_timeo :
3162                             &so->so_snd.sb_timeo) :
3163                             (SOLISTENING(so) ? &so->sol_sbrcv_timeo :
3164                             &so->so_rcv.sb_timeo);
3165                         *valp = val;
3166                         SOCK_UNLOCK(so);
3167                         break;
3168
3169                 case SO_LABEL:
3170 #ifdef MAC
3171                         error = sooptcopyin(sopt, &extmac, sizeof extmac,
3172                             sizeof extmac);
3173                         if (error)
3174                                 goto bad;
3175                         error = mac_setsockopt_label(sopt->sopt_td->td_ucred,
3176                             so, &extmac);
3177 #else
3178                         error = EOPNOTSUPP;
3179 #endif
3180                         break;
3181
3182                 case SO_TS_CLOCK:
3183                         error = sooptcopyin(sopt, &optval, sizeof optval,
3184                             sizeof optval);
3185                         if (error)
3186                                 goto bad;
3187                         if (optval < 0 || optval > SO_TS_CLOCK_MAX) {
3188                                 error = EINVAL;
3189                                 goto bad;
3190                         }
3191                         so->so_ts_clock = optval;
3192                         break;
3193
3194                 case SO_MAX_PACING_RATE:
3195                         error = sooptcopyin(sopt, &val32, sizeof(val32),
3196                             sizeof(val32));
3197                         if (error)
3198                                 goto bad;
3199                         so->so_max_pacing_rate = val32;
3200                         break;
3201
3202                 default:
3203                         if (V_socket_hhh[HHOOK_SOCKET_OPT]->hhh_nhooks > 0)
3204                                 error = hhook_run_socket(so, sopt,
3205                                     HHOOK_SOCKET_OPT);
3206                         else
3207                                 error = ENOPROTOOPT;
3208                         break;
3209                 }
3210                 if (error == 0 && so->so_proto->pr_ctloutput != NULL)
3211                         (void)(*so->so_proto->pr_ctloutput)(so, sopt);
3212         }
3213 bad:
3214         CURVNET_RESTORE();
3215         return (error);
3216 }
3217
3218 /*
3219  * Helper routine for getsockopt.
3220  */
3221 int
3222 sooptcopyout(struct sockopt *sopt, const void *buf, size_t len)
3223 {
3224         int     error;
3225         size_t  valsize;
3226
3227         error = 0;
3228
3229         /*
3230          * Documented get behavior is that we always return a value, possibly
3231          * truncated to fit in the user's buffer.  Traditional behavior is
3232          * that we always tell the user precisely how much we copied, rather
3233          * than something useful like the total amount we had available for
3234          * her.  Note that this interface is not idempotent; the entire
3235          * answer must be generated ahead of time.
3236          */
3237         valsize = min(len, sopt->sopt_valsize);
3238         sopt->sopt_valsize = valsize;
3239         if (sopt->sopt_val != NULL) {
3240                 if (sopt->sopt_td != NULL)
3241                         error = copyout(buf, sopt->sopt_val, valsize);
3242                 else
3243                         bcopy(buf, sopt->sopt_val, valsize);
3244         }
3245         return (error);
3246 }
3247
3248 int
3249 sogetopt(struct socket *so, struct sockopt *sopt)
3250 {
3251         int     error, optval;
3252         struct  linger l;
3253         struct  timeval tv;
3254 #ifdef MAC
3255         struct mac extmac;
3256 #endif
3257
3258         CURVNET_SET(so->so_vnet);
3259         error = 0;
3260         if (sopt->sopt_level != SOL_SOCKET) {
3261                 if (so->so_proto->pr_ctloutput != NULL)
3262                         error = (*so->so_proto->pr_ctloutput)(so, sopt);
3263                 else
3264                         error = ENOPROTOOPT;
3265                 CURVNET_RESTORE();
3266                 return (error);
3267         } else {
3268                 switch (sopt->sopt_name) {
3269                 case SO_ACCEPTFILTER:
3270                         error = accept_filt_getopt(so, sopt);
3271                         break;
3272
3273                 case SO_LINGER:
3274                         SOCK_LOCK(so);
3275                         l.l_onoff = so->so_options & SO_LINGER;
3276                         l.l_linger = so->so_linger;
3277                         SOCK_UNLOCK(so);
3278                         error = sooptcopyout(sopt, &l, sizeof l);
3279                         break;
3280
3281                 case SO_USELOOPBACK:
3282                 case SO_DONTROUTE:
3283                 case SO_DEBUG:
3284                 case SO_KEEPALIVE:
3285                 case SO_REUSEADDR:
3286                 case SO_REUSEPORT:
3287                 case SO_REUSEPORT_LB:
3288                 case SO_BROADCAST:
3289                 case SO_OOBINLINE:
3290                 case SO_ACCEPTCONN:
3291                 case SO_TIMESTAMP:
3292                 case SO_BINTIME:
3293                 case SO_NOSIGPIPE:
3294                 case SO_NO_DDP:
3295                 case SO_NO_OFFLOAD:
3296                 case SO_RERROR:
3297                         optval = so->so_options & sopt->sopt_name;
3298 integer:
3299                         error = sooptcopyout(sopt, &optval, sizeof optval);
3300                         break;
3301
3302                 case SO_DOMAIN:
3303                         optval = so->so_proto->pr_domain->dom_family;
3304                         goto integer;
3305
3306                 case SO_TYPE:
3307                         optval = so->so_type;
3308                         goto integer;
3309
3310                 case SO_PROTOCOL:
3311                         optval = so->so_proto->pr_protocol;
3312                         goto integer;
3313
3314                 case SO_ERROR:
3315                         SOCK_LOCK(so);
3316                         if (so->so_error) {
3317                                 optval = so->so_error;
3318                                 so->so_error = 0;
3319                         } else {
3320                                 optval = so->so_rerror;
3321                                 so->so_rerror = 0;
3322                         }
3323                         SOCK_UNLOCK(so);
3324                         goto integer;
3325
3326                 case SO_SNDBUF:
3327                         optval = SOLISTENING(so) ? so->sol_sbsnd_hiwat :
3328                             so->so_snd.sb_hiwat;
3329                         goto integer;
3330
3331                 case SO_RCVBUF:
3332                         optval = SOLISTENING(so) ? so->sol_sbrcv_hiwat :
3333                             so->so_rcv.sb_hiwat;
3334                         goto integer;
3335
3336                 case SO_SNDLOWAT:
3337                         optval = SOLISTENING(so) ? so->sol_sbsnd_lowat :
3338                             so->so_snd.sb_lowat;
3339                         goto integer;
3340
3341                 case SO_RCVLOWAT:
3342                         optval = SOLISTENING(so) ? so->sol_sbrcv_lowat :
3343                             so->so_rcv.sb_lowat;
3344                         goto integer;
3345
3346                 case SO_SNDTIMEO:
3347                 case SO_RCVTIMEO:
3348                         SOCK_LOCK(so);
3349                         tv = sbttotv(sopt->sopt_name == SO_SNDTIMEO ?
3350                             (SOLISTENING(so) ? so->sol_sbsnd_timeo :
3351                             so->so_snd.sb_timeo) :
3352                             (SOLISTENING(so) ? so->sol_sbrcv_timeo :
3353                             so->so_rcv.sb_timeo));
3354                         SOCK_UNLOCK(so);
3355 #ifdef COMPAT_FREEBSD32
3356                         if (SV_CURPROC_FLAG(SV_ILP32)) {
3357                                 struct timeval32 tv32;
3358
3359                                 CP(tv, tv32, tv_sec);
3360                                 CP(tv, tv32, tv_usec);
3361                                 error = sooptcopyout(sopt, &tv32, sizeof tv32);
3362                         } else
3363 #endif
3364                                 error = sooptcopyout(sopt, &tv, sizeof tv);
3365                         break;
3366
3367                 case SO_LABEL:
3368 #ifdef MAC
3369                         error = sooptcopyin(sopt, &extmac, sizeof(extmac),
3370                             sizeof(extmac));
3371                         if (error)
3372                                 goto bad;
3373                         error = mac_getsockopt_label(sopt->sopt_td->td_ucred,
3374                             so, &extmac);
3375                         if (error)
3376                                 goto bad;
3377                         error = sooptcopyout(sopt, &extmac, sizeof extmac);
3378 #else
3379                         error = EOPNOTSUPP;
3380 #endif
3381                         break;
3382
3383                 case SO_PEERLABEL:
3384 #ifdef MAC
3385                         error = sooptcopyin(sopt, &extmac, sizeof(extmac),
3386                             sizeof(extmac));
3387                         if (error)
3388                                 goto bad;
3389                         error = mac_getsockopt_peerlabel(
3390                             sopt->sopt_td->td_ucred, so, &extmac);
3391                         if (error)
3392                                 goto bad;
3393                         error = sooptcopyout(sopt, &extmac, sizeof extmac);
3394 #else
3395                         error = EOPNOTSUPP;
3396 #endif
3397                         break;
3398
3399                 case SO_LISTENQLIMIT:
3400                         optval = SOLISTENING(so) ? so->sol_qlimit : 0;
3401                         goto integer;
3402
3403                 case SO_LISTENQLEN:
3404                         optval = SOLISTENING(so) ? so->sol_qlen : 0;
3405                         goto integer;
3406
3407                 case SO_LISTENINCQLEN:
3408                         optval = SOLISTENING(so) ? so->sol_incqlen : 0;
3409                         goto integer;
3410
3411                 case SO_TS_CLOCK:
3412                         optval = so->so_ts_clock;
3413                         goto integer;
3414
3415                 case SO_MAX_PACING_RATE:
3416                         optval = so->so_max_pacing_rate;
3417                         goto integer;
3418
3419                 default:
3420                         if (V_socket_hhh[HHOOK_SOCKET_OPT]->hhh_nhooks > 0)
3421                                 error = hhook_run_socket(so, sopt,
3422                                     HHOOK_SOCKET_OPT);
3423                         else
3424                                 error = ENOPROTOOPT;
3425                         break;
3426                 }
3427         }
3428 #ifdef MAC
3429 bad:
3430 #endif
3431         CURVNET_RESTORE();
3432         return (error);
3433 }
3434
3435 int
3436 soopt_getm(struct sockopt *sopt, struct mbuf **mp)
3437 {
3438         struct mbuf *m, *m_prev;
3439         int sopt_size = sopt->sopt_valsize;
3440
3441         MGET(m, sopt->sopt_td ? M_WAITOK : M_NOWAIT, MT_DATA);
3442         if (m == NULL)
3443                 return ENOBUFS;
3444         if (sopt_size > MLEN) {
3445                 MCLGET(m, sopt->sopt_td ? M_WAITOK : M_NOWAIT);
3446                 if ((m->m_flags & M_EXT) == 0) {
3447                         m_free(m);
3448                         return ENOBUFS;
3449                 }
3450                 m->m_len = min(MCLBYTES, sopt_size);
3451         } else {
3452                 m->m_len = min(MLEN, sopt_size);
3453         }
3454         sopt_size -= m->m_len;
3455         *mp = m;
3456         m_prev = m;
3457
3458         while (sopt_size) {
3459                 MGET(m, sopt->sopt_td ? M_WAITOK : M_NOWAIT, MT_DATA);
3460                 if (m == NULL) {
3461                         m_freem(*mp);
3462                         return ENOBUFS;
3463                 }
3464                 if (sopt_size > MLEN) {
3465                         MCLGET(m, sopt->sopt_td != NULL ? M_WAITOK :
3466                             M_NOWAIT);
3467                         if ((m->m_flags & M_EXT) == 0) {
3468                                 m_freem(m);
3469                                 m_freem(*mp);
3470                                 return ENOBUFS;
3471                         }
3472                         m->m_len = min(MCLBYTES, sopt_size);
3473                 } else {
3474                         m->m_len = min(MLEN, sopt_size);
3475                 }
3476                 sopt_size -= m->m_len;
3477                 m_prev->m_next = m;
3478                 m_prev = m;
3479         }
3480         return (0);
3481 }
3482
3483 int
3484 soopt_mcopyin(struct sockopt *sopt, struct mbuf *m)
3485 {
3486         struct mbuf *m0 = m;
3487
3488         if (sopt->sopt_val == NULL)
3489                 return (0);
3490         while (m != NULL && sopt->sopt_valsize >= m->m_len) {
3491                 if (sopt->sopt_td != NULL) {
3492                         int error;
3493
3494                         error = copyin(sopt->sopt_val, mtod(m, char *),
3495                             m->m_len);
3496                         if (error != 0) {
3497                                 m_freem(m0);
3498                                 return(error);
3499                         }
3500                 } else
3501                         bcopy(sopt->sopt_val, mtod(m, char *), m->m_len);
3502                 sopt->sopt_valsize -= m->m_len;
3503                 sopt->sopt_val = (char *)sopt->sopt_val + m->m_len;
3504                 m = m->m_next;
3505         }
3506         if (m != NULL) /* should be allocated enoughly at ip6_sooptmcopyin() */
3507                 panic("ip6_sooptmcopyin");
3508         return (0);
3509 }
3510
3511 int
3512 soopt_mcopyout(struct sockopt *sopt, struct mbuf *m)
3513 {
3514         struct mbuf *m0 = m;
3515         size_t valsize = 0;
3516
3517         if (sopt->sopt_val == NULL)
3518                 return (0);
3519         while (m != NULL && sopt->sopt_valsize >= m->m_len) {
3520                 if (sopt->sopt_td != NULL) {
3521                         int error;
3522
3523                         error = copyout(mtod(m, char *), sopt->sopt_val,
3524                             m->m_len);
3525                         if (error != 0) {
3526                                 m_freem(m0);
3527                                 return(error);
3528                         }
3529                 } else
3530                         bcopy(mtod(m, char *), sopt->sopt_val, m->m_len);
3531                 sopt->sopt_valsize -= m->m_len;
3532                 sopt->sopt_val = (char *)sopt->sopt_val + m->m_len;
3533                 valsize += m->m_len;
3534                 m = m->m_next;
3535         }
3536         if (m != NULL) {
3537                 /* enough soopt buffer should be given from user-land */
3538                 m_freem(m0);
3539                 return(EINVAL);
3540         }
3541         sopt->sopt_valsize = valsize;
3542         return (0);
3543 }
3544
3545 /*
3546  * sohasoutofband(): protocol notifies socket layer of the arrival of new
3547  * out-of-band data, which will then notify socket consumers.
3548  */
3549 void
3550 sohasoutofband(struct socket *so)
3551 {
3552
3553         if (so->so_sigio != NULL)
3554                 pgsigio(&so->so_sigio, SIGURG, 0);
3555         selwakeuppri(&so->so_rdsel, PSOCK);
3556 }
3557
3558 int
3559 sopoll(struct socket *so, int events, struct ucred *active_cred,
3560     struct thread *td)
3561 {
3562
3563         /*
3564          * We do not need to set or assert curvnet as long as everyone uses
3565          * sopoll_generic().
3566          */
3567         return (so->so_proto->pr_usrreqs->pru_sopoll(so, events, active_cred,
3568             td));
3569 }
3570
3571 int
3572 sopoll_generic(struct socket *so, int events, struct ucred *active_cred,
3573     struct thread *td)
3574 {
3575         int revents;
3576
3577         SOCK_LOCK(so);
3578         if (SOLISTENING(so)) {
3579                 if (!(events & (POLLIN | POLLRDNORM)))
3580                         revents = 0;
3581                 else if (!TAILQ_EMPTY(&so->sol_comp))
3582                         revents = events & (POLLIN | POLLRDNORM);
3583                 else if ((events & POLLINIGNEOF) == 0 && so->so_error)
3584                         revents = (events & (POLLIN | POLLRDNORM)) | POLLHUP;
3585                 else {
3586                         selrecord(td, &so->so_rdsel);
3587                         revents = 0;
3588                 }
3589         } else {
3590                 revents = 0;
3591                 SOCKBUF_LOCK(&so->so_snd);
3592                 SOCKBUF_LOCK(&so->so_rcv);
3593                 if (events & (POLLIN | POLLRDNORM))
3594                         if (soreadabledata(so))
3595                                 revents |= events & (POLLIN | POLLRDNORM);
3596                 if (events & (POLLOUT | POLLWRNORM))
3597                         if (sowriteable(so))
3598                                 revents |= events & (POLLOUT | POLLWRNORM);
3599                 if (events & (POLLPRI | POLLRDBAND))
3600                         if (so->so_oobmark ||
3601                             (so->so_rcv.sb_state & SBS_RCVATMARK))
3602                                 revents |= events & (POLLPRI | POLLRDBAND);
3603                 if ((events & POLLINIGNEOF) == 0) {
3604                         if (so->so_rcv.sb_state & SBS_CANTRCVMORE) {
3605                                 revents |= events & (POLLIN | POLLRDNORM);
3606                                 if (so->so_snd.sb_state & SBS_CANTSENDMORE)
3607                                         revents |= POLLHUP;
3608                         }
3609                 }
3610                 if (so->so_rcv.sb_state & SBS_CANTRCVMORE)
3611                         revents |= events & POLLRDHUP;
3612                 if (revents == 0) {
3613                         if (events &
3614                             (POLLIN | POLLPRI | POLLRDNORM | POLLRDBAND | POLLRDHUP)) {
3615                                 selrecord(td, &so->so_rdsel);
3616                                 so->so_rcv.sb_flags |= SB_SEL;
3617                         }
3618                         if (events & (POLLOUT | POLLWRNORM)) {
3619                                 selrecord(td, &so->so_wrsel);
3620                                 so->so_snd.sb_flags |= SB_SEL;
3621                         }
3622                 }
3623                 SOCKBUF_UNLOCK(&so->so_rcv);
3624                 SOCKBUF_UNLOCK(&so->so_snd);
3625         }
3626         SOCK_UNLOCK(so);
3627         return (revents);
3628 }
3629
3630 int
3631 soo_kqfilter(struct file *fp, struct knote *kn)
3632 {
3633         struct socket *so = kn->kn_fp->f_data;
3634         struct sockbuf *sb;
3635         struct knlist *knl;
3636
3637         switch (kn->kn_filter) {
3638         case EVFILT_READ:
3639                 kn->kn_fop = &soread_filtops;
3640                 knl = &so->so_rdsel.si_note;
3641                 sb = &so->so_rcv;
3642                 break;
3643         case EVFILT_WRITE:
3644                 kn->kn_fop = &sowrite_filtops;
3645                 knl = &so->so_wrsel.si_note;
3646                 sb = &so->so_snd;
3647                 break;
3648         case EVFILT_EMPTY:
3649                 kn->kn_fop = &soempty_filtops;
3650                 knl = &so->so_wrsel.si_note;
3651                 sb = &so->so_snd;
3652                 break;
3653         default:
3654                 return (EINVAL);
3655         }
3656
3657         SOCK_LOCK(so);
3658         if (SOLISTENING(so)) {
3659                 knlist_add(knl, kn, 1);
3660         } else {
3661                 SOCKBUF_LOCK(sb);
3662                 knlist_add(knl, kn, 1);
3663                 sb->sb_flags |= SB_KNOTE;
3664                 SOCKBUF_UNLOCK(sb);
3665         }
3666         SOCK_UNLOCK(so);
3667         return (0);
3668 }
3669
3670 /*
3671  * Some routines that return EOPNOTSUPP for entry points that are not
3672  * supported by a protocol.  Fill in as needed.
3673  */
3674 int
3675 pru_accept_notsupp(struct socket *so, struct sockaddr **nam)
3676 {
3677
3678         return EOPNOTSUPP;
3679 }
3680
3681 int
3682 pru_aio_queue_notsupp(struct socket *so, struct kaiocb *job)
3683 {
3684
3685         return EOPNOTSUPP;
3686 }
3687
3688 int
3689 pru_attach_notsupp(struct socket *so, int proto, struct thread *td)
3690 {
3691
3692         return EOPNOTSUPP;
3693 }
3694
3695 int
3696 pru_bind_notsupp(struct socket *so, struct sockaddr *nam, struct thread *td)
3697 {
3698
3699         return EOPNOTSUPP;
3700 }
3701
3702 int
3703 pru_bindat_notsupp(int fd, struct socket *so, struct sockaddr *nam,
3704     struct thread *td)
3705 {
3706
3707         return EOPNOTSUPP;
3708 }
3709
3710 int
3711 pru_connect_notsupp(struct socket *so, struct sockaddr *nam, struct thread *td)
3712 {
3713
3714         return EOPNOTSUPP;
3715 }
3716
3717 int
3718 pru_connectat_notsupp(int fd, struct socket *so, struct sockaddr *nam,
3719     struct thread *td)
3720 {
3721
3722         return EOPNOTSUPP;
3723 }
3724
3725 int
3726 pru_connect2_notsupp(struct socket *so1, struct socket *so2)
3727 {
3728
3729         return EOPNOTSUPP;
3730 }
3731
3732 int
3733 pru_control_notsupp(struct socket *so, u_long cmd, caddr_t data,
3734     struct ifnet *ifp, struct thread *td)
3735 {
3736
3737         return EOPNOTSUPP;
3738 }
3739
3740 int
3741 pru_disconnect_notsupp(struct socket *so)
3742 {
3743
3744         return EOPNOTSUPP;
3745 }
3746
3747 int
3748 pru_listen_notsupp(struct socket *so, int backlog, struct thread *td)
3749 {
3750
3751         return EOPNOTSUPP;
3752 }
3753
3754 int
3755 pru_peeraddr_notsupp(struct socket *so, struct sockaddr **nam)
3756 {
3757
3758         return EOPNOTSUPP;
3759 }
3760
3761 int
3762 pru_rcvd_notsupp(struct socket *so, int flags)
3763 {
3764
3765         return EOPNOTSUPP;
3766 }
3767
3768 int
3769 pru_rcvoob_notsupp(struct socket *so, struct mbuf *m, int flags)
3770 {
3771
3772         return EOPNOTSUPP;
3773 }
3774
3775 int
3776 pru_send_notsupp(struct socket *so, int flags, struct mbuf *m,
3777     struct sockaddr *addr, struct mbuf *control, struct thread *td)
3778 {
3779
3780         if (control != NULL)
3781                 m_freem(control);
3782         if ((flags & PRUS_NOTREADY) == 0)
3783                 m_freem(m);
3784         return (EOPNOTSUPP);
3785 }
3786
3787 int
3788 pru_ready_notsupp(struct socket *so, struct mbuf *m, int count)
3789 {
3790
3791         return (EOPNOTSUPP);
3792 }
3793
3794 /*
3795  * This isn't really a ``null'' operation, but it's the default one and
3796  * doesn't do anything destructive.
3797  */
3798 int
3799 pru_sense_null(struct socket *so, struct stat *sb)
3800 {
3801
3802         sb->st_blksize = so->so_snd.sb_hiwat;
3803         return 0;
3804 }
3805
3806 int
3807 pru_shutdown_notsupp(struct socket *so)
3808 {
3809
3810         return EOPNOTSUPP;
3811 }
3812
3813 int
3814 pru_sockaddr_notsupp(struct socket *so, struct sockaddr **nam)
3815 {
3816
3817         return EOPNOTSUPP;
3818 }
3819
3820 int
3821 pru_sosend_notsupp(struct socket *so, struct sockaddr *addr, struct uio *uio,
3822     struct mbuf *top, struct mbuf *control, int flags, struct thread *td)
3823 {
3824
3825         return EOPNOTSUPP;
3826 }
3827
3828 int
3829 pru_soreceive_notsupp(struct socket *so, struct sockaddr **paddr,
3830     struct uio *uio, struct mbuf **mp0, struct mbuf **controlp, int *flagsp)
3831 {
3832
3833         return EOPNOTSUPP;
3834 }
3835
3836 int
3837 pru_sopoll_notsupp(struct socket *so, int events, struct ucred *cred,
3838     struct thread *td)
3839 {
3840
3841         return EOPNOTSUPP;
3842 }
3843
3844 static void
3845 filt_sordetach(struct knote *kn)
3846 {
3847         struct socket *so = kn->kn_fp->f_data;
3848
3849         so_rdknl_lock(so);
3850         knlist_remove(&so->so_rdsel.si_note, kn, 1);
3851         if (!SOLISTENING(so) && knlist_empty(&so->so_rdsel.si_note))
3852                 so->so_rcv.sb_flags &= ~SB_KNOTE;
3853         so_rdknl_unlock(so);
3854 }
3855
3856 /*ARGSUSED*/
3857 static int
3858 filt_soread(struct knote *kn, long hint)
3859 {
3860         struct socket *so;
3861
3862         so = kn->kn_fp->f_data;
3863
3864         if (SOLISTENING(so)) {
3865                 SOCK_LOCK_ASSERT(so);
3866                 kn->kn_data = so->sol_qlen;
3867                 if (so->so_error) {
3868                         kn->kn_flags |= EV_EOF;
3869                         kn->kn_fflags = so->so_error;
3870                         return (1);
3871                 }
3872                 return (!TAILQ_EMPTY(&so->sol_comp));
3873         }
3874
3875         SOCKBUF_LOCK_ASSERT(&so->so_rcv);
3876
3877         kn->kn_data = sbavail(&so->so_rcv) - so->so_rcv.sb_ctl;
3878         if (so->so_rcv.sb_state & SBS_CANTRCVMORE) {
3879                 kn->kn_flags |= EV_EOF;
3880                 kn->kn_fflags = so->so_error;
3881                 return (1);
3882         } else if (so->so_error || so->so_rerror)
3883                 return (1);
3884
3885         if (kn->kn_sfflags & NOTE_LOWAT) {
3886                 if (kn->kn_data >= kn->kn_sdata)
3887                         return (1);
3888         } else if (sbavail(&so->so_rcv) >= so->so_rcv.sb_lowat)
3889                 return (1);
3890
3891         /* This hook returning non-zero indicates an event, not error */
3892         return (hhook_run_socket(so, NULL, HHOOK_FILT_SOREAD));
3893 }
3894
3895 static void
3896 filt_sowdetach(struct knote *kn)
3897 {
3898         struct socket *so = kn->kn_fp->f_data;
3899
3900         so_wrknl_lock(so);
3901         knlist_remove(&so->so_wrsel.si_note, kn, 1);
3902         if (!SOLISTENING(so) && knlist_empty(&so->so_wrsel.si_note))
3903                 so->so_snd.sb_flags &= ~SB_KNOTE;
3904         so_wrknl_unlock(so);
3905 }
3906
3907 /*ARGSUSED*/
3908 static int
3909 filt_sowrite(struct knote *kn, long hint)
3910 {
3911         struct socket *so;
3912
3913         so = kn->kn_fp->f_data;
3914
3915         if (SOLISTENING(so))
3916                 return (0);
3917
3918         SOCKBUF_LOCK_ASSERT(&so->so_snd);
3919         kn->kn_data = sbspace(&so->so_snd);
3920
3921         hhook_run_socket(so, kn, HHOOK_FILT_SOWRITE);
3922
3923         if (so->so_snd.sb_state & SBS_CANTSENDMORE) {
3924                 kn->kn_flags |= EV_EOF;
3925                 kn->kn_fflags = so->so_error;
3926                 return (1);
3927         } else if (so->so_error)        /* temporary udp error */
3928                 return (1);
3929         else if (((so->so_state & SS_ISCONNECTED) == 0) &&
3930             (so->so_proto->pr_flags & PR_CONNREQUIRED))
3931                 return (0);
3932         else if (kn->kn_sfflags & NOTE_LOWAT)
3933                 return (kn->kn_data >= kn->kn_sdata);
3934         else
3935                 return (kn->kn_data >= so->so_snd.sb_lowat);
3936 }
3937
3938 static int
3939 filt_soempty(struct knote *kn, long hint)
3940 {
3941         struct socket *so;
3942
3943         so = kn->kn_fp->f_data;
3944
3945         if (SOLISTENING(so))
3946                 return (1);
3947
3948         SOCKBUF_LOCK_ASSERT(&so->so_snd);
3949         kn->kn_data = sbused(&so->so_snd);
3950
3951         if (kn->kn_data == 0)
3952                 return (1);
3953         else
3954                 return (0);
3955 }
3956
3957 int
3958 socheckuid(struct socket *so, uid_t uid)
3959 {
3960
3961         if (so == NULL)
3962                 return (EPERM);
3963         if (so->so_cred->cr_uid != uid)
3964                 return (EPERM);
3965         return (0);
3966 }
3967
3968 /*
3969  * These functions are used by protocols to notify the socket layer (and its
3970  * consumers) of state changes in the sockets driven by protocol-side events.
3971  */
3972
3973 /*
3974  * Procedures to manipulate state flags of socket and do appropriate wakeups.
3975  *
3976  * Normal sequence from the active (originating) side is that
3977  * soisconnecting() is called during processing of connect() call, resulting
3978  * in an eventual call to soisconnected() if/when the connection is
3979  * established.  When the connection is torn down soisdisconnecting() is
3980  * called during processing of disconnect() call, and soisdisconnected() is
3981  * called when the connection to the peer is totally severed.  The semantics
3982  * of these routines are such that connectionless protocols can call
3983  * soisconnected() and soisdisconnected() only, bypassing the in-progress
3984  * calls when setting up a ``connection'' takes no time.
3985  *
3986  * From the passive side, a socket is created with two queues of sockets:
3987  * so_incomp for connections in progress and so_comp for connections already
3988  * made and awaiting user acceptance.  As a protocol is preparing incoming
3989  * connections, it creates a socket structure queued on so_incomp by calling
3990  * sonewconn().  When the connection is established, soisconnected() is
3991  * called, and transfers the socket structure to so_comp, making it available
3992  * to accept().
3993  *
3994  * If a socket is closed with sockets on either so_incomp or so_comp, these
3995  * sockets are dropped.
3996  *
3997  * If higher-level protocols are implemented in the kernel, the wakeups done
3998  * here will sometimes cause software-interrupt process scheduling.
3999  */
4000 void
4001 soisconnecting(struct socket *so)
4002 {
4003
4004         SOCK_LOCK(so);
4005         so->so_state &= ~(SS_ISCONNECTED|SS_ISDISCONNECTING);
4006         so->so_state |= SS_ISCONNECTING;
4007         SOCK_UNLOCK(so);
4008 }
4009
4010 void
4011 soisconnected(struct socket *so)
4012 {
4013         bool last __diagused;
4014
4015         SOCK_LOCK(so);
4016         so->so_state &= ~(SS_ISCONNECTING|SS_ISDISCONNECTING|SS_ISCONFIRMING);
4017         so->so_state |= SS_ISCONNECTED;
4018
4019         if (so->so_qstate == SQ_INCOMP) {
4020                 struct socket *head = so->so_listen;
4021                 int ret;
4022
4023                 KASSERT(head, ("%s: so %p on incomp of NULL", __func__, so));
4024                 /*
4025                  * Promoting a socket from incomplete queue to complete, we
4026                  * need to go through reverse order of locking.  We first do
4027                  * trylock, and if that doesn't succeed, we go the hard way
4028                  * leaving a reference and rechecking consistency after proper
4029                  * locking.
4030                  */
4031                 if (__predict_false(SOLISTEN_TRYLOCK(head) == 0)) {
4032                         soref(head);
4033                         SOCK_UNLOCK(so);
4034                         SOLISTEN_LOCK(head);
4035                         SOCK_LOCK(so);
4036                         if (__predict_false(head != so->so_listen)) {
4037                                 /*
4038                                  * The socket went off the listen queue,
4039                                  * should be lost race to close(2) of sol.
4040                                  * The socket is about to soabort().
4041                                  */
4042                                 SOCK_UNLOCK(so);
4043                                 sorele(head);
4044                                 return;
4045                         }
4046                         last = refcount_release(&head->so_count);
4047                         KASSERT(!last, ("%s: released last reference for %p",
4048                             __func__, head));
4049                 }
4050 again:
4051                 if ((so->so_options & SO_ACCEPTFILTER) == 0) {
4052                         TAILQ_REMOVE(&head->sol_incomp, so, so_list);
4053                         head->sol_incqlen--;
4054                         TAILQ_INSERT_TAIL(&head->sol_comp, so, so_list);
4055                         head->sol_qlen++;
4056                         so->so_qstate = SQ_COMP;
4057                         SOCK_UNLOCK(so);
4058                         solisten_wakeup(head);  /* unlocks */
4059                 } else {
4060                         SOCKBUF_LOCK(&so->so_rcv);
4061                         soupcall_set(so, SO_RCV,
4062                             head->sol_accept_filter->accf_callback,
4063                             head->sol_accept_filter_arg);
4064                         so->so_options &= ~SO_ACCEPTFILTER;
4065                         ret = head->sol_accept_filter->accf_callback(so,
4066                             head->sol_accept_filter_arg, M_NOWAIT);
4067                         if (ret == SU_ISCONNECTED) {
4068                                 soupcall_clear(so, SO_RCV);
4069                                 SOCKBUF_UNLOCK(&so->so_rcv);
4070                                 goto again;
4071                         }
4072                         SOCKBUF_UNLOCK(&so->so_rcv);
4073                         SOCK_UNLOCK(so);
4074                         SOLISTEN_UNLOCK(head);
4075                 }
4076                 return;
4077         }
4078         SOCK_UNLOCK(so);
4079         wakeup(&so->so_timeo);
4080         sorwakeup(so);
4081         sowwakeup(so);
4082 }
4083
4084 void
4085 soisdisconnecting(struct socket *so)
4086 {
4087
4088         SOCK_LOCK(so);
4089         so->so_state &= ~SS_ISCONNECTING;
4090         so->so_state |= SS_ISDISCONNECTING;
4091
4092         if (!SOLISTENING(so)) {
4093                 SOCKBUF_LOCK(&so->so_rcv);
4094                 socantrcvmore_locked(so);
4095                 SOCKBUF_LOCK(&so->so_snd);
4096                 socantsendmore_locked(so);
4097         }
4098         SOCK_UNLOCK(so);
4099         wakeup(&so->so_timeo);
4100 }
4101
4102 void
4103 soisdisconnected(struct socket *so)
4104 {
4105
4106         SOCK_LOCK(so);
4107
4108         /*
4109          * There is at least one reader of so_state that does not
4110          * acquire socket lock, namely soreceive_generic().  Ensure
4111          * that it never sees all flags that track connection status
4112          * cleared, by ordering the update with a barrier semantic of
4113          * our release thread fence.
4114          */
4115         so->so_state |= SS_ISDISCONNECTED;
4116         atomic_thread_fence_rel();
4117         so->so_state &= ~(SS_ISCONNECTING|SS_ISCONNECTED|SS_ISDISCONNECTING);
4118
4119         if (!SOLISTENING(so)) {
4120                 SOCK_UNLOCK(so);
4121                 SOCKBUF_LOCK(&so->so_rcv);
4122                 socantrcvmore_locked(so);
4123                 SOCKBUF_LOCK(&so->so_snd);
4124                 sbdrop_locked(&so->so_snd, sbused(&so->so_snd));
4125                 socantsendmore_locked(so);
4126         } else
4127                 SOCK_UNLOCK(so);
4128         wakeup(&so->so_timeo);
4129 }
4130
4131 int
4132 soiolock(struct socket *so, struct sx *sx, int flags)
4133 {
4134         int error;
4135
4136         KASSERT((flags & SBL_VALID) == flags,
4137             ("soiolock: invalid flags %#x", flags));
4138
4139         if ((flags & SBL_WAIT) != 0) {
4140                 if ((flags & SBL_NOINTR) != 0) {
4141                         sx_xlock(sx);
4142                 } else {
4143                         error = sx_xlock_sig(sx);
4144                         if (error != 0)
4145                                 return (error);
4146                 }
4147         } else if (!sx_try_xlock(sx)) {
4148                 return (EWOULDBLOCK);
4149         }
4150
4151         if (__predict_false(SOLISTENING(so))) {
4152                 sx_xunlock(sx);
4153                 return (ENOTCONN);
4154         }
4155         return (0);
4156 }
4157
4158 void
4159 soiounlock(struct sx *sx)
4160 {
4161         sx_xunlock(sx);
4162 }
4163
4164 /*
4165  * Make a copy of a sockaddr in a malloced buffer of type M_SONAME.
4166  */
4167 struct sockaddr *
4168 sodupsockaddr(const struct sockaddr *sa, int mflags)
4169 {
4170         struct sockaddr *sa2;
4171
4172         sa2 = malloc(sa->sa_len, M_SONAME, mflags);
4173         if (sa2)
4174                 bcopy(sa, sa2, sa->sa_len);
4175         return sa2;
4176 }
4177
4178 /*
4179  * Register per-socket destructor.
4180  */
4181 void
4182 sodtor_set(struct socket *so, so_dtor_t *func)
4183 {
4184
4185         SOCK_LOCK_ASSERT(so);
4186         so->so_dtor = func;
4187 }
4188
4189 /*
4190  * Register per-socket buffer upcalls.
4191  */
4192 void
4193 soupcall_set(struct socket *so, int which, so_upcall_t func, void *arg)
4194 {
4195         struct sockbuf *sb;
4196
4197         KASSERT(!SOLISTENING(so), ("%s: so %p listening", __func__, so));
4198
4199         switch (which) {
4200         case SO_RCV:
4201                 sb = &so->so_rcv;
4202                 break;
4203         case SO_SND:
4204                 sb = &so->so_snd;
4205                 break;
4206         default:
4207                 panic("soupcall_set: bad which");
4208         }
4209         SOCKBUF_LOCK_ASSERT(sb);
4210         sb->sb_upcall = func;
4211         sb->sb_upcallarg = arg;
4212         sb->sb_flags |= SB_UPCALL;
4213 }
4214
4215 void
4216 soupcall_clear(struct socket *so, int which)
4217 {
4218         struct sockbuf *sb;
4219
4220         KASSERT(!SOLISTENING(so), ("%s: so %p listening", __func__, so));
4221
4222         switch (which) {
4223         case SO_RCV:
4224                 sb = &so->so_rcv;
4225                 break;
4226         case SO_SND:
4227                 sb = &so->so_snd;
4228                 break;
4229         default:
4230                 panic("soupcall_clear: bad which");
4231         }
4232         SOCKBUF_LOCK_ASSERT(sb);
4233         KASSERT(sb->sb_upcall != NULL,
4234             ("%s: so %p no upcall to clear", __func__, so));
4235         sb->sb_upcall = NULL;
4236         sb->sb_upcallarg = NULL;
4237         sb->sb_flags &= ~SB_UPCALL;
4238 }
4239
4240 void
4241 solisten_upcall_set(struct socket *so, so_upcall_t func, void *arg)
4242 {
4243
4244         SOLISTEN_LOCK_ASSERT(so);
4245         so->sol_upcall = func;
4246         so->sol_upcallarg = arg;
4247 }
4248
4249 static void
4250 so_rdknl_lock(void *arg)
4251 {
4252         struct socket *so = arg;
4253
4254         if (SOLISTENING(so))
4255                 SOCK_LOCK(so);
4256         else
4257                 SOCKBUF_LOCK(&so->so_rcv);
4258 }
4259
4260 static void
4261 so_rdknl_unlock(void *arg)
4262 {
4263         struct socket *so = arg;
4264
4265         if (SOLISTENING(so))
4266                 SOCK_UNLOCK(so);
4267         else
4268                 SOCKBUF_UNLOCK(&so->so_rcv);
4269 }
4270
4271 static void
4272 so_rdknl_assert_lock(void *arg, int what)
4273 {
4274         struct socket *so = arg;
4275
4276         if (what == LA_LOCKED) {
4277                 if (SOLISTENING(so))
4278                         SOCK_LOCK_ASSERT(so);
4279                 else
4280                         SOCKBUF_LOCK_ASSERT(&so->so_rcv);
4281         } else {
4282                 if (SOLISTENING(so))
4283                         SOCK_UNLOCK_ASSERT(so);
4284                 else
4285                         SOCKBUF_UNLOCK_ASSERT(&so->so_rcv);
4286         }
4287 }
4288
4289 static void
4290 so_wrknl_lock(void *arg)
4291 {
4292         struct socket *so = arg;
4293
4294         if (SOLISTENING(so))
4295                 SOCK_LOCK(so);
4296         else
4297                 SOCKBUF_LOCK(&so->so_snd);
4298 }
4299
4300 static void
4301 so_wrknl_unlock(void *arg)
4302 {
4303         struct socket *so = arg;
4304
4305         if (SOLISTENING(so))
4306                 SOCK_UNLOCK(so);
4307         else
4308                 SOCKBUF_UNLOCK(&so->so_snd);
4309 }
4310
4311 static void
4312 so_wrknl_assert_lock(void *arg, int what)
4313 {
4314         struct socket *so = arg;
4315
4316         if (what == LA_LOCKED) {
4317                 if (SOLISTENING(so))
4318                         SOCK_LOCK_ASSERT(so);
4319                 else
4320                         SOCKBUF_LOCK_ASSERT(&so->so_snd);
4321         } else {
4322                 if (SOLISTENING(so))
4323                         SOCK_UNLOCK_ASSERT(so);
4324                 else
4325                         SOCKBUF_UNLOCK_ASSERT(&so->so_snd);
4326         }
4327 }
4328
4329 /*
4330  * Create an external-format (``xsocket'') structure using the information in
4331  * the kernel-format socket structure pointed to by so.  This is done to
4332  * reduce the spew of irrelevant information over this interface, to isolate
4333  * user code from changes in the kernel structure, and potentially to provide
4334  * information-hiding if we decide that some of this information should be
4335  * hidden from users.
4336  */
4337 void
4338 sotoxsocket(struct socket *so, struct xsocket *xso)
4339 {
4340
4341         bzero(xso, sizeof(*xso));
4342         xso->xso_len = sizeof *xso;
4343         xso->xso_so = (uintptr_t)so;
4344         xso->so_type = so->so_type;
4345         xso->so_options = so->so_options;
4346         xso->so_linger = so->so_linger;
4347         xso->so_state = so->so_state;
4348         xso->so_pcb = (uintptr_t)so->so_pcb;
4349         xso->xso_protocol = so->so_proto->pr_protocol;
4350         xso->xso_family = so->so_proto->pr_domain->dom_family;
4351         xso->so_timeo = so->so_timeo;
4352         xso->so_error = so->so_error;
4353         xso->so_uid = so->so_cred->cr_uid;
4354         xso->so_pgid = so->so_sigio ? so->so_sigio->sio_pgid : 0;
4355         if (SOLISTENING(so)) {
4356                 xso->so_qlen = so->sol_qlen;
4357                 xso->so_incqlen = so->sol_incqlen;
4358                 xso->so_qlimit = so->sol_qlimit;
4359                 xso->so_oobmark = 0;
4360         } else {
4361                 xso->so_state |= so->so_qstate;
4362                 xso->so_qlen = xso->so_incqlen = xso->so_qlimit = 0;
4363                 xso->so_oobmark = so->so_oobmark;
4364                 sbtoxsockbuf(&so->so_snd, &xso->so_snd);
4365                 sbtoxsockbuf(&so->so_rcv, &xso->so_rcv);
4366         }
4367 }
4368
4369 struct sockbuf *
4370 so_sockbuf_rcv(struct socket *so)
4371 {
4372
4373         return (&so->so_rcv);
4374 }
4375
4376 struct sockbuf *
4377 so_sockbuf_snd(struct socket *so)
4378 {
4379
4380         return (&so->so_snd);
4381 }
4382
4383 int
4384 so_state_get(const struct socket *so)
4385 {
4386
4387         return (so->so_state);
4388 }
4389
4390 void
4391 so_state_set(struct socket *so, int val)
4392 {
4393
4394         so->so_state = val;
4395 }
4396
4397 int
4398 so_options_get(const struct socket *so)
4399 {
4400
4401         return (so->so_options);
4402 }
4403
4404 void
4405 so_options_set(struct socket *so, int val)
4406 {
4407
4408         so->so_options = val;
4409 }
4410
4411 int
4412 so_error_get(const struct socket *so)
4413 {
4414
4415         return (so->so_error);
4416 }
4417
4418 void
4419 so_error_set(struct socket *so, int val)
4420 {
4421
4422         so->so_error = val;
4423 }
4424
4425 int
4426 so_linger_get(const struct socket *so)
4427 {
4428
4429         return (so->so_linger);
4430 }
4431
4432 void
4433 so_linger_set(struct socket *so, int val)
4434 {
4435
4436         KASSERT(val >= 0 && val <= USHRT_MAX && val <= (INT_MAX / hz),
4437             ("%s: val %d out of range", __func__, val));
4438
4439         so->so_linger = val;
4440 }
4441
4442 struct protosw *
4443 so_protosw_get(const struct socket *so)
4444 {
4445
4446         return (so->so_proto);
4447 }
4448
4449 void
4450 so_protosw_set(struct socket *so, struct protosw *val)
4451 {
4452
4453         so->so_proto = val;
4454 }
4455
4456 void
4457 so_sorwakeup(struct socket *so)
4458 {
4459
4460         sorwakeup(so);
4461 }
4462
4463 void
4464 so_sowwakeup(struct socket *so)
4465 {
4466
4467         sowwakeup(so);
4468 }
4469
4470 void
4471 so_sorwakeup_locked(struct socket *so)
4472 {
4473
4474         sorwakeup_locked(so);
4475 }
4476
4477 void
4478 so_sowwakeup_locked(struct socket *so)
4479 {
4480
4481         sowwakeup_locked(so);
4482 }
4483
4484 void
4485 so_lock(struct socket *so)
4486 {
4487
4488         SOCK_LOCK(so);
4489 }
4490
4491 void
4492 so_unlock(struct socket *so)
4493 {
4494
4495         SOCK_UNLOCK(so);
4496 }