socketvar.h revision 131029
11541Srgrimes/*-
21541Srgrimes * Copyright (c) 1982, 1986, 1990, 1993
31541Srgrimes *	The Regents of the University of California.  All rights reserved.
41541Srgrimes *
51541Srgrimes * Redistribution and use in source and binary forms, with or without
61541Srgrimes * modification, are permitted provided that the following conditions
71541Srgrimes * are met:
81541Srgrimes * 1. Redistributions of source code must retain the above copyright
91541Srgrimes *    notice, this list of conditions and the following disclaimer.
101541Srgrimes * 2. Redistributions in binary form must reproduce the above copyright
111541Srgrimes *    notice, this list of conditions and the following disclaimer in the
121541Srgrimes *    documentation and/or other materials provided with the distribution.
131541Srgrimes * 4. Neither the name of the University nor the names of its contributors
141541Srgrimes *    may be used to endorse or promote products derived from this software
151541Srgrimes *    without specific prior written permission.
161541Srgrimes *
171541Srgrimes * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
181541Srgrimes * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
191541Srgrimes * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
201541Srgrimes * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
211541Srgrimes * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
221541Srgrimes * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
231541Srgrimes * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
241541Srgrimes * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
251541Srgrimes * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
261541Srgrimes * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
271541Srgrimes * SUCH DAMAGE.
281541Srgrimes *
2914505Shsu *	@(#)socketvar.h	8.3 (Berkeley) 2/19/95
3050477Speter * $FreeBSD: head/sys/sys/socketvar.h 131029 2004-06-24 04:27:10Z rwatson $
311541Srgrimes */
321541Srgrimes
332165Spaul#ifndef _SYS_SOCKETVAR_H_
342165Spaul#define _SYS_SOCKETVAR_H_
352165Spaul
3615492Sbde#include <sys/queue.h>			/* for TAILQ macros */
3770834Swollman#include <sys/selinfo.h>		/* for struct selinfo */
38130380Srwatson#include <sys/_lock.h>
39130380Srwatson#include <sys/_mutex.h>
401541Srgrimes
411541Srgrimes/*
421541Srgrimes * Kernel structure per socket.
431541Srgrimes * Contains send and receive buffer queues,
441541Srgrimes * handle on protocol and pointer to protocol
451541Srgrimes * private data and error information.
461541Srgrimes */
4736079Swollmantypedef	u_quad_t so_gen_t;
4836079Swollman
49129958Srwatson/*-
50129958Srwatson * Locking key to struct socket:
51129958Srwatson * (a) constant after allocation, no locking required.
52129958Srwatson * (b) locked by SOCK_LOCK(so).
53129958Srwatson * (c) locked by SOCKBUF_LOCK(&so->so_rcv).
54129958Srwatson * (d) locked by SOCKBUF_LOCK(&so->so_snd).
55129958Srwatson * (e) locked by ACCEPT_LOCK().
56129958Srwatson * (f) not locked since integer reads/writes are atomic.
57129958Srwatson * (g) used only as a sleep/wakeup address, no value.
5895552Stanimura */
591541Srgrimesstruct socket {
60130387Srwatson	int	so_count;		/* (b) reference count */
61129958Srwatson	short	so_type;		/* (a) generic type, see socket.h */
6297658Stanimura	short	so_options;		/* from socket call, see socket.h */
6397658Stanimura	short	so_linger;		/* time to linger while closing */
64130818Srwatson	short	so_state;		/* (b) internal state flags SS_* */
65129979Srwatson	int	so_qstate;		/* (e) internal state flags SQ_* */
6698993Salfred	void	*so_pcb;		/* protocol control block */
67129958Srwatson	struct	protosw *so_proto;	/* (a) protocol handle */
681541Srgrimes/*
6913765Smpp * Variables for connection queuing.
701541Srgrimes * Socket where accepts occur is so_head in all subsidiary sockets.
711541Srgrimes * If so_head is 0, socket is not related to an accept.
7278913Sjlemon * For head socket so_incomp queues partially completed connections,
7378913Sjlemon * while so_comp is a queue of connections ready to be accepted.
741541Srgrimes * If a connection is aborted and it has so_head set, then
7578913Sjlemon * it has to be pulled out of either so_incomp or so_comp.
761541Srgrimes * We allow connections to queue up based on current queue lengths
771541Srgrimes * and limit on number of queued connections for this socket.
781541Srgrimes */
79129979Srwatson	struct	socket *so_head;	/* (e) back pointer to accept socket */
80129979Srwatson	TAILQ_HEAD(, socket) so_incomp;	/* (e) queue of partial unaccepted connections */
81129979Srwatson	TAILQ_HEAD(, socket) so_comp;	/* (e) queue of complete unaccepted connections */
82129979Srwatson	TAILQ_ENTRY(socket) so_list;	/* (e) list of unaccepted connections */
83129979Srwatson	short	so_qlen;		/* (e) number of unaccepted connections */
84129979Srwatson	short	so_incqlen;		/* (e) number of unaccepted incomplete
8518787Spst					   connections */
86129979Srwatson	short	so_qlimit;		/* (e) max number queued connections */
87130527Srwatson	short	so_timeo;		/* (g) connection timeout */
88131029Srwatson	u_short	so_error;		/* (f) error affecting connection */
8997658Stanimura	struct	sigio *so_sigio;	/* [sg] information for async I/O or
9041087Struckman					   out of band data (SIGURG) */
91131017Srwatson	u_long	so_oobmark;		/* (c) chars to oob mark */
9297658Stanimura	TAILQ_HEAD(, aiocblist) so_aiojobq; /* AIO ops waiting on socket */
931541Srgrimes/*
941541Srgrimes * Variables for socket buffering.
951541Srgrimes */
9683421Sobrien	struct sockbuf {
97100591Sjdp		struct	selinfo sb_sel;	/* process selecting read/write */
98130380Srwatson		struct	mtx sb_mtx;	/* sockbuf lock */
99117708Srobert#define	sb_startzero	sb_mb
100130527Srwatson		struct	mbuf *sb_mb;	/* (c/d) the mbuf chain */
101130527Srwatson		struct	mbuf *sb_mbtail; /* (c/d) the last mbuf in the chain */
102130527Srwatson		struct	mbuf *sb_lastrecord;	/* (c/d) first mbuf of last
103130527Srwatson						 * record in socket buffer */
104130527Srwatson		u_int	sb_cc;		/* (c/d) actual chars in buffer */
105130527Srwatson		u_int	sb_hiwat;	/* (c/d) max actual char count */
106130527Srwatson		u_int	sb_mbcnt;	/* (c/d) chars of mbufs used */
107130527Srwatson		u_int	sb_mbmax;	/* (c/d) max chars of mbufs to use */
108130527Srwatson		u_int	sb_ctl;		/* (c/d) non-data chars in buffer */
109130527Srwatson		int	sb_lowat;	/* (c/d) low water mark */
110130527Srwatson		int	sb_timeo;	/* (c/d) timeout for read/write */
111130527Srwatson		short	sb_flags;	/* (c/d) flags, see below */
112130480Srwatson		short	sb_state;	/* (c/d) socket state on sockbuf */
1131541Srgrimes	} so_rcv, so_snd;
114130818Srwatson/*
115130818Srwatson * Constants for sb_flags field of struct sockbuf.
116130818Srwatson */
1171541Srgrimes#define	SB_MAX		(256*1024)	/* default for max chars in sockbuf */
118131022Srwatson/*
119131022Srwatson * Constants for sb_flags field of struct sockbuf.
120131022Srwatson */
1211541Srgrimes#define	SB_LOCK		0x01		/* lock on data queue */
1221541Srgrimes#define	SB_WANT		0x02		/* someone is waiting to lock */
1231541Srgrimes#define	SB_WAIT		0x04		/* someone is waiting for data/space */
1241541Srgrimes#define	SB_SEL		0x08		/* someone is selecting */
1251541Srgrimes#define	SB_ASYNC	0x10		/* ASYNC I/O, need signals */
12636527Speter#define	SB_UPCALL	0x20		/* someone wants an upcall */
1271541Srgrimes#define	SB_NOINTR	0x40		/* operations not interruptible */
12855943Sjasone#define SB_AIO		0x80		/* AIO operations queued */
12959288Sjlemon#define SB_KNOTE	0x100		/* kernel note attached */
1301541Srgrimes
13197658Stanimura	void	(*so_upcall)(struct socket *, void *, int);
13297658Stanimura	void	*so_upcallarg;
133130527Srwatson	struct	ucred *so_cred;		/* (a) user credentials */
134130398Srwatson	struct	label *so_label;	/* (b) MAC label for socket */
135130398Srwatson	struct	label *so_peerlabel;	/* (b) cached MAC label for peer */
13638482Swollman	/* NB: generation count must not be first; easiest to make it last. */
13797658Stanimura	so_gen_t so_gencnt;		/* generation count */
13897658Stanimura	void	*so_emuldata;		/* private data for emulators */
13997658Stanimura 	struct so_accf {
14097658Stanimura		struct	accept_filter *so_accept_filter;
14197658Stanimura		void	*so_accept_filter_arg;	/* saved filter args */
14297658Stanimura		char	*so_accept_filter_str;	/* saved user args */
14397658Stanimura	} *so_accf;
1441541Srgrimes};
1451541Srgrimes
146121628Ssam#define SB_EMPTY_FIXUP(sb) do {						\
147121628Ssam	if ((sb)->sb_mb == NULL) {					\
148121628Ssam		(sb)->sb_mbtail = NULL;					\
149121628Ssam		(sb)->sb_lastrecord = NULL;				\
150121628Ssam	}								\
151121628Ssam} while (/*CONSTCOND*/0)
152121628Ssam
1531541Srgrimes/*
154129979Srwatson * Global accept mutex to serialize access to accept queues and
155129979Srwatson * fields associated with multiple sockets.  This allows us to
156129979Srwatson * avoid defining a lock order between listen and accept sockets
157129979Srwatson * until such time as it proves to be a good idea.
158129979Srwatson */
159129979Srwatsonextern struct mtx accept_mtx;
160130364Srwatson#define	ACCEPT_LOCK()			mtx_lock(&accept_mtx)
161130364Srwatson#define	ACCEPT_UNLOCK()			mtx_unlock(&accept_mtx)
162129979Srwatson
163129979Srwatson/*
164130380Srwatson * Per-socket buffer mutex used to protect most fields in the socket
165130380Srwatson * buffer.
166130380Srwatson */
167130380Srwatson#define	SOCKBUF_MTX(_sb)		(&(_sb)->sb_mtx)
168130380Srwatson#define	SOCKBUF_LOCK_INIT(_sb, _name) \
169130380Srwatson	mtx_init(SOCKBUF_MTX(_sb), _name, NULL, MTX_DEF)
170130380Srwatson#define	SOCKBUF_LOCK_DESTROY(_sb)	mtx_destroy(SOCKBUF_MTX(_sb))
171130380Srwatson#define	SOCKBUF_LOCK(_sb)		mtx_lock(SOCKBUF_MTX(_sb))
172130380Srwatson#define	SOCKBUF_OWNED(_sb)		mtx_owned(SOCKBUF_MTX(_sb))
173130380Srwatson#define	SOCKBUF_UNLOCK(_sb)		mtx_unlock(SOCKBUF_MTX(_sb))
174130380Srwatson#define	SOCKBUF_LOCK_ASSERT(_sb)	mtx_assert(SOCKBUF_MTX(_sb), MA_OWNED)
175130380Srwatson
176130380Srwatson/*
177130380Srwatson * Per-socket mutex: we reuse the receive socket buffer mutex for space
178130380Srwatson * efficiency.  This decision should probably be revisited as we optimize
179130380Srwatson * locking for the socket code.
180130380Srwatson */
181130380Srwatson#define	SOCK_MTX(_so)			SOCKBUF_MTX(&(_so)->so_rcv)
182130380Srwatson#define	SOCK_LOCK(_so)			SOCKBUF_LOCK(&(_so)->so_rcv)
183130380Srwatson#define	SOCK_OWNED(_so)			SOCKBUF_OWNED(&(_so)->so_rcv)
184130380Srwatson#define	SOCK_UNLOCK(_so)		SOCKBUF_UNLOCK(&(_so)->so_rcv)
185130380Srwatson#define	SOCK_LOCK_ASSERT(_so)		SOCKBUF_LOCK_ASSERT(&(_so)->so_rcv)
186130380Srwatson
187130492Srwatson/*
1881541Srgrimes * Socket state bits.
189130480Srwatson *
190130480Srwatson * Historically, this bits were all kept in the so_state field.  For
191130480Srwatson * locking reasons, they are now in multiple fields, as they are
192130480Srwatson * locked differently.  so_state maintains basic socket state protected
193130480Srwatson * by the socket lock.  so_qstate holds information about the socket
194130480Srwatson * accept queues.  Each socket buffer also has a state field holding
195130480Srwatson * information relevant to that socket buffer (can't send, rcv).  Many
196130480Srwatson * fields will be read without locks to improve performance and avoid
197130480Srwatson * lock order issues.  However, this approach must be used with caution.
1981541Srgrimes */
19914547Sdg#define	SS_NOFDREF		0x0001	/* no file table ref any more */
20014547Sdg#define	SS_ISCONNECTED		0x0002	/* socket connected to a peer */
20114547Sdg#define	SS_ISCONNECTING		0x0004	/* in process of connecting to peer */
20214547Sdg#define	SS_ISDISCONNECTING	0x0008	/* in process of disconnecting */
20314547Sdg#define	SS_NBIO			0x0100	/* non-blocking ops */
20414547Sdg#define	SS_ASYNC		0x0200	/* async i/o notify */
20514547Sdg#define	SS_ISCONFIRMING		0x0400	/* deciding to accept connection req */
20643196Sfenner#define	SS_ISDISCONNECTED	0x2000	/* socket disconnected from peer */
2071541Srgrimes
20836079Swollman/*
209130480Srwatson * Socket state bits now stored in the socket buffer state field.
210130480Srwatson */
211130480Srwatson#define	SBS_CANTSENDMORE	0x0010	/* can't send more data to peer */
212130480Srwatson#define	SBS_CANTRCVMORE		0x0020	/* can't receive more data from peer */
213130480Srwatson#define	SBS_RCVATMARK		0x0040	/* at mark on input */
214130480Srwatson
215130480Srwatson/*
216129916Srwatson * Socket state bits stored in so_qstate.
217129916Srwatson */
218129916Srwatson#define	SQ_INCOMP		0x0800	/* unaccepted, incomplete connection */
219129916Srwatson#define	SQ_COMP			0x1000	/* unaccepted, complete connection */
220129916Srwatson
221129916Srwatson/*
22236079Swollman * Externalized form of struct socket used by the sysctl(3) interface.
22336079Swollman */
22483045Sobrienstruct xsocket {
22536079Swollman	size_t	xso_len;	/* length of this structure */
22636079Swollman	struct	socket *xso_so;	/* makes a convenient handle sometimes */
22736079Swollman	short	so_type;
22836079Swollman	short	so_options;
22936079Swollman	short	so_linger;
23036079Swollman	short	so_state;
23136079Swollman	caddr_t	so_pcb;		/* another convenient handle */
23236079Swollman	int	xso_protocol;
23336079Swollman	int	xso_family;
23436079Swollman	short	so_qlen;
23536079Swollman	short	so_incqlen;
23636079Swollman	short	so_qlimit;
23736079Swollman	short	so_timeo;
23836079Swollman	u_short	so_error;
23936079Swollman	pid_t	so_pgid;
24036079Swollman	u_long	so_oobmark;
24183421Sobrien	struct xsockbuf {
242100591Sjdp		u_int	sb_cc;
243100591Sjdp		u_int	sb_hiwat;
244100591Sjdp		u_int	sb_mbcnt;
245100591Sjdp		u_int	sb_mbmax;
246100591Sjdp		int	sb_lowat;
247100591Sjdp		int	sb_timeo;
24836079Swollman		short	sb_flags;
24936079Swollman	} so_rcv, so_snd;
25036079Swollman	uid_t	so_uid;		/* XXX */
25136079Swollman};
25214547Sdg
253130393Srwatson#ifdef _KERNEL
254130393Srwatson
2551541Srgrimes/*
2561541Srgrimes * Macros for sockets and socket buffering.
2571541Srgrimes */
2581541Srgrimes
2591541Srgrimes/*
26036527Speter * Do we need to notify the other side when I/O is possible?
26136527Speter */
26255943Sjasone#define	sb_notify(sb)	(((sb)->sb_flags & (SB_WAIT | SB_SEL | SB_ASYNC | \
26359288Sjlemon    SB_UPCALL | SB_AIO | SB_KNOTE)) != 0)
26436527Speter
26536527Speter/*
2661541Srgrimes * How much space is there in a socket buffer (so->so_snd or so->so_rcv)?
2671541Srgrimes * This is problematical if the fields are unsigned, as the space might
2681541Srgrimes * still be negative (cc > hiwat or mbcnt > mbmax).  Should detect
2691541Srgrimes * overflow and return 0.  Should use "lmin" but it doesn't exist now.
2701541Srgrimes */
2711541Srgrimes#define	sbspace(sb) \
2721541Srgrimes    ((long) imin((int)((sb)->sb_hiwat - (sb)->sb_cc), \
2731541Srgrimes	 (int)((sb)->sb_mbmax - (sb)->sb_mbcnt)))
2741541Srgrimes
2751541Srgrimes/* do we have to send all at once on a socket? */
2761541Srgrimes#define	sosendallatonce(so) \
2771541Srgrimes    ((so)->so_proto->pr_flags & PR_ATOMIC)
2781541Srgrimes
2791541Srgrimes/* can we read something from so? */
2801541Srgrimes#define	soreadable(so) \
2811541Srgrimes    ((so)->so_rcv.sb_cc >= (so)->so_rcv.sb_lowat || \
282130480Srwatson	((so)->so_rcv.sb_state & SBS_CANTRCVMORE) || \
28370536Sphk	!TAILQ_EMPTY(&(so)->so_comp) || (so)->so_error)
2841541Srgrimes
2851541Srgrimes/* can we write something to so? */
2861541Srgrimes#define	sowriteable(so) \
2873304Sphk    ((sbspace(&(so)->so_snd) >= (so)->so_snd.sb_lowat && \
2881541Srgrimes	(((so)->so_state&SS_ISCONNECTED) || \
2893304Sphk	  ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0)) || \
290130480Srwatson     ((so)->so_snd.sb_state & SBS_CANTSENDMORE) || \
2911541Srgrimes     (so)->so_error)
2921541Srgrimes
2931541Srgrimes/* adjust counters in sb reflecting allocation of m */
2941541Srgrimes#define	sballoc(sb, m) { \
2951541Srgrimes	(sb)->sb_cc += (m)->m_len; \
296109098Stjr	if ((m)->m_type != MT_DATA && (m)->m_type != MT_HEADER && \
297109098Stjr	    (m)->m_type != MT_OOBDATA) \
298106313Skbyanc		(sb)->sb_ctl += (m)->m_len; \
2991541Srgrimes	(sb)->sb_mbcnt += MSIZE; \
3001541Srgrimes	if ((m)->m_flags & M_EXT) \
3011541Srgrimes		(sb)->sb_mbcnt += (m)->m_ext.ext_size; \
3021541Srgrimes}
3031541Srgrimes
3041541Srgrimes/* adjust counters in sb reflecting freeing of m */
3051541Srgrimes#define	sbfree(sb, m) { \
3061541Srgrimes	(sb)->sb_cc -= (m)->m_len; \
307109098Stjr	if ((m)->m_type != MT_DATA && (m)->m_type != MT_HEADER && \
308109098Stjr	    (m)->m_type != MT_OOBDATA) \
309106313Skbyanc		(sb)->sb_ctl -= (m)->m_len; \
3101541Srgrimes	(sb)->sb_mbcnt -= MSIZE; \
3111541Srgrimes	if ((m)->m_flags & M_EXT) \
3121541Srgrimes		(sb)->sb_mbcnt -= (m)->m_ext.ext_size; \
3131541Srgrimes}
3141541Srgrimes
3151541Srgrimes/*
3161541Srgrimes * Set lock on sockbuf sb; sleep if lock is already held.
3171541Srgrimes * Unless SB_NOINTR is set on sockbuf, sleep is interruptible.
3181541Srgrimes * Returns error without lock if sleep is interrupted.
3191541Srgrimes */
3201541Srgrimes#define sblock(sb, wf) ((sb)->sb_flags & SB_LOCK ? \
321111119Simp		(((wf) == M_WAITOK) ? sb_lock(sb) : EWOULDBLOCK) : \
3221541Srgrimes		((sb)->sb_flags |= SB_LOCK), 0)
3231541Srgrimes
3241541Srgrimes/* release lock on sockbuf sb */
325130831Srwatson#define	sbunlock(sb) do { \
326130831Srwatson	SOCKBUF_LOCK_ASSERT(sb); \
3271541Srgrimes	(sb)->sb_flags &= ~SB_LOCK; \
3281541Srgrimes	if ((sb)->sb_flags & SB_WANT) { \
3291541Srgrimes		(sb)->sb_flags &= ~SB_WANT; \
330111748Sdes		wakeup(&(sb)->sb_flags); \
3311541Srgrimes	} \
332130831Srwatson} while (0)
3331541Srgrimes
33486487Sdillon/*
33586487Sdillon * soref()/sorele() ref-count the socket structure.  Note that you must
33686487Sdillon * still explicitly close the socket, but the last ref count will free
33786487Sdillon * the structure.
33886487Sdillon */
339130383Srwatson#define	soref(so) do {							\
340130387Srwatson	SOCK_LOCK_ASSERT(so);						\
341130383Srwatson	++(so)->so_count;						\
342130383Srwatson} while (0)
34386487Sdillon
344130383Srwatson#define	sorele(so) do {							\
345130387Srwatson	SOCK_LOCK_ASSERT(so);						\
346130383Srwatson	if ((so)->so_count <= 0)					\
347130383Srwatson		panic("sorele");					\
348130383Srwatson	if (--(so)->so_count == 0)					\
349130383Srwatson		sofree(so);						\
350130387Srwatson	else								\
351130387Srwatson		SOCK_UNLOCK(so);					\
352130383Srwatson} while (0)
35386487Sdillon
354130383Srwatson#define	sotryfree(so) do {						\
355130387Srwatson	SOCK_LOCK_ASSERT(so);						\
356130383Srwatson	if ((so)->so_count == 0)					\
357130383Srwatson		sofree(so);						\
358130387Srwatson	else								\
359130387Srwatson		SOCK_UNLOCK(so);					\
360130383Srwatson} while(0)
36186487Sdillon
362130831Srwatson/*
363130831Srwatson * In sorwakeup() and sowwakeup(), acquire the socket buffer lock to
364130831Srwatson * avoid a non-atomic test-and-wakeup.  However, sowakeup is
365130831Srwatson * responsible for releasing the lock if it is called.  We unlock only
366130831Srwatson * if we don't call into sowakeup.  If any code is introduced that
367130831Srwatson * directly invokes the underlying sowakeup() primitives, it must
368130831Srwatson * maintain the same semantics.
369130831Srwatson */
370130831Srwatson#define	sorwakeup_locked(so) do {					\
371130831Srwatson	SOCKBUF_LOCK_ASSERT(&(so)->so_rcv);				\
372130383Srwatson	if (sb_notify(&(so)->so_rcv))					\
373130831Srwatson		sowakeup((so), &(so)->so_rcv);	 			\
374130831Srwatson	else								\
375130831Srwatson		SOCKBUF_UNLOCK(&(so)->so_rcv);				\
376130383Srwatson} while (0)
3771541Srgrimes
378130831Srwatson#define	sorwakeup(so) do {						\
379130831Srwatson	SOCKBUF_LOCK(&(so)->so_rcv);					\
380130831Srwatson	sorwakeup_locked(so);						\
381130831Srwatson} while (0)
382130831Srwatson
383130831Srwatson#define	sowwakeup_locked(so) do {					\
384131029Srwatson	SOCKBUF_LOCK_ASSERT(&(so)->so_snd);				\
385130383Srwatson	if (sb_notify(&(so)->so_snd))					\
386130383Srwatson		sowakeup((so), &(so)->so_snd); 				\
387130831Srwatson	else								\
388130831Srwatson		SOCKBUF_UNLOCK(&(so)->so_snd);				\
389130383Srwatson} while (0)
3901541Srgrimes
391130831Srwatson#define	sowwakeup(so) do {						\
392130831Srwatson	SOCKBUF_LOCK(&(so)->so_snd);					\
393130831Srwatson	sowwakeup_locked(so);						\
394130831Srwatson} while (0)
395130831Srwatson
39638482Swollman/*
39738482Swollman * Argument structure for sosetopt et seq.  This is in the KERNEL
39838482Swollman * section because it will never be visible to user code.
39938482Swollman */
40038482Swollmanenum sopt_dir { SOPT_GET, SOPT_SET };
40138482Swollmanstruct sockopt {
40238482Swollman	enum	sopt_dir sopt_dir; /* is this a get or a set? */
40338482Swollman	int	sopt_level;	/* second arg of [gs]etsockopt */
40438482Swollman	int	sopt_name;	/* third arg of [gs]etsockopt */
40538482Swollman	void   *sopt_val;	/* fourth arg of [gs]etsockopt */
40638482Swollman	size_t	sopt_valsize;	/* (almost) fifth arg of [gs]etsockopt */
40795959Salfred	struct	thread *sopt_td; /* calling thread or null if kernel */
40838482Swollman};
40938482Swollman
41061837Salfredstruct accept_filter {
41161837Salfred	char	accf_name[16];
41261837Salfred	void	(*accf_callback)
41392719Salfred		(struct socket *so, void *arg, int waitflag);
41461837Salfred	void *	(*accf_create)
41592719Salfred		(struct socket *so, char *arg);
41661837Salfred	void	(*accf_destroy)
41792719Salfred		(struct socket *so);
41895959Salfred	SLIST_ENTRY(accept_filter) accf_next;
41982656Sjlemon};
42061837Salfred
42131927Sbde#ifdef MALLOC_DECLARE
42295959SalfredMALLOC_DECLARE(M_ACCF);
42331927SbdeMALLOC_DECLARE(M_PCB);
42431927SbdeMALLOC_DECLARE(M_SONAME);
42531927Sbde#endif
42631927Sbde
42795959Salfredextern int	maxsockets;
4282112Swollmanextern u_long	sb_max;
42995959Salfredextern struct uma_zone *socket_zone;
43036079Swollmanextern so_gen_t so_gencnt;
43114505Shsu
43215492Sbdestruct mbuf;
43315492Sbdestruct sockaddr;
43432995Sbdestruct ucred;
43532995Sbdestruct uio;
43615492Sbde
4371541Srgrimes/*
4383304Sphk * From uipc_socket and friends
4393304Sphk */
44092719Salfredint	sockargs(struct mbuf **mp, caddr_t buf, int buflen, int type);
44192719Salfredint	getsockaddr(struct sockaddr **namp, caddr_t uaddr, size_t len);
44292719Salfredvoid	sbappend(struct sockbuf *sb, struct mbuf *m);
443130831Srwatsonvoid	sbappend_locked(struct sockbuf *sb, struct mbuf *m);
444121628Ssamvoid	sbappendstream(struct sockbuf *sb, struct mbuf *m);
445130831Srwatsonvoid	sbappendstream_locked(struct sockbuf *sb, struct mbuf *m);
446130050Srwatsonint	sbappendaddr(struct sockbuf *sb, const struct sockaddr *asa,
44792719Salfred	    struct mbuf *m0, struct mbuf *control);
448130831Srwatsonint	sbappendaddr_locked(struct sockbuf *sb, const struct sockaddr *asa,
449130831Srwatson	    struct mbuf *m0, struct mbuf *control);
45092719Salfredint	sbappendcontrol(struct sockbuf *sb, struct mbuf *m0,
45192719Salfred	    struct mbuf *control);
452130831Srwatsonint	sbappendcontrol_locked(struct sockbuf *sb, struct mbuf *m0,
453130831Srwatson	    struct mbuf *control);
45492719Salfredvoid	sbappendrecord(struct sockbuf *sb, struct mbuf *m0);
455130831Srwatsonvoid	sbappendrecord_locked(struct sockbuf *sb, struct mbuf *m0);
45692719Salfredvoid	sbcheck(struct sockbuf *sb);
45792719Salfredvoid	sbcompress(struct sockbuf *sb, struct mbuf *m, struct mbuf *n);
45819670Sbdestruct mbuf *
45992719Salfred	sbcreatecontrol(caddr_t p, int size, int type, int level);
46092719Salfredvoid	sbdrop(struct sockbuf *sb, int len);
461130831Srwatsonvoid	sbdrop_locked(struct sockbuf *sb, int len);
46292719Salfredvoid	sbdroprecord(struct sockbuf *sb);
463130831Srwatsonvoid	sbdroprecord_locked(struct sockbuf *sb);
46492719Salfredvoid	sbflush(struct sockbuf *sb);
465130831Srwatsonvoid	sbflush_locked(struct sockbuf *sb);
46692719Salfredvoid	sbinsertoob(struct sockbuf *sb, struct mbuf *m0);
467130831Srwatsonvoid	sbinsertoob_locked(struct sockbuf *sb, struct mbuf *m0);
46892719Salfredvoid	sbrelease(struct sockbuf *sb, struct socket *so);
469130831Srwatsonvoid	sbrelease_locked(struct sockbuf *sb, struct socket *so);
47092719Salfredint	sbreserve(struct sockbuf *sb, u_long cc, struct socket *so,
47193008Sbde	    struct thread *td);
472131006Srwatsonint	sbreserve_locked(struct sockbuf *sb, u_long cc, struct socket *so,
473131006Srwatson	    struct thread *td);
47492719Salfredvoid	sbtoxsockbuf(struct sockbuf *sb, struct xsockbuf *xsb);
47592719Salfredint	sbwait(struct sockbuf *sb);
47692719Salfredint	sb_lock(struct sockbuf *sb);
47792719Salfredint	soabort(struct socket *so);
47892719Salfredint	soaccept(struct socket *so, struct sockaddr **nam);
479126411Srwatsonstruct	socket *soalloc(int mflags);
48095959Salfredint	socheckuid(struct socket *so, uid_t uid);
48192719Salfredint	sobind(struct socket *so, struct sockaddr *nam, struct thread *td);
48292719Salfredvoid	socantrcvmore(struct socket *so);
483130831Srwatsonvoid	socantrcvmore_locked(struct socket *so);
48492719Salfredvoid	socantsendmore(struct socket *so);
485130831Srwatsonvoid	socantsendmore_locked(struct socket *so);
48692719Salfredint	soclose(struct socket *so);
48792719Salfredint	soconnect(struct socket *so, struct sockaddr *nam, struct thread *td);
48892719Salfredint	soconnect2(struct socket *so1, struct socket *so2);
48998849Skenint	socow_setup(struct mbuf *m0, struct uio *uio);
49092719Salfredint	socreate(int dom, struct socket **aso, int type, int proto,
49192719Salfred	    struct ucred *cred, struct thread *td);
492106326Salcvoid	sodealloc(struct socket *so);
49392719Salfredint	sodisconnect(struct socket *so);
494126425Srwatsonstruct	sockaddr *sodupsockaddr(const struct sockaddr *sa, int mflags);
49592719Salfredvoid	sofree(struct socket *so);
49692719Salfredint	sogetopt(struct socket *so, struct sockopt *sopt);
49792719Salfredvoid	sohasoutofband(struct socket *so);
49892719Salfredvoid	soisconnected(struct socket *so);
49992719Salfredvoid	soisconnecting(struct socket *so);
50092719Salfredvoid	soisdisconnected(struct socket *so);
50192719Salfredvoid	soisdisconnecting(struct socket *so);
50292719Salfredint	solisten(struct socket *so, int backlog, struct thread *td);
50314505Shsustruct socket *
50492719Salfred	sonewconn(struct socket *head, int connstatus);
50593008Sbdeint	sooptcopyin(struct sockopt *sopt, void *buf, size_t len, size_t minlen);
506118453Shsuint	sooptcopyout(struct sockopt *sopt, const void *buf, size_t len);
50753541Sshin
50853541Sshin/* XXX; prepare mbuf for (__FreeBSD__ < 3) routines. */
50992719Salfredint	soopt_getm(struct sockopt *sopt, struct mbuf **mp);
51092719Salfredint	soopt_mcopyin(struct sockopt *sopt, struct mbuf *m);
51192719Salfredint	soopt_mcopyout(struct sockopt *sopt, struct mbuf *m);
51253541Sshin
513101983Srwatsonint	sopoll(struct socket *so, int events, struct ucred *active_cred,
51493008Sbde	    struct thread *td);
51593008Sbdeint	soreceive(struct socket *so, struct sockaddr **paddr, struct uio *uio,
51693008Sbde	    struct mbuf **mp0, struct mbuf **controlp, int *flagsp);
51792719Salfredint	soreserve(struct socket *so, u_long sndcc, u_long rcvcc);
51892719Salfredvoid	sorflush(struct socket *so);
51992719Salfredint	sosend(struct socket *so, struct sockaddr *addr, struct uio *uio,
52093008Sbde	    struct mbuf *top, struct mbuf *control, int flags,
52193008Sbde	    struct thread *td);
52292719Salfredint	sosetopt(struct socket *so, struct sockopt *sopt);
52392719Salfredint	soshutdown(struct socket *so, int how);
52492719Salfredvoid	sotoxsocket(struct socket *so, struct xsocket *xso);
52592719Salfredvoid	sowakeup(struct socket *so, struct sockbuf *sb);
52631927Sbde
527121628Ssam#ifdef SOCKBUF_DEBUG
528121628Ssamvoid	sblastrecordchk(struct sockbuf *, const char *, int);
529121628Ssam#define	SBLASTRECORDCHK(sb)	sblastrecordchk((sb), __FILE__, __LINE__)
530121628Ssam
531121628Ssamvoid	sblastmbufchk(struct sockbuf *, const char *, int);
532121628Ssam#define	SBLASTMBUFCHK(sb)	sblastmbufchk((sb), __FILE__, __LINE__)
533121628Ssam#else
534121628Ssam#define	SBLASTRECORDCHK(sb)      /* nothing */
535121628Ssam#define	SBLASTMBUFCHK(sb)        /* nothing */
536121628Ssam#endif /* SOCKBUF_DEBUG */
537121628Ssam
53895959Salfred/*
53995959Salfred * Accept filter functions (duh).
54095959Salfred */
54192719Salfredint	accept_filt_add(struct accept_filter *filt);
54292719Salfredint	accept_filt_del(char *name);
54395959Salfredstruct	accept_filter *accept_filt_get(char *name);
54461837Salfred#ifdef ACCEPT_FILTER_MOD
54595959Salfred#ifdef SYSCTL_DECL
54665534SalfredSYSCTL_DECL(_net_inet_accf);
54795959Salfred#endif
54895959Salfredint	accept_filt_generic_mod_event(module_t mod, int event, void *data);
54995959Salfred#endif
55061837Salfred
55155205Speter#endif /* _KERNEL */
5522165Spaul
55314505Shsu#endif /* !_SYS_SOCKETVAR_H_ */
554