2 * Copyright (c) 1982, 1986, 1990, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
29 * @(#)socketvar.h 8.3 (Berkeley) 2/19/95
33 #ifndef _SYS_SOCKBUF_H_
34 #define _SYS_SOCKBUF_H_
35 #include <sys/selinfo.h> /* for struct selinfo */
36 #include <sys/_lock.h>
37 #include <sys/_mutex.h>
40 #define SB_MAX (2*1024*1024) /* default for max chars in sockbuf */
43 * Constants for sb_flags field of struct sockbuf.
45 #define SB_WAIT 0x04 /* someone is waiting for data/space */
46 #define SB_SEL 0x08 /* someone is selecting */
47 #define SB_ASYNC 0x10 /* ASYNC I/O, need signals */
48 #define SB_UPCALL 0x20 /* someone wants an upcall */
49 #define SB_NOINTR 0x40 /* operations not interruptible */
50 #define SB_AIO 0x80 /* AIO operations queued */
51 #define SB_KNOTE 0x100 /* kernel note attached */
52 #define SB_NOCOALESCE 0x200 /* don't coalesce new data into existing mbufs */
53 #define SB_IN_TOE 0x400 /* socket buffer is in the middle of an operation */
54 #define SB_AUTOSIZE 0x800 /* automatically size socket buffer */
56 #define SBS_CANTSENDMORE 0x0010 /* can't send more data to peer */
57 #define SBS_CANTRCVMORE 0x0020 /* can't receive more data from peer */
58 #define SBS_RCVATMARK 0x0040 /* at mark on input */
78 * Variables for socket buffering.
81 struct selinfo sb_sel; /* process selecting read/write */
82 struct mtx sb_mtx; /* sockbuf lock */
83 struct sx sb_sx; /* prevent I/O interlacing */
84 short sb_state; /* (c/d) socket state on sockbuf */
85 #define sb_startzero sb_mb
86 struct mbuf *sb_mb; /* (c/d) the mbuf chain */
87 struct mbuf *sb_mbtail; /* (c/d) the last mbuf in the chain */
88 struct mbuf *sb_lastrecord; /* (c/d) first mbuf of last
89 * record in socket buffer */
90 struct mbuf *sb_sndptr; /* (c/d) pointer into mbuf chain */
91 u_int sb_sndptroff; /* (c/d) byte offset of ptr into chain */
92 u_int sb_cc; /* (c/d) actual chars in buffer */
93 u_int sb_hiwat; /* (c/d) max actual char count */
94 u_int sb_mbcnt; /* (c/d) chars of mbufs used */
95 u_int sb_mcnt; /* (c/d) number of mbufs in buffer */
96 u_int sb_ccnt; /* (c/d) number of clusters in buffer */
97 u_int sb_mbmax; /* (c/d) max chars of mbufs to use */
98 u_int sb_ctl; /* (c/d) non-data chars in buffer */
99 int sb_lowat; /* (c/d) low water mark */
100 sbintime_t sb_timeo; /* (c/d) timeout for read/write */
101 short sb_flags; /* (c/d) flags, see below */
102 int (*sb_upcall)(struct socket *, void *, int); /* (c/d) */
103 void *sb_upcallarg; /* (c/d) */
109 * Per-socket buffer mutex used to protect most fields in the socket
112 #define SOCKBUF_MTX(_sb) (&(_sb)->sb_mtx)
113 #define SOCKBUF_LOCK_INIT(_sb, _name) \
114 mtx_init(SOCKBUF_MTX(_sb), _name, NULL, MTX_DEF)
115 #define SOCKBUF_LOCK_DESTROY(_sb) mtx_destroy(SOCKBUF_MTX(_sb))
116 #define SOCKBUF_LOCK(_sb) mtx_lock(SOCKBUF_MTX(_sb))
117 #define SOCKBUF_OWNED(_sb) mtx_owned(SOCKBUF_MTX(_sb))
118 #define SOCKBUF_UNLOCK(_sb) mtx_unlock(SOCKBUF_MTX(_sb))
119 #define SOCKBUF_LOCK_ASSERT(_sb) mtx_assert(SOCKBUF_MTX(_sb), MA_OWNED)
120 #define SOCKBUF_UNLOCK_ASSERT(_sb) mtx_assert(SOCKBUF_MTX(_sb), MA_NOTOWNED)
122 void sbappend(struct sockbuf *sb, struct mbuf *m);
123 void sbappend_locked(struct sockbuf *sb, struct mbuf *m);
124 void sbappendstream(struct sockbuf *sb, struct mbuf *m);
125 void sbappendstream_locked(struct sockbuf *sb, struct mbuf *m);
126 int sbappendaddr(struct sockbuf *sb, const struct sockaddr *asa,
127 struct mbuf *m0, struct mbuf *control);
128 int sbappendaddr_locked(struct sockbuf *sb, const struct sockaddr *asa,
129 struct mbuf *m0, struct mbuf *control);
130 int sbappendcontrol(struct sockbuf *sb, struct mbuf *m0,
131 struct mbuf *control);
132 int sbappendcontrol_locked(struct sockbuf *sb, struct mbuf *m0,
133 struct mbuf *control);
134 void sbappendrecord(struct sockbuf *sb, struct mbuf *m0);
135 void sbappendrecord_locked(struct sockbuf *sb, struct mbuf *m0);
136 void sbcheck(struct sockbuf *sb);
137 void sbcompress(struct sockbuf *sb, struct mbuf *m, struct mbuf *n);
139 sbcreatecontrol(caddr_t p, int size, int type, int level);
140 void sbdestroy(struct sockbuf *sb, struct socket *so);
141 void sbdrop(struct sockbuf *sb, int len);
142 void sbdrop_locked(struct sockbuf *sb, int len);
144 sbcut_locked(struct sockbuf *sb, int len);
145 void sbdroprecord(struct sockbuf *sb);
146 void sbdroprecord_locked(struct sockbuf *sb);
147 void sbflush(struct sockbuf *sb);
148 void sbflush_locked(struct sockbuf *sb);
149 void sbrelease(struct sockbuf *sb, struct socket *so);
150 void sbrelease_internal(struct sockbuf *sb, struct socket *so);
151 void sbrelease_locked(struct sockbuf *sb, struct socket *so);
152 int sbreserve(struct sockbuf *sb, u_long cc, struct socket *so,
154 int sbreserve_locked(struct sockbuf *sb, u_long cc, struct socket *so,
157 sbsndptr(struct sockbuf *sb, u_int off, u_int len, u_int *moff);
158 void sbtoxsockbuf(struct sockbuf *sb, struct xsockbuf *xsb);
159 int sbwait(struct sockbuf *sb);
160 int sblock(struct sockbuf *sb, int flags);
161 void sbunlock(struct sockbuf *sb);
164 * How much space is there in a socket buffer (so->so_snd or so->so_rcv)?
165 * This is problematical if the fields are unsigned, as the space might
166 * still be negative (cc > hiwat or mbcnt > mbmax). Should detect
167 * overflow and return 0. Should use "lmin" but it doesn't exist now.
169 #define sbspace(sb) \
170 ((long) imin((int)((sb)->sb_hiwat - (sb)->sb_cc), \
171 (int)((sb)->sb_mbmax - (sb)->sb_mbcnt)))
173 /* adjust counters in sb reflecting allocation of m */
174 #define sballoc(sb, m) { \
175 (sb)->sb_cc += (m)->m_len; \
176 if ((m)->m_type != MT_DATA && (m)->m_type != MT_OOBDATA) \
177 (sb)->sb_ctl += (m)->m_len; \
178 (sb)->sb_mbcnt += MSIZE; \
179 (sb)->sb_mcnt += 1; \
180 if ((m)->m_flags & M_EXT) { \
181 (sb)->sb_mbcnt += (m)->m_ext.ext_size; \
182 (sb)->sb_ccnt += 1; \
186 /* adjust counters in sb reflecting freeing of m */
187 #define sbfree(sb, m) { \
188 (sb)->sb_cc -= (m)->m_len; \
189 if ((m)->m_type != MT_DATA && (m)->m_type != MT_OOBDATA) \
190 (sb)->sb_ctl -= (m)->m_len; \
191 (sb)->sb_mbcnt -= MSIZE; \
192 (sb)->sb_mcnt -= 1; \
193 if ((m)->m_flags & M_EXT) { \
194 (sb)->sb_mbcnt -= (m)->m_ext.ext_size; \
195 (sb)->sb_ccnt -= 1; \
197 if ((sb)->sb_sndptr == (m)) { \
198 (sb)->sb_sndptr = NULL; \
199 (sb)->sb_sndptroff = 0; \
201 if ((sb)->sb_sndptroff != 0) \
202 (sb)->sb_sndptroff -= (m)->m_len; \
205 #define SB_EMPTY_FIXUP(sb) do { \
206 if ((sb)->sb_mb == NULL) { \
207 (sb)->sb_mbtail = NULL; \
208 (sb)->sb_lastrecord = NULL; \
210 } while (/*CONSTCOND*/0)
213 void sblastrecordchk(struct sockbuf *, const char *, int);
214 #define SBLASTRECORDCHK(sb) sblastrecordchk((sb), __FILE__, __LINE__)
216 void sblastmbufchk(struct sockbuf *, const char *, int);
217 #define SBLASTMBUFCHK(sb) sblastmbufchk((sb), __FILE__, __LINE__)
219 #define SBLASTRECORDCHK(sb) /* nothing */
220 #define SBLASTMBUFCHK(sb) /* nothing */
221 #endif /* SOCKBUF_DEBUG */
225 #endif /* _SYS_SOCKBUF_H_ */