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                 if (so->so_options & SO_LINGER) {
1094                         if ((so->so_state & SS_ISDISCONNECTING) &&
1095                             (so->so_state & SS_NBIO))
1096                                 goto drop;
1097                         while (so->so_state & SS_ISCONNECTED) {
1098                                 error = tsleep(&so->so_timeo,
1099                                     PSOCK | PCATCH, "soclos",
1100                                     so->so_linger * hz);
1101                                 if (error)
1102                                         break;
1103                         }
1104                 }
1105         }
1106
1107 drop:
1108         if (so->so_proto->pr_usrreqs->pru_close != NULL)
1109                 (*so->so_proto->pr_usrreqs->pru_close)(so);
1110
1111         SOCK_LOCK(so);
1112         if ((listening = (so->so_options & SO_ACCEPTCONN))) {
1113                 struct socket *sp;
1114
1115                 TAILQ_INIT(&lqueue);
1116                 TAILQ_SWAP(&lqueue, &so->sol_incomp, socket, so_list);
1117                 TAILQ_CONCAT(&lqueue, &so->sol_comp, so_list);
1118
1119                 so->sol_qlen = so->sol_incqlen = 0;
1120
1121                 TAILQ_FOREACH(sp, &lqueue, so_list) {
1122                         SOCK_LOCK(sp);
1123                         sp->so_qstate = SQ_NONE;
1124                         sp->so_listen = NULL;
1125                         SOCK_UNLOCK(sp);
1126                         /* Guaranteed not to be the last. */
1127                         refcount_release(&so->so_count);
1128                 }
1129         }
1130         KASSERT((so->so_state & SS_NOFDREF) == 0, ("soclose: NOFDREF"));
1131         so->so_state |= SS_NOFDREF;
1132         sorele(so);
1133         if (listening) {
1134                 struct socket *sp, *tsp;
1135
1136                 TAILQ_FOREACH_SAFE(sp, &lqueue, so_list, tsp) {
1137                         SOCK_LOCK(sp);
1138                         if (sp->so_count == 0) {
1139                                 SOCK_UNLOCK(sp);
1140                                 soabort(sp);
1141                         } else
1142                                 /* sp is now in sofree() */
1143                                 SOCK_UNLOCK(sp);
1144                 }
1145         }
1146         CURVNET_RESTORE();
1147         return (error);
1148 }
1149
1150 /*
1151  * soabort() is used to abruptly tear down a connection, such as when a
1152  * resource limit is reached (listen queue depth exceeded), or if a listen
1153  * socket is closed while there are sockets waiting to be accepted.
1154  *
1155  * This interface is tricky, because it is called on an unreferenced socket,
1156  * and must be called only by a thread that has actually removed the socket
1157  * from the listen queue it was on, or races with other threads are risked.
1158  *
1159  * This interface will call into the protocol code, so must not be called
1160  * with any socket locks held.  Protocols do call it while holding their own
1161  * recursible protocol mutexes, but this is something that should be subject
1162  * to review in the future.
1163  */
1164 void
1165 soabort(struct socket *so)
1166 {
1167
1168         /*
1169          * In as much as is possible, assert that no references to this
1170          * socket are held.  This is not quite the same as asserting that the
1171          * current thread is responsible for arranging for no references, but
1172          * is as close as we can get for now.
1173          */
1174         KASSERT(so->so_count == 0, ("soabort: so_count"));
1175         KASSERT((so->so_state & SS_PROTOREF) == 0, ("soabort: SS_PROTOREF"));
1176         KASSERT(so->so_state & SS_NOFDREF, ("soabort: !SS_NOFDREF"));
1177         VNET_SO_ASSERT(so);
1178
1179         if (so->so_proto->pr_usrreqs->pru_abort != NULL)
1180                 (*so->so_proto->pr_usrreqs->pru_abort)(so);
1181         SOCK_LOCK(so);
1182         sofree(so);
1183 }
1184
1185 int
1186 soaccept(struct socket *so, struct sockaddr **nam)
1187 {
1188         int error;
1189
1190         SOCK_LOCK(so);
1191         KASSERT((so->so_state & SS_NOFDREF) != 0, ("soaccept: !NOFDREF"));
1192         so->so_state &= ~SS_NOFDREF;
1193         SOCK_UNLOCK(so);
1194
1195         CURVNET_SET(so->so_vnet);
1196         error = (*so->so_proto->pr_usrreqs->pru_accept)(so, nam);
1197         CURVNET_RESTORE();
1198         return (error);
1199 }
1200
1201 int
1202 soconnect(struct socket *so, struct sockaddr *nam, struct thread *td)
1203 {
1204
1205         return (soconnectat(AT_FDCWD, so, nam, td));
1206 }
1207
1208 int
1209 soconnectat(int fd, struct socket *so, struct sockaddr *nam, struct thread *td)
1210 {
1211         int error;
1212
1213         if (so->so_options & SO_ACCEPTCONN)
1214                 return (EOPNOTSUPP);
1215
1216         CURVNET_SET(so->so_vnet);
1217         /*
1218          * If protocol is connection-based, can only connect once.
1219          * Otherwise, if connected, try to disconnect first.  This allows
1220          * user to disconnect by connecting to, e.g., a null address.
1221          */
1222         if (so->so_state & (SS_ISCONNECTED|SS_ISCONNECTING) &&
1223             ((so->so_proto->pr_flags & PR_CONNREQUIRED) ||
1224             (error = sodisconnect(so)))) {
1225                 error = EISCONN;
1226         } else {
1227                 /*
1228                  * Prevent accumulated error from previous connection from
1229                  * biting us.
1230                  */
1231                 so->so_error = 0;
1232                 if (fd == AT_FDCWD) {
1233                         error = (*so->so_proto->pr_usrreqs->pru_connect)(so,
1234                             nam, td);
1235                 } else {
1236                         error = (*so->so_proto->pr_usrreqs->pru_connectat)(fd,
1237                             so, nam, td);
1238                 }
1239         }
1240         CURVNET_RESTORE();
1241
1242         return (error);
1243 }
1244
1245 int
1246 soconnect2(struct socket *so1, struct socket *so2)
1247 {
1248         int error;
1249
1250         CURVNET_SET(so1->so_vnet);
1251         error = (*so1->so_proto->pr_usrreqs->pru_connect2)(so1, so2);
1252         CURVNET_RESTORE();
1253         return (error);
1254 }
1255
1256 int
1257 sodisconnect(struct socket *so)
1258 {
1259         int error;
1260
1261         if ((so->so_state & SS_ISCONNECTED) == 0)
1262                 return (ENOTCONN);
1263         if (so->so_state & SS_ISDISCONNECTING)
1264                 return (EALREADY);
1265         VNET_SO_ASSERT(so);
1266         error = (*so->so_proto->pr_usrreqs->pru_disconnect)(so);
1267         return (error);
1268 }
1269
1270 #define SBLOCKWAIT(f)   (((f) & MSG_DONTWAIT) ? 0 : SBL_WAIT)
1271
1272 int
1273 sosend_dgram(struct socket *so, struct sockaddr *addr, struct uio *uio,
1274     struct mbuf *top, struct mbuf *control, int flags, struct thread *td)
1275 {
1276         long space;
1277         ssize_t resid;
1278         int clen = 0, error, dontroute;
1279
1280         KASSERT(so->so_type == SOCK_DGRAM, ("sosend_dgram: !SOCK_DGRAM"));
1281         KASSERT(so->so_proto->pr_flags & PR_ATOMIC,
1282             ("sosend_dgram: !PR_ATOMIC"));
1283
1284         if (uio != NULL)
1285                 resid = uio->uio_resid;
1286         else
1287                 resid = top->m_pkthdr.len;
1288         /*
1289          * In theory resid should be unsigned.  However, space must be
1290          * signed, as it might be less than 0 if we over-committed, and we
1291          * must use a signed comparison of space and resid.  On the other
1292          * hand, a negative resid causes us to loop sending 0-length
1293          * segments to the protocol.
1294          */
1295         if (resid < 0) {
1296                 error = EINVAL;
1297                 goto out;
1298         }
1299
1300         dontroute =
1301             (flags & MSG_DONTROUTE) && (so->so_options & SO_DONTROUTE) == 0;
1302         if (td != NULL)
1303                 td->td_ru.ru_msgsnd++;
1304         if (control != NULL)
1305                 clen = control->m_len;
1306
1307         SOCKBUF_LOCK(&so->so_snd);
1308         if (so->so_snd.sb_state & SBS_CANTSENDMORE) {
1309                 SOCKBUF_UNLOCK(&so->so_snd);
1310                 error = EPIPE;
1311                 goto out;
1312         }
1313         if (so->so_error) {
1314                 error = so->so_error;
1315                 so->so_error = 0;
1316                 SOCKBUF_UNLOCK(&so->so_snd);
1317                 goto out;
1318         }
1319         if ((so->so_state & SS_ISCONNECTED) == 0) {
1320                 /*
1321                  * `sendto' and `sendmsg' is allowed on a connection-based
1322                  * socket if it supports implied connect.  Return ENOTCONN if
1323                  * not connected and no address is supplied.
1324                  */
1325                 if ((so->so_proto->pr_flags & PR_CONNREQUIRED) &&
1326                     (so->so_proto->pr_flags & PR_IMPLOPCL) == 0) {
1327                         if ((so->so_state & SS_ISCONFIRMING) == 0 &&
1328                             !(resid == 0 && clen != 0)) {
1329                                 SOCKBUF_UNLOCK(&so->so_snd);
1330                                 error = ENOTCONN;
1331                                 goto out;
1332                         }
1333                 } else if (addr == NULL) {
1334                         if (so->so_proto->pr_flags & PR_CONNREQUIRED)
1335                                 error = ENOTCONN;
1336                         else
1337                                 error = EDESTADDRREQ;
1338                         SOCKBUF_UNLOCK(&so->so_snd);
1339                         goto out;
1340                 }
1341         }
1342
1343         /*
1344          * Do we need MSG_OOB support in SOCK_DGRAM?  Signs here may be a
1345          * problem and need fixing.
1346          */
1347         space = sbspace(&so->so_snd);
1348         if (flags & MSG_OOB)
1349                 space += 1024;
1350         space -= clen;
1351         SOCKBUF_UNLOCK(&so->so_snd);
1352         if (resid > space) {
1353                 error = EMSGSIZE;
1354                 goto out;
1355         }
1356         if (uio == NULL) {
1357                 resid = 0;
1358                 if (flags & MSG_EOR)
1359                         top->m_flags |= M_EOR;
1360         } else {
1361                 /*
1362                  * Copy the data from userland into a mbuf chain.
1363                  * If no data is to be copied in, a single empty mbuf
1364                  * is returned.
1365                  */
1366                 top = m_uiotombuf(uio, M_WAITOK, space, max_hdr,
1367                     (M_PKTHDR | ((flags & MSG_EOR) ? M_EOR : 0)));
1368                 if (top == NULL) {
1369                         error = EFAULT; /* only possible error */
1370                         goto out;
1371                 }
1372                 space -= resid - uio->uio_resid;
1373                 resid = uio->uio_resid;
1374         }
1375         KASSERT(resid == 0, ("sosend_dgram: resid != 0"));
1376         /*
1377          * XXXRW: Frobbing SO_DONTROUTE here is even worse without sblock
1378          * than with.
1379          */
1380         if (dontroute) {
1381                 SOCK_LOCK(so);
1382                 so->so_options |= SO_DONTROUTE;
1383                 SOCK_UNLOCK(so);
1384         }
1385         /*
1386          * XXX all the SBS_CANTSENDMORE checks previously done could be out
1387          * of date.  We could have received a reset packet in an interrupt or
1388          * maybe we slept while doing page faults in uiomove() etc.  We could
1389          * probably recheck again inside the locking protection here, but
1390          * there are probably other places that this also happens.  We must
1391          * rethink this.
1392          */
1393         VNET_SO_ASSERT(so);
1394         error = (*so->so_proto->pr_usrreqs->pru_send)(so,
1395             (flags & MSG_OOB) ? PRUS_OOB :
1396         /*
1397          * If the user set MSG_EOF, the protocol understands this flag and
1398          * nothing left to send then use PRU_SEND_EOF instead of PRU_SEND.
1399          */
1400             ((flags & MSG_EOF) &&
1401              (so->so_proto->pr_flags & PR_IMPLOPCL) &&
1402              (resid <= 0)) ?
1403                 PRUS_EOF :
1404                 /* If there is more to send set PRUS_MORETOCOME */
1405                 (flags & MSG_MORETOCOME) ||
1406                 (resid > 0 && space > 0) ? PRUS_MORETOCOME : 0,
1407                 top, addr, control, td);
1408         if (dontroute) {
1409                 SOCK_LOCK(so);
1410                 so->so_options &= ~SO_DONTROUTE;
1411                 SOCK_UNLOCK(so);
1412         }
1413         clen = 0;
1414         control = NULL;
1415         top = NULL;
1416 out:
1417         if (top != NULL)
1418                 m_freem(top);
1419         if (control != NULL)
1420                 m_freem(control);
1421         return (error);
1422 }
1423
1424 /*
1425  * Send on a socket.  If send must go all at once and message is larger than
1426  * send buffering, then hard error.  Lock against other senders.  If must go
1427  * all at once and not enough room now, then inform user that this would
1428  * block and do nothing.  Otherwise, if nonblocking, send as much as
1429  * possible.  The data to be sent is described by "uio" if nonzero, otherwise
1430  * by the mbuf chain "top" (which must be null if uio is not).  Data provided
1431  * in mbuf chain must be small enough to send all at once.
1432  *
1433  * Returns nonzero on error, timeout or signal; callers must check for short
1434  * counts if EINTR/ERESTART are returned.  Data and control buffers are freed
1435  * on return.
1436  */
1437 int
1438 sosend_generic(struct socket *so, struct sockaddr *addr, struct uio *uio,
1439     struct mbuf *top, struct mbuf *control, int flags, struct thread *td)
1440 {
1441         long space;
1442         ssize_t resid;
1443         int clen = 0, error, dontroute;
1444         int atomic = sosendallatonce(so) || top;
1445
1446         if (uio != NULL)
1447                 resid = uio->uio_resid;
1448         else
1449                 resid = top->m_pkthdr.len;
1450         /*
1451          * In theory resid should be unsigned.  However, space must be
1452          * signed, as it might be less than 0 if we over-committed, and we
1453          * must use a signed comparison of space and resid.  On the other
1454          * hand, a negative resid causes us to loop sending 0-length
1455          * segments to the protocol.
1456          *
1457          * Also check to make sure that MSG_EOR isn't used on SOCK_STREAM
1458          * type sockets since that's an error.
1459          */
1460         if (resid < 0 || (so->so_type == SOCK_STREAM && (flags & MSG_EOR))) {
1461                 error = EINVAL;
1462                 goto out;
1463         }
1464
1465         dontroute =
1466             (flags & MSG_DONTROUTE) && (so->so_options & SO_DONTROUTE) == 0 &&
1467             (so->so_proto->pr_flags & PR_ATOMIC);
1468         if (td != NULL)
1469                 td->td_ru.ru_msgsnd++;
1470         if (control != NULL)
1471                 clen = control->m_len;
1472
1473         error = sblock(&so->so_snd, SBLOCKWAIT(flags));
1474         if (error)
1475                 goto out;
1476
1477 restart:
1478         do {
1479                 SOCKBUF_LOCK(&so->so_snd);
1480                 if (so->so_snd.sb_state & SBS_CANTSENDMORE) {
1481                         SOCKBUF_UNLOCK(&so->so_snd);
1482                         error = EPIPE;
1483                         goto release;
1484                 }
1485                 if (so->so_error) {
1486                         error = so->so_error;
1487                         so->so_error = 0;
1488                         SOCKBUF_UNLOCK(&so->so_snd);
1489                         goto release;
1490                 }
1491                 if ((so->so_state & SS_ISCONNECTED) == 0) {
1492                         /*
1493                          * `sendto' and `sendmsg' is allowed on a connection-
1494                          * based socket if it supports implied connect.
1495                          * Return ENOTCONN if not connected and no address is
1496                          * supplied.
1497                          */
1498                         if ((so->so_proto->pr_flags & PR_CONNREQUIRED) &&
1499                             (so->so_proto->pr_flags & PR_IMPLOPCL) == 0) {
1500                                 if ((so->so_state & SS_ISCONFIRMING) == 0 &&
1501                                     !(resid == 0 && clen != 0)) {
1502                                         SOCKBUF_UNLOCK(&so->so_snd);
1503                                         error = ENOTCONN;
1504                                         goto release;
1505                                 }
1506                         } else if (addr == NULL) {
1507                                 SOCKBUF_UNLOCK(&so->so_snd);
1508                                 if (so->so_proto->pr_flags & PR_CONNREQUIRED)
1509                                         error = ENOTCONN;
1510                                 else
1511                                         error = EDESTADDRREQ;
1512                                 goto release;
1513                         }
1514                 }
1515                 space = sbspace(&so->so_snd);
1516                 if (flags & MSG_OOB)
1517                         space += 1024;
1518                 if ((atomic && resid > so->so_snd.sb_hiwat) ||
1519                     clen > so->so_snd.sb_hiwat) {
1520                         SOCKBUF_UNLOCK(&so->so_snd);
1521                         error = EMSGSIZE;
1522                         goto release;
1523                 }
1524                 if (space < resid + clen &&
1525                     (atomic || space < so->so_snd.sb_lowat || space < clen)) {
1526                         if ((so->so_state & SS_NBIO) ||
1527                             (flags & (MSG_NBIO | MSG_DONTWAIT)) != 0) {
1528                                 SOCKBUF_UNLOCK(&so->so_snd);
1529                                 error = EWOULDBLOCK;
1530                                 goto release;
1531                         }
1532                         error = sbwait(&so->so_snd);
1533                         SOCKBUF_UNLOCK(&so->so_snd);
1534                         if (error)
1535                                 goto release;
1536                         goto restart;
1537                 }
1538                 SOCKBUF_UNLOCK(&so->so_snd);
1539                 space -= clen;
1540                 do {
1541                         if (uio == NULL) {
1542                                 resid = 0;
1543                                 if (flags & MSG_EOR)
1544                                         top->m_flags |= M_EOR;
1545                         } else {
1546                                 /*
1547                                  * Copy the data from userland into a mbuf
1548                                  * chain.  If resid is 0, which can happen
1549                                  * only if we have control to send, then
1550                                  * a single empty mbuf is returned.  This
1551                                  * is a workaround to prevent protocol send
1552                                  * methods to panic.
1553                                  */
1554                                 top = m_uiotombuf(uio, M_WAITOK, space,
1555                                     (atomic ? max_hdr : 0),
1556                                     (atomic ? M_PKTHDR : 0) |
1557                                     ((flags & MSG_EOR) ? M_EOR : 0));
1558                                 if (top == NULL) {
1559                                         error = EFAULT; /* only possible error */
1560                                         goto release;
1561                                 }
1562                                 space -= resid - uio->uio_resid;
1563                                 resid = uio->uio_resid;
1564                         }
1565                         if (dontroute) {
1566                                 SOCK_LOCK(so);
1567                                 so->so_options |= SO_DONTROUTE;
1568                                 SOCK_UNLOCK(so);
1569                         }
1570                         /*
1571                          * XXX all the SBS_CANTSENDMORE checks previously
1572                          * done could be out of date.  We could have received
1573                          * a reset packet in an interrupt or maybe we slept
1574                          * while doing page faults in uiomove() etc.  We
1575                          * could probably recheck again inside the locking
1576                          * protection here, but there are probably other
1577                          * places that this also happens.  We must rethink
1578                          * this.
1579                          */
1580                         VNET_SO_ASSERT(so);
1581                         error = (*so->so_proto->pr_usrreqs->pru_send)(so,
1582                             (flags & MSG_OOB) ? PRUS_OOB :
1583                         /*
1584                          * If the user set MSG_EOF, the protocol understands
1585                          * this flag and nothing left to send then use
1586                          * PRU_SEND_EOF instead of PRU_SEND.
1587                          */
1588                             ((flags & MSG_EOF) &&
1589                              (so->so_proto->pr_flags & PR_IMPLOPCL) &&
1590                              (resid <= 0)) ?
1591                                 PRUS_EOF :
1592                         /* If there is more to send set PRUS_MORETOCOME. */
1593                             (flags & MSG_MORETOCOME) ||
1594                             (resid > 0 && space > 0) ? PRUS_MORETOCOME : 0,
1595                             top, addr, control, td);
1596                         if (dontroute) {
1597                                 SOCK_LOCK(so);
1598                                 so->so_options &= ~SO_DONTROUTE;
1599                                 SOCK_UNLOCK(so);
1600                         }
1601                         clen = 0;
1602                         control = NULL;
1603                         top = NULL;
1604                         if (error)
1605                                 goto release;
1606                 } while (resid && space > 0);
1607         } while (resid);
1608
1609 release:
1610         sbunlock(&so->so_snd);
1611 out:
1612         if (top != NULL)
1613                 m_freem(top);
1614         if (control != NULL)
1615                 m_freem(control);
1616         return (error);
1617 }
1618
1619 int
1620 sosend(struct socket *so, struct sockaddr *addr, struct uio *uio,
1621     struct mbuf *top, struct mbuf *control, int flags, struct thread *td)
1622 {
1623         int error;
1624
1625         CURVNET_SET(so->so_vnet);
1626         if (!SOLISTENING(so))
1627                 error = so->so_proto->pr_usrreqs->pru_sosend(so, addr, uio,
1628                     top, control, flags, td);
1629         else {
1630                 m_freem(top);
1631                 m_freem(control);
1632                 error = ENOTCONN;
1633         }
1634         CURVNET_RESTORE();
1635         return (error);
1636 }
1637
1638 /*
1639  * The part of soreceive() that implements reading non-inline out-of-band
1640  * data from a socket.  For more complete comments, see soreceive(), from
1641  * which this code originated.
1642  *
1643  * Note that soreceive_rcvoob(), unlike the remainder of soreceive(), is
1644  * unable to return an mbuf chain to the caller.
1645  */
1646 static int
1647 soreceive_rcvoob(struct socket *so, struct uio *uio, int flags)
1648 {
1649         struct protosw *pr = so->so_proto;
1650         struct mbuf *m;
1651         int error;
1652
1653         KASSERT(flags & MSG_OOB, ("soreceive_rcvoob: (flags & MSG_OOB) == 0"));
1654         VNET_SO_ASSERT(so);
1655
1656         m = m_get(M_WAITOK, MT_DATA);
1657         error = (*pr->pr_usrreqs->pru_rcvoob)(so, m, flags & MSG_PEEK);
1658         if (error)
1659                 goto bad;
1660         do {
1661                 error = uiomove(mtod(m, void *),
1662                     (int) min(uio->uio_resid, m->m_len), uio);
1663                 m = m_free(m);
1664         } while (uio->uio_resid && error == 0 && m);
1665 bad:
1666         if (m != NULL)
1667                 m_freem(m);
1668         return (error);
1669 }
1670
1671 /*
1672  * Following replacement or removal of the first mbuf on the first mbuf chain
1673  * of a socket buffer, push necessary state changes back into the socket
1674  * buffer so that other consumers see the values consistently.  'nextrecord'
1675  * is the callers locally stored value of the original value of
1676  * sb->sb_mb->m_nextpkt which must be restored when the lead mbuf changes.
1677  * NOTE: 'nextrecord' may be NULL.
1678  */
1679 static __inline void
1680 sockbuf_pushsync(struct sockbuf *sb, struct mbuf *nextrecord)
1681 {
1682
1683         SOCKBUF_LOCK_ASSERT(sb);
1684         /*
1685          * First, update for the new value of nextrecord.  If necessary, make
1686          * it the first record.
1687          */
1688         if (sb->sb_mb != NULL)
1689                 sb->sb_mb->m_nextpkt = nextrecord;
1690         else
1691                 sb->sb_mb = nextrecord;
1692
1693         /*
1694          * Now update any dependent socket buffer fields to reflect the new
1695          * state.  This is an expanded inline of SB_EMPTY_FIXUP(), with the
1696          * addition of a second clause that takes care of the case where
1697          * sb_mb has been updated, but remains the last record.
1698          */
1699         if (sb->sb_mb == NULL) {
1700                 sb->sb_mbtail = NULL;
1701                 sb->sb_lastrecord = NULL;
1702         } else if (sb->sb_mb->m_nextpkt == NULL)
1703                 sb->sb_lastrecord = sb->sb_mb;
1704 }
1705
1706 /*
1707  * Implement receive operations on a socket.  We depend on the way that
1708  * records are added to the sockbuf by sbappend.  In particular, each record
1709  * (mbufs linked through m_next) must begin with an address if the protocol
1710  * so specifies, followed by an optional mbuf or mbufs containing ancillary
1711  * data, and then zero or more mbufs of data.  In order to allow parallelism
1712  * between network receive and copying to user space, as well as avoid
1713  * sleeping with a mutex held, we release the socket buffer mutex during the
1714  * user space copy.  Although the sockbuf is locked, new data may still be
1715  * appended, and thus we must maintain consistency of the sockbuf during that
1716  * time.
1717  *
1718  * The caller may receive the data as a single mbuf chain by supplying an
1719  * mbuf **mp0 for use in returning the chain.  The uio is then used only for
1720  * the count in uio_resid.
1721  */
1722 int
1723 soreceive_generic(struct socket *so, struct sockaddr **psa, struct uio *uio,
1724     struct mbuf **mp0, struct mbuf **controlp, int *flagsp)
1725 {
1726         struct mbuf *m, **mp;
1727         int flags, error, offset;
1728         ssize_t len;
1729         struct protosw *pr = so->so_proto;
1730         struct mbuf *nextrecord;
1731         int moff, type = 0;
1732         ssize_t orig_resid = uio->uio_resid;
1733
1734         mp = mp0;
1735         if (psa != NULL)
1736                 *psa = NULL;
1737         if (controlp != NULL)
1738                 *controlp = NULL;
1739         if (flagsp != NULL)
1740                 flags = *flagsp &~ MSG_EOR;
1741         else
1742                 flags = 0;
1743         if (flags & MSG_OOB)
1744                 return (soreceive_rcvoob(so, uio, flags));
1745         if (mp != NULL)
1746                 *mp = NULL;
1747         if ((pr->pr_flags & PR_WANTRCVD) && (so->so_state & SS_ISCONFIRMING)
1748             && uio->uio_resid) {
1749                 VNET_SO_ASSERT(so);
1750                 (*pr->pr_usrreqs->pru_rcvd)(so, 0);
1751         }
1752
1753         error = sblock(&so->so_rcv, SBLOCKWAIT(flags));
1754         if (error)
1755                 return (error);
1756
1757 restart:
1758         SOCKBUF_LOCK(&so->so_rcv);
1759         m = so->so_rcv.sb_mb;
1760         /*
1761          * If we have less data than requested, block awaiting more (subject
1762          * to any timeout) if:
1763          *   1. the current count is less than the low water mark, or
1764          *   2. MSG_DONTWAIT is not set
1765          */
1766         if (m == NULL || (((flags & MSG_DONTWAIT) == 0 &&
1767             sbavail(&so->so_rcv) < uio->uio_resid) &&
1768             sbavail(&so->so_rcv) < so->so_rcv.sb_lowat &&
1769             m->m_nextpkt == NULL && (pr->pr_flags & PR_ATOMIC) == 0)) {
1770                 KASSERT(m != NULL || !sbavail(&so->so_rcv),
1771                     ("receive: m == %p sbavail == %u",
1772                     m, sbavail(&so->so_rcv)));
1773                 if (so->so_error) {
1774                         if (m != NULL)
1775                                 goto dontblock;
1776                         error = so->so_error;
1777                         if ((flags & MSG_PEEK) == 0)
1778                                 so->so_error = 0;
1779                         SOCKBUF_UNLOCK(&so->so_rcv);
1780                         goto release;
1781                 }
1782                 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
1783                 if (so->so_rcv.sb_state & SBS_CANTRCVMORE) {
1784                         if (m == NULL) {
1785                                 SOCKBUF_UNLOCK(&so->so_rcv);
1786                                 goto release;
1787                         } else
1788                                 goto dontblock;
1789                 }
1790                 for (; m != NULL; m = m->m_next)
1791                         if (m->m_type == MT_OOBDATA  || (m->m_flags & M_EOR)) {
1792                                 m = so->so_rcv.sb_mb;
1793                                 goto dontblock;
1794                         }
1795                 if ((so->so_state & (SS_ISCONNECTING | SS_ISCONNECTED |
1796                     SS_ISDISCONNECTING | SS_ISDISCONNECTED)) == 0 &&
1797                     (so->so_proto->pr_flags & PR_CONNREQUIRED) != 0) {
1798                         SOCKBUF_UNLOCK(&so->so_rcv);
1799                         error = ENOTCONN;
1800                         goto release;
1801                 }
1802                 if (uio->uio_resid == 0) {
1803                         SOCKBUF_UNLOCK(&so->so_rcv);
1804                         goto release;
1805                 }
1806                 if ((so->so_state & SS_NBIO) ||
1807                     (flags & (MSG_DONTWAIT|MSG_NBIO))) {
1808                         SOCKBUF_UNLOCK(&so->so_rcv);
1809                         error = EWOULDBLOCK;
1810                         goto release;
1811                 }
1812                 SBLASTRECORDCHK(&so->so_rcv);
1813                 SBLASTMBUFCHK(&so->so_rcv);
1814                 error = sbwait(&so->so_rcv);
1815                 SOCKBUF_UNLOCK(&so->so_rcv);
1816                 if (error)
1817                         goto release;
1818                 goto restart;
1819         }
1820 dontblock:
1821         /*
1822          * From this point onward, we maintain 'nextrecord' as a cache of the
1823          * pointer to the next record in the socket buffer.  We must keep the
1824          * various socket buffer pointers and local stack versions of the
1825          * pointers in sync, pushing out modifications before dropping the
1826          * socket buffer mutex, and re-reading them when picking it up.
1827          *
1828          * Otherwise, we will race with the network stack appending new data
1829          * or records onto the socket buffer by using inconsistent/stale
1830          * versions of the field, possibly resulting in socket buffer
1831          * corruption.
1832          *
1833          * By holding the high-level sblock(), we prevent simultaneous
1834          * readers from pulling off the front of the socket buffer.
1835          */
1836         SOCKBUF_LOCK_ASSERT(&so->so_rcv);
1837         if (uio->uio_td)
1838                 uio->uio_td->td_ru.ru_msgrcv++;
1839         KASSERT(m == so->so_rcv.sb_mb, ("soreceive: m != so->so_rcv.sb_mb"));
1840         SBLASTRECORDCHK(&so->so_rcv);
1841         SBLASTMBUFCHK(&so->so_rcv);
1842         nextrecord = m->m_nextpkt;
1843         if (pr->pr_flags & PR_ADDR) {
1844                 KASSERT(m->m_type == MT_SONAME,
1845                     ("m->m_type == %d", m->m_type));
1846                 orig_resid = 0;
1847                 if (psa != NULL)
1848                         *psa = sodupsockaddr(mtod(m, struct sockaddr *),
1849                             M_NOWAIT);
1850                 if (flags & MSG_PEEK) {
1851                         m = m->m_next;
1852                 } else {
1853                         sbfree(&so->so_rcv, m);
1854                         so->so_rcv.sb_mb = m_free(m);
1855                         m = so->so_rcv.sb_mb;
1856                         sockbuf_pushsync(&so->so_rcv, nextrecord);
1857                 }
1858         }
1859
1860         /*
1861          * Process one or more MT_CONTROL mbufs present before any data mbufs
1862          * in the first mbuf chain on the socket buffer.  If MSG_PEEK, we
1863          * just copy the data; if !MSG_PEEK, we call into the protocol to
1864          * perform externalization (or freeing if controlp == NULL).
1865          */
1866         if (m != NULL && m->m_type == MT_CONTROL) {
1867                 struct mbuf *cm = NULL, *cmn;
1868                 struct mbuf **cme = &cm;
1869
1870                 do {
1871                         if (flags & MSG_PEEK) {
1872                                 if (controlp != NULL) {
1873                                         *controlp = m_copym(m, 0, m->m_len,
1874                                             M_NOWAIT);
1875                                         controlp = &(*controlp)->m_next;
1876                                 }
1877                                 m = m->m_next;
1878                         } else {
1879                                 sbfree(&so->so_rcv, m);
1880                                 so->so_rcv.sb_mb = m->m_next;
1881                                 m->m_next = NULL;
1882                                 *cme = m;
1883                                 cme = &(*cme)->m_next;
1884                                 m = so->so_rcv.sb_mb;
1885                         }
1886                 } while (m != NULL && m->m_type == MT_CONTROL);
1887                 if ((flags & MSG_PEEK) == 0)
1888                         sockbuf_pushsync(&so->so_rcv, nextrecord);
1889                 while (cm != NULL) {
1890                         cmn = cm->m_next;
1891                         cm->m_next = NULL;
1892                         if (pr->pr_domain->dom_externalize != NULL) {
1893                                 SOCKBUF_UNLOCK(&so->so_rcv);
1894                                 VNET_SO_ASSERT(so);
1895                                 error = (*pr->pr_domain->dom_externalize)
1896                                     (cm, controlp, flags);
1897                                 SOCKBUF_LOCK(&so->so_rcv);
1898                         } else if (controlp != NULL)
1899                                 *controlp = cm;
1900                         else
1901                                 m_freem(cm);
1902                         if (controlp != NULL) {
1903                                 orig_resid = 0;
1904                                 while (*controlp != NULL)
1905                                         controlp = &(*controlp)->m_next;
1906                         }
1907                         cm = cmn;
1908                 }
1909                 if (m != NULL)
1910                         nextrecord = so->so_rcv.sb_mb->m_nextpkt;
1911                 else
1912                         nextrecord = so->so_rcv.sb_mb;
1913                 orig_resid = 0;
1914         }
1915         if (m != NULL) {
1916                 if ((flags & MSG_PEEK) == 0) {
1917                         KASSERT(m->m_nextpkt == nextrecord,
1918                             ("soreceive: post-control, nextrecord !sync"));
1919                         if (nextrecord == NULL) {
1920                                 KASSERT(so->so_rcv.sb_mb == m,
1921                                     ("soreceive: post-control, sb_mb!=m"));
1922                                 KASSERT(so->so_rcv.sb_lastrecord == m,
1923                                     ("soreceive: post-control, lastrecord!=m"));
1924                         }
1925                 }
1926                 type = m->m_type;
1927                 if (type == MT_OOBDATA)
1928                         flags |= MSG_OOB;
1929         } else {
1930                 if ((flags & MSG_PEEK) == 0) {
1931                         KASSERT(so->so_rcv.sb_mb == nextrecord,
1932                             ("soreceive: sb_mb != nextrecord"));
1933                         if (so->so_rcv.sb_mb == NULL) {
1934                                 KASSERT(so->so_rcv.sb_lastrecord == NULL,
1935                                     ("soreceive: sb_lastercord != NULL"));
1936                         }
1937                 }
1938         }
1939         SOCKBUF_LOCK_ASSERT(&so->so_rcv);
1940         SBLASTRECORDCHK(&so->so_rcv);
1941         SBLASTMBUFCHK(&so->so_rcv);
1942
1943         /*
1944          * Now continue to read any data mbufs off of the head of the socket
1945          * buffer until the read request is satisfied.  Note that 'type' is
1946          * used to store the type of any mbuf reads that have happened so far
1947          * such that soreceive() can stop reading if the type changes, which
1948          * causes soreceive() to return only one of regular data and inline
1949          * out-of-band data in a single socket receive operation.
1950          */
1951         moff = 0;
1952         offset = 0;
1953         while (m != NULL && !(m->m_flags & M_NOTAVAIL) && uio->uio_resid > 0
1954             && error == 0) {
1955                 /*
1956                  * If the type of mbuf has changed since the last mbuf
1957                  * examined ('type'), end the receive operation.
1958                  */
1959                 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
1960                 if (m->m_type == MT_OOBDATA || m->m_type == MT_CONTROL) {
1961                         if (type != m->m_type)
1962                                 break;
1963                 } else if (type == MT_OOBDATA)
1964                         break;
1965                 else
1966                     KASSERT(m->m_type == MT_DATA,
1967                         ("m->m_type == %d", m->m_type));
1968                 so->so_rcv.sb_state &= ~SBS_RCVATMARK;
1969                 len = uio->uio_resid;
1970                 if (so->so_oobmark && len > so->so_oobmark - offset)
1971                         len = so->so_oobmark - offset;
1972                 if (len > m->m_len - moff)
1973                         len = m->m_len - moff;
1974                 /*
1975                  * If mp is set, just pass back the mbufs.  Otherwise copy
1976                  * them out via the uio, then free.  Sockbuf must be
1977                  * consistent here (points to current mbuf, it points to next
1978                  * record) when we drop priority; we must note any additions
1979                  * to the sockbuf when we block interrupts again.
1980                  */
1981                 if (mp == NULL) {
1982                         SOCKBUF_LOCK_ASSERT(&so->so_rcv);
1983                         SBLASTRECORDCHK(&so->so_rcv);
1984                         SBLASTMBUFCHK(&so->so_rcv);
1985                         SOCKBUF_UNLOCK(&so->so_rcv);
1986                         error = uiomove(mtod(m, char *) + moff, (int)len, uio);
1987                         SOCKBUF_LOCK(&so->so_rcv);
1988                         if (error) {
1989                                 /*
1990                                  * The MT_SONAME mbuf has already been removed
1991                                  * from the record, so it is necessary to
1992                                  * remove the data mbufs, if any, to preserve
1993                                  * the invariant in the case of PR_ADDR that
1994                                  * requires MT_SONAME mbufs at the head of
1995                                  * each record.
1996                                  */
1997                                 if (pr->pr_flags & PR_ATOMIC &&
1998                                     ((flags & MSG_PEEK) == 0))
1999                                         (void)sbdroprecord_locked(&so->so_rcv);
2000                                 SOCKBUF_UNLOCK(&so->so_rcv);
2001                                 goto release;
2002                         }
2003                 } else
2004                         uio->uio_resid -= len;
2005                 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2006                 if (len == m->m_len - moff) {
2007                         if (m->m_flags & M_EOR)
2008                                 flags |= MSG_EOR;
2009                         if (flags & MSG_PEEK) {
2010                                 m = m->m_next;
2011                                 moff = 0;
2012                         } else {
2013                                 nextrecord = m->m_nextpkt;
2014                                 sbfree(&so->so_rcv, m);
2015                                 if (mp != NULL) {
2016                                         m->m_nextpkt = NULL;
2017                                         *mp = m;
2018                                         mp = &m->m_next;
2019                                         so->so_rcv.sb_mb = m = m->m_next;
2020                                         *mp = NULL;
2021                                 } else {
2022                                         so->so_rcv.sb_mb = m_free(m);
2023                                         m = so->so_rcv.sb_mb;
2024                                 }
2025                                 sockbuf_pushsync(&so->so_rcv, nextrecord);
2026                                 SBLASTRECORDCHK(&so->so_rcv);
2027                                 SBLASTMBUFCHK(&so->so_rcv);
2028                         }
2029                 } else {
2030                         if (flags & MSG_PEEK)
2031                                 moff += len;
2032                         else {
2033                                 if (mp != NULL) {
2034                                         if (flags & MSG_DONTWAIT) {
2035                                                 *mp = m_copym(m, 0, len,
2036                                                     M_NOWAIT);
2037                                                 if (*mp == NULL) {
2038                                                         /*
2039                                                          * m_copym() couldn't
2040                                                          * allocate an mbuf.
2041                                                          * Adjust uio_resid back
2042                                                          * (it was adjusted
2043                                                          * down by len bytes,
2044                                                          * which we didn't end
2045                                                          * up "copying" over).
2046                                                          */
2047                                                         uio->uio_resid += len;
2048                                                         break;
2049                                                 }
2050                                         } else {
2051                                                 SOCKBUF_UNLOCK(&so->so_rcv);
2052                                                 *mp = m_copym(m, 0, len,
2053                                                     M_WAITOK);
2054                                                 SOCKBUF_LOCK(&so->so_rcv);
2055                                         }
2056                                 }
2057                                 sbcut_locked(&so->so_rcv, len);
2058                         }
2059                 }
2060                 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2061                 if (so->so_oobmark) {
2062                         if ((flags & MSG_PEEK) == 0) {
2063                                 so->so_oobmark -= len;
2064                                 if (so->so_oobmark == 0) {
2065                                         so->so_rcv.sb_state |= SBS_RCVATMARK;
2066                                         break;
2067                                 }
2068                         } else {
2069                                 offset += len;
2070                                 if (offset == so->so_oobmark)
2071                                         break;
2072                         }
2073                 }
2074                 if (flags & MSG_EOR)
2075                         break;
2076                 /*
2077                  * If the MSG_WAITALL flag is set (for non-atomic socket), we
2078                  * must not quit until "uio->uio_resid == 0" or an error
2079                  * termination.  If a signal/timeout occurs, return with a
2080                  * short count but without error.  Keep sockbuf locked
2081                  * against other readers.
2082                  */
2083                 while (flags & MSG_WAITALL && m == NULL && uio->uio_resid > 0 &&
2084                     !sosendallatonce(so) && nextrecord == NULL) {
2085                         SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2086                         if (so->so_error ||
2087                             so->so_rcv.sb_state & SBS_CANTRCVMORE)
2088                                 break;
2089                         /*
2090                          * Notify the protocol that some data has been
2091                          * drained before blocking.
2092                          */
2093                         if (pr->pr_flags & PR_WANTRCVD) {
2094                                 SOCKBUF_UNLOCK(&so->so_rcv);
2095                                 VNET_SO_ASSERT(so);
2096                                 (*pr->pr_usrreqs->pru_rcvd)(so, flags);
2097                                 SOCKBUF_LOCK(&so->so_rcv);
2098                         }
2099                         SBLASTRECORDCHK(&so->so_rcv);
2100                         SBLASTMBUFCHK(&so->so_rcv);
2101                         /*
2102                          * We could receive some data while was notifying
2103                          * the protocol. Skip blocking in this case.
2104                          */
2105                         if (so->so_rcv.sb_mb == NULL) {
2106                                 error = sbwait(&so->so_rcv);
2107                                 if (error) {
2108                                         SOCKBUF_UNLOCK(&so->so_rcv);
2109                                         goto release;
2110                                 }
2111                         }
2112                         m = so->so_rcv.sb_mb;
2113                         if (m != NULL)
2114                                 nextrecord = m->m_nextpkt;
2115                 }
2116         }
2117
2118         SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2119         if (m != NULL && pr->pr_flags & PR_ATOMIC) {
2120                 flags |= MSG_TRUNC;
2121                 if ((flags & MSG_PEEK) == 0)
2122                         (void) sbdroprecord_locked(&so->so_rcv);
2123         }
2124         if ((flags & MSG_PEEK) == 0) {
2125                 if (m == NULL) {
2126                         /*
2127                          * First part is an inline SB_EMPTY_FIXUP().  Second
2128                          * part makes sure sb_lastrecord is up-to-date if
2129                          * there is still data in the socket buffer.
2130                          */
2131                         so->so_rcv.sb_mb = nextrecord;
2132                         if (so->so_rcv.sb_mb == NULL) {
2133                                 so->so_rcv.sb_mbtail = NULL;
2134                                 so->so_rcv.sb_lastrecord = NULL;
2135                         } else if (nextrecord->m_nextpkt == NULL)
2136                                 so->so_rcv.sb_lastrecord = nextrecord;
2137                 }
2138                 SBLASTRECORDCHK(&so->so_rcv);
2139                 SBLASTMBUFCHK(&so->so_rcv);
2140                 /*
2141                  * If soreceive() is being done from the socket callback,
2142                  * then don't need to generate ACK to peer to update window,
2143                  * since ACK will be generated on return to TCP.
2144                  */
2145                 if (!(flags & MSG_SOCALLBCK) &&
2146                     (pr->pr_flags & PR_WANTRCVD)) {
2147                         SOCKBUF_UNLOCK(&so->so_rcv);
2148                         VNET_SO_ASSERT(so);
2149                         (*pr->pr_usrreqs->pru_rcvd)(so, flags);
2150                         SOCKBUF_LOCK(&so->so_rcv);
2151                 }
2152         }
2153         SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2154         if (orig_resid == uio->uio_resid && orig_resid &&
2155             (flags & MSG_EOR) == 0 && (so->so_rcv.sb_state & SBS_CANTRCVMORE) == 0) {
2156                 SOCKBUF_UNLOCK(&so->so_rcv);
2157                 goto restart;
2158         }
2159         SOCKBUF_UNLOCK(&so->so_rcv);
2160
2161         if (flagsp != NULL)
2162                 *flagsp |= flags;
2163 release:
2164         sbunlock(&so->so_rcv);
2165         return (error);
2166 }
2167
2168 /*
2169  * Optimized version of soreceive() for stream (TCP) sockets.
2170  */
2171 int
2172 soreceive_stream(struct socket *so, struct sockaddr **psa, struct uio *uio,
2173     struct mbuf **mp0, struct mbuf **controlp, int *flagsp)
2174 {
2175         int len = 0, error = 0, flags, oresid;
2176         struct sockbuf *sb;
2177         struct mbuf *m, *n = NULL;
2178
2179         /* We only do stream sockets. */
2180         if (so->so_type != SOCK_STREAM)
2181                 return (EINVAL);
2182         if (psa != NULL)
2183                 *psa = NULL;
2184         if (flagsp != NULL)
2185                 flags = *flagsp &~ MSG_EOR;
2186         else
2187                 flags = 0;
2188         if (controlp != NULL)
2189                 *controlp = NULL;
2190         if (flags & MSG_OOB)
2191                 return (soreceive_rcvoob(so, uio, flags));
2192         if (mp0 != NULL)
2193                 *mp0 = NULL;
2194
2195         sb = &so->so_rcv;
2196
2197         /* Prevent other readers from entering the socket. */
2198         error = sblock(sb, SBLOCKWAIT(flags));
2199         if (error)
2200                 return (error);
2201         SOCKBUF_LOCK(sb);
2202
2203         /* Easy one, no space to copyout anything. */
2204         if (uio->uio_resid == 0) {
2205                 error = EINVAL;
2206                 goto out;
2207         }
2208         oresid = uio->uio_resid;
2209
2210         /* We will never ever get anything unless we are or were connected. */
2211         if (!(so->so_state & (SS_ISCONNECTED|SS_ISDISCONNECTED))) {
2212                 error = ENOTCONN;
2213                 goto out;
2214         }
2215
2216 restart:
2217         SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2218
2219         /* Abort if socket has reported problems. */
2220         if (so->so_error) {
2221                 if (sbavail(sb) > 0)
2222                         goto deliver;
2223                 if (oresid > uio->uio_resid)
2224                         goto out;
2225                 error = so->so_error;
2226                 if (!(flags & MSG_PEEK))
2227                         so->so_error = 0;
2228                 goto out;
2229         }
2230
2231         /* Door is closed.  Deliver what is left, if any. */
2232         if (sb->sb_state & SBS_CANTRCVMORE) {
2233                 if (sbavail(sb) > 0)
2234                         goto deliver;
2235                 else
2236                         goto out;
2237         }
2238
2239         /* Socket buffer is empty and we shall not block. */
2240         if (sbavail(sb) == 0 &&
2241             ((so->so_state & SS_NBIO) || (flags & (MSG_DONTWAIT|MSG_NBIO)))) {
2242                 error = EAGAIN;
2243                 goto out;
2244         }
2245
2246         /* Socket buffer got some data that we shall deliver now. */
2247         if (sbavail(sb) > 0 && !(flags & MSG_WAITALL) &&
2248             ((so->so_state & SS_NBIO) ||
2249              (flags & (MSG_DONTWAIT|MSG_NBIO)) ||
2250              sbavail(sb) >= sb->sb_lowat ||
2251              sbavail(sb) >= uio->uio_resid ||
2252              sbavail(sb) >= sb->sb_hiwat) ) {
2253                 goto deliver;
2254         }
2255
2256         /* On MSG_WAITALL we must wait until all data or error arrives. */
2257         if ((flags & MSG_WAITALL) &&
2258             (sbavail(sb) >= uio->uio_resid || sbavail(sb) >= sb->sb_hiwat))
2259                 goto deliver;
2260
2261         /*
2262          * Wait and block until (more) data comes in.
2263          * NB: Drops the sockbuf lock during wait.
2264          */
2265         error = sbwait(sb);
2266         if (error)
2267                 goto out;
2268         goto restart;
2269
2270 deliver:
2271         SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2272         KASSERT(sbavail(sb) > 0, ("%s: sockbuf empty", __func__));
2273         KASSERT(sb->sb_mb != NULL, ("%s: sb_mb == NULL", __func__));
2274
2275         /* Statistics. */
2276         if (uio->uio_td)
2277                 uio->uio_td->td_ru.ru_msgrcv++;
2278
2279         /* Fill uio until full or current end of socket buffer is reached. */
2280         len = min(uio->uio_resid, sbavail(sb));
2281         if (mp0 != NULL) {
2282                 /* Dequeue as many mbufs as possible. */
2283                 if (!(flags & MSG_PEEK) && len >= sb->sb_mb->m_len) {
2284                         if (*mp0 == NULL)
2285                                 *mp0 = sb->sb_mb;
2286                         else
2287                                 m_cat(*mp0, sb->sb_mb);
2288                         for (m = sb->sb_mb;
2289                              m != NULL && m->m_len <= len;
2290                              m = m->m_next) {
2291                                 KASSERT(!(m->m_flags & M_NOTAVAIL),
2292                                     ("%s: m %p not available", __func__, m));
2293                                 len -= m->m_len;
2294                                 uio->uio_resid -= m->m_len;
2295                                 sbfree(sb, m);
2296                                 n = m;
2297                         }
2298                         n->m_next = NULL;
2299                         sb->sb_mb = m;
2300                         sb->sb_lastrecord = sb->sb_mb;
2301                         if (sb->sb_mb == NULL)
2302                                 SB_EMPTY_FIXUP(sb);
2303                 }
2304                 /* Copy the remainder. */
2305                 if (len > 0) {
2306                         KASSERT(sb->sb_mb != NULL,
2307                             ("%s: len > 0 && sb->sb_mb empty", __func__));
2308
2309                         m = m_copym(sb->sb_mb, 0, len, M_NOWAIT);
2310                         if (m == NULL)
2311                                 len = 0;        /* Don't flush data from sockbuf. */
2312                         else
2313                                 uio->uio_resid -= len;
2314                         if (*mp0 != NULL)
2315                                 m_cat(*mp0, m);
2316                         else
2317                                 *mp0 = m;
2318                         if (*mp0 == NULL) {
2319                                 error = ENOBUFS;
2320                                 goto out;
2321                         }
2322                 }
2323         } else {
2324                 /* NB: Must unlock socket buffer as uiomove may sleep. */
2325                 SOCKBUF_UNLOCK(sb);
2326                 error = m_mbuftouio(uio, sb->sb_mb, len);
2327                 SOCKBUF_LOCK(sb);
2328                 if (error)
2329                         goto out;
2330         }
2331         SBLASTRECORDCHK(sb);
2332         SBLASTMBUFCHK(sb);
2333
2334         /*
2335          * Remove the delivered data from the socket buffer unless we
2336          * were only peeking.
2337          */
2338         if (!(flags & MSG_PEEK)) {
2339                 if (len > 0)
2340                         sbdrop_locked(sb, len);
2341
2342                 /* Notify protocol that we drained some data. */
2343                 if ((so->so_proto->pr_flags & PR_WANTRCVD) &&
2344                     (((flags & MSG_WAITALL) && uio->uio_resid > 0) ||
2345                      !(flags & MSG_SOCALLBCK))) {
2346                         SOCKBUF_UNLOCK(sb);
2347                         VNET_SO_ASSERT(so);
2348                         (*so->so_proto->pr_usrreqs->pru_rcvd)(so, flags);
2349                         SOCKBUF_LOCK(sb);
2350                 }
2351         }
2352
2353         /*
2354          * For MSG_WAITALL we may have to loop again and wait for
2355          * more data to come in.
2356          */
2357         if ((flags & MSG_WAITALL) && uio->uio_resid > 0)
2358                 goto restart;
2359 out:
2360         SOCKBUF_LOCK_ASSERT(sb);
2361         SBLASTRECORDCHK(sb);
2362         SBLASTMBUFCHK(sb);
2363         SOCKBUF_UNLOCK(sb);
2364         sbunlock(sb);
2365         return (error);
2366 }
2367
2368 /*
2369  * Optimized version of soreceive() for simple datagram cases from userspace.
2370  * Unlike in the stream case, we're able to drop a datagram if copyout()
2371  * fails, and because we handle datagrams atomically, we don't need to use a
2372  * sleep lock to prevent I/O interlacing.
2373  */
2374 int
2375 soreceive_dgram(struct socket *so, struct sockaddr **psa, struct uio *uio,
2376     struct mbuf **mp0, struct mbuf **controlp, int *flagsp)
2377 {
2378         struct mbuf *m, *m2;
2379         int flags, error;
2380         ssize_t len;
2381         struct protosw *pr = so->so_proto;
2382         struct mbuf *nextrecord;
2383
2384         if (psa != NULL)
2385                 *psa = NULL;
2386         if (controlp != NULL)
2387                 *controlp = NULL;
2388         if (flagsp != NULL)
2389                 flags = *flagsp &~ MSG_EOR;
2390         else
2391                 flags = 0;
2392
2393         /*
2394          * For any complicated cases, fall back to the full
2395          * soreceive_generic().
2396          */
2397         if (mp0 != NULL || (flags & MSG_PEEK) || (flags & MSG_OOB))
2398                 return (soreceive_generic(so, psa, uio, mp0, controlp,
2399                     flagsp));
2400
2401         /*
2402          * Enforce restrictions on use.
2403          */
2404         KASSERT((pr->pr_flags & PR_WANTRCVD) == 0,
2405             ("soreceive_dgram: wantrcvd"));
2406         KASSERT(pr->pr_flags & PR_ATOMIC, ("soreceive_dgram: !atomic"));
2407         KASSERT((so->so_rcv.sb_state & SBS_RCVATMARK) == 0,
2408             ("soreceive_dgram: SBS_RCVATMARK"));
2409         KASSERT((so->so_proto->pr_flags & PR_CONNREQUIRED) == 0,
2410             ("soreceive_dgram: P_CONNREQUIRED"));
2411
2412         /*
2413          * Loop blocking while waiting for a datagram.
2414          */
2415         SOCKBUF_LOCK(&so->so_rcv);
2416         while ((m = so->so_rcv.sb_mb) == NULL) {
2417                 KASSERT(sbavail(&so->so_rcv) == 0,
2418                     ("soreceive_dgram: sb_mb NULL but sbavail %u",
2419                     sbavail(&so->so_rcv)));
2420                 if (so->so_error) {
2421                         error = so->so_error;
2422                         so->so_error = 0;
2423                         SOCKBUF_UNLOCK(&so->so_rcv);
2424                         return (error);
2425                 }
2426                 if (so->so_rcv.sb_state & SBS_CANTRCVMORE ||
2427                     uio->uio_resid == 0) {
2428                         SOCKBUF_UNLOCK(&so->so_rcv);
2429                         return (0);
2430                 }
2431                 if ((so->so_state & SS_NBIO) ||
2432                     (flags & (MSG_DONTWAIT|MSG_NBIO))) {
2433                         SOCKBUF_UNLOCK(&so->so_rcv);
2434                         return (EWOULDBLOCK);
2435                 }
2436                 SBLASTRECORDCHK(&so->so_rcv);
2437                 SBLASTMBUFCHK(&so->so_rcv);
2438                 error = sbwait(&so->so_rcv);
2439                 if (error) {
2440                         SOCKBUF_UNLOCK(&so->so_rcv);
2441                         return (error);
2442                 }
2443         }
2444         SOCKBUF_LOCK_ASSERT(&so->so_rcv);
2445
2446         if (uio->uio_td)
2447                 uio->uio_td->td_ru.ru_msgrcv++;
2448         SBLASTRECORDCHK(&so->so_rcv);
2449         SBLASTMBUFCHK(&so->so_rcv);
2450         nextrecord = m->m_nextpkt;
2451         if (nextrecord == NULL) {
2452                 KASSERT(so->so_rcv.sb_lastrecord == m,
2453                     ("soreceive_dgram: lastrecord != m"));
2454         }
2455
2456         KASSERT(so->so_rcv.sb_mb->m_nextpkt == nextrecord,
2457             ("soreceive_dgram: m_nextpkt != nextrecord"));
2458
2459         /*
2460          * Pull 'm' and its chain off the front of the packet queue.
2461          */
2462         so->so_rcv.sb_mb = NULL;
2463         sockbuf_pushsync(&so->so_rcv, nextrecord);
2464
2465         /*
2466          * Walk 'm's chain and free that many bytes from the socket buffer.
2467          */
2468         for (m2 = m; m2 != NULL; m2 = m2->m_next)
2469                 sbfree(&so->so_rcv, m2);
2470
2471         /*
2472          * Do a few last checks before we let go of the lock.
2473          */
2474         SBLASTRECORDCHK(&so->so_rcv);
2475         SBLASTMBUFCHK(&so->so_rcv);
2476         SOCKBUF_UNLOCK(&so->so_rcv);
2477
2478         if (pr->pr_flags & PR_ADDR) {
2479                 KASSERT(m->m_type == MT_SONAME,
2480                     ("m->m_type == %d", m->m_type));
2481                 if (psa != NULL)
2482                         *psa = sodupsockaddr(mtod(m, struct sockaddr *),
2483                             M_NOWAIT);
2484                 m = m_free(m);
2485         }
2486         if (m == NULL) {
2487                 /* XXXRW: Can this happen? */
2488                 return (0);
2489         }
2490
2491         /*
2492          * Packet to copyout() is now in 'm' and it is disconnected from the
2493          * queue.
2494          *
2495          * Process one or more MT_CONTROL mbufs present before any data mbufs
2496          * in the first mbuf chain on the socket buffer.  We call into the
2497          * protocol to perform externalization (or freeing if controlp ==
2498          * NULL). In some cases there can be only MT_CONTROL mbufs without
2499          * MT_DATA mbufs.
2500          */
2501         if (m->m_type == MT_CONTROL) {
2502                 struct mbuf *cm = NULL, *cmn;
2503                 struct mbuf **cme = &cm;
2504
2505                 do {
2506                         m2 = m->m_next;
2507                         m->m_next = NULL;
2508                         *cme = m;
2509                         cme = &(*cme)->m_next;
2510                         m = m2;
2511                 } while (m != NULL && m->m_type == MT_CONTROL);
2512                 while (cm != NULL) {
2513                         cmn = cm->m_next;
2514                         cm->m_next = NULL;
2515                         if (pr->pr_domain->dom_externalize != NULL) {
2516                                 error = (*pr->pr_domain->dom_externalize)
2517                                     (cm, controlp, flags);
2518                         } else if (controlp != NULL)
2519                                 *controlp = cm;
2520                         else
2521                                 m_freem(cm);
2522                         if (controlp != NULL) {
2523                                 while (*controlp != NULL)
2524                                         controlp = &(*controlp)->m_next;
2525                         }
2526                         cm = cmn;
2527                 }
2528         }
2529         KASSERT(m == NULL || m->m_type == MT_DATA,
2530             ("soreceive_dgram: !data"));
2531         while (m != NULL && uio->uio_resid > 0) {
2532                 len = uio->uio_resid;
2533                 if (len > m->m_len)
2534                         len = m->m_len;
2535                 error = uiomove(mtod(m, char *), (int)len, uio);
2536                 if (error) {
2537                         m_freem(m);
2538                         return (error);
2539                 }
2540                 if (len == m->m_len)
2541                         m = m_free(m);
2542                 else {
2543                         m->m_data += len;
2544                         m->m_len -= len;
2545                 }
2546         }
2547         if (m != NULL) {
2548                 flags |= MSG_TRUNC;
2549                 m_freem(m);
2550         }
2551         if (flagsp != NULL)
2552                 *flagsp |= flags;
2553         return (0);
2554 }
2555
2556 int
2557 soreceive(struct socket *so, struct sockaddr **psa, struct uio *uio,
2558     struct mbuf **mp0, struct mbuf **controlp, int *flagsp)
2559 {
2560         int error;
2561
2562         CURVNET_SET(so->so_vnet);
2563         if (!SOLISTENING(so))
2564                 error = (so->so_proto->pr_usrreqs->pru_soreceive(so, psa, uio,
2565                     mp0, controlp, flagsp));
2566         else
2567                 error = ENOTCONN;
2568         CURVNET_RESTORE();
2569         return (error);
2570 }
2571
2572 int
2573 soshutdown(struct socket *so, int how)
2574 {
2575         struct protosw *pr = so->so_proto;
2576         int error, soerror_enotconn;
2577
2578         if (!(how == SHUT_RD || how == SHUT_WR || how == SHUT_RDWR))
2579                 return (EINVAL);
2580
2581         soerror_enotconn = 0;
2582         if ((so->so_state &
2583             (SS_ISCONNECTED | SS_ISCONNECTING | SS_ISDISCONNECTING)) == 0) {
2584                 /*
2585                  * POSIX mandates us to return ENOTCONN when shutdown(2) is
2586                  * invoked on a datagram sockets, however historically we would
2587                  * actually tear socket down. This is known to be leveraged by
2588                  * some applications to unblock process waiting in recvXXX(2)
2589                  * by other process that it shares that socket with. Try to meet
2590                  * both backward-compatibility and POSIX requirements by forcing
2591                  * ENOTCONN but still asking protocol to perform pru_shutdown().
2592                  */
2593                 if (so->so_type != SOCK_DGRAM && !SOLISTENING(so))
2594                         return (ENOTCONN);
2595                 soerror_enotconn = 1;
2596         }
2597
2598         if (SOLISTENING(so)) {
2599                 if (how != SHUT_WR) {
2600                         SOLISTEN_LOCK(so);
2601                         so->so_error = ECONNABORTED;
2602                         solisten_wakeup(so);    /* unlocks so */
2603                 }
2604                 goto done;
2605         }
2606
2607         CURVNET_SET(so->so_vnet);
2608         if (pr->pr_usrreqs->pru_flush != NULL)
2609                 (*pr->pr_usrreqs->pru_flush)(so, how);
2610         if (how != SHUT_WR)
2611                 sorflush(so);
2612         if (how != SHUT_RD) {
2613                 error = (*pr->pr_usrreqs->pru_shutdown)(so);
2614                 wakeup(&so->so_timeo);
2615                 CURVNET_RESTORE();
2616                 return ((error == 0 && soerror_enotconn) ? ENOTCONN : error);
2617         }
2618         wakeup(&so->so_timeo);
2619         CURVNET_RESTORE();
2620
2621 done:
2622         return (soerror_enotconn ? ENOTCONN : 0);
2623 }
2624
2625 void
2626 sorflush(struct socket *so)
2627 {
2628         struct sockbuf *sb = &so->so_rcv;
2629         struct protosw *pr = so->so_proto;
2630         struct socket aso;
2631
2632         VNET_SO_ASSERT(so);
2633
2634         /*
2635          * In order to avoid calling dom_dispose with the socket buffer mutex
2636          * held, and in order to generally avoid holding the lock for a long
2637          * time, we make a copy of the socket buffer and clear the original
2638          * (except locks, state).  The new socket buffer copy won't have
2639          * initialized locks so we can only call routines that won't use or
2640          * assert those locks.
2641          *
2642          * Dislodge threads currently blocked in receive and wait to acquire
2643          * a lock against other simultaneous readers before clearing the
2644          * socket buffer.  Don't let our acquire be interrupted by a signal
2645          * despite any existing socket disposition on interruptable waiting.
2646          */
2647         socantrcvmore(so);
2648         (void) sblock(sb, SBL_WAIT | SBL_NOINTR);
2649
2650         /*
2651          * Invalidate/clear most of the sockbuf structure, but leave selinfo
2652          * and mutex data unchanged.
2653          */
2654         SOCKBUF_LOCK(sb);
2655         bzero(&aso, sizeof(aso));
2656         aso.so_pcb = so->so_pcb;
2657         bcopy(&sb->sb_startzero, &aso.so_rcv.sb_startzero,
2658             sizeof(*sb) - offsetof(struct sockbuf, sb_startzero));
2659         bzero(&sb->sb_startzero,
2660             sizeof(*sb) - offsetof(struct sockbuf, sb_startzero));
2661         SOCKBUF_UNLOCK(sb);
2662         sbunlock(sb);
2663
2664         /*
2665          * Dispose of special rights and flush the copied socket.  Don't call
2666          * any unsafe routines (that rely on locks being initialized) on aso.
2667          */
2668         if (pr->pr_flags & PR_RIGHTS && pr->pr_domain->dom_dispose != NULL)
2669                 (*pr->pr_domain->dom_dispose)(&aso);
2670         sbrelease_internal(&aso.so_rcv, so);
2671 }
2672
2673 /*
2674  * Wrapper for Socket established helper hook.
2675  * Parameters: socket, context of the hook point, hook id.
2676  */
2677 static int inline
2678 hhook_run_socket(struct socket *so, void *hctx, int32_t h_id)
2679 {
2680         struct socket_hhook_data hhook_data = {
2681                 .so = so,
2682                 .hctx = hctx,
2683                 .m = NULL,
2684                 .status = 0
2685         };
2686
2687         CURVNET_SET(so->so_vnet);
2688         HHOOKS_RUN_IF(V_socket_hhh[h_id], &hhook_data, &so->osd);
2689         CURVNET_RESTORE();
2690
2691         /* Ugly but needed, since hhooks return void for now */
2692         return (hhook_data.status);
2693 }
2694
2695 /*
2696  * Perhaps this routine, and sooptcopyout(), below, ought to come in an
2697  * additional variant to handle the case where the option value needs to be
2698  * some kind of integer, but not a specific size.  In addition to their use
2699  * here, these functions are also called by the protocol-level pr_ctloutput()
2700  * routines.
2701  */
2702 int
2703 sooptcopyin(struct sockopt *sopt, void *buf, size_t len, size_t minlen)
2704 {
2705         size_t  valsize;
2706
2707         /*
2708          * If the user gives us more than we wanted, we ignore it, but if we
2709          * don't get the minimum length the caller wants, we return EINVAL.
2710          * On success, sopt->sopt_valsize is set to however much we actually
2711          * retrieved.
2712          */
2713         if ((valsize = sopt->sopt_valsize) < minlen)
2714                 return EINVAL;
2715         if (valsize > len)
2716                 sopt->sopt_valsize = valsize = len;
2717
2718         if (sopt->sopt_td != NULL)
2719                 return (copyin(sopt->sopt_val, buf, valsize));
2720
2721         bcopy(sopt->sopt_val, buf, valsize);
2722         return (0);
2723 }
2724
2725 /*
2726  * Kernel version of setsockopt(2).
2727  *
2728  * XXX: optlen is size_t, not socklen_t
2729  */
2730 int
2731 so_setsockopt(struct socket *so, int level, int optname, void *optval,
2732     size_t optlen)
2733 {
2734         struct sockopt sopt;
2735
2736         sopt.sopt_level = level;
2737         sopt.sopt_name = optname;
2738         sopt.sopt_dir = SOPT_SET;
2739         sopt.sopt_val = optval;
2740         sopt.sopt_valsize = optlen;
2741         sopt.sopt_td = NULL;
2742         return (sosetopt(so, &sopt));
2743 }
2744
2745 int
2746 sosetopt(struct socket *so, struct sockopt *sopt)
2747 {
2748         int     error, optval;
2749         struct  linger l;
2750         struct  timeval tv;
2751         sbintime_t val;
2752         uint32_t val32;
2753 #ifdef MAC
2754         struct mac extmac;
2755 #endif
2756
2757         CURVNET_SET(so->so_vnet);
2758         error = 0;
2759         if (sopt->sopt_level != SOL_SOCKET) {
2760                 if (so->so_proto->pr_ctloutput != NULL) {
2761                         error = (*so->so_proto->pr_ctloutput)(so, sopt);
2762                         CURVNET_RESTORE();
2763                         return (error);
2764                 }
2765                 error = ENOPROTOOPT;
2766         } else {
2767                 switch (sopt->sopt_name) {
2768                 case SO_ACCEPTFILTER:
2769                         error = accept_filt_setopt(so, sopt);
2770                         if (error)
2771                                 goto bad;
2772                         break;
2773
2774                 case SO_LINGER:
2775                         error = sooptcopyin(sopt, &l, sizeof l, sizeof l);
2776                         if (error)
2777                                 goto bad;
2778                         if (l.l_linger < 0 ||
2779                             l.l_linger > USHRT_MAX ||
2780                             l.l_linger > (INT_MAX / hz)) {
2781                                 error = EDOM;
2782                                 goto bad;
2783                         }
2784                         SOCK_LOCK(so);
2785                         so->so_linger = l.l_linger;
2786                         if (l.l_onoff)
2787                                 so->so_options |= SO_LINGER;
2788                         else
2789                                 so->so_options &= ~SO_LINGER;
2790                         SOCK_UNLOCK(so);
2791                         break;
2792
2793                 case SO_DEBUG:
2794                 case SO_KEEPALIVE:
2795                 case SO_DONTROUTE:
2796                 case SO_USELOOPBACK:
2797                 case SO_BROADCAST:
2798                 case SO_REUSEADDR:
2799                 case SO_REUSEPORT:
2800                 case SO_REUSEPORT_LB:
2801                 case SO_OOBINLINE:
2802                 case SO_TIMESTAMP:
2803                 case SO_BINTIME:
2804                 case SO_NOSIGPIPE:
2805                 case SO_NO_DDP:
2806                 case SO_NO_OFFLOAD:
2807                         error = sooptcopyin(sopt, &optval, sizeof optval,
2808                             sizeof optval);
2809                         if (error)
2810                                 goto bad;
2811                         SOCK_LOCK(so);
2812                         if (optval)
2813                                 so->so_options |= sopt->sopt_name;
2814                         else
2815                                 so->so_options &= ~sopt->sopt_name;
2816                         SOCK_UNLOCK(so);
2817                         break;
2818
2819                 case SO_SETFIB:
2820                         error = sooptcopyin(sopt, &optval, sizeof optval,
2821                             sizeof optval);
2822                         if (error)
2823                                 goto bad;
2824
2825                         if (optval < 0 || optval >= rt_numfibs) {
2826                                 error = EINVAL;
2827                                 goto bad;
2828                         }
2829                         if (((so->so_proto->pr_domain->dom_family == PF_INET) ||
2830                            (so->so_proto->pr_domain->dom_family == PF_INET6) ||
2831                            (so->so_proto->pr_domain->dom_family == PF_ROUTE)))
2832                                 so->so_fibnum = optval;
2833                         else
2834                                 so->so_fibnum = 0;
2835                         break;
2836
2837                 case SO_USER_COOKIE:
2838                         error = sooptcopyin(sopt, &val32, sizeof val32,
2839                             sizeof val32);
2840                         if (error)
2841                                 goto bad;
2842                         so->so_user_cookie = val32;
2843                         break;
2844
2845                 case SO_SNDBUF:
2846                 case SO_RCVBUF:
2847                 case SO_SNDLOWAT:
2848                 case SO_RCVLOWAT:
2849                         error = sooptcopyin(sopt, &optval, sizeof optval,
2850                             sizeof optval);
2851                         if (error)
2852                                 goto bad;
2853
2854                         /*
2855                          * Values < 1 make no sense for any of these options,
2856                          * so disallow them.
2857                          */
2858                         if (optval < 1) {
2859                                 error = EINVAL;
2860                                 goto bad;
2861                         }
2862
2863                         error = sbsetopt(so, sopt->sopt_name, optval);
2864                         break;
2865
2866                 case SO_SNDTIMEO:
2867                 case SO_RCVTIMEO:
2868 #ifdef COMPAT_FREEBSD32
2869                         if (SV_CURPROC_FLAG(SV_ILP32)) {
2870                                 struct timeval32 tv32;
2871
2872                                 error = sooptcopyin(sopt, &tv32, sizeof tv32,
2873                                     sizeof tv32);
2874                                 CP(tv32, tv, tv_sec);
2875                                 CP(tv32, tv, tv_usec);
2876                         } else
2877 #endif
2878                                 error = sooptcopyin(sopt, &tv, sizeof tv,
2879                                     sizeof tv);
2880                         if (error)
2881                                 goto bad;
2882                         if (tv.tv_sec < 0 || tv.tv_usec < 0 ||
2883                             tv.tv_usec >= 1000000) {
2884                                 error = EDOM;
2885                                 goto bad;
2886                         }
2887                         if (tv.tv_sec > INT32_MAX)
2888                                 val = SBT_MAX;
2889                         else
2890                                 val = tvtosbt(tv);
2891                         switch (sopt->sopt_name) {
2892                         case SO_SNDTIMEO:
2893                                 so->so_snd.sb_timeo = val;
2894                                 break;
2895                         case SO_RCVTIMEO:
2896                                 so->so_rcv.sb_timeo = val;
2897                                 break;
2898                         }
2899                         break;
2900
2901                 case SO_LABEL:
2902 #ifdef MAC
2903                         error = sooptcopyin(sopt, &extmac, sizeof extmac,
2904                             sizeof extmac);
2905                         if (error)
2906                                 goto bad;
2907                         error = mac_setsockopt_label(sopt->sopt_td->td_ucred,
2908                             so, &extmac);
2909 #else
2910                         error = EOPNOTSUPP;
2911 #endif
2912                         break;
2913
2914                 case SO_TS_CLOCK:
2915                         error = sooptcopyin(sopt, &optval, sizeof optval,
2916                             sizeof optval);
2917                         if (error)
2918                                 goto bad;
2919                         if (optval < 0 || optval > SO_TS_CLOCK_MAX) {
2920                                 error = EINVAL;
2921                                 goto bad;
2922                         }
2923                         so->so_ts_clock = optval;
2924                         break;
2925
2926                 case SO_MAX_PACING_RATE:
2927                         error = sooptcopyin(sopt, &val32, sizeof(val32),
2928                             sizeof(val32));
2929                         if (error)
2930                                 goto bad;
2931                         so->so_max_pacing_rate = val32;
2932                         break;
2933
2934                 default:
2935                         if (V_socket_hhh[HHOOK_SOCKET_OPT]->hhh_nhooks > 0)
2936                                 error = hhook_run_socket(so, sopt,
2937                                     HHOOK_SOCKET_OPT);
2938                         else
2939                                 error = ENOPROTOOPT;
2940                         break;
2941                 }
2942                 if (error == 0 && so->so_proto->pr_ctloutput != NULL)
2943                         (void)(*so->so_proto->pr_ctloutput)(so, sopt);
2944         }
2945 bad:
2946         CURVNET_RESTORE();
2947         return (error);
2948 }
2949
2950 /*
2951  * Helper routine for getsockopt.
2952  */
2953 int
2954 sooptcopyout(struct sockopt *sopt, const void *buf, size_t len)
2955 {
2956         int     error;
2957         size_t  valsize;
2958
2959         error = 0;
2960
2961         /*
2962          * Documented get behavior is that we always return a value, possibly
2963          * truncated to fit in the user's buffer.  Traditional behavior is
2964          * that we always tell the user precisely how much we copied, rather
2965          * than something useful like the total amount we had available for
2966          * her.  Note that this interface is not idempotent; the entire
2967          * answer must be generated ahead of time.
2968          */
2969         valsize = min(len, sopt->sopt_valsize);
2970         sopt->sopt_valsize = valsize;
2971         if (sopt->sopt_val != NULL) {
2972                 if (sopt->sopt_td != NULL)
2973                         error = copyout(buf, sopt->sopt_val, valsize);
2974                 else
2975                         bcopy(buf, sopt->sopt_val, valsize);
2976         }
2977         return (error);
2978 }
2979
2980 int
2981 sogetopt(struct socket *so, struct sockopt *sopt)
2982 {
2983         int     error, optval;
2984         struct  linger l;
2985         struct  timeval tv;
2986 #ifdef MAC
2987         struct mac extmac;
2988 #endif
2989
2990         CURVNET_SET(so->so_vnet);
2991         error = 0;
2992         if (sopt->sopt_level != SOL_SOCKET) {
2993                 if (so->so_proto->pr_ctloutput != NULL)
2994                         error = (*so->so_proto->pr_ctloutput)(so, sopt);
2995                 else
2996                         error = ENOPROTOOPT;
2997                 CURVNET_RESTORE();
2998                 return (error);
2999         } else {
3000                 switch (sopt->sopt_name) {
3001                 case SO_ACCEPTFILTER:
3002                         error = accept_filt_getopt(so, sopt);
3003                         break;
3004
3005                 case SO_LINGER:
3006                         SOCK_LOCK(so);
3007                         l.l_onoff = so->so_options & SO_LINGER;
3008                         l.l_linger = so->so_linger;
3009                         SOCK_UNLOCK(so);
3010                         error = sooptcopyout(sopt, &l, sizeof l);
3011                         break;
3012
3013                 case SO_USELOOPBACK:
3014                 case SO_DONTROUTE:
3015                 case SO_DEBUG:
3016                 case SO_KEEPALIVE:
3017                 case SO_REUSEADDR:
3018                 case SO_REUSEPORT:
3019                 case SO_REUSEPORT_LB:
3020                 case SO_BROADCAST:
3021                 case SO_OOBINLINE:
3022                 case SO_ACCEPTCONN:
3023                 case SO_TIMESTAMP:
3024                 case SO_BINTIME:
3025                 case SO_NOSIGPIPE:
3026                 case SO_NO_DDP:
3027                 case SO_NO_OFFLOAD:
3028                         optval = so->so_options & sopt->sopt_name;
3029 integer:
3030                         error = sooptcopyout(sopt, &optval, sizeof optval);
3031                         break;
3032
3033                 case SO_DOMAIN:
3034                         optval = so->so_proto->pr_domain->dom_family;
3035                         goto integer;
3036
3037                 case SO_TYPE:
3038                         optval = so->so_type;
3039                         goto integer;
3040
3041                 case SO_PROTOCOL:
3042                         optval = so->so_proto->pr_protocol;
3043                         goto integer;
3044
3045                 case SO_ERROR:
3046                         SOCK_LOCK(so);
3047                         optval = so->so_error;
3048                         so->so_error = 0;
3049                         SOCK_UNLOCK(so);
3050                         goto integer;
3051
3052                 case SO_SNDBUF:
3053                         optval = SOLISTENING(so) ? so->sol_sbsnd_hiwat :
3054                             so->so_snd.sb_hiwat;
3055                         goto integer;
3056
3057                 case SO_RCVBUF:
3058                         optval = SOLISTENING(so) ? so->sol_sbrcv_hiwat :
3059                             so->so_rcv.sb_hiwat;
3060                         goto integer;
3061
3062                 case SO_SNDLOWAT:
3063                         optval = SOLISTENING(so) ? so->sol_sbsnd_lowat :
3064                             so->so_snd.sb_lowat;
3065                         goto integer;
3066
3067                 case SO_RCVLOWAT:
3068                         optval = SOLISTENING(so) ? so->sol_sbrcv_lowat :
3069                             so->so_rcv.sb_lowat;
3070                         goto integer;
3071
3072                 case SO_SNDTIMEO:
3073                 case SO_RCVTIMEO:
3074                         tv = sbttotv(sopt->sopt_name == SO_SNDTIMEO ?
3075                             so->so_snd.sb_timeo : so->so_rcv.sb_timeo);
3076 #ifdef COMPAT_FREEBSD32
3077                         if (SV_CURPROC_FLAG(SV_ILP32)) {
3078                                 struct timeval32 tv32;
3079
3080                                 CP(tv, tv32, tv_sec);
3081                                 CP(tv, tv32, tv_usec);
3082                                 error = sooptcopyout(sopt, &tv32, sizeof tv32);
3083                         } else
3084 #endif
3085                                 error = sooptcopyout(sopt, &tv, sizeof tv);
3086                         break;
3087
3088                 case SO_LABEL:
3089 #ifdef MAC
3090                         error = sooptcopyin(sopt, &extmac, sizeof(extmac),
3091                             sizeof(extmac));
3092                         if (error)
3093                                 goto bad;
3094                         error = mac_getsockopt_label(sopt->sopt_td->td_ucred,
3095                             so, &extmac);
3096                         if (error)
3097                                 goto bad;
3098                         error = sooptcopyout(sopt, &extmac, sizeof extmac);
3099 #else
3100                         error = EOPNOTSUPP;
3101 #endif
3102                         break;
3103
3104                 case SO_PEERLABEL:
3105 #ifdef MAC
3106                         error = sooptcopyin(sopt, &extmac, sizeof(extmac),
3107                             sizeof(extmac));
3108                         if (error)
3109                                 goto bad;
3110                         error = mac_getsockopt_peerlabel(
3111                             sopt->sopt_td->td_ucred, so, &extmac);
3112                         if (error)
3113                                 goto bad;
3114                         error = sooptcopyout(sopt, &extmac, sizeof extmac);
3115 #else
3116                         error = EOPNOTSUPP;
3117 #endif
3118                         break;
3119
3120                 case SO_LISTENQLIMIT:
3121                         optval = SOLISTENING(so) ? so->sol_qlimit : 0;
3122                         goto integer;
3123
3124                 case SO_LISTENQLEN:
3125                         optval = SOLISTENING(so) ? so->sol_qlen : 0;
3126                         goto integer;
3127
3128                 case SO_LISTENINCQLEN:
3129                         optval = SOLISTENING(so) ? so->sol_incqlen : 0;
3130                         goto integer;
3131
3132                 case SO_TS_CLOCK:
3133                         optval = so->so_ts_clock;
3134                         goto integer;
3135
3136                 case SO_MAX_PACING_RATE:
3137                         optval = so->so_max_pacing_rate;
3138                         goto integer;
3139
3140                 default:
3141                         if (V_socket_hhh[HHOOK_SOCKET_OPT]->hhh_nhooks > 0)
3142                                 error = hhook_run_socket(so, sopt,
3143                                     HHOOK_SOCKET_OPT);
3144                         else
3145                                 error = ENOPROTOOPT;
3146                         break;
3147                 }
3148         }
3149 #ifdef MAC
3150 bad:
3151 #endif
3152         CURVNET_RESTORE();
3153         return (error);
3154 }
3155
3156 int
3157 soopt_getm(struct sockopt *sopt, struct mbuf **mp)
3158 {
3159         struct mbuf *m, *m_prev;
3160         int sopt_size = sopt->sopt_valsize;
3161
3162         MGET(m, sopt->sopt_td ? M_WAITOK : M_NOWAIT, MT_DATA);
3163         if (m == NULL)
3164                 return ENOBUFS;
3165         if (sopt_size > MLEN) {
3166                 MCLGET(m, sopt->sopt_td ? M_WAITOK : M_NOWAIT);
3167                 if ((m->m_flags & M_EXT) == 0) {
3168                         m_free(m);
3169                         return ENOBUFS;
3170                 }
3171                 m->m_len = min(MCLBYTES, sopt_size);
3172         } else {
3173                 m->m_len = min(MLEN, sopt_size);
3174         }
3175         sopt_size -= m->m_len;
3176         *mp = m;
3177         m_prev = m;
3178
3179         while (sopt_size) {
3180                 MGET(m, sopt->sopt_td ? M_WAITOK : M_NOWAIT, MT_DATA);
3181                 if (m == NULL) {
3182                         m_freem(*mp);
3183                         return ENOBUFS;
3184                 }
3185                 if (sopt_size > MLEN) {
3186                         MCLGET(m, sopt->sopt_td != NULL ? M_WAITOK :
3187                             M_NOWAIT);
3188                         if ((m->m_flags & M_EXT) == 0) {
3189                                 m_freem(m);
3190                                 m_freem(*mp);
3191                                 return ENOBUFS;
3192                         }
3193                         m->m_len = min(MCLBYTES, sopt_size);
3194                 } else {
3195                         m->m_len = min(MLEN, sopt_size);
3196                 }
3197                 sopt_size -= m->m_len;
3198                 m_prev->m_next = m;
3199                 m_prev = m;
3200         }
3201         return (0);
3202 }
3203
3204 int
3205 soopt_mcopyin(struct sockopt *sopt, struct mbuf *m)
3206 {
3207         struct mbuf *m0 = m;
3208
3209         if (sopt->sopt_val == NULL)
3210                 return (0);
3211         while (m != NULL && sopt->sopt_valsize >= m->m_len) {
3212                 if (sopt->sopt_td != NULL) {
3213                         int error;
3214
3215                         error = copyin(sopt->sopt_val, mtod(m, char *),
3216                             m->m_len);
3217                         if (error != 0) {
3218                                 m_freem(m0);
3219                                 return(error);
3220                         }
3221                 } else
3222                         bcopy(sopt->sopt_val, mtod(m, char *), m->m_len);
3223                 sopt->sopt_valsize -= m->m_len;
3224                 sopt->sopt_val = (char *)sopt->sopt_val + m->m_len;
3225                 m = m->m_next;
3226         }
3227         if (m != NULL) /* should be allocated enoughly at ip6_sooptmcopyin() */
3228                 panic("ip6_sooptmcopyin");
3229         return (0);
3230 }
3231
3232 int
3233 soopt_mcopyout(struct sockopt *sopt, struct mbuf *m)
3234 {
3235         struct mbuf *m0 = m;
3236         size_t valsize = 0;
3237
3238         if (sopt->sopt_val == NULL)
3239                 return (0);
3240         while (m != NULL && sopt->sopt_valsize >= m->m_len) {
3241                 if (sopt->sopt_td != NULL) {
3242                         int error;
3243
3244                         error = copyout(mtod(m, char *), sopt->sopt_val,
3245                             m->m_len);
3246                         if (error != 0) {
3247                                 m_freem(m0);
3248                                 return(error);
3249                         }
3250                 } else
3251                         bcopy(mtod(m, char *), sopt->sopt_val, m->m_len);
3252                 sopt->sopt_valsize -= m->m_len;
3253                 sopt->sopt_val = (char *)sopt->sopt_val + m->m_len;
3254                 valsize += m->m_len;
3255                 m = m->m_next;
3256         }
3257         if (m != NULL) {
3258                 /* enough soopt buffer should be given from user-land */
3259                 m_freem(m0);
3260                 return(EINVAL);
3261         }
3262         sopt->sopt_valsize = valsize;
3263         return (0);
3264 }
3265
3266 /*
3267  * sohasoutofband(): protocol notifies socket layer of the arrival of new
3268  * out-of-band data, which will then notify socket consumers.
3269  */
3270 void
3271 sohasoutofband(struct socket *so)
3272 {
3273
3274         if (so->so_sigio != NULL)
3275                 pgsigio(&so->so_sigio, SIGURG, 0);
3276         selwakeuppri(&so->so_rdsel, PSOCK);
3277 }
3278
3279 int
3280 sopoll(struct socket *so, int events, struct ucred *active_cred,
3281     struct thread *td)
3282 {
3283
3284         /*
3285          * We do not need to set or assert curvnet as long as everyone uses
3286          * sopoll_generic().
3287          */
3288         return (so->so_proto->pr_usrreqs->pru_sopoll(so, events, active_cred,
3289             td));
3290 }
3291
3292 int
3293 sopoll_generic(struct socket *so, int events, struct ucred *active_cred,
3294     struct thread *td)
3295 {
3296         int revents;
3297
3298         SOCK_LOCK(so);
3299         if (SOLISTENING(so)) {
3300                 if (!(events & (POLLIN | POLLRDNORM)))
3301                         revents = 0;
3302                 else if (!TAILQ_EMPTY(&so->sol_comp))
3303                         revents = events & (POLLIN | POLLRDNORM);
3304                 else if ((events & POLLINIGNEOF) == 0 && so->so_error)
3305                         revents = (events & (POLLIN | POLLRDNORM)) | POLLHUP;
3306                 else {
3307                         selrecord(td, &so->so_rdsel);
3308                         revents = 0;
3309                 }
3310         } else {
3311                 revents = 0;
3312                 SOCKBUF_LOCK(&so->so_snd);
3313                 SOCKBUF_LOCK(&so->so_rcv);
3314                 if (events & (POLLIN | POLLRDNORM))
3315                         if (soreadabledata(so))
3316                                 revents |= events & (POLLIN | POLLRDNORM);
3317                 if (events & (POLLOUT | POLLWRNORM))
3318                         if (sowriteable(so))
3319                                 revents |= events & (POLLOUT | POLLWRNORM);
3320                 if (events & (POLLPRI | POLLRDBAND))
3321                         if (so->so_oobmark ||
3322                             (so->so_rcv.sb_state & SBS_RCVATMARK))
3323                                 revents |= events & (POLLPRI | POLLRDBAND);
3324                 if ((events & POLLINIGNEOF) == 0) {
3325                         if (so->so_rcv.sb_state & SBS_CANTRCVMORE) {
3326                                 revents |= events & (POLLIN | POLLRDNORM);
3327                                 if (so->so_snd.sb_state & SBS_CANTSENDMORE)
3328                                         revents |= POLLHUP;
3329                         }
3330                 }
3331                 if (revents == 0) {
3332                         if (events &
3333                             (POLLIN | POLLPRI | POLLRDNORM | POLLRDBAND)) {
3334                                 selrecord(td, &so->so_rdsel);
3335                                 so->so_rcv.sb_flags |= SB_SEL;
3336                         }
3337                         if (events & (POLLOUT | POLLWRNORM)) {
3338                                 selrecord(td, &so->so_wrsel);
3339                                 so->so_snd.sb_flags |= SB_SEL;
3340                         }
3341                 }
3342                 SOCKBUF_UNLOCK(&so->so_rcv);
3343                 SOCKBUF_UNLOCK(&so->so_snd);
3344         }
3345         SOCK_UNLOCK(so);
3346         return (revents);
3347 }
3348
3349 int
3350 soo_kqfilter(struct file *fp, struct knote *kn)
3351 {
3352         struct socket *so = kn->kn_fp->f_data;
3353         struct sockbuf *sb;
3354         struct knlist *knl;
3355
3356         switch (kn->kn_filter) {
3357         case EVFILT_READ:
3358                 kn->kn_fop = &soread_filtops;
3359                 knl = &so->so_rdsel.si_note;
3360                 sb = &so->so_rcv;
3361                 break;
3362         case EVFILT_WRITE:
3363                 kn->kn_fop = &sowrite_filtops;
3364                 knl = &so->so_wrsel.si_note;
3365                 sb = &so->so_snd;
3366                 break;
3367         case EVFILT_EMPTY:
3368                 kn->kn_fop = &soempty_filtops;
3369                 knl = &so->so_wrsel.si_note;
3370                 sb = &so->so_snd;
3371                 break;
3372         default:
3373                 return (EINVAL);
3374         }
3375
3376         SOCK_LOCK(so);
3377         if (SOLISTENING(so)) {
3378                 knlist_add(knl, kn, 1);
3379         } else {
3380                 SOCKBUF_LOCK(sb);
3381                 knlist_add(knl, kn, 1);
3382                 sb->sb_flags |= SB_KNOTE;
3383                 SOCKBUF_UNLOCK(sb);
3384         }
3385         SOCK_UNLOCK(so);
3386         return (0);
3387 }
3388
3389 /*
3390  * Some routines that return EOPNOTSUPP for entry points that are not
3391  * supported by a protocol.  Fill in as needed.
3392  */
3393 int
3394 pru_accept_notsupp(struct socket *so, struct sockaddr **nam)
3395 {
3396
3397         return EOPNOTSUPP;
3398 }
3399
3400 int
3401 pru_aio_queue_notsupp(struct socket *so, struct kaiocb *job)
3402 {
3403
3404         return EOPNOTSUPP;
3405 }
3406
3407 int
3408 pru_attach_notsupp(struct socket *so, int proto, struct thread *td)
3409 {
3410
3411         return EOPNOTSUPP;
3412 }
3413
3414 int
3415 pru_bind_notsupp(struct socket *so, struct sockaddr *nam, struct thread *td)
3416 {
3417
3418         return EOPNOTSUPP;
3419 }
3420
3421 int
3422 pru_bindat_notsupp(int fd, struct socket *so, struct sockaddr *nam,
3423     struct thread *td)
3424 {
3425
3426         return EOPNOTSUPP;
3427 }
3428
3429 int
3430 pru_connect_notsupp(struct socket *so, struct sockaddr *nam, struct thread *td)
3431 {
3432
3433         return EOPNOTSUPP;
3434 }
3435
3436 int
3437 pru_connectat_notsupp(int fd, struct socket *so, struct sockaddr *nam,
3438     struct thread *td)
3439 {
3440
3441         return EOPNOTSUPP;
3442 }
3443
3444 int
3445 pru_connect2_notsupp(struct socket *so1, struct socket *so2)
3446 {
3447
3448         return EOPNOTSUPP;
3449 }
3450
3451 int
3452 pru_control_notsupp(struct socket *so, u_long cmd, caddr_t data,
3453     struct ifnet *ifp, struct thread *td)
3454 {
3455
3456         return EOPNOTSUPP;
3457 }
3458
3459 int
3460 pru_disconnect_notsupp(struct socket *so)
3461 {
3462
3463         return EOPNOTSUPP;
3464 }
3465
3466 int
3467 pru_listen_notsupp(struct socket *so, int backlog, struct thread *td)
3468 {
3469
3470         return EOPNOTSUPP;
3471 }
3472
3473 int
3474 pru_peeraddr_notsupp(struct socket *so, struct sockaddr **nam)
3475 {
3476
3477         return EOPNOTSUPP;
3478 }
3479
3480 int
3481 pru_rcvd_notsupp(struct socket *so, int flags)
3482 {
3483
3484         return EOPNOTSUPP;
3485 }
3486
3487 int
3488 pru_rcvoob_notsupp(struct socket *so, struct mbuf *m, int flags)
3489 {
3490
3491         return EOPNOTSUPP;
3492 }
3493
3494 int
3495 pru_send_notsupp(struct socket *so, int flags, struct mbuf *m,
3496     struct sockaddr *addr, struct mbuf *control, struct thread *td)
3497 {
3498
3499         return EOPNOTSUPP;
3500 }
3501
3502 int
3503 pru_ready_notsupp(struct socket *so, struct mbuf *m, int count)
3504 {
3505
3506         return (EOPNOTSUPP);
3507 }
3508
3509 /*
3510  * This isn't really a ``null'' operation, but it's the default one and
3511  * doesn't do anything destructive.
3512  */
3513 int
3514 pru_sense_null(struct socket *so, struct stat *sb)
3515 {
3516
3517         sb->st_blksize = so->so_snd.sb_hiwat;
3518         return 0;
3519 }
3520
3521 int
3522 pru_shutdown_notsupp(struct socket *so)
3523 {
3524
3525         return EOPNOTSUPP;
3526 }
3527
3528 int
3529 pru_sockaddr_notsupp(struct socket *so, struct sockaddr **nam)
3530 {
3531
3532         return EOPNOTSUPP;
3533 }
3534
3535 int
3536 pru_sosend_notsupp(struct socket *so, struct sockaddr *addr, struct uio *uio,
3537     struct mbuf *top, struct mbuf *control, int flags, struct thread *td)
3538 {
3539
3540         return EOPNOTSUPP;
3541 }
3542
3543 int
3544 pru_soreceive_notsupp(struct socket *so, struct sockaddr **paddr,
3545     struct uio *uio, struct mbuf **mp0, struct mbuf **controlp, int *flagsp)
3546 {
3547
3548         return EOPNOTSUPP;
3549 }
3550
3551 int
3552 pru_sopoll_notsupp(struct socket *so, int events, struct ucred *cred,
3553     struct thread *td)
3554 {
3555
3556         return EOPNOTSUPP;
3557 }
3558
3559 static void
3560 filt_sordetach(struct knote *kn)
3561 {
3562         struct socket *so = kn->kn_fp->f_data;
3563
3564         so_rdknl_lock(so);
3565         knlist_remove(&so->so_rdsel.si_note, kn, 1);
3566         if (!SOLISTENING(so) && knlist_empty(&so->so_rdsel.si_note))
3567                 so->so_rcv.sb_flags &= ~SB_KNOTE;
3568         so_rdknl_unlock(so);
3569 }
3570
3571 /*ARGSUSED*/
3572 static int
3573 filt_soread(struct knote *kn, long hint)
3574 {
3575         struct socket *so;
3576
3577         so = kn->kn_fp->f_data;
3578
3579         if (SOLISTENING(so)) {
3580                 SOCK_LOCK_ASSERT(so);
3581                 kn->kn_data = so->sol_qlen;
3582                 if (so->so_error) {
3583                         kn->kn_flags |= EV_EOF;
3584                         kn->kn_fflags = so->so_error;
3585                         return (1);
3586                 }
3587                 return (!TAILQ_EMPTY(&so->sol_comp));
3588         }
3589
3590         SOCKBUF_LOCK_ASSERT(&so->so_rcv);
3591
3592         kn->kn_data = sbavail(&so->so_rcv) - so->so_rcv.sb_ctl;
3593         if (so->so_rcv.sb_state & SBS_CANTRCVMORE) {
3594                 kn->kn_flags |= EV_EOF;
3595                 kn->kn_fflags = so->so_error;
3596                 return (1);
3597         } else if (so->so_error)        /* temporary udp error */
3598                 return (1);
3599
3600         if (kn->kn_sfflags & NOTE_LOWAT) {
3601                 if (kn->kn_data >= kn->kn_sdata)
3602                         return (1);
3603         } else if (sbavail(&so->so_rcv) >= so->so_rcv.sb_lowat)
3604                 return (1);
3605
3606         /* This hook returning non-zero indicates an event, not error */
3607         return (hhook_run_socket(so, NULL, HHOOK_FILT_SOREAD));
3608 }
3609
3610 static void
3611 filt_sowdetach(struct knote *kn)
3612 {
3613         struct socket *so = kn->kn_fp->f_data;
3614
3615         so_wrknl_lock(so);
3616         knlist_remove(&so->so_wrsel.si_note, kn, 1);
3617         if (!SOLISTENING(so) && knlist_empty(&so->so_wrsel.si_note))
3618                 so->so_snd.sb_flags &= ~SB_KNOTE;
3619         so_wrknl_unlock(so);
3620 }
3621
3622 /*ARGSUSED*/
3623 static int
3624 filt_sowrite(struct knote *kn, long hint)
3625 {
3626         struct socket *so;
3627
3628         so = kn->kn_fp->f_data;
3629
3630         if (SOLISTENING(so))
3631                 return (0);
3632
3633         SOCKBUF_LOCK_ASSERT(&so->so_snd);
3634         kn->kn_data = sbspace(&so->so_snd);
3635
3636         hhook_run_socket(so, kn, HHOOK_FILT_SOWRITE);
3637
3638         if (so->so_snd.sb_state & SBS_CANTSENDMORE) {
3639                 kn->kn_flags |= EV_EOF;
3640                 kn->kn_fflags = so->so_error;
3641                 return (1);
3642         } else if (so->so_error)        /* temporary udp error */
3643                 return (1);
3644         else if (((so->so_state & SS_ISCONNECTED) == 0) &&
3645             (so->so_proto->pr_flags & PR_CONNREQUIRED))
3646                 return (0);
3647         else if (kn->kn_sfflags & NOTE_LOWAT)
3648                 return (kn->kn_data >= kn->kn_sdata);
3649         else
3650                 return (kn->kn_data >= so->so_snd.sb_lowat);
3651 }
3652
3653 static int
3654 filt_soempty(struct knote *kn, long hint)
3655 {
3656         struct socket *so;
3657
3658         so = kn->kn_fp->f_data;
3659
3660         if (SOLISTENING(so))
3661                 return (1);
3662
3663         SOCKBUF_LOCK_ASSERT(&so->so_snd);
3664         kn->kn_data = sbused(&so->so_snd);
3665
3666         if (kn->kn_data == 0)
3667                 return (1);
3668         else
3669                 return (0);
3670 }
3671
3672 int
3673 socheckuid(struct socket *so, uid_t uid)
3674 {
3675
3676         if (so == NULL)
3677                 return (EPERM);
3678         if (so->so_cred->cr_uid != uid)
3679                 return (EPERM);
3680         return (0);
3681 }
3682
3683 /*
3684  * These functions are used by protocols to notify the socket layer (and its
3685  * consumers) of state changes in the sockets driven by protocol-side events.
3686  */
3687
3688 /*
3689  * Procedures to manipulate state flags of socket and do appropriate wakeups.
3690  *
3691  * Normal sequence from the active (originating) side is that
3692  * soisconnecting() is called during processing of connect() call, resulting
3693  * in an eventual call to soisconnected() if/when the connection is
3694  * established.  When the connection is torn down soisdisconnecting() is
3695  * called during processing of disconnect() call, and soisdisconnected() is
3696  * called when the connection to the peer is totally severed.  The semantics
3697  * of these routines are such that connectionless protocols can call
3698  * soisconnected() and soisdisconnected() only, bypassing the in-progress
3699  * calls when setting up a ``connection'' takes no time.
3700  *
3701  * From the passive side, a socket is created with two queues of sockets:
3702  * so_incomp for connections in progress and so_comp for connections already
3703  * made and awaiting user acceptance.  As a protocol is preparing incoming
3704  * connections, it creates a socket structure queued on so_incomp by calling
3705  * sonewconn().  When the connection is established, soisconnected() is
3706  * called, and transfers the socket structure to so_comp, making it available
3707  * to accept().
3708  *
3709  * If a socket is closed with sockets on either so_incomp or so_comp, these
3710  * sockets are dropped.
3711  *
3712  * If higher-level protocols are implemented in the kernel, the wakeups done
3713  * here will sometimes cause software-interrupt process scheduling.
3714  */
3715 void
3716 soisconnecting(struct socket *so)
3717 {
3718
3719         SOCK_LOCK(so);
3720         so->so_state &= ~(SS_ISCONNECTED|SS_ISDISCONNECTING);
3721         so->so_state |= SS_ISCONNECTING;
3722         SOCK_UNLOCK(so);
3723 }
3724
3725 void
3726 soisconnected(struct socket *so)
3727 {
3728
3729         SOCK_LOCK(so);
3730         so->so_state &= ~(SS_ISCONNECTING|SS_ISDISCONNECTING|SS_ISCONFIRMING);
3731         so->so_state |= SS_ISCONNECTED;
3732
3733         if (so->so_qstate == SQ_INCOMP) {
3734                 struct socket *head = so->so_listen;
3735                 int ret;
3736
3737                 KASSERT(head, ("%s: so %p on incomp of NULL", __func__, so));
3738                 /*
3739                  * Promoting a socket from incomplete queue to complete, we
3740                  * need to go through reverse order of locking.  We first do
3741                  * trylock, and if that doesn't succeed, we go the hard way
3742                  * leaving a reference and rechecking consistency after proper
3743                  * locking.
3744                  */
3745                 if (__predict_false(SOLISTEN_TRYLOCK(head) == 0)) {
3746                         soref(head);
3747                         SOCK_UNLOCK(so);
3748                         SOLISTEN_LOCK(head);
3749                         SOCK_LOCK(so);
3750                         if (__predict_false(head != so->so_listen)) {
3751                                 /*
3752                                  * The socket went off the listen queue,
3753                                  * should be lost race to close(2) of sol.
3754                                  * The socket is about to soabort().
3755                                  */
3756                                 SOCK_UNLOCK(so);
3757                                 sorele(head);
3758                                 return;
3759                         }
3760                         /* Not the last one, as so holds a ref. */
3761                         refcount_release(&head->so_count);
3762                 }
3763 again:
3764                 if ((so->so_options & SO_ACCEPTFILTER) == 0) {
3765                         TAILQ_REMOVE(&head->sol_incomp, so, so_list);
3766                         head->sol_incqlen--;
3767                         TAILQ_INSERT_TAIL(&head->sol_comp, so, so_list);
3768                         head->sol_qlen++;
3769                         so->so_qstate = SQ_COMP;
3770                         SOCK_UNLOCK(so);
3771                         solisten_wakeup(head);  /* unlocks */
3772                 } else {
3773                         SOCKBUF_LOCK(&so->so_rcv);
3774                         soupcall_set(so, SO_RCV,
3775                             head->sol_accept_filter->accf_callback,
3776                             head->sol_accept_filter_arg);
3777                         so->so_options &= ~SO_ACCEPTFILTER;
3778                         ret = head->sol_accept_filter->accf_callback(so,
3779                             head->sol_accept_filter_arg, M_NOWAIT);
3780                         if (ret == SU_ISCONNECTED) {
3781                                 soupcall_clear(so, SO_RCV);
3782                                 SOCKBUF_UNLOCK(&so->so_rcv);
3783                                 goto again;
3784                         }
3785                         SOCKBUF_UNLOCK(&so->so_rcv);
3786                         SOCK_UNLOCK(so);
3787                         SOLISTEN_UNLOCK(head);
3788                 }
3789                 return;
3790         }
3791         SOCK_UNLOCK(so);
3792         wakeup(&so->so_timeo);
3793         sorwakeup(so);
3794         sowwakeup(so);
3795 }
3796
3797 void
3798 soisdisconnecting(struct socket *so)
3799 {
3800
3801         SOCK_LOCK(so);
3802         so->so_state &= ~SS_ISCONNECTING;
3803         so->so_state |= SS_ISDISCONNECTING;
3804
3805         if (!SOLISTENING(so)) {
3806                 SOCKBUF_LOCK(&so->so_rcv);
3807                 socantrcvmore_locked(so);
3808                 SOCKBUF_LOCK(&so->so_snd);
3809                 socantsendmore_locked(so);
3810         }
3811         SOCK_UNLOCK(so);
3812         wakeup(&so->so_timeo);
3813 }
3814
3815 void
3816 soisdisconnected(struct socket *so)
3817 {
3818
3819         SOCK_LOCK(so);
3820
3821         /*
3822          * There is at least one reader of so_state that does not
3823          * acquire socket lock, namely soreceive_generic().  Ensure
3824          * that it never sees all flags that track connection status
3825          * cleared, by ordering the update with a barrier semantic of
3826          * our release thread fence.
3827          */
3828         so->so_state |= SS_ISDISCONNECTED;
3829         atomic_thread_fence_rel();
3830         so->so_state &= ~(SS_ISCONNECTING|SS_ISCONNECTED|SS_ISDISCONNECTING);
3831
3832         if (!SOLISTENING(so)) {
3833                 SOCK_UNLOCK(so);
3834                 SOCKBUF_LOCK(&so->so_rcv);
3835                 socantrcvmore_locked(so);
3836                 SOCKBUF_LOCK(&so->so_snd);
3837                 sbdrop_locked(&so->so_snd, sbused(&so->so_snd));
3838                 socantsendmore_locked(so);
3839         } else
3840                 SOCK_UNLOCK(so);
3841         wakeup(&so->so_timeo);
3842 }
3843
3844 /*
3845  * Make a copy of a sockaddr in a malloced buffer of type M_SONAME.
3846  */
3847 struct sockaddr *
3848 sodupsockaddr(const struct sockaddr *sa, int mflags)
3849 {
3850         struct sockaddr *sa2;
3851
3852         sa2 = malloc(sa->sa_len, M_SONAME, mflags);
3853         if (sa2)
3854                 bcopy(sa, sa2, sa->sa_len);
3855         return sa2;
3856 }
3857
3858 /*
3859  * Register per-socket destructor.
3860  */
3861 void
3862 sodtor_set(struct socket *so, so_dtor_t *func)
3863 {
3864
3865         SOCK_LOCK_ASSERT(so);
3866         so->so_dtor = func;
3867 }
3868
3869 /*
3870  * Register per-socket buffer upcalls.
3871  */
3872 void
3873 soupcall_set(struct socket *so, int which, so_upcall_t func, void *arg)
3874 {
3875         struct sockbuf *sb;
3876
3877         KASSERT(!SOLISTENING(so), ("%s: so %p listening", __func__, so));
3878
3879         switch (which) {
3880         case SO_RCV:
3881                 sb = &so->so_rcv;
3882                 break;
3883         case SO_SND:
3884                 sb = &so->so_snd;
3885                 break;
3886         default:
3887                 panic("soupcall_set: bad which");
3888         }
3889         SOCKBUF_LOCK_ASSERT(sb);
3890         sb->sb_upcall = func;
3891         sb->sb_upcallarg = arg;
3892         sb->sb_flags |= SB_UPCALL;
3893 }
3894
3895 void
3896 soupcall_clear(struct socket *so, int which)
3897 {
3898         struct sockbuf *sb;
3899
3900         KASSERT(!SOLISTENING(so), ("%s: so %p listening", __func__, so));
3901
3902         switch (which) {
3903         case SO_RCV:
3904                 sb = &so->so_rcv;
3905                 break;
3906         case SO_SND:
3907                 sb = &so->so_snd;
3908                 break;
3909         default:
3910                 panic("soupcall_clear: bad which");
3911         }
3912         SOCKBUF_LOCK_ASSERT(sb);
3913         KASSERT(sb->sb_upcall != NULL,
3914             ("%s: so %p no upcall to clear", __func__, so));
3915         sb->sb_upcall = NULL;
3916         sb->sb_upcallarg = NULL;
3917         sb->sb_flags &= ~SB_UPCALL;
3918 }
3919
3920 void
3921 solisten_upcall_set(struct socket *so, so_upcall_t func, void *arg)
3922 {
3923
3924         SOLISTEN_LOCK_ASSERT(so);
3925         so->sol_upcall = func;
3926         so->sol_upcallarg = arg;
3927 }
3928
3929 static void
3930 so_rdknl_lock(void *arg)
3931 {
3932         struct socket *so = arg;
3933
3934         if (SOLISTENING(so))
3935                 SOCK_LOCK(so);
3936         else
3937                 SOCKBUF_LOCK(&so->so_rcv);
3938 }
3939
3940 static void
3941 so_rdknl_unlock(void *arg)
3942 {
3943         struct socket *so = arg;
3944
3945         if (SOLISTENING(so))
3946                 SOCK_UNLOCK(so);
3947         else
3948                 SOCKBUF_UNLOCK(&so->so_rcv);
3949 }
3950
3951 static void
3952 so_rdknl_assert_locked(void *arg)
3953 {
3954         struct socket *so = arg;
3955
3956         if (SOLISTENING(so))
3957                 SOCK_LOCK_ASSERT(so);
3958         else
3959                 SOCKBUF_LOCK_ASSERT(&so->so_rcv);
3960 }
3961
3962 static void
3963 so_rdknl_assert_unlocked(void *arg)
3964 {
3965         struct socket *so = arg;
3966
3967         if (SOLISTENING(so))
3968                 SOCK_UNLOCK_ASSERT(so);
3969         else
3970                 SOCKBUF_UNLOCK_ASSERT(&so->so_rcv);
3971 }
3972
3973 static void
3974 so_wrknl_lock(void *arg)
3975 {
3976         struct socket *so = arg;
3977
3978         if (SOLISTENING(so))
3979                 SOCK_LOCK(so);
3980         else
3981                 SOCKBUF_LOCK(&so->so_snd);
3982 }
3983
3984 static void
3985 so_wrknl_unlock(void *arg)
3986 {
3987         struct socket *so = arg;
3988
3989         if (SOLISTENING(so))
3990                 SOCK_UNLOCK(so);
3991         else
3992                 SOCKBUF_UNLOCK(&so->so_snd);
3993 }
3994
3995 static void
3996 so_wrknl_assert_locked(void *arg)
3997 {
3998         struct socket *so = arg;
3999
4000         if (SOLISTENING(so))
4001                 SOCK_LOCK_ASSERT(so);
4002         else
4003                 SOCKBUF_LOCK_ASSERT(&so->so_snd);
4004 }
4005
4006 static void
4007 so_wrknl_assert_unlocked(void *arg)
4008 {
4009         struct socket *so = arg;
4010
4011         if (SOLISTENING(so))
4012                 SOCK_UNLOCK_ASSERT(so);
4013         else
4014                 SOCKBUF_UNLOCK_ASSERT(&so->so_snd);
4015 }
4016
4017 /*
4018  * Create an external-format (``xsocket'') structure using the information in
4019  * the kernel-format socket structure pointed to by so.  This is done to
4020  * reduce the spew of irrelevant information over this interface, to isolate
4021  * user code from changes in the kernel structure, and potentially to provide
4022  * information-hiding if we decide that some of this information should be
4023  * hidden from users.
4024  */
4025 void
4026 sotoxsocket(struct socket *so, struct xsocket *xso)
4027 {
4028
4029         bzero(xso, sizeof(*xso));
4030         xso->xso_len = sizeof *xso;
4031         xso->xso_so = (uintptr_t)so;
4032         xso->so_type = so->so_type;
4033         xso->so_options = so->so_options;
4034         xso->so_linger = so->so_linger;
4035         xso->so_state = so->so_state;
4036         xso->so_pcb = (uintptr_t)so->so_pcb;
4037         xso->xso_protocol = so->so_proto->pr_protocol;
4038         xso->xso_family = so->so_proto->pr_domain->dom_family;
4039         xso->so_timeo = so->so_timeo;
4040         xso->so_error = so->so_error;
4041         xso->so_uid = so->so_cred->cr_uid;
4042         xso->so_pgid = so->so_sigio ? so->so_sigio->sio_pgid : 0;
4043         if (SOLISTENING(so)) {
4044                 xso->so_qlen = so->sol_qlen;
4045                 xso->so_incqlen = so->sol_incqlen;
4046                 xso->so_qlimit = so->sol_qlimit;
4047                 xso->so_oobmark = 0;
4048         } else {
4049                 xso->so_state |= so->so_qstate;
4050                 xso->so_qlen = xso->so_incqlen = xso->so_qlimit = 0;
4051                 xso->so_oobmark = so->so_oobmark;
4052                 sbtoxsockbuf(&so->so_snd, &xso->so_snd);
4053                 sbtoxsockbuf(&so->so_rcv, &xso->so_rcv);
4054         }
4055 }
4056
4057 struct sockbuf *
4058 so_sockbuf_rcv(struct socket *so)
4059 {
4060
4061         return (&so->so_rcv);
4062 }
4063
4064 struct sockbuf *
4065 so_sockbuf_snd(struct socket *so)
4066 {
4067
4068         return (&so->so_snd);
4069 }
4070
4071 int
4072 so_state_get(const struct socket *so)
4073 {
4074
4075         return (so->so_state);
4076 }
4077
4078 void
4079 so_state_set(struct socket *so, int val)
4080 {
4081
4082         so->so_state = val;
4083 }
4084
4085 int
4086 so_options_get(const struct socket *so)
4087 {
4088
4089         return (so->so_options);
4090 }
4091
4092 void
4093 so_options_set(struct socket *so, int val)
4094 {
4095
4096         so->so_options = val;
4097 }
4098
4099 int
4100 so_error_get(const struct socket *so)
4101 {
4102
4103         return (so->so_error);
4104 }
4105
4106 void
4107 so_error_set(struct socket *so, int val)
4108 {
4109
4110         so->so_error = val;
4111 }
4112
4113 int
4114 so_linger_get(const struct socket *so)
4115 {
4116
4117         return (so->so_linger);
4118 }
4119
4120 void
4121 so_linger_set(struct socket *so, int val)
4122 {
4123
4124         KASSERT(val >= 0 && val <= USHRT_MAX && val <= (INT_MAX / hz),
4125             ("%s: val %d out of range", __func__, val));
4126
4127         so->so_linger = val;
4128 }
4129
4130 struct protosw *
4131 so_protosw_get(const struct socket *so)
4132 {
4133
4134         return (so->so_proto);
4135 }
4136
4137 void
4138 so_protosw_set(struct socket *so, struct protosw *val)
4139 {
4140
4141         so->so_proto = val;
4142 }
4143
4144 void
4145 so_sorwakeup(struct socket *so)
4146 {
4147
4148         sorwakeup(so);
4149 }
4150
4151 void
4152 so_sowwakeup(struct socket *so)
4153 {
4154
4155         sowwakeup(so);
4156 }
4157
4158 void
4159 so_sorwakeup_locked(struct socket *so)
4160 {
4161
4162         sorwakeup_locked(so);
4163 }
4164
4165 void
4166 so_sowwakeup_locked(struct socket *so)
4167 {
4168
4169         sowwakeup_locked(so);
4170 }
4171
4172 void
4173 so_lock(struct socket *so)
4174 {
4175
4176         SOCK_LOCK(so);
4177 }
4178
4179 void
4180 so_unlock(struct socket *so)
4181 {
4182
4183         SOCK_UNLOCK(so);
4184 }