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