sys/sys/sockbuf.h

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