sys/sys/sockbuf.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1982, 1986, 1990, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)socketvar.h 8.3 (Berkeley) 2/19/95
  32  *
  33  * $FreeBSD$
  34  */
  35 #ifndef _SYS_SOCKBUF_H_
  36 #define _SYS_SOCKBUF_H_
  37
  38 /*
  39  * Constants for sb_flags field of struct sockbuf/xsockbuf.
  40  */
  41 #define SB_WAIT         0x04            /* someone is waiting for data/space */
  42 #define SB_SEL          0x08            /* someone is selecting */
  43 #define SB_ASYNC        0x10            /* ASYNC I/O, need signals */
  44 #define SB_UPCALL       0x20            /* someone wants an upcall */
  45 #define SB_NOINTR       0x40            /* operations not interruptible */
  46 #define SB_AIO          0x80            /* AIO operations queued */
  47 #define SB_KNOTE        0x100           /* kernel note attached */
  48 #define SB_NOCOALESCE   0x200           /* don't coalesce new data into existing mbufs */
  49 #define SB_IN_TOE       0x400           /* socket buffer is in the middle of an operation */
  50 #define SB_AUTOSIZE     0x800           /* automatically size socket buffer */
  51 #define SB_STOP         0x1000          /* backpressure indicator */
  52 #define SB_AIO_RUNNING  0x2000          /* AIO operation running */
  53 #define SB_TLS_IFNET    0x4000          /* has used / is using ifnet KTLS */
  54
  55 #define SBS_CANTSENDMORE        0x0010  /* can't send more data to peer */
  56 #define SBS_CANTRCVMORE         0x0020  /* can't receive more data from peer */
  57 #define SBS_RCVATMARK           0x0040  /* at mark on input */
  58
  59 #if defined(_KERNEL) || defined(_WANT_SOCKET)
  60 #include <sys/_lock.h>
  61 #include <sys/_mutex.h>
  62 #include <sys/_sx.h>
  63 #include <sys/_task.h>
  64
  65 #define SB_MAX          (2*1024*1024)   /* default for max chars in sockbuf */
  66
  67 struct ktls_session;
  68 struct mbuf;
  69 struct sockaddr;
  70 struct socket;
  71 struct thread;
  72 struct selinfo;
  73
  74 /*
  75  * Variables for socket buffering.
  76  *
  77  * Locking key to struct sockbuf:
  78  * (a) locked by SOCKBUF_LOCK().
  79  * (b) locked by sblock()
  80  */
  81 struct  sockbuf {
  82         struct  mtx sb_mtx;             /* sockbuf lock */
  83         struct  sx sb_sx;               /* prevent I/O interlacing */
  84         struct  selinfo *sb_sel;        /* process selecting read/write */
  85         short   sb_state;       /* (a) socket state on sockbuf */
  86 #define sb_startzero    sb_mb
  87         struct  mbuf *sb_mb;    /* (a) the mbuf chain */
  88         struct  mbuf *sb_mbtail; /* (a) the last mbuf in the chain */
  89         struct  mbuf *sb_lastrecord;    /* (a) first mbuf of last
  90                                          * record in socket buffer */
  91         struct  mbuf *sb_sndptr; /* (a) pointer into mbuf chain */
  92         struct  mbuf *sb_fnrdy; /* (a) pointer to first not ready buffer */
  93         u_int   sb_sndptroff;   /* (a) byte offset of ptr into chain */
  94         u_int   sb_acc;         /* (a) available chars in buffer */
  95         u_int   sb_ccc;         /* (a) claimed chars in buffer */
  96         u_int   sb_hiwat;       /* (a) max actual char count */
  97         u_int   sb_mbcnt;       /* (a) chars of mbufs used */
  98         u_int   sb_mcnt;        /* (a) number of mbufs in buffer */
  99         u_int   sb_ccnt;        /* (a) number of clusters in buffer */
 100         u_int   sb_mbmax;       /* (a) max chars of mbufs to use */
 101         u_int   sb_ctl;         /* (a) non-data chars in buffer */
 102         int     sb_lowat;       /* (a) low water mark */
 103         sbintime_t      sb_timeo;       /* (a) timeout for read/write */
 104         uint64_t sb_tls_seqno;  /* (a) TLS seqno */
 105         struct  ktls_session *sb_tls_info; /* (a + b) TLS state */
 106         short   sb_flags;       /* (a) flags, see above */
 107         int     (*sb_upcall)(struct socket *, void *, int); /* (a) */
 108         void    *sb_upcallarg;  /* (a) */
 109         TAILQ_HEAD(, kaiocb) sb_aiojobq; /* (a) pending AIO ops */
 110         struct  task sb_aiotask; /* AIO task */
 111 };
 112
 113 #endif  /* defined(_KERNEL) || defined(_WANT_SOCKET) */
 114 #ifdef _KERNEL
 115
 116 /*
 117  * Per-socket buffer mutex used to protect most fields in the socket
 118  * buffer.
 119  */
 120 #define SOCKBUF_MTX(_sb)                (&(_sb)->sb_mtx)
 121 #define SOCKBUF_LOCK_INIT(_sb, _name) \
 122         mtx_init(SOCKBUF_MTX(_sb), _name, NULL, MTX_DEF)
 123 #define SOCKBUF_LOCK_DESTROY(_sb)       mtx_destroy(SOCKBUF_MTX(_sb))
 124 #define SOCKBUF_LOCK(_sb)               mtx_lock(SOCKBUF_MTX(_sb))
 125 #define SOCKBUF_OWNED(_sb)              mtx_owned(SOCKBUF_MTX(_sb))
 126 #define SOCKBUF_UNLOCK(_sb)             mtx_unlock(SOCKBUF_MTX(_sb))
 127 #define SOCKBUF_LOCK_ASSERT(_sb)        mtx_assert(SOCKBUF_MTX(_sb), MA_OWNED)
 128 #define SOCKBUF_UNLOCK_ASSERT(_sb)      mtx_assert(SOCKBUF_MTX(_sb), MA_NOTOWNED)
 129
 130 /*
 131  * Socket buffer private mbuf(9) flags.
 132  */
 133 #define M_NOTREADY      M_PROTO1        /* m_data not populated yet */
 134 #define M_BLOCKED       M_PROTO2        /* M_NOTREADY in front of m */
 135 #define M_NOTAVAIL      (M_NOTREADY | M_BLOCKED)
 136
 137 void    sbappend(struct sockbuf *sb, struct mbuf *m, int flags);
 138 void    sbappend_locked(struct sockbuf *sb, struct mbuf *m, int flags);
 139 void    sbappendstream(struct sockbuf *sb, struct mbuf *m, int flags);
 140 void    sbappendstream_locked(struct sockbuf *sb, struct mbuf *m, int flags);
 141 int     sbappendaddr(struct sockbuf *sb, const struct sockaddr *asa,
 142             struct mbuf *m0, struct mbuf *control);
 143 int     sbappendaddr_locked(struct sockbuf *sb, const struct sockaddr *asa,
 144             struct mbuf *m0, struct mbuf *control);
 145 int     sbappendaddr_nospacecheck_locked(struct sockbuf *sb,
 146             const struct sockaddr *asa, struct mbuf *m0, struct mbuf *control);
 147 void    sbappendcontrol(struct sockbuf *sb, struct mbuf *m0,
 148             struct mbuf *control);
 149 void    sbappendcontrol_locked(struct sockbuf *sb, struct mbuf *m0,
 150             struct mbuf *control);
 151 void    sbappendrecord(struct sockbuf *sb, struct mbuf *m0);
 152 void    sbappendrecord_locked(struct sockbuf *sb, struct mbuf *m0);
 153 void    sbcompress(struct sockbuf *sb, struct mbuf *m, struct mbuf *n);
 154 struct mbuf *
 155         sbcreatecontrol(caddr_t p, int size, int type, int level);
 156 void    sbdestroy(struct sockbuf *sb, struct socket *so);
 157 void    sbdrop(struct sockbuf *sb, int len);
 158 void    sbdrop_locked(struct sockbuf *sb, int len);
 159 struct mbuf *
 160         sbcut_locked(struct sockbuf *sb, int len);
 161 void    sbdroprecord(struct sockbuf *sb);
 162 void    sbdroprecord_locked(struct sockbuf *sb);
 163 void    sbflush(struct sockbuf *sb);
 164 void    sbflush_locked(struct sockbuf *sb);
 165 void    sbrelease(struct sockbuf *sb, struct socket *so);
 166 void    sbrelease_internal(struct sockbuf *sb, struct socket *so);
 167 void    sbrelease_locked(struct sockbuf *sb, struct socket *so);
 168 int     sbsetopt(struct socket *so, int cmd, u_long cc);
 169 int     sbreserve_locked(struct sockbuf *sb, u_long cc, struct socket *so,
 170             struct thread *td);
 171 void    sbsndptr_adv(struct sockbuf *sb, struct mbuf *mb, u_int len);
 172 struct mbuf *
 173         sbsndptr_noadv(struct sockbuf *sb, u_int off, u_int *moff);
 174 struct mbuf *
 175         sbsndmbuf(struct sockbuf *sb, u_int off, u_int *moff);
 176 int     sbwait(struct sockbuf *sb);
 177 int     sblock(struct sockbuf *sb, int flags);
 178 void    sbunlock(struct sockbuf *sb);
 179 void    sballoc(struct sockbuf *, struct mbuf *);
 180 void    sbfree(struct sockbuf *, struct mbuf *);
 181 int     sbready(struct sockbuf *, struct mbuf *, int);
 182
 183 /*
 184  * Return how much data is available to be taken out of socket
 185  * buffer right now.
 186  */
 187 static inline u_int
 188 sbavail(struct sockbuf *sb)
 189 {
 190
 191 #if 0
 192         SOCKBUF_LOCK_ASSERT(sb);
 193 #endif
 194         return (sb->sb_acc);
 195 }
 196
 197 /*
 198  * Return how much data sits there in the socket buffer
 199  * It might be that some data is not yet ready to be read.
 200  */
 201 static inline u_int
 202 sbused(struct sockbuf *sb)
 203 {
 204
 205 #if 0
 206         SOCKBUF_LOCK_ASSERT(sb);
 207 #endif
 208         return (sb->sb_ccc);
 209 }
 210
 211 /*
 212  * How much space is there in a socket buffer (so->so_snd or so->so_rcv)?
 213  * This is problematical if the fields are unsigned, as the space might
 214  * still be negative (ccc > hiwat or mbcnt > mbmax).
 215  */
 216 static inline long
 217 sbspace(struct sockbuf *sb)
 218 {
 219         int bleft, mleft;               /* size should match sockbuf fields */
 220
 221 #if 0
 222         SOCKBUF_LOCK_ASSERT(sb);
 223 #endif
 224
 225         if (sb->sb_flags & SB_STOP)
 226                 return(0);
 227
 228         bleft = sb->sb_hiwat - sb->sb_ccc;
 229         mleft = sb->sb_mbmax - sb->sb_mbcnt;
 230
 231         return ((bleft < mleft) ? bleft : mleft);
 232 }
 233
 234 #define SB_EMPTY_FIXUP(sb) do {                                         \
 235         if ((sb)->sb_mb == NULL) {                                      \
 236                 (sb)->sb_mbtail = NULL;                                 \
 237                 (sb)->sb_lastrecord = NULL;                             \
 238         }                                                               \
 239 } while (/*CONSTCOND*/0)
 240
 241 #ifdef SOCKBUF_DEBUG
 242 void    sblastrecordchk(struct sockbuf *, const char *, int);
 243 void    sblastmbufchk(struct sockbuf *, const char *, int);
 244 void    sbcheck(struct sockbuf *, const char *, int);
 245 #define SBLASTRECORDCHK(sb)     sblastrecordchk((sb), __FILE__, __LINE__)
 246 #define SBLASTMBUFCHK(sb)       sblastmbufchk((sb), __FILE__, __LINE__)
 247 #define SBCHECK(sb)             sbcheck((sb), __FILE__, __LINE__)
 248 #else
 249 #define SBLASTRECORDCHK(sb)     do {} while (0)
 250 #define SBLASTMBUFCHK(sb)       do {} while (0)
 251 #define SBCHECK(sb)             do {} while (0)
 252 #endif /* SOCKBUF_DEBUG */
 253
 254 #endif /* _KERNEL */
 255
 256 #endif /* _SYS_SOCKBUF_H_ */