sockbuf.h revision 180970
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 * 4. 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: head/sys/sys/sockbuf.h 180970 2008-07-29 21:48:01Z cognet $ 32 */ 33#ifndef _SYS_SOCKBUF_H_ 34#define _SYS_SOCKBUF_H_ 35 36#define SB_MAX (256*1024) /* default for max chars in sockbuf */ 37 38/* 39 * Constants for sb_flags field of struct sockbuf. 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 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 56struct socket; 57struct sockaddr; 58struct mbuf; 59 60struct xsockbuf { 61 u_int sb_cc; 62 u_int sb_hiwat; 63 u_int sb_mbcnt; 64 u_int sb_mcnt; 65 u_int sb_ccnt; 66 u_int sb_mbmax; 67 int sb_lowat; 68 int sb_timeo; 69 short sb_flags; 70}; 71 72/* 73 * Variables for socket buffering. 74 */ 75struct sockbuf { 76 struct selinfo sb_sel; /* process selecting read/write */ 77 struct mtx sb_mtx; /* sockbuf lock */ 78 struct sx sb_sx; /* prevent I/O interlacing */ 79 short sb_state; /* (c/d) socket state on sockbuf */ 80#define sb_startzero sb_mb 81 struct mbuf *sb_mb; /* (c/d) the mbuf chain */ 82 struct mbuf *sb_mbtail; /* (c/d) the last mbuf in the chain */ 83 struct mbuf *sb_lastrecord; /* (c/d) first mbuf of last 84 * record in socket buffer */ 85 struct mbuf *sb_sndptr; /* (c/d) pointer into mbuf chain */ 86 u_int sb_sndptroff; /* (c/d) byte offset of ptr into chain */ 87 u_int sb_cc; /* (c/d) actual chars in buffer */ 88 u_int sb_hiwat; /* (c/d) max actual char count */ 89 u_int sb_mbcnt; /* (c/d) chars of mbufs used */ 90 u_int sb_mcnt; /* (c/d) number of mbufs in buffer */ 91 u_int sb_ccnt; /* (c/d) number of clusters in buffer */ 92 u_int sb_mbmax; /* (c/d) max chars of mbufs to use */ 93 u_int sb_ctl; /* (c/d) non-data chars in buffer */ 94 int sb_lowat; /* (c/d) low water mark */ 95 int sb_timeo; /* (c/d) timeout for read/write */ 96 short sb_flags; /* (c/d) flags, see below */ 97}; 98 99#ifdef _KERNEL 100 101void sbappend(struct sockbuf *sb, struct mbuf *m); 102void sbappend_locked(struct sockbuf *sb, struct mbuf *m); 103void sbappendstream(struct sockbuf *sb, struct mbuf *m); 104void sbappendstream_locked(struct sockbuf *sb, struct mbuf *m); 105int sbappendaddr(struct sockbuf *sb, const struct sockaddr *asa, 106 struct mbuf *m0, struct mbuf *control); 107int sbappendaddr_locked(struct sockbuf *sb, const struct sockaddr *asa, 108 struct mbuf *m0, struct mbuf *control); 109int sbappendcontrol(struct sockbuf *sb, struct mbuf *m0, 110 struct mbuf *control); 111int sbappendcontrol_locked(struct sockbuf *sb, struct mbuf *m0, 112 struct mbuf *control); 113void sbappendrecord(struct sockbuf *sb, struct mbuf *m0); 114void sbappendrecord_locked(struct sockbuf *sb, struct mbuf *m0); 115void sbcheck(struct sockbuf *sb); 116void sbcompress(struct sockbuf *sb, struct mbuf *m, struct mbuf *n); 117struct mbuf * 118 sbcreatecontrol(caddr_t p, int size, int type, int level); 119void sbdestroy(struct sockbuf *sb, struct socket *so); 120void sbdrop(struct sockbuf *sb, int len); 121void sbdrop_locked(struct sockbuf *sb, int len); 122void sbdroprecord(struct sockbuf *sb); 123void sbdroprecord_locked(struct sockbuf *sb); 124void sbflush(struct sockbuf *sb); 125void sbflush_locked(struct sockbuf *sb); 126void sbrelease(struct sockbuf *sb, struct socket *so); 127void sbrelease_internal(struct sockbuf *sb, struct socket *so); 128void sbrelease_locked(struct sockbuf *sb, struct socket *so); 129int sbreserve(struct sockbuf *sb, u_long cc, struct socket *so, 130 struct thread *td); 131int sbreserve_locked(struct sockbuf *sb, u_long cc, struct socket *so, 132 struct thread *td); 133struct mbuf * 134 sbsndptr(struct sockbuf *sb, u_int off, u_int len, u_int *moff); 135void sbtoxsockbuf(struct sockbuf *sb, struct xsockbuf *xsb); 136int sbwait(struct sockbuf *sb); 137int sblock(struct sockbuf *sb, int flags); 138void sbunlock(struct sockbuf *sb); 139 140/* 141 * How much space is there in a socket buffer (so->so_snd or so->so_rcv)? 142 * This is problematical if the fields are unsigned, as the space might 143 * still be negative (cc > hiwat or mbcnt > mbmax). Should detect 144 * overflow and return 0. Should use "lmin" but it doesn't exist now. 145 */ 146#define sbspace(sb) \ 147 ((long) imin((int)((sb)->sb_hiwat - (sb)->sb_cc), \ 148 (int)((sb)->sb_mbmax - (sb)->sb_mbcnt))) 149 150/* adjust counters in sb reflecting allocation of m */ 151#define sballoc(sb, m) { \ 152 (sb)->sb_cc += (m)->m_len; \ 153 if ((m)->m_type != MT_DATA && (m)->m_type != MT_OOBDATA) \ 154 (sb)->sb_ctl += (m)->m_len; \ 155 (sb)->sb_mbcnt += MSIZE; \ 156 (sb)->sb_mcnt += 1; \ 157 if ((m)->m_flags & M_EXT) { \ 158 (sb)->sb_mbcnt += (m)->m_ext.ext_size; \ 159 (sb)->sb_ccnt += 1; \ 160 } \ 161} 162 163/* adjust counters in sb reflecting freeing of m */ 164#define sbfree(sb, m) { \ 165 (sb)->sb_cc -= (m)->m_len; \ 166 if ((m)->m_type != MT_DATA && (m)->m_type != MT_OOBDATA) \ 167 (sb)->sb_ctl -= (m)->m_len; \ 168 (sb)->sb_mbcnt -= MSIZE; \ 169 (sb)->sb_mcnt -= 1; \ 170 if ((m)->m_flags & M_EXT) { \ 171 (sb)->sb_mbcnt -= (m)->m_ext.ext_size; \ 172 (sb)->sb_ccnt -= 1; \ 173 } \ 174 if ((sb)->sb_sndptr == (m)) { \ 175 (sb)->sb_sndptr = NULL; \ 176 (sb)->sb_sndptroff = 0; \ 177 } \ 178 if ((sb)->sb_sndptroff != 0) \ 179 (sb)->sb_sndptroff -= (m)->m_len; \ 180} 181 182#define SB_EMPTY_FIXUP(sb) do { \ 183 if ((sb)->sb_mb == NULL) { \ 184 (sb)->sb_mbtail = NULL; \ 185 (sb)->sb_lastrecord = NULL; \ 186 } \ 187} while (/*CONSTCOND*/0) 188 189#ifdef SOCKBUF_DEBUG 190void sblastrecordchk(struct sockbuf *, const char *, int); 191#define SBLASTRECORDCHK(sb) sblastrecordchk((sb), __FILE__, __LINE__) 192 193void sblastmbufchk(struct sockbuf *, const char *, int); 194#define SBLASTMBUFCHK(sb) sblastmbufchk((sb), __FILE__, __LINE__) 195#else 196#define SBLASTRECORDCHK(sb) /* nothing */ 197#define SBLASTMBUFCHK(sb) /* nothing */ 198#endif /* SOCKBUF_DEBUG */ 199 200#endif /* _KERNEL */ 201 202#endif /* _SYS_SOCKBUF_H_ */ 203