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