socketvar.h revision 175845
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 175845 2008-01-31 08:22:24Z 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>
40169236Srwatson#include <sys/_sx.h>
411541Srgrimes
421541Srgrimes/*
431541Srgrimes * Kernel structure per socket.
441541Srgrimes * Contains send and receive buffer queues,
451541Srgrimes * handle on protocol and pointer to protocol
461541Srgrimes * private data and error information.
471541Srgrimes */
4836079Swollmantypedef	u_quad_t so_gen_t;
4936079Swollman
50129958Srwatson/*-
51129958Srwatson * Locking key to struct socket:
52129958Srwatson * (a) constant after allocation, no locking required.
53129958Srwatson * (b) locked by SOCK_LOCK(so).
54129958Srwatson * (c) locked by SOCKBUF_LOCK(&so->so_rcv).
55129958Srwatson * (d) locked by SOCKBUF_LOCK(&so->so_snd).
56129958Srwatson * (e) locked by ACCEPT_LOCK().
57129958Srwatson * (f) not locked since integer reads/writes are atomic.
58129958Srwatson * (g) used only as a sleep/wakeup address, no value.
59131168Srwatson * (h) locked by global mutex so_global_mtx.
6095552Stanimura */
611541Srgrimesstruct socket {
62130387Srwatson	int	so_count;		/* (b) reference count */
63129958Srwatson	short	so_type;		/* (a) generic type, see socket.h */
6497658Stanimura	short	so_options;		/* from socket call, see socket.h */
6597658Stanimura	short	so_linger;		/* time to linger while closing */
66130818Srwatson	short	so_state;		/* (b) internal state flags SS_* */
67129979Srwatson	int	so_qstate;		/* (e) internal state flags SQ_* */
6898993Salfred	void	*so_pcb;		/* protocol control block */
69129958Srwatson	struct	protosw *so_proto;	/* (a) protocol handle */
701541Srgrimes/*
7113765Smpp * Variables for connection queuing.
721541Srgrimes * Socket where accepts occur is so_head in all subsidiary sockets.
731541Srgrimes * If so_head is 0, socket is not related to an accept.
7478913Sjlemon * For head socket so_incomp queues partially completed connections,
7578913Sjlemon * while so_comp is a queue of connections ready to be accepted.
761541Srgrimes * If a connection is aborted and it has so_head set, then
7778913Sjlemon * it has to be pulled out of either so_incomp or so_comp.
781541Srgrimes * We allow connections to queue up based on current queue lengths
791541Srgrimes * and limit on number of queued connections for this socket.
801541Srgrimes */
81160604Srwatson	struct	socket *so_head;	/* (e) back pointer to listen socket */
82129979Srwatson	TAILQ_HEAD(, socket) so_incomp;	/* (e) queue of partial unaccepted connections */
83129979Srwatson	TAILQ_HEAD(, socket) so_comp;	/* (e) queue of complete unaccepted connections */
84129979Srwatson	TAILQ_ENTRY(socket) so_list;	/* (e) list of unaccepted connections */
85140730Sglebius	u_short	so_qlen;		/* (e) number of unaccepted connections */
86140730Sglebius	u_short	so_incqlen;		/* (e) number of unaccepted incomplete
8718787Spst					   connections */
88140730Sglebius	u_short	so_qlimit;		/* (e) max number queued connections */
89130527Srwatson	short	so_timeo;		/* (g) connection timeout */
90131029Srwatson	u_short	so_error;		/* (f) error affecting connection */
9197658Stanimura	struct	sigio *so_sigio;	/* [sg] information for async I/O or
9241087Struckman					   out of band data (SIGURG) */
93131017Srwatson	u_long	so_oobmark;		/* (c) chars to oob mark */
9497658Stanimura	TAILQ_HEAD(, aiocblist) so_aiojobq; /* AIO ops waiting on socket */
951541Srgrimes/*
961541Srgrimes * Variables for socket buffering.
971541Srgrimes */
9883421Sobrien	struct sockbuf {
99100591Sjdp		struct	selinfo sb_sel;	/* process selecting read/write */
100130380Srwatson		struct	mtx sb_mtx;	/* sockbuf lock */
101169236Srwatson		struct	sx sb_sx;	/* prevent I/O interlacing */
102141052Sglebius		short	sb_state;	/* (c/d) socket state on sockbuf */
103117708Srobert#define	sb_startzero	sb_mb
104130527Srwatson		struct	mbuf *sb_mb;	/* (c/d) the mbuf chain */
105130527Srwatson		struct	mbuf *sb_mbtail; /* (c/d) the last mbuf in the chain */
106130527Srwatson		struct	mbuf *sb_lastrecord;	/* (c/d) first mbuf of last
107130527Srwatson						 * record in socket buffer */
108167715Sandre		struct	mbuf *sb_sndptr; /* (c/d) pointer into mbuf chain */
109167715Sandre		u_int	sb_sndptroff;	/* (c/d) byte offset of ptr into chain */
110130527Srwatson		u_int	sb_cc;		/* (c/d) actual chars in buffer */
111130527Srwatson		u_int	sb_hiwat;	/* (c/d) max actual char count */
112130527Srwatson		u_int	sb_mbcnt;	/* (c/d) chars of mbufs used */
113130527Srwatson		u_int	sb_mbmax;	/* (c/d) max chars of mbufs to use */
114130527Srwatson		u_int	sb_ctl;		/* (c/d) non-data chars in buffer */
115130527Srwatson		int	sb_lowat;	/* (c/d) low water mark */
116130527Srwatson		int	sb_timeo;	/* (c/d) timeout for read/write */
117130527Srwatson		short	sb_flags;	/* (c/d) flags, see below */
1181541Srgrimes	} so_rcv, so_snd;
119130818Srwatson/*
120130818Srwatson * Constants for sb_flags field of struct sockbuf.
121130818Srwatson */
1221541Srgrimes#define	SB_MAX		(256*1024)	/* default for max chars in sockbuf */
123131022Srwatson/*
124131022Srwatson * Constants for sb_flags field of struct sockbuf.
125131022Srwatson */
1261541Srgrimes#define	SB_WAIT		0x04		/* someone is waiting for data/space */
1271541Srgrimes#define	SB_SEL		0x08		/* someone is selecting */
1281541Srgrimes#define	SB_ASYNC	0x10		/* ASYNC I/O, need signals */
12936527Speter#define	SB_UPCALL	0x20		/* someone wants an upcall */
1301541Srgrimes#define	SB_NOINTR	0x40		/* operations not interruptible */
131167717Sandre#define	SB_AIO		0x80		/* AIO operations queued */
132167717Sandre#define	SB_KNOTE	0x100		/* kernel note attached */
133174711Skmacy#define	SB_NOCOALESCE	0x200		/* don't coalesce new data into existing mbufs */
134166404Sandre#define	SB_AUTOSIZE	0x800		/* automatically size socket buffer */
1351541Srgrimes
13697658Stanimura	void	(*so_upcall)(struct socket *, void *, int);
13797658Stanimura	void	*so_upcallarg;
138130527Srwatson	struct	ucred *so_cred;		/* (a) user credentials */
139130398Srwatson	struct	label *so_label;	/* (b) MAC label for socket */
140130398Srwatson	struct	label *so_peerlabel;	/* (b) cached MAC label for peer */
141160605Srwatson	/* NB: generation count must not be first. */
142131168Srwatson	so_gen_t so_gencnt;		/* (h) generation count */
143147852Sjhb	void	*so_emuldata;		/* (b) private data for emulators */
14497658Stanimura 	struct so_accf {
14597658Stanimura		struct	accept_filter *so_accept_filter;
14697658Stanimura		void	*so_accept_filter_arg;	/* saved filter args */
14797658Stanimura		char	*so_accept_filter_str;	/* saved user args */
14897658Stanimura	} *so_accf;
1491541Srgrimes};
1501541Srgrimes
151121628Ssam#define SB_EMPTY_FIXUP(sb) do {						\
152121628Ssam	if ((sb)->sb_mb == NULL) {					\
153121628Ssam		(sb)->sb_mbtail = NULL;					\
154121628Ssam		(sb)->sb_lastrecord = NULL;				\
155121628Ssam	}								\
156121628Ssam} while (/*CONSTCOND*/0)
157121628Ssam
1581541Srgrimes/*
159129979Srwatson * Global accept mutex to serialize access to accept queues and
160129979Srwatson * fields associated with multiple sockets.  This allows us to
161129979Srwatson * avoid defining a lock order between listen and accept sockets
162129979Srwatson * until such time as it proves to be a good idea.
163129979Srwatson */
164129979Srwatsonextern struct mtx accept_mtx;
165136682Srwatson#define	ACCEPT_LOCK_ASSERT()		mtx_assert(&accept_mtx, MA_OWNED)
166136682Srwatson#define	ACCEPT_UNLOCK_ASSERT()		mtx_assert(&accept_mtx, MA_NOTOWNED)
167130364Srwatson#define	ACCEPT_LOCK()			mtx_lock(&accept_mtx)
168130364Srwatson#define	ACCEPT_UNLOCK()			mtx_unlock(&accept_mtx)
169129979Srwatson
170129979Srwatson/*
171130380Srwatson * Per-socket buffer mutex used to protect most fields in the socket
172130380Srwatson * buffer.
173130380Srwatson */
174130380Srwatson#define	SOCKBUF_MTX(_sb)		(&(_sb)->sb_mtx)
175130380Srwatson#define	SOCKBUF_LOCK_INIT(_sb, _name) \
176130380Srwatson	mtx_init(SOCKBUF_MTX(_sb), _name, NULL, MTX_DEF)
177130380Srwatson#define	SOCKBUF_LOCK_DESTROY(_sb)	mtx_destroy(SOCKBUF_MTX(_sb))
178130380Srwatson#define	SOCKBUF_LOCK(_sb)		mtx_lock(SOCKBUF_MTX(_sb))
179130380Srwatson#define	SOCKBUF_OWNED(_sb)		mtx_owned(SOCKBUF_MTX(_sb))
180130380Srwatson#define	SOCKBUF_UNLOCK(_sb)		mtx_unlock(SOCKBUF_MTX(_sb))
181130380Srwatson#define	SOCKBUF_LOCK_ASSERT(_sb)	mtx_assert(SOCKBUF_MTX(_sb), MA_OWNED)
182136326Srwatson#define	SOCKBUF_UNLOCK_ASSERT(_sb)	mtx_assert(SOCKBUF_MTX(_sb), MA_NOTOWNED)
183130380Srwatson
184130380Srwatson/*
185130380Srwatson * Per-socket mutex: we reuse the receive socket buffer mutex for space
186130380Srwatson * efficiency.  This decision should probably be revisited as we optimize
187130380Srwatson * locking for the socket code.
188130380Srwatson */
189130380Srwatson#define	SOCK_MTX(_so)			SOCKBUF_MTX(&(_so)->so_rcv)
190130380Srwatson#define	SOCK_LOCK(_so)			SOCKBUF_LOCK(&(_so)->so_rcv)
191130380Srwatson#define	SOCK_OWNED(_so)			SOCKBUF_OWNED(&(_so)->so_rcv)
192130380Srwatson#define	SOCK_UNLOCK(_so)		SOCKBUF_UNLOCK(&(_so)->so_rcv)
193130380Srwatson#define	SOCK_LOCK_ASSERT(_so)		SOCKBUF_LOCK_ASSERT(&(_so)->so_rcv)
194130380Srwatson
195130492Srwatson/*
1961541Srgrimes * Socket state bits.
197130480Srwatson *
198130480Srwatson * Historically, this bits were all kept in the so_state field.  For
199130480Srwatson * locking reasons, they are now in multiple fields, as they are
200130480Srwatson * locked differently.  so_state maintains basic socket state protected
201130480Srwatson * by the socket lock.  so_qstate holds information about the socket
202130480Srwatson * accept queues.  Each socket buffer also has a state field holding
203130480Srwatson * information relevant to that socket buffer (can't send, rcv).  Many
204130480Srwatson * fields will be read without locks to improve performance and avoid
205130480Srwatson * lock order issues.  However, this approach must be used with caution.
2061541Srgrimes */
20714547Sdg#define	SS_NOFDREF		0x0001	/* no file table ref any more */
20814547Sdg#define	SS_ISCONNECTED		0x0002	/* socket connected to a peer */
20914547Sdg#define	SS_ISCONNECTING		0x0004	/* in process of connecting to peer */
21014547Sdg#define	SS_ISDISCONNECTING	0x0008	/* in process of disconnecting */
21114547Sdg#define	SS_NBIO			0x0100	/* non-blocking ops */
21214547Sdg#define	SS_ASYNC		0x0200	/* async i/o notify */
21314547Sdg#define	SS_ISCONFIRMING		0x0400	/* deciding to accept connection req */
21443196Sfenner#define	SS_ISDISCONNECTED	0x2000	/* socket disconnected from peer */
215157360Srwatson/*
216157360Srwatson * Protocols can mark a socket as SS_PROTOREF to indicate that, following
217157360Srwatson * pru_detach, they still want the socket to persist, and will free it
218157360Srwatson * themselves when they are done.  Protocols should only ever call sofree()
219157360Srwatson * following setting this flag in pru_detach(), and never otherwise, as
220157360Srwatson * sofree() bypasses socket reference counting.
221157360Srwatson */
222156746Srwatson#define	SS_PROTOREF		0x4000	/* strong protocol reference */
2231541Srgrimes
22436079Swollman/*
225130480Srwatson * Socket state bits now stored in the socket buffer state field.
226130480Srwatson */
227130480Srwatson#define	SBS_CANTSENDMORE	0x0010	/* can't send more data to peer */
228130480Srwatson#define	SBS_CANTRCVMORE		0x0020	/* can't receive more data from peer */
229130480Srwatson#define	SBS_RCVATMARK		0x0040	/* at mark on input */
230130480Srwatson
231130480Srwatson/*
232129916Srwatson * Socket state bits stored in so_qstate.
233129916Srwatson */
234129916Srwatson#define	SQ_INCOMP		0x0800	/* unaccepted, incomplete connection */
235129916Srwatson#define	SQ_COMP			0x1000	/* unaccepted, complete connection */
236129916Srwatson
237129916Srwatson/*
23836079Swollman * Externalized form of struct socket used by the sysctl(3) interface.
23936079Swollman */
24083045Sobrienstruct xsocket {
24136079Swollman	size_t	xso_len;	/* length of this structure */
24236079Swollman	struct	socket *xso_so;	/* makes a convenient handle sometimes */
24336079Swollman	short	so_type;
24436079Swollman	short	so_options;
24536079Swollman	short	so_linger;
24636079Swollman	short	so_state;
24736079Swollman	caddr_t	so_pcb;		/* another convenient handle */
24836079Swollman	int	xso_protocol;
24936079Swollman	int	xso_family;
250140730Sglebius	u_short	so_qlen;
251140730Sglebius	u_short	so_incqlen;
252140730Sglebius	u_short	so_qlimit;
25336079Swollman	short	so_timeo;
25436079Swollman	u_short	so_error;
25536079Swollman	pid_t	so_pgid;
25636079Swollman	u_long	so_oobmark;
25783421Sobrien	struct xsockbuf {
258100591Sjdp		u_int	sb_cc;
259100591Sjdp		u_int	sb_hiwat;
260100591Sjdp		u_int	sb_mbcnt;
261100591Sjdp		u_int	sb_mbmax;
262100591Sjdp		int	sb_lowat;
263100591Sjdp		int	sb_timeo;
26436079Swollman		short	sb_flags;
26536079Swollman	} so_rcv, so_snd;
26636079Swollman	uid_t	so_uid;		/* XXX */
26736079Swollman};
26814547Sdg
269130393Srwatson#ifdef _KERNEL
270130393Srwatson
2711541Srgrimes/*
2721541Srgrimes * Macros for sockets and socket buffering.
2731541Srgrimes */
2741541Srgrimes
2751541Srgrimes/*
276175845Srwatson * Flags to sblock().
277175845Srwatson */
278175845Srwatson#define	SBL_WAIT	0x00000001	/* Wait if not immediately available. */
279175845Srwatson#define	SBL_NOINTR	0x00000002	/* Force non-interruptible sleep. */
280175845Srwatson#define	SBL_VALID	(SBL_WAIT | SBL_NOINTR)
281175845Srwatson
282175845Srwatson/*
28336527Speter * Do we need to notify the other side when I/O is possible?
28436527Speter */
28555943Sjasone#define	sb_notify(sb)	(((sb)->sb_flags & (SB_WAIT | SB_SEL | SB_ASYNC | \
28659288Sjlemon    SB_UPCALL | SB_AIO | SB_KNOTE)) != 0)
28736527Speter
28836527Speter/*
2891541Srgrimes * How much space is there in a socket buffer (so->so_snd or so->so_rcv)?
2901541Srgrimes * This is problematical if the fields are unsigned, as the space might
2911541Srgrimes * still be negative (cc > hiwat or mbcnt > mbmax).  Should detect
2921541Srgrimes * overflow and return 0.  Should use "lmin" but it doesn't exist now.
2931541Srgrimes */
2941541Srgrimes#define	sbspace(sb) \
2951541Srgrimes    ((long) imin((int)((sb)->sb_hiwat - (sb)->sb_cc), \
2961541Srgrimes	 (int)((sb)->sb_mbmax - (sb)->sb_mbcnt)))
2971541Srgrimes
2981541Srgrimes/* do we have to send all at once on a socket? */
2991541Srgrimes#define	sosendallatonce(so) \
3001541Srgrimes    ((so)->so_proto->pr_flags & PR_ATOMIC)
3011541Srgrimes
3021541Srgrimes/* can we read something from so? */
3031541Srgrimes#define	soreadable(so) \
3041541Srgrimes    ((so)->so_rcv.sb_cc >= (so)->so_rcv.sb_lowat || \
305130480Srwatson	((so)->so_rcv.sb_state & SBS_CANTRCVMORE) || \
30670536Sphk	!TAILQ_EMPTY(&(so)->so_comp) || (so)->so_error)
3071541Srgrimes
3081541Srgrimes/* can we write something to so? */
3091541Srgrimes#define	sowriteable(so) \
3103304Sphk    ((sbspace(&(so)->so_snd) >= (so)->so_snd.sb_lowat && \
3111541Srgrimes	(((so)->so_state&SS_ISCONNECTED) || \
3123304Sphk	  ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0)) || \
313130480Srwatson     ((so)->so_snd.sb_state & SBS_CANTSENDMORE) || \
3141541Srgrimes     (so)->so_error)
3151541Srgrimes
3161541Srgrimes/* adjust counters in sb reflecting allocation of m */
3171541Srgrimes#define	sballoc(sb, m) { \
3181541Srgrimes	(sb)->sb_cc += (m)->m_len; \
319151967Sandre	if ((m)->m_type != MT_DATA && (m)->m_type != MT_OOBDATA) \
320106313Skbyanc		(sb)->sb_ctl += (m)->m_len; \
3211541Srgrimes	(sb)->sb_mbcnt += MSIZE; \
3221541Srgrimes	if ((m)->m_flags & M_EXT) \
3231541Srgrimes		(sb)->sb_mbcnt += (m)->m_ext.ext_size; \
3241541Srgrimes}
3251541Srgrimes
3261541Srgrimes/* adjust counters in sb reflecting freeing of m */
3271541Srgrimes#define	sbfree(sb, m) { \
3281541Srgrimes	(sb)->sb_cc -= (m)->m_len; \
329151967Sandre	if ((m)->m_type != MT_DATA && (m)->m_type != MT_OOBDATA) \
330106313Skbyanc		(sb)->sb_ctl -= (m)->m_len; \
3311541Srgrimes	(sb)->sb_mbcnt -= MSIZE; \
3321541Srgrimes	if ((m)->m_flags & M_EXT) \
3331541Srgrimes		(sb)->sb_mbcnt -= (m)->m_ext.ext_size; \
334167715Sandre	if ((sb)->sb_sndptr == (m)) { \
335167715Sandre		(sb)->sb_sndptr = NULL; \
336167715Sandre		(sb)->sb_sndptroff = 0; \
337167715Sandre	} \
338167715Sandre	if ((sb)->sb_sndptroff != 0) \
339167715Sandre		(sb)->sb_sndptroff -= (m)->m_len; \
3401541Srgrimes}
3411541Srgrimes
3421541Srgrimes/*
34386487Sdillon * soref()/sorele() ref-count the socket structure.  Note that you must
34486487Sdillon * still explicitly close the socket, but the last ref count will free
34586487Sdillon * the structure.
34686487Sdillon */
347130383Srwatson#define	soref(so) do {							\
348130387Srwatson	SOCK_LOCK_ASSERT(so);						\
349130383Srwatson	++(so)->so_count;						\
350130383Srwatson} while (0)
35186487Sdillon
352130383Srwatson#define	sorele(so) do {							\
353136682Srwatson	ACCEPT_LOCK_ASSERT();						\
354130387Srwatson	SOCK_LOCK_ASSERT(so);						\
355130383Srwatson	if ((so)->so_count <= 0)					\
356130383Srwatson		panic("sorele");					\
357130383Srwatson	if (--(so)->so_count == 0)					\
358130383Srwatson		sofree(so);						\
359136682Srwatson	else {								\
360130387Srwatson		SOCK_UNLOCK(so);					\
361136682Srwatson		ACCEPT_UNLOCK();					\
362136682Srwatson	}								\
363130383Srwatson} while (0)
36486487Sdillon
365130383Srwatson#define	sotryfree(so) do {						\
366136682Srwatson	ACCEPT_LOCK_ASSERT();						\
367130387Srwatson	SOCK_LOCK_ASSERT(so);						\
368130383Srwatson	if ((so)->so_count == 0)					\
369130383Srwatson		sofree(so);						\
370136682Srwatson	else {								\
371130387Srwatson		SOCK_UNLOCK(so);					\
372136682Srwatson		ACCEPT_UNLOCK();					\
373136682Srwatson	}								\
374130383Srwatson} while(0)
37586487Sdillon
376130831Srwatson/*
377130831Srwatson * In sorwakeup() and sowwakeup(), acquire the socket buffer lock to
378130831Srwatson * avoid a non-atomic test-and-wakeup.  However, sowakeup is
379130831Srwatson * responsible for releasing the lock if it is called.  We unlock only
380130831Srwatson * if we don't call into sowakeup.  If any code is introduced that
381130831Srwatson * directly invokes the underlying sowakeup() primitives, it must
382130831Srwatson * maintain the same semantics.
383130831Srwatson */
384130831Srwatson#define	sorwakeup_locked(so) do {					\
385130831Srwatson	SOCKBUF_LOCK_ASSERT(&(so)->so_rcv);				\
386130383Srwatson	if (sb_notify(&(so)->so_rcv))					\
387130831Srwatson		sowakeup((so), &(so)->so_rcv);	 			\
388130831Srwatson	else								\
389130831Srwatson		SOCKBUF_UNLOCK(&(so)->so_rcv);				\
390130383Srwatson} while (0)
3911541Srgrimes
392130831Srwatson#define	sorwakeup(so) do {						\
393130831Srwatson	SOCKBUF_LOCK(&(so)->so_rcv);					\
394130831Srwatson	sorwakeup_locked(so);						\
395130831Srwatson} while (0)
396130831Srwatson
397130831Srwatson#define	sowwakeup_locked(so) do {					\
398131029Srwatson	SOCKBUF_LOCK_ASSERT(&(so)->so_snd);				\
399130383Srwatson	if (sb_notify(&(so)->so_snd))					\
400130383Srwatson		sowakeup((so), &(so)->so_snd); 				\
401130831Srwatson	else								\
402130831Srwatson		SOCKBUF_UNLOCK(&(so)->so_snd);				\
403130383Srwatson} while (0)
4041541Srgrimes
405130831Srwatson#define	sowwakeup(so) do {						\
406130831Srwatson	SOCKBUF_LOCK(&(so)->so_snd);					\
407130831Srwatson	sowwakeup_locked(so);						\
408130831Srwatson} while (0)
409130831Srwatson
41038482Swollman/*
41138482Swollman * Argument structure for sosetopt et seq.  This is in the KERNEL
41238482Swollman * section because it will never be visible to user code.
41338482Swollman */
41438482Swollmanenum sopt_dir { SOPT_GET, SOPT_SET };
41538482Swollmanstruct sockopt {
41638482Swollman	enum	sopt_dir sopt_dir; /* is this a get or a set? */
41738482Swollman	int	sopt_level;	/* second arg of [gs]etsockopt */
41838482Swollman	int	sopt_name;	/* third arg of [gs]etsockopt */
41938482Swollman	void   *sopt_val;	/* fourth arg of [gs]etsockopt */
42038482Swollman	size_t	sopt_valsize;	/* (almost) fifth arg of [gs]etsockopt */
42195959Salfred	struct	thread *sopt_td; /* calling thread or null if kernel */
42238482Swollman};
42338482Swollman
42461837Salfredstruct accept_filter {
42561837Salfred	char	accf_name[16];
42661837Salfred	void	(*accf_callback)
42792719Salfred		(struct socket *so, void *arg, int waitflag);
42861837Salfred	void *	(*accf_create)
42992719Salfred		(struct socket *so, char *arg);
43061837Salfred	void	(*accf_destroy)
43192719Salfred		(struct socket *so);
43295959Salfred	SLIST_ENTRY(accept_filter) accf_next;
43382656Sjlemon};
43461837Salfred
43531927Sbde#ifdef MALLOC_DECLARE
43695959SalfredMALLOC_DECLARE(M_ACCF);
43731927SbdeMALLOC_DECLARE(M_PCB);
43831927SbdeMALLOC_DECLARE(M_SONAME);
43931927Sbde#endif
44031927Sbde
44195959Salfredextern int	maxsockets;
4422112Swollmanextern u_long	sb_max;
44395959Salfredextern struct uma_zone *socket_zone;
44436079Swollmanextern so_gen_t so_gencnt;
44514505Shsu
44615492Sbdestruct mbuf;
44715492Sbdestruct sockaddr;
44832995Sbdestruct ucred;
44932995Sbdestruct uio;
45015492Sbde
4511541Srgrimes/*
4523304Sphk * From uipc_socket and friends
4533304Sphk */
454143463Srwatsonint	do_getopt_accept_filter(struct socket *so, struct sockopt *sopt);
455142058Srwatsonint	do_setopt_accept_filter(struct socket *so, struct sockopt *sopt);
456132060Sdwmaloneint	so_setsockopt(struct socket *so, int level, int optname,
457132060Sdwmalone	    void *optval, size_t optlen);
45892719Salfredint	sockargs(struct mbuf **mp, caddr_t buf, int buflen, int type);
45992719Salfredint	getsockaddr(struct sockaddr **namp, caddr_t uaddr, size_t len);
46092719Salfredvoid	sbappend(struct sockbuf *sb, struct mbuf *m);
461130831Srwatsonvoid	sbappend_locked(struct sockbuf *sb, struct mbuf *m);
462121628Ssamvoid	sbappendstream(struct sockbuf *sb, struct mbuf *m);
463130831Srwatsonvoid	sbappendstream_locked(struct sockbuf *sb, struct mbuf *m);
464130050Srwatsonint	sbappendaddr(struct sockbuf *sb, const struct sockaddr *asa,
46592719Salfred	    struct mbuf *m0, struct mbuf *control);
466130831Srwatsonint	sbappendaddr_locked(struct sockbuf *sb, const struct sockaddr *asa,
467130831Srwatson	    struct mbuf *m0, struct mbuf *control);
46892719Salfredint	sbappendcontrol(struct sockbuf *sb, struct mbuf *m0,
46992719Salfred	    struct mbuf *control);
470130831Srwatsonint	sbappendcontrol_locked(struct sockbuf *sb, struct mbuf *m0,
471130831Srwatson	    struct mbuf *control);
47292719Salfredvoid	sbappendrecord(struct sockbuf *sb, struct mbuf *m0);
473130831Srwatsonvoid	sbappendrecord_locked(struct sockbuf *sb, struct mbuf *m0);
47492719Salfredvoid	sbcheck(struct sockbuf *sb);
47592719Salfredvoid	sbcompress(struct sockbuf *sb, struct mbuf *m, struct mbuf *n);
47619670Sbdestruct mbuf *
47792719Salfred	sbcreatecontrol(caddr_t p, int size, int type, int level);
478160875Srwatsonvoid	sbdestroy(struct sockbuf *sb, struct socket *so);
47992719Salfredvoid	sbdrop(struct sockbuf *sb, int len);
480130831Srwatsonvoid	sbdrop_locked(struct sockbuf *sb, int len);
48192719Salfredvoid	sbdroprecord(struct sockbuf *sb);
482130831Srwatsonvoid	sbdroprecord_locked(struct sockbuf *sb);
48392719Salfredvoid	sbflush(struct sockbuf *sb);
484130831Srwatsonvoid	sbflush_locked(struct sockbuf *sb);
48592719Salfredvoid	sbrelease(struct sockbuf *sb, struct socket *so);
486130831Srwatsonvoid	sbrelease_locked(struct sockbuf *sb, struct socket *so);
48792719Salfredint	sbreserve(struct sockbuf *sb, u_long cc, struct socket *so,
48893008Sbde	    struct thread *td);
489131006Srwatsonint	sbreserve_locked(struct sockbuf *sb, u_long cc, struct socket *so,
490131006Srwatson	    struct thread *td);
491167715Sandrestruct mbuf *
492167715Sandre	sbsndptr(struct sockbuf *sb, u_int off, u_int len, u_int *moff);
49392719Salfredvoid	sbtoxsockbuf(struct sockbuf *sb, struct xsockbuf *xsb);
49492719Salfredint	sbwait(struct sockbuf *sb);
495169236Srwatsonint	sblock(struct sockbuf *sb, int flags);
496169236Srwatsonvoid	sbunlock(struct sockbuf *sb);
497156763Srwatsonvoid	soabort(struct socket *so);
49892719Salfredint	soaccept(struct socket *so, struct sockaddr **nam);
49995959Salfredint	socheckuid(struct socket *so, uid_t uid);
50092719Salfredint	sobind(struct socket *so, struct sockaddr *nam, struct thread *td);
50192719Salfredvoid	socantrcvmore(struct socket *so);
502130831Srwatsonvoid	socantrcvmore_locked(struct socket *so);
50392719Salfredvoid	socantsendmore(struct socket *so);
504130831Srwatsonvoid	socantsendmore_locked(struct socket *so);
50592719Salfredint	soclose(struct socket *so);
50692719Salfredint	soconnect(struct socket *so, struct sockaddr *nam, struct thread *td);
50792719Salfredint	soconnect2(struct socket *so1, struct socket *so2);
50898849Skenint	socow_setup(struct mbuf *m0, struct uio *uio);
50992719Salfredint	socreate(int dom, struct socket **aso, int type, int proto,
51092719Salfred	    struct ucred *cred, struct thread *td);
51192719Salfredint	sodisconnect(struct socket *so);
512126425Srwatsonstruct	sockaddr *sodupsockaddr(const struct sockaddr *sa, int mflags);
51392719Salfredvoid	sofree(struct socket *so);
51492719Salfredint	sogetopt(struct socket *so, struct sockopt *sopt);
51592719Salfredvoid	sohasoutofband(struct socket *so);
51692719Salfredvoid	soisconnected(struct socket *so);
51792719Salfredvoid	soisconnecting(struct socket *so);
51892719Salfredvoid	soisdisconnected(struct socket *so);
51992719Salfredvoid	soisdisconnecting(struct socket *so);
52092719Salfredint	solisten(struct socket *so, int backlog, struct thread *td);
521151888Srwatsonvoid	solisten_proto(struct socket *so, int backlog);
522142190Srwatsonint	solisten_proto_check(struct socket *so);
52314505Shsustruct socket *
52492719Salfred	sonewconn(struct socket *head, int connstatus);
52593008Sbdeint	sooptcopyin(struct sockopt *sopt, void *buf, size_t len, size_t minlen);
526118453Shsuint	sooptcopyout(struct sockopt *sopt, const void *buf, size_t len);
52753541Sshin
52853541Sshin/* XXX; prepare mbuf for (__FreeBSD__ < 3) routines. */
52992719Salfredint	soopt_getm(struct sockopt *sopt, struct mbuf **mp);
53092719Salfredint	soopt_mcopyin(struct sockopt *sopt, struct mbuf *m);
53192719Salfredint	soopt_mcopyout(struct sockopt *sopt, struct mbuf *m);
53253541Sshin
533101983Srwatsonint	sopoll(struct socket *so, int events, struct ucred *active_cred,
53493008Sbde	    struct thread *td);
535160619Srwatsonint	sopoll_generic(struct socket *so, int events,
536160619Srwatson	    struct ucred *active_cred, struct thread *td);
53793008Sbdeint	soreceive(struct socket *so, struct sockaddr **paddr, struct uio *uio,
53893008Sbde	    struct mbuf **mp0, struct mbuf **controlp, int *flagsp);
539160619Srwatsonint	soreceive_generic(struct socket *so, struct sockaddr **paddr,
540160619Srwatson	    struct uio *uio, struct mbuf **mp0, struct mbuf **controlp,
541160619Srwatson	    int *flagsp);
54292719Salfredint	soreserve(struct socket *so, u_long sndcc, u_long rcvcc);
54392719Salfredvoid	sorflush(struct socket *so);
54492719Salfredint	sosend(struct socket *so, struct sockaddr *addr, struct uio *uio,
54593008Sbde	    struct mbuf *top, struct mbuf *control, int flags,
54693008Sbde	    struct thread *td);
547154294Srwatsonint	sosend_dgram(struct socket *so, struct sockaddr *addr,
548154294Srwatson	    struct uio *uio, struct mbuf *top, struct mbuf *control,
549154294Srwatson	    int flags, struct thread *td);
550160619Srwatsonint	sosend_generic(struct socket *so, struct sockaddr *addr,
551160619Srwatson	    struct uio *uio, struct mbuf *top, struct mbuf *control,
552160619Srwatson	    int flags, struct thread *td);
55392719Salfredint	sosetopt(struct socket *so, struct sockopt *sopt);
55492719Salfredint	soshutdown(struct socket *so, int how);
55592719Salfredvoid	sotoxsocket(struct socket *so, struct xsocket *xso);
55692719Salfredvoid	sowakeup(struct socket *so, struct sockbuf *sb);
557174647Sjeffint	selsocket(struct socket *so, int events, struct timeval *tv,
558174647Sjeff	    struct thread *td);
55931927Sbde
560121628Ssam#ifdef SOCKBUF_DEBUG
561121628Ssamvoid	sblastrecordchk(struct sockbuf *, const char *, int);
562121628Ssam#define	SBLASTRECORDCHK(sb)	sblastrecordchk((sb), __FILE__, __LINE__)
563121628Ssam
564121628Ssamvoid	sblastmbufchk(struct sockbuf *, const char *, int);
565121628Ssam#define	SBLASTMBUFCHK(sb)	sblastmbufchk((sb), __FILE__, __LINE__)
566121628Ssam#else
567121628Ssam#define	SBLASTRECORDCHK(sb)      /* nothing */
568121628Ssam#define	SBLASTMBUFCHK(sb)        /* nothing */
569121628Ssam#endif /* SOCKBUF_DEBUG */
570121628Ssam
57195959Salfred/*
57295959Salfred * Accept filter functions (duh).
57395959Salfred */
57492719Salfredint	accept_filt_add(struct accept_filter *filt);
57592719Salfredint	accept_filt_del(char *name);
57695959Salfredstruct	accept_filter *accept_filt_get(char *name);
57761837Salfred#ifdef ACCEPT_FILTER_MOD
57895959Salfred#ifdef SYSCTL_DECL
57965534SalfredSYSCTL_DECL(_net_inet_accf);
58095959Salfred#endif
58195959Salfredint	accept_filt_generic_mod_event(module_t mod, int event, void *data);
58295959Salfred#endif
58361837Salfred
58455205Speter#endif /* _KERNEL */
5852165Spaul
58614505Shsu#endif /* !_SYS_SOCKETVAR_H_ */
587